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