Fix comment indentation.
[gpgme.git] / gpgme / passphrase.c
1 /* passphrase.c -  passphrase functions
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 <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <assert.h>
28
29 #include "util.h"
30 #include "context.h"
31 #include "ops.h"
32
33
34 struct passphrase_result_s
35 {
36   int no_passphrase;
37   void *last_pw_handle;
38   char *userid_hint;
39   char *passphrase_info;
40   int bad_passphrase;
41 };
42
43
44 void
45 _gpgme_release_passphrase_result (PassphraseResult result)
46 {
47   if (!result)
48     return;
49   free (result->passphrase_info);
50   free (result->userid_hint);
51   free (result);
52 }
53
54
55 GpgmeError
56 _gpgme_passphrase_status_handler (GpgmeCtx ctx, GpgmeStatusCode code, char *args)
57 {
58   test_and_allocate_result (ctx, passphrase);
59
60   switch (code)
61     {
62     case GPGME_STATUS_USERID_HINT:
63       free (ctx->result.passphrase->userid_hint);
64       if (!(ctx->result.passphrase->userid_hint = strdup (args)))
65         return GPGME_Out_Of_Core;
66       break;
67
68     case GPGME_STATUS_BAD_PASSPHRASE:
69       ctx->result.passphrase->bad_passphrase++;
70       ctx->result.passphrase->no_passphrase = 0;
71       break;
72
73     case GPGME_STATUS_GOOD_PASSPHRASE:
74       ctx->result.passphrase->bad_passphrase = 0;
75       ctx->result.passphrase->no_passphrase = 0;
76       break;
77
78     case GPGME_STATUS_NEED_PASSPHRASE:
79     case GPGME_STATUS_NEED_PASSPHRASE_SYM:
80       free (ctx->result.passphrase->passphrase_info);
81       ctx->result.passphrase->passphrase_info = strdup (args);
82       if (!ctx->result.passphrase->passphrase_info)
83         return GPGME_Out_Of_Core;
84       break;
85
86     case GPGME_STATUS_MISSING_PASSPHRASE:
87       DEBUG0 ("missing passphrase - stop\n");;
88       ctx->result.passphrase->no_passphrase = 1;
89       break;
90
91     case GPGME_STATUS_EOF:
92       if (ctx->result.passphrase->no_passphrase
93           || ctx->result.passphrase->bad_passphrase)
94         return GPGME_No_Passphrase;
95       break;
96
97     default:
98       /* Ignore all other codes.  */
99       break;
100     }
101   return 0;
102 }
103
104
105 GpgmeError
106 _gpgme_passphrase_command_handler (void *opaque, GpgmeStatusCode code,
107                                    const char *key, const char **result)
108 {
109   GpgmeCtx ctx = opaque;
110
111   if (!ctx->result.passphrase)
112     {
113       ctx->result.passphrase = calloc (1, sizeof *ctx->result.passphrase);
114       if (!ctx->result.passphrase)
115         return GPGME_Out_Of_Core;
116     }
117
118   if (!code)
119     {
120       /* We have been called for cleanup.  */
121       if (ctx->passphrase_cb)
122         { 
123           /* Fixme: Take the key in account.  */
124           ctx->passphrase_cb (ctx->passphrase_cb_value, NULL, 
125                               &ctx->result.passphrase->last_pw_handle);
126         }
127       *result = NULL;
128       return 0;
129     }
130
131   if (!key || !ctx->passphrase_cb)
132     {
133       *result = NULL;
134       return 0;
135     }
136     
137   if (code == GPGME_STATUS_GET_HIDDEN && !strcmp (key, "passphrase.enter"))
138     {
139       const char *userid_hint = ctx->result.passphrase->userid_hint;
140       const char *passphrase_info = ctx->result.passphrase->passphrase_info;
141       int bad_passphrase = ctx->result.passphrase->bad_passphrase;
142       char *buf;
143
144       ctx->result.passphrase->bad_passphrase = 0;
145       if (!userid_hint)
146         userid_hint = "[User ID hint missing]";
147       if (!passphrase_info)
148         passphrase_info = "[passphrase info missing]";
149       buf = malloc (20 + strlen (userid_hint)
150                         + strlen (passphrase_info) + 3);
151       if (!buf)
152         return GPGME_Out_Of_Core;
153       sprintf (buf, "%s\n%s\n%s",
154                bad_passphrase ? "TRY_AGAIN":"ENTER",
155                userid_hint, passphrase_info);
156
157       *result = ctx->passphrase_cb (ctx->passphrase_cb_value, buf,
158                                     &ctx->result.passphrase->last_pw_handle);
159       free (buf);
160       return 0;
161     }
162
163   *result = NULL;
164   return 0;
165 }
166
167
168 GpgmeError
169 _gpgme_passphrase_start (GpgmeCtx ctx)
170 {
171   GpgmeError err = 0;
172
173   if (ctx->passphrase_cb)
174     err = _gpgme_engine_set_command_handler (ctx->engine,
175                                              _gpgme_passphrase_command_handler,
176                                              ctx, NULL);
177   return err;
178 }