54ec97fba47a987ab502c008e4d3bba04f837626
[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     if (!c)
69         return;
70     _gpgme_gpg_release ( c->gpg ); 
71     _gpgme_release_result ( c );
72     gpgme_key_release ( c->tmp_key );
73     gpgme_data_release ( c->help_data_1 );
74     gpgme_data_release ( c->notation );
75     gpgme_signers_clear (c);
76     if (c->signers)
77         xfree (c->signers);
78     /* fixme: release the key_queue */
79     xfree (c);
80 }
81
82
83 void
84 _gpgme_release_result ( GpgmeCtx c )
85 {
86     switch (c->result_type) {
87       case RESULT_TYPE_NONE:
88         break;
89       case RESULT_TYPE_VERIFY:
90         _gpgme_release_verify_result ( c->result.verify );
91         break;
92       case RESULT_TYPE_DECRYPT:
93         _gpgme_release_decrypt_result ( c->result.decrypt );
94         break;
95       case RESULT_TYPE_SIGN:
96         _gpgme_release_sign_result ( c->result.sign );
97         break;
98     }
99
100     c->result.verify = NULL;
101     c->result_type = RESULT_TYPE_NONE;
102 }
103
104
105 /**
106  * gpgme_cancel:
107  * @c: the context
108  * 
109  * Cancel the current operation.  It is not guaranteed that it will work for
110  * all kinds of operations.  It is especially useful in a passphrase callback
111  * to stop the system from asking another time for the passphrase.
112  **/
113
114 void
115 gpgme_cancel (GpgmeCtx c)
116 {
117     c->cancel = 1;
118 }
119
120 /**
121  * gpgme_get_notation:
122  * @c: the context 
123  * 
124  * If there is notation data available from the last signature check, this
125  * function may be used to return this notation data as a string.  The string
126  * is an XML represantaton of that data embedded in a %<notation> container.
127  * 
128  * Return value: An XML string or NULL if no notation data is available.
129  **/
130 char *
131 gpgme_get_notation ( GpgmeCtx c )
132 {
133     if ( !c->notation )
134         return NULL;
135     return _gpgme_data_get_as_string ( c->notation );
136 }
137
138 /**
139  * gpgme_set_armor:
140  * @c: the contect 
141  * @yes: boolean value to set or clear that flag
142  * 
143  * Enable or disable the use of an ascii armor for all output.  
144  **/
145 void
146 gpgme_set_armor ( GpgmeCtx c, int yes )
147 {
148     if ( !c )
149         return; /* oops */
150     c->use_armor = yes;
151 }
152
153 /**
154  * gpgme_set_textmode:
155  * @c: the context 
156  * @yes: boolean flag whether textmode should be enabled
157  * 
158  * Enable or disable the use of the special textmode.  Textmode is for example
159  * used for MIME (RFC2015) signatures
160  **/
161 void
162 gpgme_set_textmode ( GpgmeCtx c, int yes )
163 {
164     if ( !c )
165         return; /* oops */
166     c->use_textmode = yes;
167 }
168
169 /**
170  * gpgme_set_keylist_mode:
171  * @c: the context
172  * @mode: listing mode
173  * 
174  * This function changes the default behaviour of the keylisting functions.
175  * Defines values for @mode are: %0 = normal, %1 = fast listing without
176  * information about key validity.
177  **/
178 void
179 gpgme_set_keylist_mode ( GpgmeCtx c, int mode )
180 {
181     if (!c)
182         return;
183     c->keylist_mode = mode;
184 }
185
186
187 /**
188  * gpgme_set_passphrase_cb:
189  * @c: the context 
190  * @cb: A callback function
191  * @cb_value: The value passed to the callback function
192  * 
193  * This function sets a callback function to be used to pass a passphrase
194  * to gpg. The preferred way to handle this is by using the gpg-agent, but
195  * because that beast is not ready for real use, you can use this passphrase
196  * thing.
197  *
198  * The callback function is defined as:
199  * <literal>
200  * typedef const char *(*GpgmePassphraseCb)(void*cb_value,
201  *                                          const char *desc,
202  *                                          void *r_hd);
203  * </literal>
204  * and called whenever gpgme needs a passphrase. DESC will have a nice
205  * text, to be used to prompt for the passphrase and R_HD is just a parameter
206  * to be used by the callback it self.  Becuase the callback returns a const
207  * string, the callback might want to know when it can release resources
208  * assocated with that returned string; gpgme helps here by calling this
209  * passphrase callback with an DESC of %NULL as soon as it does not need
210  * the returned string anymore.  The callback function might then choose
211  * to release resources depending on R_HD.
212  *
213  **/
214 void
215 gpgme_set_passphrase_cb ( GpgmeCtx c, GpgmePassphraseCb cb, void *cb_value )
216 {
217     c->passphrase_cb = cb;
218     c->passphrase_cb_value = cb_value;
219 }
220
221 /**
222  * gpgme_set_pprogress_cb:
223  * @c: the context 
224  * @cb: A callback function
225  * @cb_value: The value passed to the callback function
226  * 
227  * This function sets a callback function to be used as a progress indicator.
228  *
229  * The callback function is defined as:
230  * <literal>
231  * typedef void (*GpgmeProgressCb) (void*cb_value,
232  *                                  const char *what, int type,
233  *                                  int curretn, int total);
234  * </literal>
235  * For details on the progress events, see the entry for the PROGRESS
236  * status in the file doc/DETAILS of the GnuPG distribution.
237  **/
238 void
239 gpgme_set_progress_cb ( GpgmeCtx c, GpgmeProgressCb cb, void *cb_value )
240 {
241     c->progress_cb = cb;
242     c->progress_cb_value = cb_value;
243 }
244
245
246
247
248
249
250
251
252