NEWS

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