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