IEncryptor.h

/*
 * Copyright 2024-2025 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/>.
 */

#pragma once

#include <quentier/types/ErrorString.h>
#include <quentier/types/Result.h>
#include <quentier/utility/Linkage.h>

#include <QString>

class QDebug;
class QTextStream;

namespace quentier::utility {

struct QUENTIER_EXPORT IEncryptor
{
    virtual ~IEncryptor() noexcept;

    enum class Cipher
    {
        RC2,
        AES
    };

    friend QUENTIER_EXPORT QDebug & operator<<(QDebug & dbg, Cipher cipher);

    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, Cipher cipher);

    [[nodiscard]] virtual Result<QString, ErrorString> encrypt(
        const QString & text, const QString & passphrase) = 0;

    [[nodiscard]] virtual Result<QString, ErrorString> decrypt(
        const QString & encryptedText, const QString & passphrase,
        Cipher cipher) = 0;
};

} // namespace quentier::utility