NEWS

   1 Noteworthy changes in version 1.1.7 (2008-10-177)
   2 ------------------------------------------------
   3
   4  * Using GPGME_KEYLIST_MODE_LOCAL combined with
   5    GPGME_KEYLIST_MODE_EXTERN is now supported; it uses the
   6    --locate-keys feature of gpg (>= 2.0.10).
   7
   8  * The encoding of gpgme_data_t objects can affect the output encoding
   9    of export, sign and encrypt operations now (the same operations
  10    that are also affected by the ASCII mode switch).  We believe this
  11    change in the ABI is innocent enough not to break existing
  12    applications (it only affects the S/MIME backend on certain
  13    operations).
  14
  15  * The reference manual now includes the specification of "The GnuPG
  16    UI Server protocol".
  17
  18  * A new function gpgme_cancel_async can be used to asynchronously
  19    cancel any pending operation at any time, from any thread.
  20
  21  * Interface changes relative to the 1.1.6 release:
  22  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23 gpgme_op_encrypt                CHANGED: Output encoding can affect result.
  24 gpgme_op_encrypt_start          CHANGED: Output encoding can affect result.
  25 gpgme_op_encrypt_sign           CHANGED: Output encoding can affect result.
  26 gpgme_op_encrypt_sign_start     CHANGED: Output encoding can affect result.
  27 gpgme_op_sign                   CHANGED: Output encoding can affect result.
  28 gpgme_op_sign_start             CHANGED: Output encoding can affect result.
  29 gpgme_op_export                 CHANGED: Output encoding can affect result.
  30 gpgme_op_export_start           CHANGED: Output encoding can affect result.
  31 gpgme_op_export_ext             CHANGED: Output encoding can affect result.
  32 gpgme_op_export_ext_start       CHANGED: Output encoding can affect result.
  33 gpgme_cancel_async              NEW
  34  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35
  36
  37 Noteworthy changes in version 1.1.6 (2008-01-04)
  38 ------------------------------------------------
  39
  40  * Bug fixes for for W32.
  41
  42  * A new, experimental (and thus undocumented and potentially
  43    unstable) interface for accessing gpg-conf through GPGME has been
  44    added.
  45
  46  * Interface changes relative to the 1.1.1 release:
  47  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  48  gpgme_signature_t               EXTENDED: New field chain_model.
  49  gpgme_op_getauditlog_start      NEW.
  50  gpgme_op_getauditlog            NEW.
  51  GPGME_AUDITLOG_HTML             NEW.
  52  GPGME_AUDITLOG_WITH_HELP        NEW.
  53  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  54
  55
  56 Noteworthy changes in version 1.1.5 (2007-07-09)
  57 ------------------------------------------------
  58
  59  * Bug and portability fixes (mainly for W32).
  60
  61
  62 Noteworthy changes in version 1.1.4 (2007-03-05)
  63 ------------------------------------------------
  64
  65  * Detect and bail out on double plaintext messages.  This is required
  66    so that applications can properly detect the signed parts of a
  67    message.  Actual there is now a double protection as GnuPG 1.4.7
  68    will detect this case too.
  69
  70
  71 Noteworthy changes in version 1.1.3 (2007-01-29)
  72 ------------------------------------------------
  73
  74  * Fixed a memory leak in gpgme_data_release_and_get_mem.
  75
  76  * Fixed a bug in Windows command line quoting.
  77
  78
  79 Noteworthy changes in version 1.1.2 (2006-03-02)
  80 ------------------------------------------------
  81
  82  * Fixed a bug in the W32 glib backend.
  83
  84
  85 Noteworthy changes in version 1.1.1 (2006-02-23)
  86 ------------------------------------------------
  87
  88  * Fixed a bug in that the fingerprints of subkeys are not available.
  89
  90  * Clarified usage of the SECRET flag in key listings.  It is now
  91    reset for stub keys.
  92
  93  * Reading signature notations and policy URLs on key signatures is
  94    supported.  They can be found in the new field notations of the
  95    gpgme_key_sig_t structure.  This has to be enabled with the keylist
  96    mode flag GPGME_KEYLIST_MODE_SIG_NOTATIONS.
  97
  98  * A new gpgme_free() function solves the problem of using different
  99    allocators in a single program.  This function should now be used
 100    instead calling free() to release the buffer returned by
 101    gpgme_data_release_and_get_mem.  It is recommended that you always
 102    do this, but it is only necessary on certain platforms, so backwards
 103    compatibility is provided.  In other words: If free() worked for
 104    you before, it will keep working.
 105
 106  * New status codes GPGME_PKA_TRUST_GOOD and GPGME_PKA_TRUST_BAD.
 107    They are analyzed by the verify handlers and made available in the
 108    new PKA_TRUST and PKA_ADDRESS fields of the signature result structure.
 109
 110  * Interface changes relative to the 1.1.0 release:
 111 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 112 gpgme_key_sig_t                 EXTENDED: New field notations.
 113 GPGME_KEYLIST_MODE_SIG_NOTATIONS NEW
 114 gpgme_free                      NEW
 115 GPGME_STATUS_PKA_TRUST_BAD      NEW
 116 GPGME_STATUS_PKA_TRUST_GOOD     NEW
 117 gpgme_signature_t               EXTENDED: New field pka_trust.
 118 gpgme_signature_t               EXTENDED: New field pka_address.
 119 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 120
 121
 122 Noteworthy changes in version 1.1.0 (2005-10-01)
 123 ------------------------------------------------
 124
 125  * You can now configure the backend engine file name and home
 126    directory to be used, as default and per context.
 127
 128  * Information about the recipients of an encrypted text is now
 129    available at decryption time.
 130
 131  * New status GPGME_STATUS_PLAINTEXT.  This is analyzed by the decrypt
 132    and verify handlers, the information about the plaintext filename,
 133    if available is made available in the new field file_name of the
 134    respective result structure.
 135
 136  * The code for "automagically detecting the thread library" has been
 137    removed from libgpgme.  It is deprecated since version 0.4.3.
 138    Since then, you had to link against libgpgme-pthread for
 139    applications using pthread and libgpgme-pth for applications using
 140    GNU Pth.
 141
 142    The code was removed because it caused compilation problems on
 143    systems where the pthread.h header from GNU Pth is available in
 144    addition to the system header (FreeBSD 6 and later for example).
 145
 146  * "./autogen.sh --build-w32" does now build gpgme.dll.
 147
 148  * [W32] The environment variable GPGME_DEBUG now uses a semicolon as
 149    delimiter.  The standard install directory is used when locating
 150    gpg or gpgsm before finally falling back to the hardwired name.
 151
 152  * There is a new flag for keys and subkeys, is_qualified, which
 153    indicates if a key can be used for qualified signatures according
 154    to local government regulations.
 155
 156  * You can associate a filename with a data object using the new
 157    function gpgme_data_set_file_name().  This filename will be stored
 158    in the output when encrypting or signing the data and will be
 159    returned when decrypting or verifying the output data.
 160
 161  * You can now set notation data at signature creation with the new
 162    function gpgme_sig_notation_add().
 163
 164  * Interface changes relative to the 1.0.3 release:
 165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 166 gpgme_set_engine_info           NEW
 167 gpgme_ctx_get_engine_info       NEW
 168 gpgme_ctx_set_engine_info       NEW
 169 gpgme_recipient_t               NEW
 170 gpgme_decrypt_result_t          EXTENDED: New field recipients.
 171 gpgme_verify_result_t           EXTENDED: New fields pubkey_algo, hash_algo.
 172 gpgme_decrypt_result_t          EXTENDED: New field plaintext_filename.
 173 gpgme_verify_result_t           EXTENDED: New field plaintext_filename.
 174 GPGME_STATUS_PLAINTEXT          NEW
 175 gpgme_key_t                     EXTENDED: New field is_qualified.
 176 gpgme_subkey_t                  EXTENDED: New field is_qualified.
 177 gpgme_data_get_file_name        NEW
 178 gpgme_data_set_file_name        NEW
 179 gpgme_sig_notation_flags_t      NEW
 180 GPGME_SIG_NOTATION_HUMAN_READABLE NEW
 181 GPGME_SIG_NOTATAION_CRITICAL    NEW
 182 gpgme_sig_notation_clear        NEW
 183 gpgme_sig_notation_add          NEW
 184 gpgme_sig_notation_get          NEW
 185 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 186
 187
 188 Noteworthy changes in version 1.0.3 (2005-06-20)
 189 ------------------------------------------------
 190
 191  * Previousy, GPGME would use a default "include certs" of 1.  This
 192    has been changed.  Now GPGME will use the crypto backend engines
 193    default unless you set the value with gpgme_set_include_certs()
 194    explicitely.  A new macro GPGME_INCLUDE_CERTS_DEFAULT can be used
 195    as a value to explicitely request the new default behaviour.
 196
 197    Because the default changes, this is a slight change of the API
 198    semantics.  We consider it to be a bug fix.
 199
 200  * A bug which made GPGME hang has been fixed.  If you have
 201    experienced hanging before, please try out this version and let me
 202    know if you still experience hanging problems.
 203
 204  * Interface changes relative to the 0.9.0 release:
 205 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 206 gpgme_set_include_certs         CHANGED DEFAULT
 207 GPGME_INCLUDE_CERTS_DEFAULT     NEW
 208 GPGME_STATUS_SIG_SUBPACKET      NEW
 209 GPGME_STATUS_NEED_PASSPHRASE_PIN NEW
 210 GPGME_STATUS_SC_OP_FAILURE      NEW
 211 GPGME_STATUS_SC_OP_SUCCESS      NEW
 212 GPGME_STATUS_CARDCTRL           NEW
 213 GPGME_STATUS_BACKUP_KEY_CREATED NEW
 214 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 215
 216
 217 Noteworthy changes in version 1.0.2 (2004-12-28)
 218 ------------------------------------------------
 219
 220  * Changed the license of the library to the GNU Lesser General Public
 221    License (LGPL), version 2.1 or later.
 222
 223
 224 Noteworthy changes in version 1.0.1 (2004-10-22)
 225 ------------------------------------------------
 226
 227  * Only bug fixes.
 228
 229
 230 Noteworthy changes in version 1.0.0 (2004-09-30)
 231 ------------------------------------------------
 232
 233  * Version 1.0.0!  We are proud to present you with a thoroughly
 234    tested and stable version of the GPGME library.  A big Thank You!
 235    to all the people who made this possible.
 236
 237    The development will be branched into a stable 1.x.y series and the
 238    head.
 239
 240  * The gpgme.m4 macro supports checking the API version.  Just prepend
 241    it to the required version string, separated by a colon.  For
 242    example, this release has the version "1:1.0.0".  The last release
 243    to which this version is (mostly) ABI compatible is "1:0.4.2",
 244    which is the default required version.
 245
 246
 247 Noteworthy changes in version 0.9.0 (2004-06-08)
 248 ------------------------------------------------
 249
 250  * The type gpgme_key_t has now a new field keylist_mode that contains
 251    the keylist mode that was active at the time the key was retrieved.
 252
 253  * The type gpgme_decrypt_result_t has a new field "wrong_key_usage"
 254    that contains a flag indicating that the key should not have been
 255    used for encryption.
 256
 257  * Verifying a signature of a revoked key gives the correct result now
 258    (GPG_ERR_CERT_REVOKED error code).
 259
 260  * Clarified that the error code GPG_ERR_NO_DATA from the decrypt &
 261    verify operations still allows you to look at the signature
 262    verification result.
 263
 264  * Clarified that patterns in keylisting operations have an upper
 265    limit, and thus are not suited to list many keys at once by their
 266    fingerprint.  Also improve the error message if the pattern is too
 267    long for the CMS protocol to handle.
 268
 269 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 270 gpgme_key_t                     EXTENDED: New field keylist_mode.
 271 gpgme_decrypt_result_t          EXTENDED: New field wrong_key_usage.
 272 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 273
 274
 275 Noteworthy changes in version 0.4.7 (2004-04-29)
 276 ------------------------------------------------
 277
 278  * Correctly initialize the fields expired, revoked, invalid, and
 279    disabled in the gpgme_key_t structures.
 280
 281  * A bug fix: The flag wrong_key_usage of gpgme_signature_t was
 282    accidently of type int instead unsigned int.
 283
 284  * Interface changes relative to the 0.4.5 release:
 285 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 286 gpgme_signature_t               CHANGED: wrong_key_usage is unsigned int now.
 287 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 288
 289 Noteworthy changes in version 0.4.6 (2004-04-06)
 290 ------------------------------------------------
 291
 292  * Bug fixes
 293
 294
 295 Noteworthy changes in version 0.4.5 (2004-03-07)
 296 ------------------------------------------------
 297
 298  * GPGME is now compiled with LFS (large file support) by default.
 299    This means that _all_ programs using GPGME must be compiled with
 300    LFS support enabled by default.  You can do this easily with
 301    autoconf, by using the AC_SYS_LARGEFILE macro.  Or you can do this
 302    without autoconf by defining the preprocessor symbol
 303    _FILE_OFFSET_BITS to 64 (by passing the -D_FILE_OFFSET_BITS=64 to
 304    the C compiler command line, or by defining this preprocessor
 305    symbol before including any system header files).  For more
 306    details, read the section on LFS in the manual.
 307
 308    Up to now, it was undocumented that GPGME was not using LFS.
 309    But the public interfaces use off_t, and file descriptors are
 310    exchanged between the application and GPGME.  This was an oversight,
 311    and bound to cause troubles in the future.
 312
 313    Writing GPGME as a dual mode library that seamlessly supports LFS
 314    while keeping backwards compatibility is possible, but does not
 315    solve the problem: Many applications already expect GPGME to have
 316    LFS (they are compiled with off_t being a 64bit value).  This is true
 317    in particular for the popular Gtk+ and Qt programs.
 318
 319    So, although this is an ABI (but not an API) break, we will not
 320    change the library version to reflect that.  Because the interfaces
 321    affected are probably not used yet in any GPGME 0.4 based
 322    application, we don't expect any real failures from this change.
 323    In fact, applications already using LFS will have some subtle bugs
 324    fixed.
 325
 326    However, if you encounter an application using GPGME 0.4.x that
 327    does _not_ use LFS by default (off_t is a 32bit value), _and_
 328    uses at least one of the functions gpgme_data_seek,
 329    gpgme_data_new_from_filepart, or a gpgme_data_seek_cb_t with
 330    gpgme_data_new_from_cbs, then indeed this library will be ABI
 331    incompatible with the program.  As said above, we don't believe
 332    such a program exists.  If we are in error, then you have two
 333    options: As a quick hack, you can configure GPGME with the
 334    --disable-largefile option.  This will revert the change, and GPGME
 335    will not use LFS.  However, GPGME will be incompatible with
 336    programs that expect GPGME to use LFS.  All applications are
 337    required to use LFS when using GPGME, so this is only good as a
 338    temporary local work-around.
 339
 340    The other option is to change the versioning of the library and
 341    recompile all applications.  We have reserved a special version of
 342    the library for that, so you can do that without expecting a
 343    version clash in the future.  Furthermore, everyone who does this
 344    will agree on the version to use (this is important for
 345    distribution makers).  Read the comment in configure.ac (before
 346    LIBGPGME_LT_AGE) if you want to do this.  Please don't do this
 347    blindly: As stated above, we think it is unlikely this measure is
 348    needed.  Still, it is there if necessary.  If in doubt, contact us
 349    and we will give our advise for your specific situation.
 350
 351  * New key listing mode GPGME_KEYLIST_MODE_VALIDATE for validation of
 352    the listed keys.
 353
 354  * New interface gpgme_cancel() that can be used to cancel
 355    asynchronous operations.
 356
 357  * Interface changes relative to the 0.4.4 release:
 358 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 359 gpgme_data_seek_cb_t            CHANGED: off_t is now a largefile type.
 360 gpgme_data_seek                 CHANGED: off_t is now a largefile type.
 361 gpgme_data_new_from_filepart    CHANGED: off_t is now a largefile type.
 362 GPGME_KEYLIST_MODE_VALIDATE     NEW
 363 gpgme_cancel                    NEW
 364 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 365
 366 Noteworthy changes in version 0.4.4 (2004-01-12)
 367 ------------------------------------------------
 368
 369  * The member "class" in gpgme_key_sig_t and gpgme_new_signature_t has
 370    been renamed to "sig_class", to avoid clash with C++ compilers.  In
 371    the C API, the old name "class" has been preserved for backwards
 372    compatibility, but is deprecated.
 373
 374  * Interface changes relative to the 0.4.3 release:
 375 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 376 gpgme_key_sig_t                 CHANGED: class deprecated, use new sig_class.
 377 gpgme_new_signature_t           CHANGED: class deprecated, use new sig_class.
 378 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 379
 380 Noteworthy changes in version 0.4.3 (2003-10-06)
 381 ------------------------------------------------
 382
 383  * libgpgme should not be used for threaded programs anymore.  This
 384    never worked reliably in all cases, because you had to
 385    be careful about the linking order and libtool wouldn't do that for
 386    you automatically.  Instead, now you have to link against
 387    libgpgme-pthread for applications using pthread and libgpgme-pth for
 388    applications using GNU Pth.
 389
 390    The old code for automagically detecting the thread library is
 391    still part of libgpgme, but it is DEPRECATED.
 392
 393  * There are new automake macros AM_PATH_GPGME_PTH and
 394    AM_PATH_GPGME_PTHREAD, which support checking for thread-enabled
 395    versions of GPGME.  They define GPGME_PTH_CFLAGS, GPGME_PTH_LIBS,
 396    GPGME_PTHREAD_CFLAGS and GPGME_PTHREAD_LIBS respectively.  These
 397    variables of course also include the configuration for the thread
 398    package itself.  Alternatively, use libtool.
 399
 400  * gpgme_strerror_r as a thread safe variant of gpgme_strerror was
 401    added.
 402
 403  * gpgme-config doesn't support setting the prefix or exec prefix
 404    anymore.  I don't think it ever worked correctly, and it seems to
 405    be pointless.
 406
 407  * gpgme_get_key fails with GPG_ERR_AMBIGUOUS_NAME if the key ID
 408    provided was not unique, instead returning the first matching key.
 409
 410  * gpgme_key_t and gpgme_subkey_t have a new field, can_authenticate,
 411    that indicates if the key can be used for authentication.
 412
 413  * gpgme_signature_t's status field is now correctly set to an error
 414    with error code GPG_ERR_NO_PUBKEY if public key is not found.
 415
 416  * gpgme_new_signature_t's class field is now an unsigned int, rather
 417    than an unsigned long (the old class field is preserved for
 418    backwards compatibility).
 419
 420  * A new function gpgme_set_locale() is provided to allow configuring
 421    the locale for the crypto backend.  This is necessary for text
 422    terminals so that programs like the pinentry can be started with
 423    the right locale settings for the terminal the application is running
 424    on, in case the terminal has different settings than the system
 425    default (for example, if it is a remote terminal).  You are highly
 426    recommended to call the following functions directly after
 427    gpgme_check_version:
 428
 429    #include <locale.h>
 430
 431    setlocale (LC_ALL, "");
 432    gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
 433    gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
 434
 435    GPGME can not do this for you, as setlocale is not thread safe, and
 436    there is no alternative.
 437
 438  * The signal action for SIGPIPE is now set to SIG_IGN by
 439    gpgme_check_version, instead the first time a crypto engine is
 440    started (which is not well defined).
 441
 442  * In the output of gpgme_hash_algo_name, change RMD160 to RIPEMD160,
 443    TIGER to TIGER192, CRC32-RFC1510 to CRC32RFC1510, and CRC24-RFC2440
 444    to CRC24RFC2440.  For now, these strings can be used as the MIC
 445    parameter for PGP/MIME (if appropriately modified).
 446
 447  * Interface changes relative to the 0.4.2 release:
 448 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 449 gpgme_strerror_t                NEW
 450 gpgme_get_key                   CHANGED: Fails correctly if key ID not unique.
 451 gpgme_key_t                     EXTENDED: New field can_authenticate.
 452 gpgme_subkey_t                  EXTENDED: New field can_authenticate.
 453 gpgme_new_signature_t           CHANGED: New type for class field.
 454 gpgme_set_locale                NEW
 455 gpgme_hash_algo_name            CHANGED: Slight adjustment of algo names.
 456 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 457
 458 Noteworthy changes in version 0.4.2 (2003-07-30)
 459 ------------------------------------------------
 460
 461  * Allow gpg-error to be in non-standard place when linking the test suite.
 462
 463  * Configure will fail now if gpg-error can not be found.
 464
 465  * Fixed initialized memory backed data objects for writing, which
 466    caused the test program to crash (but only on Mac OS, surprisingly).
 467
 468  * Eliminate use of C99 constructs.
 469
 470  * Small improvements to the manual.
 471
 472
 473 Noteworthy changes in version 0.4.1 (2003-06-06)
 474 ------------------------------------------------
 475
 476  This is the release that 0.4.0 should have been.  There are many
 477  interface changes, please see below for the details.  The changes are
 478  sometimes the result of new functionality, but more often express a
 479  paradigm shift.  Others are an overdue cleanup to get GPGME in line
 480  with the GNU coding standards and to make the interface more
 481  self-consistent.  Here is an overview on the changes:
 482
 483  All types have been renamed to conform to the GNU coding standards,
 484  most of the time by keeping the whole name in lowercase and inserting
 485  underscores between words.
 486
 487  All operations consistently only accept input parameters in their
 488  invocation function, and return only an error code directly.  Further
 489  information about the result of the operation has to be retrieved
 490  afterwards by calling one of the result functions.  This unifies the
 491  synchronous and the asynchronous interface.
 492
 493  The error values have been completely replaced by a more
 494  sophisticated model that allows GPGME to transparently and accurately
 495  report all errors from the other GnuPG components, irregardless of
 496  process boundaries.  This is achieved by using the library
 497  libgpg-errors, which is shared by all GnuPG components.  This library
 498  is now required for GPGME.
 499
 500  The results of all operations are now provided by pointers to C
 501  structs rather than by XML structs or in other ways.
 502
 503  Objects which used to be opaque (for example a key) are now pointers
 504  to accessible structs, so no accessor functions are necessary.
 505
 506  Backward compatibility is provided where it was possible without too
 507  much effort and did not collide with the overall sanitization effort.
 508  However, this is only for ease of transition.  NO DEPRECATED FUNCTION
 509  OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND WILL BE
 510  DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE LIBRARY.
 511  Recommendations how to replace deprecated or removed functionality
 512  can be found within the description of each change.
 513
 514  What follows are all changes to the interface and behaviour of GPGME
 515  in detail.
 516
 517  * If gpgme.h is included in sources compiled by GCC 3.1 or later,
 518    deprecated attributes will warn about use of obsolete functions and
 519    type definitions.  You can suppress these warnings by passing
 520    -Wno-deprecated-declarations to the gcc command.
 521
 522  * The following types have been renamed.  The old types are still
 523    available as aliases, but they are deprecated now:
 524    Old name:            New name:
 525    GpgmeCtx             gpgme_ctx_t
 526    GpgmeData            gpgme_data_t
 527    GpgmeError           gpgme_error_t
 528    GpgmeDataEncoding    gpgme_data_encoding_t
 529    GpgmeSigStat         gpgme_sig_stat_t
 530    GpgmeSigMode         gpgme_sig_mode_t
 531    GpgmeAttr            gpgme_attr_t
 532    GpgmeValidity        gpgme_validity_t
 533    GpgmeProtocol        gpgme_protocol_t
 534    GpgmeKey             gpgme_key_t
 535    GpgmePassphraseCb    gpgme_passphrase_cb_t
 536    GpgmeProgressCb      gpgme_progress_cb_t
 537    GpgmeIOCb            gpgme_io_cb_t
 538    GpgmeRegisterIOCb    gpgme_register_io_cb_t
 539    GpgmeRemoveIOCb      gpgme_remove_io_cb_t
 540    GpgmeEventIO         gpgme_event_io_t
 541    GpgmeEventIOCb       gpgme_event_io_cb_t
 542    GpgmeIOCbs           gpgme_io_cbs
 543    GpgmeDataReadCb      gpgme_data_read_cb_t
 544    GpgmeDataWriteCb     gpgme_data_write_cb_t
 545    GpgmeDataSeekCb      gpgme_data_seek_cb_t
 546    GpgmeDataReleaseCb   gpgme_data_release_cb_t
 547    GpgmeDataCbs         gpgme_data_cbs_t
 548    GpgmeTrustItem       gpgme_trust_item_t
 549    GpgmeStatusCode      gpgme_status_code_t
 550
 551  * gpgme_error_t is now identical to gpg_error_t, the error type
 552    provided by libgpg-error.  More about using libgpg-error with GPGME
 553    can be found in the manual.  All error symbols have been removed!
 554
 555  * All functions and types in libgpg-error have been wrapped in GPGME.
 556    The new types are gpgme_err_code_t and gpgme_err_source_t.  The new
 557    functions are gpgme_err_code, gpgme_err_source, gpgme_error,
 558    gpgme_err_make, gpgme_error_from_errno, gpgme_err_make_from_errno,
 559    gpgme_err_code_from_errno, gpgme_err_code_to_errno,
 560    gpgme_strsource.
 561
 562  * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
 563
 564  * GnuPG 1.2.2 is required.  The progress callback is now also invoked
 565    for encrypt, sign, encrypt-sign, decrypt, verify, and
 566    decrypt-verify operations.  For verify operations on detached
 567    signatures, the progress callback is invoked for both the detached
 568    signature and the plaintext message, though.
 569
 570  * gpgme_passphrase_cb_t has been changed to not provide a complete
 571    description, but the UID hint, passphrase info and a flag
 572    indicating if this is a repeated attempt individually, so the user
 573    can compose his own description from this information.
 574
 575    The passphrase is not returned as a C string, but must be written
 576    to a file descriptor directly.  This allows for secure passphrase
 577    entries.
 578
 579    The return type has been changed to gpgme_error_t value.  This
 580    allowed to remove the gpgme_cancel function; just return
 581    the error code GPG_ERR_CANCELED in the passphrase callback directly.
 582
 583  * gpgme_edit_cb_t has been changed to take a file descriptor argument.
 584    The user is expected to write the response to the file descriptor,
 585    followed by a newline.
 586
 587  * The recipients interface has been removed.  Instead, you use
 588    NULL-terminated lists of keys for specifying the recipients of an
 589    encryption operation.  Use the new encryption flag
 590    GPGME_ENCRYPT_ALWAYS_TRUST if you want to override the validity of
 591    the keys (but note that in general this is not a good idea).
 592
 593    This change has been made to the prototypes of gpgme_op_encrypt,
 594    gpgme_op_encrypt_start, gpgme_op_encrypt_sign and
 595    gpgme_op_encrypt_sign_start.
 596
 597    The export interface has been changed to use pattern strings like
 598    the keylist interface.  Thus, new functions gpgme_op_export_ext and
 599    gpgme_op_export_ext_start have been added as well.  Now the
 600    prototypes of gpgme_op_export_start and gpgme_op_export finally
 601    make sense.
 602
 603  * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
 604    summary anymore.  Use gpgme_get_sig_status to retrieve the individual
 605    stati.
 606
 607  * gpgme_io_cb_t changed from a void function to a function returning
 608    a gpgme_error_t value.  However, it will always return 0, so you
 609    can safely ignore the return value.
 610
 611  * A new I/O callback event GPGME_EVENT_START has been added.  The new
 612    requirement is that you must wait until this event until you are
 613    allowed to call the I/O callback handlers previously registered for
 614    this context operation.  Calling I/O callback functions for this
 615    context operation before the start event happened is unsafe because
 616    it can lead to race conditions in a multi-threaded environment.
 617
 618  * The idle function feature has been removed.  It was not precisely
 619    defined in a multi-threaded environment and is obsoleted by the
 620    user I/O callback functions.  If you still need a simple way to
 621    call something while waiting on one or multiple asynchronous
 622    operations to complete, don't set the HANG flag in gpgme_wait (note
 623    that this will return to your program more often than the idle
 624    function did).
 625
 626  * gpgme_wait can return NULL even if hang is true, if an error
 627    occurs.  In that case *status contains the error code.
 628
 629  * gpgme_get_engine_info was radically changed.  Instead an XML
 630    string, an info structure of the new type gpgme_engine_info_t is
 631    returned.  This makes it easier and more robust to evaluate the
 632    information in an application.
 633
 634  * The new function gpgme_get_protocol_name can be used to convert a
 635    gpgme_protocol_t value into a string.
 636
 637  * The status of a context operation is not checked anymore.  Starting
 638    a new operation will silently cancel the previous one.  Calling a
 639    function that requires you to have started an operation before without
 640    doing so is undefined.
 641
 642  * The FPR argument to gpgme_op_genkey was removed.  Instead, use the
 643    gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
 644    pointer to a structure which contains the fingerprint.  This also
 645    works with gpgme_op_genkey_start.  The structure also provides
 646    other information about the generated keys.
 647
 648    So, instead:
 649
 650    char *fpr;
 651    err = gpgme_op_genkey (ctx, NULL, NULL, &fpr);
 652    if (!err && fpr)
 653      printf ("%s\n", fpr);
 654
 655    you should now do:
 656
 657    gpgme_genkey_result_t result;
 658    err = gpgme_op_genkey (ctx, NULL, NULL);
 659    if (!err)
 660      {
 661        result = gpgme_op_genkey_result (ctx);
 662        if (result->fpr)
 663          printf ("%s\n", result->fpr);
 664      }
 665
 666  * The new gpgme_op_import_result function provides detailed
 667    information about the result of an import operation in
 668    gpgme_import_result_t and gpgme_import_status_t objects.
 669    Thus, the gpgme_op_import_ext variant is deprecated.
 670
 671  * The new gpgme_op_sign_result function provides detailed information
 672    about the result of a signing operation in gpgme_sign_result_t,
 673    gpgme_invalid_key_t and gpgme_new_signature_t objects.
 674
 675  * The new gpgme_op_encrypt_result function provides detailed
 676    information about the result of an encryption operation in
 677    a GpgmeEncryptResult object.
 678
 679  * The new gpgme_op_decrypt_result function provides detailed
 680    information about the result of a decryption operation in
 681    a GpgmeDecryptResult object.
 682
 683  * The new gpgme_op_verify_result function provides detailed
 684    information about the result of an verify operation in
 685    a GpgmeVerifyResult object.  Because of this, the GPGME_SIG_STAT_*
 686    values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
 687    gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
 688    and gpgme_get_notation is removed.
 689
 690  * GpgmeTrustItem objects have now directly accessible data, so the
 691    gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
 692    accessor functions are deprecated.  Also, reference counting is
 693    available through gpgme_trust_item_ref and gpgme_trust_item_unref
 694    (the gpgme_trust_item_release alias for the latter is deprecated).
 695
 696  * Keys are not cached internally anymore, so the force_update argument
 697    to gpgme_get_key has been removed.
 698
 699  * GpgmeKey objects have now directly accessible data so the
 700    gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
 701    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
 702    functions are deprecated.  Also, gpgme_key_release is now
 703    deprecated.  The gpgme_key_get_as_xml function has been dropped.
 704
 705  * Because all interfaces using attributes are deprecated, the
 706    GpgmeAttr data type is also deprecated.
 707
 708  * The new gpgme_op_keylist_result function provides detailed
 709    information about the result of a key listing operation in
 710    a GpgmeKeyListResult object.
 711
 712  * Now that each function comes with its own result retrieval
 713    interface, the generic gpgme_get_op_info interface is not useful
 714    anymore and dropped.
 715
 716  * The type and mode of data objects is not available anymore.
 717
 718  * Interface changes relative to the 0.4.0 release:
 719 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 720 GpgmeCtx                        DEPRECATED: Use gpgme_ctx_t.
 721 GpgmeData                       DEPRECATED: Use gpgme_data_t.
 722 GpgmeError                      DEPRECATED: Use gpgme_error_t.
 723 GpgmeDataEncoding               DEPRECATED: Use gpgme_data_encoding_t.
 724 GpgmeSigStat                    DEPRECATED: Use gpgme_sig_stat_t.
 725 GpgmeSigMode                    DEPRECATED: Use gpgme_sig_mode_t.
 726 GpgmeAttr                       DEPRECATED: Use gpgme_attr_t.
 727 GpgmeValidity                   DEPRECATED: Use gpgme_validity_t.
 728 GpgmeProtocol                   DEPRECATED: Use gpgme_protocol_t.
 729 GpgmeKey                        DEPRECATED: Use gpgme_key_t.
 730 GpgmePassphraseCb               DEPRECATED: Use gpgme_passphrase_cb_t.
 731 GpgmeProgressCb                 DEPRECATED: Use gpgme_progress_cb_t.
 732 GpgmeIOCb                       DEPRECATED: Use gpgme_io_cb_t.
 733 GpgmeRegisterIOCb               DEPRECATED: Use gpgme_register_io_cb_t.
 734 GpgmeRemoveIOCb                 DEPRECATED: Use gpgme_remove_io_cb_t.
 735 GpgmeEventIO                    DEPRECATED: Use gpgme_event_io_t.
 736 GpgmeEventIOCb                  DEPRECATED: Use gpgme_event_io_cb_t.
 737 GpgmeIOCbs                      DEPRECATED: Use gpgme_io_cbs.
 738 GpgmeDataReadCb                 DEPRECATED: Use gpgme_data_read_cb_t.
 739 GpgmeDataWriteCb                DEPRECATED: Use gpgme_data_write_cb_t.
 740 GpgmeDataSeekCb                 DEPRECATED: Use gpgme_data_seek_cb_t.
 741 GpgmeDataReleaseCb              DEPRECATED: Use gpgme_data_release_cb_t.
 742 GpgmeDataCbs                    DEPRECATED: Use gpgme_data_cbs_t.
 743 GpgmeTrustItem                  DEPRECATED: Use gpgme_trust_item_t.
 744 GpgmeStatusCode                 DEPRECATED: Use gpgme_status_code_t.
 745 gpgme_ctx_t                     NEW
 746 gpgme_data_t                    NEW
 747 gpgme_recipients_t              NEW
 748 gpgme_error_t                   NEW
 749 gpgme_data_encoding_t           NEW
 750 gpgme_sig_stat_t                NEW
 751 gpgme_sig_mode_t                NEW
 752 gpgme_attr_t                    NEW
 753 gpgme_validity_t                NEW
 754 gpgme_protocol_t                NEW
 755 gpgme_key_t                     NEW
 756 gpgme_passphrase_cb_t           NEW
 757 gpgme_progress_cb_t             NEW
 758 gpgme_io_cb_t                   NEW
 759 gpgme_register_io_cb_t          NEW
 760 gpgme_remove_io_cb_t            NEW
 761 gpgme_event_io_t                NEW
 762 gpgme_event_io_cb_t             NEW
 763 gpgme_io_cbs                    NEW
 764 gpgme_data_read_cb_t            NEW
 765 gpgme_data_write_cb_t           NEW
 766 gpgme_data_seek_cb_t            NEW
 767 gpgme_data_release_cb_t         NEW
 768 gpgme_data_cbs_t                NEW
 769 gpgme_trust_item_t              NEW
 770 gpgme_status_code_t             NEW
 771 GPGME_{some error code}         REMOVED! Use GPG_ERR_* from libgpg-error.
 772 gpgme_err_code_t                NEW
 773 gpgme_err_source_t              NEW
 774 gpgme_err_code                  NEW
 775 gpgme_err_source                NEW
 776 gpgme_error                     NEW
 777 gpgme_err_make                  NEW
 778 gpgme_error_from_errno          NEW
 779 gpgme_err_make_from_errno       NEW
 780 gpgme_err_code_from_errno       NEW
 781 gpgme_err_code_to_errno         NEW
 782 gpgme_strsource                 NEW
 783 gpgme_io_cb_t                   CHANGED: Return type from void to GpgmeError.
 784 gpgme_event_io_t                CHANGED: New event type (all numbers changed).
 785 gpgme_passphrase_cb_t           CHANGED: Desc decomposed, write directly to FD.
 786 gpgme_edit_cb_t                 CHANGED: Write directly to FD.
 787 gpgme_key_get_string_attr       CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
 788 gpgme_op_verify                 CHANGED: Drop R_STAT argument.
 789 gpgme_op_decrypt_verify         CHANGED: Drop R_STAT argument.
 790 gpgme_wait                      CHANGED: Can return NULL even if hang is true.
 791 GpgmeIdleFunc                   REMOVED
 792 gpgme_register_idle             REMOVED
 793 GpgmeRecipients                 REMOVED
 794 gpgme_recipients_new            REMOVED
 795 gpgme_recipients_release        REMOVED
 796 gpgme_recipients_add_name       REMOVED
 797 gpgme_recipients_add_name_with_validity REMOVED
 798 gpgme_recipients_count          REMOVED
 799 gpgme_recipients_enum_open      REMOVED
 800 gpgme_recipients_enum_read      REMOVED
 801 gpgme_recipients_enum_close     REMOVED
 802 gpgme_encrypt_flags_t           NEW
 803 GPGME_ENCRYPT_ALWAYS_TRUST      NEW
 804 gpgme_op_encrypt                CHANGED: Recipients passed as gpgme_key_t[].
 805 gpgme_op_encrypt_start          CHANGED: Recipients passed as gpgme_key_t[].
 806 gpgme_op_encrypt_sign           CHANGED: Recipients passed as gpgme_key_t[].
 807 gpgme_op_encrypt_sign_start     CHANGED: Recipients passed as gpgme_key_t[].
 808 gpgme_op_export_start           CHANGED: User IDs passed as patterns.
 809 gpgme_op_export                 CHANGED: User IDs passed as patterns.
 810 gpgme_op_export_ext_start       NEW
 811 gpgme_op_export_ext             NEW
 812 gpgme_keylist_mode_t            NEW
 813 gpgme_sigsum_t                  NEW
 814 gpgme_engine_info_t             NEW
 815 gpgme_get_engine_info           CHANGED: Return info structure instead XML.
 816 gpgme_get_protocol_name         NEW
 817 gpgme_cancel                    REMOVED: Return error in callback directly.
 818 gpgme_op_genkey                 CHANGED: FPR argument dropped.
 819 gpgme_op_genkey_result          NEW
 820 gpgme_genkey_result_t           NEW
 821 gpgme_op_import_ext             DEPRECATED: Use gpgme_op_import_result.
 822 gpgme_op_import_result          NEW
 823 gpgme_import_status_t           NEW
 824 gpgme_import_result_t           NEW
 825 gpgme_pubkey_algo_t             NEW
 826 gpgme_hash_algo_t               NEW
 827 gpgme_invalid_key_t             NEW
 828 gpgme_new_signature_t           NEW
 829 gpgme_sign_result_t             NEW
 830 gpgme_op_sign_result            NEW
 831 gpgme_pubkey_algo_name          NEW
 832 gpgme_hash_algo_name            NEW
 833 gpgme_encrypt_result_t          NEW
 834 gpgme_op_encrypt_result         NEW
 835 gpgme_decrypt_result_t          NEW
 836 gpgme_op_decrypt_result         NEW
 837 gpgme_verify_result_t           NEW
 838 gpgme_op_verify_result          NEW
 839 gpgme_get_notation              REMOVED: Access verify result directly instead.
 840 gpgme_get_sig_key               DEPRECATED: Use gpgme_get_key with fingerprint.
 841 gpgme_get_sig_ulong_attr        DEPRECATED: Use verify result directly.
 842 gpgme_get_sig_string_attr       DEPRECATED: Use verify result directly.
 843 GPGME_SIG_STAT_*                DEPRECATED: Use error value in sig status.
 844 gpgme_get_sig_status            DEPRECATED: Use verify result directly.
 845 gpgme_trust_item_t              CHANGED: Now has user accessible data members.
 846 gpgme_trust_item_ref            NEW
 847 gpgme_trust_item_unref          NEW
 848 gpgme_trust_item_release        DEPRECATED: Use gpgme_trust_item_unref.
 849 gpgme_trust_item_get_string_attr DEPRECATED
 850 gpgme_trust_item_get_ulong_attr DEPRECATED
 851 gpgme_get_key                   CHANGED: Removed force_update argument.
 852 gpgme_sub_key_t                 NEW
 853 gpgme_key_sig_t                 NEW
 854 gpgme_user_id_t                 NEW
 855 gpgme_key_t                     CHANGED: Now has user accessible data members.
 856 gpgme_key_get_string_attr       DEPRECATED
 857 gpgme_key_get_ulong_attr        DEPRECATED
 858 gpgme_key_sig_get_string_attr   DEPRECATED
 859 gpgme_key_sig_get_ulong_attr    DEPRECATED
 860 gpgme_key_get_as_xml            REMOVED
 861 gpgme_key_list_result_t         NEW
 862 gpgme_op_keylist_result         NEW
 863 gpgme_get_op_info               REMOVED
 864 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 865
 866 Noteworthy changes in version 0.4.0 (2002-12-23)
 867 ------------------------------------------------
 868
 869  * Key generation returns the fingerprint of the generated key.
 870
 871  * New convenience function gpgme_get_key.
 872
 873  * Supports signatures of user IDs in keys via the new
 874    GPGME_KEYLIST_MODE_SIGS keylist mode and the
 875    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
 876    interfaces.  The XML info about a key also includes the signatures
 877    if available.
 878
 879  * New data object interface, which is more flexible and transparent.
 880
 881  * Interface changes relative to the 0.3.9 release:
 882 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 883 GpgmeDataReadCb                 NEW
 884 GpgmeDataWriteCb                NEW
 885 GpgmeDataSeekCb                 NEW
 886 GpgmeDataReleaseCb              NEW
 887 GpgmeDataCbs                    NEW
 888 gpgme_data_read                 CHANGED: Match read() closely.
 889 gpgme_data_write                CHANGED: Match write() closely.
 890 gpgme_data_seek                 NEW
 891 gpgme_data_new_from_fd          NEW
 892 gpgme_data_new_from_stream      NEW
 893 gpgme_data_new_from_cbs         NEW
 894 gpgme_data_rewind               DEPRECATED: Replaced by gpgme_data_seek().
 895 gpgme_data_new_from_read_cb     DEPRECATED: Replaced by gpgme_data_from_cbs().
 896 gpgme_data_get_type             REMOVED: No replacement.
 897 gpgme_op_verify                 CHANGED: Take different data objects for
 898                                 signed text and plain text.
 899 gpgme_op_verify_start           CHANGED: See gpgme_op_verify.
 900 gpgme_check_engine              REMOVED: Deprecated since 0.3.0.
 901 gpgme_op_genkey                 CHANGED: New parameter FPR.
 902 GPGME_KEYLIST_MODE_SIGS         NEW
 903 gpgme_key_sig_get_string_attr   NEW
 904 gpgme_key_sig_get_ulong_attr    NEW
 905 gpgme_get_key                   NEW
 906 GPGME_ATTR_SIG_CLASS            NEW
 907 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 908
 909 Noteworthy changes in version 0.3.16 (2003-11-19)
 910 -------------------------------------------------
 911
 912  * Compatibility fixes for GnuPG 1.9.x
 913
 914 Noteworthy changes in version 0.3.15 (2003-02-18)
 915 -------------------------------------------------
 916
 917  * The progress status is sent via the progress callbacks in
 918    gpgme_op_edit.
 919
 920  * Bug fix for signing operations with explicit signer settings for
 921    the CMS protocol.
 922
 923 Noteworthy changes in version 0.3.14 (2002-12-04)
 924 -------------------------------------------------
 925
 926  * GPGME-Plug is now in its own package "cryptplug".
 927
 928  * Workaround for a setlocale problem.  Fixed a segv related to not
 929    correctly as closed marked file descriptors.
 930
 931 Noteworthy changes in version 0.3.13 (2002-11-20)
 932 -------------------------------------------------
 933
 934  * Release due to changes in gpgmeplug.
 935
 936 Noteworthy changes in version 0.3.12 (2002-10-15)
 937 -------------------------------------------------
 938
 939  * Fixed some bux with key listings.
 940
 941  * The development has been branched to clean up some API issues.
 942    This 0.3 series will be kept for compatibility reasons; so do don't
 943    expect new features.
 944
 945 Noteworthy changes in version 0.3.11 (2002-09-20)
 946 -------------------------------------------------
 947
 948  * Bug fixes.
 949
 950 Noteworthy changes in version 0.3.10 (2002-09-02)
 951 -------------------------------------------------
 952
 953  * Setting the signing keys for the CMS protocol does now work.
 954
 955  * The signers setting is honoured by gpgme_op_edit.
 956
 957 Noteworthy changes in version 0.3.9 (2002-08-21)
 958 ------------------------------------------------
 959
 960  * A spec file for creating RPMs has been added.
 961
 962  * An experimental interface to GnuPG's --edit-key functionality is
 963    introduced, see gpgme_op_edit.
 964
 965  * The new gpgme_import_ext function provides a convenient access to
 966    the number of processed keys.
 967
 968  * Interface changes relative to the 0.3.8 release:
 969 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 970 GpgmeStatusCode                 NEW
 971 GpgmeEditCb                     NEW
 972 gpgme_op_edit_start             NEW
 973 gpgme_op_edit                   NEW
 974 gpgme_op_import_ext             NEW
 975 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 976
 977 Noteworthy changes in version 0.3.8 (2002-06-25)
 978 ------------------------------------------------
 979
 980  * It is possible to use an outside event loop for the I/O to the
 981    crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
 982
 983  * Interface changes relative to the 0.3.6 release:
 984 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 985 GpgmeIOCb                       NEW
 986 GpgmeRegisterIOCb               NEW
 987 GpgmeRemoveIOCb                 NEW
 988 GpgmeEventIO                    NEW
 989 GpgmeEventIOCb                  NEW
 990 struct GpgmeIOCbs               NEW
 991 gpgme_set_io_cbs                NEW
 992 gpgme_get_io_cbs                NEW
 993 GPGME_ATTR_ERRTOK               NEW
 994 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 995
 996 Noteworthy changes in version 0.3.7 (2002-06-04)
 997 ------------------------------------------------
 998
 999  * GPGME_ATTR_OTRUST is implemented now.
1000
1001  * A first step toward thread safeness has been achieved, see the
1002    documentation for details.  Supported thread libraries are pthread
1003    and Pth.
1004
1005 Noteworthy changes in version 0.3.6 (2002-05-03)
1006 ------------------------------------------------
1007
1008  * All error output of the gpgsm backend is send to the bit bucket.
1009
1010  * The signature verification functions are extended.  Instead of
1011    always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
1012    expired signatures.  2 new functions may be used to retrieve more
1013    detailed information like the signature expiration time and a
1014    validity information of the key without an extra key looking.
1015
1016  * The current passphrase callback and progress meter callback can be
1017    retrieved with the new functions gpgme_get_passphrase_cb and
1018    gpgme_get_progress_cb respectively.
1019
1020  * Interface changes relative to the 0.3.5 release:
1021 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1022 gpgme_get_passphrase_cb         NEW
1023 gpgme_get_progress_cb           NEW
1024 GpgmeDataEncoding               NEW
1025 gpgme_data_set_encoding         NEW
1026 gpgme_data_get_encoding         NEW
1027 GPGME_SIG_STAT_GOOD_EXP         NEW
1028 GPGME_SIG_STAT_GOOD_EXPKEY      NEW
1029 gpgme_op_verify                 CHANGED: Returns more status codes.
1030 GPGME_ATTR_SIG_STATUS           NEW
1031 gpgme_get_sig_string_attr       NEW
1032 gpgme_get_sig_ulong_attr        NEW
1033 gpgme_get_protocol              NEW
1034 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1035
1036 Noteworthy changes in version 0.3.5 (2002-04-01)
1037 ------------------------------------------------
1038
1039  * gpgme_op_encrypt can be called with RECIPIENTS being 0.  In this
1040    case, symmetric encryption is performed.  Note that this requires a
1041    passphrase from the user.
1042
1043  * More information is returned for X.509 certificates.
1044
1045  * Interface changes relative to the 0.3.4 release:
1046 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1047 gpgme_op_encrypt                EXTENDED: Symmetric encryption possible
1048 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1049
1050 Noteworthy changes in version 0.3.4 (2002-03-04)
1051 ------------------------------------------------
1052
1053  * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
1054    some recipients have been invalid, whereas earlier versions
1055    succeeded in this case.  The plaintext is still encrypted for all valid
1056    recipients, so the application might take this error as a hint that
1057    the ciphertext is not usable for all requested recipients.
1058    Information about invalid recipients is available with gpgme_get_op_info.
1059
1060  * gpgme_op_verify now allows to pass an uninitialized data object as
1061    its plaintext argument to check for normal and cleartext
1062    signatures.  The plaintext is then returned in the data object.
1063
1064  * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
1065    to set and get the number of certifications to include in S/MIME
1066    signed messages.
1067
1068  * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
1069    to encrypt and sign a message in a combined operation.
1070
1071  * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
1072
1073  * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
1074
1075  * Interface changes relative to the 0.3.3 release:
1076 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1077 gpgme_op_encrypt                CHANGED: Can fail with GPGME_Invalid_Recipients
1078 gpgme_op_verify                 EXTENDED: Accepts uninitialized text argument
1079 gpgme_key_get_ulong_attr        EXTENDED: Supports GPGME_ATTR_EXPIRE
1080 gpgme_set_include_certs         NEW
1081 gpgme_get_include_certs         NEW
1082 gpgme_op_encrypt_sign           NEW
1083 gpgme_op_encrypt_sign_start     NEW
1084 gpgme_op_keylist_ext_start      NEW
1085 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1086
1087 Noteworthy changes in version 0.3.3 (2002-02-12)
1088 ------------------------------------------------
1089
1090  * Fix the Makefile in jnlib.
1091
1092  * Fix the test suite (hopefully).  It should clean up all its state
1093    with `make check' now.
1094
1095
1096 Noteworthy changes in version 0.3.2 (2002-02-10)
1097 ------------------------------------------------
1098
1099  * Remove erroneous dependency on libgcrypt in jnlib.
1100
1101
1102 Noteworthy changes in version 0.3.1 (2002-02-09)
1103 ------------------------------------------------
1104
1105  * There is a Texinfo manual documenting the API.
1106
1107  * The gpgme_set_keylist_mode function returns an error, and changed
1108    its meaning.  It is no longer usable to select between normal and
1109    fast mode (newer versions of GnuPG will always be fast), but
1110    selects between local keyring, remote keyserver, or both.
1111    For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
1112    and GPGME_KEYLIST_MODE_EXTERN.  To make it possible to modify the
1113    current setting, a fucntion gpgme_get_keylist_mode was added to
1114    retrieve the current mode.
1115
1116  * gpgme_wait accepts a new argument STATUS to return the error status
1117    of the operation on the context.  Its definition is closer to
1118    waitpid() now than before.
1119
1120  * The LENGTH argument to gpgme_data_new_from_filepart changed its
1121    type from off_t to the unsigned size_t.
1122
1123  * The R_HD argument to the GpgmePassphraseCb type changed its type
1124    from void* to void**.
1125
1126  * New interface gpgme_op_trustlist_end() to match
1127    gpgme_op_keylist_end().
1128
1129  * The CryptPlug modules have been renamed to gpgme-openpgp and
1130    gpgme-smime, and they are installed in pkglibdir by `make install'.
1131
1132  * An idle function can be registered with gpgme_register_idle().
1133
1134  * The GpgSM backend supports key generation with gpgme_op_genkey().
1135
1136  * Interface changes relative to the 0.3.0 release:
1137 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1138 gpgme_data_new_from_filepart    CHANGED: Type of LENGTH is size_t.
1139 GpgmePassphraseCb               CHANGED: Type of R_HD is void **.
1140 gpgme_wait                      CHANGED: New argument STATUS.
1141 gpgme_set_keylist_mode          CHANGED: Type of return value is GpgmeError.
1142                                 The function has a new meaning!
1143 gpgme_get_keylist_mode          NEW
1144 GPGME_KEYLIST_MODE_LOCAL        NEW
1145 GPGME_KEYLIST_MODE_EXTERN       NEW
1146 gpgme_op_trustlist_next         NEW
1147 GpgmeIdleFunc                   NEW
1148 gpgme_register_idle             NEW
1149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1150
1151 Noteworthy changes in version 0.3.0 (2001-12-19)
1152 ------------------------------------------------
1153
1154  * New interface gpgme_set_protocol() to set the protocol and thus the
1155    crypto engine to be used by the context.  Currently, the OpenPGP
1156    and the CMS protocols are supported.  They are specified by the new
1157    preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
1158    A new context uses the OpenPGP engine by default.
1159
1160  * gpgme_get_engine_info() returns information for all crypto engines
1161    compiled into the library.  The XML format has changed.  To
1162    reliably get the version of a crypto engine, the <version> tag
1163    after the appropriate <protocol> tag has to be looked for.
1164
1165  * New interface gpgme_engine_check_version(), obsoleting
1166    gpgme_check_engine().  Check the version of all engines you are
1167    supporting in your software.
1168
1169  * GpgmeKey lists the user ids in the order as they are returned by
1170    GnuPG, first the primary key with index 0, then the sub-user ids.
1171
1172  * New operation gpgme_op_decrypt_verify() to decrypt and verify
1173    signatures simultaneously.
1174
1175  * The new interface gpgme_op_keylist_end() terminates a pending
1176    keylist operation.  A keylist operation is also terminated when
1177    gpgme_op_keylist_next() returns GPGME_EOF.
1178
1179  * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
1180    cross-compiled, or even compiled without support for GnuPG
1181    (`--without-gpg').
1182
1183  * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
1184    `--with-gpgsm=PATH').  It is enabled by default if the `gpgsm' is found
1185    in the path, but it can also be compiled without support for GpgSM
1186    (`--without-gpgsm').
1187
1188  * CryptPlug modules for GPGME are included and can be enabled at
1189    configure time (`--enable-gpgmeplug').  There is one module which
1190    uses the GnuPG engine (`gpgmeplug') and one module which uses the
1191    GpgSM engine (`gpgsmplug').
1192
1193  * Interface changes relative to the latest 0.2.x release:
1194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1195 gpgme_key_get_as_xml            CHANGED: Sub-user ids reversed in order.
1196 gpgme_key_get_string_attr       CHANGED: User ids reversed in order.
1197 gpgme_key_get_ulong_attr        CHANGED: User ids reversed in order.
1198 gpgme_get_engine_info           CHANGED: New format, extended content.
1199 gpgme_engine_check_version      NEW
1200 gpgme_decrypt_verify_start      NEW
1201 gpgme_decrypt_verify            NEW
1202 gpgme_op_keylist_next           NEW
1203 gpgme_set_protocol              NEW
1204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1205
1206
1207 Noteworthy changes in version 0.2.3 (2001-09-17)
1208 ------------------------------------------------
1209
1210  * New function gpgme_get_op_info which can be used to get the micalg
1211    parameter needed for MOSS.
1212
1213  * New functions gpgme_get_armor and gpgme_get_textmode.
1214
1215  * The usual bug fixes and some minor functionality improvements.
1216
1217  * Added a simple encryption component for MS-Windows; however the
1218    build procedure might have some problems.
1219
1220
1221 Noteworthy changes in version 0.2.2 (2001-06-12)
1222 ------------------------------------------------
1223
1224  * Implemented a key cache.
1225
1226  * Fixed a race condition under W32 and some other bug fixes.
1227
1228
1229 Noteworthy changes in version 0.2.1 (2001-04-02)
1230 ------------------------------------------------
1231
1232  * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
1233
1234  * Handle GnuPG's new key capabilities output and support revocation
1235    et al. attributes
1236
1237  * Made the W32 support more robust.
1238
1239
1240  Copyright 2001, 2002, 2003, 2004, 2005, 2007, 2008 g10 Code GmbH
1241
1242  This file is free software; as a special exception the author gives
1243  unlimited permission to copy and/or distribute it, with or without
1244  modifications, as long as this notice is preserved.
1245
1246  This file is distributed in the hope that it will be useful, but
1247  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
1248  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.