sbin/dhclient/dhcp.h

   1 /*      $OpenBSD: dhcp.h,v 1.5 2004/05/04 15:49:49 deraadt Exp $        */
   2 /*      $FreeBSD$       */
   3
   4 /* Protocol structures... */
   5
   6 /*-
   7  * SPDX-License-Identifier: BSD-3-Clause
   8  *
   9  * Copyright (c) 1995, 1996 The Internet Software Consortium.
  10  * All rights reserved.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  *
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  * 3. Neither the name of The Internet Software Consortium nor the names
  22  *    of its contributors may be used to endorse or promote products derived
  23  *    from this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND
  26  * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
  27  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  28  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  29  * DISCLAIMED.  IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR
  30  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  31  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  32  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  33  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  34  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  35  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  36  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  * This software has been written for the Internet Software Consortium
  40  * by Ted Lemon <mellon@fugue.com> in cooperation with Vixie
  41  * Enterprises.  To learn more about the Internet Software Consortium,
  42  * see ``http://www.vix.com/isc''.  To learn more about Vixie
  43  * Enterprises, see ``http://www.vix.com''.
  44  */
  45
  46 #define DHCP_UDP_OVERHEAD       (14 + /* Ethernet header */     \
  47                                  20 + /* IP header */           \
  48                                  8)   /* UDP header */
  49 #define DHCP_SNAME_LEN          64
  50 #define DHCP_FILE_LEN           128
  51 #define DHCP_FIXED_NON_UDP      236
  52 #define DHCP_FIXED_LEN          (DHCP_FIXED_NON_UDP + DHCP_UDP_OVERHEAD)
  53                                                 /* Everything but options. */
  54 #define DHCP_MTU_MAX            1500
  55 #define DHCP_OPTION_LEN         (DHCP_MTU_MAX - DHCP_FIXED_LEN)
  56
  57 #define BOOTP_MIN_LEN           300
  58 #define DHCP_MIN_LEN            548
  59
  60 struct dhcp_packet {
  61         u_int8_t  op;           /* Message opcode/type */
  62         u_int8_t  htype;        /* Hardware addr type (see net/if_types.h) */
  63         u_int8_t  hlen;         /* Hardware addr length */
  64         u_int8_t  hops;         /* Number of relay agent hops from client */
  65         u_int32_t xid;          /* Transaction ID */
  66         u_int16_t secs;         /* Seconds since client started looking */
  67         u_int16_t flags;        /* Flag bits */
  68         struct in_addr ciaddr;  /* Client IP address (if already in use) */
  69         struct in_addr yiaddr;  /* Client IP address */
  70         struct in_addr siaddr;  /* IP address of next server to talk to */
  71         struct in_addr giaddr;  /* DHCP relay agent IP address */
  72         unsigned char chaddr[16];       /* Client hardware address */
  73         char sname[DHCP_SNAME_LEN];     /* Server name */
  74         char file[DHCP_FILE_LEN];       /* Boot filename */
  75         unsigned char options[DHCP_OPTION_LEN];
  76                                 /* Optional parameters
  77                                    (actual length dependent on MTU). */
  78 };
  79
  80 /* BOOTP (rfc951) message types */
  81 #define BOOTREQUEST     1
  82 #define BOOTREPLY       2
  83
  84 /* Possible values for flags field... */
  85 #define BOOTP_BROADCAST 32768L
  86
  87 /* Possible values for hardware type (htype) field... */
  88 #define HTYPE_ETHER     1               /* Ethernet                     */
  89 #define HTYPE_IEEE802   6               /* IEEE 802.2 Token Ring...     */
  90 #define HTYPE_FDDI      8               /* FDDI...                      */
  91
  92 /* Magic cookie validating dhcp options field (and bootp vendor
  93    extensions field). */
  94 #define DHCP_OPTIONS_COOKIE     "\143\202\123\143"
  95
  96 /* DHCP Option codes: */
  97
  98 #define DHO_PAD                         0
  99 #define DHO_SUBNET_MASK                 1
 100 #define DHO_TIME_OFFSET                 2
 101 #define DHO_ROUTERS                     3
 102 #define DHO_TIME_SERVERS                4
 103 #define DHO_NAME_SERVERS                5
 104 #define DHO_DOMAIN_NAME_SERVERS         6
 105 #define DHO_LOG_SERVERS                 7
 106 #define DHO_COOKIE_SERVERS              8
 107 #define DHO_LPR_SERVERS                 9
 108 #define DHO_IMPRESS_SERVERS             10
 109 #define DHO_RESOURCE_LOCATION_SERVERS   11
 110 #define DHO_HOST_NAME                   12
 111 #define DHO_BOOT_SIZE                   13
 112 #define DHO_MERIT_DUMP                  14
 113 #define DHO_DOMAIN_NAME                 15
 114 #define DHO_SWAP_SERVER                 16
 115 #define DHO_ROOT_PATH                   17
 116 #define DHO_EXTENSIONS_PATH             18
 117 #define DHO_IP_FORWARDING               19
 118 #define DHO_NON_LOCAL_SOURCE_ROUTING    20
 119 #define DHO_POLICY_FILTER               21
 120 #define DHO_MAX_DGRAM_REASSEMBLY        22
 121 #define DHO_DEFAULT_IP_TTL              23
 122 #define DHO_PATH_MTU_AGING_TIMEOUT      24
 123 #define DHO_PATH_MTU_PLATEAU_TABLE      25
 124 #define DHO_INTERFACE_MTU               26
 125 #define DHO_ALL_SUBNETS_LOCAL           27
 126 #define DHO_BROADCAST_ADDRESS           28
 127 #define DHO_PERFORM_MASK_DISCOVERY      29
 128 #define DHO_MASK_SUPPLIER               30
 129 #define DHO_ROUTER_DISCOVERY            31
 130 #define DHO_ROUTER_SOLICITATION_ADDRESS 32
 131 #define DHO_STATIC_ROUTES               33
 132 #define DHO_TRAILER_ENCAPSULATION       34
 133 #define DHO_ARP_CACHE_TIMEOUT           35
 134 #define DHO_IEEE802_3_ENCAPSULATION     36
 135 #define DHO_DEFAULT_TCP_TTL             37
 136 #define DHO_TCP_KEEPALIVE_INTERVAL      38
 137 #define DHO_TCP_KEEPALIVE_GARBAGE       39
 138 #define DHO_NIS_DOMAIN                  40
 139 #define DHO_NIS_SERVERS                 41
 140 #define DHO_NTP_SERVERS                 42
 141 #define DHO_VENDOR_ENCAPSULATED_OPTIONS 43
 142 #define DHO_NETBIOS_NAME_SERVERS        44
 143 #define DHO_NETBIOS_DD_SERVER           45
 144 #define DHO_NETBIOS_NODE_TYPE           46
 145 #define DHO_NETBIOS_SCOPE               47
 146 #define DHO_FONT_SERVERS                48
 147 #define DHO_X_DISPLAY_MANAGER           49
 148 #define DHO_DHCP_REQUESTED_ADDRESS      50
 149 #define DHO_DHCP_LEASE_TIME             51
 150 #define DHO_DHCP_OPTION_OVERLOAD        52
 151 #define DHO_DHCP_MESSAGE_TYPE           53
 152 #define DHO_DHCP_SERVER_IDENTIFIER      54
 153 #define DHO_DHCP_PARAMETER_REQUEST_LIST 55
 154 #define DHO_DHCP_MESSAGE                56
 155 #define DHO_DHCP_MAX_MESSAGE_SIZE       57
 156 #define DHO_DHCP_RENEWAL_TIME           58
 157 #define DHO_DHCP_REBINDING_TIME         59
 158 #define DHO_DHCP_CLASS_IDENTIFIER       60
 159 #define DHO_DHCP_CLIENT_IDENTIFIER      61
 160 #define DHO_NISPLUS_DOMAIN              64
 161 #define DHO_NISPLUS_SERVERS             65
 162 #define DHO_TFTP_SERVER_NAME            66
 163 #define DHO_BOOTFILE_NAME               67
 164 #define DHO_MOBILE_IP_HOME_AGENT        68
 165 #define DHO_SMTP_SERVER                 69
 166 #define DHO_POP_SERVER                  70
 167 #define DHO_NNTP_SERVER                 71
 168 #define DHO_WWW_SERVER                  72
 169 #define DHO_FINGER_SERVER               73
 170 #define DHO_IRC_SERVER                  74
 171 #define DHO_STREETTALK_SERVER           75
 172 #define DHO_STREETTALK_DA_SERVER        76
 173 #define DHO_DHCP_USER_CLASS_ID          77
 174 #define DHO_URL                         114
 175 #define DHO_DOMAIN_SEARCH               119
 176 #define DHO_CLASSLESS_ROUTES            121
 177 #define DHO_END                         255
 178
 179 /* DHCP message types. */
 180 #define DHCPDISCOVER    1
 181 #define DHCPOFFER       2
 182 #define DHCPREQUEST     3
 183 #define DHCPDECLINE     4
 184 #define DHCPACK         5
 185 #define DHCPNAK         6
 186 #define DHCPRELEASE     7
 187 #define DHCPINFORM      8