networking/udhcp/common.h

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