Package com.oracle.bmc.auth

Interface Summary

Interface	Description
AbstractAuthenticationDetailsProvider	Root interface for classes providing some information needed to authenticate requests.
AuthenticationDetailsProvider	Interface defining a BasicAuthenticationDetailsProvider that also provides the individual components used to create the keyId.
BasicAuthenticationDetailsProvider	Base interface used provide required information to sign requests to Oracle Cloud Infrastructure.
BasicConfigFileAuthenticationProvider	Interface defining AuthenticationDetailsProvider that also returns PEM file path and a list of ClientConfigurators
ConfigurableRefreshOnNotAuthenticatedProvider<T>	For authentication providers with refreshable authentication data (e.g. those which wrap a security token received from a remote service), this interface flags that when a caller receives a NotAuthenticated error (HTTP 401) that they can refresh the authentication data and retry their request.
ProvidesClientConfigurators	An interface that has the API to return a list of ClientConfigurators
ProvidesConfigurableRefresh	An interface that has the API to return refresh security token after if the token expires within a configurable time
ProvidesCustomRequestSigner
RefreshableOnNotAuthenticatedProvider<T>	For authentication providers with refreshable authentication data (e.g. those which wrap a security token received from a remote service), this interface flags that when a caller receives a NotAuthenticated error (HTTP 401) that they can refresh the authentication data and retry their request.
RegionProvider	A region provider has the API to return the region.
RequestSignerCacheConfigurationProvider	Optional marker for BasicAuthenticationDetailsProvider implementations that wish to control request-signer caching behaviour.
ServiceAccountTokenSupplier	A ServiceAccountTokenSupplier is responsible for providing kubernetes service account token used for oke workload identity
SessionKeySupplier	A session key supplier is responsible for providing public/private key pairs that will be used to both fetch federated service tokens and to sign individual requests to OCI.
X509CertificateSupplier	An interface to provide X509 certificate for a federated client.

Class Summary

Class	Description
AbstractFederationClientAuthenticationDetailsProviderBuilder<B extends AbstractFederationClientAuthenticationDetailsProviderBuilder<B,P>,P extends AbstractAuthenticationDetailsProvider>	Abstract builder base class for authentication details provider extending AbstractRequestingAuthenticationDetailsProvider
AbstractRequestingAuthenticationDetailsProvider	Base class for authentication details providers that make remote requests.
AbstractRequestingAuthenticationDetailsProvider.Builder<B extends AbstractRequestingAuthenticationDetailsProvider.Builder<B>>	Base class for builders.
AbstractRequestingAuthenticationDetailsProvider.CachingSessionKeySupplier	Helper class to cache the private key as bytes so we don’t have to parse it every time.
AbstractServiceAccountTokenSupplier
ConfigFileAuthenticationDetailsProvider	Implementation of AuthenticationDetailsProvider that uses a standard OCI configuration file as an input.
ConfigFileAuthenticationDetailsProvider.ConfigFileInstancePrincipalAuthenticationDetailsProvider
ConfigFileAuthenticationDetailsProvider.ConfigFileResourcePrincipalAuthenticationDetailsProvider
ConfigFileAuthenticationDetailsProvider.ConfigFileSimpleAuthenticationDetailsProvider
CustomerAuthenticationDetailsProvider
CustomerKeyIdFormatter	Formatter used to create the correct ‘keyId’ needed for signing requests.
DefaultServiceAccountTokenProvider	Implementation of ServiceAccountTokenSupplier that allows to pass in a token path to read kubernetes service account token If not set, then use default service account token path /var/run/secrets/kubernetes.io/serviceaccount/toke
InstancePrincipalsAuthenticationDetailsProvider	Implementation of BasicAuthenticationDetailsProvider that integrates with instance principal authentication endpoints to generate service tokens used for actual signing.
InstancePrincipalsAuthenticationDetailsProvider.InstancePrincipalsAuthenticationDetailsProviderBuilder	Builder for InstancePrincipalsAuthenticationDetailsProviderBuilder.
RequestSignerCacheConfiguration	Configuration object used by BasicAuthenticationDetailsProvider implementations to influence how request signer metadata should be cached.
RequestSignerCacheConfiguration.Builder	Builder for RequestSignerCacheConfiguration.
ResourcePrincipalAuthenticationDetailsProvider	This constructs a default implementation of the ResourcePrincipalAuthenticationDetailsProvider, constructed in accordance with the following environment variable settings: OCI_RESOURCE_PRINCIPAL_VERSION:
ResourcePrincipalAuthenticationDetailsProvider.ClaimKeys
ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder	Builder for ResourcePrincipalAuthenticationDetailsProvider that understands the V2.2 configuration
ResourcePrincipalsV3AuthenticationDetailsProvider	This constructs a default implementation of the ResourcePrincipalAuthenticationDetailsProvider, integrates with resource principal authentication services to generate resource principal session token used for actual signing.
ResourcePrincipalsV3AuthenticationDetailsProvider.ResourcePrincipalsV3AuthenticationDetailsProviderBuilder	Builder for ResourcePrincipalsAuthenticationDetailsProviderBuilder.
SessionTokenAuthenticationDetailsProvider	Implementation of AuthenticationDetailsProvider that uses a session token for authentication.
SimpleAuthenticationDetailsProvider	Basic implementation of AuthenticationDetailsProvider that just returns configured values.
SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder
SimplePrivateKeySupplier	Simple Supplier for the private key that handles missing files.
StringPrivateKeySupplier	Supplier for private key in String format
SuppliedServiceAccountTokenProvider	Implementation of ServiceAccountTokenSupplier that allows to pass in a token to be used as a kubernetes service account token.
URLBasedX509CertificateSupplier	X509CertificateSupplier implementation that reads both certificate and private key off of URL.
URLBasedX509CertificateSupplier.ResourceDetails
URLBasedX509CertificateSupplier.ResourceDetails.ResourceDetailsBuilder
X509CertificateSupplier.CertificateAndPrivateKeyPair
YubikeyAuthenticationDetailsProvider	Implementation of AuthenticationDetailsProvider that uses yubikey for authentication.
YubikeyAuthenticationDetailsProvider.YubikeyAuthenticationDetailsProviderBuilder
YubikeyConfig
YubikeyConfig.YubikeyConfigBuilder

Annotation Types Summary

Annotation Type	Description
AuthCachingPolicy	AuthCachingPolicy provides the ability to annotation basic auth providers with what level of caching a request signer should try to follow.