Module com.microsoft.credentialstorage

Package com.microsoft.credentialstorage.implementation.posix.keyring

Class GnomeKeyringBackedSecureStore<E extends StoredSecret>

java.lang.Object

com.microsoft.credentialstorage.implementation.posix.keyring.GnomeKeyringBackedSecureStore<E>

Type Parameters:

E - secret class to store

All Implemented Interfaces:

SecretStore<E>

Direct Known Subclasses:

GnomeKeyringBackedCredentialStore, GnomeKeyringBackedTokenPairStore, GnomeKeyringBackedTokenStore

public abstract class GnomeKeyringBackedSecureStore<E extends StoredSecret>
extends Object
implements SecretStore<E>

Base class for GNOME Keyring stores.

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	ALLOW_UNLOCK_KEYRING
protected static String	APP_NAME
protected static String	ATTRIBUTE_ACCOUNT
protected static String	ATTRIBUTE_KEY
protected static String	ATTRIBUTE_TYPE
protected static GnomeKeyringLibrary	INSTANCE
protected static org.slf4j.Logger	logger
protected static GnomeKeyringLibrary.GnomeKeyringPasswordSchema	SCHEMA

Constructor Summary

Constructors

Constructor	Description
GnomeKeyringBackedSecureStore()

Method Summary

Modifier and Type	Method	Description
protected static boolean	checkResult(int retCode, String message)
protected abstract E	create(String username, char[] secret)	Create a Secret from the string representation
boolean	delete(String key)	Delete a secret from GNOME Keyring.
protected int	deleteSecret(String key)
E	get(String key)	Read a secret from GNOME Keyring using its item API to get attributes containing username.
protected abstract String	getType()	Return the type of this secure store, used to match the secret in GNOME Keyring
boolean	isSecure()	GNOME Keyring is considered secure
static boolean	isSupported()
protected <T> T	readSecret(String key, BiFunction<String,char[],T> mapper)
protected int	writeSecret(String key, String account, char[] secret)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.microsoft.credentialstorage.SecretStore

add

Field Detail

logger

protected static final org.slf4j.Logger logger

INSTANCE

protected static final GnomeKeyringLibrary INSTANCE

SCHEMA

protected static final GnomeKeyringLibrary.GnomeKeyringPasswordSchema SCHEMA

APP_NAME

protected static final String APP_NAME

See Also:

Constant Field Values

ALLOW_UNLOCK_KEYRING

protected static final String ALLOW_UNLOCK_KEYRING

See Also:

Constant Field Values

ATTRIBUTE_TYPE

protected static final String ATTRIBUTE_TYPE

See Also:

Constant Field Values

ATTRIBUTE_KEY

protected static final String ATTRIBUTE_KEY

See Also:

Constant Field Values

ATTRIBUTE_ACCOUNT

protected static final String ATTRIBUTE_ACCOUNT

See Also:

Constant Field Values

Constructor Detail

GnomeKeyringBackedSecureStore

public GnomeKeyringBackedSecureStore()

Method Detail

get

public E get(String key)

Read a secret from GNOME Keyring using its item API to get attributes containing username.

Specified by:

get in interface SecretStore<E extends StoredSecret>

Parameters:

key - for which a secret is associated with

Returns:

secret

delete

public boolean delete(String key)

Delete a secret from GNOME Keyring.

Specified by:

delete in interface SecretStore<E extends StoredSecret>

Parameters:

key - for which a secret is associated with

Returns:

true if operation succeeded

isSecure

public boolean isSecure()

GNOME Keyring is considered secure

Specified by:

isSecure in interface SecretStore<E extends StoredSecret>

Returns:

true for GNOME Keyring

isSupported

public static boolean isSupported()

create

protected abstract E create(String username,
                            char[] secret)

Create a Secret from the string representation

Parameters:

username - username for the secret

secret - password, oauth2 access token, or Personal Access Token

Returns:

a Secret from the input

getType

protected abstract String getType()

Return the type of this secure store, used to match the secret in GNOME Keyring

Returns:

type string representation of the secret type

readSecret

protected <T> T readSecret(String key,
                           BiFunction<String,char[],T> mapper)

writeSecret

protected int writeSecret(String key,
                          String account,
                          char[] secret)

deleteSecret

protected int deleteSecret(String key)

checkResult

protected static boolean checkResult(int retCode,
                                     String message)