babe4d0c929db3461b1e2cc822c5afe165f6f774
[gpgme.git] / lang / qt / src / signjob.h
1 /*
2     signjob.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_SIGNJOB_H__
35 #define __KLEO_SIGNJOB_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
49 class QByteArray;
50 class QIODevice;
51
52 namespace GpgME
53 {
54 class Error;
55 class Key;
56 class SigningResult;
57 }
58
59 namespace QGpgME
60 {
61
62 /**
63    @short An abstract base class for asynchronous signing
64
65    To use a SignJob, first obtain an instance from the CryptoBackend
66    implementation, connect the progress() and result() signals to
67    suitable slots and then start the signing with a call to
68    start(). This call might fail, in which case the SignJob instance
69    will have scheduled it's own destruction with a call to
70    QObject::deleteLater().
71
72    After result() is emitted, the SignJob will schedule it's own
73    destruction by calling QObject::deleteLater().
74 */
75 class QGPGME_EXPORT SignJob : public Job
76 {
77     Q_OBJECT
78 protected:
79     explicit SignJob(QObject *parent);
80 public:
81     ~SignJob();
82
83     /**
84        Starts the signing operation. \a signers is the list of keys to
85        sign \a plainText with. Empty (null) keys are ignored.
86     */
87     virtual QGPGME_DEPRECATED_EXPORT GpgME::Error start(const std::vector<GpgME::Key> &signers,
88             const QByteArray &plainText,
89             GpgME::SignatureMode mode) = 0;
90
91     /*!
92       \overload
93
94       If \a signature is non-null the signature is written
95       there. Otherwise, it will be delivered in the second argument of
96       result().
97
98       \throws GpgME::Exception if starting fails
99     */
100     virtual void start(const std::vector<GpgME::Key> &signers,
101                        const boost::shared_ptr<QIODevice> &plainText,
102                        const boost::shared_ptr<QIODevice> &signature,
103                        GpgME::SignatureMode mode) = 0;
104
105     virtual GpgME::SigningResult exec(const std::vector<GpgME::Key> &signers,
106                                       const QByteArray &plainText,
107                                       GpgME::SignatureMode mode,
108                                       QByteArray &signature) = 0;
109
110     /*!
111       This is a hack to request BASE64 output (instead of whatever
112       comes out normally).
113     */
114     virtual void setOutputIsBase64Encoded(bool) = 0;
115
116 Q_SIGNALS:
117     void result(const GpgME::SigningResult &result, const QByteArray &signature, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
118 };
119
120 }
121
122 #endif // __KLEO_SIGNJOB_H__