com.microsoft.alm.storage.windows.internal

Class CredManagerBackedSecureStore<E extends Secret>

java.lang.Object

com.microsoft.alm.storage.windows.internal.CredManagerBackedSecureStore<E>

All Implemented Interfaces:

SecretStore<E>

Direct Known Subclasses:

CredManagerBackedCredentialStore, CredManagerBackedTokenPairStore, CredManagerBackedTokenStore

public abstract class CredManagerBackedSecureStore<E extends Secret>
extends Object
implements SecretStore<E>

This class exposes functions to interact with Windows Credential Manager

Constructor Summary

Constructors

Constructor and Description
CredManagerBackedSecureStore()

Method Summary

Modifier and Type	Method and Description
boolean	add(String key, E secret) Add the specified secret to Windows Credential Manager Multi-thread safe, synchronized access to store
protected abstract E	create(String username, String secret) Create a Secret from the string representation
boolean	delete(String key) Delete the stored credential from Credential Manager Multi-thread safe, synchronized access to store
E	get(String key) Read calls CredRead on Windows and retrieve the Secret Multi-thread safe, synchronized access to store
protected abstract String	getCredentialBlob(E secret) Get String representation of the CredentialBlob field from the secret
protected abstract String	getUsername(E secret) Get String representation of the UserName field from the Secret
boolean	isSecure() Windows credential manager is considered a secure storage for secrets

Methods inherited from class java.lang.Object

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

Constructor Detail

CredManagerBackedSecureStore

public CredManagerBackedSecureStore()

Method Detail

create

protected abstract E create(String username,
                            String 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

getUsername

protected abstract String getUsername(E secret)

Get String representation of the UserName field from the Secret

Parameters:

secret - A Credential, Token or TokenPair

Returns:

username from this secret

getCredentialBlob

protected abstract String getCredentialBlob(E secret)

Get String representation of the CredentialBlob field from the secret

Parameters:

secret - A Credential, Token or TokenPair

Returns:

credential from this secre

get

public E get(String key)

Read calls CredRead on Windows and retrieve the Secret Multi-thread safe, synchronized access to store

Specified by:

get in interface SecretStore<E extends Secret>

Parameters:

key - TargetName in the credential structure

delete

public boolean delete(String key)

Delete the stored credential from Credential Manager Multi-thread safe, synchronized access to store

Specified by:

delete in interface SecretStore<E extends Secret>

Parameters:

key - TargetName in the credential structure

Returns:

true if delete successful, false otherwise (including key doesn't exist)

add

public boolean add(String key,
                   E secret)

Add the specified secret to Windows Credential Manager Multi-thread safe, synchronized access to store

Specified by:

add in interface SecretStore<E extends Secret>

Parameters:

key - TargetName in the credential structure

secret - secret to be stored

Returns:

true if successfully added false otherwise

isSecure

public boolean isSecure()

Windows credential manager is considered a secure storage for secrets

Specified by:

isSecure in interface SecretStore<E extends Secret>

Returns:

true for Windows Credential Manager