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