QGpgME  9.2.0.0
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 
42 namespace QGpgME {
43 class CryptoConfig;
44 class KeyListJob;
45 class ListAllKeysJob;
46 class KeyGenerationJob;
47 class ImportJob;
48 class ImportFromKeyserverJob;
49 class ExportJob;
50 class DownloadJob;
51 class DeleteJob;
52 class EncryptJob;
53 class DecryptJob;
54 class SignJob;
55 class SignKeyJob;
56 class VerifyDetachedJob;
57 class VerifyOpaqueJob;
58 class SignEncryptJob;
59 class DecryptVerifyJob;
60 class RefreshKeysJob;
61 class ChangeExpiryJob;
62 class ChangeOwnerTrustJob;
63 class ChangePasswdJob;
64 class AddUserIDJob;
65 class SpecialJob;
66 class KeyForMailboxJob;
67 class WKSPublishJob;
68 class TofuPolicyJob;
69 
105 class QGPGME_EXPORT Protocol
106 {
107 public:
108  virtual ~Protocol() {}
109 
110  virtual QString name() const = 0;
111 
112  virtual QString displayName() const = 0;
113 
114  virtual KeyListJob *keyListJob(bool remote = false, bool includeSigs = false, bool validate = false) const = 0;
115  virtual ListAllKeysJob *listAllKeysJob(bool includeSigs = false, bool validate = false) const = 0;
116  virtual EncryptJob *encryptJob(bool armor = false, bool textmode = false) const = 0;
117  virtual DecryptJob *decryptJob() const = 0;
118  virtual SignJob *signJob(bool armor = false, bool textMode = false) const = 0;
119  virtual VerifyDetachedJob *verifyDetachedJob(bool textmode = false) const = 0;
120  virtual VerifyOpaqueJob *verifyOpaqueJob(bool textmode = false) const = 0;
121  virtual KeyGenerationJob *keyGenerationJob() const = 0;
122  virtual ImportJob *importJob() const = 0;
123  virtual ImportFromKeyserverJob *importFromKeyserverJob() const = 0;
124  virtual ExportJob *publicKeyExportJob(bool armor = false) const = 0;
125  // @param charset the encoding of the passphrase in the exported file
126  virtual ExportJob *secretKeyExportJob(bool armor = false, const QString &charset = QString()) const = 0;
127  virtual DownloadJob *downloadJob(bool armor = false) const = 0;
128  virtual DeleteJob *deleteJob() const = 0;
129  virtual SignEncryptJob *signEncryptJob(bool armor = false, bool textMode = false) const = 0;
130  virtual DecryptVerifyJob *decryptVerifyJob(bool textmode = false) const = 0;
131  virtual RefreshKeysJob *refreshKeysJob() const = 0;
132  virtual ChangeExpiryJob *changeExpiryJob() const = 0;
133  virtual SignKeyJob *signKeyJob() const = 0;
134  virtual ChangePasswdJob *changePasswdJob() const = 0;
135  virtual ChangeOwnerTrustJob *changeOwnerTrustJob() const = 0;
136  virtual AddUserIDJob *addUserIDJob() const = 0;
137  virtual SpecialJob *specialJob(const char *type, const QMap<QString, QVariant> &args) const = 0;
138 
151  virtual KeyListJob *locateKeysJob() const = 0;
153  virtual KeyForMailboxJob *keyForMailboxJob() const = 0;
154 
156  virtual WKSPublishJob *wksPublishJob() const = 0;
157 
159  virtual TofuPolicyJob *tofuPolicyJob() const = 0;
160 };
161 
167 QGPGME_EXPORT Protocol *openpgp();
168 
174 QGPGME_EXPORT Protocol *smime();
175 
181 QGPGME_EXPORT CryptoConfig *cryptoConfig();
182 
183 }
184 #endif
An abstract base class for asynchronous keyserver-importers.
Definition: importfromkeyserverjob.h:66
An abstract base class to asynchronously add UIDs to OpenPGP keys.
Definition: adduseridjob.h:64
Definition: tofupolicyjob.h:54
An abstract base class to change a key&#39;s passphrase asynchronously.
Definition: changepasswdjob.h:62
An abstract base class for asynchronous combined signing and encrypting.
Definition: signencryptjob.h:80
An abstract base class for asynchronous decrypters.
Definition: decryptjob.h:67
An abstract base class for asynchronous encrypters.
Definition: encryptjob.h:75
An abstract base class for asynchronous downloaders.
Definition: downloadjob.h:69
An abstract base class to change expiry asynchronously.
Definition: changeexpiryjob.h:64
An abstract base class for asynchronous deleters.
Definition: deletejob.h:63
Definition: wkspublishjob.h:61
An abstract base class for asynchronous verification of detached signatures.
Definition: verifydetachedjob.h:68
An abstract base class for asynchronous key generation.
Definition: keygenerationjob.h:65
An abstract base class for asynchronously listing all keys.
Definition: listallkeysjob.h:74
An abstract base class for asynchronous key refreshers.
Definition: refreshkeysjob.h:67
An abstract base class to sign keys asynchronously.
Definition: signkeyjob.h:64
An abstract base class for asynchronous exporters.
Definition: exportjob.h:66
An abstract base class for asynchronous signing.
Definition: signjob.h:76
An abstract base class for asynchronous combined decrypters and verifiers.
Definition: decryptverifyjob.h:68
Definition: abstractimportjob.h:48
An abstract base class for asynchronous importers.
Definition: importjob.h:65
An abstract base class for protocol-specific jobs.
Definition: specialjob.h:70
An abstract base class to change owner trust asynchronously.
Definition: changeownertrustjob.h:62
Get the best key to use for a Mailbox.
Definition: keyformailboxjob.h:73
Definition: protocol.h:105
An abstract base class for asynchronous verification of opaque signatures.
Definition: verifyopaquejob.h:67
Definition: qgpgmebackend.h:43
An abstract base class for asynchronous key listers.
Definition: keylistjob.h:75