1 /* $OpenBSD: dhcpd.h,v 1.33 2004/05/06 22:29:15 deraadt Exp $ */
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.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
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''.
44 #include <sys/param.h>
46 #include <sys/socket.h>
47 #include <sys/sockio.h>
54 #include <net/if_dl.h>
55 #include <net/route.h>
57 #include <netinet/in.h>
58 #include <arpa/inet.h>
80 #define REMOTE_PORT 67
88 struct string_list *next;
94 unsigned char iabuf[16];
98 struct iaddrlist *next;
103 struct dhcp_packet *raw;
108 struct iaddr client_addr;
109 struct interface_info *interface;
110 struct hardware *haddr;
111 struct option_data options[256];
120 struct client_lease {
121 struct client_lease *next;
122 time_t expiry, renewal, rebind;
123 struct iaddr address;
126 struct string_list *medium;
127 unsigned int is_static : 1;
128 unsigned int is_bootp : 1;
129 struct option_data options[256];
132 /* Possible states in which the client can be. */
143 struct client_config {
144 struct option_data defaults[256];
150 } default_actions[256];
152 struct option_data send_options[256];
153 u_int8_t required_options[256];
154 u_int8_t requested_options[256];
155 int requested_option_count;
157 time_t initial_interval;
158 time_t retry_interval;
159 time_t select_interval;
160 time_t reboot_timeout;
161 time_t backoff_cutoff;
162 struct string_list *media;
164 enum { IGNORE, ACCEPT, PREFER }
166 struct string_list *medium;
167 struct iaddrlist *reject_list;
170 struct client_state {
171 struct client_lease *active;
172 struct client_lease *new;
173 struct client_lease *offered_leases;
174 struct client_lease *leases;
175 struct client_lease *alias;
176 enum dhcp_state state;
177 struct iaddr destination;
180 time_t first_sending;
182 struct string_list *medium;
183 struct dhcp_packet packet;
185 struct iaddr requested_address;
186 struct client_config *config;
189 struct string_list *env;
193 struct interface_info {
194 struct interface_info *next;
195 struct hardware hw_address;
196 struct in_addr primary_address;
206 struct client_state *client;
214 struct timeout *next;
216 void (*func)(void *);
221 struct protocol *next;
223 void (*handler)(struct protocol *);
227 #define DEFAULT_HASH_SIZE 97
230 struct hash_bucket *next;
233 unsigned char *value;
238 struct hash_bucket *buckets[DEFAULT_HASH_SIZE];
241 /* Default path to dhcpd config file. */
242 #define _PATH_DHCLIENT_CONF "/etc/dhclient.conf"
243 #define _PATH_DHCLIENT_DB "/var/db/dhclient.leases"
244 #define DHCPD_LOG_FACILITY LOG_DAEMON
246 #define MAX_TIME 0x7fffffff
249 /* External definitions... */
252 int cons_options(struct packet *, struct dhcp_packet *, int,
253 struct tree_cache **, int, int, int, u_int8_t *, int);
254 char *pretty_print_option(unsigned int,
255 unsigned char *, int, int, int);
256 void do_packet(struct interface_info *, struct dhcp_packet *,
257 int, unsigned int, struct iaddr, struct hardware *);
260 extern int warnings_occurred;
261 void error(char *, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
262 int warning(char *, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
263 int note(char *, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
264 int debug(char *, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
265 int parse_warn(char *, ...) __attribute__ ((__format__ (__printf__, 1, 2)));
268 extern int lexline, lexchar;
269 extern char *token_line, *tlname;
270 extern char comments[4096];
271 extern int comment_index;
272 extern int eol_token;
273 void new_parse(char *);
274 int next_token(char **, FILE *);
275 int peek_token(char **, FILE *);
278 void skip_to_semi(FILE *);
279 int parse_semi(FILE *);
280 char *parse_string(FILE *);
281 int parse_ip_addr(FILE *, struct iaddr *);
282 void parse_hardware_param(FILE *, struct hardware *);
283 void parse_lease_time(FILE *, time_t *);
284 unsigned char *parse_numeric_aggregate(FILE *, unsigned char *, int *,
286 void convert_num(unsigned char *, char *, int, int);
287 time_t parse_date(FILE *);
290 pair cons(caddr_t, pair);
293 struct string_list *new_string_list(size_t size);
294 struct hash_table *new_hash_table(int);
295 struct hash_bucket *new_hash_bucket(void);
298 int if_register_bpf(struct interface_info *);
299 void if_register_send(struct interface_info *);
300 void if_register_receive(struct interface_info *);
301 ssize_t send_packet(struct interface_info *, struct dhcp_packet *, size_t,
302 struct in_addr, struct sockaddr_in *, struct hardware *);
303 ssize_t receive_packet(struct interface_info *, unsigned char *, size_t,
304 struct sockaddr_in *, struct hardware *);
307 extern void (*bootp_packet_handler)(struct interface_info *,
308 struct dhcp_packet *, int, unsigned int, struct iaddr, struct hardware *);
309 void discover_interfaces(struct interface_info *);
310 void reinitialize_interfaces(void);
312 void got_one(struct protocol *);
313 void add_timeout(time_t, void (*)(void *), void *);
314 void cancel_timeout(void (*)(void *), void *);
315 void add_protocol(char *, int, void (*)(struct protocol *), void *);
316 void remove_protocol(struct protocol *);
317 int interface_link_status(char *);
320 struct hash_table *new_hash(void);
321 void add_hash(struct hash_table *, unsigned char *, int, unsigned char *);
322 unsigned char *hash_lookup(struct hash_table *, unsigned char *, int);
325 extern struct option dhcp_options[256];
326 extern unsigned char dhcp_option_default_priority_list[];
327 extern int sizeof_dhcp_option_default_priority_list;
328 extern struct hash_table universe_hash;
329 extern struct universe dhcp_universe;
330 void initialize_universes(void);
333 u_int32_t getULong(unsigned char *);
334 int32_t getLong(unsigned char *);
335 u_int16_t getUShort(unsigned char *);
336 int16_t getShort(unsigned char *);
337 void putULong(unsigned char *, u_int32_t);
338 void putLong(unsigned char *, int32_t);
339 void putUShort(unsigned char *, unsigned int);
340 void putShort(unsigned char *, int);
343 struct iaddr subnet_number(struct iaddr, struct iaddr);
344 struct iaddr broadcast_addr(struct iaddr, struct iaddr);
345 int addr_eq(struct iaddr, struct iaddr);
346 char *piaddr(struct iaddr);
349 extern char *path_dhclient_conf;
350 extern char *path_dhclient_db;
351 extern time_t cur_time;
352 extern int log_priority;
353 extern int log_perror;
355 extern struct client_config top_level_config;
357 extern struct pidfh *pidfile;
359 void dhcpoffer(struct packet *);
360 void dhcpack(struct packet *);
361 void dhcpnak(struct packet *);
363 void send_discover(void *);
364 void send_request(void *);
365 void send_decline(void *);
367 void state_reboot(void *);
368 void state_init(void *);
369 void state_selecting(void *);
370 void state_requesting(void *);
371 void state_bound(void *);
372 void state_panic(void *);
374 void bind_lease(struct interface_info *);
376 void make_discover(struct interface_info *, struct client_lease *);
377 void make_request(struct interface_info *, struct client_lease *);
378 void make_decline(struct interface_info *, struct client_lease *);
380 void free_client_lease(struct client_lease *);
381 void rewrite_client_leases(void);
382 void write_client_lease(struct interface_info *, struct client_lease *, int);
384 void priv_script_init(char *, char *);
385 void priv_script_write_params(char *, struct client_lease *);
386 int priv_script_go(void);
388 void script_init(char *, struct string_list *);
389 void script_write_params(char *, struct client_lease *);
391 void client_envadd(struct client_state *,
392 const char *, const char *, const char *, ...);
393 void script_set_env(struct client_state *, const char *, const char *,
395 void script_flush_env(struct client_state *);
396 int dhcp_option_ev_name(char *, size_t, struct option *);
398 struct client_lease *packet_to_lease(struct packet *);
399 void go_daemon(void);
400 void client_location_changed(void);
402 void bootp(struct packet *);
403 void dhcp(struct packet *);
406 void assemble_hw_header(struct interface_info *, unsigned char *,
407 int *, struct hardware *);
408 void assemble_udp_ip_header(unsigned char *, int *, u_int32_t, u_int32_t,
409 unsigned int, unsigned char *, int);
410 ssize_t decode_hw_header(unsigned char *, int, struct hardware *);
411 ssize_t decode_udp_ip_header(unsigned char *, int, struct sockaddr_in *,
412 unsigned char *, int);
415 void assemble_ethernet_header(struct interface_info *, unsigned char *,
416 int *, struct hardware *);
417 ssize_t decode_ethernet_header(struct interface_info *, unsigned char *,
418 int, struct hardware *);
421 int read_client_conf(void);
422 void read_client_leases(void);
423 void parse_client_statement(FILE *, struct interface_info *,
424 struct client_config *);
425 int parse_X(FILE *, u_int8_t *, int);
426 int parse_option_list(FILE *, u_int8_t *);
427 void parse_interface_declaration(FILE *, struct client_config *);
428 struct interface_info *interface_or_dummy(char *);
429 void make_client_state(struct interface_info *);
430 void make_client_config(struct interface_info *, struct client_config *);
431 void parse_client_lease_statement(FILE *, int);
432 void parse_client_lease_declaration(FILE *, struct client_lease *,
433 struct interface_info **);
434 struct option *parse_option_decl(FILE *, struct option_data *);
435 void parse_string_list(FILE *, struct string_list **, int);
436 void parse_reject_statement(FILE *, struct client_config *);
439 struct buf *buf_open(size_t);
440 int buf_add(struct buf *, void *, size_t);
441 int buf_close(int, struct buf *);
442 ssize_t buf_read(int, void *, size_t);
443 void dispatch_imsg(int);