#!/usr/bin/perl
#
# Copyright (C) 2002, 2003, 2004, 2005 Yokogawa Electric Corporation, 
# INTAP(Interoperability Technology Association for Information 
# Processing, Japan), IPA (Information-technology Promotion Agency, Japan).
# All rights reserved.
# 
# Redistribution and use of this software in source and binary forms, with 
# or without modification, are permitted provided that the following 
# conditions and disclaimer are agreed and accepted by the user:
# 
# 1. Redistributions of source code must retain the above copyright 
# notice, this list of conditions and the following disclaimer.
# 
# 2. Redistributions in binary form must reproduce the above copyright 
# notice, this list of conditions and the following disclaimer in the 
# documentation and/or other materials provided with the distribution.
# 
# 3. Neither the names of the copyrighters, the name of the project which 
# is related to this software (hereinafter referred to as "project") nor 
# the names of the contributors may be used to endorse or promote products 
# derived from this software without specific prior written permission.
# 
# 4. No merchantable use may be permitted without prior written 
# notification to the copyrighters. However, using this software for the 
# purpose of testing or evaluating any products including merchantable 
# products may be permitted without any notification to the copyrighters.
# 
# 
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHTERS, THE PROJECT AND 
# CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING 
# BUT NOT LIMITED THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
# FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.  IN NO EVENT SHALL THE 
# COPYRIGHTERS, THE PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
# CONTRACT,STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
# THE POSSIBILITY OF SUCH DAMAGE.
#
# $TAHI: ct/ipsec/HTR_E_In_ReceiveWindow.seq,v 1.2 2003/06/05 13:42:45 ozoe Exp $
#
######################################################################
BEGIN {
    unshift(@INC, '../ipsec/');
    $V6evalTool::TestVersion = '$Name: REL_2_1_2 $ ';
}

use V6evalTool;
use IPSEC;

%pktdesc = (
            ### TBD
);

$IF = Link0;

#----- check NUT type

ipsecCheckNUT(host);

#----- set SAD,SPD
vLogHTML("<FONT SIZE=3>*** Target initialization phase ***</FONT><BR>");

ipsecClearAll();

## HOST1 vs NUT
ipsecSetSAD(
	"src=$IPSEC::IPsecAddr{IPSEC_HOST1_NET5_ADDR}" ,
	"dst=$IPSEC::IPsecAddr{IPSEC_NUT_NET3_ADDR}" ,
	"spi=0x1000" ,
	"mode=transport" ,
	"protocol=esp" ,
	"rsize=4" ,
	"ealgo=null" ,
        "eauth=hmac-md5" ,
        "eauthkey=TAHITEST89ABCDEF"
	);

ipsecSetSPD(
	"src=$IPSEC::IPsecAddr{IPSEC_HOST1_NET5_ADDR}" ,
	"dst=$IPSEC::IPsecAddr{IPSEC_NUT_NET3_ADDR}" ,
	"upperspec=any" ,
	"direction=in" ,
	"protocol=esp-auth" ,
	"mode=transport" ,
	);

#======================================================================

vLogHTML("<FONT SIZE=3>*** Target testing phase ***<FONT><BR>");

#----- start capturing

vCapture($IF);

$seq = 0;
vCPP("-DSEQ=$seq");

if ($IPSEC::IPsecAddr{IPSEC_IPVERSION} == 4) {
} else {
## RA

vSend($IF, ra_to_nut);
vSleep(3);
}

$seq = 4294967295;

vLogHTML("<B>Sequence number = $seq</B>");

vCPP("-DSEQ=$seq");

# ping TN(Host1) <-> NUT

($stat, %ret) = ipsecPing2NUT($IF, 'echo_request_from_host1_esp_2', 'echo_reply_to_host1');

if ($stat eq 'NO_REPLY') {
    vLogHTML("TN received no echo reply from NUT to HOST1.<BR>");
    vLogHTML("TUN doesn't shift receive window.<BR>");
    vLogHTML('<B>OK</B>');
}

if ($stat eq 'GOT_REPLY') {
    vLogHTML("TN received echo reply from NUT to HOST1.<BR>");
    vLogHTML("TUN shifts receive window.<BR>");
    vLogHTML('<B>OK</B>');
}

######################################################################

vClear($IF);

$seq = 1;

vLogHTML("<B>Sequence number = $seq</B>");

vCPP("-DSEQ=$seq");

# ping TN(Host1) <-> NUT

($stat, %ret) = ipsecPing2NUT($IF, 'echo_request_from_host1_esp_2', 'echo_reply_to_host1');

if ($stat eq 'GOT_REPLY') {
    vLogHTML("TN received echo reply from NUT to HOST1.<BR>");
    vLogHTML("TUN seemes to expand receive window to maximum size.<BR>");
    vLogHTML('<B>OK</B>');
    ipsecExitIgnore();
}

if ($stat eq 'NO_REPLY') {
    vLogHTML("TN received no echo reply from NUT to HOST1.<BR>");
    vLogHTML("TUN seems to shift receive window.<BR>");
    vLogHTML("TUN ignored left side sequence packet of receive window.<BR>");
    vLogHTML('<B>OK</B>');
    ipsecExitIgnore();
}

ipsecExitFail();

######################################################################
__END__

=head1 NAME

  HTR_E_In_ReceiveWindow - Host Transport Mode ESP (NULL), Inbound Expand or Shift Receive Window

=head1 TARGET

  Host

=head1 SYNOPSIS

=begin html
<PRE>
  <A HREF="./HTR_E_In_ReceiveWindow.seq">HTR_E_In_ReceiveWindow.seq</A> [-tooloption ...] -pkt <A HREF="./HTR_E_ReceiveWindow.def">HTR_E_ReceiveWindow.def</A>
    -tooloption : v6eval tool option
  See also <A HREF="./HTR_E_common.def">HTR_E_common.def</A> and <A HREF="./HTR_common.def">HTR_common.def</A>
</PRE>

=end html

=head1 INITIALIZATION

=begin html
<P>
For details of Network Topology, see <A HREF="00README">00README</A>
</P>
<P>
Set NUT's SAD and SPD as following:
</P>
<PRE>
              NET5      NET3
    HOST1_NET5 -- Router -- NUT
         -----transport----->
</PRE>
<P>
Security Association Database (SAD)
</P>
<TABLE border="1">
  <TR>
    <TD>source address</TD>
    <TD>HOST1_NET5</TD></TR>
  <TR>
    <TD>destination address</TD>
    <TD>NUT_NET3</TD></TR>
  <TR>
    <TD>SPI</TD>
    <TD>0x1000</TD></TR>
  <TR>
    <TD>mode</TD>
    <TD>transport</TD></TR>
  <TR>
    <TD>protocol</TD>
    <TD>ESP</TD></TR>
  <TR>
    <TD>ESP algorithm</TD>
    <TD>NULL</TD></TR>
  <TR>
    <TD>ESP authentication</TD>
    <TD>HMAC-MD5</TD></TR>
  <TR>
    <TD>ESP authentication key</TD>
    <TD>TAHITEST89ABCDEF</TD></TR>
</TABLE>
<P>
Security Policy Database (SPD)
</P>
<TABLE border="1">
  <TR>
    <TD>source address</TD>
    <TD>HOST1_NET5</TD></TR>
  <TR>
    <TD>destination address</TD>
    <TD>NUT_NET3</TD></TR>
  <TR>
    <TD>upper spec</TD>
    <TD>any</TD></TR>
  <TR>
    <TD>direction</TD>
    <TD>in</TD></TR>
  <TR>
    <TD>protocol</TD>
    <TD>ESP</TD></TR>
  <TR>
    <TD>mode</TD>
    <TD>transport</TD></TR>
</TABLE>

=end html

=head1 TEST PROCEDURE

=begin html
<PRE>
 Tester                      Target
   |                           |
   |-------------------------->|
   |      ICMP Echo Request    |
   |( with ESP, SEQ=4294967295)|
   |                           |
   |<------------------------- |
   |     no ICMP Echo Reply?   |
   |                           |
   |-------------------------->|
   |      ICMP Echo Request    |
   |    ( with ESP, SEQ=1 )    |
   |                           |
   | (<----------------------) |
   |     no ICMP Echo Reply?   |
   |                           |
   v                           v
</PRE>
<OL>
  <LI>Send ICMP Echo Request with ESP
  <LI>Receive Nothing or Not
</OL>
<P>
ICMP Echo Request with ESP
</P>
<TABLE border="1">
  <TR>
    <TD>IP Header</TD>
    <TD>Source Address</TD>
    <TD>HOST1_NET5</TD></TR>
  <TR>
    <TD></TD>
    <TD>Destination Address</TD>
    <TD>NUT_NET3</TD></TR>
  <TR>
    <TD>ESP</TD>
    <TD>SPI</TD>
    <TD>0x1000</TD></TR>
  <TR>
    <TD></TD>
    <TD>Sequence Number</TD>
    <TD>4294967295->1</TD></TR>
  <TR>
    <TD></TD>
    <TD>Receive window size</TD>
    <TD>32</TD></TR>
  <TR>
    <TD></TD>
    <TD>Algorithm</TD>
    <TD>NULL</TD></TR>
  <TR>
    <TD></TD>
    <TD>ESP authentication</TD>
    <TD>HMAC-MD5</TD></TR>
  <TR>
    <TD></TD>
    <TD>ESP authentication key</TD>
    <TD>TAHITEST89ABCDEF</TD></TR>
  <TR>
    <TD></TD>
    <TD>Padding</TD>
    <TD>Zero</TD></TR>
  <TR>
    <TD></TD>
    <TD>Padding Length</TD>
    <TD>0</TD></TR>
  <TR>
    <TD>ICMP</TD>
    <TD>Type</TD>
    <TD>128 (Echo Request)</TD></TR>
  <TR>
    <TD></TD>
    <TD>Data Length</TD>
    <TD>14</TD></TR>
</TABLE>
<P>
ICMP Echo Reply
</P>
<TABLE border="1">
  <TR>
    <TD>IP Header</TD>
    <TD>Source Address</TD>
    <TD>NUT_NET3</TD></TR>
  <TR>
    <TD></TD>
    <TD>Destination Address</TD>
    <TD>HOST1_NET5</TD></TR>
  <TR>
    <TD>ICMP</TD>
    <TD>Type</TD>
    <TD>129 (Echo Reply)</TD></TR>
  <TR>
    <TD></TD>
    <TD>Data Length</TD>
    <TD>14</TD></TR>
</TABLE>


=end html

=head1 JUDGMENT

  FYI
      Nothing received: TUN shift receive window when receiving large sequence number packet.
      ICMP Echo Reply received: TUN expand receive window size when receiving large sequence number packet.

=head1 SEE ALSO

  perldoc V6evalTool

=begin html
<PRE>
  <A HREF="./IPSEC.html">IPSEC.html</A> IPsec Test Common Utility
</PRE>

=cut