nettle.texinfo 217 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::                
368
* Authenticated encryption::
Niels Möller's avatar
Niels Möller committed
369
* Keyed hash functions::        
Simon Josefsson's avatar
Simon Josefsson committed
370
* Key derivation functions::    
371 372
* Public-key algorithms::       
* Randomness::                  
373
* ASCII encoding::              
Niels Möller's avatar
Niels Möller committed
374
* Miscellaneous functions::     
375
* Compatibility functions::     
Niels Möller's avatar
Niels Möller committed
376 377 378 379
@end menu

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

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

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

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

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

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

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

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

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

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

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

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

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

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

470
@subsubsection @acronym{SHA224}
471

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

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

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

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

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

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

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

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

507
@subsubsection @acronym{SHA512}
508

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

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

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

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

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

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

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

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

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

548 549
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
550
Naming is a bit confused, these algorithms are called SHA512-224,
551 552 553
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).
554

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

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

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

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

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

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

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

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

603
The SHA3 hash functions were specified by NIST in response to weaknesses
604
in SHA1, and doubts about SHA2 hash functions which structurally are
605 606
very similar to SHA1. SHA3 is a result of a competition, where the
winner, also known as Keccak, was designed by Guido Bertoni, Joan
607 608 609 610
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
611

612 613 614 615 616 617 618 619 620
Nettle's implementation of SHA3 should be considered
@strong{experimental}. It is based on the design from the competition.
Unfortunately, it is likely that when the standard is finalized, there
will be small changes making Nettle's current implementation
incompatible with the standard. Nettle's implementation may need
incompatible changes to track standardization. Latest standard draft, at
the time of writing, is at
@uref{http://csrc.nist.gov/publications/drafts/fips-202/fips_202_draft.pdf}.

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

623
@deftp {Context struct} {struct sha3_224_ctx}
Niels Möller's avatar
Niels Möller committed
624 625
@end deftp

626 627 628 629
@defvr Constant SHA3_224_DIGEST_SIZE
The size of a SHA3_224 digest, i.e., 28.
@end defvr

630
@defvr Constant SHA3_224_BLOCK_SIZE
631 632 633 634 635 636 637
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

638
@deftypefun void sha3_224_update (struct sha3_224_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
639 640 641
Hash some more data.
@end deftypefun

642
@deftypefun void sha3_224_digest (struct sha3_224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
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

661
@defvr Constant SHA3_256_DIGEST_SIZE
662
The size of a SHA3_256 digest, i.e., 32.
Niels Möller's avatar
Niels Möller committed
663 664
@end defvr

665
@defvr Constant SHA3_256_BLOCK_SIZE
666
The internal block size of SHA3_256.
Niels Möller's avatar
Niels Möller committed
667 668
@end defvr

669 670
@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
671 672
@end deftypefun

673
@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
674 675 676
Hash some more data.
@end deftypefun

677
@deftypefun void sha3_256_digest (struct sha3_256_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
678 679
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
680
@code{SHA3_256_DIGEST_SIZE}, in which case only the first @var{length}
681 682
octets of the digest are written.

683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
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

699
@defvr Constant SHA3_384_BLOCK_SIZE
700 701 702 703 704 705 706
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

707
@deftypefun void sha3_384_update (struct sha3_384_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
708 709 710
Hash some more data.
@end deftypefun

711
@deftypefun void sha3_384_digest (struct sha3_384_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
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

733
@defvr Constant SHA3_512_BLOCK_SIZE
734 735 736 737 738 739 740
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

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

745
@deftypefun void sha3_512_digest (struct sha3_512_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
746 747 748 749 750 751
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
752 753
@end deftypefun

754 755 756
@node Legacy hash functions, nettle_hash abstraction, Recommended hash functions, Hash functions
@comment  node-name,  next,  previous,  up
@subsection Legacy hash functions
757

758 759 760 761 762 763 764 765 766
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.
767

768
@subsubsection @acronym{MD5}
769

770 771 772 773 774
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}
775 776
@end deftp

777 778
@defvr Constant MD5_DIGEST_SIZE
The size of an MD5 digest, i.e. 16.
779 780
@end defvr

781
@defvr Constant MD5_BLOCK_SIZE
782 783
The internal block size of MD5. Useful for some special constructions,
in particular HMAC-MD5.
784 785
@end defvr

786 787
@deftypefun void md5_init (struct md5_ctx *@var{ctx})
Initialize the MD5 state.
788 789
@end deftypefun

790
@deftypefun void md5_update (struct md5_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
791 792 793
Hash some more data.
@end deftypefun

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

800
This function also resets the context in the same way as
801
@code{md5_init}.
Niels Möller's avatar
Niels Möller committed
802 803
@end deftypefun

804 805 806 807 808
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.
809

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

812
@subsubsection @acronym{MD2}
813

814 815 816 817 818
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}
819 820
@end deftp

821 822
@defvr Constant MD2_DIGEST_SIZE
The size of an MD2 digest, i.e. 16.
823 824
@end defvr

825
@defvr Constant MD2_BLOCK_SIZE
826
The internal block size of MD2.
827 828
@end defvr

829 830
@deftypefun void md2_init (struct md2_ctx *@var{ctx})
Initialize the MD2 state.
831 832
@end deftypefun

833
@deftypefun void md2_update (struct md2_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
834 835 836
Hash some more data.
@end deftypefun

837
@deftypefun void md2_digest (struct md2_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
838 839
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
840
@code{MD2_DIGEST_SIZE}, in which case only the first @var{length}
841 842 843
octets of the digest are written.

This function also resets the context in the same way as
844
@code{md2_init}.
845 846
@end deftypefun

847
@subsubsection @acronym{MD4}
848

849 850 851 852 853
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.
854

855
@deftp {Context struct} {struct md4_ctx}
856 857
@end deftp

858 859
@defvr Constant MD4_DIGEST_SIZE
The size of an MD4 digest, i.e. 16.
860 861
@end defvr

862
@defvr Constant MD4_BLOCK_SIZE
863
The internal block size of MD4.
864 865
@end defvr

866 867
@deftypefun void md4_init (struct md4_ctx *@var{ctx})
Initialize the MD4 state.
868 869
@end deftypefun

870
@deftypefun void md4_update (struct md4_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
871 872 873
Hash some more data.
@end deftypefun

874
@deftypefun void md4_digest (struct md4_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
875 876
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
877
@code{MD4_DIGEST_SIZE}, in which case only the first @var{length}
878 879 880
octets of the digest are written.

This function also resets the context in the same way as
881
@code{md4_init}.
882 883
@end deftypefun

884
@subsubsection @acronym{RIPEMD160}
885

886 887 888 889 890
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}.
891

892 893
@deftp {Context struct} {struct ripemd160_ctx}
@end deftp
894

895
@defvr Constant RIPEMD160_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
896
The size of a RIPEMD160 digest, i.e. 20.
897 898
@end defvr

899
@defvr Constant RIPEMD160_BLOCK_SIZE
900 901 902 903 904 905 906
The internal block size of RIPEMD160.
@end defvr

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

907
@deftypefun void ripemd160_update (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
908 909 910
Hash some more data.
@end deftypefun

911
@deftypefun void ripemd160_digest (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
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}
929 930
@end deftp

931
@defvr Constant SHA1_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
932
The size of a SHA1 digest, i.e. 20.
933 934
@end defvr

935
@defvr Constant SHA1_BLOCK_SIZE
936 937
The internal block size of SHA1. Useful for some special constructions,
in particular HMAC-SHA1.
938 939
@end defvr

940 941
@deftypefun void sha1_init (struct sha1_ctx *@var{ctx})
Initialize the SHA1 state.
942 943
@end deftypefun

944
@deftypefun void sha1_update (struct sha1_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
945 946 947
Hash some more data.
@end deftypefun

948
@deftypefun void sha1_digest (struct sha1_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
949 950
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
951
@code{SHA1_DIGEST_SIZE}, in which case only the first @var{length}
952 953 954
octets of the digest are written.

This function also resets the context in the same way as
955
@code{sha1_init}.
956 957
@end deftypefun

958 959

@subsubsection @acronym{GOSTHASH94}
960 961 962 963 964 965 966 967 968 969

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
970
The size of a GOSTHASH94 digest, i.e. 32.
971 972
@end defvr

973
@defvr Constant GOSTHASH94_BLOCK_SIZE
974 975 976 977 978 979 980
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

981
@deftypefun void gosthash94_update (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
982 983 984
Hash some more data.
@end deftypefun

985
@deftypefun void gosthash94_digest (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
986 987 988 989 990 991 992 993 994
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

995 996
@node nettle_hash abstraction,, Legacy hash functions, Hash functions
@comment  node-name,  next,  previous,  up
Niels Möller's avatar
Niels Möller committed
997 998 999
@subsection The @code{struct nettle_hash} abstraction
@cindex nettle_hash
@cindex nettle_hashes
Niels Möller's avatar
Niels Möller committed
1000 1001 1002

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

@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
1008 1009
@code{nettle_hash_init_func *}, @code{nettle_hash_update_func *}, and
@code{nettle_hash_digest_func *}. The first argument to these functions is
1010
@code{void *} pointer to a context struct, which is of size
1011
@code{context_size}.
Niels Möller's avatar
Niels Möller committed
1012 1013
@end deftp

1014 1015 1016
@deftypevr {Constant Struct} {struct nettle_hash} nettle_md2
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md4
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md5
1017
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_ripemd160
1018 1019 1020 1021 1022
@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
1023
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha3_256
1024
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_gosthash94
Niels Möller's avatar
Niels Möller committed
1025
These are all the hash functions that Nettle implements.
1026
@end deftypevr
1027

1028
Nettle also exports a list of all these hashes.
1029

1030 1031 1032
@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
1033 1034
@end deftypevr

1035
@node Cipher functions, Cipher modes, Hash functions, Reference
Niels Möller's avatar
Niels Möller committed
1036 1037
@comment  node-name,  next,  previous,  up
@section Cipher functions
1038
@cindex Cipher
Niels Möller's avatar
Niels Möller committed
1039 1040 1041 1042

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

1046 1047 1048
@cindex Block Cipher
@cindex Stream Cipher

Niels Möller's avatar
Niels Möller committed
1049 1050 1051 1052 1053 1054 1055 1056
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.
1057
However, using @acronym{ECB} is usually a bad idea. For a start, plaintext blocks
Niels Möller's avatar
Niels Möller committed
1058 1059
that are equal are transformed to ciphertext blocks that are equal; that
leaks information about the plaintext. Usually you should apply the
1060 1061 1062 1063
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
1064

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

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

1094
Some ciphers have so called ``weak keys'', keys that results in
Niels Möller's avatar
Niels Möller committed
1095
undesirable structure after the key setup processing, and should be
1096 1097 1098 1099
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
1100 1101 1102
have weak keys. There are several good ciphers that don't have any weak
keys.

1103 1104 1105
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
1106
as @dfn{key setup}. With Nettle, it is recommended to use each
1107 1108 1109 1110
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
1111
@subsection AES
1112
AES is a block cipher, specified by NIST as a replacement for
Niels Möller's avatar
Niels Möller committed
1113
the older DES standard. The standard is the result of a competition
1114 1115
between cipher designers. The winning design, also known as RIJNDAEL,
was constructed by Joan Daemen and Vincent Rijnmen.
Niels Möller's avatar
Niels Möller committed
1116 1117

Like all the AES candidates, the winning design uses a block size of 128
1118 1119 1120 1121 1122 1123
bits, or 16 octets, and three possible key-size, 128, 192 and 256 bits
(16, 24 and 32 octets) being the allowed key sizes. It does not have any
weak keys. Nettle defines AES in @file{<nettle/aes.h>}, and there is one
context struct for each key size. (Earlier versions of Nettle used a
single context struct, @code{struct aes_ctx}, for all key sizes. This
interface kept for backwards compatibility).
Niels Möller's avatar
Niels Möller committed
1124
 
1125 1126 1127 1128 1129
@deftp {Context struct} {struct aes128_ctx}
@deftpx {Context struct} {struct aes192_ctx}
@deftpx {Context struct} {struct aes256_ctx}
@end deftp

Niels Möller's avatar
Niels Möller committed
1130
@deftp {Context struct} {struct aes_ctx}
1131
Alternative struct, for the old AES interface.
Niels Möller's avatar
Niels Möller committed
1132 1133 1134
@end deftp

@defvr Constant AES_BLOCK_SIZE
Niels Möller's avatar
Niels Möller committed
1135
The AES block-size, 16.
Niels Möller's avatar
Niels Möller committed
1136 1137
@end defvr

1138 1139 1140 1141 1142
@defvr Constant AES128_KEY_SIZE
@defvrx Constant AES192_KEY_SIZE
@defvrx Constant AES256_KEY_SIZE
@defvrx Constant AES_MIN_KEY_SIZE
@defvrx Constant AES_MAX_KEY_SIZE
Niels Möller's avatar
Niels Möller committed
1143 1144 1145
@end defvr

@defvr Constant AES_KEY_SIZE
Niels Möller's avatar
Niels Möller committed
1146
Default AES key size, 32.
Niels Möller's avatar
Niels Möller committed
1147 1148
@end defvr

1149 1150 1151 1152 1153 1154 1155 1156
@deftypefun void aes128_set_encrypt_key (struct aes128_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes128_set_decrypt_key (struct aes128_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes192_set_encrypt_key (struct aes192_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes192_set_decrypt_key (struct aes192_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes256_set_encrypt_key (struct aes256_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes256_set_decrypt_key (struct aes256_ctx *@var{ctx}, const uint8_t *@var{key})
@deftypefunx void aes_set_encrypt_key (struct aes_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{key})
@deftypefunx void aes_set_decrypt_key (struct aes_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{key})
1157
Initialize the cipher, for encryption or decryption, respectively.
Niels Möller's avatar
Niels Möller committed
1158 1159
@end deftypefun