NEWS

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