NEWS

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