1 /* 2 decryptverifyjob.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_DECRYPTVERIFYJOB_H__ 36 #define __KLEO_DECRYPTVERIFYJOB_H__ 37 38 #include "job.h" 39 40 #include <memory> 41 42 class QByteArray; 43 class QIODevice; 44 45 namespace GpgME 46 { 47 class Error; 48 class DecryptionResult; 49 class VerificationResult; 50 } 51 52 namespace QGpgME 53 { 54 55 /** 56 @short An abstract base class for asynchronous combined decrypters and verifiers 57 58 To use a DecryptVerifyJob, first obtain an instance from the 59 CryptoBackend implementation, connect the progress() and result() 60 signals to suitable slots and then start the operation with a 61 call to start(). This call might fail, in which case the 62 DecryptVerifyJob instance will have scheduled it's own destruction with 63 a call to QObject::deleteLater(). 64 65 After result() is emitted, the DecryptVerifyJob will schedule it's own 66 destruction by calling QObject::deleteLater(). 67 */ 68 class QGPGME_EXPORT DecryptVerifyJob : public Job 69 { 70 Q_OBJECT 71 protected: 72 explicit DecryptVerifyJob(QObject *parent); 73 public: 74 ~DecryptVerifyJob(); 75 76 /** 77 Starts the combined decryption and verification operation. 78 \a cipherText is the data to decrypt and later verify. 79 */ 80 virtual GpgME::Error start(const QByteArray &cipherText) = 0; 81 82 /*! 83 \overload 84 85 If \a plainText is non-null, the plaintext is written 86 there. Otherwise, it will be delivered in the third argument 87 of result(). 88 89 \throws GpgME::Exception if starting fails 90 */ 91 virtual void start(const std::shared_ptr<QIODevice> &cipherText, const std::shared_ptr<QIODevice> &plainText = std::shared_ptr<QIODevice>()) = 0; 92 93 /** Synchronous equivalent of start() */ 94 virtual std::pair<GpgME::DecryptionResult, GpgME::VerificationResult> 95 exec(const QByteArray &cipherText, QByteArray &plainText) = 0; 96 97 Q_SIGNALS: 98 void result(const GpgME::DecryptionResult &decryptionresult, 99 const GpgME::VerificationResult &verificationresult, 100 const QByteArray &plainText, const QString &auditLogAsHtml = QString(), 101 const GpgME::Error &auditLogError = GpgME::Error()); 102 }; 103 104 } 105 106 #endif // __KLEO_DECRYPTVERIFYJOB_H__ 107