94
81
except ImportError:
95
82
SO_BINDTODEVICE = None
97
if sys.version_info.major == 2:
101
stored_state_file = "clients.pickle"
103
logger = logging.getLogger()
107
if_nametoindex = ctypes.cdll.LoadLibrary(
108
ctypes.util.find_library("c")).if_nametoindex
109
except (OSError, AttributeError):
111
def if_nametoindex(interface):
112
"Get an interface index the hard way, i.e. using fcntl()"
113
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
114
with contextlib.closing(socket.socket()) as s:
115
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
116
struct.pack(b"16s16x", interface))
117
interface_index = struct.unpack("I", ifreq[16:20])[0]
118
return interface_index
121
def copy_function(func):
122
"""Make a copy of a function"""
123
if sys.version_info.major == 2:
124
return types.FunctionType(func.func_code,
130
return types.FunctionType(func.__code__,
137
def initlogger(debug, level=logging.WARNING):
138
"""init logger and add loglevel"""
141
syslogger = (logging.handlers.SysLogHandler(
142
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
143
address = "/dev/log"))
144
syslogger.setFormatter(logging.Formatter
145
('Mandos [%(process)d]: %(levelname)s:'
147
logger.addHandler(syslogger)
150
console = logging.StreamHandler()
151
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
155
logger.addHandler(console)
156
logger.setLevel(level)
159
class PGPError(Exception):
160
"""Exception if encryption/decryption fails"""
164
class PGPEngine(object):
165
"""A simple class for OpenPGP symmetric encryption & decryption"""
168
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
171
output = subprocess.check_output(["gpgconf"])
172
for line in output.splitlines():
173
name, text, path = line.split(b":")
178
if e.errno != errno.ENOENT:
180
self.gnupgargs = ['--batch',
181
'--homedir', self.tempdir,
189
def __exit__(self, exc_type, exc_value, traceback):
197
if self.tempdir is not None:
198
# Delete contents of tempdir
199
for root, dirs, files in os.walk(self.tempdir,
201
for filename in files:
202
os.remove(os.path.join(root, filename))
204
os.rmdir(os.path.join(root, dirname))
206
os.rmdir(self.tempdir)
209
def password_encode(self, password):
210
# Passphrase can not be empty and can not contain newlines or
211
# NUL bytes. So we prefix it and hex encode it.
212
encoded = b"mandos" + binascii.hexlify(password)
213
if len(encoded) > 2048:
214
# GnuPG can't handle long passwords, so encode differently
215
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
216
.replace(b"\n", b"\\n")
217
.replace(b"\0", b"\\x00"))
220
def encrypt(self, data, password):
221
passphrase = self.password_encode(password)
222
with tempfile.NamedTemporaryFile(
223
dir=self.tempdir) as passfile:
224
passfile.write(passphrase)
226
proc = subprocess.Popen([self.gpg, '--symmetric',
230
stdin = subprocess.PIPE,
231
stdout = subprocess.PIPE,
232
stderr = subprocess.PIPE)
233
ciphertext, err = proc.communicate(input = data)
234
if proc.returncode != 0:
238
def decrypt(self, data, password):
239
passphrase = self.password_encode(password)
240
with tempfile.NamedTemporaryFile(
241
dir = self.tempdir) as passfile:
242
passfile.write(passphrase)
244
proc = subprocess.Popen([self.gpg, '--decrypt',
248
stdin = subprocess.PIPE,
249
stdout = subprocess.PIPE,
250
stderr = subprocess.PIPE)
251
decrypted_plaintext, err = proc.communicate(input = data)
252
if proc.returncode != 0:
254
return decrypted_plaintext
256
# Pretend that we have an Avahi module
258
"""This isn't so much a class as it is a module-like namespace.
259
It is instantiated once, and simulates having an Avahi module."""
260
IF_UNSPEC = -1 # avahi-common/address.h
261
PROTO_UNSPEC = -1 # avahi-common/address.h
262
PROTO_INET = 0 # avahi-common/address.h
263
PROTO_INET6 = 1 # avahi-common/address.h
264
DBUS_NAME = "org.freedesktop.Avahi"
265
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
266
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
267
DBUS_PATH_SERVER = "/"
268
def string_array_to_txt_array(self, t):
269
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
270
for s in t), signature="ay")
271
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
272
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
273
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
274
SERVER_INVALID = 0 # avahi-common/defs.h
275
SERVER_REGISTERING = 1 # avahi-common/defs.h
276
SERVER_RUNNING = 2 # avahi-common/defs.h
277
SERVER_COLLISION = 3 # avahi-common/defs.h
278
SERVER_FAILURE = 4 # avahi-common/defs.h
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
89
syslogger = (logging.handlers.SysLogHandler
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
address = str("/dev/log")))
92
syslogger.setFormatter(logging.Formatter
93
('Mandos [%(process)d]: %(levelname)s:'
95
logger.addHandler(syslogger)
97
console = logging.StreamHandler()
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
101
logger.addHandler(console)
281
103
class AvahiError(Exception):
282
104
def __init__(self, value, *args, **kwargs):
283
105
self.value = value
284
return super(AvahiError, self).__init__(value, *args,
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
288
110
class AvahiServiceError(AvahiError):
292
113
class AvahiGroupError(AvahiError):
466
260
follow_name_owner_changes=True),
467
261
avahi.DBUS_INTERFACE_SERVER)
468
262
self.server.connect_to_signal("StateChanged",
469
self.server_state_changed)
263
self.server_state_changed)
470
264
self.server_state_changed(self.server.GetState())
473
class AvahiServiceToSyslog(AvahiService):
474
def rename(self, *args, **kwargs):
475
"""Add the new name to the syslog messages"""
476
ret = AvahiService.rename(self, *args, **kwargs)
477
syslogger.setFormatter(logging.Formatter(
478
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
482
# Pretend that we have a GnuTLS module
483
class GnuTLS(object):
484
"""This isn't so much a class as it is a module-like namespace.
485
It is instantiated once, and simulates having a GnuTLS module."""
487
_library = ctypes.cdll.LoadLibrary(
488
ctypes.util.find_library("gnutls"))
489
_need_version = b"3.3.0"
491
# Need to use class name "GnuTLS" here, since this method is
492
# called before the assignment to the "gnutls" global variable
494
if GnuTLS.check_version(self._need_version) is None:
495
raise GnuTLS.Error("Needs GnuTLS {} or later"
496
.format(self._need_version))
498
# Unless otherwise indicated, the constants and types below are
499
# all from the gnutls/gnutls.h C header file.
509
E_NO_CERTIFICATE_FOUND = -49
510
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
513
class session_int(ctypes.Structure):
515
session_t = ctypes.POINTER(session_int)
516
class certificate_credentials_st(ctypes.Structure):
518
certificate_credentials_t = ctypes.POINTER(
519
certificate_credentials_st)
520
certificate_type_t = ctypes.c_int
521
class datum_t(ctypes.Structure):
522
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
523
('size', ctypes.c_uint)]
524
class openpgp_crt_int(ctypes.Structure):
526
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
527
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
528
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
529
credentials_type_t = ctypes.c_int
530
transport_ptr_t = ctypes.c_void_p
531
close_request_t = ctypes.c_int
534
class Error(Exception):
535
# We need to use the class name "GnuTLS" here, since this
536
# exception might be raised from within GnuTLS.__init__,
537
# which is called before the assignment to the "gnutls"
538
# global variable has happened.
539
def __init__(self, message = None, code = None, args=()):
540
# Default usage is by a message string, but if a return
541
# code is passed, convert it to a string with
544
if message is None and code is not None:
545
message = GnuTLS.strerror(code)
546
return super(GnuTLS.Error, self).__init__(
549
class CertificateSecurityError(Error):
553
class Credentials(object):
555
self._c_object = gnutls.certificate_credentials_t()
556
gnutls.certificate_allocate_credentials(
557
ctypes.byref(self._c_object))
558
self.type = gnutls.CRD_CERTIFICATE
561
gnutls.certificate_free_credentials(self._c_object)
563
class ClientSession(object):
564
def __init__(self, socket, credentials = None):
565
self._c_object = gnutls.session_t()
566
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
567
gnutls.set_default_priority(self._c_object)
568
gnutls.transport_set_ptr(self._c_object, socket.fileno())
569
gnutls.handshake_set_private_extensions(self._c_object,
572
if credentials is None:
573
credentials = gnutls.Credentials()
574
gnutls.credentials_set(self._c_object, credentials.type,
575
ctypes.cast(credentials._c_object,
577
self.credentials = credentials
580
gnutls.deinit(self._c_object)
583
return gnutls.handshake(self._c_object)
585
def send(self, data):
589
data_len -= gnutls.record_send(self._c_object,
594
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
596
# Error handling functions
597
def _error_code(result):
598
"""A function to raise exceptions on errors, suitable
599
for the 'restype' attribute on ctypes functions"""
602
if result == gnutls.E_NO_CERTIFICATE_FOUND:
603
raise gnutls.CertificateSecurityError(code = result)
604
raise gnutls.Error(code = result)
606
def _retry_on_error(result, func, arguments):
607
"""A function to retry on some errors, suitable
608
for the 'errcheck' attribute on ctypes functions"""
610
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
611
return _error_code(result)
612
result = func(*arguments)
615
# Unless otherwise indicated, the function declarations below are
616
# all from the gnutls/gnutls.h C header file.
619
priority_set_direct = _library.gnutls_priority_set_direct
620
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
621
ctypes.POINTER(ctypes.c_char_p)]
622
priority_set_direct.restype = _error_code
624
init = _library.gnutls_init
625
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
626
init.restype = _error_code
628
set_default_priority = _library.gnutls_set_default_priority
629
set_default_priority.argtypes = [session_t]
630
set_default_priority.restype = _error_code
632
record_send = _library.gnutls_record_send
633
record_send.argtypes = [session_t, ctypes.c_void_p,
635
record_send.restype = ctypes.c_ssize_t
636
record_send.errcheck = _retry_on_error
638
certificate_allocate_credentials = (
639
_library.gnutls_certificate_allocate_credentials)
640
certificate_allocate_credentials.argtypes = [
641
ctypes.POINTER(certificate_credentials_t)]
642
certificate_allocate_credentials.restype = _error_code
644
certificate_free_credentials = (
645
_library.gnutls_certificate_free_credentials)
646
certificate_free_credentials.argtypes = [certificate_credentials_t]
647
certificate_free_credentials.restype = None
649
handshake_set_private_extensions = (
650
_library.gnutls_handshake_set_private_extensions)
651
handshake_set_private_extensions.argtypes = [session_t,
653
handshake_set_private_extensions.restype = None
655
credentials_set = _library.gnutls_credentials_set
656
credentials_set.argtypes = [session_t, credentials_type_t,
658
credentials_set.restype = _error_code
660
strerror = _library.gnutls_strerror
661
strerror.argtypes = [ctypes.c_int]
662
strerror.restype = ctypes.c_char_p
664
certificate_type_get = _library.gnutls_certificate_type_get
665
certificate_type_get.argtypes = [session_t]
666
certificate_type_get.restype = _error_code
668
certificate_get_peers = _library.gnutls_certificate_get_peers
669
certificate_get_peers.argtypes = [session_t,
670
ctypes.POINTER(ctypes.c_uint)]
671
certificate_get_peers.restype = ctypes.POINTER(datum_t)
673
global_set_log_level = _library.gnutls_global_set_log_level
674
global_set_log_level.argtypes = [ctypes.c_int]
675
global_set_log_level.restype = None
677
global_set_log_function = _library.gnutls_global_set_log_function
678
global_set_log_function.argtypes = [log_func]
679
global_set_log_function.restype = None
681
deinit = _library.gnutls_deinit
682
deinit.argtypes = [session_t]
683
deinit.restype = None
685
handshake = _library.gnutls_handshake
686
handshake.argtypes = [session_t]
687
handshake.restype = _error_code
688
handshake.errcheck = _retry_on_error
690
transport_set_ptr = _library.gnutls_transport_set_ptr
691
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
692
transport_set_ptr.restype = None
694
bye = _library.gnutls_bye
695
bye.argtypes = [session_t, close_request_t]
696
bye.restype = _error_code
697
bye.errcheck = _retry_on_error
699
check_version = _library.gnutls_check_version
700
check_version.argtypes = [ctypes.c_char_p]
701
check_version.restype = ctypes.c_char_p
703
# All the function declarations below are from gnutls/openpgp.h
705
openpgp_crt_init = _library.gnutls_openpgp_crt_init
706
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
707
openpgp_crt_init.restype = _error_code
709
openpgp_crt_import = _library.gnutls_openpgp_crt_import
710
openpgp_crt_import.argtypes = [openpgp_crt_t,
711
ctypes.POINTER(datum_t),
713
openpgp_crt_import.restype = _error_code
715
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
716
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
717
ctypes.POINTER(ctypes.c_uint)]
718
openpgp_crt_verify_self.restype = _error_code
720
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
721
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
722
openpgp_crt_deinit.restype = None
724
openpgp_crt_get_fingerprint = (
725
_library.gnutls_openpgp_crt_get_fingerprint)
726
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
730
openpgp_crt_get_fingerprint.restype = _error_code
732
# Remove non-public functions
733
del _error_code, _retry_on_error
734
# Create the global "gnutls" object, simulating a module
737
def call_pipe(connection, # : multiprocessing.Connection
738
func, *args, **kwargs):
739
"""This function is meant to be called by multiprocessing.Process
741
This function runs func(*args, **kwargs), and writes the resulting
742
return value on the provided multiprocessing.Connection.
744
connection.send(func(*args, **kwargs))
267
def _timedelta_to_milliseconds(td):
268
"Convert a datetime.timedelta() to milliseconds"
269
return ((td.days * 24 * 60 * 60 * 1000)
270
+ (td.seconds * 1000)
271
+ (td.microseconds // 1000))
747
273
class Client(object):
748
274
"""A representation of a client host served by this server.
751
approved: bool(); 'None' if not yet approved/disapproved
277
_approved: bool(); 'None' if not yet approved/disapproved
752
278
approval_delay: datetime.timedelta(); Time to wait for approval
753
279
approval_duration: datetime.timedelta(); Duration of one approval
754
280
checker: subprocess.Popen(); a running checker process used
755
281
to see if the client lives.
756
282
'None' if no process is running.
757
checker_callback_tag: a GLib event source tag, or None
283
checker_callback_tag: a gobject event source tag, or None
758
284
checker_command: string; External command which is run to check
759
285
if client lives. %() expansions are done at
760
286
runtime with vars(self) as dict, so that for
761
287
instance %(name)s can be used in the command.
762
checker_initiator_tag: a GLib event source tag, or None
288
checker_initiator_tag: a gobject event source tag, or None
763
289
created: datetime.datetime(); (UTC) object creation
764
client_structure: Object describing what attributes a client has
765
and is used for storing the client at exit
766
290
current_checker_command: string; current running checker_command
767
disable_initiator_tag: a GLib event source tag, or None
291
disable_hook: If set, called by disable() as disable_hook(self)
292
disable_initiator_tag: a gobject event source tag, or None
769
294
fingerprint: string (40 or 32 hexadecimal digits); used to
770
295
uniquely identify the client
772
297
interval: datetime.timedelta(); How often to start a new checker
773
298
last_approval_request: datetime.datetime(); (UTC) or None
774
299
last_checked_ok: datetime.datetime(); (UTC) or None
775
last_checker_status: integer between 0 and 255 reflecting exit
776
status of last checker. -1 reflects crashed
777
checker, -2 means no checker completed yet.
778
last_checker_signal: The signal which killed the last checker, if
779
last_checker_status is -1
780
last_enabled: datetime.datetime(); (UTC) or None
300
last_enabled: datetime.datetime(); (UTC)
781
301
name: string; from the config file, used in log messages and
782
302
D-Bus identifiers
783
303
secret: bytestring; sent verbatim (over TLS) to client
784
304
timeout: datetime.timedelta(); How long from last_checked_ok
785
305
until this client is disabled
786
extended_timeout: extra long timeout when secret has been sent
306
extended_timeout: extra long timeout when password has been sent
787
307
runtime_expansions: Allowed attributes for runtime expansion.
788
308
expires: datetime.datetime(); time (UTC) when a client will be
789
309
disabled, or None
790
server_settings: The server_settings dict from main()
793
312
runtime_expansions = ("approval_delay", "approval_duration",
794
"created", "enabled", "expires",
795
"fingerprint", "host", "interval",
796
"last_approval_request", "last_checked_ok",
313
"created", "enabled", "fingerprint",
314
"host", "interval", "last_checked_ok",
797
315
"last_enabled", "name", "timeout")
800
"extended_timeout": "PT15M",
802
"checker": "fping -q -- %%(host)s",
804
"approval_delay": "PT0S",
805
"approval_duration": "PT1S",
806
"approved_by_default": "True",
811
def config_parser(config):
812
"""Construct a new dict of client settings of this form:
813
{ client_name: {setting_name: value, ...}, ...}
814
with exceptions for any special settings as defined above.
815
NOTE: Must be a pure function. Must return the same result
816
value given the same arguments.
819
for client_name in config.sections():
820
section = dict(config.items(client_name))
821
client = settings[client_name] = {}
823
client["host"] = section["host"]
824
# Reformat values from string types to Python types
825
client["approved_by_default"] = config.getboolean(
826
client_name, "approved_by_default")
827
client["enabled"] = config.getboolean(client_name,
830
# Uppercase and remove spaces from fingerprint for later
831
# comparison purposes with return value from the
832
# fingerprint() function
833
client["fingerprint"] = (section["fingerprint"].upper()
835
if "secret" in section:
836
client["secret"] = codecs.decode(section["secret"]
839
elif "secfile" in section:
840
with open(os.path.expanduser(os.path.expandvars
841
(section["secfile"])),
843
client["secret"] = secfile.read()
845
raise TypeError("No secret or secfile for section {}"
847
client["timeout"] = string_to_delta(section["timeout"])
848
client["extended_timeout"] = string_to_delta(
849
section["extended_timeout"])
850
client["interval"] = string_to_delta(section["interval"])
851
client["approval_delay"] = string_to_delta(
852
section["approval_delay"])
853
client["approval_duration"] = string_to_delta(
854
section["approval_duration"])
855
client["checker_command"] = section["checker"]
856
client["last_approval_request"] = None
857
client["last_checked_ok"] = None
858
client["last_checker_status"] = -2
862
def __init__(self, settings, name = None, server_settings=None):
317
def timeout_milliseconds(self):
318
"Return the 'timeout' attribute in milliseconds"
319
return _timedelta_to_milliseconds(self.timeout)
321
def extended_timeout_milliseconds(self):
322
"Return the 'extended_timeout' attribute in milliseconds"
323
return _timedelta_to_milliseconds(self.extended_timeout)
325
def interval_milliseconds(self):
326
"Return the 'interval' attribute in milliseconds"
327
return _timedelta_to_milliseconds(self.interval)
329
def approval_delay_milliseconds(self):
330
return _timedelta_to_milliseconds(self.approval_delay)
332
def __init__(self, name = None, disable_hook=None, config=None):
333
"""Note: the 'checker' key in 'config' sets the
334
'checker_command' attribute and *not* the 'checker'
864
if server_settings is None:
866
self.server_settings = server_settings
867
# adding all client settings
868
for setting, value in settings.items():
869
setattr(self, setting, value)
872
if not hasattr(self, "last_enabled"):
873
self.last_enabled = datetime.datetime.utcnow()
874
if not hasattr(self, "expires"):
875
self.expires = (datetime.datetime.utcnow()
878
self.last_enabled = None
881
339
logger.debug("Creating client %r", self.name)
340
# Uppercase and remove spaces from fingerprint for later
341
# comparison purposes with return value from the fingerprint()
343
self.fingerprint = (config["fingerprint"].upper()
882
345
logger.debug(" Fingerprint: %s", self.fingerprint)
883
self.created = settings.get("created",
884
datetime.datetime.utcnow())
886
# attributes specific for this server instance
346
if "secret" in config:
347
self.secret = config["secret"].decode("base64")
348
elif "secfile" in config:
349
with open(os.path.expanduser(os.path.expandvars
350
(config["secfile"])),
352
self.secret = secfile.read()
354
raise TypeError("No secret or secfile for client %s"
356
self.host = config.get("host", "")
357
self.created = datetime.datetime.utcnow()
359
self.last_approval_request = None
360
self.last_enabled = None
361
self.last_checked_ok = None
362
self.timeout = string_to_delta(config["timeout"])
363
self.extended_timeout = string_to_delta(config["extended_timeout"])
364
self.interval = string_to_delta(config["interval"])
365
self.disable_hook = disable_hook
887
366
self.checker = None
888
367
self.checker_initiator_tag = None
889
368
self.disable_initiator_tag = None
890
370
self.checker_callback_tag = None
371
self.checker_command = config["checker"]
891
372
self.current_checker_command = None
373
self.last_connect = None
374
self._approved = None
375
self.approved_by_default = config.get("approved_by_default",
893
377
self.approvals_pending = 0
894
self.changedstate = multiprocessing_manager.Condition(
895
multiprocessing_manager.Lock())
896
self.client_structure = [attr
897
for attr in self.__dict__.keys()
898
if not attr.startswith("_")]
899
self.client_structure.append("client_structure")
901
for name, t in inspect.getmembers(
902
type(self), lambda obj: isinstance(obj, property)):
903
if not name.startswith("_"):
904
self.client_structure.append(name)
378
self.approval_delay = string_to_delta(
379
config["approval_delay"])
380
self.approval_duration = string_to_delta(
381
config["approval_duration"])
382
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
906
# Send notice to process children that client state has changed
907
384
def send_changedstate(self):
908
with self.changedstate:
909
self.changedstate.notify_all()
385
self.changedstate.acquire()
386
self.changedstate.notify_all()
387
self.changedstate.release()
911
389
def enable(self):
912
390
"""Start this client's checker and timeout hooks"""
913
391
if getattr(self, "enabled", False):
914
392
# Already enabled
394
self.send_changedstate()
395
# Schedule a new checker to be started an 'interval' from now,
396
# and every interval from then on.
397
self.checker_initiator_tag = (gobject.timeout_add
398
(self.interval_milliseconds(),
400
# Schedule a disable() when 'timeout' has passed
916
401
self.expires = datetime.datetime.utcnow() + self.timeout
402
self.disable_initiator_tag = (gobject.timeout_add
403
(self.timeout_milliseconds(),
917
405
self.enabled = True
918
406
self.last_enabled = datetime.datetime.utcnow()
920
self.send_changedstate()
407
# Also start a new checker *right now*.
922
410
def disable(self, quiet=True):
923
411
"""Disable this client."""
924
412
if not getattr(self, "enabled", False):
415
self.send_changedstate()
927
417
logger.info("Disabling client %s", self.name)
928
if getattr(self, "disable_initiator_tag", None) is not None:
929
GLib.source_remove(self.disable_initiator_tag)
418
if getattr(self, "disable_initiator_tag", False):
419
gobject.source_remove(self.disable_initiator_tag)
930
420
self.disable_initiator_tag = None
931
421
self.expires = None
932
if getattr(self, "checker_initiator_tag", None) is not None:
933
GLib.source_remove(self.checker_initiator_tag)
422
if getattr(self, "checker_initiator_tag", False):
423
gobject.source_remove(self.checker_initiator_tag)
934
424
self.checker_initiator_tag = None
935
425
self.stop_checker()
426
if self.disable_hook:
427
self.disable_hook(self)
936
428
self.enabled = False
938
self.send_changedstate()
939
# Do not run this again if called by a GLib.timeout_add
429
# Do not run this again if called by a gobject.timeout_add
942
432
def __del__(self):
433
self.disable_hook = None
945
def init_checker(self):
946
# Schedule a new checker to be started an 'interval' from now,
947
# and every interval from then on.
948
if self.checker_initiator_tag is not None:
949
GLib.source_remove(self.checker_initiator_tag)
950
self.checker_initiator_tag = GLib.timeout_add(
951
int(self.interval.total_seconds() * 1000),
953
# Schedule a disable() when 'timeout' has passed
954
if self.disable_initiator_tag is not None:
955
GLib.source_remove(self.disable_initiator_tag)
956
self.disable_initiator_tag = GLib.timeout_add(
957
int(self.timeout.total_seconds() * 1000), self.disable)
958
# Also start a new checker *right now*.
961
def checker_callback(self, source, condition, connection,
436
def checker_callback(self, pid, condition, command):
963
437
"""The checker has completed, so take appropriate actions."""
964
438
self.checker_callback_tag = None
965
439
self.checker = None
966
# Read return code from connection (see call_pipe)
967
returncode = connection.recv()
971
self.last_checker_status = returncode
972
self.last_checker_signal = None
973
if self.last_checker_status == 0:
440
if os.WIFEXITED(condition):
441
exitstatus = os.WEXITSTATUS(condition)
974
443
logger.info("Checker for %(name)s succeeded",
976
445
self.checked_ok()
978
logger.info("Checker for %(name)s failed", vars(self))
447
logger.info("Checker for %(name)s failed",
980
self.last_checker_status = -1
981
self.last_checker_signal = -returncode
982
450
logger.warning("Checker for %(name)s crashed?",
986
def checked_ok(self):
987
"""Assert that the client has been seen, alive and well."""
988
self.last_checked_ok = datetime.datetime.utcnow()
989
self.last_checker_status = 0
990
self.last_checker_signal = None
993
def bump_timeout(self, timeout=None):
994
"""Bump up the timeout for this client."""
453
def checked_ok(self, timeout=None):
454
"""Bump up the timeout for this client.
456
This should only be called when the client has been seen,
995
459
if timeout is None:
996
460
timeout = self.timeout
997
if self.disable_initiator_tag is not None:
998
GLib.source_remove(self.disable_initiator_tag)
999
self.disable_initiator_tag = None
1000
if getattr(self, "enabled", False):
1001
self.disable_initiator_tag = GLib.timeout_add(
1002
int(timeout.total_seconds() * 1000), self.disable)
1003
self.expires = datetime.datetime.utcnow() + timeout
461
self.last_checked_ok = datetime.datetime.utcnow()
462
gobject.source_remove(self.disable_initiator_tag)
463
self.expires = datetime.datetime.utcnow() + timeout
464
self.disable_initiator_tag = (gobject.timeout_add
465
(_timedelta_to_milliseconds(timeout),
1005
468
def need_approval(self):
1006
469
self.last_approval_request = datetime.datetime.utcnow()
1011
474
If a checker already exists, leave it running and do
1013
476
# The reason for not killing a running checker is that if we
1014
# did that, and if a checker (for some reason) started running
1015
# slowly and taking more than 'interval' time, then the client
1016
# would inevitably timeout, since no checker would get a
1017
# chance to run to completion. If we instead leave running
477
# did that, then if a checker (for some reason) started
478
# running slowly and taking more than 'interval' time, the
479
# client would inevitably timeout, since no checker would get
480
# a chance to run to completion. If we instead leave running
1018
481
# checkers alone, the checker would have to take more time
1019
482
# than 'timeout' for the client to be disabled, which is as it
1022
if self.checker is not None and not self.checker.is_alive():
1023
logger.warning("Checker was not alive; joining")
485
# If a checker exists, make sure it is not a zombie
487
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
488
except (AttributeError, OSError) as error:
489
if (isinstance(error, OSError)
490
and error.errno != errno.ECHILD):
494
logger.warning("Checker was a zombie")
495
gobject.source_remove(self.checker_callback_tag)
496
self.checker_callback(pid, status,
497
self.current_checker_command)
1026
498
# Start a new checker if needed
1027
499
if self.checker is None:
1028
# Escape attributes for the shell
1030
attr: re.escape(str(getattr(self, attr)))
1031
for attr in self.runtime_expansions }
1033
command = self.checker_command % escaped_attrs
1034
except TypeError as error:
1035
logger.error('Could not format string "%s"',
1036
self.checker_command,
1038
return True # Try again later
501
# In case checker_command has exactly one % operator
502
command = self.checker_command % self.host
504
# Escape attributes for the shell
505
escaped_attrs = dict(
507
re.escape(unicode(str(getattr(self, attr, "")),
511
self.runtime_expansions)
514
command = self.checker_command % escaped_attrs
515
except TypeError as error:
516
logger.error('Could not format string "%s":'
517
' %s', self.checker_command, error)
518
return True # Try again later
1039
519
self.current_checker_command = command
1040
logger.info("Starting checker %r for %s", command,
1042
# We don't need to redirect stdout and stderr, since
1043
# in normal mode, that is already done by daemon(),
1044
# and in debug mode we don't want to. (Stdin is
1045
# always replaced by /dev/null.)
1046
# The exception is when not debugging but nevertheless
1047
# running in the foreground; use the previously
1049
popen_args = { "close_fds": True,
1052
if (not self.server_settings["debug"]
1053
and self.server_settings["foreground"]):
1054
popen_args.update({"stdout": wnull,
1056
pipe = multiprocessing.Pipe(duplex = False)
1057
self.checker = multiprocessing.Process(
1059
args = (pipe[1], subprocess.call, command),
1060
kwargs = popen_args)
1061
self.checker.start()
1062
self.checker_callback_tag = GLib.io_add_watch(
1063
pipe[0].fileno(), GLib.IO_IN,
1064
self.checker_callback, pipe[0], command)
1065
# Re-run this periodically if run by GLib.timeout_add
521
logger.info("Starting checker %r for %s",
523
# We don't need to redirect stdout and stderr, since
524
# in normal mode, that is already done by daemon(),
525
# and in debug mode we don't want to. (Stdin is
526
# always replaced by /dev/null.)
527
self.checker = subprocess.Popen(command,
530
self.checker_callback_tag = (gobject.child_watch_add
532
self.checker_callback,
534
# The checker may have completed before the gobject
535
# watch was added. Check for this.
536
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
538
gobject.source_remove(self.checker_callback_tag)
539
self.checker_callback(pid, status, command)
540
except OSError as error:
541
logger.error("Failed to start subprocess: %s",
543
# Re-run this periodically if run by gobject.timeout_add
1068
546
def stop_checker(self):
1069
547
"""Force the checker process, if any, to stop."""
1070
548
if self.checker_callback_tag:
1071
GLib.source_remove(self.checker_callback_tag)
549
gobject.source_remove(self.checker_callback_tag)
1072
550
self.checker_callback_tag = None
1073
551
if getattr(self, "checker", None) is None:
1075
553
logger.debug("Stopping checker for %(name)s", vars(self))
1076
self.checker.terminate()
555
os.kill(self.checker.pid, signal.SIGTERM)
557
#if self.checker.poll() is None:
558
# os.kill(self.checker.pid, signal.SIGKILL)
559
except OSError as error:
560
if error.errno != errno.ESRCH: # No such process
1077
562
self.checker = None
1080
def dbus_service_property(dbus_interface,
564
def dbus_service_property(dbus_interface, signature="v",
565
access="readwrite", byte_arrays=False):
1084
566
"""Decorators for marking methods of a DBusObjectWithProperties to
1085
567
become properties on the D-Bus.
1175
class DBusObjectWithAnnotations(dbus.service.Object):
1176
"""A D-Bus object with annotations.
1178
Classes inheriting from this can use the dbus_annotations
1179
decorator to add annotations to methods or signals.
1183
def _is_dbus_thing(thing):
1184
"""Returns a function testing if an attribute is a D-Bus thing
1186
If called like _is_dbus_thing("method") it returns a function
1187
suitable for use as predicate to inspect.getmembers().
1189
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1192
def _get_all_dbus_things(self, thing):
1193
"""Returns a generator of (name, attribute) pairs
1195
return ((getattr(athing.__get__(self), "_dbus_name", name),
1196
athing.__get__(self))
1197
for cls in self.__class__.__mro__
1199
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1201
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1202
out_signature = "s",
1203
path_keyword = 'object_path',
1204
connection_keyword = 'connection')
1205
def Introspect(self, object_path, connection):
1206
"""Overloading of standard D-Bus method.
1208
Inserts annotation tags on methods and signals.
1210
xmlstring = dbus.service.Object.Introspect(self, object_path,
1213
document = xml.dom.minidom.parseString(xmlstring)
1215
for if_tag in document.getElementsByTagName("interface"):
1216
# Add annotation tags
1217
for typ in ("method", "signal"):
1218
for tag in if_tag.getElementsByTagName(typ):
1220
for name, prop in (self.
1221
_get_all_dbus_things(typ)):
1222
if (name == tag.getAttribute("name")
1223
and prop._dbus_interface
1224
== if_tag.getAttribute("name")):
1225
annots.update(getattr(
1226
prop, "_dbus_annotations", {}))
1227
for name, value in annots.items():
1228
ann_tag = document.createElement(
1230
ann_tag.setAttribute("name", name)
1231
ann_tag.setAttribute("value", value)
1232
tag.appendChild(ann_tag)
1233
# Add interface annotation tags
1234
for annotation, value in dict(
1235
itertools.chain.from_iterable(
1236
annotations().items()
1237
for name, annotations
1238
in self._get_all_dbus_things("interface")
1239
if name == if_tag.getAttribute("name")
1241
ann_tag = document.createElement("annotation")
1242
ann_tag.setAttribute("name", annotation)
1243
ann_tag.setAttribute("value", value)
1244
if_tag.appendChild(ann_tag)
1245
# Fix argument name for the Introspect method itself
1246
if (if_tag.getAttribute("name")
1247
== dbus.INTROSPECTABLE_IFACE):
1248
for cn in if_tag.getElementsByTagName("method"):
1249
if cn.getAttribute("name") == "Introspect":
1250
for arg in cn.getElementsByTagName("arg"):
1251
if (arg.getAttribute("direction")
1253
arg.setAttribute("name",
1255
xmlstring = document.toxml("utf-8")
1257
except (AttributeError, xml.dom.DOMException,
1258
xml.parsers.expat.ExpatError) as error:
1259
logger.error("Failed to override Introspection method",
1264
class DBusObjectWithProperties(DBusObjectWithAnnotations):
613
class DBusObjectWithProperties(dbus.service.Object):
1265
614
"""A D-Bus object with properties.
1267
616
Classes inheriting from this can use the dbus_service_property
1268
617
decorator to expose methods as D-Bus properties. It exposes the
1269
618
standard Get(), Set(), and GetAll() methods on the D-Bus.
622
def _is_dbus_property(obj):
623
return getattr(obj, "_dbus_is_property", False)
625
def _get_all_dbus_properties(self):
626
"""Returns a generator of (name, attribute) pairs
628
return ((prop._dbus_name, prop)
630
inspect.getmembers(self, self._is_dbus_property))
1272
632
def _get_dbus_property(self, interface_name, property_name):
1273
633
"""Returns a bound method if one exists which is a D-Bus
1274
634
property with the specified name and interface.
1276
for cls in self.__class__.__mro__:
1277
for name, value in inspect.getmembers(
1278
cls, self._is_dbus_thing("property")):
1279
if (value._dbus_name == property_name
1280
and value._dbus_interface == interface_name):
1281
return value.__get__(self)
636
for name in (property_name,
637
property_name + "_dbus_property"):
638
prop = getattr(self, name, None)
640
or not self._is_dbus_property(prop)
641
or prop._dbus_name != property_name
642
or (interface_name and prop._dbus_interface
643
and interface_name != prop._dbus_interface)):
1283
646
# No such property
1284
raise DBusPropertyNotFound("{}:{}.{}".format(
1285
self.dbus_object_path, interface_name, property_name))
1288
def _get_all_interface_names(cls):
1289
"""Get a sequence of all interfaces supported by an object"""
1290
return (name for name in set(getattr(getattr(x, attr),
1291
"_dbus_interface", None)
1292
for x in (inspect.getmro(cls))
1294
if name is not None)
1296
@dbus.service.method(dbus.PROPERTIES_IFACE,
647
raise DBusPropertyNotFound(self.dbus_object_path + ":"
648
+ interface_name + "."
651
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1298
652
out_signature="v")
1299
653
def Get(self, interface_name, property_name):
1300
654
"""Standard D-Bus property Get() method, see D-Bus standard.
1347
698
if not hasattr(value, "variant_level"):
1348
properties[name] = value
1350
properties[name] = type(value)(
1351
value, variant_level = value.variant_level + 1)
1352
return dbus.Dictionary(properties, signature="sv")
1354
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1355
def PropertiesChanged(self, interface_name, changed_properties,
1356
invalidated_properties):
1357
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
701
all[name] = type(value)(value, variant_level=
702
value.variant_level+1)
703
return dbus.Dictionary(all, signature="sv")
1362
705
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1363
706
out_signature="s",
1364
707
path_keyword='object_path',
1365
708
connection_keyword='connection')
1366
709
def Introspect(self, object_path, connection):
1367
"""Overloading of standard D-Bus method.
1369
Inserts property tags and interface annotation tags.
710
"""Standard D-Bus method, overloaded to insert property tags.
1371
xmlstring = DBusObjectWithAnnotations.Introspect(self,
712
xmlstring = dbus.service.Object.Introspect(self, object_path,
1375
715
document = xml.dom.minidom.parseString(xmlstring)
1377
716
def make_tag(document, name, prop):
1378
717
e = document.createElement("property")
1379
718
e.setAttribute("name", name)
1380
719
e.setAttribute("type", prop._dbus_signature)
1381
720
e.setAttribute("access", prop._dbus_access)
1384
722
for if_tag in document.getElementsByTagName("interface"):
1386
723
for tag in (make_tag(document, name, prop)
1388
in self._get_all_dbus_things("property")
725
in self._get_all_dbus_properties()
1389
726
if prop._dbus_interface
1390
727
== if_tag.getAttribute("name")):
1391
728
if_tag.appendChild(tag)
1392
# Add annotation tags for properties
1393
for tag in if_tag.getElementsByTagName("property"):
1395
for name, prop in self._get_all_dbus_things(
1397
if (name == tag.getAttribute("name")
1398
and prop._dbus_interface
1399
== if_tag.getAttribute("name")):
1400
annots.update(getattr(
1401
prop, "_dbus_annotations", {}))
1402
for name, value in annots.items():
1403
ann_tag = document.createElement(
1405
ann_tag.setAttribute("name", name)
1406
ann_tag.setAttribute("value", value)
1407
tag.appendChild(ann_tag)
1408
729
# Add the names to the return values for the
1409
730
# "org.freedesktop.DBus.Properties" methods
1410
731
if (if_tag.getAttribute("name")
1425
746
except (AttributeError, xml.dom.DOMException,
1426
747
xml.parsers.expat.ExpatError) as error:
1427
748
logger.error("Failed to override Introspection method",
1432
dbus.OBJECT_MANAGER_IFACE
1433
except AttributeError:
1434
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1436
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1437
"""A D-Bus object with an ObjectManager.
1439
Classes inheriting from this exposes the standard
1440
GetManagedObjects call and the InterfacesAdded and
1441
InterfacesRemoved signals on the standard
1442
"org.freedesktop.DBus.ObjectManager" interface.
1444
Note: No signals are sent automatically; they must be sent
1447
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1448
out_signature = "a{oa{sa{sv}}}")
1449
def GetManagedObjects(self):
1450
"""This function must be overridden"""
1451
raise NotImplementedError()
1453
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1454
signature = "oa{sa{sv}}")
1455
def InterfacesAdded(self, object_path, interfaces_and_properties):
1458
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1459
def InterfacesRemoved(self, object_path, interfaces):
1462
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1463
out_signature = "s",
1464
path_keyword = 'object_path',
1465
connection_keyword = 'connection')
1466
def Introspect(self, object_path, connection):
1467
"""Overloading of standard D-Bus method.
1469
Override return argument name of GetManagedObjects to be
1470
"objpath_interfaces_and_properties"
1472
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1476
document = xml.dom.minidom.parseString(xmlstring)
1478
for if_tag in document.getElementsByTagName("interface"):
1479
# Fix argument name for the GetManagedObjects method
1480
if (if_tag.getAttribute("name")
1481
== dbus.OBJECT_MANAGER_IFACE):
1482
for cn in if_tag.getElementsByTagName("method"):
1483
if (cn.getAttribute("name")
1484
== "GetManagedObjects"):
1485
for arg in cn.getElementsByTagName("arg"):
1486
if (arg.getAttribute("direction")
1490
"objpath_interfaces"
1492
xmlstring = document.toxml("utf-8")
1494
except (AttributeError, xml.dom.DOMException,
1495
xml.parsers.expat.ExpatError) as error:
1496
logger.error("Failed to override Introspection method",
1500
def datetime_to_dbus(dt, variant_level=0):
753
def datetime_to_dbus (dt, variant_level=0):
1501
754
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1503
756
return dbus.String("", variant_level = variant_level)
1504
return dbus.String(dt.isoformat(), variant_level=variant_level)
1507
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1508
"""A class decorator; applied to a subclass of
1509
dbus.service.Object, it will add alternate D-Bus attributes with
1510
interface names according to the "alt_interface_names" mapping.
1513
@alternate_dbus_interfaces({"org.example.Interface":
1514
"net.example.AlternateInterface"})
1515
class SampleDBusObject(dbus.service.Object):
1516
@dbus.service.method("org.example.Interface")
1517
def SampleDBusMethod():
1520
The above "SampleDBusMethod" on "SampleDBusObject" will be
1521
reachable via two interfaces: "org.example.Interface" and
1522
"net.example.AlternateInterface", the latter of which will have
1523
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1524
"true", unless "deprecate" is passed with a False value.
1526
This works for methods and signals, and also for D-Bus properties
1527
(from DBusObjectWithProperties) and interfaces (from the
1528
dbus_interface_annotations decorator).
1532
for orig_interface_name, alt_interface_name in (
1533
alt_interface_names.items()):
1535
interface_names = set()
1536
# Go though all attributes of the class
1537
for attrname, attribute in inspect.getmembers(cls):
1538
# Ignore non-D-Bus attributes, and D-Bus attributes
1539
# with the wrong interface name
1540
if (not hasattr(attribute, "_dbus_interface")
1541
or not attribute._dbus_interface.startswith(
1542
orig_interface_name)):
1544
# Create an alternate D-Bus interface name based on
1546
alt_interface = attribute._dbus_interface.replace(
1547
orig_interface_name, alt_interface_name)
1548
interface_names.add(alt_interface)
1549
# Is this a D-Bus signal?
1550
if getattr(attribute, "_dbus_is_signal", False):
1551
# Extract the original non-method undecorated
1552
# function by black magic
1553
if sys.version_info.major == 2:
1554
nonmethod_func = (dict(
1555
zip(attribute.func_code.co_freevars,
1556
attribute.__closure__))
1557
["func"].cell_contents)
1559
nonmethod_func = (dict(
1560
zip(attribute.__code__.co_freevars,
1561
attribute.__closure__))
1562
["func"].cell_contents)
1563
# Create a new, but exactly alike, function
1564
# object, and decorate it to be a new D-Bus signal
1565
# with the alternate D-Bus interface name
1566
new_function = copy_function(nonmethod_func)
1567
new_function = (dbus.service.signal(
1569
attribute._dbus_signature)(new_function))
1570
# Copy annotations, if any
1572
new_function._dbus_annotations = dict(
1573
attribute._dbus_annotations)
1574
except AttributeError:
1576
# Define a creator of a function to call both the
1577
# original and alternate functions, so both the
1578
# original and alternate signals gets sent when
1579
# the function is called
1580
def fixscope(func1, func2):
1581
"""This function is a scope container to pass
1582
func1 and func2 to the "call_both" function
1583
outside of its arguments"""
1585
@functools.wraps(func2)
1586
def call_both(*args, **kwargs):
1587
"""This function will emit two D-Bus
1588
signals by calling func1 and func2"""
1589
func1(*args, **kwargs)
1590
func2(*args, **kwargs)
1591
# Make wrapper function look like a D-Bus signal
1592
for name, attr in inspect.getmembers(func2):
1593
if name.startswith("_dbus_"):
1594
setattr(call_both, name, attr)
1597
# Create the "call_both" function and add it to
1599
attr[attrname] = fixscope(attribute, new_function)
1600
# Is this a D-Bus method?
1601
elif getattr(attribute, "_dbus_is_method", False):
1602
# Create a new, but exactly alike, function
1603
# object. Decorate it to be a new D-Bus method
1604
# with the alternate D-Bus interface name. Add it
1607
dbus.service.method(
1609
attribute._dbus_in_signature,
1610
attribute._dbus_out_signature)
1611
(copy_function(attribute)))
1612
# Copy annotations, if any
1614
attr[attrname]._dbus_annotations = dict(
1615
attribute._dbus_annotations)
1616
except AttributeError:
1618
# Is this a D-Bus property?
1619
elif getattr(attribute, "_dbus_is_property", False):
1620
# Create a new, but exactly alike, function
1621
# object, and decorate it to be a new D-Bus
1622
# property with the alternate D-Bus interface
1623
# name. Add it to the class.
1624
attr[attrname] = (dbus_service_property(
1625
alt_interface, attribute._dbus_signature,
1626
attribute._dbus_access,
1627
attribute._dbus_get_args_options
1629
(copy_function(attribute)))
1630
# Copy annotations, if any
1632
attr[attrname]._dbus_annotations = dict(
1633
attribute._dbus_annotations)
1634
except AttributeError:
1636
# Is this a D-Bus interface?
1637
elif getattr(attribute, "_dbus_is_interface", False):
1638
# Create a new, but exactly alike, function
1639
# object. Decorate it to be a new D-Bus interface
1640
# with the alternate D-Bus interface name. Add it
1643
dbus_interface_annotations(alt_interface)
1644
(copy_function(attribute)))
1646
# Deprecate all alternate interfaces
1647
iname="_AlternateDBusNames_interface_annotation{}"
1648
for interface_name in interface_names:
1650
@dbus_interface_annotations(interface_name)
1652
return { "org.freedesktop.DBus.Deprecated":
1654
# Find an unused name
1655
for aname in (iname.format(i)
1656
for i in itertools.count()):
1657
if aname not in attr:
1661
# Replace the class with a new subclass of it with
1662
# methods, signals, etc. as created above.
1663
if sys.version_info.major == 2:
1664
cls = type(b"{}Alternate".format(cls.__name__),
1667
cls = type("{}Alternate".format(cls.__name__),
1674
@alternate_dbus_interfaces({"se.recompile.Mandos":
1675
"se.bsnet.fukt.Mandos"})
757
return dbus.String(dt.isoformat(),
758
variant_level=variant_level)
1676
760
class ClientDBus(Client, DBusObjectWithProperties):
1677
761
"""A Client class using D-Bus
1684
768
runtime_expansions = (Client.runtime_expansions
1685
+ ("dbus_object_path", ))
1687
_interface = "se.recompile.Mandos.Client"
769
+ ("dbus_object_path",))
1689
771
# dbus.service.Object doesn't use super(), so we can't either.
1691
773
def __init__(self, bus = None, *args, **kwargs):
774
self._approvals_pending = 0
1693
776
Client.__init__(self, *args, **kwargs)
1694
777
# Only now, when this client is initialized, can it show up on
1696
client_object_name = str(self.name).translate(
779
client_object_name = unicode(self.name).translate(
1697
780
{ord("."): ord("_"),
1698
781
ord("-"): ord("_")})
1699
self.dbus_object_path = dbus.ObjectPath(
1700
"/clients/" + client_object_name)
782
self.dbus_object_path = (dbus.ObjectPath
783
("/clients/" + client_object_name))
1701
784
DBusObjectWithProperties.__init__(self, self.bus,
1702
785
self.dbus_object_path)
1704
def notifychangeproperty(transform_func, dbus_name,
1705
type_func=lambda x: x,
1707
invalidate_only=False,
1708
_interface=_interface):
1709
""" Modify a variable so that it's a property which announces
1710
its changes to DBus.
1712
transform_fun: Function that takes a value and a variant_level
1713
and transforms it to a D-Bus type.
1714
dbus_name: D-Bus name of the variable
787
def notifychangeproperty(transform_func,
788
dbus_name, type_func=lambda x: x,
790
""" Modify a variable so that its a property that announce its
792
transform_fun: Function that takes a value and transform it to
794
dbus_name: DBus name of the variable
1715
795
type_func: Function that transform the value before sending it
1716
to the D-Bus. Default: no transform
1717
variant_level: D-Bus variant level. Default: 1
797
variant_level: DBus variant level. default: 1
1719
attrname = "_{}".format(dbus_name)
1721
800
def setter(self, value):
801
old_value = real_value[0]
802
real_value[0] = value
1722
803
if hasattr(self, "dbus_object_path"):
1723
if (not hasattr(self, attrname) or
1724
type_func(getattr(self, attrname, None))
1725
!= type_func(value)):
1727
self.PropertiesChanged(
1728
_interface, dbus.Dictionary(),
1729
dbus.Array((dbus_name, )))
1731
dbus_value = transform_func(
1733
variant_level = variant_level)
1734
self.PropertyChanged(dbus.String(dbus_name),
1736
self.PropertiesChanged(
1738
dbus.Dictionary({ dbus.String(dbus_name):
1741
setattr(self, attrname, value)
1743
return property(lambda self: getattr(self, attrname), setter)
804
if type_func(old_value) != type_func(real_value[0]):
805
dbus_value = transform_func(type_func(real_value[0]),
807
self.PropertyChanged(dbus.String(dbus_name),
810
return property(lambda self: real_value[0], setter)
1745
813
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1746
814
approvals_pending = notifychangeproperty(dbus.Boolean,
1747
815
"ApprovalPending",
1749
817
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1750
818
last_enabled = notifychangeproperty(datetime_to_dbus,
1752
checker = notifychangeproperty(
1753
dbus.Boolean, "CheckerRunning",
1754
type_func = lambda checker: checker is not None)
820
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
821
type_func = lambda checker: checker is not None)
1755
822
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1756
823
"LastCheckedOK")
1757
last_checker_status = notifychangeproperty(dbus.Int16,
1758
"LastCheckerStatus")
1759
last_approval_request = notifychangeproperty(
1760
datetime_to_dbus, "LastApprovalRequest")
824
last_approval_request = notifychangeproperty(datetime_to_dbus,
825
"LastApprovalRequest")
1761
826
approved_by_default = notifychangeproperty(dbus.Boolean,
1762
827
"ApprovedByDefault")
1763
approval_delay = notifychangeproperty(
1764
dbus.UInt64, "ApprovalDelay",
1765
type_func = lambda td: td.total_seconds() * 1000)
1766
approval_duration = notifychangeproperty(
1767
dbus.UInt64, "ApprovalDuration",
1768
type_func = lambda td: td.total_seconds() * 1000)
828
approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",
829
type_func = _timedelta_to_milliseconds)
830
approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",
831
type_func = _timedelta_to_milliseconds)
1769
832
host = notifychangeproperty(dbus.String, "Host")
1770
timeout = notifychangeproperty(
1771
dbus.UInt64, "Timeout",
1772
type_func = lambda td: td.total_seconds() * 1000)
1773
extended_timeout = notifychangeproperty(
1774
dbus.UInt64, "ExtendedTimeout",
1775
type_func = lambda td: td.total_seconds() * 1000)
1776
interval = notifychangeproperty(
1777
dbus.UInt64, "Interval",
1778
type_func = lambda td: td.total_seconds() * 1000)
833
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
834
type_func = _timedelta_to_milliseconds)
835
extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",
836
type_func = _timedelta_to_milliseconds)
837
interval = notifychangeproperty(dbus.UInt16, "Interval",
838
type_func = _timedelta_to_milliseconds)
1779
839
checker_command = notifychangeproperty(dbus.String, "Checker")
1780
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1781
invalidate_only=True)
1783
841
del notifychangeproperty
2027
1064
return datetime_to_dbus(self.last_approval_request)
2029
1066
# Timeout - property
2030
@dbus_service_property(_interface,
1067
@dbus_service_property(_interface, signature="t",
2032
1068
access="readwrite")
2033
1069
def Timeout_dbus_property(self, value=None):
2034
1070
if value is None: # get
2035
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2036
old_timeout = self.timeout
1071
return dbus.UInt64(self.timeout_milliseconds())
2037
1072
self.timeout = datetime.timedelta(0, 0, 0, value)
2038
# Reschedule disabling
2040
now = datetime.datetime.utcnow()
2041
self.expires += self.timeout - old_timeout
2042
if self.expires <= now:
2043
# The timeout has passed
2046
if (getattr(self, "disable_initiator_tag", None)
2049
GLib.source_remove(self.disable_initiator_tag)
2050
self.disable_initiator_tag = GLib.timeout_add(
2051
int((self.expires - now).total_seconds() * 1000),
1073
if getattr(self, "disable_initiator_tag", None) is None:
1075
# Reschedule timeout
1076
gobject.source_remove(self.disable_initiator_tag)
1077
self.disable_initiator_tag = None
1079
time_to_die = (self.
1080
_timedelta_to_milliseconds((self
1085
if time_to_die <= 0:
1086
# The timeout has passed
1089
self.expires = (datetime.datetime.utcnow()
1090
+ datetime.timedelta(milliseconds = time_to_die))
1091
self.disable_initiator_tag = (gobject.timeout_add
1092
(time_to_die, self.disable))
2054
1094
# ExtendedTimeout - property
2055
@dbus_service_property(_interface,
1095
@dbus_service_property(_interface, signature="t",
2057
1096
access="readwrite")
2058
1097
def ExtendedTimeout_dbus_property(self, value=None):
2059
1098
if value is None: # get
2060
return dbus.UInt64(self.extended_timeout.total_seconds()
1099
return dbus.UInt64(self.extended_timeout_milliseconds())
2062
1100
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2064
1102
# Interval - property
2065
@dbus_service_property(_interface,
1103
@dbus_service_property(_interface, signature="t",
2067
1104
access="readwrite")
2068
1105
def Interval_dbus_property(self, value=None):
2069
1106
if value is None: # get
2070
return dbus.UInt64(self.interval.total_seconds() * 1000)
1107
return dbus.UInt64(self.interval_milliseconds())
2071
1108
self.interval = datetime.timedelta(0, 0, 0, value)
2072
1109
if getattr(self, "checker_initiator_tag", None) is None:
2075
# Reschedule checker run
2076
GLib.source_remove(self.checker_initiator_tag)
2077
self.checker_initiator_tag = GLib.timeout_add(
2078
value, self.start_checker)
2079
self.start_checker() # Start one now, too
1111
# Reschedule checker run
1112
gobject.source_remove(self.checker_initiator_tag)
1113
self.checker_initiator_tag = (gobject.timeout_add
1114
(value, self.start_checker))
1115
self.start_checker() # Start one now, too
2081
1117
# Checker - property
2082
@dbus_service_property(_interface,
1118
@dbus_service_property(_interface, signature="s",
2084
1119
access="readwrite")
2085
1120
def Checker_dbus_property(self, value=None):
2086
1121
if value is None: # get
2087
1122
return dbus.String(self.checker_command)
2088
self.checker_command = str(value)
1123
self.checker_command = value
2090
1125
# CheckerRunning - property
2091
@dbus_service_property(_interface,
1126
@dbus_service_property(_interface, signature="b",
2093
1127
access="readwrite")
2094
1128
def CheckerRunning_dbus_property(self, value=None):
2095
1129
if value is None: # get
2310
1352
def fingerprint(openpgp):
2311
1353
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2312
1354
# New GnuTLS "datum" with the OpenPGP public key
2313
datum = gnutls.datum_t(
2314
ctypes.cast(ctypes.c_char_p(openpgp),
2315
ctypes.POINTER(ctypes.c_ubyte)),
2316
ctypes.c_uint(len(openpgp)))
1355
datum = (gnutls.library.types
1356
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1359
ctypes.c_uint(len(openpgp))))
2317
1360
# New empty GnuTLS certificate
2318
crt = gnutls.openpgp_crt_t()
2319
gnutls.openpgp_crt_init(ctypes.byref(crt))
1361
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1362
(gnutls.library.functions
1363
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2320
1364
# Import the OpenPGP public key into the certificate
2321
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2322
gnutls.OPENPGP_FMT_RAW)
1365
(gnutls.library.functions
1366
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1367
gnutls.library.constants
1368
.GNUTLS_OPENPGP_FMT_RAW))
2323
1369
# Verify the self signature in the key
2324
1370
crtverify = ctypes.c_uint()
2325
gnutls.openpgp_crt_verify_self(crt, 0,
2326
ctypes.byref(crtverify))
1371
(gnutls.library.functions
1372
.gnutls_openpgp_crt_verify_self(crt, 0,
1373
ctypes.byref(crtverify)))
2327
1374
if crtverify.value != 0:
2328
gnutls.openpgp_crt_deinit(crt)
2329
raise gnutls.CertificateSecurityError("Verify failed")
1375
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1376
raise (gnutls.errors.CertificateSecurityError
2330
1378
# New buffer for the fingerprint
2331
1379
buf = ctypes.create_string_buffer(20)
2332
1380
buf_len = ctypes.c_size_t()
2333
1381
# Get the fingerprint from the certificate into the buffer
2334
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2335
ctypes.byref(buf_len))
1382
(gnutls.library.functions
1383
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1384
ctypes.byref(buf_len)))
2336
1385
# Deinit the certificate
2337
gnutls.openpgp_crt_deinit(crt)
1386
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2338
1387
# Convert the buffer to a Python bytestring
2339
1388
fpr = ctypes.string_at(buf, buf_len.value)
2340
1389
# Convert the bytestring to hexadecimal notation
2341
hex_fpr = binascii.hexlify(fpr).upper()
1390
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2345
1394
class MultiprocessingMixIn(object):
2346
1395
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2348
1396
def sub_process_main(self, request, address):
2350
1398
self.finish_request(request, address)
2352
1400
self.handle_error(request, address)
2353
1401
self.close_request(request)
2355
1403
def process_request(self, request, address):
2356
1404
"""Start a new process to process the request."""
2357
proc = multiprocessing.Process(target = self.sub_process_main,
2358
args = (request, address))
1405
multiprocessing.Process(target = self.sub_process_main,
1406
args = (request, address)).start()
2363
1408
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2364
1409
""" adds a pipe to the MixIn """
2366
1410
def process_request(self, request, client_address):
2367
1411
"""Overrides and wraps the original process_request().
2369
1413
This function creates a new pipe in self.pipe
2371
1415
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2373
proc = MultiprocessingMixIn.process_request(self, request,
1417
super(MultiprocessingMixInWithPipe,
1418
self).process_request(request, client_address)
2375
1419
self.child_pipe.close()
2376
self.add_pipe(parent_pipe, proc)
2378
def add_pipe(self, parent_pipe, proc):
1420
self.add_pipe(parent_pipe)
1422
def add_pipe(self, parent_pipe):
2379
1423
"""Dummy function; override as necessary"""
2380
raise NotImplementedError()
1424
raise NotImplementedError
2383
1426
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2384
1427
socketserver.TCPServer, object):
2484
1494
gnutls_priority GnuTLS priority string
2485
1495
use_dbus: Boolean; to emit D-Bus signals or not
2487
Assumes a GLib.MainLoop event loop.
1497
Assumes a gobject.MainLoop event loop.
2490
1499
def __init__(self, server_address, RequestHandlerClass,
2494
gnutls_priority=None,
1500
interface=None, use_ipv6=True, clients=None,
1501
gnutls_priority=None, use_dbus=True):
2497
1502
self.enabled = False
2498
1503
self.clients = clients
2499
1504
if self.clients is None:
1505
self.clients = set()
2501
1506
self.use_dbus = use_dbus
2502
1507
self.gnutls_priority = gnutls_priority
2503
1508
IPv6_TCPServer.__init__(self, server_address,
2504
1509
RequestHandlerClass,
2505
1510
interface = interface,
2506
use_ipv6 = use_ipv6,
2507
socketfd = socketfd)
1511
use_ipv6 = use_ipv6)
2509
1512
def server_activate(self):
2510
1513
if self.enabled:
2511
1514
return socketserver.TCPServer.server_activate(self)
2513
1515
def enable(self):
2514
1516
self.enabled = True
2516
def add_pipe(self, parent_pipe, proc):
1517
def add_pipe(self, parent_pipe):
2517
1518
# Call "handle_ipc" for both data and EOF events
2519
parent_pipe.fileno(),
2520
GLib.IO_IN | GLib.IO_HUP,
2521
functools.partial(self.handle_ipc,
2522
parent_pipe = parent_pipe,
2525
def handle_ipc(self, source, condition,
1519
gobject.io_add_watch(parent_pipe.fileno(),
1520
gobject.IO_IN | gobject.IO_HUP,
1521
functools.partial(self.handle_ipc,
1522
parent_pipe = parent_pipe))
1524
def handle_ipc(self, source, condition, parent_pipe=None,
2528
1525
client_object=None):
2529
# error, or the other end of multiprocessing.Pipe has closed
2530
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2531
# Wait for other process to exit
1527
gobject.IO_IN: "IN", # There is data to read.
1528
gobject.IO_OUT: "OUT", # Data can be written (without
1530
gobject.IO_PRI: "PRI", # There is urgent data to read.
1531
gobject.IO_ERR: "ERR", # Error condition.
1532
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1533
# broken, usually for pipes and
1536
conditions_string = ' | '.join(name
1538
condition_names.iteritems()
1539
if cond & condition)
1540
# error or the other end of multiprocessing.Pipe has closed
1541
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2535
1544
# Read a request from the child
2549
1558
"dress: %s", fpr, address)
2550
1559
if self.use_dbus:
2551
1560
# Emit D-Bus signal
2552
mandos_dbus_service.ClientNotFound(fpr,
1561
mandos_dbus_service.ClientNotFound(fpr, address[0])
2554
1562
parent_pipe.send(False)
2558
parent_pipe.fileno(),
2559
GLib.IO_IN | GLib.IO_HUP,
2560
functools.partial(self.handle_ipc,
2561
parent_pipe = parent_pipe,
2563
client_object = client))
1565
gobject.io_add_watch(parent_pipe.fileno(),
1566
gobject.IO_IN | gobject.IO_HUP,
1567
functools.partial(self.handle_ipc,
1568
parent_pipe = parent_pipe,
1569
client_object = client))
2564
1570
parent_pipe.send(True)
2565
# remove the old hook in favor of the new above hook on
1571
# remove the old hook in favor of the new above hook on same fileno
2568
1573
if command == 'funcall':
2569
1574
funcname = request[1]
2570
1575
args = request[2]
2571
1576
kwargs = request[3]
2573
parent_pipe.send(('data', getattr(client_object,
1578
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2577
1580
if command == 'getattr':
2578
1581
attrname = request[1]
2579
if isinstance(client_object.__getattribute__(attrname),
2580
collections.Callable):
2581
parent_pipe.send(('function', ))
1582
if callable(client_object.__getattribute__(attrname)):
1583
parent_pipe.send(('function',))
2584
'data', client_object.__getattribute__(attrname)))
1585
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2586
1587
if command == 'setattr':
2587
1588
attrname = request[1]
2588
1589
value = request[2]
2589
1590
setattr(client_object, attrname, value)
2594
def rfc3339_duration_to_delta(duration):
2595
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2597
>>> rfc3339_duration_to_delta("P7D")
2598
datetime.timedelta(7)
2599
>>> rfc3339_duration_to_delta("PT60S")
2600
datetime.timedelta(0, 60)
2601
>>> rfc3339_duration_to_delta("PT60M")
2602
datetime.timedelta(0, 3600)
2603
>>> rfc3339_duration_to_delta("PT24H")
2604
datetime.timedelta(1)
2605
>>> rfc3339_duration_to_delta("P1W")
2606
datetime.timedelta(7)
2607
>>> rfc3339_duration_to_delta("PT5M30S")
2608
datetime.timedelta(0, 330)
2609
>>> rfc3339_duration_to_delta("P1DT3M20S")
2610
datetime.timedelta(1, 200)
2613
# Parsing an RFC 3339 duration with regular expressions is not
2614
# possible - there would have to be multiple places for the same
2615
# values, like seconds. The current code, while more esoteric, is
2616
# cleaner without depending on a parsing library. If Python had a
2617
# built-in library for parsing we would use it, but we'd like to
2618
# avoid excessive use of external libraries.
2620
# New type for defining tokens, syntax, and semantics all-in-one
2621
Token = collections.namedtuple("Token", (
2622
"regexp", # To match token; if "value" is not None, must have
2623
# a "group" containing digits
2624
"value", # datetime.timedelta or None
2625
"followers")) # Tokens valid after this token
2626
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2627
# the "duration" ABNF definition in RFC 3339, Appendix A.
2628
token_end = Token(re.compile(r"$"), None, frozenset())
2629
token_second = Token(re.compile(r"(\d+)S"),
2630
datetime.timedelta(seconds=1),
2631
frozenset((token_end, )))
2632
token_minute = Token(re.compile(r"(\d+)M"),
2633
datetime.timedelta(minutes=1),
2634
frozenset((token_second, token_end)))
2635
token_hour = Token(re.compile(r"(\d+)H"),
2636
datetime.timedelta(hours=1),
2637
frozenset((token_minute, token_end)))
2638
token_time = Token(re.compile(r"T"),
2640
frozenset((token_hour, token_minute,
2642
token_day = Token(re.compile(r"(\d+)D"),
2643
datetime.timedelta(days=1),
2644
frozenset((token_time, token_end)))
2645
token_month = Token(re.compile(r"(\d+)M"),
2646
datetime.timedelta(weeks=4),
2647
frozenset((token_day, token_end)))
2648
token_year = Token(re.compile(r"(\d+)Y"),
2649
datetime.timedelta(weeks=52),
2650
frozenset((token_month, token_end)))
2651
token_week = Token(re.compile(r"(\d+)W"),
2652
datetime.timedelta(weeks=1),
2653
frozenset((token_end, )))
2654
token_duration = Token(re.compile(r"P"), None,
2655
frozenset((token_year, token_month,
2656
token_day, token_time,
2658
# Define starting values
2659
value = datetime.timedelta() # Value so far
2661
followers = frozenset((token_duration, )) # Following valid tokens
2662
s = duration # String left to parse
2663
# Loop until end token is found
2664
while found_token is not token_end:
2665
# Search for any currently valid tokens
2666
for token in followers:
2667
match = token.regexp.match(s)
2668
if match is not None:
2670
if token.value is not None:
2671
# Value found, parse digits
2672
factor = int(match.group(1), 10)
2673
# Add to value so far
2674
value += factor * token.value
2675
# Strip token from string
2676
s = token.regexp.sub("", s, 1)
2679
# Set valid next tokens
2680
followers = found_token.followers
2683
# No currently valid tokens were found
2684
raise ValueError("Invalid RFC 3339 duration: {!r}"
2690
1595
def string_to_delta(interval):
2691
1596
"""Parse a string and return a datetime.timedelta
2821
1729
"debug": "False",
2823
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2824
":+SIGN-DSA-SHA256",
1731
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2825
1732
"servicename": "Mandos",
2826
1733
"use_dbus": "True",
2827
1734
"use_ipv6": "True",
2828
1735
"debuglevel": "",
2831
"statedir": "/var/lib/mandos",
2832
"foreground": "False",
2836
1738
# Parse config file for server-global settings
2837
1739
server_config = configparser.SafeConfigParser(server_defaults)
2838
1740
del server_defaults
2839
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1741
server_config.read(os.path.join(options.configdir,
2840
1743
# Convert the SafeConfigParser object to a dict
2841
1744
server_settings = server_config.defaults()
2842
1745
# Use the appropriate methods on the non-string config options
2843
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1746
for option in ("debug", "use_dbus", "use_ipv6"):
2844
1747
server_settings[option] = server_config.getboolean("DEFAULT",
2846
1749
if server_settings["port"]:
2847
1750
server_settings["port"] = server_config.getint("DEFAULT",
2849
if server_settings["socket"]:
2850
server_settings["socket"] = server_config.getint("DEFAULT",
2852
# Later, stdin will, and stdout and stderr might, be dup'ed
2853
# over with an opened os.devnull. But we don't want this to
2854
# happen with a supplied network socket.
2855
if 0 <= server_settings["socket"] <= 2:
2856
server_settings["socket"] = os.dup(server_settings
2858
1752
del server_config
2860
1754
# Override the settings from the config file with command line
2861
1755
# options, if set.
2862
1756
for option in ("interface", "address", "port", "debug",
2863
"priority", "servicename", "configdir", "use_dbus",
2864
"use_ipv6", "debuglevel", "restore", "statedir",
2865
"socket", "foreground", "zeroconf"):
1757
"priority", "servicename", "configdir",
1758
"use_dbus", "use_ipv6", "debuglevel"):
2866
1759
value = getattr(options, option)
2867
1760
if value is not None:
2868
1761
server_settings[option] = value
2870
1763
# Force all strings to be unicode
2871
1764
for option in server_settings.keys():
2872
if isinstance(server_settings[option], bytes):
2873
server_settings[option] = (server_settings[option]
2875
# Force all boolean options to be boolean
2876
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2877
"foreground", "zeroconf"):
2878
server_settings[option] = bool(server_settings[option])
2879
# Debug implies foreground
2880
if server_settings["debug"]:
2881
server_settings["foreground"] = True
1765
if type(server_settings[option]) is str:
1766
server_settings[option] = unicode(server_settings[option])
2882
1767
# Now we have our good server settings in "server_settings"
2884
1769
##################################################################
2886
if (not server_settings["zeroconf"]
2887
and not (server_settings["port"]
2888
or server_settings["socket"] != "")):
2889
parser.error("Needs port or socket to work without Zeroconf")
2891
1771
# For convenience
2892
1772
debug = server_settings["debug"]
2893
1773
debuglevel = server_settings["debuglevel"]
2894
1774
use_dbus = server_settings["use_dbus"]
2895
1775
use_ipv6 = server_settings["use_ipv6"]
2896
stored_state_path = os.path.join(server_settings["statedir"],
2898
foreground = server_settings["foreground"]
2899
zeroconf = server_settings["zeroconf"]
2902
initlogger(debug, logging.DEBUG)
2907
level = getattr(logging, debuglevel.upper())
2908
initlogger(debug, level)
2910
1777
if server_settings["servicename"] != "Mandos":
2911
syslogger.setFormatter(
2912
logging.Formatter('Mandos ({}) [%(process)d]:'
2913
' %(levelname)s: %(message)s'.format(
2914
server_settings["servicename"])))
1778
syslogger.setFormatter(logging.Formatter
1779
('Mandos (%s) [%%(process)d]:'
1780
' %%(levelname)s: %%(message)s'
1781
% server_settings["servicename"]))
2916
1783
# Parse config file with clients
2917
client_config = configparser.SafeConfigParser(Client
1784
client_defaults = { "timeout": "5m",
1785
"extended_timeout": "15m",
1787
"checker": "fping -q -- %%(host)s",
1789
"approval_delay": "0s",
1790
"approval_duration": "1s",
1792
client_config = configparser.SafeConfigParser(client_defaults)
2919
1793
client_config.read(os.path.join(server_settings["configdir"],
2920
1794
"clients.conf"))
2922
1796
global mandos_dbus_service
2923
1797
mandos_dbus_service = None
2926
if server_settings["socket"] != "":
2927
socketfd = server_settings["socket"]
2928
tcp_server = MandosServer(
2929
(server_settings["address"], server_settings["port"]),
2931
interface=(server_settings["interface"] or None),
2933
gnutls_priority=server_settings["priority"],
2937
pidfilename = "/run/mandos.pid"
2938
if not os.path.isdir("/run/."):
2939
pidfilename = "/var/run/mandos.pid"
1799
tcp_server = MandosServer((server_settings["address"],
1800
server_settings["port"]),
1802
interface=(server_settings["interface"]
1806
server_settings["priority"],
1809
pidfilename = "/var/run/mandos.pid"
2942
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2943
except IOError as e:
2944
logger.error("Could not open file %r", pidfilename,
1811
pidfile = open(pidfilename, "w")
1813
logger.error("Could not open file %r", pidfilename)
2947
for name, group in (("_mandos", "_mandos"),
2948
("mandos", "mandos"),
2949
("nobody", "nogroup")):
1816
uid = pwd.getpwnam("_mandos").pw_uid
1817
gid = pwd.getpwnam("_mandos").pw_gid
2951
uid = pwd.getpwnam(name).pw_uid
2952
gid = pwd.getpwnam(group).pw_gid
1820
uid = pwd.getpwnam("mandos").pw_uid
1821
gid = pwd.getpwnam("mandos").pw_gid
2954
1822
except KeyError:
1824
uid = pwd.getpwnam("nobody").pw_uid
1825
gid = pwd.getpwnam("nobody").pw_gid
2963
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2965
1832
except OSError as error:
2966
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2967
.format(uid, gid, os.strerror(error.errno)))
2968
if error.errno != errno.EPERM:
1833
if error[0] != errno.EPERM:
1836
if not debug and not debuglevel:
1837
syslogger.setLevel(logging.WARNING)
1838
console.setLevel(logging.WARNING)
1840
level = getattr(logging, debuglevel.upper())
1841
syslogger.setLevel(level)
1842
console.setLevel(level)
2972
1845
# Enable all possible GnuTLS debugging
2974
1847
# "Use a log level over 10 to enable all debugging options."
2975
1848
# - GnuTLS manual
2976
gnutls.global_set_log_level(11)
1849
gnutls.library.functions.gnutls_global_set_log_level(11)
1851
@gnutls.library.types.gnutls_log_func
2979
1852
def debug_gnutls(level, string):
2980
1853
logger.debug("GnuTLS: %s", string[:-1])
2982
gnutls.global_set_log_function(debug_gnutls)
1855
(gnutls.library.functions
1856
.gnutls_global_set_log_function(debug_gnutls))
2984
1858
# Redirect stdin so all checkers get /dev/null
2985
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1859
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2986
1860
os.dup2(null, sys.stdin.fileno())
1864
# No console logging
1865
logger.removeHandler(console)
2990
1867
# Need to fork before connecting to D-Bus
2992
1869
# Close all input and output, do double fork, etc.
2995
# multiprocessing will use threads, so before we use GLib we need
2996
# to inform GLib that threads will be used.
2999
1872
global main_loop
3000
1873
# From the Avahi example code
3001
DBusGMainLoop(set_as_default=True)
3002
main_loop = GLib.MainLoop()
1874
DBusGMainLoop(set_as_default=True )
1875
main_loop = gobject.MainLoop()
3003
1876
bus = dbus.SystemBus()
3004
1877
# End of Avahi example code
3007
bus_name = dbus.service.BusName("se.recompile.Mandos",
3010
old_bus_name = dbus.service.BusName(
3011
"se.bsnet.fukt.Mandos", bus,
3013
except dbus.exceptions.DBusException as e:
3014
logger.error("Disabling D-Bus:", exc_info=e)
1880
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1881
bus, do_not_queue=True)
1882
except dbus.exceptions.NameExistsException as e:
1883
logger.error(unicode(e) + ", disabling D-Bus")
3015
1884
use_dbus = False
3016
1885
server_settings["use_dbus"] = False
3017
1886
tcp_server.use_dbus = False
3019
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3020
service = AvahiServiceToSyslog(
3021
name = server_settings["servicename"],
3022
servicetype = "_mandos._tcp",
3023
protocol = protocol,
3025
if server_settings["interface"]:
3026
service.interface = if_nametoindex(
3027
server_settings["interface"].encode("utf-8"))
1887
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1888
service = AvahiService(name = server_settings["servicename"],
1889
servicetype = "_mandos._tcp",
1890
protocol = protocol, bus = bus)
1891
if server_settings["interface"]:
1892
service.interface = (if_nametoindex
1893
(str(server_settings["interface"])))
3029
1895
global multiprocessing_manager
3030
1896
multiprocessing_manager = multiprocessing.Manager()
3032
1898
client_class = Client
3034
1900
client_class = functools.partial(ClientDBus, bus = bus)
3036
client_settings = Client.config_parser(client_config)
3037
old_client_settings = {}
3040
# This is used to redirect stdout and stderr for checker processes
3042
wnull = open(os.devnull, "w") # A writable /dev/null
3043
# Only used if server is running in foreground but not in debug
3045
if debug or not foreground:
3048
# Get client data and settings from last running state.
3049
if server_settings["restore"]:
3051
with open(stored_state_path, "rb") as stored_state:
3052
if sys.version_info.major == 2:
3053
clients_data, old_client_settings = pickle.load(
3056
bytes_clients_data, bytes_old_client_settings = (
3057
pickle.load(stored_state, encoding = "bytes"))
3058
### Fix bytes to strings
3061
clients_data = { (key.decode("utf-8")
3062
if isinstance(key, bytes)
3065
bytes_clients_data.items() }
3066
del bytes_clients_data
3067
for key in clients_data:
3068
value = { (k.decode("utf-8")
3069
if isinstance(k, bytes) else k): v
3071
clients_data[key].items() }
3072
clients_data[key] = value
3074
value["client_structure"] = [
3076
if isinstance(s, bytes)
3078
value["client_structure"] ]
3080
for k in ("name", "host"):
3081
if isinstance(value[k], bytes):
3082
value[k] = value[k].decode("utf-8")
3083
## old_client_settings
3085
old_client_settings = {
3086
(key.decode("utf-8")
3087
if isinstance(key, bytes)
3090
bytes_old_client_settings.items() }
3091
del bytes_old_client_settings
3093
for value in old_client_settings.values():
3094
if isinstance(value["host"], bytes):
3095
value["host"] = (value["host"]
3097
os.remove(stored_state_path)
3098
except IOError as e:
3099
if e.errno == errno.ENOENT:
3100
logger.warning("Could not load persistent state:"
3101
" {}".format(os.strerror(e.errno)))
3103
logger.critical("Could not load persistent state:",
3106
except EOFError as e:
3107
logger.warning("Could not load persistent state: "
3111
with PGPEngine() as pgp:
3112
for client_name, client in clients_data.items():
3113
# Skip removed clients
3114
if client_name not in client_settings:
3117
# Decide which value to use after restoring saved state.
3118
# We have three different values: Old config file,
3119
# new config file, and saved state.
3120
# New config value takes precedence if it differs from old
3121
# config value, otherwise use saved state.
3122
for name, value in client_settings[client_name].items():
3124
# For each value in new config, check if it
3125
# differs from the old config value (Except for
3126
# the "secret" attribute)
3127
if (name != "secret"
3129
old_client_settings[client_name][name])):
3130
client[name] = value
3134
# Clients who has passed its expire date can still be
3135
# enabled if its last checker was successful. A Client
3136
# whose checker succeeded before we stored its state is
3137
# assumed to have successfully run all checkers during
3139
if client["enabled"]:
3140
if datetime.datetime.utcnow() >= client["expires"]:
3141
if not client["last_checked_ok"]:
3143
"disabling client {} - Client never "
3144
"performed a successful checker".format(
3146
client["enabled"] = False
3147
elif client["last_checker_status"] != 0:
3149
"disabling client {} - Client last"
3150
" checker failed with error code"
3153
client["last_checker_status"]))
3154
client["enabled"] = False
3156
client["expires"] = (
3157
datetime.datetime.utcnow()
3158
+ client["timeout"])
3159
logger.debug("Last checker succeeded,"
3160
" keeping {} enabled".format(
1901
def client_config_items(config, section):
1902
special_settings = {
1903
"approved_by_default":
1904
lambda: config.getboolean(section,
1905
"approved_by_default"),
1907
for name, value in config.items(section):
3163
client["secret"] = pgp.decrypt(
3164
client["encrypted_secret"],
3165
client_settings[client_name]["secret"])
3167
# If decryption fails, we use secret from new settings
3168
logger.debug("Failed to decrypt {} old secret".format(
3170
client["secret"] = (client_settings[client_name]
3173
# Add/remove clients based on new changes made to config
3174
for client_name in (set(old_client_settings)
3175
- set(client_settings)):
3176
del clients_data[client_name]
3177
for client_name in (set(client_settings)
3178
- set(old_client_settings)):
3179
clients_data[client_name] = client_settings[client_name]
3181
# Create all client objects
3182
for client_name, client in clients_data.items():
3183
tcp_server.clients[client_name] = client_class(
3186
server_settings = server_settings)
1909
yield (name, special_settings[name]())
1913
tcp_server.clients.update(set(
1914
client_class(name = section,
1915
config= dict(client_config_items(
1916
client_config, section)))
1917
for section in client_config.sections()))
3188
1918
if not tcp_server.clients:
3189
1919
logger.warning("No clients defined")
3192
if pidfile is not None:
3196
print(pid, file=pidfile)
3198
logger.error("Could not write to file %r with PID %d",
1925
pidfile.write(str(pid) + "\n".encode("utf-8"))
1928
logger.error("Could not write to file %r with PID %d",
1931
# "pidfile" was never created
3201
1933
del pidfilename
3203
for termsig in (signal.SIGHUP, signal.SIGTERM):
3204
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3205
lambda: main_loop.quit() and False)
1935
signal.signal(signal.SIGINT, signal.SIG_IGN)
1937
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1938
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3209
@alternate_dbus_interfaces(
3210
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3211
class MandosDBusService(DBusObjectWithObjectManager):
1941
class MandosDBusService(dbus.service.Object):
3212
1942
"""A D-Bus proxy object"""
3214
1943
def __init__(self):
3215
1944
dbus.service.Object.__init__(self, bus, "/")
3217
_interface = "se.recompile.Mandos"
1945
_interface = "se.bsnet.fukt.Mandos"
3219
1947
@dbus.service.signal(_interface, signature="o")
3220
1948
def ClientAdded(self, objpath):
3229
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3231
1957
@dbus.service.signal(_interface, signature="os")
3232
1958
def ClientRemoved(self, objpath, name):
3236
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3238
1962
@dbus.service.method(_interface, out_signature="ao")
3239
1963
def GetAllClients(self):
3241
return dbus.Array(c.dbus_object_path for c in
3242
tcp_server.clients.values())
1965
return dbus.Array(c.dbus_object_path
1966
for c in tcp_server.clients)
3244
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3246
1968
@dbus.service.method(_interface,
3247
1969
out_signature="a{oa{sv}}")
3248
1970
def GetAllClientsWithProperties(self):
3250
1972
return dbus.Dictionary(
3251
{ c.dbus_object_path: c.GetAll(
3252
"se.recompile.Mandos.Client")
3253
for c in tcp_server.clients.values() },
1973
((c.dbus_object_path, c.GetAll(""))
1974
for c in tcp_server.clients),
3254
1975
signature="oa{sv}")
3256
1977
@dbus.service.method(_interface, in_signature="o")
3257
1978
def RemoveClient(self, object_path):
3259
for c in tcp_server.clients.values():
1980
for c in tcp_server.clients:
3260
1981
if c.dbus_object_path == object_path:
3261
del tcp_server.clients[c.name]
1982
tcp_server.clients.remove(c)
3262
1983
c.remove_from_connection()
3263
# Don't signal the disabling
1984
# Don't signal anything except ClientRemoved
3264
1985
c.disable(quiet=True)
3265
# Emit D-Bus signal for removal
3266
self.client_removed_signal(c)
1987
self.ClientRemoved(object_path, c.name)
3268
1989
raise KeyError(object_path)
3272
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3273
out_signature = "a{oa{sa{sv}}}")
3274
def GetManagedObjects(self):
3276
return dbus.Dictionary(
3277
{ client.dbus_object_path:
3279
{ interface: client.GetAll(interface)
3281
client._get_all_interface_names()})
3282
for client in tcp_server.clients.values()})
3284
def client_added_signal(self, client):
3285
"""Send the new standard signal and the old signal"""
3287
# New standard signal
3288
self.InterfacesAdded(
3289
client.dbus_object_path,
3291
{ interface: client.GetAll(interface)
3293
client._get_all_interface_names()}))
3295
self.ClientAdded(client.dbus_object_path)
3297
def client_removed_signal(self, client):
3298
"""Send the new standard signal and the old signal"""
3300
# New standard signal
3301
self.InterfacesRemoved(
3302
client.dbus_object_path,
3303
client._get_all_interface_names())
3305
self.ClientRemoved(client.dbus_object_path,
3308
1993
mandos_dbus_service = MandosDBusService()
3311
1996
"Cleanup function; run on exit"
3315
multiprocessing.active_children()
3317
if not (tcp_server.clients or client_settings):
3320
# Store client before exiting. Secrets are encrypted with key
3321
# based on what config file has. If config file is
3322
# removed/edited, old secret will thus be unrecovable.
3324
with PGPEngine() as pgp:
3325
for client in tcp_server.clients.values():
3326
key = client_settings[client.name]["secret"]
3327
client.encrypted_secret = pgp.encrypt(client.secret,
3331
# A list of attributes that can not be pickled
3333
exclude = { "bus", "changedstate", "secret",
3334
"checker", "server_settings" }
3335
for name, typ in inspect.getmembers(dbus.service
3339
client_dict["encrypted_secret"] = (client
3341
for attr in client.client_structure:
3342
if attr not in exclude:
3343
client_dict[attr] = getattr(client, attr)
3345
clients[client.name] = client_dict
3346
del client_settings[client.name]["secret"]
3349
with tempfile.NamedTemporaryFile(
3353
dir=os.path.dirname(stored_state_path),
3354
delete=False) as stored_state:
3355
pickle.dump((clients, client_settings), stored_state,
3357
tempname = stored_state.name
3358
os.rename(tempname, stored_state_path)
3359
except (IOError, OSError) as e:
3365
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3366
logger.warning("Could not save persistent state: {}"
3367
.format(os.strerror(e.errno)))
3369
logger.warning("Could not save persistent state:",
3373
# Delete all clients, and settings from config
3374
1999
while tcp_server.clients:
3375
name, client = tcp_server.clients.popitem()
2000
client = tcp_server.clients.pop()
3377
2002
client.remove_from_connection()
3378
# Don't signal the disabling
2003
client.disable_hook = None
2004
# Don't signal anything except ClientRemoved
3379
2005
client.disable(quiet=True)
3380
# Emit D-Bus signal for removal
3382
mandos_dbus_service.client_removed_signal(client)
3383
client_settings.clear()
2008
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3385
2011
atexit.register(cleanup)
3387
for client in tcp_server.clients.values():
2013
for client in tcp_server.clients:
3389
# Emit D-Bus signal for adding
3390
mandos_dbus_service.client_added_signal(client)
3391
# Need to initiate checking of clients
3393
client.init_checker()
2016
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3395
2019
tcp_server.enable()
3396
2020
tcp_server.server_activate()
3398
2022
# Find out what port we got
3400
service.port = tcp_server.socket.getsockname()[1]
2023
service.port = tcp_server.socket.getsockname()[1]
3402
2025
logger.info("Now listening on address %r, port %d,"
3403
" flowinfo %d, scope_id %d",
3404
*tcp_server.socket.getsockname())
2026
" flowinfo %d, scope_id %d"
2027
% tcp_server.socket.getsockname())
3406
logger.info("Now listening on address %r, port %d",
3407
*tcp_server.socket.getsockname())
2029
logger.info("Now listening on address %r, port %d"
2030
% tcp_server.socket.getsockname())
3409
2032
#service.interface = tcp_server.socket.getsockname()[3]
3413
# From the Avahi example code
3416
except dbus.exceptions.DBusException as error:
3417
logger.critical("D-Bus Exception", exc_info=error)
3420
# End of Avahi example code
2035
# From the Avahi example code
2038
except dbus.exceptions.DBusException as error:
2039
logger.critical("DBusException: %s", error)
2042
# End of Avahi example code
3422
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3423
lambda *args, **kwargs:
3424
(tcp_server.handle_request
3425
(*args[2:], **kwargs) or True))
2044
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2045
lambda *args, **kwargs:
2046
(tcp_server.handle_request
2047
(*args[2:], **kwargs) or True))
3427
2049
logger.debug("Starting main loop")
3428
2050
main_loop.run()
3429
2051
except AvahiError as error:
3430
logger.critical("Avahi Error", exc_info=error)
2052
logger.critical("AvahiError: %s", error)
3433
2055
except KeyboardInterrupt: