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