Module: OCI::Auth::Signers

Defined in:
lib/oci/auth/signers/resource_principals_signer.rb,
lib/oci/auth/signers/security_token_signer.rb,
lib/oci/auth/signers/ephemeral_resource_principals_signer.rb,
lib/oci/auth/signers/resource_principals_federation_signer.rb,
lib/oci/auth/signers/instance_principals_security_token_signer.rb,
lib/oci/auth/signers/instance_principals_delegation_token_signer.rb,
lib/oci/auth/signers/oke_workload_identity_resource_principal_signer.rb,
lib/oci/auth/signers/service_account_token_provider/sa_token_provider.rb,
lib/oci/auth/signers/x509_federation_client_based_security_token_signer.rb,
lib/oci/auth/signers/resource_principal_token_path_provider/rpt_path_provider.rb,
lib/oci/auth/signers/resource_principal_token_path_provider/env_rpt_path_provider.rb,
lib/oci/auth/signers/resource_principal_token_path_provider/imds_rpt_path_provider.rb,
lib/oci/auth/signers/resource_principal_token_path_provider/string_rpt_path_provider.rb,
lib/oci/auth/signers/resource_principal_token_path_provider/default_rpt_path_provider.rb

Overview

signer

Defined Under Namespace

Modules: RptPathProvider, ServiceAccountTokenProvider Classes: EphemeralRPSessionKeySupplier, EphemeralResourcePrincipalsSigner, InstancePrincipalsDelegationTokenSigner, InstancePrincipalsSecurityTokenSigner, OkeWorkloadIdentityResourcePrincipalSigner, ResourcePrincipalsFederationSigner, SecurityTokenSigner, X509FederationClientBasedSecurityTokenSigner

Constant Summary collapse

OCI_RESOURCE_PRINCIPAL_VERSION = 
'OCI_RESOURCE_PRINCIPAL_VERSION'.freeze
OCI_RESOURCE_PRINCIPAL_RPT_ENDPOINT = 
'OCI_RESOURCE_PRINCIPAL_RPT_ENDPOINT'.freeze
OCI_RESOURCE_PRINCIPAL_RPST_ENDPOINT = 
'OCI_RESOURCE_PRINCIPAL_RPST_ENDPOINT'.freeze
OCI_RESOURCE_PRINCIPAL_RPST = 
'OCI_RESOURCE_PRINCIPAL_RPST'.freeze
OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM = 
'OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM'.freeze
OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM_PASSPHRASE = 
'OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM_PASSPHRASE'.freeze
OCI_RESOURCE_PRINCIPAL_REGION = 
'OCI_RESOURCE_PRINCIPAL_REGION'.freeze
OCI_KUBERNETES_SERVICE_ACCOUNT_TOKEN_PATH = 
'/var/run/secrets/kubernetes.io/serviceaccount/token'.freeze
DEFAULT_OCI_KUBERNETES_SERVICE_ACCOUNT_CERT_PATH = 
'/var/run/secrets/kubernetes.io/serviceaccount/ca.crt'.freeze
OCI_KUBERNETES_SERVICE_ACCOUNT_CERT_PATH = 
'OCI_KUBERNETES_SERVICE_ACCOUNT_CERT_PATH'.freeze
OCI_KUBERNETES_PROXYMUX_SERVICE_PORT = 
'12250'.freeze
KUBERNETES_SERVICE_HOST = 
'KUBERNETES_SERVICE_HOST'.freeze

Class Method Summary collapse

Class Method Details

.oke_workload_resource_principal_signer(service_account_token_path: nil, service_account_token: nil) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/auth/signers/resource_principals_signer.rb', line 61

def self.oke_workload_resource_principal_signer(service_account_token_path: nil, service_account_token: nil)
  sa_cert_path = ENV[OCI_KUBERNETES_SERVICE_ACCOUNT_CERT_PATH]
  sa_cert_path = DEFAULT_OCI_KUBERNETES_SERVICE_ACCOUNT_CERT_PATH if sa_cert_path.nil?

  if .nil?
    sa_token_provider = OCI::Auth::Signers::ServiceAccountTokenProvider::DefaultServiceAccountTokenProvider.new
    sa_token_provider.override_sa_token_path() unless .nil?
  else
    sa_token_provider = OCI::Auth::Signers::ServiceAccountTokenProvider::SuppliedServiceAccountTokenProvider.new()
  end

  service_host = ENV[KUBERNETES_SERVICE_HOST]
  region = ENV[OCI_RESOURCE_PRINCIPAL_REGION]

  OCI::Auth::Signers::OkeWorkloadIdentityResourcePrincipalSigner.new(
    sa_token_provider,
    sa_cert_path,
    service_host,
    OCI_KUBERNETES_PROXYMUX_SERVICE_PORT,
    region: region
  )
end

.resource_principals_signer(resource_principal_token_path_provider: nil) ⇒ Object 



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
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/auth/signers/resource_principals_signer.rb', line 25

def self.resource_principals_signer(resource_principal_token_path_provider: nil)
  rp_version = ENV[OCI_RESOURCE_PRINCIPAL_VERSION]
  if rp_version == '2.2'
    session_token = ENV[OCI_RESOURCE_PRINCIPAL_RPST]
    private_key = ENV[OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM]
    private_key_passphrase = ENV[OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM_PASSPHRASE]
    region = ENV[OCI_RESOURCE_PRINCIPAL_REGION]
    OCI::Auth::Signers::EphemeralResourcePrincipalsSigner.new(
      session_token: session_token,
      private_key: private_key,
      private_key_passphrase: private_key_passphrase,
      region: region
    )
  elsif rp_version == '1.1'
    #
    # This signer takes the following parameters
    # - OCI_RESOURCE_PRINCIPAL_RPT_ENDPOINT
    #     The endpoint for retrieving the Resource Principal Token
    # - OCI_RESOURCE_PRINCIPAL_RPST_ENDPOINT
    #     The endpoint for retrieving the Resource Principal Session Token
    # - Resource Principal Token Path Provider
    #     An Object which Provides the complete path for getting the Resource Principal Token
    resource_principal_token_endpoint = ENV[OCI_RESOURCE_PRINCIPAL_RPT_ENDPOINT]
    resource_principal_session_token_endpoint = ENV[OCI_RESOURCE_PRINCIPAL_RPST_ENDPOINT]
    OCI::Auth::Signers::ResourcePrincipalsFederationSigner.new(
      rp_token_endpoint: resource_principal_token_endpoint,
      rp_session_endpoint: resource_principal_session_token_endpoint,
      rp_token_path_provider: resource_principal_token_path_provider
    )
  elsif rp_version.nil?
    raise Exception("#{OCI_RESOURCE_PRINCIPAL_VERSION} is not defined")
  else
    raise Exception("Unsupported #{OCI_RESOURCE_PRINCIPAL_VERSION}: #{rp_version}")
  end
end