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