1 /*	$OpenBSD: mlkem_tests_util.h,v 1.4 2024/12/26 00:04:24 tb Exp $ */
2 /*
3  * Copyright (c) 2024 Bob Beck <beck@obtuse.com>
4  * Copyright (c) 2024 Theo Buehler <tb@openbsd.org>
5  *
6  * Permission to use, copy, modify, and/or distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
13  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
15  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
16  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 #ifndef MLKEM_TEST_UTIL_H
20 #define MLKEM_TEST_UTIL_H
21 
22 #include <stddef.h>
23 #include <stdint.h>
24 
25 #include "bytestring.h"
26 
27 #include "mlkem.h"
28 #include "mlkem_internal.h"
29 
30 int compare_data(const uint8_t *want, const uint8_t *got, size_t len,
31     const char *msg);
32 
33 int mlkem768_encode_private_key(const void *priv, uint8_t **out_buf,
34     size_t *out_len);
35 int mlkem768_encode_public_key(const void *pub, uint8_t **out_buf,
36     size_t *out_len);
37 int mlkem1024_encode_private_key(const void *priv, uint8_t **out_buf,
38     size_t *out_len);
39 int mlkem1024_encode_public_key(const void *pub, uint8_t **out_buf,
40     size_t *out_len);
41 
42 int mlkem768_decap(uint8_t out_shared_secret[MLKEM_SHARED_SECRET_BYTES],
43     const uint8_t *ciphertext, size_t ciphertext_len, const void *priv);
44 void mlkem768_encap(uint8_t *out_ciphertext,
45     uint8_t out_shared_secret[MLKEM_SHARED_SECRET_BYTES], const void *pub);
46 void mlkem768_encap_external_entropy(uint8_t *out_ciphertext,
47     uint8_t out_shared_secret[MLKEM_SHARED_SECRET_BYTES], const void *pub,
48     const uint8_t entropy[MLKEM_ENCAP_ENTROPY]);
49 void mlkem768_generate_key(uint8_t *out_encoded_public_key,
50     uint8_t optional_out_seed[MLKEM_SEED_BYTES], void *out_private_key);
51 void mlkem768_generate_key_external_entropy(uint8_t *out_encoded_public_key,
52     void *out_private_key, const uint8_t entropy[MLKEM_SEED_BYTES]);
53 int mlkem768_parse_private_key(void *priv, CBS *private_key_cbs);
54 int mlkem768_parse_public_key(void *pub, CBS *in);
55 void mlkem768_public_from_private(void *out_public_key, const void *private_key);
56 
57 int mlkem1024_decap(uint8_t out_shared_secret[MLKEM_SHARED_SECRET_BYTES],
58     const uint8_t *ciphertext, size_t ciphertext_len, const void *priv);
59 void mlkem1024_encap(uint8_t *out_ciphertext,
60     uint8_t out_shared_secret[MLKEM_SHARED_SECRET_BYTES], const void *pub);
61 void mlkem1024_encap_external_entropy(uint8_t *out_ciphertext,
62     uint8_t out_shared_secret[MLKEM_SHARED_SECRET_BYTES], const void *pub,
63     const uint8_t entropy[MLKEM_ENCAP_ENTROPY]);
64 void mlkem1024_generate_key(uint8_t *out_encoded_public_key,
65     uint8_t optional_out_seed[MLKEM_SEED_BYTES], void *out_private_key);
66 void mlkem1024_generate_key_external_entropy(uint8_t *out_encoded_public_key,
67     void *out_private_key, const uint8_t entropy[MLKEM_SEED_BYTES]);
68 int mlkem1024_parse_private_key(void *priv, CBS *private_key_cbs);
69 int mlkem1024_parse_public_key(void *pub, CBS *in);
70 void mlkem1024_public_from_private(void *out_public_key, const void *private_key);
71 
72 typedef int (*mlkem_encode_private_key_fn)(const void *, uint8_t **, size_t *);
73 typedef int (*mlkem_encode_public_key_fn)(const void *, uint8_t **, size_t *);
74 typedef int (*mlkem_decap_fn)(uint8_t [MLKEM_SHARED_SECRET_BYTES],
75     const uint8_t *, size_t, const void *);
76 typedef void (*mlkem_encap_fn)(uint8_t *, uint8_t [MLKEM_SHARED_SECRET_BYTES],
77     const void *);
78 typedef void (*mlkem_encap_external_entropy_fn)(uint8_t *,
79     uint8_t [MLKEM_SHARED_SECRET_BYTES], const void *,
80     const uint8_t [MLKEM_ENCAP_ENTROPY]);
81 typedef void (*mlkem_generate_key_fn)(uint8_t *, uint8_t *, void *);
82 typedef void (*mlkem_generate_key_external_entropy_fn)(uint8_t *, void *,
83     const uint8_t [MLKEM_SEED_BYTES]);
84 typedef int (*mlkem_parse_private_key_fn)(void *, CBS *);
85 typedef int (*mlkem_parse_public_key_fn)(void *, CBS *);
86 typedef void (*mlkem_public_from_private_fn)(void *out_public_key,
87     const void *private_key);
88 
89 #endif /* MLKEM_TEST_UTIL_H */
90