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
return b"mandos" + binascii.hexlify(password)
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"))
177
183
def encrypt(self, data, password):
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
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:
192
199
return ciphertext
194
201
def decrypt(self, data, password):
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
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:
209
218
return decrypted_plaintext
434
446
runtime_expansions: Allowed attributes for runtime expansion.
435
447
expires: datetime.datetime(); time (UTC) when a client will be
436
448
disabled, or None
449
server_settings: The server_settings dict from main()
439
452
runtime_expansions = ("approval_delay", "approval_duration",
440
"created", "enabled", "fingerprint",
441
"host", "interval", "last_checked_ok",
453
"created", "enabled", "expires",
454
"fingerprint", "host", "interval",
455
"last_approval_request", "last_checked_ok",
442
456
"last_enabled", "name", "timeout")
443
client_defaults = { "timeout": "5m",
444
"extended_timeout": "15m",
457
client_defaults = { "timeout": "PT5M",
458
"extended_timeout": "PT15M",
446
460
"checker": "fping -q -- %%(host)s",
448
"approval_delay": "0s",
449
"approval_duration": "1s",
462
"approval_delay": "PT0S",
463
"approval_duration": "PT1S",
450
464
"approved_by_default": "True",
451
465
"enabled": "True",
570
587
if getattr(self, "enabled", False):
571
588
# Already enabled
573
self.send_changedstate()
574
590
self.expires = datetime.datetime.utcnow() + self.timeout
575
591
self.enabled = True
576
592
self.last_enabled = datetime.datetime.utcnow()
577
593
self.init_checker()
594
self.send_changedstate()
579
596
def disable(self, quiet=True):
580
597
"""Disable this client."""
581
598
if not getattr(self, "enabled", False):
584
self.send_changedstate()
586
601
logger.info("Disabling client %s", self.name)
587
if getattr(self, "disable_initiator_tag", False):
602
if getattr(self, "disable_initiator_tag", None) is not None:
588
603
gobject.source_remove(self.disable_initiator_tag)
589
604
self.disable_initiator_tag = None
590
605
self.expires = None
591
if getattr(self, "checker_initiator_tag", False):
606
if getattr(self, "checker_initiator_tag", None) is not None:
592
607
gobject.source_remove(self.checker_initiator_tag)
593
608
self.checker_initiator_tag = None
594
609
self.stop_checker()
595
610
self.enabled = False
612
self.send_changedstate()
596
613
# Do not run this again if called by a gobject.timeout_add
680
703
self.current_checker_command)
681
704
# Start a new checker if needed
682
705
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)
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
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
702
717
self.current_checker_command = command
704
719
logger.info("Starting checker %r for %s",
707
722
# in normal mode, that is already done by daemon(),
708
723
# and in debug mode we don't want to. (Stdin is
709
724
# 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,
710
733
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)
723
737
except OSError as error:
724
738
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)
726
759
# Re-run this periodically if run by gobject.timeout_add
1527
1562
def Timeout_dbus_property(self, value=None):
1528
1563
if value is None: # get
1529
1564
return dbus.UInt64(self.timeout_milliseconds())
1565
old_timeout = self.timeout
1530
1566
self.timeout = datetime.timedelta(0, 0, 0, value)
1531
# Reschedule timeout
1567
# Reschedule disabling
1532
1568
if self.enabled:
1533
1569
now = datetime.datetime.utcnow()
1534
time_to_die = timedelta_to_milliseconds(
1535
(self.last_checked_ok + self.timeout) - now)
1536
if time_to_die <= 0:
1570
self.expires += self.timeout - old_timeout
1571
if self.expires <= now:
1537
1572
# The timeout has passed
1540
self.expires = (now +
1541
datetime.timedelta(milliseconds =
1543
1575
if (getattr(self, "disable_initiator_tag", None)
1546
1578
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (gobject.timeout_add
1579
self.disable_initiator_tag = (
1580
gobject.timeout_add(
1581
timedelta_to_milliseconds(self.expires - now),
1551
1584
# ExtendedTimeout - property
1552
1585
@dbus_service_property(_interface, signature="t",
1899
1931
use_ipv6: Boolean; to use IPv6 or not
1901
1933
def __init__(self, server_address, RequestHandlerClass,
1902
interface=None, use_ipv6=True):
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().
1903
1938
self.interface = interface
1905
1940
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.
1906
1967
socketserver.TCPServer.__init__(self, server_address,
1907
1968
RequestHandlerClass)
1908
1970
def server_bind(self):
1909
1971
"""This overrides the normal server_bind() function
1910
1972
to bind to an interface if one was specified, and also NOT to
1919
1981
self.socket.setsockopt(socket.SOL_SOCKET,
1920
1982
SO_BINDTODEVICE,
1983
str(self.interface + '\0'))
1923
1984
except socket.error as error:
1924
if error[0] == errno.EPERM:
1925
logger.error("No permission to"
1926
" bind to interface %s",
1928
elif error[0] == errno.ENOPROTOOPT:
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:
1929
1989
logger.error("SO_BINDTODEVICE not available;"
1930
1990
" cannot bind to interface %s",
1931
1991
self.interface)
1992
elif error.errno == errno.ENODEV:
1993
logger.error("Interface %s does not exist,"
1994
" cannot bind", self.interface)
1934
1997
# Only bind(2) the socket if we really need to.
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")
2061
2224
def string_to_delta(interval):
2062
2225
"""Parse a string and return a datetime.timedelta
2156
2325
parser.add_argument("--no-dbus", action="store_false",
2157
2326
dest="use_dbus", help="Do not provide D-Bus"
2158
" system bus interface")
2327
" system bus interface", default=None)
2159
2328
parser.add_argument("--no-ipv6", action="store_false",
2160
dest="use_ipv6", help="Do not use IPv6")
2329
dest="use_ipv6", help="Do not use IPv6",
2161
2331
parser.add_argument("--no-restore", action="store_false",
2162
2332
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")
2164
2337
parser.add_argument("--statedir", metavar="DIR",
2165
2338
help="Directory to save/restore state in")
2339
parser.add_argument("--foreground", action="store_true",
2340
help="Run in foreground", default=None)
2167
2342
options = parser.parse_args()
2169
2344
if options.check:
2346
fail_count, test_count = doctest.testmod()
2347
sys.exit(os.EX_OK if fail_count == 0 else 1)
2174
2349
# Default values for config file for server-global settings
2175
2350
server_defaults = { "interface": "",
2194
2371
# Convert the SafeConfigParser object to a dict
2195
2372
server_settings = server_config.defaults()
2196
2373
# Use the appropriate methods on the non-string config options
2197
for option in ("debug", "use_dbus", "use_ipv6"):
2374
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2198
2375
server_settings[option] = server_config.getboolean("DEFAULT",
2200
2377
if server_settings["port"]:
2201
2378
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
2203
2389
del server_config
2205
2391
# Override the settings from the config file with command line
2440
2653
# Create all client objects
2441
2654
for client_name, client in clients_data.iteritems():
2442
2655
tcp_server.clients[client_name] = client_class(
2443
name = client_name, settings = client)
2656
name = client_name, settings = client,
2657
server_settings = server_settings)
2445
2659
if not tcp_server.clients:
2446
2660
logger.warning("No clients defined")
2452
pidfile.write(str(pid) + "\n".encode("utf-8"))
2455
logger.error("Could not write to file %r with PID %d",
2458
# "pidfile" was never created
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",
2460
2672
del pidfilename
2461
signal.signal(signal.SIGINT, signal.SIG_IGN)
2463
2674
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2464
2675
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())