nettle.texinfo 262 KB
Newer Older
1 2 3
\input texinfo          @c -*-texinfo-*-
@c %**start of header
@setfilename nettle.info
4
@settitle Nettle: a low-level cryptographic library
5
@documentencoding UTF-8
6
@footnotestyle separate
7
@syncodeindex fn cp
8
@c %**end of header
9

Niels Möller's avatar
Niels Möller committed
10
@set UPDATED-FOR 3.4
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.
16

Niels Möller's avatar
Niels Möller committed
17
Originally written 2001 by @value{AUTHOR}, updated 2017.
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
25

26 27 28 29 30 31
@ifnottex
@macro pmod {m} 
(mod \m\)
@end macro
@end ifnottex

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
39 40
@end titlepage

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

46 47
@contents

48 49 50
@ifnottex
@node     Top, Introduction, (dir), (dir)
@comment  node-name,  next,  previous,  up
51
@top Nettle
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.
56

57
@insertcopying
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.
65
* Compatibility::               On API and ABI compatibility between versions.
Niels Möller's avatar
Niels Möller committed
66 67 68
* Reference::                   All Nettle functions and features.
* Nettle soup::                 For the serious nettle hacker.
* Installation::                How to install Nettle.
69
* Index::                       Function and concept index.
70 71 72 73 74 75 76 77 78 79

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

Reference

* Hash functions::              
* Cipher functions::            
* Cipher modes::                
* Keyed hash functions::        
Simon Josefsson's avatar
Simon Josefsson committed
80
* Key derivation functions::    
81 82
* Public-key algorithms::       
* Randomness::                  
83
* ASCII encoding::              
84 85 86
* Miscellaneous functions::     
* Compatibility functions::     

87 88 89 90 91 92
Hash functions

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

93 94 95 96
Cipher modes

* CBC::                         
* CTR::                         
97
* CFB and CFB8::
98
* GCM::                         
99
* CCM::                         
100
* SIV-CMAC::
101 102 103 104 105

Keyed Hash Functions

* HMAC::
* UMAC::
106
* CMAC::
107 108 109 110 111

Public-key algorithms

* RSA::                         The RSA public key algorithm.
* DSA::                         The DSA digital signature algorithm.
112
* Elliptic curves::             Elliptic curves and ECDSA
113

114 115 116 117
@acronym{Elliptic curves}

* Side-channel silence::
* ECDSA::
Daiki Ueno's avatar
Daiki Ueno committed
118
* Curve 25519 and Curve 448::
119

120
@end detailmenu
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
@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.

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

153 154 155 156
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.

157 158 159 160
@node Copyright, Conventions, Introduction, Top
@comment  node-name,  next,  previous,  up
@chapter Copyright

Niels Möller's avatar
Niels Möller committed
161 162 163 164 165 166 167
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.
168

169 170 171 172 173
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
174 175
A list of the supported algorithms, their origins, and exceptions to the
above licensing:
176 177 178 179

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

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

Niels Möller's avatar
Niels Möller committed
187 188 189
@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
190
Josefsson.
Niels Möller's avatar
Niels Möller committed
191

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

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

202 203 204 205
@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
206 207 208 209
@item CHACHA
Implemented by Joachim Strömbergson, based on the implementation of
SALSA20 (see below). Assembly for x86_64 by Niels Möller.

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

214 215 216 217 218
@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.

219 220
@item MD2
The implementation of MD2 is written by Andrew Kuchling, and hacked
221
some by Andreas Sigfridsson and @value{AUTHOR}. Python Cryptography
222 223 224 225 226 227
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.

228 229
@item MD5
The implementation of the MD5 message digest is written by Colin Plumb.
230
It has been hacked some more by Andrew Kuchling and @value{AUTHOR}.
231 232
Released into the public domain.

233 234
@item PBKDF2
The C implementation of PBKDF2 is based on earlier work for Shishi and
Niels Möller's avatar
Niels Möller committed
235
GnuTLS by Simon Josefsson.
236

237
@item RIPEMD160
238 239
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
240
Nettle by Andres Mejia.
241

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

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

@item SHA1
260 261
The C implementation of the SHA1 message digest is written by Peter
Gutmann, and hacked some more by Andrew Kuchling and @value{AUTHOR}.
262 263
Released into the public domain. Assembler for x86, x86_64 and ARM by
@value{AUTHOR}, released under the LGPL.
264

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

Niels Möller's avatar
Niels Möller committed
268
@item SHA3
Niels Möller's avatar
Niels Möller committed
269
Written by @value{AUTHOR}.
270

271 272
@item TWOFISH
The implementation of the TWOFISH cipher is written by Ruud de Rooij.
Niels Möller's avatar
Niels Möller committed
273

274
@item UMAC
Niels Möller's avatar
Niels Möller committed
275
Written by @value{AUTHOR}.
276

277 278 279
@item CMAC
Written by Nikos Mavrogiannopoulos, @value{AUTHOR}, Jeremy Allison, Michael Adam and Stefan Metzmacher.

Niels Möller's avatar
Niels Möller committed
280
@item RSA
Niels Möller's avatar
Niels Möller committed
281
Written by @value{AUTHOR}. Uses the GMP library for bignum operations.
Niels Möller's avatar
Niels Möller committed
282 283

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

@item ECDSA
Niels Möller's avatar
Niels Möller committed
287 288
Written by @value{AUTHOR}. Uses the GMP library for bignum operations.
Development of Nettle's ECC support was funded by the .SE Internet Fund.
289 290 291 292 293 294 295 296
@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
297
operating on the context. The context struct encapsulates all information
298 299 300
needed by the algorithm, and it can be copied or moved in memory with no
unexpected effects.

301 302
For consistency, functions for different algorithms are very similar,
but there are some differences, for instance reflecting if the key setup
303
or encryption function differ for encryption and decryption, and whether
304 305 306 307 308
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.
309

310 311 312
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.
313 314 315 316 317 318 319

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
320
type @code{size_t}, and a pointer of type @code{uint8_t *} or
321 322
@code{const uint8_t *}. For functions that transform one string to
another, the argument order is length, destination pointer and source
323 324 325 326 327 328
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.
329

330 331 332
Many of the functions lack return value and can never fail. Those
functions which can fail, return one on success and zero on failure.

333 334
@c FIXME: Say something about the name mangling.

335
@node Example, Linking, Conventions, Top
336 337 338
@comment  node-name,  next,  previous,  up
@chapter Example

339
A simple example program that reads a file from standard input and
340
writes its SHA1 check-sum on standard output should give the flavor of
341
Nettle.
342 343

@example
344
@verbatiminclude sha-example.c
345 346
@end example

347 348 349
On a typical Unix system, this program can be compiled and linked with
the command line 
@example
350
gcc sha-example.c -o sha-example -lnettle
351 352
@end example

353
@node Linking, Compatibility, Example, Top
354 355 356 357 358 359 360 361 362
@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.

363 364 365 366 367 368 369
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.
370

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
@node Compatibility, Reference, Linking, Top
@comment  node-name,  next,  previous,  up
@chapter Compatibility
@cindex ABI compatibility
@cindex API compatibility
@cindex Binary compatibility

When you write a program using the Nettle library, it's desirable to
have it work together not only with exactly the same version of Nettle
you had at hand, but with other current and future versions. If a
different version of Nettle is used at compile time, i.e., you recompile
it using the header and library files belonging to a different version,
we talk about API compatibility (for Application Programming Interface).
If a different version of Nettle isn't used until link time, we talk
about ABI compatibility (Application Binary Interface) or binary
compatibility. ABI compatibility matters mainly when using dynamic
linking with a shared library. E.g., a user has an executable linking at
run-time with @file{libnettle.so}, and then updates to a later version
of the shared library, without updating or recompiling the executable.

Nettle aims to provide backwards compatibility, i.e., a program written
for a particular version of the Nettle library should usually work fine
with later version of the library. Note that the opposite is not
supported: The program should @emph{not} be expected to work with older
versions of the Nettle library; and ABI breakage can be unobvious. E.g,
the later version may define a new library symbol, and let header files
redefine an old API name as an alias for the new symbol. If the later
version ensures that the old symbol is still defined in the library,
this change is backwards compatible: A program compiled using headers
400
from the older version can be successfully linked with either version of
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
the library. But if you compile the same program using headers from the
later version of the library, and attempt to link with the older
version, you'll get an undefined reference to the new symbol.

API compatibility is rarely broken; exceptions are noted in the NEWS
file. For example, the key size argument to the function
@code{cast128_set_key} was dropped in the Nettle-3.0 release, and all
programs using that function had to be updated to work with the new
version.

ABI compatibility is broken occasionally. This is also noted in the NEWS
file, and the name of the shared library is updated to prevent
accidental run-time linking with the wrong version. All programs have to
be recompiled before they can link with the new version. Since names are
different, multiple versions can be installed on the same system, with a
mix of programs linking to one version or the other.

Under some circumstances, it is possible to have a single program
linking dynamically with two binary incompatible versions of the Nettle
library, thanks to the use of symbol versioning. Consider a program
calling functions in both Nettle and GnuTLS. For the direct dependency
on Nettle, the program is linked with a particular version of the Nettle
shared library. GnuTLS uses Nettle internally, but does not expose any
Nettle data structures or the like in its own ABI. In this situation,
the GnuTLS shared library may link with a different version of the
Nettle library. Then both versions of the Nettle library will be loaded
into the program's address space, and each reference to a symbol will be
resolved to the correct version.

Finally, some of Nettle's symbols are internal. They carry a leading
underscore, and are not declared in installed header files. They can be
used for local or experimental purposes, but programs referring directly
to those symbols get neither API nor ABI compatibility, not even between
minor versions.

@node Reference, Nettle soup, Compatibility, Top
437 438 439 440 441 442 443 444
@comment  node-name,  next,  previous,  up
@chapter Reference

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

@menu
* Hash functions::              
* Cipher functions::            
445
* Cipher modes::                
446
* Authenticated encryption::
Niels Möller's avatar
Niels Möller committed
447
* Keyed hash functions::        
Simon Josefsson's avatar
Simon Josefsson committed
448
* Key derivation functions::    
449 450
* Public-key algorithms::       
* Randomness::                  
451
* ASCII encoding::              
452
* Miscellaneous functions::     
453
* Compatibility functions::     
454 455 456 457
@end menu

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

459
@section Hash functions
460
@cindex Hash function
461 462 463 464 465 466 467 468 469 470
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
471
@cindex One-way
472 473 474 475
Given a hash value @code{H(x)} it is hard to find a string @code{x}
that hashes to that value.

@item Collision-resistant
476
@cindex Collision-resistant
477 478 479 480 481 482
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,
483
message authentication codes, pseudo random generators, association of
484
unique ids to documents, and many other things.
485

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

494 495 496 497 498
@menu
* Recommended hash functions::
* Legacy hash functions::
* nettle_hash abstraction::
@end menu
499

500 501 502
@node Recommended hash functions, Legacy hash functions,, Hash functions
@comment  node-name,  next,  previous,  up
@subsection Recommended hash functions
503

504 505 506 507 508 509 510 511 512 513
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}
514 515
@end deftp

516
@defvr Constant SHA256_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
517
The size of a SHA256 digest, i.e. 32.
518 519
@end defvr

520
@defvr Constant SHA256_BLOCK_SIZE
521 522
The internal block size of SHA256. Useful for some special constructions,
in particular HMAC-SHA256.
523 524
@end defvr

525 526
@deftypefun void sha256_init (struct sha256_ctx *@var{ctx})
Initialize the SHA256 state.
527 528
@end deftypefun

529
@deftypefun void sha256_update (struct sha256_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
530 531 532
Hash some more data.
@end deftypefun

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

539
This function also resets the context in the same way as
540
@code{sha256_init}.
541 542
@end deftypefun

543 544 545
Earlier versions of nettle defined SHA256 in the header file
@file{<nettle/sha.h>}, which is now deprecated, but kept for
compatibility.
546

547
@subsubsection @acronym{SHA224}
548

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

554
@deftp {Context struct} {struct sha224_ctx}
555 556
@end deftp

557
@defvr Constant SHA224_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
558
The size of a SHA224 digest, i.e. 28.
559 560
@end defvr

561
@defvr Constant SHA224_BLOCK_SIZE
562 563
The internal block size of SHA224. Useful for some special constructions,
in particular HMAC-SHA224.
564 565
@end defvr

566 567
@deftypefun void sha224_init (struct sha224_ctx *@var{ctx})
Initialize the SHA224 state.
568 569
@end deftypefun

570
@deftypefun void sha224_update (struct sha224_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
571 572 573
Hash some more data.
@end deftypefun

574
@deftypefun void sha224_digest (struct sha224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
575 576
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
577
@code{SHA224_DIGEST_SIZE}, in which case only the first @var{length}
578 579 580
octets of the digest are written.

This function also resets the context in the same way as
581
@code{sha224_init}.
582 583
@end deftypefun

584
@subsubsection @acronym{SHA512}
585

586 587 588 589 590 591
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).
592

593
@deftp {Context struct} {struct sha512_ctx}
594 595
@end deftp

596
@defvr Constant SHA512_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
597
The size of a SHA512 digest, i.e. 64.
598 599
@end defvr

600
@defvr Constant SHA512_BLOCK_SIZE
601 602
The internal block size of SHA512, 128. Useful for some special
constructions, in particular HMAC-SHA512.
603 604
@end defvr

605 606
@deftypefun void sha512_init (struct sha512_ctx *@var{ctx})
Initialize the SHA512 state.
607 608
@end deftypefun

609
@deftypefun void sha512_update (struct sha512_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
610 611 612
Hash some more data.
@end deftypefun

613
@deftypefun void sha512_digest (struct sha512_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
614 615
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
616
@code{SHA512_DIGEST_SIZE}, in which case only the first @var{length}
617 618 619
octets of the digest are written.

This function also resets the context in the same way as
620
@code{sha512_init}.
621 622
@end deftypefun

623
@subsubsection @acronym{SHA384 and other variants of SHA512}
624

625 626
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
627
Naming is a bit confused, these algorithms are called SHA512-224,
628 629 630
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).
631

632 633 634 635 636 637
@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.
638 639
@end deftp

640 641 642
@defvr Constant SHA512_224_DIGEST_SIZE
@defvrx Constant SHA512_256_DIGEST_SIZE
@defvrx Constant SHA384_DIGEST_SIZE
643
The digest size for each variant, i.e., 28, 32, and 48, respectively.
644 645
@end defvr

646 647 648 649
@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
650
some special constructions, in particular HMAC-SHA384.
651 652
@end defvr

653 654 655 656
@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.
657 658
@end deftypefun

659 660 661 662 663
@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.
664 665
@end deftypefun

666 667 668 669 670 671 672
@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.
673

674 675
These function also reset the context in the same way as the
corresponding init function.
676 677
@end deftypefun

678
@subsubsection @acronym{SHA3-224}
Niels Möller's avatar
Niels Möller committed
679
@cindex SHA3
680

681
The SHA3 hash functions were specified by NIST in response to weaknesses
682
in SHA1, and doubts about SHA2 hash functions which structurally are
683 684
very similar to SHA1. SHA3 is a result of a competition, where the
winner, also known as Keccak, was designed by Guido Bertoni, Joan
685 686 687
Daemen, Michaël Peeters and Gilles Van Assche. It is structurally very
different from all widely used earlier hash functions. Like SHA2, there
are several variants, with output sizes of 224, 256, 384 and 512 bits
Niels Möller's avatar
Niels Möller committed
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702
(28, 32, 48 and 64 octets, respectively). In August 2015, it was
formally standardized by NIST, as FIPS 202,
@uref{http://dx.doi.org/10.6028/NIST.FIPS.202}.

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

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

704
Nettle defines SHA3-224 in @file{<nettle/sha3.h>}.
705

706
@deftp {Context struct} {struct sha3_224_ctx}
707 708
@end deftp

709 710 711 712
@defvr Constant SHA3_224_DIGEST_SIZE
The size of a SHA3_224 digest, i.e., 28.
@end defvr

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

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

725
@deftypefun void sha3_224_digest (struct sha3_224_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
@code{SHA3_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

744
@defvr Constant SHA3_256_DIGEST_SIZE
745
The size of a SHA3_256 digest, i.e., 32.
746 747
@end defvr

748
@defvr Constant SHA3_256_BLOCK_SIZE
749
The internal block size of SHA3_256.
750 751
@end defvr

752 753
@deftypefun void sha3_256_init (struct sha3_256_ctx *@var{ctx})
Initialize the SHA3-256 state.
754 755
@end deftypefun

756
@deftypefun void sha3_256_update (struct sha3_256_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
757 758 759
Hash some more data.
@end deftypefun

760
@deftypefun void sha3_256_digest (struct sha3_256_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
761 762
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
763
@code{SHA3_256_DIGEST_SIZE}, in which case only the first @var{length}
764 765
octets of the digest are written.

766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
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

782
@defvr Constant SHA3_384_BLOCK_SIZE
783 784 785 786 787 788 789
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

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

794
@deftypefun void sha3_384_digest (struct sha3_384_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
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

816
@defvr Constant SHA3_512_BLOCK_SIZE
817 818 819 820 821 822 823
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

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

828
@deftypefun void sha3_512_digest (struct sha3_512_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
829 830 831 832 833 834
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.
835 836
@end deftypefun

Niels Möller's avatar
Niels Möller committed
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
@subsubsection @acronym{SHAKE-256}
@cindex SHAKE

In addition to those SHA-3 hash functions, Nettle also provides a SHA-3
extendable-output function (XOF), SHAKE-256. Unlike SHA-3 hash functions,
SHAKE can produce an output digest of any desired length.

To use SHAKE256, the context struct, init and update functions are the
same as for SHA3-256. To get a SHAKE256 digest, the following function
is used instead of @code{sha3_256_digest}. For an output size of
@code{SHA3_256_DIGEST_SIZE}, security is equivalent to SHA3-256 (but the
digest is different). Increasing output size further does not increase
security in terms of collision or preimage resistance. It can be seen as
a built in pseudorandomness generator.

@deftypefun void sha3_256_shake (struct shake256_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
Performs final processing and produces a SHAKE256 digest, writing it
to @var{digest}. @var{length} can be of arbitrary size.

This function also resets the context.
@end deftypefun

859 860 861
@node Legacy hash functions, nettle_hash abstraction, Recommended hash functions, Hash functions
@comment  node-name,  next,  previous,  up
@subsection Legacy hash functions
862

863 864 865 866 867 868 869 870 871
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.
872

873
@subsubsection @acronym{MD5}
874

875 876 877 878 879
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}
880 881
@end deftp

882 883
@defvr Constant MD5_DIGEST_SIZE
The size of an MD5 digest, i.e. 16.
884 885
@end defvr

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

891 892
@deftypefun void md5_init (struct md5_ctx *@var{ctx})
Initialize the MD5 state.
893 894
@end deftypefun

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

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

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

909 910 911 912 913
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.
914

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

917
@subsubsection @acronym{MD2}
918

919 920 921 922 923
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}
924 925
@end deftp

926 927
@defvr Constant MD2_DIGEST_SIZE
The size of an MD2 digest, i.e. 16.
928 929
@end defvr

930
@defvr Constant MD2_BLOCK_SIZE
931
The internal block size of MD2.
932 933
@end defvr

934 935
@deftypefun void md2_init (struct md2_ctx *@var{ctx})
Initialize the MD2 state.
936 937
@end deftypefun

938
@deftypefun void md2_update (struct md2_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
939 940 941
Hash some more data.
@end deftypefun

942
@deftypefun void md2_digest (struct md2_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
943 944
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
945
@code{MD2_DIGEST_SIZE}, in which case only the first @var{length}
946 947 948
octets of the digest are written.

This function also resets the context in the same way as
949
@code{md2_init}.
950 951
@end deftypefun

952
@subsubsection @acronym{MD4}
953

954 955 956 957 958
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.
959

960
@deftp {Context struct} {struct md4_ctx}
961 962
@end deftp

963 964
@defvr Constant MD4_DIGEST_SIZE
The size of an MD4 digest, i.e. 16.
965 966
@end defvr

967
@defvr Constant MD4_BLOCK_SIZE
968
The internal block size of MD4.
969 970
@end defvr

971 972
@deftypefun void md4_init (struct md4_ctx *@var{ctx})
Initialize the MD4 state.
973 974
@end deftypefun

975
@deftypefun void md4_update (struct md4_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
976 977 978
Hash some more data.
@end deftypefun

979
@deftypefun void md4_digest (struct md4_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
980 981
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
982
@code{MD4_DIGEST_SIZE}, in which case only the first @var{length}
983 984 985
octets of the digest are written.

This function also resets the context in the same way as
986
@code{md4_init}.
987 988
@end deftypefun

989
@subsubsection @acronym{RIPEMD160}
990

991 992 993 994 995
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}.
996

997 998
@deftp {Context struct} {struct ripemd160_ctx}
@end deftp
999

1000
@defvr Constant RIPEMD160_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
1001
The size of a RIPEMD160 digest, i.e. 20.
1002 1003
@end defvr

1004
@defvr Constant RIPEMD160_BLOCK_SIZE
1005 1006 1007 1008 1009 1010 1011
The internal block size of RIPEMD160.
@end defvr

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

1012
@deftypefun void ripemd160_update (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
1013 1014 1015
Hash some more data.
@end deftypefun

1016
@deftypefun void ripemd160_digest (struct ripemd160_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
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}
1034 1035
@end deftp

1036
@defvr Constant SHA1_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
1037
The size of a SHA1 digest, i.e. 20.
1038 1039
@end defvr

1040
@defvr Constant SHA1_BLOCK_SIZE
1041 1042
The internal block size of SHA1. Useful for some special constructions,
in particular HMAC-SHA1.
1043 1044
@end defvr

1045 1046
@deftypefun void sha1_init (struct sha1_ctx *@var{ctx})
Initialize the SHA1 state.
1047 1048
@end deftypefun

1049
@deftypefun void sha1_update (struct sha1_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
1050 1051 1052
Hash some more data.
@end deftypefun

1053
@deftypefun void sha1_digest (struct sha1_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
1054 1055
Performs final processing and extracts the message digest, writing it
to @var{digest}. @var{length} may be smaller than
1056
@code{SHA1_DIGEST_SIZE}, in which case only the first @var{length}
1057 1058 1059
octets of the digest are written.

This function also resets the context in the same way as
1060
@code{sha1_init}.
1061 1062
@end deftypefun

1063

1064
@subsubsection @acronym{GOSTHASH94 and GOSTHASH94CP}
1065 1066 1067

The GOST94 or GOST R 34.11-94 hash algorithm is a Soviet-era algorithm 
used in Russian government standards (see @cite{RFC 4357}).
1068 1069 1070 1071 1072 1073 1074
It outputs message digests of 256 bits, or 32 octets. The standard itself
does not fix the S-box used by the hash algorith, so there are two popular
variants (the testing S-box from the standard itself and the S-box defined
by CryptoPro company, see RFC 4357). Nettle provides support for the former
S-box in the form of GOSTHASH94 hash algorithm and for the latter in the
form of GOSTHASH94CP hash algorithm.
Nettle defines GOSTHASH94 and GOSTHASH94CP in @file{<nettle/gosthash94.h>}.
1075 1076 1077 1078 1079

@deftp {Context struct} {struct gosthash94_ctx}
@end deftp

@defvr Constant GOSTHASH94_DIGEST_SIZE
Niels Möller's avatar
Niels Möller committed
1080
The size of a GOSTHASH94 digest, i.e. 32.
1081 1082
@end defvr

1083
@defvr Constant GOSTHASH94_BLOCK_SIZE
1084 1085 1086 1087 1088 1089 1090
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

1091
@deftypefun void gosthash94_update (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
1092 1093 1094
Hash some more data.
@end deftypefun

1095
@deftypefun void gosthash94_digest (struct gosthash94_ctx *@var{ctx}, size_t @var{length}, uint8_t *@var{digest})
1096 1097 1098 1099 1100 1101 1102 1103 1104
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

1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
@deftp {Context struct} {struct gosthash94cp_ctx}
@end deftp

@defvr Constant GOSTHASH94CP_DIGEST_SIZE
The size of a GOSTHASH94CP digest, i.e. 32.
@end defvr

@defvr Constant GOSTHASH94CP_BLOCK_SIZE
The internal block size of GOSTHASH94CP, i.e., 32.
@end defvr

@deftypefun void gosthash94cp_init (struct gosthash94cp_ctx *@var{ctx})
Initialize the GOSTHASH94CP state.
@end deftypefun

@deftypefun void gosthash94cp_update (struct gosthash94cp_ctx *@var{ctx}, size_t @var{length}, const uint8_t *@var{data})
Hash some more data.
@end deftypefun

@deftypefun void gosthash94cp_digest (struct gosthash94cp_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
@code{GOSTHASH94CP_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{gosthash94cp_init}.
@end deftypefun

1134 1135
@node nettle_hash abstraction,, Legacy hash functions, Hash functions
@comment  node-name,  next,  previous,  up
Niels Möller's avatar
Niels Möller committed
1136 1137
@subsection The @code{struct nettle_hash} abstraction
@cindex nettle_hash
Niels Möller's avatar
Niels Möller committed
1138 1139 1140

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

@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
1146 1147
@code{nettle_hash_init_func *}, @code{nettle_hash_update_func *}, and
@code{nettle_hash_digest_func *}. The first argument to these functions is
1148
@code{void *} pointer to a context struct, which is of size
1149
@code{context_size}.
Niels Möller's avatar
Niels Möller committed
1150 1151
@end deftp

1152 1153 1154
@deftypevr {Constant Struct} {struct nettle_hash} nettle_md2
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md4
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_md5
1155
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_ripemd160
1156 1157 1158 1159 1160
@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
1161
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_sha3_256
1162
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_gosthash94
1163
@deftypevrx {Constant Struct} {struct nettle_hash} nettle_gosthash94cp
Niels Möller's avatar
Niels Möller committed
1164
These are all the hash functions that Nettle implements.
1165
@end deftypevr
1166

1167
Nettle also exports a list of all these hashes.
1168

1169
@deftypefun {const struct nettle_hash **} nettle_get_hashes (void)
Niels Möller's avatar
Niels Möller committed
1170
Returns a NULL-terminated list of pointers to supported hash functions.
1171
This list can be used to dynamically enumerate or search the supported
Niels Möller's avatar
Niels Möller committed
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
algorithms.
@end deftypefun

@deffn Macro nettle_hashes
A macro expanding to a call to nettle_get_hashes, so that one could
write, e.g., @code{nettle_hashes[0]->name} for the name of the first
hash function on the list. In earlier versions, this was not a macro but
the actual array of pointers. However, referring directly to the array
makes the array size leak into the ABI in some cases.
@end deffn
Niels Möller's avatar
Niels Möller committed
1182

1183
@node Cipher functions, Cipher modes, Hash functions, Reference
1184 1185
@comment  node-name,  next,  previous,  up
@section Cipher functions
1186
@cindex Cipher
1187 1188 1189 1190

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
1191
plaintext. Given matching pairs of plaintext and ciphertext, it should
1192 1193
be hard to find the key.

1194 1195 1196
@cindex Block Cipher
@cindex Stream Cipher

1197 1198 1199 1200 1201 1202 1203 1204
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.
1205
However, using @acronym{ECB} is usually a bad idea. For a start, plaintext blocks
1206 1207
that are equal are transformed to ciphertext blocks that are equal; that
leaks information about the plaintext. Usually you should apply the
1208 1209 1210 1211
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.
1212

Niels Möller's avatar
Niels Möller committed
1213
A stream cipher can be used for messages of arbitrary length. A typical
Niels Möller's avatar
Niels Möller committed
1214
stream cipher is a keyed pseudo-random generator. To encrypt a plaintext
1215
message of @var{n} octets, you key the generator, generate @var{n}
Niels Möller's avatar
Niels Möller committed
1216
octets of pseudo-random data, and XOR it with the plaintext. To decrypt,