1 Noteworthy changes in version 0.4.1 (unreleased)
2 ------------------------------------------------
4 This is the release that 0.4.0 should have been. There are many
5 interface changes, please see below for the details. The changes are
6 sometimes the result of new functionality, but more often express a
7 paradigm shift. Others are an overdue cleanup to get GPGME in line
8 with the GNU coding standards and to make the interface more
9 self-consistent. Here is an overview on the changes:
11 All types have been renamed to conform to the GNU coding standards,
12 most of the time by keeping the whole name in lowercase and inserting
13 underscores between words.
15 All operations consistently only accept input parameters in their
16 invocation function, and return only an error code directly. Further
17 information about the result of the operation has to be retrieved
18 afterwards by calling one of the result functions. This unifies the
19 synchronous and the asynchronous interface.
21 The error values have been completely replaced by a more
22 sophisticated model that allows GPGME to transparently and accurately
23 report all errors from the other GnuPG components, irregardless of
24 process boundaries. This is achieved by using the library
25 libgpg-errors, which is shared by all GnuPG components. This library
26 is now required for GPGME.
28 The results of all operations are now provided by pointers to C
29 structs rather than by XML structs or in other ways.
31 Objects which used to be opaque (for example a key) are now pointers
32 to accessible structs, so no accessor functions are necessary.
34 Backward compatibility is provided where it was possible without too
35 much effort and did not collide with the overall sanitization effort.
36 However, this is only for ease of transition. NO DEPRECATED FUNCTION
37 OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND WILL BE
38 DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE LIBRARY.
39 Recommendations how to replace deprecated or removed functionality
40 can be found within the description of each change.
42 What follows are all changes to the interface and behaviour of GPGME
45 * If gpgme.h is included in sources compiled by GCC 3.1 or later,
46 deprecated attributes will warn about use of obsolete functions and
47 type definitions. You can suppress these warnings by passing
48 -Wno-deprecated-declarations to the gcc command.
50 * The following types have been renamed. The old types are still
51 available as aliases, but they are deprecated now:
54 GpgmeData gpgme_data_t
55 GpgmeError gpgme_error_t
56 GpgmeDataEncoding gpgme_data_encoding_t
57 GpgmeSigStat gpgme_sig_stat_t
58 GpgmeSigMode gpgme_sig_mode_t
59 GpgmeAttr gpgme_attr_t
60 GpgmeValidity gpgme_validity_t
61 GpgmeProtocol gpgme_protocol_t
63 GpgmePassphraseCb gpgme_passphrase_cb_t
64 GpgmeProgressCb gpgme_progress_cb_t
65 GpgmeIOCb gpgme_io_cb_t
66 GpgmeRegisterIOCb gpgme_register_io_cb_t
67 GpgmeRemoveIOCb gpgme_remove_io_cb_t
68 GpgmeEventIO gpgme_event_io_t
69 GpgmeEventIOCb gpgme_event_io_cb_t
70 GpgmeIOCbs gpgme_io_cbs
71 GpgmeDataReadCb gpgme_data_read_cb_t
72 GpgmeDataWriteCb gpgme_data_write_cb_t
73 GpgmeDataSeekCb gpgme_data_seek_cb_t
74 GpgmeDataReleaseCb gpgme_data_release_cb_t
75 GpgmeDataCbs gpgme_data_cbs_t
76 GpgmeTrustItem gpgme_trust_item_t
77 GpgmeStatusCode gpgme_status_code_t
79 * gpgme_error_t is now identical to gpg_error_t, the error type
80 provided by libgpg-error. More about using libgpg-error with GPGME
81 can be found in the manual. All error symbols have been removed!
83 * All functions and types in libgpg-error have been wrapped in GPGME.
84 The new types are gpgme_err_code_t and gpgme_err_source_t. The new
85 functions are gpgme_err_code, gpgme_err_source, gpgme_error,
86 gpgme_err_make, gpgme_error_from_errno, gpgme_err_make_from_errno,
87 gpgme_err_code_from_errno, gpgme_err_code_to_errno,
90 * GPGME_ATTR_IS_SECRET is not anymore representable as a string.
92 * GnuPG 1.2.2 is required. The progress callback is now also invoked
93 for encrypt, sign, encrypt-sign, decrypt, verify, and
94 decrypt-verify operations. For verify operations on detached
95 signatures, the progress callback is invoked for both the detached
96 signature and the plaintext message, though.
98 * gpgme_passphrase_cb_t has been changed to not provide a complete
99 description, but the UID hint, passphrase info and a flag
100 indicating if this is a repeated attempt individually, so the user
101 can compose his own description from this information.
103 The passphrase is not returned as a C string, but must be written
104 to a file descriptor directly. This allows for secure passphrase
107 The return type has been changed to gpgme_error_t value. This
108 allowed to remove the gpgme_cancel function; just return
109 the error code GPG_ERR_CANCELED in the passphrase callback directly.
111 * gpgme_edit_cb_t has been changed to take a file descriptor argument.
112 The user is expected to write the response to the file descriptor,
113 followed by a newline.
115 * The recipients interface has been removed. Instead, you use
116 NULL-terminated lists of keys for specifying the recipients of an
117 encryption operation. Use the new encryption flag
118 GPGME_ENCRYPT_ALWAYS_TRUST if you want to override the validity of
119 the keys (but note that in general this is not a good idea).
121 This change has been made to the prototypes of gpgme_op_encrypt,
122 gpgme_op_encrypt_start, gpgme_op_encrypt_sign and
123 gpgme_op_encrypt_sign_start.
125 The export interface has been changed to use pattern strings like
126 the keylist interface. Thus, new functions gpgme_op_export_ext and
127 gpgme_op_export_ext_start have been added as well. Now the
128 prototypes of gpgme_op_export_start and gpgme_op_export finally
131 * gpgme_op_verify and gpgme_op_decrypt_verify don't return a status
132 summary anymore. Use gpgme_get_sig_status to retrieve the individual
135 * gpgme_io_cb_t changed from a void function to a function returning
136 a gpgme_error_t value. However, it will always return 0, so you
137 can safely ignore the return value.
139 * A new I/O callback event GPGME_EVENT_START has been added. The new
140 requirement is that you must wait until this event until you are
141 allowed to call the I/O callback handlers previously registered for
142 this context operation. Calling I/O callback functions for this
143 context operation before the start event happened is unsafe because
144 it can lead to race conditions in a multi-threaded environment.
146 * The idle function feature has been removed. It was not precisely
147 defined in a multi-threaded environment and is obsoleted by the
148 user I/O callback functions. If you still need a simple way to
149 call something while waiting on one or multiple asynchronous
150 operations to complete, don't set the HANG flag in gpgme_wait (note
151 that this will return to your program more often than the idle
154 * gpgme_wait can return NULL even if hang is true, if an error
155 occurs. In that case *status contains the error code.
157 * gpgme_get_engine_info was radically changed. Instead an XML
158 string, an info structure of the new type gpgme_engine_info_t is
159 returned. This makes it easier and more robust to evaluate the
160 information in an application.
162 * The new function gpgme_get_protocol_name can be used to convert a
163 gpgme_protocol_t value into a string.
165 * The status of a context operation is not checked anymore. Starting
166 a new operation will silently cancel the previous one. Calling a
167 function that requires you to have started an operation before without
168 doing so is undefined.
170 * The FPR argument to gpgme_op_genkey was removed. Instead, use the
171 gpgme_op_genkey_result function to retrieve a gpgme_genkey_result_t
172 pointer to a structure which contains the fingerprint. This also
173 works with gpgme_op_genkey_start. The structure also provides
174 other information about the generated keys.
179 err = gpgme_op_genkey (ctx, NULL, NULL, &fpr);
181 printf ("%s\n", fpr);
185 gpgme_genkey_result_t result;
186 err = gpgme_op_genkey (ctx, NULL, NULL);
189 result = gpgme_op_genkey_result (ctx);
191 printf ("%s\n", result->fpr);
194 * The new gpgme_op_import_result function provides detailed
195 information about the result of an import operation in
196 gpgme_import_result_t and gpgme_import_status_t objects.
197 Thus, the gpgme_op_import_ext variant is deprecated.
199 * The new gpgme_op_sign_result function provides detailed information
200 about the result of a signing operation in gpgme_sign_result_t,
201 gpgme_invalid_user_id_t and gpgme_new_signature_t objects.
203 * The new gpgme_op_encrypt_result function provides detailed
204 information about the result of an encryption operation in
205 a GpgmeEncryptResult object.
207 * The new gpgme_op_decrypt_result function provides detailed
208 information about the result of a decryption operation in
209 a GpgmeDecryptResult object.
211 * The new gpgme_op_verify_result function provides detailed
212 information about the result of an verify operation in
213 a GpgmeVerifyResult object. Because of this, the GPGME_SIG_STAT_*
214 values, gpgme_get_sig_status, gpgme_get_sig_ulong_attr,
215 gpgme_get_sig_string_attr and gpgme_get_sig_key are now deprecated,
216 and gpgme_get_notation is removed.
218 * GpgmeTrustItem objects have now directly accessible data, so the
219 gpgme_trust_item_get_string_attr and gpgme_trust_item_get_ulong_attr
220 accessor functions are deprecated. Also, reference counting is
221 available through gpgme_trust_item_ref and gpgme_trust_item_unref
222 (the gpgme_trust_item_release alias for the latter is deprecated).
224 * Keys are not cached internally anymore, so the force_update argument
225 to gpgme_get_key has been removed.
227 * GpgmeKey objects have now directly accessible data so the
228 gpgme_key_get_string_attr, gpgme_key_get_ulong_attr,
229 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
230 functions are deprecated. Also, gpgme_key_release is now
231 deprecated. The gpgme_key_get_as_xml function has been dropped.
233 * Because all interfaces using attributes are deprecated, the
234 GpgmeAttr data type is also deprecated.
236 * The new gpgme_op_keylist_result function provides detailed
237 information about the result of a key listing operation in
238 a GpgmeKeyListResult object.
240 * Now that each function comes with its own result retrieval
241 interface, the generic gpgme_get_op_info interface is not useful
244 * The type and mode of data objects is not available anymore.
246 * Interface changes relative to the 0.4.0 release:
247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
248 GpgmeCtx DEPRECATED: Use gpgme_ctx_t.
249 GpgmeData DEPRECATED: Use gpgme_data_t.
250 GpgmeError DEPRECATED: Use gpgme_error_t.
251 GpgmeDataEncoding DEPRECATED: Use gpgme_data_encoding_t.
252 GpgmeSigStat DEPRECATED: Use gpgme_sig_stat_t.
253 GpgmeSigMode DEPRECATED: Use gpgme_sig_mode_t.
254 GpgmeAttr DEPRECATED: Use gpgme_attr_t.
255 GpgmeValidity DEPRECATED: Use gpgme_validity_t.
256 GpgmeProtocol DEPRECATED: Use gpgme_protocol_t.
257 GpgmeKey DEPRECATED: Use gpgme_key_t.
258 GpgmePassphraseCb DEPRECATED: Use gpgme_passphrase_cb_t.
259 GpgmeProgressCb DEPRECATED: Use gpgme_progress_cb_t.
260 GpgmeIOCb DEPRECATED: Use gpgme_io_cb_t.
261 GpgmeRegisterIOCb DEPRECATED: Use gpgme_register_io_cb_t.
262 GpgmeRemoveIOCb DEPRECATED: Use gpgme_remove_io_cb_t.
263 GpgmeEventIO DEPRECATED: Use gpgme_event_io_t.
264 GpgmeEventIOCb DEPRECATED: Use gpgme_event_io_cb_t.
265 GpgmeIOCbs DEPRECATED: Use gpgme_io_cbs.
266 GpgmeDataReadCb DEPRECATED: Use gpgme_data_read_cb_t.
267 GpgmeDataWriteCb DEPRECATED: Use gpgme_data_write_cb_t.
268 GpgmeDataSeekCb DEPRECATED: Use gpgme_data_seek_cb_t.
269 GpgmeDataReleaseCb DEPRECATED: Use gpgme_data_release_cb_t.
270 GpgmeDataCbs DEPRECATED: Use gpgme_data_cbs_t.
271 GpgmeTrustItem DEPRECATED: Use gpgme_trust_item_t.
272 GpgmeStatusCode DEPRECATED: Use gpgme_status_code_t.
275 gpgme_recipients_t NEW
277 gpgme_data_encoding_t NEW
284 gpgme_passphrase_cb_t NEW
285 gpgme_progress_cb_t NEW
287 gpgme_register_io_cb_t NEW
288 gpgme_remove_io_cb_t NEW
290 gpgme_event_io_cb_t NEW
292 gpgme_data_read_cb_t NEW
293 gpgme_data_write_cb_t NEW
294 gpgme_data_seek_cb_t NEW
295 gpgme_data_release_cb_t NEW
297 gpgme_trust_item_t NEW
298 gpgme_status_code_t NEW
299 GPGME_{some error code} REMOVED! Use GPG_ERR_* from libgpg-error.
301 gpgme_err_source_t NEW
306 gpgme_error_from_errno NEW
307 gpgme_err_make_from_errno NEW
308 gpgme_err_code_from_errno NEW
309 gpgme_err_code_to_errno NEW
311 gpgme_io_cb_t CHANGED: Return type from void to GpgmeError.
312 gpgme_event_io_t CHANGED: New event type (all numbers changed).
313 gpgme_passphrase_cb_t CHANGED: Desc decomposed, write directly to FD.
314 gpgme_edit_cb_t CHANGED: Write directly to FD.
315 gpgme_key_get_string_attr CHANGED: Don't handle GPGME_ATTR_IS_SECRET.
316 gpgme_op_verify CHANGED: Drop R_STAT argument.
317 gpgme_op_decrypt_verify CHANGED: Drop R_STAT argument.
318 gpgme_wait CHANGED: Can return NULL even if hang is true.
319 GpgmeIdleFunc REMOVED
320 gpgme_register_idle REMOVED
321 GpgmeRecipients REMOVED
322 gpgme_recipients_new REMOVED
323 gpgme_recipients_release REMOVED
324 gpgme_recipients_add_name REMOVED
325 gpgme_recipients_add_name_with_validity REMOVED
326 gpgme_recipients_count REMOVED
327 gpgme_recipients_enum_open REMOVED
328 gpgme_recipients_enum_read REMOVED
329 gpgme_recipients_enum_close REMOVED
330 gpgme_encrypt_flags_t NEW
331 GPGME_ENCRYPT_ALWAYS_TRUST NEW
332 gpgme_op_encrypt CHANGED: Recipients passed as gpgme_key_t[].
333 gpgme_op_encrypt_start CHANGED: Recipients passed as gpgme_key_t[].
334 gpgme_op_encrypt_sign CHANGED: Recipients passed as gpgme_key_t[].
335 gpgme_op_encrypt_sign_start CHANGED: Recipients passed as gpgme_key_t[].
336 gpgme_op_export_start CHANGED: User IDs passed as patterns.
337 gpgme_op_export CHANGED: User IDs passed as patterns.
338 gpgme_op_export_ext_start NEW
339 gpgme_op_export_ext NEW
340 gpgme_keylist_mode_t NEW
342 gpgme_engine_info_t NEW
343 gpgme_get_engine_info CHANGED: Return info structure instead XML.
344 gpgme_get_protocol_name NEW
345 gpgme_cancel REMOVED: Return error in callback directly.
346 gpgme_op_genkey CHANGED: FPR argument dropped.
347 gpgme_op_genkey_result NEW
348 gpgme_genkey_result_t NEW
349 gpgme_op_import_ext DEPRECATED: Use gpgme_op_import_result.
350 gpgme_op_import_result NEW
351 gpgme_import_status_t NEW
352 gpgme_import_result_t NEW
353 gpgme_pubkey_algo_t NEW
354 gpgme_hash_algo_t NEW
355 gpgme_invalid_user_id_t NEW
356 gpgme_new_signature_t NEW
357 gpgme_sign_result_t NEW
358 gpgme_op_sign_result NEW
359 gpgme_pubkey_algo_name NEW
360 gpgme_hash_algo_name NEW
361 gpgme_encrypt_result_t NEW
362 gpgme_op_encrypt_result NEW
363 gpgme_decrypt_result_t NEW
364 gpgme_op_decrypt_result NEW
365 gpgme_verify_result_t NEW
366 gpgme_op_verify_result NEW
367 gpgme_get_notation REMOVED: Access verify result directly instead.
368 gpgme_get_sig_key DEPRECATED: Use gpgme_get_key with fingerprint.
369 gpgme_get_sig_ulong_attr DEPRECATED: Use verify result directly.
370 gpgme_get_sig_string_attr DEPRECATED: Use verify result directly.
371 GPGME_SIG_STAT_* DEPRECATED: Use error value in sig status.
372 gpgme_get_sig_status DEPRECATED: Use verify result directly.
373 gpgme_trust_item_t CHANGED: Now has user accessible data members.
374 gpgme_trust_item_ref NEW
375 gpgme_trust_item_unref NEW
376 gpgme_trust_item_release DEPRECATED: Use gpgme_trust_item_unref.
377 gpgme_trust_item_get_string_attr DEPRECATED
378 gpgme_trust_item_get_ulong_attr DEPRECATED
379 gpgme_get_key CHANGED: Removed force_update argument.
383 gpgme_key_t CHANGED: Now has user accessible data members.
384 gpgme_key_get_string_attr DEPRECATED
385 gpgme_key_get_ulong_attr DEPRECATED
386 gpgme_key_sig_get_string_attr DEPRECATED
387 gpgme_key_sig_get_ulong_attr DEPRECATED
388 gpgme_key_get_as_xml REMOVED
389 gpgme_key_list_result_t NEW
390 gpgme_op_keylist_result NEW
391 gpgme_get_op_info REMOVED
392 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
394 Noteworthy changes in version 0.4.0 (2002-12-23)
395 ------------------------------------------------
397 * Key generation returns the fingerprint of the generated key.
399 * New convenience function gpgme_get_key.
401 * Supports signatures of user IDs in keys via the new
402 GPGME_KEYLIST_MODE_SIGS keylist mode and the
403 gpgme_key_sig_get_string_attr and gpgme_key_sig_get_ulong_attr
404 interfaces. The XML info about a key also includes the signatures
407 * New data object interface, which is more flexible and transparent.
409 * Interface changes relative to the 0.3.9 release:
410 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
414 GpgmeDataReleaseCb NEW
416 gpgme_data_read CHANGED: Match read() closely.
417 gpgme_data_write CHANGED: Match write() closely.
419 gpgme_data_new_from_fd NEW
420 gpgme_data_new_from_stream NEW
421 gpgme_data_new_from_cbs NEW
422 gpgme_data_rewind DEPRECATED: Replaced by gpgme_data_seek().
423 gpgme_data_new_from_read_cb DEPRECATED: Replaced by gpgme_data_from_cbs().
424 gpgme_data_get_type REMOVED: No replacement.
425 gpgme_op_verify CHANGED: Take different data objects for
426 signed text and plain text.
427 gpgme_op_verify_start CHANGED: See gpgme_op_verify.
428 gpgme_check_engine REMOVED: Deprecated since 0.3.0.
429 gpgme_op_genkey CHANGED: New parameter FPR.
430 GPGME_KEYLIST_MODE_SIGS NEW
431 gpgme_key_sig_get_string_attr NEW
432 gpgme_key_sig_get_ulong_attr NEW
434 GPGME_ATTR_SIG_CLASS NEW
435 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
437 Noteworthy changes in version 0.3.15 (2003-02-18)
438 -------------------------------------------------
440 * The progress status is sent via the progress callbacks in
443 * Bug fix for signing operations with explicit signer settings for
446 Noteworthy changes in version 0.3.14 (2002-12-04)
447 -------------------------------------------------
449 * GPGME-Plug is now in its own package "cryptplug".
451 * Workaround for a setlocale problem. Fixed a segv related to not
452 correctly as closed marked file descriptors.
454 Noteworthy changes in version 0.3.13 (2002-11-20)
455 -------------------------------------------------
457 * Release due to changes in gpgmeplug.
459 Noteworthy changes in version 0.3.12 (2002-10-15)
460 -------------------------------------------------
462 * Fixed some bux with key listings.
464 * The development has been branched to clean up some API issues.
465 This 0.3 series will be kept for compatibility reasons; so do don't
468 Noteworthy changes in version 0.3.11 (2002-09-20)
469 -------------------------------------------------
473 Noteworthy changes in version 0.3.10 (2002-09-02)
474 -------------------------------------------------
476 * Setting the signing keys for the CMS protocol does now work.
478 * The signers setting is honoured by gpgme_op_edit.
480 Noteworthy changes in version 0.3.9 (2002-08-21)
481 ------------------------------------------------
483 * A spec file for creating RPMs has been added.
485 * An experimental interface to GnuPG's --edit-key functionality is
486 introduced, see gpgme_op_edit.
488 * The new gpgme_import_ext function provides a convenient access to
489 the number of processed keys.
491 * Interface changes relative to the 0.3.8 release:
492 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
495 gpgme_op_edit_start NEW
497 gpgme_op_import_ext NEW
498 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
500 Noteworthy changes in version 0.3.8 (2002-06-25)
501 ------------------------------------------------
503 * It is possible to use an outside event loop for the I/O to the
504 crypto engine by setting the I/O callbacks with gpgme_set_io_cbs.
506 * Interface changes relative to the 0.3.6 release:
507 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
509 GpgmeRegisterIOCb NEW
513 struct GpgmeIOCbs NEW
516 GPGME_ATTR_ERRTOK NEW
517 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
519 Noteworthy changes in version 0.3.7 (2002-06-04)
520 ------------------------------------------------
522 * GPGME_ATTR_OTRUST is implemented now.
524 * A first step toward thread safeness has been achieved, see the
525 documentation for details. Supported thread libraries are pthread
528 Noteworthy changes in version 0.3.6 (2002-05-03)
529 ------------------------------------------------
531 * All error output of the gpgsm backend is send to the bit bucket.
533 * The signature verification functions are extended. Instead of
534 always returning GPGME_SIG_STATUS_GOOD, the functions new codes for
535 expired signatures. 2 new functions may be used to retrieve more
536 detailed information like the signature expiration time and a
537 validity information of the key without an extra key looking.
539 * The current passphrase callback and progress meter callback can be
540 retrieved with the new functions gpgme_get_passphrase_cb and
541 gpgme_get_progress_cb respectively.
543 * Interface changes relative to the 0.3.5 release:
544 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
545 gpgme_get_passphrase_cb NEW
546 gpgme_get_progress_cb NEW
547 GpgmeDataEncoding NEW
548 gpgme_data_set_encoding NEW
549 gpgme_data_get_encoding NEW
550 GPGME_SIG_STAT_GOOD_EXP NEW
551 GPGME_SIG_STAT_GOOD_EXPKEY NEW
552 gpgme_op_verify CHANGED: Returns more status codes.
553 GPGME_ATTR_SIG_STATUS NEW
554 gpgme_get_sig_string_attr NEW
555 gpgme_get_sig_ulong_attr NEW
556 gpgme_get_protocol NEW
557 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
559 Noteworthy changes in version 0.3.5 (2002-04-01)
560 ------------------------------------------------
562 * gpgme_op_encrypt can be called with RECIPIENTS being 0. In this
563 case, symmetric encryption is performed. Note that this requires a
564 passphrase from the user.
566 * More information is returned for X.509 certificates.
568 * Interface changes relative to the 0.3.4 release:
569 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
570 gpgme_op_encrypt EXTENDED: Symmetric encryption possible
571 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
573 Noteworthy changes in version 0.3.4 (2002-03-04)
574 ------------------------------------------------
576 * gpgme_op_encrypt does now fail with GPGME_Invalid_Recipients if
577 some recipients have been invalid, whereas earlier versions
578 succeeded in this case. The plaintext is still encrypted for all valid
579 recipients, so the application might take this error as a hint that
580 the ciphertext is not usable for all requested recipients.
581 Information about invalid recipients is available with gpgme_get_op_info.
583 * gpgme_op_verify now allows to pass an uninitialized data object as
584 its plaintext argument to check for normal and cleartext
585 signatures. The plaintext is then returned in the data object.
587 * New interfaces gpgme_set_include_certs and gpgme_get_include_certs
588 to set and get the number of certifications to include in S/MIME
591 * New interfaces gpgme_op_encrypt_sign and gpgme_op_encrypt_sign_start
592 to encrypt and sign a message in a combined operation.
594 * New interface gpgme_op_keylist_ext_start to search for multiple patterns.
596 * gpgme_key_get_ulong_attr supports the GPGME_ATTR_EXPIRE attribute.
598 * Interface changes relative to the 0.3.3 release:
599 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
600 gpgme_op_encrypt CHANGED: Can fail with GPGME_Invalid_Recipients
601 gpgme_op_verify EXTENDED: Accepts uninitialized text argument
602 gpgme_key_get_ulong_attr EXTENDED: Supports GPGME_ATTR_EXPIRE
603 gpgme_set_include_certs NEW
604 gpgme_get_include_certs NEW
605 gpgme_op_encrypt_sign NEW
606 gpgme_op_encrypt_sign_start NEW
607 gpgme_op_keylist_ext_start NEW
608 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
610 Noteworthy changes in version 0.3.3 (2002-02-12)
611 ------------------------------------------------
613 * Fix the Makefile in jnlib.
615 * Fix the test suite (hopefully). It should clean up all its state
616 with `make check' now.
619 Noteworthy changes in version 0.3.2 (2002-02-10)
620 ------------------------------------------------
622 * Remove erroneous dependency on libgcrypt in jnlib.
625 Noteworthy changes in version 0.3.1 (2002-02-09)
626 ------------------------------------------------
628 * There is a Texinfo manual documenting the API.
630 * The gpgme_set_keylist_mode function returns an error, and changed
631 its meaning. It is no longer usable to select between normal and
632 fast mode (newer versions of GnuPG will always be fast), but
633 selects between local keyring, remote keyserver, or both.
634 For this, two new macros are defined, GPGME_KEYLIST_MODE_LOCAL
635 and GPGME_KEYLIST_MODE_EXTERN. To make it possible to modify the
636 current setting, a fucntion gpgme_get_keylist_mode was added to
637 retrieve the current mode.
639 * gpgme_wait accepts a new argument STATUS to return the error status
640 of the operation on the context. Its definition is closer to
641 waitpid() now than before.
643 * The LENGTH argument to gpgme_data_new_from_filepart changed its
644 type from off_t to the unsigned size_t.
646 * The R_HD argument to the GpgmePassphraseCb type changed its type
647 from void* to void**.
649 * New interface gpgme_op_trustlist_end() to match
650 gpgme_op_keylist_end().
652 * The CryptPlug modules have been renamed to gpgme-openpgp and
653 gpgme-smime, and they are installed in pkglibdir by `make install'.
655 * An idle function can be registered with gpgme_register_idle().
657 * The GpgSM backend supports key generation with gpgme_op_genkey().
659 * Interface changes relative to the 0.3.0 release:
660 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
661 gpgme_data_new_from_filepart CHANGED: Type of LENGTH is size_t.
662 GpgmePassphraseCb CHANGED: Type of R_HD is void **.
663 gpgme_wait CHANGED: New argument STATUS.
664 gpgme_set_keylist_mode CHANGED: Type of return value is GpgmeError.
665 The function has a new meaning!
666 gpgme_get_keylist_mode NEW
667 GPGME_KEYLIST_MODE_LOCAL NEW
668 GPGME_KEYLIST_MODE_EXTERN NEW
669 gpgme_op_trustlist_next NEW
671 gpgme_register_idle NEW
672 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
674 Noteworthy changes in version 0.3.0 (2001-12-19)
675 ------------------------------------------------
677 * New interface gpgme_set_protocol() to set the protocol and thus the
678 crypto engine to be used by the context. Currently, the OpenPGP
679 and the CMS protocols are supported. They are specified by the new
680 preprocessor symbols GPGME_PROTOCOL_OpenPGP and GPGME_PROTOCOL_CMS.
681 A new context uses the OpenPGP engine by default.
683 * gpgme_get_engine_info() returns information for all crypto engines
684 compiled into the library. The XML format has changed. To
685 reliably get the version of a crypto engine, the <version> tag
686 after the appropriate <protocol> tag has to be looked for.
688 * New interface gpgme_engine_check_version(), obsoleting
689 gpgme_check_engine(). Check the version of all engines you are
690 supporting in your software.
692 * GpgmeKey lists the user ids in the order as they are returned by
693 GnuPG, first the primary key with index 0, then the sub-user ids.
695 * New operation gpgme_op_decrypt_verify() to decrypt and verify
696 signatures simultaneously.
698 * The new interface gpgme_op_keylist_end() terminates a pending
699 keylist operation. A keylist operation is also terminated when
700 gpgme_op_keylist_next() returns GPGME_EOF.
702 * GPGME can be compiled without GnuPG being installed (`--with-gpg=PATH'),
703 cross-compiled, or even compiled without support for GnuPG
706 * GPGME can be compiled with support for GpgSM (GnuPG for S/MIME,
707 `--with-gpgsm=PATH'). It is enabled by default if the `gpgsm' is found
708 in the path, but it can also be compiled without support for GpgSM
711 * CryptPlug modules for GPGME are included and can be enabled at
712 configure time (`--enable-gpgmeplug'). There is one module which
713 uses the GnuPG engine (`gpgmeplug') and one module which uses the
714 GpgSM engine (`gpgsmplug').
716 * Interface changes relative to the latest 0.2.x release:
717 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
718 gpgme_key_get_as_xml CHANGED: Sub-user ids reversed in order.
719 gpgme_key_get_string_attr CHANGED: User ids reversed in order.
720 gpgme_key_get_ulong_attr CHANGED: User ids reversed in order.
721 gpgme_get_engine_info CHANGED: New format, extended content.
722 gpgme_engine_check_version NEW
723 gpgme_decrypt_verify_start NEW
724 gpgme_decrypt_verify NEW
725 gpgme_op_keylist_next NEW
726 gpgme_set_protocol NEW
727 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
730 Noteworthy changes in version 0.2.3 (2001-09-17)
731 ------------------------------------------------
733 * New function gpgme_get_op_info which can be used to get the micalg
734 parameter needed for MOSS.
736 * New functions gpgme_get_armor and gpgme_get_textmode.
738 * The usual bug fixes and some minor functionality improvements.
740 * Added a simple encryption component for MS-Windows; however the
741 build procedure might have some problems.
744 Noteworthy changes in version 0.2.2 (2001-06-12)
745 ------------------------------------------------
747 * Implemented a key cache.
749 * Fixed a race condition under W32 and some other bug fixes.
752 Noteworthy changes in version 0.2.1 (2001-04-02)
753 ------------------------------------------------
755 * Changed debug output and GPGME_DEBUG variable (gpgme/debug.c)
757 * Handle GnuPG's new key capabilities output and support revocation
760 * Made the W32 support more robust.
763 Copyright 2001, 2002 g10 Code GmbH
765 This file is free software; as a special exception the author gives
766 unlimited permission to copy and/or distribute it, with or without
767 modifications, as long as this notice is preserved.
769 This file is distributed in the hope that it will be useful, but
770 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
771 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.