Commit 5b5a0f40 authored by Niels Möller's avatar Niels Möller

Improved index entries in the manual.

parent cd476a5e
2018-02-16 Niels Möller <nisse@lysator.liu.se> 2018-02-16 Niels Möller <nisse@lysator.liu.se>
* nettle.texinfo (Cipher functions): Update CAST128/CAST5 docs. * nettle.texinfo: Improved index entries.
Inconsistencies spotted by Henrik Rindlöw. (Cipher functions): Update CAST128/CAST5 docs. Inconsistencies
spotted by Henrik Rindlöw.
2018-02-10 Niels Möller <nisse@lysator.liu.se> 2018-02-10 Niels Möller <nisse@lysator.liu.se>
......
...@@ -1008,8 +1008,6 @@ This function also resets the context in the same way as ...@@ -1008,8 +1008,6 @@ This function also resets the context in the same way as
@comment node-name, next, previous, up @comment node-name, next, previous, up
@subsection The @code{struct nettle_hash} abstraction @subsection The @code{struct nettle_hash} abstraction
@cindex nettle_hash @cindex nettle_hash
@cindex nettle_hashes
@cindex nettle_get_hashes
Nettle includes a struct including information about the supported hash Nettle includes a struct including information about the supported hash
functions. It is defined in @file{<nettle/nettle-meta.h>}, and is used functions. It is defined in @file{<nettle/nettle-meta.h>}, and is used
...@@ -1040,7 +1038,7 @@ These are all the hash functions that Nettle implements. ...@@ -1040,7 +1038,7 @@ These are all the hash functions that Nettle implements.
Nettle also exports a list of all these hashes. Nettle also exports a list of all these hashes.
@deftypefun const struct nettle_hash **nettle_get_hashes(void) @deftypefun {const struct nettle_hash **} nettle_get_hashes (void)
Returns a NULL-terminated list of pointers to supported hash functions. Returns a NULL-terminated list of pointers to supported hash functions.
This list can be used to dynamically enumerate or search the supported This list can be used to dynamically enumerate or search the supported
algorithms. algorithms.
...@@ -1131,6 +1129,8 @@ single key setup function that can be used for both encryption and ...@@ -1131,6 +1129,8 @@ single key setup function that can be used for both encryption and
decryption. decryption.
@subsection AES @subsection AES
@cindex AES
AES is a block cipher, specified by NIST as a replacement for AES is a block cipher, specified by NIST as a replacement for
the older DES standard. The standard is the result of a competition the older DES standard. The standard is the result of a competition
between cipher designers. The winning design, also known as RIJNDAEL, between cipher designers. The winning design, also known as RIJNDAEL,
...@@ -1211,6 +1211,8 @@ Analogous to the encryption functions above. ...@@ -1211,6 +1211,8 @@ Analogous to the encryption functions above.
@end deftypefun @end deftypefun
@subsection ARCFOUR @subsection ARCFOUR
@cindex Arcfour
@cindex RC4
ARCFOUR is a stream cipher, also known under the trade marked name RC4, ARCFOUR is a stream cipher, also known under the trade marked name RC4,
and it is one of the fastest ciphers around. A problem is that the key and it is one of the fastest ciphers around. A problem is that the key
setup of ARCFOUR is quite weak, you should never use keys with setup of ARCFOUR is quite weak, you should never use keys with
...@@ -1271,6 +1273,8 @@ them one after another. The result is the same as if you had called ...@@ -1271,6 +1273,8 @@ them one after another. The result is the same as if you had called
@end deftypefun @end deftypefun
@subsection ARCTWO @subsection ARCTWO
@cindex Arctwo
@cindex RC2
ARCTWO (also known as the trade marked name RC2) is a block cipher ARCTWO (also known as the trade marked name RC2) is a block cipher
specified in RFC 2268. Nettle also include a variation of the ARCTWO specified in RFC 2268. Nettle also include a variation of the ARCTWO
set key operation that lack one step, to be compatible with the set key operation that lack one step, to be compatible with the
...@@ -1332,6 +1336,7 @@ Analogous to @code{arctwo_encrypt} ...@@ -1332,6 +1336,7 @@ Analogous to @code{arctwo_encrypt}
@end deftypefun @end deftypefun
@subsection BLOWFISH @subsection BLOWFISH
@cindex Blowfish
BLOWFISH is a block cipher designed by Bruce Schneier. It uses a block BLOWFISH is a block cipher designed by Bruce Schneier. It uses a block
size of 64 bits (8 octets), and a variable key size, up to 448 bits. It size of 64 bits (8 octets), and a variable key size, up to 448 bits. It
...@@ -1378,6 +1383,7 @@ Analogous to @code{blowfish_encrypt} ...@@ -1378,6 +1383,7 @@ Analogous to @code{blowfish_encrypt}
@end deftypefun @end deftypefun
@subsection Camellia @subsection Camellia
@cindex Camellia
Camellia is a block cipher developed by Mitsubishi and Nippon Telegraph Camellia is a block cipher developed by Mitsubishi and Nippon Telegraph
and Telephone Corporation, described in @cite{RFC3713}. It is and Telephone Corporation, described in @cite{RFC3713}. It is
...@@ -1459,6 +1465,7 @@ more than one block, the data is processed in ECB mode. @code{src} and ...@@ -1459,6 +1465,7 @@ more than one block, the data is processed in ECB mode. @code{src} and
@end deftypefun @end deftypefun
@subsection CAST128 @subsection CAST128
@cindex CAST
CAST-128 is a block cipher, specified in @cite{RFC 2144}. It uses a 64 CAST-128 is a block cipher, specified in @cite{RFC 2144}. It uses a 64
bit (8 octets) block size, and a key size of 128 bits. It is possible, bit (8 octets) block size, and a key size of 128 bits. It is possible,
...@@ -1511,6 +1518,7 @@ decryption. ...@@ -1511,6 +1518,7 @@ decryption.
@end deftypefun @end deftypefun
@subsection ChaCha @subsection ChaCha
@cindex ChaCha
ChaCha is a variant of the stream cipher Salsa20, also designed by D. J. ChaCha is a variant of the stream cipher Salsa20, also designed by D. J.
Bernstein. For more information on Salsa20, see below. Nettle defines Bernstein. For more information on Salsa20, see below. Nettle defines
...@@ -1551,6 +1559,7 @@ all but the last call @emph{must} use a length that is a multiple of ...@@ -1551,6 +1559,7 @@ all but the last call @emph{must} use a length that is a multiple of
@end deftypefun @end deftypefun
@subsection DES @subsection DES
@cindex DES
DES is the old Data Encryption Standard, specified by NIST. It uses a DES is the old Data Encryption Standard, specified by NIST. It uses a
block size of 64 bits (8 octets), and a key size of 56 bits. However, block size of 64 bits (8 octets), and a key size of 56 bits. However,
the key bits are distributed over 8 octets, where the least significant the key bits are distributed over 8 octets, where the least significant
...@@ -1608,6 +1617,10 @@ be equal. ...@@ -1608,6 +1617,10 @@ be equal.
@end deftypefun @end deftypefun
@subsection DES3 @subsection DES3
@cindex DES3
@cindex 3DES
@cindex Triple-DES
The inadequate key size of DES has already been mentioned. One way to The inadequate key size of DES has already been mentioned. One way to
increase the key size is to pipe together several DES boxes with increase the key size is to pipe together several DES boxes with
independent keys. It turns out that using two DES ciphers is not as independent keys. It turns out that using two DES ciphers is not as
...@@ -1675,6 +1688,7 @@ Analogous to @code{des_encrypt} ...@@ -1675,6 +1688,7 @@ Analogous to @code{des_encrypt}
@end deftypefun @end deftypefun
@subsection Salsa20 @subsection Salsa20
@cindex Salsa20
Salsa20 is a fairly recent stream cipher designed by D. J. Bernstein. It Salsa20 is a fairly recent stream cipher designed by D. J. Bernstein. It
is built on the observation that a cryptographic hash function can be is built on the observation that a cryptographic hash function can be
used for encryption: Form the hash input from the secret key and a used for encryption: Form the hash input from the secret key and a
...@@ -1761,6 +1775,8 @@ rounds. ...@@ -1761,6 +1775,8 @@ rounds.
@end deftypefun @end deftypefun
@subsection SERPENT @subsection SERPENT
@cindex Serpent
SERPENT is one of the AES finalists, designed by Ross Anderson, Eli SERPENT is one of the AES finalists, designed by Ross Anderson, Eli
Biham and Lars Knudsen. Thus, the interface and properties are similar Biham and Lars Knudsen. Thus, the interface and properties are similar
to AES'. One peculiarity is that it is quite pointless to use it with to AES'. One peculiarity is that it is quite pointless to use it with
...@@ -1804,6 +1820,8 @@ Analogous to @code{serpent_encrypt} ...@@ -1804,6 +1820,8 @@ Analogous to @code{serpent_encrypt}
@subsection TWOFISH @subsection TWOFISH
@cindex Twofish
Another AES finalist, this one designed by Bruce Schneier and others. Another AES finalist, this one designed by Bruce Schneier and others.
Nettle defines it in @file{<nettle/twofish.h>}. Nettle defines it in @file{<nettle/twofish.h>}.
...@@ -1842,12 +1860,10 @@ in any other way. ...@@ -1842,12 +1860,10 @@ in any other way.
Analogous to @code{twofish_encrypt} Analogous to @code{twofish_encrypt}
@end deftypefun @end deftypefun
@c @node nettle_cipher, Cipher Block Chaining, Cipher functions, Reference @c @node nettle_cipher abstraction, , Cipher functions, Cipher functions
@c @comment node-name, next, previous, up @c @comment node-name, next, previous, up
@subsection The @code{struct nettle_cipher} abstraction @subsection The @code{struct nettle_cipher} abstraction
@cindex nettle_cipher @cindex nettle_cipher
@cindex nettle_ciphers
@cindex nettle_get_ciphers
Nettle includes a struct including information about some of the more Nettle includes a struct including information about some of the more
regular cipher functions. It can be useful for applications that need a regular cipher functions. It can be useful for applications that need a
...@@ -1892,7 +1908,7 @@ ones without weak keys or other oddities. ...@@ -1892,7 +1908,7 @@ ones without weak keys or other oddities.
Nettle also exports a list of all these ciphers without weak keys or Nettle also exports a list of all these ciphers without weak keys or
other oddities. other oddities.
@deftypefun const struct nettle_cipher **nettle_get_ciphers(void) @deftypefun {const struct nettle_cipher **} nettle_get_ciphers (void)
Returns a NULL-terminated list of pointers to supported block ciphers. Returns a NULL-terminated list of pointers to supported block ciphers.
This list can be used to dynamically enumerate or search the supported This list can be used to dynamically enumerate or search the supported
algorithms. algorithms.
...@@ -3070,8 +3086,6 @@ smaller than @code{CHACHA_POLY1305_DIGEST_SIZE}, only the first ...@@ -3070,8 +3086,6 @@ smaller than @code{CHACHA_POLY1305_DIGEST_SIZE}, only the first
@comment node-name, next, previous, up @comment node-name, next, previous, up
@subsection The @code{struct nettle_aead} abstraction @subsection The @code{struct nettle_aead} abstraction
@cindex nettle_aead @cindex nettle_aead
@cindex nettle_aeads
@cindex nettle_get_aeads
Nettle includes a struct including information about the supported hash Nettle includes a struct including information about the supported hash
functions. It is defined in @file{<nettle/nettle-meta.h>}. functions. It is defined in @file{<nettle/nettle-meta.h>}.
...@@ -3095,7 +3109,7 @@ message size is specified in advance makes it incompatible with the ...@@ -3095,7 +3109,7 @@ message size is specified in advance makes it incompatible with the
Nettle also exports a list of all these constructions. Nettle also exports a list of all these constructions.
@deftypefun const struct nettle_aead **nettle_get_aeads(void) @deftypefun {const struct nettle_aead **} nettle_get_aeads (void)
Returns a NULL-terminated list of pointers to supported algorithms.This Returns a NULL-terminated list of pointers to supported algorithms.This
list can be used to dynamically enumerate or search the supported list can be used to dynamically enumerate or search the supported
algorithms. algorithms.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment