Add QGpgME code from libkleo
[gpgme.git] / lang / qt / src / qgpgmebackend.h
1 /*
2     qgpgmebackend.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 Intevation GmbH
7
8     Libkleopatra is free software; you can redistribute it and/or
9     modify it under the terms of the GNU General Public License as
10     published by the Free Software Foundation; either version 2 of the
11     License, or (at your option) any later version.
12
13     Libkleopatra is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16     General Public License for more details.
17
18     You should have received a copy of the GNU General Public License
19     along with this program; if not, write to the Free Software
20     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21
22     In addition, as a special exception, the copyright holders give
23     permission to link the code of this program with any edition of
24     the Qt library by Trolltech AS, Norway (or with modified versions
25     of Qt that use the same license as Qt), and distribute linked
26     combinations including the two.  You must obey the GNU General
27     Public License in all respects for all of the code used other than
28     Qt.  If you modify this file, you may extend this exception to
29     your version of the file, but you are not obligated to do so.  If
30     you do not wish to do so, delete this exception statement from
31     your version.
32 */
33
34 #ifndef __QGPGME_QGPGMEBACKEND_H__
35 #define __QGPGME_QGPGMEBACKEND_H__
36
37 #include <QString>
38
39 namespace QGpgME
40 {
41 class CryptoConfig;
42 class KeyListJob;
43 class ListAllKeysJob;
44 class KeyGenerationJob;
45 class ImportJob;
46 class ImportFromKeyserverJob;
47 class ExportJob;
48 class DownloadJob;
49 class DeleteJob;
50 class EncryptJob;
51 class DecryptJob;
52 class SignJob;
53 class SignKeyJob;
54 class VerifyDetachedJob;
55 class VerifyOpaqueJob;
56 class SignEncryptJob;
57 class DecryptVerifyJob;
58 class RefreshKeysJob;
59 class ChangeExpiryJob;
60 class ChangeOwnerTrustJob;
61 class ChangePasswdJob;
62 class AddUserIDJob;
63 class SpecialJob;
64 }
65
66 class QString;
67 class QVariant;
68 template <typename T_Key, typename T_Value> class QMap;
69
70 namespace QGpgME
71 {
72 class CryptoConfig;
73 class Protocol;
74
75 class QGpgMEBackend
76 {
77 public:
78     QGpgMEBackend();
79     ~QGpgMEBackend();
80
81     QString name() const;
82     QString displayName() const;
83
84     CryptoConfig *config() const;
85
86     Protocol *openpgp() const;
87     Protocol *smime() const;
88     Protocol *protocol(const char *name) const;
89
90     static const char OpenPGP[];
91     static const char SMIME[];
92
93     bool checkForOpenPGP(QString *reason = Q_NULLPTR) const;
94     bool checkForSMIME(QString *reason = Q_NULLPTR) const;
95     bool checkForProtocol(const char *name, QString *reason) const;
96
97     bool supportsOpenPGP() const
98     {
99         return true;
100     }
101     bool supportsSMIME() const
102     {
103         return true;
104     }
105     bool supportsProtocol(const char *name) const;
106
107     const char *enumerateProtocols(int i) const;
108
109 private:
110     mutable QGpgME::CryptoConfig *mCryptoConfig;
111     mutable Protocol *mOpenPGPProtocol;
112     mutable Protocol *mSMIMEProtocol;
113 };
114
115 class Protocol
116 {
117 public:
118     virtual ~Protocol() {}
119
120     virtual QString name() const = 0;
121
122     virtual QString displayName() const = 0;
123
124     virtual KeyListJob           *keyListJob(bool remote = false, bool includeSigs = false, bool validate = false) const = 0;
125     virtual ListAllKeysJob       *listAllKeysJob(bool includeSigs = false, bool validate = false) const = 0;
126     virtual EncryptJob           *encryptJob(bool armor = false, bool textmode = false) const = 0;
127     virtual DecryptJob           *decryptJob() const = 0;
128     virtual SignJob              *signJob(bool armor = false, bool textMode = false) const = 0;
129     virtual VerifyDetachedJob    *verifyDetachedJob(bool textmode = false) const = 0;
130     virtual VerifyOpaqueJob      *verifyOpaqueJob(bool textmode = false) const = 0;
131     virtual KeyGenerationJob     *keyGenerationJob() const = 0;
132     virtual ImportJob            *importJob() const = 0;
133     virtual ImportFromKeyserverJob *importFromKeyserverJob() const = 0;
134     virtual ExportJob            *publicKeyExportJob(bool armor = false) const = 0;
135     // @param charset the encoding of the passphrase in the exported file
136     virtual ExportJob            *secretKeyExportJob(bool armor = false, const QString &charset = QString()) const = 0;
137     virtual DownloadJob          *downloadJob(bool armor = false) const = 0;
138     virtual DeleteJob            *deleteJob() const = 0;
139     virtual SignEncryptJob       *signEncryptJob(bool armor = false, bool textMode = false) const = 0;
140     virtual DecryptVerifyJob     *decryptVerifyJob(bool textmode = false) const = 0;
141     virtual RefreshKeysJob       *refreshKeysJob() const = 0;
142     virtual ChangeExpiryJob      *changeExpiryJob() const;
143     virtual ChangeOwnerTrustJob *changeOwnerTrustJob() const;
144     virtual ChangePasswdJob      *changePasswdJob() const;
145     virtual SignKeyJob           *signKeyJob() const;
146     virtual AddUserIDJob         *addUserIDJob() const;
147     virtual SpecialJob           *specialJob(const char *type, const QMap<QString, QVariant> &args) const = 0;
148 };
149
150 }
151
152 #endif // __QGPGME_QGPGMEBACKEND_H__