ResourcePrincipalAuthenticationDetailsProvider, constructed in accordance with the following
environment variable settings:
OCI_RESOURCE_PRINCIPAL_VERSION:
This is required. Permitted values are "1.1", "2.1", "2.1.1", "2.1.2", "2.2" and "3.0"
For OCI_RESOURCE_PRINCIPAL_VERSION = "1.1"
OCI_RESOURCE_PRINCIPAL_RPT_ENDPOINT:
This is required. The endpoint for retrieving the Resource Principal Token.
OCI_RESOURCE_PRINCIPAL_RPST_ENDPOINT:
If set, the value from environment variable is used.
Otherwise, it uses the default resource principal token path provider.
For OCI_RESOURCE_PRINCIPAL_VERSION = "2.1"
OCI_RESOURCE_PRINCIPAL_RPT_ENDPOINT
This is required. The endpoint for retrieving the Resource Principal Token.
OCI_RESOURCE_PRINCIPAL_RPST_ENDPOINT
This is required. The endpoint for retrieving the Resource Principal Session Token.
OCI_RESOURCE_PRINCIPAL_RESOURCE_ID
This is required. The RPv2.1 resource id.
OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM
This is required. If this points to existing file path, then the filesystem-supplied private key will be retrieved from that location.
Otherwise, the value is interpreted as the direct injection of a private key.
OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM_PASSPHRASE
This is optional. The passphrase for the private key.
For OCI_RESOURCE_PRINCIPAL_VERSION = "2.1.1"
OCI_RESOURCE_PRINCIPAL_RPT_ENDPOINT
This is required. The endpoint for retrieving the Resource Principal Token.
OCI_RESOURCE_PRINCIPAL_RPST_ENDPOINT
This is required. The endpoint for retrieving the Resource Principal Session Token.
OCI_RESOURCE_PRINCIPAL_RESOURCE_ID
This is required. The RPv2.1.1 resource id.
OCI_RESOURCE_PRINCIPAL_TENANCY_ID
This is required. The RPv2.1.1 tenancy id.
OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM
This is required. If this points to existing file path, then the filesystem-supplied private key will be retrieved from that location.
Otherwise, the value is interpreted as the direct injection of a private key.
OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM_PASSPHRASE
This is optional. The passphrase for the private key.
For OCI_RESOURCE_PRINCIPAL_VERSION = "2.1.2"
OCI_RESOURCE_PRINCIPAL_RPT_ENDPOINT
This is required. The endpoint for retrieving the Resource Principal Token.
OCI_RESOURCE_PRINCIPAL_RPST_ENDPOINT
This is required. The endpoint for retrieving the Resource Principal Session Token.
OCI_RESOURCE_PRINCIPAL_RESOURCE_ID
This is required. The RPv2.1.2 resource id.
OCI_RESOURCE_PRINCIPAL_TENANCY_ID
This is required. The RPv2.1.2 tenancy id.
OCI_RESOURCE_PRINCIPAL_SECURITY_CONTEXT
Security context is a must for RPv2.1.2. If set via the environment variable, the value of RPv2.1.2 security context from environment variable is used.
If set via the builder, security context provided via the builder overrides the value provided via the environment variable.
OCI_RESOURCE_PRINCIPAL_RPT_PATH
If set, the value from environment variable is used.
Otherwise, it uses the default resource principal token path DEFAULT_OCI_RESOURCE_PRINCIPAL_RPT_PATH_FORV212.
OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM
This is required. If this points to existing file path, then the filesystem-supplied private key will be retrieved from that location.
Otherwise, the value is interpreted as the direct injection of a private key.
OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM_PASSPHRASE
This is optional. The passphrase for the private key.
For OCI_RESOURCE_PRINCIPAL_VERSION = "2.2"
OCI_RESOURCE_PRINCIPAL_RPST:
If this points to an existing file path, then the filesystem-supplied resource principal session token will be retrieved from that location. This mode supports token refresh (if the environment replaces the RPST in the filesystem).
Otherwise, the environment variable is taken to hold the raw value of an RPST. Under these circumstances, the RPST cannot be refreshed; consequently, this mode is only usable for short-lived executables.
OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM:
If this points to an existing file path, then the filesystem-supplied private key will be retrieved from that location. As with the OCI_RESOURCE_PRINCIPAL_RPST, this mode supports token refresh if the environment can update the file contents.
Otherwise, the value is interpreted as the direct injection of a private key. The same considerations as to the lifetime of this value apply when directly injecting a key.
OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM_PASSPHRASE:
This is optional. If set, it contains either the location (as an existing file path) or the value of the passphrase associated with the private key.
OCI_RESOURCE_PRINCIPAL_REGION:
If set, this holds the canonical form of the local region. This is intended to enable executables to locate their "local" OCI service endpoints.
| Modifier and Type | Class and Description |
|---|---|
| public static class | |
| public static class | ResourcePrincipalAuthenticationDetailsProvider.
Builder for ResourcePrincipalAuthenticationDetailsProvider that understands the V2.2 configuration |
| Modifier and Type | Field and Description |
|---|---|
| private static final String | |
| private static final Logger | |
| pack-priv static final String | |
| pack-priv static final String | |
| pack-priv static final String | |
| private static final String | |
| pack-priv static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| private static final String | |
| pack-priv static final String | |
| protected final Region | region
Returns the region where the java code using resource principal authentication is running at |
| private static final String | |
| private static final String | |
| protected static final String | |
| protected static final String | |
| protected static final String | |
| pack-priv static final String | |
| protected static final String |
| Access | Constructor and Description |
|---|---|
| public | ResourcePrincipalAuthenticationDetailsProvider(FederationClient
federation client implementation. federationClient, SessionKeySupplier session key supplier implementation. sessionKeySupplier, Region the region region)Constructor of ResourcePrincipalAuthenticationDetailsProvider. |
| Modifier and Type | Method and Description |
|---|---|
| public static ResourcePrincipalAuthenticationDetailsProvider. | |
| protected static FederationClient | getFederationClientFromRpst(String ociResourcePrincipalRpst, String inputType, SessionKeySupplier sessionKeySupplier)
|
| public Region | |
| protected static Region | |
| protected static SessionKeySupplier | getSessionKeySupplierFromPemAndPassphrase(String ociResourcePrincipalPrivateKey, String ociResourcePrincipalPassphrase, String inputType)
|
| public String | Returns: the claim value.the name of a claim in the session token key)Session tokens carry JWT-like claims. |
| public String | Returns: the refreshed authentication dataImplements com. Refreshes the authentication data used by the provider |
| public String | Returns: the refreshed authentication datathe duration to check time)Implements com. Refreshes the authentication data used by the provider |
| public String | Returns: the refreshed authentication datathe duration to check time, boolean boolean value to enable/disable refresh of keys refreshKeys)Implements com. Refreshes the authentication data used by the provider |
| DEFAULT_OCI_RESOURCE_PRINCIPAL_RPT_PATH_FORV212 | back to summary |
|---|---|
| private static final String DEFAULT_OCI_RESOURCE_PRINCIPAL_RPT_PATH_FORV212 | |
| LOG | back to summary |
|---|---|
| private static final Logger LOG | |
| OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM | back to summary |
|---|---|
| pack-priv static final String OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM | |
| OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM_PASSPHRASE | back to summary |
|---|---|
| pack-priv static final String OCI_RESOURCE_PRINCIPAL_PRIVATE_PEM_PASSPHRASE | |
| OCI_RESOURCE_PRINCIPAL_REGION_ENV_VAR_NAME | back to summary |
|---|---|
| pack-priv static final String OCI_RESOURCE_PRINCIPAL_REGION_ENV_VAR_NAME | |
| OCI_RESOURCE_PRINCIPAL_RESOURCE_ID | back to summary |
|---|---|
| private static final String OCI_RESOURCE_PRINCIPAL_RESOURCE_ID | |
| OCI_RESOURCE_PRINCIPAL_RPST | back to summary |
|---|---|
| pack-priv static final String OCI_RESOURCE_PRINCIPAL_RPST | |
| OCI_RESOURCE_PRINCIPAL_RPST_ENDPOINT | back to summary |
|---|---|
| private static final String OCI_RESOURCE_PRINCIPAL_RPST_ENDPOINT | |
| OCI_RESOURCE_PRINCIPAL_RPT_ENDPOINT | back to summary |
|---|---|
| private static final String OCI_RESOURCE_PRINCIPAL_RPT_ENDPOINT | |
| OCI_RESOURCE_PRINCIPAL_RPT_PATH | back to summary |
|---|---|
| private static final String OCI_RESOURCE_PRINCIPAL_RPT_PATH | |
| OCI_RESOURCE_PRINCIPAL_SECURITY_CONTEXT | back to summary |
|---|---|
| private static final String OCI_RESOURCE_PRINCIPAL_SECURITY_CONTEXT | |
| OCI_RESOURCE_PRINCIPAL_TENANCY_ID | back to summary |
|---|---|
| private static final String OCI_RESOURCE_PRINCIPAL_TENANCY_ID | |
| OCI_RESOURCE_PRINCIPAL_VERSION | back to summary |
|---|---|
| pack-priv static final String OCI_RESOURCE_PRINCIPAL_VERSION | |
| region | back to summary |
|---|---|
| protected final Region region Returns the region where the java code using resource principal authentication is running at | |
| RP_DEBUG_INFORMATION_LOG | back to summary |
|---|---|
| private static final String RP_DEBUG_INFORMATION_LOG | |
| RP_VERSION_1_1 | back to summary |
|---|---|
| private static final String RP_VERSION_1_1 | |
| RP_VERSION_2_1 | back to summary |
|---|---|
| protected static final String RP_VERSION_2_1 | |
| RP_VERSION_2_1_1 | back to summary |
|---|---|
| protected static final String RP_VERSION_2_1_1 | |
| RP_VERSION_2_1_2 | back to summary |
|---|---|
| protected static final String RP_VERSION_2_1_2 | |
| RP_VERSION_2_2 | back to summary |
|---|---|
| pack-priv static final String RP_VERSION_2_2 | |
| RP_VERSION_3_0 | back to summary |
|---|---|
| protected static final String RP_VERSION_3_0 | |
| ResourcePrincipalAuthenticationDetailsProvider | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider(FederationClient federationClient, SessionKeySupplier sessionKeySupplier, Region region) Constructor of ResourcePrincipalAuthenticationDetailsProvider.
| |
| builder | back to summary |
|---|---|
| public static ResourcePrincipalAuthenticationDetailsProvider. | |
| getFederationClientFromRpst | back to summary |
|---|---|
| protected static FederationClient getFederationClientFromRpst(String ociResourcePrincipalRpst, String inputType, SessionKeySupplier sessionKeySupplier) | |
| getRegion | back to summary |
|---|---|
| public Region getRegion() Implements com. Doc from com. Returns the region.
| |
| getRegion | back to summary |
|---|---|
| protected static Region getRegion(String ociResourcePrincipalRegion, String inputType) | |
| getSessionKeySupplierFromPemAndPassphrase | back to summary |
|---|---|
| protected static SessionKeySupplier getSessionKeySupplierFromPemAndPassphrase(String ociResourcePrincipalPrivateKey, String ociResourcePrincipalPassphrase, String inputType) | |
| getStringClaim | back to summary |
|---|---|
| public String getStringClaim(String key) Session tokens carry JWT-like claims. Permit the retrieval of the value of those claims from
the token. At the least, the token should carry claims for | |
| refresh | back to summary |
|---|---|
| public String refresh() Implements com. Refreshes the authentication data used by the provider | |
| refreshIfExpiringWithin | back to summary |
|---|---|
| public String refreshIfExpiringWithin(Duration time) Implements com. Refreshes the authentication data used by the provider
| |
| refreshIfExpiringWithin | back to summary |
|---|---|
| public String refreshIfExpiringWithin(Duration time, boolean refreshKeys) Implements com. Refreshes the authentication data used by the provider
| |
| Modifier and Type | Field and Description |
|---|---|
| public static final String | COMPARTMENT_ID_CLAIM_KEY
COMPARTMENT_ID is the claim name that the RPST holds for the resource compartment. |
| public static final String | TENANT_ID_CLAIM_KEY
TENANT_ID_CLAIM_KEY is the claim name that the RPST holds for the resource tenancy. |
| Access | Constructor and Description |
|---|---|
| public |
| COMPARTMENT_ID_CLAIM_KEY | back to summary |
|---|---|
| public static final String COMPARTMENT_ID_CLAIM_KEY COMPARTMENT_ID is the claim name that the RPST holds for the resource compartment. This
can be passed to | |
| TENANT_ID_CLAIM_KEY | back to summary |
|---|---|
| public static final String TENANT_ID_CLAIM_KEY TENANT_ID_CLAIM_KEY is the claim name that the RPST holds for the resource tenancy. This
can be passed to | |
| ClaimKeys | back to summary |
|---|---|
| public ClaimKeys() | |
| Modifier and Type | Field and Description |
|---|---|
| protected CircuitBreakerConfiguration | circuitBreakerConfig
The configuration for the circuit breaker. |
| protected String | resourcePrincipalTokenEndpoint
The endpoint that can provide the resource principal token. |
| protected RptPathProvider | resourcePrincipalTokenPathProvider
The path provider for the resource principal token. |
| protected String | securityContext
The configuration for the security context. |
| Access | Constructor and Description |
|---|---|
| pack-priv |
| Modifier and Type | Method and Description |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider | build()
Overrides com. Examine the environment of the running process; construct a |
| public ResourcePrincipalAuthenticationDetailsProvider | |
| public ResourcePrincipalAuthenticationDetailsProvider | Returns: ResourcePrincipalAuthenticationDetailsProviderHelper method that interprets the runtime environment to build a v2.1.2-configured client |
| public ResourcePrincipalAuthenticationDetailsProvider | Returns: ResourcePrincipalAuthenticationDetailsProviderHelper method that interprets the runtime environment to build a v2.1 or 2.1.1-configured client |
| public static ResourcePrincipalAuthenticationDetailsProvider | Returns: ResourcePrincipalAuthenticationDetailsProviderHelper method that interprets the runtime environment to build a v2.2-configured client |
| public ResourcePrincipalAuthenticationDetailsProvider | Returns: ResourcePrincipalAuthenticationDetailsProviderHelper method that interprets the runtime environment to build a v3.0-configured client |
| protected ResourcePrincipalAuthenticationDetailsProvider | buildProvider(SessionKeySupplier
the session key supplier to use sessionKeySupplierToUse)Implements abstract com. Build the actual provider. |
| public ResourcePrincipalAuthenticationDetailsProvider. | circuitBreakerConfig(CircuitBreakerConfiguration circuitBreakerConfig)
Set value for the CircuitBreaker Configuration. |
| protected FederationClient | createFederationClient(SessionKeySupplier
the session key supplier sessionKeySupplier)
Create the federation client. |
| protected void | |
| private KeyPairAuthenticationDetailProvider | |
| public ResourcePrincipalAuthenticationDetailsProvider. | leafCertificateSupplier(X509CertificateSupplier leafCertificateSupplier)
Configures the custom leafCertificateSupplier to use. |
| public ResourcePrincipalAuthenticationDetailsProvider. | resourcePrincipalSessionTokenEndpoint(String resourcePrincipalSessionTokenEndpoint)
Deprecated
use
federationEndpoint(String)
Configures the resourcePrincipalSessionTokenEndpoint to use. |
| public ResourcePrincipalAuthenticationDetailsProvider. | resourcePrincipalTokenEndpoint(String resourcePrincipalTokenEndpoint)
Configures the resourcePrincipalTokenEndpoint to use. |
| public ResourcePrincipalAuthenticationDetailsProvider. | resourcePrincipalTokenEndpoint(Service service, Region region)
Configures the resourcePrincipalTokenEndpoint to use. |
| public ResourcePrincipalAuthenticationDetailsProvider. | resourcePrincipalTokenPathProvider(RptPathProvider resourcePrincipalTokenPathProvider)
Configures the resourcePrincipalTokenPathProvider to use. |
| public ResourcePrincipalAuthenticationDetailsProvider. |
| circuitBreakerConfig | back to summary |
|---|---|
| protected CircuitBreakerConfiguration circuitBreakerConfig The configuration for the circuit breaker. | |
| resourcePrincipalTokenEndpoint | back to summary |
|---|---|
| protected String resourcePrincipalTokenEndpoint The endpoint that can provide the resource principal token. Required. | |
| resourcePrincipalTokenPathProvider | back to summary |
|---|---|
| protected RptPathProvider resourcePrincipalTokenPathProvider The path provider for the resource principal token. Defaults to DefaultRptPathProvider if null | |
| securityContext | back to summary |
|---|---|
| protected String securityContext The configuration for the security context. | |
| ResourcePrincipalAuthenticationDetailsProviderBuilder | back to summary |
|---|---|
| pack-priv ResourcePrincipalAuthenticationDetailsProviderBuilder() | |
| build | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider build() Overrides com. Examine the environment of the running process; construct a
| |
| build_1_1 | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider build_1_1(String ociResourcePrincipalRptEndpoint, String ociResourcePrincipalRpstEndpoint) Helper method that interprets the runtime environment to build a v1.1-configured client
| |
| build_2_1_2 | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider build_2_1_2(String ociResourcePrincipalRptEndpoint, String ociResourcePrincipalRpstEndpoint, String ociResourcePrincipalTokenPath, String ociSecurityContext, String ociResourcePrincipalResourceId, String ociResourcePrincipalTenancyId, String ociResourcePrincipalPrivateKey, String ociResourcePrincipalPassphrase, String ociResourcePrincipalVersion) Helper method that interprets the runtime environment to build a v2.1.2-configured client
| |
| build_2_1_or_2_1_1 | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider build_2_1_or_2_1_1(String ociResourcePrincipalRptEndpoint, String ociResourcePrincipalRpstEndpoint, String ociResourcePrincipalResourceId, String ociResourcePrincipalTenancyId, String ociResourcePrincipalPrivateKey, String ociResourcePrincipalPassphrase, String ociResourcePrincipalVersion) Helper method that interprets the runtime environment to build a v2.1 or 2.1.1-configured client
| |
| build_2_2 | back to summary |
|---|---|
| public static ResourcePrincipalAuthenticationDetailsProvider build_2_2(String ociResourcePrincipalPrivateKey, String ociResourcePrincipalPassphrase, String ociResourcePrincipalRpst, String ociResourcePrincipalRegion, String inputType) Helper method that interprets the runtime environment to build a v2.2-configured client
| |
| build_3_0 | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider build_3_0() Helper method that interprets the runtime environment to build a v3.0-configured client
| |
| buildProvider | back to summary |
|---|---|
| protected ResourcePrincipalAuthenticationDetailsProvider buildProvider(SessionKeySupplier sessionKeySupplierToUse) Implements abstract com. Doc from com. Build the actual provider.
| |
| circuitBreakerConfig | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider. Set value for the CircuitBreaker Configuration. | |
| createFederationClient | back to summary |
|---|---|
| protected FederationClient createFederationClient(SessionKeySupplier sessionKeySupplier) Create the federation client.
| |
| createRptPathProvider | back to summary |
|---|---|
| protected void createRptPathProvider() | |
| getKeyPairAuthenticationDetailProvider | back to summary |
|---|---|
| private KeyPairAuthenticationDetailProvider getKeyPairAuthenticationDetailProvider(String ociResourcePrincipalResourceId, String ociResourcePrincipalPrivateKey, String ociResourcePrincipalPassphrase, String tenancyId, String ociResourcePrincipalVersion) | |
| leafCertificateSupplier | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider. Configures the custom leafCertificateSupplier to use. | |
| resourcePrincipalSessionTokenEndpoint | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider. Deprecated Configures the resourcePrincipalSessionTokenEndpoint to use.
| |
| resourcePrincipalTokenEndpoint | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider. Configures the resourcePrincipalTokenEndpoint to use. | |
| resourcePrincipalTokenEndpoint | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider. Configures the resourcePrincipalTokenEndpoint to use. | |
| resourcePrincipalTokenPathProvider | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider. Configures the resourcePrincipalTokenPathProvider to use. | |
| securityContext | back to summary |
|---|---|
| public ResourcePrincipalAuthenticationDetailsProvider. Set value for the security context to use. | |