Class: OCI::Auth::Signers::KeyPairSigner

Inherits:
BaseSigner
  • Object
show all
Defined in:
lib/oci/auth/signers/key_pair_signer.rb

Overview

rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity A requests signer that is intended to be used when signing requests for RPv2.1 using a key pair

Constant Summary

Constants inherited from BaseSigner

BaseSigner::BODY_HEADERS, BaseSigner::GENERIC_HEADERS, BaseSigner::SIGNATURE_VERSION, BaseSigner::SIGNING_STRATEGY_ENUM

Instance Method Summary collapse

Methods inherited from BaseSigner

#sign

Constructor Details

#initialize(rp_version, resource_id, tenancy_id, private_key, headers_to_sign_in_all_requests: OCI::BaseSigner::GENERIC_HEADERS, body_headers_to_sign: OCI::BaseSigner::BODY_HEADERS) ⇒ KeyPairSigner

Creates a new KeyPairSigner

Parameters:

  • rp_version (String)
  • resource_id (String)
  • tenancy_id (String)
  • private_key (OpenSSL::PKey::RSA) —

    The private key whose corresponding public key was provided when requesting the token

  • headers_to_sign_in_all_requests (Array<String>) (defaults to: OCI::BaseSigner::GENERIC_HEADERS) —

    An array of headers which will be signed in each request. If not provided, defaults to BaseSigner::GENERIC_HEADERS

  • body_headers_to_sign (Array<String>) (defaults to: OCI::BaseSigner::BODY_HEADERS) —

    An array of headers which should be signed on requests with bodies. If not provided, defaults to BaseSigner::BODY_HEADERS

Raises:

  • (ArgumentError) 


20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/auth/signers/key_pair_signer.rb', line 20

def initialize(
  rp_version,
  resource_id,
  tenancy_id,
  private_key,
  headers_to_sign_in_all_requests: OCI::BaseSigner::GENERIC_HEADERS,
  body_headers_to_sign: OCI::BaseSigner::BODY_HEADERS
)
  if %w[2.1.1 2.1.2].include?(rp_version) && tenancy_id && resource_id
    @api_key = "resource/v#{rp_version}/#{tenancy_id}/#{resource_id}"
  elsif rp_version == '2.1' && resource_id
    @api_key = "resource/v2.1/#{resource_id}"
  else
    raise ArgumentError, 'Resource Id or Tenancy Id or OCI_RESOURCE_PRINCIPAL_VERSION is missing'
  end

  raise ArgumentError, 'Private Key is missing' if private_key.nil?

  @private_key = private_key

  @headers_to_sign_in_all_requests = 
  @body_headers_to_sign = body_headers_to_sign

  super(
    @api_key,
    @private_key,
    headers_to_sign_in_all_requests: ,
    body_headers_to_sign: body_headers_to_sign
  )
end