rnpcrypto.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Anne Jan Brouwer
// SPDX-License-Identifier: GPL-3.0-or-later
#ifndef SRC_RNPCRYPTO_H_
#define SRC_RNPCRYPTO_H_
 
#include <QByteArray>
#include <QDateTime>
#include <QList>
#include <QString>
#include <QStringList>
#include <functional>
 
struct rnp_ffi_st;

class RnpCrypto {
public:
  struct KeyInfo {
    QString fingerprint;
    QString keyId;
    QStringList userIds;
    QDateTime created;
    QDateTime expires;
    bool revoked = false;
    bool expired = false;
    bool hasSecret = false;
    bool secretProtected = true;
    bool canEncrypt = false;
    bool canSign = false;
  };

  using PassphraseProvider = std::function<QString(const QString &keyId)>;

  static constexpr qint64 kMaxPlaintextBytes = 64LL * 1024 * 1024;

  static constexpr qint64 kMaxKeyringBytes = 64LL * 1024 * 1024;

  RnpCrypto();
  ~RnpCrypto();
  // RNP holds a pointer to m_passphrase (the passphrase callback's context),
  // so the object must stay where it is: neither copied nor moved.
  RnpCrypto(const RnpCrypto &) = delete;
  auto operator=(const RnpCrypto &) -> RnpCrypto & = delete;
  RnpCrypto(RnpCrypto &&) = delete;
  auto operator=(RnpCrypto &&) -> RnpCrypto & = delete;

  [[nodiscard]] auto isValid() const -> bool;

  auto importKeys(const QByteArray &keyData, QString *error = nullptr)
      -> QStringList;

  void setPassphraseProvider(PassphraseProvider provider);

  void setMaxPlaintextBytes(qint64 bytes);

  auto encrypt(const QByteArray &plaintext, const QStringList &recipients,
               QString *error = nullptr) -> QByteArray;

  auto decrypt(const QByteArray &ciphertext, QString *error = nullptr,
               bool *ok = nullptr) -> QByteArray;

  [[nodiscard]] auto listKeys(bool secretOnly = false) const -> QList<KeyInfo>;

  auto sign(const QByteArray &data, const QString &signer,
            QString *error = nullptr) -> QByteArray;

  auto verify(const QByteArray &data, const QByteArray &signature,
              QString *error = nullptr) -> QStringList;

  auto protectKey(const QString &fingerprint, const QString &passphrase,
                  QString *error = nullptr) -> bool;

  auto saveKeyring(const QString &dir, bool allowUnprotected = false,
                   QString *error = nullptr) const -> bool;

  auto loadKeyring(const QString &dir, QString *error = nullptr) -> bool;
 
private:
  rnp_ffi_st *m_ffi = nullptr;
  PassphraseProvider m_passphrase;
  qint64 m_maxPlaintext = kMaxPlaintextBytes;
};
 
#endif // SRC_RNPCRYPTO_H_