[tripe] / server / tests.at

### -*-autotest-*-
###
### Test script for the main server
###
### (c) 2008 Straylight/Edgeware
###

###----- Licensing notice ---------------------------------------------------
###
### This file is part of Trivial IP Encryption (TrIPE).
###
### TrIPE is free software; you can redistribute it and/or modify
### it under the terms of the GNU General Public License as published by
### the Free Software Foundation; either version 2 of the License, or
### (at your option) any later version.
###
### TrIPE 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 TrIPE; if not, write to the Free Software Foundation,
### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

m4_define([nl], [
])

## Configure a directory ready for use by tripe.
m4_define([SETUPDIR], [
  cp $abs_top_srcdir/t/keyring-$1 ./keyring
  key extract -f-secret keyring.pub
])

## Running standard programs with useful options.
m4_define([TRIPE],
  [env TRIPE_PRIVHELPER=$abs_top_builddir/priv/tripe-privhelper \
     $abs_top_builddir/server/tripe -F -d. -aadmin -p0 -b127.0.0.1 -talice])
m4_define([TRIPECTL], [$abs_top_builddir/client/tripectl -d. -aadmin])
m4_define([USLIP], [$abs_top_builddir/uslip/tripe-uslip])
m4_define([PKSTREAM],
  [$abs_top_builddir/pkstream/pkstream -b127.0.0.1 -p127.0.0.1])

## Sequences.  (These are used for testing the replay protection machinery.)
m4_define([R32], [ 0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15   dnl
		  16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31])
m4_define([P32], [21 26 14 12 25 18  2 27 10 31 24 29  0 20 17 11   dnl
		   8  3  7 23 19  1 13 30  6  9  5 22 15 28 16  4])

###--------------------------------------------------------------------------
### Scaffolding for running a TrIPE server.

## WITH_TRIPEX(dir, args, body)
m4_define([WITH_TRIPEX], [

## If this directory doesn't exist then Bad Things will happen.
if test ! -d $1; then
  echo >&2 "server directory \`$1' doesn't exist"
  exit 99
fi

## Remove the status file.  This is how we notice that the server's died.
rm -f $1/server-status
> $1/expected-server-output
> $1/expected-server-errors

## Autotest writes crap to standard output, which we don't want going to the
## server.  So keep a copy of the standard output, do the pipe, and recover
## the old stdout inside the group.
exec 3>&1
{ (
exec 1>&3 3>&-

## Wait for the socket to appear.  Watch for the server crashing during
## initialization.  Busy waiting is evil, but it's the best I can do and
## not sleep for ages.  (Yes, a second on each test group is a long time.)
while test ! -r $1/server-status && test ! -S $1/admin; do :; done

## Make the port number availale.
AT_CHECK([TRIPECTL -d$1 PORT],, [stdout])
mv stdout $1/port

## Test body...
$3

## End of the test, now run the server.  There's an awful hack here.  If a
## process running under strace exits with a signal, then strace will kill
## itself with the same signal -- and therefore clobber the original
## process's core file.  So we arrange to run strace in one directory and
## have the child process run in another.
) && :; } | {
  cd $1
  mkdir -p strace-hack/
  echo TRIPE $2 >&2
  (cd strace-hack/
   ulimit -c hard >/dev/null 2>&1
   strace -f -o ../tripe.trace \
     TRIPE -d.. $2 >../server-output.full 2>../server-errors)
  stat=$?
  echo $stat >server-status
  if test $stat -ne 0; then
    echo "exit status: $stat" >>server-errors
  fi

  ## We interrupt this relatively sensible macro for an especially awful
  ## hack.  The tripe server emits warnings which are often caused by lack of
  ## synchronization between two peers.  These are harmless and shouldn't
  ## cause test failures.  But we shouldn't just trim out all messages that
  ## look like the spurious ones: if they appear when we're not expecting
  ## them, that's bad and they should properly cause a test failure.
  ##
  ## So we use the WARN command to insert magic directives into the server's
  ## message stream.  The directives begin with `WARN USER test'; remaining
  ## tokens may be as follows.
  ##
  ## PUSH		Introduce a new layer of nesting.  Settings between
  ##			this PUSH and the matching POP will be forgotten
  ##			following the POP.
  ##
  ## POP		End a layer of nesting.  See PUSH above.
  ##
  ## IGNORE tokens	Ignore lines which begin with the tokens.
  ##
  ## Token comparison isn't done very well, but it's good enough for these
  ## purposes.
  ##
  ## We also trim out trace lines here, since it's useful to produce them for
  ## debugging purposes and changing or introducing more of them shouldn't
  ## cause failures.
  awk '
	BEGIN {
	  sp = 0;
	  npat = 0;
	}
	$[]1 == "TRACE" { next; }
	$[]1 == "WARN" && $[]2 == "USER" && $[]3 == "test" {
	  if ($[]4 == "PUSH")
	    npatstk[[sp++]] = npat;
	  else if ($[]4 == "IGNORE") {
	    s = "";
	    p = "";
	    for (i = 5; i <= NF; i++) {
	      p = p s $[]i;
	      s = " ";
	    }
	    pat[[npat++]] = p;
	  } else if ($[]4 == "POP")
	    npat = npatstk[[--sp]];
	  next;
	}
	{
	  for (i = 0; i < npat; i++) {
	    n = length(pat[[i]]);
	    if (substr($[]0, 0, n) == pat[[i]])
	      next;
	  }
	  print $[]0;
	}
  ' server-output.full >server-output
}
exec 3>&-

## Now check that the server's output matches our expectations.
mv $1/expected-server-output expout
mv $1/expected-server-errors experr
AT_CHECK([cat $1/server-output; cat >&2 $1/server-errors],,
	 [expout], [experr])
])

## WITH_TRIPE(args, body)
m4_define([WITH_TRIPE], [WITH_TRIPEX([.], [$1], [$2])])

## WITH_2TRIPES(adir, bdir, bothargs, aargs, bargs, body)
m4_define([WITH_2TRIPES],
	  [WITH_TRIPEX([$1], [$3 $4], [WITH_TRIPEX([$2], [$3 $5], [$6])])])

## WITH_3TRIPES(adir, bdir, cdir, allargs, aargs, bargs, cargs, body)
m4_define([WITH_3TRIPES],
	  [WITH_TRIPEX([$1], [$4 $5],
	  [WITH_TRIPEX([$2], [$4 $6],
	  [WITH_TRIPEX([$3], [$4 $7],
	  [$8])])])])

## COMMS_EPING(adir, aname, bdir, bname)
m4_define([COMMS_EPING], [
  AT_CHECK([TRIPECTL -d$1 EPING $4],, [ignore])
  AT_CHECK([TRIPECTL -d$3 EPING $2],, [ignore])
])

## COMMS_SLIP(adir, aname, bdir, bname)
m4_define([COMMS_SLIP], [
  AT_CHECK([echo "from $1" | USLIP -p $1/$4])
  AT_CHECK([USLIP -g $3/$2],, [from $1[]nl])
  AT_CHECK([echo "from $3" | USLIP -p $3/$2])
  AT_CHECK([USLIP -g $1/$4],, [from $3[]nl])
])

## AWAIT_KXDONE(adir, aname, bdir, bname, body)
m4_define([AWAIT_KXDONE], [

  ## Ignore some reports caused by races.
  TRIPECTL -d$3 WARN test PUSH
  TRIPECTL -d$3 WARN test IGNORE WARN KX $2 incorrect cookie
  TRIPECTL -d$3 WARN test IGNORE WARN KX $2 unexpected pre-challenge

  ## Watch for the key-exchange completion announcement in the background.
  COPROCESSES([wait-$1], [
    echo WATCH +n
    while read line; do
      set x $line; shift
      echo >&2 ">>> $line"
      case "$[]1:$[]2:$[]3" in
	OK::) ;;
	NOTE:KXDONE:$4) break ;;
	NOTE:*) ;;
	*) exit 63 ;;
      esac
    done
  ], [
    TRIPECTL -d$1
  ]) & waiter_$1=$!

  $5

  ## Collect the completion announcement.
  wait $waiter_$1; waitrc=$?
  AT_CHECK([echo $waitrc],, [0[]nl])

  ## Be interested in key-exchange warnings again.
  TRIPECTL -d$4 WARN test POP
])

## ESTABLISH(adir, aname, aopts, bdir, bname, bopts, [aport], [bport])
m4_define([ESTABLISH], [

  ## Set up the establishment.
  AWAIT_KXDONE([$1], [$2], [$4], [$5], [
    AT_CHECK([TRIPECTL -d$1 ADD -cork $6 $5 INET 127.0.0.1 \
      m4_if([$8], [], [$(cat $4/port)], [$8])])
    AT_CHECK([TRIPECTL -d$4 ADD $3 $2 INET 127.0.0.1 \
      m4_if([$7], [], [$(cat $1/port)], [$7])])
  ])

  ## Check transport pinging.
  AT_CHECK([TRIPECTL -d$1 PING $5],, [ignore])
  AT_CHECK([TRIPECTL -d$4 PING $2],, [ignore])

  ## Check communication works.
  COMMS_EPING([$1], [$2], [$4], [$5])
  COMMS_SLIP([$1], [$2], [$4], [$5])
])

###--------------------------------------------------------------------------
### Very unpleasant coprocess handling.

## COPROCESSES(TAG, PROC-A, PROC-B)
m4_define([COPROCESSES], [dnl
rm -f pipe-$1; mknod pipe-$1 p
{ { $2 nl } <pipe-$1 | { $3 nl } >pipe-$1; } dnl
])

## TRIPECTL_INTERACT(ARGS, SHELLSTUFF)
m4_define([TRIPECTL_INTERACT], [
  exec 3>&1
  COPROCESSES([client], [exec 4>&1 1>&3 $1], [TRIPECTL $2])
])

## TRIPECTL_COMMAND(CMD, EXPECT)
m4_define([TRIPECTL_COMMAND], [
  AT_CHECK([
    m4_if([$1], [!], [:], [echo "$1" >&4])
    read line
    case "$line" in
      "$2") ;;
      *) echo 2>&1 "submitted $1: expected $2, found $line"; exit 1 ;;
    esac
  ])
  exec 3>&-
])

###--------------------------------------------------------------------------
### Make sure the thing basically works.

AT_SETUP([server basics])
SETUPDIR([alpha])
AT_CHECK([echo port | TRIPE -p54321],, [INFO 54321[]nl[]OK[]nl])
AT_CLEANUP

###--------------------------------------------------------------------------
### Challenges.

AT_SETUP([server challenges])
AT_KEYWORDS([chal])
SETUPDIR([alpha])

WITH_TRIPE(, [
  ## A simple test.
  AT_CHECK([chal=$(TRIPECTL GETCHAL); TRIPECTL checkchal $chal])

  ## A wrong challenge.  (This was valid once, but the probablity that the
  ## server chose the same key is negligible.)
  AT_CHECK([TRIPECTL checkchal AAAAAHyoOL+HMaE0Y9B3ivuszt0], [1],,
	   [tripectl: invalid-challenge[]nl])
  echo WARN CHAL incorrect-tag >>expected-server-output

  ## A duplicated challenge.
  AT_CHECK([
    chal=$(TRIPECTL GETCHAL)
    TRIPECTL CHECKCHAL $chal
    TRIPECTL CHECKCHAL $chal
  ], [1],, [tripectl: invalid-challenge[]nl])
  echo WARN CHAL replay duplicated-sequence >>expected-server-output

  ## Out-of-order reception.  There should be a window of 32 challenges; we
  ## make 33 and check them in a strange order.
  rm -f experr
  echo "tripectl: invalid-challenge" >>experr
  echo "WARN CHAL replay old-sequence" >>expected-server-output
  for i in P32; do
    echo "tripectl: invalid-challenge" >>experr
    echo "WARN CHAL replay duplicated-sequence" >>expected-server-output
  done
  AT_CHECK([

    ## Make the challenges.
    for i in old R32; do TRIPECTL GETCHAL >chal-$i || exit 2; done

    ## Now check them back.
    for i in P32; do TRIPECTL CHECKCHAL $(cat chal-$i) || exit 3; done

    ## Check the one which should have fallen off the front.
    TRIPECTL CHECKCHAL $(cat chal-old) && exit 4

    ## And make sure that the others are now considered duplicates.
    for i in R32; do TRIPECTL CHECKCHAL $(cat chal-$i) && exit 5; done

    ## All done: tidy cruft away.
    rm -f chal-*
    exit 0
  ], [0],, [experr])
])

AT_CLEANUP

###--------------------------------------------------------------------------
### Communication.

AT_SETUP([server communication])
AT_KEYWORDS([comm])
export TRIPE_SLIPIF=USLIP

for p in alice bob; do (mkdir $p; cd $p; SETUPDIR([alpha])); done

WITH_2TRIPES([alice], [bob], [-nslip], [-talice], [-tbob], [
  ESTABLISH([alice], [not-alice], [-key alice],
	    [bob], [bob], [])
])

AT_CLEANUP

###--------------------------------------------------------------------------
### Mobile peer tracking.

AT_SETUP([peer tracking])
AT_KEYWORDS([mobile])
export TRIPE_SLIPIF=USLIP

for p in alice bob carol; do (mkdir $p; cd $p; SETUPDIR([alpha])); done

## WITH_PKSTREAM(adir, aport, bdir, bport, body)
m4_define([WITH_PKSTREAM], [
  echo >&2 "pkstream: $1 <--> :$2 <-pkstream-> :$4 <--> $3"
  PKSTREAM -l$4 127.0.0.1:$4 127.0.0.1:$(cat $3/port)& pkstream_$3_$1=$!
  sleep 1
  PKSTREAM -c127.0.0.1:$4 127.0.0.1:$2 127.0.0.1:$(cat $1/port)&
  pkstream_$1_$3=$!
  set +x
  $5
  kill $pkstream_$3_$1 $pkstream_$1_$3
])

WITH_3TRIPES([alice], [bob], [carol], [-nslip],
	     [-talice], [-tbob], [-tcarol], [

  ## We need an indirection layer between the two peers so that we can
  ## simulate the effects of NAT remapping.  The nearest thing we have to
  ## this is pkstream, so we may as well use that.
  ##
  ## alice <--> :5311 <-pkstream-> :5312 <--> bob
  ## alice <--> :5321 <-pkstream-> :5322 <--> carol

  WITH_PKSTREAM([alice], [5311], [bob], [5312], [
    ESTABLISH([alice], [alice], [], [bob], [bob], [-mobile], [5312], [5311])
  ])

  WITH_PKSTREAM([alice], [5319], [bob], [5312], [
    COMMS_EPING([bob], [bob], [alice], [alice])
    COMMS_SLIP([bob], [bob], [alice], [alice])
  ])

  WITH_PKSTREAM([alice], [5321], [carol], [5322], [
    ESTABLISH([alice], [alice], [], [carol], [carol], [-mobile],
	[5322], [5321])
  ])

  WITH_PKSTREAM([alice], [5311], [bob], [5312], [
  WITH_PKSTREAM([alice], [5321], [carol], [5322], [
    COMMS_EPING([bob], [bob], [alice], [alice])
    COMMS_EPING([carol], [carol], [alice], [alice])
    COMMS_SLIP([bob], [bob], [alice], [alice])
    COMMS_SLIP([carol], [carol], [alice], [alice])
  ])])

  WITH_PKSTREAM([alice], [5321], [bob], [5312], [
  WITH_PKSTREAM([alice], [5311], [carol], [5322], [
    COMMS_EPING([bob], [bob], [alice], [alice])
    COMMS_EPING([carol], [carol], [alice], [alice])
    COMMS_SLIP([bob], [bob], [alice], [alice])
    COMMS_SLIP([carol], [carol], [alice], [alice])
  ])])
  wait
])

AT_CLEANUP

###--------------------------------------------------------------------------
### Services.

AT_SETUP([server services])
AT_KEYWORDS([svc])
SETUPDIR([alpha])

WITH_TRIPE(, [

  ## Make sure it's not running yet.
  AT_CHECK([TRIPECTL SVCENSURE test], [1],,
	   [tripectl: unknown-service test[]nl])

  ## Run a simple service.
  rm -f svc-test-running tripectl-status
  COPROCESSES([svc], [
    echo SVCCLAIM test 1.0.0
    read line
    case "$line" in
      OK)
	;;
      *)
	echo >&2 "SVCCLAIM failed: $line"
	exit 1
	;;
    esac
    echo ok >svc-test-running
    while read line; do
      set -- $line
      case "$[]1,$[]3,$[]4" in
	SVCJOB,test,HELP)
	  echo SVCINFO try not to use this service for anything useful
	  echo SVCOK $[]2
	  ;;
	SVCJOB,test,GOOD)
	  echo SVCOK $[]2
	  ;;
	SVCJOB,test,BAD)
	  echo SVCFAIL $[]2 this-command-always-fails
	  ;;
	SVCJOB,test,UGLY)
	  tag=$2
	  while read line; do
	    set -- $line
	    case "$[]1,$[]2,$[]3,$[]4" in
	      SVCCANCEL,$tag,,) break ;;
	      SVCJOB,*,test,ESCAPE)
		echo >&2 "attempt to escape from alkatraz"
		exit 1
		;;
	    esac
	  done
	  ;;
	SVCJOB,test,FIRST)
	  firsttag=$[]2
	  ;;
	SVCJOB,test,SECOND)
	  echo SVCOK $firsttag
	  echo SVCOK $[]2
	  ;;
	SVCJOB,*)
	  echo SVCFAIL $[]2 unknown-svc-command $[]4
	  ;;
	SVCCLAIM,*)
	  break
	  ;;
	OK,* | INFO,*)
	  ;;
	FAIL,*)
	  echo "failure in service: $line" >&2
	  ;;
      esac
    done
  ], [
    TRIPECTL; echo $? >tripectl-status
  ]) 2>tripectl-errors &

  ## Wait until it starts up.
  while test ! -r svc-test-running && test ! -r tripectl-status; do :; done

  ## Make sure it's running.
  AT_CHECK([TRIPECTL SVCQUERY test],, [name=test version=1.0.0[]nl])

  ## Try some simple commands.
  AT_CHECK([TRIPECTL SVCSUBMIT test GOOD])
  AT_CHECK([TRIPECTL SVCSUBMIT test BAD], [1],,
	   [tripectl: this-command-always-fails[]nl])

  ## And now with commands in the background.
  TRIPECTL_INTERACT([
    TRIPECTL_COMMAND([SVCSUBMIT test GOOD], [OK])
    TRIPECTL_COMMAND([SVCSUBMIT -background foo test UGLY], [BGDETACH foo])
    TRIPECTL_COMMAND([BGCANCEL foo], [OK])
    TRIPECTL_COMMAND([SVCSUBMIT test ESCAPE],
		     [FAIL unknown-svc-command ESCAPE])
  ])

  ## Out-of-order completion.
  TRIPECTL_INTERACT([
    TRIPECTL_COMMAND([SVCSUBMIT -background one test FIRST], [BGDETACH one])
    TRIPECTL_COMMAND([SVCSUBMIT -background two test SECOND], [BGDETACH two])
    TRIPECTL_COMMAND([!], [BGOK one])
    TRIPECTL_COMMAND([!], [BGOK two])
  ])

  ## All done.
  exit 0
])

AT_CLEANUP

###----- That's all, folks --------------------------------------------------
Commit	Line	Data
5d85da1c MW	1	### --autotest--
	2	###
	3	### Test script for the main server
	4	###
	5	### (c) 2008 Straylight/Edgeware
	6	###
	7
	8	###----- Licensing notice ---------------------------------------------------
	9	###
	10	### This file is part of Trivial IP Encryption (TrIPE).
	11	###
	12	### TrIPE is free software; you can redistribute it and/or modify
	13	### it under the terms of the GNU General Public License as published by
	14	### the Free Software Foundation; either version 2 of the License, or
	15	### (at your option) any later version.
	16	###
	17	### TrIPE is distributed in the hope that it will be useful,
	18	### but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	### GNU General Public License for more details.
	21	###
	22	### You should have received a copy of the GNU General Public License
	23	### along with TrIPE; if not, write to the Free Software Foundation,
	24	### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	25
	26	m4_define([nl], [
	27	])
	28
	29	## Configure a directory ready for use by tripe.
	30	m4_define([SETUPDIR], [
	31	cp $abs_top_srcdir/t/keyring-$1 ./keyring
	32	key extract -f-secret keyring.pub
	33	])
	34
	35	## Running standard programs with useful options.
	36	m4_define([TRIPE],
388e0319 MW	37	[env TRIPE_PRIVHELPER=$abs_top_builddir/priv/tripe-privhelper \
388e0319 MW	38	$abs_top_builddir/server/tripe -F -d. -aadmin -p0 -b127.0.0.1 -talice])
5d85da1c MW	39	m4_define([TRIPECTL], [$abs_top_builddir/client/tripectl -d. -aadmin])
5d85da1c MW	40	m4_define([USLIP], [$abs_top_builddir/uslip/tripe-uslip])
01c21903 MW	41	m4_define([PKSTREAM],
01c21903 MW	42	[$abs_top_builddir/pkstream/pkstream -b127.0.0.1 -p127.0.0.1])
5d85da1c MW	43
	44	## Sequences. (These are used for testing the replay protection machinery.)
	45	m4_define([R32], [ 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 dnl
	46	16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31])
	47	m4_define([P32], [21 26 14 12 25 18 2 27 10 31 24 29 0 20 17 11 dnl
	48	8 3 7 23 19 1 13 30 6 9 5 22 15 28 16 4])
	49
	50	###--------------------------------------------------------------------------
	51	### Scaffolding for running a TrIPE server.
	52
05d4b7da	53	## WITH_TRIPEX(dir, args, body)
5d85da1c MW	54	m4_define([WITH_TRIPEX], [
5d85da1c MW	55
05d4b7da MW	56	## If this directory doesn't exist then Bad Things will happen.
	57	if test ! -d $1; then
	58	echo >&2 "server directory \`$1' doesn't exist"
	59	exit 99
	60	fi
	61
5d85da1c MW	62	## Remove the status file. This is how we notice that the server's died.
	63	rm -f $1/server-status
	64	> $1/expected-server-output
	65	> $1/expected-server-errors
	66
768a2316 MW	67	## Autotest writes crap to standard output, which we don't want going to the
	68	## server. So keep a copy of the standard output, do the pipe, and recover
	69	## the old stdout inside the group.
5d85da1c MW	70	exec 3>&1
	71	{ (
	72	exec 1>&3 3>&-
	73
	74	## Wait for the socket to appear. Watch for the server crashing during
	75	## initialization. Busy waiting is evil, but it's the best I can do and
	76	## not sleep for ages. (Yes, a second on each test group is a long time.)
768a2316	77	while test ! -r $1/server-status && test ! -S $1/admin; do :; done
5d85da1c	78
05d4b7da MW	79	## Make the port number availale.
	80	AT_CHECK([TRIPECTL -d$1 PORT],, [stdout])
	81	mv stdout $1/port
	82
5d85da1c MW	83	## Test body...
	84	$3
	85
96f1fb57 MW	86	## End of the test, now run the server. There's an awful hack here. If a
	87	## process running under strace exits with a signal, then strace will kill
	88	## itself with the same signal -- and therefore clobber the original
	89	## process's core file. So we arrange to run strace in one directory and
	90	## have the child process run in another.
5d85da1c MW	91	) && :; } \| {
5d85da1c MW	92	cd $1
96f1fb57	93	mkdir -p strace-hack/
5d85da1c	94	echo TRIPE $2 >&2
96f1fb57 MW	95	(cd strace-hack/
	96	ulimit -c hard >/dev/null 2>&1
	97	strace -f -o ../tripe.trace \
05d4b7da	98	TRIPE -d.. $2 >../server-output.full 2>../server-errors)
5d85da1c MW	99	stat=$?
	100	echo $stat >server-status
	101	if test $stat -ne 0; then
	102	echo "exit status: $stat" >>server-errors
	103	fi
05d4b7da MW	104
	105	## We interrupt this relatively sensible macro for an especially awful
	106	## hack. The tripe server emits warnings which are often caused by lack of
	107	## synchronization between two peers. These are harmless and shouldn't
	108	## cause test failures. But we shouldn't just trim out all messages that
	109	## look like the spurious ones: if they appear when we're not expecting
	110	## them, that's bad and they should properly cause a test failure.
	111	##
	112	## So we use the WARN command to insert magic directives into the server's
	113	## message stream. The directives begin with `WARN USER test'; remaining
	114	## tokens may be as follows.
	115	##
	116	## PUSH Introduce a new layer of nesting. Settings between
	117	## this PUSH and the matching POP will be forgotten
	118	## following the POP.
	119	##
	120	## POP End a layer of nesting. See PUSH above.
	121	##
	122	## IGNORE tokens Ignore lines which begin with the tokens.
	123	##
	124	## Token comparison isn't done very well, but it's good enough for these
	125	## purposes.
	126	##
	127	## We also trim out trace lines here, since it's useful to produce them for
	128	## debugging purposes and changing or introducing more of them shouldn't
	129	## cause failures.
	130	awk '
	131	BEGIN {
	132	sp = 0;
	133	npat = 0;
	134	}
	135	$[]1 == "TRACE" { next; }
	136	$[]1 == "WARN" && $[]2 == "USER" && $[]3 == "test" {
	137	if ($[]4 == "PUSH")
	138	npatstk[[sp++]] = npat;
	139	else if ($[]4 == "IGNORE") {
	140	s = "";
	141	p = "";
	142	for (i = 5; i <= NF; i++) {
	143	p = p s $[]i;
	144	s = " ";
	145	}
	146	pat[[npat++]] = p;
	147	} else if ($[]4 == "POP")
	148	npat = npatstk[[--sp]];
	149	next;
	150	}
	151	{
	152	for (i = 0; i < npat; i++) {
	153	n = length(pat[[i]]);
	154	if (substr($[]0, 0, n) == pat[[i]])
	155	next;
	156	}
	157	print $[]0;
	158	}
	159	' server-output.full >server-output
5d85da1c MW	160	}
	161	exec 3>&-
	162
	163	## Now check that the server's output matches our expectations.
	164	mv $1/expected-server-output expout
	165	mv $1/expected-server-errors experr
	166	AT_CHECK([cat $1/server-output; cat >&2 $1/server-errors],,
	167	[expout], [experr])
	168	])
	169
05d4b7da	170	## WITH_TRIPE(args, body)
5d85da1c MW	171	m4_define([WITH_TRIPE], [WITH_TRIPEX([.], [$1], [$2])])
5d85da1c MW	172
05d4b7da	173	## WITH_2TRIPES(adir, bdir, bothargs, aargs, bargs, body)
5d85da1c MW	174	m4_define([WITH_2TRIPES],
	175	[WITH_TRIPEX([$1], [$3 $4], [WITH_TRIPEX([$2], [$3 $5], [$6])])])
	176
203e1b1f MW	177	## WITH_3TRIPES(adir, bdir, cdir, allargs, aargs, bargs, cargs, body)
	178	m4_define([WITH_3TRIPES],
	179	[WITH_TRIPEX([$1], [$4 $5],
	180	[WITH_TRIPEX([$2], [$4 $6],
	181	[WITH_TRIPEX([$3], [$4 $7],
	182	[$8])])])])
	183
05d4b7da MW	184	## COMMS_EPING(adir, aname, bdir, bname)
	185	m4_define([COMMS_EPING], [
	186	AT_CHECK([TRIPECTL -d$1 EPING $4],, [ignore])
	187	AT_CHECK([TRIPECTL -d$3 EPING $2],, [ignore])
	188	])
	189
	190	## COMMS_SLIP(adir, aname, bdir, bname)
	191	m4_define([COMMS_SLIP], [
	192	AT_CHECK([echo "from $1" \| USLIP -p $1/$4])
	193	AT_CHECK([USLIP -g $3/$2],, [from $1[]nl])
	194	AT_CHECK([echo "from $3" \| USLIP -p $3/$2])
	195	AT_CHECK([USLIP -g $1/$4],, [from $3[]nl])
	196	])
	197
	198	## AWAIT_KXDONE(adir, aname, bdir, bname, body)
	199	m4_define([AWAIT_KXDONE], [
	200
	201	## Ignore some reports caused by races.
	202	TRIPECTL -d$3 WARN test PUSH
	203	TRIPECTL -d$3 WARN test IGNORE WARN KX $2 incorrect cookie
	204	TRIPECTL -d$3 WARN test IGNORE WARN KX $2 unexpected pre-challenge
	205
	206	## Watch for the key-exchange completion announcement in the background.
	207	COPROCESSES([wait-$1], [
	208	echo WATCH +n
	209	while read line; do
	210	set x $line; shift
	211	echo >&2 ">>> $line"
	212	case "$[]1:$[]2:$[]3" in
	213	OK::) ;;
	214	NOTE:KXDONE:$4) break ;;
	215	NOTE:*) ;;
	216	*) exit 63 ;;
	217	esac
	218	done
	219	], [
	220	TRIPECTL -d$1
	221	]) & waiter_$1=$!
	222
	223	$5
	224
	225	## Collect the completion announcement.
	226	wait $waiter_$1; waitrc=$?
	227	AT_CHECK([echo $waitrc],, [0[]nl])
	228
	229	## Be interested in key-exchange warnings again.
	230	TRIPECTL -d$4 WARN test POP
	231	])
	232
01c21903	233	## ESTABLISH(adir, aname, aopts, bdir, bname, bopts, [aport], [bport])
05d4b7da MW	234	m4_define([ESTABLISH], [
	235
	236	## Set up the establishment.
	237	AWAIT_KXDONE([$1], [$2], [$4], [$5], [
01c21903 MW	238	AT_CHECK([TRIPECTL -d$1 ADD -cork $6 $5 INET 127.0.0.1 \
	239	m4_if([$8], [], [$(cat $4/port)], [$8])])
	240	AT_CHECK([TRIPECTL -d$4 ADD $3 $2 INET 127.0.0.1 \
	241	m4_if([$7], [], [$(cat $1/port)], [$7])])
05d4b7da MW	242	])
	243
	244	## Check transport pinging.
	245	AT_CHECK([TRIPECTL -d$1 PING $5],, [ignore])
	246	AT_CHECK([TRIPECTL -d$4 PING $2],, [ignore])
	247
	248	## Check communication works.
	249	COMMS_EPING([$1], [$2], [$4], [$5])
	250	COMMS_SLIP([$1], [$2], [$4], [$5])
	251	])
	252
5d85da1c MW	253	###--------------------------------------------------------------------------
	254	### Very unpleasant coprocess handling.
	255
	256	## COPROCESSES(TAG, PROC-A, PROC-B)
	257	m4_define([COPROCESSES], [dnl
	258	rm -f pipe-$1; mknod pipe-$1 p
	259	{ { $2 nl } <pipe-$1 \| { $3 nl } >pipe-$1; } dnl
	260	])
	261
	262	## TRIPECTL_INTERACT(ARGS, SHELLSTUFF)
	263	m4_define([TRIPECTL_INTERACT], [
768a2316	264	exec 3>&1
11715242	265	COPROCESSES([client], [exec 4>&1 1>&3 $1], [TRIPECTL $2])
5d85da1c MW	266	])
	267
	268	## TRIPECTL_COMMAND(CMD, EXPECT)
	269	m4_define([TRIPECTL_COMMAND], [
	270	AT_CHECK([
	271	m4_if([$1], [!], [:], [echo "$1" >&4])
	272	read line
	273	case "$line" in
	274	"$2") ;;
	275	*) echo 2>&1 "submitted $1: expected $2, found $line"; exit 1 ;;
	276	esac
	277	])
	278	exec 3>&-
	279	])
	280
	281	###--------------------------------------------------------------------------
	282	### Make sure the thing basically works.
	283
	284	AT_SETUP([server basics])
59d05259	285	SETUPDIR([alpha])
5d85da1c MW	286	AT_CHECK([echo port \| TRIPE -p54321],, [INFO 54321[]nl[]OK[]nl])
	287	AT_CLEANUP
	288
	289	###--------------------------------------------------------------------------
	290	### Challenges.
	291
	292	AT_SETUP([server challenges])
	293	AT_KEYWORDS([chal])
59d05259	294	SETUPDIR([alpha])
5d85da1c MW	295
	296	WITH_TRIPE(, [
	297	## A simple test.
	298	AT_CHECK([chal=$(TRIPECTL GETCHAL); TRIPECTL checkchal $chal])
	299
	300	## A wrong challenge. (This was valid once, but the probablity that the
	301	## server chose the same key is negligible.)
	302	AT_CHECK([TRIPECTL checkchal AAAAAHyoOL+HMaE0Y9B3ivuszt0], [1],,
	303	[tripectl: invalid-challenge[]nl])
	304	echo WARN CHAL incorrect-tag >>expected-server-output
	305
	306	## A duplicated challenge.
	307	AT_CHECK([
	308	chal=$(TRIPECTL GETCHAL)
	309	TRIPECTL CHECKCHAL $chal
	310	TRIPECTL CHECKCHAL $chal
	311	], [1],, [tripectl: invalid-challenge[]nl])
	312	echo WARN CHAL replay duplicated-sequence >>expected-server-output
	313
	314	## Out-of-order reception. There should be a window of 32 challenges; we
	315	## make 33 and check them in a strange order.
	316	rm -f experr
	317	echo "tripectl: invalid-challenge" >>experr
	318	echo "WARN CHAL replay old-sequence" >>expected-server-output
	319	for i in P32; do
	320	echo "tripectl: invalid-challenge" >>experr
	321	echo "WARN CHAL replay duplicated-sequence" >>expected-server-output
	322	done
	323	AT_CHECK([
	324
	325	## Make the challenges.
	326	for i in old R32; do TRIPECTL GETCHAL >chal-$i \|\| exit 2; done
	327
	328	## Now check them back.
	329	for i in P32; do TRIPECTL CHECKCHAL $(cat chal-$i) \|\| exit 3; done
	330
	331	## Check the one which should have fallen off the front.
	332	TRIPECTL CHECKCHAL $(cat chal-old) && exit 4
	333
	334	## And make sure that the others are now considered duplicates.
	335	for i in R32; do TRIPECTL CHECKCHAL $(cat chal-$i) && exit 5; done
	336
	337	## All done: tidy cruft away.
	338	rm -f chal-*
	339	exit 0
	340	], [0],, [experr])
	341	])
	342
	343	AT_CLEANUP
	344
	345	###--------------------------------------------------------------------------
	346	### Communication.
	347
	348	AT_SETUP([server communication])
	349	AT_KEYWORDS([comm])
	350	export TRIPE_SLIPIF=USLIP
	351
59d05259	352	for p in alice bob; do (mkdir $p; cd $p; SETUPDIR([alpha])); done
5d85da1c MW	353
5d85da1c MW	354	WITH_2TRIPES([alice], [bob], [-nslip], [-talice], [-tbob], [
05d4b7da MW	355	ESTABLISH([alice], [not-alice], [-key alice],
05d4b7da MW	356	[bob], [bob], [])
5d85da1c MW	357	])
	358
	359	AT_CLEANUP
	360
01c21903 MW	361	###--------------------------------------------------------------------------
	362	### Mobile peer tracking.
	363
	364	AT_SETUP([peer tracking])
	365	AT_KEYWORDS([mobile])
	366	export TRIPE_SLIPIF=USLIP
	367
	368	for p in alice bob carol; do (mkdir $p; cd $p; SETUPDIR([alpha])); done
	369
	370	## WITH_PKSTREAM(adir, aport, bdir, bport, body)
	371	m4_define([WITH_PKSTREAM], [
	372	echo >&2 "pkstream: $1 <--> :$2 <-pkstream-> :$4 <--> $3"
	373	PKSTREAM -l$4 127.0.0.1:$4 127.0.0.1:$(cat $3/port)& pkstream_$3_$1=$!
	374	sleep 1
	375	PKSTREAM -c127.0.0.1:$4 127.0.0.1:$2 127.0.0.1:$(cat $1/port)&
	376	pkstream_$1_$3=$!
	377	set +x
	378	$5
	379	kill $pkstream_$3_$1 $pkstream_$1_$3
	380	])
	381
	382	WITH_3TRIPES([alice], [bob], [carol], [-nslip],
	383	[-talice], [-tbob], [-tcarol], [
	384
	385	## We need an indirection layer between the two peers so that we can
	386	## simulate the effects of NAT remapping. The nearest thing we have to
	387	## this is pkstream, so we may as well use that.
	388	##
	389	## alice <--> :5311 <-pkstream-> :5312 <--> bob
	390	## alice <--> :5321 <-pkstream-> :5322 <--> carol
	391
	392	WITH_PKSTREAM([alice], [5311], [bob], [5312], [
	393	ESTABLISH([alice], [alice], [], [bob], [bob], [-mobile], [5312], [5311])
	394	])
	395
	396	WITH_PKSTREAM([alice], [5319], [bob], [5312], [
	397	COMMS_EPING([bob], [bob], [alice], [alice])
	398	COMMS_SLIP([bob], [bob], [alice], [alice])
	399	])
	400
	401	WITH_PKSTREAM([alice], [5321], [carol], [5322], [
	402	ESTABLISH([alice], [alice], [], [carol], [carol], [-mobile],
	403	[5322], [5321])
	404	])
	405
	406	WITH_PKSTREAM([alice], [5311], [bob], [5312], [
	407	WITH_PKSTREAM([alice], [5321], [carol], [5322], [
	408	COMMS_EPING([bob], [bob], [alice], [alice])
	409	COMMS_EPING([carol], [carol], [alice], [alice])
	410	COMMS_SLIP([bob], [bob], [alice], [alice])
	411	COMMS_SLIP([carol], [carol], [alice], [alice])
	412	])])
	413
	414	WITH_PKSTREAM([alice], [5321], [bob], [5312], [
	415	WITH_PKSTREAM([alice], [5311], [carol], [5322], [
	416	COMMS_EPING([bob], [bob], [alice], [alice])
	417	COMMS_EPING([carol], [carol], [alice], [alice])
	418	COMMS_SLIP([bob], [bob], [alice], [alice])
	419	COMMS_SLIP([carol], [carol], [alice], [alice])
	420	])])
	421	wait
	422	])
	423
	424	AT_CLEANUP
425
5d85da1c MW	426	###--------------------------------------------------------------------------
	427	### Services.
	428
	429	AT_SETUP([server services])
	430	AT_KEYWORDS([svc])
59d05259	431	SETUPDIR([alpha])
5d85da1c MW	432
	433	WITH_TRIPE(, [
	434
	435	## Make sure it's not running yet.
	436	AT_CHECK([TRIPECTL SVCENSURE test], [1],,
	437	[tripectl: unknown-service test[]nl])
	438
	439	## Run a simple service.
	440	rm -f svc-test-running tripectl-status
	441	COPROCESSES([svc], [
	442	echo SVCCLAIM test 1.0.0
	443	read line
	444	case "$line" in
	445	OK)
2f20abf2	446	;;
5d85da1c	447	*)
2f20abf2	448	echo >&2 "SVCCLAIM failed: $line"
5d85da1c MW	449	exit 1
	450	;;
	451	esac
	452	echo ok >svc-test-running
	453	while read line; do
	454	set -- $line
	455	case "$[]1,$[]3,$[]4" in
	456	SVCJOB,test,HELP)
	457	echo SVCINFO try not to use this service for anything useful
	458	echo SVCOK $[]2
	459	;;
	460	SVCJOB,test,GOOD)
	461	echo SVCOK $[]2
	462	;;
	463	SVCJOB,test,BAD)
	464	echo SVCFAIL $[]2 this-command-always-fails
	465	;;
	466	SVCJOB,test,UGLY)
	467	tag=$2
	468	while read line; do
	469	set -- $line
	470	case "$[]1,$[]2,$[]3,$[]4" in
	471	SVCCANCEL,$tag,,) break ;;
	472	SVCJOB,*,test,ESCAPE)
2f20abf2	473	echo >&2 "attempt to escape from alkatraz"
5d85da1c MW	474	exit 1
	475	;;
	476	esac
	477	done
	478	;;
	479	SVCJOB,test,FIRST)
	480	firsttag=$[]2
	481	;;
	482	SVCJOB,test,SECOND)
	483	echo SVCOK $firsttag
	484	echo SVCOK $[]2
	485	;;
	486	SVCJOB,*)
	487	echo SVCFAIL $[]2 unknown-svc-command $[]4
	488	;;
	489	SVCCLAIM,*)
	490	break
	491	;;
	492	OK,* \| INFO,*)
	493	;;
	494	FAIL,*)
	495	echo "failure in service: $line" >&2
	496	;;
	497	esac
	498	done
	499	], [
	500	TRIPECTL; echo $? >tripectl-status
	501	]) 2>tripectl-errors &
	502
	503	## Wait until it starts up.
	504	while test ! -r svc-test-running && test ! -r tripectl-status; do :; done
	505
	506	## Make sure it's running.
	507	AT_CHECK([TRIPECTL SVCQUERY test],, [name=test version=1.0.0[]nl])
	508
	509	## Try some simple commands.
	510	AT_CHECK([TRIPECTL SVCSUBMIT test GOOD])
	511	AT_CHECK([TRIPECTL SVCSUBMIT test BAD], [1],,
	512	[tripectl: this-command-always-fails[]nl])
	513
	514	## And now with commands in the background.
	515	TRIPECTL_INTERACT([
	516	TRIPECTL_COMMAND([SVCSUBMIT test GOOD], [OK])
	517	TRIPECTL_COMMAND([SVCSUBMIT -background foo test UGLY], [BGDETACH foo])
	518	TRIPECTL_COMMAND([BGCANCEL foo], [OK])
	519	TRIPECTL_COMMAND([SVCSUBMIT test ESCAPE],
	520	[FAIL unknown-svc-command ESCAPE])
	521	])
	522
	523	## Out-of-order completion.
	524	TRIPECTL_INTERACT([
	525	TRIPECTL_COMMAND([SVCSUBMIT -background one test FIRST], [BGDETACH one])
	526	TRIPECTL_COMMAND([SVCSUBMIT -background two test SECOND], [BGDETACH two])
	527	TRIPECTL_COMMAND([!], [BGOK one])
	528	TRIPECTL_COMMAND([!], [BGOK two])
	529	])
	530
	531	## All done.
	532	exit 0
	533	])
	534
	535	AT_CLEANUP
	536
	537	###----- That's all, folks --------------------------------------------------