common.h 14 KB

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