#!/usr/bin/perl
#
# Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005 Yokogawa Electric Corporation,
# IPA (Information-technology Promotion Agency, Japan).
# 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. However, using this software for the 
# purpose of testing or evaluating any products including merchantable 
# products may be permitted without any notification to the copyrighters.
# 
# 
# 
# 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/icmp/Echo_Checksum.seq,v 1.1 2003/03/26 07:47:29 masaxmasa Exp $
#----------------------------------------------------------------------

BEGIN { $V6evalTool::TestVersion = '$Name: REL_2_1_2 $ '; }
use V6evalTool;
use icmp;

$IF = Link0;

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

vLogHTML("<FONT SIZE=\"+1\">Initialization</FONT><BR>");

vCapture($IF);

#----------------------------------------------------------------------
# This part is just for comparison 
#----------------------------------------------------------------------

vLogHTML("<B>This is very tricky, but send echo-reply (src = NUT/dst = TN) ".
	 "to get valid checksum value.</B><BR>");

%ret1 = vSend($IF,echo_reply_link_local);

$Valid_Checksum = $ret1{"Frame_Ether.Packet_IPv6.ICMPv6_EchoReply.Checksum"};

vClear($IF);

#----------------------------------------------------------------------
# Test
#----------------------------------------------------------------------
%pktdesc = (
	ns_local	=> 'Receive Neighbor Solicitation',
	ns_local_sll	=> 'Receive Neighbor Solicitation',
	na_local	=> 'Send Neighbor Advertisement',
	echo_request	=> 'Send Echo Request (Link-local address)',
	echo_reply	=> 'Receive Echo Reply (Link-local address)'
);

vLogHTML("<FONT SIZE=\"+1\">Test</FONT><BR>");

vSend($IF, echo_request);

%ret = vRecv($IF, 5, 0, 0, echo_reply, ns_local, ns_local_sll);

if ($ret{status} != 0) {
	vLog("TN can not receive Echo Reply from NUT.");
	goto error;
}
elsif ($ret{recvFrame} eq 'echo_reply') {
	if ($ret{"Frame_Ether.Packet_IPv6.ICMPv6_EchoReply.Checksum"} eq
	    $Valid_Checksum) {
		vLog("Checksum value included in NUT's sending packet is valid");
		vLog("OK");
		exit($V6evalTool::exitPass);
	}
	else {
		vLog("Checksum value included in NUT's sending packet is invalid");
		goto error;
	};
}
elsif ($ret{recvFrame} eq 'ns_local' || $ret{recvFrame} eq 'ns_local_sll') {
	vSend($IF, na_local);
	%ret = vRecv($IF, 5, 0, 0, echo_reply);

	if ($ret{status} != 0) {
		vLog("TN can not receive Echo Reply from NUT");
	}
	elsif ($ret{recvFrame} eq 'echo_reply') {
		if ($ret{"Frame_Ether.Packet_IPv6.ICMPv6_EchoReply.Checksum"} eq
		    $Valid_Checksum) {
			vLog("Checksum value included in NUT's sending packet is valid");
			vLog("OK");
			exit($V6evalTool::exitPass);
		}
		else {
			vLog("Checksum value included in NUT's sending packet is invalid");
			goto error;
		};
	}
	else {
		vLog("TN received an expected packet from NUT");
	};

	goto error;
}
else {
	vLog("TN receive unexpected packets from NUT.");
	goto error;
};
	
error:

vLog("FAIL");
exit($V6evalTool::exitFail);


#----------------------------------------------------------------------

__END__

=head1 NAME

	Echo_Checksum.seq - check that sending and receiving Echo Request 
			    and Echo Reply (checksum)

=head1 TARGET

	Host/Router

=head1 SYNOPSIS

	Echo_Checksum.seq [-tooloption ...] -p Echo_Checksum.def

=head1 INITIALIZATION

	None

=head1 TEST PROCEDURE

	This test verifies that NUT receives valid ICMPv6 Echo Request 
	and sent ICMPv6 Echo Reply. 
	

	TN			NUT

	---------------------------

	1.
	 === ICMPv6 Echo Request ===>
			src address : TN link local address
			dst address : NUT link local address        
	2.
	<< JUDGMENT >>

	 <=== ICMPv6 Echo Reply ===
			src address : NUT link local address
			dst address : TN link local address        
          

=head1 JUDGMENT

	<< PASS >>
		Check Sum which is in a received packet is valid
		

	<< FAIL >>	
		Check Sum which is in a received packet is invalid


=head1 SEE ALSO

	  perldoc V6evalTool

=cut