83e6b970ec9414c4e64652ff4f00fc9c5313d402
[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, int flags );
38 static int do_export_stream( IOBUF out, STRLIST users,
39                              int secret, int flags, int *any );
40
41 /****************
42  * Export the public keys (to standard out or --output).
43  * Depending on opt.armor the output is armored.
44  * flags has two bits: EXPORT_FLAG_ONLYRFC, so that only RFC2440
45  * compatible keys are exported, and EXPORT_FLAG_SKIPATTRIBS to not
46  * export attribute packets (photo IDs).
47  * If USERS is NULL, the complete ring will be exported.  */
48 int
49 export_pubkeys( STRLIST users, int flags )
50 {
51     return do_export( users, 0, flags );
52 }
53
54 /****************
55  * Export to an already opened stream; return -1 if no keys have
56  * been exported
57  */
58 int
59 export_pubkeys_stream( IOBUF out, STRLIST users, int flags )
60 {
61     int any, rc;
62
63     rc = do_export_stream( out, users, 0, flags, &any );
64     if( !rc && !any )
65         rc = -1;
66     return rc;
67 }
68
69 int
70 export_seckeys( STRLIST users )
71 {
72     return do_export( users, 1, 0 );
73 }
74
75 int
76 export_secsubkeys( STRLIST users )
77 {
78     return do_export( users, 2, 0 );
79 }
80
81 static int
82 do_export( STRLIST users, int secret, int flags )
83 {
84     IOBUF out = NULL;
85     int any, rc;
86     armor_filter_context_t afx;
87     compress_filter_context_t zfx;
88
89     memset( &afx, 0, sizeof afx);
90     memset( &zfx, 0, sizeof zfx);
91
92     rc = open_outfile( NULL, 0, &out );
93     if( rc )
94         return rc;
95
96     if( opt.armor ) {
97         afx.what = secret?5:1;
98         iobuf_push_filter( out, armor_filter, &afx );
99     }
100     if( opt.compress_keys && opt.compress )
101         iobuf_push_filter( out, compress_filter, &zfx );
102     rc = do_export_stream( out, users, secret, flags, &any );
103
104     if( rc || !any )
105         iobuf_cancel(out);
106     else
107         iobuf_close(out);
108     return rc;
109 }
110
111
112 static int
113 do_export_stream( IOBUF out, STRLIST users, int secret, int flags, int *any )
114 {
115     int rc = 0;
116     PACKET pkt;
117     KBNODE keyblock = NULL;
118     KBNODE kbctx, node;
119     int ndesc;
120     KEYDB_SEARCH_DESC *desc = NULL;
121     KEYDB_HANDLE kdbhd;
122     STRLIST sl;
123
124     *any = 0;
125     init_packet( &pkt );
126     kdbhd = keydb_new (secret);
127
128     if (!users) {
129         ndesc = 1;
130         desc = m_alloc_clear ( ndesc * sizeof *desc);
131         desc[0].mode = KEYDB_SEARCH_MODE_FIRST;
132     }
133     else {
134         for (ndesc=0, sl=users; sl; sl = sl->next, ndesc++) 
135             ;
136         desc = m_alloc ( ndesc * sizeof *desc);
137         
138         for (ndesc=0, sl=users; sl; sl = sl->next) {
139             if (classify_user_id (sl->d, desc+ndesc))
140                 ndesc++;
141             else
142                 log_error (_("key `%s' not found: %s\n"),
143                            sl->d, g10_errstr (G10ERR_INV_USER_ID));
144         }
145
146         /* it would be nice to see which of the given users did
147            actually match one in the keyring.  To implement this we
148            need to have a found flag for each entry in desc and to set
149            this we must check all those entries after a match to mark
150            all matched one - currently we stop at the first match.  To
151            do this we need an extra flag to enable this feature so */
152     }
153
154
155     while (!(rc = keydb_search (kdbhd, desc, ndesc))) {
156         int sha1_warned=0;
157         u32 sk_keyid[2];
158
159         if (!users) 
160             desc[0].mode = KEYDB_SEARCH_MODE_NEXT;
161
162         /* read the keyblock */
163         rc = keydb_get_keyblock (kdbhd, &keyblock );
164         if( rc ) {
165             log_error (_("error reading keyblock: %s\n"), g10_errstr(rc) );
166             goto leave;
167         }
168
169         /* do not export keys which are incompatible with rfc2440 */
170         if( (flags&EXPORT_FLAG_ONLYRFC) &&
171             (node = find_kbnode( keyblock, PKT_PUBLIC_KEY )) ) {
172             PKT_public_key *pk = node->pkt->pkt.public_key;
173             if( pk->version == 3 && pk->pubkey_algo > 3 ) {
174                 log_info(_("key %08lX: not a rfc2440 key - skipped\n"),
175                               (ulong)keyid_from_pk( pk, NULL) );
176                 continue;
177             }
178         }
179
180         node=find_kbnode( keyblock, PKT_SECRET_KEY );
181         if(node)
182           {
183             PKT_secret_key *sk=node->pkt->pkt.secret_key;
184
185             keyid_from_sk(sk,sk_keyid);
186
187             /* we can't apply GNU mode 1001 on an unprotected key */
188             if( secret == 2 && !sk->is_protected )
189               {
190                 log_info(_("key %08lX: not protected - skipped\n"),
191                          (ulong)sk_keyid[1]);
192                 continue;
193               }
194
195             /* no v3 keys with GNU mode 1001 */
196             if( secret == 2 && sk->version == 3 )
197               {
198                 log_info(_("key %08lX: PGP 2.x style key - skipped\n"),
199                          (ulong)sk_keyid[1]);
200                 continue;
201               }
202           }
203
204         /* and write it */
205         for( kbctx=NULL; (node = walk_kbnode( keyblock, &kbctx, 0 )); ) {
206             /* don't export any comment packets but those in the
207              * secret keyring */
208             if( !secret && node->pkt->pkttype == PKT_COMMENT )
209                 continue;
210             /* make sure that ring_trust packets never get exported */
211             if (node->pkt->pkttype == PKT_RING_TRUST)
212               continue;
213
214             if( node->pkt->pkttype == PKT_SIGNATURE ) {
215               /* do not export packets which are marked as not exportable */
216               if( !node->pkt->pkt.signature->flags.exportable )
217                 continue; /* not exportable */
218
219               /* do not export packets with a "sensitive" revocation
220                  key.  This will need revisiting when we start
221                  supporting creating revocation keys and not just
222                  reading them. */
223               if( node->pkt->pkt.signature->revkey ) {
224                 int i;
225
226                 for(i=0;i<node->pkt->pkt.signature->numrevkeys;i++)
227                   if(node->pkt->pkt.signature->revkey[i]->class & 0x40)
228                     continue;
229               }
230
231               /* delete our verification cache */
232               delete_sig_subpkt (node->pkt->pkt.signature->unhashed,
233                                  SIGSUBPKT_PRIV_VERIFY_CACHE);
234             }
235
236             /* Don't export attribs? */
237             if( (flags&EXPORT_FLAG_SKIPATTRIBS) &&
238                 node->pkt->pkttype == PKT_USER_ID &&
239                 node->pkt->pkt.user_id->attrib_data ) {
240               /* Skip until we get to something that is not an attrib
241                  or a signature on an attrib */
242               while(kbctx->next && kbctx->next->pkt->pkttype==PKT_SIGNATURE) {
243                 kbctx=kbctx->next;
244               }
245  
246               continue;
247             }
248
249             if( secret == 2 && node->pkt->pkttype == PKT_SECRET_KEY ) {
250                 /* we don't want to export the secret parts of the
251                  * primary key, this is done by using GNU protection mode 1001
252                  */
253                 int save_mode = node->pkt->pkt.secret_key->protect.s2k.mode;
254                 node->pkt->pkt.secret_key->protect.s2k.mode = 1001;
255                 rc = build_packet( out, node->pkt );
256                 node->pkt->pkt.secret_key->protect.s2k.mode = save_mode;
257             }
258             else {
259               /* Warn the user if the secret key or any of the secret
260                  subkeys are protected with SHA1 and we have
261                  simple_sk_checksum set. */
262               if(!sha1_warned && opt.simple_sk_checksum &&
263                  (node->pkt->pkttype==PKT_SECRET_KEY ||
264                   node->pkt->pkttype==PKT_SECRET_SUBKEY) &&
265                  node->pkt->pkt.secret_key->protect.sha1chk)
266                 {
267                   /* I hope this warning doesn't confuse people. */
268                   log_info("Warning: secret key %08lX does not have a "
269                            "simple SK checksum\n",(ulong)sk_keyid[1]);
270
271                   sha1_warned=1;
272                 }
273
274                 rc = build_packet( out, node->pkt );
275             }
276
277             if( rc ) {
278                 log_error("build_packet(%d) failed: %s\n",
279                             node->pkt->pkttype, g10_errstr(rc) );
280                 rc = G10ERR_WRITE_FILE;
281                 goto leave;
282             }
283         }
284         ++*any;
285     }
286     if( rc == -1 )
287         rc = 0;
288
289   leave:
290     m_free(desc);
291     keydb_release (kdbhd);
292     release_kbnode( keyblock );
293     if( !*any )
294         log_info(_("WARNING: nothing exported\n"));
295     return rc;
296 }
297