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