nettle.texinfo 147 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1
2
3
\input texinfo          @c -*-texinfo-*-
@c %**start of header
@setfilename nettle.info
4
@settitle Nettle: a low-level cryptographic library
Niels Möller's avatar
Niels Möller committed
5
@documentencoding UTF-8
6
@footnotestyle separate
Niels Möller's avatar
Niels Möller committed
7
@syncodeindex fn cp
8
@c %**end of header
Niels Möller's avatar
Niels Möller committed
9

10
@set UPDATED-FOR 2.6
Niels Möller's avatar
Niels Möller committed
11
@set AUTHOR Niels Möller
12

13
14
15
@copying
This manual is for the Nettle library (version @value{UPDATED-FOR}), a
low-level cryptographic library.
Niels Möller's avatar
Niels Möller committed
16

17
Originally written 2001 by @value{AUTHOR}, updated 2012.
Niels Möller's avatar
Niels Möller committed
18

19
@quotation
20
21
22
This manual is placed in the public domain. You may freely copy it, in
whole or in part, with or without modification. Attribution is
appreciated, but not required.
23
24
@end quotation
@end copying
Niels Möller's avatar
Niels Möller committed
25
26
27
28
29
30
31

@titlepage
@title Nettle Manual
@subtitle For the Nettle Library version @value{UPDATED-FOR}
@author @value{AUTHOR}
@page
@vskip 0pt plus 1filll
32
@insertcopying
Niels Möller's avatar
Niels Möller committed
33
34
@end titlepage

35
36
37
38
39
@dircategory Encryption
@direntry
* Nettle: (nettle).             A low-level cryptographic library.
@end direntry

40
41
@contents

Niels Möller's avatar
Niels Möller committed
42
43
44
@ifnottex
@node     Top, Introduction, (dir), (dir)
@comment  node-name,  next,  previous,  up
45
@top Nettle
Niels Möller's avatar
Niels Möller committed
46

47
48
49
This document describes the Nettle low-level cryptographic library. You
can use the library directly from your C programs, or write or use an
object-oriented wrapper for your favorite language or application.
Niels Möller's avatar
Niels Möller committed
50

51
@insertcopying
Niels Möller's avatar
Niels Möller committed
52
53

@menu
Niels Möller's avatar
Niels Möller committed
54
55
* Introduction::                What is Nettle?
* Copyright::                   Your rights.
56
57
* Conventions::                 General interface conventions.
* Example::                     An example program.
58
* Linking::                     Linking with the libnettle and libhogweed.
Niels Möller's avatar
Niels Möller committed
59
60
61
* Reference::                   All Nettle functions and features.
* Nettle soup::                 For the serious nettle hacker.
* Installation::                How to install Nettle.
62
* Index::                       Function and concept index.
63
64
65
66
67
68
69
70
71
72

@detailmenu
 --- The Detailed Node Listing ---

Reference

* Hash functions::              
* Cipher functions::            
* Cipher modes::                
* Keyed hash functions::        
Simon Josefsson's avatar
Simon Josefsson committed
73
* Key derivation functions::    
74
75
* Public-key algorithms::       
* Randomness::                  
76
* Ascii encoding::              
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
* Miscellaneous functions::     
* Compatibility functions::     

Cipher modes

* CBC::                         
* CTR::                         
* GCM::                         

Public-key algorithms

* RSA::                         The RSA public key algorithm.
* DSA::                         The DSA digital signature algorithm.

@end detailmenu
Niels Möller's avatar
Niels Möller committed
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
@end menu

@end ifnottex

@node Introduction, Copyright, Top, Top
@comment  node-name,  next,  previous,  up
@chapter Introduction

Nettle is a cryptographic library that is designed to fit easily in more
or less any context: In crypto toolkits for object-oriented languages
(C++, Python, Pike, ...), in applications like LSH or GNUPG, or even in
kernel space. In most contexts, you need more than the basic
cryptographic algorithms, you also need some way to keep track of available
algorithms, their properties and variants. You often have some algorithm
selection process, often dictated by a protocol you want to implement.

108
And as the requirements of applications differ in subtle and not so
Niels Möller's avatar
Niels Möller committed
109
110
111
112
113
114
115
116
117
118
subtle ways, an API that fits one application well can be a pain to use
in a different context. And that is why there are so many different
cryptographic libraries around.

Nettle tries to avoid this problem by doing one thing, the low-level
crypto stuff, and providing a @emph{simple} but general interface to it.
In particular, Nettle doesn't do algorithm selection. It doesn't do
memory allocation. It doesn't do any I/O.

The idea is that one can build several application and context specific
Niels Möller's avatar
Niels Möller committed
119
interfaces on top of Nettle, and share the code, test cases, benchmarks,
Niels Möller's avatar
Niels Möller committed
120
121
122
documentation, etc. Examples are the Nettle module for the Pike
language, and LSH, which both use an object-oriented abstraction on top
of the library.
Niels Möller's avatar
Niels Möller committed
123

124
125
126
127
This manual explains how to use the Nettle library. It also tries to
provide some background on the cryptography, and advice on how to best
put it to use.

Niels Möller's avatar
Niels Möller committed
128
129
130
131
@node Copyright, Conventions, Introduction, Top
@comment  node-name,  next,  previous,  up
@chapter Copyright

132
133
134
135
Nettle is distributed under the GNU Lesser General Public License
(LGPL), see the file COPYING.LIB for details. A few of the individual
files are in the public domain. To find the current status of particular
files, you have to read the copyright notices at the top of the files.
Niels Möller's avatar
Niels Möller committed
136

137
138
139
140
141
This manual is in the public domain. You may freely copy it in whole or
in part, e.g., into documentation of programs that build on Nettle.
Attribution, as well as contribution of improvements to the text, is of
course appreciated, but it is not required.

Niels Möller's avatar
Niels Möller committed
142
143
144
145
146
A list of the supported algorithms, their origins and licenses:

@table @emph
@item AES
The implementation of the AES cipher (also known as rijndael) is written
147
148
149
by Rafael Sevilla. Assembler for x86 by Rafael Sevilla and
@value{AUTHOR}, Sparc assembler by @value{AUTHOR}. Released under the
LGPL.
Niels Möller's avatar
Niels Möller committed
150
151
152

@item ARCFOUR
The implementation of the ARCFOUR (also known as RC4) cipher is written
153
by @value{AUTHOR}. Released under the LGPL.
Niels Möller's avatar
Niels Möller committed
154

Niels Möller's avatar
Niels Möller committed
155
156
157
158
159
@item ARCTWO
The implementation of the ARCTWO (also known as RC2) cipher is written
by Nikos Mavroyanopoulos and modified by Werner Koch and Simon
Josefsson. Released under the LGPL.

Niels Möller's avatar
Niels Möller committed
160
161
@item BLOWFISH
The implementation of the BLOWFISH cipher is written by Werner Koch,
162
copyright owned by the Free Software Foundation. Also hacked by Simon
Niels Möller's avatar
Niels Möller committed
163
Josefsson and Niels Möller. Released under the LGPL.
Niels Möller's avatar
Niels Möller committed
164

165
@item CAMELLIA
166
The C implementation is by Nippon Telegraph and Telephone Corporation
167
168
(NTT), heavily modified by @value{AUTHOR}. Assembler for x86 and x86_64
by @value{AUTHOR}. Released under the LGPL.
169

Niels Möller's avatar
Niels Möller committed
170
171
172
173
174
175
176
177
@item CAST128
The implementation of the CAST128 cipher is written by Steve Reid.
Released into the public domain.

@item DES
The implementation of the DES cipher is written by Dana L. How, and
released under the LGPL.

178
179
@item MD2
The implementation of MD2 is written by Andrew Kuchling, and hacked
180
some by Andreas Sigfridsson and @value{AUTHOR}. Python Cryptography
181
182
183
184
185
186
Toolkit license (essentially public domain).

@item MD4
This is almost the same code as for MD5 below, with modifications by
Marcus Comstedt. Released into the public domain.

Niels Möller's avatar
Niels Möller committed
187
188
@item MD5
The implementation of the MD5 message digest is written by Colin Plumb.
189
It has been hacked some more by Andrew Kuchling and @value{AUTHOR}.
Niels Möller's avatar
Niels Möller committed
190
191
Released into the public domain.

192
193
194
195
196
@item RIPMED160
The implementation of RIPEMD160 message digest is based on the code in
libgcrypt, copyright owned by the Free Software Foundation. Ported to
Nettle by Andres Mejia. Released under the LGPL.

Niels Möller's avatar
Niels Möller committed
197
198
@item SALSA20
The C implementation of SALSA20 is based on D. J. Bernstein's reference
199
200
201
implementation (in the public domain), adapted to Nettle by Simon
Josefsson, and heavily modified by Niels Möller. Assembly for x86_64 by
Niels Möller. Released under the LGPL.
Niels Möller's avatar
Niels Möller committed
202

Simon Josefsson's avatar
Simon Josefsson committed
203
204
205
206
@item PBKDF2
The C implementation of PBKDF2 is based on earlier work for Shishi and
GnuTLS by Simon Josefsson.  Released under the LGPL.

Niels Möller's avatar
Niels Möller committed
207
@item SERPENT
208
The implementation of the SERPENT cipher is based on the code in libgcrypt,
209
copyright owned by the Free Software Foundation. Adapted to Nettle by
Niels Möller's avatar
Niels Möller committed
210
211
Simon Josefsson and heavily modified by Niels Möller. Assembly for
x86_64 by Niels Möller. Released under the LGPL.
Niels Möller's avatar
Niels Möller committed
212
213

@item SHA1
214
215
216
217
The C implementation of the SHA1 message digest is written by Peter
Gutmann, and hacked some more by Andrew Kuchling and @value{AUTHOR}.
Released into the public domain. Assembler for x86 by @value{AUTHOR},
released under the LGPL.
Niels Möller's avatar
Niels Möller committed
218

Niels Möller's avatar
Niels Möller committed
219
@item SHA2
Niels Möller's avatar
Niels Möller committed
220
221
222
Written by @value{AUTHOR}, using Peter Gutmann's SHA1 code as a model. 
Released under the LGPL.

Niels Möller's avatar
Niels Möller committed
223
@item SHA3
224
225
Written by @value{AUTHOR}. Released under the LGPL.

226
227
228
229
230
@item GOSTHASH94
The C implementation of the GOST94 message digest is written by 
Aleksey Kravchenko and was ported from the rhash library by Nikos
Mavrogiannopoulos. It is released under the MIT license.

Niels Möller's avatar
Niels Möller committed
231
232
233
@item TWOFISH
The implementation of the TWOFISH cipher is written by Ruud de Rooij.
Released under the LGPL.
Niels Möller's avatar
Niels Möller committed
234
235
236
237
238
239
240
241

@item RSA
Written by @value{AUTHOR}, released under the LGPL. Uses the GMP library
for bignum operations.

@item DSA
Written by @value{AUTHOR}, released under the LGPL. Uses the GMP library
for bignum operations.
Niels Möller's avatar
Niels Möller committed
242
243
244
245
246
247
248
249
@end table

@node Conventions, Example, Copyright, Top
@comment  node-name,  next,  previous,  up
@chapter Conventions

For each supported algorithm, there is an include file that defines a
@emph{context struct}, a few constants, and declares functions for
250
operating on the context. The context struct encapsulates all information
Niels Möller's avatar
Niels Möller committed
251
252
253
needed by the algorithm, and it can be copied or moved in memory with no
unexpected effects.

254
255
For consistency, functions for different algorithms are very similar,
but there are some differences, for instance reflecting if the key setup
256
or encryption function differ for encryption and decryption, and whether
257
258
259
260
261
or not key setup can fail. There are also differences between algorithms
that don't show in function prototypes, but which the application must
nevertheless be aware of. There is no big difference between the
functions for stream ciphers and for block ciphers, although they should
be used quite differently by the application.
Niels Möller's avatar
Niels Möller committed
262

263
264
265
If your application uses more than one algorithm of the same type, you
should probably create an interface that is tailor-made for your needs,
and then write a few lines of glue code on top of Nettle.
Niels Möller's avatar
Niels Möller committed
266
267
268
269
270
271
272

By convention, for an algorithm named @code{foo}, the struct tag for the
context struct is @code{foo_ctx}, constants and functions uses prefixes
like @code{FOO_BLOCK_SIZE} (a constant) and @code{foo_set_key} (a
function).

In all functions, strings are represented with an explicit length, of
273
type @code{unsigned}, and a pointer of type @code{uint8_t *} or
Niels Möller's avatar
Niels Möller committed
274
275
276
277
@code{const uint8_t *}. For functions that transform one string to
another, the argument order is length, destination pointer and source
pointer. Source and destination areas are of the same length. Source and
destination may be the same, so that you can process strings in place,
278
but they @emph{must not} overlap in any other way.
Niels Möller's avatar
Niels Möller committed
279

280
281
282
Many of the functions lack return value and can never fail. Those
functions which can fail, return one on success and zero on failure.

283
284
@c FIXME: Say something about the name mangling.

285
@node Example, Linking, Conventions, Top
Niels Möller's avatar
Niels Möller committed
286
287
288
@comment  node-name,  next,  previous,  up
@chapter Example

289
290
291
A simple example program that reads a file from standard input and
writes its SHA1 checksum on standard output should give the flavor of
Nettle.
Niels Möller's avatar
Niels Möller committed
292
293

@example
294
@verbatiminclude sha-example.c
Niels Möller's avatar
Niels Möller committed
295
296
@end example

297
298
299
On a typical Unix system, this program can be compiled and linked with
the command line 
@example
300
gcc sha-example.c -o sha-example -lnettle
301
302
303
304
305
306
307
308
309
310
311
312
@end example

@node Linking, Reference, Example, Top
@comment  node-name,  next,  previous,  up
@chapter Linking

Nettle actually consists of two libraries, @file{libnettle} and
@file{libhogweed}. The @file{libhogweed} library contains those
functions of Nettle that uses bignum operations, and depends on the GMP
library. With this division, linking works the same for both static and
dynamic libraries.

313
314
315
316
317
318
319
If an application uses only the symmetric crypto algorithms of Nettle
(i.e., block ciphers, hash functions, and the like), it's sufficient to
link with @code{-lnettle}. If an application also uses public-key
algorithms, the recommended linker flags are @code{-lhogweed -lnettle
-lgmp}. If the involved libraries are installed as dynamic libraries, it
may be sufficient to link with just @code{-lhogweed}, and the loader
will resolve the dependencies automatically.
320
321

@node Reference, Nettle soup, Linking, Top
Niels Möller's avatar
Niels Möller committed
322
323
324
325
326
327
328
329
@comment  node-name,  next,  previous,  up
@chapter Reference

This chapter describes all the Nettle functions, grouped by family.

@menu
* Hash functions::              
* Cipher functions::            
330
* Cipher modes::                
Niels Möller's avatar
Niels Möller committed
331
* Keyed hash functions::        
Simon Josefsson's avatar
Simon Josefsson committed
332
* Key derivation functions::    
333
334
* Public-key algorithms::       
* Randomness::                  
335
* Ascii encoding::              
Niels Möller's avatar
Niels Möller committed
336
* Miscellaneous functions::     
337
* Compatibility functions::     
Niels Möller's avatar
Niels Möller committed
338
339
340
341
@end menu

@node Hash functions, Cipher functions, Reference, Reference
@comment  node-name,  next,  previous,  up
342

Niels Möller's avatar
Niels Möller committed
343
@section Hash functions
344
@cindex Hash function
Niels Möller's avatar
Niels Möller committed
345
346
347
348
349
350
351
352
353
354
A cryptographic @dfn{hash function} is a function that takes variable
size strings, and maps them to strings of fixed, short, length. There
are naturally lots of collisions, as there are more possible 1MB files
than 20 byte strings. But the function is constructed such that is hard
to find the collisions. More precisely, a cryptographic hash function
@code{H} should have the following properties:

@table @emph

@item One-way
355
@cindex One-way
Niels Möller's avatar
Niels Möller committed
356
357
358
359
Given a hash value @code{H(x)} it is hard to find a string @code{x}
that hashes to that value.

@item Collision-resistant
360
@cindex Collision-resistant
Niels Möller's avatar
Niels Möller committed
361
362
363
364
365
366
It is hard to find two different strings, @code{x} and @code{y}, such
that @code{H(x)} = @code{H(y)}.

@end table

Hash functions are useful as building blocks for digital signatures,
367
message authentication codes, pseudo random generators, association of
368
unique ids to documents, and many other things.
Niels Möller's avatar
Niels Möller committed
369

Niels Möller's avatar
Niels Möller committed
370
371
The most commonly used hash functions are MD5 and SHA1. Unfortunately,
both these fail the collision-resistance requirement; cryptologists have
372
373
374
375
376
377
found ways to construct colliding inputs. The recommended hash functions
for new applications are SHA2 (with main variants SHA256 and SHA512). At
the time of this writing (December 2012), the winner of the NIST SHA3
competition has recently been announced, and the new SHA3 (earlier known
as Keccak) and other top SHA3 candidates may also be reasonable
alternatives.
378

379
380
381
382
383
@menu
* Recommended hash functions::
* Legacy hash functions::
* nettle_hash abstraction::
@end menu
Niels Möller's avatar
Niels Möller committed
384

385
386
387
@node Recommended hash functions, Legacy hash functions,, Hash functions
@comment  node-name,  next,  previous,  up
@subsection Recommended hash functions
Niels Möller's avatar
Niels Möller committed
388

389
390
391
392
393
394
395
396
397
398
The following hash functions have no known weaknesses, and are suitable
for new applications. The SHA2 family of hash functions were specified
by @dfn{NIST}, intended as a replacement for @acronym{SHA1}.

@subsubsection @acronym{SHA256}

SHA256 is a member of the SHA2 family. It outputs hash values of 256
bits, or 32 octets. Nettle defines SHA256 in @file{<nettle/sha2.h>}.

@deftp {Context struct} {struct sha256_ctx}
Niels Möller's avatar
Niels Möller committed
399
400
@end deftp

401
@defvr Constant SHA256_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
402
The size of a SHA256 digest, i.e. 32.
Niels Möller's avatar
Niels Möller committed
403
404
@end defvr

405
406
407
@defvr Constant SHA256_DATA_SIZE
The internal block size of SHA256. Useful for some special constructions,
in particular HMAC-SHA256.
Niels Möller's avatar
Niels Möller committed
408
409
@end defvr

410
411
@deftypefun void sha256_init (struct sha256_ctx *@var{ctx})
Initialize the SHA256 state.
Niels Möller's avatar
Niels Möller committed
412
413
@end deftypefun

414
@deftypefun void sha256_update (struct sha256_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
Niels Möller's avatar
Niels Möller committed
415
416
417
Hash some more data.
@end deftypefun

418
@deftypefun void sha256_digest (struct sha256_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
419
420
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
421
@code{SHA256_DIGEST_SIZE}, in which case only the first @var{length}
422
octets of the digest are written.
Niels Möller's avatar
Niels Möller committed
423

424
This function also resets the context in the same way as
425
@code{sha256_init}.
Niels Möller's avatar
Niels Möller committed
426
427
@end deftypefun

428
429
430
Earlier versions of nettle defined SHA256 in the header file
@file{<nettle/sha.h>}, which is now deprecated, but kept for
compatibility.
Niels Möller's avatar
Niels Möller committed
431

432
@subsubsection @acronym{SHA224}
433

434
435
436
437
SHA224 is a variant of SHA256, with a different initial state, and with
the output truncated to 224 bits, or 28 octets. Nettle defines SHA224 in
@file{<nettle/sha2.h>} (and in @file{<nettle/sha.h>}, for backwards
compatibility).
438

439
@deftp {Context struct} {struct sha224_ctx}
440
441
@end deftp

442
@defvr Constant SHA224_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
443
The size of a SHA224 digest, i.e. 28.
444
445
@end defvr

446
447
448
@defvr Constant SHA224_DATA_SIZE
The internal block size of SHA224. Useful for some special constructions,
in particular HMAC-SHA224.
449
450
@end defvr

451
452
@deftypefun void sha224_init (struct sha224_ctx *@var{ctx})
Initialize the SHA224 state.
453
454
@end deftypefun

455
@deftypefun void sha224_update (struct sha224_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
456
457
458
Hash some more data.
@end deftypefun

459
@deftypefun void sha224_digest (struct sha224_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
460
461
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
462
@code{SHA224_DIGEST_SIZE}, in which case only the first @var{length}
463
464
465
octets of the digest are written.

This function also resets the context in the same way as
466
@code{sha224_init}.
467
468
@end deftypefun

469
@subsubsection @acronym{SHA512}
470

471
472
473
474
475
476
SHA512 is a larger sibling to SHA256, with a very similar structure but
with both the output and the internal variables of twice the size. The
internal variables are 64 bits rather than 32, making it significantly
slower on 32-bit computers. It outputs hash values of 512 bits, or 64
octets. Nettle defines SHA512 in @file{<nettle/sha2.h>} (and in
@file{<nettle/sha.h>}, for backwards compatibility).
477

478
@deftp {Context struct} {struct sha512_ctx}
479
480
@end deftp

481
@defvr Constant SHA512_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
482
The size of a SHA512 digest, i.e. 64.
483
484
@end defvr

485
486
487
@defvr Constant SHA512_DATA_SIZE
The internal block size of SHA512. Useful for some special constructions,
in particular HMAC-SHA512.
488
489
@end defvr

490
491
@deftypefun void sha512_init (struct sha512_ctx *@var{ctx})
Initialize the SHA512 state.
492
493
@end deftypefun

494
@deftypefun void sha512_update (struct sha512_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
495
496
497
Hash some more data.
@end deftypefun

498
@deftypefun void sha512_digest (struct sha512_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
499
500
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
501
@code{SHA512_DIGEST_SIZE}, in which case only the first @var{length}
502
503
504
octets of the digest are written.

This function also resets the context in the same way as
505
@code{sha512_init}.
506
507
@end deftypefun

508
@subsubsection @acronym{SHA384}
509

510
511
512
513
SHA384 is a variant of SHA512, with a different initial state, and with
the output truncated to 384 bits, or 48 octets. Nettle defines SHA384 in
@file{<nettle/sha2.h>} (and in @file{<nettle/sha.h>}, for backwards
compatibility).
514

515
@deftp {Context struct} {struct sha384_ctx}
516
517
@end deftp

518
@defvr Constant SHA384_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
519
The size of a SHA384 digest, i.e. 48.
520
521
@end defvr

522
523
524
@defvr Constant SHA384_DATA_SIZE
The internal block size of SHA384. Useful for some special constructions,
in particular HMAC-SHA384.
525
526
@end defvr

527
528
@deftypefun void sha384_init (struct sha384_ctx *@var{ctx})
Initialize the SHA384 state.
529
530
@end deftypefun

531
@deftypefun void sha384_update (struct sha384_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
532
533
534
Hash some more data.
@end deftypefun

535
@deftypefun void sha384_digest (struct sha384_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
536
537
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
538
@code{SHA384_DIGEST_SIZE}, in which case only the first @var{length}
539
540
541
octets of the digest are written.

This function also resets the context in the same way as
542
@code{sha384_init}.
543
544
@end deftypefun

545
@subsubsection @acronym{SHA3-224}
Niels Möller's avatar
Niels Möller committed
546

547
The SHA3 hash functions were specified by NIST in repsonse to weaknesses
548
549
550
551
552
553
554
in SHA1, and doubts about SHA2 hash functions which structurally are
very similar to SHA1. The standard is a result of a competition, where
the winner, also known as Keccak, was designed by Guido Bertoni, Joan
Daemen, Michaël Peeters and Gilles Van Assche. It is structurally very
different from all widely used earlier hash functions. Like SHA2, there
are several variants, with output sizes of 224, 256, 384 and 512 bits
(28, 32, 48 and 64 octets, respectively).
Niels Möller's avatar
Niels Möller committed
555

556
Nettle defines SHA3-224 in @file{<nettle/sha3.h>}.
Niels Möller's avatar
Niels Möller committed
557

558
@deftp {Context struct} {struct sha3_224_ctx}
Niels Möller's avatar
Niels Möller committed
559
560
@end deftp

561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
@defvr Constant SHA3_224_DIGEST_SIZE
The size of a SHA3_224 digest, i.e., 28.
@end defvr

@defvr Constant SHA3_224_DATA_SIZE
The internal block size of SHA3_224.
@end defvr

@deftypefun void sha3_224_init (struct sha3_224_ctx *@var{ctx})
Initialize the SHA3-224 state.
@end deftypefun

@deftypefun void sha3_224_update (struct sha3_224_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
Hash some more data.
@end deftypefun

@deftypefun void sha3_224_digest (struct sha3_224_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
@code{SHA3_224_DIGEST_SIZE}, in which case only the first @var{length}
octets of the digest are written.

This function also resets the context.
@end deftypefun

@subsubsection @acronym{SHA3-256}

This is SHA3 with 256-bit output size, and possibly the most useful
of the SHA3 hash functions.

Nettle defines SHA3-256 in @file{<nettle/sha3.h>}.

@deftp {Context struct} {struct sha3_256_ctx}
@end deftp

596
@defvr Constant SHA3_256_DIGEST_SIZE
597
The size of a SHA3_256 digest, i.e., 32.
Niels Möller's avatar
Niels Möller committed
598
599
@end defvr

600
601
@defvr Constant SHA3_256_DATA_SIZE
The internal block size of SHA3_256.
Niels Möller's avatar
Niels Möller committed
602
603
@end defvr

604
605
@deftypefun void sha3_256_init (struct sha3_256_ctx *@var{ctx})
Initialize the SHA3-256 state.
Niels Möller's avatar
Niels Möller committed
606
607
@end deftypefun

608
@deftypefun void sha3_256_update (struct sha3_256_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
Niels Möller's avatar
Niels Möller committed
609
610
611
Hash some more data.
@end deftypefun

612
@deftypefun void sha3_256_digest (struct sha3_256_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
613
614
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
615
@code{SHA3_256_DIGEST_SIZE}, in which case only the first @var{length}
616
617
octets of the digest are written.

618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
This function also resets the context.
@end deftypefun

@subsubsection @acronym{SHA3-384}

This is SHA3 with 384-bit output size.

Nettle defines SHA3-384 in @file{<nettle/sha3.h>}.

@deftp {Context struct} {struct sha3_384_ctx}
@end deftp

@defvr Constant SHA3_384_DIGEST_SIZE
The size of a SHA3_384 digest, i.e., 48.
@end defvr

@defvr Constant SHA3_384_DATA_SIZE
The internal block size of SHA3_384.
@end defvr

@deftypefun void sha3_384_init (struct sha3_384_ctx *@var{ctx})
Initialize the SHA3-384 state.
@end deftypefun

@deftypefun void sha3_384_update (struct sha3_384_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
Hash some more data.
@end deftypefun

@deftypefun void sha3_384_digest (struct sha3_384_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
@code{SHA3_384_DIGEST_SIZE}, in which case only the first @var{length}
octets of the digest are written.

This function also resets the context.
@end deftypefun

@subsubsection @acronym{SHA3-512}

This is SHA3 with 512-bit output size.

Nettle defines SHA3-512 in @file{<nettle/sha3.h>}.

@deftp {Context struct} {struct sha3_512_ctx}
@end deftp

@defvr Constant SHA3_512_DIGEST_SIZE
The size of a SHA3_512 digest, i.e. 64.
@end defvr

@defvr Constant SHA3_512_DATA_SIZE
The internal block size of SHA3_512.
@end defvr

@deftypefun void sha3_512_init (struct sha3_512_ctx *@var{ctx})
Initialize the SHA3-512 state.
@end deftypefun

@deftypefun void sha3_512_update (struct sha3_512_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
Hash some more data.
@end deftypefun

@deftypefun void sha3_512_digest (struct sha3_512_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
@code{SHA3_512_DIGEST_SIZE}, in which case only the first @var{length}
octets of the digest are written.

This function also resets the context.
Niels Möller's avatar
Niels Möller committed
687
688
@end deftypefun

689
690
691
@node Legacy hash functions, nettle_hash abstraction, Recommended hash functions, Hash functions
@comment  node-name,  next,  previous,  up
@subsection Legacy hash functions
692

693
694
695
696
697
698
699
700
701
The hash functions in this section all have some known weaknesses, and
should be avoided for new applications. These hash functions are mainly
useful for compatibility with old applications and protocols. Some are
still considered safe as building blocks for particular constructions,
e.g., there seems to be no known attacks against HMAC-SHA1 or even
HMAC-MD5. In some important cases, use of a ``legacy'' hash function
does not in itself make the application insecure; if a known weakness is
relevant depends on how the hash function is used, and on the threat
model.
702

703
@subsubsection @acronym{MD5}
704

705
706
707
708
709
MD5 is a message digest function constructed by Ronald Rivest, and
described in @cite{RFC 1321}. It outputs message digests of 128 bits, or
16 octets. Nettle defines MD5 in @file{<nettle/md5.h>}.

@deftp {Context struct} {struct md5_ctx}
710
711
@end deftp

712
713
@defvr Constant MD5_DIGEST_SIZE
The size of an MD5 digest, i.e. 16.
714
715
@end defvr

716
717
718
@defvr Constant MD5_DATA_SIZE
The internal block size of MD5. Useful for some special constructions,
in particular HMAC-MD5.
719
720
@end defvr

721
722
@deftypefun void md5_init (struct md5_ctx *@var{ctx})
Initialize the MD5 state.
723
724
@end deftypefun

725
@deftypefun void md5_update (struct md5_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
726
727
728
Hash some more data.
@end deftypefun

729
@deftypefun void md5_digest (struct md5_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
730
731
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
732
@code{MD5_DIGEST_SIZE}, in which case only the first @var{length}
733
octets of the digest are written.
Niels Möller's avatar
Niels Möller committed
734

735
This function also resets the context in the same way as
736
@code{md5_init}.
Niels Möller's avatar
Niels Möller committed
737
738
@end deftypefun

739
740
741
742
743
The normal way to use MD5 is to call the functions in order: First
@code{md5_init}, then @code{md5_update} zero or more times, and finally
@code{md5_digest}. After @code{md5_digest}, the context is reset to
its initial state, so you can start over calling @code{md5_update} to
hash new data.
744

745
To start over, you can call @code{md5_init} at any time.
746

747
@subsubsection @acronym{MD2}
748

749
750
751
752
753
MD2 is another hash function of Ronald Rivest's, described in
@cite{RFC 1319}. It outputs message digests of 128 bits, or 16 octets.
Nettle defines MD2 in @file{<nettle/md2.h>}.

@deftp {Context struct} {struct md2_ctx}
754
755
@end deftp

756
757
@defvr Constant MD2_DIGEST_SIZE
The size of an MD2 digest, i.e. 16.
758
759
@end defvr

760
761
@defvr Constant MD2_DATA_SIZE
The internal block size of MD2.
762
763
@end defvr

764
765
@deftypefun void md2_init (struct md2_ctx *@var{ctx})
Initialize the MD2 state.
766
767
@end deftypefun

768
@deftypefun void md2_update (struct md2_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
769
770
771
Hash some more data.
@end deftypefun

772
@deftypefun void md2_digest (struct md2_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
773
774
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
775
@code{MD2_DIGEST_SIZE}, in which case only the first @var{length}
776
777
778
octets of the digest are written.

This function also resets the context in the same way as
779
@code{md2_init}.
780
781
@end deftypefun

782
@subsubsection @acronym{MD4}
783

784
785
786
787
788
MD4 is a predecessor of MD5, described in @cite{RFC 1320}. Like MD5, it
is constructed by Ronald Rivest. It outputs message digests of 128 bits,
or 16 octets. Nettle defines MD4 in @file{<nettle/md4.h>}. Use of MD4 is
not recommended, but it is sometimes needed for compatibility with
existing applications and protocols.
789

790
@deftp {Context struct} {struct md4_ctx}
791
792
@end deftp

793
794
@defvr Constant MD4_DIGEST_SIZE
The size of an MD4 digest, i.e. 16.
795
796
@end defvr

797
798
@defvr Constant MD4_DATA_SIZE
The internal block size of MD4.
799
800
@end defvr

801
802
@deftypefun void md4_init (struct md4_ctx *@var{ctx})
Initialize the MD4 state.
803
804
@end deftypefun

805
@deftypefun void md4_update (struct md4_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
806
807
808
Hash some more data.
@end deftypefun

809
@deftypefun void md4_digest (struct md4_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
810
811
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
812
@code{MD4_DIGEST_SIZE}, in which case only the first @var{length}
813
814
815
octets of the digest are written.

This function also resets the context in the same way as
816
@code{md4_init}.
817
818
@end deftypefun

819
@subsubsection @acronym{RIPEMD160}
820

821
822
823
824
825
RIPEMD160 is a hash function designed by Hans Dobbertin, Antoon
Bosselaers, and Bart Preneel, as a strengthened version of RIPEMD
(which, like MD4 and MD5, fails the collision-resistance requirement).
It produces message digests of 160 bits, or 20 octets. Nettle defined
RIPEMD160 in @file{nettle/ripemd160.h}.
826

827
828
@deftp {Context struct} {struct ripemd160_ctx}
@end deftp
829

830
@defvr Constant RIPEMD160_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
831
The size of a RIPEMD160 digest, i.e. 20.
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
@end defvr

@defvr Constant RIPEMD160_DATA_SIZE
The internal block size of RIPEMD160.
@end defvr

@deftypefun void ripemd160_init (struct ripemd160_ctx *@var{ctx})
Initialize the RIPEMD160 state.
@end deftypefun

@deftypefun void ripemd160_update (struct ripemd160_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
Hash some more data.
@end deftypefun

@deftypefun void ripemd160_digest (struct ripemd160_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
@code{RIPEMD160_DIGEST_SIZE}, in which case only the first @var{length}
octets of the digest are written.

This function also resets the context in the same way as
@code{ripemd160_init}.
@end deftypefun

@subsubsection @acronym{SHA1}

SHA1 is a hash function specified by @dfn{NIST} (The U.S. National
Institute for Standards and Technology). It outputs hash values of 160
bits, or 20 octets. Nettle defines SHA1 in @file{<nettle/sha1.h>} (and
in @file{<nettle/sha.h>}, for backwards compatibility).

@deftp {Context struct} {struct sha1_ctx}
864
865
@end deftp

866
@defvr Constant SHA1_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
867
The size of a SHA1 digest, i.e. 20.
868
869
@end defvr

870
871
872
@defvr Constant SHA1_DATA_SIZE
The internal block size of SHA1. Useful for some special constructions,
in particular HMAC-SHA1.
873
874
@end defvr

875
876
@deftypefun void sha1_init (struct sha1_ctx *@var{ctx})
Initialize the SHA1 state.
877
878
@end deftypefun

879
@deftypefun void sha1_update (struct sha1_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
880
881
882
Hash some more data.
@end deftypefun

883
@deftypefun void sha1_digest (struct sha1_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
884
885
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
886
@code{SHA1_DIGEST_SIZE}, in which case only the first @var{length}
887
888
889
octets of the digest are written.

This function also resets the context in the same way as
890
@code{sha1_init}.
891
892
@end deftypefun

893
894

@subsubsection @acronym{GOSTHASH94}
895
896
897
898
899
900
901
902
903
904

The GOST94 or GOST R 34.11-94 hash algorithm is a Soviet-era algorithm 
used in Russian government standards (see @cite{RFC 4357}).
It outputs message digests of 256 bits, or 32 octets.
Nettle defines GOSTHASH94 in @file{<nettle/gosthash94.h>}.

@deftp {Context struct} {struct gosthash94_ctx}
@end deftp

@defvr Constant GOSTHASH94_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
905
The size of a GOSTHASH94 digest, i.e. 32.
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
@end defvr

@defvr Constant GOSTHASH94_DATA_SIZE
The internal block size of GOSTHASH94, i.e., 32.
@end defvr

@deftypefun void gosthash94_init (struct gosthash94_ctx *@var{ctx})
Initialize the GOSTHASH94 state.
@end deftypefun

@deftypefun void gosthash94_update (struct gosthash94_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{data})
Hash some more data.
@end deftypefun

@deftypefun void gosthash94_digest (struct gosthash94_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{digest})
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
@code{GOSTHASH94_DIGEST_SIZE}, in which case only the first @var{length}
octets of the digest are written.

This function also resets the context in the same way as
@code{gosthash94_init}.
@end deftypefun

930
931
932
@node nettle_hash abstraction,, Legacy hash functions, Hash functions
@comment  node-name,  next,  previous,  up
@subsection The nettle_hash abstraction
Niels Möller's avatar
Niels Möller committed
933
934
935

Nettle includes a struct including information about the supported hash
functions. It is defined in @file{<nettle/nettle-meta.h>}, and is used
936
937
by Nettle's implementation of @acronym{HMAC} (@pxref{Keyed hash
functions}).
Niels Möller's avatar
Niels Möller committed
938
939
940
941
942

@deftp {Meta struct} @code{struct nettle_hash} name context_size digest_size block_size init update digest
The last three attributes are function pointers, of types
@code{nettle_hash_init_func}, @code{nettle_hash_update_func}, and
@code{nettle_hash_digest_func}. The first argument to these functions is
943
@code{void *} pointer to a context struct, which is of size
Niels Möller's avatar
Niels Möller committed
944
945
946
@code{context_size}. 
@end deftp

947
948
949
@deftypevr {Constant Struct} {struct nettle_hash} nettle_md2
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md4
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md5
950
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_ripemd160
951
952
953
954
955
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha1
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha224
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha256
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha384
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha512
956
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha3_256
957
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_gosthash94
Niels Möller's avatar
Niels Möller committed
958
These are all the hash functions that Nettle implements.
959
@end deftypevr
960

961
Nettle also exports a list of all these hashes.
962

963
964
965
@deftypevr {Constant Array} {struct nettle_hash **} nettle_hashes
This list can be used to dynamically enumerate or search the supported
algorithms. NULL-terminated.
Niels Möller's avatar
Niels Möller committed
966
967
@end deftypevr

968
@node Cipher functions, Cipher modes, Hash functions, Reference
Niels Möller's avatar
Niels Möller committed
969
970
@comment  node-name,  next,  previous,  up
@section Cipher functions
971
@cindex Cipher
Niels Möller's avatar
Niels Möller committed
972
973
974
975

A @dfn{cipher} is a function that takes a message or @dfn{plaintext}
and a secret @dfn{key} and transforms it to a @dfn{ciphertext}. Given
only the ciphertext, but not the key, it should be hard to find the
Niels Möller's avatar
Niels Möller committed
976
plaintext. Given matching pairs of plaintext and ciphertext, it should
Niels Möller's avatar
Niels Möller committed
977
978
be hard to find the key.

979
980
981
@cindex Block Cipher
@cindex Stream Cipher

Niels Möller's avatar
Niels Möller committed
982
983
984
985
986
987
988
989
There are two main classes of ciphers: Block ciphers and stream ciphers.

A block cipher can process data only in fixed size chunks, called
@dfn{blocks}. Typical block sizes are 8 or 16 octets. To encrypt
arbitrary messages, you usually have to pad it to an integral number of
blocks, split it into blocks, and then process each block. The simplest
way is to process one block at a time, independent of each other. That
mode of operation is called @dfn{ECB}, Electronic Code Book mode.
990
However, using @acronym{ECB} is usually a bad idea. For a start, plaintext blocks
Niels Möller's avatar
Niels Möller committed
991
992
that are equal are transformed to ciphertext blocks that are equal; that
leaks information about the plaintext. Usually you should apply the
993
994
995
996
cipher is some ``feedback mode'', @dfn{CBC} (Cipher Block Chaining) and
@dfn{CTR} (Counter mode) being two of
of the most popular. See @xref{Cipher modes}, for information on
how to apply @acronym{CBC} and @acronym{CTR} with Nettle.
Niels Möller's avatar
Niels Möller committed
997

Niels Möller's avatar
Niels Möller committed
998
A stream cipher can be used for messages of arbitrary length. A typical
Niels Möller's avatar
Niels Möller committed
999
stream cipher is a keyed pseudo-random generator. To encrypt a plaintext
Niels Möller's avatar
Niels Möller committed
1000
message of @var{n} octets, you key the generator, generate @var{n}
Niels Möller's avatar
Niels Möller committed
1001
octets of pseudo-random data, and XOR it with the plaintext. To decrypt,
Niels Möller's avatar
Niels Möller committed
1002
1003
1004
1005
1006
1007
1008
1009
regenerate the same stream using the key, XOR it to the ciphertext, and
the plaintext is recovered.

@strong{Caution:} The first rule for this kind of cipher is the
same as for a One Time Pad: @emph{never} ever use the same key twice.

A common misconception is that encryption, by itself, implies
authentication. Say that you and a friend share a secret key, and you
Niels Möller's avatar
Niels Möller committed
1010
receive an encrypted message. You apply the key, and get a plaintext
1011
message that makes sense to you. Can you then be sure that it really was
Niels Möller's avatar
Niels Möller committed
1012
your friend that wrote the message you're reading? The answer is no. For
Niels Möller's avatar
Niels Möller committed
1013
1014
1015
1016
example, if you were using a block cipher in ECB mode, an attacker may
pick up the message on its way, and reorder, delete or repeat some of
the blocks. Even if the attacker can't decrypt the message, he can
change it so that you are not reading the same message as your friend
Niels Möller's avatar
Niels Möller committed
1017
1018
1019
1020
wrote. If you are using a block cipher in @acronym{CBC} mode rather than
ECB, or are using a stream cipher, the possibilities for this sort of
attack are different, but the attacker can still make predictable
changes to the message.
Niels Möller's avatar
Niels Möller committed
1021
1022
1023

It is recommended to @emph{always} use an authentication mechanism in
addition to encrypting the messages. Popular choices are Message
1024
1025
Authentication Codes like @acronym{HMAC-SHA1} (@pxref{Keyed hash
functions}), or digital signatures like @acronym{RSA}.
Niels Möller's avatar
Niels Möller committed
1026

1027
Some ciphers have so called ``weak keys'', keys that results in
Niels Möller's avatar
Niels Möller committed
1028
undesirable structure after the key setup processing, and should be
1029
1030
1031
1032
avoided. In Nettle, most key setup functions have no return value, but
for ciphers with weak keys, the return value indicates whether or not
the given key is weak. For good keys, key setup returns 1, and for weak
keys, it returns 0. When possible, avoid algorithms that
Niels Möller's avatar
Niels Möller committed
1033
1034
1035
have weak keys. There are several good ciphers that don't have any weak
keys.

1036
1037
1038
To encrypt a message, you first initialize a cipher context for
encryption or decryption with a particular key. You then use the context
to process plaintext or ciphertext messages. The initialization is known
1039
as @dfn{key setup}. With Nettle, it is recommended to use each
1040
1041
1042
1043
context struct for only one direction, even if some of the ciphers use a
single key setup function that can be used for both encryption and
decryption.

Niels Möller's avatar
Niels Möller committed
1044
@subsection AES
1045
AES is a block cipher, specified by NIST as a replacement for
Niels Möller's avatar
Niels Möller committed
1046
the older DES standard. The standard is the result of a competition
1047
1048
between cipher designers. The winning design, also known as RIJNDAEL,
was constructed by Joan Daemen and Vincent Rijnmen.
Niels Möller's avatar
Niels Möller committed
1049
1050

Like all the AES candidates, the winning design uses a block size of 128
Niels Möller's avatar
Niels Möller committed
1051
bits, or 16 octets, and variable key-size, 128, 192 and 256 bits (16, 24
Niels Möller's avatar
Niels Möller committed
1052
1053
1054
1055
1056
1057
1058
and 32 octets) being the allowed key sizes. It does not have any weak
keys. Nettle defines AES in @file{<nettle/aes.h>}.
 
@deftp {Context struct} {struct aes_ctx}
@end deftp

@defvr Constant AES_BLOCK_SIZE
Niels Möller's avatar
Niels Möller committed
1059
The AES block-size, 16
Niels Möller's avatar
Niels Möller committed
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
@end defvr

@defvr Constant AES_MIN_KEY_SIZE
@end defvr

@defvr Constant AES_MAX_KEY_SIZE
@end defvr

@defvr Constant AES_KEY_SIZE
Default AES key size, 32
@end defvr

1072
1073
1074
@deftypefun void aes_set_encrypt_key (struct aes_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{key})
@deftypefunx void aes_set_decrypt_key (struct aes_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{key})
Initialize the cipher, for encryption or decryption, respectively.
Niels Möller's avatar
Niels Möller committed
1075
1076
@end deftypefun

1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
@deftypefun void aes_invert_key (struct aes_ctx *@var{dst}, const struct aes_ctx *@var{src})
Given a context @var{src} initialized for encryption, initializes the
context struct @var{dst} for decryption, using the same key. If the same
context struct is passed for both @code{src} and @code{dst}, it is
converted in place. Calling @code{aes_set_encrypt_key} and
@code{aes_invert_key} is more efficient than calling
@code{aes_set_encrypt_key} and @code{aes_set_decrypt_key}. This function
is mainly useful for applications which needs to both encrypt and
decrypt using the @emph{same} key.
@end deftypefun

1088
@deftypefun void aes_encrypt (struct aes_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
Niels Möller's avatar
Niels Möller committed
1089
1090
1091
1092
1093
1094
Encryption function. @var{length} must be an integral multiple of the
block size. If it is more than one block, the data is processed in ECB
mode. @code{src} and @code{dst} may be equal, but they must not overlap
in any other way.
@end deftypefun

1095
@deftypefun void aes_decrypt (struct aes_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
Niels Möller's avatar
Niels Möller committed
1096
1097
1098
1099
1100
1101
1102
1103
Analogous to @code{aes_encrypt}
@end deftypefun

@subsection ARCFOUR
ARCFOUR is a stream cipher, also known under the trade marked name RC4,
and it is one of the fastest ciphers around. A problem is that the key
setup of ARCFOUR is quite weak, you should never use keys with
structure, keys that are ordinary passwords, or sequences of keys like
1104
``secret:1'', ``secret:2'', @enddots{}. If you have keys that don't look
Niels Möller's avatar
Niels Möller committed
1105
like random bit strings, and you want to use ARCFOUR, always hash the
Niels Möller's avatar
Niels Möller committed
1106
1107
1108
key before feeding it to ARCFOUR. Furthermore, the initial bytes of the
generated key stream leak information about the key; for this reason, it
is recommended to discard the first 512 bytes of the key stream.
Niels Möller's avatar
Niels Möller committed
1109
1110
1111
1112

@example
/* A more robust key setup function for ARCFOUR */
void
1113
1114
arcfour_set_key_hashed(struct arcfour_ctx *ctx,
                       unsigned length, const uint8_t *key)
Niels Möller's avatar
Niels Möller committed
1115
@{
Niels Möller's avatar
Niels Möller committed
1116
1117
1118
  struct sha256_ctx hash;
  uint8_t digest[SHA256_DIGEST_SIZE];
  uint8_t buffer[0x200];
Niels Möller's avatar
Niels Möller committed
1119

Niels Möller's avatar
Niels Möller committed
1120
1121
1122
  sha256_init(&hash);
  sha256_update(&hash, length, key);
  sha256_digest(&hash, SHA256_DIGEST_SIZE, digest);
Niels Möller's avatar
Niels Möller committed
1123

Niels Möller's avatar
Niels Möller committed
1124
1125
  arcfour_set_key(ctx, SHA256_DIGEST_SIZE, digest);
  arcfour_crypt(ctx, sizeof(buffer), buffer, buffer);
Niels Möller's avatar
Niels Möller committed
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
@}
@end example

Nettle defines ARCFOUR in @file{<nettle/arcfour.h>}.

@deftp {Context struct} {struct arcfour_ctx}
@end deftp

@defvr Constant ARCFOUR_MIN_KEY_SIZE
Minimum key size, 1
@end defvr

@defvr Constant ARCFOUR_MAX_KEY_SIZE
Maximum key size, 256
@end defvr

@defvr Constant ARCFOUR_KEY_SIZE
Default ARCFOUR key size, 16
@end defvr

@deftypefun void arcfour_set_key (struct arcfour_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{key})
Initialize the cipher. The same function is used for both encryption and
decryption. 
@end deftypefun

1151
@deftypefun void arcfour_crypt (struct arcfour_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
Niels Möller's avatar
Niels Möller committed
1152
1153
1154
1155
1156
1157
1158
Encrypt some data. The same function is used for both encryption and
decryption. Unlike the block ciphers, this function modifies the
context, so you can split the data into arbitrary chunks and encrypt
them one after another. The result is the same as if you had called
@code{arcfour_crypt} only once with all the data.
@end deftypefun

Niels Möller's avatar
Niels Möller committed
1159
1160
1161
1162
@subsection ARCTWO
ARCTWO (also known as the trade marked name RC2) is a block cipher
specified in RFC 2268. Nettle also include a variation of the ARCTWO
set key operation that lack one step, to be compatible with the
1163
reverse engineered RC2 cipher description, as described in a Usenet
Niels Möller's avatar
Niels Möller committed
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
post to @code{sci.crypt} by Peter Gutmann.

ARCTWO uses a block size of 64 bits, and variable key-size ranging
from 1 to 128 octets. Besides the key, ARCTWO also has a second
parameter to key setup, the number of effective key bits, @code{ekb}.
This parameter can be used to artificially reduce the key size. In
practice, @code{ekb} is usually set equal to the input key size.
Nettle defines ARCTWO in @file{<nettle/arctwo.h>}.

We do not recommend the use of ARCTWO; the Nettle implementation is
provided primarily for interoperability with existing applications and
standards.

@deftp {Context struct} {struct arctwo_ctx}
@end deftp

@defvr Constant ARCTWO_BLOCK_SIZE
1181
The ARCTWO block-size, 8
Niels Möller's avatar
Niels Möller committed
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
@end defvr

@defvr Constant ARCTWO_MIN_KEY_SIZE
@end defvr

@defvr Constant ARCTWO_MAX_KEY_SIZE
@end defvr

@defvr Constant ARCTWO_KEY_SIZE
Default ARCTWO key size, 8
@end defvr

@deftypefun void arctwo_set_key_ekb (struct arctwo_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{key}, unsigned @var{ekb})
@deftypefunx void arctwo_set_key (struct arctwo_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{key})
@deftypefunx void arctwo_set_key_gutmann (struct arctwo_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{key})
Initialize the cipher. The same function is used for both encryption
and decryption. The first function is the most general one, which lets
you provide both the variable size key, and the desired effective key
size (in bits). The maximum value for @var{ekb} is 1024, and for
convenience, @code{ekb = 0} has the same effect as @code{ekb = 1024}.

@code{arctwo_set_key(ctx, length, key)} is equivalent to
@code{arctwo_set_key_ekb(ctx, length, key, 8*length)}, and
@code{arctwo_set_key_gutmann(ctx, length, key)} is equivalent to
@code{arctwo_set_key_ekb(ctx, length, key, 1024)}
@end deftypefun

1209
@deftypefun void arctwo_encrypt (struct arctwo_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
Niels Möller's avatar
Niels Möller committed
1210
1211
1212
1213
1214
1215
Encryption function. @var{length} must be an integral multiple of the
block size. If it is more than one block, the data is processed in ECB
mode. @code{src} and @code{dst} may be equal, but they must not
overlap in any other way.
@end deftypefun

1216
@deftypefun void arctwo_decrypt (struct arctwo_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
Niels Möller's avatar
Niels Möller committed
1217
1218
1219
Analogous to @code{arctwo_encrypt}
@end deftypefun

Niels Möller's avatar
Niels Möller committed
1220
1221
@subsection BLOWFISH

1222
1223
1224
1225
1226
1227
1228
1229
BLOWFISH is a block cipher designed by Bruce Schneier. It uses a block
size of 64 bits (8 octets), and a variable key size, up to 448 bits. It
has some weak keys. Nettle defines BLOWFISH in @file{<nettle/blowfish.h>}.

@deftp {Context struct} {struct blowfish_ctx}
@end deftp

@defvr Constant BLOWFISH_BLOCK_SIZE
Niels Möller's avatar
Niels Möller committed
1230
The BLOWFISH block-size, 8
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
@end defvr

@defvr Constant BLOWFISH_MIN_KEY_SIZE
Minimum BLOWFISH key size, 8
@end defvr

@defvr Constant BLOWFISH_MAX_KEY_SIZE
Maximum BLOWFISH key size, 56
@end defvr

@defvr Constant BLOWFISH_KEY_SIZE
Default BLOWFISH key size, 16
@end defvr

@deftypefun int blowfish_set_key (struct blowfish_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{key})
Initialize the cipher. The same function is used for both encryption and
1247
1248
1249
1250
decryption. Checks for weak keys, returning 1
for good keys and 0 for weak keys. Applications that don't care about
weak keys can ignore the return value.

1251
1252
1253
1254
@code{blowfish_encrypt} or @code{blowfish_decrypt} with a weak key will
crash with an assert violation.
@end deftypefun

1255
@deftypefun void blowfish_encrypt (struct blowfish_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
1256
1257
1258
1259
1260
1261
Encryption function. @var{length} must be an integral multiple of the
block size. If it is more than one block, the data is processed in ECB
mode. @code{src} and @code{dst} may be equal, but they must not overlap
in any other way.
@end deftypefun

1262
@deftypefun void blowfish_decrypt (struct blowfish_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
1263
Analogous to @code{blowfish_encrypt}
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
@end deftypefun

@subsection Camellia

Camellia is a block cipher developed by Mitsubishi and Nippon Telegraph
and Telephone Corporation, described in @cite{RFC3713}, and recommended
by some Japanese and European authorities as an alternative to AES. The
algorithm is patented. The implementation in Nettle is derived from the
implementation released by NTT under the GNU LGPL (v2.1 or later), and
relies on the implicit patent license of the LGPL. There is also a
statement of royalty-free licensing for Camellia at
@url{http://www.ntt.co.jp/news/news01e/0104/010417.html}, but this
statement has some limitations which seem problematic for free software.

Camellia uses a the same block size and key sizes as AES: The block size
is 128 bits (16 octets), and the supported key sizes are 128, 192, and
256 bits. Nettle defines Camellia in @file{<nettle/camellia.h>}.

@deftp {Context struct} {struct camellia_ctx}
@end deftp

@defvr Constant CAMELLIA_BLOCK_SIZE
The CAMELLIA block-size, 16
@end defvr

@defvr Constant CAMELLIA_MIN_KEY_SIZE
@end defvr

@defvr Constant CAMELLIA_MAX_KEY_SIZE
@end defvr

@defvr Constant CAMELLIA_KEY_SIZE
Default CAMELLIA key size, 32
@end defvr

@deftypefun void camellia_set_encrypt_key (struct camellia_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{key})
@deftypefunx void camellia_set_decrypt_key (struct camellia_ctx *@var{ctx}, unsigned @var{length}, const uint8_t *@var{key})
Initialize the cipher, for encryption or decryption, respectively.
@end deftypefun

@deftypefun void camellia_invert_key (struct camellia_ctx *@var{dst}, const struct camellia_ctx *@var{src})
Given a context @var{src} initialized for encryption, initializes the
context struct @var{dst} for decryption, using the same key. If the same
context struct is passed for both @code{src} and @code{dst}, it is
converted in place. Calling @code{camellia_set_encrypt_key} and
@code{camellia_invert_key} is more efficient than calling
@code{camellia_set_encrypt_key} and @code{camellia_set_decrypt_key}. This function
is mainly useful for applications which needs to both encrypt and
decrypt using the @emph{same} key.
@end deftypefun

1315
@deftypefun void camellia_crypt (struct camellia_ctx *@var{ctx}, unsigned @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
Niels Möller's avatar