Add an API to change passphrases. Currently only implemented for
[gpgme.git] / src / passwd.c
1 /* passwd.c - Passphrase changing function
2    Copyright (C) 2010 g10 Code GmbH
3
4    This file is part of GPGME.
5  
6    GPGME is free software; you can redistribute it and/or modify it
7    under the terms of the GNU Lesser General Public License as
8    published by the Free Software Foundation; either version 2.1 of
9    the License, or (at your option) any later version.
10    
11    GPGME is distributed in the hope that it will be useful, but
12    WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15    
16    You should have received a copy of the GNU Lesser General Public
17    License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #if HAVE_CONFIG_H
21 #include <config.h>
22 #endif
23
24 #include "gpgme.h"
25 #include "debug.h"
26 #include "context.h"
27 #include "ops.h"
28
29 \f
30 static gpgme_error_t
31 passwd_status_handler (void *priv, gpgme_status_code_t code, char *args)
32 {
33   (void)priv;
34   (void)code;
35   (void)args;
36   return 0;
37 }
38
39
40 static gpgme_error_t
41 passwd_start (gpgme_ctx_t ctx, int synchronous, gpgme_key_t key,
42               unsigned int flags)
43 {
44   gpgme_error_t err;
45
46   if (!key)
47     return gpg_error (GPG_ERR_INV_VALUE);
48   if (flags)
49     return gpg_error (GPG_ERR_INV_FLAG);
50
51   err = _gpgme_op_reset (ctx, synchronous);
52   if (err)
53     return err;
54
55   _gpgme_engine_set_status_handler (ctx->engine, passwd_status_handler, ctx);
56
57   return _gpgme_engine_op_passwd (ctx->engine, key, flags);
58 }
59
60
61
62 /* Change the passphrase for KEY.  FLAGS is reserved for future use
63    and must be passed as 0.  The engine is expected to present a user
64    interface to enter the old and the new passphrase.  This is the
65    asynchronous variant. 
66
67    Note that if ever the need arises to supply a passphrase we can do
68    this with a flag value and the passphrase callback feature.  */
69 gpgme_error_t
70 gpgme_op_passwd_start (gpgme_ctx_t ctx, gpgme_key_t key, unsigned int flags)
71 {
72   gpg_error_t err;
73   TRACE_BEG2 (DEBUG_CTX, "gpgme_op_passwd_start", ctx,
74               "key=%p, flags=0x%x", key, flags);
75   err = passwd_start (ctx, 0, key, flags);
76   return TRACE_ERR (err);
77 }
78
79
80 /* Change the passphrase for KEY.  FLAGS is reserved for future use
81    and must be passed as 0.  This is the synchronous variant.  */
82 gpgme_error_t
83 gpgme_op_passwd (gpgme_ctx_t ctx, gpgme_key_t key, unsigned int flags)
84 {
85   gpgme_error_t err;
86
87   TRACE_BEG2 (DEBUG_CTX, "gpgme_op_passwd", ctx,
88               "key=%p, flags=0x%x", key, flags);
89
90   err = passwd_start (ctx, 1, key, flags);
91   if (!err)
92     err = _gpgme_wait_one (ctx);
93   return TRACE_ERR (err);
94 }
95