Magellan Linux

Contents of /trunk/mkinitrd-magellan/busybox/networking/udhcp/common.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1123 - (show annotations) (download)
Wed Aug 18 21:56:57 2010 UTC (13 years, 9 months ago) by niro
File MIME type: text/plain
File size: 13153 byte(s)
-updated to busybox-1.17.1
1 /* vi: set sw=4 ts=4: */
2 /*
3 * Russ Dill <Russ.Dill@asu.edu> September 2001
4 * Rewritten by Vladimir Oleynik <dzo@simtreas.ru> (C) 2003
5 *
6 * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
7 */
8 #ifndef UDHCP_COMMON_H
9 #define UDHCP_COMMON_H 1
10
11 #include "libbb.h"
12 #include <netinet/udp.h>
13 #include <netinet/ip.h>
14
15 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
16
17 extern const uint8_t MAC_BCAST_ADDR[6]; /* six all-ones */
18
19
20 /*** DHCP packet ***/
21
22 /* DHCP protocol. See RFC 2131 */
23 #define DHCP_MAGIC 0x63825363
24 #define DHCP_OPTIONS_BUFSIZE 308
25 #define BOOTREQUEST 1
26 #define BOOTREPLY 2
27
28 //TODO: rename ciaddr/yiaddr/chaddr
29 struct dhcp_packet {
30 uint8_t op; /* BOOTREQUEST or BOOTREPLY */
31 uint8_t htype; /* hardware address type. 1 = 10mb ethernet */
32 uint8_t hlen; /* hardware address length */
33 uint8_t hops; /* used by relay agents only */
34 uint32_t xid; /* unique id */
35 uint16_t secs; /* elapsed since client began acquisition/renewal */
36 uint16_t flags; /* only one flag so far: */
37 #define BROADCAST_FLAG 0x8000 /* "I need broadcast replies" */
38 uint32_t ciaddr; /* client IP (if client is in BOUND, RENEW or REBINDING state) */
39 uint32_t yiaddr; /* 'your' (client) IP address */
40 /* IP address of next server to use in bootstrap, returned in DHCPOFFER, DHCPACK by server */
41 uint32_t siaddr_nip;
42 uint32_t gateway_nip; /* relay agent IP address */
43 uint8_t chaddr[16]; /* link-layer client hardware address (MAC) */
44 uint8_t sname[64]; /* server host name (ASCIZ) */
45 uint8_t file[128]; /* boot file name (ASCIZ) */
46 uint32_t cookie; /* fixed first four option bytes (99,130,83,99 dec) */
47 uint8_t options[DHCP_OPTIONS_BUFSIZE + CONFIG_UDHCPC_SLACK_FOR_BUGGY_SERVERS];
48 } PACKED;
49 #define DHCP_PKT_SNAME_LEN 64
50 #define DHCP_PKT_FILE_LEN 128
51 #define DHCP_PKT_SNAME_LEN_STR "64"
52 #define DHCP_PKT_FILE_LEN_STR "128"
53
54 struct ip_udp_dhcp_packet {
55 struct iphdr ip;
56 struct udphdr udp;
57 struct dhcp_packet data;
58 } PACKED;
59
60 struct udp_dhcp_packet {
61 struct udphdr udp;
62 struct dhcp_packet data;
63 } PACKED;
64
65 enum {
66 IP_UPD_DHCP_SIZE = sizeof(struct ip_udp_dhcp_packet) - CONFIG_UDHCPC_SLACK_FOR_BUGGY_SERVERS,
67 UPD_DHCP_SIZE = sizeof(struct udp_dhcp_packet) - CONFIG_UDHCPC_SLACK_FOR_BUGGY_SERVERS,
68 DHCP_SIZE = sizeof(struct dhcp_packet) - CONFIG_UDHCPC_SLACK_FOR_BUGGY_SERVERS,
69 };
70
71 /* Let's see whether compiler understood us right */
72 struct BUG_bad_sizeof_struct_ip_udp_dhcp_packet {
73 char c[IP_UPD_DHCP_SIZE == 576 ? 1 : -1];
74 };
75
76
77 /*** Options ***/
78
79 enum {
80 OPTION_IP = 1,
81 OPTION_IP_PAIR,
82 OPTION_STRING,
83 // OPTION_BOOLEAN,
84 OPTION_U8,
85 OPTION_U16,
86 // OPTION_S16,
87 OPTION_U32,
88 OPTION_S32,
89 OPTION_BIN,
90 OPTION_STATIC_ROUTES,
91 #if ENABLE_FEATURE_UDHCP_RFC3397
92 OPTION_DNS_STRING, /* RFC1035 compressed domain name list */
93 OPTION_SIP_SERVERS,
94 #endif
95
96 OPTION_TYPE_MASK = 0x0f,
97 /* Client requests this option by default */
98 OPTION_REQ = 0x10,
99 /* There can be a list of 1 or more of these */
100 OPTION_LIST = 0x20,
101 };
102
103 /* DHCP option codes (partial list). See RFC 2132 and
104 * http://www.iana.org/assignments/bootp-dhcp-parameters/
105 * Commented out options are handled by common option machinery,
106 * uncommented ones have spacial cases (grep for them to see).
107 */
108 #define DHCP_PADDING 0x00
109 #define DHCP_SUBNET 0x01
110 //#define DHCP_TIME_OFFSET 0x02 /* (localtime - UTC_time) in seconds. signed */
111 //#define DHCP_ROUTER 0x03
112 //#define DHCP_TIME_SERVER 0x04 /* RFC 868 time server (32-bit, 0 = 1.1.1900) */
113 //#define DHCP_NAME_SERVER 0x05 /* IEN 116 _really_ ancient kind of NS */
114 //#define DHCP_DNS_SERVER 0x06
115 //#define DHCP_LOG_SERVER 0x07 /* port 704 UDP log (not syslog)
116 //#define DHCP_COOKIE_SERVER 0x08 /* "quote of the day" server */
117 //#define DHCP_LPR_SERVER 0x09
118 #define DHCP_HOST_NAME 0x0c /* either client informs server or server gives name to client */
119 //#define DHCP_BOOT_SIZE 0x0d
120 //#define DHCP_DOMAIN_NAME 0x0f /* server gives domain suffix */
121 //#define DHCP_SWAP_SERVER 0x10
122 //#define DHCP_ROOT_PATH 0x11
123 //#define DHCP_IP_TTL 0x17
124 //#define DHCP_MTU 0x1a
125 //#define DHCP_BROADCAST 0x1c
126 //#define DHCP_NIS_DOMAIN 0x28
127 //#define DHCP_NIS_SERVER 0x29
128 //#define DHCP_NTP_SERVER 0x2a
129 //#define DHCP_WINS_SERVER 0x2c
130 #define DHCP_REQUESTED_IP 0x32 /* sent by client if specific IP is wanted */
131 #define DHCP_LEASE_TIME 0x33
132 #define DHCP_OPTION_OVERLOAD 0x34
133 #define DHCP_MESSAGE_TYPE 0x35
134 #define DHCP_SERVER_ID 0x36 /* by default server's IP */
135 #define DHCP_PARAM_REQ 0x37 /* list of options client wants */
136 //#define DHCP_ERR_MESSAGE 0x38 /* error message when sending NAK etc */
137 #define DHCP_MAX_SIZE 0x39
138 #define DHCP_VENDOR 0x3c /* client's vendor (a string) */
139 #define DHCP_CLIENT_ID 0x3d /* by default client's MAC addr, but may be arbitrarily long */
140 //#define DHCP_TFTP_SERVER_NAME 0x42 /* same as 'sname' field */
141 //#define DHCP_BOOT_FILE 0x43 /* same as 'file' field */
142 //#define DHCP_USER_CLASS 0x4d /* RFC 3004. set of LASCII strings. "I am a printer" etc */
143 #define DHCP_FQDN 0x51 /* client asks to update DNS to map its FQDN to its new IP */
144 //#define DHCP_DOMAIN_SEARCH 0x77 /* RFC 3397. set of ASCIZ string, DNS-style compressed */
145 //#define DHCP_SIP_SERVERS 0x78 /* RFC 3361. flag byte, then: 0: domain names, 1: IP addrs */
146 //#define DHCP_STATIC_ROUTES 0x79 /* RFC 3442. (mask,ip,router) tuples */
147 //#define DHCP_WPAD 0xfc /* MSIE's Web Proxy Autodiscovery Protocol */
148 #define DHCP_END 0xff
149
150 /* Offsets in option byte sequence */
151 #define OPT_CODE 0
152 #define OPT_LEN 1
153 #define OPT_DATA 2
154 /* Bits in "overload" option */
155 #define OPTION_FIELD 0
156 #define FILE_FIELD 1
157 #define SNAME_FIELD 2
158
159 /* DHCP_MESSAGE_TYPE values */
160 #define DHCPDISCOVER 1 /* client -> server */
161 #define DHCPOFFER 2 /* client <- server */
162 #define DHCPREQUEST 3 /* client -> server */
163 #define DHCPDECLINE 4 /* client -> server */
164 #define DHCPACK 5 /* client <- server */
165 #define DHCPNAK 6 /* client <- server */
166 #define DHCPRELEASE 7 /* client -> server */
167 #define DHCPINFORM 8 /* client -> server */
168 #define DHCP_MINTYPE DHCPDISCOVER
169 #define DHCP_MAXTYPE DHCPINFORM
170
171 struct dhcp_optflag {
172 uint8_t flags;
173 uint8_t code;
174 };
175
176 struct option_set {
177 uint8_t *data;
178 struct option_set *next;
179 };
180
181 extern const struct dhcp_optflag dhcp_optflags[];
182 extern const char dhcp_option_strings[];
183 extern const uint8_t dhcp_option_lengths[];
184
185 unsigned FAST_FUNC udhcp_option_idx(const char *name);
186
187 uint8_t *udhcp_get_option(struct dhcp_packet *packet, int code) FAST_FUNC;
188 int udhcp_end_option(uint8_t *optionptr) FAST_FUNC;
189 void udhcp_add_binary_option(struct dhcp_packet *packet, uint8_t *addopt) FAST_FUNC;
190 void udhcp_add_simple_option(struct dhcp_packet *packet, uint8_t code, uint32_t data) FAST_FUNC;
191 #if ENABLE_FEATURE_UDHCP_RFC3397
192 char *dname_dec(const uint8_t *cstr, int clen, const char *pre) FAST_FUNC;
193 uint8_t *dname_enc(const uint8_t *cstr, int clen, const char *src, int *retlen) FAST_FUNC;
194 #endif
195 struct option_set *udhcp_find_option(struct option_set *opt_list, uint8_t code) FAST_FUNC;
196
197
198 // RFC 2131 Table 5: Fields and options used by DHCP clients
199 //
200 // Fields 'hops', 'yiaddr', 'siaddr', 'giaddr' are always zero
201 //
202 // Field DHCPDISCOVER DHCPINFORM DHCPREQUEST DHCPDECLINE DHCPRELEASE
203 // ----- ------------ ------------ ----------- ----------- -----------
204 // 'xid' selected by client selected by client 'xid' from server selected by client selected by client
205 // DHCPOFFER message
206 // 'secs' 0 or seconds since 0 or seconds since 0 or seconds since 0 0
207 // DHCP process started DHCP process started DHCP process started
208 // 'flags' Set 'BROADCAST' Set 'BROADCAST' Set 'BROADCAST' 0 0
209 // flag if client flag if client flag if client
210 // requires broadcast requires broadcast requires broadcast
211 // reply reply reply
212 // 'ciaddr' 0 client's IP 0 or client's IP 0 client's IP
213 // (BOUND/RENEW/REBIND)
214 // 'chaddr' client's MAC client's MAC client's MAC client's MAC client's MAC
215 // 'sname' options or sname options or sname options or sname (unused) (unused)
216 // 'file' options or file options or file options or file (unused) (unused)
217 // 'options' options options options message type opt message type opt
218 //
219 // Option DHCPDISCOVER DHCPINFORM DHCPREQUEST DHCPDECLINE DHCPRELEASE
220 // ------ ------------ ---------- ----------- ----------- -----------
221 // Requested IP address MAY MUST NOT MUST (in MUST MUST NOT
222 // SELECTING or
223 // INIT-REBOOT)
224 // MUST NOT (in
225 // BOUND or
226 // RENEWING)
227 // IP address lease time MAY MUST NOT MAY MUST NOT MUST NOT
228 // Use 'file'/'sname' fields MAY MAY MAY MAY MAY
229 // Client identifier MAY MAY MAY MAY MAY
230 // Vendor class identifier MAY MAY MAY MUST NOT MUST NOT
231 // Server identifier MUST NOT MUST NOT MUST (after MUST MUST
232 // SELECTING)
233 // MUST NOT (after
234 // INIT-REBOOT,
235 // BOUND, RENEWING
236 // or REBINDING)
237 // Parameter request list MAY MAY MAY MUST NOT MUST NOT
238 // Maximum message size MAY MAY MAY MUST NOT MUST NOT
239 // Message SHOULD NOT SHOULD NOT SHOULD NOT SHOULD SHOULD
240 // Site-specific MAY MAY MAY MUST NOT MUST NOT
241 // All others MAY MAY MAY MUST NOT MUST NOT
242
243
244 /*** Logging ***/
245
246 #if defined CONFIG_UDHCP_DEBUG && CONFIG_UDHCP_DEBUG >= 1
247 extern unsigned dhcp_verbose;
248 # define log1(...) do { if (dhcp_verbose >= 1) bb_info_msg(__VA_ARGS__); } while (0)
249 # if CONFIG_UDHCP_DEBUG >= 2
250 void udhcp_dump_packet(struct dhcp_packet *packet) FAST_FUNC;
251 # define log2(...) do { if (dhcp_verbose >= 2) bb_info_msg(__VA_ARGS__); } while (0)
252 # else
253 # define udhcp_dump_packet(...) ((void)0)
254 # define log2(...) ((void)0)
255 # endif
256 # if CONFIG_UDHCP_DEBUG >= 3
257 # define log3(...) do { if (dhcp_verbose >= 3) bb_info_msg(__VA_ARGS__); } while (0)
258 # else
259 # define log3(...) ((void)0)
260 # endif
261 #else
262 # define udhcp_dump_packet(...) ((void)0)
263 # define log1(...) ((void)0)
264 # define log2(...) ((void)0)
265 # define log3(...) ((void)0)
266 #endif
267
268
269 /*** Other shared functions ***/
270
271 /* 2nd param is "uint32_t*" */
272 int FAST_FUNC udhcp_str2nip(const char *str, void *arg);
273 /* 2nd param is "struct option_set**" */
274 int FAST_FUNC udhcp_str2optset(const char *str, void *arg);
275
276 uint16_t udhcp_checksum(void *addr, int count) FAST_FUNC;
277
278 void udhcp_init_header(struct dhcp_packet *packet, char type) FAST_FUNC;
279
280 int udhcp_recv_kernel_packet(struct dhcp_packet *packet, int fd) FAST_FUNC;
281
282 int udhcp_send_raw_packet(struct dhcp_packet *dhcp_pkt,
283 uint32_t source_nip, int source_port,
284 uint32_t dest_nip, int dest_port, const uint8_t *dest_arp,
285 int ifindex) FAST_FUNC;
286
287 int udhcp_send_kernel_packet(struct dhcp_packet *dhcp_pkt,
288 uint32_t source_nip, int source_port,
289 uint32_t dest_nip, int dest_port) FAST_FUNC;
290
291 void udhcp_sp_setup(void) FAST_FUNC;
292 int udhcp_sp_fd_set(fd_set *rfds, int extra_fd) FAST_FUNC;
293 int udhcp_sp_read(const fd_set *rfds) FAST_FUNC;
294
295 int udhcp_read_interface(const char *interface, int *ifindex, uint32_t *nip, uint8_t *mac) FAST_FUNC;
296
297 int udhcp_listen_socket(/*uint32_t ip,*/ int port, const char *inf) FAST_FUNC;
298
299 /* Returns 1 if no reply received */
300 int arpping(uint32_t test_nip,
301 const uint8_t *safe_mac,
302 uint32_t from_ip,
303 uint8_t *from_mac,
304 const char *interface) FAST_FUNC;
305
306 POP_SAVED_FUNCTION_VISIBILITY
307
308 #endif