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