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