Skip to content

Commit

Permalink
Update the doc
Browse files Browse the repository at this point in the history
Try to make the documentation look a bit nicer.
  • Loading branch information
fpoirotte committed Jul 29, 2017
1 parent 6917e5b commit aabac4d
Showing 1 changed file with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions docs/src/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ algorithms.

Cryptal supports 3 types of implementations:

* Assembly-based code, which provides maximum speed and is usually secure.
* Assembly code, which provides maximum speed and is usually secure.
* Compiled code, which can be a tiny bit slower, but is often more secure.
* PHP code, which is slower and less secure, but provides support for some
niche algorithms.
Expand All @@ -33,6 +33,11 @@ The following tables list the algorithms provided by each plugin, with their
implementation type. "Core" means the algorithm is provided by the Cryptal
package itself and does not require any additional plugin to work.

Please note that these lists are only given as an indication of what the
underlying library supports.
The actual supported algorithms may vary due to differing compilation options
or differing versions being used.

Cipher algorithms
~~~~~~~~~~~~~~~~~

Expand All @@ -56,6 +61,7 @@ Cipher algorithms
- compiled
- n/a
- n/a
- compiled

* - AES-128
- n/a
Expand All @@ -64,6 +70,7 @@ Cipher algorithms
- compiled
- n/a
- n/a
- compiled

* - AES-192
- n/a
Expand All @@ -72,14 +79,16 @@ Cipher algorithms
- compiled
- n/a
- n/a
- compiled

* - AES-256
- n/a
- compiled
- compiled
- compiled
- compiled
- compiled [#]_
- n/a
- compiled

* - Blowfish
- n/a
Expand All @@ -88,6 +97,7 @@ Cipher algorithms
- compiled
- n/a
- n/a
- compiled

* - Camellia-128
- PHP code
Expand All @@ -96,6 +106,7 @@ Cipher algorithms
- n/a
- n/a
- n/a
- compiled

* - Camellia-192
- PHP code
Expand All @@ -104,6 +115,7 @@ Cipher algorithms
- n/a
- n/a
- n/a
- compiled

* - Camellia-256
- PHP code
Expand All @@ -112,6 +124,7 @@ Cipher algorithms
- n/a
- n/a
- n/a
- compiled

* - CAST5
- n/a
Expand All @@ -120,13 +133,15 @@ Cipher algorithms
- compiled
- n/a
- n/a
- compiled

* - ChaCha20 (IETF variant)
- PHP code
- n/a
- n/a
- n/a
- compiled [#]_
- compiled
- n/a
- n/a

* - ChaCha20 (OpenSSH variant)
Expand All @@ -136,6 +151,7 @@ Cipher algorithms
- n/a
- n/a
- n/a
- n/a

* - DES
- n/a
Expand All @@ -144,6 +160,7 @@ Cipher algorithms
- compiled
- n/a
- n/a
- compiled

* - RC2
- n/a
Expand All @@ -152,6 +169,7 @@ Cipher algorithms
- compiled
- n/a
- n/a
- compiled

* - RC4
- n/a
Expand All @@ -160,14 +178,16 @@ Cipher algorithms
- compiled
- n/a
- n/a
- compiled

* - SEED
- n/a
- n/a
- n/a
- compiled
- compiled
- n/a
- n/a
- compiled

* - Twofish
- n/a
Expand All @@ -176,9 +196,10 @@ Cipher algorithms
- compiled
- n/a
- n/a
- compiled

.. [#] libsodium only supports AES-256 in GCM mode.
Also, this cipher/mode combination will not be available
Also, this cipher/mode combination is not available
unless the processor of the machine running the code
has support for the AES-NI instruction set.
Expand Down

0 comments on commit aabac4d

Please sign in to comment.