Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tapsetup: add more features #14928

Merged
merged 6 commits into from
Sep 8, 2020
Merged

tapsetup: add more features #14928

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
de36c40
tapsetup: make output easier to parse
miri64 Sep 2, 2020
a9722dd
tapsetup: add capability to list bridges
miri64 Sep 1, 2020
0abe581
tapsetup: add capability to enable forwarding for bridge
miri64 Sep 1, 2020
dbeb783
tapsetup: add capability to add addresses to bridge
miri64 Sep 2, 2020
29684af
tapsetup: add capability to add routes to bridge
miri64 Sep 2, 2020
5fea5fc
tapsetup: FreeBSD/OSX: remove member TAPs of bridge explicitly
miri64 Sep 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
238 changes: 233 additions & 5 deletions dist/tools/tapsetup/tapsetup
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ COMMAND=""
BRNAME="tapbr0"
TAPNAME="tap"
DEACTIVATE_IPV6=""
ENABLE_FORWARDING=0
BRIDGE_ADDRS=""
BRIDGE_ROUTES=""
DEFAULT_PREFIX_LEN=128
UPLINK=""

usage() {
Expand All @@ -17,6 +21,17 @@ usage() {
echo "Options:" >&2
echo " -c [<num>], --create [<num>]: Create <num> tap interfaces (default: 2)" >&2
echo " -d, --delete: Delete all interface" >&2
echo " -l <iface>, --list <iface>: If <iface> belongs to a bridge, list the bridge and" >&2
echo " all interfaces that belong to it. If <iface> does " >&2
echo" not belong to a bridge, just print <iface>." >&2
echo " -a <address>[/<prefix_len>], --address <address>[/<prefix_len>]:" >&2
echo " Address to add to the created bridge. Can be used" >&2
echo " multiple times." >&2
echo " -r <route>[/<prefix_len>] <next_hop>, --route <route>[/<prefix_len>] <next_hop>:" >&2
echo " Route to add to via the created bridge. Can be used" >&2
echo " multiple times." >&2
echo " -f, --forwarding Enable forwarding system-wide on creation and " >&2
echo " disable on deletion." >&2
echo " -b <name>, --bridge <name>: Give name for the bridge (default: tapbr)" >&2
echo " -t <name>, --tap <name>: Name base for the tap interfaces; the" >&2
echo " generated names will be <name>x" >&2
Expand All @@ -43,8 +58,66 @@ update_uplink() {
fi
}

activate_forwarding() {
if [ ${ENABLE_FORWARDING} -eq 1 ]; then
case "${PLATFORM}" in
FreeBSD|OSX)
sysctl -w net.inet.ip.forwarding=1 || exit 1 ;;
Linux)
sysctl -w net.ipv6.conf.${BRNAME}.forwarding=1 || exit 1
sysctl -w net.ipv6.conf.${BRNAME}.accept_ra=0 || exit 1
sysctl -w net.ipv6.conf.all.forwarding=1 || exit 1 ;;
*) ;;
esac
fi
}

add_ipv6_addrs() {
for a in ${BRIDGE_ADDRS}; do
address_addr=$(echo "${a}" | cut -d/ -f1)
prefix_len=$(echo "${a}" | cut -d/ -f2)
if [ "${a}" = "${prefix_len}" ]; then
# prefix length is not defined
prefix_len=${DEFAULT_PREFIX_LEN}
fi
case "${PLATFORM}" in
FreeBSD|OSX)
ifconfig ${BRNAME} inet6 ${address_addr} prefixlen ${prefix_len} || exit 1
;;
Linux)
ip address add ${address_addr}/${prefix_len} dev ${BRNAME} || exit 1
;;
*) ;;
esac
done
}

add_ipv6_routes() {
for r in ${BRIDGE_ROUTES}; do
route=$(echo "${r}" | cut -d- -f1)
next_hop=$(echo "${r}" | cut -d- -f2)
route_prefix=$(echo "${route}" | cut -d/ -f1)
route_prefix_len=$(echo "${route}" | cut -d/ -f2)
if [ "${route}" = "${route_prefix_len}" ]; then
# prefix length is not defined
route_prefix_len=${DEFAULT_PREFIX_LEN}
fi
case "${PLATFORM}" in
FreeBSD|OSX)
route -6n add ${route_prefix} -interface ${BRNAME} \
${next_hop} || exit 1
;;
Linux)
ip route add ${route_prefix}/${route_prefix_len} \
via ${next_hop} dev ${BRNAME} || exit 1
;;
*) ;;
esac
done
}

create_bridge() {
echo "creating ${BRNAME}"
echo "creating bridge ${BRNAME}"

case "${PLATFORM}" in
FreeBSD)
Expand Down Expand Up @@ -82,12 +155,73 @@ up_bridge() {
esac
}

deactivate_forwarding() {
if [ ${ENABLE_FORWARDING} -eq 1 ]; then
case "${PLATFORM}" in
FreeBSD|OSX)
sysctl -w net.inet.ip.forwarding=0 || exit 1 ;;
Linux)
sysctl -w net.ipv6.conf.${BRNAME}.forwarding=0 || exit 1
sysctl -w net.ipv6.conf.${BRNAME}.accept_ra=1 || exit 1
sysctl -w net.ipv6.conf.all.forwarding=0 || exit 1 ;;
*) ;;
esac
fi
}

del_ipv6_addrs() {
for a in ${BRIDGE_ADDRS}; do
address_addr=$(echo "${a}" | cut -d/ -f1)
prefix_len=$(echo "${a}" | cut -d/ -f2)
if [ "${a}" = "${prefix_len}" ]; then
# prefix length is not defined
prefix_len=${DEFAULT_PREFIX_LEN}
fi
case "${PLATFORM}" in
FreeBSD|OSX)
ifconfig ${BRNAME} inet6 ${address_addr} prefixlen ${prefix_len} delete || exit 1
;;
Linux)
ip address delete ${address_addr}/${prefix_len} dev ${BRNAME} || exit 1
;;
*) ;;
esac
done
}

del_ipv6_routes() {
for r in ${BRIDGE_ROUTES}; do
route=$(echo "${r}" | cut -d- -f1)
next_hop=$(echo "${r}" | cut -d- -f2)
route_prefix=$(echo "${route}" | cut -d/ -f1)
route_prefix_len=$(echo "${route}" | cut -d/ -f2)
if [ "${route}" = "${route_prefix_len}" ]; then
# prefix length is not defined
route_prefix_len=${DEFAULT_PREFIX_LEN}
fi
case "${PLATFORM}" in
FreeBSD|OSX)
route -6 delete ${route_prefix}/${route_prefix_len} \
-interface ${BRNAME} ${next_hop} || exit 1
;;
Linux)
ip route delete ${route_prefix}/${route_prefix_len} \
via ${next_hop} dev ${BRNAME} || exit 1
;;
*) ;;
esac
done
}

delete_bridge() {
echo "deleting ${BRNAME}"

case "${PLATFORM}" in
FreeBSD)
sysctl net.link.tap.user_open=0
for IF in $(ifconfig ${BRIDGE} | grep -oiE "member: .+ " | cut -d' ' -f2); do
ifconfig $IF destroy || exit 1
done
ifconfig ${BRNAME} destroy || exit 1
kldunload if_tap # unloading might fail due to dependencies
kldunload if_bridge ;;
Expand All @@ -105,6 +239,9 @@ delete_bridge() {
update_uplink ${UPLINK}
fi ;;
OSX)
for IF in $(ifconfig ${BRIDGE} | grep -oiE "member: .+ " | cut -d' ' -f2); do
ifconfig $IF destroy || exit 1
done
ifconfig ${BRNAME} destroy || exit 1 ;;
*)
;;
Expand Down Expand Up @@ -148,11 +285,64 @@ create_tap() {
esac
}

get_master() {
IFACE=$1
case "${PLATFORM}" in
Linux)
MASTER=$(ip link show ${IFACE} | grep -o "master \S\+" | cut -d' ' -f2)
;;
FreeBSD|OSX)
for IF in $(ifconfig | grep -oiE "^[a-z0-9_-]+"); do
if ifconfig $IF | grep -q "member: $IFACE"; then
MASTER=${IF}
break
fi
done
;;
*)
;;
esac
if [ -z "$MASTER" ]; then
# IFACE is its own master
echo "$IFACE"
else
echo "$MASTER"
fi
}

list_bridge() {
BRIDGE=$1
echo "$BRIDGE:"
case "${PLATFORM}" in
Linux)
for IF in $(ls /sys/class/net/${BRIDGE}/brif); do
echo "- $IF"
done
;;
FreeBSD|OSX)
for IF in $(ifconfig ${BRIDGE} | grep -oiE "member: .+ " | cut -d' ' -f2); do
echo "- $IF"
done
;;
*)
;;
esac
}

while true ; do
case "$1" in
-6)
DEACTIVATE_IPV6=1
shift ;;
-a|--address)
# check if valid address + optional prefix length
if echo "$2" | grep -q "^[a-f0-9:]\+\(/[0-9]\+\)\?$"; then
BRIDGE_ADDRS="${BRIDGE_ADDRS} $2"
shift 2
else
usage
exit 2
fi ;;
-b|--bridge)
case "$2" in
"")
Expand Down Expand Up @@ -185,9 +375,39 @@ while true ; do
fi
COMMAND="delete"
shift ;;
-f|--forwarding)
ENABLE_FORWARDING=1
shift ;;
-l|--list)
if [ -n "${COMMAND}" ]; then
usage
exit 2
fi
COMMAND="list"
case "$2" in
"")
usage
exit 2 ;;
*)
BRNAME="$2"
shift 2 ;;
esac ;;
-h|--help)
usage
exit ;;
-r|--route)
# check if valid address + optional prefix length
if ! echo "$2" | grep -q "^[a-f0-9:]\+\(/[0-9]\+\)\?$"; then
usage
exit 2
fi
# check if valid next hop
if ! echo "$3" | grep -q "^[a-f0-9:]\+$"; then
usage
exit 2
fi
BRIDGE_ROUTES="${BRIDGE_ROUTES} $2-$3"
shift 3 ;;
-u|--uplink)
case "$2" in
"")
Expand All @@ -213,13 +433,13 @@ while true ; do
esac
done

if [ -z "${SUDO_USER}" ]; then
echo 'Environment variable $SUDO_USER required; Please run with `sudo`'
exit 1
fi
if [ -z "${COMMAND}" ]; then
COMMAND="create"
fi
if [ -z "${SUDO_USER}" ] && [ "${COMMAND}" != "list" ]; then
echo 'Environment variable $SUDO_USER required; Please run with `sudo`'
exit 1
fi
case "$(uname -s)" in
Darwin)
PLATFORM="OSX"
Expand Down Expand Up @@ -247,10 +467,18 @@ if [ "${COMMAND}" = 'create' ]; then
create_tap || exit 1
done

activate_forwarding || exit 1
up_bridge || exit 1
add_ipv6_addrs || exit 1
add_ipv6_routes || exit 1

elif [ "${COMMAND}" = 'delete' ]; then
del_ipv6_routes || exit 1
del_ipv6_addrs || exit 1
deactivate_forwarding || exit 1
delete_bridge
elif [ "${COMMAND}" = 'list' ]; then
list_bridge $(get_master "$BRNAME")
else
echo 'unknown command'
exit 1
Expand Down