324 lines
11 KiB
C#
324 lines
11 KiB
C#
|
/*
|
||
|
|
This file is part of PacketDotNet
|
||
|
|
|
||
|
|
PacketDotNet is free software: you can redistribute it and/or modify
|
||
|
|
it under the terms of the GNU Lesser General Public License as published by
|
||
|
|
the Free Software Foundation, either version 3 of the License, or
|
||
|
|
(at your option) any later version.
|
||
|
|
|
||
|
|
PacketDotNet is distributed in the hope that it will be useful,
|
||
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
GNU Lesser General Public License for more details.
|
||
|
|
|
||
|
|
You should have received a copy of the GNU Lesser General Public License
|
||
|
|
along with PacketDotNet. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
*/
|
||
|
|
/*
|
||
|
|
* Copyright 2010 Chris Morgan <chmorgan@gmail.com>
|
||
|
|
*/
|
||
|
|
using System;
|
||
|
|
using System.Collections.Generic;
|
||
|
|
using System.Text;
|
||
|
|
using PacketDotNet.Utils;
|
||
|
|
using MiscUtil.Conversion;
|
||
|
|
|
||
|
|
namespace PacketDotNet
|
||
|
|
{
|
||
|
|
/// <summary>
|
||
|
|
/// Point to Point Protocol
|
||
|
|
/// See http://tools.ietf.org/html/rfc2516
|
||
|
|
/// </summary>
|
||
|
|
public class PPPoEPacket : Packet
|
||
|
|
{
|
||
|
|
// NOTE: No need to warn about lack of use, the compiler won't
|
||
|
|
// put any calls to 'log' here but we need 'log' to exist to compile
|
||
|
|
#pragma warning disable 0169, 0649
|
||
|
|
private static readonly ILogInactive log;
|
||
|
|
#pragma warning restore 0169, 0649
|
||
|
|
|
||
|
|
private byte VersionType
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return header.Bytes[header.Offset + PPPoEFields.VersionTypePosition];
|
||
|
|
}
|
||
|
|
|
||
|
|
set
|
||
|
|
{
|
||
|
|
header.Bytes[header.Offset + PPPoEFields.VersionTypePosition] = value;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// PPPoe version, must be 0x1 according to RFC
|
||
|
|
/// </summary>
|
||
|
|
/// FIXME: This currently outputs the wrong version number
|
||
|
|
public byte Version
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return (byte)((VersionType >> 4) & 0xF0);
|
||
|
|
}
|
||
|
|
|
||
|
|
set
|
||
|
|
{
|
||
|
|
var versionType = VersionType;
|
||
|
|
|
||
|
|
// mask the new value in
|
||
|
|
versionType = (byte)((versionType & 0x0F) | ((value << 4) & 0xF0));
|
||
|
|
|
||
|
|
VersionType = versionType;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Type, must be 0x1 according to RFC
|
||
|
|
/// </summary>
|
||
|
|
public byte Type
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return (byte)((VersionType) & 0x0F);
|
||
|
|
}
|
||
|
|
|
||
|
|
set
|
||
|
|
{
|
||
|
|
var versionType = VersionType;
|
||
|
|
|
||
|
|
// mask the new value in
|
||
|
|
versionType = (byte)((versionType & 0xF0) | (value & 0xF0));
|
||
|
|
|
||
|
|
VersionType = versionType;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
///
|
||
|
|
/// </summary>
|
||
|
|
/// FIXME: This currently outputs the wrong code
|
||
|
|
public PPPoECode Code
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return (PPPoECode)EndianBitConverter.Big.ToUInt16(header.Bytes,
|
||
|
|
header.Offset + PPPoEFields.CodePosition);
|
||
|
|
}
|
||
|
|
|
||
|
|
set
|
||
|
|
{
|
||
|
|
var val = (UInt16)value;
|
||
|
|
EndianBitConverter.Big.CopyBytes(val,
|
||
|
|
header.Bytes,
|
||
|
|
header.Offset + PPPoEFields.CodePosition);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Session identifier for this PPPoe packet
|
||
|
|
/// </summary>
|
||
|
|
public UInt16 SessionId
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return EndianBitConverter.Big.ToUInt16(header.Bytes,
|
||
|
|
header.Offset + PPPoEFields.SessionIdPosition);
|
||
|
|
}
|
||
|
|
|
||
|
|
set
|
||
|
|
{
|
||
|
|
var val = (UInt16)value;
|
||
|
|
EndianBitConverter.Big.CopyBytes(val,
|
||
|
|
header.Bytes,
|
||
|
|
header.Offset + PPPoEFields.SessionIdPosition);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Length of the PPPoe payload, not including the PPPoe header
|
||
|
|
/// </summary>
|
||
|
|
public UInt16 Length
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return EndianBitConverter.Big.ToUInt16(header.Bytes,
|
||
|
|
header.Offset + PPPoEFields.LengthPosition);
|
||
|
|
}
|
||
|
|
|
||
|
|
set
|
||
|
|
{
|
||
|
|
var val = (UInt16)value;
|
||
|
|
EndianBitConverter.Big.CopyBytes(val,
|
||
|
|
header.Bytes,
|
||
|
|
header.Offset + PPPoEFields.LengthPosition);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Construct a new PPPoEPacket from source and destination mac addresses
|
||
|
|
/// </summary>
|
||
|
|
public PPPoEPacket(PPPoECode Code,
|
||
|
|
UInt16 SessionId)
|
||
|
|
{
|
||
|
|
log.Debug("");
|
||
|
|
|
||
|
|
// allocate memory for this packet
|
||
|
|
int offset = 0;
|
||
|
|
int length = PPPoEFields.HeaderLength;
|
||
|
|
var headerBytes = new byte[length];
|
||
|
|
header = new ByteArraySegment(headerBytes, offset, length);
|
||
|
|
|
||
|
|
// set the instance values
|
||
|
|
this.Code = Code;
|
||
|
|
this.SessionId = SessionId;
|
||
|
|
|
||
|
|
// setup some typical values and default values
|
||
|
|
this.Version = 1;
|
||
|
|
this.Type = 1;
|
||
|
|
this.Length = 0;
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Constructor
|
||
|
|
/// </summary>
|
||
|
|
/// <param name="bas">
|
||
|
|
/// A <see cref="ByteArraySegment"/>
|
||
|
|
/// </param>
|
||
|
|
public PPPoEPacket(ByteArraySegment bas)
|
||
|
|
{
|
||
|
|
log.Debug("");
|
||
|
|
|
||
|
|
// slice off the header portion
|
||
|
|
header = new ByteArraySegment(bas);
|
||
|
|
RandomUtils.EnsurePacketLength(this, PPPoEFields.HeaderLength, header.Length);
|
||
|
|
header.Length = PPPoEFields.HeaderLength;
|
||
|
|
|
||
|
|
// parse the encapsulated bytes
|
||
|
|
payloadPacketOrData = ParseEncapsulatedBytes(header);
|
||
|
|
}
|
||
|
|
|
||
|
|
internal static PacketOrByteArraySegment ParseEncapsulatedBytes(ByteArraySegment Header)
|
||
|
|
{
|
||
|
|
// slice off the payload
|
||
|
|
var payload = Header.EncapsulatedBytes();
|
||
|
|
log.DebugFormat("payload {0}", payload.ToString());
|
||
|
|
|
||
|
|
var payloadPacketOrData = new PacketOrByteArraySegment();
|
||
|
|
|
||
|
|
// we assume that we have a PPPPacket as the payload
|
||
|
|
payloadPacketOrData.ThePacket = new PPPPacket(payload);
|
||
|
|
|
||
|
|
return payloadPacketOrData;
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary> Fetch ascii escape sequence of the color associated with this packet type.</summary>
|
||
|
|
public override System.String Color
|
||
|
|
{
|
||
|
|
get
|
||
|
|
{
|
||
|
|
return AnsiEscapeSequences.DarkGray;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary cref="Packet.ToString(StringOutputType)" />
|
||
|
|
public override string ToString(StringOutputType outputFormat)
|
||
|
|
{
|
||
|
|
var buffer = new StringBuilder();
|
||
|
|
string color = "";
|
||
|
|
string colorEscape = "";
|
||
|
|
|
||
|
|
if(outputFormat == StringOutputType.Colored || outputFormat == StringOutputType.VerboseColored)
|
||
|
|
{
|
||
|
|
color = Color;
|
||
|
|
colorEscape = AnsiEscapeSequences.Reset;
|
||
|
|
}
|
||
|
|
|
||
|
|
if(outputFormat == StringOutputType.Normal || outputFormat == StringOutputType.Colored)
|
||
|
|
{
|
||
|
|
// build the output string
|
||
|
|
buffer.AppendFormat("{0}[PPPoEPacket: Version={2}, Type={3}, Code={4}, SessionId={5}, Length={6}]{1}",
|
||
|
|
color,
|
||
|
|
colorEscape,
|
||
|
|
Version,
|
||
|
|
Type,
|
||
|
|
Code,
|
||
|
|
SessionId,
|
||
|
|
Length);
|
||
|
|
}
|
||
|
|
|
||
|
|
if(outputFormat == StringOutputType.Verbose || outputFormat == StringOutputType.VerboseColored)
|
||
|
|
{
|
||
|
|
// collect the properties and their value
|
||
|
|
Dictionary<string,string> properties = new Dictionary<string,string>();
|
||
|
|
// FIXME: The version output is incorrect
|
||
|
|
properties.Add("", Convert.ToString(Version, 2).PadLeft(4, '0') + " .... = version: " + Version.ToString());
|
||
|
|
properties.Add(" ", ".... " + Convert.ToString(Type, 2).PadLeft(4, '0') + " = type: " + Type.ToString());
|
||
|
|
// FIXME: The Code output is incorrect
|
||
|
|
properties.Add("code", Code.ToString() + " (0x" + Code.ToString("x") + ")");
|
||
|
|
properties.Add("session id", "0x" + SessionId.ToString("x"));
|
||
|
|
// TODO: Implement a PayloadLength property for PPPoE
|
||
|
|
//properties.Add("payload length", PayloadLength.ToString());
|
||
|
|
|
||
|
|
// calculate the padding needed to right-justify the property names
|
||
|
|
int padLength = Utils.RandomUtils.LongestStringLength(new List<string>(properties.Keys));
|
||
|
|
|
||
|
|
// build the output string
|
||
|
|
buffer.AppendLine("PPPoE: ******* PPPoE - \"Point-to-Point Protocol over Ethernet\" - offset=? length=" + TotalPacketLength);
|
||
|
|
buffer.AppendLine("PPPoE:");
|
||
|
|
foreach(var property in properties)
|
||
|
|
{
|
||
|
|
if(property.Key.Trim() != "")
|
||
|
|
{
|
||
|
|
buffer.AppendLine("PPPoE: " + property.Key.PadLeft(padLength) + " = " + property.Value);
|
||
|
|
}
|
||
|
|
else
|
||
|
|
{
|
||
|
|
buffer.AppendLine("PPPoE: " + property.Key.PadLeft(padLength) + " " + property.Value);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
buffer.AppendLine("PPPoE:");
|
||
|
|
}
|
||
|
|
|
||
|
|
// append the base output
|
||
|
|
buffer.Append(base.ToString(outputFormat));
|
||
|
|
|
||
|
|
return buffer.ToString();
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Returns the encapsulated PPPoE of the Packet p or null if
|
||
|
|
/// there is no encapsulated packet
|
||
|
|
/// </summary>
|
||
|
|
/// <param name="p">
|
||
|
|
/// A <see cref="Packet"/>
|
||
|
|
/// </param>
|
||
|
|
/// <returns>
|
||
|
|
/// A <see cref="ARPPacket"/>
|
||
|
|
/// </returns>
|
||
|
|
[Obsolete("Use Packet.Extract() instead")]
|
||
|
|
public static PPPoEPacket GetEncapsulated(Packet p)
|
||
|
|
{
|
||
|
|
if(p is EthernetPacket)
|
||
|
|
{
|
||
|
|
if(p.PayloadPacket is PPPoEPacket)
|
||
|
|
{
|
||
|
|
return (PPPoEPacket)p.PayloadPacket;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
/// <summary>
|
||
|
|
/// Generate a random PPPoEPacket
|
||
|
|
/// </summary>
|
||
|
|
/// <returns>
|
||
|
|
/// A <see cref="PPPoEPacket"/>
|
||
|
|
/// </returns>
|
||
|
|
public static PPPoEPacket RandomPacket()
|
||
|
|
{
|
||
|
|
throw new System.NotImplementedException();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|