class JWT::Claims::Issuer

The Issuer class is responsible for validating the issuer claim ('iss') in a JWT token.

Attributes

issuers[R]

Public Class Methods

new(issuers:) click to toggle source

Initializes a new Issuer instance.

@param issuers [String, Symbol, Array<String, Symbol>] the expected issuer(s) for the JWT token.

# File lib/jwt/claims/issuer.rb, line 10
def initialize(issuers:)
  @issuers = Array(issuers).map { |item| item.is_a?(Symbol) ? item.to_s : item }
end

Public Instance Methods

verify!(context:, **_args) click to toggle source

Verifies the issuer claim ('iss') in the JWT token.

@param context [Object] the context containing the JWT payload. @param _args [Hash] additional arguments (not used). @raise [JWT::InvalidIssuerError] if the issuer claim is invalid. @return [nil]

# File lib/jwt/claims/issuer.rb, line 20
def verify!(context:, **_args)
  case (iss = context.payload['iss'])
  when *issuers
    nil
  else
    raise JWT::InvalidIssuerError, "Invalid issuer. Expected #{issuers}, received #{iss || '<none>'}"
  end
end