From: Loup Vaillant <loup@loup-vaillant.fr>
Date: Sat, 6 Jan 2018 12:39:56 +0000 (+0100)
Subject: low-level primitives warnings in the header
X-Git-Url: https://git.codecow.com/?a=commitdiff_plain;h=f4eaf02d17758ae686cf347049debcd7ba8f0871;p=Monocypher.git

low-level primitives warnings in the header

Fixes #78
---

diff --git a/src/monocypher.h b/src/monocypher.h
index bacedb6..4014b50 100644
--- a/src/monocypher.h
+++ b/src/monocypher.h
@@ -11,13 +11,16 @@ int crypto_verify32(const uint8_t a[32], const uint8_t b[32]);
 int crypto_verify64(const uint8_t a[64], const uint8_t b[64]);
 
 // Erase a buffer from existence.
-// It probably wasn't the only copy...
+// It probably wasn't the only copy, make sure you wipe them all.
 void crypto_wipe(void *secret, size_t size);
 
 ////////////////
 /// Chacha20 ///
 ////////////////
 
+// Chacha20 is a low-level primitive, not indented for end users.
+// Use authenticated encryption instead.
+
 // Chacha context.  Do not rely on its contents or its size,
 // they may change without notice.
 typedef struct {
@@ -52,6 +55,9 @@ void crypto_chacha20_stream(crypto_chacha_ctx *ctx,
 /// Poly 1305 ///
 /////////////////
 
+// Poly1305 is a low-level primitive, not indented for end users.
+// Use authenticated encryption instead.
+
 // Poly 1305 context.  Do not rely on its contents or its size, they
 // may change without notice.
 typedef struct {
@@ -127,6 +133,9 @@ void crypto_argon2i(uint8_t       *hash,      uint32_t hash_size,     // >= 4
 ///////////////
 /// X-25519 ///
 ///////////////
+
+// Low-level function, not intended for end users.
+// Use crypto_key_exchange() instead
 int crypto_x25519(uint8_t       raw_shared_secret[32],
                   const uint8_t your_secret_key  [32],
                   const uint8_t their_public_key [32]);
@@ -220,6 +229,8 @@ void crypto_lock_auth(crypto_lock_ctx *ctx,
                       const uint8_t   *message,
                       size_t           message_size);
 
+// Low-level function, not intended for end users.
+// Use crypto_lock_update() and crypto_unlock_update() instead.
 void crypto_lock_encrypt(crypto_lock_ctx *ctx,
                          uint8_t         *cipher_text,
                          const uint8_t   *plain_text,