6794bc2ba7b0781e5a212eb619128acf390ac049
[gpgme.git] / lang / qt / src / 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
70 /** The main entry point for QGpgME Comes in OpenPGP and SMIME(CMS) flavors.
71  *
72  * Use the proctocol class to obtain an instance of a job. Jobs
73  * provide async API for GnuPG that can be connected to signals / slots.
74  *
75  * A job is usually started with start() and emits a result signal.
76  * The parameters of the result signal depend on the job but the last
77  * two are always a QString for the auditlog and an GpgME::Error for
78  * an eventual error.
79  *
80  * In case async API is used and the result signal is emitted a
81  * job schedules its own deletion.
82  *
83  * Most jobs also provide a synchronous call exec in which case
84  * you have to explicitly delete the job if you don't need it anymore.
85  *
86  * \code
87  * // Async example:
88  * KeyListJob *job = openpgp()->keyListJob();
89  * connect(job, &KeyListJob::result, job, [this, job](KeyListResult, std::vector<Key> keys, QString, Error)
90  * {
91  *    // keys and resuls can now be used.
92  * });
93  * \endcode
94  *
95  * \code
96  * // Sync eaxmple:
97  * KeyListJob *job = openpgp()->keyListJob(false, false, false);
98  * std::vector<GpgME::Key> keys;
99  * GpgME::KeyListResult result = job->exec(QStringList() <<
100  *                                         QStringLiteral("alfa@example.net"),
101  *                                         false, keys);
102  * delete job;
103  * \endcode
104  */
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
139     /** A key locate job.
140      *
141      * This tries to find a key in local
142      * and remote sources, if the key was remote it is imported
143      * by GnuPG. Same as KeyListJob but intended to be used
144      * to locate keys automatically. This ends up calling --locate-keys.
145      *
146      * Only available for OpenPGP
147      *
148      * Results are validated. As if keyListJob was called
149      * with both includeSigs and validate options.
150      */
151     virtual KeyListJob *locateKeysJob() const = 0;
152     /** Find the best key to use for a mailbox. */
153     virtual KeyForMailboxJob *keyForMailboxJob() const = 0;
154
155     /** A Job for interacting with gnupg's wks tools. */
156     virtual WKSPublishJob *wksPublishJob() const = 0;
157
158     /** A Job to set tofu policy */
159     virtual TofuPolicyJob *tofuPolicyJob() const = 0;
160 };
161
162 /** Obtain a reference to the OpenPGP Protocol.
163  *
164  * The reference is to a static object.
165  * @returns Reference to the OpenPGP Protocol.
166  */
167 QGPGME_EXPORT Protocol *openpgp();
168
169 /** Obtain a reference to the smime Protocol.
170  *
171  * The reference is to a static object.
172  * @returns Reference to the smime Protocol.
173  */
174 QGPGME_EXPORT Protocol *smime();
175
176 /** Obtain a reference to a cryptoConfig object.
177  *
178  * The reference is to a static object.
179  * @returns reference to cryptoConfig object.
180  */
181 QGPGME_EXPORT CryptoConfig *cryptoConfig();
182
183 }
184 #endif