aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public_key/doc/src/public_key.xml
diff options
context:
space:
mode:
authorHans Nilsson <[email protected]>2017-03-08 16:09:32 +0100
committerHans Nilsson <[email protected]>2017-03-09 16:15:42 +0100
commit60c7d23ec8d2a811d4649704c51a12f4fa1fa58d (patch)
treea4efc69c67824ca8ce6602a8f6824050171e6f44 /lib/public_key/doc/src/public_key.xml
parentbdda89d1fc42853d3c438f4055740c75153f7db7 (diff)
downloadotp-60c7d23ec8d2a811d4649704c51a12f4fa1fa58d.tar.gz
otp-60c7d23ec8d2a811d4649704c51a12f4fa1fa58d.tar.bz2
otp-60c7d23ec8d2a811d4649704c51a12f4fa1fa58d.zip
public_key: RSA key gen documentation
Diffstat (limited to 'lib/public_key/doc/src/public_key.xml')
-rw-r--r--lib/public_key/doc/src/public_key.xml9
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml
index c503230d70..75ae7ecb7b 100644
--- a/lib/public_key/doc/src/public_key.xml
+++ b/lib/public_key/doc/src/public_key.xml
@@ -331,13 +331,16 @@
</func>
<func>
- <name>generate_key(Params) -> {Public::binary(), Private::binary()} | #'ECPrivateKey'{} </name>
+ <name>generate_key(Params) -> {Public::binary(), Private::binary()} | #'ECPrivateKey'{} | {#'RSAPublicKey'{}, #'RSAPrivateKey'{}}</name>
<fsummary>Generates a new keypair.</fsummary>
<type>
- <v>Params = #'DHParameter'{} | {namedCurve, oid()} | #'ECParameters'{}</v>
+ <v>Params = #'DHParameter'{} | {namedCurve, oid()} | #'ECParameters'{}
+ | {rsa, Size::integer(), PubExp::integer} </v>
</type>
<desc>
- <p>Generates a new keypair.</p>
+ <p>Generates a new keypair. See also
+ <seealso marker="crypto:crypto#generate_key/2">crypto:generate_key/2</seealso>
+ </p>
</desc>
</func>