#!/usr/bin/perl
#
# Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Yokogawa Electric Corporation.
# 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.
# 
# 5. The copyrighters, the project and the contributors may prohibit
#    the use of this software at any time.
# 
# 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-dhcpv6/dhcpv6.tahi/S_RFC3315_15_1_TransactionIDSync.seq,v 1.16 2006/03/14 01:31:56 mnaoki Exp $
########################################################################
BEGIN { $V6evalTool::TestVersion = '$Name: DHCPv6_1_0 $';
}

use strict;
use V6evalTool;
use DHCPv6_common;
use Server_pktdesc;

my $strIndexBase = "Frame_Ether.Packet_IPv6.Upp_UDP";


#--------------------------------------------------------------#
# Initialization
#--------------------------------------------------------------#

vLogHTML('<B>==== NUT Initialization ====</B><BR>');
my $IF0 = "Link0";
#initial NUT config parameters,
my %NUT_Server_Config = (
'if_nut0'=> "$V6evalTool::NutDef{Link0_device}",
'init_opcode' => "vRemote(\"dhcp6s.rmt\", \"start\",\"rapidcommit\",\"link0=$V6evalTool::NutDef{Link0_device}\",\"startaddr=3ffe:501:ffff:100::10\",\"endaddr=3ffe:501:ffff:100::11\")"
);
dhcpSvrInit(\%NUT_Server_Config);

# send DHCPv6 Solicit Message
$CID_OPTION = "opt_CID_LLT_client1";
$IA_NA_OPTION = "opt_IA_NA";
my ($ret1, %sol1) = send_solicit($IF0, "solicit_client1_to_alldhcp", "");
dhcpExitFail() if (0 != $ret1);

# wait for DHCPv6 Advertise Message
my ($ret2, %adv2) = wait_for_advertise($IF0, 5);
dhcpExitFail() if (0 != $ret2);

if ($sol1{"$strIndexBase.Udp_DHCPv6_Solicit.Identifier"} !=
    $adv2{"$strIndexBase.Udp_DHCPv6_Advertise.Identifier"}){
	dhcpExitError("The Transaction ID isn\'t same between Solicit Msg & Advertise Msg<BR>");
}else{
	my $msg = "<b><font color='blue'>Identifier matched.</font></b>:";
	$msg .= $sol1{"$strIndexBase.Udp_DHCPv6_Solicit.Identifier"};
	$msg .= " == ";
	$msg .= $adv2{"$strIndexBase.Udp_DHCPv6_Advertise.Identifier"};
	$msg .= "<br>";
	vLogHTML($msg);
}

# send DHCPv6 Request Message
$CID_OPTION = "opt_CID_LLT_client1";
$SID_OPTION = "opt_SID_ANY";
$IA_NA_OPTION = "opt_IA_NA";
my ($ret3, %req3) = send_request($IF0, "request_client1_to_alldhcp", \%adv2, "");
dhcpExitFail() if (0 != $ret3);

# wait for DHCPv6 Reply Message
my ($ret4, %rep4) = wait_for_reply($IF0, 5);
dhcpExitFail() if (0 != $ret4);

if ($req3{"$strIndexBase.Udp_DHCPv6_Request.Identifier"} !=
    $rep4{"$strIndexBase.Udp_DHCPv6_Reply.Identifier"}){
	dhcpExitError("The Transaction ID isn\'t same between Request Msg & Reply Msg<BR>");
}else{
	my $msg = "<b><font color='blue'>Identifier matched.</font></b>:";
	$msg .= $req3{"$strIndexBase.Udp_DHCPv6_Request.Identifier"};
	$msg .= " == ";
	$msg .= $rep4{"$strIndexBase.Udp_DHCPv6_Reply.Identifier"};
	$msg .= "<br>";
	vLogHTML($msg);
}

#-------------------------------------------------------------------
vLogHTML("<B><FONT COLOR=#006666>The Message exchange is correct</FONT></B><BR>");
#-------------------------------------------------------------------
dhcpExitPass();
#NOTREACHED
########################################################################
__END__

=head1 NAME

  S_RFC3315_15_1_TransactionIDSync.seq - TransactionID field check(keep consitence)

=head1 TARGET

  Server

=head1 SYNOPSIS

=begin html
 <PRE>
 <A HREF="./S_RFC3315_15_1_TransactionIDSync.seq">S_RFC3315_15_1_TransactionIDSync.seq </A>[-tooloption ...]
 -pkt <A HREF="./S_RFC3315_15_1_TransactionIDSync.seq.def">S_RFC3315_15_1_TransactionIDSync.seq.def </A>
 -tooloption: v6eval tool option
See Also <A HREF="./DHCPv6.def"> DHCPv6.def </A>
 </PRE>

=head1 INITIALIZATION

=begin html
  <ul>
  <li><STRONG>Network Topology</STRONG></li>
  </ul>
  <PRE>
          TN(Client1)  
             |
Link0 -------+-----------+--------------- 3ffe:501:ffff:100::/64
                         |
                       NUT(Server1)
  </PRE>
  <ul>
      <li><STRONG>Verification Points</STRONG><p></li>
<PRE> 
NUT(Server) must keep one same transaction ID in a same DHCP message exchangement.
</PRE>
  </ul>
  <ul>
      <li><STRONG>Configuration</STRONG></li>
  </ul>
	<BLOCKQUOTE>
	<TABLE BORDER>
	<TR>
	<TD><TT>Device Name</TT></TD>
	<TD><TT>Device Type</TT></TD>
	<TD><TT>I/F</TT></TD>
	<TD><TT>Assigned Prefix</TT></TD>
	<TD><TT>Link Local Addr</TT></TD>
	<TD><TT>MAC Addr</TT></TD>
	</TR>
	<TR>
	<TD><TT>Server1</TT></TD>
	<TD><TT>NUT</TT></TD>
	<TD><TT>Link0</TT></TD>
	<TD><TT>3ffe:501:ffff:100::/64</TT></TD>
	<TD><TT>NUT's Linklocal address</TT></TD>
	<TD><TT>NUT's MAC address</TT></TD>
	</TR>
	<TR>
	<TD><TT>Client1</TT></TD>
	<TD><TT>TN</TT></TD>
	<TD><TT>Link0</TT></TD>
	<TD><TT>3ffe:501:ffff:100::/64</TT></TD>
	<TD><TT>fe80::200:ff:fe00:a2a2</TT></TD>
	<TD><TT>00:00:00:00:a2:a2</TT></TD>
	</TR>
	</TABLE>
	</BLOCKQUOTE>

=end html

=head1 TEST PROCEDURE

=begin html
<PRE>
       NUT      TN
        |       | 
        |       | initialize NUT (as a DHCPv6 Server)
        |       | 
        | <---- | Solicit            transaction ID1
        | ----> | Advertise   (*1)   transaction ID1
        | <---- | Request            transaction ID2
        | ----> | Reply       (*2)   transaction ID2
        |       | 
</PRE>

=end html

=head1 JUDGEMENT

<PRE>
(*1) The NUT respond to the Solicit message with same transaction
     ID1 in the Advertise message from the TN.
(*2) The NUT respond to the Request message with same transaction
     ID2 in the Reply message from the TN.
</PRE>

=head1 TERMINATION

  N/A

=head1 REFERENCE

=begin html
<PRE>
   see also RFC3315
   15.1 Use of Transaction IDs
</PRE>

=end html

=head1 SEE ALSO

  perldoc V6evalTool

=cut