Class InstancePrincipalsAuthenticationDetailsProviderBuilder

Hierarchy

AbstractFederationClientAuthenticationDetailsProviderBuilder<InstancePrincipalsAuthenticationDetailsProviderBuilder, InstancePrincipalsAuthenticationDetailsProvider>
- InstancePrincipalsAuthenticationDetailsProviderBuilder

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new InstancePrincipalsAuthenticationDetailsProviderBuilder(purpose?: undefined | string): InstancePrincipalsAuthenticationDetailsProviderBuilder

- Defined in lib/common/lib/auth/instance-principals-authentication-detail-provider.ts:50
Parameters
- Optional purpose: undefined | string
Returns InstancePrincipalsAuthenticationDetailsProviderBuilder

Properties

Protected METADATA_SERVICE_BASE_URL

METADATA_SERVICE_BASE_URL: string = "http://169.254.169.254/opc/v2/"

Protected _circuitBreaker

_circuitBreaker: any = new CircuitBreaker({timeout: 10000, // If our function takes longer than 10 seconds, trigger a failureerrorThresholdPercentage: 50, // When 50% of requests fail, trip the circuitresetTimeout: 30000 // After 30 seconds, try again.}).circuit

Protected _federationClient

_federationClient: FederationClient

Protected _federationEndpoint

_federationEndpoint: string = ""

Protected _intermediateCertificateSuppliers

_intermediateCertificateSuppliers: X509CertificateSupplier[]

Protected _leafCertificateSupplier

_leafCertificateSupplier: X509CertificateSupplier

Protected _metadataBaseUrl

_metadataBaseUrl: string = this.METADATA_SERVICE_BASE_URL

Protected _sessionKeySupplier

_sessionKeySupplier: SessionKeySupplier

Protected _tenancyId

_tenancyId: string = ""

Protected region

region: Region

Protected template

template: string = "https://auth.{region}.{secondLevelDomain}"

Accessors

circuitBreaker

get circuitBreaker(): CircuitBreaker

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.circuitBreaker
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:100
Returns CircuitBreaker

federationEndpoint

set federationEndpoint(federationEndpoint: string): void

Overrides AbstractFederationClientAuthenticationDetailsProviderBuilder.federationEndpoint
- Defined in lib/common/lib/auth/instance-principals-authentication-detail-provider.ts:73
Parameters
- federationEndpoint: string
Returns void

intermediateCertificateSuppliers

set intermediateCertificateSuppliers(intermediateCertificateSuppliers: [X509CertificateSupplier]): void

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.intermediateCertificateSuppliers
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:143
Parameters
- intermediateCertificateSuppliers: [X509CertificateSupplier]
Returns void

leafCertificateSupplier

set leafCertificateSupplier(leafCertificateSupplier: X509CertificateSupplier): void

Overrides AbstractFederationClientAuthenticationDetailsProviderBuilder.leafCertificateSupplier
- Defined in lib/common/lib/auth/instance-principals-authentication-detail-provider.ts:77
Parameters
- leafCertificateSupplier: X509CertificateSupplier
Returns void

metadataBaseUrl

get metadataBaseUrl(): string
set metadataBaseUrl(metadataBaseUrl: string): void

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.metadataBaseUrl
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:81
Returns string
Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.metadataBaseUrl
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:110
Parameters
- metadataBaseUrl: string
Returns void

purpose

set purpose(purpose: string): void

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.purpose
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:133
Parameters
- purpose: string
Returns void

sessionKeySupplier

set sessionKeySupplier(sessionKeySupplier: SessionKeySupplier): void

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.sessionKeySupplier
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:138
Parameters
- sessionKeySupplier: SessionKeySupplier
Returns void

tenancyId

get tenancyId(): string
set tenancyId(tenancyId: string): void

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.tenancyId
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:96
Returns string
Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.tenancyId
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:128
Parameters
- tenancyId: string
Returns void

Methods

Protected autoDetectCertificatesUsingMetadataUrl

autoDetectCertificatesUsingMetadataUrl(): Promise<void>

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.autoDetectCertificatesUsingMetadataUrl
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:244
Auto detects and configures the certificates needed using Instance metadata.

Returns Promise<void>

Protected autoDetectEndpointUsingMetadataUrl

autoDetectEndpointUsingMetadataUrl(): Promise<string>

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.autoDetectEndpointUsingMetadataUrl
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:197
Auto detects the endpoint that should be used when talking to OCI Auth, if no endpoint has been configured already.

Returns Promise<string>

The auto-detected, or currently set, auth endpoint.

Protected autoDetectUsingMetadataUrl

autoDetectUsingMetadataUrl(): Promise<void>

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.autoDetectUsingMetadataUrl
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:188
Auto-detect endpoint and certificate information using Instance metadata.

Returns Promise<void>

build

build(): Promise<InstancePrincipalsAuthenticationDetailsProvider>

Overrides AbstractFederationClientAuthenticationDetailsProviderBuilder.build
- Defined in lib/common/lib/auth/instance-principals-authentication-detail-provider.ts:58
Returns Promise<InstancePrincipalsAuthenticationDetailsProvider>

Protected buildProvider

buildProvider(sessionKeySupplierToUse: SessionKeySupplier): InstancePrincipalsAuthenticationDetailsProvider

Overrides AbstractFederationClientAuthenticationDetailsProviderBuilder.buildProvider
- Defined in lib/common/lib/auth/instance-principals-authentication-detail-provider.ts:63
Parameters
- sessionKeySupplierToUse: SessionKeySupplier
Returns InstancePrincipalsAuthenticationDetailsProvider

Protected createFederationClient

createFederationClient(sessionKeySupplier: SessionKeySupplier): FederationClient

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.createFederationClient
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:173
Build the Federation Client

Parameters
- sessionKeySupplier: SessionKeySupplier
Returns FederationClient

Federation Client

getMetaDataResourceDetail

getMetaDataResourceDetail(path: string, circuitBreaker: CircuitBreaker): ResourceDetails

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.getMetaDataResourceDetail
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:276
Parameters
- path: string
- circuitBreaker: CircuitBreaker
Returns ResourceDetails

getRegion

getRegion(): Region

Inherited from AbstractFederationClientAuthenticationDetailsProviderBuilder.getRegion
- Defined in lib/common/lib/auth/abstract-federation-client-authenticated-details-provider-builder.ts:105
Returns Region

Class InstancePrincipalsAuthenticationDetailsProviderBuilder

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional purpose: undefined | string

Returns InstancePrincipalsAuthenticationDetailsProviderBuilder

Properties

Protected METADATA_SERVICE_BASE_URL

Protected _circuitBreaker

Protected _federationClient

Protected _federationEndpoint

Protected _intermediateCertificateSuppliers

Protected _leafCertificateSupplier

Protected _metadataBaseUrl

Protected _sessionKeySupplier

Protected _tenancyId

Protected region

Protected template

Accessors

circuitBreaker

Returns CircuitBreaker

federationEndpoint

Parameters

federationEndpoint: string

Returns void

intermediateCertificateSuppliers

Parameters

intermediateCertificateSuppliers: [X509CertificateSupplier]

Returns void

leafCertificateSupplier

Parameters

leafCertificateSupplier: X509CertificateSupplier

Returns void

metadataBaseUrl

Returns string

Parameters

metadataBaseUrl: string

Returns void

purpose

Parameters

purpose: string

Returns void

sessionKeySupplier

Parameters

sessionKeySupplier: SessionKeySupplier

Returns void

tenancyId

Returns string

Parameters

tenancyId: string

Returns void

Methods

Protected autoDetectCertificatesUsingMetadataUrl

Returns Promise<void>

Protected autoDetectEndpointUsingMetadataUrl

Returns Promise<string>

Protected autoDetectUsingMetadataUrl

Returns Promise<void>

build

Returns Promise<InstancePrincipalsAuthenticationDetailsProvider>

Protected buildProvider

Parameters

sessionKeySupplierToUse: SessionKeySupplier

Returns InstancePrincipalsAuthenticationDetailsProvider

Protected createFederationClient

Parameters

sessionKeySupplier: SessionKeySupplier

Returns FederationClient

getMetaDataResourceDetail

Parameters

path: string

circuitBreaker: CircuitBreaker

Returns ResourceDetails

getRegion

Returns Region