api/qgsauthconfigurationstorage_8h_source.html

/***************************************************************************

  qgsauthconfigurationstorage.h - QgsAuthConfigurationStorage


 ---------------------

 begin                : 20.6.2024

 copyright            : (C) 2024 by Alessandro Pasotti

 email                : elpaso at itopen dot it

 ***************************************************************************

 *                                                                         *

 *   This program is free software; you can redistribute it and/or modify  *

 *   it under the terms of the GNU General Public License as published by  *

 *   the Free Software Foundation; either version 2 of the License, or     *

 *   (at your option) any later version.                                   *

 *                                                                         *

 ***************************************************************************/

#ifndef QGSAUTHCONFIGURATIONSTORAGE_H

#define QGSAUTHCONFIGURATIONSTORAGE_H


#include "qgis_sip.h"

#include "qgis_core.h"

#include "qgis.h"

#include "qgsauthconfig.h"

#include "qgsauthcertutils.h"

#include "qgsexception.h"


#include <QString>

#include <QObject>


class CORE_EXPORT QgsAuthConfigurationStorage: public QObject

{

    Q_OBJECT


  public:


    struct CORE_EXPORT MasterPasswordConfig

    {

      QString salt;

      QString civ;

      QString hash;

    };


    struct CORE_EXPORT SettingParameter

    {

      QString name;

      QString description;

      QVariant::Type type;

    };


    QgsAuthConfigurationStorage( const QMap<QString, QVariant> &settings );


    virtual ~QgsAuthConfigurationStorage() {}


    virtual QString name() const = 0;


    virtual QString type() const = 0;


    virtual QString description() const = 0;


    virtual QString id() const = 0;


    virtual bool initialize() { return true; }


    virtual QString lastError() const;


    virtual bool isReady() const = 0;


    Qgis::AuthConfigurationStorageCapabilities capabilities() const;


    QMap<QString, QVariant> settings() const;


    virtual QList<QgsAuthConfigurationStorage::SettingParameter> settingsParameters() const = 0;


    bool isEncrypted() const;


    bool isEnabled() const;


    void setEnabled( bool enabled );


    virtual void setReadOnly( bool readOnly );


    virtual bool isReadOnly() const;


    virtual QgsAuthMethodConfigsMap authMethodConfigs( const QStringList &allowedMethods = QStringList() ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual QgsAuthMethodConfigsMap authMethodConfigsWithPayload( ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual QgsAuthMethodConfig loadMethodConfig( const QString &id, QString &payload SIP_OUT, bool full = false ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool storeMethodConfig( const QgsAuthMethodConfig &config, const QString &payload ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool removeMethodConfig( const QString &id ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool methodConfigExists( const QString &id ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool storeAuthSetting( const QString &key, const QString &value ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual QString loadAuthSetting( const QString &key ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool removeAuthSetting( const QString &key ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool authSettingExists( const QString &key ) const SIP_THROW( QgsNotSupportedException ) = 0;


#ifndef QT_NO_SSL


    virtual bool storeCertIdentity( const QSslCertificate &cert, const QString &keyPem ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool removeCertIdentity( const QSslCertificate &cert ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual const QSslCertificate loadCertIdentity( const QString &id ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual const QPair<QSslCertificate, QString> loadCertIdentityBundle( const QString &id ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual const QList<QSslCertificate> certIdentities() const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual QStringList certIdentityIds() const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool certIdentityExists( const QString &id ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool removeCertIdentity( const QString &id ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool storeSslCertCustomConfig( const QgsAuthConfigSslServer &config ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual const QgsAuthConfigSslServer loadSslCertCustomConfig( const QString &id, const QString &hostport ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual const QgsAuthConfigSslServer loadSslCertCustomConfigByHost( const QString &hostport ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual const QList<QgsAuthConfigSslServer> sslCertCustomConfigs() const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual QStringList sslCertCustomConfigIds() const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool sslCertCustomConfigExists( const QString &id, const QString &hostport ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool removeSslCertCustomConfig( const QString &id, const QString &hostport ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool storeCertAuthority( const QSslCertificate &cert ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual QStringList certAuthorityIds() const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual const QSslCertificate loadCertAuthority( const QString &id ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool certAuthorityExists( const QSslCertificate &cert ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool removeCertAuthority( const QSslCertificate &cert ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual const QMap<QString, QgsAuthCertUtils::CertTrustPolicy> caCertsPolicy() const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual const  QList<QSslCertificate> caCerts() const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool storeCertTrustPolicy( const QSslCertificate &cert, QgsAuthCertUtils::CertTrustPolicy policy ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual QgsAuthCertUtils::CertTrustPolicy loadCertTrustPolicy( const QSslCertificate &cert ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool removeCertTrustPolicy( const QSslCertificate &cert ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool certTrustPolicyExists( const QSslCertificate &cert ) const SIP_THROW( QgsNotSupportedException ) = 0;


#endif


    virtual const QList<QgsAuthConfigurationStorage::MasterPasswordConfig> masterPasswords( ) const SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool storeMasterPassword( const QgsAuthConfigurationStorage::MasterPasswordConfig &config ) SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool clearMasterPasswords() SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool erase() SIP_THROW( QgsNotSupportedException ) = 0;


    virtual bool clearMethodConfigs() SIP_THROW( QgsNotSupportedException ) = 0;


  signals:


    void messageLog( const QString &message, const QString &tag = QStringLiteral( "Authentication" ), Qgis::MessageLevel level = Qgis::MessageLevel::Info );


    void storageChanged( const QString &id );


    void methodConfigChanged( );


    void masterPasswordChanged();


    void authSettingsChanged();


    void readOnlyChanged( bool readOnly );


#ifndef QT_NO_SSL


    void certIdentityChanged();


    void certAuthorityChanged();


    void sslCertCustomConfigChanged();


    void sslCertTrustPolicyChanged();


#endif


  protected:


    void setCapabilities( Qgis::AuthConfigurationStorageCapabilities capabilities );


    void setError( const QString &error, Qgis::MessageLevel level = Qgis::MessageLevel::Critical );


    void checkCapability( Qgis::AuthConfigurationStorageCapability capability ) const SIP_SKIP;


    virtual QString loggerTag() const;


    QMap<QString, QVariant> mConfiguration;


    Qgis::AuthConfigurationStorageCapabilities mCapabilities;


    mutable QString mLastError;


    bool mIsEncrypted = true;


    bool mIsEnabled = true;


    bool mIsReadOnly = false;


};


#endif // QGSAUTHCONFIGURATIONSTORAGE_H

Qgis
The Qgis class provides global constants for use throughout the application.
Definition qgis.h:54

Qgis::AuthConfigurationStorageCapabilities
QFlags< AuthConfigurationStorageCapability > AuthConfigurationStorageCapabilities
Authentication configuration storage capabilities.
Definition qgis.h:145

Qgis::MessageLevel
MessageLevel
Level for messages This will be used both for message log and message bar in application.
Definition qgis.h:154

Qgis::Critical
@ Critical
Critical/error message.
Definition qgis.h:157

Qgis::AuthConfigurationStorageCapability
AuthConfigurationStorageCapability
Authentication configuration storage capabilities.
Definition qgis.h:100

QgsAuthCertUtils
Utilities for working with certificates and keys.
Definition qgsauthcertutils.h:41

QgsAuthConfigSslServer
Configuration container for SSL server connection exceptions or overrides.
Definition qgsauthconfig.h:390

QgsAuthConfigurationStorage
Abstract class that defines the interface for all authentication configuration storage implementation...
Definition qgsauthconfigurationstorage.h:37

QgsAuthConfigurationStorage::mConfiguration
QMap< QString, QVariant > mConfiguration
Store the implementation-specific configuration.
Definition qgsauthconfigurationstorage.h:584

QgsAuthConfigurationStorage::mLastError
QString mLastError
Store the last error message.
Definition qgsauthconfigurationstorage.h:594

QgsAuthConfigurationStorage::description
virtual QString description() const =0
Returns a human readable localized description of the storage implementation (e.g.

QgsAuthConfigurationStorage::certIdentityChanged
void certIdentityChanged()
Emitted when the storage cert identity table was changed.

QgsAuthConfigurationStorage::authMethodConfigs
virtual QgsAuthMethodConfigsMap authMethodConfigs(const QStringList &allowedMethods=QStringList()) const =0
Returns a mapping of authentication configurations available from this storage.

QgsAuthConfigurationStorage::removeCertIdentity
virtual bool removeCertIdentity(const QSslCertificate &cert)=0
Remove a certificate identity from the storage.

QgsAuthConfigurationStorage::isReady
virtual bool isReady() const =0
Returns true is the storage is ready to be used.

QgsAuthConfigurationStorage::type
virtual QString type() const =0
Returns the type of the storage implementation.

QgsAuthConfigurationStorage::initialize
virtual bool initialize()
Initializes the storage.
Definition qgsauthconfigurationstorage.h:103

QgsAuthConfigurationStorage::certIdentities
virtual const QList< QSslCertificate > certIdentities() const =0
certIdentities get certificate identities

QgsAuthConfigurationStorage::settingsParameters
virtual QList< QgsAuthConfigurationStorage::SettingParameter > settingsParameters() const =0
Returns a list of the settings accepted by the storage.

QgsAuthConfigurationStorage::loadCertIdentity
virtual const QSslCertificate loadCertIdentity(const QString &id) const =0
certIdentity get a certificate identity by id (sha hash)

QgsAuthConfigurationStorage::storeCertIdentity
virtual bool storeCertIdentity(const QSslCertificate &cert, const QString &keyPem)=0
Store a certificate identity in the storage.

QgsAuthConfigurationStorage::name
virtual QString name() const =0
Returns a human readable localized short name of the storage implementation (e.g "SQLite").

QgsAuthConfigurationStorage::sslCertTrustPolicyChanged
void sslCertTrustPolicyChanged()
Emitted when the storage ssl cert trust policy table was changed.

QgsAuthConfigurationStorage::certAuthorityChanged
void certAuthorityChanged()
Emitted when the storage cert authority table was changed.

QgsAuthConfigurationStorage::sslCertCustomConfigChanged
void sslCertCustomConfigChanged()
Emitted when the storage ssl cert custom config table was changed.

QgsAuthConfigurationStorage::loadCertIdentityBundle
virtual const QPair< QSslCertificate, QString > loadCertIdentityBundle(const QString &id) const =0
Returns a certificate identity bundle by id (sha hash).

QgsAuthConfigurationStorage::id
virtual QString id() const =0
Returns the unique identifier of the storage object.

QgsAuthConfigurationStorage::masterPasswords
virtual const QList< QgsAuthConfigurationStorage::MasterPasswordConfig > masterPasswords() const =0
Returns the list of (encrypted) master passwords stored in the database.

QgsAuthConfigurationStorage::~QgsAuthConfigurationStorage
virtual ~QgsAuthConfigurationStorage()
Definition qgsauthconfigurationstorage.h:68

QgsAuthConfigurationStorage::mCapabilities
Qgis::AuthConfigurationStorageCapabilities mCapabilities
Store the capabilities of the storage.
Definition qgsauthconfigurationstorage.h:589

QgsAuthMethodConfig
Configuration storage class for authentication method configurations.
Definition qgsauthconfig.h:42

QgsNotSupportedException
Custom exception class which is raised when an operation is not supported.
Definition qgsexception.h:118

qgis.h

qgis_sip.h

SIP_SKIP
#define SIP_SKIP
Definition qgis_sip.h:126

SIP_OUT
#define SIP_OUT
Definition qgis_sip.h:58

SIP_THROW
#define SIP_THROW(name,...)
Definition qgis_sip.h:203

qgsauthcertutils.h

qgsauthconfig.h

QgsAuthMethodConfigsMap
QHash< QString, QgsAuthMethodConfig > QgsAuthMethodConfigsMap
Definition qgsauthconfig.h:197

qgsexception.h

QgsAuthConfigurationStorage::MasterPasswordConfig
Structure that holds the (encrypted) master password elements.
Definition qgsauthconfigurationstorage.h:46

QgsAuthConfigurationStorage::MasterPasswordConfig::hash
QString hash
Definition qgsauthconfigurationstorage.h:49

QgsAuthConfigurationStorage::MasterPasswordConfig::civ
QString civ
Definition qgsauthconfigurationstorage.h:48

QgsAuthConfigurationStorage::MasterPasswordConfig::salt
QString salt
Definition qgsauthconfigurationstorage.h:47

QgsAuthConfigurationStorage::SettingParameter
Storage configuration setting parameter.
Definition qgsauthconfigurationstorage.h:56

QgsAuthConfigurationStorage::SettingParameter::name
QString name
Definition qgsauthconfigurationstorage.h:57

QgsAuthConfigurationStorage::SettingParameter::type
QVariant::Type type
Definition qgsauthconfigurationstorage.h:59

QgsAuthConfigurationStorage::SettingParameter::description
QString description
Definition qgsauthconfigurationstorage.h:58