Fix copyright year.
[gpgme.git] / gpgme / genkey.c
1 /* genkey.c - Key generation.
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003 g10 Code GmbH
4
5    This file is part of GPGME.
6  
7    GPGME is free software; you can redistribute it and/or modify it
8    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, but
13    WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    General Public License for more details.
16  
17    You should have received a copy of the GNU General Public License
18    along with GPGME; if not, write to the Free Software Foundation,
19    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
20
21 #if HAVE_CONFIG_H
22 #include <config.h>
23 #endif
24 #include <stdlib.h>
25 #include <string.h>
26
27 #include "util.h"
28 #include "context.h"
29 #include "ops.h"
30
31
32 struct genkey_result_s
33 {
34   int created_primary : 1;
35   int created_sub : 1;
36   char *fpr;
37 };
38
39
40 void
41 _gpgme_release_genkey_result (GenKeyResult result)
42 {
43   if (!result)
44     return;
45   if (result->fpr)
46     free (result->fpr);
47   free (result);
48 }
49
50
51 static GpgmeError
52 genkey_status_handler (GpgmeCtx ctx, GpgmeStatusCode code, char *args)
53 {
54   GpgmeError err = _gpgme_progress_status_handler (ctx, code, args);
55   if (err)
56     return err;
57
58   test_and_allocate_result (ctx, genkey);
59
60   switch (code)
61     {
62     case GPGME_STATUS_KEY_CREATED:
63       if (args && *args)
64         {
65           if (*args == 'B' || *args == 'P')
66             ctx->result.genkey->created_primary = 1;
67           if (*args == 'B' || *args == 'S')
68             ctx->result.genkey->created_sub = 1;
69           if (args[1] == ' ')
70             {
71               if (ctx->result.genkey->fpr)
72                 free (ctx->result.genkey->fpr);
73               ctx->result.genkey->fpr = strdup (&args[2]);
74               if (!ctx->result.genkey->fpr)
75                 return GPGME_Out_Of_Core;
76             }
77         }
78       break;
79
80     case GPGME_STATUS_EOF:
81       /* FIXME: Should return some more useful error value.  */
82       if (!ctx->result.genkey->created_primary
83           && !ctx->result.genkey->created_sub)
84         return GPGME_General_Error;
85       break;
86
87     default:
88       break;
89     }
90   return 0;
91 }
92
93
94 static GpgmeError
95 _gpgme_op_genkey_start (GpgmeCtx ctx, int synchronous, const char *parms,
96                         GpgmeData pubkey, GpgmeData seckey)
97 {
98   int err = 0;
99   const char *s, *s2, *sx;
100
101   err = _gpgme_op_reset (ctx, synchronous);
102   if (err)
103     goto leave;
104
105   gpgme_data_release (ctx->help_data_1);
106   ctx->help_data_1 = NULL;
107
108   if ((parms = strstr (parms, "<GnupgKeyParms ")) 
109       && (s = strchr (parms, '>'))
110       && (sx = strstr (parms, "format=\"internal\""))
111       && sx < s
112       && (s2 = strstr (s+1, "</GnupgKeyParms>")))
113     {
114       /* FIXME: Check that there are no control statements inside.  */
115       s++;  /* Skip '>'.  */
116       while (*s == '\n')
117         s++;
118       err = gpgme_data_new_from_mem (&ctx->help_data_1, s, s2-s, 1);
119     }
120   else 
121     err = GPGME_Invalid_Value;
122
123   if (err)
124     goto leave;
125
126   _gpgme_engine_set_status_handler (ctx->engine, genkey_status_handler, ctx);
127   _gpgme_engine_set_verbosity (ctx->engine, ctx->verbosity);
128
129   err = _gpgme_engine_op_genkey (ctx->engine, ctx->help_data_1, ctx->use_armor,
130                                  pubkey, seckey);
131
132  leave:
133   if (err)
134     {
135       ctx->pending = 0; 
136       _gpgme_engine_release (ctx->engine);
137       ctx->engine = NULL;
138     }
139   return err;
140 }
141
142
143 /**
144  * gpgme_op_genkey:
145  * @c: the context
146  * @parms: XML string with the key parameters
147  * @pubkey: Returns the public key
148  * @seckey: Returns the secret key
149  * 
150  * Generate a new key and store the key in the default keyrings if
151  * both @pubkey and @seckey are NULL.  If @pubkey and @seckey are
152  * given, the newly created key will be returned in these data
153  * objects.  This function just starts the gheneration and does not
154  * wait for completion.
155  *
156  * Here is an example on how @parms should be formatted; for deatils
157  * see the file doc/DETAILS from the GnuPG distribution.
158  *
159  * <literal>
160  * <![CDATA[
161  * <GnupgKeyParms format="internal">
162  * Key-Type: DSA
163  * Key-Length: 1024
164  * Subkey-Type: ELG-E
165  * Subkey-Length: 1024
166  * Name-Real: Joe Tester
167  * Name-Comment: with stupid passphrase
168  * Name-Email: joe@foo.bar
169  * Expire-Date: 0
170  * Passphrase: abc
171  * </GnupgKeyParms>
172  * ]]>
173  * </literal> 
174  *
175  * Strings should be given in UTF-8 encoding.  The format we support
176  * for now is only "internal".  The content of the
177  * &lt;GnupgKeyParms&gt; container is passed verbatim to GnuPG.
178  * Control statements are not allowed.
179  * 
180  * Return value: 0 for success or an error code
181  **/
182 GpgmeError
183 gpgme_op_genkey_start (GpgmeCtx ctx, const char *parms,
184                        GpgmeData pubkey, GpgmeData seckey)
185 {
186   return _gpgme_op_genkey_start (ctx, 0, parms, pubkey, seckey);
187 }
188
189
190 /**
191  * gpgme_op_genkey:
192  * @c: the context
193  * @parms: XML string with the key parameters
194  * @pubkey: Returns the public key
195  * @seckey: Returns the secret key
196  * @fpr: Returns the fingerprint of the key.
197  *
198  * Generate a new key and store the key in the default keyrings if both
199  * @pubkey and @seckey are NULL.  If @pubkey and @seckey are given, the newly
200  * created key will be returned in these data objects.
201  * See gpgme_op_genkey_start() for a description of @parms.
202  * 
203  * Return value: 0 for success or an error code
204  **/
205 GpgmeError
206 gpgme_op_genkey (GpgmeCtx ctx, const char *parms,
207                  GpgmeData pubkey, GpgmeData seckey,
208                  char **fpr)
209 {
210   GpgmeError err = _gpgme_op_genkey_start (ctx, 1, parms, pubkey, seckey);
211   if (!err)
212     err = _gpgme_wait_one (ctx);
213   if (!err && fpr)
214     {
215       if (ctx->result.genkey->fpr)
216         {
217           *fpr = strdup (ctx->result.genkey->fpr);
218           if (!*fpr)
219             return GPGME_Out_Of_Core;
220         }
221       else
222         *fpr = NULL;
223     }
224   return err;
225 }