Class X509FederationClient

Hierarchy

X509FederationClient

Implements

FederationClient

Constructors

constructor

Properties

Accessors

Methods

Object literals

defaultAuthRetryConfiguration

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:54
Parameters
- federationEndpoint: string
- _tenancyId: string
- _leafCertificateSupplier: X509CertificateSupplier
- sessionKeySupplier: SessionKeySupplier
- intermediateCertificateSuppliers: X509CertificateSupplier[]
- purpose: string
- circuitBreaker: CircuitBreaker
Returns X509FederationClient

Properties

Private _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Private _leafCertificateSupplier

_leafCertificateSupplier: X509CertificateSupplier

Private _tenancyId

_tenancyId: string

Private circuitBreaker

circuitBreaker: CircuitBreaker

Private federationEndpoint

federationEndpoint: string

httpClient

httpClient: FetchHttpClient

Private intermediateCertificateSuppliers

intermediateCertificateSuppliers: X509CertificateSupplier[]

Private purpose

purpose: string

securityTokenAdapter

securityTokenAdapter: SecurityTokenAdapter

Private sessionKeySupplier

sessionKeySupplier: SessionKeySupplier

Static Private DEFAULT_AUTH_MAX_DELAY_IN_SECONDS

DEFAULT_AUTH_MAX_DELAY_IN_SECONDS: number = 1

Static Private DEFAULT_AUTH_MAX_RETRY_COUNT

DEFAULT_AUTH_MAX_RETRY_COUNT: number = 3

Accessors

leafCertificateSupplier

get leafCertificateSupplier(): X509CertificateSupplier

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

tenancyId

get tenancyId(): string

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

Methods

close

close(): void

- Defined in lib/common/lib/auth/X509-federation-client.ts:85
Returns void

getSecurityToken

getSecurityToken(): Promise<string>

Implementation of FederationClient.getSecurityToken
- Defined in lib/common/lib/auth/X509-federation-client.ts:100
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:176
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:112
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

Private getTokenAsync

getTokenAsync(): Promise<Response>

- Defined in lib/common/lib/auth/X509-federation-client.ts:221
Returns Promise<Response>

refreshAndGetSecurityToken

refreshAndGetSecurityToken(): Promise<string>

Implementation of FederationClient.refreshAndGetSecurityToken
- Defined in lib/common/lib/auth/X509-federation-client.ts:117
Returns Promise<string>

Private refreshAndGetSecurityTokenInner

refreshAndGetSecurityTokenInner(doFinalTokenValidityCheck: boolean): Promise<string>

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

Object literals

Static Private defaultAuthRetryConfiguration

defaultAuthRetryConfiguration: object

delayStrategy

delayStrategy: ExponentialBackoffDelayStrategyWithJitter = new ExponentialBackoffDelayStrategyWithJitter(X509FederationClient.DEFAULT_AUTH_MAX_DELAY_IN_SECONDS)

terminationStrategy

terminationStrategy: MaxAttemptsTerminationStrategy = new MaxAttemptsTerminationStrategy(X509FederationClient.DEFAULT_AUTH_MAX_RETRY_COUNT)

Class X509FederationClient

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Object literals

Constructors

constructor

Parameters

federationEndpoint: string

_tenancyId: string

_leafCertificateSupplier: X509CertificateSupplier

sessionKeySupplier: SessionKeySupplier

intermediateCertificateSuppliers: X509CertificateSupplier[]

purpose: string

circuitBreaker: CircuitBreaker

Returns X509FederationClient

Properties

Private _circuitBreaker

Private _leafCertificateSupplier

Private _tenancyId

Private circuitBreaker

Private federationEndpoint

httpClient

Private intermediateCertificateSuppliers

Private purpose

securityTokenAdapter

Private sessionKeySupplier

Static Private DEFAULT_AUTH_MAX_DELAY_IN_SECONDS

Static Private DEFAULT_AUTH_MAX_RETRY_COUNT

Accessors

leafCertificateSupplier

Returns X509CertificateSupplier

tenancyId

Returns string

Methods

close

Returns void

getSecurityToken

Returns Promise<string>

Private getSecurityTokenFromServer

Returns Promise<SecurityTokenAdapter>

getStringClaim

Parameters

key: string

Returns Promise<string | null>

Private getTokenAsync

Returns Promise<Response>

refreshAndGetSecurityToken

Returns Promise<string>

Private refreshAndGetSecurityTokenInner

Parameters

doFinalTokenValidityCheck: boolean

Returns Promise<string>

Object literals

Static Private defaultAuthRetryConfiguration

delayStrategy

terminationStrategy