2 * iptunnel.c "ip tuntap"
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version
7 * 2 of the License, or (at your option) any later version.
9 * Authors: David Woodhouse <David.Woodhouse@intel.com>
17 #include <sys/types.h>
18 #include <sys/socket.h>
19 #include <arpa/inet.h>
20 #include <sys/ioctl.h>
22 #include <linux/if_tun.h>
23 #include <linux/if_arp.h>
33 #include "ip_common.h"
35 static const char drv_name
[] = "tun";
37 #define TUNDEV "/dev/net/tun"
39 static void usage(void) __attribute__((noreturn
));
41 static void usage(void)
43 fprintf(stderr
, "Usage: ip tuntap { add | del | show | list | lst | help } [ dev PHYS_DEV ]\n");
44 fprintf(stderr
, " [ mode { tun | tap } ] [ user USER ] [ group GROUP ]\n");
45 fprintf(stderr
, " [ one_queue ] [ pi ] [ vnet_hdr ] [ multi_queue ] [ name NAME ]\n");
46 fprintf(stderr
, "\n");
47 fprintf(stderr
, "Where: USER := { STRING | NUMBER }\n");
48 fprintf(stderr
, " GROUP := { STRING | NUMBER }\n");
52 static int tap_add_ioctl(struct ifreq
*ifr
, uid_t uid
, gid_t gid
)
58 ifr
->ifr_flags
|= IFF_TUN_EXCL
;
61 fd
= open(TUNDEV
, O_RDWR
);
66 if (ioctl(fd
, TUNSETIFF
, ifr
)) {
67 perror("ioctl(TUNSETIFF)");
70 if (uid
!= -1 && ioctl(fd
, TUNSETOWNER
, uid
)) {
71 perror("ioctl(TUNSETOWNER)");
74 if (gid
!= -1 && ioctl(fd
, TUNSETGROUP
, gid
)) {
75 perror("ioctl(TUNSETGROUP)");
78 if (ioctl(fd
, TUNSETPERSIST
, 1)) {
79 perror("ioctl(TUNSETPERSIST)");
88 static int tap_del_ioctl(struct ifreq
*ifr
)
90 int fd
= open(TUNDEV
, O_RDWR
);
97 if (ioctl(fd
, TUNSETIFF
, ifr
)) {
98 perror("ioctl(TUNSETIFF)");
101 if (ioctl(fd
, TUNSETPERSIST
, 0)) {
102 perror("ioctl(TUNSETPERSIST)");
111 static int parse_args(int argc
, char **argv
,
112 struct ifreq
*ifr
, uid_t
*uid
, gid_t
*gid
)
116 memset(ifr
, 0, sizeof(*ifr
));
118 ifr
->ifr_flags
|= IFF_NO_PI
;
121 if (matches(*argv
, "mode") == 0) {
123 if (matches(*argv
, "tun") == 0) {
124 if (ifr
->ifr_flags
& IFF_TAP
) {
125 fprintf(stderr
, "You managed to ask for more than one tunnel mode.\n");
128 ifr
->ifr_flags
|= IFF_TUN
;
129 } else if (matches(*argv
, "tap") == 0) {
130 if (ifr
->ifr_flags
& IFF_TUN
) {
131 fprintf(stderr
, "You managed to ask for more than one tunnel mode.\n");
134 ifr
->ifr_flags
|= IFF_TAP
;
136 fprintf(stderr
, "Unknown tunnel mode \"%s\"\n", *argv
);
139 } else if (uid
&& matches(*argv
, "user") == 0) {
144 if (**argv
&& ((user
= strtol(*argv
, &end
, 10)), !*end
))
147 struct passwd
*pw
= getpwnam(*argv
);
150 fprintf(stderr
, "invalid user \"%s\"\n", *argv
);
155 } else if (gid
&& matches(*argv
, "group") == 0) {
161 if (**argv
&& ((group
= strtol(*argv
, &end
, 10)), !*end
))
164 struct group
*gr
= getgrnam(*argv
);
167 fprintf(stderr
, "invalid group \"%s\"\n", *argv
);
172 } else if (matches(*argv
, "pi") == 0) {
173 ifr
->ifr_flags
&= ~IFF_NO_PI
;
174 } else if (matches(*argv
, "one_queue") == 0) {
175 ifr
->ifr_flags
|= IFF_ONE_QUEUE
;
176 } else if (matches(*argv
, "vnet_hdr") == 0) {
177 ifr
->ifr_flags
|= IFF_VNET_HDR
;
178 } else if (matches(*argv
, "multi_queue") == 0) {
179 ifr
->ifr_flags
|= IFF_MULTI_QUEUE
;
180 } else if (matches(*argv
, "dev") == 0) {
182 if (get_ifname(ifr
->ifr_name
, *argv
))
183 invarg("\"dev\" not a valid ifname", *argv
);
185 if (matches(*argv
, "name") == 0) {
187 } else if (matches(*argv
, "help") == 0)
189 if (ifr
->ifr_name
[0])
190 duparg2("name", *argv
);
191 if (get_ifname(ifr
->ifr_name
, *argv
))
192 invarg("\"name\" not a valid ifname", *argv
);
198 if (!(ifr
->ifr_flags
& TUN_TYPE_MASK
)) {
199 fprintf(stderr
, "You failed to specify a tunnel mode\n");
207 static int do_add(int argc
, char **argv
)
213 if (parse_args(argc
, argv
, &ifr
, &uid
, &gid
) < 0)
216 return tap_add_ioctl(&ifr
, uid
, gid
);
219 static int do_del(int argc
, char **argv
)
223 if (parse_args(argc
, argv
, &ifr
, NULL
, NULL
) < 0)
226 return tap_del_ioctl(&ifr
);
229 static void print_flags(long flags
)
231 open_json_array(PRINT_JSON
, "flags");
234 print_string(PRINT_ANY
, NULL
, " %s", "tun");
237 print_string(PRINT_ANY
, NULL
, " %s", "tap");
239 if (!(flags
& IFF_NO_PI
))
240 print_string(PRINT_ANY
, NULL
, " %s", "pi");
242 if (flags
& IFF_ONE_QUEUE
)
243 print_string(PRINT_ANY
, NULL
, " %s", "one_queue");
245 if (flags
& IFF_VNET_HDR
)
246 print_string(PRINT_ANY
, NULL
, " %s", "vnet_hdr");
248 if (flags
& IFF_PERSIST
)
249 print_string(PRINT_ANY
, NULL
, " %s", "persist");
251 if (!(flags
& IFF_NOFILTER
))
252 print_string(PRINT_ANY
, NULL
, " %s", "filter");
254 flags
&= ~(IFF_TUN
| IFF_TAP
| IFF_NO_PI
| IFF_ONE_QUEUE
|
255 IFF_VNET_HDR
| IFF_PERSIST
| IFF_NOFILTER
);
257 print_0xhex(PRINT_ANY
, NULL
, "%#x", flags
);
259 close_json_array(PRINT_JSON
, NULL
);
262 static char *pid_name(pid_t pid
)
268 err
= asprintf(&comm
, "/proc/%d/comm", pid
);
272 f
= fopen(comm
, "r");
279 if (fscanf(f
, "%ms\n", &comm
) != 1) {
291 static void show_processes(const char *name
)
293 glob_t globbuf
= { };
297 err
= glob("/proc/[0-9]*/fd/[0-9]*", GLOB_NOSORT
,
302 open_json_array(PRINT_JSON
, "processes");
304 fd_path
= globbuf
.gl_pathv
;
306 const char *dev_net_tun
= "/dev/net/tun";
307 const size_t linkbuf_len
= strlen(dev_net_tun
) + 2;
308 char linkbuf
[linkbuf_len
], *fdinfo
;
312 if (sscanf(*fd_path
, "/proc/%d/fd/%d", &pid
, &fd
) != 2)
318 err
= readlink(*fd_path
, linkbuf
, linkbuf_len
- 1);
324 if (strcmp(dev_net_tun
, linkbuf
))
327 if (asprintf(&fdinfo
, "/proc/%d/fdinfo/%d", pid
, fd
) < 0)
330 f
= fopen(fdinfo
, "r");
338 char *key
= NULL
, *value
= NULL
;
340 err
= fscanf(f
, "%m[^:]: %ms\n", &key
, &value
);
345 } else if (err
== 2 &&
346 !strcmp("iff", key
) &&
347 !strcmp(name
, value
)) {
348 char *pname
= pid_name(pid
);
350 print_string(PRINT_ANY
, "name",
351 "%s", pname
? : "<NULL>");
353 print_uint(PRINT_ANY
, "pid",
367 close_json_array(PRINT_JSON
, NULL
);
372 static int tuntap_filter_req(struct nlmsghdr
*nlh
, int reqlen
)
374 struct rtattr
*linkinfo
;
377 linkinfo
= addattr_nest(nlh
, reqlen
, IFLA_LINKINFO
);
379 err
= addattr_l(nlh
, reqlen
, IFLA_INFO_KIND
,
380 drv_name
, sizeof(drv_name
) - 1);
384 addattr_nest_end(nlh
, linkinfo
);
389 static int print_tuntap(const struct sockaddr_nl
*who
,
390 struct nlmsghdr
*n
, void *arg
)
392 struct ifinfomsg
*ifi
= NLMSG_DATA(n
);
393 struct rtattr
*tb
[IFLA_MAX
+1];
394 struct rtattr
*linkinfo
[IFLA_INFO_MAX
+1];
395 const char *name
, *kind
;
396 long flags
, owner
= -1, group
= -1;
398 if (n
->nlmsg_type
!= RTM_NEWLINK
&& n
->nlmsg_type
!= RTM_DELLINK
)
401 if (n
->nlmsg_len
< NLMSG_LENGTH(sizeof(*ifi
)))
404 switch (ifi
->ifi_type
) {
412 parse_rtattr(tb
, IFLA_MAX
, IFLA_RTA(ifi
), IFLA_PAYLOAD(n
));
414 if (!tb
[IFLA_IFNAME
])
417 if (!tb
[IFLA_LINKINFO
])
420 parse_rtattr_nested(linkinfo
, IFLA_INFO_MAX
, tb
[IFLA_LINKINFO
]);
422 if (!linkinfo
[IFLA_INFO_KIND
])
425 kind
= rta_getattr_str(linkinfo
[IFLA_INFO_KIND
]);
426 if (strcmp(kind
, drv_name
))
429 name
= rta_getattr_str(tb
[IFLA_IFNAME
]);
431 if (read_prop(name
, "tun_flags", &flags
))
433 if (read_prop(name
, "owner", &owner
))
435 if (read_prop(name
, "group", &group
))
438 open_json_object(NULL
);
439 print_color_string(PRINT_ANY
, COLOR_IFNAME
,
440 "ifname", "%s:", name
);
443 print_uint(PRINT_ANY
, "user",
446 print_uint(PRINT_ANY
, "group",
447 " group %ld", group
);
450 print_string(PRINT_FP
, NULL
,
451 "%s\tAttached to processes:", _SL_
);
452 show_processes(name
);
455 print_string(PRINT_FP
, NULL
, "%s", "\n");
460 static int do_show(int argc
, char **argv
)
462 if (rtnl_wilddump_req_filter_fn(&rth
, AF_UNSPEC
, RTM_GETLINK
,
463 tuntap_filter_req
) < 0) {
464 perror("Cannot send dump request\n");
470 if (rtnl_dump_filter(&rth
, print_tuntap
, NULL
) < 0) {
471 fprintf(stderr
, "Dump terminated\n");
481 int do_iptuntap(int argc
, char **argv
)
484 if (matches(*argv
, "add") == 0)
485 return do_add(argc
-1, argv
+1);
486 if (matches(*argv
, "delete") == 0)
487 return do_del(argc
-1, argv
+1);
488 if (matches(*argv
, "show") == 0 ||
489 matches(*argv
, "lst") == 0 ||
490 matches(*argv
, "list") == 0)
491 return do_show(argc
-1, argv
+1);
492 if (matches(*argv
, "help") == 0)
495 return do_show(0, NULL
);
497 fprintf(stderr
, "Command \"%s\" is unknown, try \"ip tuntap help\".\n",
502 static void print_owner(FILE *f
, uid_t uid
)
504 struct passwd
*pw
= getpwuid(uid
);
507 print_string(PRINT_ANY
, "user", "user %s ", pw
->pw_name
);
509 print_uint(PRINT_ANY
, "user", "user %u ", uid
);
512 static void print_group(FILE *f
, gid_t gid
)
514 struct group
*group
= getgrgid(gid
);
517 print_string(PRINT_ANY
, "group", "group %s ", group
->gr_name
);
519 print_uint(PRINT_ANY
, "group", "group %u ", gid
);
522 static void print_mq(FILE *f
, struct rtattr
*tb
[])
524 if (!tb
[IFLA_TUN_MULTI_QUEUE
] ||
525 !rta_getattr_u8(tb
[IFLA_TUN_MULTI_QUEUE
])) {
526 if (is_json_context())
527 print_bool(PRINT_JSON
, "multi_queue", NULL
, false);
531 print_bool(PRINT_ANY
, "multi_queue", "multi_queue ", true);
533 if (tb
[IFLA_TUN_NUM_QUEUES
]) {
534 print_uint(PRINT_ANY
, "numqueues", "numqueues %u ",
535 rta_getattr_u32(tb
[IFLA_TUN_NUM_QUEUES
]));
538 if (tb
[IFLA_TUN_NUM_DISABLED_QUEUES
]) {
539 print_uint(PRINT_ANY
, "numdisabled", "numdisabled %u ",
540 rta_getattr_u32(tb
[IFLA_TUN_NUM_DISABLED_QUEUES
]));
544 static void print_onoff(FILE *f
, const char *flag
, __u8 val
)
546 if (is_json_context())
547 print_bool(PRINT_JSON
, flag
, NULL
, !!val
);
549 fprintf(f
, "%s %s ", flag
, val
? "on" : "off");
552 static void print_type(FILE *f
, __u8 type
)
555 const char *str
= buf
;
559 else if (type
== IFF_TAP
)
562 snprintf(buf
, sizeof(buf
), "UNKNOWN:%hhu", type
);
564 print_string(PRINT_ANY
, "type", "type %s ", str
);
567 static void tun_print_opt(struct link_util
*lu
, FILE *f
, struct rtattr
*tb
[])
572 if (tb
[IFLA_TUN_TYPE
])
573 print_type(f
, rta_getattr_u8(tb
[IFLA_TUN_TYPE
]));
576 print_onoff(f
, "pi", rta_getattr_u8(tb
[IFLA_TUN_PI
]));
578 if (tb
[IFLA_TUN_VNET_HDR
]) {
579 print_onoff(f
, "vnet_hdr",
580 rta_getattr_u8(tb
[IFLA_TUN_VNET_HDR
]));
585 if (tb
[IFLA_TUN_PERSIST
])
586 print_onoff(f
, "persist", rta_getattr_u8(tb
[IFLA_TUN_PERSIST
]));
588 if (tb
[IFLA_TUN_OWNER
])
589 print_owner(f
, rta_getattr_u32(tb
[IFLA_TUN_OWNER
]));
591 if (tb
[IFLA_TUN_GROUP
])
592 print_group(f
, rta_getattr_u32(tb
[IFLA_TUN_GROUP
]));
595 struct link_util tun_link_util
= {
597 .maxattr
= IFLA_TUN_MAX
,
598 .print_opt
= tun_print_opt
,