doc cleanups
[libgcrypt.git] / NEWS
1 Noteworthy changes in version 1.4.2 (2008-09-08)
2 ------------------------------------------------
3
4  * The long missing gcry_mpi_lshift function has been added.
5
6  * RSA key generation now supports a "transient-key" flag.
7
8  * The keygrip computation for ECDSA has been implemented thus ECDSA
9    is now fully supported.
10
11  * A few macros have been replaced by functions for better type
12    checking.
13
14  * The thread initialization structure now carries version
15    information.
16
17  * The manual describes more clearly how to initialize Libgcrypt.
18
19  * The library may now be switched into a FIPS mode.
20
21  * Interface changes relative to the 1.3.0 release:
22  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23  GCRYCTL_OPERATIONAL_P   NEW.
24  GCRYCTL_FIPS_MODE_P     NEW.
25  GCRYCTL_FORCE_FIPS_MODE NEW.
26  gcry_cipher_setkey      NEW: Replaces macro.
27  gcry_cipher_setiv       NEW: Replaces macro.
28  gcry_cipher_setctr      NEW: Replaces macro.
29  gcry_mpi_lshift         NEW.
30  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
31
32
33 Noteworthy changes in version 1.4.1 (2008-04-25)
34 ------------------------------------------------
35
36  * Fixed a bug introduced by 1.3.1 which led to the comsumption of far
37    too much entropy for the intial seeding.
38
39  * Improved AES performance for CFB and CBC modes.
40
41  * Removed build problems for the Padlock support.
42
43
44 Noteworthy changes in version 1.4.0 (2007-12-10)
45 ------------------------------------------------
46
47  * New configure option --disable-padlock-support which is mostly
48    useful in case of build problems.
49
50
51 Noteworthy changes in version 1.3.2 (2007-12-03)
52 ------------------------------------------------
53
54  * The visibility attribute is now used if supported by the toolchain.
55
56  * The ACE engine of VIA processors is now used for AES-128.
57
58  * The ASN.1 DER template for SHA-224 has been fixed.
59
60
61 Noteworthy changes in version 1.3.1 (2007-10-26)
62 ------------------------------------------------
63
64  * The entire library is now under the LGPL. The helper programs and
65    the manual are under the GPL.  Kudos to Peter Gutmann for giving
66    permissions to relicense the rndw32 and rndunix modules.
67
68  * The Camellia cipher is now under the LGPL and included by default.
69
70  * Fixed a bug in the detection of symbol prefixes which inhibited the
71    build of optimzied assembler code on certain systems.
72
73  * Updated the entropy gatherer for W32.
74
75
76 Noteworthy changes in version 1.3.0 (2007-05-04)
77 ------------------------------------------------
78
79  * Changed the way the RNG gets initialized. This allows to keep it
80    uninitialized as long as no random numbers are used.  To override
81    this, the new macro gcry_fast_random_poll may be used.  It is in
82    general a good idea to spread this macro into the application code
83    to make sure that these polls happen often enough.
84
85  * Made the RNG immune against fork without exec.
86
87  * Reading and writing the random seed file is now protected by a
88    fcntl style file lock on systems that provide this function.
89
90  * Support for SHA-224 and HMAC using SHA-384 and SHA-512.
91
92  * Support for the SEED cipher.
93
94  * Support for the Camellia cipher.  Note that Camellia is disabled by
95    default, and that enabling it changes the license of libgcrypt from
96    LGPL to GPL.
97
98  * Support for OFB encryption mode.
99
100  * gcry_mpi_rshift does not anymore truncate the shift count.
101
102  * Reserved algorithm ranges for use by applications.
103
104  * Support for DSA2.
105
106  * The new function gcry_md_debug should be used instead of the
107    gcry_md_start_debug and gcry_md_stop_debug macros.
108
109  * New configure option --enable-random-daemon to support a system
110    wide random daemon.  The daemon code is experimental and not yet
111    very well working.  It will eventually allow to keep a global
112    random pool for the sake of short living processes.
113
114  * Non executable stack support is now used by default on systems
115    supporting it.
116
117  * Support for Microsoft Windows.
118
119  * Assembler support for the AMD64 architecture.
120
121  * New configure option --enable-mpi-path for optimized builds.
122
123  * Experimental support for ECDSA; should only be used for testing.
124
125  * New control code GCRYCTL_PRINT_CONFIG to print the build
126    configuration.
127
128  * Minor changes to some function declarations.  Buffer arguments are
129    now typed as void pointer.  This should not affect any compilation.
130    Fixed two bugs in return values and clarified documentation.
131
132  * Interface changes relative to the 1.2.0 release:
133  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134  gcry_fast_random_poll   NEW
135  gcry_md_debug           NEW
136  gcry_sexp_nth_string    NEW
137  GCRY_MD_SHA224          NEW
138  GCRY_PK_USAGE_CERT      NEW
139  GCRY_PK_USAGE_AUTH      NEW
140  GCRY_PK_USAGE_UNKN      NEW
141  GCRY_PK_ECDSA           NEW
142  GCRY_CIPHER_SEED        NEW
143  GCRY_CIPHER_CAMELLIA128 NEW
144  GCRY_CIPHER_CAMELLIA192 NEW
145  GCRY_CIPHER_CAMELLIA256 NEW
146  GCRYCTL_FAKED_RANDOM_P  NEW 
147  GCRYCTL_PRINT_CONFIG    NEW
148  GCRYCTL_SET_RNDEGD_SOCKET  NEW.
149  gcry_mpi_scan           CHANGED: Argument BUFFER is now void*.
150  gcry_pk_algo_name       CHANGED: Returns "?" instead of NULL.
151  gcry_cipher_algo_name   CHANGED: Returns "?" instead of "".
152  gcry_pk_spec_t          CHANGED: Element ALIASES is now const ptr.
153  gcry_md_write_t         CHANGED: Argument BUF is now a const void*.
154  gcry_md_ctl             CHANGED: Argument BUFFER is now void*.
155  gcry_cipher_encrypt     CHANGED: Arguments IN and OUT are now void*.
156  gcry_cipher_decrypt     CHANGED: Arguments IN and OUT are now void*.
157  gcry_sexp_sprint        CHANGED: Argument BUFFER is now void*.
158  gcry_create_nonce       CHANGED: Argument BUFFER is now void*.
159  gcry_randomize          CHANGED: Argument BUFFER is now void*.
160  gcry_cipher_register    CHANGED: Argument ALGORITHM_ID is now int*.
161  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
162
163
164 Noteworthy changes in version 1.2.0 (2004-04-15)
165 ------------------------------------------------
166
167  * First stable release.
168
169
170 Noteworthy changes in version 1.1.94 (2004-03-29)
171 -------------------------------------------------
172
173  * The support for multi-threaded users goes into its third
174    incarnation.  We removed compile time support for thread libraries.
175    To support the thread library of your choice, you have to set up
176    callback handlers at initialization time.  New data structures, a
177    new control command, and default initializers are provided for this
178    purpose.
179
180  * Interface changes relative to the 1.1.93 release:
181 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
182 libgcrypt-config --thread       OBSOLETE
183 libgcrypt-pth.la                REMOVED
184 libgcrypt-pthread.la            REMOVED
185 GCRYCTL_SET_THREAD_CBS          NEW
186 struct gcrypt_thread_cbs        NEW
187 enum gcry_thread_option         NEW
188 GCRY_THREAD_OPTION_PTH_IMPL     NEW
189 GCRY_THREAD_OPTION_PTHREAD_IMPL NEW
190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
191
192 Noteworthy changes in version 1.1.93 (2004-03-06)
193 -------------------------------------------------
194
195  * The automatic thread library detection has finally been removed.
196    From now on, only linking explicitely to libgcrypt, libgcrypt-pth
197    or libgcrypt-pthread is supported.
198
199 Noteworthy changes in version 1.1.92 (2004-02-20)
200 -------------------------------------------------
201
202  * Minor bug fixes.
203
204  * Included a limited implementation of RFC2268.
205
206  * Changed API of the gcry_ac_ functions.  Only a very few programs
207    should be affected by this.
208
209  * Interface changes relative to the 1.1.91 release:
210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
211 GCRY_CIPHER_RFC2268_40          NEW.
212 gcry_ac_data_set                CHANGED: New argument FLAGS.
213 gcry_ac_data_get_name           CHANGED: New argument FLAGS.
214 gcry_ac_data_get_index          CHANGED: New argument FLAGS.
215 gcry_ac_key_pair_generate       CHANGED: New and reordered arguments.
216 gcry_ac_key_test                CHANGED: New argument HANDLE.
217 gcry_ac_key_get_nbits           CHANGED: New argument HANDLE.
218 gcry_ac_key_get_grip            CHANGED: New argument HANDLE.
219 gcry_ac_data_search             REMOVED.
220 gcry_ac_data_add                REMOVED.
221 GCRY_AC_DATA_FLAG_NO_BLINDING   REMOVED.
222 GCRY_AC_FLAG_NO_BLINDING        NEW: Replaces above.
223
224
225 Noteworthy changes in version 1.1.91 (2003-12-19)
226 -------------------------------------------------
227
228  * Code cleanups and minor bug fixes.
229
230
231 Noteworthy changes in version 1.1.90 (2003-11-14)
232 -------------------------------------------------
233
234  * The use of the GCRY_WEAK_RANDOM level is now deprecated in favor of
235    the new gcry_create_nonce function.
236
237  * gcry_sexp_build now supports a "%b" format to include a memory buffer.
238
239  * Minor configuration fixes.
240  
241  * Interface changes relative to the 1.1.44 release:
242 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
243 gcry_create_nonce               NEW
244 gcry_sexp_build                 ENHANCED
245
246
247 Noteworthy changes in version 1.1.44 (2003-10-31)
248 -------------------------------------------------
249
250  * Bug fixes and more code cleanups.
251
252  * Enhanced the prime API.
253
254  * Interface changes relative to the 1.1.43 release:
255 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
256 gcry_prime_group_generator      NEW
257 gcry_prime_release_factors      NEW
258
259
260 Noteworthy changes in version 1.1.43 (2003-09-04)
261 -------------------------------------------------
262
263  * Bug fixes and internal code cleanups.
264
265  * Support for the Serpent cipher algorithm.
266
267  * Interface changes relative to the 1.1.42 release:
268 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
269 gcry_prime_generate             NEW
270 gcry_prime_check                NEW
271
272
273 Noteworthy changes in version 1.1.42 (2003-07-31)
274 -------------------------------------------------
275
276  * Major API cleanup.  Applications need to be converted to the new
277    API.  See README.apichanges for hints on how to do that.  Backward
278    compatibility is provided where it was possible without too much
279    effort and did not collide with the overall sanitization effort.
280    However, this is only for ease of transition.  NO DEPRECATED
281    FUNCTION OR DATA TYPE IS CONSIDERED A PART OF THE API OR ABI AND
282    WILL BE DROPPED IN THE FUTURE WITHOUT CHANGING THE SONAME OF THE
283    LIBRARY. 
284
285  * If gcrypt.h is included in sources compiled by GCC 3.1 or later,
286    deprecated attributes will warn about use of obsolete functions and
287    type definitions.  You can suppress these warnings by passing
288    -Wno-deprecated-declarations to the gcc command.
289
290  * gcry_check_version must be called from now on to initialize the
291    library, it is not longer optional.
292
293  * Removed `libgcrypt errno' concept.
294
295  * Libgcrypt depends on libgpg-error, a library that provides error
296    codes and according functions for all GnuPG components.  Functions
297    that used to return error codes asa `int' have been changed to
298    return a code of type `gcry_error_t'.  All GCRYERR_* error symbols
299    have been removed, since they are now contained in libgpg-error
300    (GPG_ERR_*). All functions and types in libgpg-error have also been
301    wrapped in Libgcrypt. The new types are gcry_err_code_t and
302    gcry_err_source_t.  The new functions are gcry_err_code,
303    gcry_err_source, gcry_error, gcry_err_make, gcry_error_from_errno,
304    gcry_err_make_from_errno, gcry_err_code_from_errno,
305    gcry_err_code_to_errno, gcry_strsource.
306
307  * New function gcry_mpi_dump to help in debugging. 
308
309  * Added alternative interface for asymmetric cryptography.
310
311  * CRC-32, CRC-32 a'la RFC 1510, CRC-24 a'la RFC 2440 are now
312    supported.
313
314  * SHA-256, SHA-384 and SHA-512 are now supported.
315
316  * 128 bit Twofish is now supported.
317
318  * The random module won't print the "not enough random bytes
319    available" anymore.  A new progress status is issued instead.
320
321  * CBC-MAC for block ciphers is now supported, by using a
322    GCRY_CIPHER_CBC_MAC cipher flag.
323
324  * CTR mode for block ciphers is now supported.
325
326  * The public RSA exponent can now be specified in key generation. 
327
328  * RSA blinding is now supported and is used automatically for RSA
329    decryption.  It can be explicitely disabled by using the
330    `no-blinding' symbol in the `flags' S-Expression or by using the
331    GCRY_AC_FLAG_DATA_NO_BLINDING flag when using the ac interface.
332
333  * gcry_sexp_canon_len does not use a `historically encoded' error
334    code anymore.
335
336
337  * Interface changes relative to the 1.1.12 release:
338 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
339 GCRY_MPI                        DEPRECATED; Use: gcry_mpi_t
340 GcryMPI                         DEPRECATED; Use: gcry_mpi_t
341 GCRY_SEXP                       DEPRECATED; Use: gcry_sexp_t
342 GcrySexp                        DEPRECATED; Use: gcry_sexp_t
343 GCRY_CIPHER_HD                  DEPRECATED; Use: gcry_cipher_hd_t
344 GcryCipherHd                    DEPRECATED; Use: gcry_cipher_hd_t
345 GCRY_MD_HD                      DEPRECATED; Use: gcry_md_hd_t
346 GcryMDHd                        DEPRECATED; Use: gcry_md_hd_t
347 gcry_error_t                    NEW
348 gcry_err_code_t                 NEW
349 gcry_err_source_t               NEW
350 gcry_err_make                   NEW
351 gcry_error                      NEW
352 gcry_err_code                   NEW
353 gcry_err_source                 NEW
354 gcry_err_code_from_errno        NEW
355 gcry_err_code_to_errno          NEW
356 gcry_err_make_from_errno        NEW
357 gcry_error_from_errno           NEW
358 gcry_strsource                  NEW
359 GCRYERR_{some error code}       REMOVED; Use GPG_ERR_*
360                                          from libgpg-error instead.
361 gcry_errno                      REMOVED
362 gcry_sexp_canon_len             CHANGED
363 gcry_sexp_build_array           NEW
364 gcry_mpi_scan                   CHANGED: New argument to separate in/out args.
365 gcry_mpi_print                  CHANGED: Ditto.
366 gcry_mpi_dump                   NEW
367 gcry_cipher_open                CHANGED
368 gcry_cipher_reset               NEW
369 gcry_cipher_register            NEW
370 gcry_cipher_unregister          NEW
371 gcry_cipher_list                NEW
372 gcry_cipher_algo_keylen         REPLACED macro with function.
373 gcry_cipher_algo_blklen         REPLACED macro with function.
374 gcry_pk_register                NEW
375 gcry_pk_unregister              NEW
376 gcry_pk_list                    NEW
377 gcry_pk_decrypt                 ENHANCED: Allows flag to return
378                                           complete S-expression.
379 gcry_md_open                    CHANGED
380 gcry_md_copy                    CHANGED
381 gcry_md_is_enabled              NEW
382 gcry_md_is_secure               NEW
383 gcry_md_register                NEW
384 gcry_md_unregister              NEW
385 gcry_md_list                    NEW
386 gcry_ac_data_t                  NEW
387 gcry_ac_key_t                   NEW
388 gcry_ac_key_pair_t              NEW
389 gcry_ac_handle_t                NEW
390 gcry_ac_key_spec_rsa_t          NEW
391 gcry_ac_data_new                NEW
392 gcry_ac_data_destroy            NEW
393 gcry_ac_data_set                NEW
394 gcry_ac_data_copy               NEW
395 gcry_ac_data_length             NEW
396 gcry_ac_data_get_name           NEW
397 gcry_ac_data_get_index          NEW
398 gcry_ac_data_clear              NEW
399 gcry_ac_open                    NEW
400 gcry_ac_close                   NEW
401 gcry_ac_key_init                NEW
402 gcry_ac_key_pair_generate       NEW
403 gcry_ac_key_pair_extract        NEW
404 gcry_ac_key_data_get            NEW
405 gcry_ac_key_test                NEW
406 gcry_ac_key_get_nbits           NEW
407 gcry_ac_key_get_grip            NEW
408 gcry_ac_key_destroy             NEW
409 gcry_ac_key_pair_destroy        NEW
410 gcry_ac_data_encrypt            NEW
411 gcry_ac_data_decrypt            NEW
412 gcry_ac_data_sign               NEW
413 gcry_ac_data_verify             NEW
414 gcry_ac_id_to_name              NEW
415 gcry_ac_name_to_id              NEW
416 gcry_handler_progress_t         NEW
417 gcry_handler_alloc_t            NEW
418 gcry_handler_secure_check_t     NEW
419 gcry_handle_realloc_t           NEW
420 gcry_handler_free_t             NEW
421 gcry_handler_no_mem_t           NEW
422 gcry_handler_error_t            NEW
423 gcry_handler_log_t              NEW
424 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
425
426 Noteworthy changes in version 1.1.12 (2003-01-20)
427 -------------------------------------------------
428
429  * gcry_pk_sign, gcry_pk_verify and gcry_pk_encrypt can now handle an
430    optional pkcs1 flags parameter in the S-expression.  A similar flag
431    may be passed to gcry_pk_decrypt but it is only syntactically
432    implemented.
433
434  * New convenience macro gcry_md_get_asnoid.
435
436  * There is now some real stuff in the manual.
437
438
439 Noteworthy changes in version 1.1.11 (2002-12-21)
440 -------------------------------------------------
441
442  * Don't export internal symbols anymore (currently only for GNU systems)
443
444  * New algorithm: MD4
445
446  * Implemented ciphertext stealing.
447
448  * Smaller bugs fixes and a few new OIDs.
449
450  * Interface changes relative to the 1.1.8 release:
451 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
452 gcry_cipher_cts                   NEW
453 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
454
455
456 Noteworthy changes in version 1.1.10 (2002-09-20)
457 -------------------------------------------------
458
459  * Fixed shared library builds for i386, PPC and Sparc.
460
461  * Added simple benchmark tool.
462
463  * Replaced the internal mutexes by code which automatically adapts to
464    the used threading library.  Currently Pth and Pthread are
465    supported.  For non-ELF systems the GNU toolchain is now required..
466
467  * Added untested support to build Windows DLLs.
468
469 Noteworthy changes in version 1.1.9 (2002-08-23)
470 ------------------------------------------------
471
472  * Support for plain old DES.
473
474
475 Noteworthy changes in version 1.1.8 (2002-06-25)
476 ------------------------------------------------
477
478  * Minor cleanups and exported a few new functions.
479
480  * Interface changes relative to the 1.1.7 release:
481 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
482 gcry_mpi_div                      NEW
483 gcry_mpi_mod                      NEW
484 gcry_mpi_invm                     NEW
485 gcry_mpi_swap                     NEW
486 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
487
488 Noteworthy changes in version 1.1.7 (2002-05-21)
489 ------------------------------------------------
490
491 * Libgcrypt is now distributed under the terms of the GNU Lesser
492   General Public License; see the README file for details.    
493   
494 * It is possible to use libgcrypt w/o intialized secure memory.
495
496 * Libgcrypt should now be thread safe after the initialization.
497   gcry_control (GCRYCRL_INITIALIZATION_FINISHED,NULL,0) should have
498   been called before creating additional threads.
499
500  * Interface changes relative to the 1.1.6 release:
501 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
502 GCRYCTL_DISABLE_INTERNAL_LOCKING  NEW
503 GCRYCTL_DISABLE_SECMEM            NEW
504 GCRYCTL_INITIALIZATION_FINISHED   NEW
505 GCRYCTL_INITIALIZATION_FINISHED_P NEW
506 GCRYCTL_ANY_INITIALIZATION_P      NEW
507 gcry_strdup                       NEW
508 gcry_sexp_create                  NEW
509 gcry_sexp_new                     NEW
510 gcry_set_progress_handler         NEW
511 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
512
513 Noteworthy changes in version 1.1.6 (2002-02-07)
514 ------------------------------------------------
515
516   * Enhanced the S-expression conversion functions.
517         
518 Noteworthy changes in version 1.1.5 (2001-12-18)
519 ------------------------------------------------
520
521   * gcry_{cipher,md}_map_name are now able to map stringified object IDs.
522
523   * New functions gcry_sexp_canon_len and gcry_cipher_mode_from_oid.
524
525   * Closed some memory leaks.
526
527
528 Noteworthy changes in version 1.1.4 (2001-08-03)
529 ------------------------------------------------
530
531   * Arcfour does now work.                   
532
533   * Some minor fixes.
534
535   * Added a first test program
536
537   * Migrated to autoconf 2.52.
538
539
540 Noteworthy changes in version 1.1.3 (2001-05-31)
541 ------------------------------------------------
542
543   * First release of Libgcrypt which is a result of splitting GnuPG
544     into into libgcrypt and GnuPG.
545
546
547 Copyright 2001, 2002, 2003, 2004, 2007, 2008 Free Software Foundation, Inc.
548
549 This file is free software; as a special exception the author gives
550 unlimited permission to copy and/or distribute it, with or without
551 modifications, as long as this notice is preserved.
552
553 This file is distributed in the hope that it will be useful, but
554 WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
555 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.