aboutsummaryrefslogtreecommitdiffstats
path: root/lib/crypto/doc
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2019-03-21 11:59:25 +0100
committerHans Nilsson <[email protected]>2019-03-22 10:23:51 +0100
commit9d4d218eef62a64e1596f0208a7af674785efb38 (patch)
treee19af5938ada05d6604e5337e9d57efb1a598950 /lib/crypto/doc
parent97a97c8021c2740182b43ee95067898a01622000 (diff)
downloadotp-9d4d218eef62a64e1596f0208a7af674785efb38.tar.gz
otp-9d4d218eef62a64e1596f0208a7af674785efb38.tar.bz2
otp-9d4d218eef62a64e1596f0208a7af674785efb38.zip
crypto: Note about key lengths for cipher_info/1
Diffstat (limited to 'lib/crypto/doc')
-rw-r--r--lib/crypto/doc/src/crypto.xml9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index 251263714d..64872d7414 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -917,6 +917,15 @@
<p>Provides a map with information about block_size, key_length, iv_length and possibly other properties of the
cipher algorithm in question.
</p>
+ <note>
+ <p>The ciphers <c>aes_cbc</c>, <c>aes_cfb8</c>, <c>aes_cfb128</c>, <c>aes_ctr</c>,
+ <c>aes_ecb</c>, <c>aes_gcm</c> and <c>aes_ccm</c>
+ has no keylength in the <c>Type</c> as opposed to for example <c>aes_128_ctr</c>. They adapt to the length of
+ the key provided in the encrypt and decrypt function. Therefor it is impossible to return a valid keylength
+ in the map.</p>
+ <p>Always use a <c>Type</c> with an explicit key length,
+ </p>
+ </note>
<p>For a list of supported cipher algorithms, see <seealso marker="#supports-0">supports/0</seealso>.
</p>
</desc>