NEWS

   1 Noteworthy changes in version 0.4.1 (unreleased)
   2 ------------------------------------------------
   3
   4  This is the release that 0.4.0 should have been.  There are many
   5  interface changes, please see below for the details.  The changes are
   6  sometimes the result of new functionality, but more often express a
   7  paradigm shift.  Others are an overdue cleanup to get GPGME in line
   8  with the GNU coding standards and to make the interface more
   9  self-consistent.  Here is an overview on the changes:
  10
  11  All types have been renamed to conform to the GNU coding standards,
  12  most of the time by keeping the whole name in lowercase and insert
  13  underscores between words.
  14
  15  All operations consistently only accept input parameters in their
  16  invocation function, and return only an error code directly.  Further
  17  information about the result of the operation has to be retrieved
  18  afterwards by calling one of the result functions.  This unifies the
  19  synchronous and the asynchronous interface.
  20
  21  The results of all operations are now provided by pointers to C
  22  structs rather than by XML structs or in other ways.
  23
  24  Objects which used to be opaque (for example a key) are now pointers
  25  accessible structs, so no accessor functions are necessary.
  26
  27  Backward compatibility is provided where it was possible without too
  28  much effort and did not collide with the overall sanitization effort.
  29  However, it is recommended to update to the new interfaces soon, so
  30  the compatibility interfaces can be phased out quickly.
  31  Recommendations how to replace deprecated or removed functionality can
  32  be found within the description of each change.
  33
  34  What follows are all changes to the interface and behaviour of GPGME
  35  in detail.
  36
  37  * If gpgme.h is included in sources compiled by GCC 3.1 or later,
  38    deprecated attributes will warn about use of obsolete functions and
  39    typedefs.  The use of obsolete error values will appear as the use
  40    of an obsolete type _gpgme_deprecated_error_t.  You can suppress
  41    these warnings by passing -Wno-deprecated-declarations to the gcc
  42    command.
  43
  44  * The following types have been renamed.  The old types are still
  45    available as aliases, but they are deprecated now:
  46    Old name:            New name:
  47    GpgmeCtx             gpgme_ctx_t
  48    GpgmeData            gpgme_data_t
  49    GpgmeRecipients      gpgme_recipients_t
  50    GpgmeError           gpgme_error_t
  51    GpgmeDataEncoding    gpgme_data_encoding_t
  52    GpgmeSigStat         gpgme_sig_stat_t
  53    GpgmeSigMode         gpgme_sig_mode_t
  54    GpgmeAttr            gpgme_attr_t
  55    GpgmeValidity        gpgme_validity_t
  56    GpgmeProtocol        gpgme_protocol_t
  57    GpgmeKey             gpgme_key_t
  58    GpgmePassphraseCb    gpgme_passphrase_cb_t
  59    GpgmeProgressCb      gpgme_progress_cb_t
  60    GpgmeIOCb            gpgme_io_cb_t
  61    GpgmeRegisterIOCb    gpgme_register_io_cb_t
  62    GpgmeRemoveIOCb      gpgme_remove_io_cb_t
  63    GpgmeEventIO         gpgme_event_io_t
  64    GpgmeEventIOCb       gpgme_event_io_cb_t
  65    GpgmeIOCbs           gpgme_io_cbs
  66    GpgmeDataReadCb      gpgme_data_read_cb_t
  67    GpgmeDataWriteCb     gpgme_data_write_cb_t
  68    GpgmeDataSeekCb      gpgme_data_seek_cb_t
  69    GpgmeDataReleaseCb   gpgme_data_release_cb_t
  70    GpgmeDataCbs         gpgme_data_cbs_t
  71    GpgmeTrustItem       gpgme_trust_item_t
  72    GpgmeStatusCode      gpgme_status_code_t
  73
  74  * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
  75
  76  * GnuPG 1.2.2 is required.  The progress callback is now also invoked
  77    for encrypt, sign, encrypt-sign, decrypt, verify, and
  78    decrypt-verify operations.  For verify operations on detached
  79    signatures, the progress callback is invoked for both the detached
  80    signature and the plaintext message, though.
  81
  82  * gpgme_passphrase_cb_t has been changed to not provide a complete
  83    description, but the UID hint, passphrase info and a flag
  84    indicating if this is a repeated attempt individually, so the user
  85    can compose his own description from this information.
  86
  87    The passphrase is not returned as a C string, but must be written
  88    to a file descriptor directly.  This allows for secure passphrase
  89    entries.
  90
  91    The return type has been changed to gpgme_error_t value.  This
  92    allowed to remove the gpgme_cancel function; just return
  93    GPGME_Canceled in the passphrase callback directly.
  94
  95  * gpgme_edit_cb_t has been changed to take a file descriptor argument.
  96    The user is expected to write the response to the file descriptor,
  97    followed by a newline.
  98
  99  * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
 100    summary anymore.  Use gpgme_get_sig_status to retrieve the individual
 101    stati.
 102
 103  * gpgme_io_cb_t changed from a void function to a function returning
 104    a gpgme_error_t value.  However, it will always return 0, so you
 105    can safely ignore the return value.
 106
 107  * A new I/O callback event GPGME_EVENT_START has been added.  The new
 108    requirement is that you must wait until this event until you are
 109    allowed to call the I/O callback handlers previously registered for
 110    this context operation.  Calling I/O callback functions for this
 111    context operation before the start event happened is unsafe because
 112    it can lead to race conditions in a multi-threaded environment.
 113
 114  * The idle function feature has been removed.  It was not precisely
 115    defined in a multi-threaded environment and is obsoleted by the
 116    user I/O callback functions.  If you still need a simple way to
 117    call something while waiting on one or multiple asynchronous
 118    operations to complete, don't set the HANG flag in gpgme_wait (note
 119    that this will return to your program more often than the idle
 120    function did).
 121
 122  * gpgme_wait can return NULL even if hang is true, if an error
 123    occurs.  In that case *status contains the error code.
 124
 125  * gpgme_get_engine_info was radically changed.  Instead an XML
 126    string, an info structure of the new type gpgme_engine_info_t is
 127    returned.  This makes it easier and more robust to evaluate the
 128    information in an application.
 129
 130  * The new function gpgme_get_protocol_name can be used to convert a
 131    gpgme_protocol_t value into a string.
 132
 133  * The status of a context operation is not checked anymore, so the
 134    errors GPGME_Busy and GPGME_No_Request can not occur anymore.
 135
 136  * For clarity and better reusability, the error codes
 137    GPGME_No_Recipients, GPGME_Invalid_Recipient and
 138    GPGME_No_Passphrase have been renamed to GPGME_No_UserID,
 139    GPGME_Invalid_UserID and GPGME_Bad_Passphrase resp.
 140
 141  * The FPR argument to gpgme_op_genkey was removed.  Instead, use the
 142    gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
 143    pointer to a structure which contains the fingerprint.  This also
 144    works with gpgme_op_genkey_start.  The structure also provides
 145    other information about the generated keys.
 146
 147    So, instead:
 148
 149    char *fpr;
 150    err = gpgme_op_genkey (ctx, NULL, NULL, &fpr);
 151    if (!err && fpr)
 152      printf ("%s\n", fpr);
 153
 154    you should now do:
 155
 156    gpgme_genkey_result_t result;
 157    err = gpgme_op_genkey (ctx, NULL, NULL);
 158    if (!err)
 159      {
 160        result = gpgme_op_genkey_result (ctx);
 161        if (result->fpr)
 162          printf ("%s\n", result->fpr);
 163      }
 164
 165  * The new gpgme_op_import_result function provides detailed
 166    information about the result of an import operation in
 167    gpgme_import_result_t and gpgme_import_status_t objects.
 168    Thus, the gpgme_op_import_ext variant is deprecated.
 169
 170  * The new gpgme_op_sign_result function provides detailed information
 171    about the result of a signing operation in gpgme_sign_result_t,
 172    gpgme_invalid_user_id_t and gpgme_new_signature_t objects.
 173
 174  * The new gpgme_op_encrypt_result function provides detailed
 175    information about the result of an encryption operation in
 176    a GpgmeEncryptResult object.
 177
 178  * The new gpgme_op_decrypt_result function provides detailed
 179    information about the result of a decryption operation in
 180    a GpgmeDecryptResult object.
 181
 182  * The new gpgme_op_verify_result function provides detailed
 183    information about the result of an verify operation in
 184    a GpgmeVerifyResult object.  Because of this, the GPGME_SIG_STAT_*
 185    values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
 186    gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
 187    and gpgme_get_notation is removed.
 188
 189  * GpgmeTrustItem objects have now directly accessible data, so the
 190    gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
 191    accessor functions are deprecated.  Also, reference counting is
 192    available through gpgme_trust_item_ref and gpgme_trust_item_unref
 193    (the gpgme_trust_item_release alias for the latter is deprecated).
 194
 195  * Keys are not cached internally anymore, so the force_update argument
 196    to gpgme_get_key has been removed.
 197
 198  * GpgmeKey objects have now directly accessible data so the
 199    gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
 200    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
 201    functions are deprecated.  Also, gpgme_key_release is now
 202    deprecated.  The gpgme_key_get_as_xml function has been dropped.
 203
 204  * Because all interfaces using attributes are deprecated, the
 205    GpgmeAttr data type is also deprecated.
 206
 207  * The new gpgme_op_keylist_result function provides detailed
 208    information about the result of a key listing operation in
 209    a GpgmeKeyListResult object.
 210
 211  * Now that each function comes with its own result retrieval
 212    interface, the generic gpgme_get_op_info interface is not useful
 213    anymore and dropped.
 214
 215  * The error values GPGME_Invalid_Type and GPGME_Invalid_Mode can not
 216    occur anymore and are thus deprecated.
 217
 218  * Interface changes relative to the 0.4.0 release:
 219 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 220 GpgmeCtx                        DEPRECATED: Use gpgme_ctx_t.
 221 GpgmeData                       DEPRECATED: Use gpgme_data_t.
 222 GpgmeRecipients                 DEPRECATED: Use gpgme_recipients_t.
 223 GpgmeError                      DEPRECATED: Use gpgme_error_t.
 224 GpgmeDataEncoding               DEPRECATED: Use gpgme_data_encoding_t.
 225 GpgmeSigStat                    DEPRECATED: Use gpgme_sig_stat_t.
 226 GpgmeSigMode                    DEPRECATED: Use gpgme_sig_mode_t.
 227 GpgmeAttr                       DEPRECATED: Use gpgme_attr_t.
 228 GpgmeValidity                   DEPRECATED: Use gpgme_validity_t.
 229 GpgmeProtocol                   DEPRECATED: Use gpgme_protocol_t.
 230 GpgmeKey                        DEPRECATED: Use gpgme_key_t.
 231 GpgmePassphraseCb               DEPRECATED: Use gpgme_passphrase_cb_t.
 232 GpgmeProgressCb                 DEPRECATED: Use gpgme_progress_cb_t.
 233 GpgmeIOCb                       DEPRECATED: Use gpgme_io_cb_t.
 234 GpgmeRegisterIOCb               DEPRECATED: Use gpgme_register_io_cb_t.
 235 GpgmeRemoveIOCb                 DEPRECATED: Use gpgme_remove_io_cb_t.
 236 GpgmeEventIO                    DEPRECATED: Use gpgme_event_io_t.
 237 GpgmeEventIOCb                  DEPRECATED: Use gpgme_event_io_cb_t.
 238 GpgmeIOCbs                      DEPRECATED: Use gpgme_io_cbs.
 239 GpgmeDataReadCb                 DEPRECATED: Use gpgme_data_read_cb_t.
 240 GpgmeDataWriteCb                DEPRECATED: Use gpgme_data_write_cb_t.
 241 GpgmeDataSeekCb                 DEPRECATED: Use gpgme_data_seek_cb_t.
 242 GpgmeDataReleaseCb              DEPRECATED: Use gpgme_data_release_cb_t.
 243 GpgmeDataCbs                    DEPRECATED: Use gpgme_data_cbs_t.
 244 GpgmeTrustItem                  DEPRECATED: Use gpgme_trust_item_t.
 245 GpgmeStatusCode                 DEPRECATED: Use gpgme_status_code_t.
 246 gpgme_ctx_t                     NEW
 247 gpgme_data_t                    NEW
 248 gpgme_recipients_t              NEW
 249 gpgme_error_t                   NEW
 250 gpgme_data_encoding_t           NEW
 251 gpgme_sig_stat_t                NEW
 252 gpgme_sig_mode_t                NEW
 253 gpgme_attr_t                    NEW
 254 gpgme_validity_t                NEW
 255 gpgme_protocol_t                NEW
 256 gpgme_key_t                     NEW
 257 gpgme_passphrase_cb_t           NEW
 258 gpgme_progress_cb_t             NEW
 259 gpgme_io_cb_t                   NEW
 260 gpgme_register_io_cb_t          NEW
 261 gpgme_remove_io_cb_t            NEW
 262 gpgme_event_io_t                NEW
 263 gpgme_event_io_cb_t             NEW
 264 gpgme_io_cbs                    NEW
 265 gpgme_data_read_cb_t            NEW
 266 gpgme_data_write_cb_t           NEW
 267 gpgme_data_seek_cb_t            NEW
 268 gpgme_data_release_cb_t         NEW
 269 gpgme_data_cbs_t                NEW
 270 gpgme_trust_item_t              NEW
 271 gpgme_status_code_t             NEW
 272 gpgme_io_cb_t                   CHANGED: Return type from void to GpgmeError.
 273 gpgme_event_io_t                CHANGED: New event type (all numbers changed).
 274 gpgme_passphrase_cb_t           CHANGED: Desc decomposed, write directly to FD.
 275 gpgme_edit_cb_t                 CHANGED: Write directly to FD.
 276 gpgme_key_get_string_attr       CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
 277 gpgme_op_verify                 CHANGED: Drop R_STAT argument.
 278 gpgme_op_decrypt_verify         CHANGED: Drop R_STAT argument.
 279 gpgme_wait                      CHANGED: Can return NULL even if hang is true.
 280 GpgmeIdleFunc                   REMOVED
 281 gpgme_register_idle             REMOVED
 282 gpgme_engine_info_t             NEW
 283 gpgme_get_engine_info           CHANGED: Return info structure instead XML.
 284 gpgme_get_protocol_name         NEW
 285 gpgme_cancel                    REMOVED: Return error in callback directly.
 286 GPGME_Busy                      DEPRECATED: Not in use.
 287 GPGME_No_Request                DEPRECATED: Not in use.
 288 GPGME_No_Recipients             DEPRECATED: Use GPGME_No_UserID.
 289 GPGME_No_UserID                 NEW
 290 GPGME_Invalid_Recipient         DEPRECATED: Use GPGME_Invalid_UserID.
 291 GPGME_Invalid_UserID            NEW
 292 GPGME_No_Passphrase             DEPRECATED: Use GPGME_Bad_Passphrase.
 293 GPGME_Bad_Passphrase            NEW
 294 gpgme_op_genkey                 CHANGED: FPR argument dropped.
 295 gpgme_op_genkey_result          NEW
 296 gpgme_genkey_result_t           NEW
 297 gpgme_op_import_ext             DEPRECATED: Use gpgme_op_import_result.
 298 gpgme_op_import_result          NEW
 299 gpgme_import_status_t           NEW
 300 gpgme_import_result_t           NEW
 301 gpgme_pubkey_algo_t             NEW
 302 gpgme_hash_algo_t               NEW
 303 gpgme_invalid_user_id_t         NEW
 304 gpgme_new_signature_t           NEW
 305 gpgme_sign_result_t             NEW
 306 gpgme_op_sign_result            NEW
 307 gpgme_pubkey_algo_name          NEW
 308 gpgme_hash_algo_name            NEW
 309 gpgme_encrypt_result_t          NEW
 310 gpgme_op_encrypt_result         NEW
 311 gpgme_decrypt_result_t          NEW
 312 gpgme_op_decrypt_result         NEW
 313 gpgme_verify_result_t           NEW
 314 gpgme_op_verify_result          NEW
 315 gpgme_get_notation              REMOVED: Access verify result directly instead.
 316 gpgme_get_sig_key               DEPRECATED: Use gpgme_get_key with fingerprint.
 317 gpgme_get_sig_ulong_attr        DEPRECATED: Use verify result directly.
 318 gpgme_get_sig_string_attr       DEPRECATED: Use verify result directly.
 319 GPGME_SIG_STAT_*                DEPRECATED: Use error value in sig status.
 320 gpgme_get_sig_status            DEPRECATED: Use verify result directly.
 321 gpgme_trust_item_t              CHANGED: Now has user accessible data members.
 322 gpgme_trust_item_ref            NEW
 323 gpgme_trust_item_unref          NEW
 324 gpgme_trust_item_release        DEPRECATED: Use gpgme_trust_item_unref.
 325 gpgme_trust_item_get_string_attr DEPRECATED
 326 gpgme_trust_item_get_ulong_attr DEPRECATED
 327 gpgme_get_key                   CHANGED: Removed force_update argument.
 328 gpgme_sub_key_t                 NEW
 329 gpgme_key_sig_t                 NEW
 330 gpgme_user_id_t                 NEW
 331 gpgme_key_t                     CHANGED: Now has user accessible data members.
 332 gpgme_key_get_string_attr       DEPRECATED
 333 gpgme_key_get_ulong_attr        DEPRECATED
 334 gpgme_key_sig_get_string_attr   DEPRECATED
 335 gpgme_key_sig_get_ulong_attr    DEPRECATED
 336 gpgme_key_get_as_xml            REMOVED
 337 gpgme_key_list_result_t         NEW
 338 gpgme_op_keylist_result         NEW
 339 gpgme_get_op_info               REMOVED
 340 GPGME_Invalid_Type              DEPRECATED
 341 GPGME_Invalid_Mode              DEPRECATED
 342 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 343
 344 Noteworthy changes in version 0.4.0 (2002-12-23)
 345 ------------------------------------------------
 346
 347  * Key generation returns the fingerprint of the generated key.
 348
 349  * New convenience function gpgme_get_key.
 350
 351  * Supports signatures of user IDs in keys via the new
 352    GPGME_KEYLIST_MODE_SIGS keylist mode and the
 353    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
 354    interfaces.  The XML info about a key also includes the signatures
 355    if available.
 356
 357  * New data object interface, which is more flexible and transparent.
 358
 359  * Interface changes relative to the 0.3.9 release:
 360 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 361 GpgmeDataReadCb                 NEW
 362 GpgmeDataWriteCb                NEW
 363 GpgmeDataSeekCb                 NEW
 364 GpgmeDataReleaseCb              NEW
 365 GpgmeDataCbs                    NEW
 366 gpgme_data_read                 CHANGED: Match read() closely.
 367 gpgme_data_write                CHANGED: Match write() closely.
 368 gpgme_data_seek                 NEW
 369 gpgme_data_new_from_fd          NEW
 370 gpgme_data_new_from_stream      NEW
 371 gpgme_data_new_from_cbs         NEW
 372 gpgme_data_rewind               DEPRECATED: Replaced by gpgme_data_seek().
 373 gpgme_data_new_from_read_cb     DEPRECATED: Replaced by gpgme_data_from_cbs().
 374 gpgme_data_get_type             REMOVED: No replacement.
 375 gpgme_op_verify                 CHANGED: Take different data objects for
 376                                 signed text and plain text.
 377 gpgme_op_verify_start           CHANGED: See gpgme_op_verify.
 378 gpgme_check_engine              REMOVED: Deprecated since 0.3.0.
 379 gpgme_op_genkey                 CHANGED: New parameter FPR.
 380 GPGME_KEYLIST_MODE_SIGS         NEW
 381 gpgme_key_sig_get_string_attr   NEW
 382 gpgme_key_sig_get_ulong_attr    NEW
 383 gpgme_get_key                   NEW
 384 GPGME_ATTR_SIG_CLASS            NEW
 385 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 386
 387 Noteworthy changes in version 0.3.15 (2003-02-18)
 388 -------------------------------------------------
 389
 390  * The progress status is sent via the progress callbacks in
 391    gpgme_op_edit.
 392
 393  * Bug fix for signing operations with explicit signer settings for
 394    the CMS protocol.
 395
 396 Noteworthy changes in version 0.3.14 (2002-12-04)
 397 -------------------------------------------------
 398
 399  * GPGME-Plug is now in its own package "cryptplug".
 400
 401  * Workaround for a setlocale problem.  Fixed a segv related to not
 402    correctly as closed marked file descriptors.
 403
 404 Noteworthy changes in version 0.3.13 (2002-11-20)
 405 -------------------------------------------------
 406
 407  * Release due to changes in gpgmeplug.
 408
 409 Noteworthy changes in version 0.3.12 (2002-10-15)
 410 -------------------------------------------------
 411
 412  * Fixed some bux with key listings.
 413
 414  * The development has been branched to clean up some API issues.
 415    This 0.3 series will be kept for compatibility reasons; so do don't
 416    expect new features.
 417
 418 Noteworthy changes in version 0.3.11 (2002-09-20)
 419 -------------------------------------------------
 420
 421  * Bug fixes.
 422
 423 Noteworthy changes in version 0.3.10 (2002-09-02)
 424 -------------------------------------------------
 425
 426  * Setting the signing keys for the CMS protocol does now work.
 427
 428  * The signers setting is honoured by gpgme_op_edit.
 429
 430 Noteworthy changes in version 0.3.9 (2002-08-21)
 431 ------------------------------------------------
 432
 433  * A spec file for creating RPMs has been added.
 434
 435  * An experimental interface to GnuPG's --edit-key functionality is
 436    introduced, see gpgme_op_edit.
 437
 438  * The new gpgme_import_ext function provides a convenient access to
 439    the number of processed keys.
 440
 441  * Interface changes relative to the 0.3.8 release:
 442 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 443 GpgmeStatusCode                 NEW
 444 GpgmeEditCb                     NEW
 445 gpgme_op_edit_start             NEW
 446 gpgme_op_edit                   NEW
 447 gpgme_op_import_ext             NEW
 448 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 449
 450 Noteworthy changes in version 0.3.8 (2002-06-25)
 451 ------------------------------------------------
 452
 453  * It is possible to use an outside event loop for the I/O to the
 454    crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
 455
 456  * Interface changes relative to the 0.3.6 release:
 457 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 458 GpgmeIOCb                       NEW
 459 GpgmeRegisterIOCb               NEW
 460 GpgmeRemoveIOCb                 NEW
 461 GpgmeEventIO                    NEW
 462 GpgmeEventIOCb                  NEW
 463 struct GpgmeIOCbs               NEW
 464 gpgme_set_io_cbs                NEW
 465 gpgme_get_io_cbs                NEW
 466 GPGME_ATTR_ERRTOK               NEW
 467 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 468
 469 Noteworthy changes in version 0.3.7 (2002-06-04)
 470 ------------------------------------------------
 471
 472  * GPGME_ATTR_OTRUST is implemented now.
 473
 474  * A first step toward thread safeness has been achieved, see the
 475    documentation for details.  Supported thread libraries are pthread
 476    and Pth.
 477
 478 Noteworthy changes in version 0.3.6 (2002-05-03)
 479 ------------------------------------------------
 480
 481  * All error output of the gpgsm backend is send to the bit bucket.
 482
 483  * The signature verification functions are extended.  Instead of
 484    always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
 485    expired signatures.  2 new functions may be used to retrieve more
 486    detailed information like the signature expiration time and a
 487    validity information of the key without an extra key looking.
 488
 489  * The current passphrase callback and progress meter callback can be
 490    retrieved with the new functions gpgme_get_passphrase_cb and
 491    gpgme_get_progress_cb respectively.
 492
 493  * Interface changes relative to the 0.3.5 release:
 494 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 495 gpgme_get_passphrase_cb         NEW
 496 gpgme_get_progress_cb           NEW
 497 GpgmeDataEncoding               NEW
 498 gpgme_data_set_encoding         NEW
 499 gpgme_data_get_encoding         NEW
 500 GPGME_SIG_STAT_GOOD_EXP         NEW
 501 GPGME_SIG_STAT_GOOD_EXPKEY      NEW
 502 gpgme_op_verify                 CHANGED: Returns more status codes.
 503 GPGME_ATTR_SIG_STATUS           NEW
 504 gpgme_get_sig_string_attr       NEW
 505 gpgme_get_sig_ulong_attr        NEW
 506 gpgme_get_protocol              NEW
 507 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 508
 509 Noteworthy changes in version 0.3.5 (2002-04-01)
 510 ------------------------------------------------
 511
 512  * gpgme_op_encrypt can be called with RECIPIENTS being 0.  In this
 513    case, symmetric encryption is performed.  Note that this requires a
 514    passphrase from the user.
 515
 516  * More information is returned for X.509 certificates.
 517
 518  * Interface changes relative to the 0.3.4 release:
 519 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 520 gpgme_op_encrypt                EXTENDED: Symmetric encryption possible
 521 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 522
 523 Noteworthy changes in version 0.3.4 (2002-03-04)
 524 ------------------------------------------------
 525
 526  * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
 527    some recipients have been invalid, whereas earlier versions
 528    succeeded in this case.  The plaintext is still encrypted for all valid
 529    recipients, so the application might take this error as a hint that
 530    the ciphertext is not usable for all requested recipients.
 531    Information about invalid recipients is available with gpgme_get_op_info.
 532
 533  * gpgme_op_verify now allows to pass an uninitialized data object as
 534    its plaintext argument to check for normal and cleartext
 535    signatures.  The plaintext is then returned in the data object.
 536
 537  * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
 538    to set and get the number of certifications to include in S/MIME
 539    signed messages.
 540
 541  * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
 542    to encrypt and sign a message in a combined operation.
 543
 544  * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
 545
 546  * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
 547
 548  * Interface changes relative to the 0.3.3 release:
 549 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 550 gpgme_op_encrypt                CHANGED: Can fail with GPGME_Invalid_Recipients
 551 gpgme_op_verify                 EXTENDED: Accepts uninitialized text argument
 552 gpgme_key_get_ulong_attr        EXTENDED: Supports GPGME_ATTR_EXPIRE
 553 gpgme_set_include_certs         NEW
 554 gpgme_get_include_certs         NEW
 555 gpgme_op_encrypt_sign           NEW
 556 gpgme_op_encrypt_sign_start     NEW
 557 gpgme_op_keylist_ext_start      NEW
 558 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 559
 560 Noteworthy changes in version 0.3.3 (2002-02-12)
 561 ------------------------------------------------
 562
 563  * Fix the Makefile in jnlib.
 564
 565  * Fix the test suite (hopefully).  It should clean up all its state
 566    with `make check' now.
 567
 568
 569 Noteworthy changes in version 0.3.2 (2002-02-10)
 570 ------------------------------------------------
 571
 572  * Remove erroneous dependency on libgcrypt in jnlib.
 573
 574
 575 Noteworthy changes in version 0.3.1 (2002-02-09)
 576 ------------------------------------------------
 577
 578  * There is a Texinfo manual documenting the API.
 579
 580  * The gpgme_set_keylist_mode function returns an error, and changed
 581    its meaning.  It is no longer usable to select between normal and
 582    fast mode (newer versions of GnuPG will always be fast), but
 583    selects between local keyring, remote keyserver, or both.
 584    For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
 585    and GPGME_KEYLIST_MODE_EXTERN.  To make it possible to modify the
 586    current setting, a fucntion gpgme_get_keylist_mode was added to
 587    retrieve the current mode.
 588
 589  * gpgme_wait accepts a new argument STATUS to return the error status
 590    of the operation on the context.  Its definition is closer to
 591    waitpid() now than before.
 592
 593  * The LENGTH argument to gpgme_data_new_from_filepart changed its
 594    type from off_t to the unsigned size_t.
 595
 596  * The R_HD argument to the GpgmePassphraseCb type changed its type
 597    from void* to void**.
 598
 599  * New interface gpgme_op_trustlist_end() to match
 600    gpgme_op_keylist_end().
 601
 602  * The CryptPlug modules have been renamed to gpgme-openpgp and
 603    gpgme-smime, and they are installed in pkglibdir by `make install'.
 604
 605  * An idle function can be registered with gpgme_register_idle().
 606
 607  * The GpgSM backend supports key generation with gpgme_op_genkey().
 608
 609  * Interface changes relative to the 0.3.0 release:
 610 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 611 gpgme_data_new_from_filepart    CHANGED: Type of LENGTH is size_t.
 612 GpgmePassphraseCb               CHANGED: Type of R_HD is void **.
 613 gpgme_wait                      CHANGED: New argument STATUS.
 614 gpgme_set_keylist_mode          CHANGED: Type of return value is GpgmeError.
 615                                 The function has a new meaning!
 616 gpgme_get_keylist_mode          NEW
 617 GPGME_KEYLIST_MODE_LOCAL        NEW
 618 GPGME_KEYLIST_MODE_EXTERN       NEW
 619 gpgme_op_trustlist_next         NEW
 620 GpgmeIdleFunc                   NEW
 621 gpgme_register_idle             NEW
 622 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 623
 624 Noteworthy changes in version 0.3.0 (2001-12-19)
 625 ------------------------------------------------
 626
 627  * New interface gpgme_set_protocol() to set the protocol and thus the
 628    crypto engine to be used by the context.  Currently, the OpenPGP
 629    and the CMS protocols are supported.  They are specified by the new
 630    preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
 631    A new context uses the OpenPGP engine by default.
 632
 633  * gpgme_get_engine_info() returns information for all crypto engines
 634    compiled into the library.  The XML format has changed.  To
 635    reliably get the version of a crypto engine, the <version> tag
 636    after the appropriate <protocol> tag has to be looked for.
 637
 638  * New interface gpgme_engine_check_version(), obsoleting
 639    gpgme_check_engine().  Check the version of all engines you are
 640    supporting in your software.
 641
 642  * GpgmeKey lists the user ids in the order as they are returned by
 643    GnuPG, first the primary key with index 0, then the sub-user ids.
 644
 645  * New operation gpgme_op_decrypt_verify() to decrypt and verify
 646    signatures simultaneously.
 647
 648  * The new interface gpgme_op_keylist_end() terminates a pending
 649    keylist operation.  A keylist operation is also terminated when
 650    gpgme_op_keylist_next() returns GPGME_EOF.
 651
 652  * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
 653    cross-compiled, or even compiled without support for GnuPG
 654    (`--without-gpg').
 655
 656  * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
 657    `--with-gpgsm=PATH').  It is enabled by default if the `gpgsm' is found
 658    in the path, but it can also be compiled without support for GpgSM
 659    (`--without-gpgsm').
 660
 661  * CryptPlug modules for GPGME are included and can be enabled at
 662    configure time (`--enable-gpgmeplug').  There is one module which
 663    uses the GnuPG engine (`gpgmeplug') and one module which uses the
 664    GpgSM engine (`gpgsmplug').
 665
 666  * Interface changes relative to the latest 0.2.x release:
 667 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 668 gpgme_key_get_as_xml            CHANGED: Sub-user ids reversed in order.
 669 gpgme_key_get_string_attr       CHANGED: User ids reversed in order.
 670 gpgme_key_get_ulong_attr        CHANGED: User ids reversed in order.
 671 gpgme_get_engine_info           CHANGED: New format, extended content.
 672 gpgme_engine_check_version      NEW
 673 gpgme_decrypt_verify_start      NEW
 674 gpgme_decrypt_verify            NEW
 675 gpgme_op_keylist_next           NEW
 676 gpgme_set_protocol              NEW
 677 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 678
 679
 680 Noteworthy changes in version 0.2.3 (2001-09-17)
 681 ------------------------------------------------
 682
 683  * New function gpgme_get_op_info which can be used to get the micalg
 684    parameter needed for MOSS.
 685
 686  * New functions gpgme_get_armor and gpgme_get_textmode.
 687
 688  * The usual bug fixes and some minor functionality improvements.
 689
 690  * Added a simple encryption component for MS-Windows; however the
 691    build procedure might have some problems.
 692
 693
 694 Noteworthy changes in version 0.2.2 (2001-06-12)
 695 ------------------------------------------------
 696
 697  * Implemented a key cache.
 698
 699  * Fixed a race condition under W32 and some other bug fixes.
 700
 701
 702 Noteworthy changes in version 0.2.1 (2001-04-02)
 703 ------------------------------------------------
 704
 705  * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
 706
 707  * Handle GnuPG's new key capabilities output and support revocation
 708    et al. attributes
 709
 710  * Made the W32 support more robust.
 711
 712
 713  Copyright 2001, 2002 g10 Code GmbH
 714
 715  This file is free software; as a special exception the author gives
 716  unlimited permission to copy and/or distribute it, with or without
 717  modifications, as long as this notice is preserved.
 718
 719  This file is distributed in the hope that it will be useful, but
 720  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
 721  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.