Trait

pdi.jwt

JwtCore

Related Doc: package jwt

Permalink

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
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JwtCore
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def extractAlgorithm(header: H): Option[JwtAlgorithm]

    Permalink
    Attributes
    protected

  2. abstract def extractExpiration(claim: C): Option[Long]

    Permalink
    Attributes
    protected

  3. abstract def extractNotBefore(claim: C): Option[Long]

    Permalink
    Attributes
    protected

  4. abstract def parseClaim(claim: String): C

    Permalink
    Attributes
    protected

  5. abstract def parseHeader(header: String): H

    Permalink
    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  6. def decode(token: String, key: PublicKey): Try[C]

    Permalink

  7. def decode(token: String, key: PublicKey, options: JwtOptions): Try[C]

    Permalink

    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

  8. def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[C]

    Permalink

  9. def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[C]

    Permalink

    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

  10. def decode(token: String, key: SecretKey): Try[C]

    Permalink

  11. def decode(token: String, key: SecretKey, options: JwtOptions): Try[C]

    Permalink

    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

  12. def decode(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[C]

    Permalink

  13. def decode(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[C]

    Permalink

    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

  14. def decode(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm]): Try[C]

    Permalink

  15. def decode(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[C]

    Permalink

    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

  16. def decode(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[C]

    Permalink

  17. def decode(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[C]

    Permalink

    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

  18. def decode(token: String): Try[C]

    Permalink

  19. def decode(token: String, options: JwtOptions): Try[C]

    Permalink

    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

  20. def decodeAll(token: String, key: PublicKey): Try[(H, C, String)]

    Permalink

  21. def decodeAll(token: String, key: PublicKey, options: JwtOptions): Try[(H, C, String)]

    Permalink

    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

  22. def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[(H, C, String)]

    Permalink

  23. def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(H, C, String)]

    Permalink

    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

  24. def decodeAll(token: String, key: SecretKey): Try[(H, C, String)]

    Permalink

  25. def decodeAll(token: String, key: SecretKey, options: JwtOptions): Try[(H, C, String)]

    Permalink

    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

  26. def decodeAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(H, C, String)]

    Permalink

  27. def decodeAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(H, C, String)]

    Permalink

    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

  28. def decodeAll(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm]): Try[(H, C, String)]

    Permalink

  29. def decodeAll(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(H, C, String)]

    Permalink

    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

  30. def decodeAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(H, C, String)]

    Permalink

  31. def decodeAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(H, C, String)]

    Permalink

    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

  32. def decodeAll(token: String): Try[(H, C, String)]

    Permalink

  33. def decodeAll(token: String, options: JwtOptions): Try[(H, C, String)]

    Permalink

    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

  34. def decodeRaw(token: String, key: PublicKey): Try[String]

    Permalink

  35. def decodeRaw(token: String, key: PublicKey, options: JwtOptions): Try[String]

    Permalink

    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

  36. def decodeRaw(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[String]

    Permalink

  37. def decodeRaw(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[String]

    Permalink

    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

  38. def decodeRaw(token: String, key: SecretKey): Try[String]

    Permalink

  39. def decodeRaw(token: String, key: SecretKey, options: JwtOptions): Try[String]

    Permalink

    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

  40. def decodeRaw(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[String]

    Permalink

  41. def decodeRaw(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[String]

    Permalink

    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

  42. def decodeRaw(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm]): Try[String]

    Permalink

  43. def decodeRaw(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[String]

    Permalink

    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

  44. def decodeRaw(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[String]

    Permalink

  45. def decodeRaw(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[String]

    Permalink

    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

  46. def decodeRaw(token: String): Try[String]

    Permalink

  47. def decodeRaw(token: String, options: JwtOptions): Try[String]

    Permalink

    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

  48. def decodeRawAll(token: String, key: PublicKey): Try[(String, String, String)]

    Permalink

  49. def decodeRawAll(token: String, key: PublicKey, options: JwtOptions): Try[(String, String, String)]

    Permalink

  50. def decodeRawAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[(String, String, String)]

    Permalink

  51. def decodeRawAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(String, String, String)]

    Permalink

    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

  52. def decodeRawAll(token: String, key: SecretKey): Try[(String, String, String)]

    Permalink

  53. def decodeRawAll(token: String, key: SecretKey, options: JwtOptions): Try[(String, String, String)]

    Permalink

  54. def decodeRawAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]

    Permalink

  55. def decodeRawAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(String, String, String)]

    Permalink

    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

  56. def decodeRawAll(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm]): Try[(String, String, String)]

    Permalink

  57. def decodeRawAll(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(String, String, String)]

    Permalink

    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

  58. def decodeRawAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]

    Permalink

  59. def decodeRawAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(String, String, String)]

    Permalink

    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

  60. def decodeRawAll(token: String): Try[(String, String, String)]

    Permalink

  61. def decodeRawAll(token: String, options: JwtOptions): Try[(String, String, String)]

    Permalink

    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

  62. def encode(header: JwtHeader, claim: JwtClaim, key: Key): String

    Permalink

    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

  63. def encode(header: JwtHeader, claim: JwtClaim, key: String): String

    Permalink

    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

  64. def encode(header: JwtHeader, claim: JwtClaim): String

    Permalink

    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

  65. def encode(claim: JwtClaim, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String

    Permalink

    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

  66. def encode(claim: JwtClaim, key: SecretKey, algorithm: JwtHmacAlgorithm): String

    Permalink

    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

  67. def encode(claim: JwtClaim, key: String, algorithm: JwtAlgorithm): String

    Permalink

    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

  68. def encode(claim: JwtClaim): String

    Permalink

    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

  69. def encode(claim: String, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String

    Permalink

    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

  70. def encode(claim: String, key: SecretKey, algorithm: JwtHmacAlgorithm): String

    Permalink

    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

  71. def encode(claim: String, key: String, algorithm: JwtAlgorithm): String

    Permalink

    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

  72. def encode(claim: String): String

    Permalink

    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

  73. def encode(header: String, claim: String, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String

    Permalink

  74. def encode(header: String, claim: String, key: SecretKey, algorithm: JwtHmacAlgorithm): String

    Permalink

  75. def encode(header: String, claim: String, key: String, algorithm: JwtAlgorithm): String

    Permalink

    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

  76. def encode(header: String, claim: String): String

    Permalink

  77. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  78. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  79. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  80. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  81. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  82. def isValid(token: String, key: PublicKey): Boolean

    Permalink

  83. def isValid(token: String, key: PublicKey, options: JwtOptions): Boolean

    Permalink

  84. def isValid(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Boolean

    Permalink

  85. def isValid(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Boolean

    Permalink

    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

  86. def isValid(token: String, key: SecretKey): Boolean

    Permalink

  87. def isValid(token: String, key: SecretKey, options: JwtOptions): Boolean

    Permalink

  88. def isValid(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Boolean

    Permalink

  89. def isValid(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Boolean

    Permalink

    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

  90. def isValid(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm]): Boolean

    Permalink

  91. def isValid(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Boolean

    Permalink

    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

  92. def isValid(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Boolean

    Permalink

  93. def isValid(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Boolean

    Permalink

    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

  94. def isValid(token: String): Boolean

    Permalink

  95. def isValid(token: String, options: JwtOptions): Boolean

    Permalink

    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

  96. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  97. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  98. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  99. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  100. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  101. def validate(token: String, key: PublicKey): Unit

    Permalink

  102. def validate(token: String, key: PublicKey, options: JwtOptions): Unit

    Permalink

  103. def validate(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Unit

    Permalink

  104. def validate(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit

    Permalink

    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

  105. def validate(token: String, key: SecretKey): Unit

    Permalink

  106. def validate(token: String, key: SecretKey, options: JwtOptions): Unit

    Permalink

  107. def validate(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Unit

    Permalink

  108. def validate(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit

    Permalink

    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

  109. def validate(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm]): Unit

    Permalink

  110. def validate(token: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit

    Permalink

    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

  111. def validate(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Unit

    Permalink

  112. def validate(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit

    Permalink

    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

  113. def validate(token: String): Unit

    Permalink

  114. def validate(token: String, options: JwtOptions): Unit

    Permalink

    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

  115. def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit

    Permalink
    Attributes
    protected

  116. def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit

    Permalink
    Attributes
    protected

  117. def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: String, algorithms: ⇒ Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit

    Permalink
    Attributes
    protected

  118. def validate(header64: String, header: H, claim64: String, claim: C, signature: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit

    Permalink
    Attributes
    protected

  119. def validate(header64: String, header: H, claim64: String, claim: C, signature: String, options: JwtOptions, verify: (Array[Byte], Array[Byte], JwtAlgorithm) ⇒ Boolean): Unit

    Permalink
    Attributes
    protected

  120. def validate(header: H, claim: C, signature: String, options: JwtOptions): Unit

    Permalink
    Attributes
    protected

  121. def validateAsymmetricAlgorithm(algorithm: JwtAsymmetricAlgorithm, algorithms: Seq[JwtAsymmetricAlgorithm]): Boolean

    Permalink
    Attributes
    protected

  122. def validateHmacAlgorithm(algorithm: JwtHmacAlgorithm, algorithms: Seq[JwtHmacAlgorithm]): Boolean

    Permalink
    Attributes
    protected

  123. def validateTiming(claim: C, options: JwtOptions): Unit

    Permalink
    Attributes
    protected

  124. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  125. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  126. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped