Std.App.Jwt

19 public declarations

• Checking

  A check with one expectation set, each answering the check rather than

  trait
• Claiming

  Claims with one field set, each answering the claims rather than taking

  trait
• claimsStd.App.Jwt.JwtClaims

  Constructs an empty set of JWT claims.

  fn
• decodeStr -> &Bytes -> &Std.App.Jwt.JwtValidation -> Int -> Result[Std.App.Jwt.JwtClaims, Std.App.Jwt.JwtError]

  Decodes and cryptographically verifies an RFC 7519 compact JWT against secret and validation rules.

  fn
• decodeUnverifiedStr -> Result[Std.App.Jwt.JwtClaims, Std.App.Jwt.JwtError]

  Decodes claims without cryptographic signature verification.

  fn
• decodeWithKeyStr -> &Std.App.Jwt.PublicKey -> &Std.App.Jwt.JwtValidation -> Int -> Result[Std.App.Jwt.JwtClaims, Std.App.Jwt.JwtError]

  Verify a token signed with a provider's private key, and read its claims.

  fn
• encode&Std.App.Jwt.JwtClaims -> &Bytes -> Str

  Serializes and signs claims into an RFC 7519 HS256 compact JSON Web Token.

  fn
• getClaim&Std.App.Jwt.JwtClaims -> Str -> Option[Str]

  Retrieves a claim by name from registered or custom claims.

  fn
• hasExpired&Std.App.Jwt.JwtClaims -> Int -> Int -> Bool

  Checks whether claims indicate the token has expired relative to a timestamp and leeway.

  fn
• isValidAt&Std.App.Jwt.JwtClaims -> Int -> Int -> Bool

  Checks whether claims are active and valid (neither premature nor expired).

  fn
• JwtClaims

  Standard claims contained within an RFC 7519 JSON Web Token.

  type
• JwtError

  Structured failure conditions encountered while decoding or validating a JWT.

  type
• JwtValidation

  Validation parameters applied during JWT signature and claims checking.

  type
• keyAlgorithm&Std.App.Jwt.PublicKey -> Str

  The algorithm name that appears in a token's header for this key.

  fn
• keyFor&Array[Std.App.Jwt.PublicKey] -> Str -> Option[Std.App.Jwt.PublicKey]

  Pick the key a token names, out of the set a provider published.

  fn
• keyId&Std.App.Jwt.PublicKey -> Str

  The identifier a provider gave this key.

  fn
• PublicKey

  A public key an identity provider publishes, and the algorithm it signs with.

  type
• tokenKeyIdStr -> Option[Str]

  Which of a provider's keys a token says signed it.

  fn
• validationStd.App.Jwt.JwtValidation

  Constructs default validation rules with zero leeway and no mandatory issuer or audience.

  fn