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