motiejus/zig

commit ddb9eac05cf8c1bc77ecd303db82fe9fa51dd118 (tree)
parent 9e44710fc441613a85785204808ffa579f10a093
Author: Frank Denis <github@pureftpd.org>
Date:   Tue,  1 Nov 2022 07:26:32 +0100

ed25519: recommend using the seed to recover a key pair

Diffstat:
M
lib/std/crypto/25519/ed25519.zig
 | 
4
++++

1 file changed, 4 insertions(+), 0 deletions(-)
diff --git a/lib/std/crypto/25519/ed25519.zig b/lib/std/crypto/25519/ed25519.zig
@@ -269,6 +269,10 @@ pub const Ed25519 = struct {
         }
 
         /// Create a KeyPair from a secret key.
+        /// Note that with EdDSA, storing the seed, and recovering the key pair
+        /// from it is recommended over storing the entire secret key.
+        /// The seed of an exiting key pair can be obtained with
+        /// `key_pair.secret_key.seed()`.
         pub fn fromSecretKey(secret_key: SecretKey) (NonCanonicalError || EncodingError || IdentityElementError)!KeyPair {
             // It is critical for EdDSA to use the correct public key.
             // In order to enforce this, a SecretKey implicitly includes a copy of the public key.