175
174
def password_encode(self, password):
176
175
# Passphrase can not be empty and can not contain newlines or
177
176
# NUL bytes. So we prefix it and hex encode it.
178
encoded = b"mandos" + binascii.hexlify(password)
179
if len(encoded) > 2048:
180
# GnuPG can't handle long passwords, so encode differently
181
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
182
.replace(b"\n", b"\\n")
183
.replace(b"\0", b"\\x00"))
177
return b"mandos" + binascii.hexlify(password)
186
179
def encrypt(self, data, password):
187
passphrase = self.password_encode(password)
188
with tempfile.NamedTemporaryFile(dir=self.tempdir
190
passfile.write(passphrase)
192
proc = subprocess.Popen(['gpg', '--symmetric',
196
stdin = subprocess.PIPE,
197
stdout = subprocess.PIPE,
198
stderr = subprocess.PIPE)
199
ciphertext, err = proc.communicate(input = data)
200
if proc.returncode != 0:
180
self.gnupg.passphrase = self.password_encode(password)
181
with open(os.devnull, "w") as devnull:
183
proc = self.gnupg.run(['--symmetric'],
184
create_fhs=['stdin', 'stdout'],
185
attach_fhs={'stderr': devnull})
186
with contextlib.closing(proc.handles['stdin']) as f:
188
with contextlib.closing(proc.handles['stdout']) as f:
189
ciphertext = f.read()
193
self.gnupg.passphrase = None
202
194
return ciphertext
204
196
def decrypt(self, data, password):
205
passphrase = self.password_encode(password)
206
with tempfile.NamedTemporaryFile(dir = self.tempdir
208
passfile.write(passphrase)
210
proc = subprocess.Popen(['gpg', '--decrypt',
214
stdin = subprocess.PIPE,
215
stdout = subprocess.PIPE,
216
stderr = subprocess.PIPE)
217
decrypted_plaintext, err = proc.communicate(input
219
if proc.returncode != 0:
197
self.gnupg.passphrase = self.password_encode(password)
198
with open(os.devnull, "w") as devnull:
200
proc = self.gnupg.run(['--decrypt'],
201
create_fhs=['stdin', 'stdout'],
202
attach_fhs={'stderr': devnull})
203
with contextlib.closing(proc.handles['stdin']) as f:
205
with contextlib.closing(proc.handles['stdout']) as f:
206
decrypted_plaintext = f.read()
210
self.gnupg.passphrase = None
221
211
return decrypted_plaintext
442
436
runtime_expansions: Allowed attributes for runtime expansion.
443
437
expires: datetime.datetime(); time (UTC) when a client will be
444
438
disabled, or None
445
server_settings: The server_settings dict from main()
448
441
runtime_expansions = ("approval_delay", "approval_duration",
449
"created", "enabled", "expires",
450
"fingerprint", "host", "interval",
451
"last_approval_request", "last_checked_ok",
442
"created", "enabled", "fingerprint",
443
"host", "interval", "last_checked_ok",
452
444
"last_enabled", "name", "timeout")
453
client_defaults = { "timeout": "PT5M",
454
"extended_timeout": "PT15M",
445
client_defaults = { "timeout": "5m",
446
"extended_timeout": "15m",
456
448
"checker": "fping -q -- %%(host)s",
458
"approval_delay": "PT0S",
459
"approval_duration": "PT1S",
450
"approval_delay": "0s",
451
"approval_duration": "1s",
460
452
"approved_by_default": "True",
461
453
"enabled": "True",
456
def timeout_milliseconds(self):
457
"Return the 'timeout' attribute in milliseconds"
458
return timedelta_to_milliseconds(self.timeout)
460
def extended_timeout_milliseconds(self):
461
"Return the 'extended_timeout' attribute in milliseconds"
462
return timedelta_to_milliseconds(self.extended_timeout)
464
def interval_milliseconds(self):
465
"Return the 'interval' attribute in milliseconds"
466
return timedelta_to_milliseconds(self.interval)
468
def approval_delay_milliseconds(self):
469
return timedelta_to_milliseconds(self.approval_delay)
465
472
def config_parser(config):
466
473
"""Construct a new dict of client settings of this form:
568
572
if getattr(self, "enabled", False):
569
573
# Already enabled
575
self.send_changedstate()
571
576
self.expires = datetime.datetime.utcnow() + self.timeout
572
577
self.enabled = True
573
578
self.last_enabled = datetime.datetime.utcnow()
574
579
self.init_checker()
575
self.send_changedstate()
577
581
def disable(self, quiet=True):
578
582
"""Disable this client."""
579
583
if not getattr(self, "enabled", False):
586
self.send_changedstate()
582
588
logger.info("Disabling client %s", self.name)
583
if getattr(self, "disable_initiator_tag", None) is not None:
589
if getattr(self, "disable_initiator_tag", False):
584
590
gobject.source_remove(self.disable_initiator_tag)
585
591
self.disable_initiator_tag = None
586
592
self.expires = None
587
if getattr(self, "checker_initiator_tag", None) is not None:
593
if getattr(self, "checker_initiator_tag", False):
588
594
gobject.source_remove(self.checker_initiator_tag)
589
595
self.checker_initiator_tag = None
590
596
self.stop_checker()
591
597
self.enabled = False
593
self.send_changedstate()
594
598
# Do not run this again if called by a gobject.timeout_add
600
604
def init_checker(self):
601
605
# Schedule a new checker to be started an 'interval' from now,
602
606
# and every interval from then on.
603
if self.checker_initiator_tag is not None:
604
gobject.source_remove(self.checker_initiator_tag)
605
607
self.checker_initiator_tag = (gobject.timeout_add
607
.total_seconds() * 1000),
608
(self.interval_milliseconds(),
608
609
self.start_checker))
609
610
# Schedule a disable() when 'timeout' has passed
610
if self.disable_initiator_tag is not None:
611
gobject.source_remove(self.disable_initiator_tag)
612
611
self.disable_initiator_tag = (gobject.timeout_add
614
.total_seconds() * 1000),
612
(self.timeout_milliseconds(),
616
614
# Also start a new checker *right now*.
617
615
self.start_checker()
686
682
self.current_checker_command)
687
683
# Start a new checker if needed
688
684
if self.checker is None:
689
# Escape attributes for the shell
690
escaped_attrs = { attr:
691
re.escape(unicode(getattr(self,
693
for attr in self.runtime_expansions }
695
command = self.checker_command % escaped_attrs
696
except TypeError as error:
697
logger.error('Could not format string "%s"',
698
self.checker_command, exc_info=error)
699
return True # Try again later
686
# In case checker_command has exactly one % operator
687
command = self.checker_command % self.host
689
# Escape attributes for the shell
690
escaped_attrs = dict(
692
re.escape(unicode(str(getattr(self, attr, "")),
696
self.runtime_expansions)
699
command = self.checker_command % escaped_attrs
700
except TypeError as error:
701
logger.error('Could not format string "%s"',
702
self.checker_command, exc_info=error)
703
return True # Try again later
700
704
self.current_checker_command = command
702
706
logger.info("Starting checker %r for %s",
705
709
# in normal mode, that is already done by daemon(),
706
710
# and in debug mode we don't want to. (Stdin is
707
711
# always replaced by /dev/null.)
708
# The exception is when not debugging but nevertheless
709
# running in the foreground; use the previously
712
if (not self.server_settings["debug"]
713
and self.server_settings["foreground"]):
714
popen_args.update({"stdout": wnull,
716
712
self.checker = subprocess.Popen(command,
715
self.checker_callback_tag = (gobject.child_watch_add
717
self.checker_callback,
719
# The checker may have completed before the gobject
720
# watch was added. Check for this.
721
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
723
gobject.source_remove(self.checker_callback_tag)
724
self.checker_callback(pid, status, command)
720
725
except OSError as error:
721
726
logger.error("Failed to start subprocess",
724
self.checker_callback_tag = (gobject.child_watch_add
726
self.checker_callback,
728
# The checker may have completed before the gobject
729
# watch was added. Check for this.
731
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
732
except OSError as error:
733
if error.errno == errno.ECHILD:
734
# This should never happen
735
logger.error("Child process vanished",
740
gobject.source_remove(self.checker_callback_tag)
741
self.checker_callback(pid, status, command)
742
728
# Re-run this periodically if run by gobject.timeout_add
1285
1269
approval_delay = notifychangeproperty(dbus.UInt64,
1286
1270
"ApprovalDelay",
1288
lambda td: td.total_seconds()
1272
timedelta_to_milliseconds)
1290
1273
approval_duration = notifychangeproperty(
1291
1274
dbus.UInt64, "ApprovalDuration",
1292
type_func = lambda td: td.total_seconds() * 1000)
1275
type_func = timedelta_to_milliseconds)
1293
1276
host = notifychangeproperty(dbus.String, "Host")
1294
1277
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1295
type_func = lambda td:
1296
td.total_seconds() * 1000)
1279
timedelta_to_milliseconds)
1297
1280
extended_timeout = notifychangeproperty(
1298
1281
dbus.UInt64, "ExtendedTimeout",
1299
type_func = lambda td: td.total_seconds() * 1000)
1282
type_func = timedelta_to_milliseconds)
1300
1283
interval = notifychangeproperty(dbus.UInt64,
1303
lambda td: td.total_seconds()
1286
timedelta_to_milliseconds)
1305
1287
checker_command = notifychangeproperty(dbus.String, "Checker")
1307
1289
del notifychangeproperty
1542
1528
access="readwrite")
1543
1529
def Timeout_dbus_property(self, value=None):
1544
1530
if value is None: # get
1545
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1546
old_timeout = self.timeout
1531
return dbus.UInt64(self.timeout_milliseconds())
1547
1532
self.timeout = datetime.timedelta(0, 0, 0, value)
1548
# Reschedule disabling
1533
# Reschedule timeout
1549
1534
if self.enabled:
1550
1535
now = datetime.datetime.utcnow()
1551
self.expires += self.timeout - old_timeout
1552
if self.expires <= now:
1536
time_to_die = timedelta_to_milliseconds(
1537
(self.last_checked_ok + self.timeout) - now)
1538
if time_to_die <= 0:
1553
1539
# The timeout has passed
1542
self.expires = (now +
1543
datetime.timedelta(milliseconds =
1556
1545
if (getattr(self, "disable_initiator_tag", None)
1559
1548
gobject.source_remove(self.disable_initiator_tag)
1560
self.disable_initiator_tag = (
1561
gobject.timeout_add(
1562
int((self.expires - now).total_seconds()
1563
* 1000), self.disable))
1549
self.disable_initiator_tag = (gobject.timeout_add
1565
1553
# ExtendedTimeout - property
1566
1554
@dbus_service_property(_interface, signature="t",
1567
1555
access="readwrite")
1568
1556
def ExtendedTimeout_dbus_property(self, value=None):
1569
1557
if value is None: # get
1570
return dbus.UInt64(self.extended_timeout.total_seconds()
1558
return dbus.UInt64(self.extended_timeout_milliseconds())
1572
1559
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1574
1561
# Interval - property
1911
1900
use_ipv6: Boolean; to use IPv6 or not
1913
1902
def __init__(self, server_address, RequestHandlerClass,
1914
interface=None, use_ipv6=True, socketfd=None):
1915
"""If socketfd is set, use that file descriptor instead of
1916
creating a new one with socket.socket().
1903
interface=None, use_ipv6=True):
1918
1904
self.interface = interface
1920
1906
self.address_family = socket.AF_INET6
1921
if socketfd is not None:
1922
# Save the file descriptor
1923
self.socketfd = socketfd
1924
# Save the original socket.socket() function
1925
self.socket_socket = socket.socket
1926
# To implement --socket, we monkey patch socket.socket.
1928
# (When socketserver.TCPServer is a new-style class, we
1929
# could make self.socket into a property instead of monkey
1930
# patching socket.socket.)
1932
# Create a one-time-only replacement for socket.socket()
1933
@functools.wraps(socket.socket)
1934
def socket_wrapper(*args, **kwargs):
1935
# Restore original function so subsequent calls are
1937
socket.socket = self.socket_socket
1938
del self.socket_socket
1939
# This time only, return a new socket object from the
1940
# saved file descriptor.
1941
return socket.fromfd(self.socketfd, *args, **kwargs)
1942
# Replace socket.socket() function with wrapper
1943
socket.socket = socket_wrapper
1944
# The socketserver.TCPServer.__init__ will call
1945
# socket.socket(), which might be our replacement,
1946
# socket_wrapper(), if socketfd was set.
1947
1907
socketserver.TCPServer.__init__(self, server_address,
1948
1908
RequestHandlerClass)
1950
1909
def server_bind(self):
1951
1910
"""This overrides the normal server_bind() function
1952
1911
to bind to an interface if one was specified, and also NOT to
1961
1920
self.socket.setsockopt(socket.SOL_SOCKET,
1962
1921
SO_BINDTODEVICE,
1963
str(self.interface + '\0'))
1964
1924
except socket.error as error:
1965
if error.errno == errno.EPERM:
1966
logger.error("No permission to bind to"
1967
" interface %s", self.interface)
1968
elif error.errno == errno.ENOPROTOOPT:
1925
if error[0] == errno.EPERM:
1926
logger.error("No permission to"
1927
" bind to interface %s",
1929
elif error[0] == errno.ENOPROTOOPT:
1969
1930
logger.error("SO_BINDTODEVICE not available;"
1970
1931
" cannot bind to interface %s",
1971
1932
self.interface)
1972
elif error.errno == errno.ENODEV:
1973
logger.error("Interface %s does not exist,"
1974
" cannot bind", self.interface)
1977
1935
# Only bind(2) the socket if we really need to.
2105
def rfc3339_duration_to_delta(duration):
2106
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2108
>>> rfc3339_duration_to_delta("P7D")
2109
datetime.timedelta(7)
2110
>>> rfc3339_duration_to_delta("PT60S")
2111
datetime.timedelta(0, 60)
2112
>>> rfc3339_duration_to_delta("PT60M")
2113
datetime.timedelta(0, 3600)
2114
>>> rfc3339_duration_to_delta("PT24H")
2115
datetime.timedelta(1)
2116
>>> rfc3339_duration_to_delta("P1W")
2117
datetime.timedelta(7)
2118
>>> rfc3339_duration_to_delta("PT5M30S")
2119
datetime.timedelta(0, 330)
2120
>>> rfc3339_duration_to_delta("P1DT3M20S")
2121
datetime.timedelta(1, 200)
2124
# Parsing an RFC 3339 duration with regular expressions is not
2125
# possible - there would have to be multiple places for the same
2126
# values, like seconds. The current code, while more esoteric, is
2127
# cleaner without depending on a parsing library. If Python had a
2128
# built-in library for parsing we would use it, but we'd like to
2129
# avoid excessive use of external libraries.
2131
# New type for defining tokens, syntax, and semantics all-in-one
2132
Token = collections.namedtuple("Token",
2133
("regexp", # To match token; if
2134
# "value" is not None,
2135
# must have a "group"
2137
"value", # datetime.timedelta or
2139
"followers")) # Tokens valid after
2141
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2142
# the "duration" ABNF definition in RFC 3339, Appendix A.
2143
token_end = Token(re.compile(r"$"), None, frozenset())
2144
token_second = Token(re.compile(r"(\d+)S"),
2145
datetime.timedelta(seconds=1),
2146
frozenset((token_end,)))
2147
token_minute = Token(re.compile(r"(\d+)M"),
2148
datetime.timedelta(minutes=1),
2149
frozenset((token_second, token_end)))
2150
token_hour = Token(re.compile(r"(\d+)H"),
2151
datetime.timedelta(hours=1),
2152
frozenset((token_minute, token_end)))
2153
token_time = Token(re.compile(r"T"),
2155
frozenset((token_hour, token_minute,
2157
token_day = Token(re.compile(r"(\d+)D"),
2158
datetime.timedelta(days=1),
2159
frozenset((token_time, token_end)))
2160
token_month = Token(re.compile(r"(\d+)M"),
2161
datetime.timedelta(weeks=4),
2162
frozenset((token_day, token_end)))
2163
token_year = Token(re.compile(r"(\d+)Y"),
2164
datetime.timedelta(weeks=52),
2165
frozenset((token_month, token_end)))
2166
token_week = Token(re.compile(r"(\d+)W"),
2167
datetime.timedelta(weeks=1),
2168
frozenset((token_end,)))
2169
token_duration = Token(re.compile(r"P"), None,
2170
frozenset((token_year, token_month,
2171
token_day, token_time,
2173
# Define starting values
2174
value = datetime.timedelta() # Value so far
2176
followers = frozenset((token_duration,)) # Following valid tokens
2177
s = duration # String left to parse
2178
# Loop until end token is found
2179
while found_token is not token_end:
2180
# Search for any currently valid tokens
2181
for token in followers:
2182
match = token.regexp.match(s)
2183
if match is not None:
2185
if token.value is not None:
2186
# Value found, parse digits
2187
factor = int(match.group(1), 10)
2188
# Add to value so far
2189
value += factor * token.value
2190
# Strip token from string
2191
s = token.regexp.sub("", s, 1)
2194
# Set valid next tokens
2195
followers = found_token.followers
2198
# No currently valid tokens were found
2199
raise ValueError("Invalid RFC 3339 duration")
2204
2062
def string_to_delta(interval):
2205
2063
"""Parse a string and return a datetime.timedelta
2304
2157
parser.add_argument("--no-dbus", action="store_false",
2305
2158
dest="use_dbus", help="Do not provide D-Bus"
2306
" system bus interface", default=None)
2159
" system bus interface")
2307
2160
parser.add_argument("--no-ipv6", action="store_false",
2308
dest="use_ipv6", help="Do not use IPv6",
2161
dest="use_ipv6", help="Do not use IPv6")
2310
2162
parser.add_argument("--no-restore", action="store_false",
2311
2163
dest="restore", help="Do not restore stored"
2312
" state", default=None)
2313
parser.add_argument("--socket", type=int,
2314
help="Specify a file descriptor to a network"
2315
" socket to use instead of creating one")
2316
2165
parser.add_argument("--statedir", metavar="DIR",
2317
2166
help="Directory to save/restore state in")
2318
parser.add_argument("--foreground", action="store_true",
2319
help="Run in foreground", default=None)
2320
parser.add_argument("--no-zeroconf", action="store_false",
2321
dest="zeroconf", help="Do not use Zeroconf",
2324
2168
options = parser.parse_args()
2326
2170
if options.check:
2328
fail_count, test_count = doctest.testmod()
2329
sys.exit(os.EX_OK if fail_count == 0 else 1)
2331
2175
# Default values for config file for server-global settings
2332
2176
server_defaults = { "interface": "",
2354
2195
# Convert the SafeConfigParser object to a dict
2355
2196
server_settings = server_config.defaults()
2356
2197
# Use the appropriate methods on the non-string config options
2357
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2198
for option in ("debug", "use_dbus", "use_ipv6"):
2358
2199
server_settings[option] = server_config.getboolean("DEFAULT",
2360
2201
if server_settings["port"]:
2361
2202
server_settings["port"] = server_config.getint("DEFAULT",
2363
if server_settings["socket"]:
2364
server_settings["socket"] = server_config.getint("DEFAULT",
2366
# Later, stdin will, and stdout and stderr might, be dup'ed
2367
# over with an opened os.devnull. But we don't want this to
2368
# happen with a supplied network socket.
2369
if 0 <= server_settings["socket"] <= 2:
2370
server_settings["socket"] = os.dup(server_settings
2372
2204
del server_config
2374
2206
# Override the settings from the config file with command line
2385
2217
for option in server_settings.keys():
2386
2218
if type(server_settings[option]) is str:
2387
2219
server_settings[option] = unicode(server_settings[option])
2388
# Force all boolean options to be boolean
2389
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2390
"foreground", "zeroconf"):
2391
server_settings[option] = bool(server_settings[option])
2392
# Debug implies foreground
2393
if server_settings["debug"]:
2394
server_settings["foreground"] = True
2395
2220
# Now we have our good server settings in "server_settings"
2397
2222
##################################################################
2399
if (not server_settings["zeroconf"] and
2400
not (server_settings["port"]
2401
or server_settings["socket"] != "")):
2402
parser.error("Needs port or socket to work without"
2405
2224
# For convenience
2406
2225
debug = server_settings["debug"]
2407
2226
debuglevel = server_settings["debuglevel"]
2525
2333
use_dbus = False
2526
2334
server_settings["use_dbus"] = False
2527
2335
tcp_server.use_dbus = False
2529
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2530
service = AvahiServiceToSyslog(name =
2531
server_settings["servicename"],
2532
servicetype = "_mandos._tcp",
2533
protocol = protocol, bus = bus)
2534
if server_settings["interface"]:
2535
service.interface = (if_nametoindex
2536
(str(server_settings["interface"])))
2336
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2337
service = AvahiServiceToSyslog(name =
2338
server_settings["servicename"],
2339
servicetype = "_mandos._tcp",
2340
protocol = protocol, bus = bus)
2341
if server_settings["interface"]:
2342
service.interface = (if_nametoindex
2343
(str(server_settings["interface"])))
2538
2345
global multiprocessing_manager
2539
2346
multiprocessing_manager = multiprocessing.Manager()
2644
2439
clients_data[client_name] = client_settings[client_name]
2646
2441
# Create all client objects
2647
for client_name, client in clients_data.items():
2442
for client_name, client in clients_data.iteritems():
2648
2443
tcp_server.clients[client_name] = client_class(
2649
name = client_name, settings = client,
2650
server_settings = server_settings)
2444
name = client_name, settings = client)
2652
2446
if not tcp_server.clients:
2653
2447
logger.warning("No clients defined")
2656
if pidfile is not None:
2660
pidfile.write(str(pid) + "\n".encode("utf-8"))
2662
logger.error("Could not write to file %r with PID %d",
2453
pidfile.write(str(pid) + "\n".encode("utf-8"))
2456
logger.error("Could not write to file %r with PID %d",
2459
# "pidfile" was never created
2665
2461
del pidfilename
2462
signal.signal(signal.SIGINT, signal.SIG_IGN)
2667
2464
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2668
2465
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())