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