qgsauthconfigurationstorage.h

Go to the documentation of this file.

/***************************************************************************
  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