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