Object

pdi.jwt

Jwt

Related Doc: package jwt

Permalink

object Jwt extends JwtCore[String, String]

Default 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.

Linear Supertypes
JwtCore[String, String], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Jwt
  2. JwtCore
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

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
    @throws( ... )
  6. def decode(token: String, key: PublicKey): Try[String]

    Permalink
    Definition Classes
    JwtCore
  7. def decode(token: String, key: PublicKey, options: JwtOptions): Try[String]

    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

    Definition Classes
    JwtCore
  8. def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm]): Try[String]

    Permalink
    Definition Classes
    JwtCore
  9. def decode(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm], options: JwtOptions): Try[String]

    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

    Definition Classes
    JwtCore
  10. def decode(token: String, key: SecretKey): Try[String]

    Permalink
    Definition Classes
    JwtCore
  11. def decode(token: String, key: SecretKey, options: JwtOptions): Try[String]

    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

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

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

    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

    Definition Classes
    JwtCore
  14. def decode(token: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm]): Try[String]

    Permalink
    Definition Classes
    JwtCore
  15. def decode(token: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm], options: JwtOptions): Try[String]

    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

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

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

    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

    Definition Classes
    JwtCore
  18. def decode(token: String): Try[String]

    Permalink
    Definition Classes
    JwtCore
  19. def decode(token: String, options: JwtOptions): Try[String]

    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

    Definition Classes
    JwtCore
  20. def decodeAll(token: String, key: PublicKey): Try[(String, String, String)]

    Permalink
    Definition Classes
    JwtCore
  21. def decodeAll(token: String, key: PublicKey, options: JwtOptions): Try[(String, String, 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

    Definition Classes
    JwtCore
  22. def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm]): Try[(String, String, String)]

    Permalink
    Definition Classes
    JwtCore
  23. def decodeAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm], options: JwtOptions): Try[(String, String, 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

    Definition Classes
    JwtCore
  24. def decodeAll(token: String, key: SecretKey): Try[(String, String, String)]

    Permalink
    Definition Classes
    JwtCore
  25. def decodeAll(token: String, key: SecretKey, options: JwtOptions): Try[(String, String, 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

    Definition Classes
    JwtCore
  26. def decodeAll(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]

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

    Definition Classes
    JwtCore
  28. def decodeAll(token: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm]): Try[(String, String, String)]

    Permalink
    Definition Classes
    JwtCore
  29. def decodeAll(token: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm], options: JwtOptions): Try[(String, String, 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

    Definition Classes
    JwtCore
  30. def decodeAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]

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

    Definition Classes
    JwtCore
  32. def decodeAll(token: String): Try[(String, String, String)]

    Permalink
    Definition Classes
    JwtCore
  33. def decodeAll(token: String, options: JwtOptions): Try[(String, String, 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

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

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

    Definition Classes
    JwtCore
  36. def decodeRaw(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm]): Try[String]

    Permalink
    Definition Classes
    JwtCore
  37. def decodeRaw(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm], 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

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

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

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

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

    Definition Classes
    JwtCore
  42. def decodeRaw(token: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm]): Try[String]

    Permalink
    Definition Classes
    JwtCore
  43. def decodeRaw(token: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm], 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

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

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

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

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

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

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

    Permalink
    Definition Classes
    JwtCore
  50. def decodeRawAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm]): Try[(String, String, String)]

    Permalink
    Definition Classes
    JwtCore
  51. def decodeRawAll(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm], options: JwtOptions): Try[(String, String, String)]

    Permalink

    Will try to decode a JSON Web Token to raw strings using an asymetric algorithm

    Will try to decode a JSON Web Token to raw strings using an asymetric 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
  52. def decodeRawAll(token: String, key: SecretKey): Try[(String, String, String)]

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

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

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

    Definition Classes
    JwtCore
  56. def decodeRawAll(token: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm]): Try[(String, String, String)]

    Permalink
    Definition Classes
    JwtCore
  57. def decodeRawAll(token: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm], options: JwtOptions): Try[(String, String, String)]

    Permalink

    Will try to decode a JSON Web Token to raw strings using an asymetric algorithm

    Will try to decode a JSON Web Token to raw strings using an asymetric 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
  58. def decodeRawAll(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Try[(String, String, String)]

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

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

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

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

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

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

    Definition Classes
    JwtCore
  65. def encode(claim: JwtClaim, key: PrivateKey, algorithm: JwtAsymetricAlgorithm): 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

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

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

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

    Definition Classes
    JwtCore
  69. def encode(claim: String, key: PrivateKey, algorithm: JwtAsymetricAlgorithm): 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

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

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

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

    Definition Classes
    JwtCore
  73. def encode(header: String, claim: String, key: PrivateKey, algorithm: JwtAsymetricAlgorithm): String

    Permalink
    Definition Classes
    JwtCore
  74. def encode(header: String, claim: String, key: SecretKey, algorithm: JwtHmacAlgorithm): String

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

    Definition Classes
    JwtCore
  76. def encode(header: String, claim: String): String

    Permalink
    Definition Classes
    JwtCore
  77. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  78. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  79. def extractAlgorithm(header: String): Option[JwtAlgorithm]

    Permalink
    Attributes
    protected
    Definition Classes
    JwtJwtCore
  80. def extractExpiration(claim: String): Option[Long]

    Permalink
    Attributes
    protected
    Definition Classes
    JwtJwtCore
  81. def extractNotBefore(claim: String): Option[Long]

    Permalink
    Attributes
    protected
    Definition Classes
    JwtJwtCore
  82. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  83. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  84. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  85. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  86. def isValid(token: String, key: PublicKey): Boolean

    Permalink
    Definition Classes
    JwtCore
  87. def isValid(token: String, key: PublicKey, options: JwtOptions): Boolean

    Permalink
    Definition Classes
    JwtCore
  88. def isValid(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm]): Boolean

    Permalink
    Definition Classes
    JwtCore
  89. def isValid(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm], 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

    Definition Classes
    JwtCore
  90. def isValid(token: String, key: SecretKey): Boolean

    Permalink
    Definition Classes
    JwtCore
  91. def isValid(token: String, key: SecretKey, options: JwtOptions): Boolean

    Permalink
    Definition Classes
    JwtCore
  92. def isValid(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Boolean

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

    Definition Classes
    JwtCore
  94. def isValid(token: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm]): Boolean

    Permalink
    Definition Classes
    JwtCore
  95. def isValid(token: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm], options: JwtOptions): Boolean

    Permalink

    An alias for isValid if you want to directly pass a string as the key for asymetric algorithms

    An alias for isValid if you want to directly pass a string as the key for asymetric 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
  96. def isValid(token: String, key: String, algorithms: Seq[JwtHmacAlgorithm]): Boolean

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

    Definition Classes
    JwtCore
  98. def isValid(token: String): Boolean

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

    Definition Classes
    JwtCore
  100. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  101. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  102. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  103. def parseClaim(claim: String): String

    Permalink
    Attributes
    protected
    Definition Classes
    JwtJwtCore
  104. def parseHeader(header: String): String

    Permalink
    Attributes
    protected
    Definition Classes
    JwtJwtCore
  105. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  106. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  107. def validate(token: String, key: PublicKey): Unit

    Permalink
    Definition Classes
    JwtCore
  108. def validate(token: String, key: PublicKey, options: JwtOptions): Unit

    Permalink
    Definition Classes
    JwtCore
  109. def validate(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm]): Unit

    Permalink
    Definition Classes
    JwtCore
  110. def validate(token: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm], 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.

    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 exeption

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

    Permalink
    Definition Classes
    JwtCore
  112. def validate(token: String, key: SecretKey, options: JwtOptions): Unit

    Permalink
    Definition Classes
    JwtCore
  113. def validate(token: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm]): Unit

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

    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 exeption

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

    Permalink
    Definition Classes
    JwtCore
  116. def validate(token: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm], options: JwtOptions): Unit

    Permalink

    An alias of validate in case you want to directly pass a string key for asymetric algorithms.

    An alias of validate in case you want to directly pass a string key for asymetric 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 exeption

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

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

    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 exeption

  119. def validate(token: String): Unit

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

    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 exeption

  121. def validate(header64: String, header: String, claim64: String, claim: String, signature: String, key: PublicKey, algorithms: Seq[JwtAsymetricAlgorithm], options: JwtOptions): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    JwtCore
  122. def validate(header64: String, header: String, claim64: String, claim: String, signature: String, key: SecretKey, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    JwtCore
  123. def validate(header64: String, header: String, claim64: String, claim: String, signature: String, key: String, algorithms: ⇒ Seq[JwtAsymetricAlgorithm], options: JwtOptions): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    JwtCore
  124. def validate(header64: String, header: String, claim64: String, claim: String, signature: String, key: String, algorithms: Seq[JwtHmacAlgorithm], options: JwtOptions): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    JwtCore
  125. def validate(header64: String, header: String, claim64: String, claim: String, signature: String, options: JwtOptions, verify: (Array[Byte], Array[Byte], JwtAlgorithm) ⇒ Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    JwtCore
  126. def validate(header: String, claim: String, signature: String, options: JwtOptions): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    JwtCore
  127. def validateAsymetricAlgorithm(algorithm: JwtAsymetricAlgorithm, algorithms: Seq[JwtAsymetricAlgorithm]): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    JwtCore
  128. def validateHmacAlgorithm(algorithm: JwtHmacAlgorithm, algorithms: Seq[JwtHmacAlgorithm]): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    JwtCore
  129. def validateTiming(claim: String, options: JwtOptions): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    JwtCore
  130. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  131. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wait(arg0: Long): Unit

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

Inherited from JwtCore[String, String]

Inherited from AnyRef

Inherited from Any

Ungrouped