auto updated version number.
[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->error)
54     return;
55   test_and_allocate_result (ctx, genkey);
56
57   switch (code)
58     {
59     case STATUS_KEY_CREATED:
60       if (args && *args)
61         {
62           if (*args == 'B' || *args == 'P')
63             ctx->result.genkey->created_primary = 1;
64           if (*args == 'B' || *args == 'S')
65             ctx->result.genkey->created_sub = 1;
66         }
67       break;
68
69     case STATUS_EOF:
70       /* FIXME: Should return some more useful error value.  */
71       if (!ctx->result.genkey->created_primary
72           && !ctx->result.genkey->created_sub)
73         ctx->error = mk_error (General_Error);
74       break;
75
76     default:
77       break;
78     }
79 }
80
81 static GpgmeError
82 _gpgme_op_genkey_start (GpgmeCtx ctx, int synchronous, const char *parms,
83                         GpgmeData pubkey, GpgmeData seckey)
84 {
85   int err = 0;
86   const char *s, *s2, *sx;
87
88   err = _gpgme_op_reset (ctx, synchronous);
89   if (err)
90     goto leave;
91
92   gpgme_data_release (ctx->help_data_1);
93   ctx->help_data_1 = NULL;
94
95   if (!pubkey && !seckey)
96     ; /* okay: Add key to the keyrings */
97   else if (pubkey && gpgme_data_get_type (pubkey) != GPGME_DATA_TYPE_NONE)
98     {
99       err = mk_error (Invalid_Value);
100       goto leave;
101     }
102   else if (seckey && gpgme_data_get_type (seckey) != GPGME_DATA_TYPE_NONE)
103     {
104       err = mk_error (Invalid_Value);
105       goto leave;
106     }
107     
108   if (pubkey)
109     /* FIXME: Need some more things here.  */
110     _gpgme_data_set_mode (pubkey, GPGME_DATA_MODE_IN);
111
112   if (seckey)
113     /* FIXME: Need some more things here.  */
114     _gpgme_data_set_mode (seckey, GPGME_DATA_MODE_IN);
115
116   if ((parms = strstr (parms, "<GnupgKeyParms ")) 
117       && (s = strchr (parms, '>'))
118       && (sx = strstr (parms, "format=\"internal\""))
119       && sx < s
120       && (s2 = strstr (s+1, "</GnupgKeyParms>")))
121     {
122       /* FIXME: Check that there are no control statements inside.  */
123       s++;  /* Skip '>'.  */
124       while (*s == '\n')
125         s++;
126       err = gpgme_data_new_from_mem (&ctx->help_data_1, s, s2-s, 1);
127     }
128   else 
129     err = mk_error (Invalid_Value);
130
131   if (err)
132     goto leave;
133     
134   _gpgme_data_set_mode (ctx->help_data_1, GPGME_DATA_MODE_OUT);
135
136   _gpgme_engine_set_status_handler (ctx->engine, genkey_status_handler, ctx);
137   _gpgme_engine_set_verbosity (ctx->engine, ctx->verbosity);
138
139   err = _gpgme_engine_op_genkey (ctx->engine, ctx->help_data_1, ctx->use_armor,
140                                  pubkey, seckey);
141
142   if (!err)
143     err = _gpgme_engine_start (ctx->engine, ctx);
144
145  leave:
146   if (err)
147     {
148       ctx->pending = 0; 
149       _gpgme_engine_release (ctx->engine);
150       ctx->engine = NULL;
151     }
152   return err;
153 }
154
155
156 /**
157  * gpgme_op_genkey:
158  * @c: the context
159  * @parms: XML string with the key parameters
160  * @pubkey: Returns the public key
161  * @seckey: Returns the secret key
162  * 
163  * Generate a new key and store the key in the default keyrings if
164  * both @pubkey and @seckey are NULL.  If @pubkey and @seckey are
165  * given, the newly created key will be returned in these data
166  * objects.  This function just starts the gheneration and does not
167  * wait for completion.
168  *
169  * Here is an example on how @parms should be formatted; for deatils
170  * see the file doc/DETAILS from the GnuPG distribution.
171  *
172  * <literal>
173  * <![CDATA[
174  * <GnupgKeyParms format="internal">
175  * Key-Type: DSA
176  * Key-Length: 1024
177  * Subkey-Type: ELG-E
178  * Subkey-Length: 1024
179  * Name-Real: Joe Tester
180  * Name-Comment: with stupid passphrase
181  * Name-Email: joe@foo.bar
182  * Expire-Date: 0
183  * Passphrase: abc
184  * </GnupgKeyParms>
185  * ]]>
186  * </literal> 
187  *
188  * Strings should be given in UTF-8 encoding.  The format we support
189  * for now is only "internal".  The content of the
190  * &lt;GnupgKeyParms&gt; container is passed verbatim to GnuPG.
191  * Control statements are not allowed.
192  * 
193  * Return value: 0 for success or an error code
194  **/
195 GpgmeError
196 gpgme_op_genkey_start (GpgmeCtx ctx, const char *parms,
197                        GpgmeData pubkey, GpgmeData seckey)
198 {
199   return _gpgme_op_genkey_start (ctx, 0, parms, pubkey, seckey);
200 }
201
202
203 /**
204  * gpgme_op_genkey:
205  * @c: the context
206  * @parms: XML string with the key parameters
207  * @pubkey: Returns the public key
208  * @seckey: Returns the secret key
209  * 
210  * Generate a new key and store the key in the default keyrings if both
211  * @pubkey and @seckey are NULL.  If @pubkey and @seckey are given, the newly
212  * created key will be returned in these data objects.
213  * See gpgme_op_genkey_start() for a description of @parms.
214  * 
215  * Return value: 0 for success or an error code
216  **/
217 GpgmeError
218 gpgme_op_genkey (GpgmeCtx ctx, const char *parms,
219                  GpgmeData pubkey, GpgmeData seckey)
220 {
221   GpgmeError err = _gpgme_op_genkey_start (ctx, 1, parms, pubkey, seckey);
222   if (!err)
223     err = _gpgme_wait_one (ctx);
224   return err;
225 }