libzypp  17.25.6
KeyManager.cc
Go to the documentation of this file.
1 /*---------------------------------------------------------------------\
2 | ____ _ __ __ ___ |
3 | |__ / \ / / . \ . \ |
4 | / / \ V /| _/ _/ |
5 | / /__ | | | | | | |
6 | /_____||_| |_| |_| |
7 | |
8 \---------------------------------------------------------------------*/
9 #include <zypp/KeyManager.h>
10 #include <zypp/KeyRing.h>
11 #include <zypp/PathInfo.h>
12 #include <zypp/base/Logger.h>
13 #include <zypp/TmpPath.h>
14 #include <zypp/base/String.h>
15 #include <zypp/AutoDispose.h>
16 
17 #include <boost/thread/once.hpp>
18 #include <boost/interprocess/smart_ptr/scoped_ptr.hpp>
19 #include <gpgme.h>
20 
21 #include <stdio.h>
22 using std::endl;
23 
24 #undef ZYPP_BASE_LOGGER_LOGGROUP
25 #define ZYPP_BASE_LOGGER_LOGGROUP "zypp::gpg"
26 
28 namespace zypp
29 {
31  namespace
32  {
33  // @TODO [threading]
34  // make sure to call the init code of gpgme only once
35  // this might need to be moved to a different location when
36  // threads are introduced into libzypp
37  boost::once_flag gpgme_init_once = BOOST_ONCE_INIT;
38 
39  void initGpgme ()
40  {
41  const char *version = gpgme_check_version(NULL);
42  if ( version )
43  {
44  MIL << "Initialized libgpgme version: " << version << endl;
45  }
46  else
47  {
48  MIL << "Initialized libgpgme with unknown version" << endl;
49  }
50  }
51 
52  //using boost::interprocess pointer because it allows a custom deleter
53  typedef boost::interprocess::scoped_ptr<gpgme_data, boost::function<void (gpgme_data_t)>> GpgmeDataPtr;
54  typedef boost::interprocess::scoped_ptr<_gpgme_key, boost::function<void (gpgme_key_t)>> GpgmeKeyPtr;
55  typedef boost::interprocess::scoped_ptr<FILE, boost::function<int (FILE *)>> FILEPtr;
56 
57  struct GpgmeErr
58  {
59  GpgmeErr( gpgme_error_t err_r = GPG_ERR_NO_ERROR )
60  : _err( err_r )
61  {}
62  operator gpgme_error_t() const { return _err; }
63  private:
64  gpgme_error_t _err;
65  };
66 
67  std::ostream & operator<<( std::ostream & str, const GpgmeErr & obj )
68  { return str << "<" << gpgme_strsource(obj) << "> " << gpgme_strerror(obj); }
69 
71  std::ostream & operator<<( std::ostream & str, const _gpgme_op_import_result & obj )
72  {
73  str << "gpgme_op_import_result {" << endl;
74  str << " " << obj.considered << " The total number of considered keys." << endl;
75  str << " " << obj.no_user_id << " The number of keys without user ID." << endl;
76  str << " " << obj.imported << " The total number of imported keys." << endl;
77  str << " " << obj.imported_rsa << " imported RSA keys." << endl;
78  str << " " << obj.unchanged << " unchanged keys." << endl;
79  str << " " << obj.new_user_ids << " new user IDs." << endl;
80  str << " " << obj.new_sub_keys << " new sub keys." << endl;
81  str << " " << obj.new_signatures << " new signatures." << endl;
82  str << " " << obj.new_revocations << " new revocations." << endl;
83  str << " " << obj.secret_read << " secret keys read." << endl;
84  str << " " << obj.secret_imported << " imported secret keys." << endl;
85  str << " " << obj.secret_unchanged << " unchanged secret keys." << endl;
86  str << " " << obj.not_imported << " keys not imported." << endl;
87  for ( gpgme_import_status_t p = obj.imports; p; p = p->next )
88  {
89  str << " - " << p->fpr << ": " << p->result << endl;
90  }
91  // In V.1.11: str << " " << obj.skipped_v3_keys << " skipped v3 keys." << endl;
92  return str << "}";
93  }
94  } // namespace
96 
98  {
99  GpgmeException( const std::string & in_r, const GpgmeErr & err_r )
100  : KeyRingException( str::Format( "libgpgme error in '%1%': %2%" ) % in_r % err_r )
101  {}
102  };
103 
105  {
106  public:
108  { boost::call_once( gpgme_init_once, initGpgme ); }
109 
111  { if ( _ctx ) gpgme_release( _ctx ); }
112 
113 
115  std::list<std::string> readSignaturesFprs( const Pathname & signature_r )
116  { return readSignaturesFprsOptVerify( signature_r ); }
117 
119  bool verifySignaturesFprs( const Pathname & file_r, const Pathname & signature_r )
120  {
121  bool verify = false;
122  readSignaturesFprsOptVerify( signature_r, file_r, &verify );
123  return verify;
124  }
125 
126  gpgme_ctx_t _ctx { nullptr };
127  bool _volatile { false };
128 
129  private:
135  std::list<std::string> readSignaturesFprsOptVerify( const Pathname & signature_r, const Pathname & file_r = "/dev/null", bool * verify_r = nullptr );
136  };
137 
138 std::list<std::string> KeyManagerCtx::Impl::readSignaturesFprsOptVerify( const Pathname & signature_r, const Pathname & file_r, bool * verify_r )
139 {
140  //lets be pessimistic
141  if ( verify_r )
142  *verify_r = false;
143 
144 
145  if (!PathInfo( signature_r ).isExist())
146  return std::list<std::string>();
147 
148  FILEPtr dataFile(fopen(file_r.c_str(), "rb"), fclose);
149  if (!dataFile)
150  return std::list<std::string>();
151 
152  GpgmeDataPtr fileData(nullptr, gpgme_data_release);
153  GpgmeErr err = gpgme_data_new_from_stream (&fileData.get(), dataFile.get());
154  if (err) {
155  ERR << err << endl;
156  return std::list<std::string>();
157  }
158 
159  FILEPtr sigFile(fopen(signature_r.c_str(), "rb"), fclose);
160  if (!sigFile) {
161  ERR << "Unable to open signature file '" << signature_r << "'" <<endl;
162  return std::list<std::string>();
163  }
164 
165  GpgmeDataPtr sigData(nullptr, gpgme_data_release);
166  err = gpgme_data_new_from_stream (&sigData.get(), sigFile.get());
167  if (err) {
168  ERR << err << endl;
169  return std::list<std::string>();
170  }
171 
172  err = gpgme_op_verify(_ctx, sigData.get(), fileData.get(), NULL);
173  if (err != GPG_ERR_NO_ERROR) {
174  ERR << err << endl;
175  return std::list<std::string>();
176  }
177 
178  gpgme_verify_result_t res = gpgme_op_verify_result(_ctx);
179  if (!res || !res->signatures) {
180  ERR << "Unable to read signature fingerprints" <<endl;
181  return std::list<std::string>();
182  }
183 
184  bool foundBadSignature = false;
185  bool foundGoodSignature = false;
186  std::list<std::string> signatures;
187  for ( gpgme_signature_t sig = res->signatures; sig; sig = sig->next ) {
188 
189  if ( sig->fpr )
190  {
191  // bsc#1100427: With libgpgme11-1.11.0 and if a recent gpg version was used
192  // to create the signature, the field may contain the full fingerprint, but
193  // we're expected to return the ID.
194  // [https://github.com/gpg/gpgme/commit/478d1650bbef84958ccce439fac982ef57b16cd0]
195  std::string id( sig->fpr );
196  if ( id.size() > 16 )
197  id = id.substr( id.size()-16 );
198 
199  DBG << "Found signature with ID: " << id << " in " << file_r << std::endl;
200  signatures.push_back( std::move(id) );
201  }
202 
203  if ( sig->status != GPG_ERR_NO_ERROR ) {
204  DBG << "Verification failed with result: " << file_r << " " << GpgmeErr(sig->status) << std::endl;
205  const auto status = gpgme_err_code(sig->status);
206 
207  // bsc#1180721: libgpgme started to return signatures of unknown keys, which breaks
208  // our workflow when verifying files that have multiple signatures, including some that are
209  // not in the trusted keyring. We should not fail if we have unknown or expired keys and at least a good one.
210  // We will however keep the behaviour of failing if we find a bad signatures even if others are good.
211  if ( status != GPG_ERR_KEY_EXPIRED && status != GPG_ERR_NO_PUBKEY )
212  {
213  if ( !foundBadSignature )
214  foundBadSignature = true;
215  if ( verify_r )
216  WAR << "Failed signature check: " << file_r << " " << GpgmeErr(sig->status) << endl;
217  }
218  else
219  {
220  // for now treat expired keys as good signature
221  if ( status == GPG_ERR_KEY_EXPIRED )
222  foundGoodSignature = true;
223 
224  if ( verify_r )
225  WAR << "Legacy: Ignore expired or unknown key: " << file_r << " " << GpgmeErr(sig->status) << endl;
226  }
227  } else {
228  foundGoodSignature = true;
229  }
230  }
231 
232  if ( verify_r )
233  *verify_r = (!foundBadSignature) && foundGoodSignature;
234  return signatures;
235 }
236 
237 
239 : _pimpl( new Impl )
240 {}
241 
243 {
244  static Pathname tmppath( zypp::myTmpDir() / "PublicKey" );
245  filesystem::assert_dir( tmppath );
246 
247  KeyManagerCtx ret { createForOpenPGP( tmppath ) };
248  ret._pimpl->_volatile = true; // readKeyFromFile workaround bsc#1140670
249  return ret;
250 }
251 
253 {
254  DBG << "createForOpenPGP(" << keyring_r << ")" << endl;
255 
256  KeyManagerCtx ret;
257  gpgme_ctx_t & ctx { ret._pimpl->_ctx };
258 
259  // create the context
260  GpgmeErr err = gpgme_new( &ctx );
261  if ( err != GPG_ERR_NO_ERROR )
262  ZYPP_THROW( GpgmeException( "gpgme_new", err ) );
263 
264  // use OpenPGP
265  err = gpgme_set_protocol( ctx, GPGME_PROTOCOL_OpenPGP );
266  if ( err != GPG_ERR_NO_ERROR )
267  ZYPP_THROW( GpgmeException( "gpgme_set_protocol", err ) );
268 
269  if ( !keyring_r.empty() ) {
270  // get engine information to read current state
271  gpgme_engine_info_t enginfo = gpgme_ctx_get_engine_info( ctx );
272  if ( !enginfo )
273  ZYPP_THROW( GpgmeException( "gpgme_ctx_get_engine_info", err ) );
274 
275  err = gpgme_ctx_set_engine_info( ctx, GPGME_PROTOCOL_OpenPGP, enginfo->file_name, keyring_r.c_str() );
276  if ( err != GPG_ERR_NO_ERROR )
277  ZYPP_THROW( GpgmeException( "gpgme_ctx_set_engine_info", err ) );
278  }
279 
280  return ret;
281 }
282 
284 {
285  Pathname ret;
286  if ( gpgme_engine_info_t enginfo = gpgme_ctx_get_engine_info( _pimpl->_ctx ) )
287  ret = enginfo->home_dir;
288  return ret;
289 }
290 
291 std::list<PublicKeyData> KeyManagerCtx::listKeys()
292 {
293  std::list<PublicKeyData> ret;
294  GpgmeErr err = GPG_ERR_NO_ERROR;
295 
296  // Reset gpgme_keylist_mode on return!
297  AutoDispose<gpgme_keylist_mode_t> guard { gpgme_get_keylist_mode( _pimpl->_ctx ), bind( &gpgme_set_keylist_mode, _pimpl->_ctx, _1 ) };
298  // Let listed keys include signatures (required if PublicKeyData are created from the key)
299  if ( (err = gpgme_set_keylist_mode( _pimpl->_ctx, GPGME_KEYLIST_MODE_LOCAL | GPGME_KEYLIST_MODE_SIGS )) != GPG_ERR_NO_ERROR ) {
300  ERR << "gpgme_set_keylist_mode: " << err << endl;
301  return ret;
302  }
303 
304  if ( (err = gpgme_op_keylist_start( _pimpl->_ctx, NULL, 0 )) != GPG_ERR_NO_ERROR ) {
305  ERR << "gpgme_op_keylist_start: " << err << endl;
306  return ret;
307  }
308  // Close list operation on return!
309  AutoDispose<gpgme_ctx_t> guard2 { _pimpl->_ctx, &gpgme_op_keylist_end };
310 
311  AutoDispose<gpgme_key_t> key { nullptr, &gpgme_key_release };
312  for ( ; gpgme_op_keylist_next( _pimpl->_ctx, &(*key) ) == GPG_ERR_NO_ERROR; key.getDispose()( key ) ) {
314  if ( data )
315  ret.push_back( data );
316  }
317 
318  return ret;
319 }
320 
321 #if 1
322 std::list<PublicKeyData> KeyManagerCtx::readKeyFromFile( const Pathname & keyfile_r )
323 {
324  // bsc#1140670: GPGME does not support reading keys from a keyfile using
325  // gpgme_data_t and gpgme_op_keylist_from_data_start. Despite GPGME_KEYLIST_MODE_SIGS
326  // the signatures are missing, but we need them to create proper PublicKeyData objects.
327  // While this is not resolved, we read into a temp. keyring. Impl::_volatile helps
328  // to detect whether we can clear and import into the current context or need to
329  // create a temp. one.
330  std::list<PublicKeyData> ret;
331 
332  if ( _pimpl->_volatile ) {
333  // in a volatile context we can simple clear the keyring...
335  if ( importKey( keyfile_r ) )
336  ret = listKeys();
337  } else {
338  // read in a volatile context
339  ret = createForOpenPGP().readKeyFromFile( keyfile_r );
340  }
341 
342  return ret;
343 }
344 #else
345 std::list<PublicKeyData> KeyManagerCtx::readKeyFromFile( const Pathname & file_r )
346 {
347  std::list<PublicKeyData> ret;
348  GpgmeErr err = GPG_ERR_NO_ERROR;
349 
350  AutoDispose<gpgme_data_t> data { nullptr, &gpgme_data_release };
351  if ( (err = gpgme_data_new_from_file( &(*data), file_r.c_str(), 1 )) != GPG_ERR_NO_ERROR ) {
352  ERR << "gpgme_data_new_from_file " << file_r << ": " << err << endl;
353  return ret;
354  }
355 
356  // Reset gpgme_keylist_mode on return!
357  AutoDispose<gpgme_keylist_mode_t> guard { gpgme_get_keylist_mode( _pimpl->_ctx ), bind( &gpgme_set_keylist_mode, _pimpl->_ctx, _1 ) };
358  // Let listed keys include signatures (required if PublicKeyData are created from the key)
359  if ( (err = gpgme_set_keylist_mode( _pimpl->_ctx, GPGME_KEYLIST_MODE_LOCAL | GPGME_KEYLIST_MODE_SIGS )) != GPG_ERR_NO_ERROR ) {
360  ERR << "gpgme_set_keylist_mode: " << err << endl;
361  return ret;
362  }
363 
364  if ( (err = gpgme_op_keylist_from_data_start( _pimpl->_ctx, data, 0 )) != GPG_ERR_NO_ERROR ) {
365  ERR << "gpgme_op_keylist_from_data_start " << file_r << ": " << err << endl;
366  return ret;
367  }
368  // Close list operation on return!
369  AutoDispose<gpgme_ctx_t> guard2 { _pimpl->_ctx, &gpgme_op_keylist_end };
370 
371  AutoDispose<gpgme_key_t> key { nullptr, &gpgme_key_release };
372  for ( ; gpgme_op_keylist_next( _pimpl->_ctx, &(*key) ) == GPG_ERR_NO_ERROR; key.getDispose()( key ) ) {
373  PublicKeyData data { PublicKeyData::fromGpgmeKey( key ) };
374  if ( data )
375  ret.push_back( data );
376  }
377 
378  return ret;
379 }
380 #endif
381 
382 bool KeyManagerCtx::verify(const Pathname &file, const Pathname &signature)
383 {
384  return _pimpl->verifySignaturesFprs(file, signature);
385 }
386 
387 bool KeyManagerCtx::exportKey(const std::string &id, std::ostream &stream)
388 {
389  GpgmeErr err = GPG_ERR_NO_ERROR;
390 
391  GpgmeKeyPtr foundKey;
392 
393  //search for requested key id
394  gpgme_key_t key;
395  gpgme_op_keylist_start(_pimpl->_ctx, NULL, 0);
396  while (!(err = gpgme_op_keylist_next(_pimpl->_ctx, &key))) {
397  if (key->subkeys && id == str::asString(key->subkeys->keyid)) {
398  GpgmeKeyPtr(key, gpgme_key_release).swap(foundKey);
399  break;
400  }
401  gpgme_key_release(key);
402  }
403  gpgme_op_keylist_end(_pimpl->_ctx);
404 
405  if (!foundKey) {
406  WAR << "Key " << id << "not found" << endl;
407  return false;
408  }
409 
410  //function needs a array of keys to export
411  gpgme_key_t keyarray[2];
412  keyarray[0] = foundKey.get();
413  keyarray[1] = NULL;
414 
415  GpgmeDataPtr out(nullptr, gpgme_data_release);
416  err = gpgme_data_new (&out.get());
417  if (err) {
418  ERR << err << endl;
419  return false;
420  }
421 
422  //format as ascii armored
423  gpgme_set_armor (_pimpl->_ctx, 1);
424  // bsc#1179222: Remove outdated self signatures when exporting the key.
425  // The keyring does not order the signatures when multiple versions of the
426  // same key are imported. Rpm however uses the 1st to compute the -release
427  // of the gpg-pubkey. So we export only the latest to get a proper-release.
428  err = gpgme_op_export_keys (_pimpl->_ctx, keyarray, GPGME_EXPORT_MODE_MINIMAL, out.get());
429  if (!err) {
430  int ret = gpgme_data_seek (out.get(), 0, SEEK_SET);
431  if (ret) {
432  ERR << "Unable to seek in exported key data" << endl;
433  return false;
434  }
435 
436  const int bufsize = 512;
437  char buf[bufsize + 1];
438  while ((ret = gpgme_data_read(out.get(), buf, bufsize)) > 0) {
439  stream.write(buf, ret);
440  }
441 
442  //failed to read from buffer
443  if (ret < 0) {
444  ERR << "Unable to read exported key data" << endl;
445  return false;
446  }
447  } else {
448  ERR << "Error exporting key: "<< err << endl;
449  return false;
450  }
451 
452  //if we reach this point export was successful
453  return true;
454 }
455 
456 bool KeyManagerCtx::importKey(const Pathname &keyfile)
457 {
458  if ( !PathInfo( keyfile ).isExist() ) {
459  ERR << "Keyfile '" << keyfile << "' does not exist.";
460  return false;
461  }
462 
463  GpgmeDataPtr data(nullptr, gpgme_data_release);
464  GpgmeErr err;
465 
466  err = gpgme_data_new_from_file(&data.get(), keyfile.c_str(), 1);
467  if (err) {
468  ERR << "Error importing key: "<< err << endl;
469  return false;
470  }
471 
472  err = gpgme_op_import(_pimpl->_ctx, data.get());
473  if (err) {
474  ERR << "Error importing key: "<< err << endl;
475  return false;
476  }
477 
478  // Work around bsc#1127220 [libgpgme] no error upon incomplete import due to signal received.
479  // We need this error, otherwise RpmDb will report the missing keys as 'probably v3'.
480  if ( gpgme_import_result_t res = gpgme_op_import_result(_pimpl->_ctx) )
481  {
482  if ( ! res->considered && PathInfo(keyfile).size() )
483  {
484  DBG << *res << endl;
485  ERR << "Error importing key: No keys considered (bsc#1127220, [libgpgme] signal received?)" << endl;
486  return false;
487  }
488  }
489 
490  return (err == GPG_ERR_NO_ERROR);
491 }
492 
493 bool KeyManagerCtx::deleteKey(const std::string &id)
494 {
495  gpgme_key_t key;
496  GpgmeErr err = GPG_ERR_NO_ERROR;
497 
498  gpgme_op_keylist_start(_pimpl->_ctx, NULL, 0);
499 
500  while (!(err = gpgme_op_keylist_next(_pimpl->_ctx, &key))) {
501  if (key->subkeys && id == str::asString(key->subkeys->keyid)) {
502  err = gpgme_op_delete(_pimpl->_ctx, key, 0);
503 
504  gpgme_key_release(key);
505  gpgme_op_keylist_end(_pimpl->_ctx);
506 
507  if (err) {
508  ERR << "Error deleting key: "<< err << endl;
509  return false;
510  }
511  return true;
512  }
513  gpgme_key_release(key);
514  }
515 
516  gpgme_op_keylist_end(_pimpl->_ctx);
517  WAR << "Key: '"<< id << "' not found." << endl;
518  return false;
519 }
520 
521 std::list<std::string> KeyManagerCtx::readSignatureFingerprints(const Pathname &signature)
522 { return _pimpl->readSignaturesFprs(signature); }
523 
524 } // namespace zypp
int assert_dir(const Pathname &path, unsigned mode)
Like &#39;mkdir -p&#39;.
Definition: PathInfo.cc:320
#define MIL
Definition: Logger.h:79
std::list< PublicKeyData > readKeyFromFile(const Pathname &file)
Returns a list of all PublicKeyData found in file.
Definition: KeyManager.cc:322
#define ZYPP_THROW(EXCPT)
Drops a logline and throws the Exception.
Definition: Exception.h:392
std::list< std::string > readSignaturesFprs(const Pathname &signature_r)
Return all fingerprints found in signature_r.
Definition: KeyManager.cc:115
gpgme_error_t _err
Definition: KeyManager.cc:64
Class representing one GPG Public Keys data.
Definition: PublicKey.h:139
int clean_dir(const Pathname &path)
Like &#39;rm -r DIR/ *&#39;.
Definition: PathInfo.cc:443
const char * c_str() const
String representation.
Definition: Pathname.h:110
String related utilities and Regular expression matching.
const std::string & asString(const std::string &t)
Global asString() that works with std::string too.
Definition: String.h:136
bool verify(const Pathname &file, const Pathname &signature)
Tries to verify file using signature, returns true on success.
Definition: KeyManager.cc:382
static KeyManagerCtx createForOpenPGP()
Creates a new KeyManagerCtx for PGP using a volatile temp.
Definition: KeyManager.cc:242
#define ERR
Definition: Logger.h:81
bool exportKey(const std::string &id, std::ostream &stream)
Exports the key with id into the given stream, returns true on success.
Definition: KeyManager.cc:387
RW_pointer< Impl > _pimpl
Pointer to implementation.
Definition: KeyManager.h:82
Pathname homedir() const
Return the homedir/keyring.
Definition: KeyManager.cc:283
bool empty() const
Test for an empty path.
Definition: Pathname.h:114
bool importKey(const Pathname &keyfile)
Tries to import a key from keyfile, returns true on success.
Definition: KeyManager.cc:456
std::ostream & operator<<(std::ostream &str, const Exception &obj)
Definition: Exception.cc:147
bool verifySignaturesFprs(const Pathname &file_r, const Pathname &signature_r)
Tries to verify the file_r using signature_r.
Definition: KeyManager.cc:119
#define WAR
Definition: Logger.h:80
Pathname myTmpDir()
Global access to the zypp.TMPDIR (created on demand, deleted when libzypp is unloaded) ...
Definition: ZYppImpl.cc:228
bool deleteKey(const std::string &id)
Tries to delete a key specified by id, returns true on success.
Definition: KeyManager.cc:493
std::list< PublicKeyData > listKeys()
Returns a list of all public keys found in the current keyring.
Definition: KeyManager.cc:291
GpgmeException(const std::string &in_r, const GpgmeErr &err_r)
Definition: KeyManager.cc:99
Reference counted access to a Tp object calling a custom Dispose function when the last AutoDispose h...
Definition: AutoDispose.h:92
Wrapper class for ::stat/::lstat.
Definition: PathInfo.h:220
std::list< std::string > readSignatureFingerprints(const Pathname &signature)
Reads all fingerprints from the signature file , returns a list of all found fingerprints.
Definition: KeyManager.cc:521
std::list< std::string > readSignaturesFprsOptVerify(const Pathname &signature_r, const Pathname &file_r="/dev/null", bool *verify_r=nullptr)
Return all fingerprints found in signature_r and optionally verify the file_r on the fly...
Definition: KeyManager.cc:138
static PublicKeyData fromGpgmeKey(_gpgme_key *data)
Definition: PublicKey.cc:305
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:1
bool _volatile
readKeyFromFile workaround bsc#1140670
Definition: KeyManager.cc:127
#define DBG
Definition: Logger.h:78