Difference between revisions of "Unit DHCP"
From Ultibo.org
| Line 1,098: | Line 1,098: | ||
{| class="wikitable" style="font-size: 14px; background: white;" | {| class="wikitable" style="font-size: 14px; background: white;" | ||
|- | |- | ||
| − | ! | + | ! Note |
| Called only during system startup | | Called only during system startup | ||
|- | |- | ||
Revision as of 00:56, 24 April 2018
Return to Unit Reference
Contents
Description
Ultibo DHCP/BOOTP Protocol client unit
To be documented
Constants
DHCP specific constants
BOOTP_* BOOTP_DELAY = 1000;
|
(Previously 0) |
BOOTP_TIMEOUT = 8000;
|
(Previously 4000) We wait for 8 seconds for a BOOTP reply |
BOOTP_RETRIES = 6;
|
(Previously 4) Try the request 6 times |
BOOTP_MIN_DELAY = 0;
|
|
BOOTP_MAX_DELAY = 10000;
|
|
BOOTP_MIN_TIMEOUT = 500;
|
|
BOOTP_MAX_TIMEOUT = 15000;
|
|
BOOTP_MIN_RETRIES = 1;
|
|
BOOTP_MAX_RETRIES = 100;
|
|
DHCP_DELAY = 1000;
|
(Previously 0) |
DHCP_TIMEOUT = 8000;
|
(Previously 4000) We wait for 8 seconds for a DHCP reply |
DHCP_RETRIES = 6;
|
(Previously 4) Try the request 6 times |
DHCP_MIN_DELAY = 0;
|
|
DHCP_MAX_DELAY = 10000;
|
|
DHCP_MIN_TIMEOUT = 500;
|
|
DHCP_MAX_TIMEOUT = 15000;
|
|
DHCP_MIN_RETRIES = 1;
|
|
DHCP_MAX_RETRIES = 100;
|
|
BOOTP_VENDOR_SIZE = 64;
|
Size of the Vendor area |
DHCP_OPTIONS_SIZE = 312;
|
Size of the Options area |
DHCP_MESSAGE_SIZE = 576;
|
Size of the max message |
BOOTP/DHCP request
BOOTP_REQUEST* BOOTP_REQUEST = 1;
|
|
BOOTP_REPLY = 2;
|
DHCP message
DHCP_* DHCP_DISCOVER = 1;
|
|
DHCP_OFFER = 2;
|
|
DHCP_REQUEST = 3;
|
|
DHCP_DECLINE = 4;
|
|
DHCP_ACK = 5;
|
|
DHCP_NAK = 6;
|
|
DHCP_RELEASE = 7;
|
|
DHCP_INFORM = 8;
|
|
DHCP_RENEWAL_TO = 1;
|
|
DHCP_REBIND_TO = 2;
|
|
BOOTP/DHCP options
PAD_OPT = 0;
|
|
END_OPT = 255;
|
|
SUBNET_MASK = 1;
|
|
TIME_OFFSET = 2;
|
|
ROUTERS_ON_SNET = 3;
|
|
TIME_SRV = 4;
|
|
NAME_SRV = 5;
|
|
DNS_SRV = 6;
|
|
LOG_SRV = 7;
|
|
COOKIE_SRV = 8;
|
|
LPR_SRV = 9;
|
|
IMPRESS_SRV = 10;
|
|
RES_LOCATION_SRV = 11;
|
|
HOST_NAME = 12;
|
|
BOOT_FSIZE = 13;
|
|
MERIT_DUMPFILE = 14;
|
|
DOMAIN_NAME = 15;
|
|
SWAP_SRV = 16;
|
|
ROOT_PATH = 17;
|
|
EXTENTIONS_PATH = 18;
|
|
IP_FORWARDING = 19;
|
|
NON_LOCAL_SRC_ROUTE = 20;
|
|
POLICY_FILTER = 21;
|
|
MAX_DGRAM_REASM_SIZE = 22;
|
|
IP_DEFAULT_TTL = 23;
|
|
PATH_MTU_AGING_TIMEOUT = 24;
|
|
PATH_MTU_PLATEAU_TABLE = 25;
|
|
IF_MTU = 26;
|
|
ALL_SUBNETS_LOCAL = 27;
|
|
BROADCAST_ADDR = 28;
|
|
PERFORM_MASK_DISCOVERY = 29;
|
|
MASK_SUPPLIER = 30;
|
|
PERFORM_ROUTER_DISCOVERY = 31;
|
|
ROUTER_SOLICITATION_ADDR = 32;
|
|
STATIC_ROUTE = 33;
|
|
TRAILER_ENCAPSULATION = 34;
|
|
ARP_CACHE_TIMEOUT = 35;
|
|
ETHERNET_ENCAPSULATION = 36;
|
|
TCP_DEFAULT_TTL = 37;
|
|
TCP_KEEPALIVE_INTERVAL = 38;
|
|
TCP_KEEPALIVE_GARBAGE = 39;
|
|
NIS_DOMAIN_NAME = 40;
|
|
NIS_SRVS = 41;
|
|
NTP_SRVS = 42;
|
|
VENDOR_SPECIFIC_INFO = 43;
|
|
NBIOS_NAME_SRV = 44;
|
|
NBIOS_DGRAM_DIST_SRV = 45;
|
|
NBIOS_NODE_TYPE = 46;
|
|
NBIOS_SCOPE = 47;
|
|
XFONT_SRV = 48;
|
|
XDISPLAY_MANAGER = 49;
|
|
| DHCP Options | |
DHCP_REQUESTED_IP_ADDR = 50;
|
|
DHCP_IP_ADDR_LEASE_TIME = 51;
|
|
DHCP_OPT_OVERLOAD = 52;
|
|
DHCP_MSG_TYPE = 53;
|
|
DHCP_SRV_IDENTIFIER = 54;
|
|
DHCP_PARAM_REQUEST = 55;
|
|
DHCP_MSG = 56;
|
|
DHCP_MAX_MSG_SIZE = 57;
|
|
DHCP_T1_VALUE = 58;
|
|
DHCP_T2_VALUE = 59;
|
|
DHCP_CLASS_ID = 60;
|
|
DHCP_CLIENT_ID = 61;
|
|
DHCP_NIS_DOMAIN_OPT = 64;
|
|
DHCP_NIS_SRV_OPT = 65;
|
|
DHCP_TFTP_SERVER = 66;
|
|
DHCP_BOOT_FILENAME = 67;
|
|
DHCP_MOBIP_HOME_AGENTS = 68;
|
|
DHCP_SMTP_SRVS = 69;
|
|
DHCP_POP3_SRVS = 70;
|
|
DHCP_NNTP_SRVS = 71;
|
|
DHCP_WWW_SRVS = 72;
|
|
DHCP_FINGER_SRVS = 73;
|
|
DHCP_IRC_SRVS = 74;
|
|
DHCP_STREET_TALK_SRVS = 75;
|
|
DHCP_STDA_SRVS = 76;
|
|
DHCP flag
DHCP_FLAG_* DHCP_FLAG_BROADCAST = $8000;
|
ARP configuration
ARP_CONFIG_* ARP_CONFIG_START = $C0A86401;
|
192.168.100.1 |
ARP_CONFIG_STOP = $C0A864FE;
|
192.168.100.254 |
Type definitions
DHCP specific types
PBOOTPHeader = ^TBOOTPHeader;
TBOOTPHeader = packed record
Opcode:Byte;
|
packet op code/message type |
HardwareType:Byte;
|
hardware address type, 1 = 10 mb ethernet |
HardwareLength:Byte;
|
hardware address len, eg '6' for 10mb eth |
Hops:Byte;
|
client sets to zero, optionally used by gateways in cross-gateway booting |
Identifier:LongWord;
|
transaction Id, a random number |
Seconds:Word;
|
filled in by client, seconds elapsed since client started trying to boot |
Reserved:Word;
|
|
ClientIP:TInAddr;
|
client IP address filled in by client if known |
YourIP:TInAddr;
|
'your' (client) IP address filled by server if client doesn't know |
ServerIP:TInAddr;
|
server IP address returned in bootreply |
GatewayIP:TInAddr;
|
gateway IP address, used in optional cross-gateway booting |
ClientHardware:array[0..15] of Byte;
|
client hardware address, filled by client |
ClientHardware:THardwareAddress;
|
client hardware address, filled by client |
DummyData:array[0..9] of Byte;
|
dummy to fill out remaining bytes of above |
ServerName:array[0..63] of Byte;
|
optional server host name, null terminated |
FileName:array[0..127] of Byte;
|
boot file name, null terminated string 'generic' name or null in bootrequest, fully qualified directory-path name in bootreply |
VendorData:array[0..63] of Byte;
|
optional vendor-specific area |
VendorData:array[0..BOOTP_VENDOR_SIZE - 1] of Byte;
|
optional vendor-specific area |
DHCP header
PDHCPHeader = ^TDHCPHeader;
TDHCPHeader = packed record
Opcode:Byte;
|
packet op code/message type |
HardwareType:Byte;
|
hardware address type, 1 = 10 mb ethernet |
HardwareLength:Byte;
|
hardware address len, eg '6' for 10mb eth |
Hops:Byte;
|
client sets to zero, optionally used by gateways in cross-gateway booting |
Identifier:LongWord;
|
transaction Id, a random number |
Seconds:Word;
|
filled in by client, seconds elapsed since client started trying to boot |
Flags:Word;
|
|
ClientIP:TInAddr;
|
client IP address filled in by client if known |
YourIP:TInAddr;
|
'your' (client) IP address filled by server if client doesn't know |
ServerIP:TInAddr;
|
server IP address returned in bootreply |
GatewayIP:TInAddr;
|
gateway IP address, used in optional cross-gateway booting |
ClientHardware:array[0..15] of Byte;
|
client hardware address, filled by client |
ClientHardware:THardwareAddress;
|
client hardware address, filled by client |
DummyData:array[0..9] of Byte;
|
dummy to fill out remaining bytes of above |
ServerName:array[0..63] of Byte;
|
optional server host name, null terminated |
FileName:array[0..127] of Byte;
|
boot file name, null terminated string 'generic' name or null in bootrequest, fully qualified directory-path name in bootreply |
Options:array[0..311] of Byte;
|
DHCP options area (minimum 312 bytes) |
Options:array[0..DHCP_OPTIONS_SIZE - 1] of Byte;
|
DHCP options area (minimum 312 bytes) |
DHCP client Id
PDHCPClientId = ^TDHCPClientId;
TDHCPClientId = packed record
Tag:Byte;
|
|
Hardware:THardwareAddress;
|
Class definitions
DHCP configuration transport
TDHCPConfigTransport = class(TConfigTransport)
private
| |
public
| |
DHCP configuration
TDHCPConfig = class(TNetworkConfig)
constructor Create(AManager:TProtocolManager);
|
|
destructor Destroy; override;
|
|
private
| |
FARP:TARPTransport;
|
|
FUDP:TUDPProtocol;
|
|
function ConfigHandler(AHandle:THandle; AAdapter:TTransportAdapter; ACommand:Word):Boolean;
|
|
function GetDHCPClientId(AAdapter:TTransportAdapter):TDHCPClientId;
|
|
function GetDHCPHeaderSize(AHeader:PDHCPHeader):Integer;
|
|
function CreateDHCPRequest(AHeader:PDHCPHeader; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;
|
|
function CheckDHCPReply(AHeader:PDHCPHeader; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord):Boolean;
|
|
function HandleDHCPReply(AHeader:PDHCPHeader; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; ACommand:Word):Boolean;
|
|
function SendDHCPDiscover(ASocket:TProtocolSocket; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;
|
|
function SendDHCPRequest(ASocket:TProtocolSocket; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;
|
|
function SendDHCPDecline(ASocket:TProtocolSocket; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;
|
|
function SendDHCPRelease(ASocket:TProtocolSocket; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;
|
|
function SendDHCPInform(ASocket:TProtocolSocket; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;
|
|
function SendDHCPRenew(ASocket:TProtocolSocket; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;
|
|
function SendDHCPRebind(ASocket:TProtocolSocket; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;
|
|
function SendDHCPReboot(ASocket:TProtocolSocket; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;
|
|
function RecvDHCPReply(ASocket:TProtocolSocket; ATransport:TDHCPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACommand:Word):Boolean;
|
|
function InsertDHCPOption(AOption:Byte; AHeader:PDHCPHeader; AValue:Pointer; ASize:Integer):Boolean;
|
|
function ExtractDHCPOption(AOption:Byte; AHeader:PDHCPHeader; AValue:Pointer; var ASize:Integer):Boolean;
|
|
protected
| |
public
| |
function AddTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function RemoveTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function StartConfig:Boolean; override;
|
|
function StopConfig:Boolean; override;
|
|
function ProcessConfig:Boolean; override;
|
|
function SetConfig(AInitDelay,ARetryCount,ARetryTimeout:LongWord):Boolean; override;
|
|
BOOTP configuration transport
TBOOTPConfigTransport = class(TConfigTransport)
private
| |
public
| |
BOOTP configuration
TBOOTPConfig = class(TNetworkConfig)
constructor Create(AManager:TProtocolManager);
|
|
destructor Destroy; override;
|
|
private
| |
FARP:TARPTransport;
|
|
FUDP:TUDPProtocol;
|
|
function ConfigHandler(AHandle:THandle; AAdapter:TTransportAdapter; ACommand:Word):Boolean;
|
|
function CreateBOOTPRequest(AHeader:PBOOTPHeader; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;
|
|
function CheckBOOTPReply(AHeader:PBOOTPHeader; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord):Boolean;
|
|
function HandleBOOTPReply(AHeader:PBOOTPHeader; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter):Boolean;
|
|
function SendBOOTPRequest(ASocket:TProtocolSocket; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord; ACount:Word):Boolean;
|
|
function RecvBOOTPReply(ASocket:TProtocolSocket; ATransport:TBOOTPConfigTransport; AAdapter:TTransportAdapter; AIdentifier:LongWord):Boolean;
|
|
function ExtractBOOTPOption(AOption:Byte; AHeader:PBOOTPHeader; AValue:Pointer; var ASize:Integer):Boolean;
|
|
protected
| |
public
| |
function AddTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function RemoveTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function StartConfig:Boolean; override;
|
|
function StopConfig:Boolean; override;
|
|
function ProcessConfig:Boolean; override;
|
|
function SetConfig(AInitDelay,ARetryCount,ARetryTimeout:LongWord):Boolean; override;
|
|
ARP configuration transport
TARPConfigTransport = class(TConfigTransport)
private
| |
public
| |
ARP configuration
TARPConfig = class(TNetworkConfig)
constructor Create(AManager:TProtocolManager);
|
|
destructor Destroy; override;
|
|
private
| |
FARP:TARPTransport;
|
|
function ConfigHandler(AHandle:THandle; AAdapter:TTransportAdapter; ACommand:Word):Boolean;
|
|
protected
| |
public
| |
function AddTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function RemoveTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function StartConfig:Boolean; override;
|
|
function StopConfig:Boolean; override;
|
|
function ProcessConfig:Boolean; override;
|
|
RARP configuration transport
TRARPConfigTransport = class(TConfigTransport)
private
| |
public
| |
RARP configuration
TRARPConfig = class(TNetworkConfig)
constructor Create(AManager:TProtocolManager);
|
|
destructor Destroy; override;
|
|
private
| |
FRARP:TRARPTransport;
|
|
function ConfigHandler(AHandle:THandle; AAdapter:TTransportAdapter; ACommand:Word):Boolean;
|
|
protected
| |
public
| |
function AddTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function RemoveTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function StartConfig:Boolean; override;
|
|
function StopConfig:Boolean; override;
|
|
function ProcessConfig:Boolean; override;
|
|
Static configuration transport
TStaticConfigTransport = class(TConfigTransport)
private
| |
public
| |
Static configuration
TStaticConfig = class(TNetworkConfig)
constructor Create(AManager:TProtocolManager);
|
|
destructor Destroy; override;
|
|
private
| |
FARP:TARPTransport;
|
|
function ConfigHandler(AHandle:THandle; AAdapter:TTransportAdapter; ACommand:Word):Boolean;
|
|
protected
| |
public
| |
function AddTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function RemoveTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function StartConfig:Boolean; override;
|
|
function StopConfig:Boolean; override;
|
|
function ProcessConfig:Boolean; override;
|
|
Loopback configuration transport
TLoopbackConfigTransport = class(TConfigTransport)
private
| |
public
| |
Loopback configuration
TLoopbackConfig = class(TNetworkConfig)
constructor Create(AManager:TProtocolManager);
|
|
destructor Destroy; override;
|
|
private
| |
function ConfigHandler(AHandle:THandle; AAdapter:TTransportAdapter; ACommand:Word):Boolean;
|
|
protected
| |
public
| |
function AddTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function RemoveTransport(ATransport:TNetworkTransport):Boolean; override;
|
|
function StartConfig:Boolean; override;
|
|
function StopConfig:Boolean; override;
|
|
function ProcessConfig:Boolean; override;
|
|
Public variables
None defined
Function declarations
Initialization functions
procedure DHCPInit;
Description: Initialize the DHCP unit and create the Loopback, Static, DHCP, BOOTP, RARP and ARP configuration handlers
| Note | Called only during system startup |
|---|
Return to Unit Reference
