"Fossies" - the Fresh Open Source Software Archive

Member "gpgme-1.15.1/lang/qt/src/encryptjob.h" (8 Jan 2021, 5149 Bytes) of package /linux/privat/gpgme-1.15.1.tar.bz2:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) C and C++ source code syntax highlighting (style: standard) with prefixed line numbers and code folding option. Alternatively you can here view or download the uninterpreted source code file. For more information about "encryptjob.h" see the Fossies "Dox" file reference documentation and the latest Fossies "Diffs" side-by-side code changes report: 1.15.0_vs_1.15.1.

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