NEWS

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