172
174
def password_encode(self, password):
173
175
# Passphrase can not be empty and can not contain newlines or
174
176
# NUL bytes. So we prefix it and hex encode it.
175
return b"mandos" + binascii.hexlify(password)
177
encoded = b"mandos" + binascii.hexlify(password)
178
if len(encoded) > 2048:
179
# GnuPG can't handle long passwords, so encode differently
180
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
181
.replace(b"\n", b"\\n")
182
.replace(b"\0", b"\\x00"))
177
185
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
186
passphrase = self.password_encode(password)
187
with tempfile.NamedTemporaryFile(dir=self.tempdir
189
passfile.write(passphrase)
191
proc = subprocess.Popen(['gpg', '--symmetric',
195
stdin = subprocess.PIPE,
196
stdout = subprocess.PIPE,
197
stderr = subprocess.PIPE)
198
ciphertext, err = proc.communicate(input = data)
199
if proc.returncode != 0:
192
201
return ciphertext
194
203
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
204
passphrase = self.password_encode(password)
205
with tempfile.NamedTemporaryFile(dir = self.tempdir
207
passfile.write(passphrase)
209
proc = subprocess.Popen(['gpg', '--decrypt',
213
stdin = subprocess.PIPE,
214
stdout = subprocess.PIPE,
215
stderr = subprocess.PIPE)
216
decrypted_plaintext, err = proc.communicate(input
218
if proc.returncode != 0:
209
220
return decrypted_plaintext
434
448
runtime_expansions: Allowed attributes for runtime expansion.
435
449
expires: datetime.datetime(); time (UTC) when a client will be
436
450
disabled, or None
451
server_settings: The server_settings dict from main()
439
454
runtime_expansions = ("approval_delay", "approval_duration",
440
"created", "enabled", "fingerprint",
441
"host", "interval", "last_checked_ok",
455
"created", "enabled", "expires",
456
"fingerprint", "host", "interval",
457
"last_approval_request", "last_checked_ok",
442
458
"last_enabled", "name", "timeout")
443
client_defaults = { "timeout": "5m",
444
"extended_timeout": "15m",
459
client_defaults = { "timeout": "PT5M",
460
"extended_timeout": "PT15M",
446
462
"checker": "fping -q -- %%(host)s",
448
"approval_delay": "0s",
449
"approval_duration": "1s",
464
"approval_delay": "PT0S",
465
"approval_duration": "PT1S",
450
466
"approved_by_default": "True",
451
467
"enabled": "True",
570
589
if getattr(self, "enabled", False):
571
590
# Already enabled
573
self.send_changedstate()
574
592
self.expires = datetime.datetime.utcnow() + self.timeout
575
593
self.enabled = True
576
594
self.last_enabled = datetime.datetime.utcnow()
577
595
self.init_checker()
596
self.send_changedstate()
579
598
def disable(self, quiet=True):
580
599
"""Disable this client."""
581
600
if not getattr(self, "enabled", False):
584
self.send_changedstate()
586
603
logger.info("Disabling client %s", self.name)
587
if getattr(self, "disable_initiator_tag", False):
604
if getattr(self, "disable_initiator_tag", None) is not None:
588
605
gobject.source_remove(self.disable_initiator_tag)
589
606
self.disable_initiator_tag = None
590
607
self.expires = None
591
if getattr(self, "checker_initiator_tag", False):
608
if getattr(self, "checker_initiator_tag", None) is not None:
592
609
gobject.source_remove(self.checker_initiator_tag)
593
610
self.checker_initiator_tag = None
594
611
self.stop_checker()
595
612
self.enabled = False
614
self.send_changedstate()
596
615
# Do not run this again if called by a gobject.timeout_add
680
705
self.current_checker_command)
681
706
# Start a new checker if needed
682
707
if self.checker is None:
708
# Escape attributes for the shell
709
escaped_attrs = dict(
710
(attr, re.escape(unicode(getattr(self, attr))))
712
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
714
command = self.checker_command % escaped_attrs
715
except TypeError as error:
716
logger.error('Could not format string "%s"',
717
self.checker_command, exc_info=error)
718
return True # Try again later
702
719
self.current_checker_command = command
704
721
logger.info("Starting checker %r for %s",
707
724
# in normal mode, that is already done by daemon(),
708
725
# and in debug mode we don't want to. (Stdin is
709
726
# always replaced by /dev/null.)
727
# The exception is when not debugging but nevertheless
728
# running in the foreground; use the previously
731
if (not self.server_settings["debug"]
732
and self.server_settings["foreground"]):
733
popen_args.update({"stdout": wnull,
710
735
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
739
except OSError as error:
724
740
logger.error("Failed to start subprocess",
743
self.checker_callback_tag = (gobject.child_watch_add
745
self.checker_callback,
747
# The checker may have completed before the gobject
748
# watch was added. Check for this.
750
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
751
except OSError as error:
752
if error.errno == errno.ECHILD:
753
# This should never happen
754
logger.error("Child process vanished",
759
gobject.source_remove(self.checker_callback_tag)
760
self.checker_callback(pid, status, command)
726
761
# Re-run this periodically if run by gobject.timeout_add
1527
1560
def Timeout_dbus_property(self, value=None):
1528
1561
if value is None: # get
1529
1562
return dbus.UInt64(self.timeout_milliseconds())
1563
old_timeout = self.timeout
1530
1564
self.timeout = datetime.timedelta(0, 0, 0, value)
1531
# Reschedule timeout
1565
# Reschedule disabling
1532
1566
if self.enabled:
1533
1567
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:
1568
self.expires += self.timeout - old_timeout
1569
if self.expires <= now:
1537
1570
# The timeout has passed
1540
self.expires = (now +
1541
datetime.timedelta(milliseconds =
1543
1573
if (getattr(self, "disable_initiator_tag", None)
1546
1576
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (gobject.timeout_add
1577
self.disable_initiator_tag = (
1578
gobject.timeout_add(
1579
timedelta_to_milliseconds(self.expires - now),
1551
1582
# ExtendedTimeout - property
1552
1583
@dbus_service_property(_interface, signature="t",
1899
1929
use_ipv6: Boolean; to use IPv6 or not
1901
1931
def __init__(self, server_address, RequestHandlerClass,
1902
interface=None, use_ipv6=True):
1932
interface=None, use_ipv6=True, socketfd=None):
1933
"""If socketfd is set, use that file descriptor instead of
1934
creating a new one with socket.socket().
1903
1936
self.interface = interface
1905
1938
self.address_family = socket.AF_INET6
1939
if socketfd is not None:
1940
# Save the file descriptor
1941
self.socketfd = socketfd
1942
# Save the original socket.socket() function
1943
self.socket_socket = socket.socket
1944
# To implement --socket, we monkey patch socket.socket.
1946
# (When socketserver.TCPServer is a new-style class, we
1947
# could make self.socket into a property instead of monkey
1948
# patching socket.socket.)
1950
# Create a one-time-only replacement for socket.socket()
1951
@functools.wraps(socket.socket)
1952
def socket_wrapper(*args, **kwargs):
1953
# Restore original function so subsequent calls are
1955
socket.socket = self.socket_socket
1956
del self.socket_socket
1957
# This time only, return a new socket object from the
1958
# saved file descriptor.
1959
return socket.fromfd(self.socketfd, *args, **kwargs)
1960
# Replace socket.socket() function with wrapper
1961
socket.socket = socket_wrapper
1962
# The socketserver.TCPServer.__init__ will call
1963
# socket.socket(), which might be our replacement,
1964
# socket_wrapper(), if socketfd was set.
1906
1965
socketserver.TCPServer.__init__(self, server_address,
1907
1966
RequestHandlerClass)
1908
1968
def server_bind(self):
1909
1969
"""This overrides the normal server_bind() function
1910
1970
to bind to an interface if one was specified, and also NOT to
1919
1979
self.socket.setsockopt(socket.SOL_SOCKET,
1920
1980
SO_BINDTODEVICE,
1981
str(self.interface + '\0'))
1923
1982
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:
1983
if error.errno == errno.EPERM:
1984
logger.error("No permission to bind to"
1985
" interface %s", self.interface)
1986
elif error.errno == errno.ENOPROTOOPT:
1929
1987
logger.error("SO_BINDTODEVICE not available;"
1930
1988
" cannot bind to interface %s",
1931
1989
self.interface)
1990
elif error.errno == errno.ENODEV:
1991
logger.error("Interface %s does not exist,"
1992
" cannot bind", self.interface)
1934
1995
# Only bind(2) the socket if we really need to.
2123
def rfc3339_duration_to_delta(duration):
2124
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2126
>>> rfc3339_duration_to_delta("P7D")
2127
datetime.timedelta(7)
2128
>>> rfc3339_duration_to_delta("PT60S")
2129
datetime.timedelta(0, 60)
2130
>>> rfc3339_duration_to_delta("PT60M")
2131
datetime.timedelta(0, 3600)
2132
>>> rfc3339_duration_to_delta("PT24H")
2133
datetime.timedelta(1)
2134
>>> rfc3339_duration_to_delta("P1W")
2135
datetime.timedelta(7)
2136
>>> rfc3339_duration_to_delta("PT5M30S")
2137
datetime.timedelta(0, 330)
2138
>>> rfc3339_duration_to_delta("P1DT3M20S")
2139
datetime.timedelta(1, 200)
2142
# Parsing an RFC 3339 duration with regular expressions is not
2143
# possible - there would have to be multiple places for the same
2144
# values, like seconds. The current code, while more esoteric, is
2145
# cleaner without depending on a parsing library. If Python had a
2146
# built-in library for parsing we would use it, but we'd like to
2147
# avoid excessive use of external libraries.
2149
# New type for defining tokens, syntax, and semantics all-in-one
2150
Token = collections.namedtuple("Token",
2151
("regexp", # To match token; if
2152
# "value" is not None,
2153
# must have a "group"
2155
"value", # datetime.timedelta or
2157
"followers")) # Tokens valid after
2159
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2160
# the "duration" ABNF definition in RFC 3339, Appendix A.
2161
token_end = Token(re.compile(r"$"), None, frozenset())
2162
token_second = Token(re.compile(r"(\d+)S"),
2163
datetime.timedelta(seconds=1),
2164
frozenset((token_end,)))
2165
token_minute = Token(re.compile(r"(\d+)M"),
2166
datetime.timedelta(minutes=1),
2167
frozenset((token_second, token_end)))
2168
token_hour = Token(re.compile(r"(\d+)H"),
2169
datetime.timedelta(hours=1),
2170
frozenset((token_minute, token_end)))
2171
token_time = Token(re.compile(r"T"),
2173
frozenset((token_hour, token_minute,
2175
token_day = Token(re.compile(r"(\d+)D"),
2176
datetime.timedelta(days=1),
2177
frozenset((token_time, token_end)))
2178
token_month = Token(re.compile(r"(\d+)M"),
2179
datetime.timedelta(weeks=4),
2180
frozenset((token_day, token_end)))
2181
token_year = Token(re.compile(r"(\d+)Y"),
2182
datetime.timedelta(weeks=52),
2183
frozenset((token_month, token_end)))
2184
token_week = Token(re.compile(r"(\d+)W"),
2185
datetime.timedelta(weeks=1),
2186
frozenset((token_end,)))
2187
token_duration = Token(re.compile(r"P"), None,
2188
frozenset((token_year, token_month,
2189
token_day, token_time,
2191
# Define starting values
2192
value = datetime.timedelta() # Value so far
2194
followers = frozenset(token_duration,) # Following valid tokens
2195
s = duration # String left to parse
2196
# Loop until end token is found
2197
while found_token is not token_end:
2198
# Search for any currently valid tokens
2199
for token in followers:
2200
match = token.regexp.match(s)
2201
if match is not None:
2203
if token.value is not None:
2204
# Value found, parse digits
2205
factor = int(match.group(1), 10)
2206
# Add to value so far
2207
value += factor * token.value
2208
# Strip token from string
2209
s = token.regexp.sub("", s, 1)
2212
# Set valid next tokens
2213
followers = found_token.followers
2216
# No currently valid tokens were found
2217
raise ValueError("Invalid RFC 3339 duration")
2061
2222
def string_to_delta(interval):
2062
2223
"""Parse a string and return a datetime.timedelta
2156
2323
parser.add_argument("--no-dbus", action="store_false",
2157
2324
dest="use_dbus", help="Do not provide D-Bus"
2158
" system bus interface")
2325
" system bus interface", default=None)
2159
2326
parser.add_argument("--no-ipv6", action="store_false",
2160
dest="use_ipv6", help="Do not use IPv6")
2327
dest="use_ipv6", help="Do not use IPv6",
2161
2329
parser.add_argument("--no-restore", action="store_false",
2162
2330
dest="restore", help="Do not restore stored"
2331
" state", default=None)
2332
parser.add_argument("--socket", type=int,
2333
help="Specify a file descriptor to a network"
2334
" socket to use instead of creating one")
2164
2335
parser.add_argument("--statedir", metavar="DIR",
2165
2336
help="Directory to save/restore state in")
2337
parser.add_argument("--foreground", action="store_true",
2338
help="Run in foreground", default=None)
2167
2340
options = parser.parse_args()
2169
2342
if options.check:
2344
fail_count, test_count = doctest.testmod()
2345
sys.exit(os.EX_OK if fail_count == 0 else 1)
2174
2347
# Default values for config file for server-global settings
2175
2348
server_defaults = { "interface": "",
2194
2369
# Convert the SafeConfigParser object to a dict
2195
2370
server_settings = server_config.defaults()
2196
2371
# Use the appropriate methods on the non-string config options
2197
for option in ("debug", "use_dbus", "use_ipv6"):
2372
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2198
2373
server_settings[option] = server_config.getboolean("DEFAULT",
2200
2375
if server_settings["port"]:
2201
2376
server_settings["port"] = server_config.getint("DEFAULT",
2378
if server_settings["socket"]:
2379
server_settings["socket"] = server_config.getint("DEFAULT",
2381
# Later, stdin will, and stdout and stderr might, be dup'ed
2382
# over with an opened os.devnull. But we don't want this to
2383
# happen with a supplied network socket.
2384
if 0 <= server_settings["socket"] <= 2:
2385
server_settings["socket"] = os.dup(server_settings
2203
2387
del server_config
2205
2389
# Override the settings from the config file with command line
2440
2651
# Create all client objects
2441
2652
for client_name, client in clients_data.iteritems():
2442
2653
tcp_server.clients[client_name] = client_class(
2443
name = client_name, settings = client)
2654
name = client_name, settings = client,
2655
server_settings = server_settings)
2445
2657
if not tcp_server.clients:
2446
2658
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
2661
if pidfile is not None:
2665
pidfile.write(str(pid) + "\n".encode("utf-8"))
2667
logger.error("Could not write to file %r with PID %d",
2460
2670
del pidfilename
2461
signal.signal(signal.SIGINT, signal.SIG_IGN)
2463
2672
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2464
2673
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2564
2774
del client_settings[client.name]["secret"]
2567
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2570
(stored_state_path))
2571
with os.fdopen(tempfd, "wb") as stored_state:
2777
with (tempfile.NamedTemporaryFile
2778
(mode='wb', suffix=".pickle", prefix='clients-',
2779
dir=os.path.dirname(stored_state_path),
2780
delete=False)) as stored_state:
2572
2781
pickle.dump((clients, client_settings), stored_state)
2782
tempname=stored_state.name
2573
2783
os.rename(tempname, stored_state_path)
2574
2784
except (IOError, OSError) as e: