1 Noteworthy changes in version 1.5.2 (2014-11-21) [C24/A13/R1]
2 -------------------------------------------------------------
4 * gpgme-tool is now installed.
6 * Fix external listing for modern keyservers.
11 Noteworthy changes in version 1.5.1 (2014-07-30) [C24/A13/R0]
12 -------------------------------------------------------------
14 * Fixed possible overflow in gpgsm and uiserver engines.
17 * Added support for GnuPG 2.1's --with-secret option.
19 * Interface changes relative to the 1.5.0 release:
20 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
21 GPGME_KEYLIST_MODE_WITH_SECRET NEW.
24 Noteworthy changes in version 1.5.0 (2014-05-21) [C23/A12/R0]
25 -------------------------------------------------------------
27 * On Unices the engine file names are not not anymore hardwired but
28 located via the envvar PATH. All options to set the name of the
29 engines for the configure run are removed.
31 * If GPGME finds the gpgconf binary it defaults to using gpg2 or
32 whatever gpgconf tells as name for the OpenPGP engine. If gpgconf
33 is not found, GPGME looks for an engine named "gpg".
35 * New feature to use the gpgme I/O subsystem to run arbitrary
38 * New flag to use encryption without the default compression step.
40 * New function to access "gpg-conf --list-dirs"
42 * New configure option --enable-fixed-path for use by Android.
44 * Support ECC algorithms.
46 * Interface changes relative to the 1.4.3 release:
47 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48 gpgme_get_dirinfo NEW.
49 gpgme_op_spawn_start NEW.
51 GPGME_PROTOCOL_SPAWN NEW.
52 GPGME_SPAWN_DETACHED NEW.
53 GPGME_SPAWN_ALLOW_SET_FG NEW.
54 GPGME_ENCRYPT_NO_COMPRESS NEW.
57 gpgme_subkey_t EXTENDED: New field curve.
58 GPGME_STATUS_PLAINTEXT_LENGTH NEW.
59 GPGME_STATUS_MOUNTPOINT NEW.
60 GPGME_STATUS_PINENTRY_LAUNCHED NEW.
61 GPGME_STATUS_ATTRIBUTE NEW.
62 GPGME_STATUS_BEGIN_SIGNING NEW.
63 GPGME_STATUS_KEY_NOT_CREATED NEW.
66 Noteworthy changes in version 1.4.3 (2013-08-12) [C22/A11/R0]
67 -------------------------------------------------------------
69 * The default engine names are now taken from the output of gpgconf.
70 If gpgconf is not found the use of gpg 1 is assumed.
72 * Under Windows the default engines names are first searched in the
73 installation directory of the gpgme DLL.
75 * New function gpgme_data_identify to detect the type of a message.
77 * Interface changes relative to the 1.4.2 release:
78 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
79 gpgme_signers_count NEW.
80 gpgme_data_type_t NEW.
81 gpgme_data_identify NEW.
84 Noteworthy changes in version 1.4.2 (2013-05-28) [C21/A10/R0]
85 -------------------------------------------------------------
87 * Allow symmetric encryption with gpgme_op_encrypt_sign.
89 * Fixed mismatching off_t definitions on Windows.
91 * Interface changes relative to the 1.4.1 release:
92 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95 GPGME_PROTOCOL_OPENPGP NEW alias.
98 Noteworthy changes in version 1.4.1 (2013-05-01) [C20/A9/R1]
99 ------------------------------------------------------------
101 * Fixed reading of gpg.conf files with excessive use of the group
104 * Fixed building with the i686-w64-mingw32 toolchain.
106 * Disabled FD passing by default for Apple.
109 Noteworthy changes in version 1.4.0 (2013-02-26) [C20/A9/R0]
110 ------------------------------------------------------------
112 * New function gpgme_set_global_flag to help debugging on Android.
114 * New function gpgme_io_writen as a convenience wrapper around
117 * New functions to support the pinentry mode feature of GnuPG 2.1.
119 * New macro GPGME_VERSION_NUMBER to allow supporting different API
120 versions without the need for a configure test.
122 * Several improvements for gpgme-tool.
124 * Better logging of the common "invalid engine" error code.
126 * Support for FD passing is now enabled by default. The configure
127 option --disable-fd-passing may be used to disable this.
129 * Interface changes relative to the 1.3.1 release:
130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
131 GPGME_VERSION_NUMBER NEW.
133 gpgme_set_global_flag NEW.
134 gpgme_set_pinentry_mode NEW.
135 gpgme_get_pinentry_mode NEW.
136 gpgme_pinentry_mode_t NEW.
137 GPGME_PINENTRY_MODE_DEFAULT NEW.
138 GPGME_PINENTRY_MODE_ASK NEW.
139 GPGME_PINENTRY_MODE_CANCEL NEW.
140 GPGME_PINENTRY_MODE_ERROR NEW.
141 GPGME_PINENTRY_MODE_LOOPBACK NEW.
144 Noteworthy changes in version 1.3.2 (2012-05-02)
145 ------------------------------------------------
147 * Remove support for libgpgme-pth. As far as we know, this was never used,
148 and GnuPG is going to use our own npth in the future.
150 * Fix signature summary information for a missing X.509 key.
152 * Fix parsing of dates >= year 2038.
155 Noteworthy changes in version 1.3.1 (2011-06-16)
156 ------------------------------------------------
158 * Ported to Windows CE.
160 * Detect GPG versions not supporting ---passwd.
162 * Interface changes relative to the 1.3.0 release:
163 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
164 GPGME_EXPORT_MODE_MINIMAL NEW
165 GPGME_STATUS_SUCCESS NEW
166 gpgme_err_code_from_syserror NEW
167 gpgme_err_set_errno NEW
168 gpgme_error_from_errno CHANGED: Return gpgme_error_t (compatible type).
169 gpgme_error_from_syserror NEW
170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
173 Noteworthy changes in version 1.3.0 (2010-01-11)
174 ------------------------------------------------
176 * GPGME does not come with an internal libassuan version anymore.
177 The external libassuan 1.1.0 release or later is required. For
178 application programmers on systems that can resolve inter-library
179 dependencies at runtime, this is a transparent change.
181 * New engine GPGME_PROTOCOL_G13 to support the new g13 tool.
183 * New engine GPGME_PROTOCOL_UISERVER to support UI Servers.
185 * New API to change the passphrase of a key.
187 * Interface changes relative to the 1.2.0 release:
188 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
189 GPGME_STATUS_INV_SGNR NEW.
190 GPGME_STATUS_NO_SGNR NEW.
191 GPGME_PROTOCOL_G13 NEW.
192 gpgme_op_g13_mount NEW.
193 gpgme_g13_result_t NEW.
196 gpgme_op_passwd_start NEW.
198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
201 Noteworthy changes in version 1.2.0 (2009-06-18)
202 ------------------------------------------------
204 * New encryption flag GPGME_ENCRYPT_NO_ENCRYPT_TO to disable default
207 * gpgme_new will fail if gpgme_check_version was not called, or a
208 selftest failed (for example, if -mms-bitfields was not used on
211 * New functions gpgme_io_read and gpgme_io_write for use with
212 gpgme_passphrase_cb_t and gpgme_edit_cb_t functions.
214 * New functions gpgme_result_ref and gpgme_result_unref to detach
215 result structures from a context.
217 * New functions gpgme_op_export_keys_start and gpgme_op_export_keys
218 that allow to specify exported keys through gpgme_key_t objects
221 * New mode of operation gpgme_export_mode_t that allows exporting
224 * Interface changes relative to the 1.1.7 release:
225 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
226 GPGME_KEYLIST_MODE_EPHEMERAL NEW.
227 GPGME_PROTOCOL_ASSUAN NEW.
228 gpgme_assuan_data_cb_t NEW.
229 gpgme_assuan_inquire_cb_t NEW.
230 gpgme_assuan_status_cb_t NEW.
231 gpgme_op_assuan_transact_start NEW.
232 gpgme_op_assuan_transact NEW.
233 gpgme_op_assuan_result NEW.
234 gpgme_op_import_keys NEW.
235 gpgme_op_import_keys_start NEW.
236 gpgme_subkey_t EXTENDED: New fields is_cardkey, card_number.
237 GPGME_ENCRYPT_NO_ENCRYPT_TO NEW.
238 gpgme_check_version CHANGED: Is now a macro.
239 gpgme_new EXTENDED: More failure codes.
242 gpgme_result_ref NEW.
243 gpgme_result_unref NEW.
244 gpgme_export_mode_t NEW.
245 gpgme_export_ext_start EXTENDED: Arg RESERVED is now a MODE flag.
246 gpgme_op_export EXTENDED: Arg RESERVED is now a MODE flag.
247 gpgme_op_export_ext_start EXTENDED: Arg RESERVED is now a MODE flag.
248 gpgme_op_export_ext EXTENDED: Arg RESERVED is now a MODE flag.
249 gpgme_op_export_keys_start NEW.
250 gpgme_op_export_keys NEW.
251 GPGME_DATA_ENCODING_URL NEW.
252 GPGME_DATA_ENCODING_URL0 NEW.
253 GPGME_DATA_ENCODING_URLESC NEW.
254 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
257 Noteworthy changes in version 1.1.8 (2008-12-08)
258 ------------------------------------------------
260 * SIGPIPE is now again ignored as described in the manual. Fixes
261 regresion introduced with 1.1.6.
264 Noteworthy changes in version 1.1.7 (2008-10-17)
265 ------------------------------------------------
267 * Using GPGME_KEYLIST_MODE_LOCAL combined with
268 GPGME_KEYLIST_MODE_EXTERN is now supported; it uses the
269 --locate-keys feature of gpg (>= 2.0.10).
271 * The encoding of gpgme_data_t objects can affect the output encoding
272 of export, sign and encrypt operations now (the same operations
273 that are also affected by the ASCII mode switch). We believe this
274 change in the ABI is innocent enough not to break existing
275 applications (it only affects the S/MIME backend on certain
278 * The reference manual now includes the specification of "The GnuPG
281 * A new function gpgme_cancel_async can be used to asynchronously
282 cancel any pending operation at any time, from any thread.
284 * Interface changes relative to the 1.1.6 release:
285 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
286 gpgme_op_encrypt CHANGED: Output encoding can affect result.
287 gpgme_op_encrypt_start CHANGED: Output encoding can affect result.
288 gpgme_op_encrypt_sign CHANGED: Output encoding can affect result.
289 gpgme_op_encrypt_sign_start CHANGED: Output encoding can affect result.
290 gpgme_op_sign CHANGED: Output encoding can affect result.
291 gpgme_op_sign_start CHANGED: Output encoding can affect result.
292 gpgme_op_export CHANGED: Output encoding can affect result.
293 gpgme_op_export_start CHANGED: Output encoding can affect result.
294 gpgme_op_export_ext CHANGED: Output encoding can affect result.
295 gpgme_op_export_ext_start CHANGED: Output encoding can affect result.
296 gpgme_cancel_async NEW
297 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
300 Noteworthy changes in version 1.1.6 (2008-01-04)
301 ------------------------------------------------
303 * Bug fixes for for W32.
305 * A new, experimental (and thus undocumented and potentially
306 unstable) interface for accessing gpg-conf through GPGME has been
309 * Interface changes relative to the 1.1.1 release:
310 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
311 gpgme_signature_t EXTENDED: New field chain_model.
312 gpgme_op_getauditlog_start NEW.
313 gpgme_op_getauditlog NEW.
314 GPGME_AUDITLOG_HTML NEW.
315 GPGME_AUDITLOG_WITH_HELP NEW.
316 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
319 Noteworthy changes in version 1.1.5 (2007-07-09)
320 ------------------------------------------------
322 * Bug and portability fixes (mainly for W32).
325 Noteworthy changes in version 1.1.4 (2007-03-05)
326 ------------------------------------------------
328 * Detect and bail out on double plaintext messages. This is required
329 so that applications can properly detect the signed parts of a
330 message. Actual there is now a double protection as GnuPG 1.4.7
331 will detect this case too.
334 Noteworthy changes in version 1.1.3 (2007-01-29)
335 ------------------------------------------------
337 * Fixed a memory leak in gpgme_data_release_and_get_mem.
339 * Fixed a bug in Windows command line quoting.
342 Noteworthy changes in version 1.1.2 (2006-03-02)
343 ------------------------------------------------
345 * Fixed a bug in the W32 glib backend.
348 Noteworthy changes in version 1.1.1 (2006-02-23)
349 ------------------------------------------------
351 * Fixed a bug in that the fingerprints of subkeys are not available.
353 * Clarified usage of the SECRET flag in key listings. It is now
356 * Reading signature notations and policy URLs on key signatures is
357 supported. They can be found in the new field notations of the
358 gpgme_key_sig_t structure. This has to be enabled with the keylist
359 mode flag GPGME_KEYLIST_MODE_SIG_NOTATIONS.
361 * A new gpgme_free() function solves the problem of using different
362 allocators in a single program. This function should now be used
363 instead calling free() to release the buffer returned by
364 gpgme_data_release_and_get_mem. It is recommended that you always
365 do this, but it is only necessary on certain platforms, so backwards
366 compatibility is provided. In other words: If free() worked for
367 you before, it will keep working.
369 * New status codes GPGME_PKA_TRUST_GOOD and GPGME_PKA_TRUST_BAD.
370 They are analyzed by the verify handlers and made available in the
371 new PKA_TRUST and PKA_ADDRESS fields of the signature result structure.
373 * Interface changes relative to the 1.1.0 release:
374 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
375 gpgme_key_sig_t EXTENDED: New field notations.
376 GPGME_KEYLIST_MODE_SIG_NOTATIONS NEW
378 GPGME_STATUS_PKA_TRUST_BAD NEW
379 GPGME_STATUS_PKA_TRUST_GOOD NEW
380 gpgme_signature_t EXTENDED: New field pka_trust.
381 gpgme_signature_t EXTENDED: New field pka_address.
382 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
385 Noteworthy changes in version 1.1.0 (2005-10-01)
386 ------------------------------------------------
388 * You can now configure the backend engine file name and home
389 directory to be used, as default and per context.
391 * Information about the recipients of an encrypted text is now
392 available at decryption time.
394 * New status GPGME_STATUS_PLAINTEXT. This is analyzed by the decrypt
395 and verify handlers, the information about the plaintext filename,
396 if available is made available in the new field file_name of the
397 respective result structure.
399 * The code for "automagically detecting the thread library" has been
400 removed from libgpgme. It is deprecated since version 0.4.3.
401 Since then, you had to link against libgpgme-pthread for
402 applications using pthread and libgpgme-pth for applications using
405 The code was removed because it caused compilation problems on
406 systems where the pthread.h header from GNU Pth is available in
407 addition to the system header (FreeBSD 6 and later for example).
409 * "./autogen.sh --build-w32" does now build gpgme.dll.
411 * [W32] The environment variable GPGME_DEBUG now uses a semicolon as
412 delimiter. The standard install directory is used when locating
413 gpg or gpgsm before finally falling back to the hardwired name.
415 * There is a new flag for keys and subkeys, is_qualified, which
416 indicates if a key can be used for qualified signatures according
417 to local government regulations.
419 * You can associate a filename with a data object using the new
420 function gpgme_data_set_file_name(). This filename will be stored
421 in the output when encrypting or signing the data and will be
422 returned when decrypting or verifying the output data.
424 * You can now set notation data at signature creation with the new
425 function gpgme_sig_notation_add().
427 * Interface changes relative to the 1.0.3 release:
428 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
429 gpgme_set_engine_info NEW
430 gpgme_ctx_get_engine_info NEW
431 gpgme_ctx_set_engine_info NEW
432 gpgme_recipient_t NEW
433 gpgme_decrypt_result_t EXTENDED: New field recipients.
434 gpgme_verify_result_t EXTENDED: New fields pubkey_algo, hash_algo.
435 gpgme_decrypt_result_t EXTENDED: New field plaintext_filename.
436 gpgme_verify_result_t EXTENDED: New field plaintext_filename.
437 GPGME_STATUS_PLAINTEXT NEW
438 gpgme_key_t EXTENDED: New field is_qualified.
439 gpgme_subkey_t EXTENDED: New field is_qualified.
440 gpgme_data_get_file_name NEW
441 gpgme_data_set_file_name NEW
442 gpgme_sig_notation_flags_t NEW
443 GPGME_SIG_NOTATION_HUMAN_READABLE NEW
444 GPGME_SIG_NOTATAION_CRITICAL NEW
445 gpgme_sig_notation_clear NEW
446 gpgme_sig_notation_add NEW
447 gpgme_sig_notation_get NEW
448 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
451 Noteworthy changes in version 1.0.3 (2005-06-20)
452 ------------------------------------------------
454 * Previousy, GPGME would use a default "include certs" of 1. This
455 has been changed. Now GPGME will use the crypto backend engines
456 default unless you set the value with gpgme_set_include_certs()
457 explicitely. A new macro GPGME_INCLUDE_CERTS_DEFAULT can be used
458 as a value to explicitely request the new default behaviour.
460 Because the default changes, this is a slight change of the API
461 semantics. We consider it to be a bug fix.
463 * A bug which made GPGME hang has been fixed. If you have
464 experienced hanging before, please try out this version and let me
465 know if you still experience hanging problems.
467 * Interface changes relative to the 0.9.0 release:
468 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
469 gpgme_set_include_certs CHANGED DEFAULT
470 GPGME_INCLUDE_CERTS_DEFAULT NEW
471 GPGME_STATUS_SIG_SUBPACKET NEW
472 GPGME_STATUS_NEED_PASSPHRASE_PIN NEW
473 GPGME_STATUS_SC_OP_FAILURE NEW
474 GPGME_STATUS_SC_OP_SUCCESS NEW
475 GPGME_STATUS_CARDCTRL NEW
476 GPGME_STATUS_BACKUP_KEY_CREATED NEW
477 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
480 Noteworthy changes in version 1.0.2 (2004-12-28)
481 ------------------------------------------------
483 * Changed the license of the library to the GNU Lesser General Public
484 License (LGPL), version 2.1 or later.
487 Noteworthy changes in version 1.0.1 (2004-10-22)
488 ------------------------------------------------
493 Noteworthy changes in version 1.0.0 (2004-09-30)
494 ------------------------------------------------
496 * Version 1.0.0! We are proud to present you with a thoroughly
497 tested and stable version of the GPGME library. A big Thank You!
498 to all the people who made this possible.
500 The development will be branched into a stable 1.x.y series and the
503 * The gpgme.m4 macro supports checking the API version. Just prepend
504 it to the required version string, separated by a colon. For
505 example, this release has the version "1:1.0.0". The last release
506 to which this version is (mostly) ABI compatible is "1:0.4.2",
507 which is the default required version.
510 Noteworthy changes in version 0.9.0 (2004-06-08)
511 ------------------------------------------------
513 * The type gpgme_key_t has now a new field keylist_mode that contains
514 the keylist mode that was active at the time the key was retrieved.
516 * The type gpgme_decrypt_result_t has a new field "wrong_key_usage"
517 that contains a flag indicating that the key should not have been
520 * Verifying a signature of a revoked key gives the correct result now
521 (GPG_ERR_CERT_REVOKED error code).
523 * Clarified that the error code GPG_ERR_NO_DATA from the decrypt &
524 verify operations still allows you to look at the signature
527 * Clarified that patterns in keylisting operations have an upper
528 limit, and thus are not suited to list many keys at once by their
529 fingerprint. Also improve the error message if the pattern is too
530 long for the CMS protocol to handle.
532 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
533 gpgme_key_t EXTENDED: New field keylist_mode.
534 gpgme_decrypt_result_t EXTENDED: New field wrong_key_usage.
535 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
538 Noteworthy changes in version 0.4.7 (2004-04-29)
539 ------------------------------------------------
541 * Correctly initialize the fields expired, revoked, invalid, and
542 disabled in the gpgme_key_t structures.
544 * A bug fix: The flag wrong_key_usage of gpgme_signature_t was
545 accidently of type int instead unsigned int.
547 * Interface changes relative to the 0.4.5 release:
548 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
549 gpgme_signature_t CHANGED: wrong_key_usage is unsigned int now.
550 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
552 Noteworthy changes in version 0.4.6 (2004-04-06)
553 ------------------------------------------------
558 Noteworthy changes in version 0.4.5 (2004-03-07)
559 ------------------------------------------------
561 * GPGME is now compiled with LFS (large file support) by default.
562 This means that _all_ programs using GPGME must be compiled with
563 LFS support enabled by default. You can do this easily with
564 autoconf, by using the AC_SYS_LARGEFILE macro. Or you can do this
565 without autoconf by defining the preprocessor symbol
566 _FILE_OFFSET_BITS to 64 (by passing the -D_FILE_OFFSET_BITS=64 to
567 the C compiler command line, or by defining this preprocessor
568 symbol before including any system header files). For more
569 details, read the section on LFS in the manual.
571 Up to now, it was undocumented that GPGME was not using LFS.
572 But the public interfaces use off_t, and file descriptors are
573 exchanged between the application and GPGME. This was an oversight,
574 and bound to cause troubles in the future.
576 Writing GPGME as a dual mode library that seamlessly supports LFS
577 while keeping backwards compatibility is possible, but does not
578 solve the problem: Many applications already expect GPGME to have
579 LFS (they are compiled with off_t being a 64bit value). This is true
580 in particular for the popular Gtk+ and Qt programs.
582 So, although this is an ABI (but not an API) break, we will not
583 change the library version to reflect that. Because the interfaces
584 affected are probably not used yet in any GPGME 0.4 based
585 application, we don't expect any real failures from this change.
586 In fact, applications already using LFS will have some subtle bugs
589 However, if you encounter an application using GPGME 0.4.x that
590 does _not_ use LFS by default (off_t is a 32bit value), _and_
591 uses at least one of the functions gpgme_data_seek,
592 gpgme_data_new_from_filepart, or a gpgme_data_seek_cb_t with
593 gpgme_data_new_from_cbs, then indeed this library will be ABI
594 incompatible with the program. As said above, we don't believe
595 such a program exists. If we are in error, then you have two
596 options: As a quick hack, you can configure GPGME with the
597 --disable-largefile option. This will revert the change, and GPGME
598 will not use LFS. However, GPGME will be incompatible with
599 programs that expect GPGME to use LFS. All applications are
600 required to use LFS when using GPGME, so this is only good as a
601 temporary local work-around.
603 The other option is to change the versioning of the library and
604 recompile all applications. We have reserved a special version of
605 the library for that, so you can do that without expecting a
606 version clash in the future. Furthermore, everyone who does this
607 will agree on the version to use (this is important for
608 distribution makers). Read the comment in configure.ac (before
609 LIBGPGME_LT_AGE) if you want to do this. Please don't do this
610 blindly: As stated above, we think it is unlikely this measure is
611 needed. Still, it is there if necessary. If in doubt, contact us
612 and we will give our advise for your specific situation.
614 * New key listing mode GPGME_KEYLIST_MODE_VALIDATE for validation of
617 * New interface gpgme_cancel() that can be used to cancel
618 asynchronous operations.
620 * Interface changes relative to the 0.4.4 release:
621 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
622 gpgme_data_seek_cb_t CHANGED: off_t is now a largefile type.
623 gpgme_data_seek CHANGED: off_t is now a largefile type.
624 gpgme_data_new_from_filepart CHANGED: off_t is now a largefile type.
625 GPGME_KEYLIST_MODE_VALIDATE NEW
627 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
629 Noteworthy changes in version 0.4.4 (2004-01-12)
630 ------------------------------------------------
632 * The member "class" in gpgme_key_sig_t and gpgme_new_signature_t has
633 been renamed to "sig_class", to avoid clash with C++ compilers. In
634 the C API, the old name "class" has been preserved for backwards
635 compatibility, but is deprecated.
637 * Interface changes relative to the 0.4.3 release:
638 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
639 gpgme_key_sig_t CHANGED: class deprecated, use new sig_class.
640 gpgme_new_signature_t CHANGED: class deprecated, use new sig_class.
641 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
643 Noteworthy changes in version 0.4.3 (2003-10-06)
644 ------------------------------------------------
646 * libgpgme should not be used for threaded programs anymore. This
647 never worked reliably in all cases, because you had to
648 be careful about the linking order and libtool wouldn't do that for
649 you automatically. Instead, now you have to link against
650 libgpgme-pthread for applications using pthread and libgpgme-pth for
651 applications using GNU Pth.
653 The old code for automagically detecting the thread library is
654 still part of libgpgme, but it is DEPRECATED.
656 * There are new automake macros AM_PATH_GPGME_PTH and
657 AM_PATH_GPGME_PTHREAD, which support checking for thread-enabled
658 versions of GPGME. They define GPGME_PTH_CFLAGS, GPGME_PTH_LIBS,
659 GPGME_PTHREAD_CFLAGS and GPGME_PTHREAD_LIBS respectively. These
660 variables of course also include the configuration for the thread
661 package itself. Alternatively, use libtool.
663 * gpgme_strerror_r as a thread safe variant of gpgme_strerror was
666 * gpgme-config doesn't support setting the prefix or exec prefix
667 anymore. I don't think it ever worked correctly, and it seems to
670 * gpgme_get_key fails with GPG_ERR_AMBIGUOUS_NAME if the key ID
671 provided was not unique, instead returning the first matching key.
673 * gpgme_key_t and gpgme_subkey_t have a new field, can_authenticate,
674 that indicates if the key can be used for authentication.
676 * gpgme_signature_t's status field is now correctly set to an error
677 with error code GPG_ERR_NO_PUBKEY if public key is not found.
679 * gpgme_new_signature_t's class field is now an unsigned int, rather
680 than an unsigned long (the old class field is preserved for
681 backwards compatibility).
683 * A new function gpgme_set_locale() is provided to allow configuring
684 the locale for the crypto backend. This is necessary for text
685 terminals so that programs like the pinentry can be started with
686 the right locale settings for the terminal the application is running
687 on, in case the terminal has different settings than the system
688 default (for example, if it is a remote terminal). You are highly
689 recommended to call the following functions directly after
694 setlocale (LC_ALL, "");
695 gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
696 gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
698 GPGME can not do this for you, as setlocale is not thread safe, and
699 there is no alternative.
701 * The signal action for SIGPIPE is now set to SIG_IGN by
702 gpgme_check_version, instead the first time a crypto engine is
703 started (which is not well defined).
705 * In the output of gpgme_hash_algo_name, change RMD160 to RIPEMD160,
706 TIGER to TIGER192, CRC32-RFC1510 to CRC32RFC1510, and CRC24-RFC2440
707 to CRC24RFC2440. For now, these strings can be used as the MIC
708 parameter for PGP/MIME (if appropriately modified).
710 * Interface changes relative to the 0.4.2 release:
711 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
713 gpgme_get_key CHANGED: Fails correctly if key ID not unique.
714 gpgme_key_t EXTENDED: New field can_authenticate.
715 gpgme_subkey_t EXTENDED: New field can_authenticate.
716 gpgme_new_signature_t CHANGED: New type for class field.
718 gpgme_hash_algo_name CHANGED: Slight adjustment of algo names.
719 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
721 Noteworthy changes in version 0.4.2 (2003-07-30)
722 ------------------------------------------------
724 * Allow gpg-error to be in non-standard place when linking the test suite.
726 * Configure will fail now if gpg-error can not be found.
728 * Fixed initialized memory backed data objects for writing, which
729 caused the test program to crash (but only on Mac OS, surprisingly).
731 * Eliminate use of C99 constructs.
733 * Small improvements to the manual.
736 Noteworthy changes in version 0.4.1 (2003-06-06)
737 ------------------------------------------------
739 This is the release that 0.4.0 should have been. There are many
740 interface changes, please see below for the details. The changes are
741 sometimes the result of new functionality, but more often express a
742 paradigm shift. Others are an overdue cleanup to get GPGME in line
743 with the GNU coding standards and to make the interface more
744 self-consistent. Here is an overview on the changes:
746 All types have been renamed to conform to the GNU coding standards,
747 most of the time by keeping the whole name in lowercase and inserting
748 underscores between words.
750 All operations consistently only accept input parameters in their
751 invocation function, and return only an error code directly. Further
752 information about the result of the operation has to be retrieved
753 afterwards by calling one of the result functions. This unifies the
754 synchronous and the asynchronous interface.
756 The error values have been completely replaced by a more
757 sophisticated model that allows GPGME to transparently and accurately
758 report all errors from the other GnuPG components, irregardless of
759 process boundaries. This is achieved by using the library
760 libgpg-errors, which is shared by all GnuPG components. This library
761 is now required for GPGME.
763 The results of all operations are now provided by pointers to C
764 structs rather than by XML structs or in other ways.
766 Objects which used to be opaque (for example a key) are now pointers
767 to accessible structs, so no accessor functions are necessary.
769 Backward compatibility is provided where it was possible without too
770 much effort and did not collide with the overall sanitization effort.
771 However, this is only for ease of transition. NO DEPRECATED FUNCTION
772 OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND WILL BE
773 DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE LIBRARY.
774 Recommendations how to replace deprecated or removed functionality
775 can be found within the description of each change.
777 What follows are all changes to the interface and behaviour of GPGME
780 * If gpgme.h is included in sources compiled by GCC 3.1 or later,
781 deprecated attributes will warn about use of obsolete functions and
782 type definitions. You can suppress these warnings by passing
783 -Wno-deprecated-declarations to the gcc command.
785 * The following types have been renamed. The old types are still
786 available as aliases, but they are deprecated now:
789 GpgmeData gpgme_data_t
790 GpgmeError gpgme_error_t
791 GpgmeDataEncoding gpgme_data_encoding_t
792 GpgmeSigStat gpgme_sig_stat_t
793 GpgmeSigMode gpgme_sig_mode_t
794 GpgmeAttr gpgme_attr_t
795 GpgmeValidity gpgme_validity_t
796 GpgmeProtocol gpgme_protocol_t
798 GpgmePassphraseCb gpgme_passphrase_cb_t
799 GpgmeProgressCb gpgme_progress_cb_t
800 GpgmeIOCb gpgme_io_cb_t
801 GpgmeRegisterIOCb gpgme_register_io_cb_t
802 GpgmeRemoveIOCb gpgme_remove_io_cb_t
803 GpgmeEventIO gpgme_event_io_t
804 GpgmeEventIOCb gpgme_event_io_cb_t
805 GpgmeIOCbs gpgme_io_cbs
806 GpgmeDataReadCb gpgme_data_read_cb_t
807 GpgmeDataWriteCb gpgme_data_write_cb_t
808 GpgmeDataSeekCb gpgme_data_seek_cb_t
809 GpgmeDataReleaseCb gpgme_data_release_cb_t
810 GpgmeDataCbs gpgme_data_cbs_t
811 GpgmeTrustItem gpgme_trust_item_t
812 GpgmeStatusCode gpgme_status_code_t
814 * gpgme_error_t is now identical to gpg_error_t, the error type
815 provided by libgpg-error. More about using libgpg-error with GPGME
816 can be found in the manual. All error symbols have been removed!
818 * All functions and types in libgpg-error have been wrapped in GPGME.
819 The new types are gpgme_err_code_t and gpgme_err_source_t. The new
820 functions are gpgme_err_code, gpgme_err_source, gpgme_error,
821 gpgme_err_make, gpgme_error_from_errno, gpgme_err_make_from_errno,
822 gpgme_err_code_from_errno, gpgme_err_code_to_errno,
825 * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
827 * GnuPG 1.2.2 is required. The progress callback is now also invoked
828 for encrypt, sign, encrypt-sign, decrypt, verify, and
829 decrypt-verify operations. For verify operations on detached
830 signatures, the progress callback is invoked for both the detached
831 signature and the plaintext message, though.
833 * gpgme_passphrase_cb_t has been changed to not provide a complete
834 description, but the UID hint, passphrase info and a flag
835 indicating if this is a repeated attempt individually, so the user
836 can compose his own description from this information.
838 The passphrase is not returned as a C string, but must be written
839 to a file descriptor directly. This allows for secure passphrase
842 The return type has been changed to gpgme_error_t value. This
843 allowed to remove the gpgme_cancel function; just return
844 the error code GPG_ERR_CANCELED in the passphrase callback directly.
846 * gpgme_edit_cb_t has been changed to take a file descriptor argument.
847 The user is expected to write the response to the file descriptor,
848 followed by a newline.
850 * The recipients interface has been removed. Instead, you use
851 NULL-terminated lists of keys for specifying the recipients of an
852 encryption operation. Use the new encryption flag
853 GPGME_ENCRYPT_ALWAYS_TRUST if you want to override the validity of
854 the keys (but note that in general this is not a good idea).
856 This change has been made to the prototypes of gpgme_op_encrypt,
857 gpgme_op_encrypt_start, gpgme_op_encrypt_sign and
858 gpgme_op_encrypt_sign_start.
860 The export interface has been changed to use pattern strings like
861 the keylist interface. Thus, new functions gpgme_op_export_ext and
862 gpgme_op_export_ext_start have been added as well. Now the
863 prototypes of gpgme_op_export_start and gpgme_op_export finally
866 * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
867 summary anymore. Use gpgme_get_sig_status to retrieve the individual
870 * gpgme_io_cb_t changed from a void function to a function returning
871 a gpgme_error_t value. However, it will always return 0, so you
872 can safely ignore the return value.
874 * A new I/O callback event GPGME_EVENT_START has been added. The new
875 requirement is that you must wait until this event until you are
876 allowed to call the I/O callback handlers previously registered for
877 this context operation. Calling I/O callback functions for this
878 context operation before the start event happened is unsafe because
879 it can lead to race conditions in a multi-threaded environment.
881 * The idle function feature has been removed. It was not precisely
882 defined in a multi-threaded environment and is obsoleted by the
883 user I/O callback functions. If you still need a simple way to
884 call something while waiting on one or multiple asynchronous
885 operations to complete, don't set the HANG flag in gpgme_wait (note
886 that this will return to your program more often than the idle
889 * gpgme_wait can return NULL even if hang is true, if an error
890 occurs. In that case *status contains the error code.
892 * gpgme_get_engine_info was radically changed. Instead an XML
893 string, an info structure of the new type gpgme_engine_info_t is
894 returned. This makes it easier and more robust to evaluate the
895 information in an application.
897 * The new function gpgme_get_protocol_name can be used to convert a
898 gpgme_protocol_t value into a string.
900 * The status of a context operation is not checked anymore. Starting
901 a new operation will silently cancel the previous one. Calling a
902 function that requires you to have started an operation before without
903 doing so is undefined.
905 * The FPR argument to gpgme_op_genkey was removed. Instead, use the
906 gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
907 pointer to a structure which contains the fingerprint. This also
908 works with gpgme_op_genkey_start. The structure also provides
909 other information about the generated keys.
914 err = gpgme_op_genkey (ctx, NULL, NULL, &fpr);
916 printf ("%s\n", fpr);
920 gpgme_genkey_result_t result;
921 err = gpgme_op_genkey (ctx, NULL, NULL);
924 result = gpgme_op_genkey_result (ctx);
926 printf ("%s\n", result->fpr);
929 * The new gpgme_op_import_result function provides detailed
930 information about the result of an import operation in
931 gpgme_import_result_t and gpgme_import_status_t objects.
932 Thus, the gpgme_op_import_ext variant is deprecated.
934 * The new gpgme_op_sign_result function provides detailed information
935 about the result of a signing operation in gpgme_sign_result_t,
936 gpgme_invalid_key_t and gpgme_new_signature_t objects.
938 * The new gpgme_op_encrypt_result function provides detailed
939 information about the result of an encryption operation in
940 a GpgmeEncryptResult object.
942 * The new gpgme_op_decrypt_result function provides detailed
943 information about the result of a decryption operation in
944 a GpgmeDecryptResult object.
946 * The new gpgme_op_verify_result function provides detailed
947 information about the result of an verify operation in
948 a GpgmeVerifyResult object. Because of this, the GPGME_SIG_STAT_*
949 values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
950 gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
951 and gpgme_get_notation is removed.
953 * GpgmeTrustItem objects have now directly accessible data, so the
954 gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
955 accessor functions are deprecated. Also, reference counting is
956 available through gpgme_trust_item_ref and gpgme_trust_item_unref
957 (the gpgme_trust_item_release alias for the latter is deprecated).
959 * Keys are not cached internally anymore, so the force_update argument
960 to gpgme_get_key has been removed.
962 * GpgmeKey objects have now directly accessible data so the
963 gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
964 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
965 functions are deprecated. Also, gpgme_key_release is now
966 deprecated. The gpgme_key_get_as_xml function has been dropped.
968 * Because all interfaces using attributes are deprecated, the
969 GpgmeAttr data type is also deprecated.
971 * The new gpgme_op_keylist_result function provides detailed
972 information about the result of a key listing operation in
973 a GpgmeKeyListResult object.
975 * Now that each function comes with its own result retrieval
976 interface, the generic gpgme_get_op_info interface is not useful
979 * The type and mode of data objects is not available anymore.
981 * Interface changes relative to the 0.4.0 release:
982 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
983 GpgmeCtx DEPRECATED: Use gpgme_ctx_t.
984 GpgmeData DEPRECATED: Use gpgme_data_t.
985 GpgmeError DEPRECATED: Use gpgme_error_t.
986 GpgmeDataEncoding DEPRECATED: Use gpgme_data_encoding_t.
987 GpgmeSigStat DEPRECATED: Use gpgme_sig_stat_t.
988 GpgmeSigMode DEPRECATED: Use gpgme_sig_mode_t.
989 GpgmeAttr DEPRECATED: Use gpgme_attr_t.
990 GpgmeValidity DEPRECATED: Use gpgme_validity_t.
991 GpgmeProtocol DEPRECATED: Use gpgme_protocol_t.
992 GpgmeKey DEPRECATED: Use gpgme_key_t.
993 GpgmePassphraseCb DEPRECATED: Use gpgme_passphrase_cb_t.
994 GpgmeProgressCb DEPRECATED: Use gpgme_progress_cb_t.
995 GpgmeIOCb DEPRECATED: Use gpgme_io_cb_t.
996 GpgmeRegisterIOCb DEPRECATED: Use gpgme_register_io_cb_t.
997 GpgmeRemoveIOCb DEPRECATED: Use gpgme_remove_io_cb_t.
998 GpgmeEventIO DEPRECATED: Use gpgme_event_io_t.
999 GpgmeEventIOCb DEPRECATED: Use gpgme_event_io_cb_t.
1000 GpgmeIOCbs DEPRECATED: Use gpgme_io_cbs.
1001 GpgmeDataReadCb DEPRECATED: Use gpgme_data_read_cb_t.
1002 GpgmeDataWriteCb DEPRECATED: Use gpgme_data_write_cb_t.
1003 GpgmeDataSeekCb DEPRECATED: Use gpgme_data_seek_cb_t.
1004 GpgmeDataReleaseCb DEPRECATED: Use gpgme_data_release_cb_t.
1005 GpgmeDataCbs DEPRECATED: Use gpgme_data_cbs_t.
1006 GpgmeTrustItem DEPRECATED: Use gpgme_trust_item_t.
1007 GpgmeStatusCode DEPRECATED: Use gpgme_status_code_t.
1010 gpgme_recipients_t NEW
1012 gpgme_data_encoding_t NEW
1013 gpgme_sig_stat_t NEW
1014 gpgme_sig_mode_t NEW
1016 gpgme_validity_t NEW
1017 gpgme_protocol_t NEW
1019 gpgme_passphrase_cb_t NEW
1020 gpgme_progress_cb_t NEW
1022 gpgme_register_io_cb_t NEW
1023 gpgme_remove_io_cb_t NEW
1024 gpgme_event_io_t NEW
1025 gpgme_event_io_cb_t NEW
1027 gpgme_data_read_cb_t NEW
1028 gpgme_data_write_cb_t NEW
1029 gpgme_data_seek_cb_t NEW
1030 gpgme_data_release_cb_t NEW
1031 gpgme_data_cbs_t NEW
1032 gpgme_trust_item_t NEW
1033 gpgme_status_code_t NEW
1034 GPGME_{some error code} REMOVED! Use GPG_ERR_* from libgpg-error.
1035 gpgme_err_code_t NEW
1036 gpgme_err_source_t NEW
1038 gpgme_err_source NEW
1041 gpgme_error_from_errno NEW
1042 gpgme_err_make_from_errno NEW
1043 gpgme_err_code_from_errno NEW
1044 gpgme_err_code_to_errno NEW
1046 gpgme_io_cb_t CHANGED: Return type from void to GpgmeError.
1047 gpgme_event_io_t CHANGED: New event type (all numbers changed).
1048 gpgme_passphrase_cb_t CHANGED: Desc decomposed, write directly to FD.
1049 gpgme_edit_cb_t CHANGED: Write directly to FD.
1050 gpgme_key_get_string_attr CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
1051 gpgme_op_verify CHANGED: Drop R_STAT argument.
1052 gpgme_op_decrypt_verify CHANGED: Drop R_STAT argument.
1053 gpgme_wait CHANGED: Can return NULL even if hang is true.
1054 GpgmeIdleFunc REMOVED
1055 gpgme_register_idle REMOVED
1056 GpgmeRecipients REMOVED
1057 gpgme_recipients_new REMOVED
1058 gpgme_recipients_release REMOVED
1059 gpgme_recipients_add_name REMOVED
1060 gpgme_recipients_add_name_with_validity REMOVED
1061 gpgme_recipients_count REMOVED
1062 gpgme_recipients_enum_open REMOVED
1063 gpgme_recipients_enum_read REMOVED
1064 gpgme_recipients_enum_close REMOVED
1065 gpgme_encrypt_flags_t NEW
1066 GPGME_ENCRYPT_ALWAYS_TRUST NEW
1067 gpgme_op_encrypt CHANGED: Recipients passed as gpgme_key_t[].
1068 gpgme_op_encrypt_start CHANGED: Recipients passed as gpgme_key_t[].
1069 gpgme_op_encrypt_sign CHANGED: Recipients passed as gpgme_key_t[].
1070 gpgme_op_encrypt_sign_start CHANGED: Recipients passed as gpgme_key_t[].
1071 gpgme_op_export_start CHANGED: User IDs passed as patterns.
1072 gpgme_op_export CHANGED: User IDs passed as patterns.
1073 gpgme_op_export_ext_start NEW
1074 gpgme_op_export_ext NEW
1075 gpgme_keylist_mode_t NEW
1077 gpgme_engine_info_t NEW
1078 gpgme_get_engine_info CHANGED: Return info structure instead XML.
1079 gpgme_get_protocol_name NEW
1080 gpgme_cancel REMOVED: Return error in callback directly.
1081 gpgme_op_genkey CHANGED: FPR argument dropped.
1082 gpgme_op_genkey_result NEW
1083 gpgme_genkey_result_t NEW
1084 gpgme_op_import_ext DEPRECATED: Use gpgme_op_import_result.
1085 gpgme_op_import_result NEW
1086 gpgme_import_status_t NEW
1087 gpgme_import_result_t NEW
1088 gpgme_pubkey_algo_t NEW
1089 gpgme_hash_algo_t NEW
1090 gpgme_invalid_key_t NEW
1091 gpgme_new_signature_t NEW
1092 gpgme_sign_result_t NEW
1093 gpgme_op_sign_result NEW
1094 gpgme_pubkey_algo_name NEW
1095 gpgme_hash_algo_name NEW
1096 gpgme_encrypt_result_t NEW
1097 gpgme_op_encrypt_result NEW
1098 gpgme_decrypt_result_t NEW
1099 gpgme_op_decrypt_result NEW
1100 gpgme_verify_result_t NEW
1101 gpgme_op_verify_result NEW
1102 gpgme_get_notation REMOVED: Access verify result directly instead.
1103 gpgme_get_sig_key DEPRECATED: Use gpgme_get_key with fingerprint.
1104 gpgme_get_sig_ulong_attr DEPRECATED: Use verify result directly.
1105 gpgme_get_sig_string_attr DEPRECATED: Use verify result directly.
1106 GPGME_SIG_STAT_* DEPRECATED: Use error value in sig status.
1107 gpgme_get_sig_status DEPRECATED: Use verify result directly.
1108 gpgme_trust_item_t CHANGED: Now has user accessible data members.
1109 gpgme_trust_item_ref NEW
1110 gpgme_trust_item_unref NEW
1111 gpgme_trust_item_release DEPRECATED: Use gpgme_trust_item_unref.
1112 gpgme_trust_item_get_string_attr DEPRECATED
1113 gpgme_trust_item_get_ulong_attr DEPRECATED
1114 gpgme_get_key CHANGED: Removed force_update argument.
1118 gpgme_key_t CHANGED: Now has user accessible data members.
1119 gpgme_key_get_string_attr DEPRECATED
1120 gpgme_key_get_ulong_attr DEPRECATED
1121 gpgme_key_sig_get_string_attr DEPRECATED
1122 gpgme_key_sig_get_ulong_attr DEPRECATED
1123 gpgme_key_get_as_xml REMOVED
1124 gpgme_key_list_result_t NEW
1125 gpgme_op_keylist_result NEW
1126 gpgme_get_op_info REMOVED
1127 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1129 Noteworthy changes in version 0.4.0 (2002-12-23)
1130 ------------------------------------------------
1132 * Key generation returns the fingerprint of the generated key.
1134 * New convenience function gpgme_get_key.
1136 * Supports signatures of user IDs in keys via the new
1137 GPGME_KEYLIST_MODE_SIGS keylist mode and the
1138 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
1139 interfaces. The XML info about a key also includes the signatures
1142 * New data object interface, which is more flexible and transparent.
1144 * Interface changes relative to the 0.3.9 release:
1145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1147 GpgmeDataWriteCb NEW
1149 GpgmeDataReleaseCb NEW
1151 gpgme_data_read CHANGED: Match read() closely.
1152 gpgme_data_write CHANGED: Match write() closely.
1154 gpgme_data_new_from_fd NEW
1155 gpgme_data_new_from_stream NEW
1156 gpgme_data_new_from_cbs NEW
1157 gpgme_data_rewind DEPRECATED: Replaced by gpgme_data_seek().
1158 gpgme_data_new_from_read_cb DEPRECATED: Replaced by gpgme_data_from_cbs().
1159 gpgme_data_get_type REMOVED: No replacement.
1160 gpgme_op_verify CHANGED: Take different data objects for
1161 signed text and plain text.
1162 gpgme_op_verify_start CHANGED: See gpgme_op_verify.
1163 gpgme_check_engine REMOVED: Deprecated since 0.3.0.
1164 gpgme_op_genkey CHANGED: New parameter FPR.
1165 GPGME_KEYLIST_MODE_SIGS NEW
1166 gpgme_key_sig_get_string_attr NEW
1167 gpgme_key_sig_get_ulong_attr NEW
1169 GPGME_ATTR_SIG_CLASS NEW
1170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1172 Noteworthy changes in version 0.3.16 (2003-11-19)
1173 -------------------------------------------------
1175 * Compatibility fixes for GnuPG 1.9.x
1177 Noteworthy changes in version 0.3.15 (2003-02-18)
1178 -------------------------------------------------
1180 * The progress status is sent via the progress callbacks in
1183 * Bug fix for signing operations with explicit signer settings for
1186 Noteworthy changes in version 0.3.14 (2002-12-04)
1187 -------------------------------------------------
1189 * GPGME-Plug is now in its own package "cryptplug".
1191 * Workaround for a setlocale problem. Fixed a segv related to not
1192 correctly as closed marked file descriptors.
1194 Noteworthy changes in version 0.3.13 (2002-11-20)
1195 -------------------------------------------------
1197 * Release due to changes in gpgmeplug.
1199 Noteworthy changes in version 0.3.12 (2002-10-15)
1200 -------------------------------------------------
1202 * Fixed some bux with key listings.
1204 * The development has been branched to clean up some API issues.
1205 This 0.3 series will be kept for compatibility reasons; so do don't
1206 expect new features.
1208 Noteworthy changes in version 0.3.11 (2002-09-20)
1209 -------------------------------------------------
1213 Noteworthy changes in version 0.3.10 (2002-09-02)
1214 -------------------------------------------------
1216 * Setting the signing keys for the CMS protocol does now work.
1218 * The signers setting is honoured by gpgme_op_edit.
1220 Noteworthy changes in version 0.3.9 (2002-08-21)
1221 ------------------------------------------------
1223 * A spec file for creating RPMs has been added.
1225 * An experimental interface to GnuPG's --edit-key functionality is
1226 introduced, see gpgme_op_edit.
1228 * The new gpgme_import_ext function provides a convenient access to
1229 the number of processed keys.
1231 * Interface changes relative to the 0.3.8 release:
1232 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1235 gpgme_op_edit_start NEW
1237 gpgme_op_import_ext NEW
1238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1240 Noteworthy changes in version 0.3.8 (2002-06-25)
1241 ------------------------------------------------
1243 * It is possible to use an outside event loop for the I/O to the
1244 crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
1246 * Interface changes relative to the 0.3.6 release:
1247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1249 GpgmeRegisterIOCb NEW
1253 struct GpgmeIOCbs NEW
1254 gpgme_set_io_cbs NEW
1255 gpgme_get_io_cbs NEW
1256 GPGME_ATTR_ERRTOK NEW
1257 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1259 Noteworthy changes in version 0.3.7 (2002-06-04)
1260 ------------------------------------------------
1262 * GPGME_ATTR_OTRUST is implemented now.
1264 * A first step toward thread safeness has been achieved, see the
1265 documentation for details. Supported thread libraries are pthread
1268 Noteworthy changes in version 0.3.6 (2002-05-03)
1269 ------------------------------------------------
1271 * All error output of the gpgsm backend is send to the bit bucket.
1273 * The signature verification functions are extended. Instead of
1274 always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
1275 expired signatures. 2 new functions may be used to retrieve more
1276 detailed information like the signature expiration time and a
1277 validity information of the key without an extra key looking.
1279 * The current passphrase callback and progress meter callback can be
1280 retrieved with the new functions gpgme_get_passphrase_cb and
1281 gpgme_get_progress_cb respectively.
1283 * Interface changes relative to the 0.3.5 release:
1284 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1285 gpgme_get_passphrase_cb NEW
1286 gpgme_get_progress_cb NEW
1287 GpgmeDataEncoding NEW
1288 gpgme_data_set_encoding NEW
1289 gpgme_data_get_encoding NEW
1290 GPGME_SIG_STAT_GOOD_EXP NEW
1291 GPGME_SIG_STAT_GOOD_EXPKEY NEW
1292 gpgme_op_verify CHANGED: Returns more status codes.
1293 GPGME_ATTR_SIG_STATUS NEW
1294 gpgme_get_sig_string_attr NEW
1295 gpgme_get_sig_ulong_attr NEW
1296 gpgme_get_protocol NEW
1297 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1299 Noteworthy changes in version 0.3.5 (2002-04-01)
1300 ------------------------------------------------
1302 * gpgme_op_encrypt can be called with RECIPIENTS being 0. In this
1303 case, symmetric encryption is performed. Note that this requires a
1304 passphrase from the user.
1306 * More information is returned for X.509 certificates.
1308 * Interface changes relative to the 0.3.4 release:
1309 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1310 gpgme_op_encrypt EXTENDED: Symmetric encryption possible
1311 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1313 Noteworthy changes in version 0.3.4 (2002-03-04)
1314 ------------------------------------------------
1316 * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
1317 some recipients have been invalid, whereas earlier versions
1318 succeeded in this case. The plaintext is still encrypted for all valid
1319 recipients, so the application might take this error as a hint that
1320 the ciphertext is not usable for all requested recipients.
1321 Information about invalid recipients is available with gpgme_get_op_info.
1323 * gpgme_op_verify now allows to pass an uninitialized data object as
1324 its plaintext argument to check for normal and cleartext
1325 signatures. The plaintext is then returned in the data object.
1327 * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
1328 to set and get the number of certifications to include in S/MIME
1331 * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
1332 to encrypt and sign a message in a combined operation.
1334 * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
1336 * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
1338 * Interface changes relative to the 0.3.3 release:
1339 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1340 gpgme_op_encrypt CHANGED: Can fail with GPGME_Invalid_Recipients
1341 gpgme_op_verify EXTENDED: Accepts uninitialized text argument
1342 gpgme_key_get_ulong_attr EXTENDED: Supports GPGME_ATTR_EXPIRE
1343 gpgme_set_include_certs NEW
1344 gpgme_get_include_certs NEW
1345 gpgme_op_encrypt_sign NEW
1346 gpgme_op_encrypt_sign_start NEW
1347 gpgme_op_keylist_ext_start NEW
1348 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1350 Noteworthy changes in version 0.3.3 (2002-02-12)
1351 ------------------------------------------------
1353 * Fix the Makefile in jnlib.
1355 * Fix the test suite (hopefully). It should clean up all its state
1356 with `make check' now.
1359 Noteworthy changes in version 0.3.2 (2002-02-10)
1360 ------------------------------------------------
1362 * Remove erroneous dependency on libgcrypt in jnlib.
1365 Noteworthy changes in version 0.3.1 (2002-02-09)
1366 ------------------------------------------------
1368 * There is a Texinfo manual documenting the API.
1370 * The gpgme_set_keylist_mode function returns an error, and changed
1371 its meaning. It is no longer usable to select between normal and
1372 fast mode (newer versions of GnuPG will always be fast), but
1373 selects between local keyring, remote keyserver, or both.
1374 For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
1375 and GPGME_KEYLIST_MODE_EXTERN. To make it possible to modify the
1376 current setting, a fucntion gpgme_get_keylist_mode was added to
1377 retrieve the current mode.
1379 * gpgme_wait accepts a new argument STATUS to return the error status
1380 of the operation on the context. Its definition is closer to
1381 waitpid() now than before.
1383 * The LENGTH argument to gpgme_data_new_from_filepart changed its
1384 type from off_t to the unsigned size_t.
1386 * The R_HD argument to the GpgmePassphraseCb type changed its type
1387 from void* to void**.
1389 * New interface gpgme_op_trustlist_end() to match
1390 gpgme_op_keylist_end().
1392 * The CryptPlug modules have been renamed to gpgme-openpgp and
1393 gpgme-smime, and they are installed in pkglibdir by `make install'.
1395 * An idle function can be registered with gpgme_register_idle().
1397 * The GpgSM backend supports key generation with gpgme_op_genkey().
1399 * Interface changes relative to the 0.3.0 release:
1400 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1401 gpgme_data_new_from_filepart CHANGED: Type of LENGTH is size_t.
1402 GpgmePassphraseCb CHANGED: Type of R_HD is void **.
1403 gpgme_wait CHANGED: New argument STATUS.
1404 gpgme_set_keylist_mode CHANGED: Type of return value is GpgmeError.
1405 The function has a new meaning!
1406 gpgme_get_keylist_mode NEW
1407 GPGME_KEYLIST_MODE_LOCAL NEW
1408 GPGME_KEYLIST_MODE_EXTERN NEW
1409 gpgme_op_trustlist_next NEW
1411 gpgme_register_idle NEW
1412 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1414 Noteworthy changes in version 0.3.0 (2001-12-19)
1415 ------------------------------------------------
1417 * New interface gpgme_set_protocol() to set the protocol and thus the
1418 crypto engine to be used by the context. Currently, the OpenPGP
1419 and the CMS protocols are supported. They are specified by the new
1420 preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
1421 A new context uses the OpenPGP engine by default.
1423 * gpgme_get_engine_info() returns information for all crypto engines
1424 compiled into the library. The XML format has changed. To
1425 reliably get the version of a crypto engine, the <version> tag
1426 after the appropriate <protocol> tag has to be looked for.
1428 * New interface gpgme_engine_check_version(), obsoleting
1429 gpgme_check_engine(). Check the version of all engines you are
1430 supporting in your software.
1432 * GpgmeKey lists the user ids in the order as they are returned by
1433 GnuPG, first the primary key with index 0, then the sub-user ids.
1435 * New operation gpgme_op_decrypt_verify() to decrypt and verify
1436 signatures simultaneously.
1438 * The new interface gpgme_op_keylist_end() terminates a pending
1439 keylist operation. A keylist operation is also terminated when
1440 gpgme_op_keylist_next() returns GPGME_EOF.
1442 * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
1443 cross-compiled, or even compiled without support for GnuPG
1446 * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
1447 `--with-gpgsm=PATH'). It is enabled by default if the `gpgsm' is found
1448 in the path, but it can also be compiled without support for GpgSM
1449 (`--without-gpgsm').
1451 * CryptPlug modules for GPGME are included and can be enabled at
1452 configure time (`--enable-gpgmeplug'). There is one module which
1453 uses the GnuPG engine (`gpgmeplug') and one module which uses the
1454 GpgSM engine (`gpgsmplug').
1456 * Interface changes relative to the latest 0.2.x release:
1457 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1458 gpgme_key_get_as_xml CHANGED: Sub-user ids reversed in order.
1459 gpgme_key_get_string_attr CHANGED: User ids reversed in order.
1460 gpgme_key_get_ulong_attr CHANGED: User ids reversed in order.
1461 gpgme_get_engine_info CHANGED: New format, extended content.
1462 gpgme_engine_check_version NEW
1463 gpgme_decrypt_verify_start NEW
1464 gpgme_decrypt_verify NEW
1465 gpgme_op_keylist_next NEW
1466 gpgme_set_protocol NEW
1467 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1470 Noteworthy changes in version 0.2.3 (2001-09-17)
1471 ------------------------------------------------
1473 * New function gpgme_get_op_info which can be used to get the micalg
1474 parameter needed for MOSS.
1476 * New functions gpgme_get_armor and gpgme_get_textmode.
1478 * The usual bug fixes and some minor functionality improvements.
1480 * Added a simple encryption component for MS-Windows; however the
1481 build procedure might have some problems.
1484 Noteworthy changes in version 0.2.2 (2001-06-12)
1485 ------------------------------------------------
1487 * Implemented a key cache.
1489 * Fixed a race condition under W32 and some other bug fixes.
1492 Noteworthy changes in version 0.2.1 (2001-04-02)
1493 ------------------------------------------------
1495 * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
1497 * Handle GnuPG's new key capabilities output and support revocation
1500 * Made the W32 support more robust.
1503 Copyright 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009,
1506 This file is free software; as a special exception the author gives
1507 unlimited permission to copy and/or distribute it, with or without
1508 modifications, as long as this notice is preserved.
1510 This file is distributed in the hope that it will be useful, but
1511 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
1512 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.