#!/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.2_Creation-TransmissionOfAdvertiseMsgwithStatusCodeOP.seq,v 1.1 2007/02/15 02:45:16 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";
#initial NUT config parameters,
# No address pool to assign;
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::10\")"
);
dhcpSvrInit(\%NUT_Server_Config);
vClear($IF0);
#--------------------------------------------------------------#
# Main Procedure
#--------------------------------------------------------------#
vLogHTML('<B>==== Creation and Transmission of Advertise Messages(return NoAddrsAvail)  ====</B><BR>');

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

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

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

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


#-----------------------Client2---------------------------------#
# send DHCPv6 Solicit Message
$CID_OPTION = "opt_CID_LLT_client2";
$IA_NA_OPTION = "opt_IA_NA1";
$ElapsedTime_OPTION = "opt_ElapsedTime";
$SID_OPTION = undef;
my ($ret5, %sol5) = send_solicit($IF0, "solicit_client1_to_alldhcp", "");
dhcpExitFail() if (0 != $ret5);

# wait for DHCPv6 Advertise Message
my ($ret6, %adv6) = wait_for_advertise($IF0, 5);
dhcpExitFail() if (0 != $ret6);

# compare CID
dhcpExitFail() if (0 != compare_options(\%sol5, \%adv6, ($CMP_CID|$CMP_TRANS_ID)));

dhcpExitError("<B>Don't found Status Code in special location.</B>") if options_exist(\%adv6,$CMP_STATUS_CODE);
#NoAddrsAvail = 2;
dhcpExitError("<B>The returned status code is not NoAddrsAvail </B><BR>") if chk_statuscode(\%adv6,2);
dhcpExitError("<B>NUT can not return IA option!</B>") unless options_exist(\%adv6,$CMP_IA_NA);
#-------------------------------------------------------------------
vLogHTML("<B><FONT COLOR=#006666>The Messages Exchange is correct</FONT></B><BR>");
#-------------------------------------------------------------------

vClear($IF0);
vStop($IF0);
dhcpExitPass();
#NOTREACHED

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

=head1 NAME

  S_RFC3315_17.2.2_Creation-TransmissionOfAdvertiseMsgwithStatusCodeOP.seq - Respond to the Solicit Message(w/ Status Code options)

=head1 TARGET

  Server

=head1 SYNOPSIS

=begin html
 <PRE>
 <A HREF="./S_RFC3315_17.2.2_Creation-TransmissionOfAdvertiseMsgwithStatusCodeOP.seq">S_RFC3315_17.2.2_Creation-TransmissionOfAdvertiseMsgwithStatusCodeOP.seq </A>[-tooloption ...]
 -pkt <A HREF="./S_RFC3315_17.2.2_Creation-TransmissionOfAdvertiseMsgwithStatusCodeOP.def ">S_RFC3315_17.2.2_Creation-TransmissionOfAdvertiseMsgwithStatusCodeOP.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)     TN(Client2)  
             |             |
Link0 -------+----------+--+----------- 3ffe:501:ffff:100::/64
                        |
                       NUT(Server1)
  </PRE>
  <UL>
      <LI><STRONG>Verification Points</STRONG></LI>
	<UL>
	<PRE>
Advertise Message for the Client2
	<LI>msg-type</LI>
	<B>ADVERTISE(2)</B>
	<LI>transaction-id</LI>
        Same as the Solicit Message
	<LI>Server Identifier option</LI>
	Any
	<LI>Client Identifier option</LI>
	<B>Same as the Solicit Message</B>
	<LI>Status Code option</LI>
	<B>NoAddrsAvail(2)</B>
	</UL>
	</PRE>
  </UL>
  <UL>
  <PRE>
      <LI><STRONG>Configuration</STRONG></LI>
	<UL>
	<LI>Server setup</LI>
	Server <B>can only assign 1  address</B>.
	</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>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>
	<TR>
	<TD><TT>Client2</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:a3a3</TT></TD>
	<TD><TT>00:00:00:00:a3:a3</TT></TD>
	</TR>
	</TABLE>
	</BLOCKQUOTE>
</PRE>
</UL>

=end html

=head1 TEST PROCEDURE

=begin html
<PRE>
       NUT     TN
        |       | 
        |       | initialize NUT (as a DHCPv6 Server)
        |       | Client1
        | <---- | Solicit   
        | ----> | Advertise 
        | <---- | Request   
        | ----> | Reply 
        |       | 
        |       | Client2
        | <---- | Solicit   
        | ----> | Advertise (w/ Status Code option w/o  IA_NA option)(*1)
        |       | 
</PRE>

=end html

=head1 JUDGEMENT

<PRE>
Messages must be exchanged correctly.
And the Client1 can be assigned a address from the server.
The Client2 receive the Advertise message with Status Code option.
(*1) PASS:Advertise message with only one Status Code option with
	  code NoAddrsAvail and a status message for the user.
          a Server Id option with the server's DUID, and a 
          Client ID option with the client's DUID.          
</PRE>

=head1 TERMINATION

  N/A

=head1 REFERENCE

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

=end html

=head1 SEE ALSO

  perldoc V6evalTool

=cut