nettle.texinfo 226 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 3.2
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

Niels Möller's avatar
Niels Möller committed
17
Originally written 2001 by @value{AUTHOR}, updated 2015.
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
* Miscellaneous functions::     
* Compatibility functions::     

86
87
88
89
90
91
Hash functions

* Recommended hash functions::
* Legacy hash functions::
* nettle_hash abstraction::

92
93
94
95
96
Cipher modes

* CBC::                         
* CTR::                         
* GCM::                         
97
98
99
100
101
102
* CCM::                         

Keyed Hash Functions

* HMAC::
* UMAC::
103
104
105
106
107

Public-key algorithms

* RSA::                         The RSA public key algorithm.
* DSA::                         The DSA digital signature algorithm.
108
* Elliptic curves::             Elliptic curves and ECDSA
109

110
111
112
113
114
115
@acronym{Elliptic curves}

* Side-channel silence::
* ECDSA::
* Curve 25519::

116
@end detailmenu
Niels Möller's avatar
Niels Möller committed
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
@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.

133
And as the requirements of applications differ in subtle and not so
Niels Möller's avatar
Niels Möller committed
134
135
136
137
138
139
140
141
142
143
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
144
interfaces on top of Nettle, and share the code, test cases, benchmarks,
Niels Möller's avatar
Niels Möller committed
145
146
147
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
148

149
150
151
152
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
153
154
155
156
@node Copyright, Conventions, Introduction, Top
@comment  node-name,  next,  previous,  up
@chapter Copyright

Niels Möller's avatar
Niels Möller committed
157
158
159
160
161
162
163
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
164

165
166
167
168
169
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
170
171
A list of the supported algorithms, their origins, and exceptions to the
above licensing:
Niels Möller's avatar
Niels Möller committed
172
173
174
175

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

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

Niels Möller's avatar
Niels Möller committed
183
184
185
@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
186
Josefsson.
Niels Möller's avatar
Niels Möller committed
187

Niels Möller's avatar
Niels Möller committed
188
189
@item BLOWFISH
The implementation of the BLOWFISH cipher is written by Werner Koch,
190
copyright owned by the Free Software Foundation. Also hacked by Simon
Niels Möller's avatar
Niels Möller committed
191
Josefsson and Niels Möller.
Niels Möller's avatar
Niels Möller committed
192

193
@item CAMELLIA
194
The C implementation is by Nippon Telegraph and Telephone Corporation
195
(NTT), heavily modified by @value{AUTHOR}. Assembler for x86 and x86_64
Niels Möller's avatar
Niels Möller committed
196
by @value{AUTHOR}.
197

Niels Möller's avatar
Niels Möller committed
198
199
200
201
@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
202
203
204
205
@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
206
207
@item DES
The implementation of the DES cipher is written by Dana L. How, and
Niels Möller's avatar
Niels Möller committed
208
released under the LGPL, version 2 or later.
Niels Möller's avatar
Niels Möller committed
209

210
211
212
213
214
@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.

215
216
@item MD2
The implementation of MD2 is written by Andrew Kuchling, and hacked
217
some by Andreas Sigfridsson and @value{AUTHOR}. Python Cryptography
218
219
220
221
222
223
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
224
225
@item MD5
The implementation of the MD5 message digest is written by Colin Plumb.
226
It has been hacked some more by Andrew Kuchling and @value{AUTHOR}.
Niels Möller's avatar
Niels Möller committed
227
228
Released into the public domain.

229
230
@item PBKDF2
The C implementation of PBKDF2 is based on earlier work for Shishi and
Niels Möller's avatar
Niels Möller committed
231
GnuTLS by Simon Josefsson.
232

233
@item RIPEMD160
234
235
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
236
Nettle by Andres Mejia.
237

Niels Möller's avatar
Niels Möller committed
238
239
@item SALSA20
The C implementation of SALSA20 is based on D. J. Bernstein's reference
240
implementation (in the public domain), adapted to Nettle by Simon
241
Josefsson, and heavily modified by Niels Möller. Assembly for x86_64 and
Niels Möller's avatar
Niels Möller committed
242
ARM by Niels Möller.
Simon Josefsson's avatar
Simon Josefsson committed
243

Niels Möller's avatar
Niels Möller committed
244
@item SERPENT
245
The implementation of the SERPENT cipher is based on the code in libgcrypt,
246
copyright owned by the Free Software Foundation. Adapted to Nettle by
Niels Möller's avatar
Niels Möller committed
247
Simon Josefsson and heavily modified by Niels Möller. Assembly for
Niels Möller's avatar
Niels Möller committed
248
249
250
251
252
253
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
254
255

@item SHA1
256
257
The C implementation of the SHA1 message digest is written by Peter
Gutmann, and hacked some more by Andrew Kuchling and @value{AUTHOR}.
258
259
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
260

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

Niels Möller's avatar
Niels Möller committed
264
@item SHA3
Niels Möller's avatar
Niels Möller committed
265
Written by @value{AUTHOR}.
266

Niels Möller's avatar
Niels Möller committed
267
268
@item TWOFISH
The implementation of the TWOFISH cipher is written by Ruud de Rooij.
Niels Möller's avatar
Niels Möller committed
269

270
@item UMAC
Niels Möller's avatar
Niels Möller committed
271
Written by @value{AUTHOR}.
272

Niels Möller's avatar
Niels Möller committed
273
@item RSA
Niels Möller's avatar
Niels Möller committed
274
Written by @value{AUTHOR}. Uses the GMP library for bignum operations.
Niels Möller's avatar
Niels Möller committed
275
276

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

@item ECDSA
Niels Möller's avatar
Niels Möller committed
280
281
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
282
283
284
285
286
287
288
289
@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
290
operating on the context. The context struct encapsulates all information
Niels Möller's avatar
Niels Möller committed
291
292
293
needed by the algorithm, and it can be copied or moved in memory with no
unexpected effects.

294
295
For consistency, functions for different algorithms are very similar,
but there are some differences, for instance reflecting if the key setup
296
or encryption function differ for encryption and decryption, and whether
297
298
299
300
301
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
302

303
304
305
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
306
307
308
309
310
311
312

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
313
type @code{size_t}, and a pointer of type @code{uint8_t *} or
Niels Möller's avatar
Niels Möller committed
314
315
@code{const uint8_t *}. For functions that transform one string to
another, the argument order is length, destination pointer and source
316
317
318
319
320
321
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
322

323
324
325
Many of the functions lack return value and can never fail. Those
functions which can fail, return one on success and zero on failure.

326
327
@c FIXME: Say something about the name mangling.

328
@node Example, Linking, Conventions, Top
Niels Möller's avatar
Niels Möller committed
329
330
331
@comment  node-name,  next,  previous,  up
@chapter Example

332
A simple example program that reads a file from standard input and
333
writes its SHA1 check-sum on standard output should give the flavor of
334
Nettle.
Niels Möller's avatar
Niels Möller committed
335
336

@example
337
@verbatiminclude sha-example.c
Niels Möller's avatar
Niels Möller committed
338
339
@end example

340
341
342
On a typical Unix system, this program can be compiled and linked with
the command line 
@example
343
gcc sha-example.c -o sha-example -lnettle
344
345
346
347
348
349
350
351
352
353
354
355
@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.

356
357
358
359
360
361
362
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.
363
364

@node Reference, Nettle soup, Linking, Top
Niels Möller's avatar
Niels Möller committed
365
366
367
368
369
370
371
372
@comment  node-name,  next,  previous,  up
@chapter Reference

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

@menu
* Hash functions::              
* Cipher functions::            
373
* Cipher modes::                
374
* Authenticated encryption::
Niels Möller's avatar
Niels Möller committed
375
* Keyed hash functions::        
Simon Josefsson's avatar
Simon Josefsson committed
376
* Key derivation functions::    
377
378
* Public-key algorithms::       
* Randomness::                  
379
* ASCII encoding::              
Niels Möller's avatar
Niels Möller committed
380
* Miscellaneous functions::     
381
* Compatibility functions::     
Niels Möller's avatar
Niels Möller committed
382
383
384
385
@end menu

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

Niels Möller's avatar
Niels Möller committed
387
@section Hash functions
388
@cindex Hash function
Niels Möller's avatar
Niels Möller committed
389
390
391
392
393
394
395
396
397
398
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
399
@cindex One-way
Niels Möller's avatar
Niels Möller committed
400
401
402
403
Given a hash value @code{H(x)} it is hard to find a string @code{x}
that hashes to that value.

@item Collision-resistant
404
@cindex Collision-resistant
Niels Möller's avatar
Niels Möller committed
405
406
407
408
409
410
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,
411
message authentication codes, pseudo random generators, association of
412
unique ids to documents, and many other things.
Niels Möller's avatar
Niels Möller committed
413

Niels Möller's avatar
Niels Möller committed
414
415
The most commonly used hash functions are MD5 and SHA1. Unfortunately,
both these fail the collision-resistance requirement; cryptologists have
416
417
found ways to construct colliding inputs. The recommended hash functions
for new applications are SHA2 (with main variants SHA256 and SHA512). At
Niels Möller's avatar
Niels Möller committed
418
419
420
the time of this writing (Autumn 2015), SHA3 has recently been
standardized, and the new SHA3 and other top SHA3 candidates may also be
reasonable alternatives.
421

422
423
424
425
426
@menu
* Recommended hash functions::
* Legacy hash functions::
* nettle_hash abstraction::
@end menu
Niels Möller's avatar
Niels Möller committed
427

428
429
430
@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
431

432
433
434
435
436
437
438
439
440
441
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
442
443
@end deftp

444
@defvr Constant SHA256_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
445
The size of a SHA256 digest, i.e. 32.
Niels Möller's avatar
Niels Möller committed
446
447
@end defvr

448
@defvr Constant SHA256_BLOCK_SIZE
449
450
The internal block size of SHA256. Useful for some special constructions,
in particular HMAC-SHA256.
Niels Möller's avatar
Niels Möller committed
451
452
@end defvr

453
454
@deftypefun void sha256_init (struct sha256_ctx *@var{ctx})
Initialize the SHA256 state.
Niels Möller's avatar
Niels Möller committed
455
456
@end deftypefun

457
@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
458
459
460
Hash some more data.
@end deftypefun

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

467
This function also resets the context in the same way as
468
@code{sha256_init}.
Niels Möller's avatar
Niels Möller committed
469
470
@end deftypefun

471
472
473
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
474

475
@subsubsection @acronym{SHA224}
476

477
478
479
480
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).
481

482
@deftp {Context struct} {struct sha224_ctx}
483
484
@end deftp

485
@defvr Constant SHA224_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
486
The size of a SHA224 digest, i.e. 28.
487
488
@end defvr

489
@defvr Constant SHA224_BLOCK_SIZE
490
491
The internal block size of SHA224. Useful for some special constructions,
in particular HMAC-SHA224.
492
493
@end defvr

494
495
@deftypefun void sha224_init (struct sha224_ctx *@var{ctx})
Initialize the SHA224 state.
496
497
@end deftypefun

498
@deftypefun void sha224_update (struct sha224_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
499
500
501
Hash some more data.
@end deftypefun

502
@deftypefun void sha224_digest (struct sha224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
503
504
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
505
@code{SHA224_DIGEST_SIZE}, in which case only the first @var{length}
506
507
508
octets of the digest are written.

This function also resets the context in the same way as
509
@code{sha224_init}.
510
511
@end deftypefun

512
@subsubsection @acronym{SHA512}
513

514
515
516
517
518
519
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).
520

521
@deftp {Context struct} {struct sha512_ctx}
522
523
@end deftp

524
@defvr Constant SHA512_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
525
The size of a SHA512 digest, i.e. 64.
526
527
@end defvr

528
@defvr Constant SHA512_BLOCK_SIZE
529
530
The internal block size of SHA512, 128. Useful for some special
constructions, in particular HMAC-SHA512.
531
532
@end defvr

533
534
@deftypefun void sha512_init (struct sha512_ctx *@var{ctx})
Initialize the SHA512 state.
535
536
@end deftypefun

537
@deftypefun void sha512_update (struct sha512_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
538
539
540
Hash some more data.
@end deftypefun

541
@deftypefun void sha512_digest (struct sha512_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
542
543
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
544
@code{SHA512_DIGEST_SIZE}, in which case only the first @var{length}
545
546
547
octets of the digest are written.

This function also resets the context in the same way as
548
@code{sha512_init}.
549
550
@end deftypefun

551
@subsubsection @acronym{SHA384 and other variants of SHA512}
552

553
554
Several variants of SHA512 have been defined, with a different initial
state, and with the output truncated to shorter length than 512 bits.
Niels Möller's avatar
Niels Möller committed
555
Naming is a bit confused, these algorithms are called SHA512-224,
556
557
558
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).
559

560
561
562
563
564
565
@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.
566
567
@end deftp

568
569
570
@defvr Constant SHA512_224_DIGEST_SIZE
@defvrx Constant SHA512_256_DIGEST_SIZE
@defvrx Constant SHA384_DIGEST_SIZE
571
The digest size for each variant, i.e., 28, 32, and 48, respectively.
572
573
@end defvr

574
575
576
577
@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
578
some special constructions, in particular HMAC-SHA384.
579
580
@end defvr

581
582
583
584
@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.
585
586
@end deftypefun

587
588
589
590
591
@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.
592
593
@end deftypefun

594
595
596
597
598
599
600
@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.
601

602
603
These function also reset the context in the same way as the
corresponding init function.
604
605
@end deftypefun

606
@subsubsection @acronym{SHA3-224}
Niels Möller's avatar
Niels Möller committed
607
@cindex SHA3
Niels Möller's avatar
Niels Möller committed
608

609
The SHA3 hash functions were specified by NIST in response to weaknesses
610
in SHA1, and doubts about SHA2 hash functions which structurally are
611
612
very similar to SHA1. SHA3 is a result of a competition, where the
winner, also known as Keccak, was designed by Guido Bertoni, Joan
613
614
615
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
Niels Möller's avatar
Niels Möller committed
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
(28, 32, 48 and 64 octets, respectively). In August 2015, it was
formally standardized by NIST, as FIPS 202,
@uref{http://dx.doi.org/10.6028/NIST.FIPS.202}.

Note that the SHA3 implementation in earlier versions of Nettle was
based on the specification at the time Keccak was announced as the
winner of the competition, which is incompatible with the final standard
and hence with current versions of Nettle. The @file{nette/sha3.h}
defines a preprocessor symbol @code{NETTLE_SHA3_FIPS202} to indicate
conformance with the standard.

@defvr Constant NETTLE_SHA3_FIPS202
Defined to 1 in Nettle versions supporting FIPS 202. Undefined in
earlier versions.
@end defvr
631

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

634
@deftp {Context struct} {struct sha3_224_ctx}
Niels Möller's avatar
Niels Möller committed
635
636
@end deftp

637
638
639
640
@defvr Constant SHA3_224_DIGEST_SIZE
The size of a SHA3_224 digest, i.e., 28.
@end defvr

641
@defvr Constant SHA3_224_BLOCK_SIZE
642
643
644
645
646
647
648
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

649
@deftypefun void sha3_224_update (struct sha3_224_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
650
651
652
Hash some more data.
@end deftypefun

653
@deftypefun void sha3_224_digest (struct sha3_224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
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

672
@defvr Constant SHA3_256_DIGEST_SIZE
673
The size of a SHA3_256 digest, i.e., 32.
Niels Möller's avatar
Niels Möller committed
674
675
@end defvr

676
@defvr Constant SHA3_256_BLOCK_SIZE
677
The internal block size of SHA3_256.
Niels Möller's avatar
Niels Möller committed
678
679
@end defvr

680
681
@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
682
683
@end deftypefun

684
@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
685
686
687
Hash some more data.
@end deftypefun

688
@deftypefun void sha3_256_digest (struct sha3_256_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
689
690
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
691
@code{SHA3_256_DIGEST_SIZE}, in which case only the first @var{length}
692
693
octets of the digest are written.

694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
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

710
@defvr Constant SHA3_384_BLOCK_SIZE
711
712
713
714
715
716
717
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

718
@deftypefun void sha3_384_update (struct sha3_384_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
719
720
721
Hash some more data.
@end deftypefun

722
@deftypefun void sha3_384_digest (struct sha3_384_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
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

744
@defvr Constant SHA3_512_BLOCK_SIZE
745
746
747
748
749
750
751
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

752
@deftypefun void sha3_512_update (struct sha3_512_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
753
754
755
Hash some more data.
@end deftypefun

756
@deftypefun void sha3_512_digest (struct sha3_512_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
757
758
759
760
761
762
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
763
764
@end deftypefun

765
766
767
@node Legacy hash functions, nettle_hash abstraction, Recommended hash functions, Hash functions
@comment  node-name,  next,  previous,  up
@subsection Legacy hash functions
768

769
770
771
772
773
774
775
776
777
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.
778

779
@subsubsection @acronym{MD5}
780

781
782
783
784
785
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}
786
787
@end deftp

788
789
@defvr Constant MD5_DIGEST_SIZE
The size of an MD5 digest, i.e. 16.
790
791
@end defvr

792
@defvr Constant MD5_BLOCK_SIZE
793
794
The internal block size of MD5. Useful for some special constructions,
in particular HMAC-MD5.
795
796
@end defvr

797
798
@deftypefun void md5_init (struct md5_ctx *@var{ctx})
Initialize the MD5 state.
799
800
@end deftypefun

801
@deftypefun void md5_update (struct md5_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
802
803
804
Hash some more data.
@end deftypefun

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

811
This function also resets the context in the same way as
812
@code{md5_init}.
Niels Möller's avatar
Niels Möller committed
813
814
@end deftypefun

815
816
817
818
819
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.
820

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

823
@subsubsection @acronym{MD2}
824

825
826
827
828
829
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}
830
831
@end deftp

832
833
@defvr Constant MD2_DIGEST_SIZE
The size of an MD2 digest, i.e. 16.
834
835
@end defvr

836
@defvr Constant MD2_BLOCK_SIZE
837
The internal block size of MD2.
838
839
@end defvr

840
841
@deftypefun void md2_init (struct md2_ctx *@var{ctx})
Initialize the MD2 state.
842
843
@end deftypefun

844
@deftypefun void md2_update (struct md2_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
845
846
847
Hash some more data.
@end deftypefun

848
@deftypefun void md2_digest (struct md2_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
849
850
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
851
@code{MD2_DIGEST_SIZE}, in which case only the first @var{length}
852
853
854
octets of the digest are written.

This function also resets the context in the same way as
855
@code{md2_init}.
856
857
@end deftypefun

858
@subsubsection @acronym{MD4}
859

860
861
862
863
864
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.
865

866
@deftp {Context struct} {struct md4_ctx}
867
868
@end deftp

869
870
@defvr Constant MD4_DIGEST_SIZE
The size of an MD4 digest, i.e. 16.
871
872
@end defvr

873
@defvr Constant MD4_BLOCK_SIZE
874
The internal block size of MD4.
875
876
@end defvr

877
878
@deftypefun void md4_init (struct md4_ctx *@var{ctx})
Initialize the MD4 state.
879
880
@end deftypefun

881
@deftypefun void md4_update (struct md4_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
882
883
884
Hash some more data.
@end deftypefun

885
@deftypefun void md4_digest (struct md4_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
886
887
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
888
@code{MD4_DIGEST_SIZE}, in which case only the first @var{length}
889
890
891
octets of the digest are written.

This function also resets the context in the same way as
892
@code{md4_init}.
893
894
@end deftypefun

895
@subsubsection @acronym{RIPEMD160}
896

897
898
899
900
901
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}.
902

903
904
@deftp {Context struct} {struct ripemd160_ctx}
@end deftp
905

906
@defvr Constant RIPEMD160_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
907
The size of a RIPEMD160 digest, i.e. 20.
908
909
@end defvr

910
@defvr Constant RIPEMD160_BLOCK_SIZE
911
912
913
914
915
916
917
The internal block size of RIPEMD160.
@end defvr

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

918
@deftypefun void ripemd160_update (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
919
920
921
Hash some more data.
@end deftypefun

922
@deftypefun void ripemd160_digest (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
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}
940
941
@end deftp

942
@defvr Constant SHA1_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
943
The size of a SHA1 digest, i.e. 20.
944
945
@end defvr

946
@defvr Constant SHA1_BLOCK_SIZE
947
948
The internal block size of SHA1. Useful for some special constructions,
in particular HMAC-SHA1.
949
950
@end defvr

951
952
@deftypefun void sha1_init (struct sha1_ctx *@var{ctx})
Initialize the SHA1 state.
953
954
@end deftypefun

955
@deftypefun void sha1_update (struct sha1_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
956
957
958
Hash some more data.
@end deftypefun

959
@deftypefun void sha1_digest (struct sha1_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
960
961
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
962
@code{SHA1_DIGEST_SIZE}, in which case only the first @var{length}
963
964
965
octets of the digest are written.

This function also resets the context in the same way as
966
@code{sha1_init}.
967
968
@end deftypefun

969
970

@subsubsection @acronym{GOSTHASH94}
971
972
973
974
975
976
977
978
979
980

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
981
The size of a GOSTHASH94 digest, i.e. 32.
982
983
@end defvr

984
@defvr Constant GOSTHASH94_BLOCK_SIZE
985
986
987
988
989
990
991
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

992
@deftypefun void gosthash94_update (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
993
994
995
Hash some more data.
@end deftypefun

996
@deftypefun void gosthash94_digest (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
997
998
999
1000
1001
1002
1003
1004
1005
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

1006
1007
@node nettle_hash abstraction,, Legacy hash functions, Hash functions
@comment  node-name,  next,  previous,  up
Niels Möller's avatar
Niels Möller committed
1008
1009
1010
@subsection The @code{struct nettle_hash} abstraction
@cindex nettle_hash
@cindex nettle_hashes
Niels Möller's avatar
Niels Möller committed
1011
1012
1013

Nettle includes a struct including information about the supported hash
functions. It is defined in @file{<nettle/nettle-meta.h>}, and is used
1014
1015
by Nettle's implementation of @acronym{HMAC} (@pxref{Keyed hash
functions}).
Niels Möller's avatar
Niels Möller committed
1016
1017
1018

@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
1019
1020
@code{nettle_hash_init_func *}, @code{nettle_hash_update_func *}, and
@code{nettle_hash_digest_func *}. The first argument to these functions is
1021
@code{void *} pointer to a context struct, which is of size
1022
@code{context_size}.
Niels Möller's avatar
Niels Möller committed
1023
1024
@end deftp

1025
1026
1027
@deftypevr {Constant Struct} {struct nettle_hash} nettle_md2
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md4
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md5
1028
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_ripemd160
1029
1030
1031
1032
1033
@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
1034
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha3_256
1035
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_gosthash94
Niels Möller's avatar
Niels Möller committed
1036
These are all the hash functions that Nettle implements.
1037
@end deftypevr
1038

1039
Nettle also exports a list of all these hashes.
1040

1041
1042
1043
@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
1044
1045
@end deftypevr

1046
@node Cipher functions, Cipher modes, Hash functions, Reference
Niels Möller's avatar
Niels Möller committed
1047
1048
@comment  node-name,  next,  previous,  up
@section Cipher functions
1049
@cindex Cipher
Niels Möller's avatar
Niels Möller committed
1050
1051
1052
1053

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

1057
1058
1059
@cindex Block Cipher
@cindex Stream Cipher

Niels Möller's avatar
Niels Möller committed
1060
1061
1062
1063
1064
1065
1066
1067
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.
1068
However, using @acronym{ECB} is usually a bad idea. For a start, plaintext blocks
Niels Möller's avatar
Niels Möller committed
1069
1070
that are equal are transformed to ciphertext blocks that are equal; that
leaks information about the plaintext. Usually you should apply the
1071
1072
1073
1074
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
1075

Niels Möller's avatar
Niels Möller committed
1076
A stream cipher can be used for messages of arbitrary length. A typical
Niels Möller's avatar
Niels Möller committed
1077
stream cipher is a keyed pseudo-random generator. To encrypt a plaintext
Niels Möller's avatar
Niels Möller committed
1078
message of @var{n} octets, you key the generator, generate @var{n}
Niels Möller's avatar
Niels Möller committed
1079
octets of pseudo-random data, and XOR it with the plaintext. To decrypt,
Niels Möller's avatar
Niels Möller committed
1080
1081
1082
1083
1084
1085
1086
1087
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
1088
receive an encrypted message. You apply the key, and get a plaintext
1089
message that makes sense to you. Can you then be sure that it really was
Niels Möller's avatar
Niels Möller committed
1090
your friend that wrote the message you're reading? The answer is no. For
Niels Möller's avatar
Niels Möller committed
1091
1092
1093
1094
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
1095
1096
1097
1098
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
1099
1100
1101

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

1105
Some ciphers have so called ``weak keys'', keys that results in
Niels Möller's avatar
Niels Möller committed
1106
undesirable structure after the key setup processing, and should be
1107
1108
1109
1110
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
1111
1112
1113
have weak keys. There are several good ciphers that don't have any weak
keys.

1114
1115
1116
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
1117
as @dfn{key setup}. With Nettle, it is recommended to use each
1118
1119
1120
1121
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
1122
@subsection AES
1123
AES is a block cipher, specified by NIST as a replacement for
Niels Möller's avatar
Niels Möller committed
1124
the older DES standard. The standard is the result of a competition