* keylist.c (print_seckey_info, print_pubkey_info): --keyid-format
[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       {NULL,0,NULL}
52       /* add tags for include revoked and disabled? */
53     };
54
55   return parse_options(str,options,export_opts,noisy);
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 )
117       push_compress_filter(out,&zfx,default_compress_algo());
118
119     rc = do_export_stream( out, users, secret, NULL, options, &any );
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         node=find_kbnode( keyblock, PKT_SECRET_KEY );
189         if(node)
190           {
191             PKT_secret_key *sk=node->pkt->pkt.secret_key;
192
193             keyid_from_sk(sk,sk_keyid);
194
195             /* we can't apply GNU mode 1001 on an unprotected key */
196             if( secret == 2 && !sk->is_protected )
197               {
198                 log_info(_("key %s: not protected - skipped\n"),
199                          keystr(sk_keyid));
200                 continue;
201               }
202
203             /* no v3 keys with GNU mode 1001 */
204             if( secret == 2 && sk->version == 3 )
205               {
206                 log_info(_("key %s: PGP 2.x style key - skipped\n"),
207                          keystr(sk_keyid));
208                 continue;
209               }
210           }
211
212         /* and write it */
213         for( kbctx=NULL; (node = walk_kbnode( keyblock, &kbctx, 0 )); ) {
214             if( skip_until_subkey )
215               {
216                 if(node->pkt->pkttype==PKT_PUBLIC_SUBKEY
217                    || node->pkt->pkttype==PKT_SECRET_SUBKEY)
218                   skip_until_subkey=0;
219                 else
220                   continue;
221               }
222
223             /* don't export any comment packets but those in the
224              * secret keyring */
225             if( !secret && node->pkt->pkttype == PKT_COMMENT )
226                 continue;
227
228             /* make sure that ring_trust packets never get exported */
229             if (node->pkt->pkttype == PKT_RING_TRUST)
230               continue;
231
232             /* If exact is set, then we only export what was requested
233                (plus the primary key, if the user didn't specifically
234                request it) */
235             if(desc[descindex].exact
236                && (node->pkt->pkttype==PKT_PUBLIC_SUBKEY
237                    || node->pkt->pkttype==PKT_SECRET_SUBKEY))
238               {
239                 u32 kid[2];
240                 byte fpr[MAX_FINGERPRINT_LEN];
241                 size_t fprlen;
242
243                 switch(desc[descindex].mode)
244                   {
245                   case KEYDB_SEARCH_MODE_SHORT_KID:
246                   case KEYDB_SEARCH_MODE_LONG_KID:
247                     if(node->pkt->pkttype==PKT_PUBLIC_SUBKEY)
248                       keyid_from_pk(node->pkt->pkt.public_key,kid);
249                     else
250                       keyid_from_sk(node->pkt->pkt.secret_key,kid);
251                     break;
252
253                   case KEYDB_SEARCH_MODE_FPR16:
254                   case KEYDB_SEARCH_MODE_FPR20:
255                   case KEYDB_SEARCH_MODE_FPR:
256                     if(node->pkt->pkttype==PKT_PUBLIC_SUBKEY)
257                       fingerprint_from_pk(node->pkt->pkt.public_key,
258                                           fpr,&fprlen);
259                     else
260                       fingerprint_from_sk(node->pkt->pkt.secret_key,
261                                           fpr,&fprlen);
262                     break;
263
264                   default:
265                     break;
266                   }
267
268                 switch(desc[descindex].mode)
269                   {
270                   case KEYDB_SEARCH_MODE_SHORT_KID:
271                     if (desc[descindex].u.kid[1] != kid[1])
272                       skip_until_subkey=1;
273                     break;
274                   case KEYDB_SEARCH_MODE_LONG_KID:
275                     if (desc[descindex].u.kid[0] != kid[0]
276                         || desc[descindex].u.kid[1] != kid[1])
277                       skip_until_subkey=1;
278                     break;
279                   case KEYDB_SEARCH_MODE_FPR16:
280                     if (memcmp (desc[descindex].u.fpr, fpr, 16))
281                       skip_until_subkey=1;
282                     break;
283                   case KEYDB_SEARCH_MODE_FPR20:
284                   case KEYDB_SEARCH_MODE_FPR:
285                     if (memcmp (desc[descindex].u.fpr, fpr, 20))
286                       skip_until_subkey=1;
287                     break;
288                   default:
289                     break;
290                   }
291
292                 if(skip_until_subkey)
293                   continue;
294               }
295
296             if( node->pkt->pkttype == PKT_SIGNATURE ) {
297               /* do not export packets which are marked as not exportable */
298               if( !(options&EXPORT_INCLUDE_LOCAL_SIGS) &&
299                   !node->pkt->pkt.signature->flags.exportable )
300                 continue; /* not exportable */
301
302               /* Do not export packets with a "sensitive" revocation
303                  key unless the user wants us to.  Note that we do
304                  export these when issuing the actual revocation (see
305                  revoke.c). */
306               if( !(options&EXPORT_INCLUDE_SENSITIVE_REVKEYS) &&
307                   node->pkt->pkt.signature->revkey ) {
308                 int i;
309
310                 for(i=0;i<node->pkt->pkt.signature->numrevkeys;i++)
311                   if(node->pkt->pkt.signature->revkey[i]->class & 0x40)
312                     break;
313
314                 if(i<node->pkt->pkt.signature->numrevkeys)
315                   continue;
316               }
317             }
318
319             /* Don't export attribs? */
320             if( !(options&EXPORT_INCLUDE_ATTRIBUTES) &&
321                 node->pkt->pkttype == PKT_USER_ID &&
322                 node->pkt->pkt.user_id->attrib_data ) {
323               /* Skip until we get to something that is not an attrib
324                  or a signature on an attrib */
325               while(kbctx->next && kbctx->next->pkt->pkttype==PKT_SIGNATURE) {
326                 kbctx=kbctx->next;
327               }
328  
329               continue;
330             }
331
332             if( secret == 2 && node->pkt->pkttype == PKT_SECRET_KEY )
333               {
334                 /* we don't want to export the secret parts of the
335                  * primary key, this is done by using GNU protection mode 1001
336                  */
337                 int save_mode = node->pkt->pkt.secret_key->protect.s2k.mode;
338                 node->pkt->pkt.secret_key->protect.s2k.mode = 1001;
339                 rc = build_packet( out, node->pkt );
340                 node->pkt->pkt.secret_key->protect.s2k.mode = save_mode;
341               }
342             else
343               {
344                 /* Warn the user if the secret key or any of the secret
345                    subkeys are protected with SHA1 and we have
346                    simple_sk_checksum set. */
347                 if(!sha1_warned && opt.simple_sk_checksum &&
348                    (node->pkt->pkttype==PKT_SECRET_KEY ||
349                     node->pkt->pkttype==PKT_SECRET_SUBKEY) &&
350                    node->pkt->pkt.secret_key->protect.sha1chk)
351                   {
352                     /* I hope this warning doesn't confuse people. */
353                     log_info(_("WARNING: secret key %s does not have a "
354                                "simple SK checksum\n"),keystr(sk_keyid));
355
356                     sha1_warned=1;
357                   }
358
359                 rc = build_packet( out, node->pkt );
360               }
361
362             if( rc ) {
363                 log_error("build_packet(%d) failed: %s\n",
364                             node->pkt->pkttype, g10_errstr(rc) );
365                 rc = G10ERR_WRITE_FILE;
366                 goto leave;
367             }
368         }
369         ++*any;
370         if(keyblock_out)
371           {
372             *keyblock_out=keyblock;
373             break;
374           }
375     }
376     if( rc == -1 )
377         rc = 0;
378
379   leave:
380     m_free(desc);
381     keydb_release (kdbhd);
382     if(rc || keyblock_out==NULL)
383       release_kbnode( keyblock );
384     if( !*any )
385         log_info(_("WARNING: nothing exported\n"));
386     return rc;
387 }