aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public_key/doc
diff options
context:
space:
mode:
authorSverker Eriksson <[email protected]>2012-06-27 19:58:08 +0200
committerIngela Anderton Andin <[email protected]>2012-08-22 14:00:42 +0200
commitfe18efc0c82cc55e44bbc5d6ca465dff76e5287e (patch)
treebc3327f992812b4bca5a7914181bc02d6f1bc93f /lib/public_key/doc
parent3cde11a94c2761aa8980931f455734d8870446b3 (diff)
downloadotp-fe18efc0c82cc55e44bbc5d6ca465dff76e5287e.tar.gz
otp-fe18efc0c82cc55e44bbc5d6ca465dff76e5287e.tar.bz2
otp-fe18efc0c82cc55e44bbc5d6ca465dff76e5287e.zip
public_key: Align the interface of sign and verify with crypto
Diffstat (limited to 'lib/public_key/doc')
-rw-r--r--lib/public_key/doc/src/public_key.xml15
1 files changed, 7 insertions, 8 deletions
diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml
index 0c9e0c9013..f64274d608 100644
--- a/lib/public_key/doc/src/public_key.xml
+++ b/lib/public_key/doc/src/public_key.xml
@@ -396,11 +396,11 @@
<name>sign(Msg, DigestType, Key) -> binary()</name>
<fsummary> Create digital signature.</fsummary>
<type>
- <v>Msg = binary()</v>
+ <v>Msg = binary() | {digest,binary()}</v>
<d>The msg is either the binary "plain text" data to be
- signed or in the case that digest type is <c>{digest, DigestType}</c>
- it is the hashed value of "plain text" i.e. the digest.</d>
- <v>DigestType = rsa_digest_type() | dsa_digest_type() | {digest, rsa_digest_type() | dsa_digest_type()}</v>
+ signed or it is the hashed value of "plain text" i.e. the
+ digest.</d>
+ <v>DigestType = rsa_digest_type() | dsa_digest_type()</v>
<v>Key = rsa_private_key() | dsa_private_key()</v>
</type>
<desc>
@@ -461,11 +461,10 @@
<name>verify(Msg, DigestType, Signature, Key) -> boolean()</name>
<fsummary>Verifies a digital signature.</fsummary>
<type>
- <v>Msg = binary()</v>
+ <v>Msg = binary() | {digest,binary()}</v>
<d>The msg is either the binary "plain text" data
- or in the case that digest type is <c>{digest, DigestType}</c>
- it is the hashed value of "plain text" i.e. the digest.</d>
- <v>DigestType = rsa_digest_type() | dsa_digest_type() | {digest, rsa_digest_type() | dsa_digest_type()}</v>
+ or it is the hashed value of "plain text" i.e. the digest.</d>
+ <v>DigestType = rsa_digest_type() | dsa_digest_type()</v>
<v>Signature = binary()</v>
<v>Key = rsa_public_key() | dsa_public_key()</v>
</type>