From 14e33af525935482ffa05e63e9dbcf6503488e39 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Tue, 21 Nov 2017 08:32:58 -0500 Subject: [PATCH] Update documentation --- Readme.txt | 7 ++++--- cryptlib.h | 16 +++++++++++----- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/Readme.txt b/Readme.txt index 8ba3b829..881978ee 100644 --- a/Readme.txt +++ b/Readme.txt @@ -15,8 +15,9 @@ Currently the library contains the following algorithms: CAST-256 ARIA, IDEA, Blowfish, Triple-DES (DES-EDE2 and - other block ciphers DES-EDE3), Camellia, SEED, Kalyna, RC5, SPECK-64, - SPECK-128, Threefish, Skipjack, SHACAL-2, TEA, XTEA + other block ciphers DES-EDE3), Camellia, SEED, Kalyna, RC5, SIMON-64, + SIMON-128, SPECK-64, SPECK-128, Threefish, Skipjack, + SHACAL-2, TEA, XTEA block cipher modes of operation ECB, CBC, CBC ciphertext stealing (CTS), CFB, OFB, counter mode (CTR) @@ -89,7 +90,7 @@ The following compilers are supported for this release. Please visit http://www.cryptopp.com the most up to date build instructions and porting notes. * Visual Studio 2003 - 2017 - * GCC 3.3 - 7.1 + * GCC 3.3 - 7.2 * Apple Clang 4.3 - 8.3 * LLVM Clang 2.9 - 4.0 * C++Builder 2010 diff --git a/cryptlib.h b/cryptlib.h index f06622be..528b46b6 100644 --- a/cryptlib.h +++ b/cryptlib.h @@ -12,11 +12,12 @@
Block Ciphers
\ref Rijndael "AES", ARIA, Weak::ARC4, Blowfish, BTEA, Camellia, CAST128, CAST256, DES, \ref DES_EDE2 "2-key Triple-DES", \ref DES_EDE3 "3-key Triple-DES", \ref DES_XEX3 "DESX", - GOST, IDEA, \ref LR "Luby-Rackoff", MARS, RC2, RC5, RC6, \ref SAFER_K "SAFER-K", - \ref SAFER_SK "SAFER-SK", SEED, Serpent, \ref SHACAL2 "SHACAL-2", SHARK, SKIPJACK, -Square, TEA, \ref ThreeWay "3-Way", Threefish, Twofish, XTEA + GOST, IDEA, \ref LR "Luby-Rackoff", Kalyna (128/256/512), MARS, RC2, RC5, RC6, \ref SAFER_K + "SAFER-K", \ref SAFER_SK "SAFER-SK", SEED, Serpent, \ref SHACAL2 "SHACAL-2", SHARK, SKIPJACK, + \ref SIMON128 "SIMON-64 and SIMON-128", \ref SPECK128 "SPECK-64 and SPECK-128", Square, TEA, + \ref ThreeWay "3-Way", \ref Threefish256 "Threefish (Threefish-256/512/1024)", Twofish, XTEA
Stream Ciphers
- ChaCha8, ChaCha12, ChaCha20, \ref Panama "Panama-LE", \ref Panama "Panama-BE", Salsa20, + ChaCha (ChaCha-8/12/20), \ref Panama "Panama-LE", \ref Panama "Panama-BE", Salsa20, \ref SEAL "SEAL-LE", \ref SEAL "SEAL-BE", WAKE, XSalsa20
Hash Functions
BLAKE2s, BLAKE2b, \ref Keccak "Keccak (F1600)", SHA1, SHA224, SHA256, SHA384, SHA512, @@ -58,6 +59,9 @@ Square, TEA, \ref ThreeWay "3-Way", Threefish, Twofish, XTEA Base32Decoder
Wrappers for OS features
Timer, Socket, WindowsHandle, ThreadLocalStorage, ThreadUserTimer + + + +

This reference manual is a work in progress. Some classes lack detailed descriptions.

Click here to download a zip archive containing this manual.

Thanks to Ryan Phillips for providing the Doxygen configuration file and getting us started on the manual.