xref: /linux/include/net/addrconf.h (revision 81fa7a69c2174ed8de314b9c231ef30a8718e5e1)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _ADDRCONF_H
3 #define _ADDRCONF_H
4 
5 #define MAX_RTR_SOLICITATIONS		-1		/* unlimited */
6 #define RTR_SOLICITATION_INTERVAL	(4*HZ)
7 #define RTR_SOLICITATION_MAX_INTERVAL	(3600*HZ)	/* 1 hour */
8 
9 #define MIN_VALID_LIFETIME		(2*3600)	/* 2 hours */
10 
11 #define TEMP_VALID_LIFETIME		(7*86400)
12 #define TEMP_PREFERRED_LIFETIME		(86400)
13 #define REGEN_MAX_RETRY			(3)
14 #define MAX_DESYNC_FACTOR		(600)
15 
16 #define ADDR_CHECK_FREQUENCY		(120*HZ)
17 
18 #define IPV6_MAX_ADDRESSES		16
19 
20 #define ADDRCONF_TIMER_FUZZ_MINUS	(HZ > 50 ? HZ / 50 : 1)
21 #define ADDRCONF_TIMER_FUZZ		(HZ / 4)
22 #define ADDRCONF_TIMER_FUZZ_MAX		(HZ)
23 
24 #define ADDRCONF_NOTIFY_PRIORITY	0
25 
26 #include <linux/in.h>
27 #include <linux/in6.h>
28 
29 struct prefix_info {
30 	__u8			type;
31 	__u8			length;
32 	__u8			prefix_len;
33 
34 #if defined(__BIG_ENDIAN_BITFIELD)
35 	__u8			onlink : 1,
36 			 	autoconf : 1,
37 				reserved : 6;
38 #elif defined(__LITTLE_ENDIAN_BITFIELD)
39 	__u8			reserved : 6,
40 				autoconf : 1,
41 				onlink : 1;
42 #else
43 #error "Please fix <asm/byteorder.h>"
44 #endif
45 	__be32			valid;
46 	__be32			prefered;
47 	__be32			reserved2;
48 
49 	struct in6_addr		prefix;
50 };
51 
52 #include <linux/netdevice.h>
53 #include <net/if_inet6.h>
54 #include <net/ipv6.h>
55 
56 struct in6_validator_info {
57 	struct in6_addr		i6vi_addr;
58 	struct inet6_dev	*i6vi_dev;
59 	struct netlink_ext_ack	*extack;
60 };
61 
62 struct ifa6_config {
63 	const struct in6_addr	*pfx;
64 	unsigned int		plen;
65 
66 	const struct in6_addr	*peer_pfx;
67 
68 	u32			rt_priority;
69 	u32			ifa_flags;
70 	u32			preferred_lft;
71 	u32			valid_lft;
72 	u16			scope;
73 };
74 
75 int addrconf_init(void);
76 void addrconf_cleanup(void);
77 
78 int addrconf_add_ifaddr(struct net *net, void __user *arg);
79 int addrconf_del_ifaddr(struct net *net, void __user *arg);
80 int addrconf_set_dstaddr(struct net *net, void __user *arg);
81 
82 int ipv6_chk_addr(struct net *net, const struct in6_addr *addr,
83 		  const struct net_device *dev, int strict);
84 int ipv6_chk_addr_and_flags(struct net *net, const struct in6_addr *addr,
85 			    const struct net_device *dev, bool skip_dev_check,
86 			    int strict, u32 banned_flags);
87 
88 #if defined(CONFIG_IPV6_MIP6) || defined(CONFIG_IPV6_MIP6_MODULE)
89 int ipv6_chk_home_addr(struct net *net, const struct in6_addr *addr);
90 #endif
91 
92 bool ipv6_chk_custom_prefix(const struct in6_addr *addr,
93 				   const unsigned int prefix_len,
94 				   struct net_device *dev);
95 
96 int ipv6_chk_prefix(const struct in6_addr *addr, struct net_device *dev);
97 
98 struct inet6_ifaddr *ipv6_get_ifaddr(struct net *net,
99 				     const struct in6_addr *addr,
100 				     struct net_device *dev, int strict);
101 
102 int ipv6_dev_get_saddr(struct net *net, const struct net_device *dev,
103 		       const struct in6_addr *daddr, unsigned int srcprefs,
104 		       struct in6_addr *saddr);
105 int __ipv6_get_lladdr(struct inet6_dev *idev, struct in6_addr *addr,
106 		      u32 banned_flags);
107 int ipv6_get_lladdr(struct net_device *dev, struct in6_addr *addr,
108 		    u32 banned_flags);
109 bool inet_rcv_saddr_equal(const struct sock *sk, const struct sock *sk2,
110 			  bool match_wildcard);
111 bool inet_rcv_saddr_any(const struct sock *sk);
112 void addrconf_join_solict(struct net_device *dev, const struct in6_addr *addr);
113 void addrconf_leave_solict(struct inet6_dev *idev, const struct in6_addr *addr);
114 
115 void addrconf_add_linklocal(struct inet6_dev *idev,
116 			    const struct in6_addr *addr, u32 flags);
117 
118 int addrconf_prefix_rcv_add_addr(struct net *net, struct net_device *dev,
119 				 const struct prefix_info *pinfo,
120 				 struct inet6_dev *in6_dev,
121 				 const struct in6_addr *addr, int addr_type,
122 				 u32 addr_flags, bool sllao, bool tokenized,
123 				 __u32 valid_lft, u32 prefered_lft);
124 
125 static inline void addrconf_addr_eui48_base(u8 *eui, const char *const addr)
126 {
127 	memcpy(eui, addr, 3);
128 	eui[3] = 0xFF;
129 	eui[4] = 0xFE;
130 	memcpy(eui + 5, addr + 3, 3);
131 }
132 
133 static inline void addrconf_addr_eui48(u8 *eui, const char *const addr)
134 {
135 	addrconf_addr_eui48_base(eui, addr);
136 	eui[0] ^= 2;
137 }
138 
139 static inline int addrconf_ifid_eui48(u8 *eui, struct net_device *dev)
140 {
141 	if (dev->addr_len != ETH_ALEN)
142 		return -1;
143 
144 	/*
145 	 * The zSeries OSA network cards can be shared among various
146 	 * OS instances, but the OSA cards have only one MAC address.
147 	 * This leads to duplicate address conflicts in conjunction
148 	 * with IPv6 if more than one instance uses the same card.
149 	 *
150 	 * The driver for these cards can deliver a unique 16-bit
151 	 * identifier for each instance sharing the same card.  It is
152 	 * placed instead of 0xFFFE in the interface identifier.  The
153 	 * "u" bit of the interface identifier is not inverted in this
154 	 * case.  Hence the resulting interface identifier has local
155 	 * scope according to RFC2373.
156 	 */
157 
158 	addrconf_addr_eui48_base(eui, dev->dev_addr);
159 
160 	if (dev->dev_id) {
161 		eui[3] = (dev->dev_id >> 8) & 0xFF;
162 		eui[4] = dev->dev_id & 0xFF;
163 	} else {
164 		eui[0] ^= 2;
165 	}
166 
167 	return 0;
168 }
169 
170 static inline unsigned long addrconf_timeout_fixup(u32 timeout,
171 						   unsigned int unit)
172 {
173 	if (timeout == 0xffffffff)
174 		return ~0UL;
175 
176 	/*
177 	 * Avoid arithmetic overflow.
178 	 * Assuming unit is constant and non-zero, this "if" statement
179 	 * will go away on 64bit archs.
180 	 */
181 	if (0xfffffffe > LONG_MAX / unit && timeout > LONG_MAX / unit)
182 		return LONG_MAX / unit;
183 
184 	return timeout;
185 }
186 
187 static inline int addrconf_finite_timeout(unsigned long timeout)
188 {
189 	return ~timeout;
190 }
191 
192 /*
193  *	IPv6 Address Label subsystem (addrlabel.c)
194  */
195 int ipv6_addr_label_init(void);
196 void ipv6_addr_label_cleanup(void);
197 int ipv6_addr_label_rtnl_register(void);
198 u32 ipv6_addr_label(struct net *net, const struct in6_addr *addr,
199 		    int type, int ifindex);
200 
201 /*
202  *	multicast prototypes (mcast.c)
203  */
204 int ipv6_sock_mc_join(struct sock *sk, int ifindex,
205 		      const struct in6_addr *addr);
206 int ipv6_sock_mc_drop(struct sock *sk, int ifindex,
207 		      const struct in6_addr *addr);
208 void __ipv6_sock_mc_close(struct sock *sk);
209 void ipv6_sock_mc_close(struct sock *sk);
210 bool inet6_mc_check(struct sock *sk, const struct in6_addr *mc_addr,
211 		    const struct in6_addr *src_addr);
212 
213 int ipv6_dev_mc_inc(struct net_device *dev, const struct in6_addr *addr);
214 int __ipv6_dev_mc_dec(struct inet6_dev *idev, const struct in6_addr *addr);
215 int ipv6_dev_mc_dec(struct net_device *dev, const struct in6_addr *addr);
216 void ipv6_mc_up(struct inet6_dev *idev);
217 void ipv6_mc_down(struct inet6_dev *idev);
218 void ipv6_mc_unmap(struct inet6_dev *idev);
219 void ipv6_mc_remap(struct inet6_dev *idev);
220 void ipv6_mc_init_dev(struct inet6_dev *idev);
221 void ipv6_mc_destroy_dev(struct inet6_dev *idev);
222 int ipv6_mc_check_mld(struct sk_buff *skb, struct sk_buff **skb_trimmed);
223 void addrconf_dad_failure(struct sk_buff *skb, struct inet6_ifaddr *ifp);
224 
225 bool ipv6_chk_mcast_addr(struct net_device *dev, const struct in6_addr *group,
226 			 const struct in6_addr *src_addr);
227 
228 void ipv6_mc_dad_complete(struct inet6_dev *idev);
229 
230 /* A stub used by vxlan module. This is ugly, ideally these
231  * symbols should be built into the core kernel.
232  */
233 struct ipv6_stub {
234 	int (*ipv6_sock_mc_join)(struct sock *sk, int ifindex,
235 				 const struct in6_addr *addr);
236 	int (*ipv6_sock_mc_drop)(struct sock *sk, int ifindex,
237 				 const struct in6_addr *addr);
238 	int (*ipv6_dst_lookup)(struct net *net, struct sock *sk,
239 			       struct dst_entry **dst, struct flowi6 *fl6);
240 
241 	struct fib6_table *(*fib6_get_table)(struct net *net, u32 id);
242 	struct fib6_info *(*fib6_lookup)(struct net *net, int oif,
243 					 struct flowi6 *fl6, int flags);
244 	struct fib6_info *(*fib6_table_lookup)(struct net *net,
245 					      struct fib6_table *table,
246 					      int oif, struct flowi6 *fl6,
247 					      int flags);
248 	struct fib6_info *(*fib6_multipath_select)(const struct net *net,
249 						   struct fib6_info *f6i,
250 						   struct flowi6 *fl6, int oif,
251 						   const struct sk_buff *skb,
252 						   int strict);
253 	u32 (*ip6_mtu_from_fib6)(struct fib6_info *f6i, struct in6_addr *daddr,
254 				 struct in6_addr *saddr);
255 
256 	void (*udpv6_encap_enable)(void);
257 	void (*ndisc_send_na)(struct net_device *dev, const struct in6_addr *daddr,
258 			      const struct in6_addr *solicited_addr,
259 			      bool router, bool solicited, bool override, bool inc_opt);
260 	struct neigh_table *nd_tbl;
261 };
262 extern const struct ipv6_stub *ipv6_stub __read_mostly;
263 
264 /* A stub used by bpf helpers. Similarly ugly as ipv6_stub */
265 struct ipv6_bpf_stub {
266 	int (*inet6_bind)(struct sock *sk, struct sockaddr *uaddr, int addr_len,
267 			  bool force_bind_address_no_port, bool with_lock);
268 	struct sock *(*udp6_lib_lookup)(struct net *net,
269 					const struct in6_addr *saddr, __be16 sport,
270 					const struct in6_addr *daddr, __be16 dport,
271 					int dif, int sdif, struct udp_table *tbl,
272 					struct sk_buff *skb);
273 };
274 extern const struct ipv6_bpf_stub *ipv6_bpf_stub __read_mostly;
275 
276 /*
277  * identify MLD packets for MLD filter exceptions
278  */
279 static inline bool ipv6_is_mld(struct sk_buff *skb, int nexthdr, int offset)
280 {
281 	struct icmp6hdr *hdr;
282 
283 	if (nexthdr != IPPROTO_ICMPV6 ||
284 	    !pskb_network_may_pull(skb, offset + sizeof(struct icmp6hdr)))
285 		return false;
286 
287 	hdr = (struct icmp6hdr *)(skb_network_header(skb) + offset);
288 
289 	switch (hdr->icmp6_type) {
290 	case ICMPV6_MGM_QUERY:
291 	case ICMPV6_MGM_REPORT:
292 	case ICMPV6_MGM_REDUCTION:
293 	case ICMPV6_MLD2_REPORT:
294 		return true;
295 	default:
296 		break;
297 	}
298 	return false;
299 }
300 
301 void addrconf_prefix_rcv(struct net_device *dev,
302 			 u8 *opt, int len, bool sllao);
303 
304 /*
305  *	anycast prototypes (anycast.c)
306  */
307 int ipv6_sock_ac_join(struct sock *sk, int ifindex,
308 		      const struct in6_addr *addr);
309 int ipv6_sock_ac_drop(struct sock *sk, int ifindex,
310 		      const struct in6_addr *addr);
311 void ipv6_sock_ac_close(struct sock *sk);
312 
313 int __ipv6_dev_ac_inc(struct inet6_dev *idev, const struct in6_addr *addr);
314 int __ipv6_dev_ac_dec(struct inet6_dev *idev, const struct in6_addr *addr);
315 void ipv6_ac_destroy_dev(struct inet6_dev *idev);
316 bool ipv6_chk_acast_addr(struct net *net, struct net_device *dev,
317 			 const struct in6_addr *addr);
318 bool ipv6_chk_acast_addr_src(struct net *net, struct net_device *dev,
319 			     const struct in6_addr *addr);
320 
321 /* Device notifier */
322 int register_inet6addr_notifier(struct notifier_block *nb);
323 int unregister_inet6addr_notifier(struct notifier_block *nb);
324 int inet6addr_notifier_call_chain(unsigned long val, void *v);
325 
326 int register_inet6addr_validator_notifier(struct notifier_block *nb);
327 int unregister_inet6addr_validator_notifier(struct notifier_block *nb);
328 int inet6addr_validator_notifier_call_chain(unsigned long val, void *v);
329 
330 void inet6_netconf_notify_devconf(struct net *net, int event, int type,
331 				  int ifindex, struct ipv6_devconf *devconf);
332 
333 /**
334  * __in6_dev_get - get inet6_dev pointer from netdevice
335  * @dev: network device
336  *
337  * Caller must hold rcu_read_lock or RTNL, because this function
338  * does not take a reference on the inet6_dev.
339  */
340 static inline struct inet6_dev *__in6_dev_get(const struct net_device *dev)
341 {
342 	return rcu_dereference_rtnl(dev->ip6_ptr);
343 }
344 
345 /**
346  * __in6_dev_get_safely - get inet6_dev pointer from netdevice
347  * @dev: network device
348  *
349  * This is a safer version of __in6_dev_get
350  */
351 static inline struct inet6_dev *__in6_dev_get_safely(const struct net_device *dev)
352 {
353 	if (likely(dev))
354 		return rcu_dereference_rtnl(dev->ip6_ptr);
355 	else
356 		return NULL;
357 }
358 
359 /**
360  * in6_dev_get - get inet6_dev pointer from netdevice
361  * @dev: network device
362  *
363  * This version can be used in any context, and takes a reference
364  * on the inet6_dev. Callers must use in6_dev_put() later to
365  * release this reference.
366  */
367 static inline struct inet6_dev *in6_dev_get(const struct net_device *dev)
368 {
369 	struct inet6_dev *idev;
370 
371 	rcu_read_lock();
372 	idev = rcu_dereference(dev->ip6_ptr);
373 	if (idev)
374 		refcount_inc(&idev->refcnt);
375 	rcu_read_unlock();
376 	return idev;
377 }
378 
379 static inline struct neigh_parms *__in6_dev_nd_parms_get_rcu(const struct net_device *dev)
380 {
381 	struct inet6_dev *idev = __in6_dev_get(dev);
382 
383 	return idev ? idev->nd_parms : NULL;
384 }
385 
386 void in6_dev_finish_destroy(struct inet6_dev *idev);
387 
388 static inline void in6_dev_put(struct inet6_dev *idev)
389 {
390 	if (refcount_dec_and_test(&idev->refcnt))
391 		in6_dev_finish_destroy(idev);
392 }
393 
394 static inline void in6_dev_put_clear(struct inet6_dev **pidev)
395 {
396 	struct inet6_dev *idev = *pidev;
397 
398 	if (idev) {
399 		in6_dev_put(idev);
400 		*pidev = NULL;
401 	}
402 }
403 
404 static inline void __in6_dev_put(struct inet6_dev *idev)
405 {
406 	refcount_dec(&idev->refcnt);
407 }
408 
409 static inline void in6_dev_hold(struct inet6_dev *idev)
410 {
411 	refcount_inc(&idev->refcnt);
412 }
413 
414 void inet6_ifa_finish_destroy(struct inet6_ifaddr *ifp);
415 
416 static inline void in6_ifa_put(struct inet6_ifaddr *ifp)
417 {
418 	if (refcount_dec_and_test(&ifp->refcnt))
419 		inet6_ifa_finish_destroy(ifp);
420 }
421 
422 static inline void __in6_ifa_put(struct inet6_ifaddr *ifp)
423 {
424 	refcount_dec(&ifp->refcnt);
425 }
426 
427 static inline void in6_ifa_hold(struct inet6_ifaddr *ifp)
428 {
429 	refcount_inc(&ifp->refcnt);
430 }
431 
432 
433 /*
434  *	compute link-local solicited-node multicast address
435  */
436 
437 static inline void addrconf_addr_solict_mult(const struct in6_addr *addr,
438 					     struct in6_addr *solicited)
439 {
440 	ipv6_addr_set(solicited,
441 		      htonl(0xFF020000), 0,
442 		      htonl(0x1),
443 		      htonl(0xFF000000) | addr->s6_addr32[3]);
444 }
445 
446 static inline bool ipv6_addr_is_ll_all_nodes(const struct in6_addr *addr)
447 {
448 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
449 	__be64 *p = (__be64 *)addr;
450 	return ((p[0] ^ cpu_to_be64(0xff02000000000000UL)) | (p[1] ^ cpu_to_be64(1))) == 0UL;
451 #else
452 	return ((addr->s6_addr32[0] ^ htonl(0xff020000)) |
453 		addr->s6_addr32[1] | addr->s6_addr32[2] |
454 		(addr->s6_addr32[3] ^ htonl(0x00000001))) == 0;
455 #endif
456 }
457 
458 static inline bool ipv6_addr_is_ll_all_routers(const struct in6_addr *addr)
459 {
460 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
461 	__be64 *p = (__be64 *)addr;
462 	return ((p[0] ^ cpu_to_be64(0xff02000000000000UL)) | (p[1] ^ cpu_to_be64(2))) == 0UL;
463 #else
464 	return ((addr->s6_addr32[0] ^ htonl(0xff020000)) |
465 		addr->s6_addr32[1] | addr->s6_addr32[2] |
466 		(addr->s6_addr32[3] ^ htonl(0x00000002))) == 0;
467 #endif
468 }
469 
470 static inline bool ipv6_addr_is_isatap(const struct in6_addr *addr)
471 {
472 	return (addr->s6_addr32[2] | htonl(0x02000000)) == htonl(0x02005EFE);
473 }
474 
475 static inline bool ipv6_addr_is_solict_mult(const struct in6_addr *addr)
476 {
477 #if defined(CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS) && BITS_PER_LONG == 64
478 	__be64 *p = (__be64 *)addr;
479 	return ((p[0] ^ cpu_to_be64(0xff02000000000000UL)) |
480 		((p[1] ^ cpu_to_be64(0x00000001ff000000UL)) &
481 		 cpu_to_be64(0xffffffffff000000UL))) == 0UL;
482 #else
483 	return ((addr->s6_addr32[0] ^ htonl(0xff020000)) |
484 		addr->s6_addr32[1] |
485 		(addr->s6_addr32[2] ^ htonl(0x00000001)) |
486 		(addr->s6_addr[12] ^ 0xff)) == 0;
487 #endif
488 }
489 
490 #ifdef CONFIG_PROC_FS
491 int if6_proc_init(void);
492 void if6_proc_exit(void);
493 #endif
494 
495 #endif
496