Class: Azure::Core::Auth::Signer

Inherits:

Object

• Object
• Azure::Core::Auth::Signer

Defined in:

lib/azure/core/auth/signer.rb

Overview

Public: Utility class to sign strings with HMAC-256 and then encode the signed string using Base64.

Direct Known Subclasses

Blob::Auth::SharedAccessSignature, SharedKey, ServiceBus::Auth::WrapSigner, Table::Auth::SharedKey

Instance Attribute Summary

• #access_key ⇒ Object readonly

  The access key for the account.

Instance Method Summary

• #initialize(access_key = Azure.config.storage_access_key) ⇒ Signer constructor

  Public: Initialize the Signer.

• #sign(body) ⇒ Object

  Public: Generate an HMAC signature.

Constructor Details

#initialize(access_key = Azure.config.storage_access_key) ⇒ Signer

Public: Initialize the Signer.

access_key - The access_key encoded in Base64. Defaults to the one

in the global configuration.

# File 'lib/azure/core/auth/signer.rb', line 32

def initialize(access_key=Azure.config.storage_access_key)
  if access_key.nil?
    raise ArgumentError, "storage access key must be provided"
  end

  @access_key = Base64.strict_decode64(access_key)
end

Instance Attribute Details

#access_key ⇒ Object (readonly)

The access key for the account

# File 'lib/azure/core/auth/signer.rb', line 26

def access_key
  @access_key
end

Instance Method Details

#sign(body) ⇒ Object

Public: Generate an HMAC signature.

body - The string to sign.

Returns a Base64 String signed with HMAC.

# File 'lib/azure/core/auth/signer.rb', line 45

def sign(body)
  signed = OpenSSL::HMAC.digest("sha256", access_key, body)
  Base64.strict_encode64(signed)
end