#!/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/rfc3736/S_RFC3736_DUID-LLPersit.seq,v 1.2 2008/07/08 13:29:46 ozoe 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('STATELESSDHCP');

dhcpExitNS if ChkFuncSupport('DUID_LL');

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

vLogHTML('<B>==== NUT Initialization ====</B><BR>');
my $IF0 = "Link0";
#initial NUT config parameters,
my %NUT_Server_Config = (
	'if_nut0'=> "$V6evalTool::NutDef{Link0_device}",
	'init_opcode' => "vRemote(\"dhcp6s.rmt\", \"start\",\"dns=3ffe:501:ffff:100:200:ff:fe00:3f3e\",\"stateless\",\"link0=$V6evalTool::NutDef{Link0_device}\")"
);

dhcpSvrInitS(\%NUT_Server_Config);
vClear($IF0);

# 1 send DHCPv6 Information-request  Message
$CID_OPTION = "opt_CID_LLT_client1";
$OptionRequest_OPTION = "opt_ORO_dns_servers";
$ElapsedTime_OPTION = "opt_ElapsedTime";
my ($ret1, %ireq1) = send_information_request($IF0, "information_request_client1_to_alldhcp", undef, "");
if (0 != $ret1){
	dhcpExitFail();
}

# wait for DHCPv6 Reply Message
my ($ret2, %rep2) = wait_for_reply($IF0, 5);
if (0 != $ret2){
	dhcpExitFail();
}

# Check the DUID in the message
dhcpExitFail("The type of DUID is not DUID-LL") if check_DUID(\%rep2,$CMP_SID,3);

#Restart system
vLogHTML("Target: Reboot<BR>");
if ( 0 != vRemote('reboot.rmt','')) {
    dhcpExitFail();
}
sleep(5);

vLogHTML('<B>==== NUT Initialization ====</B><BR>');
dhcpSvrInitS(\%NUT_Server_Config);
vClear($IF0);

# 1 send DHCPv6 Information-request  Message
$CID_OPTION = "opt_CID_LLT_client1";
$OptionRequest_OPTION = "opt_ORO_dns_servers";
$ElapsedTime_OPTION = "opt_ElapsedTime";
my ($ret3, %ireq3) = send_information_request($IF0, "information_request_client1_to_alldhcp", undef, "");
if (0 != $ret3){
	dhcpExitFail();
}

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

# Compare the DUID values in 2 results
dhcpExitFail("The DUID value is not consistent") if ( 0 != compare_options(\%rep2,\%rep4,$CMP_SID));

#-------------------------------------------------------------------
vLogHTML("<B><FONT COLOR=#006666>The consistency of DUID-LL is correct</FONT></B><BR>");
#-------------------------------------------------------------------

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

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

=head1 NAME

  S_RFC3736_DUID-LLPersit.seq - The consistency of DUID-LL

=head1 TARGET

  Server

=head1 SYNOPSIS

=begin html
 <PRE>
 <A HREF="./S_RFC3736_DUID-LLPersit.seq">S_RFC3736_DUID-LLPersit.seq </A>[-tooloption ...]
 -pkt <A HREF="./S_RFC3736_DUID-LLPersit.def">S_RFC3736_DUID-LLPersit.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)  
             |
Link0 -------+-----------+--------------- 3ffe:501:ffff:100::/64
                         |
                       NUT(Server1)
  </PRE>
  <UL>
      <LI><STRONG>Verification Points</STRONG></LI>
          <UL>
          <PRE>DUID Format in the Server ID option<BR>
   The following diagram illustrates the format of a DUID-LL:
     0                   1                   2                   3
     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    |               3               |    hardware type (16 bits)    |
    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
    .                                                               .
    .             link-layer address (variable length)              .
    .                                                               .
    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
      <LI>DUID type</LI>
          <B>3</B>
      <LI>enterprise-number</LI>
          <B>IANA-assigned value in RFC826</B>
      <LI>link-layer address</LI>
	  <B>link-layer address of DUID</B>
          </PRE>
          </UL>
	  <UL>
	  <PRE>After rebooting
	  <LI><B>Keep the DUID value</B></LI>
          </UL>
      </LI>
  </UL>
  <UL>
      <LI><STRONG>Configuration</STRONG></LI>
      <UL>
      <PRE>
      Option Request option in the Information-request message
      <LI>option-code</LI>
      <B>OPTION_ORO(6)</B>
      <LI>option-len</LI>
      Any
      <LI>requested-option-code-1</LI>
      <B>OPTION_DNS_SERVERS(23)</B>
      </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>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>
	</TABLE>
	</BLOCKQUOTE>
	</UL>
</UL>

=end html

=head1 TEST PROCEDURE

=begin html
<PRE>
       NUT     TN
        |       | 
        |       | initialize NUT (as a DHCPv6 Server)
        |       | 
        | <---- | Information-request(w/ Option Request option)
        | ----> | Reply (w/ Server ID option) (*1)
        |       | 
         reboot 
        |       | 
        | <---- | Information-request(w/ Option Request option)
        | ----> | Reply (w/ Server ID option) (*2)
</PRE>

=end html

=head1 JUDGEMENT

<PRE>
(*1)PASS: The DUID's  format in the Server's Identifier option of Reply 
    message must be base on description of RFC(see above Verification Points).
(*2)PASS: After restarting, the DUID must be keeped.
</PRE>

=head1 TERMINATION

  N/A

=head1 REFERENCE

=begin html
<PRE>
   see also RFC3315
   9.4. DUID Based on Link-layer Address [DUID-LL]
   22.3. Server Identifier Option

   see also RFC3736
   5.2. Options Required for Stateless DHCP Service
</PRE>

=end html

=head1 SEE ALSO

  perldoc V6evalTool

=cut