diff options
author | Jeffrey Walton <noloader@gmail.com> | 2018-07-17 11:52:34 -0400 |
---|---|---|
committer | Jeffrey Walton <noloader@gmail.com> | 2018-07-17 11:52:34 -0400 |
commit | 8d6b1af4cf4a1a12f9b39f75c9fcdf9722284373 (patch) | |
tree | 36e6a2befb23964dc68a162f59ec27716b9cd7c7 /naclite.h | |
parent | d8946df8eb342c0a7c56c59444c12f5682aa0f5d (diff) | |
download | cryptopp-git-8d6b1af4cf4a1a12f9b39f75c9fcdf9722284373.tar.gz |
Update documentation
Diffstat (limited to 'naclite.h')
-rw-r--r-- | naclite.h | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -377,12 +377,14 @@ int crypto_sign_open(byte *m,word64 *mlen,const byte *sm,word64 n,const byte *pk /// \since Crypto++ 6.0
int crypto_sign_keypair(byte *pk, byte *sk);
-/// \brief Generate a public key from a secret key
+/// \brief Calculate a public key from a secret key
/// \param pk public key byte buffer
/// \param sk private key byte buffer
/// \details crypto_sign_sk2pk() creates an ed25519 public key from an existing
-/// secret key without the tail public key bytes. The function is not part of
-/// libsodium or Tweet API. It was added for interop with the I2P Java library.
+/// 32-byte secret key. The function does not backfill the tail bytes of the
+/// secret key with the calculated public key.
+/// \details crypto_sign_sk2pk() is not part of libsodium or Tweet API. It was
+/// added for interop with the I2P Java library.
/// \returns 0 on success, non-0 otherwise
/// \sa <A HREF="https://nacl.cr.yp.to/sign.html">NaCl crypto_sign documentation</A>
/// \since Crypto++ 7.1
|