JwtCore

trait JwtCore[H, C] extends AnyRef

Provide the main logic around Base64 encoding / decoding and signature using the correct algorithm. H and C types are respesctively the header type and the claim type. For the core project, they will be String but you are free to extend this trait using other types like JsObject or anything else.

Please, check implementations, like Jwt, for code samples.

H: the type of the extracted header from a JSON Web Token
C: the type of the extracted claim from a JSON Web Token

Linear Supertypes

AnyRef, Any

Known Subclasses

Jwt, Jwt

Ordering

Alphabetic
By Inheritance

Inherited

JwtCore
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def decode(token: String, key: PublicKey): Try[C]
def decode(token: String, key: PublicKey, options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, the claim of the token in its correct type
def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[C]
def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, the claim of the token in its correct type
def decode(token: String, key: SecretKey): Try[C]
def decode(token: String, key: SecretKey, options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, the claim of the token in its correct type
def decode(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[C]
def decode(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, the claim of the token in its correct type
def decode(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[C]
def decode(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, the claim of the token in its correct type
def decode(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[C]
def decode(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, the claim of the token in its correct type
def decode(token: String): Try[C]
def decode(token: String, options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
returns
if successful, the claim of the token in its correct type
def decodeAll(token: String, key: PublicKey): Try[(H, C, String)]
def decodeAll(token: String, key: PublicKey, options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[(H, C, String)]
def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String, key: SecretKey): Try[(H, C, String)]
def decodeAll(token: String, key: SecretKey, options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(H, C, String)]
def decodeAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[(H, C, String)]
def decodeAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(H, C, String)]
def decodeAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String): Try[(H, C, String)]
def decodeAll(token: String, options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeRaw(token: String, key: PublicKey): Try[String]
def decodeRaw(token: String, key: PublicKey, options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[String]
def decodeRaw(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String, key: SecretKey): Try[String]
def decodeRaw(token: String, key: SecretKey, options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[String]
def decodeRaw(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[String]
def decodeRaw(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[String]
def decodeRaw(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String): Try[String]
def decodeRaw(token: String, options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
returns
if successful, a string representing the JSON version of the claim
def decodeRawAll(token: String, key: PublicKey): Try[(String, String, String)]
def decodeRawAll(token: String, key: PublicKey, options: JwtOptions): Try[(String, String, String)]
def decodeRawAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[(String, String, String)]
def decodeRawAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(String, String, String)]
Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm
Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple of 3 strings, the header, the claim and the signature
def decodeRawAll(token: String, key: SecretKey): Try[(String, String, String)]
def decodeRawAll(token: String, key: SecretKey, options: JwtOptions): Try[(String, String, String)]
def decodeRawAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]
def decodeRawAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(String, String, String)]
Will try to decode a JSON Web Token to raw strings using a HMAC algorithm
Will try to decode a JSON Web Token to raw strings using a HMAC algorithm
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple of 3 strings, the header, the claim and the signature
def decodeRawAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[(String, String, String)]
def decodeRawAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(String, String, String)]
Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm
Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple of 3 strings, the header, the claim and the signature
def decodeRawAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]
def decodeRawAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(String, String, String)]
Will try to decode a JSON Web Token to raw strings using a HMAC algorithm
Will try to decode a JSON Web Token to raw strings using a HMAC algorithm
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple of 3 strings, the header, the claim and the signature
def decodeRawAll(token: String): Try[(String, String, String)]
def decodeRawAll(token: String, options: JwtOptions): Try[(String, String, String)]
Will try to decode a JSON Web Token to raw strings
Will try to decode a JSON Web Token to raw strings
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
returns
if successful, a tuple of 3 strings, the header, the claim and the signature
def encode(header: JwtHeader, claim: JwtClaim, key: Key): String
An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.
An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.
header
the header to stringify as a JSON before encoding the token
claim
the claim to stringify as a JSON before encoding the token
key
the secret key to use to sign the token (note that the algorithm will be deduced from the header)
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(header: JwtHeader, claim: JwtClaim, key: String): String
An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.
An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.
header
the header to stringify as a JSON before encoding the token
claim
the claim to stringify as a JSON before encoding the token
key
the secret key to use to sign the token (note that the algorithm will be deduced from the header)
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(header: JwtHeader, claim: JwtClaim): String
An alias to encode if you want to use case classes for the header and the claim rather than strings, they will just be stringified to JSON format.
An alias to encode if you want to use case classes for the header and the claim rather than strings, they will just be stringified to JSON format.
header
the header to stringify as a JSON before encoding the token
claim
the claim to stringify as a JSON before encoding the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: JwtClaim, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String
An alias to encode which will provide an automatically generated header and use the claim as a case class.
An alias to encode which will provide an automatically generated header and use the claim as a case class.
claim
the claim of the JSON Web Token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: JwtClaim, key: SecretKey, algorithm: JwtHmacAlgorithm): String
An alias to encode which will provide an automatically generated header and use the claim as a case class.
An alias to encode which will provide an automatically generated header and use the claim as a case class.
claim
the claim of the JSON Web Token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: JwtClaim, key: String, algorithm: JwtAlgorithm): String
An alias to encode which will provide an automatically generated header and use the claim as a case class.
An alias to encode which will provide an automatically generated header and use the claim as a case class.
claim
the claim of the JSON Web Token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: JwtClaim): String
An alias to encode which will provide an automatically generated header and setting both key and algorithm to None.
An alias to encode which will provide an automatically generated header and setting both key and algorithm to None.
claim
the claim of the JSON Web Token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: String, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
claim
a valid stringified JSON representing the claim of the token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: String, key: SecretKey, algorithm: JwtHmacAlgorithm): String
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
claim
a valid stringified JSON representing the claim of the token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: String, key: String, algorithm: JwtAlgorithm): String
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
claim
a valid stringified JSON representing the claim of the token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: String): String
An alias to encode which will provide an automatically generated header.
An alias to encode which will provide an automatically generated header.
claim
a valid stringified JSON representing the claim of the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(header: String, claim: String, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String
def encode(header: String, claim: String, key: SecretKey, algorithm: JwtHmacAlgorithm): String
def encode(header: String, claim: String, key: String, algorithm: JwtAlgorithm): String
Encode a JSON Web Token from its different parts.
Encode a JSON Web Token from its different parts. Both the header and the claim will be encoded to Base64 url-safe, then a signature will be eventually generated from it if you did pass a key and an algorithm, and finally, those three parts will be merged as a single string, using dots as separator.
header
a valid stringified JSON representing the header of the token
claim
a valid stringified JSON representing the claim of the token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(header: String, claim: String): String
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def isValid(token: String, key: PublicKey): Boolean
def isValid(token: String, key: PublicKey, options: JwtOptions): Boolean
def isValid(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Boolean
def isValid(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Boolean
An alias for isValid if you want to directly pass a string as the key
An alias for isValid if you want to directly pass a string as the key
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
a boolean value indicating if the token is valid or not
def isValid(token: String, key: SecretKey): Boolean
def isValid(token: String, key: SecretKey, options: JwtOptions): Boolean
def isValid(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Boolean
def isValid(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Boolean
An alias for isValid if you want to directly pass a string as the key
An alias for isValid if you want to directly pass a string as the key
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
a boolean value indicating if the token is valid or not
def isValid(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Boolean
def isValid(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Boolean
An alias for isValid if you want to directly pass a string as the key for asymmetric algorithms
An alias for isValid if you want to directly pass a string as the key for asymmetric algorithms
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
a boolean value indicating if the token is valid or not
def isValid(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Boolean
def isValid(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Boolean
An alias for isValid if you want to directly pass a string as the key for HMAC algorithms
An alias for isValid if you want to directly pass a string as the key for HMAC algorithms
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
a boolean value indicating if the token is valid or not
def isValid(token: String): Boolean
def isValid(token: String, options: JwtOptions): Boolean
Test if a token is valid.
Test if a token is valid. Doesn't throw any exception.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
returns
a boolean value indicating if the token is valid or not
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
def validate(token: String, key: PublicKey): Unit
def validate(token: String, key: PublicKey, options: JwtOptions): Unit
def validate(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Unit
def validate(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
An alias of validate in case you want to directly pass a string key.
An alias of validate in case you want to directly pass a string key.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
Exceptions thrown
IllegalArgumentException couldn't decode the token since it's not a valid base64 string
JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past
JwtLengthException the number of parts separated by dots is wrong
JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future
JwtValidationException default validation exception
def validate(token: String, key: SecretKey): Unit
def validate(token: String, key: SecretKey, options: JwtOptions): Unit
def validate(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Unit
def validate(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
An alias of validate in case you want to directly pass a string key.
An alias of validate in case you want to directly pass a string key.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
Exceptions thrown
IllegalArgumentException couldn't decode the token since it's not a valid base64 string
JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past
JwtLengthException the number of parts separated by dots is wrong
JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future
JwtValidationException default validation exception
def validate(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Unit
def validate(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
An alias of validate in case you want to directly pass a string key for asymmetric algorithms.
An alias of validate in case you want to directly pass a string key for asymmetric algorithms.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
Exceptions thrown
IllegalArgumentException couldn't decode the token since it's not a valid base64 string
JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past
JwtLengthException the number of parts separated by dots is wrong
JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future
JwtValidationException default validation exception
def validate(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Unit
def validate(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
An alias of validate in case you want to directly pass a string key for HMAC algorithms.
An alias of validate in case you want to directly pass a string key for HMAC algorithms.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
Exceptions thrown
IllegalArgumentException couldn't decode the token since it's not a valid base64 string
JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past
JwtLengthException the number of parts separated by dots is wrong
JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future
JwtValidationException default validation exception
def validate(token: String): Unit
def validate(token: String, options: JwtOptions): Unit
Valid a token: doesn't return anything but will thrown exceptions if there are any errors.
Valid a token: doesn't return anything but will thrown exceptions if there are any errors.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
Exceptions thrown
IllegalArgumentException couldn't decode the token since it's not a valid base64 string
JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past
JwtLengthException the number of parts separated by dots is wrong
JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future
JwtValidationException default validation exception
def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
Attributes
protected
def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
Attributes
protected
def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
Attributes
protected
def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
Attributes
protected
def validate(header64: String, header: H, claim64: String, claim: C, signature: String, options: JwtOptions, verify: (Array[Byte], Array[Byte], JwtAlgorithm) => Boolean): Unit
Attributes
protected
def validate(header: H, claim: C, signature: String, options: JwtOptions): Unit
Attributes
protected
def validateAsymmetricAlgorithm(algorithm: JwtAsymmetricAlgorithm, algorithms: Seq[JwtAsymmetricAlgorithm]): Boolean
Attributes
protected
def validateHmacAlgorithm(algorithm: JwtHmacAlgorithm, algorithms: Seq[JwtHmacAlgorithm]): Boolean
Attributes
protected
def validateTiming(claim: C, options: JwtOptions): Try[Unit]
Attributes
protected
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Ungrouped

abstract def extractAlgorithm(header: H): Option[JwtAlgorithm]
Attributes
protected
abstract def extractExpiration(claim: C): Option[Long]
Attributes
protected
abstract def extractNotBefore(claim: C): Option[Long]
Attributes
protected
abstract def parseClaim(claim: String): C
Attributes
protected
abstract def parseHeader(header: String): H
Attributes
protected
final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def decode(token: String, key: PublicKey): Try[C]
def decode(token: String, key: PublicKey, options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, the claim of the token in its correct type
def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[C]
def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, the claim of the token in its correct type
def decode(token: String, key: SecretKey): Try[C]
def decode(token: String, key: SecretKey, options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, the claim of the token in its correct type
def decode(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[C]
def decode(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, the claim of the token in its correct type
def decode(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[C]
def decode(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, the claim of the token in its correct type
def decode(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[C]
def decode(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, the claim of the token in its correct type
def decode(token: String): Try[C]
def decode(token: String, options: JwtOptions): Try[C]
Same as decodeAll but only return the claim
Same as decodeAll but only return the claim
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
returns
if successful, the claim of the token in its correct type
def decodeAll(token: String, key: PublicKey): Try[(H, C, String)]
def decodeAll(token: String, key: PublicKey, options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[(H, C, String)]
def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String, key: SecretKey): Try[(H, C, String)]
def decodeAll(token: String, key: SecretKey, options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(H, C, String)]
def decodeAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[(H, C, String)]
def decodeAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(H, C, String)]
def decodeAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeAll(token: String): Try[(H, C, String)]
def decodeAll(token: String, options: JwtOptions): Try[(H, C, String)]
Same as decodeRawAll but return the real header and claim types
Same as decodeRawAll but return the real header and claim types
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
returns
if successful, a tuple representing the header, the claim and eventually the signature
def decodeRaw(token: String, key: PublicKey): Try[String]
def decodeRaw(token: String, key: PublicKey, options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[String]
def decodeRaw(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String, key: SecretKey): Try[String]
def decodeRaw(token: String, key: SecretKey, options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[String]
def decodeRaw(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[String]
def decodeRaw(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[String]
def decodeRaw(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a string representing the JSON version of the claim
def decodeRaw(token: String): Try[String]
def decodeRaw(token: String, options: JwtOptions): Try[String]
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
Same as decodeRawAll but only return the claim (you only care about the claim most of the time)
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
returns
if successful, a string representing the JSON version of the claim
def decodeRawAll(token: String, key: PublicKey): Try[(String, String, String)]
def decodeRawAll(token: String, key: PublicKey, options: JwtOptions): Try[(String, String, String)]
def decodeRawAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[(String, String, String)]
def decodeRawAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(String, String, String)]
Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm
Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple of 3 strings, the header, the claim and the signature
def decodeRawAll(token: String, key: SecretKey): Try[(String, String, String)]
def decodeRawAll(token: String, key: SecretKey, options: JwtOptions): Try[(String, String, String)]
def decodeRawAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]
def decodeRawAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(String, String, String)]
Will try to decode a JSON Web Token to raw strings using a HMAC algorithm
Will try to decode a JSON Web Token to raw strings using a HMAC algorithm
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple of 3 strings, the header, the claim and the signature
def decodeRawAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[(String, String, String)]
def decodeRawAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(String, String, String)]
Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm
Will try to decode a JSON Web Token to raw strings using an asymmetric algorithm
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple of 3 strings, the header, the claim and the signature
def decodeRawAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]
def decodeRawAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(String, String, String)]
Will try to decode a JSON Web Token to raw strings using a HMAC algorithm
Will try to decode a JSON Web Token to raw strings using a HMAC algorithm
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
if successful, a tuple of 3 strings, the header, the claim and the signature
def decodeRawAll(token: String): Try[(String, String, String)]
def decodeRawAll(token: String, options: JwtOptions): Try[(String, String, String)]
Will try to decode a JSON Web Token to raw strings
Will try to decode a JSON Web Token to raw strings
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
returns
if successful, a tuple of 3 strings, the header, the claim and the signature
def encode(header: JwtHeader, claim: JwtClaim, key: Key): String
An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.
An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.
header
the header to stringify as a JSON before encoding the token
claim
the claim to stringify as a JSON before encoding the token
key
the secret key to use to sign the token (note that the algorithm will be deduced from the header)
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(header: JwtHeader, claim: JwtClaim, key: String): String
An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.
An alias of encode if you only want to pass a string as the key, the algorithm will be deduced from the header.
header
the header to stringify as a JSON before encoding the token
claim
the claim to stringify as a JSON before encoding the token
key
the secret key to use to sign the token (note that the algorithm will be deduced from the header)
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(header: JwtHeader, claim: JwtClaim): String
An alias to encode if you want to use case classes for the header and the claim rather than strings, they will just be stringified to JSON format.
An alias to encode if you want to use case classes for the header and the claim rather than strings, they will just be stringified to JSON format.
header
the header to stringify as a JSON before encoding the token
claim
the claim to stringify as a JSON before encoding the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: JwtClaim, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String
An alias to encode which will provide an automatically generated header and use the claim as a case class.
An alias to encode which will provide an automatically generated header and use the claim as a case class.
claim
the claim of the JSON Web Token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: JwtClaim, key: SecretKey, algorithm: JwtHmacAlgorithm): String
An alias to encode which will provide an automatically generated header and use the claim as a case class.
An alias to encode which will provide an automatically generated header and use the claim as a case class.
claim
the claim of the JSON Web Token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: JwtClaim, key: String, algorithm: JwtAlgorithm): String
An alias to encode which will provide an automatically generated header and use the claim as a case class.
An alias to encode which will provide an automatically generated header and use the claim as a case class.
claim
the claim of the JSON Web Token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: JwtClaim): String
An alias to encode which will provide an automatically generated header and setting both key and algorithm to None.
An alias to encode which will provide an automatically generated header and setting both key and algorithm to None.
claim
the claim of the JSON Web Token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: String, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
claim
a valid stringified JSON representing the claim of the token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: String, key: SecretKey, algorithm: JwtHmacAlgorithm): String
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
claim
a valid stringified JSON representing the claim of the token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: String, key: String, algorithm: JwtAlgorithm): String
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
An alias to encode which will provide an automatically generated header and allowing you to get rid of Option for the key and the algorithm.
claim
a valid stringified JSON representing the claim of the token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(claim: String): String
An alias to encode which will provide an automatically generated header.
An alias to encode which will provide an automatically generated header.
claim
a valid stringified JSON representing the claim of the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(header: String, claim: String, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String
def encode(header: String, claim: String, key: SecretKey, algorithm: JwtHmacAlgorithm): String
def encode(header: String, claim: String, key: String, algorithm: JwtAlgorithm): String
Encode a JSON Web Token from its different parts.
Encode a JSON Web Token from its different parts. Both the header and the claim will be encoded to Base64 url-safe, then a signature will be eventually generated from it if you did pass a key and an algorithm, and finally, those three parts will be merged as a single string, using dots as separator.
header
a valid stringified JSON representing the header of the token
claim
a valid stringified JSON representing the claim of the token
key
the key that will be used to check the token signature
algorithm
the algorithm to sign the token
returns
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
def encode(header: String, claim: String): String
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def isValid(token: String, key: PublicKey): Boolean
def isValid(token: String, key: PublicKey, options: JwtOptions): Boolean
def isValid(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Boolean
def isValid(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Boolean
An alias for isValid if you want to directly pass a string as the key
An alias for isValid if you want to directly pass a string as the key
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
a boolean value indicating if the token is valid or not
def isValid(token: String, key: SecretKey): Boolean
def isValid(token: String, key: SecretKey, options: JwtOptions): Boolean
def isValid(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Boolean
def isValid(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Boolean
An alias for isValid if you want to directly pass a string as the key
An alias for isValid if you want to directly pass a string as the key
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
a boolean value indicating if the token is valid or not
def isValid(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Boolean
def isValid(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Boolean
An alias for isValid if you want to directly pass a string as the key for asymmetric algorithms
An alias for isValid if you want to directly pass a string as the key for asymmetric algorithms
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
a boolean value indicating if the token is valid or not
def isValid(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Boolean
def isValid(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Boolean
An alias for isValid if you want to directly pass a string as the key for HMAC algorithms
An alias for isValid if you want to directly pass a string as the key for HMAC algorithms
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
returns
a boolean value indicating if the token is valid or not
def isValid(token: String): Boolean
def isValid(token: String, options: JwtOptions): Boolean
Test if a token is valid.
Test if a token is valid. Doesn't throw any exception.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
returns
a boolean value indicating if the token is valid or not
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
def validate(token: String, key: PublicKey): Unit
def validate(token: String, key: PublicKey, options: JwtOptions): Unit
def validate(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Unit
def validate(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
An alias of validate in case you want to directly pass a string key.
An alias of validate in case you want to directly pass a string key.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
Exceptions thrown
IllegalArgumentException couldn't decode the token since it's not a valid base64 string
JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past
JwtLengthException the number of parts separated by dots is wrong
JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future
JwtValidationException default validation exception
def validate(token: String, key: SecretKey): Unit
def validate(token: String, key: SecretKey, options: JwtOptions): Unit
def validate(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Unit
def validate(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
An alias of validate in case you want to directly pass a string key.
An alias of validate in case you want to directly pass a string key.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
Exceptions thrown
IllegalArgumentException couldn't decode the token since it's not a valid base64 string
JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past
JwtLengthException the number of parts separated by dots is wrong
JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future
JwtValidationException default validation exception
def validate(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Unit
def validate(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
An alias of validate in case you want to directly pass a string key for asymmetric algorithms.
An alias of validate in case you want to directly pass a string key for asymmetric algorithms.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
Exceptions thrown
IllegalArgumentException couldn't decode the token since it's not a valid base64 string
JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past
JwtLengthException the number of parts separated by dots is wrong
JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future
JwtValidationException default validation exception
def validate(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Unit
def validate(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
An alias of validate in case you want to directly pass a string key for HMAC algorithms.
An alias of validate in case you want to directly pass a string key for HMAC algorithms.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
key
the key that will be used to check the token signature
algorithms
a list of possible algorithms that the token can use. See Security concerns for more infos.
Exceptions thrown
IllegalArgumentException couldn't decode the token since it's not a valid base64 string
JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past
JwtLengthException the number of parts separated by dots is wrong
JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future
JwtValidationException default validation exception
def validate(token: String): Unit
def validate(token: String, options: JwtOptions): Unit
Valid a token: doesn't return anything but will thrown exceptions if there are any errors.
Valid a token: doesn't return anything but will thrown exceptions if there are any errors.
token
a JSON Web Token as a Base64 url-safe encoded String which can be used inside an HTTP header
Exceptions thrown
IllegalArgumentException couldn't decode the token since it's not a valid base64 string
JwtExpirationException the token isn't valid anymore because its expiration attribute is in the past
JwtLengthException the number of parts separated by dots is wrong
JwtNotBeforeException the token isn't valid yet because its notBefore attribute is in the future
JwtValidationException default validation exception
def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
Attributes
protected
def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
Attributes
protected
def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
Attributes
protected
def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
Attributes
protected
def validate(header64: String, header: H, claim64: String, claim: C, signature: String, options: JwtOptions, verify: (Array[Byte], Array[Byte], JwtAlgorithm) => Boolean): Unit
Attributes
protected
def validate(header: H, claim: C, signature: String, options: JwtOptions): Unit
Attributes
protected
def validateAsymmetricAlgorithm(algorithm: JwtAsymmetricAlgorithm, algorithms: Seq[JwtAsymmetricAlgorithm]): Boolean
Attributes
protected
def validateHmacAlgorithm(algorithm: JwtHmacAlgorithm, algorithms: Seq[JwtHmacAlgorithm]): Boolean
Attributes
protected
def validateTiming(claim: C, options: JwtOptions): Try[Unit]
Attributes
protected
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

JwtCore

trait JwtCore[H, C] extends AnyRef

Abstract Value Members

Concrete Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

Packages

JwtCore

trait JwtCore[H, C] extends AnyRef

Abstract Value Members

Concrete Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Ungrouped

JwtCore