NEWS

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