Module: Ey::Hmac

Defined in:

lib/ey-hmac/version.rb,
lib/ey-hmac.rb

Defined Under Namespace

Classes: Adapter, Faraday, Rack

Constant Summary

VERSION =

'2.4.0'

Error =

Class.new(StandardError)

MissingSecret =

Class.new(Error)

MissingAuthorization =

Class.new(Error)

SignatureMismatch =

Class.new(Error)

ExpiredHmac =

Class.new(Error)

Class Method Summary

• .authenticate!(request, options = {}) {|key_id| ... } ⇒ TrueClass

  Check Adapter#authorization_signature against calculated Adapter#signature.

• .authenticated?(request, options = {}) {|key_id| ... } ⇒ Boolean

  Success of authentication.

• .default_adapter ⇒ Object
• .default_adapter=(default_adapter) ⇒ Object
• .sign!(request, key_id, key_secret, options = {}) ⇒ String

  Signs request by calculating signature and adding it to the specified header.

Class Method Details

.authenticate!(request, options = {}) {|key_id| ... } ⇒ TrueClass

Check Ey::Hmac::Adapter#authorization_signature against calculated Ey::Hmac::Adapter#signature

Examples:

Ey::Hmac.authenticate! do |key_id|
  @consumer = Consumer.where(auth_id: key_id).first
  @consumer && @consumer.auth_key
end

Parameters:

• request (Hash) —

  request environment

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :adapter (Ey::Hmac::Adapter) — default: {#default_adapter} —

  adapter to verify request with

Yield Parameters:

• key_id (String) —

  public HMAC key

Returns:

• (TrueClass) —

  if authentication was successful

Raises:

• (SignatureMismatch) —

  if the value of Ey::Hmac::Adapter#authorization_signature does not match Ey::Hmac::Adapter#signature

• (MissingSecret) —

  if the block does not return a private key matching key_id

• (MissingAuthorization) —

  if the value of Ey::Hmac::Adapter#authorization_signature is nil

See Also:

• Ey::Hmac::Adapter#authenticate!

# File 'lib/ey-hmac.rb', line 95

def self.authenticate!(request, options = {}, &block)
  adapter = options[:adapter] || Ey::Hmac.default_adapter

  raise ArgumentError, 'Missing adapter and Ey::Hmac.default_adapter' unless adapter

  adapter.new(request, options).authenticate!(&block)
end

.authenticated?(request, options = {}) {|key_id| ... } ⇒ Boolean

Returns success of authentication.

Examples:

Ey::Hmac.authenticated? do |key_id|
  @consumer = Consumer.where(auth_id: key_id).first
  @consumer && @consumer.auth_key
end

Parameters:

• request (Hash) —

  request environment

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :adapter (Ey::Hmac::Adapter) — default: {#default_adapter} —

  adapter to verify request with

Yield Parameters:

• key_id (String) —

  public HMAC key

Returns:

• (Boolean) —

  success of authentication

Raises:

• (ArgumentError)

See Also:

• Ey::Hmac::Adapter#authenticated?
• #authenticate!

# File 'lib/ey-hmac.rb', line 69

def self.authenticated?(request, options = {}, &block)
  adapter = options[:adapter] || Ey::Hmac.default_adapter

  raise ArgumentError, 'Missing adapter and Ey::Hmac.default_adapter' unless adapter

  adapter.new(request, options).authenticated?(&block)
end

.default_adapter ⇒ Object

# File 'lib/ey-hmac.rb', line 26

def self.default_adapter
  @default_adapter ||= if defined?(::Rack) || defined?(::Rails)
                         Ey::Hmac::Adapter::Rack
                       elsif defined?(::Faraday)
                         Ey::Hmac::Adapter::Faraday
                       end
end

.default_adapter=(default_adapter) ⇒ Object

# File 'lib/ey-hmac.rb', line 22

def self.default_adapter=(default_adapter)
  @default_adapter = default_adapter
end

.sign!(request, key_id, key_secret, options = {}) ⇒ String

Signs request by calculating signature and adding it to the specified header

Examples:

Ey::Hmac.sign!(env, @key_id, @key_secret)

Parameters:

• request (Hash) —

  request environment

• options (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (options):

• :adapter (Ey::Hmac::Adapter) — default: #default_adapterr} —

  adapter to sign request with

• :version (Integer) — default: nil —

  signature version

• :authorization_header (String) — default: 'Authorization' —

  Authorization header key.

• :service (String) — default: 'EyHmac' —

  service name prefixed to Ey::Hmac::Adapter#authorization

Returns:

• (String) —

  authorization signature

Raises:

• (ArgumentError)

See Also:

• Ey::Hmac::Adapter#sign!

# File 'lib/ey-hmac.rb', line 47

def self.sign!(request, key_id, key_secret, options = {})
  adapter = options[:adapter] || Ey::Hmac.default_adapter

  raise ArgumentError, 'Missing adapter and Ey::Hmac.default_adapter' unless adapter

  adapter.new(request, options).sign!(key_id, key_secret)
end