Module com.microsoft.credentialstorage

Package com.microsoft.credentialstorage.implementation.posix.libsecret

Class LibSecretBackedSecureStore<E extends StoredSecret>

java.lang.Object

com.microsoft.credentialstorage.implementation.posix.libsecret.LibSecretBackedSecureStore<E>

Type Parameters:

E - secret class to store

All Implemented Interfaces:

SecretStore<E>

Direct Known Subclasses:

LibSecretBackedCredentialStore, LibSecretBackedTokenPairStore, LibSecretBackedTokenStore

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

Base class for Linux stores via libsecret library.

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	ALLOW_UNLOCK_DEFAULT_COLLECTION
protected static String	APP_NAME
protected static String	ATTRIBUTE_ACCOUNT
protected static String	ATTRIBUTE_KEY
protected static String	ATTRIBUTE_TYPE
protected static LibSecretLibrary	INSTANCE
protected static org.slf4j.Logger	logger
protected static LibSecretLibrary.SecretSchema	SCHEMA

Constructor Summary

Constructors

Constructor	Description
LibSecretBackedSecureStore()

Method Summary

Modifier and Type	Method	Description
protected static boolean	checkResult(com.sun.jna.ptr.PointerByReference error, 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 Libsecret.
protected boolean	deleteSecret(String key, com.sun.jna.ptr.PointerByReference error)
E	get(String key)	Read a secret from Libsecret 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 Libsecret
static boolean	isLibSecretSupported()	Check for Libsecret support on this platform
boolean	isSecure()	Libsecret is considered secure
static boolean	isSupported()
protected <T> T	readSecret(String key, BiFunction<String,char[],T> mapper)
protected boolean	writeSecret(String key, String account, char[] secret, com.sun.jna.ptr.PointerByReference error)

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 LibSecretLibrary INSTANCE

SCHEMA

protected static final LibSecretLibrary.SecretSchema SCHEMA

APP_NAME

protected static final String APP_NAME

See Also:

Constant Field Values

ALLOW_UNLOCK_DEFAULT_COLLECTION

protected static final String ALLOW_UNLOCK_DEFAULT_COLLECTION

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

LibSecretBackedSecureStore

public LibSecretBackedSecureStore()

Method Detail

get

public E get(String key)

Read a secret from Libsecret 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 Libsecret.

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()

Libsecret is considered secure

Specified by:

isSecure in interface SecretStore<E extends StoredSecret>

Returns:

true for Libsecret

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 Libsecret

Returns:

type string representation of the secret type

isLibSecretSupported

public static boolean isLibSecretSupported()

Check for Libsecret support on this platform

Returns:

true if Libsecret library is available; false otherwise

readSecret

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

writeSecret

protected boolean writeSecret(String key,
                              String account,
                              char[] secret,
                              com.sun.jna.ptr.PointerByReference error)

deleteSecret

protected boolean deleteSecret(String key,
                               com.sun.jna.ptr.PointerByReference error)

checkResult

protected static boolean checkResult(com.sun.jna.ptr.PointerByReference error,
                                     String message)