1 /* keyring.c - keyring file handling
2 * Copyright (C) 2001, 2004, 2009 Free Software Foundation, Inc.
4 * This file is part of GnuPG.
6 * GnuPG is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * GnuPG is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
27 #include <sys/types.h>
36 #include "main.h" /*for check_key_signature()*/
39 /* off_item is a funny named for an object used to keep track of known
40 * keys. The idea was to use the offset to seek to the known keyblock, but
41 * this is not possible if more than one process is using the keyring.
44 struct off_item
*next
;
49 typedef struct off_item
**OffsetHashTable
;
52 typedef struct keyring_name
*KR_NAME
;
55 struct keyring_name
*next
;
63 typedef struct keyring_name
const * CONST_KR_NAME
;
65 static KR_NAME kr_names
;
66 static int active_handles
;
68 static OffsetHashTable kr_offtbl
;
69 static int kr_offtbl_ready
;
72 struct keyring_handle
{
73 CONST_KR_NAME resource
;
74 int secret
; /* this is for a secret keyring */
86 unsigned int n_packets
; /*used for delete and update*/
96 static int do_copy (int mode
, const char *fname
, KBNODE root
, int secret
,
97 off_t start_offset
, unsigned int n_packets
);
101 static struct off_item
*
102 new_offset_item (void)
106 k
= xmalloc_clear (sizeof *k
);
112 release_offset_items (struct off_item
*k
)
124 static OffsetHashTable
125 new_offset_hash_table (void)
127 struct off_item
**tbl
;
129 tbl
= xmalloc_clear (2048 * sizeof *tbl
);
135 release_offset_hash_table (OffsetHashTable tbl
)
141 for (i
=0; i
< 2048; i
++)
142 release_offset_items (tbl
[i
]);
147 static struct off_item
*
148 lookup_offset_hash_table (OffsetHashTable tbl
, u32
*kid
)
152 for (k
= tbl
[(kid
[1] & 0x07ff)]; k
; k
= k
->next
)
153 if (k
->kid
[0] == kid
[0] && k
->kid
[1] == kid
[1])
159 update_offset_hash_table (OffsetHashTable tbl
, u32
*kid
, off_t off
)
165 for (k
= tbl
[(kid
[1] & 0x07ff)]; k
; k
= k
->next
)
167 if (k
->kid
[0] == kid
[0] && k
->kid
[1] == kid
[1])
174 k
= new_offset_item ();
178 k
->next
= tbl
[(kid
[1] & 0x07ff)];
179 tbl
[(kid
[1] & 0x07ff)] = k
;
183 update_offset_hash_table_from_kb (OffsetHashTable tbl
, KBNODE node
, off_t off
)
185 for (; node
; node
= node
->next
)
187 if (node
->pkt
->pkttype
== PKT_PUBLIC_KEY
188 || node
->pkt
->pkttype
== PKT_PUBLIC_SUBKEY
)
191 keyid_from_pk (node
->pkt
->pkt
.public_key
, aki
);
192 update_offset_hash_table (tbl
, aki
, off
);
198 * Register a filename for plain keyring files. ptr is set to a
199 * pointer to be used to create a handles etc, or the already-issued
200 * pointer if it has already been registered. The function returns 1
201 * if a new keyring was registered.
204 keyring_register_filename (const char *fname
, int secret
, int readonly
,
210 BUG (); /* We don't allow that */
212 for (kr
=kr_names
; kr
; kr
= kr
->next
)
214 if (same_file_p (kr
->fname
, fname
))
216 /* Already registered. */
225 register_secured_file (fname
);
227 kr
= xmalloc (sizeof *kr
+ strlen (fname
));
228 strcpy (kr
->fname
, fname
);
229 kr
->secret
= !!secret
;
230 kr
->readonly
= readonly
;
233 kr
->did_full_scan
= 0;
234 /* keep a list of all issued pointers */
238 /* create the offset table the first time a function here is used */
240 kr_offtbl
= new_offset_hash_table ();
248 keyring_is_writable (void *token
)
252 return r
? (r
->readonly
|| !access (r
->fname
, W_OK
)) : 0;
257 /* Create a new handle for the resource associated with TOKEN. SECRET
258 is just just as a cross-check.
260 The returned handle must be released using keyring_release (). */
262 keyring_new (void *token
, int secret
)
265 KR_NAME resource
= token
;
267 assert (resource
&& !resource
->secret
== !secret
);
269 hd
= xmalloc_clear (sizeof *hd
);
270 hd
->resource
= resource
;
271 hd
->secret
= !!secret
;
277 keyring_release (KEYRING_HANDLE hd
)
281 assert (active_handles
> 0);
283 xfree (hd
->word_match
.name
);
284 xfree (hd
->word_match
.pattern
);
285 iobuf_close (hd
->current
.iobuf
);
291 keyring_get_resource_name (KEYRING_HANDLE hd
)
293 if (!hd
|| !hd
->resource
)
295 return hd
->resource
->fname
;
300 * Lock the keyring with the given handle, or unlock if YES is false.
301 * We ignore the handle and lock all registered files.
304 keyring_lock (KEYRING_HANDLE hd
, int yes
)
312 /* first make sure the lock handles are created */
313 for (kr
=kr_names
; kr
; kr
= kr
->next
) {
314 if (!keyring_is_writable(kr
))
317 kr
->lockhd
= create_dotlock( kr
->fname
);
319 log_info ("can't allocate lock for `%s'\n", kr
->fname
);
327 /* and now set the locks */
328 for (kr
=kr_names
; kr
; kr
= kr
->next
) {
329 if (!keyring_is_writable(kr
))
333 else if (make_dotlock (kr
->lockhd
, -1) ) {
334 log_info ("can't lock `%s'\n", kr
->fname
);
343 for (kr
=kr_names
; kr
; kr
= kr
->next
) {
344 if (!keyring_is_writable(kr
))
348 else if (release_dotlock (kr
->lockhd
))
349 log_info ("can't unlock `%s'\n", kr
->fname
);
361 * Return the last found keyring. Caller must free it.
362 * The returned keyblock has the kbode flag bit 0 set for the node with
363 * the public key used to locate the keyblock or flag bit 1 set for
367 keyring_get_keyblock (KEYRING_HANDLE hd
, KBNODE
*ret_kb
)
371 KBNODE keyblock
= NULL
, node
, lastnode
;
382 return -1; /* no successful search */
384 a
= iobuf_open (hd
->found
.kr
->fname
);
387 log_error(_("can't open `%s'\n"), hd
->found
.kr
->fname
);
388 return G10ERR_KEYRING_OPEN
;
391 if (iobuf_seek (a
, hd
->found
.offset
) ) {
392 log_error ("can't seek `%s'\n", hd
->found
.kr
->fname
);
394 return G10ERR_KEYRING_OPEN
;
397 pkt
= xmalloc (sizeof *pkt
);
399 hd
->found
.n_packets
= 0;;
401 save_mode
= set_packet_list_mode(0);
402 while ((rc
=parse_packet (a
, pkt
)) != -1) {
403 hd
->found
.n_packets
++;
404 if (rc
== G10ERR_UNKNOWN_PACKET
) {
410 log_error ("keyring_get_keyblock: read error: %s\n",
412 rc
= G10ERR_INV_KEYRING
;
415 if (pkt
->pkttype
== PKT_COMPRESSED
) {
416 log_error ("skipped compressed packet in keyring\n");
422 if (in_cert
&& (pkt
->pkttype
== PKT_PUBLIC_KEY
423 || pkt
->pkttype
== PKT_SECRET_KEY
)) {
424 hd
->found
.n_packets
--; /* fix counter */
429 if (pkt
->pkttype
== PKT_RING_TRUST
) {
430 /*(this code is duplicated after the loop)*/
432 && lastnode
->pkt
->pkttype
== PKT_SIGNATURE
433 && (pkt
->pkt
.ring_trust
->sigcache
& 1) ) {
434 /* this is a ring trust packet with a checked signature
435 * status cache following directly a signature paket.
436 * Set the cache status into that signature packet */
437 PKT_signature
*sig
= lastnode
->pkt
->pkt
.signature
;
439 sig
->flags
.checked
= 1;
440 sig
->flags
.valid
= !!(pkt
->pkt
.ring_trust
->sigcache
& 2);
442 /* reset lastnode, so that we set the cache status only from
443 * the ring trust packet immediately folling a signature */
447 node
= lastnode
= new_kbnode (pkt
);
451 add_kbnode (keyblock
, node
);
453 if ( pkt
->pkttype
== PKT_PUBLIC_KEY
454 || pkt
->pkttype
== PKT_PUBLIC_SUBKEY
455 || pkt
->pkttype
== PKT_SECRET_KEY
456 || pkt
->pkttype
== PKT_SECRET_SUBKEY
) {
457 if (++pk_no
== hd
->found
.pk_no
)
460 else if ( pkt
->pkttype
== PKT_USER_ID
) {
461 if (++uid_no
== hd
->found
.uid_no
)
466 pkt
= xmalloc (sizeof *pkt
);
469 set_packet_list_mode(save_mode
);
471 if (rc
== -1 && keyblock
)
472 rc
= 0; /* got the entire keyblock */
475 release_kbnode (keyblock
);
477 /*(duplicated form the loop body)*/
478 if ( pkt
&& pkt
->pkttype
== PKT_RING_TRUST
480 && lastnode
->pkt
->pkttype
== PKT_SIGNATURE
481 && (pkt
->pkt
.ring_trust
->sigcache
& 1) ) {
482 PKT_signature
*sig
= lastnode
->pkt
->pkt
.signature
;
483 sig
->flags
.checked
= 1;
484 sig
->flags
.valid
= !!(pkt
->pkt
.ring_trust
->sigcache
& 2);
492 /* Make sure that future search operations fail immediately when
493 * we know that we are working on a invalid keyring
495 if (rc
== G10ERR_INV_KEYRING
)
496 hd
->current
.error
= rc
;
502 keyring_update_keyblock (KEYRING_HANDLE hd
, KBNODE kb
)
507 return -1; /* no successful prior search */
509 if (hd
->found
.kr
->readonly
)
510 return gpg_error (GPG_ERR_EACCES
);
512 if (!hd
->found
.n_packets
) {
513 /* need to know the number of packets - do a dummy get_keyblock*/
514 rc
= keyring_get_keyblock (hd
, NULL
);
516 log_error ("re-reading keyblock failed: %s\n", g10_errstr (rc
));
519 if (!hd
->found
.n_packets
)
523 /* The open iobuf isn't needed anymore and in fact is a problem when
524 it comes to renaming the keyring files on some operating systems,
526 iobuf_close(hd
->current
.iobuf
);
527 hd
->current
.iobuf
= NULL
;
530 rc
= do_copy (3, hd
->found
.kr
->fname
, kb
, hd
->secret
,
531 hd
->found
.offset
, hd
->found
.n_packets
);
533 if (!hd
->secret
&& kr_offtbl
)
535 update_offset_hash_table_from_kb (kr_offtbl
, kb
, 0);
537 /* better reset the found info */
539 hd
->found
.offset
= 0;
545 keyring_insert_keyblock (KEYRING_HANDLE hd
, KBNODE kb
)
552 else if (hd
->found
.kr
)
554 fname
= hd
->found
.kr
->fname
;
555 if (hd
->found
.kr
->readonly
)
556 return gpg_error (GPG_ERR_EACCES
);
558 else if (hd
->current
.kr
)
560 fname
= hd
->current
.kr
->fname
;
561 if (hd
->current
.kr
->readonly
)
562 return gpg_error (GPG_ERR_EACCES
);
565 fname
= hd
->resource
? hd
->resource
->fname
:NULL
;
568 return G10ERR_GENERAL
;
570 /* Close this one otherwise we will lose the position for
571 * a next search. Fixme: it would be better to adjust the position
572 * after the write opertions.
574 iobuf_close (hd
->current
.iobuf
);
575 hd
->current
.iobuf
= NULL
;
578 rc
= do_copy (1, fname
, kb
, hd
->secret
, 0, 0 );
579 if (!rc
&& !hd
->secret
&& kr_offtbl
)
581 update_offset_hash_table_from_kb (kr_offtbl
, kb
, 0);
589 keyring_delete_keyblock (KEYRING_HANDLE hd
)
594 return -1; /* no successful prior search */
596 if (hd
->found
.kr
->readonly
)
597 return gpg_error (GPG_ERR_EACCES
);
599 if (!hd
->found
.n_packets
) {
600 /* need to know the number of packets - do a dummy get_keyblock*/
601 rc
= keyring_get_keyblock (hd
, NULL
);
603 log_error ("re-reading keyblock failed: %s\n", g10_errstr (rc
));
606 if (!hd
->found
.n_packets
)
610 /* close this one otherwise we will lose the position for
611 * a next search. Fixme: it would be better to adjust the position
612 * after the write opertions.
614 iobuf_close (hd
->current
.iobuf
);
615 hd
->current
.iobuf
= NULL
;
618 rc
= do_copy (2, hd
->found
.kr
->fname
, NULL
, hd
->secret
,
619 hd
->found
.offset
, hd
->found
.n_packets
);
621 /* better reset the found info */
623 hd
->found
.offset
= 0;
624 /* Delete is a rare operations, so we don't remove the keys
625 * from the offset table */
633 * Start the next search on this handle right at the beginning
636 keyring_search_reset (KEYRING_HANDLE hd
)
640 hd
->current
.kr
= NULL
;
641 iobuf_close (hd
->current
.iobuf
);
642 hd
->current
.iobuf
= NULL
;
644 hd
->current
.error
= 0;
647 hd
->found
.offset
= 0;
653 prepare_search (KEYRING_HANDLE hd
)
655 if (hd
->current
.error
)
656 return hd
->current
.error
; /* still in error state */
658 if (hd
->current
.kr
&& !hd
->current
.eof
) {
659 if ( !hd
->current
.iobuf
)
660 return G10ERR_GENERAL
; /* position invalid after a modify */
664 if (!hd
->current
.kr
&& hd
->current
.eof
)
665 return -1; /* still EOF */
667 if (!hd
->current
.kr
) { /* start search with first keyring */
668 hd
->current
.kr
= hd
->resource
;
669 if (!hd
->current
.kr
) {
671 return -1; /* keyring not available */
673 assert (!hd
->current
.iobuf
);
676 iobuf_close (hd
->current
.iobuf
);
677 hd
->current
.iobuf
= NULL
;
678 hd
->current
.kr
= NULL
;
684 hd
->current
.iobuf
= iobuf_open (hd
->current
.kr
->fname
);
685 if (!hd
->current
.iobuf
)
687 hd
->current
.error
= gpg_error_from_syserror ();
688 log_error(_("can't open `%s'\n"), hd
->current
.kr
->fname
);
689 return hd
->current
.error
;
696 /* A map of the all characters valid used for word_match()
697 * Valid characters are in in this table converted to uppercase.
698 * because the upper 128 bytes have special meaning, we assume
699 * that they are all valid.
700 * Note: We must use numerical values here in case that this program
701 * will be converted to those little blue HAL9000s with their strange
702 * EBCDIC character set (user ids are UTF-8).
703 * wk 2000-04-13: Hmmm, does this really make sense, given the fact that
704 * we can run gpg now on a S/390 running GNU/Linux, where the code
705 * translation is done by the device drivers?
707 static const byte word_match_chars
[256] = {
708 /* 00 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
709 /* 08 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
710 /* 10 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
711 /* 18 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
712 /* 20 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
713 /* 28 */ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
714 /* 30 */ 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37,
715 /* 38 */ 0x38, 0x39, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
716 /* 40 */ 0x00, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
717 /* 48 */ 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
718 /* 50 */ 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57,
719 /* 58 */ 0x58, 0x59, 0x5a, 0x00, 0x00, 0x00, 0x00, 0x00,
720 /* 60 */ 0x00, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47,
721 /* 68 */ 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f,
722 /* 70 */ 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57,
723 /* 78 */ 0x58, 0x59, 0x5a, 0x00, 0x00, 0x00, 0x00, 0x00,
724 /* 80 */ 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87,
725 /* 88 */ 0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f,
726 /* 90 */ 0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97,
727 /* 98 */ 0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f,
728 /* a0 */ 0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7,
729 /* a8 */ 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf,
730 /* b0 */ 0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7,
731 /* b8 */ 0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf,
732 /* c0 */ 0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7,
733 /* c8 */ 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf,
734 /* d0 */ 0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7,
735 /* d8 */ 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf,
736 /* e0 */ 0xe0, 0xe1, 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7,
737 /* e8 */ 0xe8, 0xe9, 0xea, 0xeb, 0xec, 0xed, 0xee, 0xef,
738 /* f0 */ 0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7,
739 /* f8 */ 0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff
743 * Do a word match (original user id starts with a '+').
744 * The pattern is already tokenized to a more suitable format:
745 * There are only the real words in it delimited by one space
746 * and all converted to uppercase.
748 * Returns: 0 if all words match.
750 * Note: This algorithm is a straightforward one and not very
751 * fast. It works for UTF-8 strings. The uidlen should
752 * be removed but due to the fact that old versions of
753 * pgp don't use UTF-8 we still use the length; this should
754 * be fixed in parse-packet (and replace \0 by some special
758 word_match( const byte
*uid
, size_t uidlen
, const byte
*pattern
)
764 for( s
=pattern
; *s
; ) {
766 /* skip leading delimiters */
767 while( uidlen
&& !word_match_chars
[*uid
] )
769 /* get length of the word */
771 while( n
&& word_match_chars
[*p
] )
774 /* and compare against the current word from pattern */
775 for(n
=0, p
=uid
; n
< wlen
&& s
[n
] != ' ' && s
[n
] ; n
++, p
++ ) {
776 if( word_match_chars
[*p
] != s
[n
] )
779 if( n
== wlen
&& (s
[n
] == ' ' || !s
[n
]) )
785 return -1; /* not found */
787 /* advance to next word in pattern */
788 for(; *s
!= ' ' && *s
; s
++ )
793 return 0; /* found */
797 * prepare word word_match; that is parse the name and
799 * caller has to free the returned pattern
802 prepare_word_match (const byte
*name
)
807 /* the original length is always enough for the pattern */
808 p
= pattern
= xmalloc(strlen(name
)+1);
810 /* skip leading delimiters */
811 while( *name
&& !word_match_chars
[*name
] )
813 /* copy as long as we don't have a delimiter and convert
815 * fixme: how can we handle utf8 uppercasing */
816 for( ; *name
&& (c
=word_match_chars
[*name
]); name
++ )
818 *p
++ = ' '; /* append pattern delimiter */
820 p
[-1] = 0; /* replace last pattern delimiter by EOS */
829 compare_name (int mode
, const char *name
, const char *uid
, size_t uidlen
)
834 if (mode
== KEYDB_SEARCH_MODE_EXACT
) {
835 for (i
=0; name
[i
] && uidlen
; i
++, uidlen
--)
836 if (uid
[i
] != name
[i
])
838 if (!uidlen
&& !name
[i
])
839 return 0; /* found */
841 else if (mode
== KEYDB_SEARCH_MODE_SUBSTR
) {
842 if (ascii_memistr( uid
, uidlen
, name
))
845 else if ( mode
== KEYDB_SEARCH_MODE_MAIL
846 || mode
== KEYDB_SEARCH_MODE_MAILSUB
847 || mode
== KEYDB_SEARCH_MODE_MAILEND
) {
848 for (i
=0, s
= uid
; i
< uidlen
&& *s
!= '<'; s
++, i
++)
851 /* skip opening delim and one char and look for the closing one*/
853 for (se
=s
+1, i
++; i
< uidlen
&& *se
!= '>'; se
++, i
++)
857 if (mode
== KEYDB_SEARCH_MODE_MAIL
) {
858 if( strlen(name
)-2 == i
859 && !ascii_memcasecmp( s
, name
+1, i
) )
862 else if (mode
== KEYDB_SEARCH_MODE_MAILSUB
) {
863 if( ascii_memistr( s
, i
, name
) )
866 else { /* email from end */
872 else if (mode
== KEYDB_SEARCH_MODE_WORDS
)
873 return word_match (uid
, uidlen
, name
);
877 return -1; /* not found */
882 * Search through the keyring(s), starting at the current position,
883 * for a keyblock which contains one of the keys described in the DESC array.
886 keyring_search (KEYRING_HANDLE hd
, KEYDB_SEARCH_DESC
*desc
,
887 size_t ndesc
, size_t *descindex
)
892 off_t offset
, main_offset
;
894 int need_uid
, need_words
, need_keyid
, need_fpr
, any_skip
;
898 PKT_user_id
*uid
= NULL
;
899 PKT_public_key
*pk
= NULL
;
900 PKT_secret_key
*sk
= NULL
;
903 /* figure out what information we need */
904 need_uid
= need_words
= need_keyid
= need_fpr
= any_skip
= 0;
905 for (n
=0; n
< ndesc
; n
++)
907 switch (desc
[n
].mode
)
909 case KEYDB_SEARCH_MODE_EXACT
:
910 case KEYDB_SEARCH_MODE_SUBSTR
:
911 case KEYDB_SEARCH_MODE_MAIL
:
912 case KEYDB_SEARCH_MODE_MAILSUB
:
913 case KEYDB_SEARCH_MODE_MAILEND
:
916 case KEYDB_SEARCH_MODE_WORDS
:
920 case KEYDB_SEARCH_MODE_SHORT_KID
:
921 case KEYDB_SEARCH_MODE_LONG_KID
:
924 case KEYDB_SEARCH_MODE_FPR16
:
925 case KEYDB_SEARCH_MODE_FPR20
:
926 case KEYDB_SEARCH_MODE_FPR
:
929 case KEYDB_SEARCH_MODE_FIRST
:
930 /* always restart the search in this mode */
931 keyring_search_reset (hd
);
942 rc
= prepare_search (hd
);
946 use_offtbl
= !hd
->secret
&& kr_offtbl
;
949 else if (!kr_offtbl_ready
)
951 else if (ndesc
== 1 && desc
[0].mode
== KEYDB_SEARCH_MODE_LONG_KID
)
955 oi
= lookup_offset_hash_table (kr_offtbl
, desc
[0].u
.kid
);
957 { /* We know that we don't have this key */
962 /* We could now create a positive search status and return.
963 * However the problem is that another instance of gpg may
964 * have changed the keyring so that the offsets are not valid
965 * anymore - therefore we don't do it
971 const char *name
= NULL
;
973 log_debug ("word search mode does not yet work\n");
974 /* FIXME: here is a long standing bug in our function and in addition we
975 just use the first search description */
976 for (n
=0; n
< ndesc
&& !name
; n
++)
978 if (desc
[n
].mode
== KEYDB_SEARCH_MODE_WORDS
)
979 name
= desc
[n
].u
.name
;
982 if ( !hd
->word_match
.name
|| strcmp (hd
->word_match
.name
, name
) )
985 xfree (hd
->word_match
.name
);
986 xfree (hd
->word_match
.pattern
);
987 hd
->word_match
.name
= xstrdup (name
);
988 hd
->word_match
.pattern
= prepare_word_match (name
);
990 name
= hd
->word_match
.pattern
;
994 save_mode
= set_packet_list_mode(0);
999 initial_skip
= 1; /* skip until we see the start of a keyblock */
1000 while (!(rc
=search_packet (hd
->current
.iobuf
, &pkt
, &offset
, need_uid
)))
1002 byte afp
[MAX_FINGERPRINT_LEN
];
1005 if (pkt
.pkttype
== PKT_PUBLIC_KEY
|| pkt
.pkttype
== PKT_SECRET_KEY
)
1007 main_offset
= offset
;
1020 if ( pkt
.pkttype
== PKT_PUBLIC_KEY
1021 || pkt
.pkttype
== PKT_PUBLIC_SUBKEY
)
1023 pk
= pkt
.pkt
.public_key
;
1027 fingerprint_from_pk (pk
, afp
, &an
);
1028 while (an
< 20) /* fill up to 20 bytes */
1032 keyid_from_pk (pk
, aki
);
1034 if (use_offtbl
&& !kr_offtbl_ready
)
1035 update_offset_hash_table (kr_offtbl
, aki
, main_offset
);
1037 else if (pkt
.pkttype
== PKT_USER_ID
)
1039 uid
= pkt
.pkt
.user_id
;
1042 else if ( pkt
.pkttype
== PKT_SECRET_KEY
1043 || pkt
.pkttype
== PKT_SECRET_SUBKEY
)
1045 sk
= pkt
.pkt
.secret_key
;
1049 fingerprint_from_sk (sk
, afp
, &an
);
1050 while (an
< 20) /* fill up to 20 bytes */
1054 keyid_from_sk (sk
, aki
);
1058 for (n
=0; n
< ndesc
; n
++)
1060 switch (desc
[n
].mode
) {
1061 case KEYDB_SEARCH_MODE_NONE
:
1064 case KEYDB_SEARCH_MODE_EXACT
:
1065 case KEYDB_SEARCH_MODE_SUBSTR
:
1066 case KEYDB_SEARCH_MODE_MAIL
:
1067 case KEYDB_SEARCH_MODE_MAILSUB
:
1068 case KEYDB_SEARCH_MODE_MAILEND
:
1069 case KEYDB_SEARCH_MODE_WORDS
:
1070 if ( uid
&& !compare_name (desc
[n
].mode
,
1072 uid
->name
, uid
->len
))
1076 case KEYDB_SEARCH_MODE_SHORT_KID
:
1077 if ((pk
||sk
) && desc
[n
].u
.kid
[1] == aki
[1])
1080 case KEYDB_SEARCH_MODE_LONG_KID
:
1081 if ((pk
||sk
) && desc
[n
].u
.kid
[0] == aki
[0]
1082 && desc
[n
].u
.kid
[1] == aki
[1])
1085 case KEYDB_SEARCH_MODE_FPR16
:
1086 if ((pk
||sk
) && !memcmp (desc
[n
].u
.fpr
, afp
, 16))
1089 case KEYDB_SEARCH_MODE_FPR20
:
1090 case KEYDB_SEARCH_MODE_FPR
:
1091 if ((pk
||sk
) && !memcmp (desc
[n
].u
.fpr
, afp
, 20))
1094 case KEYDB_SEARCH_MODE_FIRST
:
1098 case KEYDB_SEARCH_MODE_NEXT
:
1103 rc
= G10ERR_INV_ARG
;
1110 /* Record which desc we matched on. Note this value is only
1111 meaningful if this function returns with no errors. */
1114 for (n
=any_skip
?0:ndesc
; n
< ndesc
; n
++)
1117 && desc
[n
].skipfnc (desc
[n
].skipfncvalue
, aki
, uid
))
1127 hd
->found
.offset
= main_offset
;
1128 hd
->found
.kr
= hd
->current
.kr
;
1129 hd
->found
.pk_no
= (pk
||sk
)? pk_no
: 0;
1130 hd
->found
.uid_no
= uid
? uid_no
: 0;
1134 hd
->current
.eof
= 1;
1135 /* if we scanned all keyrings, we are sure that
1136 * all known key IDs are in our offtbl, mark that. */
1137 if (use_offtbl
&& !kr_offtbl_ready
)
1141 /* First set the did_full_scan flag for this keyring (ignore
1143 for (kr
=kr_names
; kr
; kr
= kr
->next
)
1145 if (!kr
->secret
&& hd
->resource
== kr
)
1147 kr
->did_full_scan
= 1;
1151 /* Then check whether all flags are set and if so, mark the
1153 for (kr
=kr_names
; kr
; kr
= kr
->next
)
1155 if (!kr
->secret
&& !kr
->did_full_scan
)
1159 kr_offtbl_ready
= 1;
1163 hd
->current
.error
= rc
;
1166 set_packet_list_mode(save_mode
);
1172 create_tmp_file (const char *template,
1173 char **r_bakfname
, char **r_tmpfname
, IOBUF
*r_fp
)
1175 char *bakfname
, *tmpfname
;
1181 # ifdef USE_ONLY_8DOT3
1182 /* Here is another Windoze bug?:
1183 * you cant rename("pubring.gpg.tmp", "pubring.gpg");
1184 * but rename("pubring.gpg.tmp", "pubring.aaa");
1185 * works. So we replace .gpg by .bak or .tmp
1187 if (strlen (template) > 4
1188 && !strcmp (template+strlen(template)-4, EXTSEP_S
"gpg") )
1190 bakfname
= xmalloc (strlen (template) + 1);
1191 strcpy (bakfname
, template);
1192 strcpy (bakfname
+strlen(template)-4, EXTSEP_S
"bak");
1194 tmpfname
= xmalloc (strlen( template ) + 1 );
1195 strcpy (tmpfname
,template);
1196 strcpy (tmpfname
+strlen(template)-4, EXTSEP_S
"tmp");
1199 { /* file does not end with gpg; hmmm */
1200 bakfname
= xmalloc (strlen( template ) + 5);
1201 strcpy (stpcpy(bakfname
, template), EXTSEP_S
"bak");
1203 tmpfname
= xmalloc (strlen( template ) + 5);
1204 strcpy (stpcpy(tmpfname
, template), EXTSEP_S
"tmp");
1206 # else /* Posix file names */
1207 bakfname
= xmalloc (strlen( template ) + 2);
1208 strcpy (stpcpy (bakfname
,template),"~");
1210 tmpfname
= xmalloc (strlen( template ) + 5);
1211 strcpy (stpcpy(tmpfname
,template), EXTSEP_S
"tmp");
1212 # endif /* Posix filename */
1214 /* Create the temp file with limited access */
1216 if (is_secured_filename (tmpfname
))
1222 *r_fp
= iobuf_create (tmpfname
);
1226 int rc
= gpg_error_from_syserror ();
1227 log_error(_("can't create `%s': %s\n"), tmpfname
, strerror(errno
) );
1233 *r_bakfname
= bakfname
;
1234 *r_tmpfname
= tmpfname
;
1240 rename_tmp_file (const char *bakfname
, const char *tmpfname
,
1241 const char *fname
, int secret
)
1245 /* It's a secret keyring, so let's force a fsync just to be safe on
1246 filesystems that may not sync data and metadata together
1248 if (secret
&& iobuf_ioctl (NULL
, 4, 0, (char*)tmpfname
))
1250 rc
= gpg_error_from_syserror ();
1254 /* Invalidate close caches. */
1255 if (iobuf_ioctl (NULL
, 2, 0, (char*)tmpfname
))
1257 rc
= gpg_error_from_syserror ();
1260 iobuf_ioctl (NULL
, 2, 0, (char*)bakfname
);
1261 iobuf_ioctl (NULL
, 2, 0, (char*)fname
);
1263 /* first make a backup file except for secret keyrings */
1266 #if defined(HAVE_DOSISH_SYSTEM) || defined(__riscos__)
1269 if (rename (fname
, bakfname
) )
1271 rc
= gpg_error_from_syserror ();
1272 log_error ("renaming `%s' to `%s' failed: %s\n",
1273 fname
, bakfname
, strerror(errno
) );
1278 /* then rename the file */
1279 #if defined(HAVE_DOSISH_SYSTEM) || defined(__riscos__)
1283 unregister_secured_file (fname
);
1284 if (rename (tmpfname
, fname
) )
1286 rc
= gpg_error_from_syserror ();
1287 log_error (_("renaming `%s' to `%s' failed: %s\n"),
1288 tmpfname
, fname
, strerror(errno
) );
1289 register_secured_file (fname
);
1293 /* Now make sure the file has the same permissions as the original */
1295 #ifndef HAVE_DOSISH_SYSTEM
1297 struct stat statbuf
;
1299 statbuf
.st_mode
=S_IRUSR
| S_IWUSR
;
1301 if (((secret
&& !opt
.preserve_permissions
)
1302 || !stat (bakfname
,&statbuf
))
1303 && !chmod (fname
,statbuf
.st_mode
))
1306 log_error ("WARNING: unable to restore permissions to `%s': %s",
1307 fname
, strerror(errno
));
1316 log_info(_("WARNING: 2 files with confidential information exists.\n"));
1317 log_info(_("%s is the unchanged one\n"), fname
);
1318 log_info(_("%s is the new one\n"), tmpfname
);
1319 log_info(_("Please fix this possible security flaw\n"));
1326 write_keyblock (IOBUF fp
, KBNODE keyblock
)
1328 KBNODE kbctx
= NULL
, node
;
1331 while ( (node
= walk_kbnode (keyblock
, &kbctx
, 0)) )
1333 if (node
->pkt
->pkttype
== PKT_RING_TRUST
)
1334 continue; /* we write it later on our own */
1336 if ( (rc
= build_packet (fp
, node
->pkt
) ))
1338 log_error ("build_packet(%d) failed: %s\n",
1339 node
->pkt
->pkttype
, g10_errstr(rc
) );
1342 if (node
->pkt
->pkttype
== PKT_SIGNATURE
)
1343 { /* always write a signature cache packet */
1344 PKT_signature
*sig
= node
->pkt
->pkt
.signature
;
1345 unsigned int cacheval
= 0;
1347 if (sig
->flags
.checked
)
1350 if (sig
->flags
.valid
)
1353 iobuf_put (fp
, 0xb0); /* old style packet 12, 1 byte len*/
1354 iobuf_put (fp
, 2); /* 2 bytes */
1355 iobuf_put (fp
, 0); /* unused */
1356 if (iobuf_put (fp
, cacheval
))
1358 rc
= gpg_error_from_syserror ();
1359 log_error ("writing sigcache packet failed\n");
1368 * Walk over all public keyrings, check the signatures and replace the
1369 * keyring with a new one where the signature cache is then updated.
1370 * This is only done for the public keyrings.
1373 keyring_rebuild_cache (void *token
,int noisy
)
1376 KEYDB_SEARCH_DESC desc
;
1377 KBNODE keyblock
= NULL
, node
;
1378 const char *lastresname
= NULL
, *resname
;
1380 char *tmpfilename
= NULL
;
1381 char *bakfilename
= NULL
;
1383 ulong count
= 0, sigcount
= 0;
1385 hd
= keyring_new (token
, 0);
1386 memset (&desc
, 0, sizeof desc
);
1387 desc
.mode
= KEYDB_SEARCH_MODE_FIRST
;
1389 rc
=keyring_lock (hd
, 1);
1393 while ( !(rc
= keyring_search (hd
, &desc
, 1, NULL
)) )
1395 desc
.mode
= KEYDB_SEARCH_MODE_NEXT
;
1396 resname
= keyring_get_resource_name (hd
);
1397 if (lastresname
!= resname
)
1398 { /* we have switched to a new keyring - commit changes */
1401 if (iobuf_close (tmpfp
))
1403 rc
= gpg_error_from_syserror ();
1404 log_error ("error closing `%s': %s\n",
1405 tmpfilename
, strerror (errno
));
1408 /* because we have switched resources, we can be sure that
1409 * the original file is closed */
1412 rc
= lastresname
? rename_tmp_file (bakfilename
, tmpfilename
,
1413 lastresname
, 0) : 0;
1414 xfree (tmpfilename
); tmpfilename
= NULL
;
1415 xfree (bakfilename
); bakfilename
= NULL
;
1418 lastresname
= resname
;
1419 if (noisy
&& !opt
.quiet
)
1420 log_info (_("caching keyring `%s'\n"), resname
);
1421 rc
= create_tmp_file (resname
, &bakfilename
, &tmpfilename
, &tmpfp
);
1426 release_kbnode (keyblock
);
1427 rc
= keyring_get_keyblock (hd
, &keyblock
);
1430 log_error ("keyring_get_keyblock failed: %s\n", g10_errstr(rc
));
1433 assert (keyblock
->pkt
->pkttype
== PKT_PUBLIC_KEY
);
1435 /* check all signature to set the signature's cache flags */
1436 for (node
=keyblock
; node
; node
=node
->next
)
1438 /* Note that this doesn't cache the result of a revocation
1439 issued by a designated revoker. This is because the pk
1440 in question does not carry the revkeys as we haven't
1441 merged the key and selfsigs. It is questionable whether
1442 this matters very much since there are very very few
1443 designated revoker revocation packets out there. */
1445 if (node
->pkt
->pkttype
== PKT_SIGNATURE
)
1447 PKT_signature
*sig
=node
->pkt
->pkt
.signature
;
1449 if(!opt
.no_sig_cache
&& sig
->flags
.checked
&& sig
->flags
.valid
1450 && (openpgp_md_test_algo(sig
->digest_algo
)
1451 || openpgp_pk_test_algo(sig
->pubkey_algo
)))
1452 sig
->flags
.checked
=sig
->flags
.valid
=0;
1454 check_key_signature (keyblock
, node
, NULL
);
1460 /* write the keyblock to the temporary file */
1461 rc
= write_keyblock (tmpfp
, keyblock
);
1465 if ( !(++count
% 50) && noisy
&& !opt
.quiet
)
1466 log_info(_("%lu keys cached so far (%lu signatures)\n"),
1469 } /* end main loop */
1474 log_error ("keyring_search failed: %s\n", g10_errstr(rc
));
1477 if(noisy
|| opt
.verbose
)
1478 log_info(_("%lu keys cached (%lu signatures)\n"), count
, sigcount
);
1481 if (iobuf_close (tmpfp
))
1483 rc
= gpg_error_from_syserror ();
1484 log_error ("error closing `%s': %s\n",
1485 tmpfilename
, strerror (errno
));
1488 /* because we have switched resources, we can be sure that
1489 * the original file is closed */
1492 rc
= lastresname
? rename_tmp_file (bakfilename
, tmpfilename
,
1493 lastresname
, 0) : 0;
1494 xfree (tmpfilename
); tmpfilename
= NULL
;
1495 xfree (bakfilename
); bakfilename
= NULL
;
1499 iobuf_cancel (tmpfp
);
1500 xfree (tmpfilename
);
1501 xfree (bakfilename
);
1502 release_kbnode (keyblock
);
1503 keyring_lock (hd
, 0);
1504 keyring_release (hd
);
1510 * Perform insert/delete/update operation.
1516 do_copy (int mode
, const char *fname
, KBNODE root
, int secret
,
1517 off_t start_offset
, unsigned int n_packets
)
1521 char *bakfname
= NULL
;
1522 char *tmpfname
= NULL
;
1524 /* Open the source file. Because we do a rename, we have to check the
1525 permissions of the file */
1526 if (access (fname
, W_OK
))
1527 return gpg_error_from_syserror ();
1529 fp
= iobuf_open (fname
);
1530 if (mode
== 1 && !fp
&& errno
== ENOENT
) {
1531 /* insert mode but file does not exist: create a new file */
1536 if (!secret
&& is_secured_filename (fname
)) {
1541 newfp
= iobuf_create (fname
);
1545 rc
= gpg_error_from_syserror ();
1546 log_error (_("can't create `%s': %s\n"), fname
, strerror(errno
));
1550 log_info(_("%s: keyring created\n"), fname
);
1553 while ( (node
= walk_kbnode( root
, &kbctx
, 0 )) ) {
1554 if( (rc
= build_packet( newfp
, node
->pkt
)) ) {
1555 log_error("build_packet(%d) failed: %s\n",
1556 node
->pkt
->pkttype
, g10_errstr(rc
) );
1557 iobuf_cancel(newfp
);
1561 if( iobuf_close(newfp
) ) {
1562 rc
= gpg_error_from_syserror ();
1563 log_error ("%s: close failed: %s\n", fname
, strerror(errno
));
1566 return 0; /* ready */
1571 rc
= gpg_error_from_syserror ();
1572 log_error(_("can't open `%s': %s\n"), fname
, strerror(errno
) );
1576 /* Create the new file. */
1577 rc
= create_tmp_file (fname
, &bakfname
, &tmpfname
, &newfp
);
1583 register_secured_file (tmpfname
);
1585 if( mode
== 1 ) { /* insert */
1586 /* copy everything to the new file */
1587 rc
= copy_all_packets (fp
, newfp
);
1589 log_error("%s: copy to `%s' failed: %s\n",
1590 fname
, tmpfname
, g10_errstr(rc
) );
1593 unregister_secured_file (tmpfname
);
1594 iobuf_cancel(newfp
);
1600 if( mode
== 2 || mode
== 3 ) { /* delete or update */
1601 /* copy first part to the new file */
1602 rc
= copy_some_packets( fp
, newfp
, start_offset
);
1603 if( rc
) { /* should never get EOF here */
1604 log_error ("%s: copy to `%s' failed: %s\n",
1605 fname
, tmpfname
, g10_errstr(rc
) );
1608 unregister_secured_file (tmpfname
);
1609 iobuf_cancel(newfp
);
1612 /* skip this keyblock */
1613 assert( n_packets
);
1614 rc
= skip_some_packets( fp
, n_packets
);
1616 log_error("%s: skipping %u packets failed: %s\n",
1617 fname
, n_packets
, g10_errstr(rc
));
1620 unregister_secured_file (tmpfname
);
1621 iobuf_cancel(newfp
);
1626 if( mode
== 1 || mode
== 3 ) { /* insert or update */
1627 rc
= write_keyblock (newfp
, root
);
1631 unregister_secured_file (tmpfname
);
1632 iobuf_cancel(newfp
);
1637 if( mode
== 2 || mode
== 3 ) { /* delete or update */
1639 rc
= copy_all_packets( fp
, newfp
);
1641 log_error("%s: copy to `%s' failed: %s\n",
1642 fname
, tmpfname
, g10_errstr(rc
) );
1645 unregister_secured_file (tmpfname
);
1646 iobuf_cancel(newfp
);
1652 /* close both files */
1653 if( iobuf_close(fp
) ) {
1654 rc
= gpg_error_from_syserror ();
1655 log_error("%s: close failed: %s\n", fname
, strerror(errno
) );
1658 if( iobuf_close(newfp
) ) {
1659 rc
= gpg_error_from_syserror ();
1660 log_error("%s: close failed: %s\n", tmpfname
, strerror(errno
) );
1664 rc
= rename_tmp_file (bakfname
, tmpfname
, fname
, secret
);