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