Class: OracleBMC::Signer

Inherits:

Object

• Object
• OracleBMC::Signer

Defined in:

lib/oraclebmc/signer.rb

Overview

Used to sign HTTP requests as required by Oracle Bare Metal Cloud services.

Constant Summary

SIGNATURE_VERSION =

The Oracle Bare Metal Cloud Services API signature version

"1"

Instance Method Summary

• #initialize(user, fingerprint, tenancy, private_key_file, pass_phrase: nil) ⇒ Signer constructor

  Creates a Signer.

• #sign(method, uri, headers, body) ⇒ Object

  Generates the correct signature and adds it to the headers that are passed in.

Constructor Details

#initialize(user, fingerprint, tenancy, private_key_file, pass_phrase: nil) ⇒ Signer

Creates a Signer

Parameters:

• user (String) —

  OCID of the user to be used for authentication, for example “ocidv1:user:oc1:phx:1460406592659:aaaaaaaawcbqrkycbolrirg2n3xjl5fyxe”.

• fingerprint (String) —

  Fingerprint of the key used for authentication, for example “20:3b:97:13:55:1c:5b:0d:d3:37:d8:50:4e:c5:3a:34”

• tenancy (String) —

  OCID of the tenancy

• private_key_file (String) —

  Full path and filename of the unencrypted PEM file, for example “/Users/bgustafs/.ssh/id_rsa.pem”

• pass_phrase (String) (defaults to: nil) —

  Optional pass phrase used to encrypt the private key

# File 'lib/oraclebmc/signer.rb', line 26

def initialize(user, fingerprint, tenancy, private_key_file, pass_phrase:nil)
  fail 'Missing required parameter user.' unless user
  fail 'Missing required parameter fingerprint.' unless fingerprint
  fail 'Missing required parameter tenancy.' unless tenancy
  fail 'Missing required parameter private_key_file.' unless private_key_file

  @key_id = tenancy + "/" + user + "/" + fingerprint
  @private_key_file = private_key_file
  @pass_phrase = pass_phrase
end

Instance Method Details

#sign(method, uri, headers, body) ⇒ Object

Generates the correct signature and adds it to the headers that are passed in. Also injects any required headers that might be missing.

Parameters:

• method (Symbol) —

  The HTTP method, such as :get or :post.

• uri (String) —

  The URI, such as ‘iaas.us-phoenix-1.oraclecloud.com/20160918/volumeAttachments/’

• headers (Hash) —

  A hash of headers

• body (String) —

  The request body

# File 'lib/oraclebmc/signer.rb', line 45

def sign(method, uri, headers, body)
  method = method.to_sym.downcase
  uri = URI(uri)
  path = uri.query.nil? ? uri.path : "#{uri.path}?#{uri.query}"
  inject_missing_headers(method, headers, body, uri)
  signature = compute_signature(headers, method, path)
  unless signature.nil?
    inject_authorization_header(headers, method, signature)
  end
end