#!/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/R_RFC3315_20_RelayForwardDecMsg.seq,v 1.1 2007/03/08 04:02:57 hide Exp $
########################################################################
BEGIN { $V6evalTool::TestVersion = '$Name: DHCPv6_Self_Test_P2_1_0_13 $';
}

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";
my $IF1 = "Link1";

#initial NUT config parameters,
my %NUT_Relay_Config = (
			'if_nut0'=> "$V6evalTool::NutDef{Link0_device}",
			'if_nut1' => "$V6evalTool::NutDef{Link1_device}",
#			'if_add0' => "$NUTRELAY1_LINK0_GLOBAL_UCAST",
#			'if_add1' => "$NUTRELAY1_LINK1_GLOBAL_UCAST",
#			'if_length0' => "64",
#			'if_length1' => "64",
#			'if_type0'=> "unicast",
#			'if_type1'=> "unicast",
			'init_opcode' => "vRemote(\"dhcp6r.rmt\", \"start\",\"link0=$V6evalTool::NutDef{Link0_device}\",\"link1=$V6evalTool::NutDef{Link1_device}\",\"servermulticast\",\"clientmulticast\")"
			);

dhcpRelayInit(\%NUT_Relay_Config);

my ($retping,%ping) = ping_test_nut1("Link1");
if($retping != 0){
        dhcpExitFail;
}
my $src_addr = $ping{"Frame_Ether.Packet_IPv6.Hdr_IPv6.SourceAddress"};


# set Options
$CID_OPTION = "opt_CID_LLT_client1";
$IA_NA_OPTION = "opt_IA_NA";
$ElapsedTime_OPTION = "opt_ElapsedTime";
my($ret1, %sol1) = send_solicit($IF1, "solicit_client1_to_alldhcp",undef);
dhcpExitFail if(0 != $ret1);

# Receive the Relay_Forward messge(Solicit)
my($ret2, %rfsol2) = wait_for_relay_forward_solicit($IF0,5);
if (0 != $ret2){
	dhcpExitFail();
} 

# Send the Relay Reply Messge(Advertise)
$CID_OPTION = "opt_CID_LLT_client1";
$SID_OPTION = "opt_SID_LLT_server1";
$IA_NA_OPTION = "opt_IA_NA_Addr_Relay";
$ElapsedTime_OPTION = undef;
my ($ret3, %rradv3) = send_relay_reply($IF0,"relay_advertise_server1_to_client1_1relay",\%rfsol2,undef);
dhcpExitFail if(0 != $ret3);


# Receive the Advertise Message from $IF1
my ($ret4, %adv4) = wait_for_advertise($IF1,5);
dhcpExitFail if(0 != $ret4);


$CID_OPTION = "opt_CID_LLT_client1";
$IA_NA_OPTION = "opt_IA_NA";
$ElapsedTime_OPTION = "opt_ElapsedTime";
my ($ret5, %req5) = send_request($IF1, "request_client1_to_alldhcp",\%adv4,undef);
dhcpExitFail if (0!=$ret5);

#Receive the Relay_Forward message(Request)
my($ret6, %rfreq6) = wait_for_relay_forward_request($IF0,5);
if(0 != $ret6){
	dhcpExitFail();
}

# Send the Relay-reply message(Reply)
$CID_OPTION = "opt_CID_LLT_client1";
$SID_OPTION = "opt_SID_LLT_server1";
$IA_NA_OPTION = "opt_IA_NA_Addr_Relay";
$ElapsedTime_OPTION = undef;
my ($ret7, %rrrep7) = send_relay_reply($IF0,"relay_reply_server1_to_client1_1relay",\%rfreq6,undef);
dhcpExitFail if(0 != $ret7);


#Client1 Receive the Reply message
my ($ret8, %rep8) = wait_for_reply($IF1,5);
dhcpExitFail if(0 != $ret8);

###end common sequence###

vSleep(5);

$IA_NA_OPTION = "opt_IA_NA_Addr_woStatus";
$ElapsedTime_OPTION = "opt_ElapsedTime";
my ($ret9, %dec9) = send_decline($IF1, "decline_client1_to_alldhcp", \%rep8, "");
dhcpExitFail if (0!=$ret9);


#Receive the Relay_Forward message(Release)
my($ret10, %rfdec10) = wait_for_relay_forward_decline($IF0,5);
if(0 != $ret10){
	dhcpExitFail();
}

#Check the Multicast address
if("ff05::1:3" ne $rfdec10{"Frame_Ether.Packet_IPv6.Hdr_IPv6.DestinationAddress"}){
	dhcpExitError("NG: The Destination Port used by the Relay-forwad Message is not valid!");
}

#Check the HopLimit = 32 & hopcount = 0;(default);
if(0 != ckRelayForwardMsgHopCount(\%rfdec10,0)){
	dhcpExitFail;
}

#-------------------------------------------------------------------
vLogHTML("<B><FONT COLOR=#006666>The Hop count is correct</FONT></B><BR>");
#-------------------------------------------------------------------

#check the Link-address
if(0 != ckRelayForwardLinkAddress(\%rfdec10,$src_addr)){
	dhcpExitError("The link-address is not properly!");
}

#-------------------------------------------------------------------
vLogHTML("<B><FONT COLOR=#006666>The link-address is correct</FONT></B><BR>");
#-------------------------------------------------------------------

#Check the peer-link
if(0 != ckRelayForwardPeerAddress(\%rfdec10,\%dec9)){
	dhcpExitFail;
}
#-------------------------------------------------------------------
vLogHTML("<B><FONT COLOR=#006666>The peer-addess is correct</FONT></B><BR>");
#-------------------------------------------------------------------



#Check the relay-forward message
if ( 0 != chkMsgAfterRelay(\%dec9,\%rfdec10,)){
	dhcpExitError("NG: The relay-forward message is not correct!");
}

#-------------------------------------------------------------------
vLogHTML("<B><FONT COLOR=#006666>The Message exchange is correct</FONT></B><BR>");
#-------------------------------------------------------------------
dhcpExitPass();
vClear($IF0);
vClear($IF1);

#NOTREACHED

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

=head1 NAME

  R_RFC3315_20_RelayForwardDecMsg.seq - Relay-forward Decline message transmission

=head1 TARGET

  Relay agent

=head1 SYNOPSIS

=begin html
 <PRE>
 <A HREF="./R_RFC3315_20_RelayForwardDecMsg.seq">R_RFC3315_20_RelayForwardDecMsg.seq </A>[-tooloption ...]
 -pkt <A HREF="./R_RFC3315_20_RelayForwardDecMsg.def">R_RFC3315_20_RelayForwardDecMsg.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)
                |
Link1 ----------+----------+--------------- 3ffe:501:ffff:101::/64
                           |
                         NUT(Relay1)
                           |
Link0 ---------------------+----------+---- 3ffe:501:ffff:100::/64
                                      |
                                 TN(Server1)
  </PRE>
  <ul>
      <li><STRONG>Verification Points</STRONG><p>
          <ul>
          <PRE>
Relay-forward Message Format
      <li>destination address</li>
          <B>All_DHCP_Servers(FF05::1:3)</B>
      <li>msg-type</li>
          <b>RELAY-FORW(12)</b>
      <li>hop-count</li>
	  <b>0</b>
      <li>link-address</li>
          <b>A global or site-scoped address with a prefix assigned to the link</b>
      <li>peer-address</li>
          <b>Copied from the Decline message</b>
      <li>options</li>
          <b>Relay Message option</b>
	  <b>Same as the Message that be relayed</b>
	  <b>(Decline)</b>
          </PRE>
          </ul>
  </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>Relay1(Link0)</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(Link0)</TT></TD>
	<TD><TT>NUT's MAC address(Link0)</TT></TD>
	</TR>
	<TR>
	<TD><TT>Relay1(Link1)</TT></TD>
	<TD><TT>NUT</TT></TD>
	<TD><TT>Link1</TT></TD>
	<TD><TT>3ffe:501:ffff:101::/64</TT></TD>
	<TD><TT>NUT's Linklocal address(Link1)</TT></TD>
	<TD><TT>NUT's MAC address(Link1)</TT></TD>
	</TR>
	<TR>
	<TD><TT>Server1</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:a1a1</TT></TD>
	<TD><TT>00:00:00:00:a1:a1</TT></TD>
	</TR>
	<TR>
	<TD><TT>Client1</TT></TD>
	<TD><TT>TN</TT></TD>
	<TD><TT>Link1</TT></TD>
	<TD><TT>3ffe:501:ffff:101::/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>
	    TN(Client1) NUT(Relay1)TN(Server1)
	        |       |         |
	        | ----> |         |     Solicit
	        |       | ----->  |     Relay-forward(Solicit)
	        |       | <----   |	Relay-reply(Advertise) 
	        | <---- |         |	Advertise  
	        | ----> |         |	Request
	        |       | ---->   |	Relay-forward(Request)
	        |       | <----   |	Relay-reply(Reply) 
	        |<----  |         |	Reply  	  
	        | ----> |         |	Decline
	        |       | ---->   |	Relay-forward(Decline) (*1)            
	        |       |         |
</PRE>

=end html

=head1 JUDGEMENT

<PRE>
(*1)PASS: Relay-forward Message is same as the description of verification points.
</PRE>

=head1 TERMINATION

  N/A

=head1 REFERENCE

=begin html
<PRE>
  see also RFC3315
  20.1, 20.1.1 and 20.1.2
</PRE>

=end html

=head1 SEE ALSO

  perldoc V6evalTool

=cut