Add news item for 0.3.15.
[gpgme.git] / NEWS
1 Noteworthy changes in version 0.4.1 (unreleased)
2 ------------------------------------------------
3
4  * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
5
6  * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
7    summary anymore.  Use gpgme_get_sig_status to retrieve the individual stati.
8
9  * GpgmeIOCb changed from a void function to a function returning a
10    GpgmeError value.  However, it will always return 0, so you can
11    safely ignore the return value.
12
13  * A new I/O callback event GPGME_EVENT_START has been added.  The new
14    requirement is that you must wait until this event until you are
15    allowed to call the I/O callback handlers previously registered for
16    this context operation.  Calling I/O callback functions for this
17    context operation before the start event happened is unsafe because
18    it can lead to race conditions in a multi-threaded environment.
19
20  * The idle function feature has been removed.  It was not precisely
21    defined in a multi-threaded environment and is obsoleted by the
22    user I/O callback functions.  If you still need a simple way to
23    call something while waiting on one or multiple asynchronous
24    operations to complete, don't set the HANG flag in gpgme_wait (note
25    that this will return to your program more often than the idle
26    function did).
27
28  * gpgme_wait can return NULL even if hang is true, if an error
29    occurs.  In that case *status contains the error code.
30
31  * gpgme_get_engine_info was radically changed.  Instead an XML
32    string, an info structure of the new type GpgmeEngineInfo is
33    returned.  This makes it easier and more robust to evaluate the
34    information in an application.
35
36  * The new function gpgme_get_protocol_name can be used to convert a
37    GpgmeProtocol value into a string.
38
39  * The GpgmePassphraseCb type now returns a GpgmeError value, and
40    returns the password string in a new parameter.  The gpgme_cancel
41    function has been removed, just return GPGME_Canceled in the
42    passphrase callback directly.
43
44  * Interface changes relative to the 0.4.0 release:
45 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46 GpgmeIOCb                       CHANGED: Return type from void to GpgmeError.
47 GpgmeEventIO                    CHANGED: New event type (all numbers changed).
48 gpgme_key_get_string_attr       CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
49 gpgme_op_verify                 CHANGED: Drop R_STAT argument.
50 gpgme_op_decrypt_verify         CHANGED: Drop R_STAT argument.
51 gpgme_wait                      CHANGED: Can return NULL even if hang is true.
52 GpgmeIdleFunc                   REMOVED
53 gpgme_register_idle             REMOVED
54 GpgmeEngineInfo                 NEW
55 gpgme_get_engine_info           CHANGED: Return info structure instead XML.
56 gpgme_get_protocol_name         NEW
57 GpgmePassphraseCb               CHANGED: Return error value, new argument.
58 gpgme_cancel                    REMOVED: Return error in callback directly.
59 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60
61 Noteworthy changes in version 0.4.0 (2002-12-23)
62 ------------------------------------------------
63
64  * Key generation returns the fingerprint of the generated key.
65
66  * New convenience function gpgme_get_key.
67
68  * Supports signatures of user IDs in keys via the new
69    GPGME_KEYLIST_MODE_SIGS keylist mode and the
70    gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
71    interfaces.  The XML info about a key also includes the signatures
72    if available.
73
74  * New data object interface, which is more flexible and transparent.
75
76  * Interface changes relative to the 0.3.9 release:
77 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78 GpgmeDataReadCb                 NEW
79 GpgmeDataWriteCb                NEW
80 GpgmeDataSeekCb                 NEW
81 GpgmeDataReleaseCb              NEW
82 GpgmeDataCbs                    NEW
83 gpgme_data_read                 CHANGED: Match read() closely.
84 gpgme_data_write                CHANGED: Match write() closely.
85 gpgme_data_seek                 NEW
86 gpgme_data_new_from_fd          NEW
87 gpgme_data_new_from_stream      NEW
88 gpgme_data_new_from_cbs         NEW
89 gpgme_data_rewind               DEPRECATED: Replaced by gpgme_data_seek().
90 gpgme_data_new_from_read_cb     DEPRECATED: Replaced by gpgme_data_from_cbs().
91 gpgme_data_get_type             REMOVED: No replacement.
92 gpgme_op_verify                 CHANGED: Take different data objects for
93                                 signed text and plain text.
94 gpgme_op_verify_start           CHANGED: See gpgme_op_verify.
95 gpgme_check_engine              REMOVED: Deprecated since 0.3.0.
96 gpgme_op_genkey                 CHANGED: New parameter FPR.
97 GPGME_KEYLIST_MODE_SIGS         NEW
98 gpgme_key_sig_get_string_attr   NEW
99 gpgme_key_sig_get_ulong_attr    NEW
100 gpgme_get_key                   NEW
101 GPGME_ATTR_SIG_CLASS            NEW
102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
103
104 Noteworthy changes in version 0.3.15 (2003-02-18)
105 -------------------------------------------------
106
107  * The progress status is sent via the progress callbacks in
108    gpgme_op_edit.
109
110  * Bug fix for signing operations with explicit signer settings for
111    the CMS protocol.
112
113 Noteworthy changes in version 0.3.14 (2002-12-04)
114 -------------------------------------------------
115
116  * GPGME-Plug is now in its own package "cryptplug".
117
118  * Workaround for a setlocale problem.  Fixed a segv related to not
119    correctly as closed marked file descriptors.
120
121 Noteworthy changes in version 0.3.13 (2002-11-20)
122 -------------------------------------------------
123
124  * Release due to changes in gpgmeplug.
125
126 Noteworthy changes in version 0.3.12 (2002-10-15)
127 -------------------------------------------------
128
129  * Fixed some bux with key listings.  
130
131  * The development has been branched to clean up some API issues.
132    This 0.3 series will be kept for compatibility reasons; so do don't
133    expect new features.
134
135 Noteworthy changes in version 0.3.11 (2002-09-20)
136 -------------------------------------------------
137         
138  * Bug fixes.
139
140 Noteworthy changes in version 0.3.10 (2002-09-02)
141 -------------------------------------------------
142
143  * Setting the signing keys for the CMS protocol does now work.
144
145  * The signers setting is honoured by gpgme_op_edit.
146
147 Noteworthy changes in version 0.3.9 (2002-08-21)
148 ------------------------------------------------
149
150  * A spec file for creating RPMs has been added.
151
152  * An experimental interface to GnuPG's --edit-key functionality is
153    introduced, see gpgme_op_edit.
154
155  * The new gpgme_import_ext function provides a convenient access to
156    the number of processed keys.
157
158  * Interface changes relative to the 0.3.8 release:
159 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
160 GpgmeStatusCode                 NEW
161 GpgmeEditCb                     NEW
162 gpgme_op_edit_start             NEW
163 gpgme_op_edit                   NEW
164 gpgme_op_import_ext             NEW
165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
166
167 Noteworthy changes in version 0.3.8 (2002-06-25)
168 ------------------------------------------------
169
170  * It is possible to use an outside event loop for the I/O to the
171    crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
172
173  * Interface changes relative to the 0.3.6 release:
174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175 GpgmeIOCb                       NEW
176 GpgmeRegisterIOCb               NEW
177 GpgmeRemoveIOCb                 NEW
178 GpgmeEventIO                    NEW
179 GpgmeEventIOCb                  NEW
180 struct GpgmeIOCbs               NEW
181 gpgme_set_io_cbs                NEW
182 gpgme_get_io_cbs                NEW
183 GPGME_ATTR_ERRTOK               NEW
184 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
185
186 Noteworthy changes in version 0.3.7 (2002-06-04)
187 ------------------------------------------------
188
189  * GPGME_ATTR_OTRUST is implemented now.
190
191  * A first step toward thread safeness has been achieved, see the
192    documentation for details.  Supported thread libraries are pthread
193    and Pth.
194
195 Noteworthy changes in version 0.3.6 (2002-05-03)
196 ------------------------------------------------
197
198  * All error output of the gpgsm backend is send to the bit bucket.
199
200  * The signature verification functions are extended.  Instead of
201    always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
202    expired signatures.  2 new functions may be used to retrieve more
203    detailed information like the signature expiration time and a
204    validity information of the key without an extra key looking.
205
206  * The current passphrase callback and progress meter callback can be
207    retrieved with the new functions gpgme_get_passphrase_cb and
208    gpgme_get_progress_cb respectively.
209
210  * Interface changes relative to the 0.3.5 release:
211 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
212 gpgme_get_passphrase_cb         NEW
213 gpgme_get_progress_cb           NEW
214 GpgmeDataEncoding               NEW
215 gpgme_data_set_encoding         NEW
216 gpgme_data_get_encoding         NEW
217 GPGME_SIG_STAT_GOOD_EXP         NEW
218 GPGME_SIG_STAT_GOOD_EXPKEY      NEW
219 gpgme_op_verify                 CHANGED: Returns more status codes.
220 GPGME_ATTR_SIG_STATUS           NEW
221 gpgme_get_sig_string_attr       NEW
222 gpgme_get_sig_ulong_attr        NEW
223 gpgme_get_protocol              NEW
224 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
225
226 Noteworthy changes in version 0.3.5 (2002-04-01)
227 ------------------------------------------------
228
229  * gpgme_op_encrypt can be called with RECIPIENTS being 0.  In this
230    case, symmetric encryption is performed.  Note that this requires a
231    passphrase from the user.
232
233  * More information is returned for X.509 certificates.
234
235  * Interface changes relative to the 0.3.4 release:
236 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
237 gpgme_op_encrypt                EXTENDED: Symmetric encryption possible
238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
239
240 Noteworthy changes in version 0.3.4 (2002-03-04)
241 ------------------------------------------------
242
243  * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
244    some recipients have been invalid, whereas earlier versions
245    succeeded in this case.  The plaintext is still encrypted for all valid
246    recipients, so the application might take this error as a hint that
247    the ciphertext is not usable for all requested recipients.
248    Information about invalid recipients is available with gpgme_get_op_info.
249
250  * gpgme_op_verify now allows to pass an uninitialized data object as
251    its plaintext argument to check for normal and cleartext
252    signatures.  The plaintext is then returned in the data object.
253
254  * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
255    to set and get the number of certifications to include in S/MIME
256    signed messages.
257
258  * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
259    to encrypt and sign a message in a combined operation.
260
261  * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
262
263  * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
264
265  * Interface changes relative to the 0.3.3 release:
266 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
267 gpgme_op_encrypt                CHANGED: Can fail with GPGME_Invalid_Recipients
268 gpgme_op_verify                 EXTENDED: Accepts uninitialized text argument
269 gpgme_key_get_ulong_attr        EXTENDED: Supports GPGME_ATTR_EXPIRE
270 gpgme_set_include_certs         NEW
271 gpgme_get_include_certs         NEW
272 gpgme_op_encrypt_sign           NEW
273 gpgme_op_encrypt_sign_start     NEW
274 gpgme_op_keylist_ext_start      NEW
275 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
276
277 Noteworthy changes in version 0.3.3 (2002-02-12)
278 ------------------------------------------------
279
280  * Fix the Makefile in jnlib.
281
282  * Fix the test suite (hopefully).  It should clean up all its state
283    with `make check' now.
284
285
286 Noteworthy changes in version 0.3.2 (2002-02-10)
287 ------------------------------------------------
288
289  * Remove erroneous dependency on libgcrypt in jnlib.
290
291
292 Noteworthy changes in version 0.3.1 (2002-02-09)
293 ------------------------------------------------
294
295  * There is a Texinfo manual documenting the API.
296
297  * The gpgme_set_keylist_mode function returns an error, and changed
298    its meaning.  It is no longer usable to select between normal and
299    fast mode (newer versions of GnuPG will always be fast), but
300    selects between local keyring, remote keyserver, or both.
301    For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
302    and GPGME_KEYLIST_MODE_EXTERN.  To make it possible to modify the
303    current setting, a fucntion gpgme_get_keylist_mode was added to
304    retrieve the current mode.
305
306  * gpgme_wait accepts a new argument STATUS to return the error status
307    of the operation on the context.  Its definition is closer to
308    waitpid() now than before.
309
310  * The LENGTH argument to gpgme_data_new_from_filepart changed its
311    type from off_t to the unsigned size_t.
312
313  * The R_HD argument to the GpgmePassphraseCb type changed its type
314    from void* to void**.
315
316  * New interface gpgme_op_trustlist_end() to match
317    gpgme_op_keylist_end().
318
319  * The CryptPlug modules have been renamed to gpgme-openpgp and
320    gpgme-smime, and they are installed in pkglibdir by `make install'.
321
322  * An idle function can be registered with gpgme_register_idle().
323
324  * The GpgSM backend supports key generation with gpgme_op_genkey().
325
326  * Interface changes relative to the 0.3.0 release:
327 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
328 gpgme_data_new_from_filepart    CHANGED: Type of LENGTH is size_t.
329 GpgmePassphraseCb               CHANGED: Type of R_HD is void **.
330 gpgme_wait                      CHANGED: New argument STATUS.
331 gpgme_set_keylist_mode          CHANGED: Type of return value is GpgmeError.
332                                 The function has a new meaning!
333 gpgme_get_keylist_mode          NEW
334 GPGME_KEYLIST_MODE_LOCAL        NEW
335 GPGME_KEYLIST_MODE_EXTERN       NEW
336 gpgme_op_trustlist_next         NEW
337 GpgmeIdleFunc                   NEW
338 gpgme_register_idle             NEW
339 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
340
341 Noteworthy changes in version 0.3.0 (2001-12-19)
342 ------------------------------------------------
343  
344  * New interface gpgme_set_protocol() to set the protocol and thus the
345    crypto engine to be used by the context.  Currently, the OpenPGP
346    and the CMS protocols are supported.  They are specified by the new
347    preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
348    A new context uses the OpenPGP engine by default.
349
350  * gpgme_get_engine_info() returns information for all crypto engines
351    compiled into the library.  The XML format has changed.  To
352    reliably get the version of a crypto engine, the <version> tag
353    after the appropriate <protocol> tag has to be looked for.
354
355  * New interface gpgme_engine_check_version(), obsoleting
356    gpgme_check_engine().  Check the version of all engines you are
357    supporting in your software.
358
359  * GpgmeKey lists the user ids in the order as they are returned by
360    GnuPG, first the primary key with index 0, then the sub-user ids.
361
362  * New operation gpgme_op_decrypt_verify() to decrypt and verify
363    signatures simultaneously.
364
365  * The new interface gpgme_op_keylist_end() terminates a pending
366    keylist operation.  A keylist operation is also terminated when
367    gpgme_op_keylist_next() returns GPGME_EOF.
368
369  * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
370    cross-compiled, or even compiled without support for GnuPG
371    (`--without-gpg').
372
373  * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
374    `--with-gpgsm=PATH').  It is enabled by default if the `gpgsm' is found
375    in the path, but it can also be compiled without support for GpgSM
376    (`--without-gpgsm').
377
378  * CryptPlug modules for GPGME are included and can be enabled at
379    configure time (`--enable-gpgmeplug').  There is one module which
380    uses the GnuPG engine (`gpgmeplug') and one module which uses the
381    GpgSM engine (`gpgsmplug').
382
383  * Interface changes relative to the latest 0.2.x release:
384 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
385 gpgme_key_get_as_xml            CHANGED: Sub-user ids reversed in order.
386 gpgme_key_get_string_attr       CHANGED: User ids reversed in order.
387 gpgme_key_get_ulong_attr        CHANGED: User ids reversed in order.
388 gpgme_get_engine_info           CHANGED: New format, extended content.
389 gpgme_engine_check_version      NEW
390 gpgme_decrypt_verify_start      NEW
391 gpgme_decrypt_verify            NEW
392 gpgme_op_keylist_next           NEW
393 gpgme_set_protocol              NEW
394 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
395
396
397 Noteworthy changes in version 0.2.3 (2001-09-17)
398 ------------------------------------------------
399
400  * New function gpgme_get_op_info which can be used to get the micalg
401    parameter needed for MOSS.
402
403  * New functions gpgme_get_armor and gpgme_get_textmode.
404
405  * The usual bug fixes and some minor functionality improvements.
406
407  * Added a simple encryption component for MS-Windows; however the
408    build procedure might have some problems.
409
410
411 Noteworthy changes in version 0.2.2 (2001-06-12)
412 ------------------------------------------------
413  
414  * Implemented a key cache.
415
416  * Fixed a race condition under W32 and some other bug fixes.
417
418
419 Noteworthy changes in version 0.2.1 (2001-04-02)
420 ------------------------------------------------
421
422  * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
423
424  * Handle GnuPG's new key capabilities output and support revocation
425    et al. attributes
426
427  * Made the W32 support more robust.
428
429
430  Copyright 2001, 2002 g10 Code GmbH
431
432  This file is free software; as a special exception the author gives
433  unlimited permission to copy and/or distribute it, with or without
434  modifications, as long as this notice is preserved.
435
436  This file is distributed in the hope that it will be useful, but
437  WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
438  implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.