Class: Auth0::Mixins::Validation::Algorithm::HS256

Inherits:

JWTAlgorithm

• Object
• JWTAlgorithm
• Auth0::Mixins::Validation::Algorithm::HS256

Defined in:

lib/auth0/mixins/validation.rb

Overview

Represents the HS256 algorithm, which rely on shared secrets.

See Also:

• https://auth0.com/docs/tokens/concepts/signing-algorithms

Instance Attribute Summary

• #secret ⇒ Object

  Returns the value of attribute secret.

Class Method Summary

• .secret(secret) ⇒ HS256

  Create a new instance passing the shared secret.

Instance Method Summary

• #initialize(secret) ⇒ HS256 constructor

  A new instance of HS256.

• #name ⇒ string

  Returns the algorithm name.

Constructor Details

#initialize(secret) ⇒ HS256

Returns a new instance of HS256.

Raises:

• (Auth0::InvalidParameter)

# File 'lib/auth0/mixins/validation.rb', line 268

def initialize(secret)
  raise Auth0::InvalidParameter, 'Must supply a valid secret' if secret.to_s.empty?

  @secret = secret
end

Instance Attribute Details

#secret ⇒ Object

Returns the value of attribute secret.

# File 'lib/auth0/mixins/validation.rb', line 266

def secret
  @secret
end

Class Method Details

.secret(secret) ⇒ HS256

Create a new instance passing the shared secret.

Parameters:

• secret (string) —

  The HMAC shared secret.

Returns:

• (HS256) —

  A new instance.

# File 'lib/auth0/mixins/validation.rb', line 261

def secret(secret)
  new secret
end

Instance Method Details

#name ⇒ string

Returns the algorithm name.

Returns:

• (string) —

  The algorithm name.

# File 'lib/auth0/mixins/validation.rb', line 276

def name
  'HS256'
end