libzypp  17.3.1
PublicKey.h
Go to the documentation of this file.
1 /*---------------------------------------------------------------------\
2 | ____ _ __ __ ___ |
3 | |__ / \ / / . \ . \ |
4 | / / \ V /| _/ _/ |
5 | / /__ | | | | | | |
6 | /_____||_| |_| |_| |
7 | |
8 \---------------------------------------------------------------------*/
12 #ifndef ZYPP_PUBLICKEY_H
13 #define ZYPP_PUBLICKEY_H
14 
15 #include <iosfwd>
16 #include <map>
17 #include <list>
18 #include <set>
19 #include <string>
20 
21 #include "zypp/base/Iterable.h"
22 #include "zypp/base/PtrTypes.h"
23 #include "zypp/base/Exception.h"
25 #include "zypp/Pathname.h"
26 #include "zypp/Edition.h"
27 #include "zypp/Date.h"
28 
29 struct _gpgme_key;
30 struct _gpgme_subkey;
31 
33 namespace zypp
34 {
35 
36  namespace filesystem
37  {
38  class TmpFile;
39  }
40  class PublicKeyData;
41  class KeyManagerCtx;
42 
47  class BadKeyException : public Exception
48  {
49  public:
54  : Exception( "Bad Key Exception" )
55  {}
56 
57  Pathname keyFile() const
58  { return _keyfile; }
59 
63  BadKeyException( const std::string & msg_r, const Pathname &keyfile = Pathname() )
64  : Exception( msg_r ), _keyfile(keyfile)
65  {}
67  virtual ~BadKeyException() throw() {};
68  private:
70  };
72 
79  {
80  public:
83 
85 
87  explicit operator bool() const;
88 
89  public:
91  std::string id() const;
92 
94  Date created() const;
95 
97  Date expires() const;
98 
100  bool expired() const;
101 
107  int daysToLive() const;
108 
115  std::string asString() const;
116 
117  private:
118  class Impl;
120  friend class PublicKeyData;
121  friend std::ostream & dumpOn( std::ostream & str, const PublicKeyData & obj );
122  PublicSubkeyData(const _gpgme_subkey *rawSubKeyData);
123  };
125 
127  inline std::ostream & operator<<( std::ostream & str, const PublicSubkeyData & obj )
128  { return str << obj.asString(); }
129 
140  {
141  public:
143  PublicKeyData();
144 
145  ~PublicKeyData();
146 
148  explicit operator bool() const;
149 
150  public:
152  std::string id() const;
153 
155  std::string name() const;
156 
158  std::string fingerprint() const;
159 
161  Date created() const;
162 
164  Date expires() const;
165 
167  bool expired() const;
168 
174  int daysToLive() const;
175 
188  std::string expiresAsString() const;
189 
191  std::string gpgPubkeyVersion() const;
192 
194  std::string gpgPubkeyRelease() const;
195 
198  { return Edition( gpgPubkeyVersion(), gpgPubkeyRelease() ); }
199 
206  std::string asString() const;
207 
208  public:
210 
212  bool hasSubkeys() const;
213 
216 
218  bool providesKey( const std::string & id_r ) const;
219 
220  public:
223 
230  AsciiArt asciiArt() const;
231 
232  private:
233  class Impl;
235 
236  friend class KeyManagerCtx;
237  static PublicKeyData fromGpgmeKey(_gpgme_key *data);
238 
239  PublicKeyData(shared_ptr<Impl> data);
240  friend std::ostream & dumpOn( std::ostream & str, const PublicKeyData & obj );
241  };
243 
245  inline std::ostream & operator<<( std::ostream & str, const PublicKeyData & obj )
246  { return str << obj.asString(); }
247 
249  std::ostream & dumpOn( std::ostream & str, const PublicKeyData & obj );
250 
252  bool operator==( const PublicKeyData & lhs, const PublicKeyData & rhs );
253 
255  inline bool operator!=( const PublicKeyData & lhs, const PublicKeyData & rhs )
256  { return !( lhs == rhs ); }
257 
269  class PublicKey
270  {
271  public:
273  class Impl;
274 
275  public:
277  PublicKey();
278 
287  explicit PublicKey( const Pathname & keyFile_r );
288 
295  explicit PublicKey( const filesystem::TmpFile & sharedFile_r );
296 
297  ~PublicKey();
298 
299  public:
301  const PublicKeyData & keyData() const;
302 
304 
305  bool isValid() const
306  { return ! ( id().empty() || fingerprint().empty() ); }
307 
308  std::string id() const;
309  std::string name() const;
310  std::string fingerprint() const;
311  Date created() const;
312  Date expires() const;
313  std::string expiresAsString() const;
314  bool expired() const;
315  int daysToLive() const;
316  std::string gpgPubkeyVersion() const;
317  std::string gpgPubkeyRelease() const;
318  std::string asString() const;
319 
321  { return keyData().gpgPubkeyEdition(); }
322 
323  bool hasSubkeys() const
324  { return keyData().hasSubkeys(); }
325 
327  { return keyData().subkeys(); }
328 
329  bool providesKey( const std::string & id_r ) const
330  { return keyData().providesKey( id_r ); }
331 
332  public:
334 
336  { return keyData().asciiArt(); }
337 
338  public:
340  Pathname path() const;
341 
343  const std::list<PublicKeyData> & hiddenKeys() const;
344 
345  public:
346  bool operator==( const PublicKey & rhs ) const;
347  bool operator==( const std::string & sid ) const;
348 
349  private:
350  friend class KeyRing;
352  PublicKey( const filesystem::TmpFile & sharedFile_r, const PublicKeyData & keyData_r );
354  explicit PublicKey( const PublicKeyData & keyData_r );
355 
356  private:
359  };
361 
363  inline std::ostream & operator<<( std::ostream & str, const PublicKey & obj )
364  { return str << obj.asString(); }
365 
367  std::ostream & dumpOn( std::ostream & str, const PublicKey & obj );
368 
370 } // namespace zypp
372 #endif // ZYPP_PUBLICKEY_H
std::string asString() const
Simple string representation.
Definition: PublicKey.cc:178
int daysToLive() const
Number of days (24h) until the key expires (or since it exired).
Definition: PublicKey.cc:175
const std::list< PublicKeyData > & hiddenKeys() const
Additional keys data in case the ASCII armored blob containes multiple keys.
Definition: PublicKey.cc:508
const PublicKeyData & keyData() const
The public keys data (.
Definition: PublicKey.cc:502
std::string name() const
Definition: PublicKey.cc:514
Gpg key handling.
Definition: KeyRing.h:135
RWCOW_pointer< Impl > _pimpl
Definition: PublicKey.h:118
std::string gpgPubkeyRelease() const
Gpg-pubkey release as computed by rpm (hexencoded created)
Definition: PublicKey.cc:319
virtual ~BadKeyException()
Dtor.
Definition: PublicKey.h:67
PublicSubkeyData implementation.
Definition: PublicKey.cc:114
Edition gpgPubkeyEdition() const
!<
Definition: PublicKey.h:320
Class representing one GPG Public Keys data.
Definition: PublicKey.h:139
bool expired() const
Whether the key has expired.
Definition: PublicKey.cc:172
std::string asString() const
Simple string representation.
Definition: PublicKey.cc:322
Exception thrown when the supplied key is not a valid gpg key.
Definition: PublicKey.h:47
PublicSubkeyData()
Default constructed: empty data.
Definition: PublicKey.cc:145
std::string id() const
Definition: PublicKey.cc:511
Iterable< SubkeyIterator > subkeys() const
!<
Definition: PublicKey.h:326
std::string name() const
Key name.
Definition: PublicKey.cc:295
String related utilities and Regular expression matching.
Date created() const
Creation date.
Definition: PublicKey.cc:166
Edition represents [epoch:]version[-release]
Definition: Edition.h:60
int daysToLive() const
Definition: PublicKey.cc:529
bool hasSubkeys() const
!<
Definition: PublicKey.h:323
bool operator==(const SetRelation::Enum &lhs, const SetCompare &rhs)
Provide a new empty temporary file and delete it when no longer needed.
Definition: TmpPath.h:127
Iterable< SubkeyIterator > subkeys() const
Iterate any subkeys.
Definition: PublicKey.cc:334
PublicKeyData()
Default constructed: empty data.
Definition: PublicKey.cc:275
AsciiArt asciiArt() const
!<
Definition: PublicKey.h:335
PublicKeyData::AsciiArt AsciiArt
Definition: PublicKey.h:333
std::ostream & operator<<(std::ostream &str, const PublicKeyData &obj)
Definition: PublicKey.h:245
std::string expiresAsString() const
Definition: PublicKey.cc:532
std::string gpgPubkeyVersion() const
Gpg-pubkey version as computed by rpm (trailing 8 byte id)
Definition: PublicKey.cc:316
std::string id() const
Subkey ID.
Definition: PublicKey.cc:163
Date expires() const
Definition: PublicKey.cc:523
bool operator==(const PublicKey &rhs) const
Definition: PublicKey.cc:544
std::string expiresAsString() const
Definition: PublicKey.cc:313
int daysToLive() const
Number of days (24h) until the key expires (or since it exired).
Definition: PublicKey.cc:310
RWCOW_pointer< Impl > _pimpl
Pointer to implementation.
Definition: PublicKey.h:358
Store and operate on date (time_t).
Definition: Date.h:32
Date created() const
Creation / last modification date (latest selfsig).
Definition: PublicKey.cc:301
base::DrunkenBishop AsciiArt
Random art fingerprint visualization type (base::DrunkenBishop).
Definition: PublicKey.h:222
std::string gpgPubkeyVersion() const
Definition: PublicKey.cc:535
const PublicSubkeyData * SubkeyIterator
Definition: PublicKey.h:209
bool providesKey(const std::string &id_r) const
!<
Definition: PublicKey.h:329
BadKeyException()
Ctor taking message.
Definition: PublicKey.h:53
std::ostream & dumpOn(std::ostream &str, const Capability &obj)
Definition: Capability.cc:444
friend std::ostream & dumpOn(std::ostream &str, const PublicKeyData &obj)
Definition: PublicKey.cc:343
Pathname keyFile() const
Definition: PublicKey.h:57
BadKeyException(const std::string &msg_r, const Pathname &keyfile=Pathname())
Ctor taking message.
Definition: PublicKey.h:63
std::ostream & operator<<(std::ostream &str, const PublicSubkeyData &obj)
Definition: PublicKey.h:127
PublicKey()
Default ctor.
Definition: PublicKey.cc:479
PublicKey implementation.
Definition: PublicKey.cc:365
std::string fingerprint() const
Key fingerprint.
Definition: PublicKey.cc:298
bool expired() const
Whether the key has expired.
Definition: PublicKey.cc:307
std::string gpgPubkeyRelease() const
Definition: PublicKey.cc:538
Class representing a GPG Public Keys subkeys.
Definition: PublicKey.h:78
Class representing one GPG Public Key (PublicKeyData + ASCII armored in a tempfile).
Definition: PublicKey.h:269
std::ostream & operator<<(std::ostream &str, const PublicKey &obj)
Definition: PublicKey.h:363
Date expires() const
Expiry date, or Date() if the key never expires.
Definition: PublicKey.cc:169
AsciiArt asciiArt() const
Random art fingerprint visualization (base::DrunkenBishop).
Definition: PublicKey.cc:340
Date created() const
Definition: PublicKey.cc:520
Base class for Exception.
Definition: Exception.h:145
Pathname path() const
File containig the ASCII armored key.
Definition: PublicKey.cc:505
std::string id() const
Key ID.
Definition: PublicKey.cc:292
Edition gpgPubkeyEdition() const
Gpg-pubkey Edition built from version and release.
Definition: PublicKey.h:197
RWCOW_pointer< Impl > _pimpl
Definition: PublicKey.h:233
std::string fingerprint() const
Definition: PublicKey.cc:517
std::string asString() const
Definition: PublicKey.cc:541
bool expired() const
Definition: PublicKey.cc:526
PublicKeyData implementation.
Definition: PublicKey.cc:188
friend std::ostream & dumpOn(std::ostream &str, const PublicKeyData &obj)
Definition: PublicKey.cc:343
bool operator!=(const PublicKeyData &lhs, const PublicKeyData &rhs)
Definition: PublicKey.h:255
bool isValid() const
Definition: PublicKey.h:305
static PublicKeyData fromGpgmeKey(_gpgme_key *data)
Definition: PublicKey.cc:286
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:1
bool providesKey(const std::string &id_r) const
Whether id_r is the id of the primary key or of a subkey.
Definition: PublicKey.cc:337
Date expires() const
Expiry date, or Date() if the key never expires.
Definition: PublicKey.cc:304
bool hasSubkeys() const
Whether subkeys is not empty.
Definition: PublicKey.cc:331
Random art fingerprint visualization Visualize fingerprint data on a [17x9] (SSH) or [19x11] (GPG) or...
Definition: DrunkenBishop.h:61
PublicKeyData::SubkeyIterator SubkeyIterator
Definition: PublicKey.h:303