API: add failure mode support for randombytes()

examples/basic/test_only_rng/notrandombytes.c

@@ -87,7 +87,7 @@ static void surf(void)
   }
 }
 
-void randombytes(uint8_t *buf, size_t n)
+int randombytes(uint8_t *buf, size_t n)
 {
   while (n > 0)
   {
@@ -110,4 +110,5 @@ void randombytes(uint8_t *buf, size_t n)
     ++buf;
     --n;
   }
+  return 0;
 }

examples/basic/test_only_rng/notrandombytes.h

@@ -30,6 +30,6 @@
  */
 
 void randombytes_reset(void);
-void randombytes(uint8_t *buf, size_t n);
+int randombytes(uint8_t *buf, size_t n);
 
 #endif /* !NOTRANDOMBYTES_H */

examples/basic_deterministic/mldsa_native/custom_no_randomized_config.h

@@ -343,7 +343,8 @@
  *              consumer.
  *
  *              If this option is not set, mldsa-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
+ *              This function should return 0 on success, non-zero on failure.
  *
  *              Set this option and define `mld_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -354,9 +355,10 @@
    #if !defined(__ASSEMBLER__)
    #include <stdint.h>
    #include "sys.h"
-   static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+   static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
    {
        ... your implementation ...
+       return 0;  // 0 on success, non-zero on failure
    }
    #endif
 */

examples/bring_your_own_fips202/test_only_rng/notrandombytes.c

@@ -87,7 +87,7 @@ static void surf(void)
   }
 }
 
-void randombytes(uint8_t *buf, size_t n)
+int randombytes(uint8_t *buf, size_t n)
 {
   while (n > 0)
   {
@@ -110,4 +110,5 @@ void randombytes(uint8_t *buf, size_t n)
     ++buf;
     --n;
   }
+  return 0;
 }

examples/bring_your_own_fips202/test_only_rng/notrandombytes.h

@@ -30,6 +30,6 @@
  */
 
 void randombytes_reset(void);
-void randombytes(uint8_t *buf, size_t n);
+int randombytes(uint8_t *buf, size_t n);
 
 #endif /* !NOTRANDOMBYTES_H */

examples/bring_your_own_fips202_static/test_only_rng/notrandombytes.c

@@ -87,7 +87,7 @@ static void surf(void)
   }
 }
 
-void randombytes(uint8_t *buf, size_t n)
+int randombytes(uint8_t *buf, size_t n)
 {
   while (n > 0)
   {
@@ -110,4 +110,5 @@ void randombytes(uint8_t *buf, size_t n)
     ++buf;
     --n;
   }
+  return 0;
 }

examples/bring_your_own_fips202_static/test_only_rng/notrandombytes.h

@@ -30,6 +30,6 @@
  */
 
 void randombytes_reset(void);
-void randombytes(uint8_t *buf, size_t n);
+int randombytes(uint8_t *buf, size_t n);
 
 #endif /* !NOTRANDOMBYTES_H */

examples/monolithic_build/config_44.h

@@ -341,7 +341,8 @@
  *              consumer.
  *
  *              If this option is not set, mldsa-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
+ *              This function should return 0 on success, non-zero on failure.
  *
  *              Set this option and define `mld_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -352,9 +353,10 @@
    #if !defined(__ASSEMBLER__)
    #include <stdint.h>
    #include "sys.h"
-   static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+   static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
    {
        ... your implementation ...
+       return 0;  // 0 on success, non-zero on failure
    }
    #endif
 */

examples/monolithic_build/config_65.h

@@ -341,7 +341,8 @@
  *              consumer.
  *
  *              If this option is not set, mldsa-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
+ *              This function should return 0 on success, non-zero on failure.
  *
  *              Set this option and define `mld_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -352,9 +353,10 @@
    #if !defined(__ASSEMBLER__)
    #include <stdint.h>
    #include "sys.h"
-   static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+   static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
    {
        ... your implementation ...
+       return 0;  // 0 on success, non-zero on failure
    }
    #endif
 */

examples/monolithic_build/config_87.h

@@ -341,7 +341,8 @@
  *              consumer.
  *
  *              If this option is not set, mldsa-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
+ *              This function should return 0 on success, non-zero on failure.
  *
  *              Set this option and define `mld_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -352,9 +353,10 @@
    #if !defined(__ASSEMBLER__)
    #include <stdint.h>
    #include "sys.h"
-   static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+   static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
    {
        ... your implementation ...
+       return 0;  // 0 on success, non-zero on failure
    }
    #endif
 */

examples/monolithic_build_multilevel/multilevel_config.h

@@ -342,7 +342,8 @@
  *              consumer.
  *
  *              If this option is not set, mldsa-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
+ *              This function should return 0 on success, non-zero on failure.
  *
  *              Set this option and define `mld_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -353,9 +354,10 @@
    #if !defined(__ASSEMBLER__)
    #include <stdint.h>
    #include "sys.h"
-   static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+   static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
    {
        ... your implementation ...
+       return 0;  // 0 on success, non-zero on failure
    }
    #endif
 */

examples/monolithic_build_multilevel_native/multilevel_config.h

@@ -342,7 +342,8 @@
  *              consumer.
  *
  *              If this option is not set, mldsa-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
+ *              This function should return 0 on success, non-zero on failure.
  *
  *              Set this option and define `mld_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -360,9 +361,9 @@
 #include <stdint.h>
 #include "sys.h"
 #include "test_only_rng/notrandombytes.h"
-static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
 {
-  randombytes(ptr, len);
+  return randombytes(ptr, len);
 }
 #endif /* !__ASSEMBLER__ */
 

examples/monolithic_build_native/config_44.h

@@ -339,7 +339,8 @@
  *              consumer.
  *
  *              If this option is not set, mldsa-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
+ *              This function should return 0 on success, non-zero on failure.
  *
  *              Set this option and define `mld_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -350,9 +351,10 @@
    #if !defined(__ASSEMBLER__)
    #include <stdint.h>
    #include "sys.h"
-   static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+   static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
    {
        ... your implementation ...
+       return 0;  // 0 on success, non-zero on failure
    }
    #endif
 */

examples/monolithic_build_native/config_65.h

@@ -339,7 +339,8 @@
  *              consumer.
  *
  *              If this option is not set, mldsa-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
+ *              This function should return 0 on success, non-zero on failure.
  *
  *              Set this option and define `mld_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -350,9 +351,10 @@
    #if !defined(__ASSEMBLER__)
    #include <stdint.h>
    #include "sys.h"
-   static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+   static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
    {
        ... your implementation ...
+       return 0;  // 0 on success, non-zero on failure
    }
    #endif
 */

examples/monolithic_build_native/config_87.h

@@ -339,7 +339,8 @@
  *              consumer.
  *
  *              If this option is not set, mldsa-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
+ *              This function should return 0 on success, non-zero on failure.
  *
  *              Set this option and define `mld_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -350,9 +351,10 @@
    #if !defined(__ASSEMBLER__)
    #include <stdint.h>
    #include "sys.h"
-   static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+   static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
    {
        ... your implementation ...
+       return 0;  // 0 on success, non-zero on failure
    }
    #endif
 */

integration/liboqs/config_aarch64.h

@@ -162,7 +162,7 @@
  *              consumer.
  *
  *              If this option is not set, mlkem-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
  *
  *              Set this option and define `mlk_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -174,9 +174,10 @@
 #include <oqs/rand.h>
 #include <stdint.h>
 #include "../../mldsa/src/sys.h"
-static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
 {
   OQS_randombytes(ptr, len);
+  return 0;
 }
 #endif /* !__ASSEMBLER__ */
 

integration/liboqs/config_c.h

@@ -166,7 +166,7 @@
  *              consumer.
  *
  *              If this option is not set, mlkem-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
  *
  *              Set this option and define `mlk_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -178,9 +178,10 @@
 #include <oqs/rand.h>
 #include <stdint.h>
 #include "../../mldsa/src/sys.h"
-static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
 {
   OQS_randombytes(ptr, len);
+  return 0;
 }
 #endif /* !__ASSEMBLER__ */
 

integration/liboqs/config_x86_64.h

@@ -164,7 +164,7 @@
  *              consumer.
  *
  *              If this option is not set, mlkem-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
  *
  *              Set this option and define `mlk_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -176,9 +176,10 @@
 #include <oqs/rand.h>
 #include <stdint.h>
 #include "../../mldsa/src/sys.h"
-static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
 {
   OQS_randombytes(ptr, len);
+  return 0;
 }
 #endif /* !__ASSEMBLER__ */
 

mldsa/src/config.h

@@ -327,7 +327,8 @@
  *              consumer.
  *
  *              If this option is not set, mldsa-native expects a function
- *              void randombytes(uint8_t *out, size_t outlen).
+ *              int randombytes(uint8_t *out, size_t outlen).
+ *              This function should return 0 on success, non-zero on failure.
  *
  *              Set this option and define `mld_randombytes` if you want to
  *              use a custom method to sample randombytes with a different name
@@ -338,9 +339,10 @@
    #if !defined(__ASSEMBLER__)
    #include <stdint.h>
    #include "sys.h"
-   static MLD_INLINE void mld_randombytes(uint8_t *ptr, size_t len)
+   static MLD_INLINE int mld_randombytes(uint8_t *ptr, size_t len)
    {
        ... your implementation ...
+       return 0;  // 0 on success, non-zero on failure
    }
    #endif
 */

mldsa/src/randombytes.h

@@ -13,12 +13,12 @@
 
 #if !defined(MLD_CONFIG_NO_RANDOMIZED_API)
 #if !defined(MLD_CONFIG_CUSTOM_RANDOMBYTES)
-void randombytes(uint8_t *out, size_t outlen);
-static MLD_INLINE void mld_randombytes(uint8_t *out, size_t outlen)
+int randombytes(uint8_t *out, size_t outlen);
+static MLD_INLINE int mld_randombytes(uint8_t *out, size_t outlen)
 __contract__(
   requires(memory_no_alias(out, outlen))
   assigns(memory_slice(out, outlen))
-) { randombytes(out, outlen); }
+) { return randombytes(out, outlen); }
 #endif /* !MLD_CONFIG_CUSTOM_RANDOMBYTES */
 #endif /* !MLD_CONFIG_NO_RANDOMIZED_API */
 #endif /* !MLD_RANDOMBYTES_H */