Merge pull request #488 from IntersectMBO/js/rename-sodium-symbols

IntersectMBO · Jul 3, 2024 · 9b633d4 · 9b633d4
2 parents e87e68e + 2c700f9
commit 9b633d4
Show file tree

Hide file tree

Showing 18 changed files with 874 additions and 873 deletions.
diff --git a/cardano-crypto-praos/CHANGELOG.md b/cardano-crypto-praos/CHANGELOG.md
@@ -1,8 +1,9 @@
 # Changelog for `cardano-crypto-praos`
 
-## 2.1.2.1
+## 2.2.0.0
 
-*
+* Prefixed private bundled c functions with `cardano_` to ensure they are not
+  silently overwritten.
 
 ## 2.1.2.0
 

diff --git a/cardano-crypto-praos/cardano-crypto-praos.cabal b/cardano-crypto-praos/cardano-crypto-praos.cabal
@@ -1,7 +1,7 @@
 cabal-version: 2.2
 
 name:                cardano-crypto-praos
-version:             2.1.2.0
+version:             2.2.0.0
 synopsis:            Crypto primitives from libsodium
 description:         VRF (and KES, tba) primitives from libsodium.
 license:             Apache-2.0

diff --git a/cardano-crypto-praos/cbits/crypto_vrf.c b/cardano-crypto-praos/cbits/crypto_vrf.c
@@ -4,39 +4,39 @@
 #include "crypto_vrf.h"
 
 size_t
-crypto_vrf_publickeybytes(void)
+cardano_crypto_vrf_publickeybytes(void)
 {
-    return crypto_vrf_PUBLICKEYBYTES;
+    return cardano_crypto_vrf_PUBLICKEYBYTES;
 }
 
 size_t
-crypto_vrf_secretkeybytes(void)
+cardano_crypto_vrf_secretkeybytes(void)
 {
-    return crypto_vrf_SECRETKEYBYTES;
+    return cardano_crypto_vrf_SECRETKEYBYTES;
 }
 
 size_t
-crypto_vrf_seedbytes(void)
+cardano_crypto_vrf_seedbytes(void)
 {
-    return crypto_vrf_SEEDBYTES;
+    return cardano_crypto_vrf_SEEDBYTES;
 }
 
 size_t
-crypto_vrf_proofbytes(void)
+cardano_crypto_vrf_proofbytes(void)
 {
     return crypto_vrf_PROOFBYTES;
 }
 
 size_t
-crypto_vrf_outputbytes(void)
+cardano_crypto_vrf_outputbytes(void)
 {
-    return crypto_vrf_OUTPUTBYTES;
+    return cardano_crypto_vrf_OUTPUTBYTES;
 }
 
 const char *
-crypto_vrf_primitive(void)
+cardano_crypto_vrf_primitive(void)
 {
-    return crypto_vrf_PRIMITIVE;
+    return cardano_crypto_vrf_PRIMITIVE;
 }
 
 int
@@ -50,8 +50,8 @@ crypto_vrf_seed_keypair(unsigned char *pk, unsigned char *skpk,
     skpk[31] &= 127;
     skpk[31] |= 64;
 
-    ge25519_scalarmult_base(&A, skpk);
-    ge25519_p3_tobytes(pk, &A);
+    cardano_ge25519_scalarmult_base(&A, skpk);
+    cardano_ge25519_p3_tobytes(pk, &A);
 
     memmove(skpk, seed, 32);
     memmove(skpk + 32, pk, 32);
@@ -60,7 +60,7 @@ crypto_vrf_seed_keypair(unsigned char *pk, unsigned char *skpk,
 }
 
 int
-crypto_vrf_keypair(unsigned char *pk, unsigned char *skpk)
+cardano_crypto_vrf_keypair(unsigned char *pk, unsigned char *skpk)
 {
     unsigned char seed[32];
     int           ret;
@@ -73,22 +73,22 @@ crypto_vrf_keypair(unsigned char *pk, unsigned char *skpk)
 }
 
 int
-crypto_vrf_prove(unsigned char *proof, const unsigned char *skpk,
+cardano_crypto_vrf_prove(unsigned char *proof, const unsigned char *skpk,
 		 const unsigned char *m, const unsigned long long mlen)
 {
     return crypto_vrf_ietfdraft13_prove(proof, skpk, m, mlen);
 }
 
 int
-crypto_vrf_verify(unsigned char *output, const unsigned char *pk,
+cardano_crypto_vrf_verify(unsigned char *output, const unsigned char *pk,
 		  const unsigned char *proof, const unsigned char *m,
 		  const unsigned long long mlen)
 {
     return crypto_vrf_ietfdraft13_verify(output, pk, proof, m, mlen);
 }
 
 int
-crypto_vrf_proof_to_hash(unsigned char *hash, const unsigned char *proof)
+cardano_crypto_vrf_proof_to_hash(unsigned char *hash, const unsigned char *proof)
 {
     return crypto_vrf_ietfdraft13_proof_to_hash(hash, proof);
 }

diff --git a/cardano-crypto-praos/cbits/crypto_vrf.h b/cardano-crypto-praos/cbits/crypto_vrf.h
@@ -2,10 +2,10 @@
 #define crypto_vrf_H
 
 /*
- * THREAD SAFETY: crypto_vrf_keypair() is thread-safe provided that
+ * THREAD SAFETY: cardano_crypto_vrf_keypair() is thread-safe provided that
  * sodium_init() was called before.
  *
- * Other functions, including crypto_vrf_keypair_from_seed(), are always
+ * Other functions, including cardano_crypto_vrf_keypair_from_seed(), are always
  * thread-safe.
  */
 
@@ -28,32 +28,32 @@ static const unsigned char ONE = 0x01;
 static const unsigned char TWO = 0x02;
 static const unsigned char THREE = 0x03;
 
-#define crypto_vrf_PUBLICKEYBYTES crypto_vrf_ietfdraft13_PUBLICKEYBYTES
+#define cardano_crypto_vrf_PUBLICKEYBYTES crypto_vrf_ietfdraft13_PUBLICKEYBYTES
 SODIUM_EXPORT
-size_t crypto_vrf_publickeybytes(void);
+size_t cardano_crypto_vrf_publickeybytes(void);
 
-#define crypto_vrf_SECRETKEYBYTES crypto_vrf_ietfdraft13_SECRETKEYBYTES
+#define cardano_crypto_vrf_SECRETKEYBYTES crypto_vrf_ietfdraft13_SECRETKEYBYTES
 SODIUM_EXPORT
-size_t crypto_vrf_secretkeybytes(void);
+size_t cardano_crypto_vrf_secretkeybytes(void);
 
-#define crypto_vrf_SEEDBYTES crypto_vrf_ietfdraft13_SEEDBYTES
+#define cardano_crypto_vrf_SEEDBYTES crypto_vrf_ietfdraft13_SEEDBYTES
 SODIUM_EXPORT
-size_t crypto_vrf_seedbytes(void);
+size_t cardano_crypto_vrf_seedbytes(void);
 
 #define crypto_vrf_PROOFBYTES crypto_vrf_ietfdraft13_BYTES
 SODIUM_EXPORT
-size_t crypto_vrf_proofbytes(void);
+size_t cardano_crypto_vrf_proofbytes(void);
 
-#define crypto_vrf_OUTPUTBYTES crypto_vrf_ietfdraft13_OUTPUTBYTES
+#define cardano_crypto_vrf_OUTPUTBYTES crypto_vrf_ietfdraft13_OUTPUTBYTES
 SODIUM_EXPORT
-size_t crypto_vrf_outputbytes(void);
+size_t cardano_crypto_vrf_outputbytes(void);
 
-#define crypto_vrf_PRIMITIVE "ietfdraft13"
+#define cardano_crypto_vrf_PRIMITIVE "ietfdraft13"
 SODIUM_EXPORT
-const char *crypto_vrf_primitive(void);
+const char *cardano_crypto_vrf_primitive(void);
 
 SODIUM_EXPORT
-int crypto_vrf_keypair(unsigned char *pk, unsigned char *skpk)
+int cardano_crypto_vrf_keypair(unsigned char *pk, unsigned char *skpk)
 __attribute__ ((nonnull));
 
 SODIUM_EXPORT
@@ -62,20 +62,20 @@ int crypto_vrf_seed_keypair(unsigned char *pk, unsigned char *skpk,
 __attribute__ ((nonnull));
 
 SODIUM_EXPORT
-int crypto_vrf_prove(unsigned char *proof, const unsigned char *skpk,
+int cardano_crypto_vrf_prove(unsigned char *proof, const unsigned char *skpk,
 		     const unsigned char *m, unsigned long long mlen)
 __attribute__ ((nonnull));
 
 SODIUM_EXPORT
-int crypto_vrf_verify(unsigned char *output,
+int cardano_crypto_vrf_verify(unsigned char *output,
 		      const unsigned char *pk,
 		      const unsigned char *proof,
 		      const unsigned char *m, unsigned long long mlen)
             __attribute__ ((warn_unused_result))
 __attribute__ ((warn_unused_result))  __attribute__ ((nonnull));
 
 SODIUM_EXPORT
-int crypto_vrf_proof_to_hash(unsigned char *hash, const unsigned char *proof);
+int cardano_crypto_vrf_proof_to_hash(unsigned char *hash, const unsigned char *proof);
 
 SODIUM_EXPORT
 void crypto_vrf_sk_to_pk(unsigned char *pk, const unsigned char *skpk);

diff --git a/cardano-crypto-praos/cbits/private/core_h2c.c b/cardano-crypto-praos/cbits/private/core_h2c.c
@@ -12,7 +12,7 @@
 #define HASH_BLOCKBYTES 64U
 
 static void
-core_h2c_string_to_hash_sha256(unsigned char *h, const size_t h_len, const char *ctx,
+cardano_core_h2c_string_to_hash_sha256(unsigned char *h, const size_t h_len, const char *ctx,
                                const unsigned char *msg, size_t msg_len)
 {
     crypto_hash_sha256_state st;
@@ -67,7 +67,7 @@ core_h2c_string_to_hash_sha256(unsigned char *h, const size_t h_len, const char
 #define HASH_BLOCKBYTES 128U
 
 static void
-core_h2c_string_to_hash_sha512(unsigned char *h, const size_t h_len, const char *ctx,
+cardano_core_h2c_string_to_hash_sha512(unsigned char *h, const size_t h_len, const char *ctx,
                                const unsigned char *msg, size_t msg_len)
 {
     crypto_hash_sha512_state st;
@@ -116,15 +116,15 @@ core_h2c_string_to_hash_sha512(unsigned char *h, const size_t h_len, const char
 }
 
 int
-core_h2c_string_to_hash(unsigned char *h, const size_t h_len, const char *ctx,
+cardano_core_h2c_string_to_hash(unsigned char *h, const size_t h_len, const char *ctx,
                         const unsigned char *msg, size_t msg_len, int hash_alg)
 {
     switch (hash_alg) {
         case CORE_H2C_SHA256:
-            core_h2c_string_to_hash_sha256(h, h_len, ctx, msg, msg_len);
+            cardano_core_h2c_string_to_hash_sha256(h, h_len, ctx, msg, msg_len);
             return 0;
         case CORE_H2C_SHA512:
-            core_h2c_string_to_hash_sha512(h, h_len, ctx, msg, msg_len);
+            cardano_core_h2c_string_to_hash_sha512(h, h_len, ctx, msg, msg_len);
             return 0;
         default:
             errno = EINVAL;

diff --git a/cardano-crypto-praos/cbits/private/core_h2c.h b/cardano-crypto-praos/cbits/private/core_h2c.h
@@ -4,7 +4,7 @@
 #define CORE_H2C_SHA256 1
 #define CORE_H2C_SHA512 2
 
-int core_h2c_string_to_hash(unsigned char *h, const size_t h_len, const char *ctx,
+int cardano_core_h2c_string_to_hash(unsigned char *h, const size_t h_len, const char *ctx,
                             const unsigned char *msg, size_t msg_len,
                             int hash_alg);
 #endif