* options.h, main.h, g10.c (main), import.c (parse_import_options,
[gnupg.git] / g10 / export.c
1 /* export.c
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <assert.h>
27
28 #include "options.h"
29 #include "packet.h"
30 #include "errors.h"
31 #include "keydb.h"
32 #include "memory.h"
33 #include "util.h"
34 #include "main.h"
35 #include "i18n.h"
36
37 static int do_export( STRLIST users, int secret, unsigned int options );
38 static int do_export_stream( IOBUF out, STRLIST users,
39                              int secret, unsigned int options, int *any );
40
41 int
42 parse_export_options(char *str,unsigned int *options)
43 {
44   char *tok;
45   int hit=0;
46   struct
47   {
48     char *name;
49     unsigned int bit;
50   } export_opts[]=
51     {
52       {"include-non-rfc",EXPORT_INCLUDE_NON_RFC},
53       {"include-local-sigs",EXPORT_INCLUDE_LOCAL_SIGS},
54       {"include-attributes",EXPORT_INCLUDE_ATTRIBUTES},
55       {"include-sensitive-revkeys",EXPORT_INCLUDE_SENSITIVE_REVKEYS},
56       {NULL,0}
57       /* add tags for include revoked and disabled? */
58     };
59
60   while((tok=strsep(&str," ,")))
61     {
62       int i,rev=0;
63
64       if(ascii_memcasecmp("no-",tok,3)==0)
65         rev=1;
66
67       for(i=0;export_opts[i].name;i++)
68         {
69           if(ascii_strcasecmp(export_opts[i].name,tok)==0)
70             {
71               if(rev)
72                 *options&=~export_opts[i].bit;
73               else
74                 *options|=export_opts[i].bit;
75               hit=1;
76               break;
77             }
78         }
79
80       if(!hit && !export_opts[i].name)
81         return 0;
82     }
83
84   return hit;
85 }
86
87 /****************
88  * Export the public keys (to standard out or --output).
89  * Depending on opt.armor the output is armored.
90  * options are defined in main.h.
91  * If USERS is NULL, the complete ring will be exported.  */
92 int
93 export_pubkeys( STRLIST users, unsigned int options )
94 {
95     return do_export( users, 0, options );
96 }
97
98 /****************
99  * Export to an already opened stream; return -1 if no keys have
100  * been exported
101  */
102 int
103 export_pubkeys_stream( IOBUF out, STRLIST users, unsigned int options )
104 {
105     int any, rc;
106
107     rc = do_export_stream( out, users, 0, options, &any );
108     if( !rc && !any )
109         rc = -1;
110     return rc;
111 }
112
113 int
114 export_seckeys( STRLIST users )
115 {
116     return do_export( users, 1, 0 );
117 }
118
119 int
120 export_secsubkeys( STRLIST users )
121 {
122     return do_export( users, 2, 0 );
123 }
124
125 static int
126 do_export( STRLIST users, int secret, unsigned int options )
127 {
128     IOBUF out = NULL;
129     int any, rc;
130     armor_filter_context_t afx;
131     compress_filter_context_t zfx;
132
133     memset( &afx, 0, sizeof afx);
134     memset( &zfx, 0, sizeof zfx);
135
136     rc = open_outfile( NULL, 0, &out );
137     if( rc )
138         return rc;
139
140     if( opt.armor ) {
141         afx.what = secret?5:1;
142         iobuf_push_filter( out, armor_filter, &afx );
143     }
144     if( opt.compress_keys && opt.compress )
145         iobuf_push_filter( out, compress_filter, &zfx );
146     rc = do_export_stream( out, users, secret, options, &any );
147
148     if( rc || !any )
149         iobuf_cancel(out);
150     else
151         iobuf_close(out);
152     return rc;
153 }
154
155
156 static int
157 do_export_stream( IOBUF out, STRLIST users, int secret,
158                   unsigned int options, int *any )
159 {
160     int rc = 0;
161     PACKET pkt;
162     KBNODE keyblock = NULL;
163     KBNODE kbctx, node;
164     int ndesc;
165     KEYDB_SEARCH_DESC *desc = NULL;
166     KEYDB_HANDLE kdbhd;
167     STRLIST sl;
168
169     *any = 0;
170     init_packet( &pkt );
171     kdbhd = keydb_new (secret);
172
173     if (!users) {
174         ndesc = 1;
175         desc = m_alloc_clear ( ndesc * sizeof *desc);
176         desc[0].mode = KEYDB_SEARCH_MODE_FIRST;
177     }
178     else {
179         for (ndesc=0, sl=users; sl; sl = sl->next, ndesc++) 
180             ;
181         desc = m_alloc ( ndesc * sizeof *desc);
182         
183         for (ndesc=0, sl=users; sl; sl = sl->next) {
184             if (classify_user_id (sl->d, desc+ndesc))
185                 ndesc++;
186             else
187                 log_error (_("key `%s' not found: %s\n"),
188                            sl->d, g10_errstr (G10ERR_INV_USER_ID));
189         }
190
191         /* it would be nice to see which of the given users did
192            actually match one in the keyring.  To implement this we
193            need to have a found flag for each entry in desc and to set
194            this we must check all those entries after a match to mark
195            all matched one - currently we stop at the first match.  To
196            do this we need an extra flag to enable this feature so */
197     }
198
199
200     while (!(rc = keydb_search (kdbhd, desc, ndesc))) {
201         int sha1_warned=0;
202         u32 sk_keyid[2];
203
204         if (!users) 
205             desc[0].mode = KEYDB_SEARCH_MODE_NEXT;
206
207         /* read the keyblock */
208         rc = keydb_get_keyblock (kdbhd, &keyblock );
209         if( rc ) {
210             log_error (_("error reading keyblock: %s\n"), g10_errstr(rc) );
211             goto leave;
212         }
213
214         /* do not export keys which are incompatible with rfc2440 */
215         if( !(options&EXPORT_INCLUDE_NON_RFC) &&
216             (node = find_kbnode( keyblock, PKT_PUBLIC_KEY )) ) {
217             PKT_public_key *pk = node->pkt->pkt.public_key;
218             if( pk->version == 3 && pk->pubkey_algo > 3 ) {
219                 log_info(_("key %08lX: not a rfc2440 key - skipped\n"),
220                               (ulong)keyid_from_pk( pk, NULL) );
221                 continue;
222             }
223         }
224
225         node=find_kbnode( keyblock, PKT_SECRET_KEY );
226         if(node)
227           {
228             PKT_secret_key *sk=node->pkt->pkt.secret_key;
229
230             keyid_from_sk(sk,sk_keyid);
231
232             /* we can't apply GNU mode 1001 on an unprotected key */
233             if( secret == 2 && !sk->is_protected )
234               {
235                 log_info(_("key %08lX: not protected - skipped\n"),
236                          (ulong)sk_keyid[1]);
237                 continue;
238               }
239
240             /* no v3 keys with GNU mode 1001 */
241             if( secret == 2 && sk->version == 3 )
242               {
243                 log_info(_("key %08lX: PGP 2.x style key - skipped\n"),
244                          (ulong)sk_keyid[1]);
245                 continue;
246               }
247           }
248
249         /* and write it */
250         for( kbctx=NULL; (node = walk_kbnode( keyblock, &kbctx, 0 )); ) {
251             /* don't export any comment packets but those in the
252              * secret keyring */
253             if( !secret && node->pkt->pkttype == PKT_COMMENT )
254                 continue;
255             /* make sure that ring_trust packets never get exported */
256             if (node->pkt->pkttype == PKT_RING_TRUST)
257               continue;
258
259             if( node->pkt->pkttype == PKT_SIGNATURE ) {
260               /* do not export packets which are marked as not exportable */
261               if( !(options&EXPORT_INCLUDE_LOCAL_SIGS) &&
262                   !node->pkt->pkt.signature->flags.exportable )
263                 continue; /* not exportable */
264
265               /* do not export packets with a "sensitive" revocation
266                  key.  This will need revisiting when we start
267                  supporting creating revocation keys and not just
268                  reading them. */
269               if( !(options&EXPORT_INCLUDE_SENSITIVE_REVKEYS) &&
270                   node->pkt->pkt.signature->revkey ) {
271                 int i;
272
273                 for(i=0;i<node->pkt->pkt.signature->numrevkeys;i++)
274                   if(node->pkt->pkt.signature->revkey[i]->class & 0x40)
275                     continue;
276               }
277
278               /* delete our verification cache */
279               delete_sig_subpkt (node->pkt->pkt.signature->unhashed,
280                                  SIGSUBPKT_PRIV_VERIFY_CACHE);
281             }
282
283             /* Don't export attribs? */
284             if( !(options&EXPORT_INCLUDE_ATTRIBUTES) &&
285                 node->pkt->pkttype == PKT_USER_ID &&
286                 node->pkt->pkt.user_id->attrib_data ) {
287               /* Skip until we get to something that is not an attrib
288                  or a signature on an attrib */
289               while(kbctx->next && kbctx->next->pkt->pkttype==PKT_SIGNATURE) {
290                 kbctx=kbctx->next;
291               }
292  
293               continue;
294             }
295
296             if( secret == 2 && node->pkt->pkttype == PKT_SECRET_KEY ) {
297                 /* we don't want to export the secret parts of the
298                  * primary key, this is done by using GNU protection mode 1001
299                  */
300                 int save_mode = node->pkt->pkt.secret_key->protect.s2k.mode;
301                 node->pkt->pkt.secret_key->protect.s2k.mode = 1001;
302                 rc = build_packet( out, node->pkt );
303                 node->pkt->pkt.secret_key->protect.s2k.mode = save_mode;
304             }
305             else {
306               /* Warn the user if the secret key or any of the secret
307                  subkeys are protected with SHA1 and we have
308                  simple_sk_checksum set. */
309               if(!sha1_warned && opt.simple_sk_checksum &&
310                  (node->pkt->pkttype==PKT_SECRET_KEY ||
311                   node->pkt->pkttype==PKT_SECRET_SUBKEY) &&
312                  node->pkt->pkt.secret_key->protect.sha1chk)
313                 {
314                   /* I hope this warning doesn't confuse people. */
315                   log_info("Warning: secret key %08lX does not have a "
316                            "simple SK checksum\n",(ulong)sk_keyid[1]);
317
318                   sha1_warned=1;
319                 }
320
321                 rc = build_packet( out, node->pkt );
322             }
323
324             if( rc ) {
325                 log_error("build_packet(%d) failed: %s\n",
326                             node->pkt->pkttype, g10_errstr(rc) );
327                 rc = G10ERR_WRITE_FILE;
328                 goto leave;
329             }
330         }
331         ++*any;
332     }
333     if( rc == -1 )
334         rc = 0;
335
336   leave:
337     m_free(desc);
338     keydb_release (kdbhd);
339     release_kbnode( keyblock );
340     if( !*any )
341         log_info(_("WARNING: nothing exported\n"));
342     return rc;
343 }
344