Singleton offering an interface to manage the authentication configuration database and to utilize configurations through various authentication method plugins. More...

#include <qgsauthmanager.h>

Inheritance diagram for QgsAuthManager:

[legend]

Public Types
enum	MessageLevel { INFO = 0 , WARNING = 1 , CRITICAL = 2 }
	Message log level (mirrors that of QgsMessageLog, so it can also output there) More...

Public Slots
void	clearAllCachedConfigs ()
	Clear all authentication configs from authentication method caches. More...

void	clearCachedConfig (const QString &authcfg)
	Clear an authentication config from its associated authentication method cache. More...

Signals
void	authDatabaseChanged ()
	Emitted when the authentication db is significantly changed, e.g. large record removal, erased, etc. More...

void	authDatabaseEraseRequested ()
	Emitted when a user has indicated they may want to erase the authentication db. More...

void	masterPasswordVerified (bool verified)
	Emitted when a password has been verify (or not) More...

void	messageOut (const QString &message, const QString &tag=QgsAuthManager::AUTH_MAN_TAG, QgsAuthManager::MessageLevel level=QgsAuthManager::INFO) const
	Custom logging signal to relay to console output and QgsMessageLog. More...

void	passwordHelperFailure ()
	Signals emitted on password helper failure, mainly used in the tests to exit main application loop. More...

void	passwordHelperMessageOut (const QString &message, const QString &tag=QgsAuthManager::AUTH_MAN_TAG, QgsAuthManager::MessageLevel level=QgsAuthManager::INFO)
	Custom logging signal to inform the user about master password <-> password manager interactions. More...

void	passwordHelperSuccess ()
	Signals emitted on password helper success, mainly used in the tests to exit main application loop. More...

Public Member Functions
	~QgsAuthManager () override

const QString	authDatabaseConfigTable () const
	Name of the authentication database table that stores configs. More...

QSqlDatabase	authDatabaseConnection () const
	Sets up the application instance of the authentication database connection. More...

const QString	authDatabaseServersTable () const
	Name of the authentication database table that stores server exceptions/configs. More...

const QString	authenticationDatabasePath () const
	The standard authentication database file in ~/.qgis3/ or defined location. More...

QString	authManTag () const
	Simple text tag describing authentication system for message logs. More...

QgsAuthMethod *	authMethod (const QString &authMethodKey)
	Gets authentication method from the config/provider cache via its key. More...

const QgsAuthMethodMetadata *	authMethodMetadata (const QString &authMethodKey)
	Gets authentication method metadata via its key. More...

QStringList	authMethodsKeys (const QString &dataprovider=QString())
	Gets keys of supported authentication methods. More...

QgsAuthMethodsMap	authMethodsMap (const QString &dataprovider=QString())
	Gets available authentication methods mapped to their key. More...

QVariant	authSetting (const QString &key, const QVariant &defaultValue=QVariant(), bool decrypt=false)
	authSetting get an authentication setting (retrieved as string and returned as QVariant( QString )) More...

QgsAuthMethodConfigsMap	availableAuthMethodConfigs (const QString &dataprovider=QString())
	Gets mapping of authentication config ids and their base configs (not decrypted data) More...

bool	backupAuthenticationDatabase (QString *backuppath=nullptr)
	Close connection to current authentication database and back it up. More...

const QMap< QString, QPair< QgsAuthCertUtils::CaCertSource, QSslCertificate > >	caCertsCache ()
	caCertsCache get all CA certs mapped to their sha1 from cache. More...

const QSslCertificate	certAuthority (const QString &id)
	Gets a certificate authority by id (sha hash) More...

const QList< QSslCertificate >	certIdentities ()
	certIdentities get certificate identities More...

const QSslCertificate	certIdentity (const QString &id)
	certIdentity get a certificate identity by id (sha hash) More...

const QPair< QSslCertificate, QSslKey >	certIdentityBundle (const QString &id)
	Gets a certificate identity bundle by id (sha hash). More...

const QStringList	certIdentityBundleToPem (const QString &id)
	certIdentityBundleToPem get a certificate identity bundle by id (sha hash) returned as PEM text More...

QStringList	certIdentityIds () const
	certIdentityIds get list of certificate identity ids from database More...

QgsAuthCertUtils::CertTrustPolicy	certificateTrustPolicy (const QSslCertificate &cert)
	certificateTrustPolicy get trust policy for a particular certificate cert More...

const QMap< QgsAuthCertUtils::CertTrustPolicy, QStringList >	certTrustCache ()
	certTrustCache get cache of certificate sha1s, per trust policy More...

QgsAuthCertUtils::CertTrustPolicy	certTrustPolicy (const QSslCertificate &cert)
	certTrustPolicy get whether certificate cert is trusted by user More...

void	clearMasterPassword ()
	Clear supplied master password. More...

QgsAuthMethod *	configAuthMethod (const QString &authcfg)
	Gets authentication method from the config/provider cache. More...

QString	configAuthMethodKey (const QString &authcfg) const
	Gets key of authentication method associated with config ID. More...

QString	configIdRegex () const
	Returns the regular expression for authcfg=.{7} key/value token for authentication ids. More...

QStringList	configIds () const
	Gets list of authentication ids from database. More...

bool	configIdUnique (const QString &id) const
	Verify if provided authentication id is unique. More...

const QList< QSslCertificate >	databaseCAs ()
	databaseCAs get database-stored certificate authorities More...

QgsAuthCertUtils::CertTrustPolicy	defaultCertTrustPolicy ()
	Gets the default certificate trust policy preferred by user. More...

const QString	disabledMessage () const
	Standard message for when QCA's qca-ossl plugin is missing and system is disabled. More...

void	dumpIgnoredSslErrorsCache_ ()
	Utility function to dump the cache for debug purposes. More...

bool	eraseAuthenticationDatabase (bool backup, QString *backuppath=nullptr)
	Erase all rows from all tables in authentication database. More...

bool	existsAuthSetting (const QString &key)
	Check if an authentication setting exists. More...

bool	existsCertAuthority (const QSslCertificate &cert)
	Check if a certificate authority exists. More...

bool	existsCertIdentity (const QString &id)
	Check if a certificate identity exists. More...

bool	existsSslCertCustomConfig (const QString &id, const QString &hostport)
	Check if SSL certificate custom config exists. More...

bool	exportAuthenticationConfigsToXml (const QString &filename, const QStringList &authcfgs, const QString &password=QString())
	Export authentication configurations to an XML file. More...

const QList< QSslCertificate >	extraFileCAs ()
	extraFileCAs extra file-based certificate authorities More...

bool	hasConfigId (const QString &txt) const
	Returns whether a string includes an authcfg ID token. More...

QHash< QString, QSet< QSslError::SslError > >	ignoredSslErrorCache ()
	ignoredSslErrorCache Get ignored SSL error cache, keyed with cert/connection's sha:host:port. More...

bool	importAuthenticationConfigsFromXml (const QString &filename, const QString &password=QString(), bool overwrite=false)
	Import authentication configurations from an XML file. More...

bool	init (const QString &pluginPath=QString(), const QString &authDatabasePath=QString())
	init initialize QCA, prioritize qca-ossl plugin and optionally set up the authentication database More...

bool	initSslCaches ()
	Initialize various SSL authentication caches. More...

bool	isDisabled () const
	Whether QCA has the qca-ossl plugin, which a base run-time requirement. More...

bool	loadAuthenticationConfig (const QString &authcfg, QgsAuthMethodConfig &mconfig, bool full=false)
	Load an authentication config from the database into subclass. More...

const QMap< QString, QSslCertificate >	mappedDatabaseCAs ()
	mappedDatabaseCAs get sha1-mapped database-stored certificate authorities More...

bool	masterPasswordHashInDatabase () const
	Verify a password hash existing in authentication database. More...

bool	masterPasswordIsSet () const
	Whether master password has be input and verified, i.e. authentication database is accessible. More...

bool	masterPasswordSame (const QString &pass) const
	Check whether supplied password is the same as the one already set. More...

bool	passwordHelperDelete ()
	Delete master password from wallet. More...

bool	passwordHelperEnabled () const
	Password helper enabled getter. More...

const QString	passwordHelperErrorMessage ()
	Error message getter. More...

bool	passwordHelperLoggingEnabled () const
	Password helper logging enabled getter. More...

bool	passwordHelperSync ()
	Store the password manager into the wallet. More...

bool	rebuildCaCertsCache ()
	Rebuild certificate authority cache. More...

bool	rebuildCertTrustCache ()
	Rebuild certificate authority cache. More...

bool	rebuildIgnoredSslErrorCache ()
	Rebuild ignoredSSL error cache. More...

bool	rebuildTrustedCaCertsCache ()
	Rebuild trusted certificate authorities cache. More...

bool	registerCoreAuthMethods ()
	Instantiate and register existing C++ core authentication methods from plugins. More...

bool	removeAllAuthenticationConfigs ()
	Clear all authentication configs from table in database and from provider caches. More...

bool	removeAuthenticationConfig (const QString &authcfg)
	Remove an authentication config in the database. More...

bool	removeAuthSetting (const QString &key)
	Remove an authentication setting. More...

bool	removeCertAuthority (const QSslCertificate &cert)
	Remove a certificate authority. More...

bool	removeCertIdentity (const QString &id)
	Remove a certificate identity. More...

bool	removeCertTrustPolicies (const QList< QSslCertificate > &certs)
	Remove a group certificate authorities. More...

bool	removeCertTrustPolicy (const QSslCertificate &cert)
	Remove a certificate authority. More...

bool	removeSslCertCustomConfig (const QString &id, const QString &hostport)
	Remove an SSL certificate custom config. More...

bool	resetMasterPassword (const QString &newpass, const QString &oldpass, bool keepbackup, QString *backuppath=nullptr)
	Reset the master password to a new one, then re-encrypt all previous configs in a new database file, optionally backup curren database. More...

bool	scheduledAuthDatabaseErase ()
	Whether there is a scheduled opitonal erase of authentication database. More...

bool	setDefaultCertTrustPolicy (QgsAuthCertUtils::CertTrustPolicy policy)
	Sets the default certificate trust policy preferred by user. More...

bool	setMasterPassword (bool verify=false)
	Main call to initially set or continually check master password is set. More...

bool	setMasterPassword (const QString &pass, bool verify=false)
	Overloaded call to reset master password or set it initially without user interaction. More...

void	setPasswordHelperEnabled (bool enabled)
	Password helper enabled setter. More...

void	setPasswordHelperLoggingEnabled (bool enabled)
	Password helper logging enabled setter. More...

void	setScheduledAuthDatabaseErase (bool scheduleErase)
	Schedule an optional erase of authentication database, starting when mutex is lockable. More...

void	setScheduledAuthDatabaseEraseRequestEmitted (bool emitted)
	Re-emit a signal to schedule an optional erase of authentication database. More...

const QgsAuthConfigSslServer	sslCertCustomConfig (const QString &id, const QString &hostport)
	sslCertCustomConfig get an SSL certificate custom config by id (sha hash) and hostport (host:port) More...

const QgsAuthConfigSslServer	sslCertCustomConfigByHost (const QString &hostport)
	sslCertCustomConfigByHost get an SSL certificate custom config by hostport (host:port) More...

const QList< QgsAuthConfigSslServer >	sslCertCustomConfigs ()
	sslCertCustomConfigs get SSL certificate custom configs More...

bool	storeAuthenticationConfig (QgsAuthMethodConfig &mconfig, bool overwrite=false)
	Store an authentication config in the database. More...

bool	storeAuthSetting (const QString &key, const QVariant &value, bool encrypt=false)
	Store an authentication setting (stored as string via QVariant( value ).toString() ) More...

bool	storeCertAuthorities (const QList< QSslCertificate > &certs)
	Store multiple certificate authorities. More...

bool	storeCertAuthority (const QSslCertificate &cert)
	Store a certificate authority. More...

bool	storeCertIdentity (const QSslCertificate &cert, const QSslKey &key)
	Store a certificate identity. More...

bool	storeCertTrustPolicy (const QSslCertificate &cert, QgsAuthCertUtils::CertTrustPolicy policy)
	Store user trust value for a certificate. More...

bool	storeSslCertCustomConfig (const QgsAuthConfigSslServer &config)
	Store an SSL certificate custom config. More...

QgsAuthMethod::Expansions	supportedAuthMethodExpansions (const QString &authcfg)
	Gets supported authentication method expansion(s), e.g. More...

const QList< QSslCertificate >	systemRootCAs ()
	systemRootCAs get root system certificate authorities More...

const QList< QSslCertificate >	trustedCaCerts (bool includeinvalid=false)
	trustedCaCerts get list of all trusted CA certificates More...

const QList< QSslCertificate >	trustedCaCertsCache ()
	trustedCaCertsCache cache of trusted certificate authorities, ready for network connections More...

const QByteArray	trustedCaCertsPemText ()
	trustedCaCertsPemText get concatenated string of all trusted CA certificates More...

const QString	uniqueConfigId () const
	Gets a unique generated 7-character string to assign to as config id. More...

const QList< QSslCertificate >	untrustedCaCerts (QList< QSslCertificate > trustedCAs=QList< QSslCertificate >())
	untrustedCaCerts get list of untrusted certificate authorities More...

bool	updateAuthenticationConfig (const QgsAuthMethodConfig &config)
	Update an authentication config in the database. More...

void	updateConfigAuthMethods ()
	Sync the confg/authentication method cache with what is in database. More...

bool	updateDataSourceUriItems (QStringList &connectionItems, const QString &authcfg, const QString &dataprovider=QString())
	Provider call to update a QgsDataSourceUri with an authentication config. More...

bool	updateIgnoredSslErrorsCache (const QString &shahostport, const QList< QSslError > &errors)
	Update ignored SSL error cache with possible ignored SSL errors, using sha:host:port key. More...

bool	updateIgnoredSslErrorsCacheFromConfig (const QgsAuthConfigSslServer &config)
	Update ignored SSL error cache with possible ignored SSL errors, using server config. More...

bool	updateNetworkProxy (QNetworkProxy &proxy, const QString &authcfg, const QString &dataprovider=QString())
	Provider call to update a QNetworkProxy with an authentication config. More...

bool	updateNetworkReply (QNetworkReply *reply, const QString &authcfg, const QString &dataprovider=QString())
	Provider call to update a QNetworkReply with an authentication config (used to skip known SSL errors, etc.) More...

bool	updateNetworkRequest (QNetworkRequest &request, const QString &authcfg, const QString &dataprovider=QString())
	Provider call to update a QNetworkRequest with an authentication config. More...

bool	verifyMasterPassword (const QString &compare=QString())
	Verify the supplied master password against any existing hash in authentication database. More...

Static Public Attributes
static const QString	AUTH_MAN_TAG = QObject::tr( "Authentication Manager" )
	The display name of the Authentication Manager. More...

static const QString	AUTH_PASSWORD_HELPER_DISPLAY_NAME
	The display name of the password helper (platform dependent) More...

Protected Member Functions
	QgsAuthManager ()

Static Protected Member Functions
static QgsAuthManager *	instance ()
	Enforce singleton pattern. More...

Friends
class	QgsApplication

Detailed Description

Singleton offering an interface to manage the authentication configuration database and to utilize configurations through various authentication method plugins.

QgsAuthManager should not usually be directly created, but rather accessed through QgsApplication::authManager().

Definition at line 69 of file qgsauthmanager.h.

Member Enumeration Documentation

◆ MessageLevel

enum QgsAuthManager::MessageLevel

Message log level (mirrors that of QgsMessageLog, so it can also output there)

Enumerator
INFO
WARNING
CRITICAL

Definition at line 76 of file qgsauthmanager.h.

Constructor & Destructor Documentation

◆ ~QgsAuthManager()

QgsAuthManager::~QgsAuthManager ( )

override

Definition at line 3167 of file qgsauthmanager.cpp.

◆ QgsAuthManager()

QgsAuthManager::QgsAuthManager ( )

explicitprotected

Definition at line 104 of file qgsauthmanager.cpp.

Member Function Documentation

◆ authDatabaseChanged

void QgsAuthManager::authDatabaseChanged ( )

signal

Emitted when the authentication db is significantly changed, e.g. large record removal, erased, etc.

◆ authDatabaseConfigTable()

const QString QgsAuthManager::authDatabaseConfigTable ( ) const

inline

Name of the authentication database table that stores configs.

Definition at line 100 of file qgsauthmanager.h.

◆ authDatabaseConnection()

QSqlDatabase QgsAuthManager::authDatabaseConnection ( ) const

Sets up the application instance of the authentication database connection.

Definition at line 117 of file qgsauthmanager.cpp.

◆ authDatabaseEraseRequested

void QgsAuthManager::authDatabaseEraseRequested ( )

signal

Emitted when a user has indicated they may want to erase the authentication db.

◆ authDatabaseServersTable()

const QString QgsAuthManager::authDatabaseServersTable ( ) const

inline

Name of the authentication database table that stores server exceptions/configs.

Definition at line 103 of file qgsauthmanager.h.

◆ authenticationDatabasePath()

const QString QgsAuthManager::authenticationDatabasePath ( ) const

inline

The standard authentication database file in ~/.qgis3/ or defined location.

See also: QgsApplication::qgisAuthDatabaseFilePath

Definition at line 116 of file qgsauthmanager.h.

◆ authManTag()

QString QgsAuthManager::authManTag ( ) const

inline

Simple text tag describing authentication system for message logs.

Definition at line 199 of file qgsauthmanager.h.

◆ authMethod()

QgsAuthMethod * QgsAuthManager::authMethod ( const QString & authMethodKey )

Gets authentication method from the config/provider cache via its key.

Parameters

authMethodKey Authentication method key

Definition at line 1029 of file qgsauthmanager.cpp.

◆ authMethodMetadata()

const QgsAuthMethodMetadata * QgsAuthManager::authMethodMetadata ( const QString & authMethodKey )

Gets authentication method metadata via its key.

Parameters

authMethodKey Authentication method key

Since: QGIS 3.22

Definition at line 1040 of file qgsauthmanager.cpp.

◆ authMethodsKeys()

QStringList QgsAuthManager::authMethodsKeys ( const QString & dataprovider = QString() )

Gets keys of supported authentication methods.

Definition at line 1024 of file qgsauthmanager.cpp.

◆ authMethodsMap()

QgsAuthMethodsMap QgsAuthManager::authMethodsMap ( const QString & dataprovider = QString() )

Gets available authentication methods mapped to their key.

Parameters

dataprovider Provider key filter, returning only methods that support a particular provider

Note: not available in Python bindings

Definition at line 1052 of file qgsauthmanager.cpp.

◆ authSetting()

QVariant QgsAuthManager::authSetting	(	const QString &	key,
		const QVariant &	defaultValue = `QVariant()`,
		bool	decrypt = `false`
	)

authSetting get an authentication setting (retrieved as string and returned as QVariant( QString ))

Parameters

key	setting key
defaultValue
decrypt	if the value needs decrypted

Returns: QVariant( QString ) authentication setting

Since: QGIS 3.0

Definition at line 1743 of file qgsauthmanager.cpp.

◆ availableAuthMethodConfigs()

QgsAuthMethodConfigsMap QgsAuthManager::availableAuthMethodConfigs ( const QString & dataprovider = QString() )

Gets mapping of authentication config ids and their base configs (not decrypted data)

Definition at line 925 of file qgsauthmanager.cpp.

◆ backupAuthenticationDatabase()

bool QgsAuthManager::backupAuthenticationDatabase ( QString * backuppath = nullptr )

Close connection to current authentication database and back it up.

Returns: Path to backup

Definition at line 1483 of file qgsauthmanager.cpp.

◆ caCertsCache()

const QMap<QString, QPair<QgsAuthCertUtils::CaCertSource, QSslCertificate> > QgsAuthManager::caCertsCache ( )

inline

caCertsCache get all CA certs mapped to their sha1 from cache.

Returns: map of sha1 <source, certificates>

Note: not available in Python bindings

Since: QGIS 3.0

Definition at line 586 of file qgsauthmanager.h.

◆ certAuthority()

const QSslCertificate QgsAuthManager::certAuthority ( const QString & id )

Gets a certificate authority by id (sha hash)

certAuthority get a certificate authority by id (sha hash)

Parameters

id sha hash

Returns: a certificate

Since: QGIS 3.0

Definition at line 2597 of file qgsauthmanager.cpp.

◆ certIdentities()

const QList< QSslCertificate > QgsAuthManager::certIdentities ( )

certIdentities get certificate identities

Returns: list of certificates

Since: QGIS 3.0

Definition at line 2012 of file qgsauthmanager.cpp.

◆ certIdentity()

const QSslCertificate QgsAuthManager::certIdentity ( const QString & id )

certIdentity get a certificate identity by id (sha hash)

Parameters

id	sha hash of the cert

Returns: the certificate

Since: QGIS 3.0

Definition at line 1912 of file qgsauthmanager.cpp.

◆ certIdentityBundle()

const QPair< QSslCertificate, QSslKey > QgsAuthManager::certIdentityBundle ( const QString & id )

Gets a certificate identity bundle by id (sha hash).

Parameters

id sha shash

Returns: a pair with the certificate and its SSL key

Note: not available in Python bindings

Since: QGIS 3.0

Definition at line 1946 of file qgsauthmanager.cpp.

◆ certIdentityBundleToPem()

const QStringList QgsAuthManager::certIdentityBundleToPem ( const QString & id )

certIdentityBundleToPem get a certificate identity bundle by id (sha hash) returned as PEM text

Parameters

id sha hash

Returns: a list of strings

Since: QGIS 3.0

Definition at line 2001 of file qgsauthmanager.cpp.

◆ certIdentityIds()

QStringList QgsAuthManager::certIdentityIds ( ) const

certIdentityIds get list of certificate identity ids from database

Returns: list of certificate ids

Since: QGIS 3.0

Definition at line 2034 of file qgsauthmanager.cpp.

◆ certificateTrustPolicy()

QgsAuthCertUtils::CertTrustPolicy QgsAuthManager::certificateTrustPolicy ( const QSslCertificate & cert )

certificateTrustPolicy get trust policy for a particular certificate cert

Parameters

cert

Returns: DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy

Since: QGIS 3.0

Definition at line 2909 of file qgsauthmanager.cpp.

◆ certTrustCache()

const QMap<QgsAuthCertUtils::CertTrustPolicy, QStringList > QgsAuthManager::certTrustCache ( )

inline

certTrustCache get cache of certificate sha1s, per trust policy

Returns: trust-policy-mapped certificate sha1s

Since: QGIS 3.0

Definition at line 630 of file qgsauthmanager.h.

◆ certTrustPolicy()

QgsAuthCertUtils::CertTrustPolicy QgsAuthManager::certTrustPolicy ( const QSslCertificate & cert )

certTrustPolicy get whether certificate cert is trusted by user

Parameters

cert

Returns: DefaultTrust if certificate sha not in trust table, i.e. follows default trust policy

Since: QGIS 3.0

Definition at line 2823 of file qgsauthmanager.cpp.

◆ clearAllCachedConfigs

void QgsAuthManager::clearAllCachedConfigs ( )

slot

Clear all authentication configs from authentication method caches.

Definition at line 3079 of file qgsauthmanager.cpp.

◆ clearCachedConfig

void QgsAuthManager::clearCachedConfig ( const QString & authcfg )

slot

Clear an authentication config from its associated authentication method cache.

Definition at line 3091 of file qgsauthmanager.cpp.

◆ clearMasterPassword()

void QgsAuthManager::clearMasterPassword ( )

inline

Clear supplied master password.

Note: This will not necessarily clear authenticated connections cached in network connection managers

Definition at line 150 of file qgsauthmanager.h.

◆ configAuthMethod()

QgsAuthMethod * QgsAuthManager::configAuthMethod ( const QString & authcfg )

Gets authentication method from the config/provider cache.

Parameters

authcfg Authentication config id

Definition at line 999 of file qgsauthmanager.cpp.

◆ configAuthMethodKey()

QString QgsAuthManager::configAuthMethodKey ( const QString & authcfg ) const

Gets key of authentication method associated with config ID.

Parameters

authcfg

Definition at line 1015 of file qgsauthmanager.cpp.

◆ configIdRegex()

QString QgsAuthManager::configIdRegex ( ) const

inline

Returns the regular expression for authcfg=.{7} key/value token for authentication ids.

Definition at line 281 of file qgsauthmanager.h.

◆ configIds()

QStringList QgsAuthManager::configIds ( ) const

Gets list of authentication ids from database.

Definition at line 3541 of file qgsauthmanager.cpp.

◆ configIdUnique()

bool QgsAuthManager::configIdUnique ( const QString & id ) const

Verify if provided authentication id is unique.

Parameters

id	Id to check

Definition at line 903 of file qgsauthmanager.cpp.

◆ databaseCAs()

const QList< QSslCertificate > QgsAuthManager::databaseCAs ( )

databaseCAs get database-stored certificate authorities

Returns: list of certificate authorities

Since: QGIS 3.0

Definition at line 2741 of file qgsauthmanager.cpp.

◆ defaultCertTrustPolicy()

QgsAuthCertUtils::CertTrustPolicy QgsAuthManager::defaultCertTrustPolicy ( )

Gets the default certificate trust policy preferred by user.

Definition at line 2944 of file qgsauthmanager.cpp.

◆ disabledMessage()

const QString QgsAuthManager::disabledMessage ( ) const

Standard message for when QCA's qca-ossl plugin is missing and system is disabled.

Definition at line 496 of file qgsauthmanager.cpp.

◆ dumpIgnoredSslErrorsCache_()

void QgsAuthManager::dumpIgnoredSslErrorsCache_ ( )

Utility function to dump the cache for debug purposes.

Definition at line 2385 of file qgsauthmanager.cpp.

◆ eraseAuthenticationDatabase()

bool QgsAuthManager::eraseAuthenticationDatabase	(	bool	backup,
		QString *	backuppath = `nullptr`
	)

Erase all rows from all tables in authentication database.

Parameters

backup	Whether to backup of current database
backuppath	Where the backup is locate

Returns: Whether operation succeeded

Definition at line 1519 of file qgsauthmanager.cpp.

◆ existsAuthSetting()

bool QgsAuthManager::existsAuthSetting ( const QString & key )

Check if an authentication setting exists.

Definition at line 1786 of file qgsauthmanager.cpp.

◆ existsCertAuthority()

bool QgsAuthManager::existsCertAuthority ( const QSslCertificate & cert )

Check if a certificate authority exists.

Definition at line 2631 of file qgsauthmanager.cpp.

◆ existsCertIdentity()

bool QgsAuthManager::existsCertIdentity ( const QString & id )

Check if a certificate identity exists.

Definition at line 2060 of file qgsauthmanager.cpp.

◆ existsSslCertCustomConfig()

bool QgsAuthManager::existsSslCertCustomConfig	(	const QString &	id,
		const QString &	hostport
	)

Check if SSL certificate custom config exists.

Definition at line 2308 of file qgsauthmanager.cpp.

◆ exportAuthenticationConfigsToXml()

bool QgsAuthManager::exportAuthenticationConfigsToXml	(	const QString &	filename,
		const QStringList &	authcfgs,
		const QString &	password = `QString()`
	)

Export authentication configurations to an XML file.

Parameters

filename	The file path to save the XML content to
authcfgs	The list of configuration IDs to export
password	A password string to encrypt the XML content

Since: QGIS 3.20

Definition at line 1352 of file qgsauthmanager.cpp.

◆ extraFileCAs()

const QList< QSslCertificate > QgsAuthManager::extraFileCAs ( )

extraFileCAs extra file-based certificate authorities

Returns: list of certificate authorities

Since: QGIS 3.0

Definition at line 2704 of file qgsauthmanager.cpp.

◆ hasConfigId()

bool QgsAuthManager::hasConfigId ( const QString & txt ) const

Returns whether a string includes an authcfg ID token.

Parameters

txt	String to check

Definition at line 919 of file qgsauthmanager.cpp.

◆ ignoredSslErrorCache()

QHash<QString, QSet<QSslError::SslError> > QgsAuthManager::ignoredSslErrorCache ( )

inline

ignoredSslErrorCache Get ignored SSL error cache, keyed with cert/connection's sha:host:port.

Returns: hash keyed with cert/connection's sha:host:port.

Note: not available in Python bindings

Since: QGIS 3.0

Definition at line 515 of file qgsauthmanager.h.

◆ importAuthenticationConfigsFromXml()

bool QgsAuthManager::importAuthenticationConfigsFromXml	(	const QString &	filename,
		const QString &	password = `QString()`,
		bool	overwrite = `false`
	)

Import authentication configurations from an XML file.

Parameters

filename	The file path from which the XML content will be read
password	A password string to decrypt the XML content
overwrite	If set to `true`, pre-existing authentication configurations will be overwritten

Since: QGIS 3.20

Definition at line 1411 of file qgsauthmanager.cpp.

◆ init()

bool QgsAuthManager::init	(	const QString &	pluginPath = `QString()`,
		const QString &	authDatabasePath = `QString()`
	)

init initialize QCA, prioritize qca-ossl plugin and optionally set up the authentication database

Parameters

pluginPath	the plugin path
authDatabasePath	the authentication DB path

Returns: true on success

See also: QgsApplication::pluginPath; QgsApplication::qgisAuthDatabaseFilePath

Definition at line 180 of file qgsauthmanager.cpp.

◆ initSslCaches()

bool QgsAuthManager::initSslCaches ( )

Initialize various SSL authentication caches.

Definition at line 1850 of file qgsauthmanager.cpp.

◆ instance()

QgsAuthManager * QgsAuthManager::instance ( )

staticprotected

Enforce singleton pattern.

Note: To set up the manager instance and initialize everything use QgsAuthManager::instance()->init()

Definition at line 92 of file qgsauthmanager.cpp.

◆ isDisabled()

bool QgsAuthManager::isDisabled ( ) const

Whether QCA has the qca-ossl plugin, which a base run-time requirement.

Definition at line 487 of file qgsauthmanager.cpp.

◆ loadAuthenticationConfig()

bool QgsAuthManager::loadAuthenticationConfig	(	const QString &	authcfg,
		QgsAuthMethodConfig &	mconfig,
		bool	full = `false`
	)

Load an authentication config from the database into subclass.

Parameters

authcfg	Associated authentication config id
mconfig	Subclassed config to load into
full	Whether to decrypt and populate all sensitive data in subclass

Returns: Whether operation succeeded

Definition at line 1251 of file qgsauthmanager.cpp.

◆ mappedDatabaseCAs()

const QMap< QString, QSslCertificate > QgsAuthManager::mappedDatabaseCAs ( )

mappedDatabaseCAs get sha1-mapped database-stored certificate authorities

Returns: sha1-mapped certificate authorities

Since: QGIS 3.0

Definition at line 2763 of file qgsauthmanager.cpp.

◆ masterPasswordHashInDatabase()

bool QgsAuthManager::masterPasswordHashInDatabase ( ) const

Verify a password hash existing in authentication database.

Definition at line 3447 of file qgsauthmanager.cpp.

◆ masterPasswordIsSet()

bool QgsAuthManager::masterPasswordIsSet ( ) const

Whether master password has be input and verified, i.e. authentication database is accessible.

Definition at line 652 of file qgsauthmanager.cpp.

◆ masterPasswordSame()

bool QgsAuthManager::masterPasswordSame ( const QString & pass ) const

Check whether supplied password is the same as the one already set.

Parameters

pass	Password to verify

Definition at line 657 of file qgsauthmanager.cpp.

◆ masterPasswordVerified

void QgsAuthManager::masterPasswordVerified ( bool verified )

signal

Emitted when a password has been verify (or not)

Parameters

verified The state of password's verification

◆ messageOut

void QgsAuthManager::messageOut	(	const QString &	message,
		const QString &	tag = `QgsAuthManager::AUTH_MAN_TAG`,
		QgsAuthManager::MessageLevel	level = `QgsAuthManager::INFO`
	)		const

signal

Custom logging signal to relay to console output and QgsMessageLog.

Parameters

message	Message to send
tag	Associated tag (title)
level	Message log level

See also: QgsMessageLog

◆ passwordHelperDelete()

bool QgsAuthManager::passwordHelperDelete ( )

Delete master password from wallet.

Note: not available in Python bindings

Definition at line 3207 of file qgsauthmanager.cpp.

◆ passwordHelperEnabled()

bool QgsAuthManager::passwordHelperEnabled ( ) const

Password helper enabled getter.

Note: Available in Python bindings since QGIS 3.8.0

Definition at line 3314 of file qgsauthmanager.cpp.

◆ passwordHelperErrorMessage()

const QString QgsAuthManager::passwordHelperErrorMessage ( )

inline

Error message getter.

Note: not available in Python bindings

Definition at line 673 of file qgsauthmanager.h.

◆ passwordHelperFailure

void QgsAuthManager::passwordHelperFailure ( )

signal

Signals emitted on password helper failure, mainly used in the tests to exit main application loop.

◆ passwordHelperLoggingEnabled()

bool QgsAuthManager::passwordHelperLoggingEnabled ( ) const

Password helper logging enabled getter.

Note: not available in Python bindings

Definition at line 3331 of file qgsauthmanager.cpp.

◆ passwordHelperMessageOut

void QgsAuthManager::passwordHelperMessageOut	(	const QString &	message,
		const QString &	tag = `QgsAuthManager::AUTH_MAN_TAG`,
		QgsAuthManager::MessageLevel	level = `QgsAuthManager::INFO`
	)

signal

Custom logging signal to inform the user about master password <-> password manager interactions.

Parameters

message	Message to send
tag	Associated tag (title)
level	Message log level

See also: QgsMessageLog

◆ passwordHelperSuccess

void QgsAuthManager::passwordHelperSuccess ( )

signal

Signals emitted on password helper success, mainly used in the tests to exit main application loop.

◆ passwordHelperSync()

bool QgsAuthManager::passwordHelperSync ( )

Store the password manager into the wallet.

Note: Available in Python bindings since QGIS 3.8.0

Definition at line 3064 of file qgsauthmanager.cpp.

◆ rebuildCaCertsCache()

bool QgsAuthManager::rebuildCaCertsCache ( )

Rebuild certificate authority cache.

Definition at line 2769 of file qgsauthmanager.cpp.

◆ rebuildCertTrustCache()

bool QgsAuthManager::rebuildCertTrustCache ( )

Rebuild certificate authority cache.

Definition at line 2955 of file qgsauthmanager.cpp.

◆ rebuildIgnoredSslErrorCache()

bool QgsAuthManager::rebuildIgnoredSslErrorCache ( )

Rebuild ignoredSSL error cache.

Definition at line 2482 of file qgsauthmanager.cpp.

◆ rebuildTrustedCaCertsCache()

bool QgsAuthManager::rebuildTrustedCaCertsCache ( )

Rebuild trusted certificate authorities cache.

Definition at line 3049 of file qgsauthmanager.cpp.

◆ registerCoreAuthMethods()

bool QgsAuthManager::registerCoreAuthMethods ( )

Instantiate and register existing C++ core authentication methods from plugins.

Definition at line 836 of file qgsauthmanager.cpp.

◆ removeAllAuthenticationConfigs()

bool QgsAuthManager::removeAllAuthenticationConfigs ( )

Clear all authentication configs from table in database and from provider caches.

Returns: Whether operation succeeded

Definition at line 1462 of file qgsauthmanager.cpp.

◆ removeAuthenticationConfig()

bool QgsAuthManager::removeAuthenticationConfig ( const QString & authcfg )

Remove an authentication config in the database.

Parameters

authcfg Associated authentication config id

Returns: Whether operation succeeded

Definition at line 1319 of file qgsauthmanager.cpp.

◆ removeAuthSetting()

bool QgsAuthManager::removeAuthSetting ( const QString & key )

Remove an authentication setting.

Definition at line 1819 of file qgsauthmanager.cpp.

◆ removeCertAuthority()

bool QgsAuthManager::removeCertAuthority ( const QSslCertificate & cert )

Remove a certificate authority.

Definition at line 2669 of file qgsauthmanager.cpp.

◆ removeCertIdentity()

bool QgsAuthManager::removeCertIdentity ( const QString & id )

Remove a certificate identity.

Definition at line 2093 of file qgsauthmanager.cpp.

◆ removeCertTrustPolicies()

bool QgsAuthManager::removeCertTrustPolicies ( const QList< QSslCertificate > & certs )

Remove a group certificate authorities.

Definition at line 2861 of file qgsauthmanager.cpp.

◆ removeCertTrustPolicy()

bool QgsAuthManager::removeCertTrustPolicy ( const QSslCertificate & cert )

Remove a certificate authority.

Definition at line 2878 of file qgsauthmanager.cpp.

◆ removeSslCertCustomConfig()

bool QgsAuthManager::removeSslCertCustomConfig	(	const QString &	id,
		const QString &	hostport
	)

Remove an SSL certificate custom config.

Definition at line 2346 of file qgsauthmanager.cpp.

◆ resetMasterPassword()

bool QgsAuthManager::resetMasterPassword	(	const QString &	newpass,
		const QString &	oldpass,
		bool	keepbackup,
		QString *	backuppath = `nullptr`
	)

Reset the master password to a new one, then re-encrypt all previous configs in a new database file, optionally backup curren database.

Parameters

newpass	New master password to replace existing
oldpass	Current master password to replace existing
keepbackup	Whether to keep the generated backup of current database
backuppath	Where the backup is located, if kept

Definition at line 662 of file qgsauthmanager.cpp.

◆ scheduledAuthDatabaseErase()

bool QgsAuthManager::scheduledAuthDatabaseErase ( )

inline

Whether there is a scheduled opitonal erase of authentication database.

Note: not available in Python bindings

Definition at line 172 of file qgsauthmanager.h.

◆ setDefaultCertTrustPolicy()

bool QgsAuthManager::setDefaultCertTrustPolicy ( QgsAuthCertUtils::CertTrustPolicy policy )

Sets the default certificate trust policy preferred by user.

Definition at line 2933 of file qgsauthmanager.cpp.

◆ setMasterPassword() [1/2]

bool QgsAuthManager::setMasterPassword ( bool verify = false )

Main call to initially set or continually check master password is set.

Note: If it is not set, the user is asked for its input

Parameters

verify Whether password's hash was saved in authentication database

Definition at line 501 of file qgsauthmanager.cpp.

◆ setMasterPassword() [2/2]

bool QgsAuthManager::setMasterPassword	(	const QString &	pass,
		bool	verify = `false`
	)

Overloaded call to reset master password or set it initially without user interaction.

Note: Only use this in trusted reset functions, unit tests or user/app setup scripts!

Parameters

pass	Password to use
verify	Whether password's hash was saved in authentication database

Definition at line 533 of file qgsauthmanager.cpp.

◆ setPasswordHelperEnabled()

void QgsAuthManager::setPasswordHelperEnabled ( bool enabled )

Password helper enabled setter.

Note: Available in Python bindings since QGIS 3.8.0

Definition at line 3321 of file qgsauthmanager.cpp.

◆ setPasswordHelperLoggingEnabled()

void QgsAuthManager::setPasswordHelperLoggingEnabled ( bool enabled )

Password helper logging enabled setter.

Note: not available in Python bindings

Definition at line 3338 of file qgsauthmanager.cpp.

◆ setScheduledAuthDatabaseErase()

void QgsAuthManager::setScheduledAuthDatabaseErase ( bool scheduleErase )

Schedule an optional erase of authentication database, starting when mutex is lockable.

Note: When an erase is scheduled, any attempt to set the master password, e.g. password input dialog, is effectively canceled. For example: In a GUI app, this keeps excess password input dialogs from popping up when a user has initiated an erase, from a password input dialog, because they forgot their password. The created schedule timer will emit a request to gain access to the user, through the given application, to prompt the erase operation (e.g. via a dialog); if no access to user interaction occurs within 90 seconds, it cancels the schedule.; not available in Python bindings

Definition at line 809 of file qgsauthmanager.cpp.

◆ setScheduledAuthDatabaseEraseRequestEmitted()

void QgsAuthManager::setScheduledAuthDatabaseEraseRequestEmitted ( bool emitted )

inline

Re-emit a signal to schedule an optional erase of authentication database.

Note: This can be called from the slot connected to a previously emitted scheduling signal, so that the slot can ask for another emit later, if the slot noticies the current GUI processing state is not ready for interacting with the user, e.g. project is still loading

Parameters

emitted Setting to false will cause signal to be emitted by the schedule timer. Setting to true will stop any emitting, but will not stop the schedule timer.

Definition at line 196 of file qgsauthmanager.h.

◆ sslCertCustomConfig()

const QgsAuthConfigSslServer QgsAuthManager::sslCertCustomConfig	(	const QString &	id,
		const QString &	hostport
	)

sslCertCustomConfig get an SSL certificate custom config by id (sha hash) and hostport (host:port)

Parameters

id	sha hash
hostport	string host:port

Returns: a SSL certificate custom config

Since: QGIS 3.0

Definition at line 2165 of file qgsauthmanager.cpp.

◆ sslCertCustomConfigByHost()

const QgsAuthConfigSslServer QgsAuthManager::sslCertCustomConfigByHost ( const QString & hostport )

sslCertCustomConfigByHost get an SSL certificate custom config by hostport (host:port)

Parameters

hostport host:port

Returns: a SSL certificate custom config

Since: QGIS 3.0

Definition at line 2207 of file qgsauthmanager.cpp.

◆ sslCertCustomConfigs()

const QList< QgsAuthConfigSslServer > QgsAuthManager::sslCertCustomConfigs ( )

sslCertCustomConfigs get SSL certificate custom configs

Returns: list of SSL certificate custom config

Since: QGIS 3.0

Definition at line 2281 of file qgsauthmanager.cpp.

◆ storeAuthenticationConfig()

bool QgsAuthManager::storeAuthenticationConfig	(	QgsAuthMethodConfig &	mconfig,
		bool	overwrite = `false`
	)

Store an authentication config in the database.

Parameters

mconfig	Associated authentication config id
overwrite	If set to `true`, pre-existing authentication configurations will be overwritten

Returns: Whether operation succeeded

Definition at line 1098 of file qgsauthmanager.cpp.

◆ storeAuthSetting()

bool QgsAuthManager::storeAuthSetting	(	const QString &	key,
		const QVariant &	value,
		bool	encrypt = `false`
	)

Store an authentication setting (stored as string via QVariant( value ).toString() )

Definition at line 1702 of file qgsauthmanager.cpp.

◆ storeCertAuthorities()

bool QgsAuthManager::storeCertAuthorities ( const QList< QSslCertificate > & certs )

Store multiple certificate authorities.

Definition at line 2544 of file qgsauthmanager.cpp.

◆ storeCertAuthority()

bool QgsAuthManager::storeCertAuthority ( const QSslCertificate & cert )

Store a certificate authority.

Definition at line 2561 of file qgsauthmanager.cpp.

◆ storeCertIdentity()

bool QgsAuthManager::storeCertIdentity	(	const QSslCertificate &	cert,
		const QSslKey &	key
	)

Store a certificate identity.

Definition at line 1868 of file qgsauthmanager.cpp.

◆ storeCertTrustPolicy()

bool QgsAuthManager::storeCertTrustPolicy	(	const QSslCertificate &	cert,
		QgsAuthCertUtils::CertTrustPolicy	policy
	)

Store user trust value for a certificate.

Definition at line 2784 of file qgsauthmanager.cpp.

◆ storeSslCertCustomConfig()

bool QgsAuthManager::storeSslCertCustomConfig ( const QgsAuthConfigSslServer & config )

Store an SSL certificate custom config.

Definition at line 2121 of file qgsauthmanager.cpp.

◆ supportedAuthMethodExpansions()

QgsAuthMethod::Expansions QgsAuthManager::supportedAuthMethodExpansions ( const QString & authcfg )

Gets supported authentication method expansion(s), e.g.

NetworkRequest | DataSourceURI, as flags

Parameters

authcfg

Definition at line 1085 of file qgsauthmanager.cpp.

◆ systemRootCAs()

const QList< QSslCertificate > QgsAuthManager::systemRootCAs ( )

systemRootCAs get root system certificate authorities

Returns: list of certificate authorities

Since: QGIS 3.0

Definition at line 2699 of file qgsauthmanager.cpp.

◆ trustedCaCerts()

const QList< QSslCertificate > QgsAuthManager::trustedCaCerts ( bool includeinvalid = false )

trustedCaCerts get list of all trusted CA certificates

Parameters

includeinvalid whether invalid certs needs to be returned

Returns: list of certificates

Since: QGIS 3.0

Definition at line 2989 of file qgsauthmanager.cpp.

◆ trustedCaCertsCache()

const QList<QSslCertificate> QgsAuthManager::trustedCaCertsCache ( )

inline

trustedCaCertsCache cache of trusted certificate authorities, ready for network connections

Returns: list of certificates

Since: QGIS 3.0

Definition at line 658 of file qgsauthmanager.h.

◆ trustedCaCertsPemText()

const QByteArray QgsAuthManager::trustedCaCertsPemText ( )

trustedCaCertsPemText get concatenated string of all trusted CA certificates

Returns: bye array with all PEM encoded trusted CAs

Since: QGIS 3.0

Definition at line 3058 of file qgsauthmanager.cpp.

◆ uniqueConfigId()

const QString QgsAuthManager::uniqueConfigId ( ) const

Gets a unique generated 7-character string to assign to as config id.

Definition at line 852 of file qgsauthmanager.cpp.

◆ untrustedCaCerts()

const QList< QSslCertificate > QgsAuthManager::untrustedCaCerts ( QList< QSslCertificate > trustedCAs = QList<QSslCertificate>() )

untrustedCaCerts get list of untrusted certificate authorities

Returns: list of certificates

Since: QGIS 3.0

Definition at line 3023 of file qgsauthmanager.cpp.

◆ updateAuthenticationConfig()

bool QgsAuthManager::updateAuthenticationConfig ( const QgsAuthMethodConfig & config )

Update an authentication config in the database.

Parameters

config Associated authentication config id

Returns: Whether operation succeeded

Definition at line 1180 of file qgsauthmanager.cpp.

◆ updateConfigAuthMethods()

void QgsAuthManager::updateConfigAuthMethods ( )

Sync the confg/authentication method cache with what is in database.

Definition at line 970 of file qgsauthmanager.cpp.

◆ updateDataSourceUriItems()

bool QgsAuthManager::updateDataSourceUriItems	(	QStringList &	connectionItems,
		const QString &	authcfg,
		const QString &	dataprovider = `QString()`
	)

Provider call to update a QgsDataSourceUri with an authentication config.

Parameters

connectionItems	The connection items, e.g. username=myname, of QgsDataSourceUri
authcfg	Associated authentication config id
dataprovider	Provider key filter, offering logic branching in authentication method

Returns: Whether operation succeeded

Definition at line 1650 of file qgsauthmanager.cpp.

◆ updateIgnoredSslErrorsCache()

bool QgsAuthManager::updateIgnoredSslErrorsCache	(	const QString &	shahostport,
		const QList< QSslError > &	errors
	)

Update ignored SSL error cache with possible ignored SSL errors, using sha:host:port key.

Definition at line 2438 of file qgsauthmanager.cpp.

◆ updateIgnoredSslErrorsCacheFromConfig()

bool QgsAuthManager::updateIgnoredSslErrorsCacheFromConfig ( const QgsAuthConfigSslServer & config )

Update ignored SSL error cache with possible ignored SSL errors, using server config.

Definition at line 2409 of file qgsauthmanager.cpp.

◆ updateNetworkProxy()

bool QgsAuthManager::updateNetworkProxy	(	QNetworkProxy &	proxy,
		const QString &	authcfg,
		const QString &	dataprovider = `QString()`
	)

Provider call to update a QNetworkProxy with an authentication config.

Parameters

proxy	the QNetworkProxy
authcfg	Associated authentication config id
dataprovider	Provider key filter, offering logic branching in authentication method

Returns: Whether operation succeeded

Definition at line 1676 of file qgsauthmanager.cpp.

◆ updateNetworkReply()

bool QgsAuthManager::updateNetworkReply	(	QNetworkReply *	reply,
		const QString &	authcfg,
		const QString &	dataprovider = `QString()`
	)

Provider call to update a QNetworkReply with an authentication config (used to skip known SSL errors, etc.)

Parameters

reply	The QNetworkReply
authcfg	Associated authentication config id
dataprovider	Provider key filter, offering logic branching in authentication method

Returns: Whether operation succeeded

Definition at line 1624 of file qgsauthmanager.cpp.

◆ updateNetworkRequest()

bool QgsAuthManager::updateNetworkRequest	(	QNetworkRequest &	request,
		const QString &	authcfg,
		const QString &	dataprovider = `QString()`
	)

Provider call to update a QNetworkRequest with an authentication config.

Parameters

request	The QNetworkRequest
authcfg	Associated authentication config id
dataprovider	Provider key filter, offering logic branching in authentication method

Returns: Whether operation succeeded

Definition at line 1599 of file qgsauthmanager.cpp.

◆ verifyMasterPassword()

bool QgsAuthManager::verifyMasterPassword ( const QString & compare = QString() )

Verify the supplied master password against any existing hash in authentication database.

Note: Do not emit verification signals when only comparing

Parameters

compare Password to compare against

Definition at line 558 of file qgsauthmanager.cpp.

Friends And Related Function Documentation

◆ QgsApplication

friend class QgsApplication

friend

Definition at line 958 of file qgsauthmanager.h.

Member Data Documentation

◆ AUTH_MAN_TAG

const QString QgsAuthManager::AUTH_MAN_TAG = QObject::tr( "Authentication Manager" )

static

The display name of the Authentication Manager.

Definition at line 715 of file qgsauthmanager.h.

◆ AUTH_PASSWORD_HELPER_DISPLAY_NAME

const QString QgsAuthManager::AUTH_PASSWORD_HELPER_DISPLAY_NAME

static

The display name of the password helper (platform dependent)

Definition at line 712 of file qgsauthmanager.h.

The documentation for this class was generated from the following files:

/build/qgis-3.24.2+99sid/src/core/auth/qgsauthmanager.h
/build/qgis-3.24.2+99sid/src/core/auth/qgsauthmanager.cpp

Public Types

Public Slots

Signals

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ MessageLevel

Constructor & Destructor Documentation

◆ ~QgsAuthManager()

◆ QgsAuthManager()

Member Function Documentation

◆ authDatabaseChanged

◆ authDatabaseConfigTable()

◆ authDatabaseConnection()

◆ authDatabaseEraseRequested

◆ authDatabaseServersTable()

◆ authenticationDatabasePath()

◆ authManTag()

◆ authMethod()

◆ authMethodMetadata()

◆ authMethodsKeys()

◆ authMethodsMap()

◆ authSetting()

◆ availableAuthMethodConfigs()

◆ backupAuthenticationDatabase()

◆ caCertsCache()

◆ certAuthority()

◆ certIdentities()

◆ certIdentity()

◆ certIdentityBundle()

◆ certIdentityBundleToPem()

◆ certIdentityIds()

◆ certificateTrustPolicy()

◆ certTrustCache()

◆ certTrustPolicy()

◆ clearAllCachedConfigs

◆ clearCachedConfig

◆ clearMasterPassword()

◆ configAuthMethod()

◆ configAuthMethodKey()

◆ configIdRegex()

◆ configIds()

◆ configIdUnique()

◆ databaseCAs()

◆ defaultCertTrustPolicy()

◆ disabledMessage()

◆ dumpIgnoredSslErrorsCache_()

◆ eraseAuthenticationDatabase()

◆ existsAuthSetting()

◆ existsCertAuthority()

◆ existsCertIdentity()

◆ existsSslCertCustomConfig()

◆ exportAuthenticationConfigsToXml()

◆ extraFileCAs()

◆ hasConfigId()

◆ ignoredSslErrorCache()

◆ importAuthenticationConfigsFromXml()

◆ init()

◆ initSslCaches()

◆ instance()

◆ isDisabled()

◆ loadAuthenticationConfig()

◆ mappedDatabaseCAs()

◆ masterPasswordHashInDatabase()

◆ masterPasswordIsSet()

◆ masterPasswordSame()

◆ masterPasswordVerified

◆ messageOut

◆ passwordHelperDelete()

◆ passwordHelperEnabled()

◆ passwordHelperErrorMessage()

◆ passwordHelperFailure

◆ passwordHelperLoggingEnabled()

◆ passwordHelperMessageOut

◆ passwordHelperSuccess

◆ passwordHelperSync()