jwt
Methods Summary
Type | Name | Summary |
---|---|---|
Builder to create a new Algorithm instance using SHA256withECDSA.. | ||
Builder to create a new Algorithm instance using SHA256withECDSA.. | ||
Builder to create a new Algorithm instance using SHA256withECDSA.. | ||
Builder to create a new Algorithm instance using SHA256withECDSA.. | ||
Builder to create a new Algorithm instance using SHA384withECDSA.. | ||
Builder to create a new Algorithm instance using SHA384withECDSA.. | ||
Builder to create a new Algorithm instance using SHA384withECDSA.. | ||
Builder to create a new Algorithm instance using SHA384withECDSA.. | ||
Builder to create a new Algorithm instance using SHA512withECDSA.. | ||
Builder to create a new Algorithm instance using SHA512withECDSA.. | ||
Builder to create a new Algorithm instance using SHA512withECDSA.. | ||
Builder to create a new Algorithm instance using SHA512withECDSA.. | ||
Create a new Algorithm instance using HmacSHA256.. | ||
Create a new HmacSHA256 Algorithm using the specified password.. | ||
Create a new Algorithm instance using HmacSHA384.. | ||
Create a new HmacSHA384 Algorithm using the specified password.. | ||
Create a new Algorithm instance using HmacSHA512.. | ||
Create a new Algorithm instance using HmacSHA512.. | ||
Builder to create an algorithm instance based on a Json Web Key Set (JWKS) url.. | ||
Builder to create a new Algorithm instance using SHA256withRSA.. | ||
Builder to create a new Algorithm instance using SHA256withRSA.. | ||
Builder to create a new Algorithm instance using SHA256withRSA.. | ||
Builder to create a new Algorithm instance using SHA256withRSA.. | ||
Builder to create a new Algorithm instance using SHA384withRSA.. | ||
Builder to create a new Algorithm instance using SHA384withRSA.. | ||
Builder to create a new Algorithm instance using SHA384withRSA.. | ||
Builder to create a new Algorithm instance using SHA384withRSA.. | ||
Builder to create a new Algorithm instance using SHA512withRSA.. | ||
Builder to create a new Algorithm instance using SHA512withRSA.. | ||
Builder to create a new Algorithm instance using SHA512withRSA.. | ||
Builder to create a new Algorithm instance using SHA512withRSA.. | ||
Returns a JSON Web Token token builder.. | ||
Create a JSON Web Token for the given payload that is signed with the (shared) secret key 'jwt.. | ||
Create a JSON Web Token for the given payload that is signed with the HS256 algorithm and the (shared) secret key 'jwt.. | ||
Verify a JSON Web Token with the HS256 algorithm and the (shared) secret key 'jwt.. | ||
Verify a JSON Web Token with a specific algorithm.. |
Methods Details
ES256(publicKey)
Builder to create a new Algorithm instance using SHA256withECDSA. Tokens specify this as "ES256".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens)
Returns Algorithm an algorithm builder used to sign or verify JSON Web Tokens.
Sample
ES256(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA256withECDSA. Tokens specify this as "ES256".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens) Array privateKey a byte array representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
ES256(publicKey)
Builder to create a new Algorithm instance using SHA256withECDSA. Tokens specify this as "ES256".
Parameters String publicKey a String representing the publicKey (mostly used to verify tokens)
Returns Algorithm an algorithm builder used to sign or verify JSON Web Tokens.
Sample
ES256(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA256withECDSA. Tokens specify this as "ES256".
Parameters String publicKey a String representing the publicKey (mostly used to verify tokens) String privateKey a String representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
ES384(publicKey)
Builder to create a new Algorithm instance using SHA384withECDSA. Tokens specify this as "ES384".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens)
Returns Algorithm an algorithm builder used to sign or verify JSON Web Tokens.
Sample
ES384(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA384withECDSA. Tokens specify this as "ES384".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens) Array privateKey a byte array representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
ES384(publicKey)
Builder to create a new Algorithm instance using SHA384withECDSA. Tokens specify this as "ES384".
Parameters String publicKey a String representing the publicKey (mostly used to verify tokens)
Returns Algorithm an algorithm builder used to sign or verify JSON Web Tokens.
Sample
ES384(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA384withECDSA. Tokens specify this as "ES384".
Parameters String publicKey a String representing the publicKey (mostly used to verify tokens) String privateKey a String representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
ES512(publicKey)
Builder to create a new Algorithm instance using SHA512withECDSA. Tokens specify this as "ES512".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens)
Returns Algorithm an algorithm builder used to sign or verify JSON Web Tokens.
Sample
ES512(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA512withECDSA. Tokens specify this as "ES512".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens) Array privateKey a byte array representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
ES512(publicKey)
Builder to create a new Algorithm instance using SHA512withECDSA. Tokens specify this as "ES512".
Parameters String publicKey a String representing the publicKey
Returns Algorithm an algorithm builder used to sign or verify JSON Web Tokens.
Sample
ES512(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA512withECDSA. Tokens specify this as "ES512".
Parameters String publicKey a String representing the publicKey (mostly used to verify tokens) String privateKey a String representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
HS256()
Create a new Algorithm instance using HmacSHA256. Tokens specify this as "HS256". The password used to configure the algorithm is the (shared) secret key 'jwt.secret.password' that has to be configured on the admin page for this plugin.
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
HS256(password)
Create a new HmacSHA256 Algorithm using the specified password. Tokens specify this as "HS256".
Parameters String password the secret used to encrypt and decrypt the tokens
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
HS384()
Create a new Algorithm instance using HmacSHA384. Tokens specify this as "HS384". The password used to configure the algorithm is the (shared) secret key 'jwt.secret.password' that has to be configured on the admin page for this plugin.
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
HS384(password)
Create a new HmacSHA384 Algorithm using the specified password. Tokens specify this as "HS384".
Parameters String password the secret used to encrypt and decrypt the tokens
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
HS512()
Create a new Algorithm instance using HmacSHA512. Tokens specify this as "HS512". The password used to configure the algorithm is the (shared) secret key 'jwt.secret.password' that has to be configured on the admin page for this plugin.
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
HS512(password)
Create a new Algorithm instance using HmacSHA512. Tokens specify this as "HS512".
Parameters String password the secret used to encrypt and decrypt the tokens
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
JWK(url)
Builder to create an algorithm instance based on a Json Web Key Set (JWKS) url. Please note that the returned algorithm can only be used to verify tokens.
Parameters String url the jwks url
Returns Algorithm an algorithm which can only be used to VERIFY Json Web Tokens.
Sample
RSA256(publicKey)
Builder to create a new Algorithm instance using SHA256withRSA. Tokens specify this as "RS256".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens)
Returns Algorithm an algorithm used to sign or verify Json Web Tokens.
Sample
RSA256(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA256withRSA. Tokens specify this as "RS256".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens) Array privateKey a byte array representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify Json Web Tokens.
Sample
RSA256(publicKey)
Builder to create a new Algorithm instance using SHA256withRSA. Tokens specify this as "RS256".
Parameters String publicKey a String representing the publicKey (mostly used to verify tokens)
Returns Algorithm an algorithm used to sign or verify Json Web Tokens.
Sample
RSA256(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA256withRSA. Tokens specify this as "RS256".
Parameters String publicKey a String representing the publicKey (mostly used to verify tokens) String privateKey a String representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify Json Web Tokens.
Sample
RSA384(publicKey)
Builder to create a new Algorithm instance using SHA384withRSA. Tokens specify this as "RS384".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
RSA384(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA384withRSA. Tokens specify this as "RS384".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens) Array privateKey a byte array representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
RSA384(publicKey)
Builder to create a new Algorithm instance using SHA384withRSA. Tokens specify this as "RS384".
Parameters String publicKey a String representing the publicKey (mostly used to verify tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
RSA384(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA384withRSA. Tokens specify this as "RS384".
Parameters String publicKey a String representing the publicKey (mostly used to verify tokens) String privateKey a String representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
RSA512(publicKey)
Builder to create a new Algorithm instance using SHA512withRSA. Tokens specify this as "RS512".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
RSA512(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA512withRSA. Tokens specify this as "RS512".
Parameters Array publicKey a byte array representing the publicKey (mostly used to verify tokens) Array privateKey a byte array representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
RSA512(publicKey)
Builder to create a new Algorithm instance using SHA512withRSA. Tokens specify this as "RS512".
Parameters String publicKey a String representing the publicKey (mostly used to verify tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
RSA512(publicKey, privateKey)
Builder to create a new Algorithm instance using SHA512withRSA. Tokens specify this as "RS512".
Parameters String publicKey a String representing the publicKey (mostly used to verify tokens) String privateKey a String representing the privateKey (mostly used to create tokens)
Returns Algorithm an algorithm used to sign or verify JSON Web Tokens.
Sample
builder()
Returns a JSON Web Token token builder.
Returns Builder an object which creates a jwt token.
Sample
create(payload)
Create a JSON Web Token for the given payload that is signed with the (shared) secret key 'jwt.secret.password'. The 'jwt.secret.password' plugin property has to be configured on the admin page. The payload can be for example a user:username of the current user, so that with this token if it verifies with the same secret key you can assume it is the same user that wants to login. This is a shorthand method of the #builder() method with a HS256 algorithm.
Parameters Object payload a json containing the data, e.g. {'some': 'data', 'somemore': 'data2'}
Returns String a string representing the encrypted data or null if the token cannot be generated
Sample
create(payload, expiresAt)
Create a JSON Web Token for the given payload that is signed with the HS256 algorithm and the (shared) secret key 'jwt.secret.password'. The 'jwt.secret.password' plugin property has to be configured on the admin page. The payload can be for example a user:username of the current user, so that with this token if it verifies with the same secret key you can assume it is the same user that wants to login. The expiresAt makes sure this token is only valid until that date. This is a shorthand method of the #builder() method with a HS256 algorithm.
Parameters Object payload a json containing the data, e.g. {'some': 'data', 'somemore': 'data2'} Date expiresAt the date when the created token expires, after the expired date the token won't be verified
Returns String a string representing the encrypted data or null if the token cannot be generated
Sample
verify(token)
Verify a JSON Web Token with the HS256 algorithm and the (shared) secret key 'jwt.secret.password'. The 'jwt.secret.password' plugin property has to be configured on the admin page. This will only verify and return the payload that was given if the token was created with the HS256 algorithm and the 'jwt.secret.password'. Will also return null if the token passed its expire date.
Parameters String token a JSON Web Token
Returns Object the payload or null if the token can't be verified
Sample
verify(token, algorithm)
Verify a JSON Web Token with a specific algorithm. The token could be external or created with the #builder() method.
This will only verify and return the payload that was given if the token could be verified with the provided algorithm. Will also return null if the token passed its expire date.
Parameters String token a JSON Web Token Algorithm algorithm an algorithm used to verify the signature
Returns Object the payload or null if the token can't be verified
Sample
Last updated