xref: /illumos-gate/usr/src/boot/libsa/bootp.h (revision 22028508fd28d36ff74dc02c5774a8ba1f0db045)
1 /*
2  * Bootstrap Protocol (BOOTP).  RFC951 and RFC1048.
3  *
4  * This file specifies the "implementation-independent" BOOTP protocol
5  * information which is common to both client and server.
6  *
7  * Copyright 1988 by Carnegie Mellon.
8  *
9  * Permission to use, copy, modify, and distribute this program for any
10  * purpose and without fee is hereby granted, provided that this copyright
11  * and permission notice appear on all copies and supporting documentation,
12  * the name of Carnegie Mellon not be used in advertising or publicity
13  * pertaining to distribution of the program without specific prior
14  * permission, and notice be given in supporting documentation that copying
15  * and distribution is by permission of Carnegie Mellon and Stanford
16  * University.  Carnegie Mellon makes no representations about the
17  * suitability of this software for any purpose.  It is provided "as is"
18  * without express or implied warranty.
19  */
20 
21 #ifndef _BOOTP_H_
22 #define	_BOOTP_H_
23 
24 #include <netinet/in.h>
25 
26 struct bootp {
27 	unsigned char	bp_op;		/* packet opcode type */
28 	unsigned char	bp_htype;	/* hardware addr type */
29 	unsigned char	bp_hlen;	/* hardware addr length */
30 	unsigned char	bp_hops;	/* gateway hops */
31 	unsigned int	bp_xid;		/* transaction ID */
32 	unsigned short	bp_secs;	/* seconds since boot began */
33 	unsigned short	bp_flags;
34 	struct in_addr	bp_ciaddr;	/* client IP address */
35 	struct in_addr	bp_yiaddr;	/* 'your' IP address */
36 	struct in_addr	bp_siaddr;	/* server IP address */
37 	struct in_addr	bp_giaddr;	/* gateway IP address */
38 	unsigned char	bp_chaddr[16];	/* client hardware address */
39 	unsigned char	bp_sname[64];	/* server host name */
40 	char	bp_file[128];		/* boot file name */
41 #ifdef SUPPORT_DHCP
42 #define	BOOTP_VENDSIZE 312
43 #else
44 #define	BOOTP_VENDSIZE 64
45 #endif
46 	unsigned char	bp_vend[BOOTP_VENDSIZE]; /* vendor-specific area */
47 };
48 
49 /*
50  * UDP port numbers, server and client.
51  */
52 #define	IPPORT_BOOTPS		67
53 #define	IPPORT_BOOTPC		68
54 
55 #define	BOOTREPLY		2
56 #define	BOOTREQUEST		1
57 
58 
59 /*
60  * Vendor magic cookie (v_magic) for CMU
61  */
62 #define	VM_CMU		"CMU"
63 
64 /*
65  * Vendor magic cookie (v_magic) for RFC1048
66  */
67 #define	VM_RFC1048	{ 99, 130, 83, 99 }
68 
69 /*
70  * RFC1048 tag values used to specify what information is being supplied in
71  * the vendor field of the packet.
72  */
73 
74 #define	TAG_PAD			((unsigned char)   0)
75 #define	TAG_SUBNET_MASK		((unsigned char)   1)
76 #define	TAG_TIME_OFFSET		((unsigned char)   2)
77 #define	TAG_GATEWAY		((unsigned char)   3)
78 #define	TAG_TIME_SERVER		((unsigned char)   4)
79 #define	TAG_NAME_SERVER		((unsigned char)   5)
80 #define	TAG_DOMAIN_SERVER	((unsigned char)   6)
81 #define	TAG_LOG_SERVER		((unsigned char)   7)
82 #define	TAG_COOKIE_SERVER	((unsigned char)   8)
83 #define	TAG_LPR_SERVER		((unsigned char)   9)
84 #define	TAG_IMPRESS_SERVER	((unsigned char)  10)
85 #define	TAG_RLP_SERVER		((unsigned char)  11)
86 #define	TAG_HOSTNAME		((unsigned char)  12)
87 #define	TAG_BOOTSIZE		((unsigned char)  13)
88 #define	TAG_DUMPFILE		((unsigned char)  14)
89 #define	TAG_DOMAINNAME		((unsigned char)  15)
90 #define	TAG_SWAPSERVER		((unsigned char)  16)
91 #define	TAG_ROOTPATH		((unsigned char)  17)
92 #define	TAG_INTF_MTU		((unsigned char)  26)
93 
94 #ifdef SUPPORT_DHCP
95 #define	TAG_REQ_ADDR		((unsigned char)  50)
96 #define	TAG_LEASETIME		((unsigned char)  51)
97 #define	TAG_OVERLOAD		((unsigned char)  52)
98 #define	TAG_DHCP_MSGTYPE	((unsigned char)  53)
99 #define	TAG_SERVERID		((unsigned char)  54)
100 #define	TAG_PARAM_REQ		((unsigned char)  55)
101 #define	TAG_MSG			((unsigned char)  56)
102 #define	TAG_MAXSIZE		((unsigned char)  57)
103 #define	TAG_T1			((unsigned char)  58)
104 #define	TAG_T2			((unsigned char)  59)
105 #define	TAG_CLASSID		((unsigned char)  60)
106 #define	TAG_CLIENTID		((unsigned char)  61)
107 #define	TAG_USER_CLASS		((unsigned char)  77)
108 #endif
109 
110 #define	TAG_END			((unsigned char) 255)
111 
112 #ifdef SUPPORT_DHCP
113 #define	DHCPDISCOVER 1
114 #define	DHCPOFFER 2
115 #define	DHCPREQUEST 3
116 #define	DHCPDECLINE 4
117 #define	DHCPACK 5
118 #define	DHCPNAK 6
119 #define	DHCPRELEASE 7
120 #endif
121 
122 /*
123  * "vendor" data permitted for CMU bootp clients.
124  */
125 
126 struct cmu_vend {
127 	unsigned char	v_magic[4];	/* magic number */
128 	unsigned int	v_flags;	/* flags/opcodes, etc. */
129 	struct in_addr	v_smask;	/* Subnet mask */
130 	struct in_addr	v_dgate;	/* Default gateway */
131 	struct in_addr	v_dns1, v_dns2; /* Domain name servers */
132 	struct in_addr	v_ins1, v_ins2; /* IEN-116 name servers */
133 	struct in_addr	v_ts1, v_ts2;	/* Time servers */
134 	unsigned char	v_unused[25];	/* currently unused */
135 };
136 
137 
138 /* v_flags values */
139 #define	VF_SMASK	1	/* Subnet mask field contains valid data */
140 
141 /* cached bootp response/dhcp ack */
142 extern struct bootp *bootp_response;
143 extern size_t bootp_response_size;
144 
145 #endif /* _BOOTP_H_ */
146