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