udhcp: tweak udhcpd.conf example and comments. no code changes
[oweals/busybox.git] / networking / udhcp / files.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * files.c -- DHCP server file manipulation *
4  * Rewrite by Russ Dill <Russ.Dill@asu.edu> July 2001
5  *
6  * Licensed under GPLv2, see file LICENSE in this tarball for details.
7  */
8
9 #include <netinet/ether.h>
10
11 #include "common.h"
12 #include "dhcpd.h"
13 #include "options.h"
14
15 #if BB_LITTLE_ENDIAN
16 static inline uint64_t hton64(uint64_t v)
17 {
18         return (((uint64_t)htonl(v)) << 32) | htonl(v >> 32);
19 }
20 #else
21 #define hton64(v) (v)
22 #endif
23 #define ntoh64(v) hton64(v)
24
25
26 /* on these functions, make sure your datatype matches */
27 static int FAST_FUNC read_nip(const char *line, void *arg)
28 {
29         len_and_sockaddr *lsa;
30
31         lsa = host_and_af2sockaddr(line, 0, AF_INET);
32         if (!lsa)
33                 return 0;
34         *(uint32_t*)arg = lsa->u.sin.sin_addr.s_addr;
35         free(lsa);
36         return 1;
37 }
38
39
40 static int FAST_FUNC read_mac(const char *line, void *arg)
41 {
42         return NULL == ether_aton_r(line, (struct ether_addr *)arg);
43 }
44
45
46 static int FAST_FUNC read_str(const char *line, void *arg)
47 {
48         char **dest = arg;
49
50         free(*dest);
51         *dest = xstrdup(line);
52         return 1;
53 }
54
55
56 static int FAST_FUNC read_u32(const char *line, void *arg)
57 {
58         *(uint32_t*)arg = bb_strtou32(line, NULL, 10);
59         return errno == 0;
60 }
61
62
63 static int FAST_FUNC read_yn(const char *line, void *arg)
64 {
65         char *dest = arg;
66
67         if (!strcasecmp("yes", line)) {
68                 *dest = 1;
69                 return 1;
70         }
71         if (!strcasecmp("no", line)) {
72                 *dest = 0;
73                 return 1;
74         }
75         return 0;
76 }
77
78
79 /* find option 'code' in opt_list */
80 struct option_set* FAST_FUNC find_option(struct option_set *opt_list, uint8_t code)
81 {
82         while (opt_list && opt_list->data[OPT_CODE] < code)
83                 opt_list = opt_list->next;
84
85         if (opt_list && opt_list->data[OPT_CODE] == code)
86                 return opt_list;
87         return NULL;
88 }
89
90
91 /* add an option to the opt_list */
92 static void attach_option(struct option_set **opt_list,
93                 const struct dhcp_option *option, char *buffer, int length)
94 {
95         struct option_set *existing, *new, **curr;
96
97         existing = find_option(*opt_list, option->code);
98         if (!existing) {
99                 log2("Attaching option %02x to list", option->code);
100
101 #if ENABLE_FEATURE_UDHCP_RFC3397
102                 if ((option->flags & TYPE_MASK) == OPTION_STR1035)
103                         /* reuse buffer and length for RFC1035-formatted string */
104                         buffer = (char *)dname_enc(NULL, 0, buffer, &length);
105 #endif
106
107                 /* make a new option */
108                 new = xmalloc(sizeof(*new));
109                 new->data = xmalloc(length + 2);
110                 new->data[OPT_CODE] = option->code;
111                 new->data[OPT_LEN] = length;
112                 memcpy(new->data + 2, buffer, length);
113
114                 curr = opt_list;
115                 while (*curr && (*curr)->data[OPT_CODE] < option->code)
116                         curr = &(*curr)->next;
117
118                 new->next = *curr;
119                 *curr = new;
120 #if ENABLE_FEATURE_UDHCP_RFC3397
121                 if ((option->flags & TYPE_MASK) == OPTION_STR1035 && buffer != NULL)
122                         free(buffer);
123 #endif
124                 return;
125         }
126
127         /* add it to an existing option */
128         log1("Attaching option %02x to existing member of list", option->code);
129         if (option->flags & OPTION_LIST) {
130 #if ENABLE_FEATURE_UDHCP_RFC3397
131                 if ((option->flags & TYPE_MASK) == OPTION_STR1035)
132                         /* reuse buffer and length for RFC1035-formatted string */
133                         buffer = (char *)dname_enc(existing->data + 2,
134                                         existing->data[OPT_LEN], buffer, &length);
135 #endif
136                 if (existing->data[OPT_LEN] + length <= 255) {
137                         existing->data = xrealloc(existing->data,
138                                         existing->data[OPT_LEN] + length + 3);
139                         if ((option->flags & TYPE_MASK) == OPTION_STRING) {
140                                 /* ' ' can bring us to 256 - bad */
141                                 if (existing->data[OPT_LEN] + length >= 255)
142                                         return;
143                                 /* add space separator between STRING options in a list */
144                                 existing->data[existing->data[OPT_LEN] + 2] = ' ';
145                                 existing->data[OPT_LEN]++;
146                         }
147                         memcpy(existing->data + existing->data[OPT_LEN] + 2, buffer, length);
148                         existing->data[OPT_LEN] += length;
149                 } /* else, ignore the data, we could put this in a second option in the future */
150 #if ENABLE_FEATURE_UDHCP_RFC3397
151                 if ((option->flags & TYPE_MASK) == OPTION_STR1035 && buffer != NULL)
152                         free(buffer);
153 #endif
154         } /* else, ignore the new data */
155 }
156
157
158 /* read a dhcp option and add it to opt_list */
159 static int FAST_FUNC read_opt(const char *const_line, void *arg)
160 {
161         struct option_set **opt_list = arg;
162         char *opt, *val, *endptr;
163         char *line;
164         const struct dhcp_option *option;
165         int retval, length, idx;
166         char buffer[8] ALIGNED(4);
167         uint16_t *result_u16 = (uint16_t *) buffer;
168         uint32_t *result_u32 = (uint32_t *) buffer;
169
170         /* Cheat, the only const line we'll actually get is "" */
171         line = (char *) const_line;
172         opt = strtok(line, " \t=");
173         if (!opt)
174                 return 0;
175
176         idx = index_in_strings(dhcp_option_strings, opt); /* NB: was strcasecmp! */
177         if (idx < 0)
178                 return 0;
179         option = &dhcp_options[idx];
180
181         retval = 0;
182         do {
183                 val = strtok(NULL, ", \t");
184                 if (!val) break;
185                 length = dhcp_option_lengths[option->flags & TYPE_MASK];
186                 retval = 0;
187                 opt = buffer; /* new meaning for variable opt */
188                 switch (option->flags & TYPE_MASK) {
189                 case OPTION_IP:
190                         retval = read_nip(val, buffer);
191                         break;
192                 case OPTION_IP_PAIR:
193                         retval = read_nip(val, buffer);
194                         val = strtok(NULL, ", \t/-");
195                         if (!val)
196                                 retval = 0;
197                         if (retval)
198                                 retval = read_nip(val, buffer + 4);
199                         break;
200                 case OPTION_STRING:
201 #if ENABLE_FEATURE_UDHCP_RFC3397
202                 case OPTION_STR1035:
203 #endif
204                         length = strnlen(val, 254);
205                         if (length > 0) {
206                                 opt = val;
207                                 retval = 1;
208                         }
209                         break;
210                 case OPTION_BOOLEAN:
211                         retval = read_yn(val, buffer);
212                         break;
213                 case OPTION_U8:
214                         buffer[0] = strtoul(val, &endptr, 0);
215                         retval = (endptr[0] == '\0');
216                         break;
217                 /* htonX are macros in older libc's, using temp var
218                  * in code below for safety */
219                 /* TODO: use bb_strtoX? */
220                 case OPTION_U16: {
221                         unsigned long tmp = strtoul(val, &endptr, 0);
222                         *result_u16 = htons(tmp);
223                         retval = (endptr[0] == '\0' /*&& tmp < 0x10000*/);
224                         break;
225                 }
226                 case OPTION_S16: {
227                         long tmp = strtol(val, &endptr, 0);
228                         *result_u16 = htons(tmp);
229                         retval = (endptr[0] == '\0');
230                         break;
231                 }
232                 case OPTION_U32: {
233                         unsigned long tmp = strtoul(val, &endptr, 0);
234                         *result_u32 = htonl(tmp);
235                         retval = (endptr[0] == '\0');
236                         break;
237                 }
238                 case OPTION_S32: {
239                         long tmp = strtol(val, &endptr, 0);
240                         *result_u32 = htonl(tmp);
241                         retval = (endptr[0] == '\0');
242                         break;
243                 }
244                 default:
245                         break;
246                 }
247                 if (retval)
248                         attach_option(opt_list, option, opt, length);
249         } while (retval && option->flags & OPTION_LIST);
250         return retval;
251 }
252
253 static int FAST_FUNC read_staticlease(const char *const_line, void *arg)
254 {
255         char *line;
256         char *mac_string;
257         char *ip_string;
258         struct ether_addr mac_bytes;
259         uint32_t ip;
260
261         /* Read mac */
262         line = (char *) const_line;
263         mac_string = strtok_r(line, " \t", &line);
264         read_mac(mac_string, &mac_bytes);
265
266         /* Read ip */
267         ip_string = strtok_r(NULL, " \t", &line);
268         read_nip(ip_string, &ip);
269
270         add_static_lease(arg, (uint8_t*) &mac_bytes, ip);
271
272         log_static_leases(arg);
273
274         return 1;
275 }
276
277
278 struct config_keyword {
279         const char *keyword;
280         int (*handler)(const char *line, void *var) FAST_FUNC;
281         void *var;
282         const char *def;
283 };
284
285 static const struct config_keyword keywords[] = {
286         /* keyword       handler   variable address               default */
287         {"start",        read_nip, &(server_config.start_ip),     "192.168.0.20"},
288         {"end",          read_nip, &(server_config.end_ip),       "192.168.0.254"},
289         {"interface",    read_str, &(server_config.interface),    "eth0"},
290         /* Avoid "max_leases value not sane" warning by setting default
291          * to default_end_ip - default_start_ip + 1: */
292         {"max_leases",   read_u32, &(server_config.max_leases),   "235"},
293         {"auto_time",    read_u32, &(server_config.auto_time),    "7200"},
294         {"decline_time", read_u32, &(server_config.decline_time), "3600"},
295         {"conflict_time",read_u32, &(server_config.conflict_time),"3600"},
296         {"offer_time",   read_u32, &(server_config.offer_time),   "60"},
297         {"min_lease",    read_u32, &(server_config.min_lease_sec),"60"},
298         {"lease_file",   read_str, &(server_config.lease_file),   LEASES_FILE},
299         {"pidfile",      read_str, &(server_config.pidfile),      "/var/run/udhcpd.pid"},
300         {"siaddr",       read_nip, &(server_config.siaddr_nip),   "0.0.0.0"},
301         /* keywords with no defaults must be last! */
302         {"option",       read_opt, &(server_config.options),      ""},
303         {"opt",          read_opt, &(server_config.options),      ""},
304         {"notify_file",  read_str, &(server_config.notify_file),  ""},
305         {"sname",        read_str, &(server_config.sname),        ""},
306         {"boot_file",    read_str, &(server_config.boot_file),    ""},
307         {"static_lease", read_staticlease, &(server_config.static_leases), ""},
308 };
309 enum { KWS_WITH_DEFAULTS = ARRAY_SIZE(keywords) - 6 };
310
311 void FAST_FUNC read_config(const char *file)
312 {
313         parser_t *parser;
314         const struct config_keyword *k;
315         unsigned i;
316         char *token[2];
317
318         for (i = 0; i < KWS_WITH_DEFAULTS; i++)
319                 keywords[i].handler(keywords[i].def, keywords[i].var);
320
321         parser = config_open(file);
322         while (config_read(parser, token, 2, 2, "# \t", PARSE_NORMAL)) {
323                 for (k = keywords, i = 0; i < ARRAY_SIZE(keywords); k++, i++) {
324                         if (!strcasecmp(token[0], k->keyword)) {
325                                 if (!k->handler(token[1], k->var)) {
326                                         bb_error_msg("can't parse line %u in %s",
327                                                         parser->lineno, file);
328                                         /* reset back to the default value */
329                                         k->handler(k->def, k->var);
330                                 }
331                                 break;
332                         }
333                 }
334         }
335         config_close(parser);
336
337         server_config.start_ip = ntohl(server_config.start_ip);
338         server_config.end_ip = ntohl(server_config.end_ip);
339 }
340
341
342 void FAST_FUNC write_leases(void)
343 {
344         int fd;
345         unsigned i;
346         leasetime_t curr;
347         int64_t written_at;
348
349         fd = open_or_warn(server_config.lease_file, O_WRONLY|O_CREAT|O_TRUNC);
350         if (fd < 0)
351                 return;
352
353         curr = written_at = time(NULL);
354
355         written_at = hton64(written_at);
356         full_write(fd, &written_at, sizeof(written_at));
357
358         for (i = 0; i < server_config.max_leases; i++) {
359                 leasetime_t tmp_time;
360
361                 if (g_leases[i].lease_nip == 0)
362                         continue;
363
364                 /* Screw with the time in the struct, for easier writing */
365                 tmp_time = g_leases[i].expires;
366
367                 g_leases[i].expires -= curr;
368                 if ((signed_leasetime_t) g_leases[i].expires < 0)
369                         g_leases[i].expires = 0;
370                 g_leases[i].expires = htonl(g_leases[i].expires);
371
372                 /* No error check. If the file gets truncated,
373                  * we lose some leases on restart. Oh well. */
374                 full_write(fd, &g_leases[i], sizeof(g_leases[i]));
375
376                 /* Then restore it when done */
377                 g_leases[i].expires = tmp_time;
378         }
379         close(fd);
380
381         if (server_config.notify_file) {
382 // TODO: vfork-based child creation
383                 char *cmd = xasprintf("%s %s", server_config.notify_file, server_config.lease_file);
384                 system(cmd);
385                 free(cmd);
386         }
387 }
388
389
390 void FAST_FUNC read_leases(const char *file)
391 {
392         struct dyn_lease lease;
393         int64_t written_at, time_passed;
394         int fd;
395 #if defined CONFIG_UDHCP_DEBUG && CONFIG_UDHCP_DEBUG >= 1
396         unsigned i = 0;
397 #endif
398
399         fd = open_or_warn(file, O_RDONLY);
400         if (fd < 0)
401                 return;
402
403         if (full_read(fd, &written_at, sizeof(written_at)) != sizeof(written_at))
404                 goto ret;
405         written_at = ntoh64(written_at);
406
407         time_passed = time(NULL) - written_at;
408         /* Strange written_at, or lease file from old version of udhcpd
409          * which had no "written_at" field? */
410         if ((uint64_t)time_passed > 12 * 60 * 60)
411                 goto ret;
412
413         while (full_read(fd, &lease, sizeof(lease)) == sizeof(lease)) {
414 //FIXME: what if it matches some static lease?
415                 uint32_t y = ntohl(lease.lease_nip);
416                 if (y >= server_config.start_ip && y <= server_config.end_ip) {
417                         signed_leasetime_t expires = ntohl(lease.expires) - (signed_leasetime_t)time_passed;
418                         if (expires <= 0)
419                                 continue;
420                         /* NB: add_lease takes "relative time", IOW,
421                          * lease duration, not lease deadline. */
422                         if (add_lease(lease.lease_mac, lease.lease_nip,
423                                         expires,
424                                         lease.hostname, sizeof(lease.hostname)
425                                 ) == 0
426                         ) {
427                                 bb_error_msg("too many leases while loading %s", file);
428                                 break;
429                         }
430 #if defined CONFIG_UDHCP_DEBUG && CONFIG_UDHCP_DEBUG >= 1
431                         i++;
432 #endif
433                 }
434         }
435         log1("Read %d leases", i);
436  ret:
437         close(fd);
438 }