Skip to content

Commit

Permalink
crypto: Fix crypto:compute_key/4 documentation
Browse files Browse the repository at this point in the history
If the function's first argument (i.e. the key-agreement protocol) is
`srp`, the third argument has to be a tuple of public and private key
instead of only the private key.

This changes the documentation to reflect that fact.
  • Loading branch information
KlausTrainer committed May 19, 2013
1 parent 678b4bc commit 76b0b72
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions lib/crypto/doc/src/crypto.xml
Original file line number Diff line number Diff line change
Expand Up @@ -188,12 +188,12 @@
</func>

<func>
<name>compute_key(Type, OthersPublicKey, MyPrivateKey, Params) -> SharedSecret</name>
<name>compute_key(Type, OthersPublicKey, MyPrivate, Params) -> SharedSecret</name>
<fsummary>Computes the shared secret</fsummary>
<type>
<v> Type = dh | ecdh | srp </v>
<v>Type = dh | ecdh | srp </v>
<v>OthersPublicKey = dh_public() | ecdh_public() | srp_public() </v>
<v>MyPrivate = dh_private() | ecdh_private() | srp_private() </v>
<v>MyPrivate = dh_private() | ecdh_private() | {srp_public(), srp_private()} </v>
<v>Params = dh_params() | edhc_params() | srp_params() </v>
<v>SharedSecret = binary()</v>
</type>
Expand Down

0 comments on commit 76b0b72

Please sign in to comment.