xref: /linux/net/core/dev_ioctl.c (revision 76b5878cffab379dd4fd84c04bdf20d21177729d)
1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/kmod.h>
3 #include <linux/netdevice.h>
4 #include <linux/inetdevice.h>
5 #include <linux/etherdevice.h>
6 #include <linux/rtnetlink.h>
7 #include <linux/net_tstamp.h>
8 #include <linux/wireless.h>
9 #include <net/dsa.h>
10 #include <net/wext.h>
11 
12 /*
13  *	Map an interface index to its name (SIOCGIFNAME)
14  */
15 
16 /*
17  *	We need this ioctl for efficient implementation of the
18  *	if_indextoname() function required by the IPv6 API.  Without
19  *	it, we would have to search all the interfaces to find a
20  *	match.  --pb
21  */
22 
23 static int dev_ifname(struct net *net, struct ifreq *ifr)
24 {
25 	ifr->ifr_name[IFNAMSIZ-1] = 0;
26 	return netdev_get_name(net, ifr->ifr_name, ifr->ifr_ifindex);
27 }
28 
29 /*
30  *	Perform a SIOCGIFCONF call. This structure will change
31  *	size eventually, and there is nothing I can do about it.
32  *	Thus we will need a 'compatibility mode'.
33  */
34 int dev_ifconf(struct net *net, struct ifconf __user *uifc)
35 {
36 	struct net_device *dev;
37 	void __user *pos;
38 	size_t size;
39 	int len, total = 0, done;
40 
41 	/* both the ifconf and the ifreq structures are slightly different */
42 	if (in_compat_syscall()) {
43 		struct compat_ifconf ifc32;
44 
45 		if (copy_from_user(&ifc32, uifc, sizeof(struct compat_ifconf)))
46 			return -EFAULT;
47 
48 		pos = compat_ptr(ifc32.ifcbuf);
49 		len = ifc32.ifc_len;
50 		size = sizeof(struct compat_ifreq);
51 	} else {
52 		struct ifconf ifc;
53 
54 		if (copy_from_user(&ifc, uifc, sizeof(struct ifconf)))
55 			return -EFAULT;
56 
57 		pos = ifc.ifc_buf;
58 		len = ifc.ifc_len;
59 		size = sizeof(struct ifreq);
60 	}
61 
62 	/* Loop over the interfaces, and write an info block for each. */
63 	rtnl_lock();
64 	for_each_netdev(net, dev) {
65 		if (!pos)
66 			done = inet_gifconf(dev, NULL, 0, size);
67 		else
68 			done = inet_gifconf(dev, pos + total,
69 					    len - total, size);
70 		if (done < 0) {
71 			rtnl_unlock();
72 			return -EFAULT;
73 		}
74 		total += done;
75 	}
76 	rtnl_unlock();
77 
78 	return put_user(total, &uifc->ifc_len);
79 }
80 
81 static int dev_getifmap(struct net_device *dev, struct ifreq *ifr)
82 {
83 	struct ifmap *ifmap = &ifr->ifr_map;
84 
85 	if (in_compat_syscall()) {
86 		struct compat_ifmap *cifmap = (struct compat_ifmap *)ifmap;
87 
88 		cifmap->mem_start = dev->mem_start;
89 		cifmap->mem_end   = dev->mem_end;
90 		cifmap->base_addr = dev->base_addr;
91 		cifmap->irq       = dev->irq;
92 		cifmap->dma       = dev->dma;
93 		cifmap->port      = dev->if_port;
94 
95 		return 0;
96 	}
97 
98 	ifmap->mem_start  = dev->mem_start;
99 	ifmap->mem_end    = dev->mem_end;
100 	ifmap->base_addr  = dev->base_addr;
101 	ifmap->irq        = dev->irq;
102 	ifmap->dma        = dev->dma;
103 	ifmap->port       = dev->if_port;
104 
105 	return 0;
106 }
107 
108 static int dev_setifmap(struct net_device *dev, struct ifreq *ifr)
109 {
110 	struct compat_ifmap *cifmap = (struct compat_ifmap *)&ifr->ifr_map;
111 
112 	if (!dev->netdev_ops->ndo_set_config)
113 		return -EOPNOTSUPP;
114 
115 	if (in_compat_syscall()) {
116 		struct ifmap ifmap = {
117 			.mem_start  = cifmap->mem_start,
118 			.mem_end    = cifmap->mem_end,
119 			.base_addr  = cifmap->base_addr,
120 			.irq        = cifmap->irq,
121 			.dma        = cifmap->dma,
122 			.port       = cifmap->port,
123 		};
124 
125 		return dev->netdev_ops->ndo_set_config(dev, &ifmap);
126 	}
127 
128 	return dev->netdev_ops->ndo_set_config(dev, &ifr->ifr_map);
129 }
130 
131 /*
132  *	Perform the SIOCxIFxxx calls, inside rcu_read_lock()
133  */
134 static int dev_ifsioc_locked(struct net *net, struct ifreq *ifr, unsigned int cmd)
135 {
136 	int err;
137 	struct net_device *dev = dev_get_by_name_rcu(net, ifr->ifr_name);
138 
139 	if (!dev)
140 		return -ENODEV;
141 
142 	switch (cmd) {
143 	case SIOCGIFFLAGS:	/* Get interface flags */
144 		ifr->ifr_flags = (short) dev_get_flags(dev);
145 		return 0;
146 
147 	case SIOCGIFMETRIC:	/* Get the metric on the interface
148 				   (currently unused) */
149 		ifr->ifr_metric = 0;
150 		return 0;
151 
152 	case SIOCGIFMTU:	/* Get the MTU of a device */
153 		ifr->ifr_mtu = dev->mtu;
154 		return 0;
155 
156 	case SIOCGIFSLAVE:
157 		err = -EINVAL;
158 		break;
159 
160 	case SIOCGIFMAP:
161 		return dev_getifmap(dev, ifr);
162 
163 	case SIOCGIFINDEX:
164 		ifr->ifr_ifindex = dev->ifindex;
165 		return 0;
166 
167 	case SIOCGIFTXQLEN:
168 		ifr->ifr_qlen = dev->tx_queue_len;
169 		return 0;
170 
171 	default:
172 		/* dev_ioctl() should ensure this case
173 		 * is never reached
174 		 */
175 		WARN_ON(1);
176 		err = -ENOTTY;
177 		break;
178 
179 	}
180 	return err;
181 }
182 
183 static int net_hwtstamp_validate(struct ifreq *ifr)
184 {
185 	struct hwtstamp_config cfg;
186 	enum hwtstamp_tx_types tx_type;
187 	enum hwtstamp_rx_filters rx_filter;
188 	int tx_type_valid = 0;
189 	int rx_filter_valid = 0;
190 
191 	if (copy_from_user(&cfg, ifr->ifr_data, sizeof(cfg)))
192 		return -EFAULT;
193 
194 	if (cfg.flags) /* reserved for future extensions */
195 		return -EINVAL;
196 
197 	tx_type = cfg.tx_type;
198 	rx_filter = cfg.rx_filter;
199 
200 	switch (tx_type) {
201 	case HWTSTAMP_TX_OFF:
202 	case HWTSTAMP_TX_ON:
203 	case HWTSTAMP_TX_ONESTEP_SYNC:
204 	case HWTSTAMP_TX_ONESTEP_P2P:
205 		tx_type_valid = 1;
206 		break;
207 	case __HWTSTAMP_TX_CNT:
208 		/* not a real value */
209 		break;
210 	}
211 
212 	switch (rx_filter) {
213 	case HWTSTAMP_FILTER_NONE:
214 	case HWTSTAMP_FILTER_ALL:
215 	case HWTSTAMP_FILTER_SOME:
216 	case HWTSTAMP_FILTER_PTP_V1_L4_EVENT:
217 	case HWTSTAMP_FILTER_PTP_V1_L4_SYNC:
218 	case HWTSTAMP_FILTER_PTP_V1_L4_DELAY_REQ:
219 	case HWTSTAMP_FILTER_PTP_V2_L4_EVENT:
220 	case HWTSTAMP_FILTER_PTP_V2_L4_SYNC:
221 	case HWTSTAMP_FILTER_PTP_V2_L4_DELAY_REQ:
222 	case HWTSTAMP_FILTER_PTP_V2_L2_EVENT:
223 	case HWTSTAMP_FILTER_PTP_V2_L2_SYNC:
224 	case HWTSTAMP_FILTER_PTP_V2_L2_DELAY_REQ:
225 	case HWTSTAMP_FILTER_PTP_V2_EVENT:
226 	case HWTSTAMP_FILTER_PTP_V2_SYNC:
227 	case HWTSTAMP_FILTER_PTP_V2_DELAY_REQ:
228 	case HWTSTAMP_FILTER_NTP_ALL:
229 		rx_filter_valid = 1;
230 		break;
231 	case __HWTSTAMP_FILTER_CNT:
232 		/* not a real value */
233 		break;
234 	}
235 
236 	if (!tx_type_valid || !rx_filter_valid)
237 		return -ERANGE;
238 
239 	return 0;
240 }
241 
242 static int dev_do_ioctl(struct net_device *dev,
243 			struct ifreq *ifr, unsigned int cmd)
244 {
245 	const struct net_device_ops *ops = dev->netdev_ops;
246 	int err;
247 
248 	err = dsa_ndo_do_ioctl(dev, ifr, cmd);
249 	if (err == 0 || err != -EOPNOTSUPP)
250 		return err;
251 
252 	if (ops->ndo_do_ioctl) {
253 		if (netif_device_present(dev))
254 			err = ops->ndo_do_ioctl(dev, ifr, cmd);
255 		else
256 			err = -ENODEV;
257 	}
258 
259 	return err;
260 }
261 
262 static int dev_siocdevprivate(struct net_device *dev,
263 			      struct ifreq *ifr, unsigned int cmd)
264 {
265 	const struct net_device_ops *ops = dev->netdev_ops;
266 	void __user *data = ifr->ifr_data;
267 
268 	if (ops->ndo_siocdevprivate) {
269 		if (netif_device_present(dev))
270 			return ops->ndo_siocdevprivate(dev, ifr, data, cmd);
271 		else
272 			return -ENODEV;
273 	}
274 
275 	/* fall back to do_ioctl for drivers not yet converted */
276 	return dev_do_ioctl(dev, ifr, cmd);
277 }
278 
279 /*
280  *	Perform the SIOCxIFxxx calls, inside rtnl_lock()
281  */
282 static int dev_ifsioc(struct net *net, struct ifreq *ifr, unsigned int cmd)
283 {
284 	int err;
285 	struct net_device *dev = __dev_get_by_name(net, ifr->ifr_name);
286 	const struct net_device_ops *ops;
287 
288 	if (!dev)
289 		return -ENODEV;
290 
291 	ops = dev->netdev_ops;
292 
293 	switch (cmd) {
294 	case SIOCSIFFLAGS:	/* Set interface flags */
295 		return dev_change_flags(dev, ifr->ifr_flags, NULL);
296 
297 	case SIOCSIFMETRIC:	/* Set the metric on the interface
298 				   (currently unused) */
299 		return -EOPNOTSUPP;
300 
301 	case SIOCSIFMTU:	/* Set the MTU of a device */
302 		return dev_set_mtu(dev, ifr->ifr_mtu);
303 
304 	case SIOCSIFHWADDR:
305 		if (dev->addr_len > sizeof(struct sockaddr))
306 			return -EINVAL;
307 		return dev_set_mac_address_user(dev, &ifr->ifr_hwaddr, NULL);
308 
309 	case SIOCSIFHWBROADCAST:
310 		if (ifr->ifr_hwaddr.sa_family != dev->type)
311 			return -EINVAL;
312 		memcpy(dev->broadcast, ifr->ifr_hwaddr.sa_data,
313 		       min(sizeof(ifr->ifr_hwaddr.sa_data),
314 			   (size_t)dev->addr_len));
315 		call_netdevice_notifiers(NETDEV_CHANGEADDR, dev);
316 		return 0;
317 
318 	case SIOCSIFMAP:
319 		return dev_setifmap(dev, ifr);
320 
321 	case SIOCADDMULTI:
322 		if (!ops->ndo_set_rx_mode ||
323 		    ifr->ifr_hwaddr.sa_family != AF_UNSPEC)
324 			return -EINVAL;
325 		if (!netif_device_present(dev))
326 			return -ENODEV;
327 		return dev_mc_add_global(dev, ifr->ifr_hwaddr.sa_data);
328 
329 	case SIOCDELMULTI:
330 		if (!ops->ndo_set_rx_mode ||
331 		    ifr->ifr_hwaddr.sa_family != AF_UNSPEC)
332 			return -EINVAL;
333 		if (!netif_device_present(dev))
334 			return -ENODEV;
335 		return dev_mc_del_global(dev, ifr->ifr_hwaddr.sa_data);
336 
337 	case SIOCSIFTXQLEN:
338 		if (ifr->ifr_qlen < 0)
339 			return -EINVAL;
340 		return dev_change_tx_queue_len(dev, ifr->ifr_qlen);
341 
342 	case SIOCSIFNAME:
343 		ifr->ifr_newname[IFNAMSIZ-1] = '\0';
344 		return dev_change_name(dev, ifr->ifr_newname);
345 
346 	case SIOCSHWTSTAMP:
347 		err = net_hwtstamp_validate(ifr);
348 		if (err)
349 			return err;
350 		fallthrough;
351 
352 	/*
353 	 *	Unknown or private ioctl
354 	 */
355 	default:
356 		if (cmd >= SIOCDEVPRIVATE &&
357 		    cmd <= SIOCDEVPRIVATE + 15)
358 			return dev_siocdevprivate(dev, ifr, cmd);
359 
360 		if (cmd == SIOCBONDENSLAVE ||
361 		    cmd == SIOCBONDRELEASE ||
362 		    cmd == SIOCBONDSETHWADDR ||
363 		    cmd == SIOCBONDSLAVEINFOQUERY ||
364 		    cmd == SIOCBONDINFOQUERY ||
365 		    cmd == SIOCBONDCHANGEACTIVE ||
366 		    cmd == SIOCGMIIPHY ||
367 		    cmd == SIOCGMIIREG ||
368 		    cmd == SIOCSMIIREG ||
369 		    cmd == SIOCBRADDIF ||
370 		    cmd == SIOCBRDELIF ||
371 		    cmd == SIOCSHWTSTAMP ||
372 		    cmd == SIOCGHWTSTAMP ||
373 		    cmd == SIOCWANDEV) {
374 			err = dev_do_ioctl(dev, ifr, cmd);
375 		} else
376 			err = -EINVAL;
377 
378 	}
379 	return err;
380 }
381 
382 /**
383  *	dev_load 	- load a network module
384  *	@net: the applicable net namespace
385  *	@name: name of interface
386  *
387  *	If a network interface is not present and the process has suitable
388  *	privileges this function loads the module. If module loading is not
389  *	available in this kernel then it becomes a nop.
390  */
391 
392 void dev_load(struct net *net, const char *name)
393 {
394 	struct net_device *dev;
395 	int no_module;
396 
397 	rcu_read_lock();
398 	dev = dev_get_by_name_rcu(net, name);
399 	rcu_read_unlock();
400 
401 	no_module = !dev;
402 	if (no_module && capable(CAP_NET_ADMIN))
403 		no_module = request_module("netdev-%s", name);
404 	if (no_module && capable(CAP_SYS_MODULE))
405 		request_module("%s", name);
406 }
407 EXPORT_SYMBOL(dev_load);
408 
409 /*
410  *	This function handles all "interface"-type I/O control requests. The actual
411  *	'doing' part of this is dev_ifsioc above.
412  */
413 
414 /**
415  *	dev_ioctl	-	network device ioctl
416  *	@net: the applicable net namespace
417  *	@cmd: command to issue
418  *	@ifr: pointer to a struct ifreq in user space
419  *	@need_copyout: whether or not copy_to_user() should be called
420  *
421  *	Issue ioctl functions to devices. This is normally called by the
422  *	user space syscall interfaces but can sometimes be useful for
423  *	other purposes. The return value is the return from the syscall if
424  *	positive or a negative errno code on error.
425  */
426 
427 int dev_ioctl(struct net *net, unsigned int cmd, struct ifreq *ifr, bool *need_copyout)
428 {
429 	int ret;
430 	char *colon;
431 
432 	if (need_copyout)
433 		*need_copyout = true;
434 	if (cmd == SIOCGIFNAME)
435 		return dev_ifname(net, ifr);
436 
437 	ifr->ifr_name[IFNAMSIZ-1] = 0;
438 
439 	colon = strchr(ifr->ifr_name, ':');
440 	if (colon)
441 		*colon = 0;
442 
443 	/*
444 	 *	See which interface the caller is talking about.
445 	 */
446 
447 	switch (cmd) {
448 	case SIOCGIFHWADDR:
449 		dev_load(net, ifr->ifr_name);
450 		ret = dev_get_mac_address(&ifr->ifr_hwaddr, net, ifr->ifr_name);
451 		if (colon)
452 			*colon = ':';
453 		return ret;
454 	/*
455 	 *	These ioctl calls:
456 	 *	- can be done by all.
457 	 *	- atomic and do not require locking.
458 	 *	- return a value
459 	 */
460 	case SIOCGIFFLAGS:
461 	case SIOCGIFMETRIC:
462 	case SIOCGIFMTU:
463 	case SIOCGIFSLAVE:
464 	case SIOCGIFMAP:
465 	case SIOCGIFINDEX:
466 	case SIOCGIFTXQLEN:
467 		dev_load(net, ifr->ifr_name);
468 		rcu_read_lock();
469 		ret = dev_ifsioc_locked(net, ifr, cmd);
470 		rcu_read_unlock();
471 		if (colon)
472 			*colon = ':';
473 		return ret;
474 
475 	case SIOCETHTOOL:
476 		dev_load(net, ifr->ifr_name);
477 		rtnl_lock();
478 		ret = dev_ethtool(net, ifr);
479 		rtnl_unlock();
480 		if (colon)
481 			*colon = ':';
482 		return ret;
483 
484 	/*
485 	 *	These ioctl calls:
486 	 *	- require superuser power.
487 	 *	- require strict serialization.
488 	 *	- return a value
489 	 */
490 	case SIOCGMIIPHY:
491 	case SIOCGMIIREG:
492 	case SIOCSIFNAME:
493 		dev_load(net, ifr->ifr_name);
494 		if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
495 			return -EPERM;
496 		rtnl_lock();
497 		ret = dev_ifsioc(net, ifr, cmd);
498 		rtnl_unlock();
499 		if (colon)
500 			*colon = ':';
501 		return ret;
502 
503 	/*
504 	 *	These ioctl calls:
505 	 *	- require superuser power.
506 	 *	- require strict serialization.
507 	 *	- do not return a value
508 	 */
509 	case SIOCSIFMAP:
510 	case SIOCSIFTXQLEN:
511 		if (!capable(CAP_NET_ADMIN))
512 			return -EPERM;
513 		fallthrough;
514 	/*
515 	 *	These ioctl calls:
516 	 *	- require local superuser power.
517 	 *	- require strict serialization.
518 	 *	- do not return a value
519 	 */
520 	case SIOCSIFFLAGS:
521 	case SIOCSIFMETRIC:
522 	case SIOCSIFMTU:
523 	case SIOCSIFHWADDR:
524 	case SIOCSIFSLAVE:
525 	case SIOCADDMULTI:
526 	case SIOCDELMULTI:
527 	case SIOCSIFHWBROADCAST:
528 	case SIOCSMIIREG:
529 	case SIOCBONDENSLAVE:
530 	case SIOCBONDRELEASE:
531 	case SIOCBONDSETHWADDR:
532 	case SIOCBONDCHANGEACTIVE:
533 	case SIOCBRADDIF:
534 	case SIOCBRDELIF:
535 	case SIOCSHWTSTAMP:
536 		if (!ns_capable(net->user_ns, CAP_NET_ADMIN))
537 			return -EPERM;
538 		fallthrough;
539 	case SIOCBONDSLAVEINFOQUERY:
540 	case SIOCBONDINFOQUERY:
541 		dev_load(net, ifr->ifr_name);
542 		rtnl_lock();
543 		ret = dev_ifsioc(net, ifr, cmd);
544 		rtnl_unlock();
545 		if (need_copyout)
546 			*need_copyout = false;
547 		return ret;
548 
549 	case SIOCGIFMEM:
550 		/* Get the per device memory space. We can add this but
551 		 * currently do not support it */
552 	case SIOCSIFMEM:
553 		/* Set the per device memory buffer space.
554 		 * Not applicable in our case */
555 	case SIOCSIFLINK:
556 		return -ENOTTY;
557 
558 	/*
559 	 *	Unknown or private ioctl.
560 	 */
561 	default:
562 		if (cmd == SIOCWANDEV ||
563 		    cmd == SIOCGHWTSTAMP ||
564 		    (cmd >= SIOCDEVPRIVATE &&
565 		     cmd <= SIOCDEVPRIVATE + 15)) {
566 			dev_load(net, ifr->ifr_name);
567 			rtnl_lock();
568 			ret = dev_ifsioc(net, ifr, cmd);
569 			rtnl_unlock();
570 			return ret;
571 		}
572 		return -ENOTTY;
573 	}
574 }
575