* main.h, misc.c (parse_options): Add a "noisy" flag to enable and disable
[gnupg.git] / g10 / export.c
1 /* export.c
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002
3  *               2003 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-non-rfc",EXPORT_INCLUDE_NON_RFC},
49       {"include-local-sigs",EXPORT_INCLUDE_LOCAL_SIGS},
50       {"include-attributes",EXPORT_INCLUDE_ATTRIBUTES},
51       {"include-sensitive-revkeys",EXPORT_INCLUDE_SENSITIVE_REVKEYS},
52       {NULL,0}
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
145     *any = 0;
146     init_packet( &pkt );
147     kdbhd = keydb_new (secret);
148
149     if (!users) {
150         ndesc = 1;
151         desc = m_alloc_clear ( ndesc * sizeof *desc);
152         desc[0].mode = KEYDB_SEARCH_MODE_FIRST;
153     }
154     else {
155         for (ndesc=0, sl=users; sl; sl = sl->next, ndesc++) 
156             ;
157         desc = m_alloc ( ndesc * sizeof *desc);
158         
159         for (ndesc=0, sl=users; sl; sl = sl->next) {
160             if (classify_user_id (sl->d, desc+ndesc))
161                 ndesc++;
162             else
163                 log_error (_("key `%s' not found: %s\n"),
164                            sl->d, g10_errstr (G10ERR_INV_USER_ID));
165         }
166
167         /* it would be nice to see which of the given users did
168            actually match one in the keyring.  To implement this we
169            need to have a found flag for each entry in desc and to set
170            this we must check all those entries after a match to mark
171            all matched one - currently we stop at the first match.  To
172            do this we need an extra flag to enable this feature so */
173     }
174
175     while (!(rc = keydb_search2 (kdbhd, desc, ndesc, &descindex))) {
176         int sha1_warned=0,skip_until_subkey=0;
177         u32 sk_keyid[2];
178
179         if (!users) 
180             desc[0].mode = KEYDB_SEARCH_MODE_NEXT;
181
182         /* read the keyblock */
183         rc = keydb_get_keyblock (kdbhd, &keyblock );
184         if( rc ) {
185             log_error (_("error reading keyblock: %s\n"), g10_errstr(rc) );
186             goto leave;
187         }
188
189         /* do not export keys which are incompatible with rfc2440 */
190         if( !(options&EXPORT_INCLUDE_NON_RFC) &&
191             (node = find_kbnode( keyblock, PKT_PUBLIC_KEY )) ) {
192             PKT_public_key *pk = node->pkt->pkt.public_key;
193             if( pk->version == 3 && pk->pubkey_algo > 3 ) {
194                 log_info(_("key %08lX: not a rfc2440 key - skipped\n"),
195                               (ulong)keyid_from_pk( pk, NULL) );
196                 continue;
197             }
198         }
199
200         node=find_kbnode( keyblock, PKT_SECRET_KEY );
201         if(node)
202           {
203             PKT_secret_key *sk=node->pkt->pkt.secret_key;
204
205             keyid_from_sk(sk,sk_keyid);
206
207             /* we can't apply GNU mode 1001 on an unprotected key */
208             if( secret == 2 && !sk->is_protected )
209               {
210                 log_info(_("key %08lX: not protected - skipped\n"),
211                          (ulong)sk_keyid[1]);
212                 continue;
213               }
214
215             /* no v3 keys with GNU mode 1001 */
216             if( secret == 2 && sk->version == 3 )
217               {
218                 log_info(_("key %08lX: PGP 2.x style key - skipped\n"),
219                          (ulong)sk_keyid[1]);
220                 continue;
221               }
222           }
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               /* do not export packets which are marked as not exportable */
310               if( !(options&EXPORT_INCLUDE_LOCAL_SIGS) &&
311                   !node->pkt->pkt.signature->flags.exportable )
312                 continue; /* not exportable */
313
314               /* Do not export packets with a "sensitive" revocation
315                  key unless the user wants us to.  Note that we do
316                  export these when issuing the actual revocation (see
317                  revoke.c). */
318               if( !(options&EXPORT_INCLUDE_SENSITIVE_REVKEYS) &&
319                   node->pkt->pkt.signature->revkey ) {
320                 int i;
321
322                 for(i=0;i<node->pkt->pkt.signature->numrevkeys;i++)
323                   if(node->pkt->pkt.signature->revkey[i]->class & 0x40)
324                     break;
325
326                 if(i<node->pkt->pkt.signature->numrevkeys)
327                   continue;
328               }
329             }
330
331             /* Don't export attribs? */
332             if( !(options&EXPORT_INCLUDE_ATTRIBUTES) &&
333                 node->pkt->pkttype == PKT_USER_ID &&
334                 node->pkt->pkt.user_id->attrib_data ) {
335               /* Skip until we get to something that is not an attrib
336                  or a signature on an attrib */
337               while(kbctx->next && kbctx->next->pkt->pkttype==PKT_SIGNATURE) {
338                 kbctx=kbctx->next;
339               }
340  
341               continue;
342             }
343
344             if( secret == 2 && node->pkt->pkttype == PKT_SECRET_KEY ) {
345                 /* we don't want to export the secret parts of the
346                  * primary key, this is done by using GNU protection mode 1001
347                  */
348                 int save_mode = node->pkt->pkt.secret_key->protect.s2k.mode;
349                 node->pkt->pkt.secret_key->protect.s2k.mode = 1001;
350                 rc = build_packet( out, node->pkt );
351                 node->pkt->pkt.secret_key->protect.s2k.mode = save_mode;
352             }
353             else {
354               /* Warn the user if the secret key or any of the secret
355                  subkeys are protected with SHA1 and we have
356                  simple_sk_checksum set. */
357               if(!sha1_warned && opt.simple_sk_checksum &&
358                  (node->pkt->pkttype==PKT_SECRET_KEY ||
359                   node->pkt->pkttype==PKT_SECRET_SUBKEY) &&
360                  node->pkt->pkt.secret_key->protect.sha1chk)
361                 {
362                   /* I hope this warning doesn't confuse people. */
363                   log_info(_("WARNING: secret key %08lX does not have a "
364                              "simple SK checksum\n"),(ulong)sk_keyid[1]);
365
366                   sha1_warned=1;
367                 }
368
369                 rc = build_packet( out, node->pkt );
370             }
371
372             if( rc ) {
373                 log_error("build_packet(%d) failed: %s\n",
374                             node->pkt->pkttype, g10_errstr(rc) );
375                 rc = G10ERR_WRITE_FILE;
376                 goto leave;
377             }
378         }
379         ++*any;
380         if(keyblock_out)
381           {
382             *keyblock_out=keyblock;
383             break;
384           }
385     }
386     if( rc == -1 )
387         rc = 0;
388
389   leave:
390     m_free(desc);
391     keydb_release (kdbhd);
392     if(rc || keyblock_out==NULL)
393       release_kbnode( keyblock );
394     if( !*any )
395         log_info(_("WARNING: nothing exported\n"));
396     return rc;
397 }