qgsauthconfigurationstoragedb.h

Go to the documentation of this file.

/***************************************************************************
  qgsauthconfigurationstoragedb.h - QgsAuthConfigurationStorageDb
 
 ---------------------
 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 QGSAUTHCONFIGURATIONSTORAGEDB_H
#define QGSAUTHCONFIGURATIONSTORAGEDB_H
 
#include "qgis_core.h"
#include "qgsauthconfigurationstorage.h"
 
#include <QObject>
#include <QRecursiveMutex>
#include <QSqlDatabase>

class CORE_EXPORT QgsAuthConfigurationStorageDb : public QgsAuthConfigurationStorage
{
    Q_OBJECT
  public:

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

    QgsAuthConfigurationStorageDb( const QString &uri );
 
 
    ~QgsAuthConfigurationStorageDb() override;
 

    QSqlDatabase authDatabaseConnection() const;
 
    // QgsAuthConfigurationStorage interface
  public:
    QString name() const override;
    QString type() const override;
    QString description() const override;
    QString id() const override;
 
    QgsAuthMethodConfigsMap authMethodConfigs( const QStringList &allowedMethods = QStringList() ) const override;
    QgsAuthMethodConfigsMap authMethodConfigsWithPayload( ) const override;
    QgsAuthMethodConfig loadMethodConfig( const QString &id, QString &payload SIP_OUT, bool full = false ) const override;
    bool storeMethodConfig( const QgsAuthMethodConfig &mconfig, const QString &payload ) override;
    bool removeMethodConfig( const QString &id ) override;
    bool methodConfigExists( const QString &id ) const override;
    bool storeAuthSetting( const QString &key, const QString &value ) override;
    QString loadAuthSetting( const QString &key ) const override;
    bool removeAuthSetting( const QString &key ) override;
    bool authSettingExists( const QString &key ) const override;
    bool clearMethodConfigs() override;
    bool erase() override;
    bool isReady() const override;
    bool initialize() override;
    QList<QgsAuthConfigurationStorage::SettingParameter> settingsParameters() const override;
 
    bool storeCertIdentity( const QSslCertificate &cert, const QString &keyPem ) override;
    bool removeCertIdentity( const QSslCertificate &cert ) override;
    const QSslCertificate loadCertIdentity( const QString &id ) const override;
    const QPair<QSslCertificate, QString> loadCertIdentityBundle( const QString &id ) const override;
    const QList<QSslCertificate> certIdentities() const override;
    QStringList certIdentityIds() const override;
    bool certIdentityExists( const QString &id ) const override;
    bool removeCertIdentity( const QString &id ) override;
    bool storeSslCertCustomConfig( const QgsAuthConfigSslServer &config ) override;
    QStringList sslCertCustomConfigIds() const override;
    const QgsAuthConfigSslServer loadSslCertCustomConfig( const QString &id, const QString &hostport ) const override;
    const QgsAuthConfigSslServer loadSslCertCustomConfigByHost( const QString &hostport ) const override;
    const QList<QgsAuthConfigSslServer> sslCertCustomConfigs() const override;
    bool sslCertCustomConfigExists( const QString &id, const QString &hostport ) override;
    bool removeSslCertCustomConfig( const QString &id, const QString &hostport ) override;
 
    bool storeCertAuthority( const QSslCertificate &cert ) override;
    QStringList certAuthorityIds() const override;
    const QSslCertificate loadCertAuthority( const QString &id ) const override;
    bool certAuthorityExists( const QSslCertificate &cert ) const override;
    bool removeCertAuthority( const QSslCertificate &cert ) override;
    const QMap<QString, QgsAuthCertUtils::CertTrustPolicy> caCertsPolicy() const override;
    const QList<QSslCertificate> caCerts() const override;
 
    bool storeCertTrustPolicy( const QSslCertificate &cert, QgsAuthCertUtils::CertTrustPolicy policy ) override;
    QgsAuthCertUtils::CertTrustPolicy loadCertTrustPolicy( const QSslCertificate &cert ) const override;
    bool removeCertTrustPolicy( const QSslCertificate &cert ) override;
    bool certTrustPolicyExists( const QSslCertificate &cert ) const override;
 
    const QList<QgsAuthConfigurationStorage::MasterPasswordConfig> masterPasswords( ) const override;
    bool storeMasterPassword( const QgsAuthConfigurationStorage::MasterPasswordConfig &config ) override;
    bool clearMasterPasswords() override;
 
    // DB specific methods

    virtual QString methodConfigTableName() const;

    virtual QString authSettingsTableName() const;

    virtual QString certIdentityTableName() const;

    virtual QString certAuthorityTableName() const;

    virtual QString sslCertCustomConfigTableName() const;

    virtual QString certTrustPolicyTableName() const;

    virtual QString masterPasswordTableName() const;

    virtual bool tableExists( const QString &table ) const;

    virtual QString quotedQualifiedIdentifier( const QString &identifier, bool isIndex = false ) const;
 
  private:
 
    bool clearTables( const QStringList &tables );
 
    static const QMap<QString, QVariant> uriToSettings( const QString &uri );
    mutable QMap<QThread *, QMetaObject::Connection> mConnectedThreads;
 
  protected:

    bool authDbOpen() const;

    bool authDbQuery( QSqlQuery *query, const QString &sql = QString() ) const;

    bool authDbTransactionQuery( QSqlQuery *query );

    bool createConfigTables();

    bool createCertTables();

    virtual void checkCapabilities();
 
    // Storage ID
    mutable QString mId;
 
    // From https://doc.qt.io/qt-6/sql-driver.html
    QString mDriver;
    QString mDatabase;
    QString mHost;
    QString mUser;
    QString mPassword;
    int mPort;
    // Driver specific options
    QString mConnectOptions;
 
    bool mIsReady = false;
 
    mutable QRecursiveMutex mMutex;
 
};
 
#endif // QGSAUTHCONFIGURATIONSTORAGEDB_H