Add a passphrase callback and minor changes to the interface
[gpgme.git] / gpgme / gpgme.c
1 /* gpgme.c -  GnuPG Made Easy
2  *      Copyright (C) 2000 Werner Koch (dd9jn)
3  *
4  * This file is part of GPGME.
5  *
6  * GPGME is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GPGME is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <assert.h>
25
26 #include "util.h"
27 #include "context.h"
28 #include "ops.h"
29
30 #define my_isdigit(a)  ( (a) >='0' && (a) <= '9' )
31 #define my_isxdigit(a) ( my_isdigit((a))               \
32                          || ((a) >= 'A' && (a) <= 'F') \
33                          || ((a) >= 'f' && (a) <= 'f') )
34
35 /**
36  * gpgme_new:
37  * @r_ctx: Returns the new context
38  * 
39  * Create a new context to be used with most of the other GPGME
40  * functions.  Use gpgme_release_contect() to release all resources
41  *
42  * Return value: An error code 
43  **/
44 GpgmeError
45 gpgme_new (GpgmeCtx *r_ctx)
46 {
47     GpgmeCtx c;
48
49     c = xtrycalloc ( 1, sizeof *c );
50     if (!c)
51         return mk_error (Out_Of_Core);
52     c->verbosity = 1;
53     c->use_armor = 1; /* fixme: reset this to 0 */
54     *r_ctx = c;
55
56     return 0;
57 }
58
59 /**
60  * gpgme_release:
61  * @c: Context to be released. 
62  * 
63  * Release all resources associated with the given context.
64  **/
65 void
66 gpgme_release ( GpgmeCtx c )
67 {
68     
69     _gpgme_gpg_release ( c->gpg ); 
70     _gpgme_release_result ( c );
71     _gpgme_key_release ( c->tmp_key );
72     gpgme_data_release ( c->notation );
73     /* fixme: release the key_queue */
74     xfree (c);
75 }
76
77
78 void
79 _gpgme_release_result ( GpgmeCtx c )
80 {
81     switch (c->result_type) {
82       case RESULT_TYPE_NONE:
83         break;
84       case RESULT_TYPE_VERIFY:
85         _gpgme_release_verify_result ( c->result.verify );
86         break;
87       case RESULT_TYPE_DECRYPT:
88         _gpgme_release_decrypt_result ( c->result.decrypt );
89         break;
90       case RESULT_TYPE_SIGN:
91         _gpgme_release_sign_result ( c->result.sign );
92         break;
93     }
94
95     c->result.verify = NULL;
96     c->result_type = RESULT_TYPE_NONE;
97 }
98
99
100 /**
101  * gpgme_get_notation:
102  * @c: the context 
103  * 
104  * If there is notation data available from the last signature check, this
105  * function may be used to return this notation data as a string.  The string
106  * is an XML represantaton of that data embedded in a %<notation> container.
107  * 
108  * Return value: An XML string or NULL if no notation data is available.
109  **/
110 char *
111 gpgme_get_notation ( GpgmeCtx c )
112 {
113     if ( !c->notation )
114         return NULL;
115     return _gpgme_data_get_as_string ( c->notation );
116 }
117
118
119 /**
120  * gpgme_set_armor:
121  * @c: the contect 
122  * @yes: boolean value to set or clear that flag
123  * 
124  * Enable or disable the use of an ascii armor for all output.  
125  **/
126 void
127 gpgme_set_armor ( GpgmeCtx c, int yes )
128 {
129     if ( !c )
130         return; /* oops */
131     c->use_armor = yes;
132 }
133
134 /**
135  * gpgme_set_textmode:
136  * @c: the context 
137  * @yes: boolean flag whether textmode should be enabled
138  * 
139  * Enable or disable the use of the special textmode.  Textmode is for example
140  * used for MIME (RFC2015) signatures
141  **/
142 void
143 gpgme_set_textmode ( GpgmeCtx c, int yes )
144 {
145     if ( !c )
146         return; /* oops */
147     c->use_textmode = yes;
148 }
149
150 /**
151  * gpgme_set_passphrase_cb:
152  * @c: the context 
153  * @cb: A callback function
154  * @cb_value: The value passed to the callback function
155  * 
156  * This function sets a callback function to be used to pass a passphrase
157  * to gpg. The preferred way to handle this is by using the gpg-agent, but
158  * because that beast is not ready for real use, you can use this passphrase
159  * thing.
160  *
161  * The callback function is defined as:
162  * <literal>
163  * typedef const char *(*GpgmePassphraseCb)(void*cb_value,
164  *                                          const char *desc,
165  *                                          void *r_hd);
166  * </literal>
167  * and called whenever gpgme needs a passphrase. DESC will have a nice
168  * text, to be used to prompt for the passphrase and R_HD is just a parameter
169  * to be used by the callback it self.  Becuase the callback returns a const
170  * string, the callback might want to know when it can releae resources
171  * assocated with that returned string; gpgme helps here by calling this
172  * passphrase callback with an DESC of %NULL as soon as it does not need
173  * the returned string anymore.  The callback function might then choose
174  * to release resources depending on R_HD.
175  *
176  **/
177 void
178 gpgme_set_passphrase_cb ( GpgmeCtx c, GpgmePassphraseCb cb, void *cb_value )
179 {
180     c->passphrase_cb = cb;
181     c->passphrase_cb_value = cb_value;
182 }
183
184
185
186
187