nettle.texinfo 201 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.0
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 2014.
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

@end detailmenu
Niels Möller's avatar
Niels Möller committed
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
@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.

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

143
144
145
146
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
147
148
149
150
@node Copyright, Conventions, Introduction, Top
@comment  node-name,  next,  previous,  up
@chapter Copyright

Niels Möller's avatar
Niels Möller committed
151
152
153
154
155
156
157
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
158

159
160
161
162
163
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
164
165
A list of the supported algorithms, their origins, and exceptions to the
above licensing:
Niels Möller's avatar
Niels Möller committed
166
167
168
169

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

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

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

Niels Möller's avatar
Niels Möller committed
182
183
@item BLOWFISH
The implementation of the BLOWFISH cipher is written by Werner Koch,
184
copyright owned by the Free Software Foundation. Also hacked by Simon
Niels Möller's avatar
Niels Möller committed
185
Josefsson and Niels Möller.
Niels Möller's avatar
Niels Möller committed
186

187
@item CAMELLIA
188
The C implementation is by Nippon Telegraph and Telephone Corporation
189
(NTT), heavily modified by @value{AUTHOR}. Assembler for x86 and x86_64
Niels Möller's avatar
Niels Möller committed
190
by @value{AUTHOR}.
191

Niels Möller's avatar
Niels Möller committed
192
193
194
195
@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
196
197
198
199
@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
200
201
@item DES
The implementation of the DES cipher is written by Dana L. How, and
Niels Möller's avatar
Niels Möller committed
202
released under the LGPL, version 2 or later.
Niels Möller's avatar
Niels Möller committed
203

204
205
206
207
208
@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.

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

223
224
@item PBKDF2
The C implementation of PBKDF2 is based on earlier work for Shishi and
Niels Möller's avatar
Niels Möller committed
225
GnuTLS by Simon Josefsson.
226

227
@item RIPEMD160
228
229
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
230
Nettle by Andres Mejia.
231

Niels Möller's avatar
Niels Möller committed
232
233
@item SALSA20
The C implementation of SALSA20 is based on D. J. Bernstein's reference
234
implementation (in the public domain), adapted to Nettle by Simon
235
Josefsson, and heavily modified by Niels Möller. Assembly for x86_64 and
Niels Möller's avatar
Niels Möller committed
236
ARM by Niels Möller.
Simon Josefsson's avatar
Simon Josefsson committed
237

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

@item SHA1
250
251
The C implementation of the SHA1 message digest is written by Peter
Gutmann, and hacked some more by Andrew Kuchling and @value{AUTHOR}.
252
253
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
254

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

Niels Möller's avatar
Niels Möller committed
258
@item SHA3
Niels Möller's avatar
Niels Möller committed
259
Written by @value{AUTHOR}.
260

Niels Möller's avatar
Niels Möller committed
261
262
@item TWOFISH
The implementation of the TWOFISH cipher is written by Ruud de Rooij.
Niels Möller's avatar
Niels Möller committed
263

264
@item UMAC
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
@item RSA
Niels Möller's avatar
Niels Möller committed
268
Written by @value{AUTHOR}. Uses the GMP library for bignum operations.
Niels Möller's avatar
Niels Möller committed
269
270

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

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

288
289
For consistency, functions for different algorithms are very similar,
but there are some differences, for instance reflecting if the key setup
290
or encryption function differ for encryption and decryption, and whether
291
292
293
294
295
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
296

297
298
299
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
300
301
302
303
304
305
306

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

317
318
319
Many of the functions lack return value and can never fail. Those
functions which can fail, return one on success and zero on failure.

320
321
@c FIXME: Say something about the name mangling.

322
@node Example, Linking, Conventions, Top
Niels Möller's avatar
Niels Möller committed
323
324
325
@comment  node-name,  next,  previous,  up
@chapter Example

326
A simple example program that reads a file from standard input and
327
writes its SHA1 check-sum on standard output should give the flavor of
328
Nettle.
Niels Möller's avatar
Niels Möller committed
329
330

@example
331
@verbatiminclude sha-example.c
Niels Möller's avatar
Niels Möller committed
332
333
@end example

334
335
336
On a typical Unix system, this program can be compiled and linked with
the command line 
@example
337
gcc sha-example.c -o sha-example -lnettle
338
339
340
341
342
343
344
345
346
347
348
349
@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.

350
351
352
353
354
355
356
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.
357
358

@node Reference, Nettle soup, Linking, Top
Niels Möller's avatar
Niels Möller committed
359
360
361
362
363
364
365
366
@comment  node-name,  next,  previous,  up
@chapter Reference

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

@menu
* Hash functions::              
* Cipher functions::            
367
* Cipher modes::                
Niels Möller's avatar
Niels Möller committed
368
* Keyed hash functions::        
Simon Josefsson's avatar
Simon Josefsson committed
369
* Key derivation functions::    
370
371
* Public-key algorithms::       
* Randomness::                  
372
* ASCII encoding::              
Niels Möller's avatar
Niels Möller committed
373
* Miscellaneous functions::     
374
* Compatibility functions::     
Niels Möller's avatar
Niels Möller committed
375
376
377
378
@end menu

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

Niels Möller's avatar
Niels Möller committed
380
@section Hash functions
381
@cindex Hash function
Niels Möller's avatar
Niels Möller committed
382
383
384
385
386
387
388
389
390
391
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
392
@cindex One-way
Niels Möller's avatar
Niels Möller committed
393
394
395
396
Given a hash value @code{H(x)} it is hard to find a string @code{x}
that hashes to that value.

@item Collision-resistant
397
@cindex Collision-resistant
Niels Möller's avatar
Niels Möller committed
398
399
400
401
402
403
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,
404
message authentication codes, pseudo random generators, association of
405
unique ids to documents, and many other things.
Niels Möller's avatar
Niels Möller committed
406

Niels Möller's avatar
Niels Möller committed
407
408
The most commonly used hash functions are MD5 and SHA1. Unfortunately,
both these fail the collision-resistance requirement; cryptologists have
409
410
411
412
413
414
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.
415

416
417
418
419
420
@menu
* Recommended hash functions::
* Legacy hash functions::
* nettle_hash abstraction::
@end menu
Niels Möller's avatar
Niels Möller committed
421

422
423
424
@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
425

426
427
428
429
430
431
432
433
434
435
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
436
437
@end deftp

438
@defvr Constant SHA256_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
439
The size of a SHA256 digest, i.e. 32.
Niels Möller's avatar
Niels Möller committed
440
441
@end defvr

442
@defvr Constant SHA256_BLOCK_SIZE
443
444
The internal block size of SHA256. Useful for some special constructions,
in particular HMAC-SHA256.
Niels Möller's avatar
Niels Möller committed
445
446
@end defvr

447
448
@deftypefun void sha256_init (struct sha256_ctx *@var{ctx})
Initialize the SHA256 state.
Niels Möller's avatar
Niels Möller committed
449
450
@end deftypefun

451
@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
452
453
454
Hash some more data.
@end deftypefun

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

461
This function also resets the context in the same way as
462
@code{sha256_init}.
Niels Möller's avatar
Niels Möller committed
463
464
@end deftypefun

465
466
467
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
468

469
@subsubsection @acronym{SHA224}
470

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

476
@deftp {Context struct} {struct sha224_ctx}
477
478
@end deftp

479
@defvr Constant SHA224_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
480
The size of a SHA224 digest, i.e. 28.
481
482
@end defvr

483
@defvr Constant SHA224_BLOCK_SIZE
484
485
The internal block size of SHA224. Useful for some special constructions,
in particular HMAC-SHA224.
486
487
@end defvr

488
489
@deftypefun void sha224_init (struct sha224_ctx *@var{ctx})
Initialize the SHA224 state.
490
491
@end deftypefun

492
@deftypefun void sha224_update (struct sha224_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
493
494
495
Hash some more data.
@end deftypefun

496
@deftypefun void sha224_digest (struct sha224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
497
498
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
499
@code{SHA224_DIGEST_SIZE}, in which case only the first @var{length}
500
501
502
octets of the digest are written.

This function also resets the context in the same way as
503
@code{sha224_init}.
504
505
@end deftypefun

506
@subsubsection @acronym{SHA512}
507

508
509
510
511
512
513
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).
514

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

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

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

527
528
@deftypefun void sha512_init (struct sha512_ctx *@var{ctx})
Initialize the SHA512 state.
529
530
@end deftypefun

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

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

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

545
@subsubsection @acronym{SHA384 and other variants of SHA512}
546

547
548
549
550
551
552
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).
553

554
555
556
557
558
559
@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.
560
561
@end deftp

562
563
564
@defvr Constant SHA512_224_DIGEST_SIZE
@defvrx Constant SHA512_256_DIGEST_SIZE
@defvrx Constant SHA384_DIGEST_SIZE
565
The digest size for each variant, i.e., 28, 32, and 48, respectively.
566
567
@end defvr

568
569
570
571
@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
572
some special constructions, in particular HMAC-SHA384.
573
574
@end defvr

575
576
577
578
@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.
579
580
@end deftypefun

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

588
589
590
591
592
593
594
@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.
595

596
597
These function also reset the context in the same way as the
corresponding init function.
598
599
@end deftypefun

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

602
The SHA3 hash functions were specified by NIST in response to weaknesses
603
604
605
606
607
608
609
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
610

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

613
@deftp {Context struct} {struct sha3_224_ctx}
Niels Möller's avatar
Niels Möller committed
614
615
@end deftp

616
617
618
619
@defvr Constant SHA3_224_DIGEST_SIZE
The size of a SHA3_224 digest, i.e., 28.
@end defvr

620
@defvr Constant SHA3_224_BLOCK_SIZE
621
622
623
624
625
626
627
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

628
@deftypefun void sha3_224_update (struct sha3_224_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
629
630
631
Hash some more data.
@end deftypefun

632
@deftypefun void sha3_224_digest (struct sha3_224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
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

651
@defvr Constant SHA3_256_DIGEST_SIZE
652
The size of a SHA3_256 digest, i.e., 32.
Niels Möller's avatar
Niels Möller committed
653
654
@end defvr

655
@defvr Constant SHA3_256_BLOCK_SIZE
656
The internal block size of SHA3_256.
Niels Möller's avatar
Niels Möller committed
657
658
@end defvr

659
660
@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
661
662
@end deftypefun

663
@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
664
665
666
Hash some more data.
@end deftypefun

667
@deftypefun void sha3_256_digest (struct sha3_256_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
668
669
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
670
@code{SHA3_256_DIGEST_SIZE}, in which case only the first @var{length}
671
672
octets of the digest are written.

673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
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

689
@defvr Constant SHA3_384_BLOCK_SIZE
690
691
692
693
694
695
696
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

697
@deftypefun void sha3_384_update (struct sha3_384_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
698
699
700
Hash some more data.
@end deftypefun

701
@deftypefun void sha3_384_digest (struct sha3_384_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
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

723
@defvr Constant SHA3_512_BLOCK_SIZE
724
725
726
727
728
729
730
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

731
@deftypefun void sha3_512_update (struct sha3_512_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
732
733
734
Hash some more data.
@end deftypefun

735
@deftypefun void sha3_512_digest (struct sha3_512_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
736
737
738
739
740
741
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
742
743
@end deftypefun

744
745
746
@node Legacy hash functions, nettle_hash abstraction, Recommended hash functions, Hash functions
@comment  node-name,  next,  previous,  up
@subsection Legacy hash functions
747

748
749
750
751
752
753
754
755
756
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.
757

758
@subsubsection @acronym{MD5}
759

760
761
762
763
764
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}
765
766
@end deftp

767
768
@defvr Constant MD5_DIGEST_SIZE
The size of an MD5 digest, i.e. 16.
769
770
@end defvr

771
@defvr Constant MD5_BLOCK_SIZE
772
773
The internal block size of MD5. Useful for some special constructions,
in particular HMAC-MD5.
774
775
@end defvr

776
777
@deftypefun void md5_init (struct md5_ctx *@var{ctx})
Initialize the MD5 state.
778
779
@end deftypefun

780
@deftypefun void md5_update (struct md5_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
781
782
783
Hash some more data.
@end deftypefun

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

790
This function also resets the context in the same way as
791
@code{md5_init}.
Niels Möller's avatar
Niels Möller committed
792
793
@end deftypefun

794
795
796
797
798
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.
799

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

802
@subsubsection @acronym{MD2}
803

804
805
806
807
808
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}
809
810
@end deftp

811
812
@defvr Constant MD2_DIGEST_SIZE
The size of an MD2 digest, i.e. 16.
813
814
@end defvr

815
@defvr Constant MD2_BLOCK_SIZE
816
The internal block size of MD2.
817
818
@end defvr

819
820
@deftypefun void md2_init (struct md2_ctx *@var{ctx})
Initialize the MD2 state.
821
822
@end deftypefun

823
@deftypefun void md2_update (struct md2_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
824
825
826
Hash some more data.
@end deftypefun

827
@deftypefun void md2_digest (struct md2_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
828
829
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
830
@code{MD2_DIGEST_SIZE}, in which case only the first @var{length}
831
832
833
octets of the digest are written.

This function also resets the context in the same way as
834
@code{md2_init}.
835
836
@end deftypefun

837
@subsubsection @acronym{MD4}
838

839
840
841
842
843
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.
844

845
@deftp {Context struct} {struct md4_ctx}
846
847
@end deftp

848
849
@defvr Constant MD4_DIGEST_SIZE
The size of an MD4 digest, i.e. 16.
850
851
@end defvr

852
@defvr Constant MD4_BLOCK_SIZE
853
The internal block size of MD4.
854
855
@end defvr

856
857
@deftypefun void md4_init (struct md4_ctx *@var{ctx})
Initialize the MD4 state.
858
859
@end deftypefun

860
@deftypefun void md4_update (struct md4_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
861
862
863
Hash some more data.
@end deftypefun

864
@deftypefun void md4_digest (struct md4_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
865
866
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
867
@code{MD4_DIGEST_SIZE}, in which case only the first @var{length}
868
869
870
octets of the digest are written.

This function also resets the context in the same way as
871
@code{md4_init}.
872
873
@end deftypefun

874
@subsubsection @acronym{RIPEMD160}
875

876
877
878
879
880
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}.
881

882
883
@deftp {Context struct} {struct ripemd160_ctx}
@end deftp
884

885
@defvr Constant RIPEMD160_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
886
The size of a RIPEMD160 digest, i.e. 20.
887
888
@end defvr

889
@defvr Constant RIPEMD160_BLOCK_SIZE
890
891
892
893
894
895
896
The internal block size of RIPEMD160.
@end defvr

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

897
@deftypefun void ripemd160_update (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
898
899
900
Hash some more data.
@end deftypefun

901
@deftypefun void ripemd160_digest (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
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}
919
920
@end deftp

921
@defvr Constant SHA1_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
922
The size of a SHA1 digest, i.e. 20.
923
924
@end defvr

925
@defvr Constant SHA1_BLOCK_SIZE
926
927
The internal block size of SHA1. Useful for some special constructions,
in particular HMAC-SHA1.
928
929
@end defvr

930
931
@deftypefun void sha1_init (struct sha1_ctx *@var{ctx})
Initialize the SHA1 state.
932
933
@end deftypefun

934
@deftypefun void sha1_update (struct sha1_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
935
936
937
Hash some more data.
@end deftypefun

938
@deftypefun void sha1_digest (struct sha1_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
939
940
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
941
@code{SHA1_DIGEST_SIZE}, in which case only the first @var{length}
942
943
944
octets of the digest are written.

This function also resets the context in the same way as
945
@code{sha1_init}.
946
947
@end deftypefun

948
949

@subsubsection @acronym{GOSTHASH94}
950
951
952
953
954
955
956
957
958
959

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
960
The size of a GOSTHASH94 digest, i.e. 32.
961
962
@end defvr

963
@defvr Constant GOSTHASH94_BLOCK_SIZE
964
965
966
967
968
969
970
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

971
@deftypefun void gosthash94_update (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
972
973
974
Hash some more data.
@end deftypefun

975
@deftypefun void gosthash94_digest (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
976
977
978
979
980
981
982
983
984
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

985
986
987
@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
988
989
990

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

@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
996
997
@code{nettle_hash_init_func *}, @code{nettle_hash_update_func *}, and
@code{nettle_hash_digest_func *}. The first argument to these functions is
998
@code{void *} pointer to a context struct, which is of size
999
@code{context_size}.
Niels Möller's avatar
Niels Möller committed
1000
1001
@end deftp

1002
1003
1004
@deftypevr {Constant Struct} {struct nettle_hash} nettle_md2
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md4
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md5
1005
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_ripemd160
1006
1007
1008
1009
1010
@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
1011
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha3_256
1012
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_gosthash94
Niels Möller's avatar
Niels Möller committed
1013
These are all the hash functions that Nettle implements.
1014
@end deftypevr
1015

1016
Nettle also exports a list of all these hashes.
1017

1018
1019
1020
@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
1021
1022
@end deftypevr

1023
@node Cipher functions, Cipher modes, Hash functions, Reference
Niels Möller's avatar
Niels Möller committed
1024
1025
@comment  node-name,  next,  previous,  up
@section Cipher functions
1026
@cindex Cipher
Niels Möller's avatar
Niels Möller committed
1027
1028
1029
1030

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

1034
1035
1036
@cindex Block Cipher
@cindex Stream Cipher

Niels Möller's avatar
Niels Möller committed
1037
1038
1039
1040
1041
1042
1043
1044
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.
Niels Möller's avatar