Package com.oracle.bmc.auth

Class YubikeyAuthenticationDetailsProvider

java.lang.Object

com.oracle.bmc.auth.YubikeyAuthenticationDetailsProvider

All Implemented Interfaces:

AbstractAuthenticationDetailsProvider, AuthenticationDetailsProvider, BasicAuthenticationDetailsProvider, RegionProvider

public class YubikeyAuthenticationDetailsProvider
extends Object
implements AuthenticationDetailsProvider, RegionProvider

Implementation of AuthenticationDetailsProvider that uses yubikey for authentication.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	YubikeyAuthenticationDetailsProvider.YubikeyAuthenticationDetailsProviderBuilder

Constructor Summary

Constructors

Constructor	Description
YubikeyAuthenticationDetailsProvider(ConfigFileReader.ConfigFile configFile, Region region, String tenantId, String userId, char[] yubikeyPassphraseCharacters, YubikeyConfig yubikeyConfig, String keyId)	Creates a new YubikeyAuthenticationDetailsProvider instance.

Method Summary

Modifier and Type	Method	Description
static YubikeyAuthenticationDetailsProvider.YubikeyAuthenticationDetailsProviderBuilder	builder()
String	getFingerprint()	Returns the fingerprint of the key being used.
String	getKeyId()	Returns the keyId used to sign requests.
String	getPassPhrase()	Deprecated.
char[]	getPassphraseCharacters()	Returns the optional pass phrase for the (encrypted) private key, as a character array.
InputStream	getPrivateKey()	Returns a new InputStream to the private key.
Region	getRegion()	Returns the region.
String	getTenantId()	Returns the tenant OCID.
String	getUserId()	Returns the user OCID.
PrivateKey	getYubikeyPrivateKey()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

YubikeyAuthenticationDetailsProvider

public YubikeyAuthenticationDetailsProvider(ConfigFileReader.ConfigFile configFile,
                                            Region region,
                                            String tenantId,
                                            String userId,
                                            char[] yubikeyPassphraseCharacters,
                                            YubikeyConfig yubikeyConfig,
                                            String keyId)
                                     throws IOException,
                                            NullPointerException

Creates a new YubikeyAuthenticationDetailsProvider instance.

Details come from Builder. For certain parameters, if the value is @null, then the details from YubikeyConfig are used, if the values are still null, then config file is tried.

Parameters:

configFile - The configuration file to use, if any

region - region which overrides the region from the configFile

tenantId - tenantId which overrides tenantId in the configFile

userId - userId which overrides the user in the configFile

yubikeyPassphraseCharacters - passphraseCharacters which override passphrase in the configFile

yubikeyConfig - The yubikeyConfig to use, if any

keyId - keyId to use with form tenantId/userId/YubikeyFingerprint

Throws:

IOException - if the configuration file could not be loaded

NullPointerException

Method Detail

getKeyId

public String getKeyId()

Description copied from interface: BasicAuthenticationDetailsProvider

Returns the keyId used to sign requests.

Specified by:

getKeyId in interface BasicAuthenticationDetailsProvider

Returns:

The keyId.

getPrivateKey

public InputStream getPrivateKey()

Description copied from interface: BasicAuthenticationDetailsProvider

Returns a new InputStream to the private key.

This stream should be closed by the caller, implementations should return new streams each time.

Specified by:

getPrivateKey in interface BasicAuthenticationDetailsProvider

Returns:

A new InputStream.

getPassPhrase

@Deprecated
public String getPassPhrase()

Deprecated.

Description copied from interface: BasicAuthenticationDetailsProvider

Returns the optional pass phrase for the (encrypted) private key.

Specified by:

getPassPhrase in interface BasicAuthenticationDetailsProvider

Returns:

The pass phrase, or null if not applicable

getPassphraseCharacters

public char[] getPassphraseCharacters()

Description copied from interface: BasicAuthenticationDetailsProvider

Returns the optional pass phrase for the (encrypted) private key, as a character array.

Specified by:

getPassphraseCharacters in interface BasicAuthenticationDetailsProvider

Returns:

The pass phrase as character array, or null if not applicable

getFingerprint

public String getFingerprint()

Description copied from interface: AuthenticationDetailsProvider

Returns the fingerprint of the key being used.

Specified by:

getFingerprint in interface AuthenticationDetailsProvider

Returns:

The fingerprint.

getTenantId

public String getTenantId()

Description copied from interface: AuthenticationDetailsProvider

Returns the tenant OCID.

Specified by:

getTenantId in interface AuthenticationDetailsProvider

Returns:

The tenant OCID.

getUserId

public String getUserId()

Description copied from interface: AuthenticationDetailsProvider

Returns the user OCID.

Specified by:

getUserId in interface AuthenticationDetailsProvider

Returns:

The user OCID.

getRegion

public Region getRegion()

Description copied from interface: RegionProvider

Returns the region.

Specified by:

getRegion in interface RegionProvider

Returns:

Region object.

getYubikeyPrivateKey

public PrivateKey getYubikeyPrivateKey()

toString

public String toString()

Overrides:

toString in class Object

builder

public static YubikeyAuthenticationDetailsProvider.YubikeyAuthenticationDetailsProviderBuilder builder()