Loading...
Searching...
No Matches
protocol_p.h
/*
protocol_p.h
This file is part of qgpgme, the Qt API binding for gpgme
Copyright (c) 2004,2005 Klarälvdalens Datakonsult AB
Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik
Software engineering by Intevation GmbH
Copyright (c) 2022 by g10 Code GmbH
Software engineering by Ingo Klöcker <dev@ingo-kloecker.de>
QGpgME 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.
QGpgME 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
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
In addition, as a special exception, the copyright holders give
permission to link the code of this program with any edition of
the Qt library by Trolltech AS, Norway (or with modified versions
of Qt that use the same license as Qt), and distribute linked
combinations including the two. You must obey the GNU General
Public License in all respects for all of the code used other than
Qt. If you modify this file, you may extend this exception to
your version of the file, but you are not obligated to do so. If
you do not wish to do so, delete this exception statement from
your version.
*/
#ifndef __QGPGME_PROTOCOL_P_H__
#define __QGPGME_PROTOCOL_P_H__
#include "qgpgmenewcryptoconfig.h"
#include "qgpgmeadqueryjob.h"
#include "qgpgmekeygenerationjob.h"
#include "qgpgmekeylistjob.h"
#include "qgpgmelistallkeysjob.h"
#include "qgpgmedecryptjob.h"
#include "qgpgmedecryptverifyarchivejob.h"
#include "qgpgmedecryptverifyjob.h"
#include "qgpgmerefreshsmimekeysjob.h"
#include "qgpgmedeletejob.h"
#include "qgpgmedownloadjob.h"
#include "qgpgmesignencryptjob.h"
#include "qgpgmeencryptarchivejob.h"
#include "qgpgmeencryptjob.h"
#include "qgpgmesignarchivejob.h"
#include "qgpgmesignencryptarchivejob.h"
#include "qgpgmesignjob.h"
#include "qgpgmesignkeyjob.h"
#include "qgpgmeexportjob.h"
#include "qgpgmeverifydetachedjob.h"
#include "qgpgmeimportjob.h"
#include "qgpgmeimportfromkeyserverjob.h"
#include "qgpgmeverifyopaquejob.h"
#include "qgpgmechangeexpiryjob.h"
#include "qgpgmechangeownertrustjob.h"
#include "qgpgmechangepasswdjob.h"
#include "qgpgmeaddexistingsubkeyjob.h"
#include "qgpgmeadduseridjob.h"
#include "qgpgmekeyformailboxjob.h"
#include "qgpgmewkdlookupjob.h"
#include "qgpgmewkspublishjob.h"
#include "qgpgmetofupolicyjob.h"
#include "qgpgmequickjob.h"
#include "qgpgmereceivekeysjob.h"
#include "qgpgmerevokekeyjob.h"
#include "qgpgmesetprimaryuseridjob.h"
#include "qgpgmewkdrefreshjob.h"
namespace
{
class Protocol : public QGpgME::Protocol
{
GpgME::Protocol mProtocol;
public:
explicit Protocol(GpgME::Protocol proto) : mProtocol(proto) {}
QString name() const override
{
switch (mProtocol) {
case GpgME::OpenPGP: return QStringLiteral("OpenPGP");
case GpgME::CMS: return QStringLiteral("SMIME");
default: return QString();
}
}
QString displayName() const override
{
// ah (2.4.16): Where is this used and isn't this inverted
// with name
switch (mProtocol) {
case GpgME::OpenPGP: return QStringLiteral("gpg");
case GpgME::CMS: return QStringLiteral("gpgsm");
default: return QStringLiteral("unknown");
}
}
QGpgME::SpecialJob *specialJob(const char *, const QMap<QString, QVariant> &) const override
{
return nullptr;
}
QGpgME::KeyListJob *keyListJob(bool remote, bool includeSigs, bool validate) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
unsigned int mode = context->keyListMode();
if (remote) {
mode |= GpgME::Extern;
mode &= ~GpgME::Local;
} else {
mode |= GpgME::Local;
mode &= ~GpgME::Extern;
}
if (includeSigs) {
mode |= GpgME::Signatures;
}
if (validate) {
mode |= GpgME::Validate;
}
context->setKeyListMode(mode);
return new QGpgME::QGpgMEKeyListJob(context);
}
QGpgME::ListAllKeysJob *listAllKeysJob(bool includeSigs, bool validate) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
unsigned int mode = context->keyListMode();
mode |= GpgME::Local;
mode &= ~GpgME::Extern;
if (includeSigs) {
mode |= GpgME::Signatures;
}
if (validate) {
mode |= GpgME::Validate;
/* Setting the context to offline mode disables CRL / OCSP checks in
this Job. Otherwise we would try to fetch the CRL's for all CMS
keys in the users keyring because GpgME::Validate includes remote
resources by default in the validity check.
This setting only has any effect if gpgsm >= 2.1.6 is used.
*/
context->setOffline(true);
}
context->setKeyListMode(mode);
return new QGpgME::QGpgMEListAllKeysJob(context);
}
QGpgME::EncryptJob *encryptJob(bool armor, bool textmode) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
context->setArmor(armor);
context->setTextMode(textmode);
return new QGpgME::QGpgMEEncryptJob(context);
}
QGpgME::DecryptJob *decryptJob() const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEDecryptJob(context);
}
QGpgME::SignJob *signJob(bool armor, bool textMode) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
context->setArmor(armor);
context->setTextMode(textMode);
return new QGpgME::QGpgMESignJob(context);
}
QGpgME::VerifyDetachedJob *verifyDetachedJob(bool textMode) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
context->setTextMode(textMode);
return new QGpgME::QGpgMEVerifyDetachedJob(context);
}
QGpgME::VerifyOpaqueJob *verifyOpaqueJob(bool textMode) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
context->setTextMode(textMode);
return new QGpgME::QGpgMEVerifyOpaqueJob(context);
}
QGpgME::KeyGenerationJob *keyGenerationJob() const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEKeyGenerationJob(context);
}
QGpgME::ImportJob *importJob() const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEImportJob(context);
}
QGpgME::ImportFromKeyserverJob *importFromKeyserverJob() const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEImportFromKeyserverJob(context);
}
QGpgME::ReceiveKeysJob *receiveKeysJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEReceiveKeysJob{context};
}
QGpgME::ExportJob *publicKeyExportJob(bool armor) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
context->setArmor(armor);
return new QGpgME::QGpgMEExportJob(context);
}
QGpgME::ExportJob *secretKeyExportJob(bool armor, const QString &) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
context->setArmor(armor);
return new QGpgME::QGpgMEExportJob(context, GpgME::Context::ExportSecret);
}
QGpgME::ExportJob *secretSubkeyExportJob(bool armor) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
context->setArmor(armor);
return new QGpgME::QGpgMEExportJob(context, GpgME::Context::ExportSecretSubkey);
}
QGpgME::RefreshKeysJob *refreshKeysJob() const override
{
if (mProtocol != GpgME::CMS) {
return nullptr;
}
return new QGpgME::QGpgMERefreshSMIMEKeysJob;
}
QGpgME::DownloadJob *downloadJob(bool armor) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
context->setArmor(armor);
// this is the hackish interface for downloading from keyserers currently:
context->setKeyListMode(GpgME::Extern);
return new QGpgME::QGpgMEDownloadJob(context);
}
QGpgME::DeleteJob *deleteJob() const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEDeleteJob(context);
}
QGpgME::SignEncryptJob *signEncryptJob(bool armor, bool textMode) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
context->setArmor(armor);
context->setTextMode(textMode);
return new QGpgME::QGpgMESignEncryptJob(context);
}
QGpgME::DecryptVerifyJob *decryptVerifyJob(bool textMode) const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
context->setTextMode(textMode);
return new QGpgME::QGpgMEDecryptVerifyJob(context);
}
QGpgME::ChangeExpiryJob *changeExpiryJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr; // only supported by gpg
}
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEChangeExpiryJob(context);
}
QGpgME::ChangePasswdJob *changePasswdJob() const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEChangePasswdJob(context);
}
QGpgME::SignKeyJob *signKeyJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr; // only supported by gpg
}
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMESignKeyJob(context);
}
QGpgME::ChangeOwnerTrustJob *changeOwnerTrustJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr; // only supported by gpg
}
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEChangeOwnerTrustJob(context);
}
QGpgME:: AddExistingSubkeyJob *addExistingSubkeyJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr; // only supported by gpg
}
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEAddExistingSubkeyJob{context};
}
QGpgME::AddUserIDJob *addUserIDJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr; // only supported by gpg
}
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEAddUserIDJob(context);
}
QGpgME::KeyListJob *locateKeysJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
context->setKeyListMode(GpgME::Locate | GpgME::Signatures | GpgME::Validate);
return new QGpgME::QGpgMEKeyListJob(context);
}
QGpgME::KeyForMailboxJob *keyForMailboxJob() const override
{
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEKeyForMailboxJob(context);
}
QGpgME::WKDLookupJob *wkdLookupJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
auto context = GpgME::Context::createForEngine(GpgME::AssuanEngine);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEWKDLookupJob(context.release());
}
QGpgME::WKSPublishJob *wksPublishJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
auto context = GpgME::Context::createForEngine(GpgME::SpawnEngine);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEWKSPublishJob(context.release());
}
QGpgME::TofuPolicyJob *tofuPolicyJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMETofuPolicyJob(context);
}
QGpgME::QuickJob *quickJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMEQuickJob(context);
}
QGpgME::RevokeKeyJob *revokeKeyJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMERevokeKeyJob(context);
}
QGpgME::SetPrimaryUserIDJob *setPrimaryUserIDJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
GpgME::Context *context = GpgME::Context::createForProtocol(mProtocol);
if (!context) {
return nullptr;
}
return new QGpgME::QGpgMESetPrimaryUserIDJob{context};
}
QGpgME::EncryptArchiveJob *encryptArchiveJob(bool armor) const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
if (auto context = GpgME::Context::createForProtocol(mProtocol)) {
context->setArmor(armor);
return new QGpgME::QGpgMEEncryptArchiveJob{context};
}
return nullptr;
}
QGpgME::SignArchiveJob *signArchiveJob(bool armor) const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
if (auto context = GpgME::Context::createForProtocol(mProtocol)) {
context->setArmor(armor);
return new QGpgME::QGpgMESignArchiveJob{context};
}
return nullptr;
}
QGpgME::SignEncryptArchiveJob *signEncryptArchiveJob(bool armor) const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
if (auto context = GpgME::Context::createForProtocol(mProtocol)) {
context->setArmor(armor);
return new QGpgME::QGpgMESignEncryptArchiveJob{context};
}
return nullptr;
}
QGpgME::DecryptVerifyArchiveJob *decryptVerifyArchiveJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
if (auto context = GpgME::Context::createForProtocol(mProtocol)) {
return new QGpgME::QGpgMEDecryptVerifyArchiveJob{context};
}
return nullptr;
}
QGpgME::WKDRefreshJob *wkdRefreshJob() const override
{
if (mProtocol != GpgME::OpenPGP) {
return nullptr;
}
if (auto context = GpgME::Context::createForProtocol(mProtocol)) {
return new QGpgME::QGpgMEWKDRefreshJob{context};
}
return nullptr;
}
QGpgME::ADQueryJob *adQueryJob() const override
{
if (auto context = GpgME::Context::createForEngine(GpgME::AssuanEngine)) {
return new QGpgME::QGpgMEADQueryJob{context.release()};
}
return nullptr;
}
};
}
#endif
QGpgME::Protocol
Definition protocol.h:120