qt: Undeprecate API that I find useful
[gpgme.git] / lang / qt / src / signencryptjob.h
1 /*
2     signencryptjob.h
3
4     This file is part of qgpgme, the Qt API binding for gpgme
5     Copyright (c) 2004, 2007 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
35 #ifndef __KLEO_SIGNENCRYPTJOB_H__
36 #define __KLEO_SIGNENCRYPTJOB_H__
37
38 #include "job.h"
39 #include "qgpgme_export.h"
40
41 #ifdef BUILDING_QGPGME
42 # include "global.h"
43 # include "context.h"
44 #else
45 # include <gpgme++/global.h>
46 # include <gpgme++/context.h>
47 #endif
48
49 #include <memory>
50 #include <vector>
51 #include <utility>
52
53 class QByteArray;
54 class QIODevice;
55
56 namespace GpgME
57 {
58 class Error;
59 class Key;
60 class SigningResult;
61 class EncryptionResult;
62 }
63
64 namespace QGpgME
65 {
66
67 /**
68    @short An abstract base class for asynchronous combined signing and encrypting
69
70    To use a SignEncryptJob, first obtain an instance from the
71    CryptoBackend implementation, connect the progress() and result()
72    signals to suitable slots and then start the operation with a
73    call to start(). This call might fail, in which case the
74    SignEncryptJob instance will have scheduled it's own destruction
75    with a call to QObject::deleteLater().
76
77    After result() is emitted, the SignEncryptJob will schedule it's
78    own destruction by calling QObject::deleteLater().
79 */
80 class QGPGME_EXPORT SignEncryptJob : public Job
81 {
82     Q_OBJECT
83 protected:
84     explicit SignEncryptJob(QObject *parent);
85 public:
86     ~SignEncryptJob();
87
88     /**
89        Starts the combined signing and encrypting operation. \a signers
90        is the list of keys to sign \a plainText with. \a recipients is
91        a list of keys to encrypt the signed \a plainText to. In both
92        lists, empty (null) keys are ignored.
93
94        If \a alwaysTrust is true, validity checking for the
95        \em recipient keys will not be performed, but full validity
96        assumed for all \em recipient keys without further checks.
97     */
98     virtual GpgME::Error start(const std::vector<GpgME::Key> &signers,
99             const std::vector<GpgME::Key> &recipients,
100             const QByteArray &plainText,
101             bool alwaysTrust = false) = 0;
102
103     /*!
104       \overload
105
106       If \a cipherText is non-null, the ciphertext is written
107       there. Otherwise, it will be delivered in the third argument of
108       result().
109
110       \throws GpgME::Exception if starting fails
111     */
112     virtual void start(const std::vector<GpgME::Key> &signers,
113                        const std::vector<GpgME::Key> &recipients,
114                        const std::shared_ptr<QIODevice> &plainText,
115                        const std::shared_ptr<QIODevice> &cipherText = std::shared_ptr<QIODevice>(),
116                        bool alwaysTrust = false) = 0;
117
118     virtual std::pair<GpgME::SigningResult, GpgME::EncryptionResult>
119     exec(const std::vector<GpgME::Key> &signers,
120          const std::vector<GpgME::Key> &recipients,
121          const QByteArray &plainText,
122          bool alwaysTrust, QByteArray &cipherText) = 0;
123
124     /*!
125       This is a hack to request BASE64 output (instead of whatever
126       comes out normally).
127     */
128     virtual void setOutputIsBase64Encoded(bool) = 0;
129
130     /** Like start but with an additional argument for EncryptionFlags for
131      * more flexibility. */
132     virtual void start(const std::vector<GpgME::Key> &signers,
133                        const std::vector<GpgME::Key> &recipients,
134                        const std::shared_ptr<QIODevice> &plainText,
135                        const std::shared_ptr<QIODevice> &cipherText = std::shared_ptr<QIODevice>(),
136                        const GpgME::Context::EncryptionFlags flags = GpgME::Context::None) = 0;
137
138     /** Like exec but with an additional argument for EncryptionFlags for
139      * more flexibility. */
140     virtual std::pair<GpgME::SigningResult, GpgME::EncryptionResult>
141     exec(const std::vector<GpgME::Key> &signers,
142          const std::vector<GpgME::Key> &recipients,
143          const QByteArray &plainText,
144          const GpgME::Context::EncryptionFlags flags, QByteArray &cipherText) = 0;
145 Q_SIGNALS:
146     void result(const GpgME::SigningResult &signingresult,
147                 const GpgME::EncryptionResult &encryptionresult,
148                 const QByteArray &cipherText, const QString &auditLogAsHtml = QString(),
149                 const GpgME::Error &auditLogError = GpgME::Error());
150 };
151
152 }
153
154 #endif // __KLEO_SIGNENCRYPTJOB_H__