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