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