#!/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/R_RFC3315_20_MultiRelayReplyMsg.seq,v 1.17 2006/03/09 08:45:40 mnaoki Exp $
########################################################################
BEGIN { $V6evalTool::TestVersion = '$Name: DHCPv6_1_0 $';
}

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

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

vLogHTML('<B>==== NUT Initialization ====</B><BR>');
my $IF0 = "Link0";
my $IF1 = "Link1";

#IID dentifier
#my $IID_IDENTIFIER = '00000001';

#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}\",\"clientunicast=$NUTRELAY1_LINK1_GLOBAL_UCAST\",\"servermulticast\")"#\"serverunicast=$NUTRELAY1_LINK0_GLOBAL_UCAST\")"##,\"interfaceid=\'$IID_IDENTIFIER\'\")"
);
dhcpRelayInit(\%NUT_Relay_Config);

# Need add the Relay-forward Message
# Relay 2 --> NUT(Solicit)
$CID_OPTION = "opt_CID_LLT_client1";
$IA_NA_OPTION = "opt_IA_NA";
# Send  the Relay_Forward messge(Solicit)
my($ret1, %rfsol1) = send_relay_forward($IF1,"relayforward_solicit_relay2_to_nut");
#dhcpExitFail if (0!=$ret1);

 
# wait for DHCPv6 Relay reforward Message(Solicit)
my ($ret2, %rrsol2) =  wait_for_relay_forward($IF0, 5,"relay_forward_nut_server");
if (0 != $ret2){
 	dhcpExitError("NG: The message have not be relayed");
}

# 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";
my $cpp = '';
my ($ret, %rradv) = send_relay_reply($IF0,"relay_advertise_server1_to_client1_2relay",undef,$cpp);
dhcpExitFail if(0 != $ret);

# Receive the Advertise Message from $IF1
my ($ret, %adv) = wait_for_relay_reply_advertise($IF1,5,"relay_reply_relay1_relay2");
dhcpExitFail if(0 != $ret);

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

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

=head1 NAME

  R_RFC3315_20_MultiRelayReplyMsg.seq - Relay relay-reply message to another relay agent

=head1 TARGET

  Relay agent

=head1 SYNOPSIS

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

=head1 INITIALIZATION

=begin html
  <UL>
  <LI><STRONG>Network Topology</STRONG></LI>
  </UL>
	<PRE>
                         TN(Client1)
                              |
Link2 -------------+----------+---------------------3ffe:501:ffff:102::/64
                   |                       
                   |                       
             TN(Relay2)
                   |                       
                   |                       
Link1 -------------+-----------------------+-------- 3ffe:501:ffff:101::/64
                                           |
                                           |
                                     NUT(Relay1)
                                           |
                                           |
Link0 ------------------------+------------+-------- 3ffe:501:ffff:100::/64
                              |
                           TN(Server1)
	</PRE>
       </UL>
<UL>
      <LI><STRONG>Verification Points</STRONG><p></LI>
        <PRE><B>Relay-reply Message 2</B>
        <UL>
	<LI>msg-type</LI>
	<B>RELAY-REPLY</B>
	<LI>hop-count</LI>
	<B>0</B>
	<LI>link-address</LI>
	<B>Rleay2's address (Link2)</B>       
	<LI>peer-address</LI>
	<B>Client1's addess</B>       
	<LI>Relay Message option</LI>
	<B>Advertise Message</B>
        </UL>
       </PRE>
</UL>
<UL>
      <LI><STRONG>Configuration</STRONG></LI>
        <PRE>
        <B>Relay-reply Message 1</B>
	<LI>msg-type</LI>
		<B>RELAY-REPLY</B>
		<LI>hop-count</LI>
		<B>1</B>
		<LI>link-address</LI>
		<B>0</B>       
		<LI>peer-address</LI>
		<B>Relay2's Global address (Link1) </B>
		<LI>Relay Message option</LI>
		<UL>
			<LI>msg-type</LI>
			<B>RELAY-REPLY</B>
			<LI>hop-count</LI>
			<B>0</B>
			<LI>link-address</LI>
			<B>Rleay2's address (Link2)</B>       
			<LI>peer-address</LI>
			<B>Client1's addess</B>       
			<LI>Relay Message option</LI>
			<B>Advertise Message</B>
		</UL>
       </PRE>
	<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>Relay2(Link1)</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:a7a7</TT></TD>
	<TD><TT>00:00:00:00:a7:a7</TT></TD>
	</TR>
	<TR>
	<TD><TT>Relay2(Link2)</TT></TD>
	<TD><TT>TN</TT></TD>
	<TD><TT>Link2</TT></TD>
	<TD><TT>3ffe:501:ffff:102::/64</TT></TD>
	<TD><TT>fe80::200:ff:fe00:a8a8</TT></TD>
	<TD><TT>00:00:00:00:a8:a8</TT></TD>
	</TR>
	<TR>
	<TD><TT>Client1</TT></TD>
	<TD><TT>TN</TT></TD>
	<TD><TT>Link2</TT></TD>
	<TD><TT>3ffe:501:ffff:102::/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)TN(Relay2) NUT(Relay1) TN(Server1)
	        |       |           |              |
	        | ----> |           |              |Solicit
	        |       | ----->    |              |Relay-forward(Solicit)
	        |       |           |  ------->    |Relay-forward(Solicit)
	        |       |           |  <------     |Relay-reply Message1(Relay-reply/Advertise)  (*1)
	        |       | <----     |              |Relay-reply Message2(Advertise)  (*2)
	        |       |           |              |
(*1)(*2) PASS: NUT will covert the Relay-reply message correctly.
</PRE>

=end html

=head1 JUDGEMENT

<PRE>
 (*1)(*2) PASS: NUT will covert the Relay-reply message correctly.
</PRE>

=head1 TERMINATION

  N/A

=head1 REFERENCE

=begin html
<PRE>
  see also RFC3315
  20.3. Construction of  Relay-reply Messages
</PRE>

=end html

=head1 SEE ALSO

  perldoc V6evalTool

=cut