QGpgME 21.6.2.0000005
Qt API for GpgME
protocol.h
1/*
2 protocol.h
3
4 This file is part of qgpgme, the Qt API binding for gpgme
5 Copyright (c) 2004,2005 Klarälvdalens Datakonsult AB
6 Copyright (c) 2016 by Bundesamt für Sicherheit in der Informationstechnik
7 Software engineering by Intevation GmbH
8
9 QGpgME is free software; you can redistribute it and/or
10 modify it under the terms of the GNU General Public License as
11 published by the Free Software Foundation; either version 2 of the
12 License, or (at your option) any later version.
13
14 QGpgME is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22
23 In addition, as a special exception, the copyright holders give
24 permission to link the code of this program with any edition of
25 the Qt library by Trolltech AS, Norway (or with modified versions
26 of Qt that use the same license as Qt), and distribute linked
27 combinations including the two. You must obey the GNU General
28 Public License in all respects for all of the code used other than
29 Qt. If you modify this file, you may extend this exception to
30 your version of the file, but you are not obligated to do so. If
31 you do not wish to do so, delete this exception statement from
32 your version.
33*/
34#ifndef __QGPGME_PROTOCOL_H__
35#define __QGPGME_PROTOCOL_H__
36
37#include <QString>
38#include <QVariant>
39
40#include "qgpgme_export.h"
41
42namespace QGpgME {
43class AddExistingSubkeyJob;
44class CryptoConfig;
45class KeyListJob;
46class ListAllKeysJob;
47class KeyGenerationJob;
48class ImportJob;
49class ImportFromKeyserverJob;
50class ExportJob;
51class DownloadJob;
52class DeleteJob;
53class EncryptArchiveJob;
54class EncryptJob;
55class DecryptJob;
56class SignArchiveJob;
57class SignEncryptArchiveJob;
58class SignJob;
59class SignKeyJob;
60class VerifyDetachedJob;
61class VerifyOpaqueJob;
62class SignEncryptJob;
63class DecryptVerifyArchiveJob;
64class DecryptVerifyJob;
65class RefreshKeysJob;
66class ChangeExpiryJob;
67class ChangeOwnerTrustJob;
68class ChangePasswdJob;
69class AddUserIDJob;
70class SpecialJob;
71class KeyForMailboxJob;
72class WKDLookupJob;
73class WKSPublishJob;
74class TofuPolicyJob;
75class QuickJob;
76class GpgCardJob;
77class ReceiveKeysJob;
78class RevokeKeyJob;
79class SetPrimaryUserIDJob;
80class WKDRefreshJob;
81
118class QGPGME_EXPORT Protocol
119{
120public:
121 virtual ~Protocol() {}
122
123 virtual QString name() const = 0;
124
125 virtual QString displayName() const = 0;
126
127 virtual KeyListJob *keyListJob(bool remote = false, bool includeSigs = false, bool validate = false) const = 0;
128 virtual ListAllKeysJob *listAllKeysJob(bool includeSigs = false, bool validate = false) const = 0;
129 virtual EncryptJob *encryptJob(bool armor = false, bool textmode = false) const = 0;
130 virtual DecryptJob *decryptJob() const = 0;
131 virtual SignJob *signJob(bool armor = false, bool textMode = false) const = 0;
132 virtual VerifyDetachedJob *verifyDetachedJob(bool textmode = false) const = 0;
133 virtual VerifyOpaqueJob *verifyOpaqueJob(bool textmode = false) const = 0;
134 virtual KeyGenerationJob *keyGenerationJob() const = 0;
135 virtual ImportJob *importJob() const = 0;
136 virtual ImportFromKeyserverJob *importFromKeyserverJob() const = 0;
137 virtual ExportJob *publicKeyExportJob(bool armor = false) const = 0;
138 // the second parameter is ignored; the passphrase in the exported file is always utf-8 encoded
139 virtual ExportJob *secretKeyExportJob(bool armor = false, const QString & = QString()) const = 0;
140 virtual DownloadJob *downloadJob(bool armor = false) const = 0;
141 virtual DeleteJob *deleteJob() const = 0;
142 virtual SignEncryptJob *signEncryptJob(bool armor = false, bool textMode = false) const = 0;
143 virtual DecryptVerifyJob *decryptVerifyJob(bool textmode = false) const = 0;
144
150 virtual RefreshKeysJob *refreshKeysJob() const = 0;
151 virtual ChangeExpiryJob *changeExpiryJob() const = 0;
152 virtual SignKeyJob *signKeyJob() const = 0;
153 virtual ChangePasswdJob *changePasswdJob() const = 0;
154 virtual ChangeOwnerTrustJob *changeOwnerTrustJob() const = 0;
155 virtual AddUserIDJob *addUserIDJob() const = 0;
156 virtual SpecialJob *specialJob(const char *type, const QMap<QString, QVariant> &args) const = 0;
157
170 virtual KeyListJob *locateKeysJob() const = 0;
172 virtual KeyForMailboxJob *keyForMailboxJob() const = 0;
173
175 virtual WKSPublishJob *wksPublishJob() const = 0;
176
178 virtual TofuPolicyJob *tofuPolicyJob() const = 0;
179
181 virtual QuickJob *quickJob() const = 0;
182
184 virtual WKDLookupJob *wkdLookupJob() const = 0;
185
186 virtual ExportJob *secretSubkeyExportJob(bool armor = false) const = 0;
187 virtual AddExistingSubkeyJob *addExistingSubkeyJob() const = 0;
188 virtual ReceiveKeysJob *receiveKeysJob() const = 0;
189
190 virtual RevokeKeyJob *revokeKeyJob() const = 0;
191
197
198 virtual EncryptArchiveJob *encryptArchiveJob(bool armor = false) const = 0;
199 virtual SignArchiveJob *signArchiveJob(bool armor = false) const = 0;
200 virtual SignEncryptArchiveJob *signEncryptArchiveJob(bool armor = false) const = 0;
201 virtual DecryptVerifyArchiveJob *decryptVerifyArchiveJob() const = 0;
202
203 virtual WKDRefreshJob *wkdRefreshJob() const = 0;
204};
205
211QGPGME_EXPORT Protocol *openpgp();
212
218QGPGME_EXPORT Protocol *smime();
219
225QGPGME_EXPORT CryptoConfig *cryptoConfig();
226
232QGPGME_EXPORT GpgCardJob *gpgCardJob();
233
234}
235#endif
Definition: addexistingsubkeyjob.h:53
An abstract base class to asynchronously add UIDs to OpenPGP keys.
Definition: adduseridjob.h:65
An abstract base class to change expiry asynchronously.
Definition: changeexpiryjob.h:68
An abstract base class to change owner trust asynchronously.
Definition: changeownertrustjob.h:59
An abstract base class to change a key's passphrase asynchronously.
Definition: changepasswdjob.h:63
An abstract base class for asynchronous decrypters.
Definition: decryptjob.h:68
Definition: decryptverifyarchivejob.h:53
An abstract base class for asynchronous combined decrypters and verifiers.
Definition: decryptverifyjob.h:77
An abstract base class for asynchronous deleters.
Definition: deletejob.h:64
An abstract base class for asynchronous downloaders.
Definition: downloadjob.h:70
Definition: encryptarchivejob.h:53
An abstract base class for asynchronous encrypters.
Definition: encryptjob.h:84
An abstract base class for asynchronous exporters.
Definition: exportjob.h:66
Definition: gpgcardjob.h:48
An abstract base class for asynchronous keyserver-importers.
Definition: importfromkeyserverjob.h:67
An abstract base class for asynchronous importers.
Definition: importjob.h:68
Get the best key to use for a Mailbox.
Definition: keyformailboxjob.h:66
An abstract base class for asynchronous key generation.
Definition: keygenerationjob.h:66
An abstract base class for asynchronous key listers.
Definition: keylistjob.h:72
An abstract base class for asynchronously listing all keys.
Definition: listallkeysjob.h:73
Definition: protocol.h:119
virtual KeyListJob * locateKeysJob() const =0
virtual WKSPublishJob * wksPublishJob() const =0
virtual QuickJob * quickJob() const =0
virtual KeyForMailboxJob * keyForMailboxJob() const =0
virtual WKDLookupJob * wkdLookupJob() const =0
virtual SetPrimaryUserIDJob * setPrimaryUserIDJob() const =0
virtual TofuPolicyJob * tofuPolicyJob() const =0
virtual RefreshKeysJob * refreshKeysJob() const =0
Definition: quickjob.h:52
Definition: receivekeysjob.h:44
An abstract base class for asynchronous key refreshers.
Definition: refreshkeysjob.h:68
Definition: revokekeyjob.h:52
Definition: setprimaryuseridjob.h:51
Definition: signarchivejob.h:53
Definition: signencryptarchivejob.h:53
An abstract base class for asynchronous combined signing and encrypting.
Definition: signencryptjob.h:87
An abstract base class for asynchronous signing.
Definition: signjob.h:81
An abstract base class to sign keys asynchronously.
Definition: signkeyjob.h:69
An abstract base class for protocol-specific jobs.
Definition: specialjob.h:71
Definition: tofupolicyjob.h:51
An abstract base class for asynchronous verification of detached signatures.
Definition: verifydetachedjob.h:74
An abstract base class for asynchronous verification of opaque signatures.
Definition: verifyopaquejob.h:76
Definition: wkdlookupjob.h:54
Definition: wkdrefreshjob.h:56
Definition: wkspublishjob.h:60
Definition: qgpgmebackend.h:43