Return to Unit Reference
Description
Ultibo ICMP (Internet Control Message Protocol) unit
To be documented
Constants
[Expand]
ICMP protocol ICMP_PROTOCOL_*
| Note: Some ICMP definitions are in the Protocol or IP modules
|
|
|
ICMP_PROTOCOL_NAME = 'ICMP';
|
|
[Expand]
ICMP specific constants ICMP_*
ICMP_TIMEOUT = 0;
|
Wait forever on a ICMP Read
|
ICMP_BUFFER_SIZE = 65536;
|
ICMP Receive Buffer Size
|
|
|
ICMP_HEADER_SIZE = 8;
|
SizeOf(TICMPHeader); ICMP.Solicit
|
|
|
ICMP_PACKET_SIZE = 8;
|
SizeOf(TICMPPacket)
|
|
|
ICMP_ROUTER_TIMEOUT = 60000;
|
|
Type definitions
ICMP unused header
[Expand]
PICMPUnusedHeader = ^TICMPUnusedHeader;
TICMPUnusedHeader = packed record {Unreachable, TimeExceeded, SourceQuench etc}
| Note: Some ICMP definitions are in the Protocol or IP modules
|
ICMPType:Byte;
|
ICMP_UNREACH etc
|
Code:Byte;
|
ICMP_UNREACH_NET,ICMP_UNREACH_PORT etc
|
Checksum:Word;
|
1s Compliment checksum of Structure
|
Unused:LongWord;
|
4 Bytes Unused Must be Zero
|
IP:TIPHeader;
|
IP Header from Original IP Packet
|
Data:array[0..7] of Byte;
|
8 Bytes of Original IP Packet Data
|
ICMP unreach header
[Expand]
PICMPUnreachHeader = ^TICMPUnreachHeader;
TICMPUnreachHeader = TICMPUnusedHeader;
ICMP expire header
[Expand]
PICMPExpireHeader = ^TICMPExpireHeader;
TICMPExpireHeader = TICMPUnusedHeader;
ICMP quench header
[Expand]
PICMPQuenchHeader = ^TICMPQuenchHeader;
TICMPQuenchHeader = TICMPUnusedHeader;
ICMP pointer header
[Expand]
PICMPPointerHeader = ^TICMPPointerHeader;
TICMPPointerHeader = packed record
| Note: Param Problem
|
ICMPType:Byte;
|
ICMP_PARAMPROB etc
|
Code:Byte;
|
ICMP_PARAMPROB_OPTABSENT etc
|
Checksum:Word;
|
1s Compliment checksum of Structure
|
Pointer:Byte;
|
If Code = 0 Pointer to Byte where Error Occured
|
Unused:array[0..2] of Byte;
|
3 Bytes Unused Must be Zero
|
IP:TIPHeader;
|
IP Header from Original IP Packet
|
Data:array[0..7] of Byte;
|
8 Bytes of Original IP Packet Data
|
ICMP param header
[Expand]
PICMPParamHeader = ^TICMPParamHeader;
TICMPParamHeader = TICMPPointerHeader;
ICMP IP header
[Expand]
PICMPIpHeader = ^TICMPIpHeader;
TICMPIpHeader = packed record
| Note: Redirect
|
ICMPType:Byte;
|
ICMP_REDIRECT etc
|
Code:Byte;
|
ICMP_REDIRECT_NET,ICMP_REDIRECT_HOST etc
|
Checksum:Word;
|
1s Compliment checksum of Structure
|
Gateway:TInAddr;
|
Redirect Gateway Address
|
IP:TIPHeader;
|
IP Header from Original IP Packet
|
Data:array[0..7] of Byte;
|
8 Bytes of Original IP Packet Data
|
ICMP redirect header
[Expand]
PICMPRedirectHeader = ^TICMPRedirectHeader;
TICMPRedirectHeader = TICMPIpHeader
ICMP echo header
[Expand]
PICMPEchoHeader = ^TICMPEchoHeader;
TICMPEchoHeader = packed record
| Note: Echo Request/Reply
|
ICMPType:Byte;
|
ICMP_ECHO,ICMP_ECHOREPLY
|
Code:Byte;
|
Always 0
|
Checksum:Word;
|
1s Compliment checksum of Structure
|
Identifier:Word;
|
Increments with each ICMP_ECHO
|
Sequence:Word;
|
Sequence within an ICMP_ECHO set
|
Data:array[0..((MAX_IP_PACKET - 1) - SizeOf(TIPHeader)) - 8] of Byte;
|
|
ICMP time stamp header
[Expand]
PICMPTimestampHeader = ^TICMPTimestampHeader;
TICMPTimestampHeader = packed record
| Note: Timestamp Request/Reply
|
ICMPType:Byte;
|
ICMP_TSTAMP,ICMP_TSTAMPREPLY
|
Code:Byte;
|
Always 0
|
Checksum:Word;
|
1s Compliment checksum of Structure
|
Identifier:Word;
|
Increments with each ICMP_TSTAMP
|
Sequence:Word;
|
Sequence within an ICMP_TSTAMP set
|
Original:LongWord;
|
Original Timestamp
|
Receive:LongWord;
|
Receive Timestamp
|
Transmit:LongWord;
|
Transmit Timestamp (A sort of Round Trip Time Echo)
|
ICMP info header
[Expand]
PICMPInfoHeader = ^TICMPInfoHeader;
TICMPInfoHeader = packed record
| Note: Info Request/Reply
|
ICMPType:Byte;
|
ICMP_IREQ,ICMP_IREQREPLY
|
Code:Byte;
|
Always 0
|
Checksum:Word;
|
1s Compliment checksum of Structure
|
Identifier:Word;
|
Increments with each ICMP_IREQ
|
Sequence:Word;
|
Sequence within an ICMP_IREQ set (Used to determine Network Number of Local Subnet)
|
ICMP mask header
[Expand]
PICMPMaskHeader = ^TICMPMaskHeader;
TICMPMaskHeader = packed record
| Note: Mask Request/Reply
|
ICMPType:Byte;
|
ICMP_MASKREQ,ICMP_MASKREPLY
|
Code:Byte;
|
Always 0
|
Checksum:Word;
|
1s Compliment checksum of Structure
|
Identifier:Word;
|
Increments with each ICMP_MASKREQ
|
Sequence:Word;
|
Sequence within an ICMP_MASKREQ set
|
Mask:TInAddr;
|
Subnet Mask of Local Subnet (Used to determine Subnet Mask of Local Subnet)
|
ICMP router address
[Expand]
PICMPRouterAddress = ^TICMPRouterAddress;
TICMPRouterAddress = packed record
Address:TInAddr;
|
The address of the Router on this subnet
|
Level:LongInt;
|
The level of preference, higher is better
|
ICMP advert header
[Expand]
PICMPAdvertHeader = ^TICMPAdvertHeader;
TICMPAdvertHeader = packed record
ICMPType:Byte;
|
ICMP_ROUTERADVERT
|
Code:Byte;
|
Always 0
|
Checksum:Word;
|
1s Compliment checksum of Structure
|
EntryCount:Byte;
|
Number of Router Address entries
|
EntrySize:Byte;
|
Size of each Router Address entry
|
Lifetime:Word;
|
Lifetime of entries in seconds
|
Routers:array[1..EntryCount] of TICMPRouterAddress;
|
Used to advertise routers
|
ICMP solicit header
[Expand]
PICMPSolicitHeader = ^TICMPSolicitHeader;
TICMPSolicitHeader = packed record
ICMPType:Byte;
|
ICMP_ROUTERSOLICIT
|
Code:Byte;
|
Always 0
|
Checksum:Word;
|
1s Compliment checksum of Structure
|
Reserved:LongWord;
|
Always 0 (Used to solicit routers)
|
ICMP header
[Expand]
PICMPHeader = ^TICMPHeader;
TICMPHeader = packed record
case Integer of
|
|
0:(Unused:TICMPUnusedHeader);
|
|
1:(Unreach:TICMPUnreachHeader);
|
|
2:(Expire:TICMPExpireHeader);
|
|
3:(Quench:TICMPQuenchHeader);
|
|
4:(Pointer:TICMPPointerHeader);
|
|
5:(Param:TICMPParamHeader);
|
|
6:(Ip:TICMPIpHeader);
|
|
7:(Redirect:TICMPRedirectHeader);
|
|
8:(Echo:TICMPEchoHeader);
|
|
9:(Timestamp:TICMPTimestampHeader);
|
|
10:(Info:TICMPInfoHeader);
|
|
11:(Mask:TICMPMaskHeader);
|
|
12:(Advert:TICMPAdvertHeader);
|
|
13:(Solicit:TICMPSolicitHeader);
|
|
ICMP packet
[Expand]
PICMPPacket = ^TICMPPacket;
TICMPPacket = record
| Note: 8 Bytes (Used by ICMPBuffer)
|
Size:LongWord;
|
LongWord to keep size even
|
Next:PICMPPacket;
|
Followed by RemoteAddress (4 or 16 Bytes)
|
Class definitions
ICMP protocol transport
[Expand]
TICMPProtocolTransport = class(TProtocolTransport)
constructor Create;
|
|
destructor Destroy; override;
|
|
public
|
Socket:TICMPSocket;
|
Socket for sending replies
|
ICMP protocol
[Expand]
TICMPProtocol = class(TNetworkProtocol)
constructor Create(AManager:TProtocolManager; const AName:String);
|
|
destructor Destroy; override;
|
|
private
|
FNextICMPId:Word;
|
|
FNextICMPLock:TMutexHandle;
|
|
|
|
function PacketHandler(AHandle:THandle; ASource,ADest,APacket:Pointer; ASize:Integer; ABroadcast:Boolean):Boolean;
|
|
function ControlHandler(AHandle:THandle; ASource,ADest:Pointer; AProtocol,ACommand,ACode:Word; AAddress,AData:Pointer; ASize:Integer):Boolean;
|
|
|
|
function GetNextICMPId(AIncrement:Boolean):Word;
|
|
|
|
function SendICMPUnreach(ASocket:TICMPSocket; ASource,ADest:Pointer; ACode:Byte; AData:Pointer; ASize:Integer):Boolean;
|
|
function SendICMPRedirect(ASocket:TICMPSocket; ASource,ADest:Pointer; ACode:Byte; AAddress,AData:Pointer; ASize:Integer):Boolean;
|
|
function SendICMPTimeExceeded(ASocket:TICMPSocket; ASource,ADest:Pointer; ACode:Byte; AData:Pointer; ASize:Integer):Boolean;
|
|
function SendICMPSourceQuench(ASocket:TICMPSocket; ASource,ADest:Pointer; AData:Pointer; ASize:Integer):Boolean;
|
|
function SendICMPParamProblem(ASocket:TICMPSocket; ASource,ADest:Pointer; ACode,APointer:Byte; AData:Pointer; ASize:Integer):Boolean;
|
|
|
|
function SendICMPEchoReply(ASocket:TICMPSocket; ASource,ADest,AData:Pointer; ASize:Integer):Boolean;
|
|
function SendICMPInfoReply(ASocket:TICMPSocket; ASource,ADest,AData:Pointer; ASize:Integer):Boolean;
|
|
function SendICMPMaskReply(ASocket:TICMPSocket; ASource,ADest,AData:Pointer; ASize:Integer):Boolean;
|
|
function SendICMPTimestampReply(ASocket:TICMPSocket; ASource,ADest,AData:Pointer; ASize:Integer):Boolean;
|
|
|
|
function SendICMPEchoRequest(ASocket:TICMPSocket ;ASource,ADest:Pointer; ASize:Integer):Boolean;
|
|
function SendICMPInfoRequest(ASocket:TICMPSocket; ASource,ADest:Pointer):Boolean;
|
|
function SendICMPMaskRequest(ASocket:TICMPSocket; ASource,ADest:Pointer):Boolean;
|
|
function SendICMPTimestampRequest(ASocket:TICMPSocket; ASource,ADest:Pointer):Boolean;
|
|
|
|
function SendICMPRouterAdvert(ASocket:TICMPSocket; ASource,ADest,AAddress:Pointer):Boolean;
|
|
function SendICMPRouterSolicit(ASocket:TICMPSocket; ASource,ADest:Pointer):Boolean;
|
|
protected
|
function SelectCheck(ASource,ADest:PFDSet; ACode:Integer):Integer; override;
|
|
function SelectWait(ASocket:TProtocolSocket; ACode:Integer; ATimeout:LongWord):Integer; override;
|
|
|
|
function SendPacket(ASocket:TProtocolSocket; ASource,ADest:Pointer; ASourcePort,ADestPort:Word; APacket:PPacketFragment; ASize,AFlags:Integer):Integer; override;
|
|
public
|
function Accept(ASocket:TProtocolSocket; ASockAddr:PSockAddr; AAddrLength:PInteger):TProtocolSocket; override;
|
|
function Bind(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; override;
|
|
function CloseSocket(ASocket:TProtocolSocket):Integer; override;
|
|
function Connect(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; AAddrLength:Integer):Integer; override;
|
|
function IoctlSocket(ASocket:TProtocolSocket; ACmd:DWORD; var AArg:u_long):Integer; override;
|
|
function GetPeerName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; override;
|
|
function GetSockName(ASocket:TProtocolSocket; var ASockAddr:TSockAddr; var AAddrLength:Integer):Integer; override;
|
|
function GetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; var AOptLength:Integer):Integer; override;
|
|
function Listen(ASocket:TProtocolSocket; ABacklog:Integer):Integer; override;
|
|
function Recv(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; override;
|
|
function RecvFrom(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AFromAddr:TSockAddr; var AFromLength:Integer):Integer; override;
|
|
function Select(ANfds:Integer; AReadfds,AWritefds,AExceptfds:PFDSet; ATimeout:PTimeVal):LongInt; override;
|
|
function Send(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer):Integer; override;
|
|
function SendTo(ASocket:TProtocolSocket; var ABuffer; ALength,AFlags:Integer; var AToAddr:TSockAddr; AToLength:Integer):Integer; override;
|
|
function SetSockOpt(ASocket:TProtocolSocket; ALevel,AOptName:Integer; AOptValue:PChar; AOptLength:Integer):Integer; override;
|
|
function Shutdown(ASocket:TProtocolSocket; AHow:Integer):Integer; override;
|
|
function Socket(AFamily,AStruct,AProtocol:Integer):TProtocolSocket; override;
|
|
function AddTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function RemoveTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
|
|
function FindSocket(AFamily,AStruct,AProtocol:Word; ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast,AListen,ALock:Boolean; AState:LongWord):TProtocolSocket; override;
|
|
procedure FlushSockets(All:Boolean); override;
|
|
|
|
function StartProtocol:Boolean; override;
|
|
function StopProtocol:Boolean; override;
|
|
function ProcessProtocol:Boolean; override;
|
|
ICMP socket
[Expand]
TICMPSocket = class(TProtocolSocket)
| Note: SOCK_RAW
|
|
|
constructor Create(AProtocol:TNetworkProtocol; ATransport:TNetworkTransport);
|
|
destructor Destroy; override;
|
|
private
|
FRecvData:TICMPBuffer;
|
|
public
|
property RecvData:TICMPBuffer read FRecvData;
|
|
|
|
function IoCtl(ACommand:DWORD; var AArgument:u_long):Integer; override;
|
|
|
|
function IsConnected(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean; override;
|
|
function IsListening(ALocalAddress,ARemoteAddress:Pointer; ALocalPort,ARemotePort:Word; ABroadcast:Boolean):Boolean; override;
|
|
ICMP buffer
[Expand]
TICMPBuffer = class(TSocketBuffer)
constructor Create(ASocket:TTransportSocket);
|
|
destructor Destroy; override;
|
|
private
|
FOffset:Word;
|
Offset to RemoteAddress
|
FLength:Word;
|
Length of RemoteAddress
|
|
|
FRead:Pointer;
|
Pointer to Next Read from Buffer
|
FWrite:Pointer;
|
Pointer to Next Write to Buffer
|
|
|
FCount:LongWord;
|
Number of Packets in Buffer
|
|
|
FFirst:PICMPPacket;
|
Pointer to First Packet
|
FLast:PICMPPacket;
|
Pointer to Last Packet
|
|
|
function AddPacket(ASize:Integer):Boolean;
|
|
function RemovePacket:Boolean;
|
|
procedure FlushPackets;
|
|
protected
|
procedure SetSize(ASize:LongWord); override;
|
|
public
|
function GetNext:Integer;
|
|
function GetCount:LongWord;
|
|
|
|
function ReadBuffer(var ABuffer; var ASize:Integer; ARemoteAddress:Pointer; AFlags:Integer):Boolean;
|
|
function WriteBuffer(var ABuffer; ASize:Integer; ARemoteAddress:Pointer):Boolean;
|
|
Public variables
None defined
Function declarations
Initialization functions
[Expand]
procedure ICMPInit;
Description: To be documented
ICMP functions
[Expand]
function CheckICMP(AFamily:Word; ABuffer:Pointer):Boolean;
Description: Verify that the packet is a valid ICMP packet
| Buffer
|
The complete packet including Transport header
|
[Expand]
function GetICMPHeaderOffset(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented
| Buffer
|
The complete packet including Transport header
|
[Expand]
function GetICMPHeaderLength(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented
| Buffer
|
The complete packet including Transport header
|
[Expand]
function GetICMPDataOffset(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented
| Buffer
|
The complete packet including Transport header
|
[Expand]
function GetICMPDataLength(AFamily:Word; ABuffer:Pointer):Word;
Description: To be documented
| Buffer
|
The complete packet including Transport header
|
[Expand]
function ChecksumICMP(AFamily:Word; ABuffer:Pointer; AOffset,ALength:Word):Word;
Description: Checksum the ICMP Header on Send/Validate the Checksum on Receive
Return to Unit Reference
