diff options
author | Hans Nilsson <[email protected]> | 2019-06-17 11:55:00 +0200 |
---|---|---|
committer | Hans Nilsson <[email protected]> | 2019-06-17 11:55:00 +0200 |
commit | 8a17f3629530c033971cb1e0fd9ded7dd7a775c4 (patch) | |
tree | d8f07c73fae6c3d529d181024e22c2c016fc4734 /lib/crypto/doc/src/crypto.xml | |
parent | e233ca13bedc193ebee800f4bfe6c6afe2ffd1bc (diff) | |
parent | 5f05cfb309bcbdc1e9444086b7c920739e389215 (diff) | |
download | otp-8a17f3629530c033971cb1e0fd9ded7dd7a775c4.tar.gz otp-8a17f3629530c033971cb1e0fd9ded7dd7a775c4.tar.bz2 otp-8a17f3629530c033971cb1e0fd9ded7dd7a775c4.zip |
Merge branch 'hans/crypto/cuddle_docs' into maint
* hans/crypto/cuddle_docs:
crypto: Modernized 'Algorithms' section in User's Guide
Diffstat (limited to 'lib/crypto/doc/src/crypto.xml')
-rw-r--r-- | lib/crypto/doc/src/crypto.xml | 38 |
1 files changed, 32 insertions, 6 deletions
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml index 26fbfc166e..8988a18482 100644 --- a/lib/crypto/doc/src/crypto.xml +++ b/lib/crypto/doc/src/crypto.xml @@ -814,10 +814,16 @@ <p><c>SubType</c> depends on the MAC <c>Type</c>: </p> <list> - <item>For <c>hmac</c> it is a hash algorithm</item> - <item>For <c>cmac</c> it is a cipher suitable for cmac</item> + <item>For <c>hmac</c> it is a hash algorithm, see + <seealso marker="algorithm_details#hmac">Algorithm Details</seealso> in the User's Guide. + </item> + <item>For <c>cmac</c> it is a cipher suitable for cmac, see + <seealso marker="algorithm_details#cmac">Algorithm Details</seealso> in the User's Guide. + </item> <item>For <c>poly1305</c> it should be set to <c>undefined</c> or the - <seealso marker="#mac-3">mac/3</seealso> function could be used instead.</item> + <seealso marker="#mac_init-2">mac/2</seealso> function could be used instead, see + <seealso marker="algorithm_details#poly1305">Algorithm Details</seealso> in the User's Guide. + </item> </list> <p><c>Key</c> is the authentication key with a length according to the @@ -832,6 +838,9 @@ <p>The <c>Mac</c> result will have a default length depending on the <c>Type</c> and <c>SubType</c>. To set a shorter length, use <seealso marker="#macN-4">macN/4</seealso> or <seealso marker="#macN-5">macN/5</seealso> instead. + The default length is documented in + <seealso marker="algorithm_details#message-authentication-codes--macs-">Algorithm Details</seealso> + in the User's Guide. </p> </desc> </func> @@ -857,6 +866,10 @@ bytes returned from the underlying hash, the returned hash will have that shorter length instead. </p> + <p>The max <c>MacLength</c> is documented in + <seealso marker="algorithm_details#message-authentication-codes--macs-">Algorithm Details</seealso> + in the User's Guide. + </p> </desc> </func> @@ -881,10 +894,16 @@ <p><c>SubType</c> depends on the MAC <c>Type</c>: </p> <list> - <item>For <c>hmac</c> it is a hash algorithm</item> - <item>For <c>cmac</c> it is a cipher suitable for cmac</item> + <item>For <c>hmac</c> it is a hash algorithm, see + <seealso marker="algorithm_details#hmac">Algorithm Details</seealso> in the User's Guide. + </item> + <item>For <c>cmac</c> it is a cipher suitable for cmac, see + <seealso marker="algorithm_details#cmac">Algorithm Details</seealso> in the User's Guide. + </item> <item>For <c>poly1305</c> it should be set to <c>undefined</c> or the - <seealso marker="#mac_init-2">mac/2</seealso> function could be used instead.</item> + <seealso marker="#mac_init-2">mac/2</seealso> function could be used instead, see + <seealso marker="algorithm_details#poly1305">Algorithm Details</seealso> in the User's Guide. + </item> </list> <p><c>Key</c> is the authentication key with a length according to the @@ -933,6 +952,9 @@ a default length depending on the <c>Type</c> and <c>SubType</c> in the <seealso marker="#mac_init-3">mac_init/2,3</seealso> call. To set a shorter length, use <seealso marker="#mac_finalN-2">mac_finalN/2</seealso> instead. + The default length is documented in + <seealso marker="algorithm_details#message-authentication-codes--macs-">Algorithm Details</seealso> + in the User's Guide. </p> </desc> </func> @@ -948,6 +970,10 @@ bytes returned from the underlying hash, the returned hash will have that shorter length instead. </p> + <p>The max <c>MacLength</c> is documented in + <seealso marker="algorithm_details#message-authentication-codes--macs-">Algorithm Details</seealso> + in the User's Guide. + </p> </desc> </func> </funcs> |