Class: JWT::Claims::Subject

Inherits:

Object

• Object
• JWT::Claims::Subject

Defined in:

lib/jwt/claims/subject.rb

Overview

The Subject class is responsible for validating the subject claim (‘sub’) in a JWT token.

Instance Method Summary

• #initialize(expected_subject:) ⇒ Subject constructor

  Initializes a new Subject instance.

• #verify!(context:, **_args) ⇒ nil

  Verifies the subject claim (‘sub’) in the JWT token.

Constructor Details

#initialize(expected_subject:) ⇒ Subject

Initializes a new Subject instance.

Parameters:

• expected_subject (String) —

  the expected subject for the JWT token.

# File 'lib/jwt/claims/subject.rb', line 10

def initialize(expected_subject:)
  @expected_subject = expected_subject.to_s
end

Instance Method Details

#verify!(context:, **_args) ⇒ nil

Verifies the subject claim (‘sub’) in the JWT token.

Parameters:

• context (Object) —

  the context containing the JWT payload.

• _args (Hash) —

  additional arguments (not used).

Returns:

• (nil)

Raises:

• (JWT::InvalidSubError) —

  if the subject claim is invalid.

# File 'lib/jwt/claims/subject.rb', line 20

def verify!(context:, **_args)
  sub = context.payload['sub']
  raise(JWT::InvalidSubError, "Invalid subject. Expected #{expected_subject}, received #{sub || '<none>'}") unless sub.to_s == expected_subject
end