class JOSE::JWKS

• JOSE::JWKS
• Reference
• Object

Overview

Represents a JSON Web Key Set (JWKS, RFC 7517 §5).

A JWKS is an ordered collection of JWK objects serialised as {"keys": [...]}. It is the standard container for publishing public keys (e.g. OIDC /.well-known/jwks.json) and for managing key rotation.

Included Modules

• Enumerable(JOSE::JWK)

Defined in:

jose/jwks.cr

Constructors

• .from_binary(json : String) : JWKS

  Parses json and returns the resulting JWKS.

• .from_map(map : Hash(String, JSON::Any)) : JWKS

  Constructs a JWKS from a parsed JSON map.

• .new(keys : Array(JWK))

Instance Method Summary

• #[](kid : String) : JWK

  Returns the JWK whose kid equals kid, or raises KeyError.

• #[]?(kid : String) : JWK | Nil

  Returns the JWK whose kid equals kid, or nil.

• #add(jwk : JWK) : JWKS

  Returns a new JWKS with jwk appended.

• #each(& : JWK -> _)

  Yields each JWK in order.

• #filter(&block : JWK -> Bool) : JWKS

  Returns a new JWKS containing only keys for which the block returns true.

• #keys : Array(JWK)
• #merge(other : JWKS) : JWKS

  Returns a new JWKS that is the concatenation of this set and other.

• #remove(kid : String) : JWKS

  Returns a new JWKS with the key whose kid equals kid removed.

• #size : Int32

  Returns the number of keys in the set.

• #to_binary : String

  Serialises this key set to a compact JSON string.

• #to_map : Hash(String, JSON::Any)

  Returns a JSON map of the form {"keys" => [...]}.

• #to_public : JWKS

  Returns a new JWKS containing only public key material for every key.

Constructor Detail

Instance Method Detail