doc/
[gpgme.git] / gpgme / genkey.c
1 /* genkey.c -  key generation
2  *      Copyright (C) 2000 Werner Koch (dd9jn)
3  *      Copyright (C) 2001, 2002 g10 Code GmbH
4  *
5  * This file is part of GPGME.
6  *
7  * GPGME 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  * GPGME 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 <assert.h>
27
28 #include "util.h"
29 #include "context.h"
30 #include "ops.h"
31
32
33 struct genkey_result_s
34 {
35   int created_primary : 1;
36   int created_sub : 1;
37 };
38
39
40 void
41 _gpgme_release_genkey_result (GenKeyResult result)
42 {
43   if (!result)
44     return;
45   xfree (result);
46 }
47
48 static void
49 genkey_status_handler (GpgmeCtx ctx, GpgStatusCode code, char *args)
50 {
51   _gpgme_progress_status_handler (ctx, code, args);
52
53   if (ctx->out_of_core)
54     return;
55
56   if (!ctx->result.genkey)
57     {
58       ctx->result.genkey = xtrycalloc (1, sizeof *ctx->result.genkey);
59       if (!ctx->result.genkey)
60         {
61           ctx->out_of_core = 1;
62           return;
63         }
64     }
65
66   switch (code)
67     {
68     case STATUS_KEY_CREATED:
69       if (args && *args)
70         {
71           if (*args == 'B' || *args == 'P')
72             ctx->result.genkey->created_primary = 1;
73           if (*args == 'B' || *args == 'S')
74             ctx->result.genkey->created_sub = 1;
75         }
76       break;
77
78     default:
79       break;
80     }
81 }
82
83
84 /**
85  * gpgme_op_genkey:
86  * @c: the context
87  * @parms: XML string with the key parameters
88  * @pubkey: Returns the public key
89  * @seckey: Returns the secret key
90  * 
91  * Generate a new key and store the key in the default keyrings if
92  * both @pubkey and @seckey are NULL.  If @pubkey and @seckey are
93  * given, the newly created key will be returned in these data
94  * objects.  This function just starts the gheneration and does not
95  * wait for completion.
96  *
97  * Here is an example on how @parms should be formatted; for deatils
98  * see the file doc/DETAILS from the GnuPG distribution.
99  *
100  * <literal>
101  * <![CDATA[
102  * <GnupgKeyParms format="internal">
103  * Key-Type: DSA
104  * Key-Length: 1024
105  * Subkey-Type: ELG-E
106  * Subkey-Length: 1024
107  * Name-Real: Joe Tester
108  * Name-Comment: with stupid passphrase
109  * Name-Email: joe@foo.bar
110  * Expire-Date: 0
111  * Passphrase: abc
112  * </GnupgKeyParms>
113  * ]]>
114  * </literal> 
115  *
116  * Strings should be given in UTF-8 encoding.  The format we support
117  * for now is only "internal".  The content of the
118  * &lt;GnupgKeyParms&gt; container is passed verbatim to GnuPG.
119  * Control statements are not allowed.
120  * 
121  * Return value: 0 for success or an error code
122  **/
123 GpgmeError
124 gpgme_op_genkey_start (GpgmeCtx ctx, const char *parms,
125                        GpgmeData pubkey, GpgmeData seckey)
126 {
127   int err = 0;
128   const char *s, *s2, *sx;
129
130   fail_on_pending_request (ctx);
131   ctx->pending = 1;
132
133   gpgme_data_release (ctx->help_data_1);
134   ctx->help_data_1 = NULL;
135
136   _gpgme_engine_release (ctx->engine);
137   ctx->engine = NULL;
138   err = _gpgme_engine_new (ctx->use_cms ? GPGME_PROTOCOL_CMS
139                            : GPGME_PROTOCOL_OpenPGP, &ctx->engine);
140   if (err)
141     goto leave;
142
143   /* We need a special mechanism to get the fd of a pipe here, so
144    * that we can use this for the %pubring and %secring parameters.
145    * We don't have this yet, so we implement only the adding to the
146    * standard keyrings */
147   if (pubkey || seckey)
148     {
149       err = mk_error (Not_Implemented);
150       goto leave;
151     }
152
153   if (!pubkey && !seckey)
154     ; /* okay: Add key to the keyrings */
155   else if (!pubkey || gpgme_data_get_type (pubkey) != GPGME_DATA_TYPE_NONE)
156     {
157       err = mk_error (Invalid_Value);
158       goto leave;
159     }
160   else if (!seckey || gpgme_data_get_type (seckey) != GPGME_DATA_TYPE_NONE)
161     {
162       err = mk_error (Invalid_Value);
163       goto leave;
164     }
165     
166   if (pubkey)
167     {
168       _gpgme_data_set_mode (pubkey, GPGME_DATA_MODE_IN);
169       _gpgme_data_set_mode (seckey, GPGME_DATA_MODE_IN);
170       /* FIXME: Need some more things here.  */
171     }
172
173   if ((parms = strstr (parms, "<GnupgKeyParms ")) 
174       && (s = strchr (parms, '>'))
175       && (sx = strstr (parms, "format=\"internal\""))
176       && sx < s
177       && (s2 = strstr (s+1, "</GnupgKeyParms>")))
178     {
179       /* FIXME: Check that there are no control statements inside.  */
180       err = gpgme_data_new_from_mem (&ctx->help_data_1, s+1, s2-s-1, 1);
181     }
182   else 
183     err = mk_error (Invalid_Value);
184
185   if (err)
186     goto leave;
187     
188   _gpgme_data_set_mode (ctx->help_data_1, GPGME_DATA_MODE_OUT);
189
190   _gpgme_engine_set_status_handler (ctx->engine, genkey_status_handler, ctx);
191   _gpgme_engine_set_verbosity (ctx->engine, ctx->verbosity);
192
193   err = _gpgme_engine_op_genkey (ctx->engine, ctx->help_data_1, ctx->use_armor);
194
195   if (!err)
196     err = _gpgme_engine_start (ctx->engine, ctx);
197
198  leave:
199   if (err)
200     {
201       ctx->pending = 0; 
202       _gpgme_engine_release (ctx->engine);
203       ctx->engine = NULL;
204     }
205   return err;
206 }
207
208
209 /**
210  * gpgme_op_genkey:
211  * @c: the context
212  * @parms: XML string with the key parameters
213  * @pubkey: Returns the public key
214  * @seckey: Returns the secret key
215  * 
216  * Generate a new key and store the key in the default keyrings if both
217  * @pubkey and @seckey are NULL.  If @pubkey and @seckey are given, the newly
218  * created key will be returned in these data objects.
219  * See gpgme_op_genkey_start() for a description of @parms.
220  * 
221  * Return value: 0 for success or an error code
222  **/
223 GpgmeError
224 gpgme_op_genkey (GpgmeCtx ctx, const char *parms,
225                  GpgmeData pubkey, GpgmeData seckey)
226 {
227   GpgmeError err = gpgme_op_genkey_start (ctx, parms, pubkey, seckey);
228   if (!err)
229     {
230       gpgme_wait (ctx, 1);
231
232       /* FIXME: Should return some more useful error value.  */
233       if (!ctx->result.genkey)
234         err = mk_error (General_Error);
235       else if (!ctx->result.genkey->created_primary
236                && !ctx->result.genkey->created_sub)
237         err = mk_error (General_Error);
238     }
239   return err;
240 }