nettle.texinfo 181 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
* Miscellaneous functions::     
* Compatibility functions::     

Cipher modes

* CBC::                         
* CTR::                         
* GCM::                         
Owen Kirby's avatar
Owen Kirby committed
91
* CCM::
92
93
94
95
96

Public-key algorithms

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

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

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

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

Niels Möller's avatar
Niels Möller committed
140
141
142
143
144
145
146
Nettle is dual licenced under the GNU General Public License version 2
or later, and the GNU Lesser General Public License version 3 or later.
When using Nettle, you must comply fully with all conditions of at least
one of these licenses. A few of the individual files are licensed under
more permissive terms, or 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
147

148
149
150
151
152
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
153
154
A list of the supported algorithms, their origins, and exceptions to the
above licensing:
Niels Möller's avatar
Niels Möller committed
155
156
157
158

@table @emph
@item AES
The implementation of the AES cipher (also known as rijndael) is written
159
by Rafael Sevilla. Assembler for x86 by Rafael Sevilla and
Niels Möller's avatar
Niels Möller committed
160
@value{AUTHOR}, Sparc assembler by @value{AUTHOR}.
Niels Möller's avatar
Niels Möller committed
161
162
163

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

Niels Möller's avatar
Niels Möller committed
166
167
168
@item ARCTWO
The implementation of the ARCTWO (also known as RC2) cipher is written
by Nikos Mavroyanopoulos and modified by Werner Koch and Simon
Niels Möller's avatar
Niels Möller committed
169
Josefsson.
Niels Möller's avatar
Niels Möller committed
170

Niels Möller's avatar
Niels Möller committed
171
172
@item BLOWFISH
The implementation of the BLOWFISH cipher is written by Werner Koch,
173
copyright owned by the Free Software Foundation. Also hacked by Simon
Niels Möller's avatar
Niels Möller committed
174
Josefsson and Niels Möller.
Niels Möller's avatar
Niels Möller committed
175

176
@item CAMELLIA
177
The C implementation is by Nippon Telegraph and Telephone Corporation
178
(NTT), heavily modified by @value{AUTHOR}. Assembler for x86 and x86_64
Niels Möller's avatar
Niels Möller committed
179
by @value{AUTHOR}.
180

Niels Möller's avatar
Niels Möller committed
181
182
183
184
@item CAST128
The implementation of the CAST128 cipher is written by Steve Reid.
Released into the public domain.

Niels Möller's avatar
Niels Möller committed
185
186
187
188
@item CHACHA
Implemented by Joachim Strömbergson, based on the implementation of
SALSA20 (see below). Assembly for x86_64 by Niels Möller.

Niels Möller's avatar
Niels Möller committed
189
190
@item DES
The implementation of the DES cipher is written by Dana L. How, and
Niels Möller's avatar
Niels Möller committed
191
released under the LGPL, version 2 or later.
Niels Möller's avatar
Niels Möller committed
192

193
194
195
196
197
@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.

198
199
@item MD2
The implementation of MD2 is written by Andrew Kuchling, and hacked
200
some by Andreas Sigfridsson and @value{AUTHOR}. Python Cryptography
201
202
203
204
205
206
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
207
208
@item MD5
The implementation of the MD5 message digest is written by Colin Plumb.
209
It has been hacked some more by Andrew Kuchling and @value{AUTHOR}.
Niels Möller's avatar
Niels Möller committed
210
211
Released into the public domain.

212
213
@item PBKDF2
The C implementation of PBKDF2 is based on earlier work for Shishi and
Niels Möller's avatar
Niels Möller committed
214
GnuTLS by Simon Josefsson.
215

216
@item RIPEMD160
217
218
The implementation of RIPEMD160 message digest is based on the code in
libgcrypt, copyright owned by the Free Software Foundation. Ported to
Niels Möller's avatar
Niels Möller committed
219
Nettle by Andres Mejia.
220

Niels Möller's avatar
Niels Möller committed
221
222
@item SALSA20
The C implementation of SALSA20 is based on D. J. Bernstein's reference
223
implementation (in the public domain), adapted to Nettle by Simon
224
Josefsson, and heavily modified by Niels Möller. Assembly for x86_64 and
Niels Möller's avatar
Niels Möller committed
225
ARM by Niels Möller.
Simon Josefsson's avatar
Simon Josefsson committed
226

Niels Möller's avatar
Niels Möller committed
227
@item SERPENT
228
The implementation of the SERPENT cipher is based on the code in libgcrypt,
229
copyright owned by the Free Software Foundation. Adapted to Nettle by
Niels Möller's avatar
Niels Möller committed
230
Simon Josefsson and heavily modified by Niels Möller. Assembly for
Niels Möller's avatar
Niels Möller committed
231
232
233
234
235
236
x86_64 by Niels Möller.

@item POLY1305
Based on the implementation by Andrew M. (floodyberry), modified by
Nikos Mavrogiannopoulos and Niels Möller. Assembly for x86_64 by Niels
Möller.
Niels Möller's avatar
Niels Möller committed
237
238

@item SHA1
239
240
The C implementation of the SHA1 message digest is written by Peter
Gutmann, and hacked some more by Andrew Kuchling and @value{AUTHOR}.
241
242
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
243

Niels Möller's avatar
Niels Möller committed
244
@item SHA2
Niels Möller's avatar
Niels Möller committed
245
246
Written by @value{AUTHOR}, using Peter Gutmann's SHA1 code as a model. 

Niels Möller's avatar
Niels Möller committed
247
@item SHA3
Niels Möller's avatar
Niels Möller committed
248
Written by @value{AUTHOR}.
249

Niels Möller's avatar
Niels Möller committed
250
251
@item TWOFISH
The implementation of the TWOFISH cipher is written by Ruud de Rooij.
Niels Möller's avatar
Niels Möller committed
252

253
@item UMAC
Niels Möller's avatar
Niels Möller committed
254
Written by @value{AUTHOR}.
255

Niels Möller's avatar
Niels Möller committed
256
@item RSA
Niels Möller's avatar
Niels Möller committed
257
Written by @value{AUTHOR}. Uses the GMP library for bignum operations.
Niels Möller's avatar
Niels Möller committed
258
259

@item DSA
Niels Möller's avatar
Niels Möller committed
260
Written by @value{AUTHOR}. Uses the GMP library for bignum operations.
261
262

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

277
278
For consistency, functions for different algorithms are very similar,
but there are some differences, for instance reflecting if the key setup
279
or encryption function differ for encryption and decryption, and whether
280
281
282
283
284
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
285

286
287
288
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
289
290
291
292
293
294
295

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
296
type @code{size_t}, and a pointer of type @code{uint8_t *} or
Niels Möller's avatar
Niels Möller committed
297
298
@code{const uint8_t *}. For functions that transform one string to
another, the argument order is length, destination pointer and source
299
300
301
302
303
304
pointer. Source and destination areas are usually of the same length.
When they differ, e.g., for @code{ccm_encrypt_message}, the length
argument specifies the size of the destination area. Source and
destination pointers may be equal, so that you can process strings in
place, but source and destination areas @emph{must not} overlap in any
other way.
Niels Möller's avatar
Niels Möller committed
305

306
307
308
Many of the functions lack return value and can never fail. Those
functions which can fail, return one on success and zero on failure.

309
310
@c FIXME: Say something about the name mangling.

311
@node Example, Linking, Conventions, Top
Niels Möller's avatar
Niels Möller committed
312
313
314
@comment  node-name,  next,  previous,  up
@chapter Example

315
A simple example program that reads a file from standard input and
316
writes its SHA1 check-sum on standard output should give the flavor of
317
Nettle.
Niels Möller's avatar
Niels Möller committed
318
319

@example
320
@verbatiminclude sha-example.c
Niels Möller's avatar
Niels Möller committed
321
322
@end example

323
324
325
On a typical Unix system, this program can be compiled and linked with
the command line 
@example
326
gcc sha-example.c -o sha-example -lnettle
327
328
329
330
331
332
333
334
335
336
337
338
@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.

339
340
341
342
343
344
345
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.
346
347

@node Reference, Nettle soup, Linking, Top
Niels Möller's avatar
Niels Möller committed
348
349
350
351
352
353
354
355
@comment  node-name,  next,  previous,  up
@chapter Reference

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

@menu
* Hash functions::              
* Cipher functions::            
356
* Cipher modes::                
Niels Möller's avatar
Niels Möller committed
357
* Keyed hash functions::        
Simon Josefsson's avatar
Simon Josefsson committed
358
* Key derivation functions::    
359
360
* Public-key algorithms::       
* Randomness::                  
361
* ASCII encoding::              
Niels Möller's avatar
Niels Möller committed
362
* Miscellaneous functions::     
363
* Compatibility functions::     
Niels Möller's avatar
Niels Möller committed
364
365
366
367
@end menu

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

Niels Möller's avatar
Niels Möller committed
369
@section Hash functions
370
@cindex Hash function
Niels Möller's avatar
Niels Möller committed
371
372
373
374
375
376
377
378
379
380
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
381
@cindex One-way
Niels Möller's avatar
Niels Möller committed
382
383
384
385
Given a hash value @code{H(x)} it is hard to find a string @code{x}
that hashes to that value.

@item Collision-resistant
386
@cindex Collision-resistant
Niels Möller's avatar
Niels Möller committed
387
388
389
390
391
392
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,
393
message authentication codes, pseudo random generators, association of
394
unique ids to documents, and many other things.
Niels Möller's avatar
Niels Möller committed
395

Niels Möller's avatar
Niels Möller committed
396
397
The most commonly used hash functions are MD5 and SHA1. Unfortunately,
both these fail the collision-resistance requirement; cryptologists have
398
399
400
401
402
403
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.
404

405
406
407
408
409
@menu
* Recommended hash functions::
* Legacy hash functions::
* nettle_hash abstraction::
@end menu
Niels Möller's avatar
Niels Möller committed
410

411
412
413
@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
414

415
416
417
418
419
420
421
422
423
424
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
425
426
@end deftp

427
@defvr Constant SHA256_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
428
The size of a SHA256 digest, i.e. 32.
Niels Möller's avatar
Niels Möller committed
429
430
@end defvr

431
@defvr Constant SHA256_BLOCK_SIZE
432
433
The internal block size of SHA256. Useful for some special constructions,
in particular HMAC-SHA256.
Niels Möller's avatar
Niels Möller committed
434
435
@end defvr

436
437
@deftypefun void sha256_init (struct sha256_ctx *@var{ctx})
Initialize the SHA256 state.
Niels Möller's avatar
Niels Möller committed
438
439
@end deftypefun

440
@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
441
442
443
Hash some more data.
@end deftypefun

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

450
This function also resets the context in the same way as
451
@code{sha256_init}.
Niels Möller's avatar
Niels Möller committed
452
453
@end deftypefun

454
455
456
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
457

458
@subsubsection @acronym{SHA224}
459

460
461
462
463
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).
464

465
@deftp {Context struct} {struct sha224_ctx}
466
467
@end deftp

468
@defvr Constant SHA224_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
469
The size of a SHA224 digest, i.e. 28.
470
471
@end defvr

472
@defvr Constant SHA224_BLOCK_SIZE
473
474
The internal block size of SHA224. Useful for some special constructions,
in particular HMAC-SHA224.
475
476
@end defvr

477
478
@deftypefun void sha224_init (struct sha224_ctx *@var{ctx})
Initialize the SHA224 state.
479
480
@end deftypefun

481
@deftypefun void sha224_update (struct sha224_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
482
483
484
Hash some more data.
@end deftypefun

485
@deftypefun void sha224_digest (struct sha224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
486
487
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
488
@code{SHA224_DIGEST_SIZE}, in which case only the first @var{length}
489
490
491
octets of the digest are written.

This function also resets the context in the same way as
492
@code{sha224_init}.
493
494
@end deftypefun

495
@subsubsection @acronym{SHA512}
496

497
498
499
500
501
502
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).
503

504
@deftp {Context struct} {struct sha512_ctx}
505
506
@end deftp

507
@defvr Constant SHA512_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
508
The size of a SHA512 digest, i.e. 64.
509
510
@end defvr

511
@defvr Constant SHA512_BLOCK_SIZE
512
513
The internal block size of SHA512, 128. Useful for some special
constructions, in particular HMAC-SHA512.
514
515
@end defvr

516
517
@deftypefun void sha512_init (struct sha512_ctx *@var{ctx})
Initialize the SHA512 state.
518
519
@end deftypefun

520
@deftypefun void sha512_update (struct sha512_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
521
522
523
Hash some more data.
@end deftypefun

524
@deftypefun void sha512_digest (struct sha512_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
525
526
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
527
@code{SHA512_DIGEST_SIZE}, in which case only the first @var{length}
528
529
530
octets of the digest are written.

This function also resets the context in the same way as
531
@code{sha512_init}.
532
533
@end deftypefun

534
@subsubsection @acronym{SHA384 and other variants of SHA512}
535

536
537
538
539
540
541
Several variants of SHA512 have been defined, with a different initial
state, and with the output truncated to shorter length than 512 bits.
Naming is a bit confused, these algorithms are call SHA512-224,
SHA512-256 and SHA384, for output sizes of 224, 256 and 384 bits,
respectively. Nettle defines these in @file{<nettle/sha2.h>} (and in
@file{<nettle/sha.h>}, for backwards compatibility).
542

543
544
545
546
547
548
@deftp {Context struct} {struct sha512_224_ctx}
@deftpx {Context struct} {struct sha512_256_ctx}
@deftpx {Context struct} {struct sha384_ctx}
These context structs are all the same as sha512_ctx. They are defined as
simple preprocessor aliases, which may cause some problems if used as
identifiers for other purposes. So avoid doing that.
549
550
@end deftp

551
552
553
@defvr Constant SHA512_224_DIGEST_SIZE
@defvrx Constant SHA512_256_DIGEST_SIZE
@defvrx Constant SHA384_DIGEST_SIZE
554
The digest size for each variant, i.e., 28, 32, and 48, respectively.
555
556
@end defvr

557
558
559
560
@defvr Constant SHA512_224_BLOCK_SIZE
@defvrx Constant SHA512_256_BLOCK_SIZE
@defvrx Constant SHA384_BLOCK_SIZE
The internal block size, same as SHA512_BLOCK_SIZE, i.e., 128. Useful for
561
some special constructions, in particular HMAC-SHA384.
562
563
@end defvr

564
565
566
567
@deftypefun void sha512_224_init (struct sha512_224_ctx *@var{ctx})
@deftypefunx void sha512_256_init (struct sha512_256_ctx *@var{ctx})
@deftypefunx void sha384_init (struct sha384_ctx *@var{ctx})
Initialize the context struct.
568
569
@end deftypefun

570
571
572
573
574
@deftypefun void sha512_224_update (struct sha512_224_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
@deftypefunx void sha512_256_update (struct sha512_256_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
@deftypefunx void sha384_update (struct sha384_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
Hash some more data. These are all aliases for sha512_update, which does
the same thing.
575
576
@end deftypefun

577
578
579
580
581
582
583
@deftypefun void sha512_224_digest (struct sha512_224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
@deftypefunx void sha512_256_digest (struct sha512_256_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
@deftypefunx void sha384_digest (struct sha384_ctx *@var{ctx}, size_t @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 the specified digest
size, in which case only the first @var{length} octets of the digest are
written.
584

585
586
These function also reset the context in the same way as the
corresponding init function.
587
588
@end deftypefun

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

591
The SHA3 hash functions were specified by NIST in response to weaknesses
592
593
594
595
596
597
598
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
599

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

602
@deftp {Context struct} {struct sha3_224_ctx}
Niels Möller's avatar
Niels Möller committed
603
604
@end deftp

605
606
607
608
@defvr Constant SHA3_224_DIGEST_SIZE
The size of a SHA3_224 digest, i.e., 28.
@end defvr

609
@defvr Constant SHA3_224_BLOCK_SIZE
610
611
612
613
614
615
616
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

617
@deftypefun void sha3_224_update (struct sha3_224_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
618
619
620
Hash some more data.
@end deftypefun

621
@deftypefun void sha3_224_digest (struct sha3_224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
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

640
@defvr Constant SHA3_256_DIGEST_SIZE
641
The size of a SHA3_256 digest, i.e., 32.
Niels Möller's avatar
Niels Möller committed
642
643
@end defvr

644
@defvr Constant SHA3_256_BLOCK_SIZE
645
The internal block size of SHA3_256.
Niels Möller's avatar
Niels Möller committed
646
647
@end defvr

648
649
@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
650
651
@end deftypefun

652
@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
653
654
655
Hash some more data.
@end deftypefun

656
@deftypefun void sha3_256_digest (struct sha3_256_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
657
658
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
659
@code{SHA3_256_DIGEST_SIZE}, in which case only the first @var{length}
660
661
octets of the digest are written.

662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
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

678
@defvr Constant SHA3_384_BLOCK_SIZE
679
680
681
682
683
684
685
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

686
@deftypefun void sha3_384_update (struct sha3_384_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
687
688
689
Hash some more data.
@end deftypefun

690
@deftypefun void sha3_384_digest (struct sha3_384_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
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

712
@defvr Constant SHA3_512_BLOCK_SIZE
713
714
715
716
717
718
719
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

720
@deftypefun void sha3_512_update (struct sha3_512_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
721
722
723
Hash some more data.
@end deftypefun

724
@deftypefun void sha3_512_digest (struct sha3_512_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
725
726
727
728
729
730
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
731
732
@end deftypefun

733
734
735
@node Legacy hash functions, nettle_hash abstraction, Recommended hash functions, Hash functions
@comment  node-name,  next,  previous,  up
@subsection Legacy hash functions
736

737
738
739
740
741
742
743
744
745
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.
746

747
@subsubsection @acronym{MD5}
748

749
750
751
752
753
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}
754
755
@end deftp

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

760
@defvr Constant MD5_BLOCK_SIZE
761
762
The internal block size of MD5. Useful for some special constructions,
in particular HMAC-MD5.
763
764
@end defvr

765
766
@deftypefun void md5_init (struct md5_ctx *@var{ctx})
Initialize the MD5 state.
767
768
@end deftypefun

769
@deftypefun void md5_update (struct md5_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
770
771
772
Hash some more data.
@end deftypefun

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

779
This function also resets the context in the same way as
780
@code{md5_init}.
Niels Möller's avatar
Niels Möller committed
781
782
@end deftypefun

783
784
785
786
787
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.
788

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

791
@subsubsection @acronym{MD2}
792

793
794
795
796
797
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}
798
799
@end deftp

800
801
@defvr Constant MD2_DIGEST_SIZE
The size of an MD2 digest, i.e. 16.
802
803
@end defvr

804
@defvr Constant MD2_BLOCK_SIZE
805
The internal block size of MD2.
806
807
@end defvr

808
809
@deftypefun void md2_init (struct md2_ctx *@var{ctx})
Initialize the MD2 state.
810
811
@end deftypefun

812
@deftypefun void md2_update (struct md2_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
813
814
815
Hash some more data.
@end deftypefun

816
@deftypefun void md2_digest (struct md2_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
817
818
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
819
@code{MD2_DIGEST_SIZE}, in which case only the first @var{length}
820
821
822
octets of the digest are written.

This function also resets the context in the same way as
823
@code{md2_init}.
824
825
@end deftypefun

826
@subsubsection @acronym{MD4}
827

828
829
830
831
832
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.
833

834
@deftp {Context struct} {struct md4_ctx}
835
836
@end deftp

837
838
@defvr Constant MD4_DIGEST_SIZE
The size of an MD4 digest, i.e. 16.
839
840
@end defvr

841
@defvr Constant MD4_BLOCK_SIZE
842
The internal block size of MD4.
843
844
@end defvr

845
846
@deftypefun void md4_init (struct md4_ctx *@var{ctx})
Initialize the MD4 state.
847
848
@end deftypefun

849
@deftypefun void md4_update (struct md4_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
850
851
852
Hash some more data.
@end deftypefun

853
@deftypefun void md4_digest (struct md4_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
854
855
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
856
@code{MD4_DIGEST_SIZE}, in which case only the first @var{length}
857
858
859
octets of the digest are written.

This function also resets the context in the same way as
860
@code{md4_init}.
861
862
@end deftypefun

863
@subsubsection @acronym{RIPEMD160}
864

865
866
867
868
869
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}.
870

871
872
@deftp {Context struct} {struct ripemd160_ctx}
@end deftp
873

874
@defvr Constant RIPEMD160_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
875
The size of a RIPEMD160 digest, i.e. 20.
876
877
@end defvr

878
@defvr Constant RIPEMD160_BLOCK_SIZE
879
880
881
882
883
884
885
The internal block size of RIPEMD160.
@end defvr

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

886
@deftypefun void ripemd160_update (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
887
888
889
Hash some more data.
@end deftypefun

890
@deftypefun void ripemd160_digest (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
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}
908
909
@end deftp

910
@defvr Constant SHA1_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
911
The size of a SHA1 digest, i.e. 20.
912
913
@end defvr

914
@defvr Constant SHA1_BLOCK_SIZE
915
916
The internal block size of SHA1. Useful for some special constructions,
in particular HMAC-SHA1.
917
918
@end defvr

919
920
@deftypefun void sha1_init (struct sha1_ctx *@var{ctx})
Initialize the SHA1 state.
921
922
@end deftypefun

923
@deftypefun void sha1_update (struct sha1_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
924
925
926
Hash some more data.
@end deftypefun

927
@deftypefun void sha1_digest (struct sha1_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
928
929
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
930
@code{SHA1_DIGEST_SIZE}, in which case only the first @var{length}
931
932
933
octets of the digest are written.

This function also resets the context in the same way as
934
@code{sha1_init}.
935
936
@end deftypefun

937
938

@subsubsection @acronym{GOSTHASH94}
939
940
941
942
943
944
945
946
947
948

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
949
The size of a GOSTHASH94 digest, i.e. 32.
950
951
@end defvr

952
@defvr Constant GOSTHASH94_BLOCK_SIZE
953
954
955
956
957
958
959
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

960
@deftypefun void gosthash94_update (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
961
962
963
Hash some more data.
@end deftypefun

964
@deftypefun void gosthash94_digest (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
965
966
967
968
969
970
971
972
973
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

974
975
976
@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
977
978
979

Nettle includes a struct including information about the supported hash
functions. It is defined in @file{<nettle/nettle-meta.h>}, and is used
980
981
by Nettle's implementation of @acronym{HMAC} (@pxref{Keyed hash
functions}).
Niels Möller's avatar
Niels Möller committed
982
983
984
985
986

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

991
992
993
@deftypevr {Constant Struct} {struct nettle_hash} nettle_md2
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md4
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md5
994
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_ripemd160
995
996
997
998
999
@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
1000
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha3_256
1001
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_gosthash94
Niels Möller's avatar
Niels Möller committed
1002
These are all the hash functions that Nettle implements.
1003
@end deftypevr
1004

1005
Nettle also exports a list of all these hashes.
1006

1007
1008
1009
@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
1010
1011
@end deftypevr

1012
@node Cipher functions, Cipher modes, Hash functions, Reference
Niels Möller's avatar
Niels Möller committed
1013
1014
@comment  node-name,  next,  previous,  up
@section Cipher functions
1015
@cindex Cipher
Niels Möller's avatar
Niels Möller committed
1016
1017
1018
1019

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

1023
1024
1025
@cindex Block Cipher
@cindex Stream Cipher

Niels Möller's avatar
Niels Möller committed
1026
1027
1028
1029
1030
1031
1032
1033
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.
1034
However, using @acronym{ECB} is usually a bad idea. For a start, plaintext blocks
Niels Möller's avatar
Niels Möller committed
1035
1036
that are equal are transformed to ciphertext blocks that are equal; that
leaks information about the plaintext. Usually you should apply the
1037
1038
1039
1040
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
1041

Niels Möller's avatar
Niels Möller committed
1042
A stream cipher can be used for messages of arbitrary length. A typical
Niels Möller's avatar
Niels Möller committed
1043
stream cipher is a keyed pseudo-random generator. To encrypt a plaintext
Niels Möller's avatar
Niels Möller committed
1044
message of @var{n} octets, you key the generator, generate @var{n}
Niels Möller's avatar
Niels Möller committed
1045
octets of pseudo-random data, and XOR it with the plaintext. To decrypt,
Niels Möller's avatar
Niels Möller committed
1046
1047
1048
1049
1050
1051
1052
1053
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
1054
receive an encrypted message. You apply the key, and get a plaintext
1055
message that makes sense to you. Can you then be sure that it really was
Niels Möller's avatar
Niels Möller committed
1056
your friend that wrote the message you're reading? The answer is no. For
Niels Möller's avatar
Niels Möller committed
1057
1058
1059
1060
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
1061
1062
1063
1064
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
1065
1066
1067

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

1071
Some ciphers have so called ``weak keys'', keys that results in
Niels Möller's avatar
Niels Möller committed
1072
undesirable structure after the key setup processing, and should be
1073
1074
1075
1076
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
1077
1078
1079
have weak keys. There are several good ciphers that don't have any weak
keys.

1080
1081
1082
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
1083
as @dfn{key setup}. With Nettle, it is recommended to use each
1084
1085
1086
1087
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
1088
@subsection AES
1089
AES is a block cipher, specified by NIST as a replacement for
Niels Möller's avatar
Niels Möller committed
1090
the older DES standard. The standard is the result of a competition
1091
1092
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
1093
1094

Like all the AES candidates, the winning design uses a block size of 128
1095
1096
1097
1098
1099
1100
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
1101
 
1102
1103
1104
1105
1106
@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
1107
@deftp {Context struct} {struct aes_ctx}
1108
Alternative struct, for the old AES interface.
Niels Möller's avatar
Niels Möller committed
1109
1110
1111
@end deftp

@defvr Constant AES_BLOCK_SIZE
Niels Möller's avatar
Niels Möller committed
1112
The AES block-size, 16.
Niels Möller's avatar
Niels Möller committed
1113
1114
@end defvr

1115
1116
1117
1118
1119
@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
1120
1121
1122
@end defvr

@defvr Constant AES_KEY_SIZE
Niels Möller's avatar
Niels Möller committed
1123
Default AES key size, 32.
Niels Möller's avatar
Niels Möller committed
1124
1125
@end defvr

1126
1127
1128
1129
1130
1131