diff options
| author | Hans Nilsson <[email protected]> | 2019-03-18 13:53:47 +0100 |
|---|---|---|
| committer | Hans Nilsson <[email protected]> | 2019-03-22 10:17:56 +0100 |
| commit | 7cb7cd54f3000c08c925f2ad10723b54efdc485e (patch) | |
| tree | 8a1998354c1d13c8dc26d86e93b878bc90247600 /lib/crypto/doc | |
| parent | b96629dff27003d6df5ad12dd58801619681ac19 (diff) | |
| download | otp-7cb7cd54f3000c08c925f2ad10723b54efdc485e.tar.gz otp-7cb7cd54f3000c08c925f2ad10723b54efdc485e.tar.bz2 otp-7cb7cd54f3000c08c925f2ad10723b54efdc485e.zip | |
crypto: Document hash_info/1 and cipher_info/1
Diffstat (limited to 'lib/crypto/doc')
| -rw-r--r-- | lib/crypto/doc/src/crypto.xml | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index e5a3af923c..17522bcdab 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -546,6 +546,22 @@ </desc> </datatype> + <datatype_title>Error types</datatype_title> + + <datatype> + <name name="run_time_error"/> + <desc> + <p>The exception <c>error:badarg</c> signifies that one or more arguments are of wrong data type, + or are otherwise badly formed. + </p> + <p>The exception <c>error:notsup</c> signifies that the algorithm is known but is not supported + by current underlying libcrypto or explicitly disabled when building that. + </p> + <p>For a list of supported algorithms, see <seealso marker="#supports-0">supports/0</seealso>. + </p> + </desc> + </datatype> + </datatypes> <!--================ FUNCTIONS ================--> @@ -853,6 +869,30 @@ </func> <func> + <name name="hash_info" arity="1" since="OTP 22.0"/> + <fsummary>Information about supported hash algorithms.</fsummary> + <desc> + <p>Provides a map with information about block_size, size and possibly other properties of the + hash algorithm in the argument. + </p> + <p>For a list of supported hash algorithms, see <seealso marker="#supports-0">supports/0</seealso>. + </p> + </desc> + </func> + + <func> + <name name="cipher_info" arity="1" since="OTP 22.0"/> + <fsummary>Information about supported ciphers.</fsummary> + <desc> + <p>Provides a map with information about block_size, key_length, iv_length and possibly other properties of the + cipher algorithm in the argument. + </p> + <p>For a list of supported cipher algorithms, see <seealso marker="#supports-0">supports/0</seealso>. + </p> + </desc> + </func> + + <func> <name name="mod_pow" arity="3" since="OTP R16B01"/> <fsummary>Computes the function: N^P mod M</fsummary> <desc> @@ -1301,6 +1341,9 @@ FloatValue = rand:uniform(). % again <p>Note: the <c>rsa_opts</c> entry is in an experimental state and may change or be removed without notice. No guarantee for the accuarcy of the rsa option's value list should be assumed. </p> + <p>See <seealso marker="#hash_info-1">hash_info/1</seealso> and <seealso marker="#cipher_info-1">cipher_info/1</seealso> + for information about the hash and cipher algorithms. + </p> </desc> </func> |