JWTKeyCollection

Topics

Initializers

• init(defaultJWTParser: some JWTParser, defaultJWTSerializer: some JWTSerializer, logger: Logger)
  Creates a new empty Signers collection.

Instance Properties

• let defaultJWTParser: any JWTParser
• let defaultJWTSerializer: any JWTSerializer

Instance Methods

• func add(ecdsa: some ECDSAKey, kid: JWKIdentifier?, parser: some JWTParser, serializer: some JWTSerializer) -> Self
  Adds an ECDSA key to the collection.
• func add(eddsa: some EdDSAKey, kid: JWKIdentifier?, parser: some JWTParser, serializer: some JWTSerializer) -> Self
  Adds an EdDSA key to the collection using an EdDSAKey.
• func add(hmac: HMACKey, digestAlgorithm: DigestAlgorithm, kid: JWKIdentifier?, parser: some JWTParser, serializer: some JWTSerializer) -> Self
  Adds an HMAC key to the collection.
• func add(jwk: JWK, isDefault: Bool?) throws -> Self
  Adds a single JWK (JSON Web Key) to the collection.
• func add(jwks: JWKS) throws -> Self
  Adds a JWKS (JSON Web Key Set) directly to the collection.
• func add(jwksJSON: String) throws -> Self
  Adds a JWKS (JSON Web Key Set) to the collection by decoding a JSON string.
• func add(pss: some RSAKey, digestAlgorithm: DigestAlgorithm, kid: JWKIdentifier?, parser: some JWTParser, serializer: some JWTSerializer) -> Self
  Adds a PSS key to the collection.
• func add(rsa: some RSAKey, digestAlgorithm: DigestAlgorithm, kid: JWKIdentifier?, parser: some JWTParser, serializer: some JWTSerializer) -> Self
  Adds an RSA key to the collection.
• func addUnsecuredNone(kid: JWKIdentifier?, parser: some JWTParser, serializer: some JWTSerializer) -> Self
  Adds a configuration for JWTs without a signature.
• func clearDefault() -> Bool
  Removes the default signer. The signer might still exist in the collection as non-default one.
• func getKey(for: JWKIdentifier?, alg: String?) async throws -> any JWTAlgorithm
  Retrieves the key associated with the provided key identifier (KID) and algorithm (ALG), if available.
• func remove(kid: JWKIdentifier) -> Bool
  Removes the key with the selected KID from the collection. If the default matches, that one is also removed.
• func removeAll(except: [JWKIdentifier], clearingDefault: Bool) -> Int
  Removes all keys from the collection except the ones defined in the kids parameter.
• func sign(some JWTPayload, kid: JWKIdentifier?, header: JWTHeader) async throws -> String
  Signs a JWT payload and returns the JWT string.
• func unverified(_:as:parser:)
  Decodes an unverified JWT payload.
• func verify(_:as:iteratingKeys:)
  Verifies and decodes a JWT token to extract the payload.