Class X509FederationClient

Hierarchy

X509FederationClient

Implements

FederationClient

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new X509FederationClient(federationEndpoint: string, _tenancyId: string, _leafCertificateSupplier: X509CertificateSupplier, sessionKeySupplier: SessionKeySupplier, intermediateCertificateSuppliers: X509CertificateSupplier[], purpose: string, circuitBreaker: CircuitBreaker): X509FederationClient

- Defined in lib/common/lib/auth/X509-federation-client.ts:32
Parameters
- federationEndpoint: string
- _tenancyId: string
- _leafCertificateSupplier: X509CertificateSupplier
- sessionKeySupplier: SessionKeySupplier
- intermediateCertificateSuppliers: X509CertificateSupplier[]
- purpose: string
- circuitBreaker: CircuitBreaker
Returns X509FederationClient

Properties

Private _leafCertificateSupplier

_leafCertificateSupplier: X509CertificateSupplier

Private _tenancyId

_tenancyId: string

Private circuitBreaker

circuitBreaker: CircuitBreaker

Private federationEndpoint

federationEndpoint: string

Private intermediateCertificateSuppliers

intermediateCertificateSuppliers: X509CertificateSupplier[]

Private purpose

purpose: string

Private retry

retry: number = 0

securityTokenAdapter

securityTokenAdapter: SecurityTokenAdapter

Private sessionKeySupplier

sessionKeySupplier: SessionKeySupplier

Accessors

leafCertificateSupplier

get leafCertificateSupplier(): X509CertificateSupplier

- Defined in lib/common/lib/auth/X509-federation-client.ts:52
Returns X509CertificateSupplier

tenancyId

get tenancyId(): string

- Defined in lib/common/lib/auth/X509-federation-client.ts:47
Returns string

Methods

getSecurityToken

getSecurityToken(): Promise<string>

Implementation of FederationClient.getSecurityToken
- Defined in lib/common/lib/auth/X509-federation-client.ts:64
Gets a security token. If there is already a valid token cached, it will be returned. Else this will make a call to the auth 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 auth server

Returns Promise<string>

the security token

Private getSecurityTokenFromServer

getSecurityTokenFromServer(): Promise<SecurityTokenAdapter>

- Defined in lib/common/lib/auth/X509-federation-client.ts:140
Gets a security token from the federation server

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.ts:76
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.ts:81
Returns Promise<string>

Private refreshAndGetSecurityTokenInner

refreshAndGetSecurityTokenInner(doFinalTokenValidityCheck: boolean): Promise<string>

- Defined in lib/common/lib/auth/X509-federation-client.ts:85
Parameters
- doFinalTokenValidityCheck: boolean
Returns Promise<string>