doc/
[gpgme.git] / NEWS
1 Noteworthy changes in version 1.1.9
2 ------------------------------------------------
3
4  * New encryption flag GPGME_ENCRYPT_NO_ENCRYPT_TO to disable default
5    recipients.
6
7  * gpgme_new will fail if gpgme_check_version was not called, or a
8    selftest failed (for example, if -mms-bitfields was not used on
9    MingW32 targets).
10
11  * Interface changes relative to the 1.1.7 release:
12  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13  GPGME_KEYLIST_MODE_EPHEMERAL   NEW.
14  GPGME_PROTOCOL_ASSUAN          NEW.
15  gpgme_assuan_data_cb_t         NEW.
16  gpgme_assuan_inquire_cb_t      NEW.
17  gpgme_assuan_status_cb_t       NEW.
18  gpgme_op_assuan_transact_start NEW.
19  gpgme_op_assuan_transact       NEW.
20  gpgme_op_assuan_result         NEW.
21  gpgme_subkey_t                 EXTENDED: New fields is_cardkey, card_number.
22  GPGME_ENCRYPT_NO_ENCRYPT_TO    NEW.
23  gpgme_check_version            CHANGED: Is now a macro.
24  gpgme_new                      EXTENDED: More failure codes.
25  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26
27
28 Noteworthy changes in version 1.1.8 (2008-12-08)
29 ------------------------------------------------
30
31  * SIGPIPE is now again ignored as described in the manual.  Fixes
32    regresion introduced with 1.1.6.
33
34
35 Noteworthy changes in version 1.1.7 (2008-10-17)
36 ------------------------------------------------
37
38  * Using GPGME_KEYLIST_MODE_LOCAL combined with
39    GPGME_KEYLIST_MODE_EXTERN is now supported; it uses the
40    --locate-keys feature of gpg (>= 2.0.10).
41    
42  * The encoding of gpgme_data_t objects can affect the output encoding
43    of export, sign and encrypt operations now (the same operations
44    that are also affected by the ASCII mode switch).  We believe this
45    change in the ABI is innocent enough not to break existing
46    applications (it only affects the S/MIME backend on certain
47    operations).
48
49  * The reference manual now includes the specification of "The GnuPG
50    UI Server protocol".
51
52  * A new function gpgme_cancel_async can be used to asynchronously
53    cancel any pending operation at any time, from any thread.
54
55  * Interface changes relative to the 1.1.6 release:
56  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
57 gpgme_op_encrypt                CHANGED: Output encoding can affect result.
58 gpgme_op_encrypt_start          CHANGED: Output encoding can affect result.
59 gpgme_op_encrypt_sign           CHANGED: Output encoding can affect result.
60 gpgme_op_encrypt_sign_start     CHANGED: Output encoding can affect result.
61 gpgme_op_sign                   CHANGED: Output encoding can affect result.
62 gpgme_op_sign_start             CHANGED: Output encoding can affect result.
63 gpgme_op_export                 CHANGED: Output encoding can affect result.
64 gpgme_op_export_start           CHANGED: Output encoding can affect result.
65 gpgme_op_export_ext             CHANGED: Output encoding can affect result.
66 gpgme_op_export_ext_start       CHANGED: Output encoding can affect result.
67 gpgme_cancel_async              NEW
68  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
69
70
71 Noteworthy changes in version 1.1.6 (2008-01-04)
72 ------------------------------------------------
73
74  * Bug fixes for for W32.
75
76  * A new, experimental (and thus undocumented and potentially
77    unstable) interface for accessing gpg-conf through GPGME has been
78    added.
79
80  * Interface changes relative to the 1.1.1 release:
81  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
82  gpgme_signature_t               EXTENDED: New field chain_model.
83  gpgme_op_getauditlog_start      NEW.
84  gpgme_op_getauditlog            NEW.
85  GPGME_AUDITLOG_HTML             NEW.
86  GPGME_AUDITLOG_WITH_HELP        NEW.
87  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88
89
90 Noteworthy changes in version 1.1.5 (2007-07-09)
91 ------------------------------------------------
92
93  * Bug and portability fixes (mainly for W32).
94
95
96 Noteworthy changes in version 1.1.4 (2007-03-05)
97 ------------------------------------------------
98
99  * Detect and bail out on double plaintext messages.  This is required
100    so that applications can properly detect the signed parts of a
101    message.  Actual there is now a double protection as GnuPG 1.4.7
102    will detect this case too.
103
104
105 Noteworthy changes in version 1.1.3 (2007-01-29)
106 ------------------------------------------------
107
108  * Fixed a memory leak in gpgme_data_release_and_get_mem.
109
110  * Fixed a bug in Windows command line quoting.
111
112
113 Noteworthy changes in version 1.1.2 (2006-03-02)
114 ------------------------------------------------
115
116  * Fixed a bug in the W32 glib backend.
117
118
119 Noteworthy changes in version 1.1.1 (2006-02-23)
120 ------------------------------------------------
121
122  * Fixed a bug in that the fingerprints of subkeys are not available.
123
124  * Clarified usage of the SECRET flag in key listings.  It is now
125    reset for stub keys.
126
127  * Reading signature notations and policy URLs on key signatures is
128    supported.  They can be found in the new field notations of the
129    gpgme_key_sig_t structure.  This has to be enabled with the keylist
130    mode flag GPGME_KEYLIST_MODE_SIG_NOTATIONS.
131
132  * A new gpgme_free() function solves the problem of using different
133    allocators in a single program.  This function should now be used
134    instead calling free() to release the buffer returned by
135    gpgme_data_release_and_get_mem.  It is recommended that you always
136    do this, but it is only necessary on certain platforms, so backwards
137    compatibility is provided.  In other words: If free() worked for
138    you before, it will keep working.
139
140  * New status codes GPGME_PKA_TRUST_GOOD and GPGME_PKA_TRUST_BAD.
141    They are analyzed by the verify handlers and made available in the
142    new PKA_TRUST and PKA_ADDRESS fields of the signature result structure.
143
144  * Interface changes relative to the 1.1.0 release:
145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
146 gpgme_key_sig_t                 EXTENDED: New field notations.
147 GPGME_KEYLIST_MODE_SIG_NOTATIONS NEW
148 gpgme_free                      NEW
149 GPGME_STATUS_PKA_TRUST_BAD      NEW
150 GPGME_STATUS_PKA_TRUST_GOOD     NEW
151 gpgme_signature_t               EXTENDED: New field pka_trust.
152 gpgme_signature_t               EXTENDED: New field pka_address.
153 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154
155
156 Noteworthy changes in version 1.1.0 (2005-10-01)
157 ------------------------------------------------
158
159  * You can now configure the backend engine file name and home
160    directory to be used, as default and per context.
161
162  * Information about the recipients of an encrypted text is now
163    available at decryption time.
164
165  * New status GPGME_STATUS_PLAINTEXT.  This is analyzed by the decrypt
166    and verify handlers, the information about the plaintext filename,
167    if available is made available in the new field file_name of the
168    respective result structure.
169
170  * The code for "automagically detecting the thread library" has been
171    removed from libgpgme.  It is deprecated since version 0.4.3.
172    Since then, you had to link against libgpgme-pthread for
173    applications using pthread and libgpgme-pth for applications using
174    GNU Pth.
175
176    The code was removed because it caused compilation problems on
177    systems where the pthread.h header from GNU Pth is available in
178    addition to the system header (FreeBSD 6 and later for example).
179
180  * "./autogen.sh --build-w32" does now build gpgme.dll.
181
182  * [W32] The environment variable GPGME_DEBUG now uses a semicolon as
183    delimiter.  The standard install directory is used when locating
184    gpg or gpgsm before finally falling back to the hardwired name.
185
186  * There is a new flag for keys and subkeys, is_qualified, which
187    indicates if a key can be used for qualified signatures according
188    to local government regulations.
189
190  * You can associate a filename with a data object using the new
191    function gpgme_data_set_file_name().  This filename will be stored
192    in the output when encrypting or signing the data and will be
193    returned when decrypting or verifying the output data.
194
195  * You can now set notation data at signature creation with the new
196    function gpgme_sig_notation_add().
197
198  * Interface changes relative to the 1.0.3 release:
199 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
200 gpgme_set_engine_info           NEW
201 gpgme_ctx_get_engine_info       NEW
202 gpgme_ctx_set_engine_info       NEW
203 gpgme_recipient_t               NEW
204 gpgme_decrypt_result_t          EXTENDED: New field recipients.
205 gpgme_verify_result_t           EXTENDED: New fields pubkey_algo, hash_algo.
206 gpgme_decrypt_result_t          EXTENDED: New field plaintext_filename.
207 gpgme_verify_result_t           EXTENDED: New field plaintext_filename.
208 GPGME_STATUS_PLAINTEXT          NEW
209 gpgme_key_t                     EXTENDED: New field is_qualified.
210 gpgme_subkey_t                  EXTENDED: New field is_qualified.
211 gpgme_data_get_file_name        NEW
212 gpgme_data_set_file_name        NEW
213 gpgme_sig_notation_flags_t      NEW
214 GPGME_SIG_NOTATION_HUMAN_READABLE NEW
215 GPGME_SIG_NOTATAION_CRITICAL    NEW
216 gpgme_sig_notation_clear        NEW
217 gpgme_sig_notation_add          NEW
218 gpgme_sig_notation_get          NEW
219 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
220
221
222 Noteworthy changes in version 1.0.3 (2005-06-20)
223 ------------------------------------------------
224
225  * Previousy, GPGME would use a default "include certs" of 1.  This
226    has been changed.  Now GPGME will use the crypto backend engines
227    default unless you set the value with gpgme_set_include_certs()
228    explicitely.  A new macro GPGME_INCLUDE_CERTS_DEFAULT can be used
229    as a value to explicitely request the new default behaviour.
230
231    Because the default changes, this is a slight change of the API
232    semantics.  We consider it to be a bug fix.
233
234  * A bug which made GPGME hang has been fixed.  If you have
235    experienced hanging before, please try out this version and let me
236    know if you still experience hanging problems.
237
238  * Interface changes relative to the 0.9.0 release:
239 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
240 gpgme_set_include_certs         CHANGED DEFAULT
241 GPGME_INCLUDE_CERTS_DEFAULT     NEW
242 GPGME_STATUS_SIG_SUBPACKET      NEW
243 GPGME_STATUS_NEED_PASSPHRASE_PIN NEW
244 GPGME_STATUS_SC_OP_FAILURE      NEW
245 GPGME_STATUS_SC_OP_SUCCESS      NEW
246 GPGME_STATUS_CARDCTRL           NEW
247 GPGME_STATUS_BACKUP_KEY_CREATED NEW
248 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
249
250
251 Noteworthy changes in version 1.0.2 (2004-12-28)
252 ------------------------------------------------
253
254  * Changed the license of the library to the GNU Lesser General Public
255    License (LGPL), version 2.1 or later.
256
257
258 Noteworthy changes in version 1.0.1 (2004-10-22)
259 ------------------------------------------------
260
261  * Only bug fixes.
262
263
264 Noteworthy changes in version 1.0.0 (2004-09-30)
265 ------------------------------------------------
266
267  * Version 1.0.0!  We are proud to present you with a thoroughly
268    tested and stable version of the GPGME library.  A big Thank You!
269    to all the people who made this possible.
270
271    The development will be branched into a stable 1.x.y series and the
272    head.
273
274  * The gpgme.m4 macro supports checking the API version.  Just prepend
275    it to the required version string, separated by a colon.  For
276    example, this release has the version "1:1.0.0".  The last release
277    to which this version is (mostly) ABI compatible is "1:0.4.2",
278    which is the default required version.
279
280
281 Noteworthy changes in version 0.9.0 (2004-06-08)
282 ------------------------------------------------
283
284  * The type gpgme_key_t has now a new field keylist_mode that contains
285    the keylist mode that was active at the time the key was retrieved.
286
287  * The type gpgme_decrypt_result_t has a new field "wrong_key_usage"
288    that contains a flag indicating that the key should not have been
289    used for encryption.
290
291  * Verifying a signature of a revoked key gives the correct result now
292    (GPG_ERR_CERT_REVOKED error code).
293
294  * Clarified that the error code GPG_ERR_NO_DATA from the decrypt &
295    verify operations still allows you to look at the signature
296    verification result.
297
298  * Clarified that patterns in keylisting operations have an upper
299    limit, and thus are not suited to list many keys at once by their
300    fingerprint.  Also improve the error message if the pattern is too
301    long for the CMS protocol to handle.
302
303 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
304 gpgme_key_t                     EXTENDED: New field keylist_mode.
305 gpgme_decrypt_result_t          EXTENDED: New field wrong_key_usage.
306 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
307
308
309 Noteworthy changes in version 0.4.7 (2004-04-29)
310 ------------------------------------------------
311
312  * Correctly initialize the fields expired, revoked, invalid, and
313    disabled in the gpgme_key_t structures.
314
315  * A bug fix: The flag wrong_key_usage of gpgme_signature_t was
316    accidently of type int instead unsigned int.
317
318  * Interface changes relative to the 0.4.5 release:
319 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
320 gpgme_signature_t               CHANGED: wrong_key_usage is unsigned int now.
321 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
322
323 Noteworthy changes in version 0.4.6 (2004-04-06)
324 ------------------------------------------------
325
326  * Bug fixes
327
328
329 Noteworthy changes in version 0.4.5 (2004-03-07)
330 ------------------------------------------------
331
332  * GPGME is now compiled with LFS (large file support) by default.
333    This means that _all_ programs using GPGME must be compiled with
334    LFS support enabled by default.  You can do this easily with
335    autoconf, by using the AC_SYS_LARGEFILE macro.  Or you can do this
336    without autoconf by defining the preprocessor symbol
337    _FILE_OFFSET_BITS to 64 (by passing the -D_FILE_OFFSET_BITS=64 to
338    the C compiler command line, or by defining this preprocessor
339    symbol before including any system header files).  For more
340    details, read the section on LFS in the manual.
341
342    Up to now, it was undocumented that GPGME was not using LFS.
343    But the public interfaces use off_t, and file descriptors are
344    exchanged between the application and GPGME.  This was an oversight,
345    and bound to cause troubles in the future.
346
347    Writing GPGME as a dual mode library that seamlessly supports LFS
348    while keeping backwards compatibility is possible, but does not
349    solve the problem: Many applications already expect GPGME to have
350    LFS (they are compiled with off_t being a 64bit value).  This is true
351    in particular for the popular Gtk+ and Qt programs.
352
353    So, although this is an ABI (but not an API) break, we will not
354    change the library version to reflect that.  Because the interfaces
355    affected are probably not used yet in any GPGME 0.4 based
356    application, we don't expect any real failures from this change.
357    In fact, applications already using LFS will have some subtle bugs
358    fixed.
359
360    However, if you encounter an application using GPGME 0.4.x that
361    does _not_ use LFS by default (off_t is a 32bit value), _and_
362    uses at least one of the functions gpgme_data_seek,
363    gpgme_data_new_from_filepart, or a gpgme_data_seek_cb_t with
364    gpgme_data_new_from_cbs, then indeed this library will be ABI
365    incompatible with the program.  As said above, we don't believe
366    such a program exists.  If we are in error, then you have two
367    options: As a quick hack, you can configure GPGME with the
368    --disable-largefile option.  This will revert the change, and GPGME
369    will not use LFS.  However, GPGME will be incompatible with
370    programs that expect GPGME to use LFS.  All applications are
371    required to use LFS when using GPGME, so this is only good as a
372    temporary local work-around.
373
374    The other option is to change the versioning of the library and
375    recompile all applications.  We have reserved a special version of
376    the library for that, so you can do that without expecting a
377    version clash in the future.  Furthermore, everyone who does this
378    will agree on the version to use (this is important for
379    distribution makers).  Read the comment in configure.ac (before
380    LIBGPGME_LT_AGE) if you want to do this.  Please don't do this
381    blindly: As stated above, we think it is unlikely this measure is
382    needed.  Still, it is there if necessary.  If in doubt, contact us
383    and we will give our advise for your specific situation.
384
385  * New key listing mode GPGME_KEYLIST_MODE_VALIDATE for validation of
386    the listed keys.
387
388  * New interface gpgme_cancel() that can be used to cancel
389    asynchronous operations.
390
391  * Interface changes relative to the 0.4.4 release:
392 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
393 gpgme_data_seek_cb_t            CHANGED: off_t is now a largefile type.
394 gpgme_data_seek                 CHANGED: off_t is now a largefile type.
395 gpgme_data_new_from_filepart    CHANGED: off_t is now a largefile type.
396 GPGME_KEYLIST_MODE_VALIDATE     NEW
397 gpgme_cancel                    NEW
398 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
399
400 Noteworthy changes in version 0.4.4 (2004-01-12)
401 ------------------------------------------------
402
403  * The member "class" in gpgme_key_sig_t and gpgme_new_signature_t has
404    been renamed to "sig_class", to avoid clash with C++ compilers.  In
405    the C API, the old name "class" has been preserved for backwards
406    compatibility, but is deprecated.
407
408  * Interface changes relative to the 0.4.3 release:
409 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
410 gpgme_key_sig_t                 CHANGED: class deprecated, use new sig_class.
411 gpgme_new_signature_t           CHANGED: class deprecated, use new sig_class.
412 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
413
414 Noteworthy changes in version 0.4.3 (2003-10-06)
415 ------------------------------------------------
416
417  * libgpgme should not be used for threaded programs anymore.  This
418    never worked reliably in all cases, because you had to
419    be careful about the linking order and libtool wouldn't do that for
420    you automatically.  Instead, now you have to link against
421    libgpgme-pthread for applications using pthread and libgpgme-pth for
422    applications using GNU Pth.
423
424    The old code for automagically detecting the thread library is
425    still part of libgpgme, but it is DEPRECATED.
426
427  * There are new automake macros AM_PATH_GPGME_PTH and
428    AM_PATH_GPGME_PTHREAD, which support checking for thread-enabled
429    versions of GPGME.  They define GPGME_PTH_CFLAGS, GPGME_PTH_LIBS,
430    GPGME_PTHREAD_CFLAGS and GPGME_PTHREAD_LIBS respectively.  These
431    variables of course also include the configuration for the thread
432    package itself.  Alternatively, use libtool.
433
434  * gpgme_strerror_r as a thread safe variant of gpgme_strerror was
435    added.
436
437  * gpgme-config doesn't support setting the prefix or exec prefix
438    anymore.  I don't think it ever worked correctly, and it seems to
439    be pointless.
440
441  * gpgme_get_key fails with GPG_ERR_AMBIGUOUS_NAME if the key ID
442    provided was not unique, instead returning the first matching key.
443
444  * gpgme_key_t and gpgme_subkey_t have a new field, can_authenticate,
445    that indicates if the key can be used for authentication.
446
447  * gpgme_signature_t's status field is now correctly set to an error
448    with error code GPG_ERR_NO_PUBKEY if public key is not found.
449
450  * gpgme_new_signature_t's class field is now an unsigned int, rather
451    than an unsigned long (the old class field is preserved for
452    backwards compatibility).
453
454  * A new function gpgme_set_locale() is provided to allow configuring
455    the locale for the crypto backend.  This is necessary for text
456    terminals so that programs like the pinentry can be started with
457    the right locale settings for the terminal the application is running
458    on, in case the terminal has different settings than the system
459    default (for example, if it is a remote terminal).  You are highly
460    recommended to call the following functions directly after
461    gpgme_check_version:
462
463    #include <locale.h>
464
465    setlocale (LC_ALL, "");
466    gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
467    gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
468
469    GPGME can not do this for you, as setlocale is not thread safe, and
470    there is no alternative.
471
472  * The signal action for SIGPIPE is now set to SIG_IGN by
473    gpgme_check_version, instead the first time a crypto engine is
474    started (which is not well defined).
475
476  * In the output of gpgme_hash_algo_name, change RMD160 to RIPEMD160,
477    TIGER to TIGER192, CRC32-RFC1510 to CRC32RFC1510, and CRC24-RFC2440
478    to CRC24RFC2440.  For now, these strings can be used as the MIC
479    parameter for PGP/MIME (if appropriately modified).
480
481  * Interface changes relative to the 0.4.2 release:
482 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
483 gpgme_strerror_t                NEW
484 gpgme_get_key                   CHANGED: Fails correctly if key ID not unique.
485 gpgme_key_t                     EXTENDED: New field can_authenticate.
486 gpgme_subkey_t                  EXTENDED: New field can_authenticate.
487 gpgme_new_signature_t           CHANGED: New type for class field.
488 gpgme_set_locale                NEW
489 gpgme_hash_algo_name            CHANGED: Slight adjustment of algo names.
490 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
491
492 Noteworthy changes in version 0.4.2 (2003-07-30)
493 ------------------------------------------------
494
495  * Allow gpg-error to be in non-standard place when linking the test suite.
496
497  * Configure will fail now if gpg-error can not be found.
498
499  * Fixed initialized memory backed data objects for writing, which
500    caused the test program to crash (but only on Mac OS, surprisingly).
501
502  * Eliminate use of C99 constructs.
503
504  * Small improvements to the manual.
505
506
507 Noteworthy changes in version 0.4.1 (2003-06-06)
508 ------------------------------------------------
509
510  This is the release that 0.4.0 should have been.  There are many
511  interface changes, please see below for the details.  The changes are
512  sometimes the result of new functionality, but more often express a
513  paradigm shift.  Others are an overdue cleanup to get GPGME in line
514  with the GNU coding standards and to make the interface more
515  self-consistent.  Here is an overview on the changes:
516
517  All types have been renamed to conform to the GNU coding standards,
518  most of the time by keeping the whole name in lowercase and inserting
519  underscores between words.
520
521  All operations consistently only accept input parameters in their
522  invocation function, and return only an error code directly.  Further
523  information about the result of the operation has to be retrieved
524  afterwards by calling one of the result functions.  This unifies the
525  synchronous and the asynchronous interface.
526
527  The error values have been completely replaced by a more
528  sophisticated model that allows GPGME to transparently and accurately
529  report all errors from the other GnuPG components, irregardless of
530  process boundaries.  This is achieved by using the library
531  libgpg-errors, which is shared by all GnuPG components.  This library
532  is now required for GPGME.
533
534  The results of all operations are now provided by pointers to C
535  structs rather than by XML structs or in other ways.
536
537  Objects which used to be opaque (for example a key) are now pointers
538  to accessible structs, so no accessor functions are necessary.
539
540  Backward compatibility is provided where it was possible without too
541  much effort and did not collide with the overall sanitization effort.
542  However, this is only for ease of transition.  NO DEPRECATED FUNCTION
543  OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND WILL BE
544  DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE LIBRARY.
545  Recommendations how to replace deprecated or removed functionality
546  can be found within the description of each change.
547
548  What follows are all changes to the interface and behaviour of GPGME
549  in detail.
550
551  * If gpgme.h is included in sources compiled by GCC 3.1 or later,
552    deprecated attributes will warn about use of obsolete functions and
553    type definitions.  You can suppress these warnings by passing
554    -Wno-deprecated-declarations to the gcc command.
555
556  * The following types have been renamed.  The old types are still
557    available as aliases, but they are deprecated now:
558    Old name:            New name:
559    GpgmeCtx             gpgme_ctx_t
560    GpgmeData            gpgme_data_t
561    GpgmeError           gpgme_error_t
562    GpgmeDataEncoding    gpgme_data_encoding_t
563    GpgmeSigStat         gpgme_sig_stat_t
564    GpgmeSigMode         gpgme_sig_mode_t
565    GpgmeAttr            gpgme_attr_t
566    GpgmeValidity        gpgme_validity_t
567    GpgmeProtocol        gpgme_protocol_t
568    GpgmeKey             gpgme_key_t
569    GpgmePassphraseCb    gpgme_passphrase_cb_t
570    GpgmeProgressCb      gpgme_progress_cb_t
571    GpgmeIOCb            gpgme_io_cb_t
572    GpgmeRegisterIOCb    gpgme_register_io_cb_t
573    GpgmeRemoveIOCb      gpgme_remove_io_cb_t
574    GpgmeEventIO         gpgme_event_io_t
575    GpgmeEventIOCb       gpgme_event_io_cb_t
576    GpgmeIOCbs           gpgme_io_cbs
577    GpgmeDataReadCb      gpgme_data_read_cb_t
578    GpgmeDataWriteCb     gpgme_data_write_cb_t
579    GpgmeDataSeekCb      gpgme_data_seek_cb_t
580    GpgmeDataReleaseCb   gpgme_data_release_cb_t
581    GpgmeDataCbs         gpgme_data_cbs_t
582    GpgmeTrustItem       gpgme_trust_item_t
583    GpgmeStatusCode      gpgme_status_code_t
584
585  * gpgme_error_t is now identical to gpg_error_t, the error type
586    provided by libgpg-error.  More about using libgpg-error with GPGME
587    can be found in the manual.  All error symbols have been removed!
588
589  * All functions and types in libgpg-error have been wrapped in GPGME.
590    The new types are gpgme_err_code_t and gpgme_err_source_t.  The new
591    functions are gpgme_err_code, gpgme_err_source, gpgme_error,
592    gpgme_err_make, gpgme_error_from_errno, gpgme_err_make_from_errno,
593    gpgme_err_code_from_errno, gpgme_err_code_to_errno,
594    gpgme_strsource.
595
596  * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
597
598  * GnuPG 1.2.2 is required.  The progress callback is now also invoked
599    for encrypt, sign, encrypt-sign, decrypt, verify, and
600    decrypt-verify operations.  For verify operations on detached
601    signatures, the progress callback is invoked for both the detached
602    signature and the plaintext message, though.
603
604  * gpgme_passphrase_cb_t has been changed to not provide a complete
605    description, but the UID hint, passphrase info and a flag
606    indicating if this is a repeated attempt individually, so the user
607    can compose his own description from this information.
608
609    The passphrase is not returned as a C string, but must be written
610    to a file descriptor directly.  This allows for secure passphrase
611    entries.
612
613    The return type has been changed to gpgme_error_t value.  This
614    allowed to remove the gpgme_cancel function; just return
615    the error code GPG_ERR_CANCELED in the passphrase callback directly.
616
617  * gpgme_edit_cb_t has been changed to take a file descriptor argument.
618    The user is expected to write the response to the file descriptor,
619    followed by a newline.
620
621  * The recipients interface has been removed.  Instead, you use
622    NULL-terminated lists of keys for specifying the recipients of an
623    encryption operation.  Use the new encryption flag
624    GPGME_ENCRYPT_ALWAYS_TRUST if you want to override the validity of
625    the keys (but note that in general this is not a good idea).
626
627    This change has been made to the prototypes of gpgme_op_encrypt,
628    gpgme_op_encrypt_start, gpgme_op_encrypt_sign and
629    gpgme_op_encrypt_sign_start.
630
631    The export interface has been changed to use pattern strings like
632    the keylist interface.  Thus, new functions gpgme_op_export_ext and
633    gpgme_op_export_ext_start have been added as well.  Now the
634    prototypes of gpgme_op_export_start and gpgme_op_export finally
635    make sense.
636
637  * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
638    summary anymore.  Use gpgme_get_sig_status to retrieve the individual
639    stati.
640
641  * gpgme_io_cb_t changed from a void function to a function returning
642    a gpgme_error_t value.  However, it will always return 0, so you
643    can safely ignore the return value.
644
645  * A new I/O callback event GPGME_EVENT_START has been added.  The new
646    requirement is that you must wait until this event until you are
647    allowed to call the I/O callback handlers previously registered for
648    this context operation.  Calling I/O callback functions for this
649    context operation before the start event happened is unsafe because
650    it can lead to race conditions in a multi-threaded environment.
651
652  * The idle function feature has been removed.  It was not precisely
653    defined in a multi-threaded environment and is obsoleted by the
654    user I/O callback functions.  If you still need a simple way to
655    call something while waiting on one or multiple asynchronous
656    operations to complete, don't set the HANG flag in gpgme_wait (note
657    that this will return to your program more often than the idle
658    function did).
659
660  * gpgme_wait can return NULL even if hang is true, if an error
661    occurs.  In that case *status contains the error code.
662
663  * gpgme_get_engine_info was radically changed.  Instead an XML
664    string, an info structure of the new type gpgme_engine_info_t is
665    returned.  This makes it easier and more robust to evaluate the
666    information in an application.
667
668  * The new function gpgme_get_protocol_name can be used to convert a
669    gpgme_protocol_t value into a string.
670
671  * The status of a context operation is not checked anymore.  Starting
672    a new operation will silently cancel the previous one.  Calling a
673    function that requires you to have started an operation before without
674    doing so is undefined.
675
676  * The FPR argument to gpgme_op_genkey was removed.  Instead, use the
677    gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
678    pointer to a structure which contains the fingerprint.  This also
679    works with gpgme_op_genkey_start.  The structure also provides
680    other information about the generated keys.
681
682    So, instead:
683
684    char *fpr;
685    err = gpgme_op_genkey (ctx, NULL, NULL, &fpr); 
686    if (!err && fpr)
687      printf ("%s\n", fpr);
688
689    you should now do:
690
691    gpgme_genkey_result_t result;
692    err = gpgme_op_genkey (ctx, NULL, NULL);
693    if (!err)
694      {
695        result = gpgme_op_genkey_result (ctx);
696        if (result->fpr)
697          printf ("%s\n", result->fpr);
698      }
699
700  * The new gpgme_op_import_result function provides detailed
701    information about the result of an import operation in
702    gpgme_import_result_t and gpgme_import_status_t objects.
703    Thus, the gpgme_op_import_ext variant is deprecated.
704
705  * The new gpgme_op_sign_result function provides detailed information
706    about the result of a signing operation in gpgme_sign_result_t,
707    gpgme_invalid_key_t and gpgme_new_signature_t objects.
708
709  * The new gpgme_op_encrypt_result function provides detailed
710    information about the result of an encryption operation in
711    a GpgmeEncryptResult object.
712
713  * The new gpgme_op_decrypt_result function provides detailed
714    information about the result of a decryption operation in
715    a GpgmeDecryptResult object.
716
717  * The new gpgme_op_verify_result function provides detailed
718    information about the result of an verify operation in
719    a GpgmeVerifyResult object.  Because of this, the GPGME_SIG_STAT_*
720    values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
721    gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
722    and gpgme_get_notation is removed.
723
724  * GpgmeTrustItem objects have now directly accessible data, so the
725    gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
726    accessor functions are deprecated.  Also, reference counting is
727    available through gpgme_trust_item_ref and gpgme_trust_item_unref
728    (the gpgme_trust_item_release alias for the latter is deprecated).
729
730  * Keys are not cached internally anymore, so the force_update argument
731    to gpgme_get_key has been removed.
732
733  * GpgmeKey objects have now directly accessible data so the
734    gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
735    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
736    functions are deprecated.  Also, gpgme_key_release is now
737    deprecated.  The gpgme_key_get_as_xml function has been dropped.
738
739  * Because all interfaces using attributes are deprecated, the
740    GpgmeAttr data type is also deprecated.
741
742  * The new gpgme_op_keylist_result function provides detailed
743    information about the result of a key listing operation in
744    a GpgmeKeyListResult object.
745
746  * Now that each function comes with its own result retrieval
747    interface, the generic gpgme_get_op_info interface is not useful
748    anymore and dropped.
749
750  * The type and mode of data objects is not available anymore.
751
752  * Interface changes relative to the 0.4.0 release:
753 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
754 GpgmeCtx                        DEPRECATED: Use gpgme_ctx_t.
755 GpgmeData                       DEPRECATED: Use gpgme_data_t.
756 GpgmeError                      DEPRECATED: Use gpgme_error_t.
757 GpgmeDataEncoding               DEPRECATED: Use gpgme_data_encoding_t.
758 GpgmeSigStat                    DEPRECATED: Use gpgme_sig_stat_t.
759 GpgmeSigMode                    DEPRECATED: Use gpgme_sig_mode_t.
760 GpgmeAttr                       DEPRECATED: Use gpgme_attr_t.
761 GpgmeValidity                   DEPRECATED: Use gpgme_validity_t.
762 GpgmeProtocol                   DEPRECATED: Use gpgme_protocol_t.
763 GpgmeKey                        DEPRECATED: Use gpgme_key_t.
764 GpgmePassphraseCb               DEPRECATED: Use gpgme_passphrase_cb_t.
765 GpgmeProgressCb                 DEPRECATED: Use gpgme_progress_cb_t.
766 GpgmeIOCb                       DEPRECATED: Use gpgme_io_cb_t.
767 GpgmeRegisterIOCb               DEPRECATED: Use gpgme_register_io_cb_t.
768 GpgmeRemoveIOCb                 DEPRECATED: Use gpgme_remove_io_cb_t.
769 GpgmeEventIO                    DEPRECATED: Use gpgme_event_io_t.
770 GpgmeEventIOCb                  DEPRECATED: Use gpgme_event_io_cb_t.
771 GpgmeIOCbs                      DEPRECATED: Use gpgme_io_cbs.
772 GpgmeDataReadCb                 DEPRECATED: Use gpgme_data_read_cb_t.
773 GpgmeDataWriteCb                DEPRECATED: Use gpgme_data_write_cb_t.
774 GpgmeDataSeekCb                 DEPRECATED: Use gpgme_data_seek_cb_t.
775 GpgmeDataReleaseCb              DEPRECATED: Use gpgme_data_release_cb_t.
776 GpgmeDataCbs                    DEPRECATED: Use gpgme_data_cbs_t.
777 GpgmeTrustItem                  DEPRECATED: Use gpgme_trust_item_t.
778 GpgmeStatusCode                 DEPRECATED: Use gpgme_status_code_t.
779 gpgme_ctx_t                     NEW
780 gpgme_data_t                    NEW
781 gpgme_recipients_t              NEW
782 gpgme_error_t                   NEW
783 gpgme_data_encoding_t           NEW
784 gpgme_sig_stat_t                NEW
785 gpgme_sig_mode_t                NEW
786 gpgme_attr_t                    NEW
787 gpgme_validity_t                NEW
788 gpgme_protocol_t                NEW
789 gpgme_key_t                     NEW
790 gpgme_passphrase_cb_t           NEW
791 gpgme_progress_cb_t             NEW
792 gpgme_io_cb_t                   NEW
793 gpgme_register_io_cb_t          NEW
794 gpgme_remove_io_cb_t            NEW
795 gpgme_event_io_t                NEW
796 gpgme_event_io_cb_t             NEW
797 gpgme_io_cbs                    NEW
798 gpgme_data_read_cb_t            NEW
799 gpgme_data_write_cb_t           NEW
800 gpgme_data_seek_cb_t            NEW
801 gpgme_data_release_cb_t         NEW
802 gpgme_data_cbs_t                NEW
803 gpgme_trust_item_t              NEW
804 gpgme_status_code_t             NEW
805 GPGME_{some error code}         REMOVED! Use GPG_ERR_* from libgpg-error.
806 gpgme_err_code_t                NEW
807 gpgme_err_source_t              NEW
808 gpgme_err_code                  NEW
809 gpgme_err_source                NEW
810 gpgme_error                     NEW
811 gpgme_err_make                  NEW
812 gpgme_error_from_errno          NEW
813 gpgme_err_make_from_errno       NEW
814 gpgme_err_code_from_errno       NEW
815 gpgme_err_code_to_errno         NEW
816 gpgme_strsource                 NEW
817 gpgme_io_cb_t                   CHANGED: Return type from void to GpgmeError.
818 gpgme_event_io_t                CHANGED: New event type (all numbers changed).
819 gpgme_passphrase_cb_t           CHANGED: Desc decomposed, write directly to FD.
820 gpgme_edit_cb_t                 CHANGED: Write directly to FD.
821 gpgme_key_get_string_attr       CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
822 gpgme_op_verify                 CHANGED: Drop R_STAT argument.
823 gpgme_op_decrypt_verify         CHANGED: Drop R_STAT argument.
824 gpgme_wait                      CHANGED: Can return NULL even if hang is true.
825 GpgmeIdleFunc                   REMOVED
826 gpgme_register_idle             REMOVED
827 GpgmeRecipients                 REMOVED
828 gpgme_recipients_new            REMOVED
829 gpgme_recipients_release        REMOVED
830 gpgme_recipients_add_name       REMOVED
831 gpgme_recipients_add_name_with_validity REMOVED
832 gpgme_recipients_count          REMOVED
833 gpgme_recipients_enum_open      REMOVED
834 gpgme_recipients_enum_read      REMOVED
835 gpgme_recipients_enum_close     REMOVED
836 gpgme_encrypt_flags_t           NEW
837 GPGME_ENCRYPT_ALWAYS_TRUST      NEW
838 gpgme_op_encrypt                CHANGED: Recipients passed as gpgme_key_t[].
839 gpgme_op_encrypt_start          CHANGED: Recipients passed as gpgme_key_t[].
840 gpgme_op_encrypt_sign           CHANGED: Recipients passed as gpgme_key_t[].
841 gpgme_op_encrypt_sign_start     CHANGED: Recipients passed as gpgme_key_t[].
842 gpgme_op_export_start           CHANGED: User IDs passed as patterns.
843 gpgme_op_export                 CHANGED: User IDs passed as patterns.
844 gpgme_op_export_ext_start       NEW
845 gpgme_op_export_ext             NEW
846 gpgme_keylist_mode_t            NEW
847 gpgme_sigsum_t                  NEW
848 gpgme_engine_info_t             NEW
849 gpgme_get_engine_info           CHANGED: Return info structure instead XML.
850 gpgme_get_protocol_name         NEW
851 gpgme_cancel                    REMOVED: Return error in callback directly.
852 gpgme_op_genkey                 CHANGED: FPR argument dropped.
853 gpgme_op_genkey_result          NEW
854 gpgme_genkey_result_t           NEW
855 gpgme_op_import_ext             DEPRECATED: Use gpgme_op_import_result.
856 gpgme_op_import_result          NEW
857 gpgme_import_status_t           NEW
858 gpgme_import_result_t           NEW
859 gpgme_pubkey_algo_t             NEW
860 gpgme_hash_algo_t               NEW
861 gpgme_invalid_key_t             NEW
862 gpgme_new_signature_t           NEW
863 gpgme_sign_result_t             NEW
864 gpgme_op_sign_result            NEW
865 gpgme_pubkey_algo_name          NEW
866 gpgme_hash_algo_name            NEW
867 gpgme_encrypt_result_t          NEW
868 gpgme_op_encrypt_result         NEW
869 gpgme_decrypt_result_t          NEW
870 gpgme_op_decrypt_result         NEW
871 gpgme_verify_result_t           NEW
872 gpgme_op_verify_result          NEW
873 gpgme_get_notation              REMOVED: Access verify result directly instead.
874 gpgme_get_sig_key               DEPRECATED: Use gpgme_get_key with fingerprint.
875 gpgme_get_sig_ulong_attr        DEPRECATED: Use verify result directly.
876 gpgme_get_sig_string_attr       DEPRECATED: Use verify result directly.
877 GPGME_SIG_STAT_*                DEPRECATED: Use error value in sig status.
878 gpgme_get_sig_status            DEPRECATED: Use verify result directly.
879 gpgme_trust_item_t              CHANGED: Now has user accessible data members.
880 gpgme_trust_item_ref            NEW
881 gpgme_trust_item_unref          NEW
882 gpgme_trust_item_release        DEPRECATED: Use gpgme_trust_item_unref.
883 gpgme_trust_item_get_string_attr DEPRECATED
884 gpgme_trust_item_get_ulong_attr DEPRECATED
885 gpgme_get_key                   CHANGED: Removed force_update argument.
886 gpgme_sub_key_t                 NEW
887 gpgme_key_sig_t                 NEW
888 gpgme_user_id_t                 NEW
889 gpgme_key_t                     CHANGED: Now has user accessible data members.
890 gpgme_key_get_string_attr       DEPRECATED
891 gpgme_key_get_ulong_attr        DEPRECATED
892 gpgme_key_sig_get_string_attr   DEPRECATED
893 gpgme_key_sig_get_ulong_attr    DEPRECATED
894 gpgme_key_get_as_xml            REMOVED
895 gpgme_key_list_result_t         NEW
896 gpgme_op_keylist_result         NEW
897 gpgme_get_op_info               REMOVED
898 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
899
900 Noteworthy changes in version 0.4.0 (2002-12-23)
901 ------------------------------------------------
902
903  * Key generation returns the fingerprint of the generated key.
904
905  * New convenience function gpgme_get_key.
906
907  * Supports signatures of user IDs in keys via the new
908    GPGME_KEYLIST_MODE_SIGS keylist mode and the
909    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
910    interfaces.  The XML info about a key also includes the signatures
911    if available.
912
913  * New data object interface, which is more flexible and transparent.
914
915  * Interface changes relative to the 0.3.9 release:
916 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
917 GpgmeDataReadCb                 NEW
918 GpgmeDataWriteCb                NEW
919 GpgmeDataSeekCb                 NEW
920 GpgmeDataReleaseCb              NEW
921 GpgmeDataCbs                    NEW
922 gpgme_data_read                 CHANGED: Match read() closely.
923 gpgme_data_write                CHANGED: Match write() closely.
924 gpgme_data_seek                 NEW
925 gpgme_data_new_from_fd          NEW
926 gpgme_data_new_from_stream      NEW
927 gpgme_data_new_from_cbs         NEW
928 gpgme_data_rewind               DEPRECATED: Replaced by gpgme_data_seek().
929 gpgme_data_new_from_read_cb     DEPRECATED: Replaced by gpgme_data_from_cbs().
930 gpgme_data_get_type             REMOVED: No replacement.
931 gpgme_op_verify                 CHANGED: Take different data objects for
932                                 signed text and plain text.
933 gpgme_op_verify_start           CHANGED: See gpgme_op_verify.
934 gpgme_check_engine              REMOVED: Deprecated since 0.3.0.
935 gpgme_op_genkey                 CHANGED: New parameter FPR.
936 GPGME_KEYLIST_MODE_SIGS         NEW
937 gpgme_key_sig_get_string_attr   NEW
938 gpgme_key_sig_get_ulong_attr    NEW
939 gpgme_get_key                   NEW
940 GPGME_ATTR_SIG_CLASS            NEW
941 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
942
943 Noteworthy changes in version 0.3.16 (2003-11-19)
944 -------------------------------------------------
945
946  * Compatibility fixes for GnuPG 1.9.x
947
948 Noteworthy changes in version 0.3.15 (2003-02-18)
949 -------------------------------------------------
950
951  * The progress status is sent via the progress callbacks in
952    gpgme_op_edit.
953
954  * Bug fix for signing operations with explicit signer settings for
955    the CMS protocol.
956
957 Noteworthy changes in version 0.3.14 (2002-12-04)
958 -------------------------------------------------
959
960  * GPGME-Plug is now in its own package "cryptplug".
961
962  * Workaround for a setlocale problem.  Fixed a segv related to not
963    correctly as closed marked file descriptors.
964
965 Noteworthy changes in version 0.3.13 (2002-11-20)
966 -------------------------------------------------
967
968  * Release due to changes in gpgmeplug.
969
970 Noteworthy changes in version 0.3.12 (2002-10-15)
971 -------------------------------------------------
972
973  * Fixed some bux with key listings.  
974
975  * The development has been branched to clean up some API issues.
976    This 0.3 series will be kept for compatibility reasons; so do don't
977    expect new features.
978
979 Noteworthy changes in version 0.3.11 (2002-09-20)
980 -------------------------------------------------
981         
982  * Bug fixes.
983
984 Noteworthy changes in version 0.3.10 (2002-09-02)
985 -------------------------------------------------
986
987  * Setting the signing keys for the CMS protocol does now work.
988
989  * The signers setting is honoured by gpgme_op_edit.
990
991 Noteworthy changes in version 0.3.9 (2002-08-21)
992 ------------------------------------------------
993
994  * A spec file for creating RPMs has been added.
995
996  * An experimental interface to GnuPG's --edit-key functionality is
997    introduced, see gpgme_op_edit.
998
999  * The new gpgme_import_ext function provides a convenient access to
1000    the number of processed keys.
1001
1002  * Interface changes relative to the 0.3.8 release:
1003 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1004 GpgmeStatusCode                 NEW
1005 GpgmeEditCb                     NEW
1006 gpgme_op_edit_start             NEW
1007 gpgme_op_edit                   NEW
1008 gpgme_op_import_ext             NEW
1009 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1010
1011 Noteworthy changes in version 0.3.8 (2002-06-25)
1012 ------------------------------------------------
1013
1014  * It is possible to use an outside event loop for the I/O to the
1015    crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
1016
1017  * Interface changes relative to the 0.3.6 release:
1018 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1019 GpgmeIOCb                       NEW
1020 GpgmeRegisterIOCb               NEW
1021 GpgmeRemoveIOCb                 NEW
1022 GpgmeEventIO                    NEW
1023 GpgmeEventIOCb                  NEW
1024 struct GpgmeIOCbs               NEW
1025 gpgme_set_io_cbs                NEW
1026 gpgme_get_io_cbs                NEW
1027 GPGME_ATTR_ERRTOK               NEW
1028 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1029
1030 Noteworthy changes in version 0.3.7 (2002-06-04)
1031 ------------------------------------------------
1032
1033  * GPGME_ATTR_OTRUST is implemented now.
1034
1035  * A first step toward thread safeness has been achieved, see the
1036    documentation for details.  Supported thread libraries are pthread
1037    and Pth.
1038
1039 Noteworthy changes in version 0.3.6 (2002-05-03)
1040 ------------------------------------------------
1041
1042  * All error output of the gpgsm backend is send to the bit bucket.
1043
1044  * The signature verification functions are extended.  Instead of
1045    always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
1046    expired signatures.  2 new functions may be used to retrieve more
1047    detailed information like the signature expiration time and a
1048    validity information of the key without an extra key looking.
1049
1050  * The current passphrase callback and progress meter callback can be
1051    retrieved with the new functions gpgme_get_passphrase_cb and
1052    gpgme_get_progress_cb respectively.
1053
1054  * Interface changes relative to the 0.3.5 release:
1055 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1056 gpgme_get_passphrase_cb         NEW
1057 gpgme_get_progress_cb           NEW
1058 GpgmeDataEncoding               NEW
1059 gpgme_data_set_encoding         NEW
1060 gpgme_data_get_encoding         NEW
1061 GPGME_SIG_STAT_GOOD_EXP         NEW
1062 GPGME_SIG_STAT_GOOD_EXPKEY      NEW
1063 gpgme_op_verify                 CHANGED: Returns more status codes.
1064 GPGME_ATTR_SIG_STATUS           NEW
1065 gpgme_get_sig_string_attr       NEW
1066 gpgme_get_sig_ulong_attr        NEW
1067 gpgme_get_protocol              NEW
1068 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1069
1070 Noteworthy changes in version 0.3.5 (2002-04-01)
1071 ------------------------------------------------
1072
1073  * gpgme_op_encrypt can be called with RECIPIENTS being 0.  In this
1074    case, symmetric encryption is performed.  Note that this requires a
1075    passphrase from the user.
1076
1077  * More information is returned for X.509 certificates.
1078
1079  * Interface changes relative to the 0.3.4 release:
1080 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1081 gpgme_op_encrypt                EXTENDED: Symmetric encryption possible
1082 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1083
1084 Noteworthy changes in version 0.3.4 (2002-03-04)
1085 ------------------------------------------------
1086
1087  * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
1088    some recipients have been invalid, whereas earlier versions
1089    succeeded in this case.  The plaintext is still encrypted for all valid
1090    recipients, so the application might take this error as a hint that
1091    the ciphertext is not usable for all requested recipients.
1092    Information about invalid recipients is available with gpgme_get_op_info.
1093
1094  * gpgme_op_verify now allows to pass an uninitialized data object as
1095    its plaintext argument to check for normal and cleartext
1096    signatures.  The plaintext is then returned in the data object.
1097
1098  * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
1099    to set and get the number of certifications to include in S/MIME
1100    signed messages.
1101
1102  * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
1103    to encrypt and sign a message in a combined operation.
1104
1105  * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
1106
1107  * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
1108
1109  * Interface changes relative to the 0.3.3 release:
1110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1111 gpgme_op_encrypt                CHANGED: Can fail with GPGME_Invalid_Recipients
1112 gpgme_op_verify                 EXTENDED: Accepts uninitialized text argument
1113 gpgme_key_get_ulong_attr        EXTENDED: Supports GPGME_ATTR_EXPIRE
1114 gpgme_set_include_certs         NEW
1115 gpgme_get_include_certs         NEW
1116 gpgme_op_encrypt_sign           NEW
1117 gpgme_op_encrypt_sign_start     NEW
1118 gpgme_op_keylist_ext_start      NEW
1119 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1120
1121 Noteworthy changes in version 0.3.3 (2002-02-12)
1122 ------------------------------------------------
1123
1124  * Fix the Makefile in jnlib.
1125
1126  * Fix the test suite (hopefully).  It should clean up all its state
1127    with `make check' now.
1128
1129
1130 Noteworthy changes in version 0.3.2 (2002-02-10)
1131 ------------------------------------------------
1132
1133  * Remove erroneous dependency on libgcrypt in jnlib.
1134
1135
1136 Noteworthy changes in version 0.3.1 (2002-02-09)
1137 ------------------------------------------------
1138
1139  * There is a Texinfo manual documenting the API.
1140
1141  * The gpgme_set_keylist_mode function returns an error, and changed
1142    its meaning.  It is no longer usable to select between normal and
1143    fast mode (newer versions of GnuPG will always be fast), but
1144    selects between local keyring, remote keyserver, or both.
1145    For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
1146    and GPGME_KEYLIST_MODE_EXTERN.  To make it possible to modify the
1147    current setting, a fucntion gpgme_get_keylist_mode was added to
1148    retrieve the current mode.
1149
1150  * gpgme_wait accepts a new argument STATUS to return the error status
1151    of the operation on the context.  Its definition is closer to
1152    waitpid() now than before.
1153
1154  * The LENGTH argument to gpgme_data_new_from_filepart changed its
1155    type from off_t to the unsigned size_t.
1156
1157  * The R_HD argument to the GpgmePassphraseCb type changed its type
1158    from void* to void**.
1159
1160  * New interface gpgme_op_trustlist_end() to match
1161    gpgme_op_keylist_end().
1162
1163  * The CryptPlug modules have been renamed to gpgme-openpgp and
1164    gpgme-smime, and they are installed in pkglibdir by `make install'.
1165
1166  * An idle function can be registered with gpgme_register_idle().
1167
1168  * The GpgSM backend supports key generation with gpgme_op_genkey().
1169
1170  * Interface changes relative to the 0.3.0 release:
1171 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1172 gpgme_data_new_from_filepart    CHANGED: Type of LENGTH is size_t.
1173 GpgmePassphraseCb               CHANGED: Type of R_HD is void **.
1174 gpgme_wait                      CHANGED: New argument STATUS.
1175 gpgme_set_keylist_mode          CHANGED: Type of return value is GpgmeError.
1176                                 The function has a new meaning!
1177 gpgme_get_keylist_mode          NEW
1178 GPGME_KEYLIST_MODE_LOCAL        NEW
1179 GPGME_KEYLIST_MODE_EXTERN       NEW
1180 gpgme_op_trustlist_next         NEW
1181 GpgmeIdleFunc                   NEW
1182 gpgme_register_idle             NEW
1183 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1184
1185 Noteworthy changes in version 0.3.0 (2001-12-19)
1186 ------------------------------------------------
1187  
1188  * New interface gpgme_set_protocol() to set the protocol and thus the
1189    crypto engine to be used by the context.  Currently, the OpenPGP
1190    and the CMS protocols are supported.  They are specified by the new
1191    preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
1192    A new context uses the OpenPGP engine by default.
1193
1194  * gpgme_get_engine_info() returns information for all crypto engines
1195    compiled into the library.  The XML format has changed.  To
1196    reliably get the version of a crypto engine, the <version> tag
1197    after the appropriate <protocol> tag has to be looked for.
1198
1199  * New interface gpgme_engine_check_version(), obsoleting
1200    gpgme_check_engine().  Check the version of all engines you are
1201    supporting in your software.
1202
1203  * GpgmeKey lists the user ids in the order as they are returned by
1204    GnuPG, first the primary key with index 0, then the sub-user ids.
1205
1206  * New operation gpgme_op_decrypt_verify() to decrypt and verify
1207    signatures simultaneously.
1208
1209  * The new interface gpgme_op_keylist_end() terminates a pending
1210    keylist operation.  A keylist operation is also terminated when
1211    gpgme_op_keylist_next() returns GPGME_EOF.
1212
1213  * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
1214    cross-compiled, or even compiled without support for GnuPG
1215    (`--without-gpg').
1216
1217  * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
1218    `--with-gpgsm=PATH').  It is enabled by default if the `gpgsm' is found
1219    in the path, but it can also be compiled without support for GpgSM
1220    (`--without-gpgsm').
1221
1222  * CryptPlug modules for GPGME are included and can be enabled at
1223    configure time (`--enable-gpgmeplug').  There is one module which
1224    uses the GnuPG engine (`gpgmeplug') and one module which uses the
1225    GpgSM engine (`gpgsmplug').
1226
1227  * Interface changes relative to the latest 0.2.x release:
1228 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1229 gpgme_key_get_as_xml            CHANGED: Sub-user ids reversed in order.
1230 gpgme_key_get_string_attr       CHANGED: User ids reversed in order.
1231 gpgme_key_get_ulong_attr        CHANGED: User ids reversed in order.
1232 gpgme_get_engine_info           CHANGED: New format, extended content.
1233 gpgme_engine_check_version      NEW
1234 gpgme_decrypt_verify_start      NEW
1235 gpgme_decrypt_verify            NEW
1236 gpgme_op_keylist_next           NEW
1237 gpgme_set_protocol              NEW
1238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1239
1240
1241 Noteworthy changes in version 0.2.3 (2001-09-17)
1242 ------------------------------------------------
1243
1244  * New function gpgme_get_op_info which can be used to get the micalg
1245    parameter needed for MOSS.
1246
1247  * New functions gpgme_get_armor and gpgme_get_textmode.
1248
1249  * The usual bug fixes and some minor functionality improvements.
1250
1251  * Added a simple encryption component for MS-Windows; however the
1252    build procedure might have some problems.
1253
1254
1255 Noteworthy changes in version 0.2.2 (2001-06-12)
1256 ------------------------------------------------
1257  
1258  * Implemented a key cache.
1259
1260  * Fixed a race condition under W32 and some other bug fixes.
1261
1262
1263 Noteworthy changes in version 0.2.1 (2001-04-02)
1264 ------------------------------------------------
1265
1266  * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
1267
1268  * Handle GnuPG's new key capabilities output and support revocation
1269    et al. attributes
1270
1271  * Made the W32 support more robust.
1272
1273
1274  Copyright 2001, 2002, 2003, 2004, 2005, 2007, 2008 g10 Code GmbH
1275
1276  This file is free software; as a special exception the author gives
1277  unlimited permission to copy and/or distribute it, with or without
1278  modifications, as long as this notice is preserved.
1279
1280  This file is distributed in the hope that it will be useful, but
1281  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
1282  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.