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