#!/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_RelayMsgFromRelayAgentWithInterfaceidOP.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";

#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\",\"clientunicast=$NUTRELAY1_LINK1_GLOBAL_UCAST\")"
);

dhcpRelayInit(\%NUT_Relay_Config);

# send DHCPv6 Relay Forward Message(Solicit) with Interface ID option
# set Options
$CID_OPTION = "opt_CID_LLT_client1";
$IA_NA_OPTION = "opt_IA_NA";
$IID_OPTION = "opt_IID";
my($ret1, %rfsol1) = send_relay_forward($IF1, "relayforward_solicit_relay2_to_nut");
 if (0 != $ret1){
 	dhcpExitFail();
 }

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

if(0 != CheckIfExistOP(\%rrsol2,$CMP_IID)){
	dhcpExitError(" Can not find the Interface-id option in Relay-forward message.<BR>");
}

# HopCount = 1;
if(0 != ckRelayForwardMsgHopCount(\%rrsol2,1)){
	dhcpExitFail;
}


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




#NOTREACHED

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

=head1 NAME

  R_RFC3315_20_RelayMsgFromRelayAgentWithInterfaceidOP.seq - Relay messages from another Relay agent(w/ Interface-Id option)

=head1 TARGET

  Relay agent

=head1 SYNOPSIS

=begin html
 <PRE>
 <A HREF="./R_RFC3315_20_RelayMsgFromRelayAgentWithInterfaceidOP.seq">R_RFC3315_20_RelayMsgFromRelayAgentWithInterfaceidOP.seq </A>[-tooloption ...]
 -pkt <A HREF="./R_RFC3315_20_RelayMsgFromRelayAgentWithInterfaceidOP.def">R_RFC3315_20_RelayMsgFromRelayAgentWithInterfaceidOP.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(Relay2)
                   |
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>
NUT's Relay-forward Message Format
      <li>msg-type</li>
          <b>RELAY-FORW(12)</b>
      <li>hop-count</li>
	  <b>1</b>
      <li>link-address</li>
          <b>Any</b>
      <li>peer-address</li>
          <b>the source address from the IP datagram in TN's Relay-forward Message</b>
      <li>options</li>
          <b>Relay Message option</b>
	  <b>Same as the received Relay-forward Message</b>
          </ul>
          </PRE>
          </ul>
  </ul>
  <ul>
      <li><STRONG>Configuration</STRONG></li>
          <ul>
          <PRE>
TN(Realy agent2)'s Relay-forward Message 
      <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>
	or
	  <b>Any</b>
      <li>peer-address</li>
          <b>Any</b>
      <li>options</li>
          <b>Relay Message option</b>
	  <b>Interface-Id option</b>
          </ul>
          </PRE>
          </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>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</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>
	</TABLE>
	</BLOCKQUOTE>
  </ul>

=end html

=head1 TEST PROCEDURE

=begin html
<PRE>
	    TN(Relay2) NUT(Relay1)TN(Server1)
	        |       |         |
	        | ----> |         |Relay-forward(Solicit w/ Interface-id Option)
	        |       | ----->  |Relay-forward(Solicit w/ Interface-id Option)(*1)
	        |       |         |
</PRE>

=end html

=head1 JUDGEMENT

<PRE>
(*1)PASS: NUT will send new Relay-forward message to the Server1.
</PRE>

=head1 TERMINATION

  N/A

=head1 REFERENCE

=begin html
<PRE>
  see also RFC3315
  20.1.2. Relaying a Message from a Relay Agent
</PRE>

=end html

=head1 SEE ALSO

  perldoc V6evalTool

=cut