Nickvision::Keyring::SystemCredentials Namespace Reference

Functions
std::optional< Credential >	getCredential (const std::string &name)
	Gets a credential from the system's credential manager.
std::optional< Credential >	addCredential (const std::string &name)
	Adds a new credential with a random password to the system's credential manager.
bool	addCredential (const Credential &credential)
	Adds a new credential to the system's credential manager.
bool	updateCredential (const Credential &credential)
	Updates a credential in the system's credential manager.
bool	deleteCredential (const std::string &name)
	Deletes a credential from the system's credential manager.

Function Documentation

addCredential() [1/2]

bool Nickvision::Keyring::SystemCredentials::addCredential

(

const Credential &

credential

)

Adds a new credential to the system's credential manager.

On Linux, only the name and password of a credential will be stored.

On Windows, all fields of a credential will be stored.

On macOS, all fields of a credential will be stored.

Parameters

credential

The new credential object

Returns

True if successful, else false

addCredential() [2/2]

std::optional< Credential > Nickvision::Keyring::SystemCredentials::addCredential

(

const std::string &

name

)

Adds a new credential with a random password to the system's credential manager.

Parameters

name	The name of the credential

Returns

The new Credential object, if successful

deleteCredential()

bool Nickvision::Keyring::SystemCredentials::deleteCredential

(

const std::string &

name

)

Deletes a credential from the system's credential manager.

Parameters

name	The name of the credential to delete

Returns

True if successful, else false

getCredential()

std::optional< Credential > Nickvision::Keyring::SystemCredentials::getCredential

(

const std::string &

name

)

Gets a credential from the system's credential manager.

Parameters

name	The name of the credential

Returns

The Credential object, if found

updateCredential()

bool Nickvision::Keyring::SystemCredentials::updateCredential

(

const Credential &

credential

)

Updates a credential in the system's credential manager.

On Linux, only the name and password of a credential will be stored.

On Windows, all fields of a credential will be stored.

On macOS, all fields of a credential will be stored.

Parameters

credential

The updated credential object

Returns

True if successful, else false