keyresolver.h

/*
    keyresolver.h
 
    This file is part of libkleopatra, the KDE keymanagement library
    Copyright (c) 2004 Klarälvdalens Datakonsult AB
 
    Based on kpgp.h
    Copyright (C) 2001,2002 the KPGP authors
    See file libtdenetwork/AUTHORS.kpgp for details
 
    Libkleopatra 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.
 
    Libkleopatra 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 TQt library by Trolltech AS, Norway (or with modified versions
    of TQt that use the same license as TQt), 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
    TQt.  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_KEYRESOLVER_H__
#define __KLEO_KEYRESOLVER_H__
 
#include <ui/keyapprovaldialog.h>
 
#include <kleo/enum.h>
 
#include <kpgp.h> // for Kpgp::Result
#include <gpgmepp/key.h>
 
#include <vector>
 
class TQStringList;
 
namespace Kleo {
 
 
  class KeyResolver {
  public:
    KeyResolver( bool encToSelf, bool showApproval, bool oppEncryption,
         unsigned int format,
         int encrKeyNearExpiryThresholdDays,
         int signKeyNearExpiryThresholdDays,
         int encrRootCertNearExpiryThresholdDays,
         int signRootCertNearExpiryThresholdDays,
         int encrChainCertNearExpiryThresholdDays,
         int signChainCertNearExpiryThresholdDays );
 
    ~KeyResolver();
 
    struct Item : public KeyApprovalDialog::Item {
      Item()
    : KeyApprovalDialog::Item(),
      signPref( UnknownSigningPreference ),
      format( AutoFormat ),
      needKeys( true ) {}
      Item( const TQString & a,
        EncryptionPreference e, SigningPreference s,
        CryptoMessageFormat f )
    : KeyApprovalDialog::Item( a, std::vector<GpgME::Key>(), e ),
      signPref( s ), format( f ), needKeys( true ) {}
      Item( const TQString & a, const std::vector<GpgME::Key> & k,
        EncryptionPreference e, SigningPreference s,
        CryptoMessageFormat f )
    : KeyApprovalDialog::Item( a, k, e ),
      signPref( s ), format( f ), needKeys( false ) {}
 
      SigningPreference signPref;
      CryptoMessageFormat format;
      bool needKeys;
    };
 
 
    Kpgp::Result setEncryptToSelfKeys( const TQStringList & fingerprints );
    Kpgp::Result setSigningKeys( const TQStringList & fingerprints );
    void setPrimaryRecipients( const TQStringList & addresses );
    void setSecondaryRecipients( const TQStringList & addresses );
 
 
    Action checkSigningPreferences( bool signingRequested ) const;
    Action checkEncryptionPreferences( bool encryptionRequested ) const;
 
    Kpgp::Result resolveAllKeys( bool& signingRequested, bool& encryptionRequested );
 
    std::vector<GpgME::Key> signingKeys( CryptoMessageFormat f ) const;
 
    struct SplitInfo {
      SplitInfo() {}
      SplitInfo( const TQStringList & r ) : recipients( r ) {}
      SplitInfo( const TQStringList & r, const std::vector<GpgME::Key> & k )
    : recipients( r ), keys( k ) {}
      TQStringList recipients;
      std::vector<GpgME::Key> keys;
    };
    std::vector<SplitInfo> encryptionItems( CryptoMessageFormat f ) const;
 
  private:
    void dump() const;
    std::vector<Item> getEncryptionItems( const TQStringList & recipients );
    std::vector<GpgME::Key> getEncryptionKeys( const TQString & recipient, bool quiet ) const;
 
    Kpgp::Result showKeyApprovalDialog();
 
    bool encryptionPossible() const;
    bool signingPossible() const;
    Kpgp::Result resolveEncryptionKeys( bool signingRequested );
    Kpgp::Result resolveSigningKeysForEncryption();
    Kpgp::Result resolveSigningKeysForSigningOnly();
    Kpgp::Result checkKeyNearExpiry( const GpgME::Key & key,
                     const char * dontAskAgainName, bool mine,
                     bool sign, bool ca=false, int recurse_limit=100,
                     const GpgME::Key & orig_key=GpgME::Key::null ) const;
    void collapseAllSplitInfos();
    void addToAllSplitInfos( const std::vector<GpgME::Key> & keys, unsigned int formats );
    void addKeys( const std::vector<Item> & items, CryptoMessageFormat f );
    void addKeys( const std::vector<Item> & items );
    TQStringList allRecipients() const;
    std::vector<GpgME::Key> signingKeysFor( CryptoMessageFormat f ) const;
    std::vector<GpgME::Key> encryptToSelfKeysFor( CryptoMessageFormat f ) const;
 
    std::vector<GpgME::Key> lookup( const TQStringList & patterns, bool secret=false ) const;
 
    bool haveTrustedEncryptionKey( const TQString & person ) const;
 
    std::vector<GpgME::Key> selectKeys( const TQString & person, const TQString & msg,
                    const std::vector<GpgME::Key> & selectedKeys=std::vector<GpgME::Key>() ) const;
 
    TQStringList keysForAddress( const TQString & address ) const;
    void setKeysForAddress( const TQString & address, const TQStringList& pgpKeyFingerprints, const TQStringList& smimeCertFingerprints ) const;
 
    bool encryptToSelf() const { return mEncryptToSelf; }
    bool showApprovalDialog() const { return mShowApprovalDialog; }
 
    int encryptKeyNearExpiryWarningThresholdInDays() const {
      return mEncryptKeyNearExpiryWarningThreshold;
    }
    int signingKeyNearExpiryWarningThresholdInDays() const {
      return mSigningKeyNearExpiryWarningThreshold;
    }
 
    int encryptRootCertNearExpiryWarningThresholdInDays() const {
      return mEncryptRootCertNearExpiryWarningThreshold;
    }
    int signingRootCertNearExpiryWarningThresholdInDays() const {
      return mSigningRootCertNearExpiryWarningThreshold;
    }
 
    int encryptChainCertNearExpiryWarningThresholdInDays() const {
      return mEncryptChainCertNearExpiryWarningThreshold;
    }
    int signingChainCertNearExpiryWarningThresholdInDays() const {
      return mSigningChainCertNearExpiryWarningThreshold;
    }
 
    struct ContactPreferences {
      ContactPreferences();
      Kleo::EncryptionPreference encryptionPreference;
      Kleo::SigningPreference signingPreference;
      Kleo::CryptoMessageFormat cryptoMessageFormat;
      TQStringList pgpKeyFingerprints;
      TQStringList smimeCertFingerprints;
    };
 
    ContactPreferences lookupContactPreferences( const TQString& address ) const;
    void saveContactPreference( const TQString& email, const ContactPreferences& pref ) const;
 
  private:
    class EncryptionPreferenceCounter;
    friend class ::Kleo::KeyResolver::EncryptionPreferenceCounter;
    class SigningPreferenceCounter;
    friend class ::Kleo::KeyResolver::SigningPreferenceCounter;
 
    class Private;
    Private * d;
 
    bool mEncryptToSelf;
    const bool mShowApprovalDialog : 1;
    const bool mOpportunisticEncyption : 1;
    const unsigned int mCryptoMessageFormats;
 
    const int mEncryptKeyNearExpiryWarningThreshold;
    const int mSigningKeyNearExpiryWarningThreshold;
    const int mEncryptRootCertNearExpiryWarningThreshold;
    const int mSigningRootCertNearExpiryWarningThreshold;
    const int mEncryptChainCertNearExpiryWarningThreshold;
    const int mSigningChainCertNearExpiryWarningThreshold;
  };
 
} // namespace Kleo
 
#endif // __KLEO_KEYRESOLVER_H__