diff options
Diffstat (limited to 'lang/qt/src/signjob.h')
-rw-r--r-- | lang/qt/src/signjob.h | 122 |
1 files changed, 122 insertions, 0 deletions
diff --git a/lang/qt/src/signjob.h b/lang/qt/src/signjob.h new file mode 100644 index 0000000..cf5c628 --- /dev/null +++ b/lang/qt/src/signjob.h @@ -0,0 +1,122 @@ +/* + signjob.h + + This file is part of qgpgme, the Qt API binding for gpgme + Copyright (c) 2004, 2007 Klarälvdalens Datakonsult AB + Copyright (c) 2016 Intevation GmbH + + QGpgME is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + + QGpgME is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + + In addition, as a special exception, the copyright holders give + permission to link the code of this program with any edition of + the Qt library by Trolltech AS, Norway (or with modified versions + of Qt that use the same license as Qt), and distribute linked + combinations including the two. You must obey the GNU General + Public License in all respects for all of the code used other than + Qt. If you modify this file, you may extend this exception to + your version of the file, but you are not obligated to do so. If + you do not wish to do so, delete this exception statement from + your version. +*/ + +#ifndef __KLEO_SIGNJOB_H__ +#define __KLEO_SIGNJOB_H__ + +#include "job.h" + +#ifdef BUILDING_QGPGME +# include "global.h" +#else +# include <gpgme++/global.h> +#endif + + +#include <vector> +#include <memory> + +class QByteArray; +class QIODevice; + +namespace GpgME +{ +class Error; +class Key; +class SigningResult; +} + +namespace QGpgME +{ + +/** + @short An abstract base class for asynchronous signing + + To use a SignJob, first obtain an instance from the CryptoBackend + implementation, connect the progress() and result() signals to + suitable slots and then start the signing with a call to + start(). This call might fail, in which case the SignJob instance + will have scheduled it's own destruction with a call to + QObject::deleteLater(). + + After result() is emitted, the SignJob will schedule it's own + destruction by calling QObject::deleteLater(). +*/ +class QGPGME_EXPORT SignJob : public Job +{ + Q_OBJECT +protected: + explicit SignJob(QObject *parent); +public: + ~SignJob(); + + /** + Starts the signing operation. \a signers is the list of keys to + sign \a plainText with. Empty (null) keys are ignored. + */ + virtual QGPGME_DEPRECATED_EXPORT GpgME::Error start(const std::vector<GpgME::Key> &signers, + const QByteArray &plainText, + GpgME::SignatureMode mode) = 0; + + /*! + \overload + + If \a signature is non-null the signature is written + there. Otherwise, it will be delivered in the second argument of + result(). + + \throws GpgME::Exception if starting fails + */ + virtual void start(const std::vector<GpgME::Key> &signers, + const std::shared_ptr<QIODevice> &plainText, + const std::shared_ptr<QIODevice> &signature, + GpgME::SignatureMode mode) = 0; + + virtual GpgME::SigningResult exec(const std::vector<GpgME::Key> &signers, + const QByteArray &plainText, + GpgME::SignatureMode mode, + QByteArray &signature) = 0; + + /*! + This is a hack to request BASE64 output (instead of whatever + comes out normally). + */ + virtual void setOutputIsBase64Encoded(bool) = 0; + +Q_SIGNALS: + void result(const GpgME::SigningResult &result, const QByteArray &signature, const QString &auditLogAsHtml = QString(), const GpgME::Error &auditLogError = GpgME::Error()); +}; + +} + +#endif // __KLEO_SIGNJOB_H__ |