468d09b37e575e33773407b8c2a7722127848a3d
[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.5"
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     GPGME_Invalid_Recipients = 23
101   }
102 GpgmeError;
103
104 /* The possible types of GpgmeData objects.  */
105 typedef enum
106   {
107     GPGME_DATA_TYPE_NONE = 0,
108     GPGME_DATA_TYPE_MEM  = 1,
109     GPGME_DATA_TYPE_FD   = 2,
110     GPGME_DATA_TYPE_FILE = 3,
111     GPGME_DATA_TYPE_CB   = 4
112   }
113 GpgmeDataType;
114
115 /* The possible signature stati.  */
116 typedef enum
117   {
118     GPGME_SIG_STAT_NONE  = 0,
119     GPGME_SIG_STAT_GOOD  = 1,
120     GPGME_SIG_STAT_BAD   = 2,
121     GPGME_SIG_STAT_NOKEY = 3,
122     GPGME_SIG_STAT_NOSIG = 4,
123     GPGME_SIG_STAT_ERROR = 5,
124     GPGME_SIG_STAT_DIFF  = 6
125   }
126 GpgmeSigStat;
127
128 /* The available signature modes.  */
129 typedef enum
130   {
131     GPGME_SIG_MODE_NORMAL = 0,
132     GPGME_SIG_MODE_DETACH = 1,
133     GPGME_SIG_MODE_CLEAR  = 2
134   }
135 GpgmeSigMode;
136
137 /* The available key attributes.  */
138 typedef enum
139   {
140     GPGME_ATTR_KEYID        = 1,
141     GPGME_ATTR_FPR          = 2,
142     GPGME_ATTR_ALGO         = 3,
143     GPGME_ATTR_LEN          = 4,
144     GPGME_ATTR_CREATED      = 5,
145     GPGME_ATTR_EXPIRE       = 6,
146     GPGME_ATTR_OTRUST       = 7,
147     GPGME_ATTR_USERID       = 8,
148     GPGME_ATTR_NAME         = 9,
149     GPGME_ATTR_EMAIL        = 10,
150     GPGME_ATTR_COMMENT      = 11,
151     GPGME_ATTR_VALIDITY     = 12,
152     GPGME_ATTR_LEVEL        = 13,
153     GPGME_ATTR_TYPE         = 14,
154     GPGME_ATTR_IS_SECRET    = 15,
155     GPGME_ATTR_KEY_REVOKED  = 16,
156     GPGME_ATTR_KEY_INVALID  = 17,
157     GPGME_ATTR_UID_REVOKED  = 18,
158     GPGME_ATTR_UID_INVALID  = 19,
159     GPGME_ATTR_KEY_CAPS     = 20,
160     GPGME_ATTR_CAN_ENCRYPT  = 21,
161     GPGME_ATTR_CAN_SIGN     = 22,
162     GPGME_ATTR_CAN_CERTIFY  = 23,
163     GPGME_ATTR_KEY_EXPIRED  = 24,
164     GPGME_ATTR_KEY_DISABLED = 25,
165     GPGME_ATTR_SERIAL       = 26,
166     GPGME_ATTR_ISSUER       = 27,
167     GPGME_ATTR_CHAINID      = 28
168   }
169 GpgmeAttr;
170
171 /* The available validities for a trust item or key.  */
172 typedef enum
173   {
174     GPGME_VALIDITY_UNKNOWN   = 0,
175     GPGME_VALIDITY_UNDEFINED = 1,
176     GPGME_VALIDITY_NEVER     = 2,
177     GPGME_VALIDITY_MARGINAL  = 3,
178     GPGME_VALIDITY_FULL      = 4,
179     GPGME_VALIDITY_ULTIMATE  = 5
180   }
181 GpgmeValidity;
182
183 /* The available protocols.  */
184 typedef enum
185   {
186     GPGME_PROTOCOL_OpenPGP = 0,  /* The default mode.  */
187     GPGME_PROTOCOL_CMS     = 1,
188     GPGME_PROTOCOL_AUTO    = 2
189   }
190 GpgmeProtocol;
191
192
193 /* The available keylist mode flags.  */
194 #define GPGME_KEYLIST_MODE_LOCAL 1
195 #define GPGME_KEYLIST_MODE_EXTERN 2
196
197
198 /* Types for callback functions.  */
199
200 /* Request a passphrase from the user.  */
201 typedef const char *(*GpgmePassphraseCb) (void *hook, const char *desc,
202                                           void **r_hd);
203
204 /* Inform the user about progress made.  */
205 typedef void (*GpgmeProgressCb) (void *opaque, const char *what,
206                                  int type, int current, int total);
207
208
209 /* Context management functions.  */
210
211 /* Create a new context and return it in CTX.  */
212 GpgmeError gpgme_new (GpgmeCtx *ctx);
213
214 /* Release the context CTX.  */
215 void gpgme_release (GpgmeCtx ctx);
216
217 /* Retrieve more info about performed signature check.  */
218 char *gpgme_get_notation (GpgmeCtx ctx);
219
220 /* Set the protocol to be used by CTX to PROTO.  */
221 GpgmeError gpgme_set_protocol (GpgmeCtx ctx, GpgmeProtocol proto);
222
223 /* If YES is non-zero, enable armor mode in CTX, disable it otherwise.  */
224 void gpgme_set_armor (GpgmeCtx ctx, int yes);
225
226 /* Return non-zero if armor mode is set in CTX.  */
227 int gpgme_get_armor (GpgmeCtx ctx);
228
229 /* If YES is non-zero, enable text mode in CTX, disable it otherwise.  */
230 void gpgme_set_textmode (GpgmeCtx ctx, int yes);
231
232 /* Return non-zero if text mode is set in CTX.  */
233 int gpgme_get_textmode (GpgmeCtx ctx);
234
235 /* Include up to NR_OF_CERTS certificates in an S/MIME message.  */
236 void gpgme_set_include_certs (GpgmeCtx ctx, int nr_of_certs);
237
238 /* Return the number of certs to include in an S/MIME message.  */
239 int gpgme_get_include_certs (GpgmeCtx ctx);
240
241 /* Set keylist mode in CTX to MODE.  */
242 GpgmeError gpgme_set_keylist_mode (GpgmeCtx ctx, int mode);
243
244 /* Get keylist mode in CTX.  */
245 int gpgme_get_keylist_mode (GpgmeCtx ctx);
246
247 /* Set the passphrase callback function in CTX to CB.  HOOK_VALUE is
248    passed as first argument to the passphrase callback function.  */
249 void gpgme_set_passphrase_cb (GpgmeCtx ctx,
250                               GpgmePassphraseCb cb, void *hook_value);
251
252 /* Set the progress callback function in CTX to CB.  HOOK_VALUE is
253    passed as first argument to the progress callback function.  */
254 void gpgme_set_progress_cb (GpgmeCtx c, GpgmeProgressCb cb, void *hook_value);
255
256 /* Delete all signers from CTX.  */
257 void gpgme_signers_clear (GpgmeCtx ctx);
258
259 /* Add KEY to list of signers in CTX.  */
260 GpgmeError gpgme_signers_add (GpgmeCtx ctx, const GpgmeKey key);
261
262 /* Return the SEQth signer's key in CTX.  */
263 GpgmeKey gpgme_signers_enum (const GpgmeCtx ctx, int seq);
264
265 /* Retrieve the signature status of signature IDX in CTX after a
266    successful verify operation in R_STAT (if non-null).  The creation
267    time stamp of the signature is returned in R_CREATED (if non-null).
268    The function returns a string containing the fingerprint.  */
269 const char *gpgme_get_sig_status (GpgmeCtx ctx, int idx,
270                                   GpgmeSigStat *r_stat, time_t *r_created);
271
272 /* Get the key used to create signature IDX in CTX and return it in
273    R_KEY.  */
274 GpgmeError gpgme_get_sig_key (GpgmeCtx ctx, int idx, GpgmeKey *r_key);
275
276 /* Return a string with more info about the last crypto operating in CTX.
277    RESERVED should be zero.  The user has to free the string.  */
278 char *gpgme_get_op_info (GpgmeCtx ctx, int reserved);
279
280
281 /* Run control.  */
282
283 /* Cancel a pending operation in CTX.  */
284 void       gpgme_cancel (GpgmeCtx ctx);
285
286 /* Process the pending operation and, if HANG is non-zero, wait for
287    the pending operation to finish.  */
288 GpgmeCtx gpgme_wait (GpgmeCtx ctx, GpgmeError *status, int hang);
289
290
291 /* Functions to handle recipients.  */
292
293 /* Create a new recipients set and return it in R_RSET.  */
294 GpgmeError gpgme_recipients_new (GpgmeRecipients *r_rset);
295
296 /* Release the recipients set RSET.  */
297 void gpgme_recipients_release (GpgmeRecipients rset);
298
299 /* Add NAME to the recipients set RSET.  */
300 GpgmeError gpgme_recipients_add_name (GpgmeRecipients rset, const char *name);
301
302 /* Add NAME with validity AL to the recipients set RSET.  */
303 GpgmeError gpgme_recipients_add_name_with_validity (GpgmeRecipients rset,
304                                                     const char *name,
305                                                     GpgmeValidity val);
306
307 /* Return the number of recipients in RSET.  */
308 unsigned int gpgme_recipients_count (const GpgmeRecipients rset);
309
310 /* Create a new enumeration handle for the recipients set RSET and
311    return it in ITER.  */
312 GpgmeError gpgme_recipients_enum_open (const GpgmeRecipients rset,
313                                        void **iter);
314
315 /* Return the next recipient from the recipient set RSET in the
316    enumerator ITER.  */
317 const char *gpgme_recipients_enum_read (const GpgmeRecipients rset,
318                                         void **iter);
319
320 /* Destroy the enumerator ITER for the recipient set RSET.  */
321 GpgmeError gpgme_recipients_enum_close (const GpgmeRecipients rset,
322                                         void **iter);
323
324
325 /* Functions to handle data objects.  */
326
327 /* Create a new data buffer and return it in R_DH.  */
328 GpgmeError gpgme_data_new (GpgmeData *r_dh);
329
330 /* Create a new data buffer filled with SIZE bytes starting from
331    BUFFER.  If COPY is zero, copying is delayed until necessary, and
332    the data is taken from the original location when needed.  */
333 GpgmeError gpgme_data_new_from_mem (GpgmeData *r_dh,
334                                     const char *buffer, size_t size,
335                                     int copy);
336
337 /* Create a new data buffer which retrieves the data from the callback
338    function READ_CB.  */
339 GpgmeError gpgme_data_new_with_read_cb (GpgmeData *r_dh,
340                                         int (*read_cb) (void*,char *,size_t,size_t*),
341                                         void *read_cb_value);
342
343 /* Create a new data buffer filled with the content of file FNAME.
344    COPY must be non-zero (delayed reads are not supported yet).  */
345 GpgmeError gpgme_data_new_from_file (GpgmeData *r_dh,
346                                      const char *fname,
347                                      int copy);
348
349 /* Create a new data buffer filled with LENGTH bytes starting from
350    OFFSET within the file FNAME or stream FP (exactly one must be
351    non-zero).  */
352 GpgmeError gpgme_data_new_from_filepart (GpgmeData *r_dh,
353                                          const char *fname, FILE *fp,
354                                          off_t offset, size_t length);
355
356 /* Destroy the data buffer DH.  */
357 void gpgme_data_release (GpgmeData dh);
358
359 /* Destroy the data buffer DH and return a pointer to its content.
360    The memory has be to released with free by the user.  It's size is
361    returned in R_LEN.  */
362 char *gpgme_data_release_and_get_mem (GpgmeData dh, size_t *r_len);
363
364 /* Return the type of the data buffer DH.  */
365 GpgmeDataType gpgme_data_get_type (GpgmeData dh);
366
367 /* Reset the read pointer in DH.  */
368 GpgmeError gpgme_data_rewind (GpgmeData dh);
369
370 /* Read LENGTH bytes from the data object DH and store them in the
371    memory starting at BUFFER.  The number of bytes actually read is
372    returned in NREAD.  */
373 GpgmeError gpgme_data_read (GpgmeData dh, char *buffer,
374                             size_t length, size_t *nread);
375
376 /* Write LENGTH bytes starting from BUFFER into the data object DH.  */
377 GpgmeError gpgme_data_write (GpgmeData dh, const char *buffer, size_t length);
378
379
380 /* Key and trust functions.  */
381
382 /* Acquire a reference to KEY.  */
383 void gpgme_key_ref (GpgmeKey key);
384
385 /* Release a reference to KEY.  If this was the last one the key is
386    destroyed.  */
387 void gpgme_key_unref (GpgmeKey key);
388 void gpgme_key_release (GpgmeKey key);
389
390 /* Get the data from key KEY in a XML string, which has to be released
391    with free by the user.  */
392 char *gpgme_key_get_as_xml (GpgmeKey key);
393
394 /* Return the value of the attribute WHAT of KEY, which has to be
395    representable by a string.  IDX specifies a running index if the
396    attribute appears more than once in the key.  */
397 const char *gpgme_key_get_string_attr (GpgmeKey key, GpgmeAttr what,
398                                        const void *reserved, int idx);
399
400 /* Return the value of the attribute WHAT of KEY, which has to be
401    representable by an unsigned integer.  IDX specifies a running
402    index if the attribute appears more than once in the key.  */
403 unsigned long gpgme_key_get_ulong_attr (GpgmeKey key, GpgmeAttr what,
404                                         const void *reserved, int idx);
405
406 /* Release the trust item ITEM.  */
407 void gpgme_trust_item_release (GpgmeTrustItem item);
408
409 /* Return the value of the attribute WHAT of ITEM, which has to be
410    representable by a string.  IDX specifies a running index if the
411    attribute appears more than once in the key.  */
412 const char *gpgme_trust_item_get_string_attr (GpgmeTrustItem item,
413                                               GpgmeAttr what,
414                                               const void *reserved, int idx);
415
416 /* Return the value of the attribute WHAT of KEY, which has to be
417    representable by an integer.  IDX specifies a running index if the
418    attribute appears more than once in the key.  */
419 int gpgme_trust_item_get_int_attr (GpgmeTrustItem item, GpgmeAttr what,
420                                    const void *reserved, int idx);
421
422
423 /* Crypto operation function.  */
424
425 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
426    store the resulting ciphertext in CIPHER.  */
427 GpgmeError gpgme_op_encrypt_start (GpgmeCtx ctx,
428                                    GpgmeRecipients recp,
429                                    GpgmeData plain, GpgmeData cipher);
430 GpgmeError gpgme_op_encrypt (GpgmeCtx ctx,
431                              GpgmeRecipients recp,
432                              GpgmeData plain, GpgmeData cipher);
433
434 /* Encrypt plaintext PLAIN within CTX for the recipients RECP and
435    store the resulting ciphertext in CIPHER.  Also sign the ciphertext
436    with the signers in CTX.  */
437 GpgmeError gpgme_op_encrypt_sign_start (GpgmeCtx ctx,
438                                         GpgmeRecipients recp,
439                                         GpgmeData plain, GpgmeData cipher);
440 GpgmeError gpgme_op_encrypt_sign (GpgmeCtx ctx,
441                                   GpgmeRecipients recp,
442                                   GpgmeData plain, GpgmeData cipher);
443
444 /* Decrypt ciphertext CIPHER within CTX and store the resulting
445    plaintext in PLAIN.  */
446 GpgmeError gpgme_op_decrypt_start (GpgmeCtx ctx,
447                                    GpgmeData cipher, GpgmeData plain);
448 GpgmeError gpgme_op_decrypt (GpgmeCtx ctx,
449                              GpgmeData cipher, GpgmeData plain);
450
451 /* Decrypt ciphertext CIPHER and make a signature verification within
452    CTX and store the resulting plaintext in PLAIN.  */
453 GpgmeError gpgme_op_decrypt_verify_start (GpgmeCtx ctx,
454                                           GpgmeData cipher, GpgmeData plain);
455 GpgmeError gpgme_op_decrypt_verify (GpgmeCtx ctx,
456                                     GpgmeData cipher, GpgmeData plain,
457                                     GpgmeSigStat *r_status);
458
459 /* Sign the plaintext PLAIN and store the signature in SIG.  Only
460    detached signatures are supported for now.  */
461 GpgmeError gpgme_op_sign_start (GpgmeCtx ctx,
462                                 GpgmeData plain, GpgmeData sig,
463                                 GpgmeSigMode mode);
464 GpgmeError gpgme_op_sign (GpgmeCtx ctx,
465                           GpgmeData plain, GpgmeData sig,
466                           GpgmeSigMode mode);
467
468 /* Verify within CTX that SIG is a valid signature for TEXT.  */
469 GpgmeError gpgme_op_verify_start (GpgmeCtx ctx,
470                                   GpgmeData sig, GpgmeData text);
471 GpgmeError gpgme_op_verify (GpgmeCtx ctx,
472                             GpgmeData sig, GpgmeData text,
473                             GpgmeSigStat *r_status);
474
475 /* Import the key in KEYDATA into the keyring.  */
476 GpgmeError gpgme_op_import_start (GpgmeCtx ctx, GpgmeData keydata);
477 GpgmeError gpgme_op_import (GpgmeCtx ctx, GpgmeData keydata);
478
479 /* Export the keys listed in RECP into KEYDATA.  */
480 GpgmeError gpgme_op_export_start (GpgmeCtx ctx, GpgmeRecipients recp,
481                                   GpgmeData keydata);
482 GpgmeError gpgme_op_export (GpgmeCtx ctx, GpgmeRecipients recp,
483                             GpgmeData keydata);
484
485 /* Generate a new keypair and add it to the keyring.  PUBKEY and
486    SECKEY should be null for now.  PARMS specifies what keys should be
487    generated.  */
488 GpgmeError gpgme_op_genkey_start (GpgmeCtx ctx, const char *parms,
489                                   GpgmeData pubkey, GpgmeData seckey);
490 GpgmeError gpgme_op_genkey (GpgmeCtx ctx, const char *parms,
491                             GpgmeData pubkey, GpgmeData seckey);
492
493 /* Delete KEY from the keyring.  If ALLOW_SECRET is non-zero, secret
494    keys are also deleted.  */
495 GpgmeError gpgme_op_delete_start (GpgmeCtx ctx, const GpgmeKey key,
496                                   int allow_secret);
497 GpgmeError gpgme_op_delete (GpgmeCtx ctx, const GpgmeKey key,
498                             int allow_secret);
499
500
501 /* Key management functions */
502
503 /* Start a keylist operation within CTX, searching for keys which
504    match PATTERN.  If SECRET_ONLY is true, only secret keys are
505    returned.  */
506 GpgmeError gpgme_op_keylist_start (GpgmeCtx ctx,
507                                    const char *pattern, int secret_only);
508 GpgmeError gpgme_op_keylist_ext_start (GpgmeCtx ctx, const char *pattern[],
509                                        int secret_only, int reserved);
510
511 /* Return the next key from the keylist in R_KEY.  */
512 GpgmeError gpgme_op_keylist_next (GpgmeCtx ctx, GpgmeKey *r_key);
513
514 /* Terminate a pending keylist operation within CTX.  */
515 GpgmeError gpgme_op_keylist_end (GpgmeCtx ctx);
516
517
518 /* Start a trustlist operation within CTX, searching for trust items
519    which match PATTERN.  */
520 GpgmeError gpgme_op_trustlist_start (GpgmeCtx ctx,
521                                      const char *pattern, int max_level);
522
523 /* Return the next trust item from the trustlist in R_ITEM.  */
524 GpgmeError gpgme_op_trustlist_next (GpgmeCtx ctx, GpgmeTrustItem *r_item);
525
526 /* Terminate a pending trustlist operation within CTX.  */
527 GpgmeError gpgme_op_trustlist_end (GpgmeCtx ctx);
528
529
530 /* Various functions.  */
531
532 /* Check that the library fulfills the version requirement.  */
533 const char *gpgme_check_version (const char *req_version);
534
535 /* Check that the backend engine is available.  DEPRECATED.  */
536 GpgmeError  gpgme_check_engine (void);
537
538 /* Retrieve information about the backend engines.  */
539 const char *gpgme_get_engine_info (void);
540
541 /* Return a string describing ERR.  */
542 const char *gpgme_strerror (GpgmeError err);
543
544 /* Register an idle function.  */
545 typedef void (*GpgmeIdleFunc)(void);
546 GpgmeIdleFunc gpgme_register_idle (GpgmeIdleFunc idle);
547
548
549 /* Engine support functions.  */
550
551 /* Verify that the engine implementing PROTO is installed and
552    available.  */
553 GpgmeError gpgme_engine_check_version (GpgmeProtocol proto);
554
555
556 #ifdef __cplusplus
557 }
558 #endif
559 #endif /* GPGME_H */