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