1 Noteworthy changes in version 1.1.0 (unreleased)
2 ------------------------------------------------
4 * You can now configure the backend engine file name and home
5 directory to be used, as default and per context.
7 * Previousy, GPGME would use a default "include certs" of 1. This
8 has been changed. Now GPGME will use the crypto backend engines
9 default unless you set the value with gpgme_set_include_certs()
10 explicitely. A new macro GPGME_INCLUDE_CERTS_DEFAULT can be used
11 as a value to explicitely request the new default behaviour.
13 Because the default changes, this is a slight change of the API
14 semantics. We consider it to be a bug fix.
16 * Information about the recipients of an encrypted text is now
17 available at decryption time.
19 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 gpgme_set_engine_info NEW
21 gpgme_ctx_get_engine_info NEW
22 gpgme_ctx_set_engine_info NEW
23 gpgme_set_include_certs CHANGED DEFAULT
24 GPGME_INCLUDE_CERTS_DEFAULT NEW
26 gpgme_decrypt_result_t EXTENDED: New field recipients.
27 GPGME_STATUS_SIG_SUBPACKET NEW
28 GPGME_STATUS_NEED_PASSPHRASE_PIN NEW
29 GPGME_STATUS_SC_OP_FAILURE NEW
30 GPGME_STATUS_SC_OP_SUCCESS NEW
31 GPGME_STATUS_CARDCTRL NEW
32 GPGME_STATUS_BACKUP_KEY_CREATED NEW
33 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36 Noteworthy changes in version 1.0.2 (2004-12-28)
37 ------------------------------------------------
39 * Changed the license of the library to the GNU Lesser General Public
40 License (LGPL), version 2.1 or later.
43 Noteworthy changes in version 1.0.1 (2004-10-22)
44 ------------------------------------------------
49 Noteworthy changes in version 1.0.0 (2004-09-30)
50 ------------------------------------------------
52 * Version 1.0.0! We are proud to present you with a thoroughly
53 tested and stable version of the GPGME library. A big Thank You!
54 to all the people who made this possible.
56 The development will be branched into a stable 1.x.y series and the
59 * The gpgme.m4 macro supports checking the API version. Just prepend
60 it to the required version string, separated by a colon. For
61 example, this release has the version "1:1.0.0". The last release
62 to which this version is (mostly) ABI compatible is "1:0.4.2",
63 which is the default required version.
66 Noteworthy changes in version 0.9.0 (2004-06-08)
67 ------------------------------------------------
69 * The type gpgme_key_t has now a new field keylist_mode that contains
70 the keylist mode that was active at the time the key was retrieved.
72 * The type gpgme_decrypt_result_t has a new field "wrong_key_usage"
73 that contains a flag indicating that the key should not have been
76 * Verifying a signature of a revoked key gives the correct result now
77 (GPG_ERR_CERT_REVOKED error code).
79 * Clarified that the error code GPG_ERR_NO_DATA from the decrypt &
80 verify operations still allows you to look at the signature
83 * Clarified that patterns in keylisting operations have an upper
84 limit, and thus are not suited to list many keys at once by their
85 fingerprint. Also improve the error message if the pattern is too
86 long for the CMS protocol to handle.
88 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
89 gpgme_key_t EXTENDED: New field keylist_mode.
90 gpgme_decrypt_result_t EXTENDED: New field wrong_key_usage.
91 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94 Noteworthy changes in version 0.4.7 (2004-04-29)
95 ------------------------------------------------
97 * Correctly initialize the fields expired, revoked, invalid, and
98 disabled in the gpgme_key_t structures.
100 * A bug fix: The flag wrong_key_usage of gpgme_signature_t was
101 accidently of type int instead unsigned int.
103 * Interface changes relative to the 0.4.5 release:
104 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
105 gpgme_signature_t CHANGED: wrong_key_usage is unsigned int now.
106 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
108 Noteworthy changes in version 0.4.6 (2004-04-06)
109 ------------------------------------------------
114 Noteworthy changes in version 0.4.5 (2004-03-07)
115 ------------------------------------------------
117 * GPGME is now compiled with LFS (large file support) by default.
118 This means that _all_ programs using GPGME must be compiled with
119 LFS support enabled by default. You can do this easily with
120 autoconf, by using the AC_SYS_LARGEFILE macro. Or you can do this
121 without autoconf by defining the preprocessor symbol
122 _FILE_OFFSET_BITS to 64 (by passing the -D_FILE_OFFSET_BITS=64 to
123 the C compiler command line, or by defining this preprocessor
124 symbol before including any system header files). For more
125 details, read the section on LFS in the manual.
127 Up to now, it was undocumented that GPGME was not using LFS.
128 But the public interfaces use off_t, and file descriptors are
129 exchanged between the application and GPGME. This was an oversight,
130 and bound to cause troubles in the future.
132 Writing GPGME as a dual mode library that seamlessly supports LFS
133 while keeping backwards compatibility is possible, but does not
134 solve the problem: Many applications already expect GPGME to have
135 LFS (they are compiled with off_t being a 64bit value). This is true
136 in particular for the popular Gtk+ and Qt programs.
138 So, although this is an ABI (but not an API) break, we will not
139 change the library version to reflect that. Because the interfaces
140 affected are probably not used yet in any GPGME 0.4 based
141 application, we don't expect any real failures from this change.
142 In fact, applications already using LFS will have some subtle bugs
145 However, if you encounter an application using GPGME 0.4.x that
146 does _not_ use LFS by default (off_t is a 32bit value), _and_
147 uses at least one of the functions gpgme_data_seek,
148 gpgme_data_new_from_filepart, or a gpgme_data_seek_cb_t with
149 gpgme_data_new_from_cbs, then indeed this library will be ABI
150 incompatible with the program. As said above, we don't believe
151 such a program exists. If we are in error, then you have two
152 options: As a quick hack, you can configure GPGME with the
153 --disable-largefile option. This will revert the change, and GPGME
154 will not use LFS. However, GPGME will be incompatible with
155 programs that expect GPGME to use LFS. All applications are
156 required to use LFS when using GPGME, so this is only good as a
157 temporary local work-around.
159 The other option is to change the versioning of the library and
160 recompile all applications. We have reserved a special version of
161 the library for that, so you can do that without expecting a
162 version clash in the future. Furthermore, everyone who does this
163 will agree on the version to use (this is important for
164 distribution makers). Read the comment in configure.ac (before
165 LIBGPGME_LT_AGE) if you want to do this. Please don't do this
166 blindly: As stated above, we think it is unlikely this measure is
167 needed. Still, it is there if necessary. If in doubt, contact us
168 and we will give our advise for your specific situation.
170 * New key listing mode GPGME_KEYLIST_MODE_VALIDATE for validation of
173 * New interface gpgme_cancel() that can be used to cancel
174 asynchronous operations.
176 * Interface changes relative to the 0.4.4 release:
177 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
178 gpgme_data_seek_cb_t CHANGED: off_t is now a largefile type.
179 gpgme_data_seek CHANGED: off_t is now a largefile type.
180 gpgme_data_new_from_filepart CHANGED: off_t is now a largefile type.
181 GPGME_KEYLIST_MODE_VALIDATE NEW
183 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
185 Noteworthy changes in version 0.4.4 (2004-01-12)
186 ------------------------------------------------
188 * The member "class" in gpgme_key_sig_t and gpgme_new_signature_t has
189 been renamed to "sig_class", to avoid clash with C++ compilers. In
190 the C API, the old name "class" has been preserved for backwards
191 compatibility, but is deprecated.
193 * Interface changes relative to the 0.4.3 release:
194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
195 gpgme_key_sig_t CHANGED: class deprecated, use new sig_class.
196 gpgme_new_signature_t CHANGED: class deprecated, use new sig_class.
197 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
199 Noteworthy changes in version 0.4.3 (2003-10-06)
200 ------------------------------------------------
202 * libgpgme should not be used for threaded programs anymore. This
203 never worked reliably in all cases, because you had to
204 be careful about the linking order and libtool wouldn't do that for
205 you automatically. Instead, now you have to link against
206 libgpgme-pthread for applications using pthread and libgpgme-pth for
207 applications using GNU Pth.
209 The old code for automagically detecting the thread library is
210 still part of libgpgme, but it is DEPRECATED.
212 * There are new automake macros AM_PATH_GPGME_PTH and
213 AM_PATH_GPGME_PTHREAD, which support checking for thread-enabled
214 versions of GPGME. They define GPGME_PTH_CFLAGS, GPGME_PTH_LIBS,
215 GPGME_PTHREAD_CFLAGS and GPGME_PTHREAD_LIBS respectively. These
216 variables of course also include the configuration for the thread
217 package itself. Alternatively, use libtool.
219 * gpgme_strerror_r as a thread safe variant of gpgme_strerror was
222 * gpgme-config doesn't support setting the prefix or exec prefix
223 anymore. I don't think it ever worked correctly, and it seems to
226 * gpgme_get_key fails with GPG_ERR_AMBIGUOUS_NAME if the key ID
227 provided was not unique, instead returning the first matching key.
229 * gpgme_key_t and gpgme_subkey_t have a new field, can_authenticate,
230 that indicates if the key can be used for authentication.
232 * gpgme_signature_t's status field is now correctly set to an error
233 with error code GPG_ERR_NO_PUBKEY if public key is not found.
235 * gpgme_new_signature_t's class field is now an unsigned int, rather
236 than an unsigned long (the old class field is preserved for
237 backwards compatibility).
239 * A new function gpgme_set_locale() is provided to allow configuring
240 the locale for the crypto backend. This is necessary for text
241 terminals so that programs like the pinentry can be started with
242 the right locale settings for the terminal the application is running
243 on, in case the terminal has different settings than the system
244 default (for example, if it is a remote terminal). You are highly
245 recommended to call the following functions directly after
250 setlocale (LC_ALL, "");
251 gpgme_set_locale (NULL, LC_CTYPE, setlocale (LC_CTYPE, NULL));
252 gpgme_set_locale (NULL, LC_MESSAGES, setlocale (LC_MESSAGES, NULL));
254 GPGME can not do this for you, as setlocale is not thread safe, and
255 there is no alternative.
257 * The signal action for SIGPIPE is now set to SIG_IGN by
258 gpgme_check_version, instead the first time a crypto engine is
259 started (which is not well defined).
261 * In the output of gpgme_hash_algo_name, change RMD160 to RIPEMD160,
262 TIGER to TIGER192, CRC32-RFC1510 to CRC32RFC1510, and CRC24-RFC2440
263 to CRC24RFC2440. For now, these strings can be used as the MIC
264 parameter for PGP/MIME (if appropriately modified).
266 * Interface changes relative to the 0.4.2 release:
267 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
269 gpgme_get_key CHANGED: Fails correctly if key ID not unique.
270 gpgme_key_t EXTENDED: New field can_authenticate.
271 gpgme_subkey_t EXTENDED: New field can_authenticate.
272 gpgme_new_signature_t CHANGED: New type for class field.
274 gpgme_hash_algo_name CHANGED: Slight adjustment of algo names.
275 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
277 Noteworthy changes in version 0.4.2 (2003-07-30)
278 ------------------------------------------------
280 * Allow gpg-error to be in non-standard place when linking the test suite.
282 * Configure will fail now if gpg-error can not be found.
284 * Fixed initialized memory backed data objects for writing, which
285 caused the test program to crash (but only on Mac OS, surprisingly).
287 * Eliminate use of C99 constructs.
289 * Small improvements to the manual.
292 Noteworthy changes in version 0.4.1 (2003-06-06)
293 ------------------------------------------------
295 This is the release that 0.4.0 should have been. There are many
296 interface changes, please see below for the details. The changes are
297 sometimes the result of new functionality, but more often express a
298 paradigm shift. Others are an overdue cleanup to get GPGME in line
299 with the GNU coding standards and to make the interface more
300 self-consistent. Here is an overview on the changes:
302 All types have been renamed to conform to the GNU coding standards,
303 most of the time by keeping the whole name in lowercase and inserting
304 underscores between words.
306 All operations consistently only accept input parameters in their
307 invocation function, and return only an error code directly. Further
308 information about the result of the operation has to be retrieved
309 afterwards by calling one of the result functions. This unifies the
310 synchronous and the asynchronous interface.
312 The error values have been completely replaced by a more
313 sophisticated model that allows GPGME to transparently and accurately
314 report all errors from the other GnuPG components, irregardless of
315 process boundaries. This is achieved by using the library
316 libgpg-errors, which is shared by all GnuPG components. This library
317 is now required for GPGME.
319 The results of all operations are now provided by pointers to C
320 structs rather than by XML structs or in other ways.
322 Objects which used to be opaque (for example a key) are now pointers
323 to accessible structs, so no accessor functions are necessary.
325 Backward compatibility is provided where it was possible without too
326 much effort and did not collide with the overall sanitization effort.
327 However, this is only for ease of transition. NO DEPRECATED FUNCTION
328 OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND WILL BE
329 DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE LIBRARY.
330 Recommendations how to replace deprecated or removed functionality
331 can be found within the description of each change.
333 What follows are all changes to the interface and behaviour of GPGME
336 * If gpgme.h is included in sources compiled by GCC 3.1 or later,
337 deprecated attributes will warn about use of obsolete functions and
338 type definitions. You can suppress these warnings by passing
339 -Wno-deprecated-declarations to the gcc command.
341 * The following types have been renamed. The old types are still
342 available as aliases, but they are deprecated now:
345 GpgmeData gpgme_data_t
346 GpgmeError gpgme_error_t
347 GpgmeDataEncoding gpgme_data_encoding_t
348 GpgmeSigStat gpgme_sig_stat_t
349 GpgmeSigMode gpgme_sig_mode_t
350 GpgmeAttr gpgme_attr_t
351 GpgmeValidity gpgme_validity_t
352 GpgmeProtocol gpgme_protocol_t
354 GpgmePassphraseCb gpgme_passphrase_cb_t
355 GpgmeProgressCb gpgme_progress_cb_t
356 GpgmeIOCb gpgme_io_cb_t
357 GpgmeRegisterIOCb gpgme_register_io_cb_t
358 GpgmeRemoveIOCb gpgme_remove_io_cb_t
359 GpgmeEventIO gpgme_event_io_t
360 GpgmeEventIOCb gpgme_event_io_cb_t
361 GpgmeIOCbs gpgme_io_cbs
362 GpgmeDataReadCb gpgme_data_read_cb_t
363 GpgmeDataWriteCb gpgme_data_write_cb_t
364 GpgmeDataSeekCb gpgme_data_seek_cb_t
365 GpgmeDataReleaseCb gpgme_data_release_cb_t
366 GpgmeDataCbs gpgme_data_cbs_t
367 GpgmeTrustItem gpgme_trust_item_t
368 GpgmeStatusCode gpgme_status_code_t
370 * gpgme_error_t is now identical to gpg_error_t, the error type
371 provided by libgpg-error. More about using libgpg-error with GPGME
372 can be found in the manual. All error symbols have been removed!
374 * All functions and types in libgpg-error have been wrapped in GPGME.
375 The new types are gpgme_err_code_t and gpgme_err_source_t. The new
376 functions are gpgme_err_code, gpgme_err_source, gpgme_error,
377 gpgme_err_make, gpgme_error_from_errno, gpgme_err_make_from_errno,
378 gpgme_err_code_from_errno, gpgme_err_code_to_errno,
381 * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
383 * GnuPG 1.2.2 is required. The progress callback is now also invoked
384 for encrypt, sign, encrypt-sign, decrypt, verify, and
385 decrypt-verify operations. For verify operations on detached
386 signatures, the progress callback is invoked for both the detached
387 signature and the plaintext message, though.
389 * gpgme_passphrase_cb_t has been changed to not provide a complete
390 description, but the UID hint, passphrase info and a flag
391 indicating if this is a repeated attempt individually, so the user
392 can compose his own description from this information.
394 The passphrase is not returned as a C string, but must be written
395 to a file descriptor directly. This allows for secure passphrase
398 The return type has been changed to gpgme_error_t value. This
399 allowed to remove the gpgme_cancel function; just return
400 the error code GPG_ERR_CANCELED in the passphrase callback directly.
402 * gpgme_edit_cb_t has been changed to take a file descriptor argument.
403 The user is expected to write the response to the file descriptor,
404 followed by a newline.
406 * The recipients interface has been removed. Instead, you use
407 NULL-terminated lists of keys for specifying the recipients of an
408 encryption operation. Use the new encryption flag
409 GPGME_ENCRYPT_ALWAYS_TRUST if you want to override the validity of
410 the keys (but note that in general this is not a good idea).
412 This change has been made to the prototypes of gpgme_op_encrypt,
413 gpgme_op_encrypt_start, gpgme_op_encrypt_sign and
414 gpgme_op_encrypt_sign_start.
416 The export interface has been changed to use pattern strings like
417 the keylist interface. Thus, new functions gpgme_op_export_ext and
418 gpgme_op_export_ext_start have been added as well. Now the
419 prototypes of gpgme_op_export_start and gpgme_op_export finally
422 * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
423 summary anymore. Use gpgme_get_sig_status to retrieve the individual
426 * gpgme_io_cb_t changed from a void function to a function returning
427 a gpgme_error_t value. However, it will always return 0, so you
428 can safely ignore the return value.
430 * A new I/O callback event GPGME_EVENT_START has been added. The new
431 requirement is that you must wait until this event until you are
432 allowed to call the I/O callback handlers previously registered for
433 this context operation. Calling I/O callback functions for this
434 context operation before the start event happened is unsafe because
435 it can lead to race conditions in a multi-threaded environment.
437 * The idle function feature has been removed. It was not precisely
438 defined in a multi-threaded environment and is obsoleted by the
439 user I/O callback functions. If you still need a simple way to
440 call something while waiting on one or multiple asynchronous
441 operations to complete, don't set the HANG flag in gpgme_wait (note
442 that this will return to your program more often than the idle
445 * gpgme_wait can return NULL even if hang is true, if an error
446 occurs. In that case *status contains the error code.
448 * gpgme_get_engine_info was radically changed. Instead an XML
449 string, an info structure of the new type gpgme_engine_info_t is
450 returned. This makes it easier and more robust to evaluate the
451 information in an application.
453 * The new function gpgme_get_protocol_name can be used to convert a
454 gpgme_protocol_t value into a string.
456 * The status of a context operation is not checked anymore. Starting
457 a new operation will silently cancel the previous one. Calling a
458 function that requires you to have started an operation before without
459 doing so is undefined.
461 * The FPR argument to gpgme_op_genkey was removed. Instead, use the
462 gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
463 pointer to a structure which contains the fingerprint. This also
464 works with gpgme_op_genkey_start. The structure also provides
465 other information about the generated keys.
470 err = gpgme_op_genkey (ctx, NULL, NULL, &fpr);
472 printf ("%s\n", fpr);
476 gpgme_genkey_result_t result;
477 err = gpgme_op_genkey (ctx, NULL, NULL);
480 result = gpgme_op_genkey_result (ctx);
482 printf ("%s\n", result->fpr);
485 * The new gpgme_op_import_result function provides detailed
486 information about the result of an import operation in
487 gpgme_import_result_t and gpgme_import_status_t objects.
488 Thus, the gpgme_op_import_ext variant is deprecated.
490 * The new gpgme_op_sign_result function provides detailed information
491 about the result of a signing operation in gpgme_sign_result_t,
492 gpgme_invalid_key_t and gpgme_new_signature_t objects.
494 * The new gpgme_op_encrypt_result function provides detailed
495 information about the result of an encryption operation in
496 a GpgmeEncryptResult object.
498 * The new gpgme_op_decrypt_result function provides detailed
499 information about the result of a decryption operation in
500 a GpgmeDecryptResult object.
502 * The new gpgme_op_verify_result function provides detailed
503 information about the result of an verify operation in
504 a GpgmeVerifyResult object. Because of this, the GPGME_SIG_STAT_*
505 values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
506 gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
507 and gpgme_get_notation is removed.
509 * GpgmeTrustItem objects have now directly accessible data, so the
510 gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
511 accessor functions are deprecated. Also, reference counting is
512 available through gpgme_trust_item_ref and gpgme_trust_item_unref
513 (the gpgme_trust_item_release alias for the latter is deprecated).
515 * Keys are not cached internally anymore, so the force_update argument
516 to gpgme_get_key has been removed.
518 * GpgmeKey objects have now directly accessible data so the
519 gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
520 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
521 functions are deprecated. Also, gpgme_key_release is now
522 deprecated. The gpgme_key_get_as_xml function has been dropped.
524 * Because all interfaces using attributes are deprecated, the
525 GpgmeAttr data type is also deprecated.
527 * The new gpgme_op_keylist_result function provides detailed
528 information about the result of a key listing operation in
529 a GpgmeKeyListResult object.
531 * Now that each function comes with its own result retrieval
532 interface, the generic gpgme_get_op_info interface is not useful
535 * The type and mode of data objects is not available anymore.
537 * Interface changes relative to the 0.4.0 release:
538 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
539 GpgmeCtx DEPRECATED: Use gpgme_ctx_t.
540 GpgmeData DEPRECATED: Use gpgme_data_t.
541 GpgmeError DEPRECATED: Use gpgme_error_t.
542 GpgmeDataEncoding DEPRECATED: Use gpgme_data_encoding_t.
543 GpgmeSigStat DEPRECATED: Use gpgme_sig_stat_t.
544 GpgmeSigMode DEPRECATED: Use gpgme_sig_mode_t.
545 GpgmeAttr DEPRECATED: Use gpgme_attr_t.
546 GpgmeValidity DEPRECATED: Use gpgme_validity_t.
547 GpgmeProtocol DEPRECATED: Use gpgme_protocol_t.
548 GpgmeKey DEPRECATED: Use gpgme_key_t.
549 GpgmePassphraseCb DEPRECATED: Use gpgme_passphrase_cb_t.
550 GpgmeProgressCb DEPRECATED: Use gpgme_progress_cb_t.
551 GpgmeIOCb DEPRECATED: Use gpgme_io_cb_t.
552 GpgmeRegisterIOCb DEPRECATED: Use gpgme_register_io_cb_t.
553 GpgmeRemoveIOCb DEPRECATED: Use gpgme_remove_io_cb_t.
554 GpgmeEventIO DEPRECATED: Use gpgme_event_io_t.
555 GpgmeEventIOCb DEPRECATED: Use gpgme_event_io_cb_t.
556 GpgmeIOCbs DEPRECATED: Use gpgme_io_cbs.
557 GpgmeDataReadCb DEPRECATED: Use gpgme_data_read_cb_t.
558 GpgmeDataWriteCb DEPRECATED: Use gpgme_data_write_cb_t.
559 GpgmeDataSeekCb DEPRECATED: Use gpgme_data_seek_cb_t.
560 GpgmeDataReleaseCb DEPRECATED: Use gpgme_data_release_cb_t.
561 GpgmeDataCbs DEPRECATED: Use gpgme_data_cbs_t.
562 GpgmeTrustItem DEPRECATED: Use gpgme_trust_item_t.
563 GpgmeStatusCode DEPRECATED: Use gpgme_status_code_t.
566 gpgme_recipients_t NEW
568 gpgme_data_encoding_t NEW
575 gpgme_passphrase_cb_t NEW
576 gpgme_progress_cb_t NEW
578 gpgme_register_io_cb_t NEW
579 gpgme_remove_io_cb_t NEW
581 gpgme_event_io_cb_t NEW
583 gpgme_data_read_cb_t NEW
584 gpgme_data_write_cb_t NEW
585 gpgme_data_seek_cb_t NEW
586 gpgme_data_release_cb_t NEW
588 gpgme_trust_item_t NEW
589 gpgme_status_code_t NEW
590 GPGME_{some error code} REMOVED! Use GPG_ERR_* from libgpg-error.
592 gpgme_err_source_t NEW
597 gpgme_error_from_errno NEW
598 gpgme_err_make_from_errno NEW
599 gpgme_err_code_from_errno NEW
600 gpgme_err_code_to_errno NEW
602 gpgme_io_cb_t CHANGED: Return type from void to GpgmeError.
603 gpgme_event_io_t CHANGED: New event type (all numbers changed).
604 gpgme_passphrase_cb_t CHANGED: Desc decomposed, write directly to FD.
605 gpgme_edit_cb_t CHANGED: Write directly to FD.
606 gpgme_key_get_string_attr CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
607 gpgme_op_verify CHANGED: Drop R_STAT argument.
608 gpgme_op_decrypt_verify CHANGED: Drop R_STAT argument.
609 gpgme_wait CHANGED: Can return NULL even if hang is true.
610 GpgmeIdleFunc REMOVED
611 gpgme_register_idle REMOVED
612 GpgmeRecipients REMOVED
613 gpgme_recipients_new REMOVED
614 gpgme_recipients_release REMOVED
615 gpgme_recipients_add_name REMOVED
616 gpgme_recipients_add_name_with_validity REMOVED
617 gpgme_recipients_count REMOVED
618 gpgme_recipients_enum_open REMOVED
619 gpgme_recipients_enum_read REMOVED
620 gpgme_recipients_enum_close REMOVED
621 gpgme_encrypt_flags_t NEW
622 GPGME_ENCRYPT_ALWAYS_TRUST NEW
623 gpgme_op_encrypt CHANGED: Recipients passed as gpgme_key_t[].
624 gpgme_op_encrypt_start CHANGED: Recipients passed as gpgme_key_t[].
625 gpgme_op_encrypt_sign CHANGED: Recipients passed as gpgme_key_t[].
626 gpgme_op_encrypt_sign_start CHANGED: Recipients passed as gpgme_key_t[].
627 gpgme_op_export_start CHANGED: User IDs passed as patterns.
628 gpgme_op_export CHANGED: User IDs passed as patterns.
629 gpgme_op_export_ext_start NEW
630 gpgme_op_export_ext NEW
631 gpgme_keylist_mode_t NEW
633 gpgme_engine_info_t NEW
634 gpgme_get_engine_info CHANGED: Return info structure instead XML.
635 gpgme_get_protocol_name NEW
636 gpgme_cancel REMOVED: Return error in callback directly.
637 gpgme_op_genkey CHANGED: FPR argument dropped.
638 gpgme_op_genkey_result NEW
639 gpgme_genkey_result_t NEW
640 gpgme_op_import_ext DEPRECATED: Use gpgme_op_import_result.
641 gpgme_op_import_result NEW
642 gpgme_import_status_t NEW
643 gpgme_import_result_t NEW
644 gpgme_pubkey_algo_t NEW
645 gpgme_hash_algo_t NEW
646 gpgme_invalid_key_t NEW
647 gpgme_new_signature_t NEW
648 gpgme_sign_result_t NEW
649 gpgme_op_sign_result NEW
650 gpgme_pubkey_algo_name NEW
651 gpgme_hash_algo_name NEW
652 gpgme_encrypt_result_t NEW
653 gpgme_op_encrypt_result NEW
654 gpgme_decrypt_result_t NEW
655 gpgme_op_decrypt_result NEW
656 gpgme_verify_result_t NEW
657 gpgme_op_verify_result NEW
658 gpgme_get_notation REMOVED: Access verify result directly instead.
659 gpgme_get_sig_key DEPRECATED: Use gpgme_get_key with fingerprint.
660 gpgme_get_sig_ulong_attr DEPRECATED: Use verify result directly.
661 gpgme_get_sig_string_attr DEPRECATED: Use verify result directly.
662 GPGME_SIG_STAT_* DEPRECATED: Use error value in sig status.
663 gpgme_get_sig_status DEPRECATED: Use verify result directly.
664 gpgme_trust_item_t CHANGED: Now has user accessible data members.
665 gpgme_trust_item_ref NEW
666 gpgme_trust_item_unref NEW
667 gpgme_trust_item_release DEPRECATED: Use gpgme_trust_item_unref.
668 gpgme_trust_item_get_string_attr DEPRECATED
669 gpgme_trust_item_get_ulong_attr DEPRECATED
670 gpgme_get_key CHANGED: Removed force_update argument.
674 gpgme_key_t CHANGED: Now has user accessible data members.
675 gpgme_key_get_string_attr DEPRECATED
676 gpgme_key_get_ulong_attr DEPRECATED
677 gpgme_key_sig_get_string_attr DEPRECATED
678 gpgme_key_sig_get_ulong_attr DEPRECATED
679 gpgme_key_get_as_xml REMOVED
680 gpgme_key_list_result_t NEW
681 gpgme_op_keylist_result NEW
682 gpgme_get_op_info REMOVED
683 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
685 Noteworthy changes in version 0.4.0 (2002-12-23)
686 ------------------------------------------------
688 * Key generation returns the fingerprint of the generated key.
690 * New convenience function gpgme_get_key.
692 * Supports signatures of user IDs in keys via the new
693 GPGME_KEYLIST_MODE_SIGS keylist mode and the
694 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
695 interfaces. The XML info about a key also includes the signatures
698 * New data object interface, which is more flexible and transparent.
700 * Interface changes relative to the 0.3.9 release:
701 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
705 GpgmeDataReleaseCb NEW
707 gpgme_data_read CHANGED: Match read() closely.
708 gpgme_data_write CHANGED: Match write() closely.
710 gpgme_data_new_from_fd NEW
711 gpgme_data_new_from_stream NEW
712 gpgme_data_new_from_cbs NEW
713 gpgme_data_rewind DEPRECATED: Replaced by gpgme_data_seek().
714 gpgme_data_new_from_read_cb DEPRECATED: Replaced by gpgme_data_from_cbs().
715 gpgme_data_get_type REMOVED: No replacement.
716 gpgme_op_verify CHANGED: Take different data objects for
717 signed text and plain text.
718 gpgme_op_verify_start CHANGED: See gpgme_op_verify.
719 gpgme_check_engine REMOVED: Deprecated since 0.3.0.
720 gpgme_op_genkey CHANGED: New parameter FPR.
721 GPGME_KEYLIST_MODE_SIGS NEW
722 gpgme_key_sig_get_string_attr NEW
723 gpgme_key_sig_get_ulong_attr NEW
725 GPGME_ATTR_SIG_CLASS NEW
726 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
728 Noteworthy changes in version 0.3.16 (2003-11-19)
729 -------------------------------------------------
731 * Compatibility fixes for GnuPG 1.9.x
733 Noteworthy changes in version 0.3.15 (2003-02-18)
734 -------------------------------------------------
736 * The progress status is sent via the progress callbacks in
739 * Bug fix for signing operations with explicit signer settings for
742 Noteworthy changes in version 0.3.14 (2002-12-04)
743 -------------------------------------------------
745 * GPGME-Plug is now in its own package "cryptplug".
747 * Workaround for a setlocale problem. Fixed a segv related to not
748 correctly as closed marked file descriptors.
750 Noteworthy changes in version 0.3.13 (2002-11-20)
751 -------------------------------------------------
753 * Release due to changes in gpgmeplug.
755 Noteworthy changes in version 0.3.12 (2002-10-15)
756 -------------------------------------------------
758 * Fixed some bux with key listings.
760 * The development has been branched to clean up some API issues.
761 This 0.3 series will be kept for compatibility reasons; so do don't
764 Noteworthy changes in version 0.3.11 (2002-09-20)
765 -------------------------------------------------
769 Noteworthy changes in version 0.3.10 (2002-09-02)
770 -------------------------------------------------
772 * Setting the signing keys for the CMS protocol does now work.
774 * The signers setting is honoured by gpgme_op_edit.
776 Noteworthy changes in version 0.3.9 (2002-08-21)
777 ------------------------------------------------
779 * A spec file for creating RPMs has been added.
781 * An experimental interface to GnuPG's --edit-key functionality is
782 introduced, see gpgme_op_edit.
784 * The new gpgme_import_ext function provides a convenient access to
785 the number of processed keys.
787 * Interface changes relative to the 0.3.8 release:
788 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
791 gpgme_op_edit_start NEW
793 gpgme_op_import_ext NEW
794 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
796 Noteworthy changes in version 0.3.8 (2002-06-25)
797 ------------------------------------------------
799 * It is possible to use an outside event loop for the I/O to the
800 crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
802 * Interface changes relative to the 0.3.6 release:
803 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
805 GpgmeRegisterIOCb NEW
809 struct GpgmeIOCbs NEW
812 GPGME_ATTR_ERRTOK NEW
813 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
815 Noteworthy changes in version 0.3.7 (2002-06-04)
816 ------------------------------------------------
818 * GPGME_ATTR_OTRUST is implemented now.
820 * A first step toward thread safeness has been achieved, see the
821 documentation for details. Supported thread libraries are pthread
824 Noteworthy changes in version 0.3.6 (2002-05-03)
825 ------------------------------------------------
827 * All error output of the gpgsm backend is send to the bit bucket.
829 * The signature verification functions are extended. Instead of
830 always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
831 expired signatures. 2 new functions may be used to retrieve more
832 detailed information like the signature expiration time and a
833 validity information of the key without an extra key looking.
835 * The current passphrase callback and progress meter callback can be
836 retrieved with the new functions gpgme_get_passphrase_cb and
837 gpgme_get_progress_cb respectively.
839 * Interface changes relative to the 0.3.5 release:
840 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
841 gpgme_get_passphrase_cb NEW
842 gpgme_get_progress_cb NEW
843 GpgmeDataEncoding NEW
844 gpgme_data_set_encoding NEW
845 gpgme_data_get_encoding NEW
846 GPGME_SIG_STAT_GOOD_EXP NEW
847 GPGME_SIG_STAT_GOOD_EXPKEY NEW
848 gpgme_op_verify CHANGED: Returns more status codes.
849 GPGME_ATTR_SIG_STATUS NEW
850 gpgme_get_sig_string_attr NEW
851 gpgme_get_sig_ulong_attr NEW
852 gpgme_get_protocol NEW
853 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
855 Noteworthy changes in version 0.3.5 (2002-04-01)
856 ------------------------------------------------
858 * gpgme_op_encrypt can be called with RECIPIENTS being 0. In this
859 case, symmetric encryption is performed. Note that this requires a
860 passphrase from the user.
862 * More information is returned for X.509 certificates.
864 * Interface changes relative to the 0.3.4 release:
865 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
866 gpgme_op_encrypt EXTENDED: Symmetric encryption possible
867 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
869 Noteworthy changes in version 0.3.4 (2002-03-04)
870 ------------------------------------------------
872 * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
873 some recipients have been invalid, whereas earlier versions
874 succeeded in this case. The plaintext is still encrypted for all valid
875 recipients, so the application might take this error as a hint that
876 the ciphertext is not usable for all requested recipients.
877 Information about invalid recipients is available with gpgme_get_op_info.
879 * gpgme_op_verify now allows to pass an uninitialized data object as
880 its plaintext argument to check for normal and cleartext
881 signatures. The plaintext is then returned in the data object.
883 * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
884 to set and get the number of certifications to include in S/MIME
887 * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
888 to encrypt and sign a message in a combined operation.
890 * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
892 * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
894 * Interface changes relative to the 0.3.3 release:
895 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
896 gpgme_op_encrypt CHANGED: Can fail with GPGME_Invalid_Recipients
897 gpgme_op_verify EXTENDED: Accepts uninitialized text argument
898 gpgme_key_get_ulong_attr EXTENDED: Supports GPGME_ATTR_EXPIRE
899 gpgme_set_include_certs NEW
900 gpgme_get_include_certs NEW
901 gpgme_op_encrypt_sign NEW
902 gpgme_op_encrypt_sign_start NEW
903 gpgme_op_keylist_ext_start NEW
904 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
906 Noteworthy changes in version 0.3.3 (2002-02-12)
907 ------------------------------------------------
909 * Fix the Makefile in jnlib.
911 * Fix the test suite (hopefully). It should clean up all its state
912 with `make check' now.
915 Noteworthy changes in version 0.3.2 (2002-02-10)
916 ------------------------------------------------
918 * Remove erroneous dependency on libgcrypt in jnlib.
921 Noteworthy changes in version 0.3.1 (2002-02-09)
922 ------------------------------------------------
924 * There is a Texinfo manual documenting the API.
926 * The gpgme_set_keylist_mode function returns an error, and changed
927 its meaning. It is no longer usable to select between normal and
928 fast mode (newer versions of GnuPG will always be fast), but
929 selects between local keyring, remote keyserver, or both.
930 For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
931 and GPGME_KEYLIST_MODE_EXTERN. To make it possible to modify the
932 current setting, a fucntion gpgme_get_keylist_mode was added to
933 retrieve the current mode.
935 * gpgme_wait accepts a new argument STATUS to return the error status
936 of the operation on the context. Its definition is closer to
937 waitpid() now than before.
939 * The LENGTH argument to gpgme_data_new_from_filepart changed its
940 type from off_t to the unsigned size_t.
942 * The R_HD argument to the GpgmePassphraseCb type changed its type
943 from void* to void**.
945 * New interface gpgme_op_trustlist_end() to match
946 gpgme_op_keylist_end().
948 * The CryptPlug modules have been renamed to gpgme-openpgp and
949 gpgme-smime, and they are installed in pkglibdir by `make install'.
951 * An idle function can be registered with gpgme_register_idle().
953 * The GpgSM backend supports key generation with gpgme_op_genkey().
955 * Interface changes relative to the 0.3.0 release:
956 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
957 gpgme_data_new_from_filepart CHANGED: Type of LENGTH is size_t.
958 GpgmePassphraseCb CHANGED: Type of R_HD is void **.
959 gpgme_wait CHANGED: New argument STATUS.
960 gpgme_set_keylist_mode CHANGED: Type of return value is GpgmeError.
961 The function has a new meaning!
962 gpgme_get_keylist_mode NEW
963 GPGME_KEYLIST_MODE_LOCAL NEW
964 GPGME_KEYLIST_MODE_EXTERN NEW
965 gpgme_op_trustlist_next NEW
967 gpgme_register_idle NEW
968 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
970 Noteworthy changes in version 0.3.0 (2001-12-19)
971 ------------------------------------------------
973 * New interface gpgme_set_protocol() to set the protocol and thus the
974 crypto engine to be used by the context. Currently, the OpenPGP
975 and the CMS protocols are supported. They are specified by the new
976 preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
977 A new context uses the OpenPGP engine by default.
979 * gpgme_get_engine_info() returns information for all crypto engines
980 compiled into the library. The XML format has changed. To
981 reliably get the version of a crypto engine, the <version> tag
982 after the appropriate <protocol> tag has to be looked for.
984 * New interface gpgme_engine_check_version(), obsoleting
985 gpgme_check_engine(). Check the version of all engines you are
986 supporting in your software.
988 * GpgmeKey lists the user ids in the order as they are returned by
989 GnuPG, first the primary key with index 0, then the sub-user ids.
991 * New operation gpgme_op_decrypt_verify() to decrypt and verify
992 signatures simultaneously.
994 * The new interface gpgme_op_keylist_end() terminates a pending
995 keylist operation. A keylist operation is also terminated when
996 gpgme_op_keylist_next() returns GPGME_EOF.
998 * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
999 cross-compiled, or even compiled without support for GnuPG
1002 * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
1003 `--with-gpgsm=PATH'). It is enabled by default if the `gpgsm' is found
1004 in the path, but it can also be compiled without support for GpgSM
1005 (`--without-gpgsm').
1007 * CryptPlug modules for GPGME are included and can be enabled at
1008 configure time (`--enable-gpgmeplug'). There is one module which
1009 uses the GnuPG engine (`gpgmeplug') and one module which uses the
1010 GpgSM engine (`gpgsmplug').
1012 * Interface changes relative to the latest 0.2.x release:
1013 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1014 gpgme_key_get_as_xml CHANGED: Sub-user ids reversed in order.
1015 gpgme_key_get_string_attr CHANGED: User ids reversed in order.
1016 gpgme_key_get_ulong_attr CHANGED: User ids reversed in order.
1017 gpgme_get_engine_info CHANGED: New format, extended content.
1018 gpgme_engine_check_version NEW
1019 gpgme_decrypt_verify_start NEW
1020 gpgme_decrypt_verify NEW
1021 gpgme_op_keylist_next NEW
1022 gpgme_set_protocol NEW
1023 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1026 Noteworthy changes in version 0.2.3 (2001-09-17)
1027 ------------------------------------------------
1029 * New function gpgme_get_op_info which can be used to get the micalg
1030 parameter needed for MOSS.
1032 * New functions gpgme_get_armor and gpgme_get_textmode.
1034 * The usual bug fixes and some minor functionality improvements.
1036 * Added a simple encryption component for MS-Windows; however the
1037 build procedure might have some problems.
1040 Noteworthy changes in version 0.2.2 (2001-06-12)
1041 ------------------------------------------------
1043 * Implemented a key cache.
1045 * Fixed a race condition under W32 and some other bug fixes.
1048 Noteworthy changes in version 0.2.1 (2001-04-02)
1049 ------------------------------------------------
1051 * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
1053 * Handle GnuPG's new key capabilities output and support revocation
1056 * Made the W32 support more robust.
1059 Copyright 2001, 2002, 2003, 2004 g10 Code GmbH
1061 This file is free software; as a special exception the author gives
1062 unlimited permission to copy and/or distribute it, with or without
1063 modifications, as long as this notice is preserved.
1065 This file is distributed in the hope that it will be useful, but
1066 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
1067 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.