mirror of
https://gitlab.isc.org/isc-projects/bind9
synced 2025-09-16 20:55:06 +00:00
All unit tests define the UNIT_TESTING macro, which causes <cmocka.h> to replace malloc(), calloc(), realloc(), and free() with its own functions tracking memory allocations. In order for this not to break compilation, the system header declaring the prototypes for these standard functions must be included before <cmocka.h>. Normally, these prototypes are only present in <stdlib.h>, so we make sure it is included before <cmocka.h>. However, musl libc also defines the prototypes for calloc() and free() in <sched.h>, which is included by <pthread.h>, which is included e.g. by <isc/mutex.h>. Thus, unit tests including "dnstest.h" (which includes <isc/mem.h>, which includes <isc/mutex.h>) after <cmocka.h> will not compile with musl libc as for these programs, <sched.h> will be included after <cmocka.h>. Always including <cmocka.h> after all other header files is not a feasible solution as that causes the mock assertion macros defined in <isc/util.h> to mangle the contents of <cmocka.h>, thus breaking compilation. We cannot really use the __noreturn__ or analyzer_noreturn attributes with cmocka assertion functions because they do return if the tested condition is true. The problem is that what BIND unit tests do is incompatible with Clang Static Analyzer's assumptions: since we use cmocka, our custom assertion handlers are present in a shared library (i.e. it is the cmocka library that checks the assertion condition, not a macro in unit test code). Redefining cmocka's assertion macros in <isc/util.h> is an ugly hack to overcome that problem - unfortunately, this is the only way we can think of to make Clang Static Analyzer properly process unit test code. Giving up on Clang Static Analyzer being able to properly process unit test code is not a satisfactory solution. Undefining _GNU_SOURCE for unit test code could work around the problem (musl libc's <sched.h> only defines the prototypes for calloc() and free() when _GNU_SOURCE is defined), but doing that could introduce discrepancies for unit tests including entire *.c files, so it is also not a good solution. All in all, including <sched.h> before <cmocka.h> for all affected unit tests seems to be the most benign way of working around this musl libc quirk. While quite an ugly solution, it achieves our goals here, which are to keep the benefit of proper static analysis of unit test code and to fix compilation against musl libc.
242 lines
5.2 KiB
C
242 lines
5.2 KiB
C
/*
|
|
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* See the COPYRIGHT file distributed with this work for additional
|
|
* information regarding copyright ownership.
|
|
*/
|
|
|
|
#if HAVE_CMOCKA
|
|
|
|
#include <stdarg.h>
|
|
#include <stddef.h>
|
|
#include <setjmp.h>
|
|
|
|
#include <inttypes.h>
|
|
#include <sched.h> /* IWYU pragma: keep */
|
|
#include <stdbool.h>
|
|
#include <stdlib.h>
|
|
#include <unistd.h>
|
|
|
|
#define UNIT_TESTING
|
|
#include <cmocka.h>
|
|
|
|
#include <isc/util.h>
|
|
#include <isc/buffer.h>
|
|
|
|
#include <dns/nsec3.h>
|
|
#include <dns/private.h>
|
|
#include <dns/rdataclass.h>
|
|
#include <dns/rdatatype.h>
|
|
|
|
#include <dst/dst.h>
|
|
|
|
#include "dnstest.h"
|
|
|
|
static dns_rdatatype_t privatetype = 65534;
|
|
|
|
static int
|
|
_setup(void **state) {
|
|
isc_result_t result;
|
|
|
|
UNUSED(state);
|
|
|
|
result = dns_test_begin(NULL, false);
|
|
assert_int_equal(result, ISC_R_SUCCESS);
|
|
|
|
return (0);
|
|
}
|
|
|
|
static int
|
|
_teardown(void **state) {
|
|
UNUSED(state);
|
|
|
|
dns_test_end();
|
|
|
|
return (0);
|
|
}
|
|
|
|
typedef struct {
|
|
unsigned char alg;
|
|
dns_keytag_t keyid;
|
|
bool remove;
|
|
bool complete;
|
|
} signing_testcase_t;
|
|
|
|
typedef struct {
|
|
unsigned char hash;
|
|
unsigned char flags;
|
|
unsigned int iterations;
|
|
unsigned long salt;
|
|
bool remove;
|
|
bool pending;
|
|
bool nonsec;
|
|
} nsec3_testcase_t;
|
|
|
|
static void
|
|
make_signing(signing_testcase_t *testcase, dns_rdata_t *private,
|
|
unsigned char *buf, size_t len)
|
|
{
|
|
dns_rdata_init(private);
|
|
|
|
buf[0] = testcase->alg;
|
|
buf[1] = (testcase->keyid & 0xff00) >> 8;
|
|
buf[2] = (testcase->keyid & 0xff);
|
|
buf[3] = testcase->remove;
|
|
buf[4] = testcase->complete;
|
|
private->data = buf;
|
|
private->length = len;
|
|
private->type = privatetype;
|
|
private->rdclass = dns_rdataclass_in;
|
|
}
|
|
|
|
static void
|
|
make_nsec3(nsec3_testcase_t *testcase, dns_rdata_t *private,
|
|
unsigned char *pbuf)
|
|
{
|
|
dns_rdata_nsec3param_t params;
|
|
dns_rdata_t nsec3param = DNS_RDATA_INIT;
|
|
unsigned char bufdata[BUFSIZ];
|
|
isc_buffer_t buf;
|
|
uint32_t salt;
|
|
unsigned char *sp;
|
|
int slen = 4;
|
|
|
|
/* for simplicity, we're using a maximum salt length of 4 */
|
|
salt = htonl(testcase->salt);
|
|
sp = (unsigned char *) &salt;
|
|
while (slen > 0 && *sp == '\0') {
|
|
slen--;
|
|
sp++;
|
|
}
|
|
|
|
params.common.rdclass = dns_rdataclass_in;
|
|
params.common.rdtype = dns_rdatatype_nsec3param;
|
|
params.hash = testcase->hash;
|
|
params.iterations = testcase->iterations;
|
|
params.salt = sp;
|
|
params.salt_length = slen;
|
|
|
|
params.flags = testcase->flags;
|
|
if (testcase->remove) {
|
|
params.flags |= DNS_NSEC3FLAG_REMOVE;
|
|
if (testcase->nonsec) {
|
|
params.flags |= DNS_NSEC3FLAG_NONSEC;
|
|
}
|
|
} else {
|
|
params.flags |= DNS_NSEC3FLAG_CREATE;
|
|
if (testcase->pending) {
|
|
params.flags |= DNS_NSEC3FLAG_INITIAL;
|
|
}
|
|
}
|
|
|
|
isc_buffer_init(&buf, bufdata, sizeof(bufdata));
|
|
dns_rdata_fromstruct(&nsec3param, dns_rdataclass_in,
|
|
dns_rdatatype_nsec3param, ¶ms, &buf);
|
|
|
|
dns_rdata_init(private);
|
|
|
|
dns_nsec3param_toprivate(&nsec3param, private, privatetype,
|
|
pbuf, DNS_NSEC3PARAM_BUFFERSIZE + 1);
|
|
}
|
|
|
|
/* convert private signing records to text */
|
|
static void
|
|
private_signing_totext_test(void **state) {
|
|
dns_rdata_t private;
|
|
int i;
|
|
|
|
signing_testcase_t testcases[] = {
|
|
{ DST_ALG_RSASHA512, 12345, 0, 0 },
|
|
{ DST_ALG_RSASHA256, 54321, 1, 0 },
|
|
{ DST_ALG_NSEC3RSASHA1, 22222, 0, 1 },
|
|
{ DST_ALG_RSASHA1, 33333, 1, 1 }
|
|
};
|
|
const char *results[] = {
|
|
"Signing with key 12345/RSASHA512",
|
|
"Removing signatures for key 54321/RSASHA256",
|
|
"Done signing with key 22222/NSEC3RSASHA1",
|
|
"Done removing signatures for key 33333/RSASHA1"
|
|
};
|
|
int ncases = 4;
|
|
|
|
UNUSED(state);
|
|
|
|
for (i = 0; i < ncases; i++) {
|
|
unsigned char data[5];
|
|
char output[BUFSIZ];
|
|
isc_buffer_t buf;
|
|
|
|
isc_buffer_init(&buf, output, sizeof(output));
|
|
|
|
make_signing(&testcases[i], &private, data, sizeof(data));
|
|
dns_private_totext(&private, &buf);
|
|
assert_string_equal(output, results[i]);
|
|
}
|
|
|
|
}
|
|
|
|
/* convert private chain records to text */
|
|
static void
|
|
private_nsec3_totext_test(void **state) {
|
|
dns_rdata_t private;
|
|
int i;
|
|
|
|
nsec3_testcase_t testcases[] = {
|
|
{ 1, 0, 1, 0xbeef, 0, 0, 0 },
|
|
{ 1, 1, 10, 0xdadd, 0, 0, 0 },
|
|
{ 1, 0, 20, 0xbead, 0, 1, 0 },
|
|
{ 1, 0, 30, 0xdeaf, 1, 0, 0 },
|
|
{ 1, 0, 100, 0xfeedabee, 1, 0, 1 },
|
|
};
|
|
const char *results[] = {
|
|
"Creating NSEC3 chain 1 0 1 BEEF",
|
|
"Creating NSEC3 chain 1 1 10 DADD",
|
|
"Pending NSEC3 chain 1 0 20 BEAD",
|
|
"Removing NSEC3 chain 1 0 30 DEAF / creating NSEC chain",
|
|
"Removing NSEC3 chain 1 0 100 FEEDABEE"
|
|
};
|
|
int ncases = 5;
|
|
|
|
UNUSED(state);
|
|
|
|
for (i = 0; i < ncases; i++) {
|
|
unsigned char data[DNS_NSEC3PARAM_BUFFERSIZE + 1];
|
|
char output[BUFSIZ];
|
|
isc_buffer_t buf;
|
|
|
|
isc_buffer_init(&buf, output, sizeof(output));
|
|
|
|
make_nsec3(&testcases[i], &private, data);
|
|
dns_private_totext(&private, &buf);
|
|
assert_string_equal(output, results[i]);
|
|
}
|
|
}
|
|
|
|
int
|
|
main(void) {
|
|
const struct CMUnitTest tests[] = {
|
|
cmocka_unit_test_setup_teardown(private_signing_totext_test,
|
|
_setup, _teardown),
|
|
cmocka_unit_test_setup_teardown(private_nsec3_totext_test,
|
|
_setup, _teardown),
|
|
};
|
|
|
|
return (cmocka_run_group_tests(tests, NULL, NULL));
|
|
}
|
|
|
|
#else /* HAVE_CMOCKA */
|
|
|
|
#include <stdio.h>
|
|
|
|
int
|
|
main(void) {
|
|
printf("1..0 # Skipped: cmocka not available\n");
|
|
return (0);
|
|
}
|
|
|
|
#endif
|