networking/udhcp/options.h

   1 /* vi: set sw=4 ts=4: */
   2 /* options.h */
   3 #ifndef UDHCP_OPTIONS_H
   4 #define UDHCP_OPTIONS_H 1
   5
   6 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
   7
   8 #define TYPE_MASK       0x0F
   9
  10 enum {
  11         OPTION_IP = 1,
  12         OPTION_IP_PAIR,
  13         OPTION_STRING,
  14 #if ENABLE_FEATURE_UDHCP_RFC3397
  15         OPTION_STR1035, /* RFC1035 compressed domain name list */
  16 #endif
  17         OPTION_BOOLEAN,
  18         OPTION_U8,
  19         OPTION_U16,
  20         OPTION_S16,
  21         OPTION_U32,
  22         OPTION_S32,
  23         OPTION_STATIC_ROUTES,
  24 };
  25
  26 /* Client requests this option by default */
  27 #define OPTION_REQ      0x10
  28 /* There can be a list of 1 or more of these */
  29 #define OPTION_LIST     0x20
  30
  31 /*****************************************************************/
  32 /* Do not modify below here unless you know what you are doing!! */
  33 /*****************************************************************/
  34
  35 /* DHCP protocol. See RFC 2131 */
  36 #define DHCP_MAGIC              0x63825363
  37
  38 /* DHCP option codes (partial list). See RFC 2132 and
  39  * http://www.iana.org/assignments/bootp-dhcp-parameters/
  40  * Commented out options are handled by common option machinery,
  41  * uncommented ones have spacial cases (grep for them to see).
  42  */
  43 #define DHCP_PADDING            0x00
  44 #define DHCP_SUBNET             0x01
  45 //#define DHCP_TIME_OFFSET      0x02 /* (localtime - UTC_time) in seconds. signed */
  46 //#define DHCP_ROUTER           0x03
  47 //#define DHCP_TIME_SERVER      0x04 /* RFC 868 time server (32-bit, 0 = 1.1.1900) */
  48 //#define DHCP_NAME_SERVER      0x05 /* IEN 116 _really_ ancient kind of NS */
  49 //#define DHCP_DNS_SERVER       0x06
  50 //#define DHCP_LOG_SERVER       0x07 /* port 704 UDP log (not syslog)
  51 //#define DHCP_COOKIE_SERVER    0x08 /* "quote of the day" server */
  52 //#define DHCP_LPR_SERVER       0x09
  53 #define DHCP_HOST_NAME          0x0c /* either client informs server or server gives name to client */
  54 //#define DHCP_BOOT_SIZE        0x0d
  55 //#define DHCP_DOMAIN_NAME      0x0f /* server gives domain suffix */
  56 //#define DHCP_SWAP_SERVER      0x10
  57 //#define DHCP_ROOT_PATH        0x11
  58 //#define DHCP_IP_TTL           0x17
  59 //#define DHCP_MTU              0x1a
  60 //#define DHCP_BROADCAST        0x1c
  61 //#define DHCP_NIS_DOMAIN       0x28
  62 //#define DHCP_NIS_SERVER       0x29
  63 //#define DHCP_NTP_SERVER       0x2a
  64 //#define DHCP_WINS_SERVER      0x2c
  65 #define DHCP_REQUESTED_IP       0x32 /* sent by client if specific IP is wanted */
  66 #define DHCP_LEASE_TIME         0x33
  67 #define DHCP_OPTION_OVERLOAD    0x34
  68 #define DHCP_MESSAGE_TYPE       0x35
  69 #define DHCP_SERVER_ID          0x36 /* by default server's IP */
  70 #define DHCP_PARAM_REQ          0x37 /* list of options client wants */
  71 //#define DHCP_ERR_MESSAGE      0x38 /* error message when sending NAK etc */
  72 #define DHCP_MAX_SIZE           0x39
  73 #define DHCP_VENDOR             0x3c /* client's vendor (a string) */
  74 #define DHCP_CLIENT_ID          0x3d /* by default client's MAC addr, but may be arbitrarily long */
  75 //#define DHCP_TFTP_SERVER_NAME 0x42 /* same as 'sname' field */
  76 //#define DHCP_BOOT_FILE        0x43 /* same as 'file' field */
  77 //#define DHCP_USER_CLASS       0x4d /* RFC 3004. set of LASCII strings. "I am a printer" etc */
  78 #define DHCP_FQDN               0x51 /* client asks to update DNS to map its FQDN to its new IP */
  79 //#define DHCP_DOMAIN_SEARCH    0x77 /* RFC 3397. set of ASCIZ string, DNS-style compressed */
  80 //#define DHCP_STATIC_ROUTES    0x79 /* RFC 3442. (mask,ip,router) tuples */
  81 //#define DHCP_WPAD             0xfc /* MSIE's Web Proxy Autodiscovery Protocol */
  82 #define DHCP_END                0xff
  83
  84
  85 /* Offsets in option byte sequence */
  86 #define OPT_CODE                0
  87 #define OPT_LEN                 1
  88 #define OPT_DATA                2
  89 /* Bits in "overload" option */
  90 #define OPTION_FIELD            0
  91 #define FILE_FIELD              1
  92 #define SNAME_FIELD             2
  93
  94 #define BOOTREQUEST             1
  95 #define BOOTREPLY               2
  96
  97 #define ETH_10MB                1
  98 #define ETH_10MB_LEN            6
  99
 100 #define DHCPDISCOVER            1 /* client -> server */
 101 #define DHCPOFFER               2 /* client <- server */
 102 #define DHCPREQUEST             3 /* client -> server */
 103 #define DHCPDECLINE             4 /* client -> server */
 104 #define DHCPACK                 5 /* client <- server */
 105 #define DHCPNAK                 6 /* client <- server */
 106 #define DHCPRELEASE             7 /* client -> server */
 107 #define DHCPINFORM              8 /* client -> server */
 108
 109 struct dhcp_option {
 110         uint8_t flags;
 111         uint8_t code;
 112 };
 113
 114 extern const struct dhcp_option dhcp_options[];
 115 extern const char dhcp_option_strings[];
 116 extern const uint8_t dhcp_option_lengths[];
 117
 118 uint8_t *get_option(struct dhcp_packet *packet, int code) FAST_FUNC;
 119 int end_option(uint8_t *optionptr) FAST_FUNC;
 120 void add_option_string(uint8_t *optionptr, uint8_t *string) FAST_FUNC;
 121 void add_simple_option(uint8_t *optionptr, uint8_t code, uint32_t data) FAST_FUNC;
 122 #if ENABLE_FEATURE_UDHCP_RFC3397
 123 char *dname_dec(const uint8_t *cstr, int clen, const char *pre) FAST_FUNC;
 124 uint8_t *dname_enc(const uint8_t *cstr, int clen, const char *src, int *retlen) FAST_FUNC;
 125 #endif
 126
 127 POP_SAVED_FUNCTION_VISIBILITY
 128
 129 #endif