Class X509FederationClientForOkeWorkloadIdentity

Hierarchy

X509FederationClientForOkeWorkloadIdentity

Implements

FederationClient

Constructors

constructor

Properties

Methods

Constructors

constructor

new X509FederationClientForOkeWorkloadIdentity(proxymuxEndpoint: string, kubernetesServiceAccountToken: string, kubernetesServiceAccountCert: string, sessionKeySupplier: SessionKeySupplier): X509FederationClientForOkeWorkloadIdentity

- Defined in lib/common/lib/auth/X509-federation-client-for-oke-workload-identity.ts:25
Parameters
- proxymuxEndpoint: string
- kubernetesServiceAccountToken: string
- kubernetesServiceAccountCert: string
- sessionKeySupplier: SessionKeySupplier
Returns X509FederationClientForOkeWorkloadIdentity

Properties

Private kubernetesServiceAccountCert

kubernetesServiceAccountCert: string

Private kubernetesServiceAccountToken

kubernetesServiceAccountToken: string

Private proxymuxEndpoint

proxymuxEndpoint: string

Private retry

retry: number = 0

securityTokenAdapter

securityTokenAdapter: SecurityTokenAdapter

Private sessionKeySupplier

sessionKeySupplier: SessionKeySupplier

Methods

getSecurityToken

getSecurityToken(): Promise<string>

Implementation of FederationClient.getSecurityToken
- Defined in lib/common/lib/auth/X509-federation-client-for-oke-workload-identity.ts:44
Gets a security token. If there is already a valid token cached, it will be returned. Else this will make a call to the OKE Proxymux service to get a new token, using the provided suppliers.

This method is thread-safe.

throws

OciError If there is any issue with getting a token from the OKE Proxymux server

Returns Promise<string>

the security token

Private getSecurityTokenFromServer

getSecurityTokenFromServer(): Promise<SecurityTokenAdapter>

- Defined in lib/common/lib/auth/X509-federation-client-for-oke-workload-identity.ts:83
Gets a security token from the OKE Proxymux service

Returns Promise<SecurityTokenAdapter>

the security token, which is basically a JWT token string

getStringClaim

getStringClaim(key: string): Promise<string | null>

Implementation of FederationClient.getStringClaim
- Defined in lib/common/lib/auth/X509-federation-client-for-oke-workload-identity.ts:56
Return a claim embedded in the security token

Parameters
- key: string
  
  the name of the claim
Returns Promise<string | null>

the value of the claim or null if unable to find

refreshAndGetSecurityToken

refreshAndGetSecurityToken(): Promise<string>

Implementation of FederationClient.refreshAndGetSecurityToken
- Defined in lib/common/lib/auth/X509-federation-client-for-oke-workload-identity.ts:61
Returns Promise<string>

Private refreshAndGetSecurityTokenInner

refreshAndGetSecurityTokenInner(doFinalTokenValidityCheck: boolean): Promise<string>

- Defined in lib/common/lib/auth/X509-federation-client-for-oke-workload-identity.ts:65
Parameters
- doFinalTokenValidityCheck: boolean
Returns Promise<string>