QGpgME  13.6.0.0000000
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 class QuickJob;
70 class GpgCardJob;
71 
107 class QGPGME_EXPORT Protocol
108 {
109 public:
110  virtual ~Protocol() {}
111 
112  virtual QString name() const = 0;
113 
114  virtual QString displayName() const = 0;
115 
116  virtual KeyListJob *keyListJob(bool remote = false, bool includeSigs = false, bool validate = false) const = 0;
117  virtual ListAllKeysJob *listAllKeysJob(bool includeSigs = false, bool validate = false) const = 0;
118  virtual EncryptJob *encryptJob(bool armor = false, bool textmode = false) const = 0;
119  virtual DecryptJob *decryptJob() const = 0;
120  virtual SignJob *signJob(bool armor = false, bool textMode = false) const = 0;
121  virtual VerifyDetachedJob *verifyDetachedJob(bool textmode = false) const = 0;
122  virtual VerifyOpaqueJob *verifyOpaqueJob(bool textmode = false) const = 0;
123  virtual KeyGenerationJob *keyGenerationJob() const = 0;
124  virtual ImportJob *importJob() const = 0;
125  virtual ImportFromKeyserverJob *importFromKeyserverJob() const = 0;
126  virtual ExportJob *publicKeyExportJob(bool armor = false) const = 0;
127  // @param charset the encoding of the passphrase in the exported file
128  virtual ExportJob *secretKeyExportJob(bool armor = false, const QString &charset = QString()) const = 0;
129  virtual DownloadJob *downloadJob(bool armor = false) const = 0;
130  virtual DeleteJob *deleteJob() const = 0;
131  virtual SignEncryptJob *signEncryptJob(bool armor = false, bool textMode = false) const = 0;
132  virtual DecryptVerifyJob *decryptVerifyJob(bool textmode = false) const = 0;
133  virtual RefreshKeysJob *refreshKeysJob() const = 0;
134  virtual ChangeExpiryJob *changeExpiryJob() const = 0;
135  virtual SignKeyJob *signKeyJob() const = 0;
136  virtual ChangePasswdJob *changePasswdJob() const = 0;
137  virtual ChangeOwnerTrustJob *changeOwnerTrustJob() const = 0;
138  virtual AddUserIDJob *addUserIDJob() const = 0;
139  virtual SpecialJob *specialJob(const char *type, const QMap<QString, QVariant> &args) const = 0;
140 
153  virtual KeyListJob *locateKeysJob() const = 0;
155  virtual KeyForMailboxJob *keyForMailboxJob() const = 0;
156 
158  virtual WKSPublishJob *wksPublishJob() const = 0;
159 
161  virtual TofuPolicyJob *tofuPolicyJob() const = 0;
162 
164  virtual QuickJob *quickJob() const = 0;
165 };
166 
172 QGPGME_EXPORT Protocol *openpgp();
173 
179 QGPGME_EXPORT Protocol *smime();
180 
186 QGPGME_EXPORT CryptoConfig *cryptoConfig();
187 
193 QGPGME_EXPORT GpgCardJob *gpgCardJob();
194 
195 }
196 #endif
QGpgME::Protocol
Definition: protocol.h:107
QGpgME::DeleteJob
An abstract base class for asynchronous deleters.
Definition: deletejob.h:63
QGpgME::ImportJob
An abstract base class for asynchronous importers.
Definition: importjob.h:65
QGpgME::ExportJob
An abstract base class for asynchronous exporters.
Definition: exportjob.h:66
QGpgME::DecryptVerifyJob
An abstract base class for asynchronous combined decrypters and verifiers.
Definition: decryptverifyjob.h:68
QGpgME::SignKeyJob
An abstract base class to sign keys asynchronously.
Definition: signkeyjob.h:68
QGpgME::SpecialJob
An abstract base class for protocol-specific jobs.
Definition: specialjob.h:70
QGpgME::ChangeOwnerTrustJob
An abstract base class to change owner trust asynchronously.
Definition: changeownertrustjob.h:62
QGpgME::GpgCardJob
Get the best key to use for a Mailbox.
Definition: gpgcardjob.h:65
QGpgME::DownloadJob
An abstract base class for asynchronous downloaders.
Definition: downloadjob.h:69
QGpgME::SignEncryptJob
An abstract base class for asynchronous combined signing and encrypting.
Definition: signencryptjob.h:80
QMap
Definition: qgpgmebackend.h:43
QGpgME::ChangeExpiryJob
An abstract base class to change expiry asynchronously.
Definition: changeexpiryjob.h:71
QGpgME::VerifyDetachedJob
An abstract base class for asynchronous verification of detached signatures.
Definition: verifydetachedjob.h:68
QGpgME::KeyForMailboxJob
Get the best key to use for a Mailbox.
Definition: keyformailboxjob.h:73
QGpgME::SignJob
An abstract base class for asynchronous signing.
Definition: signjob.h:76
QGpgME::RefreshKeysJob
An abstract base class for asynchronous key refreshers.
Definition: refreshkeysjob.h:67
QGpgME::ChangePasswdJob
An abstract base class to change a key's passphrase asynchronously.
Definition: changepasswdjob.h:62
QGpgME::KeyListJob
An abstract base class for asynchronous key listers.
Definition: keylistjob.h:75
QGpgME::TofuPolicyJob
Definition: tofupolicyjob.h:54
QGpgME::VerifyOpaqueJob
An abstract base class for asynchronous verification of opaque signatures.
Definition: verifyopaquejob.h:67
QGpgME::WKSPublishJob
Definition: wkspublishjob.h:61
QGpgME::QuickJob
Definition: quickjob.h:55
QGpgME::EncryptJob
An abstract base class for asynchronous encrypters.
Definition: encryptjob.h:75
QGpgME::DecryptJob
An abstract base class for asynchronous decrypters.
Definition: decryptjob.h:67
QGpgME::ListAllKeysJob
An abstract base class for asynchronously listing all keys.
Definition: listallkeysjob.h:74
QGpgME::KeyGenerationJob
An abstract base class for asynchronous key generation.
Definition: keygenerationjob.h:65
QGpgME::AddUserIDJob
An abstract base class to asynchronously add UIDs to OpenPGP keys.
Definition: adduseridjob.h:64
QGpgME::ImportFromKeyserverJob
An abstract base class for asynchronous keyserver-importers.
Definition: importfromkeyserverjob.h:66