diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/website/algos.rst | 47 | ||||
-rw-r--r-- | doc/website/manual.rst | 9 |
2 files changed, 28 insertions, 28 deletions
diff --git a/doc/website/algos.rst b/doc/website/algos.rst index c0466aba4..d0640ec54 100644 --- a/doc/website/algos.rst +++ b/doc/website/algos.rst @@ -1,6 +1,6 @@ Supported Algorithms ---------------------------------- +======================================== Botan supports a range of cryptographic algorithms and protocols, including: @@ -24,18 +24,6 @@ Public Key Cryptography Rabin-Williams (padding schemes PSS, PKCS #1 v1.5, X9.31) * Key agreement techniques Diffie-Hellman and ECDH -Hash functions -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - * SHA-1, SHA-224, SHA-256, SHA-384, and SHA-512 - * RIPEMD-160, RIPEMD-128, Tiger, Whirlpool - * SHA-3 winner Keccak-1600 - * SHA-3 candidate Skein-512 - * Hash function combiners (Parallel and Comb4P) - * National standard hashes HAS-160 and GOST 34.11 - * Obsolete or insecure hashes MD5, MD4, MD2 - * Non-cryptographic checksums Adler32, CRC24, CRC32 - Block ciphers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -43,27 +31,38 @@ Block ciphers * Unauthenticated cipher modes CTR, CBC, XTS, CFB, OFB, and ECB * AES (including constant time SSSE3 and AES-NI versions) * AES candidates Serpent, Twofish, MARS, CAST-256, RC6 - * DES, and variants 3DES and DESX + * DES, 3DES and DESX + * National/telecom block ciphers SEED, KASUMI, MISTY1, GOST 28147 * Other block ciphers including Threefish-512, Blowfish, CAST-128, IDEA, Noekeon, TEA, XTEA, RC2, RC5, SAFER-SK - * National/telecom block ciphers SEED, KASUMI, MISTY1, GOST 28147 * Large block cipher construction Lion Stream Ciphers ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - * RC4 - * Salsa20/XSalsa20 - * ChaCha20 - * CTR and OFB modes also present a stream cipher interface + * RC4 + * Salsa20/XSalsa20 + * ChaCha20 + +Hash functions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + * SHA-1, SHA-224, SHA-256, SHA-384, and SHA-512 + * RIPEMD-160, RIPEMD-128, Tiger, Whirlpool + * SHA-3 winner Keccak-1600 + * SHA-3 candidate Skein-512 + * Hash function combiners (Parallel and Comb4P) + * National standard hashes HAS-160 and GOST 34.11 + * Obsolete or insecure hashes MD5, MD4, MD2 + * Non-cryptographic checksums Adler32, CRC24, CRC32 Authentication Codes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - * HMAC - * CMAC (aka OMAC1) - * Obsolete designs CBC-MAC, ANSI X9.19 DES-MAC, and the - protocol-specific SSLv3 authentication code + * HMAC + * CMAC (aka OMAC1) + * Obsolete designs CBC-MAC, ANSI X9.19 DES-MAC, and the + protocol-specific SSLv3 authentication code Other Useful Things ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -74,7 +73,7 @@ Other Useful Things * PRFs from ANSI X9.42, SSL v3.0, TLS v1.0 Recommended Algorithms ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This section is by no means the last word on selecting which algorithms to use. However, botan includes a sometimes bewildering array of possible diff --git a/doc/website/manual.rst b/doc/website/manual.rst index 4253561b4..bda6ef09c 100644 --- a/doc/website/manual.rst +++ b/doc/website/manual.rst @@ -2,9 +2,10 @@ Reference Manual ======================================== -The documentation is all under ``doc`` in your source tree, stored as ``.rst`` -(RestructedText) files. They can be processed by Sphinx to produce HTML or -PDF output. +The documentation is all under ``doc`` in your source tree, stored as +``.rst`` (`RestructedText <http://docutils.sourceforge.net/rst.html>`_) files. +They can be processed by `Sphinx <http://sphinx-doc.org>`_ to produce +HTML or PDF output. -The `manual </manual>`_ and `Doxygen reference </doxygen>`_ for the +The `manual </manual/>`_ and `Doxygen reference </doxygen/>`_ for the latest development release is available online. |