NEWS

   1 Noteworthy changes in version 0.4.1 (unreleased)
   2 ------------------------------------------------
   3
   4  * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
   5
   6  * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
   7    summary anymore.  Use gpgme_get_sig_status to retrieve the individual stati.
   8
   9  * GpgmeIOCb changed from a void function to a function returning a
  10    GpgmeError value.  However, it will always return 0, so you can
  11    safely ignore the return value.
  12
  13  * A new I/O callback event GPGME_EVENT_START has been added.  The new
  14    requirement is that you must wait until this event until you are
  15    allowed to call the I/O callback handlers previously registered for
  16    this context operation.  Calling I/O callback functions for this
  17    context operation before the start event happened is unsafe because
  18    it can lead to race conditions in a multi-threaded environment.
  19
  20  * The idle function feature has been removed.  It was not precisely
  21    defined in a multi-threaded environment and is obsoleted by the
  22    user I/O callback functions.  If you still need a simple way to
  23    call something while waiting on one or multiple asynchronous
  24    operations to complete, don't set the HANG flag in gpgme_wait (note
  25    that this will return to your program more often than the idle
  26    function did).
  27
  28  * gpgme_wait can return NULL even if hang is true, if an error
  29    occurs.  In that case *status contains the error code.
  30
  31  * Interface changes relative to the 0.4.0 release:
  32 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 GpgmeIOCb                       CHANGED: Return type from void to GpgmeError.
  34 GpgmeEventIO                    CHANGED: New event type (all numbers changed).
  35 gpgme_key_get_string_attr       CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
  36 gpgme_op_verify                 CHANGED: Drop R_STAT argument.
  37 gpgme_op_decrypt_verify         CHANGED: Drop R_STAT argument.
  38 gpgme_wait                      CHANGED: Can return NULL even if hang is true.
  39 GpgmeIdleFunc                   REMOVED
  40 gpgme_register_idle             REMOVED
  41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42
  43 Noteworthy changes in version 0.4.0 (2002-12-23)
  44 ------------------------------------------------
  45
  46  * Key generation returns the fingerprint of the generated key.
  47
  48  * New convenience function gpgme_get_key.
  49
  50  * Supports signatures of user IDs in keys via the new
  51    GPGME_KEYLIST_MODE_SIGS keylist mode and the
  52    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
  53    interfaces.  The XML info about a key also includes the signatures
  54    if available.
  55
  56  * New data object interface, which is more flexible and transparent.
  57
  58  * Interface changes relative to the 0.3.9 release:
  59 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  60 GpgmeDataReadCb                 NEW
  61 GpgmeDataWriteCb                NEW
  62 GpgmeDataSeekCb                 NEW
  63 GpgmeDataReleaseCb              NEW
  64 GpgmeDataCbs                    NEW
  65 gpgme_data_read                 CHANGED: Match read() closely.
  66 gpgme_data_write                CHANGED: Match write() closely.
  67 gpgme_data_seek                 NEW
  68 gpgme_data_new_from_fd          NEW
  69 gpgme_data_new_from_stream      NEW
  70 gpgme_data_new_from_cbs         NEW
  71 gpgme_data_rewind               DEPRECATED: Replaced by gpgme_data_seek().
  72 gpgme_data_new_from_read_cb     DEPRECATED: Replaced by gpgme_data_from_cbs().
  73 gpgme_data_get_type             REMOVED: No replacement.
  74 gpgme_op_verify                 CHANGED: Take different data objects for
  75                                 signed text and plain text.
  76 gpgme_op_verify_start           CHANGED: See gpgme_op_verify.
  77 gpgme_check_engine              REMOVED: Deprecated since 0.3.0.
  78 gpgme_op_genkey                 CHANGED: New parameter FPR.
  79 GPGME_KEYLIST_MODE_SIGS         NEW
  80 gpgme_key_sig_get_string_attr   NEW
  81 gpgme_key_sig_get_ulong_attr    NEW
  82 gpgme_get_key                   NEW
  83 GPGME_ATTR_SIG_CLASS            NEW
  84 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  85
  86 Noteworthy changes in version 0.3.14 (2002-12-04)
  87 -------------------------------------------------
  88
  89  * GPGME-Plug is now in its own package "cryptplug".
  90
  91  * Workaround for a setlocale problem.  Fixed a segv related to not
  92    correctly as closed marked file descriptors.
  93
  94 Noteworthy changes in version 0.3.13 (2002-11-20)
  95 -------------------------------------------------
  96
  97  * Release due to changes in gpgmeplug.
  98
  99 Noteworthy changes in version 0.3.12 (2002-10-15)
 100 -------------------------------------------------
 101
 102  * Fixed some bux with key listings.
 103
 104  * The development has been branched to clean up some API issues.
 105    This 0.3 series will be kept for compatibility reasons; so do don't
 106    expect new features.
 107
 108 Noteworthy changes in version 0.3.11 (2002-09-20)
 109 -------------------------------------------------
 110
 111  * Bug fixes.
 112
 113 Noteworthy changes in version 0.3.10 (2002-09-02)
 114 -------------------------------------------------
 115
 116  * Setting the signing keys for the CMS protocol does now work.
 117
 118  * The signers setting is honoured by gpgme_op_edit.
 119
 120 Noteworthy changes in version 0.3.9 (2002-08-21)
 121 ------------------------------------------------
 122
 123  * A spec file for creating RPMs has been added.
 124
 125  * An experimental interface to GnuPG's --edit-key functionality is
 126    introduced, see gpgme_op_edit.
 127
 128  * The new gpgme_import_ext function provides a convenient access to
 129    the number of processed keys.
 130
 131  * Interface changes relative to the 0.3.8 release:
 132 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 GpgmeStatusCode                 NEW
 134 GpgmeEditCb                     NEW
 135 gpgme_op_edit_start             NEW
 136 gpgme_op_edit                   NEW
 137 gpgme_op_import_ext             NEW
 138 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 139
 140 Noteworthy changes in version 0.3.8 (2002-06-25)
 141 ------------------------------------------------
 142
 143  * It is possible to use an outside event loop for the I/O to the
 144    crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
 145
 146  * Interface changes relative to the 0.3.6 release:
 147 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 148 GpgmeIOCb                       NEW
 149 GpgmeRegisterIOCb               NEW
 150 GpgmeRemoveIOCb                 NEW
 151 GpgmeEventIO                    NEW
 152 GpgmeEventIOCb                  NEW
 153 struct GpgmeIOCbs               NEW
 154 gpgme_set_io_cbs                NEW
 155 gpgme_get_io_cbs                NEW
 156 GPGME_ATTR_ERRTOK               NEW
 157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 158
 159 Noteworthy changes in version 0.3.7 (2002-06-04)
 160 ------------------------------------------------
 161
 162  * GPGME_ATTR_OTRUST is implemented now.
 163
 164  * A first step toward thread safeness has been achieved, see the
 165    documentation for details.  Supported thread libraries are pthread
 166    and Pth.
 167
 168 Noteworthy changes in version 0.3.6 (2002-05-03)
 169 ------------------------------------------------
 170
 171  * All error output of the gpgsm backend is send to the bit bucket.
 172
 173  * The signature verification functions are extended.  Instead of
 174    always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
 175    expired signatures.  2 new functions may be used to retrieve more
 176    detailed information like the signature expiration time and a
 177    validity information of the key without an extra key looking.
 178
 179  * The current passphrase callback and progress meter callback can be
 180    retrieved with the new functions gpgme_get_passphrase_cb and
 181    gpgme_get_progress_cb respectively.
 182
 183  * Interface changes relative to the 0.3.5 release:
 184 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 185 gpgme_get_passphrase_cb         NEW
 186 gpgme_get_progress_cb           NEW
 187 GpgmeDataEncoding               NEW
 188 gpgme_data_set_encoding         NEW
 189 gpgme_data_get_encoding         NEW
 190 GPGME_SIG_STAT_GOOD_EXP         NEW
 191 GPGME_SIG_STAT_GOOD_EXPKEY      NEW
 192 gpgme_op_verify                 CHANGED: Returns more status codes.
 193 GPGME_ATTR_SIG_STATUS           NEW
 194 gpgme_get_sig_string_attr       NEW
 195 gpgme_get_sig_ulong_attr        NEW
 196 gpgme_get_protocol              NEW
 197 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 198
 199 Noteworthy changes in version 0.3.5 (2002-04-01)
 200 ------------------------------------------------
 201
 202  * gpgme_op_encrypt can be called with RECIPIENTS being 0.  In this
 203    case, symmetric encryption is performed.  Note that this requires a
 204    passphrase from the user.
 205
 206  * More information is returned for X.509 certificates.
 207
 208  * Interface changes relative to the 0.3.4 release:
 209 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 210 gpgme_op_encrypt                EXTENDED: Symmetric encryption possible
 211 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 212
 213 Noteworthy changes in version 0.3.4 (2002-03-04)
 214 ------------------------------------------------
 215
 216  * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
 217    some recipients have been invalid, whereas earlier versions
 218    succeeded in this case.  The plaintext is still encrypted for all valid
 219    recipients, so the application might take this error as a hint that
 220    the ciphertext is not usable for all requested recipients.
 221    Information about invalid recipients is available with gpgme_get_op_info.
 222
 223  * gpgme_op_verify now allows to pass an uninitialized data object as
 224    its plaintext argument to check for normal and cleartext
 225    signatures.  The plaintext is then returned in the data object.
 226
 227  * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
 228    to set and get the number of certifications to include in S/MIME
 229    signed messages.
 230
 231  * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
 232    to encrypt and sign a message in a combined operation.
 233
 234  * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
 235
 236  * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
 237
 238  * Interface changes relative to the 0.3.3 release:
 239 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 240 gpgme_op_encrypt                CHANGED: Can fail with GPGME_Invalid_Recipients
 241 gpgme_op_verify                 EXTENDED: Accepts uninitialized text argument
 242 gpgme_key_get_ulong_attr        EXTENDED: Supports GPGME_ATTR_EXPIRE
 243 gpgme_set_include_certs         NEW
 244 gpgme_get_include_certs         NEW
 245 gpgme_op_encrypt_sign           NEW
 246 gpgme_op_encrypt_sign_start     NEW
 247 gpgme_op_keylist_ext_start      NEW
 248 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 249
 250 Noteworthy changes in version 0.3.3 (2002-02-12)
 251 ------------------------------------------------
 252
 253  * Fix the Makefile in jnlib.
 254
 255  * Fix the test suite (hopefully).  It should clean up all its state
 256    with `make check' now.
 257
 258
 259 Noteworthy changes in version 0.3.2 (2002-02-10)
 260 ------------------------------------------------
 261
 262  * Remove erroneous dependency on libgcrypt in jnlib.
 263
 264
 265 Noteworthy changes in version 0.3.1 (2002-02-09)
 266 ------------------------------------------------
 267
 268  * There is a Texinfo manual documenting the API.
 269
 270  * The gpgme_set_keylist_mode function returns an error, and changed
 271    its meaning.  It is no longer usable to select between normal and
 272    fast mode (newer versions of GnuPG will always be fast), but
 273    selects between local keyring, remote keyserver, or both.
 274    For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
 275    and GPGME_KEYLIST_MODE_EXTERN.  To make it possible to modify the
 276    current setting, a fucntion gpgme_get_keylist_mode was added to
 277    retrieve the current mode.
 278
 279  * gpgme_wait accepts a new argument STATUS to return the error status
 280    of the operation on the context.  Its definition is closer to
 281    waitpid() now than before.
 282
 283  * The LENGTH argument to gpgme_data_new_from_filepart changed its
 284    type from off_t to the unsigned size_t.
 285
 286  * The R_HD argument to the GpgmePassphraseCb type changed its type
 287    from void* to void**.
 288
 289  * New interface gpgme_op_trustlist_end() to match
 290    gpgme_op_keylist_end().
 291
 292  * The CryptPlug modules have been renamed to gpgme-openpgp and
 293    gpgme-smime, and they are installed in pkglibdir by `make install'.
 294
 295  * An idle function can be registered with gpgme_register_idle().
 296
 297  * The GpgSM backend supports key generation with gpgme_op_genkey().
 298
 299  * Interface changes relative to the 0.3.0 release:
 300 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 301 gpgme_data_new_from_filepart    CHANGED: Type of LENGTH is size_t.
 302 GpgmePassphraseCb               CHANGED: Type of R_HD is void **.
 303 gpgme_wait                      CHANGED: New argument STATUS.
 304 gpgme_set_keylist_mode          CHANGED: Type of return value is GpgmeError.
 305                                 The function has a new meaning!
 306 gpgme_get_keylist_mode          NEW
 307 GPGME_KEYLIST_MODE_LOCAL        NEW
 308 GPGME_KEYLIST_MODE_EXTERN       NEW
 309 gpgme_op_trustlist_next         NEW
 310 GpgmeIdleFunc                   NEW
 311 gpgme_register_idle             NEW
 312 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 313
 314 Noteworthy changes in version 0.3.0 (2001-12-19)
 315 ------------------------------------------------
 316
 317  * New interface gpgme_set_protocol() to set the protocol and thus the
 318    crypto engine to be used by the context.  Currently, the OpenPGP
 319    and the CMS protocols are supported.  They are specified by the new
 320    preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
 321    A new context uses the OpenPGP engine by default.
 322
 323  * gpgme_get_engine_info() returns information for all crypto engines
 324    compiled into the library.  The XML format has changed.  To
 325    reliably get the version of a crypto engine, the <version> tag
 326    after the appropriate <protocol> tag has to be looked for.
 327
 328  * New interface gpgme_engine_check_version(), obsoleting
 329    gpgme_check_engine().  Check the version of all engines you are
 330    supporting in your software.
 331
 332  * GpgmeKey lists the user ids in the order as they are returned by
 333    GnuPG, first the primary key with index 0, then the sub-user ids.
 334
 335  * New operation gpgme_op_decrypt_verify() to decrypt and verify
 336    signatures simultaneously.
 337
 338  * The new interface gpgme_op_keylist_end() terminates a pending
 339    keylist operation.  A keylist operation is also terminated when
 340    gpgme_op_keylist_next() returns GPGME_EOF.
 341
 342  * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
 343    cross-compiled, or even compiled without support for GnuPG
 344    (`--without-gpg').
 345
 346  * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
 347    `--with-gpgsm=PATH').  It is enabled by default if the `gpgsm' is found
 348    in the path, but it can also be compiled without support for GpgSM
 349    (`--without-gpgsm').
 350
 351  * CryptPlug modules for GPGME are included and can be enabled at
 352    configure time (`--enable-gpgmeplug').  There is one module which
 353    uses the GnuPG engine (`gpgmeplug') and one module which uses the
 354    GpgSM engine (`gpgsmplug').
 355
 356  * Interface changes relative to the latest 0.2.x release:
 357 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 358 gpgme_key_get_as_xml            CHANGED: Sub-user ids reversed in order.
 359 gpgme_key_get_string_attr       CHANGED: User ids reversed in order.
 360 gpgme_key_get_ulong_attr        CHANGED: User ids reversed in order.
 361 gpgme_get_engine_info           CHANGED: New format, extended content.
 362 gpgme_engine_check_version      NEW
 363 gpgme_decrypt_verify_start      NEW
 364 gpgme_decrypt_verify            NEW
 365 gpgme_op_keylist_next           NEW
 366 gpgme_set_protocol              NEW
 367 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 368
 369
 370 Noteworthy changes in version 0.2.3 (2001-09-17)
 371 ------------------------------------------------
 372
 373  * New function gpgme_get_op_info which can be used to get the micalg
 374    parameter needed for MOSS.
 375
 376  * New functions gpgme_get_armor and gpgme_get_textmode.
 377
 378  * The usual bug fixes and some minor functionality improvements.
 379
 380  * Added a simple encryption component for MS-Windows; however the
 381    build procedure might have some problems.
 382
 383
 384 Noteworthy changes in version 0.2.2 (2001-06-12)
 385 ------------------------------------------------
 386
 387  * Implemented a key cache.
 388
 389  * Fixed a race condition under W32 and some other bug fixes.
 390
 391
 392 Noteworthy changes in version 0.2.1 (2001-04-02)
 393 ------------------------------------------------
 394
 395  * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
 396
 397  * Handle GnuPG's new key capabilities output and support revocation
 398    et al. attributes
 399
 400  * Made the W32 support more robust.
 401
 402
 403  Copyright 2001, 2002 g10 Code GmbH
 404
 405  This file is free software; as a special exception the author gives
 406  unlimited permission to copy and/or distribute it, with or without
 407  modifications, as long as this notice is preserved.
 408
 409  This file is distributed in the hope that it will be useful, but
 410  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
 411  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.