Net::Frame::Layer::PPPoES - PPP-over-Ethernet layer object


Net-Frame-Layer-PPPoES documentation Contained in the Net-Frame-Layer-PPPoES distribution.

Index


Code Index:

NAME

Top

Net::Frame::Layer::PPPoES - PPP-over-Ethernet layer object

SYNOPSIS

Top

   use Net::Frame::Layer::PPPoES qw(:consts);

   # Build a layer
   my $layer = Net::Frame::Layer::PPPoES->new(
      version       => 1,
      type          => 1,
      code          => 0,
      sessionId     => 1,
      payloadLength => 0,
      pppProtocol   => NF_PPPoE_PPP_PROTOCOL_IPv4,
   );
   $layer->pack;

   print 'RAW: '.$layer->dump."\n";

   # Read a raw layer
   my $layer = Net::Frame::Layer::PPPoES->new(raw => $raw);

   print $layer->print."\n";
   print 'PAYLOAD: '.unpack('H*', $layer->payload)."\n"
      if $layer->payload;

DESCRIPTION

Top

This modules implements the encoding and decoding of the PPPoES layer.

See also Net::Frame::Layer for other attributes and methods.

ATTRIBUTES

Top

version - 4 bits
code - 4 bits
type - 8 bits
sessionId - 16 bits
payloadLength - 16 bits
pppProtocol - 16 bits

For this last attribute, we can note that it is included in the computation of payloadLength.

The following are inherited attributes. See Net::Frame::Layer for more information.

raw
payload
nextLayer

METHODS

Top

new
new (hash)

Object constructor. You can pass attributes that will overwrite default ones. See SYNOPSIS for default values.

The following are inherited methods. Some of them may be overriden in this layer, and some others may not be meaningful in this layer. See Net::Frame::Layer for more information.

layer
computeLengths
computeChecksums
pack
unpack
encapsulate
getLength
getPayloadLength
print
dump

CONSTANTS

Top

Load them: use Net::Frame::Layer::PPPoES qw(:consts);

NF_PPPoE_HDR_LEN
NF_PPPoE_PPP_PROTOCOL_IPv4
NF_PPPoE_PPP_PROTOCOL_PPPLCP

SEE ALSO

Top

Net::Frame::Layer

AUTHOR

Top

Patrice <GomoR> Auffret

COPYRIGHT AND LICENSE

Top


Net-Frame-Layer-PPPoES documentation Contained in the Net-Frame-Layer-PPPoES distribution.

#
# $Id: PPPoES.pm 4 2010-06-03 13:02:31Z gomor $
#
package Net::Frame::Layer::PPPoES;
use strict;
use warnings;

our $VERSION = '1.01';

use Net::Frame::Layer qw(:consts);
require Exporter;
our @ISA = qw(Net::Frame::Layer Exporter);

our %EXPORT_TAGS = (
   consts => [qw(
      NF_PPPoE_HDR_LEN
      NF_PPPoE_PPP_PROTOCOL_IPv4
      NF_PPPoE_PPP_PROTOCOL_PPPLCP
   )],
);
our @EXPORT_OK = (
   @{$EXPORT_TAGS{consts}},
);

use constant NF_PPPoE_HDR_LEN => 8;
use constant NF_PPPoE_PPP_PROTOCOL_IPv4   => 0x0021;
use constant NF_PPPoE_PPP_PROTOCOL_PPPLCP => 0xc021;

our @AS = qw(
   version
   type
   code
   sessionId
   payloadLength
   pppProtocol
);
__PACKAGE__->cgBuildIndices;
__PACKAGE__->cgBuildAccessorsScalar(\@AS);

require Bit::Vector;

sub new {
   shift->SUPER::new(
      version       => 1,
      type          => 1,
      code          => 0,
      sessionId     => 1,
      payloadLength => 0,
      pppProtocol   => NF_PPPoE_PPP_PROTOCOL_IPv4,
      @_,
   );
}

sub getLength { NF_PPPoE_HDR_LEN }

sub getPayloadLength { shift->payloadLength }

sub pack {
   my $self = shift;

   my $version = Bit::Vector->new_Dec(4, $self->version);
   my $type    = Bit::Vector->new_Dec(4, $self->type);
   my $v8      = $version->Concat_List($type);

   $self->raw($self->SUPER::pack('CCnnn',
      $v8->to_Dec,
      $self->code,
      $self->sessionId,
      $self->payloadLength,
      $self->pppProtocol,
   )) or return undef;

   $self->raw;
}

sub unpack {
   my $self = shift;

   my ($versionType, $code, $sessionId, $payloadLength, $pppProtocol, $payload)
      = $self->SUPER::unpack('CCnnn a*', $self->raw)
         or return undef;

   my $v8 = Bit::Vector->new_Dec(8, $versionType);
   $self->version($v8->Chunk_Read(4, 0));
   $self->type($v8->Chunk_Read(4, 4));

   $self->code($code);
   $self->sessionId($sessionId);
   $self->payloadLength($payloadLength);
   $self->pppProtocol($pppProtocol);

   $self->payload($payload);

   $self;
}

sub encapsulate {
   my $self = shift;

   return $self->nextLayer if $self->nextLayer;

   my $types = {
      NF_PPPoE_PPP_PROTOCOL_IPv4()   => 'IPv4',
      NF_PPPoE_PPP_PROTOCOL_PPPLCP() => 'PPPLCP',
   };

   $types->{$self->pppProtocol} || NF_LAYER_UNKNOWN;
}

sub print {
   my $self = shift;

   my $l = $self->layer;
   sprintf "$l: version:%d  type:%d  code:0x%02x  sessionId:0x%04x\n".
           "$l: payloadLength:%d  pppProtocol:0x%04x",
      $self->version,
      $self->type,
      $self->code,
      $self->sessionId,
      $self->payloadLength,
      $self->pppProtocol,
   ;
}

1;

__END__