From 8d6b1af4cf4a1a12f9b39f75c9fcdf9722284373 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Tue, 17 Jul 2018 11:52:34 -0400 Subject: [PATCH] Update documentation --- naclite.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/naclite.h b/naclite.h index c8d4a9d1..6f069897 100644 --- a/naclite.h +++ b/naclite.h @@ -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 NaCl crypto_sign documentation /// \since Crypto++ 7.1