NEWS

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