IKeychainService.h

/*
 * Copyright 2018-2020 Dmitry Ivanov
 *
 * This file is part of libquentier
 *
 * libquentier is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * libquentier is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIB_QUENTIER_UTILITY_I_KEYCHAIN_SERVICE_H
#define LIB_QUENTIER_UTILITY_I_KEYCHAIN_SERVICE_H
 
#include <quentier/types/ErrorString.h>
#include <quentier/utility/ForwardDeclarations.h>
#include <quentier/utility/Linkage.h>
 
#include <QObject>
#include <QUuid>
 
#include <memory>
 
QT_FORWARD_DECLARE_CLASS(QDebug)
 
namespace quentier {

class QUENTIER_EXPORT IKeychainService : public QObject
{
    Q_OBJECT
protected:
    explicit IKeychainService(QObject * parent = nullptr);
 
public:
    virtual ~IKeychainService() {}

    enum class ErrorCode
    {
        NoError,
        EntryNotFound,
        CouldNotDeleteEntry,
        AccessDeniedByUser,
        AccessDenied,
        NoBackendAvailable,
        NotImplemented,
        OtherError
    };
 
    friend QTextStream & operator<<(
        QTextStream & strm, const ErrorCode errorCode);
 
    friend QDebug & operator<<(QDebug & dbg, const ErrorCode errorCode);
 
public:
    virtual QUuid startWritePasswordJob(
        const QString & service, const QString & key,
        const QString & password) = 0;

    virtual QUuid startReadPasswordJob(
        const QString & service, const QString & key) = 0;

    virtual QUuid startDeletePasswordJob(
        const QString & service, const QString & key) = 0;
 
Q_SIGNALS:
    void writePasswordJobFinished(
        QUuid requestId, ErrorCode errorCode, ErrorString errorDescription);

    void readPasswordJobFinished(
        QUuid requestId, ErrorCode errorCode, ErrorString errorDescription,
        QString password);

    void deletePasswordJobFinished(
        QUuid requestId, ErrorCode errorCode, ErrorString errorDescription);
 
private:
    Q_DISABLE_COPY(IKeychainService);
};
 
QUENTIER_EXPORT IKeychainServicePtr
newQtKeychainService(QObject * parent = nullptr);
 
QUENTIER_EXPORT IKeychainServicePtr
newObfuscatingKeychainService(QObject * parent = nullptr);
 
QUENTIER_EXPORT IKeychainServicePtr newCompositeKeychainService(
    QString name, IKeychainServicePtr primaryKeychain,
    IKeychainServicePtr secondaryKeychain, QObject * parent = nullptr);
 
QUENTIER_EXPORT IKeychainServicePtr newMigratingKeychainService(
    IKeychainServicePtr sourceKeychain, IKeychainServicePtr sinkKeychain,
    QObject * parent = nullptr);
 
} // namespace quentier
 
#endif // LIB_QUENTIER_UTILITY_I_KEYCHAIN_SERVICE_H