aboutsummaryrefslogtreecommitdiffstats
path: root/lib/crypto/doc/src
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2018-09-18 12:13:42 +0200
committerHans Nilsson <[email protected]>2018-09-18 16:23:45 +0200
commit8c47a7657d03777a03a6838c7ec937b6347d07f8 (patch)
tree69d70ca0161b9e69758f5d1d3d50ea93281165e2 /lib/crypto/doc/src
parent27b793b2ca7f18cc43ce28daad1364a6f90b7edd (diff)
downloadotp-8c47a7657d03777a03a6838c7ec937b6347d07f8.tar.gz
otp-8c47a7657d03777a03a6838c7ec937b6347d07f8.tar.bz2
otp-8c47a7657d03777a03a6838c7ec937b6347d07f8.zip
crypto: Add warnings in RefMan and User's Guide for experimental RSA opts
Diffstat (limited to 'lib/crypto/doc/src')
-rw-r--r--lib/crypto/doc/src/algorithm_details.xml8
-rw-r--r--lib/crypto/doc/src/crypto.xml14
2 files changed, 21 insertions, 1 deletions
diff --git a/lib/crypto/doc/src/algorithm_details.xml b/lib/crypto/doc/src/algorithm_details.xml
index 2d02422cb6..19a19b1ece 100644
--- a/lib/crypto/doc/src/algorithm_details.xml
+++ b/lib/crypto/doc/src/algorithm_details.xml
@@ -213,7 +213,13 @@
list with the <c>public_keys</c> tag in the return value of
<seealso marker="crypto#supports-0">crypto:supports()</seealso>.
</p>
-
+ <warning>
+ <!-- In RefMan rsa_opt(), rsa_sign_verify_opt() and User's man RSA -->
+ <p>The RSA options are experimental.
+ </p>
+ <p>The exact set of options and there syntax <em>may</em> be changed
+ without prior notice.</p>
+ </warning>
<table>
<row><cell><strong>Option</strong></cell> <cell><strong>sign/verify</strong></cell> <cell><strong>encrypt/decrypt</strong></cell> <cell><strong>Supported with</strong><br/><strong>OpenSSL versions</strong></cell> </row>
<row><cell>{rsa_mgf1_md,atom()}</cell> <cell>x</cell> <cell>x</cell> <cell>1.0.1</cell></row>
diff --git a/lib/crypto/doc/src/crypto.xml b/lib/crypto/doc/src/crypto.xml
index e6811a9a93..b7447cb9a3 100644
--- a/lib/crypto/doc/src/crypto.xml
+++ b/lib/crypto/doc/src/crypto.xml
@@ -284,6 +284,13 @@
<name name="rsa_padding"/>
<desc>
<p>Options for public key encrypt/decrypt. Only RSA is supported.</p>
+ <warning>
+ <!-- In RefMan rsa_opt(), rsa_sign_verify_opt() and User's man RSA -->
+ <p>The RSA options are experimental.
+ </p>
+ <p>The exact set of options and there syntax <em>may</em> be changed
+ without prior notice.</p>
+ </warning>
</desc>
</datatype>
@@ -309,6 +316,13 @@
<name name="rsa_sign_verify_padding"/>
<desc>
<p>Options for sign and verify.</p>
+ <warning>
+ <!-- In RefMan rsa_opt(), rsa_sign_verify_opt() and User's man RSA -->
+ <p>The RSA options are experimental.
+ </p>
+ <p>The exact set of options and there syntax <em>may</em> be changed
+ without prior notice.</p>
+ </warning>
</desc>
</datatype>