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