Mailing List Archive

Add a set of tests that exercise tpm2daemon handling of keys and
verify compatibility with non-tpm based keys.

Running this test infrastructure requires a tpm emulator, which is
tested for during configuration. If an emulator is not found, the
tests won't be run since they require the presence of a TPM (although
the TPM handling code will still be built).

Signed-off-by: James Bottomley <James.Bottomley@HansenPartnership.com>
---
configure.ac | 13 +
tests/Makefile.am | 3 +
tests/tpm2dtests/Makefile.am | 79 +++++
tests/tpm2dtests/all-tests.scm | 81 +++++
tests/tpm2dtests/defs.scm | 473 ++++++++++++++++++++++++++++
tests/tpm2dtests/ecc.scm | 23 ++
tests/tpm2dtests/longpassphrase.scm | 36 +++
tests/tpm2dtests/rsa.scm | 13 +
tests/tpm2dtests/run-tests.scm | 43 +++
tests/tpm2dtests/setup.scm | 48 +++
tests/tpm2dtests/shell.scm | 51 +++
tests/tpm2dtests/unimportable.scm | 28 ++
12 files changed, 891 insertions(+)
create mode 100644 tests/tpm2dtests/Makefile.am
create mode 100644 tests/tpm2dtests/all-tests.scm
create mode 100644 tests/tpm2dtests/defs.scm
create mode 100644 tests/tpm2dtests/ecc.scm
create mode 100644 tests/tpm2dtests/longpassphrase.scm
create mode 100644 tests/tpm2dtests/rsa.scm
create mode 100644 tests/tpm2dtests/run-tests.scm
create mode 100644 tests/tpm2dtests/setup.scm
create mode 100644 tests/tpm2dtests/shell.scm
create mode 100644 tests/tpm2dtests/unimportable.scm

diff --git a/configure.ac b/configure.ac
index 841115af0..a7e891e5e 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1609,12 +1609,17 @@ if test "$have_libtss" = yes; then
LIBTSS_LIBS=$LIBS
AC_DEFINE(HAVE_LIBTSS, 1, [Defined if we have TPM2 support library])
AC_SUBST(TSS_INCLUDE)
+ # look for a TPM emulator for testing
+ AC_PATH_PROG(TPMSERVER, tpm_server,,/bin:/usr/bin:/usr/lib/ibmtss:/usr/libexec/ibmtss)
+ AC_PATH_PROG(SWTPM, swtpm,,/bin:/usr/bin:/usr/lib/ibmtss:/usr/libexec/ibmtss)
+ AC_PATH_PROG(SWTPM_IOCTL, swtpm_ioctl,,/bin:/usr/bin:/usr/lib/ibmtss:/usr/libexec/ibmtss)
fi
LIBS="$_save_libs"
CFLAGS="$_save_cflags"
AC_SUBST(LIBTSS_LIBS)
AC_SUBST(LIBTSS_CFLAGS)
AM_CONDITIONAL(HAVE_LIBTSS, test "$have_libtss" = yes)
+AM_CONDITIONAL(TEST_LIBTSS, test -n "$TPMSERVER" -o -n "$SWTPM")
AC_SUBST(HAVE_LIBTSS)

#
@@ -2091,6 +2096,7 @@ doc/Makefile
tests/Makefile
tests/gpgscm/Makefile
tests/openpgp/Makefile
+tests/tpm2dtests/Makefile
tests/migrations/Makefile
tests/gpgsm/Makefile
tests/gpgme/Makefile
@@ -2141,6 +2147,13 @@ echo "
Tor support: $show_tor_support
TPM support: $have_libtss
"
+if test "$have_libtss" != no -a -z "$TPMSERVER" -a -z "$SWTPM"; then
+cat <<G10EOF
+ Warning: TPM support is compiled in but no software TPM
+ for testing was discovered. TPM tests are disabled
+
+G10EOF
+fi
if test "x${gpg_config_script_warn}" != x; then
cat <<G10EOF
Warning: Mismatches between the target platform and the
diff --git a/tests/Makefile.am b/tests/Makefile.am
index 65978ae3f..7697a43bf 100644
--- a/tests/Makefile.am
+++ b/tests/Makefile.am
@@ -19,6 +19,9 @@
## Process this file with automake to produce Makefile.in

SUBDIRS = gpgscm openpgp migrations gpgsm gpgme pkits .
+if TEST_LIBTSS
+SUBDIRS += tpm2dtests
+endif

GPGSM = ../sm/gpgsm

diff --git a/tests/tpm2dtests/Makefile.am b/tests/tpm2dtests/Makefile.am
new file mode 100644
index 000000000..36be90efd
--- /dev/null
+++ b/tests/tpm2dtests/Makefile.am
@@ -0,0 +1,79 @@
+# Makefile.am - For tests/openpgp
+# Copyright (C) 1998, 1999, 2000, 2001, 2003,
+# 2010 Free Software Foundation, Inc.
+#
+# This file is part of GnuPG.
+#
+# GnuPG 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 3 of the License, or
+# (at your option) any later version.
+#
+# GnuPG 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/>.
+# Process this file with automake to create Makefile.in
+
+
+# Programs required before we can run these tests.
+required_pgms = ../../g10/gpg$(EXEEXT) ../../agent/gpg-agent$(EXEEXT) \
+ ../../tools/gpg-connect-agent$(EXEEXT) \
+ ../gpgscm/gpgscm$(EXEEXT) ../openpgp/fake-pinentry$(EXEEXT)
+
+AM_CPPFLAGS = -I$(top_srcdir)/common
+include $(top_srcdir)/am/cmacros.am
+
+AM_CFLAGS =
+
+TESTS_ENVIRONMENT = LC_ALL=C \
+ EXEEXT=$(EXEEXT) \
+ PATH="../gpgscm:$(PATH)" \
+ abs_top_srcdir="$(abs_top_srcdir)" \
+ objdir="$(abs_top_builddir)" \
+ TPMSERVER="$(TPMSERVER)" \
+ SWTPM="$(SWTPM)" \
+ SWTPM_IOCTL="$(SWTPM_IOCTL)" \
+ GPGSCM_PATH="$(abs_top_srcdir)/tests/gpgscm"
+
+XTESTS = \
+ rsa.scm \
+ ecc.scm \
+ longpassphrase.scm \
+ unimportable.scm
+
+# XXX: Currently, one cannot override automake's 'check' target. As a
+# workaround, we avoid defining 'TESTS', thus automake will not emit
+# the 'check' target. For extra robustness, we merely define a
+# dependency on 'xcheck', so this hack should also work even if
+# automake would emit the 'check' target, as adding dependencies to
+# targets is okay.
+check: xcheck
+
+.PHONY: xcheck
+xcheck: tpm_server_found
+ $(TESTS_ENVIRONMENT) $(abs_top_builddir)/tests/gpgscm/gpgscm \
+ $(abs_srcdir)/run-tests.scm $(TESTFLAGS) $(TESTS)
+
+tpm_server_found:
+ @if [ -z "$(TPMSERVER)" -a -z "$(SWTPM)" -a -z "$(FORCE)" ]; then echo "ERROR: No Software TPM has been found, cannot run TPM tests. Set FORCE=1 to force using the physical TPM"; exit 1; fi
+
+EXTRA_DIST = defs.scm shell.scm all-tests.scm
+
+CLEANFILES = gpg.conf gpg-agent.conf S.gpg-agent \
+ pubring.gpg pubring.gpg~ pubring.kbx pubring.kbx~ \
+ secring.gpg pubring.pkr secring.skr \
+ gnupg-test.stop random_seed gpg-agent.log tofu.db \
+ passphrases sshcontrol S.gpg-agent.ssh report.xml \
+ msg.txt
+
+clean-local:
+ -rm -rf private-keys-v1.d openpgp-revocs.d
+
+
+# We need to depend on a couple of programs so that the tests don't
+# start before all programs are built.
+all-local: $(required_pgms)
diff --git a/tests/tpm2dtests/all-tests.scm b/tests/tpm2dtests/all-tests.scm
new file mode 100644
index 000000000..bf7a981ca
--- /dev/null
+++ b/tests/tpm2dtests/all-tests.scm
@@ -0,0 +1,81 @@
+;; Copyright (C) 2017 g10 Code GmbH
+;;
+;; This file is part of GnuPG.
+;;
+;; GnuPG 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 3 of the License, or
+;; (at your option) any later version.
+;;
+;; GnuPG 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 <http://www.gnu.org/licenses/>.
+
+(export all-tests
+ ;; Parse the Makefile.am to find all tests.
+
+ (load (with-path "makefile.scm"))
+
+ (define (expander filename port key)
+ (parse-makefile port key))
+
+ (define (parse filename key)
+ (parse-makefile-expand filename expander key))
+
+ (define setup
+ (make-environment-cache
+ (test::scm
+ #f
+ (path-join "tests" "openpgp" "setup.scm")
+ (in-srcdir "tests" "openpgp" "setup.scm"))))
+
+ (define (qualify path variant)
+ (string-append "<" variant ">" path))
+
+ (define (setup* variant)
+ (make-environment-cache
+ (test::scm
+ #f
+ (qualify (path-join "tests" "openpgp" "setup.scm") variant)
+ (in-srcdir "tests" "openpgp" "setup.scm")
+ (string-append "--" variant))))
+
+ (define setup-use-keyring (setup* "use-keyring"))
+ (define setup-use-keyboxd (setup* "use-keyboxd"))
+
+ (define all-tests
+ (parse-makefile-expand "Makefile"
+ (lambda (filename port key) (parse-makefile port key))
+ "XTESTS"))
+
+ (define tests
+ (map (lambda (name)
+ (test::scm setup
+ (qualify (path-join "tests" "tpm2dtests" name) "standard")
+ (in-srcdir "tests" "tpm2dtests" name))) all-tests))
+
+ (when *run-all-tests*
+ (set! tests
+ (append
+ tests
+ ;; The second pass uses the keyboxd
+ (map (lambda (name)
+ (test::scm setup-use-keyboxd
+ (qualify (path-join "tests" "tpm2dtests" name)
+ "keyboxd")
+ (in-srcdir "tests" "tpm2dtests" name)
+ "--use-keyboxd")) all-tests)
+ ;; The third pass uses the legact pubring.gpg
+ (map (lambda (name)
+ (test::scm setup-use-keyring
+ (qualify (path-join "tests" "tpm2dtests" name)
+ "keyring")
+ (in-srcdir "tests" "tpm2dtests" name)
+ "--use-keyring")) all-tests)
+ )))
+
+ tests)
diff --git a/tests/tpm2dtests/defs.scm b/tests/tpm2dtests/defs.scm
new file mode 100644
index 000000000..2a0910945
--- /dev/null
+++ b/tests/tpm2dtests/defs.scm
@@ -0,0 +1,473 @@
+;; Common definitions for the OpenPGP test scripts.
+;;
+;; Copyright (C) 2016, 2017 g10 Code GmbH
+;;
+;; This file is part of GnuPG.
+;;
+;; GnuPG 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 3 of the License, or
+;; (at your option) any later version.
+;;
+;; GnuPG 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 <http://www.gnu.org/licenses/>.
+
+(let ((verbose (string->number (getenv "verbose"))))
+ (if (number? verbose)
+ (*set-verbose!* verbose)))
+
+(define (qualify executable)
+ (string-append executable (getenv "EXEEXT")))
+
+(define (getenv' key default)
+ (let ((value (getenv key)))
+ (if (string=? "" value)
+ default
+ value)))
+
+(define (percent-decode s)
+ (define (decode c)
+ (if (and (> (length c) 2) (char=? #\% (car c)))
+ (integer->char (string->number (string #\# #\x (cadr c) (caddr c))))
+ #f))
+ (let loop ((i 0) (c (string->list s)) (r (make-string (string-length s))))
+ (if (null? c)
+ (substring r 0 i)
+ (let ((decoded (decode c)))
+ (string-set! r i (if decoded decoded (car c)))
+ (loop (+ 1 i) (if decoded (cdddr c) (cdr c)) r)))))
+(assert (equal? (percent-decode "") ""))
+(assert (equal? (percent-decode "%61") "a"))
+(assert (equal? (percent-decode "foob%61r") "foobar"))
+
+(define (percent-encode s)
+ (define (encode c)
+ `(#\% ,@(string->list (number->string (char->integer c) 16))))
+ (let loop ((acc '()) (cs (reverse (string->list s))))
+ (if (null? cs)
+ (list->string acc)
+ (case (car cs)
+ ((#\: #\%)
+ (loop (append (encode (car cs)) acc) (cdr cs)))
+ (else
+ (loop (cons (car cs) acc) (cdr cs)))))))
+(assert (equal? (percent-encode "") ""))
+(assert (equal? (percent-encode "%61") "%2561"))
+(assert (equal? (percent-encode "foob%61r") "foob%2561r"))
+
+(define tools
+ '((gpgv "GPGV" "g10/gpgv")
+ (gpg-connect-agent "GPG_CONNECT_AGENT" "tools/gpg-connect-agent")
+ (gpgconf "GPGCONF" "tools/gpgconf")
+ (gpg-preset-passphrase "GPG_PRESET_PASSPHRASE"
+ "agent/gpg-preset-passphrase")
+ (gpgtar "GPGTAR" "tools/gpgtar")
+ (gpg-zip "GPGZIP" "tools/gpg-zip")
+ (pinentry "PINENTRY" "tests/openpgp/fake-pinentry")
+ (tpm2daemon "TPM2DAEMON" "tpm2d/tpm2daemon")))
+
+(define bin-prefix (getenv "BIN_PREFIX"))
+(define installed? (not (string=? "" bin-prefix)))
+(define with-valgrind? (not (string=? (getenv "with_valgrind") "")))
+
+(define (tool-hardcoded which)
+ (let ((t (assoc which tools)))
+ (getenv' (cadr t)
+ (qualify (if installed?
+ (string-append bin-prefix "/" (basename (caddr t)))
+ (string-append (getenv "objdir") "/" (caddr t)))))))
+
+;; You can splice VALGRIND into your argument vector to run programs
+;; under valgrind. For example, to run valgrind on gpg, you may want
+;; to redefine gpg:
+;;
+;; (set! gpg `(,@valgrind ,@gpg))
+;;
+(define valgrind
+ '("/usr/bin/valgrind" -q --leak-check=no --track-origins=yes
+ --error-exitcode=154 --exit-on-first-error=yes))
+
+(unless installed?
+ (setenv "GNUPG_BUILDDIR" (getenv "objdir") #t))
+
+(define (gpg-conf . args)
+ (gpg-conf' "" args))
+(define (gpg-conf' input args)
+ (let ((s (call-popen `(,(tool-hardcoded 'gpgconf)
+ ,@(if installed? '()
+ (list '--build-prefix (getenv "objdir")))
+ ,@args) input)))
+ (map (lambda (line) (map percent-decode (string-split line #\:)))
+ (string-split-newlines s))))
+(define :gc:c:name car)
+(define :gc:c:description cadr)
+(define :gc:c:pgmname caddr)
+(define (:gc:o:name x) (list-ref x 0))
+(define (:gc:o:flags x) (string->number (list-ref x 1)))
+(define (:gc:o:level x) (string->number (list-ref x 2)))
+(define (:gc:o:description x) (list-ref x 3))
+(define (:gc:o:type x) (string->number (list-ref x 4)))
+(define (:gc:o:alternate-type x) (string->number (list-ref x 5)))
+(define (:gc:o:argument-name x) (list-ref x 6))
+(define (:gc:o:default-value x) (list-ref x 7))
+(define (:gc:o:default-argument x) (list-ref x 8))
+(define (:gc:o:value x) (if (< (length x) 10) "" (list-ref x 9)))
+
+(define (gpg-config component key)
+ (package
+ (define (value)
+ (let* ((conf (assoc key (gpg-conf '--list-options component)))
+ (type (:gc:o:type conf))
+ (value (:gc:o:value conf)))
+ (case type
+ ((0 2 3) (string->number value))
+ ((1 32) (substring value 1 (string-length value))))))
+ (define (update value)
+ (let ((value' (cond
+ ((string? value) (string-append "\"" value))
+ ((number? value) (number->string value))
+ (else (throw "Unsupported value" value)))))
+ (gpg-conf' (string-append key ":0:" (percent-encode value'))
+ `(--change-options ,component))))
+ (define (clear)
+ (gpg-conf' (string-append key ":16:")
+ `(--change-options ,component)))))
+
+(define gpg-components (apply gpg-conf '(--list-components)))
+
+(define (tool which)
+ (case which
+ ((gpg gpg-agent scdaemon gpgsm dirmngr)
+ (:gc:c:pgmname (assoc (symbol->string which) gpg-components)))
+ (else
+ (tool-hardcoded which))))
+
+(define (gpg-has-option? option)
+ (string-contains? (call-popen `(,(tool 'gpg) --dump-options) "")
+ option))
+
+(define have-opt-always-trust
+ (catch #f
+ (with-ephemeral-home-directory (lambda ()) (lambda ())
+ (call-check `(,(tool 'gpg) --gpgconf-test --always-trust)))
+ #t))
+
+(define GPG `(,(tool 'gpg) --no-permission-warning
+ ,@(if have-opt-always-trust '(--always-trust) '())))
+(define GPGV `(,(tool 'gpgv)))
+(define PINENTRY (tool 'pinentry))
+(define TPM2DAEMON (tool 'tpm2daemon))
+
+(define (tr:gpg input args)
+ (tr:spawn input `(,@GPG --output **out** ,@args **in**)))
+
+(define (pipe:gpg args)
+ (pipe:spawn `(,@GPG --output - ,@args)))
+
+(define (gpg-with-colons args)
+ (let ((s (call-popen `(,@GPG --with-colons ,@args) "")))
+ (map (lambda (line) (string-split line #\:))
+ (string-split-newlines s))))
+
+(define (secinfo name)
+ (assoc "sec" (gpg-with-colons `(--list-secret-key ,name))))
+(define (ssbinfo name)
+ (assoc "ssb" (gpg-with-colons `(--list-secret-key ,name))))
+(define (fingerprint name)
+ (:fpr (assoc "fpr" (gpg-with-colons `(--list-secret-key ,name)))))
+;; convenient accessors for sec
+(define (:cardinfo x) (list-ref x 14))
+;; Convenient accessors for the colon output of pub.
+(define (:type x) (string->symbol (list-ref x 0)))
+(define (:length x) (string->number (list-ref x 2)))
+(define (:alg x) (string->number (list-ref x 3)))
+(define (:expire x) (list-ref x 6))
+(define (:fpr x) (list-ref x 9))
+(define (:cap x) (list-ref x 11))
+
+(define (have-public-key? key)
+ (catch #f
+ (pair? (filter (lambda (l) (and (equal? 'fpr (:type l))
+ (equal? key::fpr (:fpr l))))
+ (gpg-with-colons `(--list-keys ,key::fpr))))))
+
+(define (have-secret-key? key)
+ (catch #f
+ (pair? (filter (lambda (l) (and (equal? 'fpr (:type l))
+ (equal? key::fpr (:fpr l))))
+ (gpg-with-colons `(--list-secret-keys ,key::fpr))))))
+
+(define (have-secret-key-file? key)
+ (file-exists? (path-join (getenv "GNUPGHOME") "private-keys-v1.d"
+ (string-append key::grip ".key"))))
+
+(define (get-config what)
+ (string-split (caddar (gpg-with-colons `(--list-config ,what))) #\;))
+
+(define all-pubkey-algos (delay (get-config "pubkeyname")))
+(define all-hash-algos (delay (get-config "digestname")))
+(define all-cipher-algos (delay (get-config "ciphername")))
+(define all-compression-algos (delay (get-config "compressname")))
+
+(define (have-pubkey-algo? x)
+ (not (not (member x (force all-pubkey-algos)))))
+(define (have-hash-algo? x)
+ (not (not (member x (force all-hash-algos)))))
+(define (have-cipher-algo? x)
+ (not (not (member x (force all-cipher-algos)))))
+(define (have-compression-algo? x)
+ (not (not (member x (force all-compression-algos)))))
+
+(define (gpg-pipe args0 args1 errfd)
+ (lambda (source sink)
+ (let* ((p (pipe))
+ (task0 (spawn-process-fd `(,@GPG ,@args0)
+ source (:write-end p) errfd))
+ (_ (close (:write-end p)))
+ (task1 (spawn-process-fd `(,@GPG ,@args1)
+ (:read-end p) sink errfd)))
+ (close (:read-end p))
+ (wait-processes (list GPG GPG) (list task0 task1) #t))))
+
+;;
+;; Do we have a software tpm
+;;
+(define have-swtpm? (not (and (string=? "" (getenv "TPMSERVER"))
+ (string=? "" (getenv "SWTPM")))))
+(setenv "GPG_AGENT_INFO" "" #t)
+(setenv "GNUPGHOME" (getcwd) #t)
+(if have-swtpm?
+ (setenv "TPM_INTERFACE_TYPE" "socsim" #t))
+(define GNUPGHOME (getcwd))
+
+;;
+;; GnuPG helper.
+;;
+
+;; Call GPG to obtain the hash sums. Either specify an input file in
+;; ARGS, or an string in INPUT. Returns a list of (<algo>
+;; "<hashsum>") lists.
+(define (gpg-hash-string args input)
+ (map
+ (lambda (line)
+ (let ((p (string-split line #\:)))
+ (list (string->number (cadr p)) (caddr p))))
+ (string-split-newlines
+ (call-popen `(,@GPG --with-colons ,@args) input))))
+
+;; Dearmor a file.
+(define (dearmor source-name sink-name)
+ (pipe:do
+ (pipe:open source-name (logior O_RDONLY O_BINARY))
+ (pipe:spawn `(,@GPG --dearmor))
+ (pipe:write-to sink-name (logior O_WRONLY O_CREAT O_BINARY) #o600)))
+
+(define (gpg-dump-packets source-name sink-name)
+ (pipe:do
+ (pipe:open source-name (logior O_RDONLY O_BINARY))
+ (pipe:spawn `(,@GPG --list-packets))
+ (pipe:write-to sink-name (logior O_WRONLY O_CREAT O_BINARY) #o600)))
+
+;;
+;; Support for test environment creation and teardown.
+;;
+
+(define (make-test-data filename size)
+ (call-with-binary-output-file
+ filename
+ (lambda (port)
+ (display (make-random-string size) port))))
+
+(define (create-file name . lines)
+ (catch #f (unlink name))
+ (letfd ((fd (open name (logior O_WRONLY O_CREAT O_BINARY) #o600)))
+ (let ((port (fdopen fd "wb")))
+ (for-each (lambda (line) (display line port) (newline port))
+ lines))))
+
+(define (create-gpghome)
+ (log "Creating test environment...")
+
+ (srandom (getpid))
+ (make-test-data "random_seed" 600)
+
+ (log "Creating configuration files")
+
+ (if (flag "--use-keyring" *args*)
+ (create-file "pubring.gpg"))
+
+ (create-file "gpg.conf"
+ ;;"log-file socket:///tmp/S.wklog"
+ ;;"verbose"
+ "no-greeting"
+ "no-secmem-warning"
+ "no-permission-warning"
+ "batch"
+ "no-auto-key-retrieve"
+ "no-auto-key-locate"
+ "allow-weak-digest-algos"
+ "ignore-mdc-error"
+ (if have-opt-always-trust
+ "no-auto-check-trustdb" "#no-auto-check-trustdb")
+ (string-append "agent-program "
+ (tool 'gpg-agent)
+ "|--debug-quick-random\n")
+ (if (flag "--use-keyboxd" *args*)
+ "use-keyboxd" "#use-keyboxd")
+ )
+ (create-file "gpg-agent.conf"
+ "allow-preset-passphrase"
+ "debug-all"
+ "log-file gpg-agent.log"
+ "no-grab"
+ "enable-ssh-support"
+ "s2k-count 65536"
+ (string-append "pinentry-program " (tool 'pinentry))
+ (string-append "tpm2daemon-program " (tool 'tpm2daemon))
+ "disable-scdaemon")
+ (create-file "msg.txt"
+ "This is a test of TPM signing and encryption"
+ "With two lines of text"))
+
+;; Initialize the test environment, install appropriate configuration
+;; and start the agent, without any keys.
+(define (setup-environment)
+ (create-gpghome)
+ (start-agent)
+ (start-tpm))
+
+(define (setup-environment-no-atexit)
+ (create-gpghome)
+ (start-agent #t))
+
+;; Initialize the test environment, install appropriate configuration
+;; and start the agent, with the keys from the legacy test suite.
+(define (setup-legacy-environment)
+ (create-gpghome)
+ (if (member "--unpack-tarball" *args*)
+ (begin
+ (call-check `(,(tool 'gpgtar) --extract --directory=. ,(cadr *args*)))
+ (start-agent))
+ (begin
+ (start-agent)
+ (create-legacy-gpghome)))
+ (preset-passphrases))
+
+;; start the tpm server
+(define (start-tpm)
+ (if have-swtpm?
+ (begin (define pid (call-check `(,(in-srcdir "tests" "tpm2dtests" "start_sw_tpm.sh"))))
+ (if (not (null? pid))
+ (atexit (lambda ()
+ (call-check `("/bin/kill" ,pid))))))))
+
+;; Create the socket dir and start the agent.
+(define (start-agent . args)
+ (log "Starting gpg-agent...")
+ (let ((gnupghome (getenv "GNUPGHOME")))
+ (if (null? args)
+ (atexit (lambda ()
+ (with-home-directory gnupghome (stop-agent))))))
+ (catch (log "Warning: Creating socket directory failed:" (car *error*))
+ (gpg-conf '--create-socketdir))
+ (call-check `(,(tool 'gpg-connect-agent) --verbose
+ ,(string-append "--agent-program=" (tool 'gpg-agent)
+ "|--debug-quick-random")
+ /bye)))
+
+;; Stop the agent and other daemons and remove the socket dir.
+(define (stop-agent)
+ (log "Stopping gpg-agent...")
+ (gpg-conf '--kill 'all)
+ (catch (log "Warning: Removing socket directory failed.")
+ (gpg-conf '--remove-socketdir)))
+
+;; Get the trust level for KEYID. Any remaining arguments are simply
+;; passed to GPG.
+;;
+;; This function only supports keys with a single user id.
+(define (gettrust keyid . args)
+ (let ((trust
+ (list-ref (assoc "pub" (gpg-with-colons
+ `(,@args
+ --list-keys ,keyid))) 1)))
+ (unless (and (= 1 (string-length trust))
+ (member (string-ref trust 0) (string->list "oidreqnmfuws-")))
+ (fail "Bad trust value:" trust))
+ trust))
+
+;; Check that KEYID's trust level matches EXPECTED-TRUST. Any
+;; remaining arguments are simply passed to GPG.
+;;
+;; This function only supports keys with a single user id.
+(define (checktrust keyid expected-trust . args)
+ (let ((trust (apply gettrust `(,keyid ,@args))))
+ (unless (string=? trust expected-trust)
+ (fail keyid ": Expected trust to be" expected-trust
+ "but got" trust))))
+
+(define (keytotpm name select)
+ (let ((result (call-with-io `(,@GPG --command-fd=0 --edit-key ,name ,select keytotpm) "y\n")))
+ (if (= 0 (:retcode result))
+ (:stdout result)
+ (throw "keytotpm failed"
+ (:stderr result)))))
+
+
+(define (quick-gen name algo)
+ (info "creating TPM " algo " key")
+ (call-check `(,@GPG --quick-generate-key ,name ,algo))
+ (keytotpm name "key 0")
+ (unless (string=? (:cardinfo (secinfo name)) "TPM-Protected")
+ (throw "key is not in the TPM")))
+
+(define (quick-add name algo)
+ (info "adding TPM encryption " algo " key")
+ (call-check `(,@GPG --quick-add-key ,(fingerprint name) ,algo "encr"))
+ (keytotpm name "key 1")
+ (unless (string=? (:cardinfo (ssbinfo name)) "TPM-Protected")
+ (throw "Added key is not in the TPM")))
+
+(define (check-sig name)
+ (info "checking TPM signing")
+ (call-check `(,@GPG --default-key ,name --sign msg.txt))
+ (call-check `(,@GPG --verify msg.txt.gpg))
+ (unlink "msg.txt.gpg"))
+
+(define (check-encrypt name)
+ (info "Checking TPM decryption")
+ (call-check `(,@GPG --recipient ,name --encrypt msg.txt))
+ (call-check `(,@GPG --output msg.out.txt --decrypt msg.txt.gpg))
+ (unless (file=? "msg.txt" "msg.out.txt")
+ (throw "File did not decrypt to the same message"))
+ (unlink "msg.out.txt")
+ (unlink "msg.txt.gpg"))
+
+;;
+;; Tests are very simple: create primary key in TPM add encryption key
+;; in TPM (verifies TPM primary can certify secondary), sign a message
+;; with primary key and check signature encrypt a message with
+;; encryption key and check signature
+;;
+(define (test-tpm name algo)
+ (quick-gen name algo)
+ (quick-add name algo)
+ (check-sig name)
+ (check-encrypt name))
+
+;;
+;; Enable checking with valgrind if the envvar "with_valgrind" is set
+;;
+(when with-valgrind?
+ (set! gpg `(,@valgrind ,@gpg)))
+
+
+;;(set! *args* (append *args* (list "--use-keyboxd")))
+
+
+;; end
diff --git a/tests/tpm2dtests/ecc.scm b/tests/tpm2dtests/ecc.scm
new file mode 100644
index 000000000..8b28cad23
--- /dev/null
+++ b/tests/tpm2dtests/ecc.scm
@@ -0,0 +1,23 @@
+#!/usr/bin/env gpgscm
+
+;; Copyright (C) 2021 James.Bottomley@HansenPartnership.com
+;;
+;; SPDX-License-Identifier: GPL-3.0-or-later
+;;
+(load (in-srcdir "tests" "tpm2dtests" "defs.scm"))
+
+(setup-environment)
+(setenv "PINENTRY_USER_DATA" "ecckey" #t)
+
+;;
+;; try checking signature and encryption on supported elliptic
+;; curve keys. Note this list must be allowable by the swtpm
+;; used for the test, which is why it's so small
+;;
+(define key-list '("nistp256" "nistp384"))
+
+(for-each
+ (lambda (algo)
+ (define name algo "<" algo "@example.com>")
+ (test-tpm name algo))
+ key-list)
diff --git a/tests/tpm2dtests/longpassphrase.scm b/tests/tpm2dtests/longpassphrase.scm
new file mode 100644
index 000000000..6e72dc317
--- /dev/null
+++ b/tests/tpm2dtests/longpassphrase.scm
@@ -0,0 +1,36 @@
+#!/usr/bin/env gpgscm
+
+;; Copyright (C) 2021 James.Bottomley@HansenPartnership.com
+;;
+;; SPDX-License-Identifier: GPL-3.0-or-later
+;;
+(load (in-srcdir "tests" "tpm2dtests" "defs.scm"))
+
+(setup-environment)
+
+;;
+;; Check that a key with a long passphrase can be created and check
+;; the passphrase can be truncated and still work
+;;
+(define name "ecc <ecc@example.com>")
+(define name1 "ecc1 <ecc1@example.com>")
+(define algo "nistp256")
+
+(setenv "PINENTRY_USER_DATA" "this is a password longer than the TPM max of the name algorithm (i.e. 32)" #t)
+(quick-gen name algo)
+
+(setenv "PINENTRY_USER_DATA" "this is a password longer than the TPM max of the name" #t)
+(check-sig name)
+
+;; exactly the TPM limit (sha256 hash name algorithm: 32)
+(setenv "PINENTRY_USER_DATA" "12345678901234567890123456789012" #t)
+(quick-gen name1 algo)
+
+(info "checking TPM signing failure with truncated passphrase")
+;; passphrase one character shorter, should fail with bad passphrase
+(setenv "PINENTRY_USER_DATA" "1234567890123456789012345678901" #t)
+(let ((result (call-with-io `(,@GPG --default-key ,name1 --sign msg.txt) "")))
+ (if (= 0 (:retcode result))
+ (throw "Signing Key succeeded with wrong passphrase")
+ (unless (string-contains? (:stderr result) "Bad passphrase")
+ (throw "Unexpected signing error:" (:stderr result)))))
diff --git a/tests/tpm2dtests/rsa.scm b/tests/tpm2dtests/rsa.scm
new file mode 100644
index 000000000..aaae35276
--- /dev/null
+++ b/tests/tpm2dtests/rsa.scm
@@ -0,0 +1,13 @@
+#!/usr/bin/env gpgscm
+
+;; Copyright (C) 2021 James.Bottomley@HansenPartnership.com
+;;
+;; SPDX-License-Identifier: GPL-3.0-or-later
+;;
+(load (in-srcdir "tests" "tpm2dtests" "defs.scm"))
+
+(setup-environment)
+
+(setenv "PINENTRY_USER_DATA" "rsakey" #t)
+
+(test-tpm "rsa <rsa@example.com>" "rsa2048")
diff --git a/tests/tpm2dtests/run-tests.scm b/tests/tpm2dtests/run-tests.scm
new file mode 100644
index 000000000..fdf1859a8
--- /dev/null
+++ b/tests/tpm2dtests/run-tests.scm
@@ -0,0 +1,43 @@
+;; Test-suite runner.
+;;
+;; Copyright (C) 2016 g10 Code GmbH
+;;
+;; This file is part of GnuPG.
+;;
+;; GnuPG 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 3 of the License, or
+;; (at your option) any later version.
+;;
+;; GnuPG 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 <http://www.gnu.org/licenses/>.
+
+(if (string=? "" (getenv "abs_top_srcdir"))
+ (begin
+ (echo "Environment variable 'abs_top_srcdir' not set. Please point it to"
+ "tests/tpm2dtests.")
+ (exit 2)))
+
+;; Set objdir so that the tests can locate built programs.
+(setenv "objdir" (getcwd) #f)
+
+(define setup
+ (make-environment-cache (test::scm
+ #f
+ (path-join "tests" "tpm2dtests" "setup.scm")
+ (in-srcdir "tests" "tpm2dtests" "setup.scm"))))
+
+(define tests (filter (lambda (arg) (not (string-prefix? arg "--"))) *args*))
+
+(run-tests (if (null? tests)
+ (load-tests "tests" "tpm2dtests")
+ (map (lambda (name)
+ (test::scm setup
+ (path-join "tests" "tpm2dtests" name)
+ (in-srcdir "tests" "tpm2dtests" name)
+ "--use-keyring")) tests)))
diff --git a/tests/tpm2dtests/setup.scm b/tests/tpm2dtests/setup.scm
new file mode 100644
index 000000000..df917e2e4
--- /dev/null
+++ b/tests/tpm2dtests/setup.scm
@@ -0,0 +1,48 @@
+#!/usr/bin/env gpgscm
+
+;; Copyright (C) 2016 g10 Code GmbH
+;;
+;; This file is part of GnuPG.
+;;
+;; GnuPG 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 3 of the License, or
+;; (at your option) any later version.
+;;
+;; GnuPG 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 <http://www.gnu.org/licenses/>.
+
+(load (in-srcdir "tests" "tpm2dtests" "defs.scm"))
+
+(define cache (flag "--create-tarball" *args*))
+(unless (and cache (= 1 (length cache)))
+ (fail "Usage: setup.scm --create-tarball <file> [--use-keyring]"))
+
+(when (> (*verbose*) 0)
+ (define (pad symbol length)
+ (let loop ((cs (string->list (symbol->string symbol)))
+ (result (make-string length #\space))
+ (i 0))
+ (if (null? cs)
+ result
+ (begin
+ (string-set! result i (car cs))
+ (loop (cdr cs) result (+ 1 i))))))
+ (log " I am going to use these tools:\n"
+ "==============================")
+ (for-each
+ (lambda (t)
+ (log (pad t 25) (tool t)))
+ '(gpgconf gpg gpg-agent scdaemon gpgsm dirmngr gpg-connect-agent
+ gpg-preset-passphrase gpgtar pinentry)))
+
+;;(setenv "GNUPGHOME" (getcwd) #t)
+(create-gpghome)
+(start-agent)
+(stop-agent)
+(call-check `(,(tool 'gpgtar) --create --output ,(car cache) "."))
diff --git a/tests/tpm2dtests/shell.scm b/tests/tpm2dtests/shell.scm
new file mode 100644
index 000000000..a0d32ec68
--- /dev/null
+++ b/tests/tpm2dtests/shell.scm
@@ -0,0 +1,51 @@
+#!/usr/bin/env gpgscm
+
+;; Copyright (C) 2016 g10 Code GmbH
+;;
+;; This file is part of GnuPG.
+;;
+;; GnuPG 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 3 of the License, or
+;; (at your option) any later version.
+;;
+;; GnuPG 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 <http://www.gnu.org/licenses/>.
+
+(load (in-srcdir "tests" "tpm2dtests" "defs.scm"))
+
+;; This is not a test, but can be used to inspect the test
+;; environment. Simply execute
+;;
+;; make -Ctests/tpm2dtests check TESTS=shell.scm
+;;
+;; to run it.
+
+(setup-environment)
+
+(if (prompt-yes-no? "Drop 'batch' from gpg.conf" #t)
+ (apply create-file
+ (cons "gpg.conf"
+ (filter (lambda (line) (not (equal? "batch" line)))
+ (string-split-newlines
+ (call-with-input-file "gpg.conf" read-all)))))
+ (begin
+ (echo "Note that gpg.conf includes 'batch'. If you want to use gpg")
+ (echo "interactively you should drop that.")))
+
+;; Add paths to tools to PATH.
+(setenv "PATH" (pathsep-join
+ (append (map (lambda (t) (dirname (tool t)))
+ '(gpg gpg-agent scdaemon gpgsm dirmngr gpgconf tpm2daemon))
+ (pathsep-split (getenv "PATH"))))
+ #t)
+
+(echo "\nEnjoy your test environment. "
+ "Type 'exit' to exit it, it will be cleaned up after you.\n")
+
+(interactive-shell)
diff --git a/tests/tpm2dtests/unimportable.scm b/tests/tpm2dtests/unimportable.scm
new file mode 100644
index 000000000..be84c13c6
--- /dev/null
+++ b/tests/tpm2dtests/unimportable.scm
@@ -0,0 +1,28 @@
+#!/usr/bin/env gpgscm
+
+;; Copyright (C) 2021 James.Bottomley@HansenPartnership.com
+;;
+;; SPDX-License-Identifier: GPL-3.0-or-later
+;;
+(load (in-srcdir "tests" "tpm2dtests" "defs.scm"))
+
+(setup-environment)
+(setenv "PINENTRY_USER_DATA" "this is a password" #t)
+
+;;
+;; Tries to import a selection of keys with no TPM representation
+;; and verifies it fails. There are many unimportable keys, so
+;; save time by only choosing one EC and one RSA one
+;;
+(define key-list '("ed25519" "rsa4096"))
+
+(for-each
+ (lambda(algo)
+ (info "Checking failure to import" algo)
+ (define name algo "<ecc" algo "@example.com>")
+ (call-check `(,@GPG --quick-generate-key ,name ,algo))
+ (let ((result (call-with-io `(,@GPG --command-fd=0 --edit-key ,name "key 0" keytotpm) "y\n")))
+ (if (= 0 (:retcode result))
+ (throw "Importing Key succeeded")
+ (:stderr result))))
+ key-list)
--
2.26.2


_______________________________________________
Gnupg-devel mailing list
Gnupg-devel@gnupg.org
http://lists.gnupg.org/mailman/listinfo/gnupg-devel