xref: /aosp_15_r20/external/boringssl/src/crypto/spx/address.h (revision 8fb009dc861624b67b6cdb62ea21f0f22d0c584b)
1 /* Copyright (c) 2023, Google LLC
2  *
3  * Permission to use, copy, modify, and/or distribute this software for any
4  * purpose with or without fee is hereby granted, provided that the above
5  * copyright notice and this permission notice appear in all copies.
6  *
7  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
10  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
12  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
13  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */
14 
15 #ifndef OPENSSL_HEADER_CRYPTO_SPX_ADDRESS_H
16 #define OPENSSL_HEADER_CRYPTO_SPX_ADDRESS_H
17 
18 #include <openssl/base.h>
19 
20 #if defined(__cplusplus)
21 extern "C" {
22 #endif
23 
24 
25 #define SPX_ADDR_TYPE_WOTS 0
26 #define SPX_ADDR_TYPE_WOTSPK 1
27 #define SPX_ADDR_TYPE_HASHTREE 2
28 #define SPX_ADDR_TYPE_FORSTREE 3
29 #define SPX_ADDR_TYPE_FORSPK 4
30 #define SPX_ADDR_TYPE_WOTSPRF 5
31 #define SPX_ADDR_TYPE_FORSPRF 6
32 
33 void spx_set_chain_addr(uint8_t addr[32], uint32_t chain);
34 void spx_set_hash_addr(uint8_t addr[32], uint32_t hash);
35 void spx_set_keypair_addr(uint8_t addr[32], uint32_t keypair);
36 void spx_set_layer_addr(uint8_t addr[32], uint32_t layer);
37 void spx_set_tree_addr(uint8_t addr[32], uint64_t tree);
38 void spx_set_type(uint8_t addr[32], uint32_t type);
39 void spx_set_tree_height(uint8_t addr[32], uint32_t tree_height);
40 void spx_set_tree_index(uint8_t addr[32], uint32_t tree_index);
41 void spx_copy_keypair_addr(uint8_t out[32], const uint8_t in[32]);
42 
43 uint32_t spx_get_tree_index(uint8_t addr[32]);
44 
45 
46 #if defined(__cplusplus)
47 }  // extern C
48 #endif
49 
50 #endif  // OPENSSL_HEADER_CRYPTO_SPX_ADDRESS_H
51