From: "flichtenheld (Code Review)"
Date: Tue, 12 Dec 2023 13:55:55 +0000
In-Reply-To:
References:
Reply-To: frank@...2641..., arne-openvpn@...1227...,
openvpn-devel@lists.sourceforge.net
Message-ID: <2730989c07f5d04f52d794b0492d0a2a1a7cb78f-EmailReplacePatchSet-HTML@...2715...>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Disposition: inline
Content-Type: multipart/alternative; boundary="QbTIR8Tg3iI="; charset=UTF-8
Subject: [Openvpn-devel] [L] Change in openvpn[master]: test_user_pass: new
UT for get_user_pass
List-Id:
List-Unsubscribe: ,
List-Archive:
List-Post:
List-Help:
List-Subscribe: ,
To: plaisthos
Cc: openvpn-devel
--QbTIR8Tg3iI=
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Attention is currently required from: plaisthos.
Hello plaisthos,
I'd like you to reexamine a change. Please visit
http://gerrit.openvpn.net/c/openvpn/+/468?usp=3Demail
to look at the new patch set (#4).
Change subject: test_user_pass: new UT for get_user_pass
......................................................................
test_user_pass: new UT for get_user_pass
UTs for basic functionality, without management functions.
v2:
- add CMake support
- add GHA support for both MSVC and mingw
v3:
- fix distcheck by adding input/ directory to dist
Change-Id: I193aef06912f01426dd4ac298aadfab97dd75a35
Signed-off-by: Frank Lichtenheld
---
M .github/workflows/build.yaml
M CMakeLists.txt
M src/openvpn/syshead.h
M tests/unit_tests/openvpn/Makefile.am
A tests/unit_tests/openvpn/input/user_only.txt
A tests/unit_tests/openvpn/input/user_pass.txt
A tests/unit_tests/openvpn/test_user_pass.c
7 files changed, 308 insertions(+), 2 deletions(-)
git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/68/468/4
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
index 4393f5c..784a844 100644
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@@ -85,11 +85,13 @@
fail-fast: false
matrix:
arch: [x86, x64]
- test: [argv, auth_token, buffer, cryptoapi, crypto, misc, ncp, pac=
ket_id, pkt, provider, tls_crypt]
+ test: [argv, auth_token, buffer, cryptoapi, crypto, misc, ncp, pac=
ket_id, pkt, provider, tls_crypt, user_pass]
runs-on: windows-latest
name: "mingw unittest ${{ matrix.test }} - ${{ matrix.arch }} - OSSL"
steps:
+ - name: Checkout OpenVPN
+ uses: actions/checkout@...2689...
- name: Retrieve mingw unittest
uses: actions/download-artifact@...2689...
with:
@@ -97,6 +99,8 @@
path: unittests
- name: Run ${{ matrix.test }} unit test
run: ./unittests/test_${{ matrix.test }}.exe
+ env:
+ srcdir: "${{ github.workspace }}/tests/unit_tests/openvpn"
ubuntu:
strategy:
@@ -279,6 +283,7 @@
configurePreset: win-${{ matrix.arch }}-release
buildPreset: win-${{ matrix.arch }}-release
testPreset: win-${{ matrix.arch }}-release
+ testPresetAdditionalArgs: "['--output-on-failure']"
- uses: actions/upload-artifact@...2689...
with:
diff --git a/CMakeLists.txt b/CMakeLists.txt
index d40b213..af891a5 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -587,6 +587,7 @@
"test_packet_id"
"test_pkt"
"test_provider"
+ "test_user_pass"
)
if (WIN32)
@@ -645,6 +646,10 @@
# test_networking needs special environment
if (NOT ${test_name} STREQUAL "test_networking")
add_test(${test_name} ${test_name})
+ # for compat with autotools make check
+ set(_UT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/tests/unit_test=
s/openvpn)
+ set_tests_properties(${test_name} PROPERTIES
+ ENVIRONMENT "srcdir=3D${_UT_SOURCE_DIR}")
endif ()
add_executable(${test_name}
tests/unit_tests/openvpn/${test_name}.c
@@ -739,6 +744,15 @@
src/openvpn/base64.c
)
+ target_sources(test_user_pass PRIVATE
+ tests/unit_tests/openvpn/mock_get_random.c
+ tests/unit_tests/openvpn/mock_win32_execve.c
+ src/openvpn/base64.c
+ src/openvpn/console.c
+ src/openvpn/env_set.c
+ src/openvpn/run_command.c
+ )
+
if (TARGET test_argv)
target_link_options(test_argv PRIVATE -Wl,--wrap=3Dparse_line)
target_sources(test_argv PRIVATE
diff --git a/src/openvpn/syshead.h b/src/openvpn/syshead.h
index 7181b94..d89d2b5 100644
--- a/src/openvpn/syshead.h
+++ b/src/openvpn/syshead.h
@@ -522,4 +522,10 @@
#define ENABLE_MEMSTATS
#endif
+#ifdef _MSC_VER
+#ifndef PATH_MAX
+#define PATH_MAX MAX_PATH
+#endif
+#endif
+
#endif /* ifndef SYSHEAD_H */
diff --git a/tests/unit_tests/openvpn/Makefile.am b/tests/unit_tests/openvp=
n/Makefile.am
index cecf4dc..342f428 100644
--- a/tests/unit_tests/openvpn/Makefile.am
+++ b/tests/unit_tests/openvpn/Makefile.am
@@ -1,5 +1,7 @@
AUTOMAKE_OPTIONS =3D foreign
+EXTRA_DIST =3D input
+
AM_TESTSUITE_SUMMARY_HEADER =3D ' for $(PACKAGE_STRING) Unit-Tests'
test_binaries=3D
@@ -9,7 +11,7 @@
endif
test_binaries +=3D crypto_testdriver packet_id_testdriver auth_token_testd=
river ncp_testdriver misc_testdriver \
- pkt_testdriver
+ pkt_testdriver user_pass_testdriver
if HAVE_LD_WRAP_SUPPORT
if !WIN32
test_binaries +=3D tls_crypt_testdriver
@@ -216,6 +218,22 @@
$(top_srcdir)/src/openvpn/base64.c
+user_pass_testdriver_CFLAGS =3D @TEST_CFLAGS@ \
+ -I$(top_srcdir)/include -I$(top_srcdir)/src/compat -I$(top_srcdir)/src/op=
envpn
+user_pass_testdriver_LDFLAGS =3D @TEST_LDFLAGS@
+
+user_pass_testdriver_SOURCES =3D test_user_pass.c mock_msg.c \
+ $(top_srcdir)/src/openvpn/buffer.c \
+ $(top_srcdir)/src/openvpn/console.c \
+ $(top_srcdir)/src/openvpn/env_set.c \
+ mock_win32_execve.c \
+ $(top_srcdir)/src/openvpn/run_command.c \
+ mock_get_random.c \
+ $(top_srcdir)/src/openvpn/platform.c \
+ $(top_srcdir)/src/openvpn/win32-util.c \
+ $(top_srcdir)/src/openvpn/base64.c
+
+
ncp_testdriver_CFLAGS =3D @TEST_CFLAGS@ \
-I$(top_srcdir)/include -I$(top_srcdir)/src/compat -I$(top_srcdir)/src/op=
envpn \
$(OPTIONAL_CRYPTO_CFLAGS)
diff --git a/tests/unit_tests/openvpn/input/user_only.txt b/tests/unit_test=
s/openvpn/input/user_only.txt
new file mode 100644
index 0000000..3ca0db3
--- /dev/null
+++ b/tests/unit_tests/openvpn/input/user_only.txt
@@ -0,0 +1 @@
+fuser
diff --git a/tests/unit_tests/openvpn/input/user_pass.txt b/tests/unit_test=
s/openvpn/input/user_pass.txt
new file mode 100644
index 0000000..31b38ef
--- /dev/null
+++ b/tests/unit_tests/openvpn/input/user_pass.txt
@@ -0,0 +1,2 @@
+fuser
+fpassword
diff --git a/tests/unit_tests/openvpn/test_user_pass.c b/tests/unit_tests/o=
penvpn/test_user_pass.c
new file mode 100644
index 0000000..ab4dfe4
--- /dev/null
+++ b/tests/unit_tests/openvpn/test_user_pass.c
@@ -0,0 +1,260 @@
+/*
+ * 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) 2023 OpenVPN Inc
+ *
+ * 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 t=
he
+ * 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, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#undef ENABLE_SYSTEMD
+
+#include "syshead.h"
+#include "manage.h"
+
+#include
+#include
+#include
+#include
+
+#include "misc.c"
+
+struct management *management; /* global */
+
+/* mocking */
+bool
+query_user_exec_builtin(void)
+{
+ /* Loop through configured query_user slots */
+ for (int i =3D 0; i < QUERY_USER_NUMSLOTS && query_user[i].response !=
=3D NULL; i++)
+ {
+ check_expected(query_user[i].prompt);
+ strncpy(query_user[i].response, mock_ptr_type(char *), query_user[=
i].response_len);
+ }
+
+ return mock();
+}
+void
+management_auth_failure(struct management *man, const char *type, const ch=
ar *reason)
+{
+ assert_true(0);
+}
+bool
+management_query_user_pass(struct management *man,
+ struct user_pass *up,
+ const char *type,
+ const unsigned int flags,
+ const char *static_challenge)
+{
+ assert_true(0);
+ return false;
+}
+/* stubs for some unused functions instead of pulling in too many dependen=
cies */
+int
+parse_line(const char *line, char **p, const int n, const char *file,
+ const int line_num, int msglevel, struct gc_arena *gc)
+{
+ assert_true(0);
+ return 0;
+}
+
+/* tooling */
+static void
+reset_user_pass(struct user_pass *up)
+{
+ up->defined =3D false;
+ up->token_defined =3D false;
+ up->nocache =3D false;
+ strcpy(up->username, "user");
+ strcpy(up->password, "password");
+}
+
+static void
+test_get_user_pass_defined(void **state)
+{
+ struct user_pass up =3D { 0 };
+ reset_user_pass(&up);
+ up.defined =3D true;
+ assert_true(get_user_pass_cr(&up, NULL, "UT", 0, NULL));
+}
+
+static void
+test_get_user_pass_needok(void **state)
+{
+ struct user_pass up =3D { 0 };
+ reset_user_pass(&up);
+ unsigned int flags =3D GET_USER_PASS_NEED_OK;
+
+ expect_string(query_user_exec_builtin, query_user[i].prompt, "NEED-OK|=
UT|user:");
+ will_return(query_user_exec_builtin, "");
+ will_return(query_user_exec_builtin, true);
+ /*FIXME: query_user_exec() called even though nothing queued */
+ will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, NULL, "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.password, "ok");
+
+ reset_user_pass(&up);
+
+ expect_string(query_user_exec_builtin, query_user[i].prompt, "NEED-OK|=
UT|user:");
+ will_return(query_user_exec_builtin, "cancel");
+ will_return(query_user_exec_builtin, true);
+ /*FIXME: query_user_exec() called even though nothing queued */
+ will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, NULL, "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.password, "cancel");
+}
+
+static void
+test_get_user_pass_inline_creds(void **state)
+{
+ struct user_pass up =3D { 0 };
+ reset_user_pass(&up);
+ unsigned int flags =3D GET_USER_PASS_INLINE_CREDS;
+
+ /*FIXME: query_user_exec() called even though nothing queued */
+ will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, "iuser\nipassword", "UT", flags, NUL=
L));
+ assert_true(up.defined);
+ assert_string_equal(up.username, "iuser");
+ assert_string_equal(up.password, "ipassword");
+
+ reset_user_pass(&up);
+
+ expect_string(query_user_exec_builtin, query_user[i].prompt, "Enter UT=
Password:");
+ will_return(query_user_exec_builtin, "cpassword");
+ will_return(query_user_exec_builtin, true);
+ /* will try to retrieve missing password from stdin */
+ assert_true(get_user_pass_cr(&up, "iuser", "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.username, "iuser");
+ assert_string_equal(up.password, "cpassword");
+
+ reset_user_pass(&up);
+
+ flags |=3D GET_USER_PASS_PASSWORD_ONLY;
+ /*FIXME: query_user_exec() called even though nothing queued */
+ will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, "ipassword\n", "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.username, "user");
+ assert_string_equal(up.password, "ipassword");
+
+ reset_user_pass(&up);
+
+ flags |=3D GET_USER_PASS_PASSWORD_ONLY;
+ expect_string(query_user_exec_builtin, query_user[i].prompt, "Enter UT=
Password:");
+ will_return(query_user_exec_builtin, "cpassword");
+ will_return(query_user_exec_builtin, true);
+ /* will try to retrieve missing password from stdin */
+ assert_true(get_user_pass_cr(&up, "", "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.username, "user");
+ assert_string_equal(up.password, "cpassword");
+}
+
+static void
+test_get_user_pass_authfile_stdin(void **state)
+{
+ struct user_pass up =3D { 0 };
+ reset_user_pass(&up);
+ unsigned int flags =3D 0;
+
+ expect_string(query_user_exec_builtin, query_user[i].prompt, "Enter UT=
Username:");
+ expect_string(query_user_exec_builtin, query_user[i].prompt, "Enter UT=
Password:");
+ will_return(query_user_exec_builtin, "cuser");
+ will_return(query_user_exec_builtin, "cpassword");
+ will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, "stdin", "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.username, "cuser");
+ assert_string_equal(up.password, "cpassword");
+
+ reset_user_pass(&up);
+
+ flags |=3D GET_USER_PASS_PASSWORD_ONLY;
+ expect_string(query_user_exec_builtin, query_user[i].prompt, "Enter UT=
Password:");
+ will_return(query_user_exec_builtin, "cpassword");
+ will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, "stdin", "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.username, "user");
+ assert_string_equal(up.password, "cpassword");
+}
+
+static void
+test_get_user_pass_authfile_file(void **state)
+{
+ struct user_pass up =3D { 0 };
+ reset_user_pass(&up);
+ unsigned int flags =3D 0;
+
+ const char *srcdir =3D getenv("srcdir");
+ assert_non_null(srcdir);
+ char authfile[PATH_MAX] =3D { 0 };
+
+ snprintf(authfile, PATH_MAX, "%s/%s", srcdir, "input/user_pass.txt");
+ /*FIXME: query_user_exec() called even though nothing queued */
+ will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, authfile, "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.username, "fuser");
+ assert_string_equal(up.password, "fpassword");
+
+ reset_user_pass(&up);
+
+ snprintf(authfile, PATH_MAX, "%s/%s", srcdir, "input/user_only.txt");
+ expect_string(query_user_exec_builtin, query_user[i].prompt, "Enter UT=
Password:");
+ will_return(query_user_exec_builtin, "cpassword");
+ will_return(query_user_exec_builtin, true);
+ /* will try to retrieve missing password from stdin */
+ assert_true(get_user_pass_cr(&up, authfile, "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.username, "fuser");
+ assert_string_equal(up.password, "cpassword");
+
+ reset_user_pass(&up);
+
+ flags |=3D GET_USER_PASS_PASSWORD_ONLY;
+ snprintf(authfile, PATH_MAX, "%s/%s", srcdir, "input/user_only.txt");
+ /*FIXME: query_user_exec() called even though nothing queued */
+ will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, authfile, "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.username, "user");
+ assert_string_equal(up.password, "fuser");
+}
+
+const struct CMUnitTest user_pass_tests[] =3D {
+ cmocka_unit_test(test_get_user_pass_defined),
+ cmocka_unit_test(test_get_user_pass_needok),
+ cmocka_unit_test(test_get_user_pass_inline_creds),
+ cmocka_unit_test(test_get_user_pass_authfile_stdin),
+ cmocka_unit_test(test_get_user_pass_authfile_file),
+};
+
+int
+main(void)
+{
+ return cmocka_run_group_tests(user_pass_tests, NULL, NULL);
+}
--
To view, visit http://gerrit.openvpn.net/c/openvpn/+/468?usp=3Demail
To unsubscribe, or for help writing mail filters, visit http://gerrit.openv=
pn.net/settings
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I193aef06912f01426dd4ac298aadfab97dd75a35
Gerrit-Change-Number: 468
Gerrit-PatchSet: 4
Gerrit-Owner: flichtenheld
Gerrit-Reviewer: plaisthos
Gerrit-CC: openvpn-devel
Gerrit-Attention: plaisthos
Gerrit-MessageType: newpatchset
--QbTIR8Tg3iI=
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Attention is currently required from: plaisthos.
flichtenheld uploaded patch set #4 to this change.
<=
p>View Ch=
ange
test_user_pass: new UT for get_user_pass
UTs for basic func=
tionality, without management functions.
v2:
- add CMake support=
- add GHA support for both MSVC and mingw
v3:
- fix distcheck b=
y adding input/ directory to dist
Change-Id: I193aef06912f01426dd4ac=
298aadfab97dd75a35
Signed-off-by: Frank Lichtenheld <frank@...2641...=
>
---
M .github/workflows/build.yaml
M CMakeLists.txt
M src/=
openvpn/syshead.h
M tests/unit_tests/openvpn/Makefile.am
A tests/unit=
_tests/openvpn/input/user_only.txt
A tests/unit_tests/openvpn/input/user=
_pass.txt
A tests/unit_tests/openvpn/test_user_pass.c
7 files changed=
, 308 insertions(+), 2 deletions(-)
git pull ssh://gerrit.openvpn=
.net:29418/openvpn refs/changes/68/468/4
diff --git a/.github/workf=
lows/build.yaml b/.github/workflows/build.yaml
index 4393f5=
c..784a844 100644
--- a/.github/workflows/build.yaml=
+++ b/.github/workflows/build.yaml
@@ -85,11 +85,=
13 @@
fail-fast: false
matrix=
:
arch: [x86, x64]
- test: [argv, auth_token, buffer, cryptoapi, c=
rypto, misc, ncp, packet_id, pkt, provider, tls_crypt]
+ test: [argv, auth_token, buffer,=
cryptoapi, crypto, misc, ncp, packet_id, pkt, provider, tls_crypt, user_pa=
ss]
runs-on: windows-latest name: "mingw unittest ${{ matrix.test }} - ${{ matrix.arc=
h }} - OSSL"
steps:
+ - name: Checkout OpenVPN
+ uses: actions/checkout@...2781...=
...
- name: Retrieve mingw unittest
=
uses: actions/download-artifact@...2689...
=
with:
@@ -97,6 +99,8 @@
path: =
unittests
- name: Run ${{ matrix.test }} unit test=
span>
run: ./unittests/test_${{ matrix.test }}.exe=
+ env:
+ srcdir: "${{ githu=
b.workspace }}/tests/unit_tests/openvpn"
<=
span> ubuntu:
strategy:
@@ -279,6 +2=
83,7 @@
configurePreset: win-${{ matrix.arch }}-=
release
buildPreset: win-${{ matrix.arch }}-rele=
ase
testPreset: win-${{ matrix.arch }}-release=
span>
+ testPresetA=
dditionalArgs: "['--output-on-failure']"
=
- uses: actions/upload-artifact@...2689...<=
br> with:
diff --git a/CMakeLists.txt b/CMake=
Lists.txt
index d40b213..af891a5 100644
---=
a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -=
587,6 +587,7 @@
"test_packet_id"<=
br> "test_pkt"
"test_=
provider"
+ =
"test_user_pass"
)
<=
/span>
if (WIN32)
@@ -645,6 +646,10 @@=
# test_networking needs special environment
if (NOT ${test_name} STREQUAL "test_networking")
add_test(${test_name} ${test_name})
+ # for compat with aut=
otools make check
+ =
set(_UT_SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/tests/unit_tests/o=
penvpn)
+ =
set_tests_properties(${test_name} PROPERTIES
+ ENVIRONMENT "srcdir=3D${_UT_S=
OURCE_DIR}")
endif ()
=
add_executable(${test_name}
tests/unit_tests=
/openvpn/${test_name}.c
@@ -739,6 +744,15 @@
src/openvpn/base64.c
)
=
+ target_sources=
(test_user_pass PRIVATE
+ tests/unit_tests/openvpn/mock_get_random.c
+ tests/unit_tests/openvpn/mock_wi=
n32_execve.c
+ =
src/openvpn/base64.c
+ src/openvpn/console.c
+ src/openvpn/env_set.c
+ src/openvpn/run_command.c
+ )
+
if (TARGET test_argv)
target_link_options(test_argv PRIVATE -Wl,--wrap=3Dpars=
e_line)
target_sources(test_argv PRIVATE
diff --git a/src/openvpn/syshead.h b/src/openvpn/syshead.h
index 7181b94..d89d2b5 100644
--- a/src/openvpn/sysh=
ead.h
+++ b/src/openvpn/syshead.h
@@ -522,4=
+522,10 @@
#define ENABLE_MEMSTATS
#endi=
f
+=
#ifdef _MSC_VER
+#ifn=
def PATH_MAX
+#define=
PATH_MAX MAX_PATH
+#=
endif
+#endif<=
br>+
#endif /*=
ifndef SYSHEAD_H */
diff --git a/tests/unit_tests/openvpn/=
Makefile.am b/tests/unit_tests/openvpn/Makefile.am
index ce=
cf4dc..342f428 100644
--- a/tests/unit_tests/openvpn/Makefi=
le.am
+++ b/tests/unit_tests/openvpn/Makefile.am
=
@@ -1,5 +1,7 @@
AUTOMAKE_OPTIONS =3D foreign<=
br>
+EXTRA_DIS=
T =3D input
+<=
br> AM_TESTSUITE_SUMMARY_HEADER =3D ' for $(PACKAGE_STRING) Unit-=
Tests'
test_binaries=3D
@@ -9,7 +11,7 @@
endif
test_binaries +=3D crypto_testdriver packet_id_testdriver auth_token_te=
stdriver ncp_testdriver misc_testdriver \
- pkt_testdriver
+ pkt_testdriver user_pass_testdriver
if HA=
VE_LD_WRAP_SUPPORT
if !WIN32
test_binarie=
s +=3D tls_crypt_testdriver
@@ -216,6 +218,22 @@
=
$(top_srcdir)/src/openvpn/base64.c
+user_pass_testdr=
iver_CFLAGS =3D @TEST_CFLAGS@ \
+ -I$(top_srcdir)/include -I$(top_srcdir)/src/compat -I$(top_sr=
cdir)/src/openvpn
+us=
er_pass_testdriver_LDFLAGS =3D @TEST_LDFLAGS@
+
+user_pass_testdriver_SOURCES =3D test_user_pass.c mock_msg.c \
+ $(top_srcdir)/src/openvp=
n/buffer.c \
+ $(top_=
srcdir)/src/openvpn/console.c \
+ $(top_srcdir)/src/openvpn/env_set.c \
+ mock_win32_execve.c \
+ $(top_srcdir)/src/openvpn/run_command.c =
\
+ mock_get_random.c=
\
+ $(top_srcdir)/sr=
c/openvpn/platform.c \
+ $(top_srcdir)/src/openvpn/win32-util.c \
+ $(top_srcdir)/src/openvpn/base64.c
+
+
ncp_testdriver_CFLAGS =3D @TEST_CF=
LAGS@ \
-I$(top_srcdir)/include -I$(top_srcdir)/src/compa=
t -I$(top_srcdir)/src/openvpn \
$(OPTIONAL_CRYPTO_CFLAGS)=
diff --git a/tests/unit_tests/openvpn/input/user_only.txt =
b/tests/unit_tests/openvpn/input/user_only.txt
new file mod=
e 100644
index 0000000..3ca0db3
--- /dev/nu=
ll
+++ b/tests/unit_tests/openvpn/input/user_only.txt
@@ -0,0 +1 @@
+fuser
diff --git a/tests/unit_tests/openvpn/input/user=
_pass.txt b/tests/unit_tests/openvpn/input/user_pass.txt
ne=
w file mode 100644
index 0000000..31b38ef
-=
-- /dev/null
+++ b/tests/unit_tests/openvpn/input/user_pass=
.txt
@@ -0,0 +1,2 @@
+fuser
+fpassword
diff --git a/tests/unit_tests/openvpn/test_use=
r_pass.c b/tests/unit_tests/openvpn/test_user_pass.c
new fi=
le mode 100644
index 0000000..ab4dfe4
--- /=
dev/null
+++ b/tests/unit_tests/openvpn/test_user_pass.c
@@ -0,0 +1,260 @@
+/*
+ * O=
penVPN -- An application to securely tunnel IP networks
+ * over a single UDP port, =
with support for SSL/TLS-based
+ * session authentication and key exchange,+ * packet encryp=
tion, packet authentication, and
+ * packet compression.
+ *
+ * Copyright (C) 2023 OpenVPN Inc <sales@...515...>
+ *
+ * This program is free software; you ca=
n redistribute it and/or modify
+ * it under the terms of the GNU General Public License as pub=
lished by the
+ * Fr=
ee Software Foundation, either version 2 of the License,
+ * or (at your option) any later vers=
ion.
+ *
+ * This program is distributed =
in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warr=
anty of
+ * MERCHANT=
ABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more d=
etails.
+ *
+ * You should have received =
a copy of the GNU General Public License along
+ * with this program; if not, write to the Free=
Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#und=
ef ENABLE_SYSTEMD
+=
span>
+#include "syshea=
d.h"
+#include &=
quot;manage.h"
+=
+#include <stdlib=
.h>
+#include <=
string.h>
+#includ=
e <setjmp.h>
+#=
include <cmocka.h>
+
+#include "=
;misc.c"
+
+struct management *manage=
ment; /* global */
+<=
/span>
+/* mocking */=
+bool
+query_user_exec_builtin(void)
<=
span style=3D"color: hsl(120, 100%, 40%);">+{
+ /* Loop through configured query_user slots *=
/
+ for (int i =3D=
0; i < QUERY_USER_NUMSLOTS && query_user[i].response !=3D NULL;=
i++)
+ {+ check_expected(query=
_user[i].prompt);
+ =
strncpy(query_user[i].response, mock_ptr_type(char *), query_user[i].=
response_len);
+ }=
+
+ return mock();
+}
+void
+management_auth_failure(struct management *man, const char *type, const =
char *reason)
+{
+ assert_true(0);
+}
+bool
+management_query_user_pass(struct management *man,
+ =
struct user_pass *up,
+ const char *type,
+ const unsigned int =
flags,
+ =
const char *static_challenge)
+{
+ assert_true(0);
+ return false;
+}
+/* stubs for s=
ome unused functions instead of pulling in too many dependencies */<=
br>+int
+parse_line(const char *line, char **p, co=
nst int n, const char *file,
+ const int line_num, int msglevel, struct gc_arena *gc)<=
/span>
+{
+ assert_true(0);
+ return 0;
+}
+
+/* too=
ling */
+static void<=
/span>
+reset_user_pass(stru=
ct user_pass *up)
+{<=
/span>
+ up->defined =
=3D false;
+ up-&g=
t;token_defined =3D false;
+ up->nocache =3D false;
+ strcpy(up->username, "user");
<=
span style=3D"color: hsl(120, 100%, 40%);">+ strcpy(up->password, &qu=
ot;password");
+=
}
+
+static void
+test_get_user_pass_defined(void **state)
+{
+ struct user_pass up =3D { 0 };=
+ reset_user_pass(&u=
p);
+ up.defined =
=3D true;
+ assert=
_true(get_user_pass_cr(&up, NULL, "UT", 0, NULL));
=
+}
+
+static void
+=
test_get_user_pass_needok(void **state)
+{
+ struct user_pass up =3D { 0 };
+ reset_user_pass(&up);
+ unsigned int flags =3D GET_USER_PASS_NEED_OK=
;
+
+ expect_string(query_user_exec_bui=
ltin, query_user[i].prompt, "NEED-OK|UT|user:");
+ will_return(query_user_exec_buil=
tin, "");
+=
will_return(query_user_exec_builtin, true);
+ /*FIXME: query_user_exec() called even thou=
gh nothing queued */
=
+ will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, NULL=
, "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.password, "ok");=
+
+ reset_user_pass(&up);+
+ expect_string(query_user_exec_builtin, quer=
y_user[i].prompt, "NEED-OK|UT|user:");
+ will_return(query_user_exec_builtin, "=
;cancel");
+ =
will_return(query_user_exec_builtin, true);
+ /*FIXME: query_user_exec() called even though n=
othing queued */
+ =
will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, NULL, &q=
uot;UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.password, "cancel");=
+}
+
+static void
+test_get_user_pass_inline_creds(void **state)
+{
+ struct user_pass up =3D { 0 };
+ reset_user_pass(&up);
<=
span style=3D"color: hsl(120, 100%, 40%);">+ unsigned int flags =3D GET_=
USER_PASS_INLINE_CREDS;
+
+ /*FIXME: qu=
ery_user_exec() called even though nothing queued */
+ will_return(query_user_exec_builtin, =
true);
+ assert_tr=
ue(get_user_pass_cr(&up, "iuser\nipassword", "UT", =
flags, NULL));
+ a=
ssert_true(up.defined);
+ assert_string_equal(up.username, "iuser");
+ assert_string_equal(up.passwor=
d, "ipassword");
+
+ reset_us=
er_pass(&up);
+=
span>
+ expect_string(que=
ry_user_exec_builtin, query_user[i].prompt, "Enter UT Password:")=
;
+ will_return(qu=
ery_user_exec_builtin, "cpassword");
+ will_return(query_user_exec_builtin, true);<=
/span>
+ /* will try to r=
etrieve missing password from stdin */
+ assert_true(get_user_pass_cr(&up, "iuser&qu=
ot;, "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.username, "iuser&q=
uot;);
+ assert_st=
ring_equal(up.password, "cpassword");
+
+ reset_user_pass(&up);
+
+=
flags |=3D GET_USER_PASS_PASSWORD_ONLY;
+ /*FIXME: query_user_exec() called even though n=
othing queued */
+ =
will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, "ip=
assword\n", "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.username, &=
quot;user");
+ =
assert_string_equal(up.password, "ipassword");
+
+ reset_user_pass(&up);
+
+ flags |=3D GET_USER_PASS_PASSWORD_ONLY;
+ expect_string(query_user_exec_builti=
n, query_user[i].prompt, "Enter UT Password:");
+ will_return(query_user_exec_built=
in, "cpassword");
+ will_return(query_user_exec_builtin, true);
+ /* will try to retrieve missing pas=
sword from stdin */
+=
assert_true(get_user_pass_cr(&up, "", "UT", fla=
gs, NULL));
+ asse=
rt_true(up.defined);
=
+ assert_string_equal(up.username, "user");
+ assert_string_equal(up.password, &=
quot;cpassword");
+}
+
+static void
+test_get_user_pass_authfile_stdin(void **=
state)
+{
<=
span style=3D"color: hsl(120, 100%, 40%);">+ struct user_pass up =3D { 0=
};
+ reset_user_p=
ass(&up);
+ un=
signed int flags =3D 0;
+
+ expect_stri=
ng(query_user_exec_builtin, query_user[i].prompt, "Enter UT Username:&=
quot;);
+ expect_s=
tring(query_user_exec_builtin, query_user[i].prompt, "Enter UT Passwor=
d:");
+ will_=
return(query_user_exec_builtin, "cuser");
+ will_return(query_user_exec_builtin, =
"cpassword");
+ will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up,=
"stdin", "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.username=
, "cuser");
+ assert_string_equal(up.password, "cpassword");
+
+ reset_user_pass(&up);
+
+ flags |=3D GET_USER_PASS_PASSWORD_ONLY;
+ expect_string(query_user_exec_bu=
iltin, query_user[i].prompt, "Enter UT Password:");
+ will_return(query_user_exec_b=
uiltin, "cpassword");
+ will_return(query_user_exec_builtin, true);
+ assert_true(get_user_pass_cr(&a=
mp;up, "stdin", "UT", flags, NULL));
+ assert_true(up.defined);
+ assert_string_equal(up.us=
ername, "user");
+ assert_string_equal(up.password, "cpassword");<=
br>+}
+
+static void
+test_get_user_pass_authfile_file(void **state)
+{
+ struct user_pass up =3D { 0 };
+ reset_user_pass(&up);
+ unsigned int flags =3D 0;+
+ const char *srcdir =3D getenv("srcdir&=
quot;);
+ assert_n=
on_null(srcdir);
+ =
char authfile[PATH_MAX] =3D { 0 };
+
+ =
snprintf(authfile, PATH_MAX, "%s/%s", srcdir, "input/user_p=
ass.txt");
+ =
/*FIXME: query_user_exec() called even though nothing queued */
<=
span style=3D"color: hsl(120, 100%, 40%);">+ will_return(query_user_exec=
_builtin, true);
+ =
assert_true(get_user_pass_cr(&up, authfile, "UT", flags, NUL=
L));
+ assert_true=
(up.defined);
+ as=
sert_string_equal(up.username, "fuser");
+ assert_string_equal(up.password, "f=
password");
+
+ reset_user_pass(&a=
mp;up);
+
<=
span style=3D"color: hsl(120, 100%, 40%);">+ snprintf(authfile, PATH_MAX=
, "%s/%s", srcdir, "input/user_only.txt");
+ expect_string(query_user_exe=
c_builtin, query_user[i].prompt, "Enter UT Password:");
+ will_return(query_user_ex=
ec_builtin, "cpassword");
+ will_return(query_user_exec_builtin, true);
<=
span style=3D"color: hsl(120, 100%, 40%);">+ /* will try to retrieve mis=
sing password from stdin */
+ assert_true(get_user_pass_cr(&up, authfile, "UT",=
flags, NULL));
+ =
assert_true(up.defined);
+ assert_string_equal(up.username, "fuser");
+ assert_string_equal(up.passwo=
rd, "cpassword");
+
+ reset_u=
ser_pass(&up);
+<=
/span>
+ flags |=3D GET_U=
SER_PASS_PASSWORD_ONLY;
+ snprintf(authfile, PATH_MAX, "%s/%s", srcdir, "input=
/user_only.txt");
+ /*FIXME: query_user_exec() called even though nothing queued */
+ will_return(query_us=
er_exec_builtin, true);
+ assert_true(get_user_pass_cr(&up, authfile, "UT", fla=
gs, NULL));
+ asse=
rt_true(up.defined);
=
+ assert_string_equal(up.username, "user");
+ assert_string_equal(up.password, &=
quot;fuser");
+}=
+
+const struct CMUnitTest user_pass_test=
s[] =3D {
+ cmocka=
_unit_test(test_get_user_pass_defined),
+ cmocka_unit_test(test_get_user_pass_needok),=
+ cmocka_unit_test(test_=
get_user_pass_inline_creds),
+ cmocka_unit_test(test_get_user_pass_authfile_stdin),
+ cmocka_unit_test(test_get=
_user_pass_authfile_file),
+};
+
+int
+main(void)
+{
+ return cmocka_run_group_tests(user_pass_tests, NULL, NULL);+}
To view, visit change 468. To unsubscribe, or for help writing mail fi=
lters, visit settings.=
p>
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I193aef06912f01426dd4ac298aa=
dfab97dd75a35
Gerrit-Change-Number: 468
Gerrit-PatchSet: 4
Gerrit-Owner: flichtenheld <frank@...2723...=
.>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...=
.1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...=
ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...=
..1227...>
Gerrit-MessageType: newpatchset
--QbTIR8Tg3iI=--