dhclient - Drop medium/alias useless utilization.
[dragonfly.git] / sbin / dhclient / dhcpd.h
CommitLineData
f155048f 1/* $OpenBSD: src/sbin/dhclient/dhcpd.h,v 1.72 2011/04/04 11:14:52 krw Exp $ */
846204b6
HT
2
3/*
4 * Copyright (c) 2004 Henning Brauer <henning@openbsd.org>
5 * Copyright (c) 1995, 1996, 1997, 1998, 1999
6 * The Internet Software Consortium. All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of The Internet Software Consortium nor the names
18 * of its contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND
22 * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
23 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 * DISCLAIMED. IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR
26 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
29 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * This software has been written for the Internet Software Consortium
36 * by Ted Lemon <mellon@fugue.com> in cooperation with Vixie
37 * Enterprises. To learn more about the Internet Software Consortium,
38 * see ``http://www.vix.com/isc''. To learn more about Vixie
39 * Enterprises, see ``http://www.vix.com''.
40 */
41
42#include <sys/socket.h>
43#include <sys/sockio.h>
44#include <sys/stat.h>
45#include <sys/time.h>
46#include <sys/types.h>
47#include <sys/wait.h>
48
49#include <arpa/inet.h>
50#include <net/if.h>
51#include <net/if_dl.h>
52#include <net/route.h>
53#include <netinet/in.h>
b1dd9915 54#include <netinet/if_ether.h>
846204b6
HT
55
56#include <ctype.h>
57#include <errno.h>
58#include <fcntl.h>
59#include <limits.h>
60#include <netdb.h>
61#include <paths.h>
62#include <stdarg.h>
63#include <stdio.h>
64#include <stdlib.h>
65#include <string.h>
66#include <syslog.h>
67#include <time.h>
68#include <unistd.h>
69
70#include "dhcp.h"
71
72#define LOCAL_PORT 68
73#define REMOTE_PORT 67
74
75struct option {
76 char *name;
77 char *format;
78};
79
80struct option_data {
81 unsigned int len;
82 u_int8_t *data;
83};
84
85struct string_list {
86 struct string_list *next;
87 char string[1]; /* Actually bigger. */
88};
89
90struct iaddr {
91 int len;
92 unsigned char iabuf[16];
93};
94
95struct iaddrlist {
96 struct iaddrlist *next;
97 struct iaddr addr;
98};
99
100struct hardware {
101 u_int8_t htype;
102 u_int8_t hlen;
103 u_int8_t haddr[16];
104};
105
106struct client_lease {
107 struct client_lease *next;
108 time_t expiry, renewal, rebind;
109 struct iaddr address;
110 char *server_name;
111 char *filename;
846204b6
HT
112 unsigned int is_static : 1;
113 unsigned int is_bootp : 1;
114 struct option_data options[256];
115};
116
117/* Possible states in which the client can be. */
118enum dhcp_state {
119 S_REBOOTING,
120 S_INIT,
121 S_SELECTING,
122 S_REQUESTING,
123 S_BOUND,
124 S_RENEWING,
125 S_REBINDING
126};
127
128struct client_config {
129 struct option_data defaults[256];
130 enum {
131 ACTION_DEFAULT,
132 ACTION_SUPERSEDE,
133 ACTION_PREPEND,
134 ACTION_APPEND
135 } default_actions[256];
136
137 struct option_data send_options[256];
138 u_int8_t required_options[256];
139 u_int8_t requested_options[256];
140 int requested_option_count;
141 time_t timeout;
142 time_t initial_interval;
143 time_t link_timeout;
144 time_t retry_interval;
145 time_t select_interval;
146 time_t reboot_timeout;
147 time_t backoff_cutoff;
846204b6
HT
148 char *script_name;
149 enum { IGNORE, ACCEPT, PREFER }
150 bootp_policy;
846204b6
HT
151 struct iaddrlist *reject_list;
152};
153
154struct client_state {
155 struct client_lease *active;
156 struct client_lease *new;
157 struct client_lease *offered_leases;
158 struct client_lease *leases;
846204b6
HT
159 enum dhcp_state state;
160 struct iaddr destination;
161 u_int32_t xid;
162 u_int16_t secs;
163 time_t first_sending;
164 time_t interval;
846204b6
HT
165 struct dhcp_packet packet;
166 int packet_length;
167 struct iaddr requested_address;
168 char **scriptEnv;
169 int scriptEnvsize;
170};
171
172struct interface_info {
173 struct hardware hw_address;
174 struct in_addr primary_address;
175 char name[IFNAMSIZ];
176 int rfdesc;
177 int wfdesc;
178 int ufdesc; /* unicast */
179 unsigned char *rbuf;
180 size_t rbuf_max;
181 size_t rbuf_offset;
182 size_t rbuf_len;
183 struct ifreq *ifp;
184 int noifmedia;
185 int errors;
186 u_int16_t index;
187 int linkstat;
188};
189
190struct timeout {
191 struct timeout *next;
192 time_t when;
193 void (*func)(void);
194};
195
196#define _PATH_DHCLIENT_CONF "/etc/dhclient.conf"
197#define _PATH_DHCLIENT_DB "/var/db/dhclient.leases"
198#define _PATH_DHCLIENT_SCRIPT "/sbin/dhclient-script"
199#define DHCPD_LOG_FACILITY LOG_DAEMON
200
201/* External definitions... */
202
203extern struct interface_info *ifi;
204extern struct client_state *client;
205extern struct client_config *config;
206
207/* options.c */
208int cons_options(unsigned char *, const int, struct option_data *);
209char *pretty_print_option(unsigned int, unsigned char *, int, int, int);
210void do_packet(int, unsigned int, struct iaddr, struct hardware *);
211
212/* errwarn.c */
213extern int warnings_occurred;
214void error(char *, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
215int warning(char *, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
216int note(char *, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
84c21dc9 217#ifdef DEBUG
846204b6 218int debug(char *, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
84c21dc9 219#endif
846204b6
HT
220int parse_warn(char *, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
221
222/* conflex.c */
223extern int lexline, lexchar;
224extern char *token_line, *tlname;
225void new_parse(char *);
226int next_token(char **, FILE *);
227int peek_token(char **, FILE *);
228
229/* parse.c */
230void skip_to_semi(FILE *);
231int parse_semi(FILE *);
232char *parse_string(FILE *);
233int parse_ip_addr(FILE *, struct iaddr *);
234void parse_hardware_param(FILE *, struct hardware *);
235void parse_lease_time(FILE *, time_t *);
236int parse_numeric_aggregate(FILE *, unsigned char *, int, int, int);
237void convert_num(unsigned char *, char *, int, int);
238time_t parse_date(FILE *);
239
240/* bpf.c */
241int if_register_bpf(void);
242void if_register_send(void);
243void if_register_receive(void);
244ssize_t send_packet(struct in_addr, struct sockaddr_in *, struct hardware *);
245ssize_t receive_packet(struct sockaddr_in *, struct hardware *);
246
247/* dispatch.c */
248void discover_interface(void);
249void reinitialize_interface(void);
250void dispatch(void);
251void got_one(void);
252void add_timeout(time_t, void (*)(void));
253void cancel_timeout(void (*)(void));
254int interface_status(char *);
255int interface_link_status(char *);
256int interface_link_forceup(char *);
846204b6
HT
257
258/* tables.c */
259extern const struct option dhcp_options[256];
260
261/* convert.c */
262u_int32_t getULong(unsigned char *);
263int32_t getLong(unsigned char *);
264u_int16_t getUShort(unsigned char *);
265int16_t getShort(unsigned char *);
266void putULong(unsigned char *, u_int32_t);
267void putLong(unsigned char *, int32_t);
268void putUShort(unsigned char *, unsigned int);
269void putShort(unsigned char *, int);
270
271/* inet.c */
272struct iaddr subnet_number(struct iaddr, struct iaddr);
273struct iaddr broadcast_addr(struct iaddr, struct iaddr);
274int addr_eq(struct iaddr, struct iaddr);
275char *piaddr(struct iaddr);
276
277/* dhclient.c */
278extern char *path_dhclient_conf;
279extern char *path_dhclient_db;
280extern time_t cur_time;
281extern int log_perror;
282extern int routefd;
283
284void dhcpoffer(struct iaddr, struct option_data *);
285void dhcpack(struct iaddr, struct option_data *);
286void dhcpnak(struct iaddr, struct option_data *);
287
288void send_discover(void);
289void send_request(void);
290void send_decline(void);
291
292void state_reboot(void);
293void state_init(void);
294void state_selecting(void);
295void state_bound(void);
296void state_panic(void);
297
298void bind_lease(void);
299
300void make_discover(struct client_lease *);
301void make_request(struct client_lease *);
302void make_decline(struct client_lease *);
303
304void free_client_lease(struct client_lease *);
305void rewrite_client_leases(void);
306void write_client_lease(struct client_lease *, int);
307
f155048f 308void priv_script_init(char *);
846204b6
HT
309void priv_script_write_params(char *, struct client_lease *);
310int priv_script_go(void);
311
f155048f 312void script_init(char *);
846204b6
HT
313void script_write_params(char *, struct client_lease *);
314int script_go(void);
315void script_set_env(const char *, const char *, const char *);
316void script_flush_env(void);
317int dhcp_option_ev_name(char *, size_t, const struct option *);
318
319struct client_lease *packet_to_lease(struct option_data *);
320void go_daemon(void);
321
322void routehandler(void);
323
324/* packet.c */
325void assemble_hw_header(unsigned char *, int *, struct hardware *);
326void assemble_udp_ip_header(unsigned char *, int *, u_int32_t, u_int32_t,
327 unsigned int, unsigned char *, int);
328ssize_t decode_hw_header(unsigned char *, int, struct hardware *);
329ssize_t decode_udp_ip_header(unsigned char *, int, struct sockaddr_in *,
330 unsigned char *, int);
331
332/* clparse.c */
333int read_client_conf(void);
334void read_client_leases(void);
335void parse_client_statement(FILE *);
336int parse_X(FILE *, u_int8_t *, int);
337int parse_option_list(FILE *, u_int8_t *);
338void parse_interface_declaration(FILE *);
339void parse_client_lease_statement(FILE *, int);
340void parse_client_lease_declaration(FILE *, struct client_lease *);
341int parse_option_decl(FILE *, struct option_data *);
342void parse_string_list(FILE *, struct string_list **, int);
343void parse_reject_statement(FILE *);