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