test_openvpnserv.c

Go to the documentation of this file.

/*
 *  OpenVPN -- An application to securely tunnel IP networks
 *             over a single UDP port, with support for SSL/TLS-based
 *             session authentication and key exchange,
 *             packet encryption, packet authentication, and
 *             packet compression.
 *
 *  Copyright (C) 2025 Frank Lichtenheld <frank@lichtenheld.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by the
 *  Free Software Foundation, either version 2 of the License,
 *  or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, see <https://www.gnu.org/licenses/>.
 */
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
#include <setjmp.h>
#include <cmocka.h>
#include "test_common.h"
 
#include <winsock2.h>
#include <windows.h>
 
#include "interactive.c"
 
BOOL
ReportStatusToSCMgr(SERVICE_STATUS_HANDLE service, SERVICE_STATUS *status)
{
    return TRUE;
}
 
static void
test_list_contains_domain(void **state)
{
    PCWSTR domain = L"openvpn.net";
    size_t domain_len = wcslen(domain);
    assert_true(ListContainsDomain(domain, domain, domain_len));
    assert_true(ListContainsDomain(L"openvpn.com,openvpn.net", domain, domain_len));
    assert_true(ListContainsDomain(L"openvpn.net,openvpn.com", domain, domain_len));
    assert_true(ListContainsDomain(L"openvpn.org,openvpn.net,openvpn.com", domain, domain_len));
 
    assert_false(ListContainsDomain(L"openvpn.com", domain, domain_len));
    assert_false(ListContainsDomain(L"internal.openvpn.net", domain, domain_len));
    assert_false(ListContainsDomain(L"openvpn.com,internal.openvpn.net", domain, domain_len));
    assert_false(ListContainsDomain(L"internal.openvpn.net,openvpn.com", domain, domain_len));
}
 
#define BUF_SIZE 64
static void
test_convert_itf_dns_domains(void **state)
{
    DWORD size, len;
    LSTATUS err;
    const DWORD glyph_size = sizeof(wchar_t);
 
    /* Remove the domain from a single-entry list */
    wchar_t domains_0[BUF_SIZE] = L"openvpn.com";
    len = (DWORD)wcslen(domains_0) + 1;
    size = len * glyph_size;
    err = ConvertItfDnsDomains(L"openvpn.com", domains_0, &size, sizeof(domains_0));
    assert_int_equal(size, 0);
    assert_int_equal(err, ERROR_FILE_NOT_FOUND);
 
    /* Remove no domain from a single-entry list */
    wchar_t domains_1[BUF_SIZE] = L"openvpn.com";
    len = (DWORD)wcslen(domains_1) + 1;
    size = len * glyph_size;
    wchar_t domains_1_res[] = L".openvpn.com\0";
    err = ConvertItfDnsDomains(L"openvpn.net", domains_1, &size, sizeof(domains_1));
    assert_memory_equal(domains_1, domains_1_res, size);
    assert_int_equal(size, sizeof(domains_1_res));
    assert_int_equal(err, NO_ERROR);
 
    /* Remove the second domain from a two-entry list */
    wchar_t domains_2[BUF_SIZE] = L"openvpn.com,openvpn.net";
    len = (DWORD)wcslen(domains_2) + 1;
    size = len * glyph_size;
    wchar_t domains_2_res[] = L".openvpn.com\0";
    err = ConvertItfDnsDomains(L"openvpn.net", domains_2, &size, sizeof(domains_2));
    assert_memory_equal(domains_2, domains_2_res, size);
    assert_int_equal(size, sizeof(domains_2_res));
    assert_int_equal(err, NO_ERROR);
 
    /* Remove the first domain from a two-entry list */
    wchar_t domains_3[BUF_SIZE] = L"openvpn.com,openvpn.net";
    len = (DWORD)wcslen(domains_3) + 1;
    size = len * glyph_size;
    wchar_t domains_3_res[] = L".openvpn.net\0";
    err = ConvertItfDnsDomains(L"openvpn.com", domains_3, &size, sizeof(domains_3));
    assert_memory_equal(domains_3, domains_3_res, size);
    assert_int_equal(size, sizeof(domains_3_res));
    assert_int_equal(err, NO_ERROR);
 
    /* Remove no domain from a two-entry list */
    wchar_t domains_4[BUF_SIZE] = L"openvpn.com,openvpn.net";
    len = (DWORD)wcslen(domains_4) + 1;
    size = len * glyph_size;
    wchar_t domains_4_res[] = L".openvpn.com\0.openvpn.net\0";
    err = ConvertItfDnsDomains(NULL, domains_4, &size, sizeof(domains_4));
    assert_memory_equal(domains_4, domains_4_res, size);
    assert_int_equal(size, sizeof(domains_4_res));
    assert_int_equal(err, NO_ERROR);
 
    /* Remove the first domain from a three-entry list */
    wchar_t domains_5[BUF_SIZE] = L"openvpn.com,openvpn.net,openvpn.org";
    len = (DWORD)wcslen(domains_5) + 1;
    size = len * glyph_size;
    wchar_t domains_5_res[] = L".openvpn.net\0.openvpn.org\0";
    err = ConvertItfDnsDomains(L"openvpn.com", domains_5, &size, sizeof(domains_5));
    assert_memory_equal(domains_5, domains_5_res, size);
    assert_int_equal(size, sizeof(domains_5_res));
    assert_int_equal(err, NO_ERROR);
 
    /* Remove the middle domain from a three-entry list */
    wchar_t domains_6[BUF_SIZE] = L"openvpn.com,openvpn.net,openvpn.org";
    len = (DWORD)wcslen(domains_6) + 1;
    size = len * glyph_size;
    wchar_t domains_6_res[] = L".openvpn.com\0.openvpn.org\0";
    err = ConvertItfDnsDomains(L"openvpn.net", domains_6, &size, sizeof(domains_6));
    assert_memory_equal(domains_6, domains_6_res, size);
    assert_int_equal(size, sizeof(domains_6_res));
    assert_int_equal(err, NO_ERROR);
 
    /* Remove the last domain from a three-entry list */
    wchar_t domains_7[BUF_SIZE] = L"openvpn.com,openvpn.net,openvpn.org";
    len = (DWORD)wcslen(domains_7) + 1;
    size = len * glyph_size;
    wchar_t domains_7_res[] = L".openvpn.com\0.openvpn.net\0";
    err = ConvertItfDnsDomains(L"openvpn.org", domains_7, &size, sizeof(domains_7));
    assert_memory_equal(domains_7, domains_7_res, size);
    assert_int_equal(size, sizeof(domains_7_res));
    assert_int_equal(err, NO_ERROR);
 
    /* Remove the last domain from a four-entry list because of size constraints*/
    wchar_t domains_8[BUF_SIZE] = L"openvpn.com,openvpn.net,openvpn.org,am-ende-noch-eine-lange.de";
    len = (DWORD)wcslen(domains_8) + 1;
    size = len * glyph_size;
    wchar_t domains_8_res[] = L".openvpn.com\0.openvpn.net\0.openvpn.org\0";
    err = ConvertItfDnsDomains(NULL, domains_8, &size, sizeof(domains_8));
    assert_memory_equal(domains_8, domains_8_res, size);
    assert_int_equal(size, sizeof(domains_8_res));
    assert_int_equal(err, ERROR_MORE_DATA);
}
 
static void
test_append_search_list(void **state)
{
    WCHAR list[64];
 
    /* append to an empty list */
    wcscpy(list, L"");
    assert_true(AppendSearchList(list, _countof(list), L"a.com"));
    assert_int_equal(wcscmp(list, L"a.com"), 0);
 
    /* append to a non-empty list */
    wcscpy(list, L"x.com");
    assert_true(AppendSearchList(list, _countof(list), L"a.com,b.com"));
    assert_int_equal(wcscmp(list, L"x.com,a.com,b.com"), 0);
 
    /* appending an empty string is a no-op */
    wcscpy(list, L"x.com");
    assert_true(AppendSearchList(list, _countof(list), L""));
    assert_int_equal(wcscmp(list, L"x.com"), 0);
 
    /* duplicates are allowed -- relied on by the multiset-aware remove */
    wcscpy(list, L"x.com");
    assert_true(AppendSearchList(list, _countof(list), L"x.com"));
    assert_int_equal(wcscmp(list, L"x.com,x.com"), 0);
 
    /* overflow: the list is left unchanged */
    WCHAR tiny[8];
    wcscpy(tiny, L"abc");
    assert_false(AppendSearchList(tiny, _countof(tiny), L"long.example.com"));
    assert_int_equal(wcscmp(tiny, L"abc"), 0);
}
 
static void
test_remove_search_list_tokens(void **state)
{
    WCHAR list[256];
 
    /* substring rejection: removing "vpn.corp.local" does NOT touch
     * "test.vpn.corp.local" -- the original wcsstr-based code did. */
    wcscpy(list, L"test.vpn.corp.local,other.com,vpn.corp.local");
    assert_int_equal(RemoveSearchListTokens(list, L"vpn.corp.local"), 1);
    assert_int_equal(wcscmp(list, L"test.vpn.corp.local,other.com"), 0);
 
    /* multiset semantics: one undo token removes one occurrence */
    wcscpy(list, L"corp.local,corp.local");
    assert_int_equal(RemoveSearchListTokens(list, L"corp.local"), 1);
    assert_int_equal(wcscmp(list, L"corp.local"), 0);
 
    /* removal targets the LAST occurrence so a pre-existing prefix is
     * preserved: with initial list "a,b" a VPN append yields "a,b,a";
     * removing "a" must restore "a,b" (not "b,a") so the result matches
     * the stored initial snapshot and a full reset can be triggered */
    wcscpy(list, L"a,b,a");
    assert_int_equal(RemoveSearchListTokens(list, L"a"), 1);
    assert_int_equal(wcscmp(list, L"a,b"), 0);
 
    /* multiple removes, mixed positions */
    wcscpy(list, L"a,b,c,d");
    assert_int_equal(RemoveSearchListTokens(list, L"b,d"), 2);
    assert_int_equal(wcscmp(list, L"a,c"), 0);
 
    /* no matches: list unchanged */
    wcscpy(list, L"a,b,c");
    assert_int_equal(RemoveSearchListTokens(list, L"x,y"), 0);
    assert_int_equal(wcscmp(list, L"a,b,c"), 0);
 
    /* head removal */
    wcscpy(list, L"a,b,c");
    assert_int_equal(RemoveSearchListTokens(list, L"a"), 1);
    assert_int_equal(wcscmp(list, L"b,c"), 0);
 
    /* tail removal */
    wcscpy(list, L"a,b,c");
    assert_int_equal(RemoveSearchListTokens(list, L"c"), 1);
    assert_int_equal(wcscmp(list, L"a,b"), 0);
 
    /* remove every token */
    wcscpy(list, L"a,b");
    assert_int_equal(RemoveSearchListTokens(list, L"a,b"), 2);
    assert_int_equal(wcscmp(list, L""), 0);
 
    /* duplicate undo tokens drain multiple occurrences */
    wcscpy(list, L"x,x,x");
    assert_int_equal(RemoveSearchListTokens(list, L"x,x"), 2);
    assert_int_equal(wcscmp(list, L"x"), 0);
 
    /* asking to remove more than is present only removes what's there */
    wcscpy(list, L"x");
    assert_int_equal(RemoveSearchListTokens(list, L"x,x,x"), 1);
    assert_int_equal(wcscmp(list, L""), 0);
 
    /* empty list */
    wcscpy(list, L"");
    assert_int_equal(RemoveSearchListTokens(list, L"a"), 0);
    assert_int_equal(wcscmp(list, L""), 0);
 
    /* empty remove */
    wcscpy(list, L"a,b");
    assert_int_equal(RemoveSearchListTokens(list, L""), 0);
    assert_int_equal(wcscmp(list, L"a,b"), 0);
 
    /* stray empty tokens in the list are tolerated -- the splice only
     * touches the token being removed (and one adjacent comma) */
    wcscpy(list, L"a,,b");
    assert_int_equal(RemoveSearchListTokens(list, L"b"), 1);
    assert_int_equal(wcscmp(list, L"a,"), 0);
}
 
int
wmain(void)
{
    openvpn_unit_test_setup();
    const struct CMUnitTest tests[] = {
        cmocka_unit_test(test_list_contains_domain),
        cmocka_unit_test(test_convert_itf_dns_domains),
        cmocka_unit_test(test_append_search_list),
        cmocka_unit_test(test_remove_search_list_tokens),
    };
 
    int ret = cmocka_run_group_tests_name("openvpnserv tests", tests, NULL, NULL);
 
    return ret;
}