* keydb.h, getkey.c (classify_user_id, classify_user_id2): Make 'exact' a
[gnupg.git] / g10 / export.c
1 /* export.c
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
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 2 of the License, or
9  * (at your option) any later version.
10  *
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.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <assert.h>
27
28 #include "options.h"
29 #include "packet.h"
30 #include "errors.h"
31 #include "keydb.h"
32 #include "memory.h"
33 #include "util.h"
34 #include "main.h"
35 #include "i18n.h"
36
37 static int do_export( STRLIST users, int secret, unsigned int options );
38 static int do_export_stream( IOBUF out, STRLIST users,
39                              int secret, unsigned int options, int *any );
40
41 int
42 parse_export_options(char *str,unsigned int *options)
43 {
44   char *tok;
45   int hit=0;
46   struct
47   {
48     char *name;
49     unsigned int bit;
50   } export_opts[]=
51     {
52       {"include-non-rfc",EXPORT_INCLUDE_NON_RFC},
53       {"include-local-sigs",EXPORT_INCLUDE_LOCAL_SIGS},
54       {"include-attributes",EXPORT_INCLUDE_ATTRIBUTES},
55       {"include-sensitive-revkeys",EXPORT_INCLUDE_SENSITIVE_REVKEYS},
56       {NULL,0}
57       /* add tags for include revoked and disabled? */
58     };
59
60   while((tok=strsep(&str," ,")))
61     {
62       int i,rev=0;
63
64       if(ascii_strncasecmp("no-",tok,3)==0)
65         {
66           rev=1;
67           tok+=3;
68         }
69
70       for(i=0;export_opts[i].name;i++)
71         {
72           if(ascii_strcasecmp(export_opts[i].name,tok)==0)
73             {
74               if(rev)
75                 *options&=~export_opts[i].bit;
76               else
77                 *options|=export_opts[i].bit;
78               hit=1;
79               break;
80             }
81         }
82
83       if(!hit && !export_opts[i].name)
84         return 0;
85     }
86
87   return hit;
88 }
89
90 /****************
91  * Export the public keys (to standard out or --output).
92  * Depending on opt.armor the output is armored.
93  * options are defined in main.h.
94  * If USERS is NULL, the complete ring will be exported.  */
95 int
96 export_pubkeys( STRLIST users, unsigned int options )
97 {
98     return do_export( users, 0, options );
99 }
100
101 /****************
102  * Export to an already opened stream; return -1 if no keys have
103  * been exported
104  */
105 int
106 export_pubkeys_stream( IOBUF out, STRLIST users, unsigned int options )
107 {
108     int any, rc;
109
110     rc = do_export_stream( out, users, 0, options, &any );
111     if( !rc && !any )
112         rc = -1;
113     return rc;
114 }
115
116 int
117 export_seckeys( STRLIST users )
118 {
119     return do_export( users, 1, 0 );
120 }
121
122 int
123 export_secsubkeys( STRLIST users )
124 {
125     return do_export( users, 2, 0 );
126 }
127
128 static int
129 do_export( STRLIST users, int secret, unsigned int options )
130 {
131     IOBUF out = NULL;
132     int any, rc;
133     armor_filter_context_t afx;
134     compress_filter_context_t zfx;
135
136     memset( &afx, 0, sizeof afx);
137     memset( &zfx, 0, sizeof zfx);
138
139     rc = open_outfile( NULL, 0, &out );
140     if( rc )
141         return rc;
142
143     if( opt.armor ) {
144         afx.what = secret?5:1;
145         iobuf_push_filter( out, armor_filter, &afx );
146     }
147     if( opt.compress_keys && opt.compress )
148         iobuf_push_filter( out, compress_filter, &zfx );
149     rc = do_export_stream( out, users, secret, options, &any );
150
151     if( rc || !any )
152         iobuf_cancel(out);
153     else
154         iobuf_close(out);
155     return rc;
156 }
157
158
159 static int
160 do_export_stream( IOBUF out, STRLIST users, int secret,
161                   unsigned int options, int *any )
162 {
163     int rc = 0;
164     PACKET pkt;
165     KBNODE keyblock = NULL;
166     KBNODE kbctx, node;
167     size_t ndesc, descindex;
168     KEYDB_SEARCH_DESC *desc = NULL;
169     KEYDB_HANDLE kdbhd;
170     STRLIST sl;
171
172     *any = 0;
173     init_packet( &pkt );
174     kdbhd = keydb_new (secret);
175
176     if (!users) {
177         ndesc = 1;
178         desc = m_alloc_clear ( ndesc * sizeof *desc);
179         desc[0].mode = KEYDB_SEARCH_MODE_FIRST;
180     }
181     else {
182         for (ndesc=0, sl=users; sl; sl = sl->next, ndesc++) 
183             ;
184         desc = m_alloc ( ndesc * sizeof *desc);
185         
186         for (ndesc=0, sl=users; sl; sl = sl->next) {
187             if (classify_user_id (sl->d, desc+ndesc))
188                 ndesc++;
189             else
190                 log_error (_("key `%s' not found: %s\n"),
191                            sl->d, g10_errstr (G10ERR_INV_USER_ID));
192         }
193
194         /* it would be nice to see which of the given users did
195            actually match one in the keyring.  To implement this we
196            need to have a found flag for each entry in desc and to set
197            this we must check all those entries after a match to mark
198            all matched one - currently we stop at the first match.  To
199            do this we need an extra flag to enable this feature so */
200     }
201
202     while (!(rc = keydb_search2 (kdbhd, desc, ndesc, &descindex))) {
203         int sha1_warned=0,skip_until_subkey=0;
204         u32 sk_keyid[2];
205
206         if (!users) 
207             desc[0].mode = KEYDB_SEARCH_MODE_NEXT;
208
209         /* read the keyblock */
210         rc = keydb_get_keyblock (kdbhd, &keyblock );
211         if( rc ) {
212             log_error (_("error reading keyblock: %s\n"), g10_errstr(rc) );
213             goto leave;
214         }
215
216         /* do not export keys which are incompatible with rfc2440 */
217         if( !(options&EXPORT_INCLUDE_NON_RFC) &&
218             (node = find_kbnode( keyblock, PKT_PUBLIC_KEY )) ) {
219             PKT_public_key *pk = node->pkt->pkt.public_key;
220             if( pk->version == 3 && pk->pubkey_algo > 3 ) {
221                 log_info(_("key %08lX: not a rfc2440 key - skipped\n"),
222                               (ulong)keyid_from_pk( pk, NULL) );
223                 continue;
224             }
225         }
226
227         node=find_kbnode( keyblock, PKT_SECRET_KEY );
228         if(node)
229           {
230             PKT_secret_key *sk=node->pkt->pkt.secret_key;
231
232             keyid_from_sk(sk,sk_keyid);
233
234             /* we can't apply GNU mode 1001 on an unprotected key */
235             if( secret == 2 && !sk->is_protected )
236               {
237                 log_info(_("key %08lX: not protected - skipped\n"),
238                          (ulong)sk_keyid[1]);
239                 continue;
240               }
241
242             /* no v3 keys with GNU mode 1001 */
243             if( secret == 2 && sk->version == 3 )
244               {
245                 log_info(_("key %08lX: PGP 2.x style key - skipped\n"),
246                          (ulong)sk_keyid[1]);
247                 continue;
248               }
249           }
250
251         /* and write it */
252         for( kbctx=NULL; (node = walk_kbnode( keyblock, &kbctx, 0 )); ) {
253             if( skip_until_subkey )
254               {
255                 if(node->pkt->pkttype==PKT_PUBLIC_SUBKEY
256                    || node->pkt->pkttype==PKT_SECRET_SUBKEY)
257                   skip_until_subkey=0;
258                 else
259                   continue;
260               }
261
262             /* don't export any comment packets but those in the
263              * secret keyring */
264             if( !secret && node->pkt->pkttype == PKT_COMMENT )
265                 continue;
266
267             /* make sure that ring_trust packets never get exported */
268             if (node->pkt->pkttype == PKT_RING_TRUST)
269               continue;
270
271             /* If exact is set, then we only export what was requested
272                (plus the primary key, if the user didn't specifically
273                request it) */
274             if(desc[descindex].exact
275                && (node->pkt->pkttype==PKT_PUBLIC_SUBKEY
276                    || node->pkt->pkttype==PKT_SECRET_SUBKEY))
277               {
278                 u32 kid[2];
279                 byte fpr[MAX_FINGERPRINT_LEN];
280                 size_t fprlen;
281
282                 switch(desc[descindex].mode)
283                   {
284                   case KEYDB_SEARCH_MODE_SHORT_KID:
285                   case KEYDB_SEARCH_MODE_LONG_KID:
286                     if(node->pkt->pkttype==PKT_PUBLIC_SUBKEY)
287                       keyid_from_pk(node->pkt->pkt.public_key,kid);
288                     else
289                       keyid_from_sk(node->pkt->pkt.secret_key,kid);
290                     break;
291
292                   case KEYDB_SEARCH_MODE_FPR16:
293                   case KEYDB_SEARCH_MODE_FPR20:
294                   case KEYDB_SEARCH_MODE_FPR:
295                     if(node->pkt->pkttype==PKT_PUBLIC_SUBKEY)
296                       fingerprint_from_pk(node->pkt->pkt.public_key,
297                                           fpr,&fprlen);
298                     else
299                       fingerprint_from_sk(node->pkt->pkt.secret_key,
300                                           fpr,&fprlen);
301                     break;
302
303                   default:
304                     break;
305                   }
306
307                 switch(desc[descindex].mode)
308                   {
309                   case KEYDB_SEARCH_MODE_SHORT_KID:
310                     if (desc[descindex].u.kid[1] != kid[1])
311                       skip_until_subkey=1;
312                     break;
313                   case KEYDB_SEARCH_MODE_LONG_KID:
314                     if (desc[descindex].u.kid[0] != kid[0]
315                         || desc[descindex].u.kid[1] != kid[1])
316                       skip_until_subkey=1;
317                     break;
318                   case KEYDB_SEARCH_MODE_FPR16:
319                     if (memcmp (desc[descindex].u.fpr, fpr, 16))
320                       skip_until_subkey=1;
321                     break;
322                   case KEYDB_SEARCH_MODE_FPR20:
323                   case KEYDB_SEARCH_MODE_FPR:
324                     if (memcmp (desc[descindex].u.fpr, fpr, 20))
325                       skip_until_subkey=1;
326                     break;
327                   default:
328                     break;
329                   }
330
331                 if(skip_until_subkey)
332                   continue;
333               }
334
335             if( node->pkt->pkttype == PKT_SIGNATURE ) {
336               /* do not export packets which are marked as not exportable */
337               if( !(options&EXPORT_INCLUDE_LOCAL_SIGS) &&
338                   !node->pkt->pkt.signature->flags.exportable )
339                 continue; /* not exportable */
340
341               /* Do not export packets with a "sensitive" revocation
342                  key unless the user wants us to.  Note that we do
343                  export these when issuing the actual revocation (see
344                  revoke.c). */
345               if( !(options&EXPORT_INCLUDE_SENSITIVE_REVKEYS) &&
346                   node->pkt->pkt.signature->revkey ) {
347                 int i;
348
349                 for(i=0;i<node->pkt->pkt.signature->numrevkeys;i++)
350                   if(node->pkt->pkt.signature->revkey[i]->class & 0x40)
351                     break;
352
353                 if(i<node->pkt->pkt.signature->numrevkeys)
354                   continue;
355               }
356
357               /* delete our verification cache */
358               delete_sig_subpkt (node->pkt->pkt.signature->unhashed,
359                                  SIGSUBPKT_PRIV_VERIFY_CACHE);
360             }
361
362             /* Don't export attribs? */
363             if( !(options&EXPORT_INCLUDE_ATTRIBUTES) &&
364                 node->pkt->pkttype == PKT_USER_ID &&
365                 node->pkt->pkt.user_id->attrib_data ) {
366               /* Skip until we get to something that is not an attrib
367                  or a signature on an attrib */
368               while(kbctx->next && kbctx->next->pkt->pkttype==PKT_SIGNATURE) {
369                 kbctx=kbctx->next;
370               }
371  
372               continue;
373             }
374
375             if( secret == 2 && node->pkt->pkttype == PKT_SECRET_KEY ) {
376                 /* we don't want to export the secret parts of the
377                  * primary key, this is done by using GNU protection mode 1001
378                  */
379                 int save_mode = node->pkt->pkt.secret_key->protect.s2k.mode;
380                 node->pkt->pkt.secret_key->protect.s2k.mode = 1001;
381                 rc = build_packet( out, node->pkt );
382                 node->pkt->pkt.secret_key->protect.s2k.mode = save_mode;
383             }
384             else {
385               /* Warn the user if the secret key or any of the secret
386                  subkeys are protected with SHA1 and we have
387                  simple_sk_checksum set. */
388               if(!sha1_warned && opt.simple_sk_checksum &&
389                  (node->pkt->pkttype==PKT_SECRET_KEY ||
390                   node->pkt->pkttype==PKT_SECRET_SUBKEY) &&
391                  node->pkt->pkt.secret_key->protect.sha1chk)
392                 {
393                   /* I hope this warning doesn't confuse people. */
394                   log_info("WARNING: secret key %08lX does not have a "
395                            "simple SK checksum\n",(ulong)sk_keyid[1]);
396
397                   sha1_warned=1;
398                 }
399
400                 rc = build_packet( out, node->pkt );
401             }
402
403             if( rc ) {
404                 log_error("build_packet(%d) failed: %s\n",
405                             node->pkt->pkttype, g10_errstr(rc) );
406                 rc = G10ERR_WRITE_FILE;
407                 goto leave;
408             }
409         }
410         ++*any;
411     }
412     if( rc == -1 )
413         rc = 0;
414
415   leave:
416     m_free(desc);
417     keydb_release (kdbhd);
418     release_kbnode( keyblock );
419     if( !*any )
420         log_info(_("WARNING: nothing exported\n"));
421     return rc;
422 }
423