#!/usr/bin/perl
#
# Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
# 	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: dhcpv6.p2/rfc3315/S_RFC3315_17.2.3_Creation-TransmissionOfReplyMsg.seq,v 1.3 2008/11/14 13:10:02 ozoe Exp $
########################################################################
BEGIN { $V6evalTool::TestVersion = '$Name: DHCPv6_Self_Test_P2_1_0_14 $';
}

use strict;
use V6evalTool;

use lib '../.';
use DHCPv6_common;
use Server_pktdesc;

dhcpExitNS if(ChkFuncSupport('ADDRASSIGN') && ChkFuncSupport('DNS'));

#--------------------------------------------------------------#
# 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\",\"link0=$V6evalTool::NutDef{Link0_device}\",\"startaddr=3ffe:501:ffff:100::10\",\"endaddr=3ffe:501:ffff:100::11\")"
);

dhcpSvrInit(\%NUT_Server_Config);
vClear($IF0);
#--------------------------------------------------------------#
# Main Procedure
#--------------------------------------------------------------#
vLogHTML('<B>==== Creation and Transmission of Reply Messages  ====</B><BR>');

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

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

# check options in Advertise Message
 if (0 != options_exist(\%adv2, ($CMP_CID|$CMP_SID))){
 	dhcpExitError("<B>Do not include necessary options!</B>");
}

# compare Options
if (0 != compare_options(\%sol1, \%adv2, ($CMP_CID|$CMP_TRANS_ID))){
	dhcpExitError("<B>Option Error</B>");
}

# 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, "");
 if (0 != $ret3) {
	dhcpExitFail() 
}

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

if ( $rep4{"Frame_Ether.Packet_IPv6.Hdr_IPv6.DestinationAddress"} ne $req3{"Frame_Ether.Packet_IPv6.Hdr_IPv6.SourceAddress"}) {
	vLogHTML("DHCPv6 Server must unicast Reply Messages.<BR>");
	dhcpExitFail()
}

# check options in Reply Message
 if (0 != options_exist(\%rep4, ($CMP_IA_NA|$CMP_CID|$CMP_SID))){
	 dhcpExitError("<B>Do not include necessary options!</B>");
 }

# compare Options
 if (0 != compare_options(\%req3, \%rep4, ($CMP_CID|$CMP_TRANS_ID))){
	 dhcpExitError("<B>Option Error</B>");
}
#--------------------------------------------------------------#
# check IAID in IA_NA option
#--------------------------------------------------------------#
if ( $rep4{"Frame_Ether.Packet_IPv6.Upp_UDP.Udp_DHCPv6_Reply.Opt_DHCPv6_IA_NA.Identifier"} != $req3{"Frame_Ether.Packet_IPv6.Upp_UDP.Udp_DHCPv6_Request.Opt_DHCPv6_IA_NA.Identifier"}) {
	dhcpExitError("IAID does not match.")
}
#--------------------------------------------------------------#
# check IA Address option
#--------------------------------------------------------------#
dhcpExitError("<B>NUT does not include IA_Address option!</B>") 
	if(option_exist(\%rep4,"Opt_DHCPv6_IA_NA.Opt_DHCPv6_IA_Address"));

my $option_base = "Frame_Ether.Packet_IPv6.Upp_UDP.Udp_DHCPv6_Reply.Opt_DHCPv6_IA_NA.Opt_DHCPv6_IA_Address";
my $option_code = $option_base."."."Code";
my $option_len = $option_base."."."Length";
my $option_addr = $option_base."."."Address";
my $option_plife = $option_base."."."PreferredLifetime";
my $option_vlife = $option_base."."."ValidLifetime";


if(defined $rep4{$option_base}){
	vLogHTML("<B> IA address option Code = $rep4{$option_code} <B><BR>");
	vLogHTML("<B> IA address option Length = $rep4{$option_len} <B><BR>");
	vLogHTML("<B> IA address option Address = $rep4{$option_addr} <B><BR>");
	vLogHTML("<B> IA address option preferredLifetime = $rep4{$option_plife} <B><BR>");
	vLogHTML("<B> IA address option ValidLifetime = $rep4{$option_vlife} <B><BR>");
}
else{
	vLogHTML("<B> NO IA address option <B><BR>");
	dhcpExitFail;
}
#-------------------------------------------------------------------
vLogHTML("<B><FONT COLOR=#006666>The Messages Exchange is correct</FONT></B><BR>");
#-------------------------------------------------------------------
dhcpExitPass();
#NOTREACHED

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

=head1 NAME

  S_RFC3315_17.2.3_Creation-TransmissionOfReplyMsg.seq - Reply message transmission

=head1 TARGET

  Server

=head1 SYNOPSIS

=begin html
 <PRE>
 <A HREF="./S_RFC3315_17.2.3_Creation-TransmissionOfReplyMsg.seq">S_RFC3315_17.2.3_Creation-TransmissionOfReplyMsg.seq </A>[-tooloption ...]
 -pkt <A HREF="./S_RFC3315_17.2.3_Creation-TransmissionOfReplyMsg.def">S_RFC3315_17.2.3_Creation-TransmissionOfReplyMsg.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></li>
	<ul>
	<PRE>
Packet's destination address
	<LI><B>unicast address</B></LI>
	<LI><B>The address  is same as the source address field from the IP datagram in which the Request message. </B></LI>
	<BR>
Reply Message
	<li>msg-type</li>
	<b>REPLY(7)</b>
	<LI>transaction-id</LI>
        Same as the Request Message
	<li>Server Identifier option</li>
	Any
	<li>Client Identifier option</li>
	Same as the Request Message
	<li>IA_NA option</li>
<UL>
<LI>option-code</LI>
<B>OPTION_IA_NA (3)</B>
<LI>option-len</LI>
<B>12 + length of IA_NA-options field</B>
<LI>IAID</LI>
<B>Same as Request message</B>
<LI>T1</LI>
<B>number</B>
<LI>T2</LI>
<B>number</B>
<LI>IA_NA-options</LI>
<B>IA Address option</B>
</UL>
	</ul>
	</PRE>
  </ul>
  <ul>
      <li><STRONG>Configuration</STRONG></li>
	<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>
</ul>

=end html

=head1 TEST PROCEDURE

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

=end html

=head1 JUDGEMENT

<PRE>
(*1) PASS: The format of Advertise,Solicit & Request message is correct.
           The Reply message with configuration parameters and assigned address is received by TN.
</PRE>

=head1 TERMINATION

  N/A

=head1 REFERENCE

=begin html
<PRE>
   see also RFC3315
   17.2.3.  Creation and Transmission of Reply Messages 
</PRE>

=end html

=head1 SEE ALSO

  perldoc V6evalTool

=cut