|
| 1 | +--- |
| 2 | +id: jwt |
| 3 | +title: Example: JWT |
| 4 | +--- |
| 5 | + |
| 6 | +A [JSON Web Token](https://en.wikipedia.org/wiki/JSON_Web_Token) consists of three parts - a header a payload and a signature - each encoded separately using [Base64url](https://en.wikipedia.org/wiki/Base64#URL_applications) (`\phpseclib3\Common\Functions\Strings::base64url_encode()`) and concatenated together using periods. eg. |
| 7 | + |
| 8 | +``` |
| 9 | +const token = base64urlEncoding(header) + '.' + |
| 10 | + base64urlEncoding(payload) + '.' + |
| 11 | + base64urlEncoding(signature) |
| 12 | +``` |
| 13 | +The signature is created from the concatenation of the Base64url encoded header and payload. The algorithm used for the signature is specified in the header. |
| 14 | + |
| 15 | +A list of all the algorithms and how to implement them with phpseclib is discussed below. In these examples `$header` and `$payload` are assumed to already be Base64url encoded and `Strings` is assumed to be namespaced to `\phpseclib3\Common\Functions\Strings`. |
| 16 | + |
| 17 | +## ES256 |
| 18 | + |
| 19 | +```php |
| 20 | +assert($private instanceof \phpseclib3\Crypt\EC); |
| 21 | +assert($private->getCurve() == 'secp256r1'); |
| 22 | + |
| 23 | +$private = $private->withHash('sha256')->withSignatureFormat('IEEE'); |
| 24 | +$sig = $private->sign("$header.$payload"); |
| 25 | +$sig = Strings::base64url_encode($sig); |
| 26 | +``` |
| 27 | + |
| 28 | +## ES384 |
| 29 | + |
| 30 | +```php |
| 31 | +assert($private instanceof \phpseclib3\Crypt\EC); |
| 32 | +assert($private->getCurve() == 'secp384r1'); |
| 33 | + |
| 34 | +$private = $private->withHash('sha384')->withSignatureFormat('IEEE'); |
| 35 | +$sig = $private->sign("$header.$payload"); |
| 36 | +$sig = Strings::base64url_encode($sig); |
| 37 | +``` |
| 38 | + |
| 39 | +## ES512 |
| 40 | + |
| 41 | +```php |
| 42 | +assert($private instanceof \phpseclib3\Crypt\EC); |
| 43 | +assert($private->getCurve() == 'secp521r1'); |
| 44 | + |
| 45 | +$private = $private->withHash('sha512')->withSignatureFormat('IEEE'); |
| 46 | +$sig = $private->sign("$header.$payload"); |
| 47 | +$sig = Strings::base64url_encode($sig); |
| 48 | +``` |
| 49 | + |
| 50 | +## RS256 |
| 51 | + |
| 52 | +```php |
| 53 | +assert($private instanceof \phpseclib3\Crypt\RSA); |
| 54 | + |
| 55 | +$private = $private->withHash('sha256')->withPadding(RSA::SIGNATURE_PKCS1); |
| 56 | +$sig = $private->sign("$header.$payload"); |
| 57 | +$sig = Strings::base64url_encode($sig); |
| 58 | +``` |
| 59 | + |
| 60 | +## RS384 |
| 61 | + |
| 62 | +```php |
| 63 | +assert($private instanceof \phpseclib3\Crypt\RSA); |
| 64 | + |
| 65 | +$private = $private->withHash('sha384')->withPadding(RSA::SIGNATURE_PKCS1); |
| 66 | +$sig = $private->sign("$header.$payload"); |
| 67 | +$sig = Strings::base64url_encode($sig); |
| 68 | +``` |
| 69 | + |
| 70 | +## RS512 |
| 71 | + |
| 72 | +```php |
| 73 | +assert($private instanceof \phpseclib3\Crypt\RSA); |
| 74 | + |
| 75 | +$private = $private->withHash('sha512')->withPadding(RSA::SIGNATURE_PKCS1); |
| 76 | +$sig = $private->sign("$header.$payload"); |
| 77 | +$sig = Strings::base64url_encode($sig); |
| 78 | +``` |
| 79 | + |
| 80 | +## PS256 |
| 81 | + |
| 82 | +```php |
| 83 | +assert($private instanceof \phpseclib3\Crypt\RSA); |
| 84 | + |
| 85 | +$private = $private->withHash('sha256')->withPadding(RSA::SIGNATURE_PSS); |
| 86 | +$sig = $private->sign("$header.$payload"); |
| 87 | +$sig = Strings::base64url_encode($sig); |
| 88 | +``` |
| 89 | + |
| 90 | +## PS384 |
| 91 | + |
| 92 | +```php |
| 93 | +assert($private instanceof \phpseclib3\Crypt\RSA); |
| 94 | + |
| 95 | +$private = $private->withHash('sha384')->withPadding(RSA::SIGNATURE_PSS); |
| 96 | +$sig = $private->sign("$header.$payload"); |
| 97 | +$sig = Strings::base64url_encode($sig); |
| 98 | +``` |
| 99 | + |
| 100 | +## PS512 |
| 101 | + |
| 102 | +```php |
| 103 | +assert($private instanceof \phpseclib3\Crypt\RSA); |
| 104 | + |
| 105 | +$private = $private->withHash('sha512')->withPadding(RSA::SIGNATURE_PSS); |
| 106 | +$sig = $private->sign("$header.$payload"); |
| 107 | +$sig = Strings::base64url_encode($sig); |
| 108 | +``` |
| 109 | + |
| 110 | +## EdDSA |
| 111 | + |
| 112 | +```php |
| 113 | +assert($private instanceof \phpseclib3\Crypt\EC); |
| 114 | +assert($private->getCurve() == 'Ed25519'); |
| 115 | + |
| 116 | +$sig = $private->sign("$header.$payload"); |
| 117 | +$sig = Strings::base64url_encode($sig); |
| 118 | +``` |
0 commit comments