Skip to content

Commit 36a60e8

Browse files
author
Chandra Pratap
committed
fuzz-tests: Add a test for codex32 operations
Changelog-None: Add a test for `codex32_encode()` and `codex32_secret_decode()` defined in `common/codex32.{c, h}`.
1 parent c50bd38 commit 36a60e8

File tree

2 files changed

+189
-0
lines changed

2 files changed

+189
-0
lines changed

tests/fuzz/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ FUZZ_COMMON_OBJS := \
2929
common/close_tx.o \
3030
common/configdir.o \
3131
common/configvar.o \
32+
common/codex32.o \
3233
common/channel_id.o \
3334
common/channel_type.o \
3435
common/cryptomsg.o \

tests/fuzz/fuzz-codex32.c

Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
#include "config.h"
2+
#include <assert.h>
3+
#include <ccan/ccan/array_size/array_size.h>
4+
#include <ccan/ccan/tal/str/str.h>
5+
#include <common/setup.h>
6+
#include <common/bech32.h>
7+
#include <common/utils.h>
8+
#include <common/codex32.h>
9+
#include <tests/fuzz/libfuzz.h>
10+
11+
/* Default mutator defined by libFuzzer */
12+
size_t LLVMFuzzerMutate(uint8_t *data, size_t size, size_t max_size);
13+
size_t LLVMFuzzerCustomMutator(uint8_t *fuzz_data, size_t size, size_t max_size,
14+
unsigned int seed);
15+
size_t LLVMFuzzerCustomCrossOver(const u8 *in1, size_t in1_size, const u8 *in2,
16+
size_t in2_size, u8 *out, size_t max_out_size,
17+
unsigned seed);
18+
19+
static const char valid_hrp_chars[] = "acdefghjklmnpqrstuvwxyz";
20+
21+
/* Duplicate codex32 structure */
22+
static struct codex32 *codex32_dup(const tal_t *ctx, const struct codex32 *src)
23+
{
24+
struct codex32 *dup = tal(ctx, struct codex32);
25+
dup->hrp = tal_strdup(dup, src->hrp);
26+
dup->threshold = src->threshold;
27+
memcpy(dup->id, src->id, sizeof(dup->id));
28+
dup->share_idx = src->share_idx;
29+
dup->payload = tal_dup_arr(dup, u8, src->payload,
30+
tal_bytelen(src->payload), 0);
31+
dup->type = src->type;
32+
return dup;
33+
}
34+
35+
void init(int *argc, char ***argv)
36+
{
37+
common_setup("fuzzer");
38+
}
39+
40+
/* Custom mutator with structure-aware and byte-level mutations */
41+
size_t LLVMFuzzerCustomMutator(uint8_t *fuzz_data, size_t size,
42+
size_t max_size, unsigned int seed)
43+
{
44+
srand(seed);
45+
char *str = to_string(tmpctx, fuzz_data, size);
46+
char *fail;
47+
struct codex32 *parts = codex32_decode(tmpctx, NULL, str, &fail);
48+
49+
/* If valid, try structure-aware mutation */
50+
if (parts) {
51+
/* Mutate a random component */
52+
switch(rand() % 3) {
53+
case 0: /* Mutate threshold to any value */
54+
parts->threshold = rand();
55+
break;
56+
57+
case 1: /* Mutate ID arbitrarily */
58+
{
59+
size_t id_len = sizeof(parts->id) - 1;
60+
LLVMFuzzerMutate((u8 *)parts->id, id_len, id_len);
61+
parts->id[id_len] = '\0';
62+
}
63+
break;
64+
65+
case 2: /* Mutate payload */
66+
{
67+
size_t old_size = tal_bytelen(parts->payload);
68+
tal_resize(&parts->payload, max_size);
69+
size_t new_size = LLVMFuzzerMutate((u8 *)parts->payload, old_size, max_size);
70+
tal_resize(&parts->payload, new_size);
71+
}
72+
break;
73+
}
74+
75+
/* Always mutate the HRP to ensure it's valid for encoding. */
76+
char *new_hrp = tal_arr(parts, char, 3);
77+
new_hrp[0] = valid_hrp_chars[rand() % strlen(valid_hrp_chars)];
78+
new_hrp[1] = valid_hrp_chars[rand() % strlen(valid_hrp_chars)];
79+
new_hrp[2] = '\0';
80+
parts->hrp = new_hrp;
81+
82+
char *reencoded;
83+
const char *err = codex32_secret_encode(tmpctx, parts->hrp, parts->id,
84+
parts->threshold, parts->payload,
85+
tal_bytelen(parts->payload), &reencoded);
86+
if (!err) {
87+
size_t len = tal_bytelen(reencoded) - 1;
88+
if (len <= max_size) {
89+
memcpy(fuzz_data, reencoded, len);
90+
return len;
91+
}
92+
}
93+
}
94+
95+
/* Fallback: byte-level mutation */
96+
return LLVMFuzzerMutate(fuzz_data, size, max_size);
97+
}
98+
99+
/* Custom crossover with structure-aware recombination */
100+
size_t LLVMFuzzerCustomCrossOver(const u8 *in1, size_t in1_size, const u8 *in2, size_t in2_size,
101+
u8 *out, size_t max_out_size, unsigned seed)
102+
{
103+
srand(seed);
104+
char *str1 = to_string(tmpctx, in1, in1_size);
105+
char *str2 = to_string(tmpctx, in2, in2_size);
106+
char *fail;
107+
108+
/* Decode both inputs */
109+
struct codex32 *p1 = codex32_decode(tmpctx, NULL, str1, &fail);
110+
struct codex32 *p2 = codex32_decode(tmpctx, NULL, str2, &fail);
111+
112+
/* If both valid, try structure-aware crossover */
113+
if (p1 && p2) {
114+
/* Create child by combining parts */
115+
struct codex32 *child = codex32_dup(tmpctx, p1);
116+
117+
/* Choose crossover method */
118+
switch(rand() % 3) {
119+
case 0: /* Crossover threshold */
120+
child->threshold = p2->threshold;
121+
break;
122+
123+
case 1: /* Crossover ID */
124+
{
125+
size_t id_len = sizeof(p1->id) - 1;
126+
cross_over((const u8 *)p1->id, id_len, (const u8 *)p2->id, id_len,
127+
(u8 *)child->id, id_len, rand());
128+
child->id[id_len] = '\0';
129+
}
130+
break;
131+
132+
case 2: /* Crossover payload */
133+
{
134+
size_t p1_len = tal_bytelen(p1->payload);
135+
size_t p2_len = tal_bytelen(p2->payload);
136+
tal_resize(&child->payload, max_out_size);
137+
size_t new_payload_len = cross_over(p1->payload, p1_len,
138+
p2->payload, p2_len,
139+
(u8 *)child->payload, max_out_size, rand());
140+
tal_resize(&child->payload, new_payload_len);
141+
}
142+
break;
143+
}
144+
145+
/* Always crossover the HRP to ensure it's valid for encoding. */
146+
char *new_hrp = tal_arr(child, char, 3);
147+
new_hrp[0] = valid_hrp_chars[rand() % strlen(valid_hrp_chars)];
148+
new_hrp[1] = valid_hrp_chars[rand() % strlen(valid_hrp_chars)];
149+
new_hrp[2] = '\0';
150+
child->hrp = new_hrp;
151+
152+
char *reencoded;
153+
const char *err = codex32_secret_encode(tmpctx, child->hrp, child->id,
154+
child->threshold, child->payload,
155+
tal_bytelen(child->payload), &reencoded);
156+
if (!err) {
157+
size_t len = strlen(reencoded);
158+
if (len <= max_out_size) {
159+
memcpy(out, reencoded, len);
160+
return len;
161+
}
162+
}
163+
}
164+
165+
/* Fallback: byte-level crossover */
166+
return cross_over(in1, in1_size, in2, in2_size, out, max_out_size, seed);
167+
}
168+
169+
void run(const uint8_t *data, size_t size)
170+
{
171+
struct codex32 *c32;
172+
char *str, *fail, *bip93;
173+
174+
str = to_string(tmpctx, data, size);
175+
176+
c32 = codex32_decode(tmpctx, NULL, str, &fail);
177+
assert(c32 || fail);
178+
179+
/* codex32_decode can decode HRPs of any length, but codex32_encode
180+
* requires that strlen(HRP) == 2, so we enforce it here. */
181+
if (c32 && strlen(c32->hrp) == 2) {
182+
const char *ret = codex32_secret_encode(tmpctx, c32->hrp, c32->id, c32->threshold,
183+
c32->payload, tal_bytelen(c32->payload), &bip93);
184+
assert(!ret && bip93);
185+
}
186+
187+
clean_tmpctx();
188+
}

0 commit comments

Comments
 (0)