cfa1ba3156b3f8a749f99c7a899a9f40c16772d2
[gpgme.git] / lang / cpp / src / key.cpp
1 /*
2   key.cpp - wraps a gpgme key
3   Copyright (C) 2003, 2005 Klarälvdalens Datakonsult AB
4
5   This file is part of GPGME++.
6
7   GPGME++ is free software; you can redistribute it and/or
8   modify it under the terms of the GNU Library General Public
9   License as published by the Free Software Foundation; either
10   version 2 of the License, or (at your option) any later version.
11
12   GPGME++ is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU Library General Public License for more details.
16
17   You should have received a copy of the GNU Library General Public License
18   along with GPGME++; see the file COPYING.LIB.  If not, write to the
19   Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20   Boston, MA 02110-1301, USA.
21 */
22
23 #include <key.h>
24
25 #include "util.h"
26 #include "tofuinfo.h"
27 #include "context.h"
28
29 #include <gpgme.h>
30
31 #include <string.h>
32 #include <istream>
33 #include <iterator>
34
35 const GpgME::Key::Null GpgME::Key::null;
36
37 namespace GpgME
38 {
39
40 Key::Key() : key() {}
41
42 Key::Key(const Null &) : key() {}
43
44 Key::Key(const shared_gpgme_key_t &k) : key(k) {}
45
46 Key::Key(gpgme_key_t k, bool ref)
47     : key(k
48           ? shared_gpgme_key_t(k, &gpgme_key_unref)
49           : shared_gpgme_key_t())
50 {
51     if (ref && impl()) {
52         gpgme_key_ref(impl());
53     }
54 }
55
56 UserID Key::userID(unsigned int index) const
57 {
58     return UserID(key, index);
59 }
60
61 Subkey Key::subkey(unsigned int index) const
62 {
63     return Subkey(key, index);
64 }
65
66 unsigned int Key::numUserIDs() const
67 {
68     if (!key) {
69         return 0;
70     }
71     unsigned int count = 0;
72     for (gpgme_user_id_t uid = key->uids ; uid ; uid = uid->next) {
73         ++count;
74     }
75     return count;
76 }
77
78 unsigned int Key::numSubkeys() const
79 {
80     if (!key) {
81         return 0;
82     }
83     unsigned int count = 0;
84     for (gpgme_sub_key_t subkey = key->subkeys ; subkey ; subkey = subkey->next) {
85         ++count;
86     }
87     return count;
88 }
89
90 std::vector<UserID> Key::userIDs() const
91 {
92     if (!key) {
93         return std::vector<UserID>();
94     }
95
96     std::vector<UserID> v;
97     v.reserve(numUserIDs());
98     for (gpgme_user_id_t uid = key->uids ; uid ; uid = uid->next) {
99         v.push_back(UserID(key, uid));
100     }
101     return v;
102 }
103
104 std::vector<Subkey> Key::subkeys() const
105 {
106     if (!key) {
107         return std::vector<Subkey>();
108     }
109
110     std::vector<Subkey> v;
111     v.reserve(numSubkeys());
112     for (gpgme_sub_key_t subkey = key->subkeys ; subkey ; subkey = subkey->next) {
113         v.push_back(Subkey(key, subkey));
114     }
115     return v;
116 }
117
118 Key::OwnerTrust Key::ownerTrust() const
119 {
120     if (!key) {
121         return Unknown;
122     }
123     switch (key->owner_trust) {
124     default:
125     case GPGME_VALIDITY_UNKNOWN:   return Unknown;
126     case GPGME_VALIDITY_UNDEFINED: return Undefined;
127     case GPGME_VALIDITY_NEVER:     return Never;
128     case GPGME_VALIDITY_MARGINAL:  return Marginal;
129     case GPGME_VALIDITY_FULL:     return Full;
130     case GPGME_VALIDITY_ULTIMATE: return Ultimate;
131     }
132 }
133 char Key::ownerTrustAsString() const
134 {
135     if (!key) {
136         return '?';
137     }
138     switch (key->owner_trust) {
139     default:
140     case GPGME_VALIDITY_UNKNOWN:   return '?';
141     case GPGME_VALIDITY_UNDEFINED: return 'q';
142     case GPGME_VALIDITY_NEVER:     return 'n';
143     case GPGME_VALIDITY_MARGINAL:  return 'm';
144     case GPGME_VALIDITY_FULL:     return 'f';
145     case GPGME_VALIDITY_ULTIMATE: return 'u';
146     }
147 }
148
149 Protocol Key::protocol() const
150 {
151     if (!key) {
152         return UnknownProtocol;
153     }
154     switch (key->protocol) {
155     case GPGME_PROTOCOL_CMS:     return CMS;
156     case GPGME_PROTOCOL_OpenPGP: return OpenPGP;
157     default:                     return UnknownProtocol;
158     }
159 }
160
161 const char *Key::protocolAsString() const
162 {
163     return key ? gpgme_get_protocol_name(key->protocol) : 0 ;
164 }
165
166 bool Key::isRevoked() const
167 {
168     return key && key->revoked;
169 }
170
171 bool Key::isExpired() const
172 {
173     return key && key->expired;
174 }
175
176 bool Key::isDisabled() const
177 {
178     return key && key->disabled;
179 }
180
181 bool Key::isInvalid() const
182 {
183     return key && key->invalid;
184 }
185
186 bool Key::hasSecret() const
187 {
188     return key && key->secret;
189 }
190
191 bool Key::isRoot() const
192 {
193     return key && key->subkeys && key->subkeys->fpr && key->chain_id &&
194            strcasecmp(key->subkeys->fpr, key->chain_id) == 0;
195 }
196
197 bool Key::canEncrypt() const
198 {
199     return key && key->can_encrypt;
200 }
201
202 bool Key::canSign() const
203 {
204 #ifndef GPGME_CAN_SIGN_ON_SECRET_OPENPGP_KEYLISTING_NOT_BROKEN
205     if (key && key->protocol == GPGME_PROTOCOL_OpenPGP) {
206         return true;
207     }
208 #endif
209     return canReallySign();
210 }
211
212 bool Key::canReallySign() const
213 {
214     return key && key->can_sign;
215 }
216
217 bool Key::canCertify() const
218 {
219     return key && key->can_certify;
220 }
221
222 bool Key::canAuthenticate() const
223 {
224     return key && key->can_authenticate;
225 }
226
227 bool Key::isQualified() const
228 {
229     return key && key->is_qualified;
230 }
231
232 const char *Key::issuerSerial() const
233 {
234     return key ? key->issuer_serial : 0 ;
235 }
236 const char *Key::issuerName() const
237 {
238     return key ? key->issuer_name : 0 ;
239 }
240 const char *Key::chainID() const
241 {
242     return key ? key->chain_id : 0 ;
243 }
244
245 const char *Key::keyID() const
246 {
247     return key && key->subkeys ? key->subkeys->keyid : 0 ;
248 }
249
250 const char *Key::shortKeyID() const
251 {
252     if (!key || !key->subkeys || !key->subkeys->keyid) {
253         return 0;
254     }
255     const int len = strlen(key->subkeys->keyid);
256     if (len > 8) {
257         return key->subkeys->keyid + len - 8; // return the last 8 bytes (in hex notation)
258     } else {
259         return key->subkeys->keyid;
260     }
261 }
262
263 const char *Key::primaryFingerprint() const
264 {
265     if (!key) {
266         return nullptr;
267     }
268     if (key->fpr) {
269         /* Return what gpgme thinks is the primary fingerprint */
270         return key->fpr;
271     }
272     if (key->subkeys) {
273         /* Return the first subkeys fingerprint */
274         return key->subkeys->fpr;
275     }
276 }
277
278 unsigned int Key::keyListMode() const
279 {
280     return key ? convert_from_gpgme_keylist_mode_t(key->keylist_mode) : 0 ;
281 }
282
283 const Key &Key::mergeWith(const Key &other)
284 {
285     // ### incomplete. Just merges has* and can*, nothing else atm
286     // ### detach also missing
287
288     if (!this->primaryFingerprint() ||
289             !other.primaryFingerprint() ||
290             strcasecmp(this->primaryFingerprint(), other.primaryFingerprint()) != 0) {
291         return *this; // only merge the Key object which describe the same key
292     }
293
294     const gpgme_key_t me = impl();
295     const gpgme_key_t him = other.impl();
296
297     if (!me || !him) {
298         return *this;
299     }
300
301     me->revoked          |= him->revoked;
302     me->expired          |= him->expired;
303     me->disabled         |= him->disabled;
304     me->invalid          |= him->invalid;
305     me->can_encrypt      |= him->can_encrypt;
306     me->can_sign         |= him->can_sign;
307     me->can_certify      |= him->can_certify;
308     me->secret           |= him->secret;
309     me->can_authenticate |= him->can_authenticate;
310     me->is_qualified     |= him->is_qualified;
311     me->keylist_mode     |= him->keylist_mode;
312
313     // make sure the gpgme_sub_key_t::is_cardkey flag isn't lost:
314     for (gpgme_sub_key_t mysk = me->subkeys ; mysk ; mysk = mysk->next) {
315         for (gpgme_sub_key_t hissk = him->subkeys ; hissk ; hissk = hissk->next) {
316             if (strcmp(mysk->fpr, hissk->fpr) == 0) {
317                 mysk->is_cardkey |= hissk->is_cardkey;
318                 break;
319             }
320         }
321     }
322
323     return *this;
324 }
325
326 void Key::update()
327 {
328     auto ctx = Context::createForProtocol(protocol());
329     if (!ctx) {
330         return;
331     }
332     ctx->setKeyListMode(KeyListMode::Local |
333                         KeyListMode::Signatures |
334                         KeyListMode::SignatureNotations |
335                         KeyListMode::Validate |
336                         KeyListMode::WithTofu);
337     Error err;
338     auto newKey = ctx->key(primaryFingerprint(), err, hasSecret());
339     delete ctx;
340     if (err) {
341         return;
342     }
343     swap(newKey);
344     return;
345 }
346
347 //
348 //
349 // class Subkey
350 //
351 //
352
353 gpgme_sub_key_t find_subkey(const shared_gpgme_key_t &key, unsigned int idx)
354 {
355     if (key) {
356         for (gpgme_sub_key_t s = key->subkeys ; s ; s = s->next, --idx) {
357             if (idx == 0) {
358                 return s;
359             }
360         }
361     }
362     return 0;
363 }
364
365 gpgme_sub_key_t verify_subkey(const shared_gpgme_key_t &key, gpgme_sub_key_t subkey)
366 {
367     if (key) {
368         for (gpgme_sub_key_t s = key->subkeys ; s ; s = s->next) {
369             if (s == subkey) {
370                 return subkey;
371             }
372         }
373     }
374     return 0;
375 }
376
377 Subkey::Subkey() : key(), subkey(0) {}
378
379 Subkey::Subkey(const shared_gpgme_key_t &k, unsigned int idx)
380     : key(k), subkey(find_subkey(k, idx))
381 {
382
383 }
384
385 Subkey::Subkey(const shared_gpgme_key_t &k, gpgme_sub_key_t sk)
386     : key(k), subkey(verify_subkey(k, sk))
387 {
388
389 }
390
391 Key Subkey::parent() const
392 {
393     return Key(key);
394 }
395
396 const char *Subkey::keyID() const
397 {
398     return subkey ? subkey->keyid : 0 ;
399 }
400
401 const char *Subkey::fingerprint() const
402 {
403     return subkey ? subkey->fpr : 0 ;
404 }
405
406 Subkey::PubkeyAlgo Subkey::publicKeyAlgorithm() const
407 {
408     return subkey ? static_cast<PubkeyAlgo>(subkey->pubkey_algo) : AlgoUnknown;
409 }
410
411 const char *Subkey::publicKeyAlgorithmAsString() const
412 {
413     return gpgme_pubkey_algo_name(subkey ? subkey->pubkey_algo : (gpgme_pubkey_algo_t)0);
414 }
415
416 /* static */
417 const char *Subkey::publicKeyAlgorithmAsString(PubkeyAlgo algo)
418 {
419     if (algo == AlgoUnknown) {
420         return NULL;
421     }
422     return gpgme_pubkey_algo_name(static_cast<gpgme_pubkey_algo_t>(algo));
423 }
424
425 std::string Subkey::algoName() const
426 {
427     char *gpgmeStr;
428     if (subkey && (gpgmeStr = gpgme_pubkey_algo_string(subkey))) {
429         std::string ret = std::string(gpgmeStr);
430         gpgme_free(gpgmeStr);
431         return ret;
432     }
433     return std::string();
434 }
435
436 bool Subkey::canEncrypt() const
437 {
438     return subkey && subkey->can_encrypt;
439 }
440
441 bool Subkey::canSign() const
442 {
443     return subkey && subkey->can_sign;
444 }
445
446 bool Subkey::canCertify() const
447 {
448     return subkey && subkey->can_certify;
449 }
450
451 bool Subkey::canAuthenticate() const
452 {
453     return subkey && subkey->can_authenticate;
454 }
455
456 bool Subkey::isQualified() const
457 {
458     return subkey && subkey->is_qualified;
459 }
460
461 bool Subkey::isCardKey() const
462 {
463     return subkey && subkey->is_cardkey;
464 }
465
466 const char *Subkey::cardSerialNumber() const
467 {
468     return subkey ? subkey->card_number : 0 ;
469 }
470
471 bool Subkey::isSecret() const
472 {
473     return subkey && subkey->secret;
474 }
475
476 unsigned int Subkey::length() const
477 {
478     return subkey ? subkey->length : 0 ;
479 }
480
481 time_t Subkey::creationTime() const
482 {
483     return static_cast<time_t>(subkey ? subkey->timestamp : 0);
484 }
485
486 time_t Subkey::expirationTime() const
487 {
488     return static_cast<time_t>(subkey ? subkey->expires : 0);
489 }
490
491 bool Subkey::neverExpires() const
492 {
493     return expirationTime() == time_t(0);
494 }
495
496 bool Subkey::isRevoked() const
497 {
498     return subkey && subkey->revoked;
499 }
500
501 bool Subkey::isInvalid() const
502 {
503     return subkey && subkey->invalid;
504 }
505
506 bool Subkey::isExpired() const
507 {
508     return subkey && subkey->expired;
509 }
510
511 bool Subkey::isDisabled() const
512 {
513     return subkey && subkey->disabled;
514 }
515
516 //
517 //
518 // class UserID
519 //
520 //
521
522 gpgme_user_id_t find_uid(const shared_gpgme_key_t &key, unsigned int idx)
523 {
524     if (key) {
525         for (gpgme_user_id_t u = key->uids ; u ; u = u->next, --idx) {
526             if (idx == 0) {
527                 return u;
528             }
529         }
530     }
531     return 0;
532 }
533
534 gpgme_user_id_t verify_uid(const shared_gpgme_key_t &key, gpgme_user_id_t uid)
535 {
536     if (key) {
537         for (gpgme_user_id_t u = key->uids ; u ; u = u->next) {
538             if (u == uid) {
539                 return uid;
540             }
541         }
542     }
543     return 0;
544 }
545
546 UserID::UserID() : key(), uid(0) {}
547
548 UserID::UserID(const shared_gpgme_key_t &k, gpgme_user_id_t u)
549     : key(k), uid(verify_uid(k, u))
550 {
551
552 }
553
554 UserID::UserID(const shared_gpgme_key_t &k, unsigned int idx)
555     : key(k), uid(find_uid(k, idx))
556 {
557
558 }
559
560 Key UserID::parent() const
561 {
562     return Key(key);
563 }
564
565 UserID::Signature UserID::signature(unsigned int index) const
566 {
567     return Signature(key, uid, index);
568 }
569
570 unsigned int UserID::numSignatures() const
571 {
572     if (!uid) {
573         return 0;
574     }
575     unsigned int count = 0;
576     for (gpgme_key_sig_t sig = uid->signatures ; sig ; sig = sig->next) {
577         ++count;
578     }
579     return count;
580 }
581
582 std::vector<UserID::Signature> UserID::signatures() const
583 {
584     if (!uid) {
585         return std::vector<Signature>();
586     }
587
588     std::vector<Signature> v;
589     v.reserve(numSignatures());
590     for (gpgme_key_sig_t sig = uid->signatures ; sig ; sig = sig->next) {
591         v.push_back(Signature(key, uid, sig));
592     }
593     return v;
594 }
595
596 const char *UserID::id() const
597 {
598     return uid ? uid->uid : 0 ;
599 }
600
601 const char *UserID::name() const
602 {
603     return uid ? uid->name : 0 ;
604 }
605
606 const char *UserID::email() const
607 {
608     return uid ? uid->email : 0 ;
609 }
610
611 const char *UserID::comment() const
612 {
613     return uid ? uid->comment : 0 ;
614 }
615
616 UserID::Validity UserID::validity() const
617 {
618     if (!uid) {
619         return Unknown;
620     }
621     switch (uid->validity) {
622     default:
623     case GPGME_VALIDITY_UNKNOWN:   return Unknown;
624     case GPGME_VALIDITY_UNDEFINED: return Undefined;
625     case GPGME_VALIDITY_NEVER:     return Never;
626     case GPGME_VALIDITY_MARGINAL:  return Marginal;
627     case GPGME_VALIDITY_FULL:      return Full;
628     case GPGME_VALIDITY_ULTIMATE:  return Ultimate;
629     }
630 }
631
632 char UserID::validityAsString() const
633 {
634     if (!uid) {
635         return '?';
636     }
637     switch (uid->validity) {
638     default:
639     case GPGME_VALIDITY_UNKNOWN:   return '?';
640     case GPGME_VALIDITY_UNDEFINED: return 'q';
641     case GPGME_VALIDITY_NEVER:     return 'n';
642     case GPGME_VALIDITY_MARGINAL:  return 'm';
643     case GPGME_VALIDITY_FULL:      return 'f';
644     case GPGME_VALIDITY_ULTIMATE:  return 'u';
645     }
646 }
647
648 bool UserID::isRevoked() const
649 {
650     return uid && uid->revoked;
651 }
652
653 bool UserID::isInvalid() const
654 {
655     return uid && uid->invalid;
656 }
657
658 TofuInfo UserID::tofuInfo() const
659 {
660     if (!uid) {
661         return TofuInfo();
662     }
663     return TofuInfo(uid->tofu);
664 }
665
666 //
667 //
668 // class Signature
669 //
670 //
671
672 gpgme_key_sig_t find_signature(gpgme_user_id_t uid, unsigned int idx)
673 {
674     if (uid) {
675         for (gpgme_key_sig_t s = uid->signatures ; s ; s = s->next, --idx) {
676             if (idx == 0) {
677                 return s;
678             }
679         }
680     }
681     return 0;
682 }
683
684 gpgme_key_sig_t verify_signature(gpgme_user_id_t uid, gpgme_key_sig_t sig)
685 {
686     if (uid) {
687         for (gpgme_key_sig_t s = uid->signatures ; s ; s = s->next) {
688             if (s == sig) {
689                 return sig;
690             }
691         }
692     }
693     return 0;
694 }
695
696 UserID::Signature::Signature() : key(), uid(0), sig(0) {}
697
698 UserID::Signature::Signature(const shared_gpgme_key_t &k, gpgme_user_id_t u, unsigned int idx)
699     : key(k), uid(verify_uid(k, u)), sig(find_signature(uid, idx))
700 {
701
702 }
703
704 UserID::Signature::Signature(const shared_gpgme_key_t &k, gpgme_user_id_t u, gpgme_key_sig_t s)
705     : key(k), uid(verify_uid(k, u)), sig(verify_signature(uid, s))
706 {
707
708 }
709
710 UserID UserID::Signature::parent() const
711 {
712     return UserID(key, uid);
713 }
714
715 const char *UserID::Signature::signerKeyID() const
716 {
717     return sig ? sig->keyid : 0 ;
718 }
719
720 const char *UserID::Signature::algorithmAsString() const
721 {
722     return gpgme_pubkey_algo_name(sig ? sig->pubkey_algo : (gpgme_pubkey_algo_t)0);
723 }
724
725 unsigned int UserID::Signature::algorithm() const
726 {
727     return sig ? sig->pubkey_algo : 0 ;
728 }
729
730 time_t UserID::Signature::creationTime() const
731 {
732     return static_cast<time_t>(sig ? sig->timestamp : 0);
733 }
734
735 time_t UserID::Signature::expirationTime() const
736 {
737     return static_cast<time_t>(sig ? sig->expires : 0);
738 }
739
740 bool UserID::Signature::neverExpires() const
741 {
742     return expirationTime() == time_t(0);
743 }
744
745 bool UserID::Signature::isRevokation() const
746 {
747     return sig && sig->revoked;
748 }
749
750 bool UserID::Signature::isInvalid() const
751 {
752     return sig && sig->invalid;
753 }
754
755 bool UserID::Signature::isExpired() const
756 {
757     return sig && sig->expired;
758 }
759
760 bool UserID::Signature::isExportable() const
761 {
762     return sig && sig->exportable;
763 }
764
765 const char *UserID::Signature::signerUserID() const
766 {
767     return sig ? sig->uid : 0 ;
768 }
769
770 const char *UserID::Signature::signerName() const
771 {
772     return sig ? sig->name : 0 ;
773 }
774
775 const char *UserID::Signature::signerEmail() const
776 {
777     return sig ? sig->email : 0 ;
778 }
779
780 const char *UserID::Signature::signerComment() const
781 {
782     return sig ? sig->comment : 0 ;
783 }
784
785 unsigned int UserID::Signature::certClass() const
786 {
787     return sig ? sig->sig_class : 0 ;
788 }
789
790 UserID::Signature::Status UserID::Signature::status() const
791 {
792     if (!sig) {
793         return GeneralError;
794     }
795
796     switch (gpgme_err_code(sig->status)) {
797     case GPG_ERR_NO_ERROR:      return NoError;
798     case GPG_ERR_SIG_EXPIRED:   return SigExpired;
799     case GPG_ERR_KEY_EXPIRED:   return KeyExpired;
800     case GPG_ERR_BAD_SIGNATURE: return BadSignature;
801     case GPG_ERR_NO_PUBKEY:     return NoPublicKey;
802     default:
803     case GPG_ERR_GENERAL:       return GeneralError;
804     }
805 }
806
807 std::string UserID::Signature::statusAsString() const
808 {
809     if (!sig) {
810         return std::string();
811     }
812     char buf[ 1024 ];
813     gpgme_strerror_r(sig->status, buf, sizeof buf);
814     buf[ sizeof buf - 1 ] = '\0';
815     return std::string(buf);
816 }
817
818 GpgME::Notation UserID::Signature::notation(unsigned int idx) const
819 {
820     if (!sig) {
821         return GpgME::Notation();
822     }
823     for (gpgme_sig_notation_t nota = sig->notations ; nota ; nota = nota->next) {
824         if (nota->name) {
825             if (idx-- == 0) {
826                 return GpgME::Notation(nota);
827             }
828         }
829     }
830     return GpgME::Notation();
831 }
832
833 unsigned int UserID::Signature::numNotations() const
834 {
835     if (!sig) {
836         return 0;
837     }
838     unsigned int count = 0;
839     for (gpgme_sig_notation_t nota = sig->notations ; nota ; nota = nota->next) {
840         if (nota->name) {
841             ++count; // others are policy URLs...
842         }
843     }
844     return count;
845 }
846
847 std::vector<Notation> UserID::Signature::notations() const
848 {
849     if (!sig) {
850         return std::vector<GpgME::Notation>();
851     }
852     std::vector<GpgME::Notation> v;
853     v.reserve(numNotations());
854     for (gpgme_sig_notation_t nota = sig->notations ; nota ; nota = nota->next) {
855         if (nota->name) {
856             v.push_back(GpgME::Notation(nota));
857         }
858     }
859     return v;
860 }
861
862 const char *UserID::Signature::policyURL() const
863 {
864     if (!sig) {
865         return 0;
866     }
867     for (gpgme_sig_notation_t nota = sig->notations ; nota ; nota = nota->next) {
868         if (!nota->name) {
869             return nota->value;
870         }
871     }
872     return 0;
873 }
874
875 std::ostream &operator<<(std::ostream &os, const UserID &uid)
876 {
877     os << "GpgME::UserID(";
878     if (!uid.isNull()) {
879         os << "\n name:      " << protect(uid.name())
880            << "\n email:     " << protect(uid.email())
881            << "\n comment:   " << protect(uid.comment())
882            << "\n validity:  " << uid.validityAsString()
883            << "\n revoked:   " << uid.isRevoked()
884            << "\n invalid:   " << uid.isInvalid()
885            << "\n numsigs:   " << uid.numSignatures()
886            << "\n tofuinfo:\n" << uid.tofuInfo();
887     }
888     return os << ')';
889 }
890
891 std::ostream &operator<<(std::ostream &os, const Key &key)
892 {
893     os << "GpgME::Key(";
894     if (!key.isNull()) {
895         os << "\n protocol:   " << protect(key.protocolAsString())
896            << "\n ownertrust: " << key.ownerTrustAsString()
897            << "\n issuer:     " << protect(key.issuerName())
898            << "\n fingerprint:" << protect(key.primaryFingerprint())
899            << "\n listmode:   " << key.keyListMode()
900            << "\n canSign:    " << key.canReallySign()
901            << "\n canEncrypt: " << key.canEncrypt()
902            << "\n canCertify: " << key.canCertify()
903            << "\n canAuth:    " << key.canAuthenticate()
904            << "\n uids:\n";
905         const std::vector<UserID> uids = key.userIDs();
906         std::copy(uids.begin(), uids.end(),
907                   std::ostream_iterator<UserID>(os, "\n"));
908     }
909     return os << ')';
910 }
911
912 } // namespace GpgME