172
172
def password_encode(self, password):
173
173
# Passphrase can not be empty and can not contain newlines or
174
174
# NUL bytes. So we prefix it and hex encode it.
175
encoded = b"mandos" + binascii.hexlify(password)
176
if len(encoded) > 2048:
177
# GnuPG can't handle long passwords, so encode differently
178
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
179
.replace(b"\n", b"\\n")
180
.replace(b"\0", b"\\x00"))
175
return b"mandos" + binascii.hexlify(password)
183
177
def encrypt(self, data, password):
184
passphrase = self.password_encode(password)
185
with tempfile.NamedTemporaryFile(dir=self.tempdir
187
passfile.write(passphrase)
189
proc = subprocess.Popen(['gpg', '--symmetric',
193
stdin = subprocess.PIPE,
194
stdout = subprocess.PIPE,
195
stderr = subprocess.PIPE)
196
ciphertext, err = proc.communicate(input = data)
197
if proc.returncode != 0:
178
self.gnupg.passphrase = self.password_encode(password)
179
with open(os.devnull, "w") as devnull:
181
proc = self.gnupg.run(['--symmetric'],
182
create_fhs=['stdin', 'stdout'],
183
attach_fhs={'stderr': devnull})
184
with contextlib.closing(proc.handles['stdin']) as f:
186
with contextlib.closing(proc.handles['stdout']) as f:
187
ciphertext = f.read()
191
self.gnupg.passphrase = None
199
192
return ciphertext
201
194
def decrypt(self, data, password):
202
passphrase = self.password_encode(password)
203
with tempfile.NamedTemporaryFile(dir = self.tempdir
205
passfile.write(passphrase)
207
proc = subprocess.Popen(['gpg', '--decrypt',
211
stdin = subprocess.PIPE,
212
stdout = subprocess.PIPE,
213
stderr = subprocess.PIPE)
214
decrypted_plaintext, err = proc.communicate(input
216
if proc.returncode != 0:
195
self.gnupg.passphrase = self.password_encode(password)
196
with open(os.devnull, "w") as devnull:
198
proc = self.gnupg.run(['--decrypt'],
199
create_fhs=['stdin', 'stdout'],
200
attach_fhs={'stderr': devnull})
201
with contextlib.closing(proc.handles['stdin']) as f:
203
with contextlib.closing(proc.handles['stdout']) as f:
204
decrypted_plaintext = f.read()
208
self.gnupg.passphrase = None
218
209
return decrypted_plaintext
446
434
runtime_expansions: Allowed attributes for runtime expansion.
447
435
expires: datetime.datetime(); time (UTC) when a client will be
448
436
disabled, or None
449
server_settings: The server_settings dict from main()
452
439
runtime_expansions = ("approval_delay", "approval_duration",
453
"created", "enabled", "expires",
454
"fingerprint", "host", "interval",
455
"last_approval_request", "last_checked_ok",
440
"created", "enabled", "fingerprint",
441
"host", "interval", "last_checked_ok",
456
442
"last_enabled", "name", "timeout")
457
client_defaults = { "timeout": "PT5M",
458
"extended_timeout": "PT15M",
443
client_defaults = { "timeout": "5m",
444
"extended_timeout": "15m",
460
446
"checker": "fping -q -- %%(host)s",
462
"approval_delay": "PT0S",
463
"approval_duration": "PT1S",
448
"approval_delay": "0s",
449
"approval_duration": "1s",
464
450
"approved_by_default": "True",
465
451
"enabled": "True",
587
570
if getattr(self, "enabled", False):
588
571
# Already enabled
573
self.send_changedstate()
590
574
self.expires = datetime.datetime.utcnow() + self.timeout
591
575
self.enabled = True
592
576
self.last_enabled = datetime.datetime.utcnow()
593
577
self.init_checker()
594
self.send_changedstate()
596
579
def disable(self, quiet=True):
597
580
"""Disable this client."""
598
581
if not getattr(self, "enabled", False):
584
self.send_changedstate()
601
586
logger.info("Disabling client %s", self.name)
602
if getattr(self, "disable_initiator_tag", None) is not None:
587
if getattr(self, "disable_initiator_tag", False):
603
588
gobject.source_remove(self.disable_initiator_tag)
604
589
self.disable_initiator_tag = None
605
590
self.expires = None
606
if getattr(self, "checker_initiator_tag", None) is not None:
591
if getattr(self, "checker_initiator_tag", False):
607
592
gobject.source_remove(self.checker_initiator_tag)
608
593
self.checker_initiator_tag = None
609
594
self.stop_checker()
610
595
self.enabled = False
612
self.send_changedstate()
613
596
# Do not run this again if called by a gobject.timeout_add
679
657
If a checker already exists, leave it running and do
681
659
# The reason for not killing a running checker is that if we
682
# did that, and if a checker (for some reason) started running
683
# slowly and taking more than 'interval' time, then the client
684
# would inevitably timeout, since no checker would get a
685
# chance to run to completion. If we instead leave running
660
# did that, then if a checker (for some reason) started
661
# running slowly and taking more than 'interval' time, the
662
# client would inevitably timeout, since no checker would get
663
# a chance to run to completion. If we instead leave running
686
664
# checkers alone, the checker would have to take more time
687
665
# than 'timeout' for the client to be disabled, which is as it
703
680
self.current_checker_command)
704
681
# Start a new checker if needed
705
682
if self.checker is None:
706
# Escape attributes for the shell
707
escaped_attrs = dict(
708
(attr, re.escape(unicode(getattr(self, attr))))
710
self.runtime_expansions)
712
command = self.checker_command % escaped_attrs
713
except TypeError as error:
714
logger.error('Could not format string "%s"',
715
self.checker_command, exc_info=error)
716
return True # Try again later
684
# In case checker_command has exactly one % operator
685
command = self.checker_command % self.host
687
# Escape attributes for the shell
688
escaped_attrs = dict(
690
re.escape(unicode(str(getattr(self, attr, "")),
694
self.runtime_expansions)
697
command = self.checker_command % escaped_attrs
698
except TypeError as error:
699
logger.error('Could not format string "%s"',
700
self.checker_command, exc_info=error)
701
return True # Try again later
717
702
self.current_checker_command = command
719
704
logger.info("Starting checker %r for %s",
722
707
# in normal mode, that is already done by daemon(),
723
708
# and in debug mode we don't want to. (Stdin is
724
709
# always replaced by /dev/null.)
725
# The exception is when not debugging but nevertheless
726
# running in the foreground; use the previously
729
if (not self.server_settings["debug"]
730
and self.server_settings["foreground"]):
731
popen_args.update({"stdout": wnull,
733
710
self.checker = subprocess.Popen(command,
713
self.checker_callback_tag = (gobject.child_watch_add
715
self.checker_callback,
717
# The checker may have completed before the gobject
718
# watch was added. Check for this.
719
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
721
gobject.source_remove(self.checker_callback_tag)
722
self.checker_callback(pid, status, command)
737
723
except OSError as error:
738
724
logger.error("Failed to start subprocess",
741
self.checker_callback_tag = (gobject.child_watch_add
743
self.checker_callback,
745
# The checker may have completed before the gobject
746
# watch was added. Check for this.
748
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
749
except OSError as error:
750
if error.errno == errno.ECHILD:
751
# This should never happen
752
logger.error("Child process vanished",
757
gobject.source_remove(self.checker_callback_tag)
758
self.checker_callback(pid, status, command)
759
726
# Re-run this periodically if run by gobject.timeout_add
1056
1021
variant_level=variant_level)
1059
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1060
"""A class decorator; applied to a subclass of
1061
dbus.service.Object, it will add alternate D-Bus attributes with
1062
interface names according to the "alt_interface_names" mapping.
1065
@alternate_dbus_interfaces({"org.example.Interface":
1066
"net.example.AlternateInterface"})
1067
class SampleDBusObject(dbus.service.Object):
1068
@dbus.service.method("org.example.Interface")
1069
def SampleDBusMethod():
1072
The above "SampleDBusMethod" on "SampleDBusObject" will be
1073
reachable via two interfaces: "org.example.Interface" and
1074
"net.example.AlternateInterface", the latter of which will have
1075
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1076
"true", unless "deprecate" is passed with a False value.
1078
This works for methods and signals, and also for D-Bus properties
1079
(from DBusObjectWithProperties) and interfaces (from the
1080
dbus_interface_annotations decorator).
1024
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
1026
"""Applied to an empty subclass of a D-Bus object, this metaclass
1027
will add additional D-Bus attributes matching a certain pattern.
1083
for orig_interface_name, alt_interface_name in (
1084
alt_interface_names.iteritems()):
1086
interface_names = set()
1087
# Go though all attributes of the class
1088
for attrname, attribute in inspect.getmembers(cls):
1029
def __new__(mcs, name, bases, attr):
1030
# Go through all the base classes which could have D-Bus
1031
# methods, signals, or properties in them
1032
old_interface_names = []
1033
for base in (b for b in bases
1034
if issubclass(b, dbus.service.Object)):
1035
# Go though all attributes of the base class
1036
for attrname, attribute in inspect.getmembers(base):
1089
1037
# Ignore non-D-Bus attributes, and D-Bus attributes
1090
1038
# with the wrong interface name
1091
1039
if (not hasattr(attribute, "_dbus_interface")
1092
1040
or not attribute._dbus_interface
1093
.startswith(orig_interface_name)):
1041
.startswith("se.recompile.Mandos")):
1095
1043
# Create an alternate D-Bus interface name based on
1096
1044
# the current name
1097
1045
alt_interface = (attribute._dbus_interface
1098
.replace(orig_interface_name,
1099
alt_interface_name))
1100
interface_names.add(alt_interface)
1046
.replace("se.recompile.Mandos",
1047
"se.bsnet.fukt.Mandos"))
1048
if alt_interface != attribute._dbus_interface:
1049
old_interface_names.append(alt_interface)
1101
1050
# Is this a D-Bus signal?
1102
1051
if getattr(attribute, "_dbus_is_signal", False):
1103
# Extract the original non-method undecorated
1104
# function by black magic
1052
# Extract the original non-method function by
1105
1054
nonmethod_func = (dict(
1106
1055
zip(attribute.func_code.co_freevars,
1107
1056
attribute.__closure__))["func"]
1202
1151
attribute.func_name,
1203
1152
attribute.func_defaults,
1204
1153
attribute.func_closure)))
1206
# Deprecate all alternate interfaces
1207
iname="_AlternateDBusNames_interface_annotation{0}"
1208
for interface_name in interface_names:
1209
@dbus_interface_annotations(interface_name)
1211
return { "org.freedesktop.DBus.Deprecated":
1213
# Find an unused name
1214
for aname in (iname.format(i)
1215
for i in itertools.count()):
1216
if aname not in attr:
1220
# Replace the class with a new subclass of it with
1221
# methods, signals, etc. as created above.
1222
cls = type(b"{0}Alternate".format(cls.__name__),
1228
@alternate_dbus_interfaces({"se.recompile.Mandos":
1229
"se.bsnet.fukt.Mandos"})
1154
# Deprecate all old interfaces
1155
iname="_AlternateDBusNamesMetaclass_interface_annotation{0}"
1156
for old_interface_name in old_interface_names:
1157
@dbus_interface_annotations(old_interface_name)
1159
return { "org.freedesktop.DBus.Deprecated": "true" }
1160
# Find an unused name
1161
for aname in (iname.format(i) for i in itertools.count()):
1162
if aname not in attr:
1165
return type.__new__(mcs, name, bases, attr)
1230
1168
class ClientDBus(Client, DBusObjectWithProperties):
1231
1169
"""A Client class using D-Bus
1562
1500
def Timeout_dbus_property(self, value=None):
1563
1501
if value is None: # get
1564
1502
return dbus.UInt64(self.timeout_milliseconds())
1565
old_timeout = self.timeout
1566
1503
self.timeout = datetime.timedelta(0, 0, 0, value)
1567
# Reschedule disabling
1504
# Reschedule timeout
1568
1505
if self.enabled:
1569
1506
now = datetime.datetime.utcnow()
1570
self.expires += self.timeout - old_timeout
1571
if self.expires <= now:
1507
time_to_die = timedelta_to_milliseconds(
1508
(self.last_checked_ok + self.timeout) - now)
1509
if time_to_die <= 0:
1572
1510
# The timeout has passed
1513
self.expires = (now +
1514
datetime.timedelta(milliseconds =
1575
1516
if (getattr(self, "disable_initiator_tag", None)
1578
1519
gobject.source_remove(self.disable_initiator_tag)
1579
self.disable_initiator_tag = (
1580
gobject.timeout_add(
1581
timedelta_to_milliseconds(self.expires - now),
1520
self.disable_initiator_tag = (gobject.timeout_add
1584
1524
# ExtendedTimeout - property
1585
1525
@dbus_service_property(_interface, signature="t",
1931
1876
use_ipv6: Boolean; to use IPv6 or not
1933
1878
def __init__(self, server_address, RequestHandlerClass,
1934
interface=None, use_ipv6=True, socketfd=None):
1935
"""If socketfd is set, use that file descriptor instead of
1936
creating a new one with socket.socket().
1879
interface=None, use_ipv6=True):
1938
1880
self.interface = interface
1940
1882
self.address_family = socket.AF_INET6
1941
if socketfd is not None:
1942
# Save the file descriptor
1943
self.socketfd = socketfd
1944
# Save the original socket.socket() function
1945
self.socket_socket = socket.socket
1946
# To implement --socket, we monkey patch socket.socket.
1948
# (When socketserver.TCPServer is a new-style class, we
1949
# could make self.socket into a property instead of monkey
1950
# patching socket.socket.)
1952
# Create a one-time-only replacement for socket.socket()
1953
@functools.wraps(socket.socket)
1954
def socket_wrapper(*args, **kwargs):
1955
# Restore original function so subsequent calls are
1957
socket.socket = self.socket_socket
1958
del self.socket_socket
1959
# This time only, return a new socket object from the
1960
# saved file descriptor.
1961
return socket.fromfd(self.socketfd, *args, **kwargs)
1962
# Replace socket.socket() function with wrapper
1963
socket.socket = socket_wrapper
1964
# The socketserver.TCPServer.__init__ will call
1965
# socket.socket(), which might be our replacement,
1966
# socket_wrapper(), if socketfd was set.
1967
1883
socketserver.TCPServer.__init__(self, server_address,
1968
1884
RequestHandlerClass)
1970
1885
def server_bind(self):
1971
1886
"""This overrides the normal server_bind() function
1972
1887
to bind to an interface if one was specified, and also NOT to
1981
1896
self.socket.setsockopt(socket.SOL_SOCKET,
1982
1897
SO_BINDTODEVICE,
1983
str(self.interface + '\0'))
1984
1900
except socket.error as error:
1985
if error.errno == errno.EPERM:
1986
logger.error("No permission to bind to"
1987
" interface %s", self.interface)
1988
elif error.errno == errno.ENOPROTOOPT:
1901
if error[0] == errno.EPERM:
1902
logger.error("No permission to"
1903
" bind to interface %s",
1905
elif error[0] == errno.ENOPROTOOPT:
1989
1906
logger.error("SO_BINDTODEVICE not available;"
1990
1907
" cannot bind to interface %s",
1991
1908
self.interface)
1992
elif error.errno == errno.ENODEV:
1993
logger.error("Interface %s does not exist,"
1994
" cannot bind", self.interface)
1997
1911
# Only bind(2) the socket if we really need to.
2058
1971
def handle_ipc(self, source, condition, parent_pipe=None,
2059
1972
proc = None, client_object=None):
1974
gobject.IO_IN: "IN", # There is data to read.
1975
gobject.IO_OUT: "OUT", # Data can be written (without
1977
gobject.IO_PRI: "PRI", # There is urgent data to read.
1978
gobject.IO_ERR: "ERR", # Error condition.
1979
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1980
# broken, usually for pipes and
1983
conditions_string = ' | '.join(name
1985
condition_names.iteritems()
1986
if cond & condition)
2060
1987
# error, or the other end of multiprocessing.Pipe has closed
2061
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1988
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2062
1989
# Wait for other process to exit
2125
def rfc3339_duration_to_delta(duration):
2126
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2128
>>> rfc3339_duration_to_delta("P7D")
2129
datetime.timedelta(7)
2130
>>> rfc3339_duration_to_delta("PT60S")
2131
datetime.timedelta(0, 60)
2132
>>> rfc3339_duration_to_delta("PT60M")
2133
datetime.timedelta(0, 3600)
2134
>>> rfc3339_duration_to_delta("PT24H")
2135
datetime.timedelta(1)
2136
>>> rfc3339_duration_to_delta("P1W")
2137
datetime.timedelta(7)
2138
>>> rfc3339_duration_to_delta("PT5M30S")
2139
datetime.timedelta(0, 330)
2140
>>> rfc3339_duration_to_delta("P1DT3M20S")
2141
datetime.timedelta(1, 200)
2144
# Parsing an RFC 3339 duration with regular expressions is not
2145
# possible - there would have to be multiple places for the same
2146
# values, like seconds. The current code, while more esoteric, is
2147
# cleaner without depending on a parsing library. If Python had a
2148
# built-in library for parsing we would use it, but we'd like to
2149
# avoid excessive use of external libraries.
2151
# New type for defining tokens, syntax, and semantics all-in-one
2152
Token = collections.namedtuple("Token",
2153
("regexp", # To match token; if
2154
# "value" is not None,
2155
# must have a "group"
2157
"value", # datetime.timedelta or
2159
"followers")) # Tokens valid after
2161
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2162
# the "duration" ABNF definition in RFC 3339, Appendix A.
2163
token_end = Token(re.compile(r"$"), None, frozenset())
2164
token_second = Token(re.compile(r"(\d+)S"),
2165
datetime.timedelta(seconds=1),
2166
frozenset((token_end,)))
2167
token_minute = Token(re.compile(r"(\d+)M"),
2168
datetime.timedelta(minutes=1),
2169
frozenset((token_second, token_end)))
2170
token_hour = Token(re.compile(r"(\d+)H"),
2171
datetime.timedelta(hours=1),
2172
frozenset((token_minute, token_end)))
2173
token_time = Token(re.compile(r"T"),
2175
frozenset((token_hour, token_minute,
2177
token_day = Token(re.compile(r"(\d+)D"),
2178
datetime.timedelta(days=1),
2179
frozenset((token_time, token_end)))
2180
token_month = Token(re.compile(r"(\d+)M"),
2181
datetime.timedelta(weeks=4),
2182
frozenset((token_day, token_end)))
2183
token_year = Token(re.compile(r"(\d+)Y"),
2184
datetime.timedelta(weeks=52),
2185
frozenset((token_month, token_end)))
2186
token_week = Token(re.compile(r"(\d+)W"),
2187
datetime.timedelta(weeks=1),
2188
frozenset((token_end,)))
2189
token_duration = Token(re.compile(r"P"), None,
2190
frozenset((token_year, token_month,
2191
token_day, token_time,
2193
# Define starting values
2194
value = datetime.timedelta() # Value so far
2196
followers = frozenset(token_duration,) # Following valid tokens
2197
s = duration # String left to parse
2198
# Loop until end token is found
2199
while found_token is not token_end:
2200
# Search for any currently valid tokens
2201
for token in followers:
2202
match = token.regexp.match(s)
2203
if match is not None:
2205
if token.value is not None:
2206
# Value found, parse digits
2207
factor = int(match.group(1), 10)
2208
# Add to value so far
2209
value += factor * token.value
2210
# Strip token from string
2211
s = token.regexp.sub("", s, 1)
2214
# Set valid next tokens
2215
followers = found_token.followers
2218
# No currently valid tokens were found
2219
raise ValueError("Invalid RFC 3339 duration")
2224
2052
def string_to_delta(interval):
2225
2053
"""Parse a string and return a datetime.timedelta
2325
2147
parser.add_argument("--no-dbus", action="store_false",
2326
2148
dest="use_dbus", help="Do not provide D-Bus"
2327
" system bus interface", default=None)
2149
" system bus interface")
2328
2150
parser.add_argument("--no-ipv6", action="store_false",
2329
dest="use_ipv6", help="Do not use IPv6",
2151
dest="use_ipv6", help="Do not use IPv6")
2331
2152
parser.add_argument("--no-restore", action="store_false",
2332
2153
dest="restore", help="Do not restore stored"
2333
" state", default=None)
2334
parser.add_argument("--socket", type=int,
2335
help="Specify a file descriptor to a network"
2336
" socket to use instead of creating one")
2337
2155
parser.add_argument("--statedir", metavar="DIR",
2338
2156
help="Directory to save/restore state in")
2339
parser.add_argument("--foreground", action="store_true",
2340
help="Run in foreground", default=None)
2342
2158
options = parser.parse_args()
2371
2185
# Convert the SafeConfigParser object to a dict
2372
2186
server_settings = server_config.defaults()
2373
2187
# Use the appropriate methods on the non-string config options
2374
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2188
for option in ("debug", "use_dbus", "use_ipv6"):
2375
2189
server_settings[option] = server_config.getboolean("DEFAULT",
2377
2191
if server_settings["port"]:
2378
2192
server_settings["port"] = server_config.getint("DEFAULT",
2380
if server_settings["socket"]:
2381
server_settings["socket"] = server_config.getint("DEFAULT",
2383
# Later, stdin will, and stdout and stderr might, be dup'ed
2384
# over with an opened os.devnull. But we don't want this to
2385
# happen with a supplied network socket.
2386
if 0 <= server_settings["socket"] <= 2:
2387
server_settings["socket"] = os.dup(server_settings
2389
2194
del server_config
2391
2196
# Override the settings from the config file with command line
2653
2432
# Create all client objects
2654
2433
for client_name, client in clients_data.iteritems():
2655
2434
tcp_server.clients[client_name] = client_class(
2656
name = client_name, settings = client,
2657
server_settings = server_settings)
2435
name = client_name, settings = client)
2659
2437
if not tcp_server.clients:
2660
2438
logger.warning("No clients defined")
2663
if pidfile is not None:
2667
pidfile.write(str(pid) + "\n".encode("utf-8"))
2669
logger.error("Could not write to file %r with PID %d",
2444
pidfile.write(str(pid) + "\n".encode("utf-8"))
2447
logger.error("Could not write to file %r with PID %d",
2450
# "pidfile" was never created
2672
2452
del pidfilename
2453
signal.signal(signal.SIGINT, signal.SIG_IGN)
2674
2455
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2675
2456
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2678
@alternate_dbus_interfaces({"se.recompile.Mandos":
2679
"se.bsnet.fukt.Mandos"})
2680
2459
class MandosDBusService(DBusObjectWithProperties):
2681
2460
"""A D-Bus proxy object"""
2682
2461
def __init__(self):
2776
2556
del client_settings[client.name]["secret"]
2779
with (tempfile.NamedTemporaryFile
2780
(mode='wb', suffix=".pickle", prefix='clients-',
2781
dir=os.path.dirname(stored_state_path),
2782
delete=False)) as stored_state:
2559
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2562
(stored_state_path))
2563
with os.fdopen(tempfd, "wb") as stored_state:
2783
2564
pickle.dump((clients, client_settings), stored_state)
2784
tempname=stored_state.name
2785
2565
os.rename(tempname, stored_state_path)
2786
2566
except (IOError, OSError) as e: