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