forked from ekstep/EkStep-Developer
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issue ekstep#18 feat: NTP integration class updated with function to …
…get JWT token
- Loading branch information
Showing
10 changed files
with
725 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
Copyright (c) 2011, Neuman Vong | ||
|
||
All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without | ||
modification, are permitted provided that the following conditions are met: | ||
|
||
* Redistributions of source code must retain the above copyright | ||
notice, this list of conditions and the following disclaimer. | ||
|
||
* Redistributions in binary form must reproduce the above | ||
copyright notice, this list of conditions and the following | ||
disclaimer in the documentation and/or other materials provided | ||
with the distribution. | ||
|
||
* Neither the name of Neuman Vong nor the names of other | ||
contributors may be used to endorse or promote products derived | ||
from this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,200 @@ | ||
[![Build Status](https://travis-ci.org/firebase/php-jwt.png?branch=master)](https://travis-ci.org/firebase/php-jwt) | ||
[![Latest Stable Version](https://poser.pugx.org/firebase/php-jwt/v/stable)](https://packagist.org/packages/firebase/php-jwt) | ||
[![Total Downloads](https://poser.pugx.org/firebase/php-jwt/downloads)](https://packagist.org/packages/firebase/php-jwt) | ||
[![License](https://poser.pugx.org/firebase/php-jwt/license)](https://packagist.org/packages/firebase/php-jwt) | ||
|
||
PHP-JWT | ||
======= | ||
A simple library to encode and decode JSON Web Tokens (JWT) in PHP, conforming to [RFC 7519](https://tools.ietf.org/html/rfc7519). | ||
|
||
Installation | ||
------------ | ||
|
||
Use composer to manage your dependencies and download PHP-JWT: | ||
|
||
```bash | ||
composer require firebase/php-jwt | ||
``` | ||
|
||
Example | ||
------- | ||
```php | ||
<?php | ||
use \Firebase\JWT\JWT; | ||
|
||
$key = "example_key"; | ||
$token = array( | ||
"iss" => "http://example.org", | ||
"aud" => "http://example.com", | ||
"iat" => 1356999524, | ||
"nbf" => 1357000000 | ||
); | ||
|
||
/** | ||
* IMPORTANT: | ||
* You must specify supported algorithms for your application. See | ||
* https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40 | ||
* for a list of spec-compliant algorithms. | ||
*/ | ||
$jwt = JWT::encode($token, $key); | ||
$decoded = JWT::decode($jwt, $key, array('HS256')); | ||
|
||
print_r($decoded); | ||
|
||
/* | ||
NOTE: This will now be an object instead of an associative array. To get | ||
an associative array, you will need to cast it as such: | ||
*/ | ||
|
||
$decoded_array = (array) $decoded; | ||
|
||
/** | ||
* You can add a leeway to account for when there is a clock skew times between | ||
* the signing and verifying servers. It is recommended that this leeway should | ||
* not be bigger than a few minutes. | ||
* | ||
* Source: http://self-issued.info/docs/draft-ietf-oauth-json-web-token.html#nbfDef | ||
*/ | ||
JWT::$leeway = 60; // $leeway in seconds | ||
$decoded = JWT::decode($jwt, $key, array('HS256')); | ||
|
||
?> | ||
``` | ||
Example with RS256 (openssl) | ||
---------------------------- | ||
```php | ||
<?php | ||
use \Firebase\JWT\JWT; | ||
|
||
$privateKey = <<<EOD | ||
-----BEGIN RSA PRIVATE KEY----- | ||
MIICXAIBAAKBgQC8kGa1pSjbSYZVebtTRBLxBz5H4i2p/llLCrEeQhta5kaQu/Rn | ||
vuER4W8oDH3+3iuIYW4VQAzyqFpwuzjkDI+17t5t0tyazyZ8JXw+KgXTxldMPEL9 | ||
5+qVhgXvwtihXC1c5oGbRlEDvDF6Sa53rcFVsYJ4ehde/zUxo6UvS7UrBQIDAQAB | ||
AoGAb/MXV46XxCFRxNuB8LyAtmLDgi/xRnTAlMHjSACddwkyKem8//8eZtw9fzxz | ||
bWZ/1/doQOuHBGYZU8aDzzj59FZ78dyzNFoF91hbvZKkg+6wGyd/LrGVEB+Xre0J | ||
Nil0GReM2AHDNZUYRv+HYJPIOrB0CRczLQsgFJ8K6aAD6F0CQQDzbpjYdx10qgK1 | ||
cP59UHiHjPZYC0loEsk7s+hUmT3QHerAQJMZWC11Qrn2N+ybwwNblDKv+s5qgMQ5 | ||
5tNoQ9IfAkEAxkyffU6ythpg/H0Ixe1I2rd0GbF05biIzO/i77Det3n4YsJVlDck | ||
ZkcvY3SK2iRIL4c9yY6hlIhs+K9wXTtGWwJBAO9Dskl48mO7woPR9uD22jDpNSwe | ||
k90OMepTjzSvlhjbfuPN1IdhqvSJTDychRwn1kIJ7LQZgQ8fVz9OCFZ/6qMCQGOb | ||
qaGwHmUK6xzpUbbacnYrIM6nLSkXgOAwv7XXCojvY614ILTK3iXiLBOxPu5Eu13k | ||
eUz9sHyD6vkgZzjtxXECQAkp4Xerf5TGfQXGXhxIX52yH+N2LtujCdkQZjXAsGdm | ||
B2zNzvrlgRmgBrklMTrMYgm1NPcW+bRLGcwgW2PTvNM= | ||
-----END RSA PRIVATE KEY----- | ||
EOD; | ||
|
||
$publicKey = <<<EOD | ||
-----BEGIN PUBLIC KEY----- | ||
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC8kGa1pSjbSYZVebtTRBLxBz5H | ||
4i2p/llLCrEeQhta5kaQu/RnvuER4W8oDH3+3iuIYW4VQAzyqFpwuzjkDI+17t5t | ||
0tyazyZ8JXw+KgXTxldMPEL95+qVhgXvwtihXC1c5oGbRlEDvDF6Sa53rcFVsYJ4 | ||
ehde/zUxo6UvS7UrBQIDAQAB | ||
-----END PUBLIC KEY----- | ||
EOD; | ||
|
||
$token = array( | ||
"iss" => "example.org", | ||
"aud" => "example.com", | ||
"iat" => 1356999524, | ||
"nbf" => 1357000000 | ||
); | ||
|
||
$jwt = JWT::encode($token, $privateKey, 'RS256'); | ||
echo "Encode:\n" . print_r($jwt, true) . "\n"; | ||
|
||
$decoded = JWT::decode($jwt, $publicKey, array('RS256')); | ||
|
||
/* | ||
NOTE: This will now be an object instead of an associative array. To get | ||
an associative array, you will need to cast it as such: | ||
*/ | ||
|
||
$decoded_array = (array) $decoded; | ||
echo "Decode:\n" . print_r($decoded_array, true) . "\n"; | ||
?> | ||
``` | ||
|
||
Changelog | ||
--------- | ||
|
||
#### 5.0.0 / 2017-06-26 | ||
- Support RS384 and RS512. | ||
See [#117](https://github.com/firebase/php-jwt/pull/117). Thanks [@joostfaassen](https://github.com/joostfaassen)! | ||
- Add an example for RS256 openssl. | ||
See [#125](https://github.com/firebase/php-jwt/pull/125). Thanks [@akeeman](https://github.com/akeeman)! | ||
- Detect invalid Base64 encoding in signature. | ||
See [#162](https://github.com/firebase/php-jwt/pull/162). Thanks [@psignoret](https://github.com/psignoret)! | ||
- Update `JWT::verify` to handle OpenSSL errors. | ||
See [#159](https://github.com/firebase/php-jwt/pull/159). Thanks [@bshaffer](https://github.com/bshaffer)! | ||
- Add `array` type hinting to `decode` method | ||
See [#101](https://github.com/firebase/php-jwt/pull/101). Thanks [@hywak](https://github.com/hywak)! | ||
- Add all JSON error types. | ||
See [#110](https://github.com/firebase/php-jwt/pull/110). Thanks [@gbalduzzi](https://github.com/gbalduzzi)! | ||
- Bugfix 'kid' not in given key list. | ||
See [#129](https://github.com/firebase/php-jwt/pull/129). Thanks [@stampycode](https://github.com/stampycode)! | ||
- Miscellaneous cleanup, documentation and test fixes. | ||
See [#107](https://github.com/firebase/php-jwt/pull/107), [#115](https://github.com/firebase/php-jwt/pull/115), | ||
[#160](https://github.com/firebase/php-jwt/pull/160), [#161](https://github.com/firebase/php-jwt/pull/161), and | ||
[#165](https://github.com/firebase/php-jwt/pull/165). Thanks [@akeeman](https://github.com/akeeman), | ||
[@chinedufn](https://github.com/chinedufn), and [@bshaffer](https://github.com/bshaffer)! | ||
|
||
#### 4.0.0 / 2016-07-17 | ||
- Add support for late static binding. See [#88](https://github.com/firebase/php-jwt/pull/88) for details. Thanks to [@chappy84](https://github.com/chappy84)! | ||
- Use static `$timestamp` instead of `time()` to improve unit testing. See [#93](https://github.com/firebase/php-jwt/pull/93) for details. Thanks to [@josephmcdermott](https://github.com/josephmcdermott)! | ||
- Fixes to exceptions classes. See [#81](https://github.com/firebase/php-jwt/pull/81) for details. Thanks to [@Maks3w](https://github.com/Maks3w)! | ||
- Fixes to PHPDoc. See [#76](https://github.com/firebase/php-jwt/pull/76) for details. Thanks to [@akeeman](https://github.com/akeeman)! | ||
|
||
#### 3.0.0 / 2015-07-22 | ||
- Minimum PHP version updated from `5.2.0` to `5.3.0`. | ||
- Add `\Firebase\JWT` namespace. See | ||
[#59](https://github.com/firebase/php-jwt/pull/59) for details. Thanks to | ||
[@Dashron](https://github.com/Dashron)! | ||
- Require a non-empty key to decode and verify a JWT. See | ||
[#60](https://github.com/firebase/php-jwt/pull/60) for details. Thanks to | ||
[@sjones608](https://github.com/sjones608)! | ||
- Cleaner documentation blocks in the code. See | ||
[#62](https://github.com/firebase/php-jwt/pull/62) for details. Thanks to | ||
[@johanderuijter](https://github.com/johanderuijter)! | ||
|
||
#### 2.2.0 / 2015-06-22 | ||
- Add support for adding custom, optional JWT headers to `JWT::encode()`. See | ||
[#53](https://github.com/firebase/php-jwt/pull/53/files) for details. Thanks to | ||
[@mcocaro](https://github.com/mcocaro)! | ||
|
||
#### 2.1.0 / 2015-05-20 | ||
- Add support for adding a leeway to `JWT:decode()` that accounts for clock skew | ||
between signing and verifying entities. Thanks to [@lcabral](https://github.com/lcabral)! | ||
- Add support for passing an object implementing the `ArrayAccess` interface for | ||
`$keys` argument in `JWT::decode()`. Thanks to [@aztech-dev](https://github.com/aztech-dev)! | ||
|
||
#### 2.0.0 / 2015-04-01 | ||
- **Note**: It is strongly recommended that you update to > v2.0.0 to address | ||
known security vulnerabilities in prior versions when both symmetric and | ||
asymmetric keys are used together. | ||
- Update signature for `JWT::decode(...)` to require an array of supported | ||
algorithms to use when verifying token signatures. | ||
|
||
|
||
Tests | ||
----- | ||
Run the tests using phpunit: | ||
|
||
```bash | ||
$ pear install PHPUnit | ||
$ phpunit --configuration phpunit.xml.dist | ||
PHPUnit 3.7.10 by Sebastian Bergmann. | ||
..... | ||
Time: 0 seconds, Memory: 2.50Mb | ||
OK (5 tests, 5 assertions) | ||
``` | ||
|
||
New Lines in private keys | ||
----- | ||
|
||
If your private key contains `\n` characters, be sure to wrap it in double quotes `""` | ||
and not single quotes `''` in order to properly interpret the escaped characters. | ||
|
||
License | ||
------- | ||
[3-Clause BSD](http://opensource.org/licenses/BSD-3-Clause). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
{ | ||
"name": "firebase/php-jwt", | ||
"description": "A simple library to encode and decode JSON Web Tokens (JWT) in PHP. Should conform to the current spec.", | ||
"homepage": "https://github.com/firebase/php-jwt", | ||
"authors": [ | ||
{ | ||
"name": "Neuman Vong", | ||
"email": "[email protected]", | ||
"role": "Developer" | ||
}, | ||
{ | ||
"name": "Anant Narayanan", | ||
"email": "[email protected]", | ||
"role": "Developer" | ||
} | ||
], | ||
"license": "BSD-3-Clause", | ||
"require": { | ||
"php": ">=5.3.0" | ||
}, | ||
"autoload": { | ||
"psr-4": { | ||
"Firebase\\JWT\\": "src" | ||
} | ||
}, | ||
"require-dev": { | ||
"phpunit/phpunit": " 4.8.35" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<?php | ||
namespace Firebase\JWT; | ||
|
||
class BeforeValidException extends \UnexpectedValueException | ||
{ | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
<?php | ||
namespace Firebase\JWT; | ||
|
||
class ExpiredException extends \UnexpectedValueException | ||
{ | ||
|
||
} |
Oops, something went wrong.