xref: /src/tests/lib/libc/gen/t_vis.c

/*	$NetBSD: t_vis.c,v 1.12 2023/08/12 12:46:16 riastradh Exp $	*/

/*-
 * Copyright (c) 2002 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code was contributed to The NetBSD Foundation by Christos Zoulas.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <atf-c.h>

#include <string.h>
#include <stdlib.h>
#include <locale.h>
#include <err.h>
#include <vis.h>

static int styles[] = {
	VIS_OCTAL,
	VIS_CSTYLE,
	VIS_SP,
	VIS_TAB,
	VIS_NL,
	VIS_WHITE,
	VIS_SAFE,
#if 0	/* Not reversible */
	VIS_NOSLASH,
#endif
	VIS_HTTP1808,
	VIS_MIMESTYLE,
#if 0	/* Not supported by vis(3) */
	VIS_HTTP1866,
#endif
};

#define SIZE	256

ATF_TC(strvis_basic);
ATF_TC_HEAD(strvis_basic, tc)
{

	atf_tc_set_md_var(tc, "descr", "Test strvis(3)");
}

ATF_TC_BODY(strvis_basic, tc)
{
	char *srcbuf, *dstbuf, *visbuf;
	unsigned int i, j;

	ATF_REQUIRE((dstbuf = malloc(SIZE)) != NULL);
	ATF_REQUIRE((srcbuf = malloc(SIZE)) != NULL);
	ATF_REQUIRE((visbuf = malloc(SIZE * 4 + 1)) != NULL);

	for (i = 0; i < SIZE; i++)
		srcbuf[i] = (char)i;

	for (i = 0; i < __arraycount(styles); i++) {
		ATF_REQUIRE(strsvisx(visbuf, srcbuf, SIZE, styles[i], "") > 0);
		memset(dstbuf, 0, SIZE);
		ATF_REQUIRE(strunvisx(dstbuf, visbuf,
		    styles[i] & (VIS_HTTP1808|VIS_MIMESTYLE)) > 0);
		for (j = 0; j < SIZE; j++)
			if (dstbuf[j] != (char)j)
				atf_tc_fail_nonfatal("Failed for style %x, "
				    "char %d [%d]", styles[i], j, dstbuf[j]);
	}
	free(dstbuf);
	free(srcbuf);
	free(visbuf);
}

ATF_TC(strvis_null);
ATF_TC_HEAD(strvis_null, tc)
{
	atf_tc_set_md_var(tc, "descr", "Test strvis(3) NULL");
}

ATF_TC_BODY(strvis_null, tc)
{
	char dst[] = "fail";
	strvis(dst, NULL, VIS_SAFE);
	ATF_REQUIRE(dst[0] == '\0' && dst[1] == 'a');
}

ATF_TC(strvis_empty);
ATF_TC_HEAD(strvis_empty, tc)
{
	atf_tc_set_md_var(tc, "descr", "Test strvis(3) empty");
}

ATF_TC_BODY(strvis_empty, tc)
{
	char dst[] = "fail";
	strvis(dst, "", VIS_SAFE);
	ATF_REQUIRE(dst[0] == '\0' && dst[1] == 'a');
}

ATF_TC(strnvis_empty_empty);
ATF_TC_HEAD(strnvis_empty_empty, tc)
{
	atf_tc_set_md_var(tc, "descr",
	    "Test strnvis(3) with empty source and destination");
}

ATF_TC_BODY(strnvis_empty_empty, tc)
{
	char dst[] = "fail";
	int n;

	atf_tc_expect_fail("PR lib/57573: Overflow possibilities in vis(3)");

	n = strnvis(dst, 0, "", VIS_SAFE);
	ATF_CHECK(memcmp(dst, "fail", sizeof(dst)) == 0);
	ATF_CHECK_EQ_MSG(n, -1, "n=%d", n);
}

ATF_TC(strunvis_hex);
ATF_TC_HEAD(strunvis_hex, tc)
{
	atf_tc_set_md_var(tc, "descr", "Test strunvis(3) \\xXX");
}

ATF_TC_BODY(strunvis_hex, tc)
{
	static const struct {
		const char *e;
		const char *d;
		int error;
	} ed[] = {
		{ "\\xff", "\xff", 1 },
		{ "\\x1", "\x1", 1 },
		{ "\\x1\\x02", "\x1\x2", 2 },
		{ "\\x1x", "\x1x", 2 },
		{ "\\xx", "", -1 },
	};
	char uv[10];

	for (size_t i = 0; i < __arraycount(ed); i++) {
		ATF_REQUIRE(strunvis(uv, ed[i].e) == ed[i].error);
		if (ed[i].error > 0)
			ATF_REQUIRE(memcmp(ed[i].d, uv, ed[i].error) == 0);
	}
}

#ifdef VIS_NOLOCALE
ATF_TC(strvis_locale);
ATF_TC_HEAD(strvis_locale, tc)
{
	atf_tc_set_md_var(tc, "descr", "Test strvis(3) with locale");
}

ATF_TC_BODY(strvis_locale, tc)
{
	char s[256], cd[sizeof(s) * 4 + 1], jd[sizeof(cd)], *ol;
	int jr, cr;

	for (size_t i = 0; i < sizeof(s) - 1; i++)
		s[i] = i + 1;
	s[sizeof(s) - 1] = '\0';

	ol = setlocale(LC_CTYPE, "ja_JP.UTF-8");
	ATF_REQUIRE(ol != NULL);
	jr = strvisx(jd, s, sizeof(s), VIS_WHITE | VIS_NOLOCALE);
	ATF_REQUIRE(jr != -1);
	ol = strdup(ol);
	ATF_REQUIRE(ol != NULL);
	ATF_REQUIRE(setlocale(LC_CTYPE, "C") != NULL);
	cr = strvisx(cd, s, sizeof(s), VIS_WHITE);
	ATF_REQUIRE(jr == cr);
	ATF_REQUIRE(memcmp(jd, cd, jr) == 0);
	setlocale(LC_CTYPE, ol);
	free(ol);
}
#endif /* VIS_NOLOCALE */

#define	STRVIS_OVERFLOW_MARKER	((char)0xff)	/* Arbitrary */

#ifdef VIS_NOLOCALE
ATF_TC(strvis_overflow_mb);
ATF_TC_HEAD(strvis_overflow_mb, tc)
{
	atf_tc_set_md_var(tc, "descr", "Test strvis(3) multi-byte overflow");
}

ATF_TC_BODY(strvis_overflow_mb, tc)
{
	const char src[] = "\xf0\x9f\xa5\x91";
	/* Extra byte to detect overflow */
	char dst[sizeof(src) + 1];
	unsigned i;
	int n;

	atf_tc_expect_fail("PR lib/57573: Overflow possibilities in vis(3)");

	setlocale(LC_CTYPE, "en_US.UTF-8");

	for (i = 0; i < sizeof(dst) - 1; i++) {
		memset(dst, STRVIS_OVERFLOW_MARKER, sizeof(dst));
		n = strnvis(dst, i, src, VIS_SAFE);
		ATF_CHECK_EQ_MSG(dst[i], STRVIS_OVERFLOW_MARKER,
		    "[%u] dst=[%02hhx %02hhx %02hhx %02hhx %02hhx]"
		    " STRVIS_OVERFLOW_MARKER=%02hhx",
		    i, dst[0], dst[1], dst[2], dst[3], dst[4],
		    STRVIS_OVERFLOW_MARKER);
		ATF_CHECK_EQ_MSG(n, -1, "[%u] n=%d", i, n);
	}

	memset(dst, STRVIS_OVERFLOW_MARKER, sizeof(dst));
	n = strnvis(dst, sizeof(dst) - 1, src, VIS_SAFE);
	ATF_CHECK_EQ_MSG(dst[sizeof(dst) - 1], STRVIS_OVERFLOW_MARKER,
	    "[%u] dst=[%02hhx %02hhx %02hhx %02hhx %02hhx %02hhx]"
	    " STRVIS_OVERFLOW_MARKER=%02hhx",
	    i, dst[0], dst[1], dst[2], dst[3], dst[4], dst[5],
	    STRVIS_OVERFLOW_MARKER);
	ATF_CHECK_EQ_MSG(n, (int)sizeof(dst) - 2, "n=%d", n);
}
#endif

ATF_TC(strvis_overflow_c);
ATF_TC_HEAD(strvis_overflow_c, tc)
{
	atf_tc_set_md_var(tc, "descr", "Test strvis(3) C locale overflow");
}

ATF_TC_BODY(strvis_overflow_c, tc)
{
	const char src[] = "AAAA";
	/* Extra byte to detect overflow */
	char dst[sizeof(src) + 1];
	unsigned i;
	int n;

	atf_tc_expect_fail("PR lib/57573: Overflow possibilities in vis(3)");

	for (i = 0; i < sizeof(dst) - 1; i++) {
		memset(dst, STRVIS_OVERFLOW_MARKER, sizeof(dst));
		n = strnvis(dst, i, src, VIS_SAFE | VIS_NOLOCALE);
		ATF_CHECK_EQ_MSG(dst[i], STRVIS_OVERFLOW_MARKER,
		    "[%u] dst=[%02hhx %02hhx %02hhx %02hhx %02hhx]"
		    " STRVIS_OVERFLOW_MARKER=%02hhx",
		    i, dst[0], dst[1], dst[2], dst[3], dst[4],
		    STRVIS_OVERFLOW_MARKER);
		ATF_CHECK_EQ_MSG(n, -1, "[%u] n=%d", i, n);
	}

	memset(dst, STRVIS_OVERFLOW_MARKER, sizeof(dst));
	n = strnvis(dst, sizeof(dst) - 1, src, VIS_SAFE | VIS_NOLOCALE);
	ATF_CHECK_EQ_MSG(dst[sizeof(dst) - 1], STRVIS_OVERFLOW_MARKER,
	    "[%u] dst=[%02hhx %02hhx %02hhx %02hhx %02hhx %02hhx]"
	    " STRVIS_OVERFLOW_MARKER=%02hhx",
	    i, dst[0], dst[1], dst[2], dst[3], dst[4], dst[5],
	    STRVIS_OVERFLOW_MARKER);
	ATF_CHECK_EQ_MSG(n, (int)sizeof(dst) - 2, "n=%d", n);
}

ATF_TP_ADD_TCS(tp)
{

	ATF_TP_ADD_TC(tp, strvis_basic);
	ATF_TP_ADD_TC(tp, strvis_null);
	ATF_TP_ADD_TC(tp, strvis_empty);
	ATF_TP_ADD_TC(tp, strnvis_empty_empty);
	ATF_TP_ADD_TC(tp, strunvis_hex);
#ifdef VIS_NOLOCALE
	ATF_TP_ADD_TC(tp, strvis_locale);
	ATF_TP_ADD_TC(tp, strvis_overflow_mb);
#endif /* VIS_NOLOCALE */
	ATF_TP_ADD_TC(tp, strvis_overflow_c);

	return atf_no_error();
}