439
444
runtime_expansions = ("approval_delay", "approval_duration",
440
"created", "enabled", "fingerprint",
441
"host", "interval", "last_checked_ok",
445
"created", "enabled", "expires",
446
"fingerprint", "host", "interval",
447
"last_approval_request", "last_checked_ok",
442
448
"last_enabled", "name", "timeout")
443
449
client_defaults = { "timeout": "5m",
444
450
"extended_timeout": "15m",
570
576
if getattr(self, "enabled", False):
571
577
# Already enabled
573
self.send_changedstate()
574
579
self.expires = datetime.datetime.utcnow() + self.timeout
575
580
self.enabled = True
576
581
self.last_enabled = datetime.datetime.utcnow()
577
582
self.init_checker()
583
self.send_changedstate()
579
585
def disable(self, quiet=True):
580
586
"""Disable this client."""
581
587
if not getattr(self, "enabled", False):
584
self.send_changedstate()
586
590
logger.info("Disabling client %s", self.name)
587
if getattr(self, "disable_initiator_tag", False):
591
if getattr(self, "disable_initiator_tag", None) is not None:
588
592
gobject.source_remove(self.disable_initiator_tag)
589
593
self.disable_initiator_tag = None
590
594
self.expires = None
591
if getattr(self, "checker_initiator_tag", False):
595
if getattr(self, "checker_initiator_tag", None) is not None:
592
596
gobject.source_remove(self.checker_initiator_tag)
593
597
self.checker_initiator_tag = None
594
598
self.stop_checker()
595
599
self.enabled = False
601
self.send_changedstate()
596
602
# Do not run this again if called by a gobject.timeout_add
602
608
def init_checker(self):
603
609
# Schedule a new checker to be started an 'interval' from now,
604
610
# and every interval from then on.
611
if self.checker_initiator_tag is not None:
612
gobject.source_remove(self.checker_initiator_tag)
605
613
self.checker_initiator_tag = (gobject.timeout_add
606
614
(self.interval_milliseconds(),
607
615
self.start_checker))
608
616
# Schedule a disable() when 'timeout' has passed
617
if self.disable_initiator_tag is not None:
618
gobject.source_remove(self.disable_initiator_tag)
609
619
self.disable_initiator_tag = (gobject.timeout_add
610
620
(self.timeout_milliseconds(),
657
668
If a checker already exists, leave it running and do
659
670
# The reason for not killing a running checker is that if we
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
671
# did that, and if a checker (for some reason) started running
672
# slowly and taking more than 'interval' time, then the client
673
# would inevitably timeout, since no checker would get a
674
# chance to run to completion. If we instead leave running
664
675
# checkers alone, the checker would have to take more time
665
676
# than 'timeout' for the client to be disabled, which is as it
680
691
self.current_checker_command)
681
692
# Start a new checker if needed
682
693
if self.checker is None:
694
# Escape attributes for the shell
695
escaped_attrs = dict(
696
(attr, re.escape(unicode(getattr(self, attr))))
698
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
700
command = self.checker_command % escaped_attrs
701
except TypeError as error:
702
logger.error('Could not format string "%s"',
703
self.checker_command, exc_info=error)
704
return True # Try again later
702
705
self.current_checker_command = command
704
707
logger.info("Starting checker %r for %s",
710
713
self.checker = subprocess.Popen(command,
712
715
shell=True, cwd="/")
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
716
except OSError as error:
724
717
logger.error("Failed to start subprocess",
719
self.checker_callback_tag = (gobject.child_watch_add
721
self.checker_callback,
723
# The checker may have completed before the gobject
724
# watch was added. Check for this.
725
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
727
gobject.source_remove(self.checker_callback_tag)
728
self.checker_callback(pid, status, command)
726
729
# Re-run this periodically if run by gobject.timeout_add
979
982
tag.appendChild(ann_tag)
980
983
# Add interface annotation tags
981
984
for annotation, value in dict(
983
*(annotations().iteritems()
984
for name, annotations in
985
self._get_all_dbus_things("interface")
986
if name == if_tag.getAttribute("name")
985
itertools.chain.from_iterable(
986
annotations().iteritems()
987
for name, annotations in
988
self._get_all_dbus_things("interface")
989
if name == if_tag.getAttribute("name")
988
991
ann_tag = document.createElement("annotation")
989
992
ann_tag.setAttribute("name", annotation)
990
993
ann_tag.setAttribute("value", value)
1021
1024
variant_level=variant_level)
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.
1027
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1028
"""A class decorator; applied to a subclass of
1029
dbus.service.Object, it will add alternate D-Bus attributes with
1030
interface names according to the "alt_interface_names" mapping.
1033
@alternate_dbus_interfaces({"org.example.Interface":
1034
"net.example.AlternateInterface"})
1035
class SampleDBusObject(dbus.service.Object):
1036
@dbus.service.method("org.example.Interface")
1037
def SampleDBusMethod():
1040
The above "SampleDBusMethod" on "SampleDBusObject" will be
1041
reachable via two interfaces: "org.example.Interface" and
1042
"net.example.AlternateInterface", the latter of which will have
1043
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1044
"true", unless "deprecate" is passed with a False value.
1046
This works for methods and signals, and also for D-Bus properties
1047
(from DBusObjectWithProperties) and interfaces (from the
1048
dbus_interface_annotations decorator).
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):
1051
for orig_interface_name, alt_interface_name in (
1052
alt_interface_names.iteritems()):
1054
interface_names = set()
1055
# Go though all attributes of the class
1056
for attrname, attribute in inspect.getmembers(cls):
1037
1057
# Ignore non-D-Bus attributes, and D-Bus attributes
1038
1058
# with the wrong interface name
1039
1059
if (not hasattr(attribute, "_dbus_interface")
1040
1060
or not attribute._dbus_interface
1041
.startswith("se.recompile.Mandos")):
1061
.startswith(orig_interface_name)):
1043
1063
# Create an alternate D-Bus interface name based on
1044
1064
# the current name
1045
1065
alt_interface = (attribute._dbus_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)
1066
.replace(orig_interface_name,
1067
alt_interface_name))
1068
interface_names.add(alt_interface)
1050
1069
# Is this a D-Bus signal?
1051
1070
if getattr(attribute, "_dbus_is_signal", False):
1052
1071
# Extract the original non-method function by
1074
1093
except AttributeError:
1076
1095
# Define a creator of a function to call both the
1077
# old and new functions, so both the old and new
1078
# signals gets sent when the function is called
1096
# original and alternate functions, so both the
1097
# original and alternate signals gets sent when
1098
# the function is called
1079
1099
def fixscope(func1, func2):
1080
1100
"""This function is a scope container to pass
1081
1101
func1 and func2 to the "call_both" function
1088
1108
return call_both
1089
1109
# Create the "call_both" function and add it to
1091
attr[attrname] = fixscope(attribute,
1111
attr[attrname] = fixscope(attribute, new_function)
1093
1112
# Is this a D-Bus method?
1094
1113
elif getattr(attribute, "_dbus_is_method", False):
1095
1114
# Create a new, but exactly alike, function
1151
1170
attribute.func_name,
1152
1171
attribute.func_defaults,
1153
1172
attribute.func_closure)))
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)
1174
# Deprecate all alternate interfaces
1175
iname="_AlternateDBusNames_interface_annotation{0}"
1176
for interface_name in interface_names:
1177
@dbus_interface_annotations(interface_name)
1179
return { "org.freedesktop.DBus.Deprecated":
1181
# Find an unused name
1182
for aname in (iname.format(i)
1183
for i in itertools.count()):
1184
if aname not in attr:
1188
# Replace the class with a new subclass of it with
1189
# methods, signals, etc. as created above.
1190
cls = type(b"{0}Alternate".format(cls.__name__),
1196
@alternate_dbus_interfaces({"se.recompile.Mandos":
1197
"se.bsnet.fukt.Mandos"})
1168
1198
class ClientDBus(Client, DBusObjectWithProperties):
1169
1199
"""A Client class using D-Bus
1500
1530
def Timeout_dbus_property(self, value=None):
1501
1531
if value is None: # get
1502
1532
return dbus.UInt64(self.timeout_milliseconds())
1533
old_timeout = self.timeout
1503
1534
self.timeout = datetime.timedelta(0, 0, 0, value)
1504
# Reschedule timeout
1535
# Reschedule disabling
1505
1536
if self.enabled:
1506
1537
now = datetime.datetime.utcnow()
1507
time_to_die = timedelta_to_milliseconds(
1508
(self.last_checked_ok + self.timeout) - now)
1509
if time_to_die <= 0:
1538
self.expires += self.timeout - old_timeout
1539
if self.expires <= now:
1510
1540
# The timeout has passed
1513
self.expires = (now +
1514
datetime.timedelta(milliseconds =
1516
1543
if (getattr(self, "disable_initiator_tag", None)
1519
1546
gobject.source_remove(self.disable_initiator_tag)
1520
self.disable_initiator_tag = (gobject.timeout_add
1547
self.disable_initiator_tag = (
1548
gobject.timeout_add(
1549
timedelta_to_milliseconds(self.expires - now),
1524
1552
# ExtendedTimeout - property
1525
1553
@dbus_service_property(_interface, signature="t",
1717
1741
#wait until timeout or approved
1718
1742
time = datetime.datetime.now()
1719
1743
client.changedstate.acquire()
1720
(client.changedstate.wait
1721
(float(client.timedelta_to_milliseconds(delay)
1744
client.changedstate.wait(
1745
float(timedelta_to_milliseconds(delay)
1723
1747
client.changedstate.release()
1724
1748
time2 = datetime.datetime.now()
1725
1749
if (time2 - time) >= delay:
1874
1899
use_ipv6: Boolean; to use IPv6 or not
1876
1901
def __init__(self, server_address, RequestHandlerClass,
1877
interface=None, use_ipv6=True):
1902
interface=None, use_ipv6=True, socketfd=None):
1903
"""If socketfd is set, use that file descriptor instead of
1904
creating a new one with socket.socket().
1878
1906
self.interface = interface
1880
1908
self.address_family = socket.AF_INET6
1909
if socketfd is not None:
1910
# Save the file descriptor
1911
self.socketfd = socketfd
1912
# Save the original socket.socket() function
1913
self.socket_socket = socket.socket
1914
# To implement --socket, we monkey patch socket.socket.
1916
# (When socketserver.TCPServer is a new-style class, we
1917
# could make self.socket into a property instead of monkey
1918
# patching socket.socket.)
1920
# Create a one-time-only replacement for socket.socket()
1921
@functools.wraps(socket.socket)
1922
def socket_wrapper(*args, **kwargs):
1923
# Restore original function so subsequent calls are
1925
socket.socket = self.socket_socket
1926
del self.socket_socket
1927
# This time only, return a new socket object from the
1928
# saved file descriptor.
1929
return socket.fromfd(self.socketfd, *args, **kwargs)
1930
# Replace socket.socket() function with wrapper
1931
socket.socket = socket_wrapper
1932
# The socketserver.TCPServer.__init__ will call
1933
# socket.socket(), which might be our replacement,
1934
# socket_wrapper(), if socketfd was set.
1881
1935
socketserver.TCPServer.__init__(self, server_address,
1882
1936
RequestHandlerClass)
1883
1938
def server_bind(self):
1884
1939
"""This overrides the normal server_bind() function
1885
1940
to bind to an interface if one was specified, and also NOT to
1894
1949
self.socket.setsockopt(socket.SOL_SOCKET,
1895
1950
SO_BINDTODEVICE,
1951
str(self.interface + '\0'))
1898
1952
except socket.error as error:
1899
if error[0] == errno.EPERM:
1900
logger.error("No permission to"
1901
" bind to interface %s",
1903
elif error[0] == errno.ENOPROTOOPT:
1953
if error.errno == errno.EPERM:
1954
logger.error("No permission to bind to"
1955
" interface %s", self.interface)
1956
elif error.errno == errno.ENOPROTOOPT:
1904
1957
logger.error("SO_BINDTODEVICE not available;"
1905
1958
" cannot bind to interface %s",
1906
1959
self.interface)
1960
elif error.errno == errno.ENODEV:
1961
logger.error("Interface %s does not exist,"
1962
" cannot bind", self.interface)
1909
1965
# Only bind(2) the socket if we really need to.
1969
2026
def handle_ipc(self, source, condition, parent_pipe=None,
1970
2027
proc = None, client_object=None):
1972
gobject.IO_IN: "IN", # There is data to read.
1973
gobject.IO_OUT: "OUT", # Data can be written (without
1975
gobject.IO_PRI: "PRI", # There is urgent data to read.
1976
gobject.IO_ERR: "ERR", # Error condition.
1977
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1978
# broken, usually for pipes and
1981
conditions_string = ' | '.join(name
1983
condition_names.iteritems()
1984
if cond & condition)
1985
2028
# error, or the other end of multiprocessing.Pipe has closed
1986
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2029
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1987
2030
# Wait for other process to exit
2150
2193
parser.add_argument("--no-restore", action="store_false",
2151
2194
dest="restore", help="Do not restore stored"
2196
parser.add_argument("--socket", type=int,
2197
help="Specify a file descriptor to a network"
2198
" socket to use instead of creating one")
2153
2199
parser.add_argument("--statedir", metavar="DIR",
2154
2200
help="Directory to save/restore state in")
2201
parser.add_argument("--foreground", action="store_true",
2202
help="Run in foreground")
2156
2204
options = parser.parse_args()
2183
2233
# Convert the SafeConfigParser object to a dict
2184
2234
server_settings = server_config.defaults()
2185
2235
# Use the appropriate methods on the non-string config options
2186
for option in ("debug", "use_dbus", "use_ipv6"):
2236
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2187
2237
server_settings[option] = server_config.getboolean("DEFAULT",
2189
2239
if server_settings["port"]:
2190
2240
server_settings["port"] = server_config.getint("DEFAULT",
2242
if server_settings["socket"]:
2243
server_settings["socket"] = server_config.getint("DEFAULT",
2245
# Later, stdin will, and stdout and stderr might, be dup'ed
2246
# over with an opened os.devnull. But we don't want this to
2247
# happen with a supplied network socket.
2248
if 0 <= server_settings["socket"] <= 2:
2249
server_settings["socket"] = os.dup(server_settings
2192
2251
del server_config
2194
2253
# Override the settings from the config file with command line
2196
2255
for option in ("interface", "address", "port", "debug",
2197
2256
"priority", "servicename", "configdir",
2198
2257
"use_dbus", "use_ipv6", "debuglevel", "restore",
2258
"statedir", "socket", "foreground"):
2200
2259
value = getattr(options, option)
2201
2260
if value is not None:
2202
2261
server_settings[option] = value
2205
2264
for option in server_settings.keys():
2206
2265
if type(server_settings[option]) is str:
2207
2266
server_settings[option] = unicode(server_settings[option])
2267
# Debug implies foreground
2268
if server_settings["debug"]:
2269
server_settings["foreground"] = True
2208
2270
# Now we have our good server settings in "server_settings"
2210
2272
##################################################################
2250
2313
use_ipv6=use_ipv6,
2251
2314
gnutls_priority=
2252
2315
server_settings["priority"],
2317
socketfd=(server_settings["socket"]
2255
2320
pidfilename = "/var/run/mandos.pid"
2257
2323
pidfile = open(pidfilename, "w")
2259
logger.error("Could not open file %r", pidfilename)
2324
except IOError as e:
2325
logger.error("Could not open file %r", pidfilename,
2261
2328
for name in ("_mandos", "mandos", "nobody"):
2349
2417
(stored_state))
2350
2418
os.remove(stored_state_path)
2351
2419
except IOError as e:
2352
logger.warning("Could not load persistent state: {0}"
2354
if e.errno != errno.ENOENT:
2420
if e.errno == errno.ENOENT:
2421
logger.warning("Could not load persistent state: {0}"
2422
.format(os.strerror(e.errno)))
2424
logger.critical("Could not load persistent state:",
2356
2427
except EOFError as e:
2357
2428
logger.warning("Could not load persistent state: "
2358
"EOFError: {0}".format(e))
2429
"EOFError:", exc_info=e)
2360
2431
with PGPEngine() as pgp:
2361
2432
for client_name, client in clients_data.iteritems():
2431
2502
if not tcp_server.clients:
2432
2503
logger.warning("No clients defined")
2438
pidfile.write(str(pid) + "\n".encode("utf-8"))
2441
logger.error("Could not write to file %r with PID %d",
2444
# "pidfile" was never created
2506
if pidfile is not None:
2510
pidfile.write(str(pid) + "\n".encode("utf-8"))
2512
logger.error("Could not write to file %r with PID %d",
2446
2515
del pidfilename
2447
signal.signal(signal.SIGINT, signal.SIG_IGN)
2449
2517
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2450
2518
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2521
@alternate_dbus_interfaces({"se.recompile.Mandos":
2522
"se.bsnet.fukt.Mandos"})
2453
2523
class MandosDBusService(DBusObjectWithProperties):
2454
2524
"""A D-Bus proxy object"""
2455
2525
def __init__(self):
2550
2618
del client_settings[client.name]["secret"]
2553
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2556
(stored_state_path))
2557
with os.fdopen(tempfd, "wb") as stored_state:
2621
with (tempfile.NamedTemporaryFile
2622
(mode='wb', suffix=".pickle", prefix='clients-',
2623
dir=os.path.dirname(stored_state_path),
2624
delete=False)) as stored_state:
2558
2625
pickle.dump((clients, client_settings), stored_state)
2626
tempname=stored_state.name
2559
2627
os.rename(tempname, stored_state_path)
2560
2628
except (IOError, OSError) as e:
2561
logger.warning("Could not save persistent state: {0}"
2565
2631
os.remove(tempname)
2566
2632
except NameError:
2568
if e.errno not in set((errno.ENOENT, errno.EACCES,
2634
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2635
logger.warning("Could not save persistent state: {0}"
2636
.format(os.strerror(e.errno)))
2638
logger.warning("Could not save persistent state:",
2572
2642
# Delete all clients, and settings from config