QGpgME  19.4.0.0000000
Qt API for GpgME
encryptjob.h
1 /*
2  encryptjob.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  Copyright (c) 2022 g10 Code GmbH
9  Software engineering by Ingo Klöcker <dev@ingo-kloecker.de>
10 
11  QGpgME is free software; you can redistribute it and/or
12  modify it under the terms of the GNU General Public License as
13  published by the Free Software Foundation; either version 2 of the
14  License, or (at your option) any later version.
15 
16  QGpgME is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  General Public License for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with this program; if not, write to the Free Software
23  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 
25  In addition, as a special exception, the copyright holders give
26  permission to link the code of this program with any edition of
27  the Qt library by Trolltech AS, Norway (or with modified versions
28  of Qt that use the same license as Qt), and distribute linked
29  combinations including the two. You must obey the GNU General
30  Public License in all respects for all of the code used other than
31  Qt. If you modify this file, you may extend this exception to
32  your version of the file, but you are not obligated to do so. If
33  you do not wish to do so, delete this exception statement from
34  your version.
35 */
36 
37 #ifndef __KLEO_ENCRYPTJOB_H__
38 #define __KLEO_ENCRYPTJOB_H__
39 
40 #include "job.h"
41 #include "data.h"
42 
43 #include <memory>
44 #include <vector>
45 
46 #ifdef BUILDING_QGPGME
47 # include "context.h"
48 #else
49 # include <gpgme++/context.h>
50 #endif
51 
52 class QByteArray;
53 class QIODevice;
54 
55 namespace GpgME
56 {
57 class Error;
58 class Key;
59 class EncryptionResult;
60 }
61 
62 namespace QGpgME
63 {
64 
78 class QGPGME_EXPORT EncryptJob : public Job
79 {
80  Q_OBJECT
81 protected:
82  explicit EncryptJob(QObject *parent);
83 public:
84  ~EncryptJob();
85 
86  void setFileName(const QString &fileName);
87  QString fileName() const;
88 
89  void setInputEncoding(GpgME::Data::Encoding);
90  GpgME::Data::Encoding inputEncoding() const;
91 
102  virtual GpgME::Error start(const std::vector<GpgME::Key> &recipients,
103  const QByteArray &plainText, bool alwaysTrust = false) = 0;
104 
112  virtual void start(const std::vector<GpgME::Key> &recipients,
113  const std::shared_ptr<QIODevice> &plainText,
114  const std::shared_ptr<QIODevice> &cipherText = std::shared_ptr<QIODevice>(),
115  bool alwaysTrust = false) = 0;
116 
117  virtual GpgME::EncryptionResult exec(const std::vector<GpgME::Key> &recipients,
118  const QByteArray &plainText,
119  bool alwaysTrust, QByteArray &cipherText) = 0;
124  virtual void setOutputIsBase64Encoded(bool) = 0;
125 
128  virtual void start(const std::vector<GpgME::Key> &recipients,
129  const std::shared_ptr<QIODevice> &plainText,
130  const std::shared_ptr<QIODevice> &cipherText = std::shared_ptr<QIODevice>(),
131  const GpgME::Context::EncryptionFlags flags = GpgME::Context::None) = 0;
132 
135  virtual GpgME::EncryptionResult exec(const std::vector<GpgME::Key> &recipients,
136  const QByteArray &plainText,
137  const GpgME::Context::EncryptionFlags flags, QByteArray &cipherText) = 0;
138 Q_SIGNALS:
139  void result(const GpgME::EncryptionResult &result, const QByteArray &cipherText, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error());
140 };
141 
142 }
143 
144 #endif // __KLEO_ENCRYPTJOB_H__
An abstract base class for asynchronous encrypters.
Definition: encryptjob.h:79
virtual void start(const std::vector< GpgME::Key > &recipients, const std::shared_ptr< QIODevice > &plainText, const std::shared_ptr< QIODevice > &cipherText=std::shared_ptr< QIODevice >(), const GpgME::Context::EncryptionFlags flags=GpgME::Context::None)=0
virtual void setOutputIsBase64Encoded(bool)=0
virtual GpgME::EncryptionResult exec(const std::vector< GpgME::Key > &recipients, const QByteArray &plainText, const GpgME::Context::EncryptionFlags flags, QByteArray &cipherText)=0
virtual void start(const std::vector< GpgME::Key > &recipients, const std::shared_ptr< QIODevice > &plainText, const std::shared_ptr< QIODevice > &cipherText=std::shared_ptr< QIODevice >(), bool alwaysTrust=false)=0
virtual GpgME::Error start(const std::vector< GpgME::Key > &recipients, const QByteArray &plainText, bool alwaysTrust=false)=0
An abstract base class for asynchronous crypto operations.
Definition: job.h:73