nettle.texinfo 166 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.7
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 2013.
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
@ifnottex
@macro pmod {m} 
(mod \m\)
@end macro
@end ifnottex

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

41
42
43
44
45
@dircategory Encryption
@direntry
* Nettle: (nettle).             A low-level cryptographic library.
@end direntry

46
47
@contents

Niels Möller's avatar
Niels Möller committed
48
49
50
@ifnottex
@node     Top, Introduction, (dir), (dir)
@comment  node-name,  next,  previous,  up
51
@top Nettle
Niels Möller's avatar
Niels Möller committed
52

53
54
55
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
56

57
@insertcopying
Niels Möller's avatar
Niels Möller committed
58
59

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

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

Reference

* Hash functions::              
* Cipher functions::            
* Cipher modes::                
* Keyed hash functions::        
Simon Josefsson's avatar
Simon Josefsson committed
79
* Key derivation functions::    
80
81
* Public-key algorithms::       
* Randomness::                  
82
* ASCII encoding::              
83
84
85
86
87
88
89
90
91
92
93
94
95
* Miscellaneous functions::     
* Compatibility functions::     

Cipher modes

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

Public-key algorithms

* RSA::                         The RSA public key algorithm.
* DSA::                         The DSA digital signature algorithm.
96
* Elliptic curves::             Elliptic curves and ECDSA
97
98

@end detailmenu
Niels Möller's avatar
Niels Möller committed
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
@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.

115
And as the requirements of applications differ in subtle and not so
Niels Möller's avatar
Niels Möller committed
116
117
118
119
120
121
122
123
124
125
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
126
interfaces on top of Nettle, and share the code, test cases, benchmarks,
Niels Möller's avatar
Niels Möller committed
127
128
129
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
130

131
132
133
134
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
135
136
137
138
@node Copyright, Conventions, Introduction, Top
@comment  node-name,  next,  previous,  up
@chapter Copyright

139
140
141
142
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
143

144
145
146
147
148
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
149
150
151
152
153
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
154
155
156
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
157
158
159

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

Niels Möller's avatar
Niels Möller committed
162
163
164
165
166
@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
167
168
@item BLOWFISH
The implementation of the BLOWFISH cipher is written by Werner Koch,
169
copyright owned by the Free Software Foundation. Also hacked by Simon
Niels Möller's avatar
Niels Möller committed
170
Josefsson and Niels Möller. Released under the LGPL.
Niels Möller's avatar
Niels Möller committed
171

172
@item CAMELLIA
173
The C implementation is by Nippon Telegraph and Telephone Corporation
174
175
(NTT), heavily modified by @value{AUTHOR}. Assembler for x86 and x86_64
by @value{AUTHOR}. Released under the LGPL.
176

Niels Möller's avatar
Niels Möller committed
177
178
179
180
181
182
183
184
@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.

185
186
187
188
189
@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.

190
191
@item MD2
The implementation of MD2 is written by Andrew Kuchling, and hacked
192
some by Andreas Sigfridsson and @value{AUTHOR}. Python Cryptography
193
194
195
196
197
198
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
199
200
@item MD5
The implementation of the MD5 message digest is written by Colin Plumb.
201
It has been hacked some more by Andrew Kuchling and @value{AUTHOR}.
Niels Möller's avatar
Niels Möller committed
202
203
Released into the public domain.

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

208
@item RIPEMD160
209
210
211
212
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
213
214
@item SALSA20
The C implementation of SALSA20 is based on D. J. Bernstein's reference
215
implementation (in the public domain), adapted to Nettle by Simon
216
217
Josefsson, and heavily modified by Niels Möller. Assembly for x86_64 and
ARM by Niels Möller. Released under the LGPL.
Simon Josefsson's avatar
Simon Josefsson committed
218

Niels Möller's avatar
Niels Möller committed
219
@item SERPENT
220
The implementation of the SERPENT cipher is based on the code in libgcrypt,
221
copyright owned by the Free Software Foundation. Adapted to Nettle by
Niels Möller's avatar
Niels Möller committed
222
223
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
224
225

@item SHA1
226
227
The C implementation of the SHA1 message digest is written by Peter
Gutmann, and hacked some more by Andrew Kuchling and @value{AUTHOR}.
228
229
Released into the public domain. Assembler for x86, x86_64 and ARM by
@value{AUTHOR}, released under the LGPL.
Niels Möller's avatar
Niels Möller committed
230

Niels Möller's avatar
Niels Möller committed
231
@item SHA2
Niels Möller's avatar
Niels Möller committed
232
233
234
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
235
@item SHA3
236
237
Written by @value{AUTHOR}. Released under the LGPL.

Niels Möller's avatar
Niels Möller committed
238
239
240
@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
241

242
243
244
@item UMAC
Written by @value{AUTHOR}. Released under the LGPL.

Niels Möller's avatar
Niels Möller committed
245
246
247
248
249
250
251
@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.
252
253
254
255

@item ECDSA
Written by @value{AUTHOR}, released under the LGPL. Uses the GMP library
for bignum operations. Development of Nettle's ECC support was funded by
256
the .SE Internet Fund.
Niels Möller's avatar
Niels Möller committed
257
258
259
260
261
262
263
264
@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
265
operating on the context. The context struct encapsulates all information
Niels Möller's avatar
Niels Möller committed
266
267
268
needed by the algorithm, and it can be copied or moved in memory with no
unexpected effects.

269
270
For consistency, functions for different algorithms are very similar,
but there are some differences, for instance reflecting if the key setup
271
or encryption function differ for encryption and decryption, and whether
272
273
274
275
276
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
277

278
279
280
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
281
282
283
284
285
286
287

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
288
type @code{size_t}, and a pointer of type @code{uint8_t *} or
Niels Möller's avatar
Niels Möller committed
289
290
291
292
@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,
293
but they @emph{must not} overlap in any other way.
Niels Möller's avatar
Niels Möller committed
294

295
296
297
Many of the functions lack return value and can never fail. Those
functions which can fail, return one on success and zero on failure.

298
299
@c FIXME: Say something about the name mangling.

300
@node Example, Linking, Conventions, Top
Niels Möller's avatar
Niels Möller committed
301
302
303
@comment  node-name,  next,  previous,  up
@chapter Example

304
A simple example program that reads a file from standard input and
305
writes its SHA1 check-sum on standard output should give the flavor of
306
Nettle.
Niels Möller's avatar
Niels Möller committed
307
308

@example
309
@verbatiminclude sha-example.c
Niels Möller's avatar
Niels Möller committed
310
311
@end example

312
313
314
On a typical Unix system, this program can be compiled and linked with
the command line 
@example
315
gcc sha-example.c -o sha-example -lnettle
316
317
318
319
320
321
322
323
324
325
326
327
@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.

328
329
330
331
332
333
334
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.
335
336

@node Reference, Nettle soup, Linking, Top
Niels Möller's avatar
Niels Möller committed
337
338
339
340
341
342
343
344
@comment  node-name,  next,  previous,  up
@chapter Reference

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

@menu
* Hash functions::              
* Cipher functions::            
345
* Cipher modes::                
Niels Möller's avatar
Niels Möller committed
346
* Keyed hash functions::        
Simon Josefsson's avatar
Simon Josefsson committed
347
* Key derivation functions::    
348
349
* Public-key algorithms::       
* Randomness::                  
350
* ASCII encoding::              
Niels Möller's avatar
Niels Möller committed
351
* Miscellaneous functions::     
352
* Compatibility functions::     
Niels Möller's avatar
Niels Möller committed
353
354
355
356
@end menu

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

Niels Möller's avatar
Niels Möller committed
358
@section Hash functions
359
@cindex Hash function
Niels Möller's avatar
Niels Möller committed
360
361
362
363
364
365
366
367
368
369
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
370
@cindex One-way
Niels Möller's avatar
Niels Möller committed
371
372
373
374
Given a hash value @code{H(x)} it is hard to find a string @code{x}
that hashes to that value.

@item Collision-resistant
375
@cindex Collision-resistant
Niels Möller's avatar
Niels Möller committed
376
377
378
379
380
381
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,
382
message authentication codes, pseudo random generators, association of
383
unique ids to documents, and many other things.
Niels Möller's avatar
Niels Möller committed
384

Niels Möller's avatar
Niels Möller committed
385
386
The most commonly used hash functions are MD5 and SHA1. Unfortunately,
both these fail the collision-resistance requirement; cryptologists have
387
388
389
390
391
392
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.
393

394
395
396
397
398
@menu
* Recommended hash functions::
* Legacy hash functions::
* nettle_hash abstraction::
@end menu
Niels Möller's avatar
Niels Möller committed
399

400
401
402
@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
403

404
405
406
407
408
409
410
411
412
413
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
414
415
@end deftp

416
@defvr Constant SHA256_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
417
The size of a SHA256 digest, i.e. 32.
Niels Möller's avatar
Niels Möller committed
418
419
@end defvr

420
421
422
@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
423
424
@end defvr

425
426
@deftypefun void sha256_init (struct sha256_ctx *@var{ctx})
Initialize the SHA256 state.
Niels Möller's avatar
Niels Möller committed
427
428
@end deftypefun

429
@deftypefun void sha256_update (struct sha256_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
Niels Möller's avatar
Niels Möller committed
430
431
432
Hash some more data.
@end deftypefun

433
@deftypefun void sha256_digest (struct sha256_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
434
435
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
436
@code{SHA256_DIGEST_SIZE}, in which case only the first @var{length}
437
octets of the digest are written.
Niels Möller's avatar
Niels Möller committed
438

439
This function also resets the context in the same way as
440
@code{sha256_init}.
Niels Möller's avatar
Niels Möller committed
441
442
@end deftypefun

443
444
445
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
446

447
@subsubsection @acronym{SHA224}
448

449
450
451
452
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).
453

454
@deftp {Context struct} {struct sha224_ctx}
455
456
@end deftp

457
@defvr Constant SHA224_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
458
The size of a SHA224 digest, i.e. 28.
459
460
@end defvr

461
462
463
@defvr Constant SHA224_DATA_SIZE
The internal block size of SHA224. Useful for some special constructions,
in particular HMAC-SHA224.
464
465
@end defvr

466
467
@deftypefun void sha224_init (struct sha224_ctx *@var{ctx})
Initialize the SHA224 state.
468
469
@end deftypefun

470
@deftypefun void sha224_update (struct sha224_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
471
472
473
Hash some more data.
@end deftypefun

474
@deftypefun void sha224_digest (struct sha224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
475
476
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
477
@code{SHA224_DIGEST_SIZE}, in which case only the first @var{length}
478
479
480
octets of the digest are written.

This function also resets the context in the same way as
481
@code{sha224_init}.
482
483
@end deftypefun

484
@subsubsection @acronym{SHA512}
485

486
487
488
489
490
491
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).
492

493
@deftp {Context struct} {struct sha512_ctx}
494
495
@end deftp

496
@defvr Constant SHA512_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
497
The size of a SHA512 digest, i.e. 64.
498
499
@end defvr

500
501
502
@defvr Constant SHA512_DATA_SIZE
The internal block size of SHA512. Useful for some special constructions,
in particular HMAC-SHA512.
503
504
@end defvr

505
506
@deftypefun void sha512_init (struct sha512_ctx *@var{ctx})
Initialize the SHA512 state.
507
508
@end deftypefun

509
@deftypefun void sha512_update (struct sha512_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
510
511
512
Hash some more data.
@end deftypefun

513
@deftypefun void sha512_digest (struct sha512_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
514
515
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
516
@code{SHA512_DIGEST_SIZE}, in which case only the first @var{length}
517
518
519
octets of the digest are written.

This function also resets the context in the same way as
520
@code{sha512_init}.
521
522
@end deftypefun

523
@subsubsection @acronym{SHA384}
524

525
526
527
528
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).
529

530
@deftp {Context struct} {struct sha384_ctx}
531
532
@end deftp

533
@defvr Constant SHA384_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
534
The size of a SHA384 digest, i.e. 48.
535
536
@end defvr

537
538
539
@defvr Constant SHA384_DATA_SIZE
The internal block size of SHA384. Useful for some special constructions,
in particular HMAC-SHA384.
540
541
@end defvr

542
543
@deftypefun void sha384_init (struct sha384_ctx *@var{ctx})
Initialize the SHA384 state.
544
545
@end deftypefun

546
@deftypefun void sha384_update (struct sha384_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
547
548
549
Hash some more data.
@end deftypefun

550
@deftypefun void sha384_digest (struct sha384_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
551
552
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
553
@code{SHA384_DIGEST_SIZE}, in which case only the first @var{length}
554
555
556
octets of the digest are written.

This function also resets the context in the same way as
557
@code{sha384_init}.
558
559
@end deftypefun

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

562
The SHA3 hash functions were specified by NIST in response to weaknesses
563
564
565
566
567
568
569
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
570

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

573
@deftp {Context struct} {struct sha3_224_ctx}
Niels Möller's avatar
Niels Möller committed
574
575
@end deftp

576
577
578
579
580
581
582
583
584
585
586
587
@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

588
@deftypefun void sha3_224_update (struct sha3_224_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
589
590
591
Hash some more data.
@end deftypefun

592
@deftypefun void sha3_224_digest (struct sha3_224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
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

611
@defvr Constant SHA3_256_DIGEST_SIZE
612
The size of a SHA3_256 digest, i.e., 32.
Niels Möller's avatar
Niels Möller committed
613
614
@end defvr

615
616
@defvr Constant SHA3_256_DATA_SIZE
The internal block size of SHA3_256.
Niels Möller's avatar
Niels Möller committed
617
618
@end defvr

619
620
@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
621
622
@end deftypefun

623
@deftypefun void sha3_256_update (struct sha3_256_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
Niels Möller's avatar
Niels Möller committed
624
625
626
Hash some more data.
@end deftypefun

627
@deftypefun void sha3_256_digest (struct sha3_256_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
628
629
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
630
@code{SHA3_256_DIGEST_SIZE}, in which case only the first @var{length}
631
632
octets of the digest are written.

633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
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

657
@deftypefun void sha3_384_update (struct sha3_384_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
658
659
660
Hash some more data.
@end deftypefun

661
@deftypefun void sha3_384_digest (struct sha3_384_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
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
687
688
689
690
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

691
@deftypefun void sha3_512_update (struct sha3_512_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
692
693
694
Hash some more data.
@end deftypefun

695
@deftypefun void sha3_512_digest (struct sha3_512_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
696
697
698
699
700
701
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
702
703
@end deftypefun

704
705
706
@node Legacy hash functions, nettle_hash abstraction, Recommended hash functions, Hash functions
@comment  node-name,  next,  previous,  up
@subsection Legacy hash functions
707

708
709
710
711
712
713
714
715
716
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.
717

718
@subsubsection @acronym{MD5}
719

720
721
722
723
724
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}
725
726
@end deftp

727
728
@defvr Constant MD5_DIGEST_SIZE
The size of an MD5 digest, i.e. 16.
729
730
@end defvr

731
732
733
@defvr Constant MD5_DATA_SIZE
The internal block size of MD5. Useful for some special constructions,
in particular HMAC-MD5.
734
735
@end defvr

736
737
@deftypefun void md5_init (struct md5_ctx *@var{ctx})
Initialize the MD5 state.
738
739
@end deftypefun

740
@deftypefun void md5_update (struct md5_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
741
742
743
Hash some more data.
@end deftypefun

744
@deftypefun void md5_digest (struct md5_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
745
746
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
747
@code{MD5_DIGEST_SIZE}, in which case only the first @var{length}
748
octets of the digest are written.
Niels Möller's avatar
Niels Möller committed
749

750
This function also resets the context in the same way as
751
@code{md5_init}.
Niels Möller's avatar
Niels Möller committed
752
753
@end deftypefun

754
755
756
757
758
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.
759

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

762
@subsubsection @acronym{MD2}
763

764
765
766
767
768
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}
769
770
@end deftp

771
772
@defvr Constant MD2_DIGEST_SIZE
The size of an MD2 digest, i.e. 16.
773
774
@end defvr

775
776
@defvr Constant MD2_DATA_SIZE
The internal block size of MD2.
777
778
@end defvr

779
780
@deftypefun void md2_init (struct md2_ctx *@var{ctx})
Initialize the MD2 state.
781
782
@end deftypefun

783
@deftypefun void md2_update (struct md2_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
784
785
786
Hash some more data.
@end deftypefun

787
@deftypefun void md2_digest (struct md2_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
788
789
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
790
@code{MD2_DIGEST_SIZE}, in which case only the first @var{length}
791
792
793
octets of the digest are written.

This function also resets the context in the same way as
794
@code{md2_init}.
795
796
@end deftypefun

797
@subsubsection @acronym{MD4}
798

799
800
801
802
803
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.
804

805
@deftp {Context struct} {struct md4_ctx}
806
807
@end deftp

808
809
@defvr Constant MD4_DIGEST_SIZE
The size of an MD4 digest, i.e. 16.
810
811
@end defvr

812
813
@defvr Constant MD4_DATA_SIZE
The internal block size of MD4.
814
815
@end defvr

816
817
@deftypefun void md4_init (struct md4_ctx *@var{ctx})
Initialize the MD4 state.
818
819
@end deftypefun

820
@deftypefun void md4_update (struct md4_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
821
822
823
Hash some more data.
@end deftypefun

824
@deftypefun void md4_digest (struct md4_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
825
826
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
827
@code{MD4_DIGEST_SIZE}, in which case only the first @var{length}
828
829
830
octets of the digest are written.

This function also resets the context in the same way as
831
@code{md4_init}.
832
833
@end deftypefun

834
@subsubsection @acronym{RIPEMD160}
835

836
837
838
839
840
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}.
841

842
843
@deftp {Context struct} {struct ripemd160_ctx}
@end deftp
844

845
@defvr Constant RIPEMD160_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
846
The size of a RIPEMD160 digest, i.e. 20.
847
848
849
850
851
852
853
854
855
856
@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

857
@deftypefun void ripemd160_update (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
858
859
860
Hash some more data.
@end deftypefun

861
@deftypefun void ripemd160_digest (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
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}
879
880
@end deftp

881
@defvr Constant SHA1_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
882
The size of a SHA1 digest, i.e. 20.
883
884
@end defvr

885
886
887
@defvr Constant SHA1_DATA_SIZE
The internal block size of SHA1. Useful for some special constructions,
in particular HMAC-SHA1.
888
889
@end defvr

890
891
@deftypefun void sha1_init (struct sha1_ctx *@var{ctx})
Initialize the SHA1 state.
892
893
@end deftypefun

894
@deftypefun void sha1_update (struct sha1_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
895
896
897
Hash some more data.
@end deftypefun

898
@deftypefun void sha1_digest (struct sha1_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
899
900
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
901
@code{SHA1_DIGEST_SIZE}, in which case only the first @var{length}
902
903
904
octets of the digest are written.

This function also resets the context in the same way as
905
@code{sha1_init}.
906
907
@end deftypefun

908
909

@subsubsection @acronym{GOSTHASH94}
910
911
912
913
914
915
916
917
918
919

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
920
The size of a GOSTHASH94 digest, i.e. 32.
921
922
923
924
925
926
927
928
929
930
@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

931
@deftypefun void gosthash94_update (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
932
933
934
Hash some more data.
@end deftypefun

935
@deftypefun void gosthash94_digest (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
936
937
938
939
940
941
942
943
944
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

945
946
947
@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
948
949
950

Nettle includes a struct including information about the supported hash
functions. It is defined in @file{<nettle/nettle-meta.h>}, and is used
951
952
by Nettle's implementation of @acronym{HMAC} (@pxref{Keyed hash
functions}).
Niels Möller's avatar
Niels Möller committed
953
954
955
956
957

@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
958
@code{void *} pointer to a context struct, which is of size
Niels Möller's avatar
Niels Möller committed
959
960
961
@code{context_size}. 
@end deftp

962
963
964
@deftypevr {Constant Struct} {struct nettle_hash} nettle_md2
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md4
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md5
965
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_ripemd160
966
967
968
969
970
@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
971
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha3_256
972
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_gosthash94
Niels Möller's avatar
Niels Möller committed
973
These are all the hash functions that Nettle implements.
974
@end deftypevr
975

976
Nettle also exports a list of all these hashes.
977

978
979
980
@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
981
982
@end deftypevr

983
@node Cipher functions, Cipher modes, Hash functions, Reference
Niels Möller's avatar
Niels Möller committed
984
985
@comment  node-name,  next,  previous,  up
@section Cipher functions
986
@cindex Cipher
Niels Möller's avatar
Niels Möller committed
987
988
989
990

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
991
plaintext. Given matching pairs of plaintext and ciphertext, it should
Niels Möller's avatar
Niels Möller committed
992
993
be hard to find the key.

994
995
996
@cindex Block Cipher
@cindex Stream Cipher

Niels Möller's avatar
Niels Möller committed
997
998
999
1000
1001
1002
1003
1004
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.
1005
However, using @acronym{ECB} is usually a bad idea. For a start, plaintext blocks
Niels Möller's avatar
Niels Möller committed
1006
1007
that are equal are transformed to ciphertext blocks that are equal; that
leaks information about the plaintext. Usually you should apply the
1008
1009
1010
1011
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
1012

Niels Möller's avatar
Niels Möller committed
1013
A stream cipher can be used for messages of arbitrary length. A typical
Niels Möller's avatar
Niels Möller committed
1014
stream cipher is a keyed pseudo-random generator. To encrypt a plaintext
Niels Möller's avatar
Niels Möller committed
1015
message of @var{n} octets, you key the generator, generate @var{n}
Niels Möller's avatar
Niels Möller committed
1016
octets of pseudo-random data, and XOR it with the plaintext. To decrypt,
Niels Möller's avatar
Niels Möller committed
1017
1018
1019
1020
1021
1022
1023
1024
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
1025
receive an encrypted message. You apply the key, and get a plaintext
1026
message that makes sense to you. Can you then be sure that it really was
Niels Möller's avatar
Niels Möller committed
1027
your friend that wrote the message you're reading? The answer is no. For
Niels Möller's avatar
Niels Möller committed
1028
1029
1030
1031
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
1032
1033
1034
1035
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
1036
1037
1038

It is recommended to @emph{always} use an authentication mechanism in
addition to encrypting the messages. Popular choices are Message
1039
1040
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
1041

1042
Some ciphers have so called ``weak keys'', keys that results in
Niels Möller's avatar
Niels Möller committed
1043
undesirable structure after the key setup processing, and should be
1044
1045
1046
1047
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
1048
1049
1050
have weak keys. There are several good ciphers that don't have any weak
keys.

1051
1052
1053
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
1054
as @dfn{key setup}. With Nettle, it is recommended to use each
1055
1056
1057
1058
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
1059
@subsection AES
1060
AES is a block cipher, specified by NIST as a replacement for
Niels Möller's avatar
Niels Möller committed
1061
the older DES standard. The standard is the result of a competition
1062
1063
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
1064
1065

Like all the AES candidates, the winning design uses a block size of 128
1066
1067
1068
1069
1070
1071
bits, or 16 octets, and three possible key-size, 128, 192 and 256 bits
(16, 24 and 32 octets) being the allowed key sizes. It does not have any
weak keys. Nettle defines AES in @file{<nettle/aes.h>}, and there is one
context struct for each key size. (Earlier versions of Nettle used a
single context struct, @code{struct aes_ctx}, for all key sizes. This
interface kept for backwards compatibility).
Niels Möller's avatar
Niels Möller committed
1072
 
1073
1074
1075
1076
1077
@deftp {Context struct} {struct aes128_ctx}
@deftpx {Context struct} {struct aes192_ctx}
@deftpx {Context struct} {struct aes256_ctx}
@end deftp

Niels Möller's avatar
Niels Möller committed
1078
@deftp {Context struct} {struct aes_ctx}
1079
Alternative struct, for the old AES interface.
Niels Möller's avatar
Niels Möller committed
1080
1081
1082
@end deftp

@defvr Constant AES_BLOCK_SIZE
Niels Möller's avatar
Niels Möller committed
1083
The AES block-size, 16.
Niels Möller's avatar
Niels Möller committed
1084
1085
@end defvr

1086
1087
1088
1089
1090
@defvr Constant AES128_KEY_SIZE
@defvrx Constant AES192_KEY_SIZE
@defvrx Constant AES256_KEY_SIZE
@defvrx Constant AES_MIN_KEY_SIZE
@defvrx Constant AES_MAX_KEY_SIZE
Niels Möller's avatar
Niels Möller committed
1091
1092
1093
@end defvr

@defvr Constant AES_KEY_SIZE
Niels Möller's avatar
Niels Möller committed
1094
Default AES key size, 32.
Niels Möller's avatar
Niels Möller committed
1095
1096
@end defvr

1097
1098
1099
1100
1101
1102
1103
1104
@deftypefun void aes128_set_encrypt_key (struct aes128_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes128_set_decrypt_key (struct aes128_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes192_set_encrypt_key (struct aes192_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes192_set_decrypt_key (struct aes192_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes256_set_encrypt_key (struct aes256_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes256_set_decrypt_key (struct aes256_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes_set_encrypt_key (struct aes_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{key})
@deftypefunx void aes_set_decrypt_key (struct aes_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{key})
1105
Initialize the cipher, for encryption or decryption, respectively.
Niels Möller's avatar
Niels Möller committed
1106
1107
@end deftypefun

1108
1109
1110
1111
@deftypefun void aes128_invert_key (struct aes128_ctx *@var{dst}, const struct aes128_ctx *@var{src})
@deftypefunx void aes192_invert_key (struct aes192_ctx *@var{dst}, const struct aes192_ctx *@var{src})
@deftypefunx void aes256_invert_key (struct aes256_ctx *@var{dst}, const struct aes256_ctx *@var{src})
@deftypefunx void aes_invert_key (struct aes_ctx *@var{dst}, const struct aes_ctx *@var{src})
1112
1113
1114
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
1115
1116
1117
1118
1119
converted in place. These functions are mainly useful for applications
which needs to both encrypt and decrypt using the @emph{same} key,
because calling, e.g., @code{aes128_set_encrypt_key} and
@code{aes128_invert_key}, is more efficient than calling
@code{aes128_set_encrypt_key} and @code{aes128_set_decrypt_key}.
1120
1121
@end deftypefun

1122
1123
1124
1125
@deftypefun void aes128_encrypt (struct aes128_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
@deftypefunx void aes192_encrypt (struct aes192_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
@deftypefunx void aes256_encrypt (struct aes256_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
@deftypefunx void aes_encrypt (struct aes_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
Niels Möller's avatar
Niels Möller committed
1126
1127
1128
1129
1130
1131
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

1132
1133
1134
1135
1136
@deftypefun void aes128_decrypt (struct aes128_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
@deftypefunx void aes192_decrypt (struct aes192_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
@deftypefunx void aes256_decrypt (struct aes256_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
@deftypefunx void aes_decrypt (struct aes_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{dst}, const uint8_t *@var{src})
Analogous to the encryption functions above.
Niels Möller's avatar
Niels Möller committed
1137
1138
1139
1140
1141
1142
1143
@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
1144
``secret:1'', ``secret:2'', @enddots{}. If you have keys that don't look
Niels Möller's avatar
Niels Möller committed
1145
like random bit strings, and you want to use ARCFOUR, always hash the
Niels Möller's avatar
Niels Möller committed
1146
1147
1148
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
1149
1150
1151
1152

@example
/* A more robust key setup function for ARCFOUR */
void
1153
arcfour_set_key_hashed(struct arcfour_ctx *ctx,
1154
                       size_t length, const uint8_t *key)
Niels Möller's avatar
Niels Möller committed
1155
@{
Niels Möller's avatar
Niels Möller committed
1156
1157
1158
  struct sha256_ctx hash;
  uint8_t digest[SHA256_DIGEST_SIZE];
  uint8_t buffer[0x200];
Niels Möller's avatar
Niels Möller committed
1159

Niels Möller's avatar
Niels Möller committed
1160
1161
1162
  sha256_init(&hash);
  sha256_update(&hash, length, key);
  sha256_digest(&hash, SHA256_DIGEST_SIZE, digest);
Niels Möller's avatar
Niels Möller committed
1163

Niels Möller's avatar
Niels Möller committed
1164
1165
  arcfour_set_key(ctx, SHA256_DIGEST_SIZE, digest);
  arcfour_crypt(ctx, sizeof(buffer), buffer, buffer);
Niels Möller's avatar
Niels Möller committed
1166
1167
1168
1169
1170
1171
1172
1173
1174
@}
@end example

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

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

@defvr Constant ARCFOUR_MIN_KEY_SIZE
Niels Möller's avatar
Niels Möller committed
1175
Minimum key size, 1.
Niels Möller's avatar
Niels Möller committed
1176
1177
1178
@end defvr

@defvr Constant ARCFOUR_MAX_KEY_SIZE
Niels Möller's avatar
Niels Möller committed
1179
Maximum key size, 256.