summaryrefslogtreecommitdiffhomepage
path: root/dhcpv4/types.go
blob: f84060983bc53fe7595073cb018cc182468f6127 (plain)
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
package dhcpv4

// values from http://www.networksorcery.com/enp/protocol/dhcp.htm and
// http://www.networksorcery.com/enp/protocol/bootp/options.htm

// DHCP message types
const (
	MessageTypeDiscover byte = iota + 1
	MessageTypeOffer
	MessageTypeRequest
	MessageTypeDecline
	MessageTypeAck
	MessageTypeNak
	MessageTypeRelease
	MessageTypeInform
)

// OpcodeType represents a DHCPv4 opcode.
type OpcodeType uint8

// constants that represent valid values for OpcodeType
const (
	_ OpcodeType = iota // skip 0
	OpcodeBootRequest
	OpcodeBootReply
)

// OpcodeToString maps an OpcodeType to its mnemonic name
var OpcodeToString = map[OpcodeType]string{
	OpcodeBootRequest: "BootRequest",
	OpcodeBootReply:   "BootReply",
}

// DHCPv4 Options
const (
	OptionPad                                        OptionCode = 0
	OptionSubnetMask                                            = 1
	OptionTimeOffset                                            = 2
	OptionRouter                                                = 3
	OptionTimeServer                                            = 4
	OptionNameServer                                            = 5
	OptionDomainNameServer                                      = 6
	OptionLogServer                                             = 7
	OptionQuoteServer                                           = 8
	OptionLPRServer                                             = 9
	OptionImpressServer                                         = 10
	OptionResourceLocationServer                                = 11
	OptionHostName                                              = 12
	OptionBootFileSize                                          = 13
	OptionMeritDumpFile                                         = 14
	OptionDomainName                                            = 15
	OptionSwapServer                                            = 16
	OptionRootPath                                              = 17
	OptionExtensionsPath                                        = 18
	OptionIPForwarding                                          = 19
	OptionNonLocalSourceRouting                                 = 20
	OptionPolicyFilter                                          = 21
	OptionMaximumDatagramAssemblySize                           = 22
	OptionDefaultIPTTL                                          = 23
	OptionPathMTUAgingTimeout                                   = 24
	OptionPathMTUPlateauTable                                   = 25
	OptionInterfaceMTU                                          = 26
	OptionAllSubnetsAreLocal                                    = 27
	OptionBroadcastAddress                                      = 28
	OptionPerformMaskDiscovery                                  = 29
	OptionMaskSupplier                                          = 30
	OptionPerformRouterDiscovery                                = 31
	OptionRouterSolicitationAddress                             = 32
	OptionStaticRoutingTable                                    = 33
	OptionTrailerEncapsulation                                  = 34
	OptionArpCacheTimeout                                       = 35
	OptionEthernetEncapsulation                                 = 36
	OptionDefaulTCPTTL                                          = 37
	OptionTCPKeepaliveInterval                                  = 38
	OptionTCPKeepaliveGarbage                                   = 39
	OptionNetworkInformationServiceDomain                       = 40
	OptionNetworkInformationServers                             = 41
	OptionNTPServers                                            = 42
	OptionVendorSpecificInformation                             = 43
	OptionNetBIOSOverTCPIPNameServer                            = 44
	OptionNetBIOSOverTCPIPDatagramDistributionServer            = 45
	OptionNetBIOSOverTCPIPNodeType                              = 46
	OptionNetBIOSOverTCPIPScope                                 = 47
	OptionXWindowSystemFontServer                               = 48
	OptionXWindowSystemDisplayManger                            = 49
	OptionRequestedIPAddress                                    = 50
	OptionIPAddressLeaseTime                                    = 51
	OptionOptionOverload                                        = 52
	OptionDHCPMessageType                                       = 53
	OptionServerIdentifier                                      = 54
	OptionParameterRequestList                                  = 55
	OptionMessage                                               = 56
	OptionMaximumDHCPMessageSize                                = 57
	OptionRenewTimeValue                                        = 58
	OptionRebindingTimeValue                                    = 59
	OptionClassIdentifier                                       = 60
	OptionClientIdentifier                                      = 61
	OptionNetWareIPDomainName                                   = 62
	OptionNetWareIPInformation                                  = 63
	OptionNetworkInformationServicePlusDomain                   = 64
	OptionNetworkInformationServicePlusServers                  = 65
	OptionTFTPServerName                                        = 66
	OptionBootfileName                                          = 67
	OptionMobileIPHomeAgent                                     = 68
	OptionSimpleMailTransportProtocolServer                     = 69
	OptionPostOfficeProtocolServer                              = 70
	OptionNetworkNewsTransportProtocolServer                    = 71
	OptionDefaultWorldWideWebServer                             = 72
	OptionDefaultFingerServer                                   = 73
	OptionDefaultInternetRelayChatServer                        = 74
	OptionStreetTalkServer                                      = 75
	OptionStreetTalkDirectoryAssistanceServer                   = 76
	OptionUserClassInformation                                  = 77
	OptionSLPDirectoryAgent                                     = 78
	OptionSLPServiceScope                                       = 79
	OptionRapidCommit                                           = 80
	OptionFQDN                                                  = 81
	OptionRelayAgentInformation                                 = 82
	OptionInternetStorageNameService                            = 83
	// Option 84 returned in RFC 3679
	OptionNDSServers                       = 85
	OptionNDSTreeName                      = 86
	OptionNDSContext                       = 87
	OptionBCMCSControllerDomainNameList    = 88
	OptionBCMCSControllerIPv4AddressList   = 89
	OptionAuthentication                   = 90
	OptionClientLastTransactionTime        = 91
	OptionAssociatedIP                     = 92
	OptionClientSystemArchitectureType     = 93
	OptionClientNetworkInterfaceIdentifier = 94
	OptionLDAP                             = 95
	// Option 96 returned in RFC 3679
	OptionClientMachineIdentifier     = 97
	OptionOpenGroupUserAuthentication = 98
	OptionGeoConfCivic                = 99
	OptionIEEE10031TZString           = 100
	OptionReferenceToTZDatabase       = 101
	// Options 102-111 returned in RFC 3679
	OptionNetInfoParentServerAddress = 112
	OptionNetInfoParentServerTag     = 113
	OptionURL                        = 114
	// Option 115 returned in RFC 3679
	OptionAutoConfigure                   = 116
	OptionNameServiceSearch               = 117
	OptionSubnetSelection                 = 118
	OptionDNSDomainSearchList             = 119
	OptionSIPServersDHCPOption            = 120
	OptionClasslessStaticRouteOption      = 121
	OptionCCC                             = 122
	OptionGeoConf                         = 123
	OptionVendorIdentifyingVendorClass    = 124
	OptionVendorIdentifyingVendorSpecific = 125
	// Options 126-127 returned in RFC 3679
	OptionTFTPServerIPAddress                   = 128
	OptionCallServerIPAddress                   = 129
	OptionDiscriminationString                  = 130
	OptionRemoteStatisticsServerIPAddress       = 131
	Option8021PVLANID                           = 132
	Option8021QL2Priority                       = 133
	OptionDiffservCodePoint                     = 134
	OptionHTTPProxyForPhoneSpecificApplications = 135
	OptionPANAAuthenticationAgent               = 136
	OptionLoSTServer                            = 137
	OptionCAPWAPAccessControllerAddresses       = 138
	OptionOPTIONIPv4AddressMoS                  = 139
	OptionOPTIONIPv4FQDNMoS                     = 140
	OptionSIPUAConfigurationServiceDomains      = 141
	OptionOPTIONIPv4AddressANDSF                = 142
	OptionOPTIONIPv6AddressANDSF                = 143
	// Options 144-149 returned in RFC 3679
	OptionTFTPServerAddress = 150
	OptionStatusCode        = 151
	OptionBaseTime          = 152
	OptionStartTimeOfState  = 153
	OptionQueryStartTime    = 154
	OptionQueryEndTime      = 155
	OptionDHCPState         = 156
	OptionDataSource        = 157
	// Options 158-174 returned in RFC 3679
	OptionEtherboot                        = 175
	OptionIPTelephone                      = 176
	OptionEtherbootPacketCableAndCableHome = 177
	// Options 178-207 returned in RFC 3679
	OptionPXELinuxMagicString  = 208
	OptionPXELinuxConfigFile   = 209
	OptionPXELinuxPathPrefix   = 210
	OptionPXELinuxRebootTime   = 211
	OptionOPTION6RD            = 212
	OptionOPTIONv4AccessDomain = 213
	// Options 214-219 returned in RFC 3679
	OptionSubnetAllocation        = 220
	OptionVirtualSubnetAllocation = 221
	// Options 222-223 returned in RFC 3679
	// Options 224-254 are reserved for private use
	OptionEnd = 255
)

// OptionCodeToString maps an OptionCode to its mnemonic name
var OptionCodeToString = map[OptionCode]string{
	OptionPad:                                        "Pad",
	OptionSubnetMask:                                 "Subnet Mask",
	OptionTimeOffset:                                 "Time Offset",
	OptionRouter:                                     "Router",
	OptionTimeServer:                                 "Time Server",
	OptionNameServer:                                 "Name Server",
	OptionDomainNameServer:                           "Domain Name Server",
	OptionLogServer:                                  "Log Server",
	OptionQuoteServer:                                "Quote Server",
	OptionLPRServer:                                  "LPR Server",
	OptionImpressServer:                              "Impress Server",
	OptionResourceLocationServer:                     "Resource Location Server",
	OptionHostName:                                   "Host Name",
	OptionBootFileSize:                               "Boot File Size",
	OptionMeritDumpFile:                              "Merit Dump File",
	OptionDomainName:                                 "Domain Name",
	OptionSwapServer:                                 "Swap Server",
	OptionRootPath:                                   "Root Path",
	OptionExtensionsPath:                             "Extensions Path",
	OptionIPForwarding:                               "IP Forwarding enable/disable",
	OptionNonLocalSourceRouting:                      "Non-local Source Routing enable/disable",
	OptionPolicyFilter:                               "Policy Filter",
	OptionMaximumDatagramAssemblySize:                "Maximum Datagram Reassembly Size",
	OptionDefaultIPTTL:                               "Default IP Time-to-live",
	OptionPathMTUAgingTimeout:                        "Path MTU Aging Timeout",
	OptionPathMTUPlateauTable:                        "Path MTU Plateau Table",
	OptionInterfaceMTU:                               "Interface MTU",
	OptionAllSubnetsAreLocal:                         "All Subnets Are Local",
	OptionBroadcastAddress:                           "Broadcast Address",
	OptionPerformMaskDiscovery:                       "Perform Mask Discovery",
	OptionMaskSupplier:                               "Mask Supplier",
	OptionPerformRouterDiscovery:                     "Perform Router Discovery",
	OptionRouterSolicitationAddress:                  "Router Solicitation Address",
	OptionStaticRoutingTable:                         "Static Routing Table",
	OptionTrailerEncapsulation:                       "Trailer Encapsulation",
	OptionArpCacheTimeout:                            "ARP Cache Timeout",
	OptionEthernetEncapsulation:                      "Ethernet Encapsulation",
	OptionDefaulTCPTTL:                               "Default TCP TTL",
	OptionTCPKeepaliveInterval:                       "TCP Keepalive Interval",
	OptionTCPKeepaliveGarbage:                        "TCP Keepalive Garbage",
	OptionNetworkInformationServiceDomain:            "Network Information Service Domain",
	OptionNetworkInformationServers:                  "Network Information Servers",
	OptionNTPServers:                                 "NTP Servers",
	OptionVendorSpecificInformation:                  "Vendor Specific Information",
	OptionNetBIOSOverTCPIPNameServer:                 "NetBIOS over TCP/IP Name Server",
	OptionNetBIOSOverTCPIPDatagramDistributionServer: "NetBIOS over TCP/IP Datagram Distribution Server",
	OptionNetBIOSOverTCPIPNodeType:                   "NetBIOS over TCP/IP Node Type",
	OptionNetBIOSOverTCPIPScope:                      "NetBIOS over TCP/IP Scope",
	OptionXWindowSystemFontServer:                    "X Window System Font Server",
	OptionXWindowSystemDisplayManger:                 "X Window System Display Manager",
	OptionRequestedIPAddress:                         "Requested IP Address",
	OptionIPAddressLeaseTime:                         "IP Addresses Lease Time",
	OptionOptionOverload:                             "Option Overload",
	OptionDHCPMessageType:                            "DHCP Message Type",
	OptionServerIdentifier:                           "Server Identifier",
	OptionParameterRequestList:                       "Parameter Request List",
	OptionMessage:                                    "Message",
	OptionMaximumDHCPMessageSize:                     "Maximum DHCP Message Size",
	OptionRenewTimeValue:                             "Renew Time Value",
	OptionRebindingTimeValue:                         "Rebinding Time Value",
	OptionClassIdentifier:                            "Class Identifier",
	OptionClientIdentifier:                           "Client identifier",
	OptionNetWareIPDomainName:                        "NetWare/IP Domain Name",
	OptionNetWareIPInformation:                       "NetWare/IP Information",
	OptionNetworkInformationServicePlusDomain:        "Network Information Service+ Domain",
	OptionNetworkInformationServicePlusServers:       "Network Information Service+ Servers",
	OptionTFTPServerName:                             "TFTP Server Name",
	OptionBootfileName:                               "Bootfile Name",
	OptionMobileIPHomeAgent:                          "Mobile IP Home Agent",
	OptionSimpleMailTransportProtocolServer:          "SMTP Server",
	OptionPostOfficeProtocolServer:                   "POP Server",
	OptionNetworkNewsTransportProtocolServer:         "NNTP Server",
	OptionDefaultWorldWideWebServer:                  "Default WWW Server",
	OptionDefaultFingerServer:                        "Default Finger Server",
	OptionDefaultInternetRelayChatServer:             "Default IRC Server",
	OptionStreetTalkServer:                           "StreetTalk Server",
	OptionStreetTalkDirectoryAssistanceServer:        "StreetTalk Directory Assistance Server",
	OptionUserClassInformation:                       "User Class Information",
	OptionSLPDirectoryAgent:                          "SLP DIrectory Agent",
	OptionSLPServiceScope:                            "SLP Service Scope",
	OptionRapidCommit:                                "Rapid Commit",
	OptionFQDN:                                       "FQDN",
	OptionRelayAgentInformation:                      "Relay Agent Information",
	OptionInternetStorageNameService:                 "Internet Storage Name Service",
	// Option 84 returned in RFC 3679
	OptionNDSServers:                       "NDS Servers",
	OptionNDSTreeName:                      "NDS Tree Name",
	OptionNDSContext:                       "NDS Context",
	OptionBCMCSControllerDomainNameList:    "BCMCS Controller Domain Name List",
	OptionBCMCSControllerIPv4AddressList:   "BCMCS Controller IPv4 Address List",
	OptionAuthentication:                   "Authentication",
	OptionClientLastTransactionTime:        "Client Last Transaction Time",
	OptionAssociatedIP:                     "Associated IP",
	OptionClientSystemArchitectureType:     "Client System Architecture Type",
	OptionClientNetworkInterfaceIdentifier: "Client Network Interface Identifier",
	OptionLDAP:                             "LDAP",
	// Option 96 returned in RFC 3679
	OptionClientMachineIdentifier:     "Client Machine Identifier",
	OptionOpenGroupUserAuthentication: "OpenGroup's User Authentication",
	OptionGeoConfCivic:                "GEOCONF_CIVIC",
	OptionIEEE10031TZString:           "IEEE 1003.1 TZ String",
	OptionReferenceToTZDatabase:       "Reference to the TZ Database",
	// Options 102-111 returned in RFC 3679
	OptionNetInfoParentServerAddress: "NetInfo Parent Server Address",
	OptionNetInfoParentServerTag:     "NetInfo Parent Server Tag",
	OptionURL:                        "URL",
	// Option 115 returned in RFC 3679
	OptionAutoConfigure:                   "Auto-Configure",
	OptionNameServiceSearch:               "Name Service Search",
	OptionSubnetSelection:                 "Subnet Selection",
	OptionDNSDomainSearchList:             "DNS Domain Search List",
	OptionSIPServersDHCPOption:            "SIP Servers DHCP Option",
	OptionClasslessStaticRouteOption:      "Classless Static Route Option",
	OptionCCC:                             "CCC, CableLabs Client Configuration",
	OptionGeoConf:                         "GeoConf",
	OptionVendorIdentifyingVendorClass:    "Vendor-Identifying Vendor Class",
	OptionVendorIdentifyingVendorSpecific: "Vendor-Identifying Vendor-Specific",
	// Options 126-127 returned in RFC 3679
	OptionTFTPServerIPAddress:                   "TFTP Server IP Address",
	OptionCallServerIPAddress:                   "Call Server IP Address",
	OptionDiscriminationString:                  "Discrimination String",
	OptionRemoteStatisticsServerIPAddress:       "RemoteStatistics Server IP Address",
	Option8021PVLANID:                           "802.1P VLAN ID",
	Option8021QL2Priority:                       "802.1Q L2 Priority",
	OptionDiffservCodePoint:                     "Diffserv Code Point",
	OptionHTTPProxyForPhoneSpecificApplications: "HTTP Proxy for phone-specific applications",
	OptionPANAAuthenticationAgent:               "PANA Authentication Agent",
	OptionLoSTServer:                            "LoST Server",
	OptionCAPWAPAccessControllerAddresses:       "CAPWAP Access Controller Addresses",
	OptionOPTIONIPv4AddressMoS:                  "OPTION-IPv4_Address-MoS",
	OptionOPTIONIPv4FQDNMoS:                     "OPTION-IPv4_FQDN-MoS",
	OptionSIPUAConfigurationServiceDomains:      "SIP UA Configuration Service Domains",
	OptionOPTIONIPv4AddressANDSF:                "OPTION-IPv4_Address-ANDSF",
	OptionOPTIONIPv6AddressANDSF:                "OPTION-IPv6_Address-ANDSF",
	// Options 144-149 returned in RFC 3679
	OptionTFTPServerAddress: "TFTP Server Address",
	OptionStatusCode:        "Status Code",
	OptionBaseTime:          "Base Time",
	OptionStartTimeOfState:  "Start Time of State",
	OptionQueryStartTime:    "Query Start Time",
	OptionQueryEndTime:      "Query End Time",
	OptionDHCPState:         "DHCP Staet",
	OptionDataSource:        "Data Source",
	// Options 158-174 returned in RFC 3679
	OptionEtherboot:                        "Etherboot",
	OptionIPTelephone:                      "IP Telephone",
	OptionEtherbootPacketCableAndCableHome: "Etherboot / PacketCable and CableHome",
	// Options 178-207 returned in RFC 3679
	OptionPXELinuxMagicString:  "PXELinux Magic String",
	OptionPXELinuxConfigFile:   "PXELinux Config File",
	OptionPXELinuxPathPrefix:   "PXELinux Path Prefix",
	OptionPXELinuxRebootTime:   "PXELinux Reboot Time",
	OptionOPTION6RD:            "OPTION_6RD",
	OptionOPTIONv4AccessDomain: "OPTION_V4_ACCESS_DOMAIN",
	// Options 214-219 returned in RFC 3679
	OptionSubnetAllocation:        "Subnet Allocation",
	OptionVirtualSubnetAllocation: "Virtual Subnet Selection",
	// Options 222-223 returned in RFC 3679
	// Options 224-254 are reserved for private use

	OptionEnd: "End",
}

// BSDPOptionCodeToString maps BSDP OptionCodes to human-readable strings
// describing what they are.
var BSDPOptionCodeToString = map[OptionCode]string{
	BSDPOptionMessageType:                   "BSDP Message Type",
	BSDPOptionVersion:                       "BSDP Version",
	BSDPOptionServerIdentifier:              "BSDP Server Identifier",
	BSDPOptionServerPriority:                "BSDP Server Priority",
	BSDPOptionReplyPort:                     "BSDP Reply Port",
	BSDPOptionBootImageListPath:             "", // Not used
	BSDPOptionDefaultBootImageID:            "BSDP Default Boot Image ID",
	BSDPOptionSelectedBootImageID:           "BSDP Selected Boot Image ID",
	BSDPOptionBootImageList:                 "BSDP Boot Image List",
	BSDPOptionNetboot1_0Firmware:            "BSDP Netboot 1.0 Firmware",
	BSDPOptionBootImageAttributesFilterList: "BSDP Boot Image Attributes Filter List",
}