NEWS

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