NEWS 34.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
NEWS for the Nettle 3.2 release

	Bug fixes:

	* The SHA3 implementation is updated according to the FIPS 202
          standard. It is not interoperable with earlier versions of
          Nettle. Thanks to Nikos Mavrogiannopoulos.

	New features:

	* New functions nettle_version_major, nettle_version_minor, as
	  a run-time variant of the compile-time constants
	  NETTLE_VERSION_MAJOR and NETTLE_VERSION_MINOR.

	Optimizations:

	* New ARM Neon implementation of the chacha stream cipher.

	Miscellaneous:

	* ABI detection on mips, with improved default libdir
	  location. Contributed by Klaus Ziegler.

	* Fixes for ARM assembly syntax, to work better with the clang
	  assembler. Thanks to Jukka Ukkonen.

27
28
29
	* Disabled use of ifunc relocations for fat builds, to fix
	  problems most triggered by using dlopen with RTLD_NOW.

Niels Möller's avatar
Niels Möller committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
NEWS for the Nettle 3.1.1 release

	This release fixes a couple of non-critical bugs.

	Bug fixes:

	* By accident, nettle-3.1 disabled the assembly code for the
	  secp_224r1 and secp_521r1 elliptic curves on all x86_64
	  configurations, making signature operations on those curves
	  10%-30% slower. This code is now re-enabled.

	* The x86_64 assembly implementation of gcm hashing has been
          fixed to work with the Sun/Oracle assembler.

	The shared library names are libnettle.so.6.1 and
	libhogweed.so.4.1, with sonames still libnettle.so.6 and
	libhogweed.so.4. It is intended to be fully binary compatible
	with nettle-3.1.

49
50
51
52
NEWS for the Nettle 3.1 release

	This release adds a couple of new features.

Niels Möller's avatar
Niels Möller committed
53
54
55
56
57
58
	The library is mostly source-level compatible with nettle-3.0.
	It is however not binary compatible, due to the introduction
	of versioned symbols, and extensions to the base64 context
	structs. The shared library names are libnettle.so.6.0 and
	libhogweed.so.4.0, with sonames libnettle.so.6 and
	libhogweed.so.4.
59
60
61

	Bug fixes:

Niels Möller's avatar
Niels Möller committed
62
63
64
65
	* Fixed a missing include of <limits.h>, which made the
	  camellia implementation fail on all 64-bit non-x86
	  platforms.

66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
	* Eliminate out-of-bounds reads in the C implementation of
	  memxor (related to valgrind's --partial-loads-ok flag).

	Interface changes:

	* Declarations of many internal functions are moved from ecc.h
	  to ecc-internal.h. The functions are undocumented, and
	  luckily they're apparently also unused by applications, so I
	  don't expect any problems from this change.

	New features:

	* Support for curve25519 and for EdDSA25519 signatures.

	* Support for "fat builds" on x86_64 and arm, where the
	  implementation of certain functions is selected at run-time
	  depending on available cpu features. Configure with
	  --enable-fat to try this out. If it turns out to work well
	  enough, it will likely be enabled by default in later
	  releases.

	* Support for building the hogweed library (public key
	  support) using "mini-gmp", a small but slower implementation
	  of a subset of the GMP interfaces. Note that builds using
	  mini-gmp are *not* binary compatible with regular builds,
	  and more likely to leak side-channel information.

Niels Möller's avatar
Niels Möller committed
93
	  One intended use-case is for small embedded applications
94
95
	  which need to verify digital signatures.

Niels Möller's avatar
Niels Möller committed
96
97
98
99
100
101
102
	* The shared libraries are now built with versioned symbols.
	  Should reduce problems in case a program links explicitly to
	  nettle and/or hogweed, and to gnutls, and the program and
	  gnutls expect different versions.

	* Support for "URL-safe" base64 encoding and decoding, as
          specified in RFC 4648. Contributed by Amos Jeffries.
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

	Optimizations:

	* New x86_64 implementation of AES, using the "aesni"
	  instructions. Autodetected in fat builds. In non-fat builds,
	  it has to be enabled explicitly with --enable-x86-aesni.

	Build system:

	* Use the same object files for both static and shared
	  libraries. This eliminates the *.po object files which were
	  confusing to some tools (as well as humans). Like before,
	  PIC code is used by default; to build a non-pic static
	  library, configure with --disable-pic --disable-shared.

	Miscellaneous:

	* Made type-checking hack in CBC_ENCRYPT and similar macros
	  stricter, to generate warnings if they are used with
	  functions which have a length argument smaller than size_t.

124
NEWS for the Nettle 3.0 release
125

126
127
128
129
130
131
	This is a major release, including several interface changes,
	and new features, some of which are a bit experimental.
	Feedback is highly appreciated.

	It is *not* binary (ABI) compatible with earlier versions. It
	is mostly source-level (API) compatible, with a couple of
132
133
134
135
	incompatibilities noted below. The shared library names are
	libnettle.so.5.0 and libhogweed.so.3.0, with sonames
	libnettle.so.5 and libhogweed.so.3.
	
136
137
138
139
140
141
142
143
144
	There may be some problems in the new interfaces and new
	features which really need incompatible fixes. It is likely
	that there will be an update in the form of a 3.1 release in
	the not too distant future, with small but incompatible
	changes, and if that happens, bugfix-only releases 3.0.x are
	unlikely. Users and applications which desire better API and
	ABI stability are advised to stay with nettle-2.7.x (latest
	version is now 2.7.1) until the dust settles.

145
146
147
	Interface changes:

	* For the many _set_key functions, it is now consider the
148
149
150
151
	  normal case to have a fixed key size, with no key_size
	  arguments. _set_key functions with a length parameter are
	  provided only for algorithms with a truly variable keysize,
	  and where it makes sense for backwards compatibility.
152

153
154
155
	  INCOMPATIBLE CHANGE: cast128_set_key no longer accepts a key
	  size argument. The old function is available under a new
	  name, cast5_set_key.
156
157
158
159
160

	  INCOMPATIBLE CHANGE: The function typedef
	  nettle_set_key_func no longer accepts a key size argument.
	  In particular, this affects users of struct nettle_cipher.

161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
	* The nettle_cipher abstraction (in nettle-meta.h) is
	  restricted to block ciphers only. The encrypt and decrypt
	  functions now take a const argument for the context.

	  INCOMPATIBLE CHANGE: nettle_arcfour, i.e., the nettle_cipher
	  abstraction for the arcfour stream cipher, is deleted.

	  INCOMPATIBLE CHANGE: New type, nettle_cipher_func, for the
	  encrypt and decrypt fields of struct nettle_cipher.

	* New DSA interface, with a separate struct dsa_param to
	  represent the underlying group, and generalized dsa_sign and
	  dsa_verify functions which don't care about the hash
	  function used. Limited backwards compatibility provided in
	  dsa-compat.h.

	  INCOMPATIBLE CHANGE: Declarations of the old interface,
	  e.g., struct dsa_public_key, dsa_sha1_sign, etc, is moved to
	  dsa-compat.h.

	  INCOMPATIBLE CHANGE: The various key conversion functions,
	  e.g., dsa_keypair_to_sexp, all use the new DSA interface, with
	  no backwards compatible functions.

	  INCOMPATIBLE CHANGE: dsa_generate_keypair also uses the new
	  interface. dsa-compat.h declares a function
187
	  dsa_compat_generate_keypair, implementing the old
188
189
190
	  interface, and #defines dsa_generate_keypair to refer to
	  this backwards compatible function.

191
	* New AES and Camellia interfaces. There are now separate
192
193
194
195
196
	  context structs for each key size, e.g., aes128_ctx and
	  camellia256_ctx, and corresponding new functions. The old
	  interface, with struct aes_ctx and struct camellia_ctx, is
	  kept for backwards compatibility, but might be removed in
	  later versions.
197
198

	* The type of most length arguments is changed from unsigned
199
200
201
	  to size_t. The memxor functions have their pointer arguments
	  changed from uint8_t * to void *, for consistency with
	  related libc functions.
202

203
204
205
206
	* For hash functions, the constants *_DATA_SIZE have been
	  renamed to *_BLOCK_SIZE. Old names kept for backwards
	  compatibility.

207
208
209
210
211
	Removed features:

	* The nettle_next_prime function has been deleted.
	  Applications should use GMP's mpz_nextprime instead.

212
213
214
	* Deleted the RSAREF compatibility, including the header file
	  rsa-compat.h and everything declared therein.

215
216
217
218
219
220
221
	* Also under consideration for removal is des-compat.h and
	  everything declared therein. This implements a subset of the
	  old libdes/ssleay/openssl interface for DES and triple-DES,
	  and it is poorly tested. If anyone uses this interface,
	  please speak up! Otherwise, it will likely be removed in the
	  next release.
	
222
223
224
	Bug fixes:

	* Building with ./configure --disable-static now works.
225
226
227
228

	* Use GMP's allocation functions for temporary storage related
	  to bignums, to avoid potentially large stack allocations.

229
230
	* Fixes for shared libraries on M$ Windows.

231
232
	New features:

233
	* Support for Poly1305-AES MAC.
234

235
236
237
238
239
	* Support for the ChaCha stream cipher and EXPERIMENTAL
	  support for the ChaCha-Poly1305 AEAD mode. Specifications
	  are still in flux, and future releases may do incompatible
	  changes to track standardization. Currently uses 256-bit key
	  and 64-bit nonce.
240
241
242

	* Support for EAX mode.

243
244
	* Support for CCM mode. Contributed by Owen Kirby.

245
246
	* Additional variants of SHA512 with output size of 224 and
	  256 bits. Contributed by Joachim Strömbergson.
247
248
249
250
251
252
253

	* New interface, struct nettle_aead, for mechanisms providing
	  authenticated encryption with associated data (AEAD).

	* DSA: Support a wider range for the size of q and a wider
	  range for the digest size.

254
255
256
	Optimizations:

	* New x86_64 assembly for GCM and MD5. Modest speedups on the
257
258
	  order of 10%-20%.

259
260
	Miscellaneous:

261
262
263
264
265
266
	* SHA3 is now documented as EXPERIMENTAL. Nettle currently
	  implements SHA3 as specified at the time Keccak won the SHA3
	  competition. However, the final standard specified by NIST
	  is likely to be incompatible, in which case future releases
	  may do incompatible changes to track standardization.

267
268
269
270
	* The portability fix for the rotation macros, mentioned in
	  NEWS for 2.7.1, actually didn't make it into that release.
	  It is included now.

271
272
273
274
275
	* cast128_set_key rewritten for clarity, also eliminating a
	  couple of compiler warnings.

	* New command line tool nettle-pbkdf2.

276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
NEWS for the 2.7.1 release

        This is a bugfix release.

        Bug fixes:

        * Fixed a bug in the new ECC code. The ecc_j_to_a function
          called GMP:s mpn_mul_n (via ecc_modp_mul) with overlapping
          input and output arguments, which is not supported.

        * The assembly files for SHA1, SHA256 and AES depend on ARMv6
          instructions, breaking nettle-2.7 for pre-v6 ARM processors.
          The configure script now enables those assembly files only
          when building for ARMv6 or later.
          
        * Use a more portable C expression for rotations. The
          previous version used the following "standard" expression
          for 32-bit rotation:

            (x << n) | (x >> (32 - n))

          But this gives undefined behavior (according to the C
          specification) for n = 0. The rotate expression is replaced
          by the more portable:

            (x << n) | (x >> ((-n)&31))

          This change affects only CAST128, which uses non-constant
          rotation counts. Unfortunately, the new expression is poorly
          optimized by released versions of gcc, making CAST128 a bit
          slower. This is being fixed by the gcc hackers, see
          http://gcc.gnu.org/bugzilla/show_bug.cgi?id=57157.
          
        The following problems have been reported, but are *not* fixed
        in this release:

        * ARM assembly files use instruction syntax which is not
          supported by all assemblers. Workaround: Use a current
          version of GNU as, or configure with --disable-assembler.

        * Configuring with --disable-static doesn't work on windows.
        
        The libraries are intended to be binary compatible with
        nettle-2.2 and later. The shared library names are
        libnettle.so.4.7 and libhogweed.so.2.5, with sonames still
        libnettle.so.4 and libhogweed.so.2.
	
Niels Möller's avatar
Niels Möller committed
323
324
NEWS for the 2.7 release

325
326
	This release includes an implementation of elliptic curve
	cryptography (ECC) and optimizations for the ARM architecture.
Niels Möller's avatar
Niels Möller committed
327
328
	This work was done at the offices of South Pole AB, and
	generously funded by the .SE Internet Fund.
329

Niels Möller's avatar
Niels Möller committed
330
331
	Bug fixes:

332
	* Fixed a bug in the buffer handling for incremental SHA3
Niels Möller's avatar
Niels Möller committed
333
334
335
	  hashing, with a possible buffer overflow. Patch by Edgar
	  E. Iglesias.

336
337
338
339
340
341
342
343
344
	New features:

	* Support for ECDSA signatures. Elliptic curve operations over
	  the following curves: secp192r1, secp224r1, secp256r1,
	  secp384r1 and secp521r1, including x86_64 and ARM assembly
	  for the most important primitives.
	  
	* Support for UMAC, including x86_64 and ARM assembly.

Niels Möller's avatar
Niels Möller committed
345
346
347
	* Support for 12-round salsa20, "salsa20r12", as specified by
	  eSTREAM. Contributed by Nikos Mavrogiannopoulos.
	
348
349
350
351
352
353
354
355
356
357
358
359
	Optimizations:

	* ARM assembly code for several additional algorithms,
	  including AES, Salsa20, and the SHA family of hash
	  functions. 

	* x86_64 assembly for SHA256, SHA512, and SHA3. (SHA3 assembly
          was included in the 2.6 release, but disabled due to poor
          performance on some AMD processors. Hopefully, that
          performance problem is fixed now).
	
	The ARM code was tested and benchmarked on Cortex-A9. Some of
360
361
362
363
	the functions use "neon" instructions. The configure script
	decides if neon instructions can be used, and the command line
	options --enable-arm-neon and --disable-arm-neon can be used
	to override its choice. Feedback appreciated.
364
365
366
367
368
369
	  
	The libraries are intended to be binary compatible with
	nettle-2.2 and later. The shared library names are
	libnettle.so.4.6 and libhogweed.so.2.4, with sonames still
	libnettle.so.4 and libhogweed.so.2.

Simon Josefsson's avatar
Simon Josefsson committed
370
371
NEWS for the 2.6 release

Niels Möller's avatar
Niels Möller committed
372
373
374
375
376
377
378
379
380
	Bug fixes:

	* Fixed a bug in ctr_crypt. For zero length (which should be a
	  NOP), it sometimes incremented the counter. Reported by Tim
	  Kosse.

	* Fixed a small memory leak in nettle_realloc and
          nettle_xrealloc.

Simon Josefsson's avatar
Simon Josefsson committed
381
382
	New features:

Niels Möller's avatar
Niels Möller committed
383
384
	* Support for PKCS #5 PBKDF2, to generate a key from a
          password or passphrase. Contributed by Simon Josefsson.
Simon Josefsson's avatar
Simon Josefsson committed
385
386
          Specification in RFC 2898 and test vectors in RFC 6070.

Niels Möller's avatar
Niels Möller committed
387
388
	* Support for SHA3.
	  
Niels Möller's avatar
Niels Möller committed
389
390
391
392
393
	* Support for the GOST R 34.11-94 hash algorithm. Ported from
	  librhash by Nikos Mavrogiannopoulos. Written by Aleksey
	  Kravchenko. More information in RFC4357. Test vectors taken
	  from the GOST hash wikipedia page.

Niels Möller's avatar
Niels Möller committed
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
	Miscellaneous:

	* The include file <nettle/sha.h> has been split into
          <nettle/sha1.h> and <nettle/sha2.h>. For now, sha.h is kept
          for backwards compatibility and it simply includes both
          files, but applications are encouraged to use the new names.
          The new SHA3 functions are declared in <nettle/sha3.h>.

	* Testsuite can be run under valgrind, using

	  make check EMULATOR='$(VALGRIND)'

	  For this to work, test programs and other executables now
	  deallocate storage.
	  
	* New configure options --disable-documentation and
          --disable-static. Contributed by Sam Thursfield and Alon
	  Bar-Lev, respectively.
	  
	* The section on hash functions in the manual is split into
          separate nodes for recommended hash functions and legacy
          hash functions.

	* Various smaller improvements, most of them portability
          fixes. Credits go to David Woodhouse, Tim Rühsen, Martin
          Storsjö, Nikos Mavrogiannopoulos, Fredrik Thulin and Dennis
          Clarke.

	Finally, a note on the naming of the various "SHA" hash
	functions. Naming is a bit inconsistent; we have, e.g.,

	  SHA1: sha1_digest
	  SHA2: sha256_digest   (not sha2_256_digest)
	  SHA3: sha3_256_digest

	Renaming the SHA2 functions to make Nettle's naming more
	consistent has been considered, but the current naming follows
	common usage. Most documents (including the specification for
	SHA2) refer to 256-bit SHA2 as "SHA-256" or "SHA256" rather
	than "SHA2-256".
Nikos Mavrogiannopoulos's avatar
Nikos Mavrogiannopoulos committed
434

435
436
437
438
439
	The libraries are intended to be binary compatible with
	nettle-2.2 and later. The shared library names are
	libnettle.so.4.5 and libhogweed.so.2.3, with sonames still
	libnettle.so.4 and libhogweed.so.2

440
441
NEWS for the 2.5 release

442
443
	This release includes important portability fixes for Windows
	and MacOS. There are also a few new features.
444
445
446
447
448
449

	First a *warning*: Some internal functions have been removed
	from the library. Since the functions in question are internal
	and not documented, this is not considered a change of ABI or
	API. Programs explicitly using any of these functions will
	break.
450
	
451
	* The function pkcs1_signature_prefix has been renamed to
452
	  _pkcs1_signature_prefix, and with slightly different
453
454
455
456
457
458
	  behavior.

	* The file nettle-internal.c is no longer included in the
          library (the features defined there are used by the
          benchmark and test programs, and were never intended for
          public use).
459
460
461

	New features:

462
	* Support for the salsa20 stream cipher, including x86_64
463
464
465
466
467
468
469
470
471
472
          assembler. Originally contributed by Simon Josefsson, based
          on the reference implementation, then further optimized.

	* Tentative interface for timing-resistant RSA functions,
          contributed by Nikos Mavrogiannopoulos.

	* A more general interface for PKCS#1 signatures, taking the
          input in the form of a "DigestInfo". Suggested by Nikos
          Mavrogiannopoulos.

473
	Configuration:
474
	
475
476
477
	* Building of shared libraries (./configure --enable-shared)
          is now enabled by default.

478
	* Various portability fixes for MacOS and M$ Windows. A lot of
Niels Möller's avatar
Niels Möller committed
479
	  this work done by Martin Storsjö.
480
481

	* In particular, Nettle now hopefully works on 64-bit Windows
482
	  builds, "W64", including the x86_64 assembly code.
483

484
485
	Miscellaneous:
	
486
487
488
	* Documentation and example programs for the base16 and base64
	  functions. Was contributed by Jeronimo Pellegrini back in
	  2006, but unfortunately forgotten until now.
489

490
491
492
493
	* Use an additional table to avoid GF2^8 multiplications in
	  aes_invert_key (mainly used by aes_set_decrypt_key). Also
	  tabulate round constants in aes_set_encrypt_key.

494
495
496
497
498
499
500
501
502
503
504
505
	* The nettle repository has been migrated from cvs to git,
	  with a public repository at
	  http://git.lysator.liu.se/nettle. To make it independent of
	  the LSH repository, a few files have been moved around.
	  While at it, files have also been converted from latin-1 to
	  utf-8.

	The libraries are intended to be binary compatible with
	nettle-2.2 and later. The shared library names are
	libnettle.so.4.4 and libhogweed.so.2.2, with sonames still
	libnettle.so.4 and libhogweed.so.2

Niels Möller's avatar
Niels Möller committed
506
507
508
509
510
511
512
513
514
515
516
NEWS for the 2.4 release

	This is a bugfix release only. It turned out ripemd160 in the
	2.3 release was broken on all big-endian systems, due to a
	missing include of config.h. nettle-2.4 fixes this.

	The library is intended to be binary compatible with
	nettle-2.2 and nettle-2.3. The shared library names are
	libnettle.so.4.3 and libhogweed.so.2.1, with sonames still
	libnettle.so.4 and libhogweed.so.2.
	
Niels Möller's avatar
Niels Möller committed
517
518
NEWS for the 2.3 release

Niels Möller's avatar
Niels Möller committed
519
	* Support for the ripemd-160 hash function.
Niels Möller's avatar
Niels Möller committed
520

Niels Möller's avatar
Niels Möller committed
521
522
523
524
525
526
527
528
529
530
	* Generates and installs nettle.pc and hogweed.pc files, for
          use with pkg-config. Feedback appreciated. For projects
          using autoconf, the traditional non-pkg-config ways of
          detecting libraries, and setting LIBS and LDFLAGS, is still
          recommended.

	* Fixed a bug which made the testsuite fail in the GCM test on
	  certain platforms. Should not affect any documented features
	  of the library.

Niels Möller's avatar
Niels Möller committed
531
	* Reorganization of the code for the various Merkle-Damgård
Niels Möller's avatar
Niels Möller committed
532
533
534
535
536
537
538
539
540
541
542
543
	  hash functions. Some fields in the context structs for md4,
	  md5 and sha1 have been renamed, for consistency.
	  Applications should not peek inside these structs, and the
	  ABI is unchanged.
	  
	* In the manual, fixed mis-placed const in certain function
          prototypes.

	The library is intended to be binary compatible with
	nettle-2.2. The shared library names are libnettle.so.4.2 and
	libhogweed.so.2.1, with sonames still libnettle.so.4 and
	libhogweed.so.2.
Niels Möller's avatar
Niels Möller committed
544

Niels Möller's avatar
Niels Möller committed
545
546
NEWS for the 2.2 release

547
548
	Licensing change:
     	
Niels Möller's avatar
Niels Möller committed
549
	* Relicensed as LGPL v2.1 or later (user's option).
Niels Möller's avatar
Niels Möller committed
550

551
552
553
554
555
	* Replaced blowfish and serpent implementation. New code is
          based on the LGPLed code in libgcrypt.

	New features:

Niels Möller's avatar
Niels Möller committed
556
	* Support for Galois/Counter Mode (GCM).
557
558
559
560
561

	* New interface for enumerating (most) available algorithms,
	  contributed by Daniel Kahn Gillmor.

	* New tool nettle-hash. Can generate hash digests using any
Niels Möller's avatar
Niels Möller committed
562
563
564
	  supported hash function, with output compatible with md5sum
	  and friends from GNU coreutils. Checking (like md5sum -c)
	  not yet implemented.
565
566
567
568
569
570
571

	Bug fixes:

	* The old serpent code had a byte order bug (introduced by
	  yours truly about ten years ago). New serpent implementation
	  does not interoperate with earlier versions of nettle.

Niels Möller's avatar
Niels Möller committed
572
573
574
	* Fixed ABI-dependent libdir default for Linux-based systems
	  which do not follow the Linux File Hierarchy Standard, e.g.,
	  Debian GNU/Linux.
575
576

	Optimizations:
Niels Möller's avatar
Niels Möller committed
577
	
Niels Möller's avatar
Niels Möller committed
578
	* x86_64 implemention of serpent.
579
580
581

	* x86_64 implemention of camellia.

Niels Möller's avatar
Niels Möller committed
582
583
	* Optimized memxor using word rather than byte operations.
          Both generic C and x86_64 assembler.
Niels Möller's avatar
Niels Möller committed
584

Niels Möller's avatar
Niels Möller committed
585
586
	* Eliminated a memcpy for in-place CBC decrypt.
	
587
588
	Miscellaneous:

Niels Möller's avatar
Niels Möller committed
589
590
591
	* In command line tools, no longer support -? for requesting
          help, since using it without shell quoting is a dangerous
          habit. Use long option --help instead.
Niels Möller's avatar
Niels Möller committed
592

593
594
595
596
	The shared library names are libnettle.so.4.1 and
	libhogweed.so.2.1, with sonames libnettle.so.4 and
	libhogweed.so.2.

Niels Möller's avatar
Niels Möller committed
597
NEWS for the 2.1 release
Niels Möller's avatar
Niels Möller committed
598
599

	*Important*: this release breaks source and binary
Niels Möller's avatar
Niels Möller committed
600
601
602
	compatibility for the digital signature functions, and for the
	DES and BLOWFISH ciphers which have weak keys.

Niels Möller's avatar
Niels Möller committed
603
604
605
	Incompatible changes:

	* The functions rsa_md5_sign, rsa_sha1_sign and
Niels Möller's avatar
Niels Möller committed
606
          rsa_sha256_sign, and the corresponding _digest variants, now
Niels Möller's avatar
Niels Möller committed
607
608
609
610
611
612
613
          have a return value which callers should check. The functions
          return failure if the key is too small for the type of
          signature.

	* The functions dsa_sign and dsa_verify are renamed to
          dsa_sha1_sign and dsa_sha1_verify. The _-digest variants are
          renamed similarly. These functions now have a return value
Niels Möller's avatar
Niels Möller committed
614
          which callers should check, and they return failure if the
Niels Möller's avatar
Niels Möller committed
615
616
          number q is not of the appropriate size.

617
618
619
620
621
622
623
624
625
626
627
	* The return value from des_set_key, des3_set_key and
	  blowfish_set_key now indicates whether or not the given key
	  is weak. But in either case, the key setup is done, and
	  applications that don't care about weak keys can ignore the
	  return value.

	  The incompatible part of this change is that enum des_error
	  and enum blowfish_error has been deleted, and so has the
	  status attribute in struct des_ctx, struct des3_ctx, and
	  struct blowfish_ctx.

628
629
630
631
	The shared library names are libnettle.so.4.0 and
	libhogweed.so.2.0, with sonames libnettle.so.4 and
	libhogweed.so.2.

Niels Möller's avatar
Niels Möller committed
632
633
	Other changes:

634
635
	* Support for the Camellia block cipher, including an
          assembler implementation for x86_32.
Niels Möller's avatar
Niels Möller committed
636
637
638
639

	* New function aes_invert_key, useful for applications that
	  need both encryption and decryption using the same AES key.
	  
640
641
642
643
644
	* des_set_key and des3_set_key no longer check the key parity
	  bits. Parity bits are silently ignored. A new function
	  des_check_parity is provided, for applications that care
	  about the DES parity bits.

Niels Möller's avatar
Niels Möller committed
645
646
647
648
649
650
651
	* Support for sha224, sha384 and sha512.

	* Support for digital signatures using rsa-sha512 and
          dsa-sha256. Due to lack of official test vectors and interop
          testing, this support should be considered somewhat
          experimental.

Niels Möller's avatar
Niels Möller committed
652
653
654
655
656
	* Key generation for RSA and DSA changed to use Maurer's
	  algorithm to generate provably prime numbers (as usual, the
	  mathematical proof does not guaranteee that the
	  implementation is bug free).
	  
Niels Möller's avatar
Niels Möller committed
657
658
659
660
	* x86_64 assembler implementation actually included in the
	  distribution (was accidentally left out in nettle-2.0).

	* Configure script now detects if the compiler uses a 32-bit
661
          or 64-bit ABI on x86_64 (prevously did this for sparc only).
Niels Möller's avatar
Niels Möller committed
662
          Also sets the default location for installing libraries
Niels Möller's avatar
Niels Möller committed
663
          (libdir) depending on system type and the ABI used.
Niels Möller's avatar
Niels Möller committed
664
665
666
667
668
669
670
671
672
673
674
675

	* Added the nettle and gmp libraries as dependencies when
          linking shared library libhogweed.so. On systems using
          shared libraries where such dependencies work (in
          particular, ELF systems), it is sufficient to link
          applications with -lhogweed. For static linking -lhogweed
          -lnettle -lgmp is still required.

	* The program pkcs1-conv is extended to also handle dsa keys.
          Contributed by Magnus Holmgren.

	* Slightly improved sha1 performance on x86.
676

Niels Möller's avatar
Niels Möller committed
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
NEWS for the 2.0 release

	This release breaks binary compatibility by splitting the
	library into two. Some other smaller changes that are not
	backwards compatible are also done at the same time.

	* The nettle library is split into two libraries, libnettle
	  and libhogweed. libnettle contains the symmetric crypto
	  algorithms that don't depend on GMP, while libhogweed
	  contains the public key algorithms that depend on GMP.
	  Using a single library worked fine with static linking, but
	  not with dynamic linking. Consider an application that uses
	  nettle and which doesn't use any public key cryptography. If
	  this application is linked dynamically to nettle, it would
	  have to be linked also with GMP if and only if public key
	  support was enabled when the nettle library was installed.

	  The library names are libnettle.so.3.0 and
	  libhogweed.so.1.0, with sonames libnettle.so.3 and
	  libhogweed.so.1.

	* Function typedefs have been changed to non-pointer types.
	  E.g, the

	    typedef void (nettle_hash_init_func *)(void *ctx);

	  of previous versions is replaced by

	    typedef void (nettle_hash_init_func)(void *ctx);

	  This makes it possible to use the type when declaring
	  functions, like

	    nettle_hash_init_func foo_hash_init;

	    void foo_hash_init(void *ctx) { ... }

	* Changes to the yarrow256 interface. The automatic seed file
	  generation, and the seed_file member in struct
	  yarrow256_ctx, has been removed. To generate a new seed
	  file, use yarrow256_random. The function
	  yarrow256_force_reseed has been replaced by the two
	  functions yarrow256_fast_reseed and yarrow256_slow_reseed,
	  which were previously static. This interface change makes it
	  easier to mix in the current content of the seed file before
	  overwriting it with newly generated data.

	Other changes:

726
727
728
729
	* Nettle manual now contributed to the public domain, to
          enable remixing into documentation of programs that use
          Nettle.	  

Niels Möller's avatar
Niels Möller committed
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
	* The sexp-conv program preserves comments when using the
	  advanced syntax for output. Optionally locks the output
	  file.

	* The base64 decoder recognizes ASCII FF (form feed) and VT
          (vertical tab) as white space.

	* New x86_64 implementations of AES and SHA1. On a 2.2 GHz
          opteron, SHA1 was benchmarked at 250 MByte/s, and AES-128 at
          110 MByte/s.

	* Performance of AES increased by 20-30% on x86.

	* New programs in the examples directory: erathostenes and
          next-prime.
	
Niels Möller's avatar
Niels Möller committed
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
NEWS for the 1.15 release

	Added support for PKCS#1 style RSA signatures using SHA256,
	according to RFC 3447. Currently lacks interoperability
	testing.
	
	Header files are now C++ aware, so C++ programs using Nettle
	should now use plain

	  #include <nettle/foo.h>

	rather than

	  #extern "C" {
	  #include <nettle/foo.h>
	  }

	as was the recommendation for the previous version. This
	breaks source-level compatibility with C++, even though
	there's full binary compatibility.

	The file rfc1750.txt (which is considered non-free by debian)
	has been removed from the distribution. The file was used as input
	for the Yarrow testcase, and has been replaced by the short
	story "The Gold-bug" by Edgar Allan Poe. Anyway, RFC 1750 is
	obsoleted by RFC 4086.

	Fixes for Darwin shared library support, contributed by Grant
	Robinsson.

	Example programs now use a supplied getopt.c.

	Configure tests for assemblers with a logarithmic .align
	directive.

	The library is intended to be upwards binary compatible with
	earlier versions. The library name is libnettle.so.2.6, soname
	is still libnettle.so.2.
		
785
786
NEWS for the 1.14 release

Niels Möller's avatar
Niels Möller committed
787
788
789
	Experimental support for reading keys in PKCS#1 ASN1/DER
	format, and a new command line tool pkcs1-conv.
	
790
791
	Improved MD5 performance on x86.

Niels Möller's avatar
Niels Möller committed
792
793
	Fixed support for sparc64.

794
795
796
797
798
799
800
801
802
	Reorganized AES code. Better performance for all three
	implementations (C, x86 assembler, sparc assembler).

	New sparc assembler for arcfour. Compared to the code
	generated by gcc, the new code is about 25% faster on old
	sparcs, and 6 times faster on ultrasparc.

	Replaced the internal function nettle_mpz_from_octets with a
	call to mpz_import, if available in the installed GMP library.
Niels Möller's avatar
Niels Möller committed
803
804
805
806
807
808
809
810
811

	More Makefile fixes; it now seems to work to build with
	the the make programs on Solaris and FreeBSD (although
	--disable-dependency-tracking is required for the latter).

	The library is intended to be binary compatible with earlier
	versions. The library name is libnettle.so.2.5, soname is
	still libnettle.so.2.

Niels Möller's avatar
Niels Möller committed
812
813
814
815
816
NEWS for the 1.13 release

	Fixed problem with broken m4 on bsd, which resulted in
	corrupted x86 assembler for sha1.

Niels Möller's avatar
Niels Möller committed
817
818
819
820
821
822
823
	Nettle probably works on windows: I've been able to cross
	compile it with ./configure --host=i586-mingw32msvc (without
	public-key support), and the testsuite binaries seem to run
	fine in Wine.

	Implemented CTR mode.

Niels Möller's avatar
Niels Möller committed
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
	Improved sha1 performance on x86.

	Configure check to figure out if symbols in assembler files
	need a leading underscore.

	Improved benchmark program. Displays cycles per byte and block,
	and compares with openssl (if openssl is installed).
	
	Terminating newline in output from sexp-conv --hash.

	The library is intended to be binary compatible with earlier
	versions. The library name is libnettle.so.2.4. However, the
	interface for the internal function _nettle_sha1_compress has
	changed; any program that calls this function directly will
	break.

840
841
842
843
844
845
846
NEWS for the 1.12 release
	
	Fixed a bug in the configure script.

	Updated the description of aes_set_encrypt_key and
	aes_set_decrypt_key in the manual.

847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
NEWS for the 1.11 release

	Nettle no longer uses automake. Side effects:

	  * Dependency tracking is enabled only for gcc-3 (help with
	    supporting dependency tracking with other compilers is
	    appreciated).
	  
	  * Makefile compatibility with make programs other than GNU
	    make is mostly unknown, please report any problems.

	Support for arctwo.

	Fixes to the libdes compatibility code. Declarations should
	now match openssl/libdes better. des_cbc_cksum pads
	input with NUL's, if it's not an integral number of blocks (in
	general, such unreversible padding is a bad idea).

	By default, also the static library is compiled as position
	independent code. This is needed on some systems to make it
	possible to link nettle into a dynamically loaded module. Use
	the configure flag --disable-pic if this is not desired.

	Stricter constness typing for the sexp_iterator_assoc and
	sexp_iterator_check_types arguments.

Niels Möller's avatar
Niels Möller committed
873
874
	Minor tweaks of arcfour on x86 cpu:s, to speed it up on older
	x86 variants such as PII and PPro.
875

Niels Möller's avatar
Niels Möller committed
876
877
	The shared library is intended to be binary compatible with
	nettle-1.8 - nettle-1.10. Only the minor version number of the
Niels Möller's avatar
Niels Möller committed
878
879
	shared library is increased. The soname is still
	libnettle.so.2.
Niels Möller's avatar
Niels Möller committed
880

Niels Möller's avatar
Niels Möller committed
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
NEWS for the 1.10 release

	Nettle should now compile also on Tru64, Darwin, FreeBSD and
	Windows. (The only tested windows build uses the rntcl rsh
	wrapper to run the command line M$ C compiler "cl". See
	http://pike.ida.liu.se for those tools, I don't know all
	details about the Pike team's windows setup).

	There are some known testsuite failures, on Windows and on one
	of the xenofarm HPUX machines, see
	http://www.lysator.liu.se/~nisse/xeno-lsh/latest.html. Help
	tracking these down is appreciated.

	There are no new features.
	
	This release is intended to be binary compatible with
	nettle-1.8 and nettle-1.9.
	
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
NEWS for the 1.9 release

	Optimized C implementation of arcfour. Optimized x86
	implementations of arcfour and sha1.

	Improved benchmark program.
	
	Fixed bug in the rsa-encrypt example program.

	Fixed bug in make install, some of the header files were
	forgotten.
	
	Portability fixes. Fixes to make Nettle compile on systems
	without gmp. This version has been tested on GNU/Linux,
	Solaris, HPUX and AIX.

	The shared library is intended to be binary compatible with
	nettle-1.8. Only the minor version number of the shared
	library is increased.

Niels Möller's avatar
Niels Möller committed
919
920
NEWS for the 1.8 release

Niels Möller's avatar
Niels Möller committed
921
922
923
924
	New example programs, demonstrating encrypting and decrypting
	files using RSA, and random sessions keys for bulk encryption
	and message authentication.

Niels Möller's avatar
Niels Möller committed
925
926
927
928
	Support for systems that don't have alloca. On such systems,
	some of Nettle's functions have arbitrary limits applied to
	their input.

Niels Möller's avatar
Niels Möller committed
929
930
931
	Uses AX_CREATE_STDINT_H, to support systems without
	inttypes.h.

Niels Möller's avatar
Niels Möller committed
932
933
	Support for the md2 and md4 hash functions.
	 
Niels Möller's avatar
Niels Möller committed
934
	New name mangling, to reduce the risk of link collisions. All
Niels Möller's avatar
Niels Möller committed
935
	functions (except memxor) now use a nettle_ or _nettle_ prefix
Niels Möller's avatar
Niels Möller committed
936
	when seen by the linker. For most functions, the header file
Niels Möller's avatar
Niels Möller committed
937
938
	that declares a function also uses #define to provide a
	shorter more readable name without the prefix.
Niels Möller's avatar
Niels Möller committed
939

Niels Möller's avatar
Niels Möller committed
940
941
	The shared library soname for this version is libnettle.so.2.
	
942
943
NEWS for the 1.7 release

Niels Möller's avatar
Niels Möller committed
944
945
946
	Implemented DSA.

	Renamed RSA functions for consistency. Now it's
947
	rsa_public_key_init, not rsa_init_public_key, etc.
Niels Möller's avatar
Niels Möller committed
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962

	Both RSA and DSA now have sign/verify functions that take the
	hash digest as argument.

	A rewritten and much more powerful sexp-conv program.

	Other changes to the sexp code, in particular updating it to
	the latest SPKI draft.

	Building nettle as a shared library (ELF only) seems to work.
	The version number is increased, so the library "soname" for
	this release is "libnettle.so.1".

	Bugfixes. Fixes for build and portability problems.

Niels Möller's avatar
Niels Möller committed
963
964
NEWS for the 1.6 release

Niels Möller's avatar
Niels Möller committed
965
966
967
968
969
970
	Optimized assembler implementations of aes, for sparc and x86.

	The aes interface has changed slightly. The function
	aes_set_key is no more. Instead one has to use
	aes_set_encrypt_key or aes_set_decrypt_key. Sorry about that. 

Niels Möller's avatar
Niels Möller committed
971
972
973
974
975
976
977
978
979
980
981
	New example programs, rsa-keygen, rsa-sign and rsa-verify,
	located in the examples directory.

	New configure option --enable-shared, which builds a shared
	library. Not tested.

	New experimental features, including sexp parsing and
	formatting, and changes to base64 encoding and decoding. The
	interfaces to these functions are subject to change, and are
	documented only in the source code.
	
Niels Möller's avatar
Niels Möller committed
982
983
NEWS for the 1.5 release

Niels Möller's avatar
Niels Möller committed
984
	RSA support. Key generation and signatures.
Niels Möller's avatar
Niels Möller committed
985
	
Niels Möller's avatar
Niels Möller committed
986
	Support for HMAC (RFC-2104).
Niels Möller's avatar
Niels Möller committed
987

Niels Möller's avatar
Niels Möller committed
988
989
990
991
	An implementation of the Yarrow-256 PRNG.

	New sections in the manual.
	
Niels Möller's avatar
Niels Möller committed
992
993
994
995
996
	Changed the interface for hash functions. The md5_digest
	function is now equivalent to the old sequence of md5_final,
	md5_digest, md5_init, and similarly for the other hashing
	algorithms. This makes the interface simpler.

Niels Möller's avatar
Niels Möller committed
997
998
999
1000
NEWS for the 1.0 release

	Fixed twofish bug spotted by Jean-Pierre Stierlin.

Niels Möller's avatar
Niels Möller committed
1001
1002
	Added des3 and cbc.
	
Niels Möller's avatar
Niels Möller committed
1003
1004
1005
	New RFC-1321-like interface in nettle/md5-compat.h, suggested
	by Assar Westerlund.

Niels Möller's avatar
Niels Möller committed
1006
	New libdes-style compatibility interface in nettle/des-compat.h.