#!/usr/bin/perl
#
# Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
# 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.
#
# $Id: IKEv2-SGW-R-1-2-5-2-A.seq,v 1.4 2008/11/28 10:16:29 doo Exp $
#
################################################################



BEGIN
{
	push(@INC, '..');
        $ENV{'V6EVAL_WITH_KOI'} = 'TRUE';
}

END { }



use V6evalTool;
use IKEv2v6eval;
use IKEv2;
use strict;



my $remote	= 'common_remote_index';
my $ike_sa_init_req_param	= undef;
my $ike_sa_init_resp_param	= undef;
my $ike_auth_req_param	= undef;
my $ike_auth_resp_param	= undef;
my $create_child_sa_req_param = undef;
my $create_child_sa_resp_param = undef;

my $session	= undef;
my $material	= undef;
my $child_sa_material_1	= undef;
my $child_sa_material_2	= undef;
my $str	= undef;
my $ret	= undef;

my @local_create_child_sa_req = undef;
my @local_create_child_sa_resp = undef;


#--------------------------------------#
# prepare IKE_AUTH request             #
#--------------------------------------#
my $common_gen_ike_auth_req = $gen_ike_auth_req->{'common_remote_index'};
my @local_ike_auth_req = @{$common_gen_ike_auth_req};
# remove N(USE_TRANSPORT_MODE)
@local_ike_auth_req = grep {
                my $ret = 0;
                if ($_->{'self'} ne 'N') { $ret = 1; }
                if ($_->{'type'} ne 'USE_TRANSPORT_MODE') { $ret = 1; }
                $ret;
        } @local_ike_auth_req;
                                
$gen_ike_auth_req->{'SGW_R_IKE_AUTH_REQ'} = \@local_ike_auth_req;



#--------------------------------------#
# prepare IKE_AUTH response            #
#--------------------------------------#
my $common_exp_ike_auth_resp = $exp_ike_auth_resp->{'common_remote_index'};
my @local_ike_auth_resp = @{$common_exp_ike_auth_resp};
# remove N(USE_TRANSPORT_MODE)
foreach my $payload (@local_ike_auth_resp) {
        if ($payload->{'self'} eq 'E') {
                my @payloads = grep {
                                my $ret = 0;
                                if ($_->{'self'} ne 'N') { $ret = 1; }
                                if ($_->{'type'} ne 'USE_TRANSPORT_MODE') { $ret = 1; }
                                $ret;
                        } @{$payload->{'innerPayloads'}};

                $payload->{'innerPayloads'} = \@payloads;
        }
}
# set correct nexttype
for (my $i = 0; $i < scalar(@local_ike_auth_resp); $i++) {
        my $payload = $local_ike_auth_resp[$i];

        if ($payload->{'self'} eq 'E') {
                for (my $j = 0; $j < scalar(@{$payload->{'innerPayloads'}}); $j++) {
                        my $cur = $payload->{'innerPayloads'}->[$j];
                        my $next = $payload->{'innerPayloads'}->[$j+1];
                        unless (defined($next)) {
                                $cur->{'nexttype'} = '0';
                                next;
                        }
                        if ($cur->{'nexttype'} eq $next->{'self'}) {
                                next;
                        }
                        $cur->{'nexttype'} = $next->{'self'};
                }

                next;
        }

}
$exp_ike_auth_resp->{'SGW_R_IKE_AUTH_RESP'} = \@local_ike_auth_resp;



#--------------------------------------#
# prepare CREATE_CHILD_SA request      #
#--------------------------------------#
my $common_gen_create_child_sa_req = $gen_create_child_sa_req->{'common_remote_index'};
my @local_create_child_sa_req = @{$common_gen_create_child_sa_req};
# remove N(USE_TRANSPORT_MODE)
@local_create_child_sa_req = grep {
                my $ret = 0;
                if ($_->{'self'} ne 'N') { $ret = 1; }
                if ($_->{'type'} ne 'USE_TRANSPORT_MODE') { $ret = 1; }
                $ret;
        } @local_create_child_sa_req;
                                
$gen_create_child_sa_req->{'SGW_R_CREATE_CHILD_SA_REQ'} = \@local_create_child_sa_req;



#--------------------------------------#
# prepare CREATE_CHILD_SA response     #
#--------------------------------------#
my $common_exp_create_child_sa_resp = $exp_create_child_sa_resp->{'common_remote_index'};
my @local_create_child_sa_resp = @{$common_exp_create_child_sa_resp};
# remove N(USE_TRANSPORT_MODE)
foreach my $payload (@local_create_child_sa_resp) {
        if ($payload->{'self'} eq 'E') {
                my @payloads = grep {
                                my $ret = 0;
                                if ($_->{'self'} ne 'N') { $ret = 1; }
                                if ($_->{'type'} ne 'USE_TRANSPORT_MODE') { $ret = 1; }
                                $ret;
                        } @{$payload->{'innerPayloads'}};

                $payload->{'innerPayloads'} = \@payloads;
        }
}
# set correct nexttype
for (my $i = 0; $i < scalar(@local_create_child_sa_resp); $i++) {
        my $payload = $local_create_child_sa_resp[$i];

        if ($payload->{'self'} eq 'E') {
                $payload->{'innerType'} = @{$payload->{'innerPayloads'}}[0]->{'self'};

                for (my $j = 0; $j < scalar(@{$payload->{'innerPayloads'}}); $j++) {
                        my $cur = $payload->{'innerPayloads'}->[$j];
                        my $next = $payload->{'innerPayloads'}->[$j+1];
                        unless (defined($next)) {
                                $cur->{'nexttype'} = '0';
                                next;
                        }
                        if ($cur->{'nexttype'} eq $next->{'self'}) {
                                next;
                        }
                        $cur->{'nexttype'} = $next->{'self'};
                }

                next;
        }

}
$exp_create_child_sa_resp->{'SGW_R_CREATE_CHILD_SA_RESP'} = \@local_create_child_sa_resp;



#------------------------------#
# register IKEv2.pm            #
#------------------------------#
kLogHTML('<FONT COLOR="#FF0000" SIZE="+1"><U><B>TEST SETUP</B></U></FONT>');



unless(IKEv2initialize('SGW', 'SGW')) {
	IKEv2exitFatal('<FONT COLOR="#ff0000">IKEv2 module initializing failure</FONT>');
}



#------------------------------#
# configure TN                 #
#------------------------------#
unless(IKEv2setupTN()) {
	IKEv2exitFatal('<FONT COLOR="#ff0000">TN setup failure</FONT>');
}



#------------------------------#
# configure NUT                #
#------------------------------#
unless(IKEv2setupNUT()) {
	IKEv2exitFatal('<FONT COLOR="#ff0000">NUT setup failure</FONT>');
}



#------------------------------#
# prepare session handler      #
#------------------------------#
kLogHTML('<FONT COLOR="#FF0000" SIZE="+1"><U><B>TEST PROCEDURE</B></U></FONT>');



$session = IKEv2create_session($remote);
unless(defined($session)) {
	IKEv2exitFatal('<FONT COLOR="#ff0000">IKEv2 session creation failure</FONT>');
}



#--------------------------------------#
# send IKE_SA_INIT request to NUT      #
#--------------------------------------#
$str  = '<PRE>';
$str .= "    (R)             (I)\n";
$str .= "    NUT             TN1\n";
$str .= "     |               |\n";
$str .= "     |<--------------| IKE_SA_INIT request (HDR, SAi1, KEi, Ni)\n";
$str .= "     |               |\n";
$str .= "     V               V";
$str .= '</PRE>';

kLogHTML($str);



$ike_sa_init_req_param = devel_IKEv2send_IKE_SA_INIT_request($session, $remote);
unless(defined($ike_sa_init_req_param)) {
	kLogHTML(kDump_Common_Error());
	IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t send IKE_SA_INIT request.</FONT>');
}



#--------------------------------------#
# receive IKE_SA_INIT response by NUT  #
#--------------------------------------#
$str  = '<PRE>';
$str .= "    (R)             (I)\n";
$str .= "    NUT             TN1\n";
$str .= "     |               |\n";
$str .= "     |-------------->| IKE_SA_INIT response (HDR, SAr1, KEr, Nr)\n";
$str .= "     |               |\n";
$str .= "     V               V";
$str .= '</PRE>';

kLogHTML($str);



$ike_sa_init_resp_param = devel_IKEv2receive_IKE_SA_INIT_response($session,
							$remote,
							$ike_sa_init_req_param);
unless(defined($ike_sa_init_resp_param)) {
	kLogHTML(kDump_Common_Error());
	kLogHTML('<FONT COLOR="#ff0000">Can\'t observe IKE_SA_INIT response.</FONT>');
	IKEv2exitFail();
}



#--------------------------------------#
# generate keying material             #
#--------------------------------------#
$material = devel_IKEv2gen_keymat(1, $ike_sa_init_req_param, $ike_sa_init_resp_param);
unless(defined($material)) {
	kLogHTML(kDump_Common_Error());
	IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t generate keying material.</FONT>');
}



#--------------------------------------#
# send IKE_AUTH request to NUT         #
#--------------------------------------#
$str  = '<PRE>';
$str .= "    (R)             (I)\n";
$str .= "    NUT             TN1\n";
$str .= "     |               |\n";
$str .= "     |<--------------| IKE_AUTH request (HDR, SK {IDi, AUTH, SAi2, TSi, TSr})\n";
$str .= "     |               |\n";
$str .= "     V               V";
$str .= '</PRE>';

kLogHTML($str);



$ike_auth_req_param = devel_IKEv2send_IKE_AUTH_request($session,
							'SGW_R_IKE_AUTH_REQ',
							$ike_sa_init_req_param,
							$ike_sa_init_resp_param,
							$material);
unless(defined($ike_auth_req_param)) {
	kLogHTML(kDump_Common_Error());
	IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t send IKE_AUTH request.</FONT>');
}



#--------------------------------------#
# receive IKE_AUTH response by NUT     #
#--------------------------------------#
$str  = '<PRE>';
$str .= "    (R)             (I)\n";
$str .= "    NUT             TN1\n";
$str .= "     |               |\n";
$str .= "     |-------------->| IKE_AUTH response (HDR, SK {IDr, AUTH, SAr2, TSi, TSr)\n";
$str .= "     |               |\n";
$str .= "     V               V";
$str .= '</PRE>';

kLogHTML($str);



$ike_auth_resp_param = devel_IKEv2receive_IKE_AUTH_response($session,
							'SGW_R_IKE_AUTH_RESP',
							$ike_sa_init_req_param,
							$ike_sa_init_resp_param,
							$ike_auth_req_param,
							$material);
unless(defined($ike_auth_resp_param)) {
	kLogHTML(kDump_Common_Error());
	kLogHTML('<FONT COLOR="#ff0000">Can\'t observe IKE_AUTH response.</FONT>');
	IKEv2exitFail();
}



#--------------------------------------#
# generate keying material (CHILD_SA)  #
#--------------------------------------#
$child_sa_material_1 = devel_IKEv2gen_child_sa_keymat(1,
                                                      $material,
                                                      $ike_sa_init_req_param,
                                                      $ike_sa_init_resp_param,
                                                      $ike_auth_req_param,
                                                      $ike_auth_resp_param,
                                                      undef,
                                                      undef);



#--------------------------------------#
# set Upper Protocol for TN's SPD      #
#--------------------------------------#
IKEv2set_SPD('upperspec', 'icmp6');



#--------------------------------------#
# set keying material                  #
#--------------------------------------#
$ret = IKEv2set_child_sa_keymat(1, $child_sa_material_1, $ike_auth_req_param, $ike_auth_resp_param);
unless($ret) {
	kLogHTML(kDump_Common_Error());
	IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t set keying material.</FONT>');
}



#--------------------------------------#
# prepare ICMP session handler         #
#--------------------------------------#
my $icmp_session_th2 = ICMPcreate_session('TH2sendtoTH1');
unless(defined($icmp_session_th2)) {
        IKEv2exitFatal('<FONT COLOR="#ff0000">ICMP session creation failure</FONT>');
}

my $icmp_session_th1 = ICMPcreate_session('TH1sendtoTH2');
unless(defined($icmp_session_th1)) {
        IKEv2exitFatal('<FONT COLOR="#ff0000">ICMP session creation failure</FONT>');
}



#--------------------------------------#
# receive Echo Reply (DUMMY)           #
#--------------------------------------#
$icmp_session_th1->timeout(1);
$ret = ICMPreceive($icmp_session_th1);
$icmp_session_th1->timeout(12);



#--------------------------------------#
# send Echo Reply                      #
#--------------------------------------#
$str  = '<PRE>';
$str .= "                    (R)             (I)\n";
$str .= "    TH1             NUT             TN1             TH2\n";
$str .= "     |               |               |               |\n";
$str .= "     |<--------------+===============+---------------| IPsec {Echo Reply}\n";
$str .= "     |               |               |               |\n";
$str .= "     V               V               V               V";
$str .= '</PRE>';

kLogHTML($str);

$ret = ICMPsend($icmp_session_th2, 'echo_reply');
unless (defined($ret)) {
        kLogHTML(kDump_Common_Error());
        IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t send ICMP packet.</FONT>');
}



#--------------------------------------#
# receive Echo Reply                   #
#--------------------------------------#
$ret = ICMPreceive($icmp_session_th1);
unless(defined($ret)) {
        my $strerror = kDump_Common_Error();
        kLogHTML('<FONT COLOR="#ff0000">Can\'t observe ICMP packet.</FONT>');
        IKEv2exitFail();
}

#--------------------------------------#
# send Echo Reply                      #
#--------------------------------------#
$str  = '<PRE>';
$str .= "                    (R)             (I)\n";
$str .= "    TH1             NUT             TN1             TH2\n";
$str .= "     |               |               |               |\n";
$str .= "     |---------------+===============+-------------->| IPsec {Echo Reply}\n";
$str .= "     |               |               |               |\n";
$str .= "     V               V               V               V";
$str .= '</PRE>';

kLogHTML($str);

$ret = ICMPsend_v6eval('TH1sendtoTH2', 'echo_reply');
unless (defined($ret)) {
        kLogHTML(kDump_Common_Error());
        IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t send ICMP packet.</FONT>');
}



#--------------------------------------#
# receive Echo Reply                   #
#--------------------------------------#
$ret = ICMPreceive($icmp_session_th2);
unless(defined($ret)) {
        my $strerror = kDump_Common_Error();
        kLogHTML('<FONT COLOR="#ff0000">Can\'t observe ICMP packet.</FONT>');
        IKEv2exitFail();
}



#--------------------------------------#
# prepare CREATE_CHILD_SA request      #
#--------------------------------------#
my $req_notify_for_rekey =
{       # Notify Payload
        'self'          => 'N',         # *** MUST BE HERE ***
        'nexttype'      => undef,       # Next Payload
        'critical'      => undef,       # Critical
        'reserved'      => undef,       # RESERVED
        'length'        => undef,       # Payload Length
        'id'            => '3',         # Protocol ID
        'spiSize'       => '4',         # SPI Size
        'type'          => 'REKEY_SA',  # Notify Message Type
        'spi'           => $ike_auth_req_param->{'spi'}[0],       # SPI
        'data'          => undef        # Notification Data
};
my $common_create_child_sa_req = $gen_create_child_sa_req->{'SGW_R_CREATE_CHILD_SA_REQ'};
@local_create_child_sa_req = @{$common_create_child_sa_req};
# change N(USE_TRANSPORT_MODE) & add N(REKEY_SA)
for (my $i = 0; $i < scalar(@local_create_child_sa_req); $i++) {
        my $payload = $local_create_child_sa_req[$i];

        if ($payload->{'self'} eq 'SA') {
                splice(@local_create_child_sa_req, $i, 0, $req_notify_for_rekey);
                last;
        }
}
$gen_create_child_sa_req->{'SGW-R-1-2-3-1.1'} = \@local_create_child_sa_req;


#--------------------------------------#
# send CREATE_CHILD_SA request to NUT  #
#--------------------------------------#
$str  = '<PRE>';
$str .= "    (R)             (I)\n";
$str .= "    NUT             TN1\n";
$str .= "     |               |\n";
$str .= "     |<--------------| CREATE_CHILD_SA request (HDR, SK {N(REKEY_SA), SA, Ni, TSi, TSr})\n";
$str .= "     |               |\n";
$str .= "     V               V";
$str .= '</PRE>';

kLogHTML($str);



$create_child_sa_req_param = devel_IKEv2send_CREATE_CHILD_SA_request($session,
                                                                     'SGW-R-1-2-3-1.1',
                                                                     $ike_sa_init_req_param,
                                                                     $ike_sa_init_resp_param,
                                                                     $ike_auth_req_param,
                                                                     $material);
unless(defined($create_child_sa_req_param)) {
        kLogHTML(kDump_Common_Error());
        IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t send CREATE_CHILD_SA request.</FONT>');
}



#------------------------------------------#
# receive CREATE_CHILD_SA response by NUT  #
#------------------------------------------#
$str  = '<PRE>';
$str .= "    (R)             (I)\n";
$str .= "    NUT             TN1\n";
$str .= "     |               |\n";
$str .= "     |-------------->| CREATE_CHILD_SA response (HDR, SK {SA, Nr, TSi, TSr})\n";
$str .= "     |               |\n";
$str .= "     V               V";
$str .= '</PRE>';

kLogHTML($str);



$create_child_sa_resp_param = devel_IKEv2receive_CREATE_CHILD_SA_response($session,
                                                                          'SGW_R_CREATE_CHILD_SA_RESP',
                                                                          $ike_sa_init_req_param,
                                                                          $ike_sa_init_resp_param,
                                                                          $create_child_sa_resp_param,
                                                                          $material);
unless(defined($create_child_sa_resp_param)) {
        kLogHTML(kDump_Common_Error());
        kLogHTML('<FONT COLOR="#ff0000">Can\'t observe CREATE_CHILD_SA response.</FONT>');
        IKEv2exitFail();
}



#--------------------------------------#
# generate keying material (CHILD_SA)  #
#--------------------------------------#
$child_sa_material_2 = devel_IKEv2gen_child_sa_keymat(0,	# CREATE_CHILD_SA Exchange
						    $material,
						    $ike_sa_init_req_param,
						    $ike_sa_init_resp_param,
						    $ike_auth_req_param,
						    $ike_auth_resp_param,
						    $create_child_sa_req_param,
						    $create_child_sa_resp_param);



#--------------------------------------#
# send Echo Reply                      #
#--------------------------------------#
$str  = '<PRE>';
$str .= "                    (R)             (I)\n";
$str .= "    TH1             NUT             TN1             TH2\n";
$str .= "     |               |               |               |\n";
$str .= "     |<--------------+===============+---------------| IPsec {Echo Reply w/ 1st CHILD_SA}\n";
$str .= "     |               |               |               |\n";
$str .= "     V               V               V               V";
$str .= '</PRE>';

kLogHTML($str);

$ret = ICMPsend($icmp_session_th2, 'echo_reply');
unless (defined($ret)) {
        kLogHTML(kDump_Common_Error());
        IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t send ICMP packet.</FONT>');
}



#--------------------------------------#
# receive Echo Reply                   #
#--------------------------------------#
$ret = ICMPreceive($icmp_session_th1);
unless(defined($ret)) {
        my $strerror = kDump_Common_Error();
        kLogHTML('<FONT COLOR="#ff0000">Can\'t observe ICMP packet.</FONT>');
        IKEv2exitFail();
}

#--------------------------------------#
# send Echo Reply                      #
#--------------------------------------#
$str  = '<PRE>';
$str .= "                    (R)             (I)\n";
$str .= "    TH1             NUT             TN1             TH2\n";
$str .= "     |               |               |               |\n";
$str .= "     |---------------+===============+-------------->| IPsec {Echo Reply}\n";
$str .= "     |               |               |               |\n";
$str .= "     V               V               V               V";
$str .= '</PRE>';

kLogHTML($str);

$ret = ICMPsend_v6eval('TH1sendtoTH2', 'echo_reply');
unless (defined($ret)) {
        kLogHTML(kDump_Common_Error());
        IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t send ICMP packet.</FONT>');
}



#--------------------------------------#
# receive Echo Reply                   #
#--------------------------------------#
$ret = ICMPreceive($icmp_session_th2);
unless(defined($ret)) {
        my $strerror = kDump_Common_Error();
        kLogHTML('<FONT COLOR="#ff0000">Can\'t observe ICMP packet.</FONT>');
        IKEv2exitFail();
}



#-----------------------------------------#
# flush SAD and SPD (delete 1st CHILD_SA) #
#-----------------------------------------#
$ret = IKEv2flush_SAD_SPD();
unless ($ret) {
        kLogHTML(kDump_Common_Error());
        IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t flush SAD or SPD.</FONT>');
}



#----------------------------------------#
# set keying material (for 2nd CHILD_SA) #
#----------------------------------------#
$ret = IKEv2set_child_sa_keymat(1,
                                $child_sa_material_2,
                                $create_child_sa_req_param,
                                $create_child_sa_resp_param);
unless($ret) {
        kLogHTML(kDump_Common_Error()); 
        IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t set keying material.</FONT>');
}



#--------------------------------------#
# send Echo Reply                      #
#--------------------------------------#
$str  = '<PRE>';
$str .= "                    (R)             (I)\n";
$str .= "    TH1             NUT             TN1             TH2\n";
$str .= "     |               |               |               |\n";
$str .= "     |<--------------+===============+---------------| IPsec {Echo Reply w/ 2nd CHILD_SA}\n";
$str .= "     |               |               |               |\n";
$str .= "     V               V               V               V";
$str .= '</PRE>';

kLogHTML($str);

$ret = ICMPsend($icmp_session_th2, 'echo_reply');
unless (defined($ret)) {
        kLogHTML(kDump_Common_Error());
        IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t send ICMP packet.</FONT>');
}



#--------------------------------------#
# receive Echo Reply                   #
#--------------------------------------#
$ret = ICMPreceive($icmp_session_th1);
unless(defined($ret)) {
        my $strerror = kDump_Common_Error();
        kLogHTML('<FONT COLOR="#ff0000">Can\'t observe ICMP packet.</FONT>');
        IKEv2exitFail();
}

#--------------------------------------#
# send Echo Reply                      #
#--------------------------------------#
$str  = '<PRE>';
$str .= "                    (R)             (I)\n";
$str .= "    TH1             NUT             TN1             TH2\n";
$str .= "     |               |               |               |\n";
$str .= "     |---------------+===============+-------------->| IPsec {Echo Reply}\n";
$str .= "     |               |               |               |\n";
$str .= "     V               V               V               V";
$str .= '</PRE>';

kLogHTML($str);

$ret = ICMPsend_v6eval('TH1sendtoTH2', 'echo_reply');
unless (defined($ret)) {
        kLogHTML(kDump_Common_Error());
        IKEv2exitFatal('<FONT COLOR="#ff0000">Can\'t send ICMP packet.</FONT>');
}



#--------------------------------------#
# receive Echo Reply                   #
#--------------------------------------#
$ret = ICMPreceive($icmp_session_th2);
unless(defined($ret)) {
        my $strerror = kDump_Common_Error();
        kLogHTML('<FONT COLOR="#ff0000">Can\'t observe ICMP packet.</FONT>');
        IKEv2exitFail();
}



#--------------------------------------#
# exit with cleanup                    #
#--------------------------------------#
IKEv2exitPass();
# NOTREACHED



#
# perldoc
#
########################################################################
__END__

=head1 Title

  Test IKEv2.SGW.R.1.2.5.2: Use of the new CHILD_SA 
  Part A: (BASIC)

=head1 Purpose

  To verify an IKEv2 device properly recognizes the lifetime of CHILD_SAs.

=head1 References

  * [RFC 4306] - Sections 2.8

=head1 Test Setup

  * Network Topology
      Connect the devices according to the Common Topology.
  * Configuration
      In each part, configure the devices according to the Common Configuration.
  * Pre-Sequence and Cleanup Sequence
      IKEv2 on the NUT is disabled after each part.

=head1 Procedure

=begin html

<BLOCKQUOTE>
<PRE>

   TH1            NUT           TN1           TH2
 (HOST)          (SGW)         (SGW)         (Host)
    |              |             |             |
    |              |<------------|             | IKE_SA_INIT request (HDR, SAi1, KEi, Ni)
    |              |             |             | (Packet #1)
    |              |------------>|             | IKE_SA_INIT Response (HDR, SAr1, KEr, Nr)
    |              |             |             | (Judgement #1)
    |              |             |             |
    |              |<------------|             | IKE_AUTH request (HDR, SK {IDi, AUTH, SAi2, TSi, TSr})
    |              |             |             | (Packet #2)
    |              |------------>|             | IKE_AUTH Response (HDR, SK {IDr, AUTH, SAr2, TSi, TSr})
    |              |             |             | (Judgement #2)
    |              |             |             |
    |<-------------+=============+-------------| IPSec {Echo Request}     
    |              |             |             | (Packet #3) (Judgement #3)
    |--------------+=============+------------>| IPSec {Echo Reply}       
    |              |             |             | (Packet #4) (Judgement #4)
    |              |             |             |
    |              |<------------|             | CREATE_CHILD_SA request (HDR, SK {N, SA, Ni, TSi, TSr})
    |              |             |             | (Packet #5)
    |              |------------>|             | CREATE_CHILD_SA response (HDR, SK {SA, Nr, TSi, TSr})
    |              |             |             | (Judgement #5)
    |              |             |             |
    |              |<------------|             | INFORMATIONAL request (HDR, SK {D})
    |              |             |             | (Packet #6)
    |              |------------>|             | INFORMATIONAL Response (HDR, SK {D})
    |              |             |             | (Judgement #6)
    |              |             |             | 
    |<-------------+=============+-------------| IPSec {Echo Request}   (new CHILD_SA) 
    |              |             |             | (Packet #7) (Judgement #7)
    |--------------+=============+------------>| IPSec {Echo Reply}     (new CHILD_SA) 
    |              |             |             | (Packet #8) (Judgement #8)
    |              |             |             |
    V              V             V             V<br>
 N: RELEY_SA 
</PRE>
</BLOCKQUOTE>

<BLOCKQUOTE>
<TABLE BORDER>
<TR>
<TD><TT>Packet #1</TT></TD>
<TD><TT>See Common Packet #1</TT></TD>
</TR>
<TR>
<TD><TT>Packet #2</TT></TD>
<TD><TT>See Common Packet #3</TT></TD>
</TR>
<TR>
<TD><TT>Packet #3</TT></TD>
<TD><TT>See Common Packet #21</TT></TD>
</TR>
<TR>
<TD><TT>Packet #4</TT></TD>
<TD><TT>See Common Packet #25</TT></TD>
</TR>
<TR>
<TD><TT>Packet #5</TT></TD>
<TD><TT>See Common Packet #15</TT></TD>
</TR>
<TR>
<TD><TT>Packet #6</TT></TD>
<TD><TT>See below</TT></TD>
</TR>
<TR>
<TD><TT>Packet #7</TT></TD>
<TD><TT>See Common Packet #21<br>(encrypted by the new CHILD_SA)</TT></TD>
</TR>
<TR>
<TD><TT>Packet #8</TT></TD>
<TD><TT>See Common Packet #25</TT></TD>
</TR>
</TABLE>
</BLOCKQUOTE>

<BLOCKQUOTE>
Packet #6: INFORMATIONAL request
<TABLE BORDER>
<TR>
<TD rowspan="2">IPv6 Header</TD>
<TD>Source Address</TD>
<TD>TN1's Global Address on Link X</TD>
</TR>
<TR>
<TD>Destination Address</TD>
<TD>NUT's Global Address on Link A</TD>
</TR>
<TR>
<TD rowspan="2">UDP Header</TD>
<TD>Source Address</TD>
<TD>500</TD>
</TR>
<TR>
<TD>Destination Address</TD>
<TD>500</TD>
</TR>
<TR>
<TD rowspan="13">IKEv2 Header</TD>
<TD>IKE_SA Initiator's SPI</TD>
<TD>any</TD>
</TR>
<TR>
<TD>IKE_SA Responder's SPI</TD>
<TD>any</TD>
</TR>
<TR>
<TD>Next Payload</TD>
<TD>46 (E)</TD>
</TR>
<TR>
<TD>Major Version</TD>
<TD>2</TD>
</TR>
<TR>
<TD>Minor Version</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Exchange Type</TD>
<TD>37 (INFORMATIONAL)</TD>
</TR>
<TR>
<TD>X (bits 0-2 of Flags)</TD>
<TD>0</TD>
</TR>
<TR>
<TD>I (bit 3 of Flags)</TD>
<TD>any</TD>
</TR>
<TR>
<TD>V (bit 4 of Flags)</TD>
<TD>0</TD>
</TR>
<TR>
<TD>R (bit 5 of Flags)</TD>
<TD>0</TD>
</TR>
<TR>
<TD>X (bits 6-7 Flags)</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Message ID</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Length</TD>
<TD>any</TD>
</TR>
<TR>
<TD rowspan="9">E Payloa</TD>
<TD>Next Payload</TD>
<TD>42 (D)</TD>
</TR>
<TR>
<TD>Critical</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Reserved</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Payload Length</TD>
<TD>any</TD>
</TR>
<TR>
<TD>Initialization Vector</TD>
<TD>The same value as block length of the underlying encryption algorithm</TD>
</TR>
<TR>
<TD>Encrypted IKE Payloads</TD>
<TD>Subsequent payloads encrypted by underlying encryption algorithm</TD>
</TR>
<TR>
<TD>Padding</TD>
<TD>Any value which to be a multiple of the encryption block size</TD>
</TR>
<TR>
<TD>Pad Length</TD>
<TD>The length of the Padding field</TD>
</TR>
<TR>
<TD>Integrity Checksum Data</TD>
<TD>The Cryptographic checksum of the entire message</TD>
</TR>
<TR>
<TD rowspan="8">D Payload</TD>
<TD>Next Payload</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Critical</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Reserved</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Payload Length</TD>
<TD>12</TD>
</TR>
<TR>
<TD>Protocol ID</TD>
<TD>3 (ESP)</TD>
</TR>
<TR>
<TD>SPI Size</TD>
<TD>4</TD>
</TR>
<TR>
<TD># of SPIs</TD>
<TD>1</TD>
</TR>
<TR>
<TD>Security Parameter Index</TD>
<TD>NUT's inbound CHILD_SA SPI value to be deleted</TD>
</TR>
</TABLE>
</BLOCKQUOTE>

=end html

  Part A: (BASIC)
     1. TN1 starts to negotiate with NUT by sending IKE_SA_INIT request.
     2. Observe the messages transmitted on Link A.
     3. After reception of IKE_SA_INIT response from the NUT, TN1 transmits an IKE_AUTH
        request to the NUT.
     4. Observe the messages transmitted on Link A.
     5. TH2 transmits an Echo Request to TH1. TN1 forwards an Echo Request using the first
        negotiated algorithms to the NUT.
     6. Observe the messages transmitted on Link B.
     7. TH1 transmits an Echo Reply to TH2.
     8. Observe the messages transmitted on Link A.
     9. TN1 transmits a CREATE_CHILD_SA request including a Notify Payload of type
        REKEY_SA and rekeyed CHILD_SA's SPI value in the SPI field to the NUT.
    10. Observe the messages transmitted on Link A.
    11. TN1 transmits an INFORMATIONAL request with a Delete payload to the NUT.
    12. Observe the messages transmitted on Link A.
    13. TH2 transmits an Echo Request to TH1. TH1. TN1 forwards an Echo Request using the
        second negotiated algorithms to the NUT.
    14. Observe the messages transmitted on Link B.
    15. TH1 transmits an Echo Reply to TH2.
    16. Observe the messages transmitted on Link A.

=head1 Observable Result

  Part A
       Step 2: Judgment #1
       The NUT transmits an IKE_SA_INIT response including "ENCR_3DES",
       "PRF_HMAC_SHA1", "AUTH_HMAC_SHA1_96" and "D-H group 2" as accepted
       algorithms.

       Step 4: Judgment #2
       The NUT transmits an IKE_AUTH response including "ENCR_3DES",
       "AUTH_HMAC_SHA1_96" and "No Extended Sequence Numbers" as accepted algorithms.

       Step 6: Judgment #3
       The NUT forwards an Echo Request.

       Step 8: Judgment #4
       The NUT forwards an Echo Reply with IPsec ESP using the first negotiated algorithms.

       Step 10: Judgment #5
       The NUT transmits a CREATE_CHILD_SA response including "ENCR_3DES",
       "AUTH_HMAC_SHA1_96" and "No Extended Sequence Numbers" as proposed algorithms.

       Step 12: Judgment #6
       The NUT transmits an INFORMATIONAL response with a Delete payload. The Delete
       payload includes 3 (ESP) as Protocol ID, 4 as SPI Size and the NUT's inbound SPI value to
       be deleted as SPI value.

       Step 14: Judgment #7
       The NUT forwards an Echo Request.

       Step 16: Judgment #8
       The NUT forwards an Echo Reply with IPsec ESP using the second negotiated algorithms.

=head1 Possible Problems

  * None. 

=cut


=head1 Title

  Test IKEv2.SGW.R.1.2.5.2: Use of the new CHILD_SA 
  Part A: (BASIC)

=head1 Purpose

  To verify an IKEv2 device properly recognizes the lifetime of CHILD_SAs.

=head1 References

  * [RFC 4306] - Sections 2.8

=head1 Test Setup

  * Network Topology
      Connect the devices according to the Common Topology.
  * Configuration
      In each part, configure the devices according to the Common Configuration.
  * Pre-Sequence and Cleanup Sequence
      IKEv2 on the NUT is disabled after each part.

=head1 Procedure

=begin html

<BLOCKQUOTE>
<PRE>

   TH1            NUT           TN1           TH2
 (HOST)          (SGW)         (SGW)         (Host)
    |              |             |             |
    |              |<------------|             | IKE_SA_INIT request (HDR, SAi1, KEi, Ni)
    |              |             |             | (Packet #1)
    |              |------------>|             | IKE_SA_INIT Response (HDR, SAr1, KEr, Nr)
    |              |             |             | (Judgement #1)
    |              |             |             |
    |              |<------------|             | IKE_AUTH request (HDR, SK {IDi, AUTH, SAi2, TSi, TSr})
    |              |             |             | (Packet #2)
    |              |------------>|             | IKE_AUTH Response (HDR, SK {IDr, AUTH, SAr2, TSi, TSr})
    |              |             |             | (Judgement #2)
    |              |             |             |
    |<-------------+=============+-------------| IPSec {Echo Request}     
    |              |             |             | (Packet #3) (Judgement #3)
    |--------------+=============+------------>| IPSec {Echo Reply}       
    |              |             |             | (Packet #4) (Judgement #4)
    |              |             |             |
    |              |<------------|             | CREATE_CHILD_SA request (HDR, SK {N, SA, Ni, TSi, TSr})
    |              |             |             | (Packet #5)
    |              |------------>|             | CREATE_CHILD_SA response (HDR, SK {SA, Nr, TSi, TSr})
    |              |             |             | (Judgement #5)
    |              |             |             |
    |              |<------------|             | INFORMATIONAL request (HDR, SK {D})
    |              |             |             | (Packet #6)
    |              |------------>|             | INFORMATIONAL Response (HDR, SK {D})
    |              |             |             | (Judgement #6)
    |              |             |             | 
    |<-------------+=============+-------------| IPSec {Echo Request}   (new CHILD_SA) 
    |              |             |             | (Packet #7) (Judgement #7)
    |--------------+=============+------------>| IPSec {Echo Reply}     (new CHILD_SA) 
    |              |             |             | (Packet #8) (Judgement #8)
    |              |             |             |
    V              V             V             V<br>
 N: RELEY_SA 
</PRE>
</BLOCKQUOTE>

<BLOCKQUOTE>
<TABLE BORDER>
<TR>
<TD><TT>Packet #1</TT></TD>
<TD><TT>See Common Packet #1</TT></TD>
</TR>
<TR>
<TD><TT>Packet #2</TT></TD>
<TD><TT>See Common Packet #3</TT></TD>
</TR>
<TR>
<TD><TT>Packet #3</TT></TD>
<TD><TT>See Common Packet #21</TT></TD>
</TR>
<TR>
<TD><TT>Packet #4</TT></TD>
<TD><TT>See Common Packet #25</TT></TD>
</TR>
<TR>
<TD><TT>Packet #5</TT></TD>
<TD><TT>See Common Packet #15</TT></TD>
</TR>
<TR>
<TD><TT>Packet #6</TT></TD>
<TD><TT>See below</TT></TD>
</TR>
<TR>
<TD><TT>Packet #7</TT></TD>
<TD><TT>See Common Packet #21<br>(encrypted by the new CHILD_SA)</TT></TD>
</TR>
<TR>
<TD><TT>Packet #8</TT></TD>
<TD><TT>See Common Packet #25</TT></TD>
</TR>
</TABLE>
</BLOCKQUOTE>

<BLOCKQUOTE>
Packet #6: INFORMATIONAL request
<TABLE BORDER>
<TR>
<TD rowspan="2">IPv6 Header</TD>
<TD>Source Address</TD>
<TD>TN1's Global Address on Link X</TD>
</TR>
<TR>
<TD>Destination Address</TD>
<TD>NUT's Global Address on Link A</TD>
</TR>
<TR>
<TD rowspan="2">UDP Header</TD>
<TD>Source Address</TD>
<TD>500</TD>
</TR>
<TR>
<TD>Destination Address</TD>
<TD>500</TD>
</TR>
<TR>
<TD rowspan="13">IKEv2 Header</TD>
<TD>IKE_SA Initiator's SPI</TD>
<TD>any</TD>
</TR>
<TR>
<TD>IKE_SA Responder's SPI</TD>
<TD>any</TD>
</TR>
<TR>
<TD>Next Payload</TD>
<TD>46 (E)</TD>
</TR>
<TR>
<TD>Major Version</TD>
<TD>2</TD>
</TR>
<TR>
<TD>Minor Version</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Exchange Type</TD>
<TD>37 (INFORMATIONAL)</TD>
</TR>
<TR>
<TD>X (bits 0-2 of Flags)</TD>
<TD>0</TD>
</TR>
<TR>
<TD>I (bit 3 of Flags)</TD>
<TD>any</TD>
</TR>
<TR>
<TD>V (bit 4 of Flags)</TD>
<TD>0</TD>
</TR>
<TR>
<TD>R (bit 5 of Flags)</TD>
<TD>0</TD>
</TR>
<TR>
<TD>X (bits 6-7 Flags)</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Message ID</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Length</TD>
<TD>any</TD>
</TR>
<TR>
<TD rowspan="9">E Payloa</TD>
<TD>Next Payload</TD>
<TD>42 (D)</TD>
</TR>
<TR>
<TD>Critical</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Reserved</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Payload Length</TD>
<TD>any</TD>
</TR>
<TR>
<TD>Initialization Vector</TD>
<TD>The same value as block length of the underlying encryption algorithm</TD>
</TR>
<TR>
<TD>Encrypted IKE Payloads</TD>
<TD>Subsequent payloads encrypted by underlying encryption algorithm</TD>
</TR>
<TR>
<TD>Padding</TD>
<TD>Any value which to be a multiple of the encryption block size</TD>
</TR>
<TR>
<TD>Pad Length</TD>
<TD>The length of the Padding field</TD>
</TR>
<TR>
<TD>Integrity Checksum Data</TD>
<TD>The Cryptographic checksum of the entire message</TD>
</TR>
<TR>
<TD rowspan="8">D Payload</TD>
<TD>Next Payload</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Critical</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Reserved</TD>
<TD>0</TD>
</TR>
<TR>
<TD>Payload Length</TD>
<TD>12</TD>
</TR>
<TR>
<TD>Protocol ID</TD>
<TD>3 (ESP)</TD>
</TR>
<TR>
<TD>SPI Size</TD>
<TD>4</TD>
</TR>
<TR>
<TD># of SPIs</TD>
<TD>1</TD>
</TR>
<TR>
<TD>Security Parameter Index</TD>
<TD>NUT's inbound CHILD_SA SPI value to be deleted</TD>
</TR>
</TABLE>
</BLOCKQUOTE>

=end html

  Part A: (BASIC)
     1. TN1 starts to negotiate with NUT by sending IKE_SA_INIT request.
     2. Observe the messages transmitted on Link A.
     3. After reception of IKE_SA_INIT response from the NUT, TN1 transmits an IKE_AUTH
        request to the NUT.
     4. Observe the messages transmitted on Link A.
     5. TH2 transmits an Echo Request to TH1. TN1 forwards an Echo Request using the first
        negotiated algorithms to the NUT.
     6. Observe the messages transmitted on Link B.
     7. TH1 transmits an Echo Reply to TH2.
     8. Observe the messages transmitted on Link A.
     9. TN1 transmits a CREATE_CHILD_SA request including a Notify Payload of type
        REKEY_SA and rekeyed CHILD_SA's SPI value in the SPI field to the NUT.
    10. Observe the messages transmitted on Link A.
    11. TN1 transmits an INFORMATIONAL request with a Delete payload to the NUT.
    12. Observe the messages transmitted on Link A.
    13. TH2 transmits an Echo Request to TH1. TH1. TN1 forwards an Echo Request using the
        second negotiated algorithms to the NUT.
    14. Observe the messages transmitted on Link B.
    15. TH1 transmits an Echo Reply to TH2.
    16. Observe the messages transmitted on Link A.

=head1 Observable Result

  Part A
       Step 2: Judgment #1
       The NUT transmits an IKE_SA_INIT response including "ENCR_3DES",
       "PRF_HMAC_SHA1", "AUTH_HMAC_SHA1_96" and "D-H group 2" as accepted
       algorithms.

       Step 4: Judgment #2
       The NUT transmits an IKE_AUTH response including "ENCR_3DES",
       "AUTH_HMAC_SHA1_96" and "No Extended Sequence Numbers" as accepted algorithms.

       Step 6: Judgment #3
       The NUT forwards an Echo Request.

       Step 8: Judgment #4
       The NUT forwards an Echo Reply with IPsec ESP using the first negotiated algorithms.

       Step 10: Judgment #5
       The NUT transmits a CREATE_CHILD_SA response including "ENCR_3DES",
       "AUTH_HMAC_SHA1_96" and "No Extended Sequence Numbers" as proposed algorithms.

       Step 12: Judgment #6
       The NUT transmits an INFORMATIONAL response with a Delete payload. The Delete
       payload includes 3 (ESP) as Protocol ID, 4 as SPI Size and the NUT's inbound SPI value to
       be deleted as SPI value.

       Step 14: Judgment #7
       The NUT forwards an Echo Request.

       Step 16: Judgment #8
       The NUT forwards an Echo Reply with IPsec ESP using the second negotiated algorithms.

=head1 Possible Problems

  * None. 

=cut

