KIPLATFORM::SECRETS Namespace Reference

Functions
bool	StoreSecret (const wxString &aService, const wxString &aKey, const wxString &aSecret)
bool	GetSecret (const wxString &aService, const wxString &aKey, wxString &aSecret)
bool	GetSecretNoPrompt (const wxString &aService, const wxString &aKey, wxString &aSecret)
	Like GetSecret(), but never waits on the user.
bool	DeleteSecret (const wxString &aService, const wxString &aKey)

Variables
static const SecretSchema	schema

Function Documentation

DeleteSecret()

bool KIPLATFORM::SECRETS::DeleteSecret	(	const wxString &	aService,
		const wxString &	aKey )

Definition at line 144 of file unix/secrets.cpp.

References schema.

Referenced by PLATFORM_SECRET_BACKEND::DeleteSecret(), and StoreDatabasePassword().

GetSecret()

bool KIPLATFORM::SECRETS::GetSecret	(	const wxString &	aService,
		const wxString &	aKey,
		wxString &	aSecret )

Definition at line 68 of file unix/secrets.cpp.

References schema.

Referenced by KIGIT_COMMON::GetPassword(), and PLATFORM_SECRET_BACKEND::GetSecret().

GetSecretNoPrompt()

bool KIPLATFORM::SECRETS::GetSecretNoPrompt	(	const wxString &	aService,
		const wxString &	aKey,
		wxString &	aSecret )

Like GetSecret(), but never waits on the user.

A locked keyring is reported as not found instead of showing an unlock prompt, so it is safe on paths that must not block.

Definition at line 96 of file unix/secrets.cpp.

References schema, and text.

Referenced by DefaultDatabaseSecretLookup(), and IsNoPromptSecretLookup().

StoreSecret()

bool KIPLATFORM::SECRETS::StoreSecret	(	const wxString &	aService,
		const wxString &	aKey,
		const wxString &	aSecret )

Definition at line 38 of file unix/secrets.cpp.

References schema.

Referenced by KICAD_MANAGER_CONTROL::NewFromRepository(), KIGIT::PromptForCredentials(), saveAcceptedRemoteSettings(), StoreDatabasePassword(), and PLATFORM_SECRET_BACKEND::StoreSecret().

Variable Documentation

schema

const SecretSchema KIPLATFORM::SECRETS::schema

static

Initial value:

=
        {
            "org.kicad.kicad", SECRET_SCHEMA_NONE,
            {
                { "service", SECRET_SCHEMA_ATTRIBUTE_STRING },
                { "key", SECRET_SCHEMA_ATTRIBUTE_STRING },
                { nullptr, SECRET_SCHEMA_ATTRIBUTE_STRING }
            }
        }

Definition at line 28 of file unix/secrets.cpp.

Referenced by DeleteSecret(), GetSecret(), GetSecretNoPrompt(), and StoreSecret().