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