änderungen für mac

This commit is contained in:
marcusH
2026-06-21 11:40:15 +02:00
parent fe9973f831
commit a89c3df49b
4549 changed files with 576393 additions and 0 deletions
@@ -0,0 +1,629 @@
#!/usr/bin/env python3
import argparse
import os
from enum import Enum
from ipaddress import IPv4Address, IPv4Network, IPv6Address, IPv6Interface, IPv6Network, ip_address, ip_network
from itertools import chain, zip_longest
from random import choice, randint, shuffle
from subprocess import CalledProcessError
from sys import platform, stderr
from time import sleep
try:
from setproctitle import setproctitle
except ImportError:
def setproctitle(title):
pass
def tagged(iter, tag):
return zip_longest(iter, (), fillvalue=tag)
from .util import slurpy
from .version import __version__
def get_default_providers():
try:
from .dnspython import DNSPythonProvider
except ImportError:
DNSPythonProvider = None
if platform.startswith('linux'):
from .linux import CheckTunDevProvider, Iproute2Provider, IptablesProvider, ProcfsProvider
from .posix import DigProvider, PosixHostsFileProvider
return dict(
process = ProcfsProvider,
route = Iproute2Provider,
firewall = IptablesProvider,
dns = DNSPythonProvider or DigProvider,
hosts = PosixHostsFileProvider,
prep = CheckTunDevProvider,
)
elif platform.startswith('darwin'):
from distutils.version import LooseVersion
from platform import release
from .dnspython import DNSPythonProvider
from .mac import BSDRouteProvider, MacSplitDNSProvider, PfFirewallProvider, PsProvider
from .posix import PosixHostsFileProvider
return dict(
process=PsProvider,
route=BSDRouteProvider,
dns=DNSPythonProvider or DigProvider,
hosts=PosixHostsFileProvider,
domain_vpn_dns=MacSplitDNSProvider,
firewall = PfFirewallProvider if release() >= LooseVersion('10.6') else None,
)
elif platform.startswith('freebsd'):
from .dnspython import DNSPythonProvider
from .freebsd import ProcfsProvider
from .mac import BSDRouteProvider
from .posix import PosixHostsFileProvider
return dict(
process = ProcfsProvider,
route = BSDRouteProvider,
dns = DNSPythonProvider or DigProvider,
hosts = PosixHostsFileProvider,
)
else:
return dict(
platform = OSError('Your platform, {}, is unsupported'.format(platform))
)
def net_or_host_param(s):
if '=' in s:
hosts = s.split('=')
ip = hosts.pop()
return hosts, ip_address(ip)
else:
if s.lstrip().startswith('%'):
include = False
s = s.lstrip()[1:]
else:
include = True
try:
return include, ip_network(s, strict=False)
except ValueError:
return s
def names_for(host, domains, short=True, long=True):
if '.' in host: first, rest = host.split('.', 1)
else: first, rest = host, None
if isinstance(domains, str): domains = (domains,)
names = []
if long:
if rest: names.append(host)
elif domains: names.append(host+'.'+domains[0])
if short:
if not rest: names.append(host)
elif rest in domains: names.append(first)
return names
########################################
def do_pre_init(env, args):
global providers
if 'prep' in providers:
providers.prep.create_tunnel()
providers.prep.prepare_tunnel()
def do_disconnect(env, args):
global providers
for pidfile in args.kill:
try:
pid = int(open(pidfile).read())
except (IOError, ValueError):
print("WARNING: could not read pid from %s" % pidfile, file=stderr)
else:
try: providers.process.kill(pid)
except OSError as e:
print("WARNING: could not kill pid %d from %s: %s" % (pid, pidfile, str(e)), file=stderr)
else:
if args.verbose:
print("Killed pid %d from %s" % (pid, pidfile), file=stderr)
if 'hosts' in providers:
removed = providers.hosts.write_hosts({}, args.name)
if args.verbose:
print("Removed %d hosts from /etc/hosts" % removed, file=stderr)
# delete explicit route to gateway
try:
providers.route.remove_route(env.gateway)
except CalledProcessError:
print("WARNING: could not delete route to VPN gateway (%s)" % env.gateway, file=stderr)
# remove firewall rule blocking incoming traffic
if 'firewall' in providers and not args.incoming:
try:
providers.firewall.deconfigure_firewall(env.tundev)
except CalledProcessError:
print("WARNING: failed to deconfigure firewall for VPN interface (%s)" % env.tundev, file=stderr)
if args.vpn_domains is not None:
try:
providers.domain_vpn_dns.deconfigure_domain_vpn_dns(args.vpn_domains, env.dns)
except OSError:
print("WARNING: failed to deconfigure domains vpn dns", file=stderr)
def do_connect(env, args):
global providers
if args.banner and env.banner:
print("Connect Banner:")
for l in env.banner.splitlines(): print("| "+l)
# set explicit route to gateway
if env.gateway.is_loopback:
print("WARNING: Gateway address is loopback (%s); probably a local proxy.", file=stderr)
else:
gwr = providers.route.get_route(env.gateway)
if gwr:
providers.route.replace_route(env.gateway, **gwr)
if args.verbose > 1:
print("Set explicit route to VPN gateway %s (%s)" % (env.gateway, ', '.join('%s %s' % kv for kv in gwr.items())), file=stderr)
else:
print("WARNING: no route to VPN gateway found %s; cannot set explicit route to it." % env.gateway)
# drop incoming traffic from VPN
if not args.incoming:
if 'firewall' not in providers:
print("WARNING: no firewall provider available; can't block incoming traffic", file=stderr)
else:
try:
providers.firewall.configure_firewall(env.tundev)
if args.verbose:
print("Blocked incoming traffic from VPN interface with iptables.", file=stderr)
except CalledProcessError:
try:
providers.firewall.deconfigure_firewall(env.tundev)
except CalledProcessError:
pass
print("WARNING: failed to block incoming traffic", file=stderr)
# configure MTU
mtu = env.mtu
if mtu is None:
dev = gwr.get('dev')
if dev:
dev_mtu = providers.route.get_link_info(dev).get('mtu')
if dev_mtu:
mtu = int(dev_mtu) - 88
if mtu:
print("WARNING: guessing MTU is %d (the MTU of %s - 88)" % (mtu, dev), file=stderr)
else:
mtu = 1412
print("WARNING: guessing default MTU of %d (couldn't determine MTU of %s)" % (mtu, dev), file=stderr)
providers.route.set_link_info(env.tundev, state='up', mtu=mtu)
# set IPv4, IPv6 addresses for tunnel device
if env.myaddr:
providers.route.add_address(env.tundev, env.myaddr)
if env.myaddr6:
providers.route.add_address(env.tundev, env.myaddr6)
# save routes for excluded subnets
exc_subnets = []
for dest in args.exc_subnets:
r = providers.route.get_route(dest)
if r:
exc_subnets.append((dest, r))
else:
print("WARNING: Ignoring unroutable split-exclude %s" % dest, file=stderr)
# set up routes to the DNS and Windows name servers, subnets, and local aliases
ns = env.dns + env.dns6 + (env.nbns if args.nbns else [])
for dest, tag in chain(tagged(ns, "nameserver"), tagged(args.subnets, "subnet"), tagged(args.aliases, "alias")):
if args.verbose > 1:
print("Adding route to %s %s through %s." % (tag, dest, env.tundev), file=stderr)
providers.route.replace_route(dest, dev=env.tundev)
else:
providers.route.flush_cache()
if args.verbose:
print("Added routes for %d nameservers, %d subnets, %d aliases." % (len(ns), len(args.subnets), len(args.aliases)), file=stderr)
# restore routes to excluded subnets
for dest, exc_route in exc_subnets:
providers.route.replace_route(dest, **exc_route)
if args.verbose > 1:
print("Restoring split-exclude route to %s (%s)" % (dest, ', '.join('%s %s' % kv for kv in exc_route.items())), file=stderr)
else:
providers.route.flush_cache()
if args.verbose:
print("Restored routes for %d excluded subnets." % len(exc_subnets), file=stderr)
# Use vpn dns for provided domains
if args.vpn_domains is not None:
if 'domain_vpn_dns' not in providers:
print("WARNING: no split dns provider available; can't split dns", file=stderr)
else:
providers.domain_vpn_dns.configure_domain_vpn_dns(args.vpn_domains, env.dns)
def do_post_connect(env, args):
global providers
# lookup named hosts for which we need routes and/or host_map entries
# (the DNS/NBNS servers already have their routes)
ip_routes = set()
host_map = []
if args.ns_hosts:
ns_names = [ (ip, ('dns%d.%s' % (ii, args.name),)) for ii, ip in enumerate(env.dns + env.dns6) ]
if args.nbns:
ns_names += [ (ip, ('nbns%d.%s' % (ii, args.name),)) for ii, ip in enumerate(env.nbns) ]
host_map += ns_names
if args.verbose:
print("Adding /etc/hosts entries for %d nameservers..." % len(ns_names), file=stderr)
for ip, names in ns_names:
print(" %s = %s" % (ip, ', '.join(map(str, names))), file=stderr)
if args.hosts or args.prevent_idle_timeout:
providers.dns.configure(dns_servers=(env.dns + env.dns6), search_domains=args.domain, bind_addresses=env.myaddrs)
if args.hosts:
if args.verbose:
print("Looking up %d hosts using VPN DNS servers..." % len(args.hosts), file=stderr)
for host in args.hosts:
try:
ips = providers.dns.lookup_host(host)
except Exception as e:
print("WARNING: Lookup for %s on VPN DNS servers failed:\n\t%s" % (host, e), file=stderr)
else:
if ips is None:
print("WARNING: Lookup for %s on VPN DNS servers returned nothing." % host, file=stderr)
else:
if args.verbose:
print(" %s = %s" % (host, ', '.join(map(str, ips))), file=stderr)
ip_routes.update(ips)
if args.host_names:
names = names_for(host, args.domain, args.short_names)
host_map.extend((ip, names) for ip in ips)
for ip, aliases in args.aliases.items():
host_map.append((ip, aliases))
# add them to /etc/hosts
if host_map:
providers.hosts.write_hosts(host_map, args.name)
if args.verbose:
print("Added hostnames and aliases for %d addresses to /etc/hosts." % len(host_map), file=stderr)
# add routes to hosts
for ip in ip_routes:
if args.verbose > 1:
print("Adding route to %s (for named hosts) through %s." % (ip, env.tundev), file=stderr)
providers.route.replace_route(ip, dev=env.tundev)
else:
providers.route.flush_cache()
if args.verbose:
print("Added %d routes for named hosts." % len(ip_routes), file=stderr)
# run DNS queries in background to prevent idle timeout
if args.prevent_idle_timeout:
dns = env.dns + env.dns6
idle_timeout = env.idle_timeout
setproctitle('vpn-slice --prevent-idle-timeout --name %s' % args.name)
if args.verbose:
print("Continuing in background as PID %d, attempting to prevent idle timeout every %d seconds." % (providers.process.pid(), idle_timeout))
while True:
delay = randint(2 * idle_timeout // 3, 9 * idle_timeout // 10)
if args.verbose > 1:
print("Sleeping %d seconds until we issue a DNS query to prevent idle timeout..." % delay, file=stderr)
sleep(delay)
# FIXME: netlink(7) may be a much better way to poll here
if not providers.process.is_alive(args.ppid):
print("Caller (PID %d) has terminated; idle preventer exiting." % args.ppid, file=stderr)
break
# pick random host or IP to look up without leaking any new information
# about what we do/don't access within the VPN
pool = args.hosts
pool += map(str, chain(env.dns, env.dns6, env.nbns, ((r.network_address) for r in args.subnets if r.prefixlen == r.max_prefixlen)))
dummy = choice(pool)
shuffle(dns)
if args.verbose > 1:
print("Issuing DNS lookup of %s to prevent idle timeout..." % dummy, file=stderr)
providers.dns.lookup_host(dummy, keep_going=False)
elif args.verbose:
print("Connection setup done, child process %d exiting." % providers.process.pid())
########################################
# Translate environment variables which may be passed by our caller
# into a more Pythonic form (these are take from vpnc-script)
reasons = Enum('reasons', 'pre_init connect disconnect reconnect attempt_reconnect')
vpncenv = [
('reason', 'reason', lambda x: reasons[x.replace('-', '_')]),
('vpnfd', 'VPNFD', int), # set if OpenConnect invoked in --script-tun/ocproxy mode
('gateway', 'VPNGATEWAY', ip_address),
('tundev', 'TUNDEV', str),
('domain', 'CISCO_DEF_DOMAIN', lambda x: x.split(), []),
('splitdns', 'CISCO_SPLIT_DNS', lambda x: x.split(','), []),
('banner', 'CISCO_BANNER', str),
('myaddr', 'INTERNAL_IP4_ADDRESS', IPv4Address), # a.b.c.d
('mtu', 'INTERNAL_IP4_MTU', int),
('netmask', 'INTERNAL_IP4_NETMASK', IPv4Address), # a.b.c.d
('netmasklen', 'INTERNAL_IP4_NETMASKLEN', int),
('network', 'INTERNAL_IP4_NETADDR', IPv4Address), # a.b.c.d
('dns', 'INTERNAL_IP4_DNS', lambda x: [ip_address(x) for x in x.split()], []),
('nbns', 'INTERNAL_IP4_NBNS', lambda x: [IPv4Address(x) for x in x.split()], []),
('myaddr6', 'INTERNAL_IP6_ADDRESS', IPv6Interface), # x:y::z or x:y::z/p
('netmask6', 'INTERNAL_IP6_NETMASK', IPv6Interface), # x:y:z:: or x:y::z/p
('dns6', 'INTERNAL_IP6_DNS', lambda x: [ip_address(x) for x in x.split()], []),
('nsplitinc', 'CISCO_SPLIT_INC', int, 0),
('nsplitexc', 'CISCO_SPLIT_EXC', int, 0),
('nsplitinc6', 'CISCO_IPV6_SPLIT_INC', int, 0),
('nsplitexc6', 'CISCO_IPV6_SPLIT_EXC', int, 0),
('idle_timeout', 'IDLE_TIMEOUT', int, 600), # OpenConnect v8.06+
('vpnpid', 'VPNPID', int), # OpenConnect v9.0+
]
def parse_env(environ=os.environ):
global vpncenv
env = slurpy()
for var, envar, maker, *default in vpncenv:
if envar in environ:
try: val = maker(environ[envar])
except Exception as e:
print('Exception while setting %s from environment variable %s=%r' % (var, envar, environ[envar]), file=stderr)
raise
elif default: val, = default
else: val = None
if var is not None: env[var] = val
# IPv4 network is the combination of the network address (e.g. 192.168.0.0) and the netmask (e.g. 255.255.0.0)
if env.network:
orig_netaddr = env.network
env.network = IPv4Network(env.network).supernet(new_prefix=env.netmasklen)
if env.network.network_address != orig_netaddr:
print("WARNING: IPv4 network %s/%d has host bits set, replacing with %s" % (orig_netaddr, env.netmasklen, env.network), file=stderr)
if env.network.netmask != env.netmask:
raise AssertionError("IPv4 network (INTERNAL_IP4_{{NETADDR,NETMASK}}) {ad}/{nm} does not match INTERNAL_IP4_NETMASKLEN={nml} (implies /{nmi})".format(
ad=orig_netaddr, nm=env.netmask, nml=env.netmasklen, nmi=env.network.netmask))
assert env.network.netmask == env.netmask
# Need to match behavior of original vpnc-script here
# Examples:
# 1) INTERNAL_IP6_ADDRESS=fe80::1, INTERNAL_IP6_NETMASK=fe80::/64 => interface of fe80::1/64, network of fe80::/64
# 2) INTERNAL_IP6_ADDRESS=unset, INTERNAL_IP6_NETMASK=fe80::1/64 => interface of fe80::1/64, network of fe80::/64
# 3) INTERNAL_IP6_ADDRESS=2000::1, INTERNAL_IP6_NETMASK=unset => interface of 2000::1/128, network of 2000::1/128
if env.myaddr6 or env.netmask6:
if not env.netmask6:
env.netmask6 = IPv6Network(env.myaddr6) # case 3 above, /128
env.myaddr6 = IPv6Interface(env.netmask6)
env.network6 = env.myaddr6.network
else:
env.myaddr6 = None
env.network6 = None
env.myaddrs = list(filter(None, (env.myaddr, env.myaddr6)))
# Handle splits
env.splitinc = []
env.splitexc = []
for pfx, n in chain((('INC', n) for n in range(env.nsplitinc)),
(('EXC', n) for n in range(env.nsplitexc))):
ad = IPv4Address(environ['CISCO_SPLIT_%s_%d_ADDR' % (pfx, n)])
nm = IPv4Address(environ['CISCO_SPLIT_%s_%d_MASK' % (pfx, n)])
nml = int(environ['CISCO_SPLIT_%s_%d_MASKLEN' % (pfx, n)])
net = IPv4Network(ad).supernet(new_prefix=nml)
if net.network_address != ad:
print("WARNING: IPv4 split network (CISCO_SPLIT_%s_%d_{ADDR,MASK}) %s/%d has host bits set, replacing with %s" % (pfx, n, ad, nml, net), file=stderr)
if net.netmask != nm:
raise AssertionError("IPv4 split network (CISCO_SPLIT_{pfx}_{n}_{{ADDR,MASK}}) {ad}/{nm} does not match CISCO_SPLIT_{pfx}_{n}_MASKLEN={nml} (implies /{nmi})".format(
pfx=pfx, n=n, ad=ad, nm=nm, nml=nml, nmi=net.netmask))
env['split' + pfx.lower()].append(net)
for pfx, n in chain((('INC', n) for n in range(env.nsplitinc6)),
(('EXC', n) for n in range(env.nsplitexc6))):
ad = IPv6Address(environ['CISCO_IPV6_SPLIT_%s_%d_ADDR' % (pfx, n)])
nml = int(environ['CISCO_IPV6_SPLIT_%s_%d_MASKLEN' % (pfx, n)])
net = IPv6Network(ad).supernet(new_prefix=nml)
if net.network_address != ad:
print("WARNING: IPv6 split network (CISCO_IPV6_SPLIT_%s_%d_{ADDR,MASKLEN}) %s/%d has host bits set, replacing with %s" % (pfx, n, ad, nml, net), file=stderr)
env['split' + pfx.lower()].append(net)
return env
# Parse command-line arguments and environment
def parse_args_and_env(args=None, environ=os.environ):
p = argparse.ArgumentParser()
p.add_argument('routes', nargs='*', type=net_or_host_param, help='List of VPN-internal hostnames, included subnets (e.g. 192.168.0.0/24), excluded subnets (e.g. %%8.0.0.0/8), or aliases (e.g. host1=192.168.1.2) to add to routing and /etc/hosts.')
g = p.add_argument_group('Subprocess options')
g.add_argument('-k', '--kill', default=[], action='append', help='File containing PID to kill before disconnect (may be specified multiple times)')
g.add_argument('-K', '--prevent-idle-timeout', action='store_true', help='Prevent idle timeout by doing random DNS lookups (interval set by $IDLE_TIMEOUT, defaulting to 10 minutes)')
g = p.add_argument_group('Informational options')
g.add_argument('--banner', action='store_true', help='Print banner message (default is to suppress it)')
g = p.add_argument_group('Routing and hostname options')
g.add_argument('-i', '--incoming', action='store_true', help='Allow incoming traffic from VPN (default is to block)')
g.add_argument('-n', '--name', default=None, help='Name of this VPN (default is $TUNDEV)')
g.add_argument('-d', '--domain', action='append', help='Search domain inside the VPN (default is $CISCO_DEF_DOMAIN)')
g.add_argument('-I', '--route-internal', action='store_true', help="Add route for VPN's default subnet (passed in as $INTERNAL_IP*_NET*")
g.add_argument('-S', '--route-splits', action='store_true', help="Add route for VPN's split-tunnel subnets (passed in via $CISCO_SPLIT_*)")
g.add_argument('--no-host-names', action='store_false', dest='host_names', default=True, help='Do not add either short or long hostnames to /etc/hosts')
g.add_argument('--no-short-names', action='store_false', dest='short_names', default=True, help="Only add long/fully-qualified domain names to /etc/hosts")
g = p.add_argument_group('Nameserver options')
g.add_argument('--no-ns-hosts', action='store_false', dest='ns_hosts', default=True, help='Do not add nameserver aliases to /etc/hosts (default is to name them dns0.tun0, etc.)')
g.add_argument('--nbns', action='store_true', dest='nbns', help='Include NBNS (Windows/NetBIOS nameservers) as well as DNS nameservers')
g.add_argument('--domains-vpn-dns', dest='vpn_domains', default=None, help="comma separated domains to query with vpn dns")
g = p.add_argument_group('Debugging options')
g.add_argument('--self-test', action='store_true', help='Stop after verifying that environment variables and providers are configured properly.')
g.add_argument('-v', '--verbose', default=0, action='count', help="Explain what %(prog)s is doing. Specify repeatedly to increase the level of detail.")
p.add_argument('-V', '--version', action='version', version='%(prog)s ' + __version__)
g.add_argument('-D', '--dump', action='store_true', help='Dump environment variables passed by caller')
g.add_argument('--no-fork', action='store_false', dest='fork', help="Don't fork and continue in background on connect")
g.add_argument('--ppid', type=int, help='PID of calling process (normally autodetected, when using openconnect or vpnc)')
args = p.parse_args(args)
env = parse_env(environ)
# use the tunnel device as the VPN name if unspecified
if args.name is None:
args.name = env.tundev
# use the PID provided by the caller if unspecified
if args.ppid is None:
args.ppid = env.vpnpid
# use the list from the env if --domain wasn't specified, but start with an
# empty list if it was specified; hence can't use 'default' here:
if args.domain is None:
args.domain = env.domain
args.subnets = []
args.exc_subnets = []
args.hosts = []
args.aliases = {}
for x in args.routes:
if isinstance(x, str):
args.hosts.append(x)
elif x[0] in (True, False):
include, net = x
if include: args.subnets.append(net)
else: args.exc_subnets.append(net)
else:
hosts, ip = x
args.aliases.setdefault(ip, []).extend(hosts)
if args.route_internal:
if env.network: args.subnets.append(env.network)
if env.network6: args.subnets.append(env.network6)
if args.route_splits:
args.subnets.extend(env.splitinc)
args.exc_subnets.extend(env.splitexc)
if args.vpn_domains is not None:
args.vpn_domains = str.split(args.vpn_domains, ',')
return p, args, env
def finalize_args_and_env(args, env):
global providers
# autodetect parent or grandparent process (skipping intermediary shell)
if args.ppid is None:
args.ppid = providers.process.ppid_of(None)
exe = providers.process.pid2exe(args.ppid)
if exe and os.path.basename(exe) in ('dash', 'bash', 'sh', 'tcsh', 'csh', 'ksh', 'zsh'):
args.ppid = providers.process.ppid_of(args.ppid)
def main(args=None, environ=os.environ):
global providers
try:
p, args, env = parse_args_and_env(args, environ)
# Set platform-specific providers
providers = slurpy()
for pn, pv in get_default_providers().items():
try:
if isinstance(pv, Exception):
raise pv
providers[pn] = pv()
except Exception as e:
print("WARNING: Couldn't configure {} provider: {}".format(pn, e), file=stderr)
# Fail if necessary providers are missing
required = {'route', 'process'}
# The hosts provider is required unless:
# 1) '--no-ns-hosts --no-host-names' specified, or
# 2) '--no-ns-hosts' specified, but neither hosts nor aliases specified
if not args.ns_hosts and not args.host_names:
pass
elif not args.ns_hosts and not args.hosts and not args.aliases:
pass
else:
required.add('hosts')
# The DNS provider is required if:
# 1) Any hosts are specified
# 2) '--prevent-idle-timeout' is specified
if args.hosts or args.prevent_idle_timeout:
required.add('dns')
missing_required = {p for p in required if p not in providers}
if missing_required:
raise RuntimeError("Aborting because providers for %s are required; use --help for more information" % ' '.join(missing_required))
# Finalize arguments that depend on providers
finalize_args_and_env(args, env)
except Exception as e:
if args.self_test:
print('******************************************************************************************', file=stderr)
print('*** Self-test did not pass. Double-check that you are running as root (e.g. with sudo) ***', file=stderr)
print('******************************************************************************************', file=stderr)
raise SystemExit(*e.args)
else:
if args.self_test:
print('***************************************************************************', file=stderr)
print('*** Self-test passed. Try using vpn-slice with openconnect or vpnc now. ***', file=stderr)
print('***************************************************************************', file=stderr)
raise SystemExit()
if env.myaddr6 or env.netmask6:
print('WARNING: IPv6 address or netmask set. Support for IPv6 in %s should be considered BETA-QUALITY.' % p.prog, file=stderr)
if args.dump:
exe = providers.process.pid2exe(args.ppid)
caller = '%s (PID %d)' % (exe, args.ppid) if exe else 'PID %d' % args.ppid
print('Called by %s with environment variables for vpnc-script:' % caller, file=stderr)
width = max((len(envar) for var, envar, *rest in vpncenv if envar in environ), default=0)
for var, envar, *rest in vpncenv:
if envar in environ:
pyvar = var + '=' + repr(env[var]) if var else 'IGNORED'
print(' %-*s => %s' % (width, envar, pyvar), file=stderr)
if env.splitinc:
print(' %-*s => %s=%r' % (width, 'CISCO_*SPLIT_INC_*', 'splitinc', env.splitinc), file=stderr)
if env.splitexc:
print(' %-*s => %s=%r' % (width, 'CISCO_*SPLIT_EXC_*', 'splitexc', env.splitexc), file=stderr)
if args.subnets:
print('Complete set of subnets to include in VPN routes:', file=stderr)
print(' ' + '\n '.join(map(str, args.subnets)))
if args.exc_subnets:
print('Complete set of subnets to exclude from VPN routes:', file=stderr)
print(' ' + '\n '.join(map(str, args.exc_subnets)))
if args.aliases:
print('Complete set of host aliases to add /etc/hosts entries for:', file=stderr)
print(' ' + '\n '.join(args.aliases))
if args.hosts:
print('Complete set of host names to include in VPN routes after DNS lookup%s:' % (' (and add /etc/hosts entries for)' if args.host_names else ''), file=stderr)
print(' ' + '\n '.join(args.hosts))
if env.reason is None:
if env.vpnfd is not None:
raise SystemExit("Called by openconnect in --script-tun mode; you need a different script. See https://www.infradead.org/openconnect/nonroot.html")
else:
raise SystemExit("Must be called as vpnc-script, with $reason set; use --help for more information")
elif env.reason == reasons.pre_init:
do_pre_init(env, args)
elif env.reason == reasons.disconnect:
do_disconnect(env, args)
elif env.reason in (reasons.reconnect, reasons.attempt_reconnect):
# FIXME: is there anything that reconnect or attempt_reconnect /should/ do
# on a modern system (Linux) which automatically removes routes to
# a tunnel adapter that has been removed? I am not clear on whether
# any other behavior is potentially useful.
#
# See these issue comments for some relevant discussion:
# https://gitlab.com/openconnect/openconnect/issues/17#note_131764677
# https://github.com/dlenski/vpn-slice/pull/14#issuecomment-488129621
if args.verbose:
print('WARNING: %s ignores reason=%s' % (p.prog, env.reason.name), file=stderr)
elif env.reason == reasons.connect:
do_connect(env, args)
# we continue running in a new child process, so the VPN can actually
# start in the background, because we need to actually send traffic to it
if args.fork and os.fork():
raise SystemExit
do_post_connect(env, args)
if __name__ == '__main__':
main()
@@ -0,0 +1,51 @@
from ipaddress import ip_address
from sys import stderr
from dns.name import from_text, root
from dns.resolver import NXDOMAIN, NoAnswer, Resolver, Timeout
from .provider import DNSProvider
class DNSPythonProvider(DNSProvider):
def configure(self, dns_servers, *, bind_addresses=None, search_domains=()):
super().configure(dns_servers, bind_addresses=bind_addresses, search_domains=search_domains)
self.resolver = Resolver(configure=False)
self.resolver.domain = root
self.resolver.search = [from_text(d) for d in search_domains]
self.rectypes = []
if self.bind_addresses is None or any(a.version == 4 for a in self.bind_addresses):
self.rectypes.append('A')
if self.bind_addresses is None or any(a.version == 6 for a in self.bind_addresses):
self.rectypes.append('AAAA')
def lookup_host(self, hostname, keep_going=True):
result = set()
for source in self.bind_addresses or [None]:
if source is None:
self.resolver.nameservers = self.dns_servers
else:
self.resolver.nameservers = [str(dns) for dns in self.dns_servers if dns.version == source.version]
if not self.resolver.nameservers:
continue
for rectype in self.rectypes:
try:
# print("Issuing query for hostname %r, rectype %r, source %r, search %r, nameservers %r" % (
# hostname, rectype, source, self.resolver.search, self.resolver.nameservers), file=stderr)
a = self.resolver.query(hostname, rectype, source=None if source is None else str(source))
print("Got results: %r" % list(a), file=stderr)
except (NXDOMAIN, NoAnswer):
pass
except Timeout:
# No point in retrying with a different rectype if these DNS server(s) are not responding
break
else:
result.update(ip_address(r.address) for r in a)
if result and not keep_going:
return result
return result or None
@@ -0,0 +1,19 @@
import os
from .posix import PosixProcessProvider
class ProcfsProvider(PosixProcessProvider):
def pid2exe(self, pid):
try:
return os.readlink('/proc/%d/file' % pid)
except (OSError, IOError):
return None
def ppid_of(self, pid=None):
if pid is None:
return os.getppid()
try:
return int(next(open('/proc/%d/status' % pid)).split()[3])
except (OSError, ValueError, IOError):
return None
@@ -0,0 +1,111 @@
import os
import stat
import subprocess
from .posix import PosixProcessProvider
from .provider import FirewallProvider, RouteProvider, TunnelPrepProvider
from .util import get_executable
class ProcfsProvider(PosixProcessProvider):
def pid2exe(self, pid):
try:
return os.readlink('/proc/%d/exe' % pid)
except (OSError, IOError):
return None
def ppid_of(self, pid=None):
if pid is None:
return os.getppid()
try:
return int(next(open('/proc/%d/stat' % pid)).split()[3])
except (OSError, ValueError, IOError):
return None
class Iproute2Provider(RouteProvider):
def __init__(self):
self.iproute = get_executable('/sbin/ip')
def _iproute(self, *args, **kwargs):
cl = [self.iproute]
cl.extend(str(v) for v in args if v is not None)
for k, v in kwargs.items():
if v is not None:
cl.extend((k, str(v)))
if args[:2] == ('route', 'get'):
output_start, keys = 1, ('via', 'dev', 'src', 'mtu')
elif args[:2] == ('link', 'show'):
output_start, keys = 3, ('state', 'mtu')
else:
output_start = None
if output_start is not None:
words = subprocess.check_output(cl, universal_newlines=True).split()
if args[:2] == ('route', 'get') and words[0] in ('broadcast', 'multicast', 'local', 'unreachable'):
output_start += 1
return {words[i]: words[i + 1] for i in range(output_start, len(words), 2) if words[i] in keys}
else:
subprocess.check_call(cl)
def add_route(self, destination, *, via=None, dev=None, src=None, mtu=None):
self._iproute('route', 'add', destination, via=via, dev=dev, src=src, mtu=mtu)
def replace_route(self, destination, *, via=None, dev=None, src=None, mtu=None):
self._iproute('route', 'replace', destination, via=via, dev=dev, src=src, mtu=mtu)
def remove_route(self, destination):
self._iproute('route', 'del', destination)
def get_route(self, destination):
r = self._iproute('route', 'get', destination)
# Ignore localhost or incomplete routes
if r.get('dev') == 'lo':
del r['dev']
if 'dev' in r or 'via' in r:
return r
def flush_cache(self):
self._iproute('route', 'flush', 'cache')
self._iproute('-6', 'route', 'flush', 'cache')
def get_link_info(self, device):
return self._iproute('link', 'show', device)
def set_link_info(self, device, state, mtu=None):
self._iproute('link', 'set', state, dev=device, mtu=mtu)
def add_address(self, device, address):
flag = '-6' if address.version == 6 else '-4'
self._iproute(flag, 'address', 'add', address, dev=device)
class IptablesProvider(FirewallProvider):
def __init__(self):
self.iptables = get_executable('/sbin/iptables')
def _iptables(self, *args):
cl = [self.iptables]
cl.extend(args)
subprocess.check_call(cl)
def configure_firewall(self, device):
self._iptables('-A', 'INPUT', '-i', device, '-m', 'state', '--state', 'RELATED,ESTABLISHED', '-j', 'ACCEPT')
self._iptables('-A', 'INPUT', '-i', device, '-j', 'DROP')
def deconfigure_firewall(self, device):
self._iptables('-D', 'INPUT', '-i', device, '-j', 'DROP')
self._iptables('-D', 'INPUT', '-i', device, '-m', 'state', '--state', 'RELATED,ESTABLISHED', '-j', 'ACCEPT')
class CheckTunDevProvider(TunnelPrepProvider):
def create_tunnel(self):
node = '/dev/net/tun'
if not os.path.exists(node):
os.makedirs(os.path.dirname(node), exist_ok=True)
os.mknod(node, mode=0o640 | stat.S_IFCHR, device=os.makedev(10, 200))
def prepare_tunnel(self):
if not os.access('/dev/net/tun', os.R_OK | os.W_OK):
raise OSError("can't read and write /dev/net/tun")
@@ -0,0 +1,221 @@
import os
import re
import subprocess
from ipaddress import ip_interface
from .posix import PosixProcessProvider
from .provider import FirewallProvider, RouteProvider, SplitDNSProvider
from .util import get_executable
class PsProvider(PosixProcessProvider):
def __init__(self):
self.lsof = get_executable('/usr/sbin/lsof')
self.ps = get_executable('/bin/ps')
def pid2exe(self, pid):
info = subprocess.check_output([self.lsof, '-p', str(pid)], universal_newlines=True)
for line in info.splitlines():
parts = line.split()
if parts[3] == 'txt':
return parts[8]
def ppid_of(self, pid=None):
if pid is None:
return os.getppid()
try:
return int(subprocess.check_output([self.ps, '-p', str(pid), '-o', 'ppid=']))
except ValueError:
return None
class BSDRouteProvider(RouteProvider):
def __init__(self):
self.route = get_executable('/sbin/route')
self.ifconfig = get_executable('/sbin/ifconfig')
def _route(self, *args):
return subprocess.check_output([self.route, '-n'] + list(map(str, args)), universal_newlines=True)
def _ifconfig(self, *args):
return subprocess.check_output([self.ifconfig] + list(map(str, args)), universal_newlines=True)
def _family_option(self, destination):
return '-inet6' if destination.version == 6 else '-inet'
def add_route(self, destination, *, via=None, dev=None, src=None, mtu=None):
args = ['add', self._family_option(destination)]
if mtu is not None:
args.extend(('-mtu', str(mtu)))
if via is not None:
args.extend((destination, via))
elif dev is not None:
args.extend(('-interface', destination, dev))
self._route(*args)
replace_route = add_route
def remove_route(self, destination):
self._route('delete', self._family_option(destination), destination)
def get_route(self, destination):
# Format of BSD route get output: https://unix.stackexchange.com/questions/53446
info = self._route('get', self._family_option(destination), destination)
lines = iter(info.splitlines())
info_d = {}
for line in lines:
if ':' not in line:
keys = line.split()
vals = next(lines).split()
info_d.update(zip(keys, vals))
break
key, val = line.split(':', 1)
info_d[key.strip()] = val.strip()
if 'gateway' in info_d or 'interface' in info_d:
return {
'via': info_d.get('gateway', None),
'dev': info_d.get('interface', None),
'mtu': info_d.get('mtu', None),
}
def flush_cache(self):
pass
_LINK_INFO_RE = re.compile(r'flags=\d<(.*?)>\smtu\s(\d+)$')
def get_link_info(self, device):
info = self._ifconfig(device)
match = self._LINK_INFO_RE.search(info)
if match:
flags = match.group(1).split(',')
mtu = int(match.group(2))
return {
'state': 'UP' if 'UP' in flags else 'DOWN',
'mtu': mtu,
}
return None
def set_link_info(self, device, state, mtu=None):
args = [device]
if state is not None:
args.append(state)
if mtu is not None:
args.extend(('mtu', str(mtu)))
self._ifconfig(*args)
def add_address(self, device, address):
address = ip_interface(address)
if address.version == 6:
self._ifconfig(device, 'inet6', address)
else:
# Repetition of the IP address is the correct syntax for a point-to-point interface
# with BSD ifconfig. See example in default vpnc-script:
# https://gitlab.com/openconnect/vpnc-scripts/blob/https://gitlab.com/openconnect/vpnc-scripts/blob/921e8760/vpnc-script#L193
self._ifconfig(device, 'inet', address.ip, address.ip, 'netmask', '255.255.255.255')
class MacSplitDNSProvider(SplitDNSProvider):
def configure_domain_vpn_dns(self, domains, nameservers):
if not os.path.exists('/etc/resolver'):
os.makedirs('/etc/resolver')
for domain in domains:
resolver_file_name = "/etc/resolver/{0}".format(domain)
with open(resolver_file_name, "w") as resolver_file:
for nameserver in nameservers:
resolver_file.write("nameserver {}\n".format(nameserver))
def deconfigure_domain_vpn_dns(self, domains, nameservers):
for domain in domains:
resolver_file_name = "/etc/resolver/{0}".format(domain)
if os.path.exists(resolver_file_name):
os.remove(resolver_file_name)
if not len(os.listdir('/etc/resolver')):
os.removedirs('/etc/resolver')
class PfFirewallProvider(FirewallProvider):
def __init__(self):
self.pfctl = get_executable('/sbin/pfctl')
_PF_TOKEN_RE = re.compile(r'Token : (\d+)')
_PF_ANCHOR = 'vpn_slice'
_PF_CONF_FILE = '/etc/pf.conf'
def _reload_conf(self):
cmd = [self.pfctl, '-f', self._PF_CONF_FILE]
p = subprocess.Popen(cmd, universal_newlines=True, stderr=subprocess.PIPE, stdout=subprocess.PIPE)
output, stderr = p.communicate()
if p.returncode != 0:
raise subprocess.CalledProcessError(p.returncode, cmd, output=output, stderr=stderr)
def configure_firewall(self, device):
# Enabled Packet Filter - increments a reference counter for processes that need packet filter enabled
cl = [self.pfctl, '-E']
p = subprocess.Popen(cl, universal_newlines=True, stderr=subprocess.PIPE, stdout=subprocess.PIPE)
output, stderr = p.communicate()
if p.returncode != 0:
raise subprocess.CalledProcessError(p.returncode, cl, output=output, stderr=stderr)
# store token returned to later be able to decrement the reference counter correctly
enable_token = None
for line in stderr.splitlines():
match = self._PF_TOKEN_RE.search(line)
if match:
enable_token = match.group(1)
if not enable_token:
print("WARNING: failed to get pf enable reference token, packet filter might not shutdown correctly")
anchor = '{}/{}'.format(self._PF_ANCHOR, device)
# add anchor to generate rules with
with open(self._PF_CONF_FILE, 'a') as file:
file.write('anchor "{}" # vpn-slice-{} AUTOCREATED {}\n'.format(anchor, device, enable_token))
# reload config file
self._reload_conf()
p = subprocess.Popen([self.pfctl, '-a', anchor, '-f', '-'],
universal_newlines=True,
stderr=subprocess.PIPE,
stdout=subprocess.PIPE,
stdin=subprocess.PIPE)
rules = '''pass out on {0} all keep state
block drop in on {0} all
'''.format(device)
output, stderr = p.communicate(rules)
if p.returncode != 0:
raise subprocess.CalledProcessError(p.returncode, cl, output=output, stderr=stderr)
def deconfigure_firewall(self, device):
# disable anchor
anchor = '{}/{}'.format(self._PF_ANCHOR, device)
subprocess.check_call([self.pfctl, '-a', anchor, '-F', 'all'])
with open(self._PF_CONF_FILE, 'r') as file:
lines = file.readlines()
enable_tokens = []
rule_re = re.compile(r'vpn-slice-{} AUTOCREATED (\d+)'.format(device))
with open(self._PF_CONF_FILE, 'w') as file:
for line in lines:
match = rule_re.search(line)
if match:
enable_tokens.append(match.group(1))
else:
file.write(line)
# decrement pf enable reference counter
for token in enable_tokens:
cl = [self.pfctl, '-X', token]
p = subprocess.Popen(cl, universal_newlines=True, stderr=subprocess.PIPE, stdout=subprocess.PIPE)
output, stderr = p.communicate()
if p.returncode != 0:
raise subprocess.CalledProcessError(p.returncode, cl, output=output, stderr=stderr)
if not enable_tokens:
print("WARNING: failed to get pf enable reference token, packet filter might not have shutdown correctly")
self._reload_conf()
@@ -0,0 +1,106 @@
import fcntl
import os
import subprocess
from ipaddress import ip_address
from signal import SIGTERM
from .provider import DNSProvider, HostsProvider, ProcessProvider
from .util import get_executable
class DigProvider(DNSProvider):
def __init__(self):
self.dig = get_executable('/usr/bin/dig')
self.base_cl = [self.dig, '+short', '+noedns']
def lookup_host(self, hostname, keep_going=True):
dns_servers = self.dns_servers
bind_addresses = self.bind_addresses
search_domains = self.search_domains
if not bind_addresses:
some_cls = [self.base_cl + ['@{!s}'.format(dns) for dns in dns_servers]]
field_requests = [hostname, 'A', hostname, 'AAAA']
else:
some_cls = []
field_requests = []
for bind in bind_addresses:
# We only do lookups for protocols of which we have bind addresses.
# (For example, if we have only an IPv4 bind address, we don't lookup AAAA/IPv6
# DNS records because we won't be able to route traffic to them.)
field_requests.extend([hostname, ('AAAA' if bind.version == 6 else 'A')])
# We can only do a lookup via DNS-over-IPv[X] if we have an IPv[X] address to bind to.
matching_dns = ['@{!s}'.format(dns) for dns in dns_servers if dns.version == bind.version]
if matching_dns:
some_cls.append(self.base_cl + ['-b', str(bind)] + matching_dns)
# N.B.: dig does not correctly handle the specification of multiple
# +domain arguments, discarding all but the last one. Therefore
# we need to run it multiple times and combine the results
# if multiple search_domains are specified.
all_cls = []
if search_domains:
for cl in some_cls:
all_cls.extend(cl + ['+domain={!s}'.format(sd)] + field_requests for sd in search_domains)
else:
for cl in some_cls:
all_cls.extend([cl + field_requests])
# actually fetch results
result = set()
for cl in all_cls:
p = subprocess.Popen(cl, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
output, stderr = p.communicate()
if p.returncode != 0:
raise subprocess.CalledProcessError(p.returncode, cl, output=output, stderr=stderr)
for line in output.splitlines():
try:
result.add(ip_address(line.strip()))
except ValueError:
# dig sometimes returns extra domain names instead of IP addresses
pass
if result and not keep_going:
return result
return result or None
class HostsFileProvider(HostsProvider):
def __init__(self, path):
self.path = path
if not os.access(path, os.R_OK | os.W_OK):
raise OSError('Cannot read/write {}'.format(path))
def write_hosts(self, host_map, name):
tag = 'vpn-slice-{} AUTOCREATED'.format(name)
with open(self.path, 'r+') as hostf:
fcntl.flock(hostf, fcntl.LOCK_EX) # POSIX only, obviously
lines = hostf.readlines()
keeplines = [l for l in lines if not l.endswith('# %s\n' % tag)]
hostf.seek(0, 0)
hostf.writelines(keeplines)
for ip, names in host_map:
print('%s %s\t\t# %s' % (ip, ' '.join(names), tag), file=hostf)
hostf.truncate()
return len(host_map) or len(lines) - len(keeplines)
class PosixHostsFileProvider(HostsFileProvider):
def __init__(self):
super().__init__('/etc/hosts')
class PosixProcessProvider(ProcessProvider):
def kill(self, pid, signal=SIGTERM):
os.kill(pid, signal)
def pid(self):
return os.getpid()
def is_alive(self, pid):
try:
os.kill(pid, 0)
return True
except ProcessLookupError:
return False
@@ -0,0 +1,160 @@
from abc import ABCMeta, abstractmethod
from ipaddress import ip_interface
class ProcessProvider(metaclass=ABCMeta):
@abstractmethod
def pid2exe(self, pid):
"""Get the path to the executable running as a given PID."""
@abstractmethod
def pid(self):
"""Get the PID of the current process."""
@abstractmethod
def ppid_of(self, pid=None):
"""Get the PID of the parent of the process with the given PID,
or of the current process if None."""
@abstractmethod
def kill(self, pid):
"""Kill the process with the given PID."""
class RouteProvider(metaclass=ABCMeta):
@abstractmethod
def add_route(self, destination, *, via=None, dev=None, src=None, mtu=None):
"""Add a route to a destination.
You must specify a device or gateway saying where to route to.
If both are specified, they must agree.
Implementations may fail if a route that already exists is
added again.
"""
@abstractmethod
def replace_route(self, destination, *, via=None, dev=None, src=None, mtu=None):
"""Add or replace a route to a destination.
You must specify a device or gateway saying where to route to.
If both are specified, they must agree.
Implementations should not fail if a route that already exists
is added again.
"""
@abstractmethod
def remove_route(self, destination):
"""Remove a route to a destination."""
@abstractmethod
def get_route(self, destination):
"""Return the gateway to a destination.
Return a dict with these keys containing the information,
or None if it is unavailable:
* via
* dev
* src
* mtu
"""
@abstractmethod
def flush_cache(self):
"""Flush the routing cache (if necessary)."""
@abstractmethod
def get_link_info(self, device):
"""Get the MTU and state for a device.
Return a dict with these keys containing the information,
or None if it is unavailable:
* mtu
* state
"""
@abstractmethod
def set_link_info(self, device, state, mtu=None):
"""Set the MTU and state of a device."""
@abstractmethod
def add_address(self, device, address):
"""Add an address to an interface."""
class FirewallProvider(metaclass=ABCMeta):
@abstractmethod
def configure_firewall(self, device):
"""Configure the firewall to prevent inbound traffic on the device."""
@abstractmethod
def deconfigure_firewall(self, device):
"""Remove the firewall configuration for a device."""
class DNSProvider(metaclass=ABCMeta):
def configure(self, dns_servers, *, bind_addresses=None, search_domains=()):
"""Configure provider to use the specified DNS servers, bind addresses, and search domains."""
self.dns_servers = dns_servers
self.bind_addresses = [ip_interface(a).ip for a in bind_addresses] if bind_addresses else []
self.search_domains = search_domains
@abstractmethod
def lookup_host(self, hostname, keep_going=True):
"""Look up the address(es) of a host using configured servers.
If keep_going is True, it will continue until all possible
combinations of address family (IPv4/6) and search domain are
exhausted; if False, it will return as soon as it has found
any valid records.
"""
class HostsProvider(metaclass=ABCMeta):
@abstractmethod
def write_hosts(self, host_map, name):
"""Write information to the hosts file.
Lines include a tag so we can identify which lines to remove.
The tag is derived from the name.
host_map maps IP addresses to host names, like the hosts file expects.
"""
class TunnelPrepProvider:
def create_tunnel(self):
"""Create tunnel device.
Base class behavior is to do nothing.
"""
def prepare_tunnel(self):
"""Prepare operating system to create tunnel devices.
Base class behavior is to do nothing.
"""
class SplitDNSProvider:
def configure_domain_vpn_dns(self, domains, nameservers):
"""Configure domain vpn dns.
Base class behavior is to do nothing.
"""
def deconfigure_domain_vpn_dns(self, domains, nameservers):
"""Remove domain vpn dns.
Base class behavior is to do nothing.
"""
@@ -0,0 +1,22 @@
import os
import os.path
from shutil import which
def get_executable(path):
path = which(os.path.basename(path)) or path
if not os.access(path, os.X_OK):
raise OSError('cannot execute {}'.format(path))
return path
class slurpy(dict):
"""Quacks like a dict and an object"""
def __getattr__(self, k):
try:
return self[k]
except KeyError as e:
raise AttributeError(*e.args)
def __setattr__(self, k, v):
self[k] = v
@@ -0,0 +1 @@
__version__ = "0.16.1"