Skip to contentSkip to conversation

Add unit tests for engine keys

PATCH In review James Bottomley 3 participants 18 messages Jun 22, 2020 – Jun 24, 2020

lore
Share & tools
lore
#0 lore raw

v8 cover Add unit tests for engine keys

This is the version that should work on Linux, Mac and BSD (famous last words ...). I've checked it on the Linux platforms (Ubuntu and OpenSUSE).

James

---

James Bottomley (1):
Add unit tests for engine keys

 configure.ac                                  |   2 +
 tests/unit_tests/Makefile.am                  |   3 +
 tests/unit_tests/engine-key/Makefile.am       |  24 +++++
 .../engine-key/check_engine_keys.sh           |  30 ++++++
 tests/unit_tests/engine-key/libtestengine.c   | 101 ++++++++++++++++++
 tests/unit_tests/engine-key/openssl.cnf.in    |  12 +++
 6 files changed, 172 insertions(+)
 create mode 100644 tests/unit_tests/engine-key/Makefile.am
 create mode 100755 tests/unit_tests/engine-key/check_engine_keys.sh
 create mode 100644 tests/unit_tests/engine-key/libtestengine.c
 create mode 100644 tests/unit_tests/engine-key/openssl.cnf.in
Signature · 1 line
2.26.2
#1 lore raw

PATCH v8 1/1 Add unit tests for engine keys

Testing engines is problematic, so one of the prerequisites built for the tests is a simple openssl engine that reads a non-standard PEM guarded key. The test is simply can we run a client/server configuration with the usual sample key replaced by an engine key. The trivial engine prints out some operations and we check for these in the log to make sure the engine was used to load the key and that it correctly got the password.

---
v8: Fix openssl.cnf.in build rule for BSD
v7: Hard code .so for dll
v6: add absolute path instead of env variable in openssl.cnf (MacOS)
v5: do not hard code dynamic library extension into openssl.cnf (MacOS)
v4: add OPENSSL_config(NULL) so debian checks will work
v3: added this patch

---
 configure.ac                                  |   2 +
 tests/unit_tests/Makefile.am                  |   3 +
 tests/unit_tests/engine-key/Makefile.am       |  24 +++++
 .../engine-key/check_engine_keys.sh           |  30 ++++++
 tests/unit_tests/engine-key/libtestengine.c   | 101 ++++++++++++++++++
 tests/unit_tests/engine-key/openssl.cnf.in    |  12 +++
 6 files changed, 172 insertions(+)
 create mode 100644 tests/unit_tests/engine-key/Makefile.am
 create mode 100755 tests/unit_tests/engine-key/check_engine_keys.sh
 create mode 100644 tests/unit_tests/engine-key/libtestengine.c
 create mode 100644 tests/unit_tests/engine-key/openssl.cnf.in
configure.ac +2 -0
index 273a8d1b..53b7a967 100644
@@ -1387,6 +1387,7 @@ AM_CONDITIONAL([GIT_CHECKOUT], [test "${GIT_CHECKOUT}" = "yes"])
 AM_CONDITIONAL([ENABLE_PLUGIN_AUTH_PAM], [test "${enable_plugin_auth_pam}" = "yes"])
 AM_CONDITIONAL([ENABLE_PLUGIN_DOWN_ROOT], [test "${enable_plugin_down_root}" = "yes"])
 AM_CONDITIONAL([HAVE_LD_WRAP_SUPPORT], [test "${have_ld_wrap_support}" = "yes"])
+AM_CONDITIONAL([OPENSSL_ENGINE], [test "${have_openssl_engine}" = "yes"])
 
 sampledir="\$(docdir)/sample"
 AC_SUBST([plugindir])
@@ -1448,6 +1449,7 @@ AC_CONFIG_FILES([
         tests/unit_tests/openvpn/Makefile
         tests/unit_tests/plugins/Makefile
         tests/unit_tests/plugins/auth-pam/Makefile
+	tests/unit_tests/engine-key/Makefile
 	sample/Makefile
 ])
 AC_CONFIG_FILES([tests/t_client.sh], [chmod +x tests/t_client.sh])
tests/unit_tests/Makefile.am +3 -0
index 33fefaac..f27cd90f 100644
@@ -2,4 +2,7 @@ AUTOMAKE_OPTIONS = foreign
 
 if ENABLE_UNITTESTS
 SUBDIRS = example_test openvpn plugins
+if OPENSSL_ENGINE
+SUBDIRS += engine-key
+endif
 endif
tests/unit_tests/engine-key/Makefile.am new file +24 -0
new file mode 100644
index 00000000..39bed743
@@ -0,0 +1,24 @@
+AUTOMAKE_OPTIONS = foreign
+
+check_LTLIBRARIES = libtestengine.la
+conffiles = openssl.cnf
+
+TESTS_ENVIRONMENT = srcdir="$(abs_srcdir)"; \
+	builddir="$(abs_builddir)"; \
+	top_builddir="$(top_builddir)"; \
+	top_srcdir="$(top_srcdir)"; \
+	export srcdir builddir top_builddir top_srcdir;
+
+TESTS = check_engine_keys.sh
+check_engine_keys.sh: $(conffiles)
+
+clean-local:
+	rm -f $(conffiles)
+
+$(builddir)/openssl.cnf: $(srcdir)/openssl.cnf.in
+	sed "s|ABSBUILDDIR|$(abs_builddir)|" < $< > $@
+
+libtestengine_la_SOURCES = libtestengine.c
+libtestengine_la_LDFLAGS = @TEST_LDFLAGS@ -rpath /lib -shrext .so
+libtestengine_la_CFLAGS = @TEST_CFLAGS@ -I$(openvpn_srcdir) -I$(compat_srcdir)
+
tests/unit_tests/engine-key/check_engine_keys.sh new file +30 -0
new file mode 100755
index 00000000..e0c9d7b0
@@ -0,0 +1,30 @@
+#!/bin/sh
+
+OPENSSL_CONF="${builddir}/openssl.cnf"
+export OPENSSL_CONF
+
+password='AT3S4PASSWD'
+
+key="${builddir}/client.key"
+pwdfile="${builddir}/passwd"
+
+# create an engine key for us
+sed 's/PRIVATE KEY/TEST ENGINE KEY/' < ${top_srcdir}/sample/sample-keys/client.key > ${key}
+echo "$password" > $pwdfile
+
+# note here we've induced a mismatch in the client key and the server
+# cert which openvpn should report and die.  Check that it does.  Note
+# also that this mismatch depends on openssl not openvpn, so it is
+# somewhat fragile
+${top_builddir}/src/openvpn/openvpn --cd ${top_srcdir}/sample --config sample-config-files/loopback-server --engine testengine --key ${key} --askpass $pwdfile > log.txt 2>&1
+
+# first off check we died because of a key mismatch.  If this doesn't
+# pass, suspect openssl of returning different messages and update the
+# test accordingly
+grep -q 'X509_check_private_key:key values mismatch' log.txt || { echo "Key mismatch not detected"; exit 1; }
+
+# now look for the engine prints (these are under our control)
+grep -q 'ENGINE: engine_init called' log.txt || { echo "Engine initialization not detected"; exit 1; }
+grep -q 'ENGINE: engine_load_key called' log.txt || { echo "Key was not loaded from engine"; exit 1; }
+grep -q "ENGINE: engine_load_key got password ${password}" log.txt || { echo "Key password was not retrieved by the engine"; exit 1; }
+exit 0
tests/unit_tests/engine-key/libtestengine.c new file +101 -0

101 lines not on this page · raw message

tests/unit_tests/engine-key/openssl.cnf.in new file +12 -0
new file mode 100644
index 00000000..5eda9fa9
@@ -0,0 +1,12 @@
+HOME		= .
+openssl_conf	= openssl_init
+
+[req]
+[openssl_init]
+engines		= engines_section
+
+[engines_section]
+testengine	= testengine_section
+
+[testengine_section]
+dynamic_path	= ABSBUILDDIR/.libs/libtestengine.so
Signature · 1 line
2.26.2
Acked-by on v8 1/1
#2 lore raw

Tested on :
- MacOS Mojave with OpenSSL 1.1.1c (brew) and out-of-tree build, works.
- Linux with mbedtls (does not try engine tests, good :-) )
- Linux with OpenSSL 1.1.1, works
- FreeBSD 11.3 with OpenSSL 1.0.2s -> v6 fails, v6 works \o/

Conferred with Arne, we agreed on "this is good enough, and who wants something more sophisticated is welcome to send more patches".

Your patch has been applied to the master branch.

Thanks :)

commit 542c69c37b347d1895dde076508d0f6554544860

Author: James Bottomley
Date:   Mon Jun 22 16:23:19 2020 -0700
     Add unit tests for engine keys

     Signed-off-by: James Bottomley <[email protected]...>
     Acked-by: Gert Doering <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg20075.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering

#3 lore raw

Hi,

Quoted 10 lines · Gert Doering

Tested on :
- MacOS Mojave with OpenSSL 1.1.1c (brew) and out-of-tree build, works.
- Linux with mbedtls (does not try engine tests, good :-) )
- Linux with OpenSSL 1.1.1, works
- FreeBSD 11.3 with OpenSSL 1.0.2s -> v6 fails, v6 works \o/

Conferred with Arne, we agreed on "this is good enough, and who wants something more sophisticated is welcome to send more patches".

Oh well. We do need another round - Travis tells me that "make distcheck" is failing. Which hints at "autoconf is not told what to pack in the tarball"

https://travis-ci.org/github/OpenVPN/openvpn/jobs/701158155
...
make[6]: Entering directory '/home/travis/build/OpenVPN/openvpn/openvpn-2.5_git/_build/sub/tests/unit_tests/engine-key' 3672make[6]: *** No rule to make target '../../../../../tests/unit_tests/engine-key/openssl.cnf.in', needed by 'openssl.cnf'. Stop. 3673make[6]: Leaving directory '/home/travis/build/OpenVPN/openvpn/openvpn-2.5_git/_build/sub/tests/unit_tests/engine-key' 3674

(so now the source file is missing)

Please... :-9

gert

Signature · 6 lines
"If was one thing all people took for granted, was conviction that if you 
 feed honest figures into a computer, honest figures come out. Never doubted 
 it myself till I met a computer with a sense of humor."
                             Robert A. Heinlein, The Moon is a Harsh Mistress

Gert Doering - Munich, Germany                             [email protected]...
#4 lore raw
Quoted 34 lines · Gert Doering

Hi,

Quoted 9 lines · Gert Doering

Tested on :
- MacOS Mojave with OpenSSL 1.1.1c (brew) and out-of-tree build,
works.
- Linux with mbedtls (does not try engine tests, good :-) )
- Linux with OpenSSL 1.1.1, works
- FreeBSD 11.3 with OpenSSL 1.0.2s -> v6 fails, v6 works \o/

Quoted 3 lines

Conferred with Arne, we agreed on "this is good enough, and who wants
something more sophisticated is welcome to send more patches".

Oh well. We do need another round - Travis tells me that "make distcheck"
is failing. Which hints at "autoconf is not told what to pack in the tarball"

https://travis-ci.org/github/OpenVPN/openvpn/jobs/701158155
...
make[6]: Entering directory '/home/travis/build/OpenVPN/openvpn/openvpn- 2.5_git/_build/sub/tests/unit_tests/engine-key' 3672make[6]: *** No rule to make target '../../../../../tests/unit_tests/engine-key/openssl.cnf.in', needed by 'openssl.cnf'. Stop.
3673make[6]: Leaving directory '/home/travis/build/OpenVPN/openvpn/openvpn- 2.5_git/_build/sub/tests/unit_tests/engine-key'
3674

Quoted 3 lines

(so now the source file is missing)

Please... :-)

Sorry about that ... it's missing files from EXTRA_DIST ... plus I don't usually use make dist, so I never remember to run make distcheck.
It passes after this

---8>8>8><8<8<8---

From: James Bottomley <[email protected]...>
Subject: [PATCH] Fix make distcheck for new engine key unit test

Add config precursor and script to extra dist and make sure built and test leftover files are cleaned up afterwards.

---
 tests/unit_tests/engine-key/Makefile.am | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
tests/unit_tests/engine-key/Makefile.am +8 -2
index 95e7d868..0bfdfcd4 100644
@@ -2,6 +2,9 @@ AUTOMAKE_OPTIONS = foreign
 
 check_LTLIBRARIES = libtestengine.la
 conffiles = openssl.cnf
+EXTRA_DIST = \
+	openssl.cnf.in \
+	check_engine_keys.sh
 
 TESTS_ENVIRONMENT = srcdir="$(abs_srcdir)"; \
 	builddir="$(abs_builddir)"; \
@@ -12,8 +15,11 @@ TESTS_ENVIRONMENT = srcdir="$(abs_srcdir)"; \
 TESTS = check_engine_keys.sh
 check_engine_keys.sh: $(conffiles)
 
-clean-local:
-	rm -f $(conffiles)
+CLEANFILES = \
+	client.key \
+	passwd \
+	log.txt \
+	$(conffiles)
 
 $(builddir)/openssl.cnf: $(srcdir)/openssl.cnf.in
 	sed "s|ABSBUILDDIR|$(abs_builddir)|" < $< > $@
Signature · 1 line
2.26.2
#5 lore raw

apparently, it fails for some build on travis
https://travis-ci.org/github/OpenVPN/openvpn/jobs/701158156

вт, 23 июн. 2020 г. в 18:07, James Bottomley <
[email protected]...>:

Quoted 95 lines · Gert Doering
Quoted 34 lines

Hi,

Quoted 9 lines · Gert Doering

Tested on :
- MacOS Mojave with OpenSSL 1.1.1c (brew) and out-of-tree build,
works.
- Linux with mbedtls (does not try engine tests, good :-) )
- Linux with OpenSSL 1.1.1, works
- FreeBSD 11.3 with OpenSSL 1.0.2s -> v6 fails, v6 works \o/

Quoted 3 lines

Conferred with Arne, we agreed on "this is good enough, and who wants
something more sophisticated is welcome to send more patches".

Oh well. We do need another round - Travis tells me that "make distcheck"
is failing. Which hints at "autoconf is not told what to pack in the tarball"

https://travis-ci.org/github/OpenVPN/openvpn/jobs/701158155
...
make[6]: Entering directory '/home/travis/build/OpenVPN/openvpn/openvpn- 2.5_git/_build/sub/tests/unit_tests/engine-key' 3672make[6]: *** No rule to make target '../../../../../tests/unit_tests/engine-key/openssl.cnf.in', needed by 'openssl.cnf'. Stop.
3673make[6]: Leaving directory '/home/travis/build/OpenVPN/openvpn/openvpn- 2.5_git/_build/sub/tests/unit_tests/engine-key'
3674

Quoted 3 lines

(so now the source file is missing)

Please... :-)

Sorry about that ... it's missing files from EXTRA_DIST ... plus I don't usually use make dist, so I never remember to run make distcheck.
It passes after this

---8>8>8><8<8<8---

From: James Bottomley <[email protected]...>
Subject: [PATCH] Fix make distcheck for new engine key unit test

Add config precursor and script to extra dist and make sure built and test leftover files are cleaned up afterwards.

---
 tests/unit_tests/engine-key/Makefile.am | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
tests/unit_tests/engine-key/Makefile.am +8 -3
index 95e7d868..0bfdfcd4 100644
@@ -2,6 +2,9 @@ AUTOMAKE_OPTIONS = foreign
 
 check_LTLIBRARIES = libtestengine.la
 conffiles = openssl.cnf
+EXTRA_DIST = \
+       openssl.cnf.in \
+       check_engine_keys.sh
 
 TESTS_ENVIRONMENT = srcdir="$(abs_srcdir)"; \
        builddir="$(abs_builddir)"; \
@@ -12,8 +15,11 @@ TESTS_ENVIRONMENT = srcdir="$(abs_srcdir)"; \
 TESTS = check_engine_keys.sh
 check_engine_keys.sh: $(conffiles)
 
-clean-local:
-       rm -f $(conffiles)
+CLEANFILES = \
+       client.key \
+       passwd \
+       log.txt \
+       $(conffiles)
 
 $(builddir)/openssl.cnf: $(srcdir)/openssl.cnf.in
        sed "s|ABSBUILDDIR|$(abs_builddir)|" < $< > $@
--

2.26.2

_______________________________________________
Openvpn-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/openvpn-devel

#6 lore raw

as far as I understand, openssl-1.0.2 does not support engines ?

вт, 23 июн. 2020 г. в 21:42, Илья Шипицин <[email protected]...>:

Quoted 102 lines

apparently, it fails for some build on travis
https://travis-ci.org/github/OpenVPN/openvpn/jobs/701158156

вт, 23 июн. 2020 г. в 18:07, James Bottomley <
[email protected]...>:

Quoted 95 lines · Gert Doering
Quoted 34 lines

Hi,

Quoted 9 lines · Gert Doering

Tested on :
- MacOS Mojave with OpenSSL 1.1.1c (brew) and out-of-tree build,
works.
- Linux with mbedtls (does not try engine tests, good :-) )
- Linux with OpenSSL 1.1.1, works
- FreeBSD 11.3 with OpenSSL 1.0.2s -> v6 fails, v6 works \o/

Quoted 3 lines

Conferred with Arne, we agreed on "this is good enough, and who wants
something more sophisticated is welcome to send more patches".

Oh well. We do need another round - Travis tells me that "make distcheck"
is failing. Which hints at "autoconf is not told what to pack in the tarball"

https://travis-ci.org/github/OpenVPN/openvpn/jobs/701158155
...
make[6]: Entering directory '/home/travis/build/OpenVPN/openvpn/openvpn- 2.5_git/_build/sub/tests/unit_tests/engine-key' 3672make[6]: *** No rule to make target '../../../../../tests/unit_tests/engine-key/openssl.cnf.in', needed by 'openssl.cnf'. Stop.
3673make[6]: Leaving directory '/home/travis/build/OpenVPN/openvpn/openvpn- 2.5_git/_build/sub/tests/unit_tests/engine-key'
3674

Quoted 3 lines

(so now the source file is missing)

Please... :-)

Sorry about that ... it's missing files from EXTRA_DIST ... plus I don't usually use make dist, so I never remember to run make distcheck.
It passes after this

---8>8>8><8<8<8---

From: James Bottomley <[email protected]...>
Subject: [PATCH] Fix make distcheck for new engine key unit test

Add config precursor and script to extra dist and make sure built and test leftover files are cleaned up afterwards.

---
 tests/unit_tests/engine-key/Makefile.am | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
tests/unit_tests/engine-key/Makefile.am +8 -3
index 95e7d868..0bfdfcd4 100644
@@ -2,6 +2,9 @@ AUTOMAKE_OPTIONS = foreign
 
 check_LTLIBRARIES = libtestengine.la
 conffiles = openssl.cnf
+EXTRA_DIST = \
+       openssl.cnf.in \
+       check_engine_keys.sh
 
 TESTS_ENVIRONMENT = srcdir="$(abs_srcdir)"; \
        builddir="$(abs_builddir)"; \
@@ -12,8 +15,11 @@ TESTS_ENVIRONMENT = srcdir="$(abs_srcdir)"; \
 TESTS = check_engine_keys.sh
 check_engine_keys.sh: $(conffiles)
 
-clean-local:
-       rm -f $(conffiles)
+CLEANFILES = \
+       client.key \
+       passwd \
+       log.txt \
+       $(conffiles)
 
 $(builddir)/openssl.cnf: $(srcdir)/openssl.cnf.in
        sed "s|ABSBUILDDIR|$(abs_builddir)|" < $< > $@
--

2.26.2

_______________________________________________
Openvpn-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/openvpn-devel

#16 lore raw
In reply to Илья Шипицин

Hi,

Quoted 2 lines · ???????? ??????????????

apparently, it fails for some build on travis
https://travis-ci.org/github/OpenVPN/openvpn/jobs/701158156

This is the reason why James sent this new patch - what we have in master works but fails "make distcheck".

[..]

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

- Linux with mbedtls (does not try engine tests, good :-) )
- Linux with OpenSSL 1.1.1, works
- FreeBSD 11.3 with OpenSSL 1.0.2s -> v6 fails, v6 works \o/

As I've tested the patch with 1.0.2s, I can confirm that it supports engines, at least "enough for our needs".

(Haven't had time to verify that "distcheck" works now, busy with other issues to wrangle today)

gert

Signature · 6 lines
"If was one thing all people took for granted, was conviction that if you 
 feed honest figures into a computer, honest figures come out. Never doubted 
 it myself till I met a computer with a sense of humor."
                             Robert A. Heinlein, The Moon is a Harsh Mistress

Gert Doering - Munich, Germany                             [email protected]...
#7 lore raw
In reply to Илья Шипицин
Quoted 1 line · Илья Шипицин

as far as I understand, openssl-1.0.2 does not support engines ?

No, it does. Engines were a pre 0.9.8 thing. I support openssl in my builds for the TPM engine down to 1.0.1

However, the failure:

Quoted 11 lines

Key mismatch not detected

FAIL: check_engine_keys.sh

====================================================

1 of 1 test failed

Please report to [email protected]

====================================================

Is because an expected message isn't found in the output. I think it's this:

   # first off check we died because of a key mismatch.  If this doesn't
   # pass, suspect openssl of returning different messages and update the
   # test accordingly
   grep -q 'X509_check_private_key:key values mismatch' log.txt || { echo "Key mismatch not detected"; exit 1; }

If I could get hold of log.txt that would confirm that the test is outputting something slightly different from what's expected.

I did run this test on openssl-1.0.2j (I keep a copy of openSUSE_Leap_42.3 around precisely for this openssl testing) but it ran just fine. so there's clearly something different about the 1.0.2u you're using (might be a locale issue?).

James

#8 lore raw

вт, 23 июн. 2020 г. в 23:17, James Bottomley <
[email protected]...>:

Quoted 29 lines · Илья Шипицин
Quoted 1 line

as far as I understand, openssl-1.0.2 does not support engines ?

No, it does. Engines were a pre 0.9.8 thing. I support openssl in my builds for the TPM engine down to 1.0.1

However, the failure:

Quoted 11 lines

Key mismatch not detected

FAIL: check_engine_keys.sh

====================================================

1 of 1 test failed

Please report to [email protected]

====================================================

Is because an expected message isn't found in the output. I think it's this:

   # first off check we died because of a key mismatch.  If this doesn't
   # pass, suspect openssl of returning different messages and update the
   # test accordingly
   grep -q 'X509_check_private_key:key values mismatch' log.txt || { echo
"Key mismatch not detected"; exit 1; }
Quoted 8 lines

If I could get hold of log.txt that would confirm that the test is outputting something slightly different from what's expected.

I did run this test on openssl-1.0.2j (I keep a copy of openSUSE_Leap_42.3 around precisely for this openssl testing) but it ran just fine. so there's clearly something different about the 1.0.2u you're using (might be a locale issue?).

I'll have a look. Also, I think we should out log.txt in case of failure.

Quoted 4 lines

James

Acked-by
#17 lore raw
In reply to James Bottomley

Looks reasonable, explanation is reasonable, and it passes "make distcheck" (only tested on Linux, but there should not be a difference here).

Your patch has been applied to the master branch.

Thanks.

commit 21e3e9fc34128d37bd612def2acca29a5a18de77 (HEAD -> master)

Author: James Bottomley <[email protected]...>
Date:   Tue Jun 23 06:05:31 2020 -0700
    Fix make distcheck for new engine key unit test
    
    Signed-off-by: James Bottomley <[email protected]...>
    Acked-by: Gert Doering <[email protected]...>
    Message-Id: <[email protected]...>
    URL: https://www.mail-archive.com/[email protected]/msg20088.html
    Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering

#9 lore raw
In reply to Илья Шипицин

Hi,

Quoted 1 line · ???????? ??????????????

Also, I think we should out log.txt in case of failure.

Indeed, this would help.

gert

Signature · 6 lines
"If was one thing all people took for granted, was conviction that if you 
 feed honest figures into a computer, honest figures come out. Never doubted 
 it myself till I met a computer with a sense of humor."
                             Robert A. Heinlein, The Moon is a Harsh Mistress

Gert Doering - Munich, Germany                             [email protected]...
#10 lore raw

Hi,

Quoted 4 lines · Gert Doering
Quoted 1 line · ???????? ??????????????

Also, I think we should out log.txt in case of failure.

Indeed, this would help.

Yep.

The "make distcheck" travis instance is now happy, but the "1.0.2u + enable-small" instance is still unhappy.

James, are you triggering on specific openvpn messages? "--enable-small" changes these (trimming some warnings and help texts). Can you test with "configure --enable-small", please?

https://travis-ci.org/github/OpenVPN/openvpn/builds/701385033?utm_medium=notification&utm_source=email

gert

Signature · 6 lines
"If was one thing all people took for granted, was conviction that if you 
 feed honest figures into a computer, honest figures come out. Never doubted 
 it myself till I met a computer with a sense of humor."
                             Robert A. Heinlein, The Moon is a Harsh Mistress

Gert Doering - Munich, Germany                             [email protected]...
#11 lore raw
Quoted 14 lines · Gert Doering

Hi,

Quoted 5 lines · Gert Doering
Quoted 1 line · ???????? ??????????????

Also, I think we should out log.txt in case of failure.

Indeed, this would help.

Yep.

The "make distcheck" travis instance is now happy, but the "1.0.2u + enable-small" instance is still unhappy.

Quoted 8 lines

James, are you triggering on specific openvpn messages? "--enable- small"
changes these (trimming some warnings and help texts). Can you test with
"configure --enable-small", please?

https://travis-ci.org/github/OpenVPN/openvpn/builds/701385033?utm_med
ium=notification&utm_source=email

Yes, that's it. The problem is the message output by openssl is

2020-06-23 19:28:46 OpenSSL: error:0B080074:lib(11):func(128):reason(116)

Instead of:

2020-06-23 12:30:43 OpenSSL: error:0B080074:x509 certificate routines:X509_check_private_key:key values mismatch

I think I can make the grep work with the former.

James

#12 lore raw

Hi,

Quoted 9 lines · James Bottomley
Quoted 8 lines

James, are you triggering on specific openvpn messages? "--enable- small"
changes these (trimming some warnings and help texts). Can you test with
"configure --enable-small", please?

https://travis-ci.org/github/OpenVPN/openvpn/builds/701385033?utm_med
ium=notification&utm_source=email

Quoted 7 lines

Yes, that's it. The problem is the message output by openssl is

2020-06-23 19:28:46 OpenSSL: error:0B080074:lib(11):func(128):reason(116)

Instead of:

2020-06-23 12:30:43 OpenSSL: error:0B080074:x509 certificate routines:X509_check_private_key:key values mismatch

Indeed :-)

Quoted 1 line

I think I can make the grep work with the former.

Please do not forget to output log.txt when it fails - it eases diagnosing remote failures where we do not have easy access to "file system things" (like travis or buildbot).

gert

Signature · 6 lines
"If was one thing all people took for granted, was conviction that if you 
 feed honest figures into a computer, honest figures come out. Never doubted 
 it myself till I met a computer with a sense of humor."
                             Robert A. Heinlein, The Moon is a Harsh Mistress

Gert Doering - Munich, Germany                             [email protected]...
#13 lore raw

ср, 24 июн. 2020 г. в 00:37, Gert Doering <[email protected]...>:

Quoted 21 lines

Hi,

Quoted 9 lines · James Bottomley
Quoted 8 lines

James, are you triggering on specific openvpn messages? "--enable- small"
changes these (trimming some warnings and help texts). Can you test with
"configure --enable-small", please?

https://travis-ci.org/github/OpenVPN/openvpn/builds/701385033?utm_med
ium=notification&utm_source=email

Quoted 7 lines

Yes, that's it. The problem is the message output by openssl is

2020-06-23 19:28:46 OpenSSL: error:0B080074:lib(11):func(128):reason(116)

Instead of:

2020-06-23 12:30:43 OpenSSL: error:0B080074:x509 certificate

routines:X509_check_private_key:key values mismatch

Quoted 8 lines

Indeed :-)

Quoted 1 line

I think I can make the grep work with the former.

Please do not forget to output log.txt when it fails - it eases diagnosing remote failures where we do not have easy access to "file system things" (like travis or buildbot).

I've added output of log.txt, if you are going to modify "grep" magic, can you adopt something like that, please ?

https://travis-ci.org/github/chipitsine/openvpn/jobs/701409750

(quoted diff) +0 -0

b/tests/unit_tests/engine-key/check_engine_keys.sh index e0c9d7b0..770a0c9c 100755

tests/unit_tests/engine-key/check_engine_keys.sh +4 -0
@@ -8,6 +8,10 @@ password='AT3S4PASSWD'
 key="${builddir}/client.key"
 pwdfile="${builddir}/passwd"
 
+grep_a_log () {
+  grep -q $1 $2 || { echo $3; cat $2 ; exit 1; }
+}
+
 # create an engine key for us
 sed 's/PRIVATE KEY/TEST ENGINE KEY/' <

${top_srcdir}/sample/sample-keys/client.key > ${key}
echo "$password" > $pwdfile
@@ -21,10 +25,10 @@ ${top_builddir}/src/openvpn/openvpn --cd ${top_srcdir}/sample --config sample-co

 # first off check we died because of a key mismatch.  If this doesn't
 # pass, suspect openssl of returning different messages and update the
 # test accordingly
-grep -q 'X509_check_private_key:key values mismatch' log.txt || { echo
"Key mismatch not detected"; exit 1; }
+grep_a_log 'X509_check_private_key:key values mismatch' log.txt 'Key
mismatch not detected'
 # now look for the engine prints (these are under our control)
-grep -q 'ENGINE: engine_init called' log.txt || { echo "Engine
initialization not detected"; exit 1; }
-grep -q 'ENGINE: engine_load_key called' log.txt || { echo "Key was not
loaded from engine"; exit 1; }
-grep -q "ENGINE: engine_load_key got password ${password}" log.txt || {
echo "Key password was not retrieved by the engine"; exit 1; }
+grep_a_log 'ENGINE: engine_init called' log.txt 'Engine initialization not
detected'
+grep_a_log 'ENGINE: engine_load_key called' log.txt 'Key was not loaded
from engine'
+grep_a_log "ENGINE: engine_load_key got password ${password}" log.txt 'Key
password was not retrieved by the engine'
 exit 0
Signature · 1 line
2.26.2
Quoted 14 lines

gert

--
"If was one thing all people took for granted, was conviction that if you
feed honest figures into a computer, honest figures come out. Never
doubted
it myself till I met a computer with a sense of humor."
Robert A. Heinlein, The Moon is a Harsh
Mistress

Gert Doering - Munich, Germany
[email protected]...

#14 lore raw

On Wed, 2020-06-24 at 01:18 +0500, Илья Шипицин wrote:
[...]

Quoted 2 lines

I've added output of log.txt, if you are going to modify "grep" magic, can you adopt something like that, please ?

OK, I folded this into the --enable-small correction

James

---8>8>8><8<8<8---
From: James Bottomley <[email protected]...>
Subject: [PATCH] engine-key tests: make check_engine_keys.sh work with
--enable-small

--enable-small eliminates one of the openssl errors the test is looking for, so alter the grep also to account for the message in this version. Additionally output log.txt on failure so any test platform gives an easy clue about what went wrong.

---
 tests/unit_tests/engine-key/check_engine_keys.sh | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)
tests/unit_tests/engine-key/check_engine_keys.sh +10 -4
index e0c9d7b0..7e9a0e80 100755
@@ -12,6 +12,12 @@ pwdfile="${builddir}/passwd"
 sed 's/PRIVATE KEY/TEST ENGINE KEY/' < ${top_srcdir}/sample/sample-keys/client.key > ${key}
 echo "$password" > $pwdfile
 
+# our version of grep to output log.txt on failure in case it's an openssl
+# error mismatch and the grep expression needs updating
+loggrep() {
+    egrep -q "$1" log.txt || { echo '---- begin log.txt ----'; cat log.txt; echo '--- end log.txt ---'; return 1; }
+}
+
 # note here we've induced a mismatch in the client key and the server
 # cert which openvpn should report and die.  Check that it does.  Note
 # also that this mismatch depends on openssl not openvpn, so it is
@@ -21,10 +27,10 @@ ${top_builddir}/src/openvpn/openvpn --cd ${top_srcdir}/sample --config sample-co
 # first off check we died because of a key mismatch.  If this doesn't
 # pass, suspect openssl of returning different messages and update the
 # test accordingly
-grep -q 'X509_check_private_key:key values mismatch' log.txt || { echo "Key mismatch not detected"; exit 1; }
+loggrep '(X509_check_private_key:key values mismatch|func\(128\):reason\(116\))' log.txt || { echo "Key mismatch not detected"; exit 1; }
 
 # now look for the engine prints (these are under our control)
-grep -q 'ENGINE: engine_init called' log.txt || { echo "Engine initialization not detected"; exit 1; }
-grep -q 'ENGINE: engine_load_key called' log.txt || { echo "Key was not loaded from engine"; exit 1; }
-grep -q "ENGINE: engine_load_key got password ${password}" log.txt || { echo "Key password was not retrieved by the engine"; exit 1; }
+loggrep 'ENGINE: engine_init called' || { echo "Engine initialization not detected"; exit 1; }
+loggrep 'ENGINE: engine_load_key called' || { echo "Key was not loaded from engine"; exit 1; }
+loggrep "ENGINE: engine_load_key got password ${password}" || { echo "Key password was not retrieved by the engine"; exit 1; }
 exit 0
Signature · 1 line
2.26.2
#15 lore raw

PATCH 1/1 engine-key tests: make check_engine_keys.sh work with --enable-small

Looks reasonable and does not break anything that already worked.

I could reproduce the --enable-small breakage with FreeBSD / 1.0.2s here (interesting enough, not with Linux and 1.1.1*), and can confirm that the patch fixes things.

Your patch has been applied to the master branch.

commit 013498ddfe0a2b7f8986e9edac2b9f062bdd5fd7 (HEAD -> master)

Author: James Bottomley <[email protected]...>
Date:   Tue Jun 23 16:02:34 2020 -0700
    engine-key tests: make check_engine_keys.sh work with --enable-small
    
    Signed-off-by: James Bottomley <[email protected]...>
    Acked-by: Gert Doering <[email protected]...>
    Message-Id: <[email protected]...>
    URL: https://www.mail-archive.com/[email protected]/msg20102.html
    Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering