PublicKey.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_PUBLICKEY_H
#define ZYPP_PUBLICKEY_H

#include <iosfwd>
#include <map>
#include <list>
#include <set>
#include <string>

#include "zypp/base/Iterable.h"
#include "zypp/base/PtrTypes.h"
#include "zypp/base/Exception.h"
#include "zypp/Pathname.h"
#include "zypp/Edition.h"
#include "zypp/Date.h"

struct _gpgme_key;
struct _gpgme_subkey;

namespace zypp
{ 

  namespace filesystem
  {
    class TmpFile;
  }
  class PublicKeyData;
  class KeyManagerCtx;

  class BadKeyException : public Exception
  {
    public:
      BadKeyException()
      : Exception( "Bad Key Exception" )
      {}

      Pathname keyFile() const
      { return _keyfile; }

      BadKeyException( const std::string & msg_r, const Pathname &keyfile = Pathname() )
      : Exception( msg_r ), _keyfile(keyfile)
      {}
      virtual ~BadKeyException() throw() {};
    private:
      Pathname _keyfile;
  };

  class PublicSubkeyData
  {
  public:
    PublicSubkeyData();

    ~PublicSubkeyData();

    explicit operator bool() const;

  public:
    std::string id() const;

    Date created() const;

    Date expires() const;

    bool expired() const;

    int daysToLive() const;

    std::string asString() const;

  private:
    class Impl;
    RWCOW_pointer<Impl> _pimpl;
    friend class PublicKeyData;
    friend std::ostream & dumpOn( std::ostream & str, const PublicKeyData & obj );
    PublicSubkeyData(const _gpgme_subkey *rawSubKeyData);
  };

  inline std::ostream & operator<<( std::ostream & str, const PublicSubkeyData & obj )
  { return str << obj.asString(); }

  class PublicKeyData
  {
  public:
    PublicKeyData();

    ~PublicKeyData();

    explicit operator bool() const;

  public:
    std::string id() const;

    std::string name() const;

    std::string fingerprint() const;

    Date created() const;

    Date expires() const;

    bool expired() const;

    int daysToLive() const;

    std::string expiresAsString() const;

    std::string gpgPubkeyVersion() const;

    std::string gpgPubkeyRelease() const;

    Edition gpgPubkeyEdition() const
    { return Edition( gpgPubkeyVersion(), gpgPubkeyRelease() ); }

    std::string asString() const;

  public:
    typedef const PublicSubkeyData * SubkeyIterator;

    bool hasSubkeys() const;

    Iterable<SubkeyIterator> subkeys() const;

    bool providesKey( const std::string & id_r ) const;

  private:
    class Impl;
    RWCOW_pointer<Impl> _pimpl;

    friend class KeyManagerCtx;
    static PublicKeyData fromGpgmeKey(_gpgme_key *data);

    PublicKeyData(shared_ptr<Impl> data);
    friend std::ostream & dumpOn( std::ostream & str, const PublicKeyData & obj );
  };

  inline std::ostream & operator<<( std::ostream & str, const PublicKeyData & obj )
  { return str << obj.asString(); }

  std::ostream & dumpOn( std::ostream & str, const PublicKeyData & obj );

  bool operator==( const PublicKeyData & lhs, const PublicKeyData & rhs );

  inline bool operator!=( const PublicKeyData & lhs, const PublicKeyData & rhs )
  { return !( lhs == rhs ); }

  class PublicKey
  {
  public:
    class Impl;

  public:
    PublicKey();

    explicit PublicKey( const Pathname & keyFile_r );

    explicit PublicKey( const filesystem::TmpFile & sharedFile_r );

    ~PublicKey();

  public:
    const PublicKeyData & keyData() const;

    typedef PublicKeyData::SubkeyIterator SubkeyIterator;

    bool isValid() const
    { return ! ( id().empty() || fingerprint().empty() ); }

    std::string id() const;                     
    std::string name() const;                   
    std::string fingerprint() const;            
    Date created() const;                       
    Date expires() const;                       
    std::string expiresAsString() const;        
    bool expired() const;                       
    int daysToLive() const;                     
    std::string gpgPubkeyVersion() const;       
    std::string gpgPubkeyRelease() const;       
    std::string asString() const;               

    Edition gpgPubkeyEdition() const            
    { return keyData().gpgPubkeyEdition(); }

    bool hasSubkeys() const                     
    { return keyData().hasSubkeys(); }

    Iterable<SubkeyIterator> subkeys() const    
    { return keyData().subkeys(); }

    bool providesKey( const std::string & id_r ) const  
    { return keyData().providesKey( id_r ); }

  public:
    Pathname path() const;

    const std::list<PublicKeyData> & hiddenKeys() const;

  public:
    bool operator==( const PublicKey & rhs ) const;
    bool operator==( const std::string & sid ) const;

  private:
    friend class KeyRing;
    PublicKey( const filesystem::TmpFile & sharedFile_r, const PublicKeyData & keyData_r );
    explicit PublicKey( const PublicKeyData & keyData_r );

  private:
    RWCOW_pointer<Impl> _pimpl;
  };

  inline std::ostream & operator<<( std::ostream & str, const PublicKey & obj )
  { return str << obj.asString(); }

  std::ostream & dumpOn( std::ostream & str, const PublicKey & obj );

} // namespace zypp
#endif // ZYPP_PUBLICKEY_H