doc/
[gpgme.git] / gpgme / gpgme.h
1 /* gpgme.h -  GnuPG Made Easy
2  *      Copyright (C) 2000 Werner Koch (dd9jn)
3  *      Copyright (C) 2001, 2002 g10 Code GmbH
4  *
5  * This file is part of GPGME.
6  *
7  * GPGME is free software; you can redistribute it and/or modify
8  * it 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,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #ifndef GPGME_H
23 #define GPGME_H
24
25 #include <stdio.h> /* For FILE *.  */
26 #ifdef _MSC_VER
27   typedef long off_t;
28 #else
29 # include <sys/types.h>
30 #endif
31
32 #ifdef __cplusplus
33 extern "C" { 
34 #if 0 /* just to make Emacs auto-indent happy */
35 }
36 #endif
37 #endif
38
39
40 /* The version of this header should match the one of the library.  Do
41    not use this symbol in your application, use gpgme_check_version
42    instead.  The purpose of this macro is to let autoconf (using the
43    AM_PATH_GPGME macro) check that this header matches the installed
44    library.  Warning: Do not edit the next line.  configure will do
45    that for you!  */
46 #define GPGME_VERSION "0.3.0a-cvs"
47
48
49 /* The opaque data types used by GPGME.  */
50
51 /* The context holds some global state and configration options as
52    well as the results of a crypto operation.  */
53 struct gpgme_context_s;
54 typedef struct gpgme_context_s *GpgmeCtx;
55
56 /* The data object used by GPGME to exchange arbitrary data.  */
57 struct gpgme_data_s;
58 typedef struct gpgme_data_s *GpgmeData;
59
60 /* A list of recipients to be used in an encryption operation.  */
61 struct gpgme_recipients_s;
62 typedef struct gpgme_recipients_s *GpgmeRecipients;
63
64 /* A key from the keyring.  */
65 struct gpgme_key_s;
66 typedef struct gpgme_key_s *GpgmeKey;
67
68 /* A trust item.  */
69 struct gpgme_trust_item_s;
70 typedef struct gpgme_trust_item_s *GpgmeTrustItem;
71
72
73 /* The error numbers used by GPGME.  */
74 typedef enum
75   {
76     GPGME_EOF               = -1,
77     GPGME_No_Error          = 0,
78     GPGME_General_Error     = 1,
79     GPGME_Out_Of_Core       = 2,
80     GPGME_Invalid_Value     = 3,
81     GPGME_Busy              = 4,
82     GPGME_No_Request        = 5,
83     GPGME_Exec_Error        = 6,
84     GPGME_Too_Many_Procs    = 7,
85     GPGME_Pipe_Error        = 8,
86     GPGME_No_Recipients     = 9,
87     GPGME_No_Data           = 10,
88     GPGME_Conflict          = 11,
89     GPGME_Not_Implemented   = 12,
90     GPGME_Read_Error        = 13,
91     GPGME_Write_Error       = 14,
92     GPGME_Invalid_Type      = 15,
93     GPGME_Invalid_Mode      = 16,
94     GPGME_File_Error        = 17,  /* errno is set in this case.  */
95     GPGME_Decryption_Failed = 18,
96     GPGME_No_Passphrase     = 19,
97     GPGME_Canceled          = 20,
98     GPGME_Invalid_Key       = 21,
99     GPGME_Invalid_Engine    = 22
100   }
101 GpgmeError;
102
103 /* The possible types of GpgmeData objects.  */
104 typedef enum
105   {
106     GPGME_DATA_TYPE_NONE = 0,
107     GPGME_DATA_TYPE_MEM  = 1,
108     GPGME_DATA_TYPE_FD   = 2,
109     GPGME_DATA_TYPE_FILE = 3,
110     GPGME_DATA_TYPE_CB   = 4
111   }
112 GpgmeDataType;
113
114 /* The possible signature stati.  */
115 typedef enum
116   {
117     GPGME_SIG_STAT_NONE  = 0,
118     GPGME_SIG_STAT_GOOD  = 1,
119     GPGME_SIG_STAT_BAD   = 2,
120     GPGME_SIG_STAT_NOKEY = 3,
121     GPGME_SIG_STAT_NOSIG = 4,
122     GPGME_SIG_STAT_ERROR = 5,
123     GPGME_SIG_STAT_DIFF  = 6
124   }
125 GpgmeSigStat;
126
127 /* The available signature modes.  */
128 typedef enum
129   {
130     GPGME_SIG_MODE_NORMAL = 0,
131     GPGME_SIG_MODE_DETACH = 1,
132     GPGME_SIG_MODE_CLEAR  = 2
133   }
134 GpgmeSigMode;
135
136 /* The available key attributes.  */
137 typedef enum
138   {
139     GPGME_ATTR_KEYID        = 1,
140     GPGME_ATTR_FPR          = 2,
141     GPGME_ATTR_ALGO         = 3,
142     GPGME_ATTR_LEN          = 4,
143     GPGME_ATTR_CREATED      = 5,
144     GPGME_ATTR_EXPIRE       = 6,
145     GPGME_ATTR_OTRUST       = 7,
146     GPGME_ATTR_USERID       = 8,
147     GPGME_ATTR_NAME         = 9,
148     GPGME_ATTR_EMAIL        = 10,
149     GPGME_ATTR_COMMENT      = 11,
150     GPGME_ATTR_VALIDITY     = 12,
151     GPGME_ATTR_LEVEL        = 13,
152     GPGME_ATTR_TYPE         = 14,
153     GPGME_ATTR_IS_SECRET    = 15,
154     GPGME_ATTR_KEY_REVOKED  = 16,
155     GPGME_ATTR_KEY_INVALID  = 17,
156     GPGME_ATTR_UID_REVOKED  = 18,
157     GPGME_ATTR_UID_INVALID  = 19,
158     GPGME_ATTR_KEY_CAPS     = 20,
159     GPGME_ATTR_CAN_ENCRYPT  = 21,
160     GPGME_ATTR_CAN_SIGN     = 22,
161     GPGME_ATTR_CAN_CERTIFY  = 23,
162     GPGME_ATTR_KEY_EXPIRED  = 24,
163     GPGME_ATTR_KEY_DISABLED = 25
164   }
165 GpgmeAttr;
166
167 /* The available validities for a trust item or key.  */
168 typedef enum
169   {
170     GPGME_VALIDITY_UNKNOWN   = 0,
171     GPGME_VALIDITY_UNDEFINED = 1,
172     GPGME_VALIDITY_NEVER     = 2,
173     GPGME_VALIDITY_MARGINAL  = 3,
174     GPGME_VALIDITY_FULL      = 4,
175     GPGME_VALIDITY_ULTIMATE  = 5
176   }
177 GpgmeValidity;
178
179 /* The available protocols.  */
180 typedef enum
181   {
182     GPGME_PROTOCOL_OpenPGP = 0,  /* The default mode.  */
183     GPGME_PROTOCOL_CMS     = 1,
184     GPGME_PROTOCOL_AUTO    = 2
185   }
186 GpgmeProtocol;
187
188
189 /* Types for callback functions.  */
190
191 /* Request a passphrase from the user.  */
192 typedef const char *(*GpgmePassphraseCb) (void *hook, const char *desc,
193                                           void **r_hd);
194
195 /* Inform the user about progress made.  */
196 typedef void (*GpgmeProgressCb) (void *opaque, const char *what,
197                                  int type, int current, int total);
198
199
200 /* Context management functions.  */
201
202 /* Create a new context and return it in CTX.  */
203 GpgmeError gpgme_new (GpgmeCtx *ctx);
204
205 /* Release the context CTX.  */
206 void gpgme_release (GpgmeCtx ctx);
207
208 /* Retrieve more info about performed signature check.  */
209 char *gpgme_get_notation (GpgmeCtx ctx);
210
211 /* Set the protocol to be used by CTX to PROTO.  */
212 GpgmeError gpgme_set_protocol (GpgmeCtx ctx, GpgmeProtocol proto);
213
214 /* If YES is non-zero, enable armor mode in CTX, disable it otherwise.  */
215 void gpgme_set_armor (GpgmeCtx ctx, int yes);
216
217 /* Return non-zero if armor mode is set in CTX.  */
218 int gpgme_get_armor (GpgmeCtx ctx);
219
220 /* If YES is non-zero, enable text mode in CTX, disable it otherwise.  */
221 void gpgme_set_textmode (GpgmeCtx ctx, int yes);
222
223 /* Return non-zero if text mode is set in CTX.  */
224 int gpgme_get_textmode (GpgmeCtx ctx);
225
226 /* Set keylist mode in CTX to MODE.  */
227 void gpgme_set_keylist_mode (GpgmeCtx ctx, int mode);
228
229 /* Set the passphrase callback function in CTX to CB.  HOOK_VALUE is
230    passed as first argument to the passphrase callback function.  */
231 void gpgme_set_passphrase_cb (GpgmeCtx ctx,
232                               GpgmePassphraseCb cb, void *hook_value);
233
234 /* Set the progress callback function in CTX to CB.  HOOK_VALUE is
235    passed as first argument to the progress callback function.  */
236 void gpgme_set_progress_cb (GpgmeCtx c, GpgmeProgressCb cb, void *hook_value);
237
238 /* Delete all signers from CTX.  */
239 void gpgme_signers_clear (GpgmeCtx ctx);
240
241 /* Add KEY to list of signers in CTX.  */
242 GpgmeError gpgme_signers_add (GpgmeCtx ctx, const GpgmeKey key);
243
244 /* Return the SEQth signer's key in CTX.  */
245 GpgmeKey gpgme_signers_enum (const GpgmeCtx ctx, int seq);
246
247 /* Retrieve the signature status of signature IDX in CTX after a
248    successful verify operation in R_STAT (if non-null).  The creation
249    time stamp of the signature is returned in R_CREATED (if non-null).
250    The function returns a string containing the fingerprint.  */
251 const char *gpgme_get_sig_status (GpgmeCtx ctx, int idx,
252                                   GpgmeSigStat *r_stat, time_t *r_created);
253
254 /* Get the key used to create signature IDX in CTX and return it in
255    R_KEY.  */
256 GpgmeError gpgme_get_sig_key (GpgmeCtx ctx, int idx, GpgmeKey *r_key);
257
258 /* Return a string with more info about the last crypto operating in CTX.
259    RESERVED should be zero.  The user has to free the string.  */
260 char *gpgme_get_op_info (GpgmeCtx ctx, int reserved);
261
262
263 /* Run control.  */
264
265 /* Cancel a pending operation in CTX.  */
266 void       gpgme_cancel (GpgmeCtx ctx);
267
268 /* Process the pending operation and, if HANG is non-zero, wait for
269    the pending operation to finish.  */
270 GpgmeCtx gpgme_wait (GpgmeCtx ctx, int hang);
271
272
273 /* Functions to handle recipients.  */
274
275 /* Create a new recipients set and return it in R_RSET.  */
276 GpgmeError gpgme_recipients_new (GpgmeRecipients *r_rset);
277
278 /* Release the recipients set RSET.  */
279 void gpgme_recipients_release (GpgmeRecipients rset);
280
281 /* Add NAME to the recipients set RSET.  */
282 GpgmeError gpgme_recipients_add_name (GpgmeRecipients rset, const char *name);
283
284 /* Add NAME with validity AL to the recipients set RSET.  */
285 GpgmeError gpgme_recipients_add_name_with_validity (GpgmeRecipients rset,
286                                                     const char *name,
287                                                     GpgmeValidity val);
288
289 /* Return the number of recipients in RSET.  */
290 unsigned int gpgme_recipients_count (const GpgmeRecipients rset);
291
292 /* Create a new enumeration handle for the recipients set RSET and
293    return it in ITER.  */
294 GpgmeError gpgme_recipients_enum_open (const GpgmeRecipients rset,
295                                        void **iter);
296
297 /* Return the next recipient from the recipient set RSET in the
298    enumerator ITER.  */
299 const char *gpgme_recipients_enum_read (const GpgmeRecipients rset,
300                                         void **iter);
301
302 /* Destroy the enumerator ITER for the recipient set RSET.  */
303 GpgmeError gpgme_recipients_enum_close (const GpgmeRecipients rset,
304                                         void **iter);
305
306
307 /* Functions to handle data objects.  */
308
309 /* Create a new data buffer and return it in R_DH.  */
310 GpgmeError gpgme_data_new (GpgmeData *r_dh);
311
312 /* Create a new data buffer filled with SIZE bytes starting from
313    BUFFER.  If COPY is zero, copying is delayed until necessary, and
314    the data is taken from the original location when needed.  */
315 GpgmeError gpgme_data_new_from_mem (GpgmeData *r_dh,
316                                     const char *buffer, size_t size,
317                                     int copy);
318
319 /* Create a new data buffer which retrieves the data from the callback
320    function READ_CB.  */
321 GpgmeError gpgme_data_new_with_read_cb (GpgmeData *r_dh,
322                                         int (*read_cb) (void*,char *,size_t,size_t*),
323                                         void *read_cb_value);
324
325 /* Create a new data buffer filled with the content of file FNAME.
326    COPY must be non-zero (delayed reads are not supported yet).  */
327 GpgmeError gpgme_data_new_from_file (GpgmeData *r_dh,
328                                      const char *fname,
329                                      int copy);
330
331 /* Create a new data buffer filled with LENGTH bytes starting from
332    OFFSET within the file FNAME or stream FP (exactly one must be
333    non-zero).  */
334 GpgmeError gpgme_data_new_from_filepart (GpgmeData *r_dh,
335                                          const char *fname, FILE *fp,
336                                          off_t offset, size_t length);
337
338 /* Destroy the data buffer DH.  */
339 void gpgme_data_release (GpgmeData dh);
340
341 /* Destroy the data buffer DH and return a pointer to its content.
342    The memory has be to released with free by the user.  It's size is
343    returned in R_LEN.  */
344 char *gpgme_data_release_and_get_mem (GpgmeData dh, size_t *r_len);
345
346 /* Return the type of the data buffer DH.  */
347 GpgmeDataType gpgme_data_get_type (GpgmeData dh);
348
349 /* Reset the read pointer in DH.  */
350 GpgmeError gpgme_data_rewind (GpgmeData dh);
351
352 /* Read LENGTH bytes from the data object DH and store them in the
353    memory starting at BUFFER.  The number of bytes actually read is
354    returned in NREAD.  */
355 GpgmeError gpgme_data_read (GpgmeData dh, char *buffer,
356                             size_t length, size_t *nread);
357
358 /* Write LENGTH bytes starting from BUFFER into the data object DH.  */
359 GpgmeError gpgme_data_write (GpgmeData dh, const char *buffer, size_t length);
360
361
362 /* Key and trust functions.  */
363
364 /* Acquire a reference to KEY.  */
365 void gpgme_key_ref (GpgmeKey key);
366
367 /* Release a reference to KEY.  If this was the last one the key is
368    destroyed.  */
369 void gpgme_key_unref (GpgmeKey key);
370 void gpgme_key_release (GpgmeKey key);
371
372 /* Get the data from key KEY in a XML string, which has to be released
373    with free by the user.  */
374 char *gpgme_key_get_as_xml (GpgmeKey key);
375
376 /* Return the value of the attribute WHAT of KEY, which has to be
377    representable by a string.  IDX specifies a running index if the
378    attribute appears more than once in the key.  */
379 const char *gpgme_key_get_string_attr (GpgmeKey key, GpgmeAttr what,
380                                        const void *reserved, int idx);
381
382 /* Return the value of the attribute WHAT of KEY, which has to be
383    representable by an unsigned integer.  IDX specifies a running
384    index if the attribute appears more than once in the key.  */
385 unsigned long gpgme_key_get_ulong_attr (GpgmeKey key, GpgmeAttr what,
386                                         const void *reserved, int idx);
387
388 /* Release the trust item ITEM.  */
389 void gpgme_trust_item_release (GpgmeTrustItem item);
390
391 /* Return the value of the attribute WHAT of ITEM, which has to be
392    representable by a string.  IDX specifies a running index if the
393    attribute appears more than once in the key.  */
394 const char *gpgme_trust_item_get_string_attr (GpgmeTrustItem item,
395                                               GpgmeAttr what,
396                                               const void *reserved, int idx);
397
398 /* Return the value of the attribute WHAT of KEY, which has to be
399    representable by an integer.  IDX specifies a running index if the
400    attribute appears more than once in the key.  */
401 int gpgme_trust_item_get_int_attr (GpgmeTrustItem item, GpgmeAttr what,
402                                    const void *reserved, int idx);
403
404
405 /* Crypto operation function.  */
406
407 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
408    store the resulting ciphertext in CIPHER.  */
409 GpgmeError gpgme_op_encrypt_start (GpgmeCtx ctx,
410                                    GpgmeRecipients recp,
411                                    GpgmeData plain, GpgmeData cipher);
412 GpgmeError gpgme_op_encrypt (GpgmeCtx ctx,
413                              GpgmeRecipients recp,
414                              GpgmeData plain, GpgmeData cipher);
415
416 /* Decrypt ciphertext CIPHER within CTX and store the resulting
417    plaintext in PLAIN.  */
418 GpgmeError gpgme_op_decrypt_start (GpgmeCtx ctx,
419                                    GpgmeData cipher, GpgmeData plain);
420 GpgmeError gpgme_op_decrypt (GpgmeCtx ctx,
421                              GpgmeData cipher, GpgmeData plain);
422
423 /* Decrypt ciphertext CIPHER and make a signature verification within
424    CTX and store the resulting plaintext in PLAIN.  */
425 GpgmeError gpgme_op_decrypt_verify_start (GpgmeCtx ctx,
426                                           GpgmeData cipher, GpgmeData plain);
427 GpgmeError gpgme_op_decrypt_verify (GpgmeCtx ctx,
428                                     GpgmeData cipher, GpgmeData plain,
429                                     GpgmeSigStat *r_status);
430
431 /* Sign the plaintext PLAIN and store the signature in SIG.  Only
432    detached signatures are supported for now.  */
433 GpgmeError gpgme_op_sign_start (GpgmeCtx ctx,
434                                 GpgmeData plain, GpgmeData sig,
435                                 GpgmeSigMode mode);
436 GpgmeError gpgme_op_sign (GpgmeCtx ctx,
437                           GpgmeData plain, GpgmeData sig,
438                           GpgmeSigMode mode);
439
440 /* Verify within CTX that SIG is a valid signature for TEXT.  */
441 GpgmeError gpgme_op_verify_start (GpgmeCtx ctx,
442                                   GpgmeData sig, GpgmeData text);
443 GpgmeError gpgme_op_verify (GpgmeCtx ctx,
444                             GpgmeData sig, GpgmeData text,
445                             GpgmeSigStat *r_status);
446
447 /* Import the key in KEYDATA into the keyring.  */
448 GpgmeError gpgme_op_import_start (GpgmeCtx ctx, GpgmeData keydata);
449 GpgmeError gpgme_op_import (GpgmeCtx ctx, GpgmeData keydata);
450
451 /* Export the keys listed in RECP into KEYDATA.  */
452 GpgmeError gpgme_op_export_start (GpgmeCtx ctx, GpgmeRecipients recp,
453                                   GpgmeData keydata);
454 GpgmeError gpgme_op_export (GpgmeCtx ctx, GpgmeRecipients recp,
455                             GpgmeData keydata);
456
457 /* Generate a new keypair and add it to the keyring.  PUBKEY and
458    SECKEY should be null for now.  PARMS specifies what keys should be
459    generated.  */
460 GpgmeError gpgme_op_genkey_start (GpgmeCtx ctx, const char *parms,
461                                   GpgmeData pubkey, GpgmeData seckey);
462 GpgmeError gpgme_op_genkey (GpgmeCtx ctx, const char *parms,
463                             GpgmeData pubkey, GpgmeData seckey);
464
465 /* Delete KEY from the keyring.  If ALLOW_SECRET is non-zero, secret
466    keys are also deleted.  */
467 GpgmeError gpgme_op_delete_start (GpgmeCtx ctx, const GpgmeKey key,
468                                   int allow_secret);
469 GpgmeError gpgme_op_delete (GpgmeCtx ctx, const GpgmeKey key,
470                             int allow_secret);
471
472
473 /* Key management functions */
474
475 /* Start a keylist operation within CTX, searching for keys which
476    match PATTERN.  If SECRET_ONLY is true, only secret keys are
477    returned.  */
478 GpgmeError gpgme_op_keylist_start (GpgmeCtx ctx,
479                                    const char *pattern, int secret_only);
480
481 /* Return the next key from the keylist in R_KEY.  */
482 GpgmeError gpgme_op_keylist_next (GpgmeCtx ctx, GpgmeKey *r_key);
483
484 /* Terminate a pending keylist operation within CTX.  */
485 GpgmeError gpgme_op_keylist_end (GpgmeCtx ctx);
486
487
488 /* Start a trustlist operation within CTX, searching for trust items
489    which match PATTERN.  */
490 GpgmeError gpgme_op_trustlist_start (GpgmeCtx ctx,
491                                      const char *pattern, int max_level);
492
493 /* Return the next trust item from the trustlist in R_ITEM.  */
494 GpgmeError gpgme_op_trustlist_next (GpgmeCtx ctx, GpgmeTrustItem *r_item);
495
496 /* Terminate a pending trustlist operation within CTX.  */
497 GpgmeError gpgme_op_trustlist_end (GpgmeCtx ctx);
498
499
500 /* Various functions.  */
501
502 /* Check that the library fulfills the version requirement.  */
503 const char *gpgme_check_version (const char *req_version);
504
505 /* Check that the backend engine is available.  DEPRECATED.  */
506 GpgmeError  gpgme_check_engine (void);
507
508 /* Retrieve information about the backend engines.  */
509 const char *gpgme_get_engine_info (void);
510
511 /* Return a string describing ERR.  */
512 const char *gpgme_strerror (GpgmeError err);
513
514 /* Register an idle function.  */
515 typedef void (*GpgmeIdleFunc)(void);
516 GpgmeIdleFunc gpgme_register_idle (GpgmeIdleFunc idle);
517
518
519 /* Engine support functions.  */
520
521 /* Verify that the engine implementing PROTO is installed and
522    available.  */
523 GpgmeError gpgme_engine_check_version (GpgmeProtocol proto);
524
525
526 #ifdef __cplusplus
527 }
528 #endif
529 #endif /* GPGME_H */