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