NEWS

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