xref: /dragonfly/contrib/dhcpcd/src/if-options.h (revision 6a6d63c5317abf314a78f8c8300ef73c2bc0c39e)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * dhcpcd - DHCP client daemon
4  * Copyright (c) 2006-2023 Roy Marples <roy@marples.name>
5  * All rights reserved
6 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef IF_OPTIONS_H
30 #define IF_OPTIONS_H
31 
32 #include <sys/param.h>
33 #include <sys/socket.h>
34 #include <net/if.h>
35 #include <netinet/in.h>
36 
37 #include <getopt.h>
38 #include <limits.h>
39 #include <stdint.h>
40 
41 #include "auth.h"
42 #include "route.h"
43 
44 /* Don't set any optional arguments here so we retain POSIX
45  * compatibility with getopt */
46 #define IF_OPTS "146bc:de:f:gh:i:j:kl:m:no:pqr:s:t:u:v:wxy:z:" \
47                     "ABC:DEF:GHI:JKLMNO:PQ:S:TUVW:X:Z:"
48 #define NOERR_IF_OPTS                   ":" IF_OPTS
49 
50 #define DEFAULT_TIMEOUT                 30
51 #define DEFAULT_REBOOT                  5
52 #define DEFAULT_REQUEST                 180       /* secs to request, mirror DHCP6 */
53 #define DEFAULT_FALLBACK      5         /* secs until fallback */
54 #define DEFAULT_IPV4LL                  5         /* secs until ipv4ll */
55 
56 #ifndef HOSTNAME_MAX_LEN
57 #define HOSTNAME_MAX_LEN      250       /* 255 - 3 (FQDN) - 2 (DNS enc) */
58 #endif
59 #define VENDORCLASSID_MAX_LEN 255
60 #define CLIENTID_MAX_LEN      48
61 #define USERCLASS_MAX_LEN     255
62 #define VENDOR_MAX_LEN                  255
63 #define   MUDURL_MAX_LEN                255
64 
65 #define DHCPCD_ARP                      (1ULL << 0)
66 #define DHCPCD_RELEASE                            (1ULL << 1)
67 #define DHCPCD_RTBUILD                            (1ULL << 2)
68 #define DHCPCD_GATEWAY                            (1ULL << 3)
69 #define DHCPCD_STATIC                             (1ULL << 4)
70 #define DHCPCD_DEBUG                              (1ULL << 5)
71 #define DHCPCD_ARP_PERSISTDEFENCE       (1ULL << 6)
72 #define DHCPCD_LASTLEASE                (1ULL << 7)
73 #define DHCPCD_INFORM                             (1ULL << 8)
74 #define DHCPCD_REQUEST                            (1ULL << 9)
75 #define DHCPCD_IPV4LL                             (1ULL << 10)
76 #define DHCPCD_DUID                     (1ULL << 11)
77 #define DHCPCD_PERSISTENT               (1ULL << 12)
78 #define DHCPCD_DAEMONISE                (1ULL << 14)
79 #define DHCPCD_DAEMONISED               (1ULL << 15)
80 #define DHCPCD_TEST                     (1ULL << 16)
81 #define DHCPCD_MANAGER                            (1ULL << 17)
82 #define DHCPCD_HOSTNAME                           (1ULL << 18)
83 #define DHCPCD_CLIENTID                           (1ULL << 19)
84 #define DHCPCD_LINK                     (1ULL << 20)
85 #define DHCPCD_ANONYMOUS                (1ULL << 21)
86 #define DHCPCD_BACKGROUND               (1ULL << 22)
87 #define DHCPCD_VENDORRAW                (1ULL << 23)
88 #define DHCPCD_NOWAITIP                           (1ULL << 24) /* To force daemonise */
89 #define DHCPCD_WAITIP                             (1ULL << 25)
90 #define DHCPCD_SLAACPRIVATE             (1ULL << 26)
91 #define DHCPCD_CSR_WARNED               (1ULL << 27)
92 #define DHCPCD_XID_HWADDR               (1ULL << 28)
93 #define DHCPCD_BROADCAST                (1ULL << 29)
94 #define DHCPCD_DUMPLEASE                (1ULL << 30)
95 #define DHCPCD_IPV6RS                             (1ULL << 31)
96 #define DHCPCD_IPV6RA_REQRDNSS                    (1ULL << 32)
97 #define DHCPCD_PRIVSEP                            (1ULL << 33)
98 #define DHCPCD_CONFIGURE                (1ULL << 34)
99 #define DHCPCD_IPV4                     (1ULL << 35)
100 #define DHCPCD_FORKED                             (1ULL << 36)
101 #define DHCPCD_IPV6                     (1ULL << 37)
102 #define DHCPCD_STARTED                            (1ULL << 38)
103 #define DHCPCD_NOALIAS                            (1ULL << 39)
104 #define DHCPCD_IA_FORCED                (1ULL << 40)
105 #define DHCPCD_STOPPING                           (1ULL << 41)
106 #define DHCPCD_LAUNCHER                           (1ULL << 42)
107 #define DHCPCD_HOSTNAME_SHORT           (1ULL << 43)
108 #define DHCPCD_EXITING                            (1ULL << 44)
109 #define DHCPCD_WAITIP4                            (1ULL << 45)
110 #define DHCPCD_WAITIP6                            (1ULL << 46)
111 #define DHCPCD_DEV                      (1ULL << 47)
112 #define DHCPCD_IAID                     (1ULL << 48)
113 #define DHCPCD_DHCP                     (1ULL << 49)
114 #define DHCPCD_DHCP6                              (1ULL << 50)
115 #define DHCPCD_IF_UP                              (1ULL << 51)
116 #define DHCPCD_INFORM6                            (1ULL << 52)
117 #define DHCPCD_WANTDHCP                           (1ULL << 53)
118 #define DHCPCD_IPV6RA_AUTOCONF                    (1ULL << 54)
119 #define DHCPCD_ROUTER_HOST_ROUTE_WARNED (1ULL << 55)
120 #define DHCPCD_LASTLEASE_EXTEND                   (1ULL << 56)
121 #define DHCPCD_BOOTP                              (1ULL << 57)
122 #define DHCPCD_INITIAL_DELAY            (1ULL << 58)
123 #define DHCPCD_PRINT_PIDFILE            (1ULL << 59)
124 #define DHCPCD_ONESHOT                            (1ULL << 60)
125 #define DHCPCD_INACTIVE                           (1ULL << 61)
126 #define   DHCPCD_SLAACTEMP              (1ULL << 62)
127 #define DHCPCD_PRIVSEPROOT              (1ULL << 63)
128 
129 #define DHCPCD_NODROP         (DHCPCD_EXITING | DHCPCD_PERSISTENT)
130 
131 #define DHCPCD_WAITOPTS       (DHCPCD_WAITIP | DHCPCD_WAITIP4 | DHCPCD_WAITIP6)
132 
133 #define DHCPCD_WARNINGS       (DHCPCD_CSR_WARNED | \
134                     DHCPCD_ROUTER_HOST_ROUTE_WARNED)
135 
136 /* These options only make sense in the config file, so don't use any
137    valid short options for them */
138 #define O_BASE                          MAX('z', 'Z') + 1
139 #define O_ARPING              O_BASE + 1
140 #define O_FALLBACK            O_BASE + 2
141 #define O_DESTINATION                   O_BASE + 3
142 #define O_IPV6RS              O_BASE + 4
143 #define O_NOIPV6RS            O_BASE + 5
144 #define O_IPV6RA_FORK                   O_BASE + 6
145 #define O_LINK_RCVBUF                   O_BASE + 7
146 #define O_ANONYMOUS           O_BASE + 8
147 #define O_NOALIAS             O_BASE + 9
148 #define O_IA_NA                         O_BASE + 10
149 #define O_IA_TA                         O_BASE + 11
150 #define O_IA_PD                         O_BASE + 12
151 #define O_HOSTNAME_SHORT      O_BASE + 13
152 #define O_DEV                           O_BASE + 14
153 #define O_NODEV                         O_BASE + 15
154 #define O_NOIPV4              O_BASE + 16
155 #define O_NOIPV6              O_BASE + 17
156 #define O_IAID                          O_BASE + 18
157 #define O_DEFINE              O_BASE + 19
158 #define O_DEFINE6             O_BASE + 20
159 #define O_EMBED                         O_BASE + 21
160 #define O_ENCAP                         O_BASE + 22
161 #define O_VENDOPT             O_BASE + 23
162 #define O_VENDCLASS           O_BASE + 24
163 #define O_AUTHPROTOCOL                  O_BASE + 25
164 #define O_AUTHTOKEN           O_BASE + 26
165 #define O_AUTHNOTREQUIRED     O_BASE + 27
166 #define O_NODHCP              O_BASE + 28
167 #define O_NODHCP6             O_BASE + 29
168 #define O_DHCP                          O_BASE + 30
169 #define O_DHCP6                         O_BASE + 31
170 #define O_IPV4                          O_BASE + 32
171 #define O_IPV6                          O_BASE + 33
172 #define O_CONTROLGRP                    O_BASE + 34
173 #define O_SLAAC                         O_BASE + 35
174 #define O_GATEWAY             O_BASE + 36
175 #define O_NOUP                          O_BASE + 37
176 #define O_IPV6RA_AUTOCONF     O_BASE + 38
177 #define O_IPV6RA_NOAUTOCONF   O_BASE + 39
178 #define O_REJECT              O_BASE + 40
179 #define O_BOOTP                         O_BASE + 42
180 #define O_DEFINEND            O_BASE + 43
181 #define O_NODELAY             O_BASE + 44
182 #define O_INFORM6             O_BASE + 45
183 #define O_LASTLEASE_EXTEND    O_BASE + 46
184 #define O_INACTIVE            O_BASE + 47
185 #define O_MUDURL              O_BASE + 48
186 #define O_MSUSERCLASS                   O_BASE + 49
187 #define O_CONFIGURE           O_BASE + 50
188 #define O_NOCONFIGURE                   O_BASE + 51
189 #define O_RANDOMISE_HWADDR    O_BASE + 52
190 #define O_ARP_PERSISTDEFENCE  O_BASE + 53
191 #define O_REQUEST_TIME                  O_BASE + 54
192 #define O_FALLBACK_TIME                 O_BASE + 55
193 #define O_IPV4LL_TIME                   O_BASE + 56
194 
195 extern const struct option cf_options[];
196 
197 struct if_sla {
198           char ifname[IF_NAMESIZE];
199           uint32_t sla;
200           uint8_t prefix_len;
201           uint64_t suffix;
202           bool sla_set;
203 };
204 
205 struct if_ia {
206           uint8_t iaid[4];
207 #ifdef INET6
208           uint16_t ia_type;
209           uint8_t iaid_set;
210           struct in6_addr addr;
211           uint8_t prefix_len;
212 #ifndef SMALL
213           uint32_t sla_max;
214           size_t sla_len;
215           struct if_sla *sla;
216 #endif
217 #endif
218 };
219 
220 struct vivco {
221           size_t len;
222           uint8_t *data;
223 };
224 
225 struct if_options {
226           time_t mtime;
227           uint8_t iaid[4];
228           int metric;
229           uint8_t requestmask[256 / NBBY];
230           uint8_t requiremask[256 / NBBY];
231           uint8_t nomask[256 / NBBY];
232           uint8_t rejectmask[256 / NBBY];
233           uint8_t dstmask[256 / NBBY];
234           uint8_t requestmasknd[(UINT16_MAX + 1) / NBBY];
235           uint8_t requiremasknd[(UINT16_MAX + 1) / NBBY];
236           uint8_t nomasknd[(UINT16_MAX + 1) / NBBY];
237           uint8_t rejectmasknd[(UINT16_MAX + 1) / NBBY];
238           uint8_t requestmask6[(UINT16_MAX + 1) / NBBY];
239           uint8_t requiremask6[(UINT16_MAX + 1) / NBBY];
240           uint8_t nomask6[(UINT16_MAX + 1) / NBBY];
241           uint8_t rejectmask6[(UINT16_MAX + 1) / NBBY];
242           uint32_t leasetime;
243           uint32_t timeout;
244           uint32_t reboot;
245           uint32_t request_time;
246           uint32_t fallback_time;
247           uint32_t ipv4ll_time;
248           unsigned long long options;
249           bool randomise_hwaddr;
250 
251           struct in_addr req_addr;
252           struct in_addr req_mask;
253           struct in_addr req_brd;
254           rb_tree_t routes;
255           struct in6_addr req_addr6;
256           uint8_t req_prefix_len;
257           unsigned int mtu;
258           char **config;
259 
260           char **environ;
261 
262           char hostname[HOSTNAME_MAX_LEN + 1]; /* We don't store the length */
263           uint8_t fqdn;
264           uint8_t vendorclassid[VENDORCLASSID_MAX_LEN + 2];
265           uint8_t clientid[CLIENTID_MAX_LEN + 2];
266           uint8_t userclass[USERCLASS_MAX_LEN + 2];
267           uint8_t vendor[VENDOR_MAX_LEN + 2];
268           uint8_t mudurl[MUDURL_MAX_LEN + 2];
269 
270           size_t blacklist_len;
271           in_addr_t *blacklist;
272           size_t whitelist_len;
273           in_addr_t *whitelist;
274           ssize_t arping_len;
275           in_addr_t *arping;
276           char *fallback;
277 
278           struct if_ia *ia;
279           size_t ia_len;
280 #ifdef INET6
281           struct in6_addr token;
282 #endif
283 
284           struct dhcp_opt *dhcp_override;
285           size_t dhcp_override_len;
286           struct dhcp_opt *nd_override;
287           size_t nd_override_len;
288           struct dhcp_opt *dhcp6_override;
289           size_t dhcp6_override_len;
290           uint32_t vivco_en;
291           struct vivco *vivco;
292           size_t vivco_len;
293           struct dhcp_opt *vivso_override;
294           size_t vivso_override_len;
295 
296           struct auth auth;
297 };
298 
299 struct if_options *read_config(struct dhcpcd_ctx *,
300     const char *, const char *, const char *);
301 int add_options(struct dhcpcd_ctx *, const char *,
302     struct if_options *, int, char **);
303 void free_dhcp_opt_embenc(struct dhcp_opt *);
304 void free_options(struct dhcpcd_ctx *, struct if_options *);
305 
306 #endif
307