object Jwt extends Jwt

Test implementation of JwtCore using only Strings. Most of the time, you should use a lib implementing JSON and shouldn't be using this object. But just in case you need pure Scala support, here it is.

To see a full list of samples, check the online documentation.

Warning: since there is no JSON support in Scala, this object doesn't have any way to parse a JSON string as an AST, so it only uses regex with all the limitations it implies. Try not to use keys like exp and nbf in sub-objects of the claim. For example, if you try to use the following claim: {"user":{"exp":1},"exp":1300819380}, it should be correct but it will fail because the regex extracting the expiration will return 1 instead of 1300819380. Sorry about that.

Source
Jwt.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Jwt
  2. Jwt
  3. JwtCore
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(clock: Clock): Jwt
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def claimToJson(claim: JwtClaim): String
    Attributes
    protected
    Definition Classes
    Jwt
  7. def clearAll(json: String): String
    Attributes
    protected
    Definition Classes
    Jwt
  8. def clearEnd(json: String): String
    Attributes
    protected
    Definition Classes
    Jwt
  9. def clearMiddle(json: String): String
    Attributes
    protected
    Definition Classes
    Jwt
  10. def clearRegex(json: String, regex: Regex): String
    Attributes
    protected
    Definition Classes
    Jwt
  11. def clearStart(json: String): String
    Attributes
    protected
    Definition Classes
    Jwt
  12. val clock: Clock
    Definition Classes
    JwtJwtCore
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  14. def decode(token: String, key: PublicKey): Try[JwtClaim]
    Definition Classes
    JwtCore
  15. def decode(token: String, key: PublicKey, options: JwtOptions): Try[JwtClaim]

    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

    Definition Classes
    JwtCore
  16. def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[JwtClaim]
    Definition Classes
    JwtCore
  17. def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[JwtClaim]

    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

    Definition Classes
    JwtCore
  18. def decode(token: String, key: SecretKey): Try[JwtClaim]
    Definition Classes
    JwtCore
  19. def decode(token: String, key: SecretKey, options: JwtOptions): Try[JwtClaim]

    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

    Definition Classes
    JwtCore
  20. def decode(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[JwtClaim]
    Definition Classes
    JwtCore
  21. def decode(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[JwtClaim]

    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

    Definition Classes
    JwtCore
  22. def decode(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[JwtClaim]
    Definition Classes
    JwtCore
  23. def decode(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[JwtClaim]

    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

    Definition Classes
    JwtCore
  24. def decode(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[JwtClaim]
    Definition Classes
    JwtCore
  25. def decode(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[JwtClaim]

    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

    Definition Classes
    JwtCore
  26. def decode(token: String): Try[JwtClaim]
    Definition Classes
    JwtCore
  27. def decode(token: String, options: JwtOptions): Try[JwtClaim]

    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

    Definition Classes
    JwtCore
  28. def decodeAll(token: String, key: PublicKey): Try[(JwtHeader, JwtClaim, String)]
    Definition Classes
    JwtCore
  29. def decodeAll(token: String, key: PublicKey, options: JwtOptions): Try[(JwtHeader, JwtClaim, 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

    Definition Classes
    JwtCore
  30. def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[(JwtHeader, JwtClaim, String)]
    Definition Classes
    JwtCore
  31. def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(JwtHeader, JwtClaim, 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

    Definition Classes
    JwtCore
  32. def decodeAll(token: String, key: SecretKey): Try[(JwtHeader, JwtClaim, String)]
    Definition Classes
    JwtCore
  33. def decodeAll(token: String, key: SecretKey, options: JwtOptions): Try[(JwtHeader, JwtClaim, 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

    Definition Classes
    JwtCore
  34. def decodeAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(JwtHeader, JwtClaim, String)]
    Definition Classes
    JwtCore
  35. def decodeAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(JwtHeader, JwtClaim, 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

    Definition Classes
    JwtCore
  36. def decodeAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[(JwtHeader, JwtClaim, String)]
    Definition Classes
    JwtCore
  37. def decodeAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Try[(JwtHeader, JwtClaim, 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

    Definition Classes
    JwtCore
  38. def decodeAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(JwtHeader, JwtClaim, String)]
    Definition Classes
    JwtCore
  39. def decodeAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Try[(JwtHeader, JwtClaim, 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

    Definition Classes
    JwtCore
  40. def decodeAll(token: String): Try[(JwtHeader, JwtClaim, String)]
    Definition Classes
    JwtCore
  41. def decodeAll(token: String, options: JwtOptions): Try[(JwtHeader, JwtClaim, 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

    Definition Classes
    JwtCore
  42. def decodeRaw(token: String, key: PublicKey): Try[String]
    Definition Classes
    JwtCore
  43. 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

    Definition Classes
    JwtCore
  44. def decodeRaw(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[String]
    Definition Classes
    JwtCore
  45. 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

    Definition Classes
    JwtCore
  46. def decodeRaw(token: String, key: SecretKey): Try[String]
    Definition Classes
    JwtCore
  47. 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

    Definition Classes
    JwtCore
  48. def decodeRaw(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[String]
    Definition Classes
    JwtCore
  49. 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

    Definition Classes
    JwtCore
  50. def decodeRaw(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[String]
    Definition Classes
    JwtCore
  51. 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

    Definition Classes
    JwtCore
  52. def decodeRaw(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[String]
    Definition Classes
    JwtCore
  53. 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

    Definition Classes
    JwtCore
  54. def decodeRaw(token: String): Try[String]
    Definition Classes
    JwtCore
  55. 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

    Definition Classes
    JwtCore
  56. def decodeRawAll(token: String, key: PublicKey): Try[(String, String, String)]
    Definition Classes
    JwtCore
  57. def decodeRawAll(token: String, key: PublicKey, options: JwtOptions): Try[(String, String, String)]
    Definition Classes
    JwtCore
  58. def decodeRawAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Try[(String, String, String)]
    Definition Classes
    JwtCore
  59. 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

    Definition Classes
    JwtCore
  60. def decodeRawAll(token: String, key: SecretKey): Try[(String, String, String)]
    Definition Classes
    JwtCore
  61. def decodeRawAll(token: String, key: SecretKey, options: JwtOptions): Try[(String, String, String)]
    Definition Classes
    JwtCore
  62. def decodeRawAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]
    Definition Classes
    JwtCore
  63. 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

    Definition Classes
    JwtCore
  64. def decodeRawAll(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Try[(String, String, String)]
    Definition Classes
    JwtCore
  65. 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

    Definition Classes
    JwtCore
  66. def decodeRawAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]
    Definition Classes
    JwtCore
  67. 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

    Definition Classes
    JwtCore
  68. def decodeRawAll(token: String): Try[(String, String, String)]
    Definition Classes
    JwtCore
  69. 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

    Definition Classes
    JwtCore
  70. 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

    Definition Classes
    JwtCore
  71. 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

    Definition Classes
    JwtCore
  72. 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

    Definition Classes
    JwtCore
  73. 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

    Definition Classes
    JwtCore
  74. 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

    Definition Classes
    JwtCore
  75. 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

    Definition Classes
    JwtCore
  76. 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

    Definition Classes
    JwtCore
  77. 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

    Definition Classes
    JwtCore
  78. 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

    Definition Classes
    JwtCore
  79. 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

    Definition Classes
    JwtCore
  80. 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

    Definition Classes
    JwtCore
  81. def encode(header: String, claim: String, key: PrivateKey, algorithm: JwtAsymmetricAlgorithm): String
    Definition Classes
    JwtCore
  82. def encode(header: String, claim: String, key: SecretKey, algorithm: JwtHmacAlgorithm): String
    Definition Classes
    JwtCore
  83. 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

    Definition Classes
    JwtCore
  84. def encode(header: String, claim: String): String
    Definition Classes
    JwtCore
  85. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  86. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  87. def extractAlgorithm(header: JwtHeader): Option[JwtAlgorithm]
    Attributes
    protected
    Definition Classes
    JwtJwtCore
  88. def extractAlgorithm(header: String): Option[JwtAlgorithm]
    Attributes
    protected
    Definition Classes
    Jwt
  89. def extractExpiration(claim: JwtClaim): Option[Long]
    Attributes
    protected
    Definition Classes
    JwtJwtCore
  90. def extractExpiration(claim: String): Option[Long]
    Attributes
    protected
    Definition Classes
    Jwt
  91. def extractIssuedAt(claim: String): Option[Long]
    Attributes
    protected
    Definition Classes
    Jwt
  92. def extractIssuer(claim: String): Option[String]
    Attributes
    protected
    Definition Classes
    Jwt
  93. def extractJwtId(claim: String): Option[String]
    Attributes
    protected
    Definition Classes
    Jwt
  94. def extractNotBefore(claim: JwtClaim): Option[Long]
    Attributes
    protected
    Definition Classes
    JwtJwtCore
  95. def extractNotBefore(claim: String): Option[Long]
    Attributes
    protected
    Definition Classes
    Jwt
  96. def extractSubject(claim: String): Option[String]
    Attributes
    protected
    Definition Classes
    Jwt
  97. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  98. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  99. def headerToJson(header: JwtHeader): String
    Attributes
    protected
    Definition Classes
    Jwt
  100. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  101. def isValid(token: String, key: PublicKey): Boolean
    Definition Classes
    JwtCore
  102. def isValid(token: String, key: PublicKey, options: JwtOptions): Boolean
    Definition Classes
    JwtCore
  103. def isValid(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Boolean
    Definition Classes
    JwtCore
  104. 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

    Definition Classes
    JwtCore
  105. def isValid(token: String, key: SecretKey): Boolean
    Definition Classes
    JwtCore
  106. def isValid(token: String, key: SecretKey, options: JwtOptions): Boolean
    Definition Classes
    JwtCore
  107. def isValid(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Boolean
    Definition Classes
    JwtCore
  108. 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

    Definition Classes
    JwtCore
  109. def isValid(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Boolean
    Definition Classes
    JwtCore
  110. 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

    Definition Classes
    JwtCore
  111. def isValid(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Boolean
    Definition Classes
    JwtCore
  112. 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

    Definition Classes
    JwtCore
  113. def isValid(token: String): Boolean
    Definition Classes
    JwtCore
  114. 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

    Definition Classes
    JwtCore
  115. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  116. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  117. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  118. def parseClaim(claim: String): JwtClaim
    Attributes
    protected
    Definition Classes
    JwtJwtCore
  119. def parseHeader(header: String): JwtHeader
    Attributes
    protected
    Definition Classes
    JwtJwtCore
  120. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  121. def toString(): String
    Definition Classes
    AnyRef → Any
  122. def validate(token: String, key: PublicKey): Unit
    Definition Classes
    JwtCore
  123. def validate(token: String, key: PublicKey, options: JwtOptions): Unit
    Definition Classes
    JwtCore
  124. def validate(token: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm]): Unit
    Definition Classes
    JwtCore
  125. 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.

    Definition Classes
    JwtCore
    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

  126. def validate(token: String, key: SecretKey): Unit
    Definition Classes
    JwtCore
  127. def validate(token: String, key: SecretKey, options: JwtOptions): Unit
    Definition Classes
    JwtCore
  128. def validate(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Unit
    Definition Classes
    JwtCore
  129. 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.

    Definition Classes
    JwtCore
    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

  130. def validate(token: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm]): Unit
    Definition Classes
    JwtCore
  131. 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.

    Definition Classes
    JwtCore
    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

  132. def validate(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Unit
    Definition Classes
    JwtCore
  133. 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.

    Definition Classes
    JwtCore
    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

  134. def validate(token: String): Unit
    Definition Classes
    JwtCore
  135. 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

    Definition Classes
    JwtCore
    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

  136. def validate(header64: String, header: JwtHeader, claim64: String, claim: JwtClaim, signature: String, key: PublicKey, algorithms: Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  137. def validate(header64: String, header: JwtHeader, claim64: String, claim: JwtClaim, signature: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  138. def validate(header64: String, header: JwtHeader, claim64: String, claim: JwtClaim, signature: String, key: String, algorithms: => Seq[JwtAsymmetricAlgorithm], options: JwtOptions): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  139. def validate(header64: String, header: JwtHeader, claim64: String, claim: JwtClaim, signature: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  140. def validate(header64: String, header: JwtHeader, claim64: String, claim: JwtClaim, signature: String, options: JwtOptions, verify: (Array[Byte], Array[Byte], JwtAlgorithm) => Boolean): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  141. def validate(header: JwtHeader, claim: JwtClaim, signature: String, options: JwtOptions): Unit
    Attributes
    protected
    Definition Classes
    JwtCore
  142. def validateAsymmetricAlgorithm(algorithm: JwtAsymmetricAlgorithm, algorithms: Seq[JwtAsymmetricAlgorithm]): Boolean
    Attributes
    protected
    Definition Classes
    JwtCore
  143. def validateHmacAlgorithm(algorithm: JwtHmacAlgorithm, algorithms: Seq[JwtHmacAlgorithm]): Boolean
    Attributes
    protected
    Definition Classes
    JwtCore
  144. def validateTiming(claim: JwtClaim, options: JwtOptions): Try[Unit]
    Attributes
    protected
    Definition Classes
    JwtCore
  145. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  146. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  147. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Jwt

Inherited from JwtCore[JwtHeader, JwtClaim]

Inherited from AnyRef

Inherited from Any

Ungrouped