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...

QWidget *	authMethodEditWidget (const QString &authMethodKey, QWidget *parent)
	Gets authentication method edit widget 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...

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	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)
	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 64 of file qgsauthmanager.h.

Member Enumeration Documentation

enum QgsAuthManager::MessageLevel

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

Enumerator
INFO
WARNING
CRITICAL

Definition at line 71 of file qgsauthmanager.h.

Constructor & Destructor Documentation

QgsAuthManager::~QgsAuthManager ( )

override

Definition at line 3004 of file qgsauthmanager.cpp.

QgsAuthManager::QgsAuthManager ( )

explicitprotected

Definition at line 103 of file qgsauthmanager.cpp.

Member Function Documentation

void QgsAuthManager::authDatabaseChanged ( )

signal

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

const QString QgsAuthManager::authDatabaseConfigTable ( ) const

inline

Name of the authentication database table that stores configs.

Definition at line 95 of file qgsauthmanager.h.

QSqlDatabase QgsAuthManager::authDatabaseConnection ( ) const

Sets up the application instance of the authentication database connection.

Definition at line 110 of file qgsauthmanager.cpp.

void QgsAuthManager::authDatabaseEraseRequested ( )

signal

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

const QString QgsAuthManager::authDatabaseServersTable ( ) const

inline

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

Definition at line 98 of file qgsauthmanager.h.

const QString QgsAuthManager::authenticationDatabasePath ( ) const

inline

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

See also: QgsApplication::qgisAuthDatabaseFilePath

Definition at line 111 of file qgsauthmanager.h.

QString QgsAuthManager::authManTag ( ) const

inline

Simple text tag describing authentication system for message logs.

Definition at line 194 of file qgsauthmanager.h.

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 1006 of file qgsauthmanager.cpp.

QWidget * QgsAuthManager::authMethodEditWidget	(	const QString &	authMethodKey,
		QWidget *	parent
	)

Gets authentication method edit widget via its key.

Parameters

authMethodKey	Authentication method key
parent	Parent widget

Definition at line 1039 of file qgsauthmanager.cpp.

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

Gets keys of supported authentication methods.

Definition at line 1001 of file qgsauthmanager.cpp.

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 1017 of file qgsauthmanager.cpp.

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 1586 of file qgsauthmanager.cpp.

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

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

Definition at line 902 of file qgsauthmanager.cpp.

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

Close connection to current authentication database and back it up.

Returns: Path to backup

Definition at line 1326 of file qgsauthmanager.cpp.

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 550 of file qgsauthmanager.h.

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 2437 of file qgsauthmanager.cpp.

const QList< QSslCertificate > QgsAuthManager::certIdentities ( )

certIdentities get certificate identities

Returns: list of certificates

Since: QGIS 3.0

Definition at line 1852 of file qgsauthmanager.cpp.

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 1752 of file qgsauthmanager.cpp.

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 1786 of file qgsauthmanager.cpp.

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 1841 of file qgsauthmanager.cpp.

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 1874 of file qgsauthmanager.cpp.

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 2750 of file qgsauthmanager.cpp.

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 594 of file qgsauthmanager.h.

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 2664 of file qgsauthmanager.cpp.

void QgsAuthManager::clearAllCachedConfigs ( )

slot

Clear all authentication configs from authentication method caches.

Definition at line 2920 of file qgsauthmanager.cpp.

void QgsAuthManager::clearCachedConfig ( const QString & authcfg )

slot

Clear an authentication config from its associated authentication method cache.

Definition at line 2932 of file qgsauthmanager.cpp.

void QgsAuthManager::clearMasterPassword ( )

inline

Clear supplied master password.

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

Definition at line 145 of file qgsauthmanager.h.

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

Gets authentication method from the config/provider cache.

Parameters

authcfg Authentication config id

Definition at line 976 of file qgsauthmanager.cpp.

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

Gets key of authentication method associated with config ID.

Parameters

authcfg

Definition at line 992 of file qgsauthmanager.cpp.

QString QgsAuthManager::configIdRegex ( ) const

inline

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

Definition at line 264 of file qgsauthmanager.h.

QStringList QgsAuthManager::configIds ( ) const

Gets list of authentication ids from database.

Definition at line 3382 of file qgsauthmanager.cpp.

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

Verify if provided authentication id is unique.

Parameters

id	Id to check

Definition at line 880 of file qgsauthmanager.cpp.

const QList< QSslCertificate > QgsAuthManager::databaseCAs ( )

databaseCAs get database-stored certificate authorities

Returns: list of certificate authorities

Since: QGIS 3.0

Definition at line 2583 of file qgsauthmanager.cpp.

QgsAuthCertUtils::CertTrustPolicy QgsAuthManager::defaultCertTrustPolicy ( )

Gets the default certificate trust policy preferred by user.

Definition at line 2785 of file qgsauthmanager.cpp.

const QString QgsAuthManager::disabledMessage ( ) const

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

Definition at line 487 of file qgsauthmanager.cpp.

void QgsAuthManager::dumpIgnoredSslErrorsCache_ ( )

Utility function to dump the cache for debug purposes.

Definition at line 2225 of file qgsauthmanager.cpp.

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 1362 of file qgsauthmanager.cpp.

bool QgsAuthManager::existsAuthSetting ( const QString & key )

Check if an authentication setting exists.

Definition at line 1629 of file qgsauthmanager.cpp.

bool QgsAuthManager::existsCertAuthority ( const QSslCertificate & cert )

Check if a certificate authority exists.

Definition at line 2471 of file qgsauthmanager.cpp.

bool QgsAuthManager::existsCertIdentity ( const QString & id )

Check if a certificate identity exists.

Definition at line 1900 of file qgsauthmanager.cpp.

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

Check if SSL certificate custom config exists.

Definition at line 2148 of file qgsauthmanager.cpp.

const QList< QSslCertificate > QgsAuthManager::extraFileCAs ( )

extraFileCAs extra file-based certificate authorities

Returns: list of certificate authorities

Since: QGIS 3.0

Definition at line 2549 of file qgsauthmanager.cpp.

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

Returns whether a string includes an authcfg ID token.

Parameters

txt	String to check

Definition at line 896 of file qgsauthmanager.cpp.

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 479 of file qgsauthmanager.h.

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 173 of file qgsauthmanager.cpp.

bool QgsAuthManager::initSslCaches ( )

Initialize various SSL authentication caches.

Definition at line 1693 of file qgsauthmanager.cpp.

QgsAuthManager * QgsAuthManager::instance ( )

staticprotected

Enforce singleton pattern.

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

Definition at line 88 of file qgsauthmanager.cpp.

bool QgsAuthManager::isDisabled ( ) const

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

Definition at line 478 of file qgsauthmanager.cpp.

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 1205 of file qgsauthmanager.cpp.

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 2605 of file qgsauthmanager.cpp.

bool QgsAuthManager::masterPasswordHashInDatabase ( ) const

Verify a password hash existing in authentication database.

Definition at line 3288 of file qgsauthmanager.cpp.

bool QgsAuthManager::masterPasswordIsSet ( ) const

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

Definition at line 643 of file qgsauthmanager.cpp.

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 648 of file qgsauthmanager.cpp.

void QgsAuthManager::masterPasswordVerified ( bool verified )

signal

Emitted when a password has been verify (or not)

Parameters

verified The state of password's verification

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

bool QgsAuthManager::passwordHelperDelete ( )

Delete master password from wallet.

Note: not available in Python bindings

Definition at line 3048 of file qgsauthmanager.cpp.

bool QgsAuthManager::passwordHelperEnabled ( ) const

Password helper enabled getter.

Note: not available in Python bindings

Definition at line 3155 of file qgsauthmanager.cpp.

const QString QgsAuthManager::passwordHelperErrorMessage ( )

inline

Error message getter.

Note: not available in Python bindings

Definition at line 637 of file qgsauthmanager.h.

void QgsAuthManager::passwordHelperFailure ( )

signal

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

bool QgsAuthManager::passwordHelperLoggingEnabled ( ) const

Password helper logging enabled getter.

Note: not available in Python bindings

Definition at line 3172 of file qgsauthmanager.cpp.

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

void QgsAuthManager::passwordHelperSuccess ( )

signal

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

bool QgsAuthManager::passwordHelperSync ( )

Store the password manager into the wallet.

Note: not available in Python bindings

Definition at line 2905 of file qgsauthmanager.cpp.

bool QgsAuthManager::rebuildCaCertsCache ( )

Rebuild certificate authority cache.

Definition at line 2611 of file qgsauthmanager.cpp.

bool QgsAuthManager::rebuildCertTrustCache ( )

Rebuild certificate authority cache.

Definition at line 2796 of file qgsauthmanager.cpp.

bool QgsAuthManager::rebuildIgnoredSslErrorCache ( )

Rebuild ignoredSSL error cache.

Definition at line 2322 of file qgsauthmanager.cpp.

bool QgsAuthManager::rebuildTrustedCaCertsCache ( )

Rebuild trusted certificate authorities cache.

Definition at line 2890 of file qgsauthmanager.cpp.

bool QgsAuthManager::registerCoreAuthMethods ( )

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

Definition at line 827 of file qgsauthmanager.cpp.

bool QgsAuthManager::removeAllAuthenticationConfigs ( )

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

Returns: Whether operation succeeded

Definition at line 1305 of file qgsauthmanager.cpp.

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 1272 of file qgsauthmanager.cpp.

bool QgsAuthManager::removeAuthSetting ( const QString & key )

Remove an authentication setting.

Definition at line 1662 of file qgsauthmanager.cpp.

bool QgsAuthManager::removeCertAuthority ( const QSslCertificate & cert )

Remove a certificate authority.

Definition at line 2509 of file qgsauthmanager.cpp.

bool QgsAuthManager::removeCertIdentity ( const QString & id )

Remove a certificate identity.

Definition at line 1933 of file qgsauthmanager.cpp.

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

Remove a group certificate authorities.

Definition at line 2702 of file qgsauthmanager.cpp.

bool QgsAuthManager::removeCertTrustPolicy ( const QSslCertificate & cert )

Remove a certificate authority.

Definition at line 2719 of file qgsauthmanager.cpp.

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

Remove an SSL certificate custom config.

Definition at line 2186 of file qgsauthmanager.cpp.

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 653 of file qgsauthmanager.cpp.

bool QgsAuthManager::scheduledAuthDatabaseErase ( )

inline

Whether there is a scheduled opitonal erase of authentication database.

Note: not available in Python bindings

Definition at line 167 of file qgsauthmanager.h.

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

Sets the default certificate trust policy preferred by user.

Definition at line 2774 of file qgsauthmanager.cpp.

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 492 of file qgsauthmanager.cpp.

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 524 of file qgsauthmanager.cpp.

void QgsAuthManager::setPasswordHelperEnabled ( bool enabled )

Password helper enabled setter.

Note: not available in Python bindings

Definition at line 3162 of file qgsauthmanager.cpp.

void QgsAuthManager::setPasswordHelperLoggingEnabled ( bool enabled )

Password helper logging enabled setter.

Note: not available in Python bindings

Definition at line 3179 of file qgsauthmanager.cpp.

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 800 of file qgsauthmanager.cpp.

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 191 of file qgsauthmanager.h.

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 2005 of file qgsauthmanager.cpp.

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 2047 of file qgsauthmanager.cpp.

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 2121 of file qgsauthmanager.cpp.

bool QgsAuthManager::storeAuthenticationConfig ( QgsAuthMethodConfig & mconfig )

Store an authentication config in the database.

Parameters

mconfig Associated authentication config id

Returns: Whether operation succeeded

Definition at line 1057 of file qgsauthmanager.cpp.

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 1545 of file qgsauthmanager.cpp.

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

Store multiple certificate authorities.

Definition at line 2384 of file qgsauthmanager.cpp.

bool QgsAuthManager::storeCertAuthority ( const QSslCertificate & cert )

Store a certificate authority.

Definition at line 2401 of file qgsauthmanager.cpp.

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

Store a certificate identity.

Definition at line 1708 of file qgsauthmanager.cpp.

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

Store user trust value for a certificate.

Definition at line 2625 of file qgsauthmanager.cpp.

bool QgsAuthManager::storeSslCertCustomConfig ( const QgsAuthConfigSslServer & config )

Store an SSL certificate custom config.

Definition at line 1961 of file qgsauthmanager.cpp.

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

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

NetworkRequest | DataSourceURI, as flags

Parameters

authcfg

Definition at line 1044 of file qgsauthmanager.cpp.

const QList< QSslCertificate > QgsAuthManager::systemRootCAs ( )

systemRootCAs get root system certificate authorities

Returns: list of certificate authorities

Since: QGIS 3.0

Definition at line 2539 of file qgsauthmanager.cpp.

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 2830 of file qgsauthmanager.cpp.

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 622 of file qgsauthmanager.h.

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 2899 of file qgsauthmanager.cpp.

const QString QgsAuthManager::uniqueConfigId ( ) const

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

Definition at line 843 of file qgsauthmanager.cpp.

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 2864 of file qgsauthmanager.cpp.

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 1134 of file qgsauthmanager.cpp.

void QgsAuthManager::updateConfigAuthMethods ( )

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

Definition at line 947 of file qgsauthmanager.cpp.

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 1493 of file qgsauthmanager.cpp.

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 2278 of file qgsauthmanager.cpp.

bool QgsAuthManager::updateIgnoredSslErrorsCacheFromConfig ( const QgsAuthConfigSslServer & config )

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

Definition at line 2249 of file qgsauthmanager.cpp.

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 1519 of file qgsauthmanager.cpp.

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 1467 of file qgsauthmanager.cpp.

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 1442 of file qgsauthmanager.cpp.

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 549 of file qgsauthmanager.cpp.

Friends And Related Function Documentation

friend class QgsApplication

friend

Definition at line 909 of file qgsauthmanager.h.

Member Data Documentation

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

static

The display name of the Authentication Manager.

Definition at line 679 of file qgsauthmanager.h.

const QString QgsAuthManager::AUTH_PASSWORD_HELPER_DISPLAY_NAME

static

The display name of the password helper (platform dependent)

Definition at line 676 of file qgsauthmanager.h.

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

/build/qgis-3.4.15+24xenial/src/core/auth/qgsauthmanager.h
/build/qgis-3.4.15+24xenial/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

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation