1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
|
#
# ICMPv6.pm
# NetPacket::ICMPv6
#
# Decode Internet Control Message Protocol v6 packet header.
#
# References:
# RFC2463 - ICMPv6 Specification
#
# Copyright (c) 2003-2009 Joel Knight <knight.joel@gmail.com>
#
# Permission to use, copy, modify, and distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
#
#
# $jwk: ICMPv6.pm,v 1.16 2009/03/01 20:12:46 jwk Exp $
package NetPacket::ICMPv6;
BEGIN {
$NetPacket::ICMPv6::VERSION = '0.43.1';
}
use strict;
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
use NetPacket;
BEGIN {
@ISA = qw(Exporter NetPacket);
@EXPORT = qw( );
@EXPORT_OK = qw(
icmpv6_strip
ICMPV6_DST_UNREACH
ICMPV6_PACKET_TOO_BIG
ICMPV6_TIME_EXCEEDED
ICMPV6_PARAM_PROB
ICMPV6_ECHO_REQUEST
ICMPV6_ECHO_REPLY
);
%EXPORT_TAGS = (
ALL => [@EXPORT, @EXPORT_OK],
types => [qw(
ICMPV6_DST_UNREACH
ICMPV6_PACKET_TOO_BIG
ICMPV6_TIME_EXCEEDED
ICMPV6_PARAM_PROB
ICMPV6_ECHO_REQUEST
ICMPV6_ECHO_REPLY
)],
strip => [qw(icmpv6_strip)],
);
}
use NetPacket::IPv6;
# icmp6 packet types
use constant ICMPV6_DST_UNREACH => 1;
use constant ICMPV6_PACKET_TOO_BIG => 2;
use constant ICMPV6_TIME_EXCEEDED => 3;
use constant ICMPV6_PARAM_PROB => 4;
use constant ICMPV6_ECHO_REQUEST => 128;
use constant ICMPV6_ECHO_REPLY => 129;
# calculate icmp6 checksum; note that parts of the outer ipv6
# packet are needed for the calculation
sub checksum {
my $self = shift;
my $ip6 = $_[0];
my @src_ip = NetPacket::IPv6::hexstr_to_int($ip6->{src_ip});
my @dst_ip = NetPacket::IPv6::hexstr_to_int($ip6->{dest_ip});
my $extra = $self->_get_extra_field;
# XXX will there ever be a header between the ip6 and icmp6 headers?
# if so, using ip6->{plen} here is wrong; the length in the pseudo
# header is the length of the icmp6 packet only; RFC2460 8.1
my $hdr = pack('NNNNNNNNNNCCnNa*', @src_ip[0..3], @dst_ip[0..3],
$ip6->{plen}, $ip6->{nxt}, $self->{type}, $self->{code},
0, $extra, $self->{data});
return NetPacket::htons(NetPacket::in_cksum($hdr));
}
# decode icmpv6 header, return a NetPacket::ICMPv6 object
sub decode {
my $class = shift;
my ($pkt, $parent) = @_;
my $self = {};
# Class fields
$self->{_parent} = $parent;
$self->{_frame} = $pkt;
# Decode packet
if (defined $pkt) {
($self->{type}, $self->{code}, $self->{cksum}, $self->{data})
= unpack('CCna*', $pkt);
# based on the icmp6 type, decode the rest of the packet
# XXX changes here must match _get_extra_field().
if ($self->{type} == ICMPV6_ECHO_REQUEST ||
$self->{type} == ICMPV6_ECHO_REPLY) {
($self->{id}, $self->{seq}, $self->{data})
= unpack('nna*', $self->{data});
} elsif ($self->{type} == ICMPV6_DST_UNREACH ||
$self->{type} == ICMPV6_TIME_EXCEEDED) {
($self->{unused}, $self->{data})
= unpack('Na*', $self->{data});
} elsif ($self->{type} == ICMPV6_PACKET_TOO_BIG) {
($self->{mtu}, $self->{data})
= unpack('Na*', $self->{data});
} elsif ($self->{type} == ICMPV6_PARAM_PROB) {
($self->{ptr}, $self->{data})
= unpack('Na*', $self->{data});
}
}
bless ($self, $class);
return $self;
}
undef &icmpv6_strip; # Create alias
*icmpv6_strip = \&strip;
# return the data portion of an ipv6 packet
sub strip {
my ($pkt) = $_[0];
my $icmpv6_obj = NetPacket::ICMPv6->decode($pkt);
return $icmpv6_obj->{data};
}
# reverse the decoding process and return the raw, encoded packet
sub encode {
my $class = shift;
my $self = shift;
my $ip6 = $_[0];
my $cksum = $self->checksum($ip6);
my $extra = $self->_get_extra_field;
my $packet = pack('CCnNa*', $self->{type}, $self->{code},
$cksum, $extra, $self->{data});
return($packet);
}
# based on the icmp6 type, return the data from the type-dependant
# header field.
# XXX changes here must match type-dependent code in decode().
sub _get_extra_field {
my $self = shift;
my $f;
if ($self->{type} == ICMPV6_ECHO_REQUEST ||
$self->{type} == ICMPV6_ECHO_REPLY) {
$f = (($self->{id} << 16) & 0xffff0000) | $self->{seq};
} elsif ($self->{type} == ICMPV6_DST_UNREACH ||
$self->{type} == ICMPV6_TIME_EXCEEDED) {
$f = $self->{unused};
} elsif ($self->{type} == ICMPV6_PACKET_TOO_BIG) {
$f = $self->{mtu};
} elsif ($self->{type} == ICMPV6_PARAM_PROB) {
$f = $self->{ptr};
}
return $f;
}
1;
__END__
=head1 NAME
C<NetPacket::ICMPv6> - Assemble and disassemble ICMPv6 (Internet Control Message Protocol Version 6) packets.
=head1 VERSION
version 0.43.1
=head1 SYNOPSIS
use NetPacket::ICMPv6;
$icmp6_obj = NetPacket::ICMPv6->decode($raw_pkt);
$icmp6_pkt = NetPacket::ICMPv6->encode($ip6_obj);
$icmp6_data = NetPacket::ICMPv6::strip($raw_pkt);
$cksum = $icmp6_obj->checksum($ip6_obj);
=head1 DESCRIPTION
C<NetPacket::ICMPv6> provides a set of routines for assembling and
disassembling ICMPv6 (Internet Control Message Protocol Version 6) packets.
=head2 Methods
=over
=item C<NetPacket::ICMPv6-E<gt>decode([RAW PACKET])>
Decode the raw packet data given and return an object containing
instance data. This method will quite happily decode garbage input.
It is the responsibility of the programmer to ensure valid packet data
is passed to this method.
=item C<NetPacket::ICMPv6-E<gt>encode($ip6_obj)>
Return an ICMPv6 packet encoded with the instance data specified. The
C<NetPacket::IPv6> object that the ICMPv6 packet was encapsulated
in must be passed to encode() because some of the IPv6 header fields
are used in the ICMPv6 checksum calculation.
=item C<NetPacket::ICMPv6-E<gt>checksum($ip6_obj)>
Calculate the ICMPv6 checksum based on the instance data of the
C<NetPacket::ICMPv6> object. The C<NetPacket::IPv6> object that the
ICMPv6 packet was/will be encapsulated in must be specified as some
of the IPv6 header fields are used in the ICMPv6 calculation.
=back
=head2 Functions
=over
=item C<NetPacket::ICMPv6::strip([RAW PACKET])>
Return the encapsulated data (or payload) contained in the ICMPv6
packet.
=back
=head2 Instance data
The instance data for the C<NetPacket::ICMPv6> object consists of
the following fields.
=over
=item type
The ICMPv6 message type of this packet.
=item code
The ICMPv6 message code of this packet.
=item cksum
The checksum for this packet.
=item data
The encapsulated data (payload) for this packet.
=back
=head2 Type-Specific Instance Data
=over
=item id
Identification number used to match Echo Requests with Echo Replies.
(Echo Request, Echo Reply)
=item seq
Sequence number used to match Echo Requests with Echo Replies. (Echo
Request, Echo Reply)
=item mtu
The Maximum Transmission Unit of the next-hop link. (Packet Too Big)
=item ptr
Problem pointer. Identifies the location in the original packet where
the problem was. (Parameter Problem)
=item unused
These ICMPv6 types contain an unused header field: Destination
Unreachable, Time Exceeded.
=back
=head2 Exports
=over
=item default
none
=item exportable
ICMPv6 message types:
ICMPV6_DST_UNREACH ICMPV6_PACKET_TOO_BIG
ICMPV6_TIME_EXCEEDED ICMPV6_PARAM_PROB
ICMPV6_ECHO_REQUEST ICMPV6_ECHO_REPLY
Strip function:
icmpv6_strip
=item tags
The following tags group together related exportable items.
=over
=item C<:strip>
Import the strip function C<icmpv6_strip>.
=item C<:types>
Import the above ICMPv6 message types.
=item C<:ALL>
All the above exportable items.
=back
=back
=head1 EXAMPLE
The following example prints the ICMPv6 type, code, and checksum
fields.
#!/usr/bin/perl -w
use strict;
use Net::PcapUtils;
use NetPacket::Ethernet qw(:strip);
use NetPacket::IPv6 qw(:strip);
use NetPacket::ICMPv6;
sub process_pkt {
my ($user, $hdr, $pkt) = @_;
my $ip6_obj = NetPacket::IPv6->decode(eth_strip($pkt));
my $icmp6_obj = NetPacket::ICMPv6->decode(ipv6_strip($ip6_obj));
print("Type: $icmp6_obj->{type}\n");
print("Code: $icmp6_obj->{code}\n");
print("Checksum: $icmp6_obj->{cksum}\n\n");
}
Net::PcapUtils::loop(\&process_pkt, FILTER => 'icmp6');
=head1 TODO
Nothing at this time.
=head1 COPYRIGHT
Copyright (c) 2003-2009 Joel Knight <knight.joel@gmail.com>
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
=head1 AUTHOR
Joel Knight E<lt>knight.joel@gmail.comE<gt>
=cut
|