NEWS

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