cryptplugwrapper.h

Go to the documentation of this file.

 
#ifndef cryptplugwrapper_h
#define cryptplugwrapper_h
 
#include "cryptplug.h"
 
#ifndef LIBKLEOPATRA_NO_COMPAT
 
/*
 *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *                                                                        *
 *  This file's source comments are optimized for processing by Doxygen.  *
 *                                                                        *
 *  To obtain best results please get an updated version of Doxygen,      *
 *  for sources and binaries goto http://www.doxygen.org/index.html       *
 *                                                                        *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 
                                                                          *
                                                                          */
#include "kleo/cryptobackend.h"
 
#include <tqdatetime.h>
 
#include <tqvaluelist.h>
#include <tqpair.h>
#include <tqstringlist.h>
#include <tqstring.h>
#include <kdemacros.h>
 
 
class TDEConfigBase;
class QGpgMECryptoConfig;
 
namespace GpgME {
  class ImportResult;
  class KeyGenerationResult;
}
 
namespace Kleo {
  class KeyListJob;
  class EncryptJob;
  class DecryptJob;
  class SignJob;
  class VerifyDetachedJob;
  class VerifyOpaqueJob;
  class KeyGenerationJob;
  class ImportJob;
  class ExportJob;
  class DownloadJob;
  class DeleteJob;
  class SignEncryptJob;
  class DecryptVerifyJob;
  class CryptoConfig;
  class RefreshKeysJob;
  class SpecialJob;
}
 
class CryptPlugWrapper;
class StructuringInfoWrapper {
public:
  StructuringInfoWrapper( CryptPlugWrapper* wrapper );
  ~StructuringInfoWrapper();
  void reset();
  CryptPlug::StructuringInfo data;
private:
  void initMe();
  void freeMe();
  bool _initDone;
  CryptPlugWrapper* _wrapper;
};
 
 
 
class TDE_EXPORT CryptPlugWrapper : public Kleo::CryptoBackend::Protocol {
public:
    static TQString errorIdToText( int errId, bool & isPassphraseError );
 
    typedef enum {
        IniStatus_undef         = 0,
 
        IniStatus_Ok            = 1,
        IniStatus_NoLibName     = 2,
        IniStatus_LoadError     = 0x1000,
        IniStatus_InitError     = 0x2000
    } IniStatus;
 
    enum {
        SigStatus_UNKNOWN     = 0x0000,
        SigStatus_VALID       = SigStat_VALID,
        SigStatus_GREEN       = SigStat_GREEN,
        SigStatus_RED         = SigStat_RED,
        SigStatus_KEY_REVOKED = SigStat_KEY_REVOKED,
        SigStatus_KEY_EXPIRED = SigStat_KEY_EXPIRED,
        SigStatus_SIG_EXPIRED = SigStat_SIG_EXPIRED,
        SigStatus_KEY_MISSING = SigStat_KEY_MISSING,
        SigStatus_CRL_MISSING = SigStat_CRL_MISSING,
        SigStatus_CRL_TOO_OLD = SigStat_CRL_TOO_OLD,
        SigStatus_BAD_POLICY  = SigStat_BAD_POLICY,
        SigStatus_SYS_ERROR   = SigStat_SYS_ERROR,
 
        SigStatus_NUMERICAL_CODE = 0x8000 /* An other error occurred. */
    };
    typedef unsigned long SigStatusFlags;
 
 
    enum {
        CerStatus_EXPIRES_NEVER = CRYPTPLUG_CERT_DOES_NEVER_EXPIRE
    };
 
 
    CryptPlugWrapper( const TQString& name=TQString(),
                      const TQString& libName=TQString(),
                      const TQString& update=TQString(),
                      bool           active = false );
 
    ~CryptPlugWrapper();
 
    TQString protocol() const;
 
    TQString name() const {
      return protocol();
    }
 
    void setActive( bool active );
 
    bool active() const;
 
 
    bool setLibName( const TQString& libName );
 
    TQString libName() const;
 
 
    void setDisplayName( const TQString& name );
 
 
    TQString displayName() const;
 
private:
    bool initialize( IniStatus* iniStatus, TQString* errorMsg );
 
public:
    void deinitialize();
 
    IniStatus iniStatus( TQString* errorMsg ) const;
 
 
    bool hasFeature( ::Feature );
 
 
    /* \ingroup groupSignAct
     * Frees the members of a signature meta data struct, but not the
     * signature meta data struct itself as this could be allocated on
     * the stack.
     */
    void freeSignatureMetaData( CryptPlug::SignatureMetaData* );
 
    bool checkMessageSignature( char** cleartext,
                                const char* signaturetext,
                                bool signatureIsBinary,
                                int signatureLen,
                                CryptPlug::SignatureMetaData* sigmeta );
 
    bool decryptMessage( const char* ciphertext,
                         bool        cipherIsBinary,
                         int         cipherLen,
                         char**      cleartext,
                         const char* certificate,
                         int* errId,
                         char** errTxt );
 
    bool decryptAndCheckMessage( const char*  ciphertext,
                                 bool         cipherIsBinary,
                                 int          cipherLen,
                                 char**       cleartext,
                                 const char*  certificate,
                                 bool*        signatureFound,
                                 CryptPlug::SignatureMetaData* sigmeta,
                                 int*   errId,
                                 char** errTxt );
 
    Kleo::KeyListJob * keyListJob( bool remote=false, bool includeSigs=false, bool validate=true ) const;
    Kleo::EncryptJob * encryptJob( bool armor=false, bool textmode=false ) const;
    Kleo::DecryptJob * decryptJob() const;
    Kleo::SignJob * signJob( bool armor=false, bool textMode=false ) const;
    Kleo::VerifyDetachedJob * verifyDetachedJob( bool textmode=false) const;
    Kleo::VerifyOpaqueJob * verifyOpaqueJob( bool textmode=false ) const;
    Kleo::KeyGenerationJob * keyGenerationJob() const;
 
    Kleo::ImportJob * importJob() const;
    Kleo::ExportJob * publicKeyExportJob( bool armor=false ) const;
    Kleo::ExportJob * secretKeyExportJob( bool armor=false, const TQString& charset = TQString() ) const;
    Kleo::DownloadJob * downloadJob( bool armor=false ) const;
    Kleo::DeleteJob * deleteJob() const;
 
    Kleo::SignEncryptJob * signEncryptJob( bool armor=false, bool textmode=false ) const;
    Kleo::DecryptVerifyJob * decryptVerifyJob( bool textmode=false ) const;
    Kleo::RefreshKeysJob * refreshKeysJob() const;
 
    Kleo::SpecialJob * specialJob( const char *, const TQStringVariantMap & ) const { return 0; }
 
    GpgME::ImportResult importCertificate( const char* data, size_t length );
 
    CryptPlug * cryptPlug() const { return _cp; }
 
private:
    TQString    _name;
    TQString    _libName;
    TQString    _updateURL;
    bool       _active;
    IniStatus _iniStatus;
    TQString    _lastError;
    CryptPlug* _cp;
    // local parameters without representation in cryptplug.h
    bool mAlwaysEncryptToSelf;
    class Config;
    Config * _config;
    QGpgMECryptoConfig * _cryptoConfig;
};
 
#endif // !LIBKLEOPATRA_NO_COMPAT
 
#endif // cryptplugwrapper_h