1 Noteworthy changes in version 1.1.0 (unreleased)
2 ------------------------------------------------
4 * You can now configure the backend engine file name and home
5 directory to be used, as default and per context.
7 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8 gpgme_set_engine_info NEW
9 gpgme_ctx_get_engine_info NEW
10 gpgme_ctx_set_engine_info NEW
11 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14 Noteworthy changes in version 1.0.2 (2004-12-28)
15 ------------------------------------------------
17 * Changed the license of the library to the GNU Lesser General Public
18 License (LGPL), version 2.1 or later.
21 Noteworthy changes in version 1.0.1 (2004-10-22)
22 ------------------------------------------------
27 Noteworthy changes in version 1.0.0 (2004-09-30)
28 ------------------------------------------------
30 * Version 1.0.0! We are proud to present you with a thoroughly
31 tested and stable version of the GPGME library. A big Thank You!
32 to all the people who made this possible.
34 The development will be branched into a stable 1.x.y series and the
37 * The gpgme.m4 macro supports checking the API version. Just prepend
38 it to the required version string, separated by a colon. For
39 example, this release has the version "1:1.0.0". The last release
40 to which this version is (mostly) ABI compatible is "1:0.4.2",
41 which is the default required version.
44 Noteworthy changes in version 0.9.0 (2004-06-08)
45 ------------------------------------------------
47 * The type gpgme_key_t has now a new field keylist_mode that contains
48 the keylist mode that was active at the time the key was retrieved.
50 * The type gpgme_decrypt_result_t has a new field "wrong_key_usage"
51 that contains a flag indicating that the key should not have been
54 * Verifying a signature of a revoked key gives the correct result now
55 (GPG_ERR_CERT_REVOKED error code).
57 * Clarified that the error code GPG_ERR_NO_DATA from the decrypt &
58 verify operations still allows you to look at the signature
61 * Clarified that patterns in keylisting operations have an upper
62 limit, and thus are not suited to list many keys at once by their
63 fingerprint. Also improve the error message if the pattern is too
64 long for the CMS protocol to handle.
66 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
67 gpgme_key_t EXTENDED: New field keylist_mode.
68 gpgme_decrypt_result_t EXTENDED: New field wrong_key_usage.
69 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72 Noteworthy changes in version 0.4.7 (2004-04-29)
73 ------------------------------------------------
75 * Correctly initialize the fields expired, revoked, invalid, and
76 disabled in the gpgme_key_t structures.
78 * A bug fix: The flag wrong_key_usage of gpgme_signature_t was
79 accidently of type int instead unsigned int.
81 * Interface changes relative to the 0.4.5 release:
82 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
83 gpgme_signature_t CHANGED: wrong_key_usage is unsigned int now.
84 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86 Noteworthy changes in version 0.4.6 (2004-04-06)
87 ------------------------------------------------
92 Noteworthy changes in version 0.4.5 (2004-03-07)
93 ------------------------------------------------
95 * GPGME is now compiled with LFS (large file support) by default.
96 This means that _all_ programs using GPGME must be compiled with
97 LFS support enabled by default. You can do this easily with
98 autoconf, by using the AC_SYS_LARGEFILE macro. Or you can do this
99 without autoconf by defining the preprocessor symbol
100 _FILE_OFFSET_BITS to 64 (by passing the -D_FILE_OFFSET_BITS=64 to
101 the C compiler command line, or by defining this preprocessor
102 symbol before including any system header files). For more
103 details, read the section on LFS in the manual.
105 Up to now, it was undocumented that GPGME was not using LFS.
106 But the public interfaces use off_t, and file descriptors are
107 exchanged between the application and GPGME. This was an oversight,
108 and bound to cause troubles in the future.
110 Writing GPGME as a dual mode library that seamlessly supports LFS
111 while keeping backwards compatibility is possible, but does not
112 solve the problem: Many applications already expect GPGME to have
113 LFS (they are compiled with off_t being a 64bit value). This is true
114 in particular for the popular Gtk+ and Qt programs.
116 So, although this is an ABI (but not an API) break, we will not
117 change the library version to reflect that. Because the interfaces
118 affected are probably not used yet in any GPGME 0.4 based
119 application, we don't expect any real failures from this change.
120 In fact, applications already using LFS will have some subtle bugs
123 However, if you encounter an application using GPGME 0.4.x that
124 does _not_ use LFS by default (off_t is a 32bit value), _and_
125 uses at least one of the functions gpgme_data_seek,
126 gpgme_data_new_from_filepart, or a gpgme_data_seek_cb_t with
127 gpgme_data_new_from_cbs, then indeed this library will be ABI
128 incompatible with the program. As said above, we don't believe
129 such a program exists. If we are in error, then you have two
130 options: As a quick hack, you can configure GPGME with the
131 --disable-largefile option. This will revert the change, and GPGME
132 will not use LFS. However, GPGME will be incompatible with
133 programs that expect GPGME to use LFS. All applications are
134 required to use LFS when using GPGME, so this is only good as a
135 temporary local work-around.
137 The other option is to change the versioning of the library and
138 recompile all applications. We have reserved a special version of
139 the library for that, so you can do that without expecting a
140 version clash in the future. Furthermore, everyone who does this
141 will agree on the version to use (this is important for
142 distribution makers). Read the comment in configure.ac (before
143 LIBGPGME_LT_AGE) if you want to do this. Please don't do this
144 blindly: As stated above, we think it is unlikely this measure is
145 needed. Still, it is there if necessary. If in doubt, contact us
146 and we will give our advise for your specific situation.
148 * New key listing mode GPGME_KEYLIST_MODE_VALIDATE for validation of
151 * New interface gpgme_cancel() that can be used to cancel
152 asynchronous operations.
154 * Interface changes relative to the 0.4.4 release:
155 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
156 gpgme_data_seek_cb_t CHANGED: off_t is now a largefile type.
157 gpgme_data_seek CHANGED: off_t is now a largefile type.
158 gpgme_data_new_from_filepart CHANGED: off_t is now a largefile type.
159 GPGME_KEYLIST_MODE_VALIDATE NEW
161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
163 Noteworthy changes in version 0.4.4 (2004-01-12)
164 ------------------------------------------------
166 * The member "class" in gpgme_key_sig_t and gpgme_new_signature_t has
167 been renamed to "sig_class", to avoid clash with C++ compilers. In
168 the C API, the old name "class" has been preserved for backwards
169 compatibility, but is deprecated.
171 * Interface changes relative to the 0.4.3 release:
172 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
173 gpgme_key_sig_t CHANGED: class deprecated, use new sig_class.
174 gpgme_new_signature_t CHANGED: class deprecated, use new sig_class.
175 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177 Noteworthy changes in version 0.4.3 (2003-10-06)
178 ------------------------------------------------
180 * libgpgme should not be used for threaded programs anymore. This
181 never worked reliably in all cases, because you had to
182 be careful about the linking order and libtool wouldn't do that for
183 you automatically. Instead, now you have to link against
184 libgpgme-pthread for applications using pthread and libgpgme-pth for
185 applications using GNU Pth.
187 The old code for automagically detecting the thread library is
188 still part of libgpgme, but it is DEPRECATED.
190 * There are new automake macros AM_PATH_GPGME_PTH and
191 AM_PATH_GPGME_PTHREAD, which support checking for thread-enabled
192 versions of GPGME. They define GPGME_PTH_CFLAGS, GPGME_PTH_LIBS,
193 GPGME_PTHREAD_CFLAGS and GPGME_PTHREAD_LIBS respectively. These
194 variables of course also include the configuration for the thread
195 package itself. Alternatively, use libtool.
197 * gpgme_strerror_r as a thread safe variant of gpgme_strerror was
200 * gpgme-config doesn't support setting the prefix or exec prefix
201 anymore. I don't think it ever worked correctly, and it seems to
204 * gpgme_get_key fails with GPG_ERR_AMBIGUOUS_NAME if the key ID
205 provided was not unique, instead returning the first matching key.
207 * gpgme_key_t and gpgme_subkey_t have a new field, can_authenticate,
208 that indicates if the key can be used for authentication.
210 * gpgme_signature_t's status field is now correctly set to an error
211 with error code GPG_ERR_NO_PUBKEY if public key is not found.
213 * gpgme_new_signature_t's class field is now an unsigned int, rather
214 than an unsigned long (the old class field is preserved for
215 backwards compatibility).
217 * A new function gpgme_set_locale() is provided to allow configuring
218 the locale for the crypto backend. This is necessary for text
219 terminals so that programs like the pinentry can be started with
220 the right locale settings for the terminal the application is running
221 on, in case the terminal has different settings than the system
222 default (for example, if it is a remote terminal). You are highly
223 recommended to call the following functions directly after
228 setlocale (LC_ALL, "");
229 gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
230 gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
232 GPGME can not do this for you, as setlocale is not thread safe, and
233 there is no alternative.
235 * The signal action for SIGPIPE is now set to SIG_IGN by
236 gpgme_check_version, instead the first time a crypto engine is
237 started (which is not well defined).
239 * In the output of gpgme_hash_algo_name, change RMD160 to RIPEMD160,
240 TIGER to TIGER192, CRC32-RFC1510 to CRC32RFC1510, and CRC24-RFC2440
241 to CRC24RFC2440. For now, these strings can be used as the MIC
242 parameter for PGP/MIME (if appropriately modified).
244 * Interface changes relative to the 0.4.2 release:
245 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
247 gpgme_get_key CHANGED: Fails correctly if key ID not unique.
248 gpgme_key_t EXTENDED: New field can_authenticate.
249 gpgme_subkey_t EXTENDED: New field can_authenticate.
250 gpgme_new_signature_t CHANGED: New type for class field.
252 gpgme_hash_algo_name CHANGED: Slight adjustment of algo names.
253 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
255 Noteworthy changes in version 0.4.2 (2003-07-30)
256 ------------------------------------------------
258 * Allow gpg-error to be in non-standard place when linking the test suite.
260 * Configure will fail now if gpg-error can not be found.
262 * Fixed initialized memory backed data objects for writing, which
263 caused the test program to crash (but only on Mac OS, surprisingly).
265 * Eliminate use of C99 constructs.
267 * Small improvements to the manual.
270 Noteworthy changes in version 0.4.1 (2003-06-06)
271 ------------------------------------------------
273 This is the release that 0.4.0 should have been. There are many
274 interface changes, please see below for the details. The changes are
275 sometimes the result of new functionality, but more often express a
276 paradigm shift. Others are an overdue cleanup to get GPGME in line
277 with the GNU coding standards and to make the interface more
278 self-consistent. Here is an overview on the changes:
280 All types have been renamed to conform to the GNU coding standards,
281 most of the time by keeping the whole name in lowercase and inserting
282 underscores between words.
284 All operations consistently only accept input parameters in their
285 invocation function, and return only an error code directly. Further
286 information about the result of the operation has to be retrieved
287 afterwards by calling one of the result functions. This unifies the
288 synchronous and the asynchronous interface.
290 The error values have been completely replaced by a more
291 sophisticated model that allows GPGME to transparently and accurately
292 report all errors from the other GnuPG components, irregardless of
293 process boundaries. This is achieved by using the library
294 libgpg-errors, which is shared by all GnuPG components. This library
295 is now required for GPGME.
297 The results of all operations are now provided by pointers to C
298 structs rather than by XML structs or in other ways.
300 Objects which used to be opaque (for example a key) are now pointers
301 to accessible structs, so no accessor functions are necessary.
303 Backward compatibility is provided where it was possible without too
304 much effort and did not collide with the overall sanitization effort.
305 However, this is only for ease of transition. NO DEPRECATED FUNCTION
306 OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND WILL BE
307 DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE LIBRARY.
308 Recommendations how to replace deprecated or removed functionality
309 can be found within the description of each change.
311 What follows are all changes to the interface and behaviour of GPGME
314 * If gpgme.h is included in sources compiled by GCC 3.1 or later,
315 deprecated attributes will warn about use of obsolete functions and
316 type definitions. You can suppress these warnings by passing
317 -Wno-deprecated-declarations to the gcc command.
319 * The following types have been renamed. The old types are still
320 available as aliases, but they are deprecated now:
323 GpgmeData gpgme_data_t
324 GpgmeError gpgme_error_t
325 GpgmeDataEncoding gpgme_data_encoding_t
326 GpgmeSigStat gpgme_sig_stat_t
327 GpgmeSigMode gpgme_sig_mode_t
328 GpgmeAttr gpgme_attr_t
329 GpgmeValidity gpgme_validity_t
330 GpgmeProtocol gpgme_protocol_t
332 GpgmePassphraseCb gpgme_passphrase_cb_t
333 GpgmeProgressCb gpgme_progress_cb_t
334 GpgmeIOCb gpgme_io_cb_t
335 GpgmeRegisterIOCb gpgme_register_io_cb_t
336 GpgmeRemoveIOCb gpgme_remove_io_cb_t
337 GpgmeEventIO gpgme_event_io_t
338 GpgmeEventIOCb gpgme_event_io_cb_t
339 GpgmeIOCbs gpgme_io_cbs
340 GpgmeDataReadCb gpgme_data_read_cb_t
341 GpgmeDataWriteCb gpgme_data_write_cb_t
342 GpgmeDataSeekCb gpgme_data_seek_cb_t
343 GpgmeDataReleaseCb gpgme_data_release_cb_t
344 GpgmeDataCbs gpgme_data_cbs_t
345 GpgmeTrustItem gpgme_trust_item_t
346 GpgmeStatusCode gpgme_status_code_t
348 * gpgme_error_t is now identical to gpg_error_t, the error type
349 provided by libgpg-error. More about using libgpg-error with GPGME
350 can be found in the manual. All error symbols have been removed!
352 * All functions and types in libgpg-error have been wrapped in GPGME.
353 The new types are gpgme_err_code_t and gpgme_err_source_t. The new
354 functions are gpgme_err_code, gpgme_err_source, gpgme_error,
355 gpgme_err_make, gpgme_error_from_errno, gpgme_err_make_from_errno,
356 gpgme_err_code_from_errno, gpgme_err_code_to_errno,
359 * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
361 * GnuPG 1.2.2 is required. The progress callback is now also invoked
362 for encrypt, sign, encrypt-sign, decrypt, verify, and
363 decrypt-verify operations. For verify operations on detached
364 signatures, the progress callback is invoked for both the detached
365 signature and the plaintext message, though.
367 * gpgme_passphrase_cb_t has been changed to not provide a complete
368 description, but the UID hint, passphrase info and a flag
369 indicating if this is a repeated attempt individually, so the user
370 can compose his own description from this information.
372 The passphrase is not returned as a C string, but must be written
373 to a file descriptor directly. This allows for secure passphrase
376 The return type has been changed to gpgme_error_t value. This
377 allowed to remove the gpgme_cancel function; just return
378 the error code GPG_ERR_CANCELED in the passphrase callback directly.
380 * gpgme_edit_cb_t has been changed to take a file descriptor argument.
381 The user is expected to write the response to the file descriptor,
382 followed by a newline.
384 * The recipients interface has been removed. Instead, you use
385 NULL-terminated lists of keys for specifying the recipients of an
386 encryption operation. Use the new encryption flag
387 GPGME_ENCRYPT_ALWAYS_TRUST if you want to override the validity of
388 the keys (but note that in general this is not a good idea).
390 This change has been made to the prototypes of gpgme_op_encrypt,
391 gpgme_op_encrypt_start, gpgme_op_encrypt_sign and
392 gpgme_op_encrypt_sign_start.
394 The export interface has been changed to use pattern strings like
395 the keylist interface. Thus, new functions gpgme_op_export_ext and
396 gpgme_op_export_ext_start have been added as well. Now the
397 prototypes of gpgme_op_export_start and gpgme_op_export finally
400 * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
401 summary anymore. Use gpgme_get_sig_status to retrieve the individual
404 * gpgme_io_cb_t changed from a void function to a function returning
405 a gpgme_error_t value. However, it will always return 0, so you
406 can safely ignore the return value.
408 * A new I/O callback event GPGME_EVENT_START has been added. The new
409 requirement is that you must wait until this event until you are
410 allowed to call the I/O callback handlers previously registered for
411 this context operation. Calling I/O callback functions for this
412 context operation before the start event happened is unsafe because
413 it can lead to race conditions in a multi-threaded environment.
415 * The idle function feature has been removed. It was not precisely
416 defined in a multi-threaded environment and is obsoleted by the
417 user I/O callback functions. If you still need a simple way to
418 call something while waiting on one or multiple asynchronous
419 operations to complete, don't set the HANG flag in gpgme_wait (note
420 that this will return to your program more often than the idle
423 * gpgme_wait can return NULL even if hang is true, if an error
424 occurs. In that case *status contains the error code.
426 * gpgme_get_engine_info was radically changed. Instead an XML
427 string, an info structure of the new type gpgme_engine_info_t is
428 returned. This makes it easier and more robust to evaluate the
429 information in an application.
431 * The new function gpgme_get_protocol_name can be used to convert a
432 gpgme_protocol_t value into a string.
434 * The status of a context operation is not checked anymore. Starting
435 a new operation will silently cancel the previous one. Calling a
436 function that requires you to have started an operation before without
437 doing so is undefined.
439 * The FPR argument to gpgme_op_genkey was removed. Instead, use the
440 gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
441 pointer to a structure which contains the fingerprint. This also
442 works with gpgme_op_genkey_start. The structure also provides
443 other information about the generated keys.
448 err = gpgme_op_genkey (ctx, NULL, NULL, &fpr);
450 printf ("%s\n", fpr);
454 gpgme_genkey_result_t result;
455 err = gpgme_op_genkey (ctx, NULL, NULL);
458 result = gpgme_op_genkey_result (ctx);
460 printf ("%s\n", result->fpr);
463 * The new gpgme_op_import_result function provides detailed
464 information about the result of an import operation in
465 gpgme_import_result_t and gpgme_import_status_t objects.
466 Thus, the gpgme_op_import_ext variant is deprecated.
468 * The new gpgme_op_sign_result function provides detailed information
469 about the result of a signing operation in gpgme_sign_result_t,
470 gpgme_invalid_key_t and gpgme_new_signature_t objects.
472 * The new gpgme_op_encrypt_result function provides detailed
473 information about the result of an encryption operation in
474 a GpgmeEncryptResult object.
476 * The new gpgme_op_decrypt_result function provides detailed
477 information about the result of a decryption operation in
478 a GpgmeDecryptResult object.
480 * The new gpgme_op_verify_result function provides detailed
481 information about the result of an verify operation in
482 a GpgmeVerifyResult object. Because of this, the GPGME_SIG_STAT_*
483 values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
484 gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
485 and gpgme_get_notation is removed.
487 * GpgmeTrustItem objects have now directly accessible data, so the
488 gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
489 accessor functions are deprecated. Also, reference counting is
490 available through gpgme_trust_item_ref and gpgme_trust_item_unref
491 (the gpgme_trust_item_release alias for the latter is deprecated).
493 * Keys are not cached internally anymore, so the force_update argument
494 to gpgme_get_key has been removed.
496 * GpgmeKey objects have now directly accessible data so the
497 gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
498 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
499 functions are deprecated. Also, gpgme_key_release is now
500 deprecated. The gpgme_key_get_as_xml function has been dropped.
502 * Because all interfaces using attributes are deprecated, the
503 GpgmeAttr data type is also deprecated.
505 * The new gpgme_op_keylist_result function provides detailed
506 information about the result of a key listing operation in
507 a GpgmeKeyListResult object.
509 * Now that each function comes with its own result retrieval
510 interface, the generic gpgme_get_op_info interface is not useful
513 * The type and mode of data objects is not available anymore.
515 * Interface changes relative to the 0.4.0 release:
516 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
517 GpgmeCtx DEPRECATED: Use gpgme_ctx_t.
518 GpgmeData DEPRECATED: Use gpgme_data_t.
519 GpgmeError DEPRECATED: Use gpgme_error_t.
520 GpgmeDataEncoding DEPRECATED: Use gpgme_data_encoding_t.
521 GpgmeSigStat DEPRECATED: Use gpgme_sig_stat_t.
522 GpgmeSigMode DEPRECATED: Use gpgme_sig_mode_t.
523 GpgmeAttr DEPRECATED: Use gpgme_attr_t.
524 GpgmeValidity DEPRECATED: Use gpgme_validity_t.
525 GpgmeProtocol DEPRECATED: Use gpgme_protocol_t.
526 GpgmeKey DEPRECATED: Use gpgme_key_t.
527 GpgmePassphraseCb DEPRECATED: Use gpgme_passphrase_cb_t.
528 GpgmeProgressCb DEPRECATED: Use gpgme_progress_cb_t.
529 GpgmeIOCb DEPRECATED: Use gpgme_io_cb_t.
530 GpgmeRegisterIOCb DEPRECATED: Use gpgme_register_io_cb_t.
531 GpgmeRemoveIOCb DEPRECATED: Use gpgme_remove_io_cb_t.
532 GpgmeEventIO DEPRECATED: Use gpgme_event_io_t.
533 GpgmeEventIOCb DEPRECATED: Use gpgme_event_io_cb_t.
534 GpgmeIOCbs DEPRECATED: Use gpgme_io_cbs.
535 GpgmeDataReadCb DEPRECATED: Use gpgme_data_read_cb_t.
536 GpgmeDataWriteCb DEPRECATED: Use gpgme_data_write_cb_t.
537 GpgmeDataSeekCb DEPRECATED: Use gpgme_data_seek_cb_t.
538 GpgmeDataReleaseCb DEPRECATED: Use gpgme_data_release_cb_t.
539 GpgmeDataCbs DEPRECATED: Use gpgme_data_cbs_t.
540 GpgmeTrustItem DEPRECATED: Use gpgme_trust_item_t.
541 GpgmeStatusCode DEPRECATED: Use gpgme_status_code_t.
544 gpgme_recipients_t NEW
546 gpgme_data_encoding_t NEW
553 gpgme_passphrase_cb_t NEW
554 gpgme_progress_cb_t NEW
556 gpgme_register_io_cb_t NEW
557 gpgme_remove_io_cb_t NEW
559 gpgme_event_io_cb_t NEW
561 gpgme_data_read_cb_t NEW
562 gpgme_data_write_cb_t NEW
563 gpgme_data_seek_cb_t NEW
564 gpgme_data_release_cb_t NEW
566 gpgme_trust_item_t NEW
567 gpgme_status_code_t NEW
568 GPGME_{some error code} REMOVED! Use GPG_ERR_* from libgpg-error.
570 gpgme_err_source_t NEW
575 gpgme_error_from_errno NEW
576 gpgme_err_make_from_errno NEW
577 gpgme_err_code_from_errno NEW
578 gpgme_err_code_to_errno NEW
580 gpgme_io_cb_t CHANGED: Return type from void to GpgmeError.
581 gpgme_event_io_t CHANGED: New event type (all numbers changed).
582 gpgme_passphrase_cb_t CHANGED: Desc decomposed, write directly to FD.
583 gpgme_edit_cb_t CHANGED: Write directly to FD.
584 gpgme_key_get_string_attr CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
585 gpgme_op_verify CHANGED: Drop R_STAT argument.
586 gpgme_op_decrypt_verify CHANGED: Drop R_STAT argument.
587 gpgme_wait CHANGED: Can return NULL even if hang is true.
588 GpgmeIdleFunc REMOVED
589 gpgme_register_idle REMOVED
590 GpgmeRecipients REMOVED
591 gpgme_recipients_new REMOVED
592 gpgme_recipients_release REMOVED
593 gpgme_recipients_add_name REMOVED
594 gpgme_recipients_add_name_with_validity REMOVED
595 gpgme_recipients_count REMOVED
596 gpgme_recipients_enum_open REMOVED
597 gpgme_recipients_enum_read REMOVED
598 gpgme_recipients_enum_close REMOVED
599 gpgme_encrypt_flags_t NEW
600 GPGME_ENCRYPT_ALWAYS_TRUST NEW
601 gpgme_op_encrypt CHANGED: Recipients passed as gpgme_key_t[].
602 gpgme_op_encrypt_start CHANGED: Recipients passed as gpgme_key_t[].
603 gpgme_op_encrypt_sign CHANGED: Recipients passed as gpgme_key_t[].
604 gpgme_op_encrypt_sign_start CHANGED: Recipients passed as gpgme_key_t[].
605 gpgme_op_export_start CHANGED: User IDs passed as patterns.
606 gpgme_op_export CHANGED: User IDs passed as patterns.
607 gpgme_op_export_ext_start NEW
608 gpgme_op_export_ext NEW
609 gpgme_keylist_mode_t NEW
611 gpgme_engine_info_t NEW
612 gpgme_get_engine_info CHANGED: Return info structure instead XML.
613 gpgme_get_protocol_name NEW
614 gpgme_cancel REMOVED: Return error in callback directly.
615 gpgme_op_genkey CHANGED: FPR argument dropped.
616 gpgme_op_genkey_result NEW
617 gpgme_genkey_result_t NEW
618 gpgme_op_import_ext DEPRECATED: Use gpgme_op_import_result.
619 gpgme_op_import_result NEW
620 gpgme_import_status_t NEW
621 gpgme_import_result_t NEW
622 gpgme_pubkey_algo_t NEW
623 gpgme_hash_algo_t NEW
624 gpgme_invalid_key_t NEW
625 gpgme_new_signature_t NEW
626 gpgme_sign_result_t NEW
627 gpgme_op_sign_result NEW
628 gpgme_pubkey_algo_name NEW
629 gpgme_hash_algo_name NEW
630 gpgme_encrypt_result_t NEW
631 gpgme_op_encrypt_result NEW
632 gpgme_decrypt_result_t NEW
633 gpgme_op_decrypt_result NEW
634 gpgme_verify_result_t NEW
635 gpgme_op_verify_result NEW
636 gpgme_get_notation REMOVED: Access verify result directly instead.
637 gpgme_get_sig_key DEPRECATED: Use gpgme_get_key with fingerprint.
638 gpgme_get_sig_ulong_attr DEPRECATED: Use verify result directly.
639 gpgme_get_sig_string_attr DEPRECATED: Use verify result directly.
640 GPGME_SIG_STAT_* DEPRECATED: Use error value in sig status.
641 gpgme_get_sig_status DEPRECATED: Use verify result directly.
642 gpgme_trust_item_t CHANGED: Now has user accessible data members.
643 gpgme_trust_item_ref NEW
644 gpgme_trust_item_unref NEW
645 gpgme_trust_item_release DEPRECATED: Use gpgme_trust_item_unref.
646 gpgme_trust_item_get_string_attr DEPRECATED
647 gpgme_trust_item_get_ulong_attr DEPRECATED
648 gpgme_get_key CHANGED: Removed force_update argument.
652 gpgme_key_t CHANGED: Now has user accessible data members.
653 gpgme_key_get_string_attr DEPRECATED
654 gpgme_key_get_ulong_attr DEPRECATED
655 gpgme_key_sig_get_string_attr DEPRECATED
656 gpgme_key_sig_get_ulong_attr DEPRECATED
657 gpgme_key_get_as_xml REMOVED
658 gpgme_key_list_result_t NEW
659 gpgme_op_keylist_result NEW
660 gpgme_get_op_info REMOVED
661 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
663 Noteworthy changes in version 0.4.0 (2002-12-23)
664 ------------------------------------------------
666 * Key generation returns the fingerprint of the generated key.
668 * New convenience function gpgme_get_key.
670 * Supports signatures of user IDs in keys via the new
671 GPGME_KEYLIST_MODE_SIGS keylist mode and the
672 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
673 interfaces. The XML info about a key also includes the signatures
676 * New data object interface, which is more flexible and transparent.
678 * Interface changes relative to the 0.3.9 release:
679 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
683 GpgmeDataReleaseCb NEW
685 gpgme_data_read CHANGED: Match read() closely.
686 gpgme_data_write CHANGED: Match write() closely.
688 gpgme_data_new_from_fd NEW
689 gpgme_data_new_from_stream NEW
690 gpgme_data_new_from_cbs NEW
691 gpgme_data_rewind DEPRECATED: Replaced by gpgme_data_seek().
692 gpgme_data_new_from_read_cb DEPRECATED: Replaced by gpgme_data_from_cbs().
693 gpgme_data_get_type REMOVED: No replacement.
694 gpgme_op_verify CHANGED: Take different data objects for
695 signed text and plain text.
696 gpgme_op_verify_start CHANGED: See gpgme_op_verify.
697 gpgme_check_engine REMOVED: Deprecated since 0.3.0.
698 gpgme_op_genkey CHANGED: New parameter FPR.
699 GPGME_KEYLIST_MODE_SIGS NEW
700 gpgme_key_sig_get_string_attr NEW
701 gpgme_key_sig_get_ulong_attr NEW
703 GPGME_ATTR_SIG_CLASS NEW
704 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
706 Noteworthy changes in version 0.3.16 (2003-11-19)
707 -------------------------------------------------
709 * Compatibility fixes for GnuPG 1.9.x
711 Noteworthy changes in version 0.3.15 (2003-02-18)
712 -------------------------------------------------
714 * The progress status is sent via the progress callbacks in
717 * Bug fix for signing operations with explicit signer settings for
720 Noteworthy changes in version 0.3.14 (2002-12-04)
721 -------------------------------------------------
723 * GPGME-Plug is now in its own package "cryptplug".
725 * Workaround for a setlocale problem. Fixed a segv related to not
726 correctly as closed marked file descriptors.
728 Noteworthy changes in version 0.3.13 (2002-11-20)
729 -------------------------------------------------
731 * Release due to changes in gpgmeplug.
733 Noteworthy changes in version 0.3.12 (2002-10-15)
734 -------------------------------------------------
736 * Fixed some bux with key listings.
738 * The development has been branched to clean up some API issues.
739 This 0.3 series will be kept for compatibility reasons; so do don't
742 Noteworthy changes in version 0.3.11 (2002-09-20)
743 -------------------------------------------------
747 Noteworthy changes in version 0.3.10 (2002-09-02)
748 -------------------------------------------------
750 * Setting the signing keys for the CMS protocol does now work.
752 * The signers setting is honoured by gpgme_op_edit.
754 Noteworthy changes in version 0.3.9 (2002-08-21)
755 ------------------------------------------------
757 * A spec file for creating RPMs has been added.
759 * An experimental interface to GnuPG's --edit-key functionality is
760 introduced, see gpgme_op_edit.
762 * The new gpgme_import_ext function provides a convenient access to
763 the number of processed keys.
765 * Interface changes relative to the 0.3.8 release:
766 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
769 gpgme_op_edit_start NEW
771 gpgme_op_import_ext NEW
772 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
774 Noteworthy changes in version 0.3.8 (2002-06-25)
775 ------------------------------------------------
777 * It is possible to use an outside event loop for the I/O to the
778 crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
780 * Interface changes relative to the 0.3.6 release:
781 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
783 GpgmeRegisterIOCb NEW
787 struct GpgmeIOCbs NEW
790 GPGME_ATTR_ERRTOK NEW
791 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
793 Noteworthy changes in version 0.3.7 (2002-06-04)
794 ------------------------------------------------
796 * GPGME_ATTR_OTRUST is implemented now.
798 * A first step toward thread safeness has been achieved, see the
799 documentation for details. Supported thread libraries are pthread
802 Noteworthy changes in version 0.3.6 (2002-05-03)
803 ------------------------------------------------
805 * All error output of the gpgsm backend is send to the bit bucket.
807 * The signature verification functions are extended. Instead of
808 always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
809 expired signatures. 2 new functions may be used to retrieve more
810 detailed information like the signature expiration time and a
811 validity information of the key without an extra key looking.
813 * The current passphrase callback and progress meter callback can be
814 retrieved with the new functions gpgme_get_passphrase_cb and
815 gpgme_get_progress_cb respectively.
817 * Interface changes relative to the 0.3.5 release:
818 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
819 gpgme_get_passphrase_cb NEW
820 gpgme_get_progress_cb NEW
821 GpgmeDataEncoding NEW
822 gpgme_data_set_encoding NEW
823 gpgme_data_get_encoding NEW
824 GPGME_SIG_STAT_GOOD_EXP NEW
825 GPGME_SIG_STAT_GOOD_EXPKEY NEW
826 gpgme_op_verify CHANGED: Returns more status codes.
827 GPGME_ATTR_SIG_STATUS NEW
828 gpgme_get_sig_string_attr NEW
829 gpgme_get_sig_ulong_attr NEW
830 gpgme_get_protocol NEW
831 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
833 Noteworthy changes in version 0.3.5 (2002-04-01)
834 ------------------------------------------------
836 * gpgme_op_encrypt can be called with RECIPIENTS being 0. In this
837 case, symmetric encryption is performed. Note that this requires a
838 passphrase from the user.
840 * More information is returned for X.509 certificates.
842 * Interface changes relative to the 0.3.4 release:
843 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
844 gpgme_op_encrypt EXTENDED: Symmetric encryption possible
845 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
847 Noteworthy changes in version 0.3.4 (2002-03-04)
848 ------------------------------------------------
850 * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
851 some recipients have been invalid, whereas earlier versions
852 succeeded in this case. The plaintext is still encrypted for all valid
853 recipients, so the application might take this error as a hint that
854 the ciphertext is not usable for all requested recipients.
855 Information about invalid recipients is available with gpgme_get_op_info.
857 * gpgme_op_verify now allows to pass an uninitialized data object as
858 its plaintext argument to check for normal and cleartext
859 signatures. The plaintext is then returned in the data object.
861 * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
862 to set and get the number of certifications to include in S/MIME
865 * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
866 to encrypt and sign a message in a combined operation.
868 * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
870 * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
872 * Interface changes relative to the 0.3.3 release:
873 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
874 gpgme_op_encrypt CHANGED: Can fail with GPGME_Invalid_Recipients
875 gpgme_op_verify EXTENDED: Accepts uninitialized text argument
876 gpgme_key_get_ulong_attr EXTENDED: Supports GPGME_ATTR_EXPIRE
877 gpgme_set_include_certs NEW
878 gpgme_get_include_certs NEW
879 gpgme_op_encrypt_sign NEW
880 gpgme_op_encrypt_sign_start NEW
881 gpgme_op_keylist_ext_start NEW
882 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
884 Noteworthy changes in version 0.3.3 (2002-02-12)
885 ------------------------------------------------
887 * Fix the Makefile in jnlib.
889 * Fix the test suite (hopefully). It should clean up all its state
890 with `make check' now.
893 Noteworthy changes in version 0.3.2 (2002-02-10)
894 ------------------------------------------------
896 * Remove erroneous dependency on libgcrypt in jnlib.
899 Noteworthy changes in version 0.3.1 (2002-02-09)
900 ------------------------------------------------
902 * There is a Texinfo manual documenting the API.
904 * The gpgme_set_keylist_mode function returns an error, and changed
905 its meaning. It is no longer usable to select between normal and
906 fast mode (newer versions of GnuPG will always be fast), but
907 selects between local keyring, remote keyserver, or both.
908 For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
909 and GPGME_KEYLIST_MODE_EXTERN. To make it possible to modify the
910 current setting, a fucntion gpgme_get_keylist_mode was added to
911 retrieve the current mode.
913 * gpgme_wait accepts a new argument STATUS to return the error status
914 of the operation on the context. Its definition is closer to
915 waitpid() now than before.
917 * The LENGTH argument to gpgme_data_new_from_filepart changed its
918 type from off_t to the unsigned size_t.
920 * The R_HD argument to the GpgmePassphraseCb type changed its type
921 from void* to void**.
923 * New interface gpgme_op_trustlist_end() to match
924 gpgme_op_keylist_end().
926 * The CryptPlug modules have been renamed to gpgme-openpgp and
927 gpgme-smime, and they are installed in pkglibdir by `make install'.
929 * An idle function can be registered with gpgme_register_idle().
931 * The GpgSM backend supports key generation with gpgme_op_genkey().
933 * Interface changes relative to the 0.3.0 release:
934 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
935 gpgme_data_new_from_filepart CHANGED: Type of LENGTH is size_t.
936 GpgmePassphraseCb CHANGED: Type of R_HD is void **.
937 gpgme_wait CHANGED: New argument STATUS.
938 gpgme_set_keylist_mode CHANGED: Type of return value is GpgmeError.
939 The function has a new meaning!
940 gpgme_get_keylist_mode NEW
941 GPGME_KEYLIST_MODE_LOCAL NEW
942 GPGME_KEYLIST_MODE_EXTERN NEW
943 gpgme_op_trustlist_next NEW
945 gpgme_register_idle NEW
946 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
948 Noteworthy changes in version 0.3.0 (2001-12-19)
949 ------------------------------------------------
951 * New interface gpgme_set_protocol() to set the protocol and thus the
952 crypto engine to be used by the context. Currently, the OpenPGP
953 and the CMS protocols are supported. They are specified by the new
954 preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
955 A new context uses the OpenPGP engine by default.
957 * gpgme_get_engine_info() returns information for all crypto engines
958 compiled into the library. The XML format has changed. To
959 reliably get the version of a crypto engine, the <version> tag
960 after the appropriate <protocol> tag has to be looked for.
962 * New interface gpgme_engine_check_version(), obsoleting
963 gpgme_check_engine(). Check the version of all engines you are
964 supporting in your software.
966 * GpgmeKey lists the user ids in the order as they are returned by
967 GnuPG, first the primary key with index 0, then the sub-user ids.
969 * New operation gpgme_op_decrypt_verify() to decrypt and verify
970 signatures simultaneously.
972 * The new interface gpgme_op_keylist_end() terminates a pending
973 keylist operation. A keylist operation is also terminated when
974 gpgme_op_keylist_next() returns GPGME_EOF.
976 * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
977 cross-compiled, or even compiled without support for GnuPG
980 * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
981 `--with-gpgsm=PATH'). It is enabled by default if the `gpgsm' is found
982 in the path, but it can also be compiled without support for GpgSM
985 * CryptPlug modules for GPGME are included and can be enabled at
986 configure time (`--enable-gpgmeplug'). There is one module which
987 uses the GnuPG engine (`gpgmeplug') and one module which uses the
988 GpgSM engine (`gpgsmplug').
990 * Interface changes relative to the latest 0.2.x release:
991 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
992 gpgme_key_get_as_xml CHANGED: Sub-user ids reversed in order.
993 gpgme_key_get_string_attr CHANGED: User ids reversed in order.
994 gpgme_key_get_ulong_attr CHANGED: User ids reversed in order.
995 gpgme_get_engine_info CHANGED: New format, extended content.
996 gpgme_engine_check_version NEW
997 gpgme_decrypt_verify_start NEW
998 gpgme_decrypt_verify NEW
999 gpgme_op_keylist_next NEW
1000 gpgme_set_protocol NEW
1001 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1004 Noteworthy changes in version 0.2.3 (2001-09-17)
1005 ------------------------------------------------
1007 * New function gpgme_get_op_info which can be used to get the micalg
1008 parameter needed for MOSS.
1010 * New functions gpgme_get_armor and gpgme_get_textmode.
1012 * The usual bug fixes and some minor functionality improvements.
1014 * Added a simple encryption component for MS-Windows; however the
1015 build procedure might have some problems.
1018 Noteworthy changes in version 0.2.2 (2001-06-12)
1019 ------------------------------------------------
1021 * Implemented a key cache.
1023 * Fixed a race condition under W32 and some other bug fixes.
1026 Noteworthy changes in version 0.2.1 (2001-04-02)
1027 ------------------------------------------------
1029 * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
1031 * Handle GnuPG's new key capabilities output and support revocation
1034 * Made the W32 support more robust.
1037 Copyright 2001, 2002, 2003, 2004 g10 Code GmbH
1039 This file is free software; as a special exception the author gives
1040 unlimited permission to copy and/or distribute it, with or without
1041 modifications, as long as this notice is preserved.
1043 This file is distributed in the hope that it will be useful, but
1044 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
1045 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.