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