62
import cPickle as pickle
69
import cPickle as pickle
63
72
import multiprocessing
66
81
import dbus.service
82
from gi.repository import GLib
69
83
from dbus.mainloop.glib import DBusGMainLoop
72
86
import xml.dom.minidom
89
# Try to find the value of SO_BINDTODEVICE:
91
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
92
# newer, and it is also the most natural place for it:
76
93
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
77
94
except AttributeError:
96
# This is where SO_BINDTODEVICE was up to and including Python
79
98
from IN import SO_BINDTODEVICE
80
99
except ImportError:
81
SO_BINDTODEVICE = None
86
logger = logging.Logger(u'mandos')
87
syslogger = (logging.handlers.SysLogHandler
88
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
89
address = "/dev/log"))
90
syslogger.setFormatter(logging.Formatter
91
(u'Mandos [%(process)d]: %(levelname)s:'
93
logger.addHandler(syslogger)
95
console = logging.StreamHandler()
96
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
99
logger.addHandler(console)
100
# In Python 2.7 it seems to have been removed entirely.
101
# Try running the C preprocessor:
103
cc = subprocess.Popen(["cc", "--language=c", "-E",
105
stdin=subprocess.PIPE,
106
stdout=subprocess.PIPE)
107
stdout = cc.communicate(
108
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
109
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
110
except (OSError, ValueError, IndexError):
112
SO_BINDTODEVICE = None
114
if sys.version_info.major == 2:
118
stored_state_file = "clients.pickle"
120
logger = logging.getLogger()
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
ctypes.util.find_library("c")).if_nametoindex
126
except (OSError, AttributeError):
128
def if_nametoindex(interface):
129
"Get an interface index the hard way, i.e. using fcntl()"
130
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
131
with contextlib.closing(socket.socket()) as s:
132
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
133
struct.pack(b"16s16x", interface))
134
interface_index = struct.unpack("I", ifreq[16:20])[0]
135
return interface_index
138
def copy_function(func):
139
"""Make a copy of a function"""
140
if sys.version_info.major == 2:
141
return types.FunctionType(func.func_code,
147
return types.FunctionType(func.__code__,
154
def initlogger(debug, level=logging.WARNING):
155
"""init logger and add loglevel"""
158
syslogger = (logging.handlers.SysLogHandler(
159
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
160
address = "/dev/log"))
161
syslogger.setFormatter(logging.Formatter
162
('Mandos [%(process)d]: %(levelname)s:'
164
logger.addHandler(syslogger)
167
console = logging.StreamHandler()
168
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
172
logger.addHandler(console)
173
logger.setLevel(level)
176
class PGPError(Exception):
177
"""Exception if encryption/decryption fails"""
181
class PGPEngine(object):
182
"""A simple class for OpenPGP symmetric encryption & decryption"""
185
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
188
output = subprocess.check_output(["gpgconf"])
189
for line in output.splitlines():
190
name, text, path = line.split(b":")
195
if e.errno != errno.ENOENT:
197
self.gnupgargs = ['--batch',
198
'--homedir', self.tempdir,
201
# Only GPG version 1 has the --no-use-agent option.
202
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
203
self.gnupgargs.append("--no-use-agent")
208
def __exit__(self, exc_type, exc_value, traceback):
216
if self.tempdir is not None:
217
# Delete contents of tempdir
218
for root, dirs, files in os.walk(self.tempdir,
220
for filename in files:
221
os.remove(os.path.join(root, filename))
223
os.rmdir(os.path.join(root, dirname))
225
os.rmdir(self.tempdir)
228
def password_encode(self, password):
229
# Passphrase can not be empty and can not contain newlines or
230
# NUL bytes. So we prefix it and hex encode it.
231
encoded = b"mandos" + binascii.hexlify(password)
232
if len(encoded) > 2048:
233
# GnuPG can't handle long passwords, so encode differently
234
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
235
.replace(b"\n", b"\\n")
236
.replace(b"\0", b"\\x00"))
239
def encrypt(self, data, password):
240
passphrase = self.password_encode(password)
241
with tempfile.NamedTemporaryFile(
242
dir=self.tempdir) as passfile:
243
passfile.write(passphrase)
245
proc = subprocess.Popen([self.gpg, '--symmetric',
249
stdin = subprocess.PIPE,
250
stdout = subprocess.PIPE,
251
stderr = subprocess.PIPE)
252
ciphertext, err = proc.communicate(input = data)
253
if proc.returncode != 0:
257
def decrypt(self, data, password):
258
passphrase = self.password_encode(password)
259
with tempfile.NamedTemporaryFile(
260
dir = self.tempdir) as passfile:
261
passfile.write(passphrase)
263
proc = subprocess.Popen([self.gpg, '--decrypt',
267
stdin = subprocess.PIPE,
268
stdout = subprocess.PIPE,
269
stderr = subprocess.PIPE)
270
decrypted_plaintext, err = proc.communicate(input = data)
271
if proc.returncode != 0:
273
return decrypted_plaintext
275
# Pretend that we have an Avahi module
277
"""This isn't so much a class as it is a module-like namespace.
278
It is instantiated once, and simulates having an Avahi module."""
279
IF_UNSPEC = -1 # avahi-common/address.h
280
PROTO_UNSPEC = -1 # avahi-common/address.h
281
PROTO_INET = 0 # avahi-common/address.h
282
PROTO_INET6 = 1 # avahi-common/address.h
283
DBUS_NAME = "org.freedesktop.Avahi"
284
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
285
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
286
DBUS_PATH_SERVER = "/"
287
def string_array_to_txt_array(self, t):
288
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
289
for s in t), signature="ay")
290
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
291
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
292
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
293
SERVER_INVALID = 0 # avahi-common/defs.h
294
SERVER_REGISTERING = 1 # avahi-common/defs.h
295
SERVER_RUNNING = 2 # avahi-common/defs.h
296
SERVER_COLLISION = 3 # avahi-common/defs.h
297
SERVER_FAILURE = 4 # avahi-common/defs.h
101
300
class AvahiError(Exception):
102
301
def __init__(self, value, *args, **kwargs):
103
302
self.value = value
104
super(AvahiError, self).__init__(value, *args, **kwargs)
105
def __unicode__(self):
106
return unicode(repr(self.value))
303
return super(AvahiError, self).__init__(value, *args,
108
307
class AvahiServiceError(AvahiError):
111
311
class AvahiGroupError(AvahiError):
191
415
dbus.UInt16(self.port),
192
416
avahi.string_array_to_txt_array(self.TXT))
193
417
self.group.Commit()
194
419
def entry_group_state_changed(self, state, error):
195
420
"""Derived from the Avahi example code"""
196
logger.debug(u"Avahi state change: %i", state)
421
logger.debug("Avahi entry group state change: %i", state)
198
423
if state == avahi.ENTRY_GROUP_ESTABLISHED:
199
logger.debug(u"Zeroconf service established.")
424
logger.debug("Zeroconf service established.")
200
425
elif state == avahi.ENTRY_GROUP_COLLISION:
201
logger.warning(u"Zeroconf service name collision.")
426
logger.info("Zeroconf service name collision.")
203
428
elif state == avahi.ENTRY_GROUP_FAILURE:
204
logger.critical(u"Avahi: Error in group state changed %s",
206
raise AvahiGroupError(u"State changed: %s"
429
logger.critical("Avahi: Error in group state changed %s",
431
raise AvahiGroupError("State changed: {!s}".format(error))
208
433
def cleanup(self):
209
434
"""Derived from the Avahi example code"""
210
435
if self.group is not None:
438
except (dbus.exceptions.UnknownMethodException,
439
dbus.exceptions.DBusException):
212
441
self.group = None
213
def server_state_changed(self, state):
444
def server_state_changed(self, state, error=None):
214
445
"""Derived from the Avahi example code"""
215
if state == avahi.SERVER_COLLISION:
216
logger.error(u"Zeroconf server name collision")
446
logger.debug("Avahi server state change: %i", state)
448
avahi.SERVER_INVALID: "Zeroconf server invalid",
449
avahi.SERVER_REGISTERING: None,
450
avahi.SERVER_COLLISION: "Zeroconf server name collision",
451
avahi.SERVER_FAILURE: "Zeroconf server failure",
453
if state in bad_states:
454
if bad_states[state] is not None:
456
logger.error(bad_states[state])
458
logger.error(bad_states[state] + ": %r", error)
218
460
elif state == avahi.SERVER_RUNNING:
463
except dbus.exceptions.DBusException as error:
464
if (error.get_dbus_name()
465
== "org.freedesktop.Avahi.CollisionError"):
466
logger.info("Local Zeroconf service name"
468
return self.rename(remove=False)
470
logger.critical("D-Bus Exception", exc_info=error)
475
logger.debug("Unknown state: %r", state)
477
logger.debug("Unknown state: %r: %r", state, error)
220
479
def activate(self):
221
480
"""Derived from the Avahi example code"""
222
481
if self.server is None:
223
482
self.server = dbus.Interface(
224
483
self.bus.get_object(avahi.DBUS_NAME,
225
avahi.DBUS_PATH_SERVER),
484
avahi.DBUS_PATH_SERVER,
485
follow_name_owner_changes=True),
226
486
avahi.DBUS_INTERFACE_SERVER)
227
self.server.connect_to_signal(u"StateChanged",
228
self.server_state_changed)
487
self.server.connect_to_signal("StateChanged",
488
self.server_state_changed)
229
489
self.server_state_changed(self.server.GetState())
492
class AvahiServiceToSyslog(AvahiService):
493
def rename(self, *args, **kwargs):
494
"""Add the new name to the syslog messages"""
495
ret = AvahiService.rename(self, *args, **kwargs)
496
syslogger.setFormatter(logging.Formatter(
497
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
501
# Pretend that we have a GnuTLS module
502
class GnuTLS(object):
503
"""This isn't so much a class as it is a module-like namespace.
504
It is instantiated once, and simulates having a GnuTLS module."""
506
_library = ctypes.cdll.LoadLibrary(
507
ctypes.util.find_library("gnutls"))
508
_need_version = b"3.3.0"
510
# Need to use class name "GnuTLS" here, since this method is
511
# called before the assignment to the "gnutls" global variable
513
if GnuTLS.check_version(self._need_version) is None:
514
raise GnuTLS.Error("Needs GnuTLS {} or later"
515
.format(self._need_version))
517
# Unless otherwise indicated, the constants and types below are
518
# all from the gnutls/gnutls.h C header file.
528
E_NO_CERTIFICATE_FOUND = -49
529
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
532
class session_int(ctypes.Structure):
534
session_t = ctypes.POINTER(session_int)
535
class certificate_credentials_st(ctypes.Structure):
537
certificate_credentials_t = ctypes.POINTER(
538
certificate_credentials_st)
539
certificate_type_t = ctypes.c_int
540
class datum_t(ctypes.Structure):
541
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
542
('size', ctypes.c_uint)]
543
class openpgp_crt_int(ctypes.Structure):
545
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
546
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
547
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
548
credentials_type_t = ctypes.c_int
549
transport_ptr_t = ctypes.c_void_p
550
close_request_t = ctypes.c_int
553
class Error(Exception):
554
# We need to use the class name "GnuTLS" here, since this
555
# exception might be raised from within GnuTLS.__init__,
556
# which is called before the assignment to the "gnutls"
557
# global variable has happened.
558
def __init__(self, message = None, code = None, args=()):
559
# Default usage is by a message string, but if a return
560
# code is passed, convert it to a string with
563
if message is None and code is not None:
564
message = GnuTLS.strerror(code)
565
return super(GnuTLS.Error, self).__init__(
568
class CertificateSecurityError(Error):
572
class Credentials(object):
574
self._c_object = gnutls.certificate_credentials_t()
575
gnutls.certificate_allocate_credentials(
576
ctypes.byref(self._c_object))
577
self.type = gnutls.CRD_CERTIFICATE
580
gnutls.certificate_free_credentials(self._c_object)
582
class ClientSession(object):
583
def __init__(self, socket, credentials = None):
584
self._c_object = gnutls.session_t()
585
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
586
gnutls.set_default_priority(self._c_object)
587
gnutls.transport_set_ptr(self._c_object, socket.fileno())
588
gnutls.handshake_set_private_extensions(self._c_object,
591
if credentials is None:
592
credentials = gnutls.Credentials()
593
gnutls.credentials_set(self._c_object, credentials.type,
594
ctypes.cast(credentials._c_object,
596
self.credentials = credentials
599
gnutls.deinit(self._c_object)
602
return gnutls.handshake(self._c_object)
604
def send(self, data):
608
data_len -= gnutls.record_send(self._c_object,
613
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
615
# Error handling functions
616
def _error_code(result):
617
"""A function to raise exceptions on errors, suitable
618
for the 'restype' attribute on ctypes functions"""
621
if result == gnutls.E_NO_CERTIFICATE_FOUND:
622
raise gnutls.CertificateSecurityError(code = result)
623
raise gnutls.Error(code = result)
625
def _retry_on_error(result, func, arguments):
626
"""A function to retry on some errors, suitable
627
for the 'errcheck' attribute on ctypes functions"""
629
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
630
return _error_code(result)
631
result = func(*arguments)
634
# Unless otherwise indicated, the function declarations below are
635
# all from the gnutls/gnutls.h C header file.
638
priority_set_direct = _library.gnutls_priority_set_direct
639
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
640
ctypes.POINTER(ctypes.c_char_p)]
641
priority_set_direct.restype = _error_code
643
init = _library.gnutls_init
644
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
645
init.restype = _error_code
647
set_default_priority = _library.gnutls_set_default_priority
648
set_default_priority.argtypes = [session_t]
649
set_default_priority.restype = _error_code
651
record_send = _library.gnutls_record_send
652
record_send.argtypes = [session_t, ctypes.c_void_p,
654
record_send.restype = ctypes.c_ssize_t
655
record_send.errcheck = _retry_on_error
657
certificate_allocate_credentials = (
658
_library.gnutls_certificate_allocate_credentials)
659
certificate_allocate_credentials.argtypes = [
660
ctypes.POINTER(certificate_credentials_t)]
661
certificate_allocate_credentials.restype = _error_code
663
certificate_free_credentials = (
664
_library.gnutls_certificate_free_credentials)
665
certificate_free_credentials.argtypes = [certificate_credentials_t]
666
certificate_free_credentials.restype = None
668
handshake_set_private_extensions = (
669
_library.gnutls_handshake_set_private_extensions)
670
handshake_set_private_extensions.argtypes = [session_t,
672
handshake_set_private_extensions.restype = None
674
credentials_set = _library.gnutls_credentials_set
675
credentials_set.argtypes = [session_t, credentials_type_t,
677
credentials_set.restype = _error_code
679
strerror = _library.gnutls_strerror
680
strerror.argtypes = [ctypes.c_int]
681
strerror.restype = ctypes.c_char_p
683
certificate_type_get = _library.gnutls_certificate_type_get
684
certificate_type_get.argtypes = [session_t]
685
certificate_type_get.restype = _error_code
687
certificate_get_peers = _library.gnutls_certificate_get_peers
688
certificate_get_peers.argtypes = [session_t,
689
ctypes.POINTER(ctypes.c_uint)]
690
certificate_get_peers.restype = ctypes.POINTER(datum_t)
692
global_set_log_level = _library.gnutls_global_set_log_level
693
global_set_log_level.argtypes = [ctypes.c_int]
694
global_set_log_level.restype = None
696
global_set_log_function = _library.gnutls_global_set_log_function
697
global_set_log_function.argtypes = [log_func]
698
global_set_log_function.restype = None
700
deinit = _library.gnutls_deinit
701
deinit.argtypes = [session_t]
702
deinit.restype = None
704
handshake = _library.gnutls_handshake
705
handshake.argtypes = [session_t]
706
handshake.restype = _error_code
707
handshake.errcheck = _retry_on_error
709
transport_set_ptr = _library.gnutls_transport_set_ptr
710
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
711
transport_set_ptr.restype = None
713
bye = _library.gnutls_bye
714
bye.argtypes = [session_t, close_request_t]
715
bye.restype = _error_code
716
bye.errcheck = _retry_on_error
718
check_version = _library.gnutls_check_version
719
check_version.argtypes = [ctypes.c_char_p]
720
check_version.restype = ctypes.c_char_p
722
# All the function declarations below are from gnutls/openpgp.h
724
openpgp_crt_init = _library.gnutls_openpgp_crt_init
725
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
726
openpgp_crt_init.restype = _error_code
728
openpgp_crt_import = _library.gnutls_openpgp_crt_import
729
openpgp_crt_import.argtypes = [openpgp_crt_t,
730
ctypes.POINTER(datum_t),
732
openpgp_crt_import.restype = _error_code
734
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
735
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
736
ctypes.POINTER(ctypes.c_uint)]
737
openpgp_crt_verify_self.restype = _error_code
739
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
740
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
741
openpgp_crt_deinit.restype = None
743
openpgp_crt_get_fingerprint = (
744
_library.gnutls_openpgp_crt_get_fingerprint)
745
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
749
openpgp_crt_get_fingerprint.restype = _error_code
751
# Remove non-public functions
752
del _error_code, _retry_on_error
753
# Create the global "gnutls" object, simulating a module
756
def call_pipe(connection, # : multiprocessing.Connection
757
func, *args, **kwargs):
758
"""This function is meant to be called by multiprocessing.Process
760
This function runs func(*args, **kwargs), and writes the resulting
761
return value on the provided multiprocessing.Connection.
763
connection.send(func(*args, **kwargs))
232
766
class Client(object):
233
767
"""A representation of a client host served by this server.
236
name: string; from the config file, used in log messages and
770
approved: bool(); 'None' if not yet approved/disapproved
771
approval_delay: datetime.timedelta(); Time to wait for approval
772
approval_duration: datetime.timedelta(); Duration of one approval
773
checker: subprocess.Popen(); a running checker process used
774
to see if the client lives.
775
'None' if no process is running.
776
checker_callback_tag: a GLib event source tag, or None
777
checker_command: string; External command which is run to check
778
if client lives. %() expansions are done at
779
runtime with vars(self) as dict, so that for
780
instance %(name)s can be used in the command.
781
checker_initiator_tag: a GLib event source tag, or None
782
created: datetime.datetime(); (UTC) object creation
783
client_structure: Object describing what attributes a client has
784
and is used for storing the client at exit
785
current_checker_command: string; current running checker_command
786
disable_initiator_tag: a GLib event source tag, or None
238
788
fingerprint: string (40 or 32 hexadecimal digits); used to
239
789
uniquely identify the client
240
secret: bytestring; sent verbatim (over TLS) to client
241
790
host: string; available for use by the checker command
242
created: datetime.datetime(); (UTC) object creation
243
last_enabled: datetime.datetime(); (UTC)
791
interval: datetime.timedelta(); How often to start a new checker
792
last_approval_request: datetime.datetime(); (UTC) or None
245
793
last_checked_ok: datetime.datetime(); (UTC) or None
794
last_checker_status: integer between 0 and 255 reflecting exit
795
status of last checker. -1 reflects crashed
796
checker, -2 means no checker completed yet.
797
last_checker_signal: The signal which killed the last checker, if
798
last_checker_status is -1
799
last_enabled: datetime.datetime(); (UTC) or None
800
name: string; from the config file, used in log messages and
802
secret: bytestring; sent verbatim (over TLS) to client
246
803
timeout: datetime.timedelta(); How long from last_checked_ok
247
804
until this client is disabled
248
interval: datetime.timedelta(); How often to start a new checker
249
disable_hook: If set, called by disable() as disable_hook(self)
250
checker: subprocess.Popen(); a running checker process used
251
to see if the client lives.
252
'None' if no process is running.
253
checker_initiator_tag: a gobject event source tag, or None
254
disable_initiator_tag: - '' -
255
checker_callback_tag: - '' -
256
checker_command: string; External command which is run to check if
257
client lives. %() expansions are done at
258
runtime with vars(self) as dict, so that for
259
instance %(name)s can be used in the command.
260
current_checker_command: string; current running checker_command
261
approved_delay: datetime.timedelta(); Time to wait for approval
262
_approved: bool(); 'None' if not yet approved/disapproved
263
approved_duration: datetime.timedelta(); Duration of one approval
805
extended_timeout: extra long timeout when secret has been sent
806
runtime_expansions: Allowed attributes for runtime expansion.
807
expires: datetime.datetime(); time (UTC) when a client will be
809
server_settings: The server_settings dict from main()
812
runtime_expansions = ("approval_delay", "approval_duration",
813
"created", "enabled", "expires",
814
"fingerprint", "host", "interval",
815
"last_approval_request", "last_checked_ok",
816
"last_enabled", "name", "timeout")
819
"extended_timeout": "PT15M",
821
"checker": "fping -q -- %%(host)s",
823
"approval_delay": "PT0S",
824
"approval_duration": "PT1S",
825
"approved_by_default": "True",
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))
273
def timeout_milliseconds(self):
274
"Return the 'timeout' attribute in milliseconds"
275
return self._timedelta_to_milliseconds(self.timeout)
277
def interval_milliseconds(self):
278
"Return the 'interval' attribute in milliseconds"
279
return self._timedelta_to_milliseconds(self.interval)
281
def approved_delay_milliseconds(self):
282
return self._timedelta_to_milliseconds(self.approved_delay)
284
def __init__(self, name = None, disable_hook=None, config=None):
285
"""Note: the 'checker' key in 'config' sets the
286
'checker_command' attribute and *not* the 'checker'
830
def config_parser(config):
831
"""Construct a new dict of client settings of this form:
832
{ client_name: {setting_name: value, ...}, ...}
833
with exceptions for any special settings as defined above.
834
NOTE: Must be a pure function. Must return the same result
835
value given the same arguments.
838
for client_name in config.sections():
839
section = dict(config.items(client_name))
840
client = settings[client_name] = {}
842
client["host"] = section["host"]
843
# Reformat values from string types to Python types
844
client["approved_by_default"] = config.getboolean(
845
client_name, "approved_by_default")
846
client["enabled"] = config.getboolean(client_name,
849
# Uppercase and remove spaces from fingerprint for later
850
# comparison purposes with return value from the
851
# fingerprint() function
852
client["fingerprint"] = (section["fingerprint"].upper()
854
if "secret" in section:
855
client["secret"] = codecs.decode(section["secret"]
858
elif "secfile" in section:
859
with open(os.path.expanduser(os.path.expandvars
860
(section["secfile"])),
862
client["secret"] = secfile.read()
864
raise TypeError("No secret or secfile for section {}"
866
client["timeout"] = string_to_delta(section["timeout"])
867
client["extended_timeout"] = string_to_delta(
868
section["extended_timeout"])
869
client["interval"] = string_to_delta(section["interval"])
870
client["approval_delay"] = string_to_delta(
871
section["approval_delay"])
872
client["approval_duration"] = string_to_delta(
873
section["approval_duration"])
874
client["checker_command"] = section["checker"]
875
client["last_approval_request"] = None
876
client["last_checked_ok"] = None
877
client["last_checker_status"] = -2
881
def __init__(self, settings, name = None, server_settings=None):
291
logger.debug(u"Creating client %r", self.name)
292
# Uppercase and remove spaces from fingerprint for later
293
# comparison purposes with return value from the fingerprint()
295
self.fingerprint = (config[u"fingerprint"].upper()
297
logger.debug(u" Fingerprint: %s", self.fingerprint)
298
if u"secret" in config:
299
self.secret = config[u"secret"].decode(u"base64")
300
elif u"secfile" in config:
301
with open(os.path.expanduser(os.path.expandvars
302
(config[u"secfile"])),
304
self.secret = secfile.read()
883
if server_settings is None:
885
self.server_settings = server_settings
886
# adding all client settings
887
for setting, value in settings.items():
888
setattr(self, setting, value)
891
if not hasattr(self, "last_enabled"):
892
self.last_enabled = datetime.datetime.utcnow()
893
if not hasattr(self, "expires"):
894
self.expires = (datetime.datetime.utcnow()
306
#XXX Need to allow secret on demand!
307
raise TypeError(u"No secret or secfile for client %s"
309
self.host = config.get(u"host", u"")
310
self.created = datetime.datetime.utcnow()
312
self.last_enabled = None
313
self.last_checked_ok = None
314
self.timeout = string_to_delta(config[u"timeout"])
315
self.interval = string_to_delta(config[u"interval"])
316
self.disable_hook = disable_hook
897
self.last_enabled = None
900
logger.debug("Creating client %r", self.name)
901
logger.debug(" Fingerprint: %s", self.fingerprint)
902
self.created = settings.get("created",
903
datetime.datetime.utcnow())
905
# attributes specific for this server instance
317
906
self.checker = None
318
907
self.checker_initiator_tag = None
319
908
self.disable_initiator_tag = None
320
909
self.checker_callback_tag = None
321
self.checker_command = config[u"checker"]
322
910
self.current_checker_command = None
323
self.last_connect = None
324
912
self.approvals_pending = 0
325
self._approved = None
326
self.approved_by_default = config.get(u"approved_by_default",
328
self.approved_delay = string_to_delta(
329
config[u"approved_delay"])
330
self.approved_duration = string_to_delta(
331
config[u"approved_duration"])
332
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
913
self.changedstate = multiprocessing_manager.Condition(
914
multiprocessing_manager.Lock())
915
self.client_structure = [attr
916
for attr in self.__dict__.keys()
917
if not attr.startswith("_")]
918
self.client_structure.append("client_structure")
920
for name, t in inspect.getmembers(
921
type(self), lambda obj: isinstance(obj, property)):
922
if not name.startswith("_"):
923
self.client_structure.append(name)
925
# Send notice to process children that client state has changed
334
926
def send_changedstate(self):
335
self.changedstate.acquire()
336
self.changedstate.notify_all()
337
self.changedstate.release()
927
with self.changedstate:
928
self.changedstate.notify_all()
339
930
def enable(self):
340
931
"""Start this client's checker and timeout hooks"""
341
if getattr(self, u"enabled", False):
932
if getattr(self, "enabled", False):
342
933
# Already enabled
344
self.send_changedstate()
935
self.expires = datetime.datetime.utcnow() + self.timeout
345
937
self.last_enabled = datetime.datetime.utcnow()
939
self.send_changedstate()
941
def disable(self, quiet=True):
942
"""Disable this client."""
943
if not getattr(self, "enabled", False):
946
logger.info("Disabling client %s", self.name)
947
if getattr(self, "disable_initiator_tag", None) is not None:
948
GLib.source_remove(self.disable_initiator_tag)
949
self.disable_initiator_tag = None
951
if getattr(self, "checker_initiator_tag", None) is not None:
952
GLib.source_remove(self.checker_initiator_tag)
953
self.checker_initiator_tag = None
957
self.send_changedstate()
958
# Do not run this again if called by a GLib.timeout_add
964
def init_checker(self):
346
965
# Schedule a new checker to be started an 'interval' from now,
347
966
# and every interval from then on.
348
self.checker_initiator_tag = (gobject.timeout_add
349
(self.interval_milliseconds(),
967
if self.checker_initiator_tag is not None:
968
GLib.source_remove(self.checker_initiator_tag)
969
self.checker_initiator_tag = GLib.timeout_add(
970
int(self.interval.total_seconds() * 1000),
351
972
# Schedule a disable() when 'timeout' has passed
352
self.disable_initiator_tag = (gobject.timeout_add
353
(self.timeout_milliseconds(),
973
if self.disable_initiator_tag is not None:
974
GLib.source_remove(self.disable_initiator_tag)
975
self.disable_initiator_tag = GLib.timeout_add(
976
int(self.timeout.total_seconds() * 1000), self.disable)
356
977
# Also start a new checker *right now*.
357
978
self.start_checker()
359
def disable(self, quiet=True):
360
"""Disable this client."""
361
if not getattr(self, "enabled", False):
364
self.send_changedstate()
366
logger.info(u"Disabling client %s", self.name)
367
if getattr(self, u"disable_initiator_tag", False):
368
gobject.source_remove(self.disable_initiator_tag)
369
self.disable_initiator_tag = None
370
if getattr(self, u"checker_initiator_tag", False):
371
gobject.source_remove(self.checker_initiator_tag)
372
self.checker_initiator_tag = None
374
if self.disable_hook:
375
self.disable_hook(self)
377
# Do not run this again if called by a gobject.timeout_add
381
self.disable_hook = None
384
def checker_callback(self, pid, condition, command):
980
def checker_callback(self, source, condition, connection,
385
982
"""The checker has completed, so take appropriate actions."""
386
983
self.checker_callback_tag = None
387
984
self.checker = None
388
if os.WIFEXITED(condition):
389
exitstatus = os.WEXITSTATUS(condition)
391
logger.info(u"Checker for %(name)s succeeded",
985
# Read return code from connection (see call_pipe)
986
returncode = connection.recv()
990
self.last_checker_status = returncode
991
self.last_checker_signal = None
992
if self.last_checker_status == 0:
993
logger.info("Checker for %(name)s succeeded",
393
995
self.checked_ok()
395
logger.info(u"Checker for %(name)s failed",
997
logger.info("Checker for %(name)s failed", vars(self))
398
logger.warning(u"Checker for %(name)s crashed?",
999
self.last_checker_status = -1
1000
self.last_checker_signal = -returncode
1001
logger.warning("Checker for %(name)s crashed?",
401
1005
def checked_ok(self):
402
"""Bump up the timeout for this client.
404
This should only be called when the client has been seen,
1006
"""Assert that the client has been seen, alive and well."""
407
1007
self.last_checked_ok = datetime.datetime.utcnow()
408
gobject.source_remove(self.disable_initiator_tag)
409
self.disable_initiator_tag = (gobject.timeout_add
410
(self.timeout_milliseconds(),
1008
self.last_checker_status = 0
1009
self.last_checker_signal = None
1012
def bump_timeout(self, timeout=None):
1013
"""Bump up the timeout for this client."""
1015
timeout = self.timeout
1016
if self.disable_initiator_tag is not None:
1017
GLib.source_remove(self.disable_initiator_tag)
1018
self.disable_initiator_tag = None
1019
if getattr(self, "enabled", False):
1020
self.disable_initiator_tag = GLib.timeout_add(
1021
int(timeout.total_seconds() * 1000), self.disable)
1022
self.expires = datetime.datetime.utcnow() + timeout
1024
def need_approval(self):
1025
self.last_approval_request = datetime.datetime.utcnow()
413
1027
def start_checker(self):
414
1028
"""Start a new checker subprocess if one is not running.
553
class DBusObjectWithProperties(dbus.service.Object):
1194
class DBusObjectWithAnnotations(dbus.service.Object):
1195
"""A D-Bus object with annotations.
1197
Classes inheriting from this can use the dbus_annotations
1198
decorator to add annotations to methods or signals.
1202
def _is_dbus_thing(thing):
1203
"""Returns a function testing if an attribute is a D-Bus thing
1205
If called like _is_dbus_thing("method") it returns a function
1206
suitable for use as predicate to inspect.getmembers().
1208
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1211
def _get_all_dbus_things(self, thing):
1212
"""Returns a generator of (name, attribute) pairs
1214
return ((getattr(athing.__get__(self), "_dbus_name", name),
1215
athing.__get__(self))
1216
for cls in self.__class__.__mro__
1218
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1220
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1221
out_signature = "s",
1222
path_keyword = 'object_path',
1223
connection_keyword = 'connection')
1224
def Introspect(self, object_path, connection):
1225
"""Overloading of standard D-Bus method.
1227
Inserts annotation tags on methods and signals.
1229
xmlstring = dbus.service.Object.Introspect(self, object_path,
1232
document = xml.dom.minidom.parseString(xmlstring)
1234
for if_tag in document.getElementsByTagName("interface"):
1235
# Add annotation tags
1236
for typ in ("method", "signal"):
1237
for tag in if_tag.getElementsByTagName(typ):
1239
for name, prop in (self.
1240
_get_all_dbus_things(typ)):
1241
if (name == tag.getAttribute("name")
1242
and prop._dbus_interface
1243
== if_tag.getAttribute("name")):
1244
annots.update(getattr(
1245
prop, "_dbus_annotations", {}))
1246
for name, value in annots.items():
1247
ann_tag = document.createElement(
1249
ann_tag.setAttribute("name", name)
1250
ann_tag.setAttribute("value", value)
1251
tag.appendChild(ann_tag)
1252
# Add interface annotation tags
1253
for annotation, value in dict(
1254
itertools.chain.from_iterable(
1255
annotations().items()
1256
for name, annotations
1257
in self._get_all_dbus_things("interface")
1258
if name == if_tag.getAttribute("name")
1260
ann_tag = document.createElement("annotation")
1261
ann_tag.setAttribute("name", annotation)
1262
ann_tag.setAttribute("value", value)
1263
if_tag.appendChild(ann_tag)
1264
# Fix argument name for the Introspect method itself
1265
if (if_tag.getAttribute("name")
1266
== dbus.INTROSPECTABLE_IFACE):
1267
for cn in if_tag.getElementsByTagName("method"):
1268
if cn.getAttribute("name") == "Introspect":
1269
for arg in cn.getElementsByTagName("arg"):
1270
if (arg.getAttribute("direction")
1272
arg.setAttribute("name",
1274
xmlstring = document.toxml("utf-8")
1276
except (AttributeError, xml.dom.DOMException,
1277
xml.parsers.expat.ExpatError) as error:
1278
logger.error("Failed to override Introspection method",
1283
class DBusObjectWithProperties(DBusObjectWithAnnotations):
554
1284
"""A D-Bus object with properties.
556
1286
Classes inheriting from this can use the dbus_service_property
557
1287
decorator to expose methods as D-Bus properties. It exposes the
558
1288
standard Get(), Set(), and GetAll() methods on the D-Bus.
562
def _is_dbus_property(obj):
563
return getattr(obj, u"_dbus_is_property", False)
565
def _get_all_dbus_properties(self):
566
"""Returns a generator of (name, attribute) pairs
568
return ((prop._dbus_name, prop)
570
inspect.getmembers(self, self._is_dbus_property))
572
1291
def _get_dbus_property(self, interface_name, property_name):
573
1292
"""Returns a bound method if one exists which is a D-Bus
574
1293
property with the specified name and interface.
576
for name in (property_name,
577
property_name + u"_dbus_property"):
578
prop = getattr(self, name, None)
580
or not self._is_dbus_property(prop)
581
or prop._dbus_name != property_name
582
or (interface_name and prop._dbus_interface
583
and interface_name != prop._dbus_interface)):
1295
for cls in self.__class__.__mro__:
1296
for name, value in inspect.getmembers(
1297
cls, self._is_dbus_thing("property")):
1298
if (value._dbus_name == property_name
1299
and value._dbus_interface == interface_name):
1300
return value.__get__(self)
586
1302
# No such property
587
raise DBusPropertyNotFound(self.dbus_object_path + u":"
588
+ interface_name + u"."
591
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1303
raise DBusPropertyNotFound("{}:{}.{}".format(
1304
self.dbus_object_path, interface_name, property_name))
1307
def _get_all_interface_names(cls):
1308
"""Get a sequence of all interfaces supported by an object"""
1309
return (name for name in set(getattr(getattr(x, attr),
1310
"_dbus_interface", None)
1311
for x in (inspect.getmro(cls))
1313
if name is not None)
1315
@dbus.service.method(dbus.PROPERTIES_IFACE,
593
1318
def Get(self, interface_name, property_name):
594
1319
"""Standard D-Bus property Get() method, see D-Bus standard.
596
1321
prop = self._get_dbus_property(interface_name, property_name)
597
if prop._dbus_access == u"write":
1322
if prop._dbus_access == "write":
598
1323
raise DBusPropertyAccessException(property_name)
600
if not hasattr(value, u"variant_level"):
1325
if not hasattr(value, "variant_level"):
602
1327
return type(value)(value, variant_level=value.variant_level+1)
604
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1329
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
605
1330
def Set(self, interface_name, property_name, value):
606
1331
"""Standard D-Bus property Set() method, see D-Bus standard.
608
1333
prop = self._get_dbus_property(interface_name, property_name)
609
if prop._dbus_access == u"read":
1334
if prop._dbus_access == "read":
610
1335
raise DBusPropertyAccessException(property_name)
611
if prop._dbus_get_args_options[u"byte_arrays"]:
1336
if prop._dbus_get_args_options["byte_arrays"]:
612
1337
# The byte_arrays option is not supported yet on
613
1338
# signatures other than "ay".
614
if prop._dbus_signature != u"ay":
616
value = dbus.ByteArray(''.join(unichr(byte)
1339
if prop._dbus_signature != "ay":
1340
raise ValueError("Byte arrays not supported for non-"
1341
"'ay' signature {!r}"
1342
.format(prop._dbus_signature))
1343
value = dbus.ByteArray(b''.join(chr(byte)
620
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
621
out_signature=u"a{sv}")
1347
@dbus.service.method(dbus.PROPERTIES_IFACE,
1349
out_signature="a{sv}")
622
1350
def GetAll(self, interface_name):
623
1351
"""Standard D-Bus property GetAll() method, see D-Bus
626
1354
Note: Will not include properties with access="write".
629
for name, prop in self._get_all_dbus_properties():
1357
for name, prop in self._get_all_dbus_things("property"):
630
1358
if (interface_name
631
1359
and interface_name != prop._dbus_interface):
632
1360
# Interface non-empty but did not match
634
1362
# Ignore write-only properties
635
if prop._dbus_access == u"write":
1363
if prop._dbus_access == "write":
638
if not hasattr(value, u"variant_level"):
1366
if not hasattr(value, "variant_level"):
1367
properties[name] = value
641
all[name] = type(value)(value, variant_level=
642
value.variant_level+1)
643
return dbus.Dictionary(all, signature=u"sv")
1369
properties[name] = type(value)(
1370
value, variant_level = value.variant_level + 1)
1371
return dbus.Dictionary(properties, signature="sv")
1373
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1374
def PropertiesChanged(self, interface_name, changed_properties,
1375
invalidated_properties):
1376
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
645
1381
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
647
1383
path_keyword='object_path',
648
1384
connection_keyword='connection')
649
1385
def Introspect(self, object_path, connection):
650
"""Standard D-Bus method, overloaded to insert property tags.
1386
"""Overloading of standard D-Bus method.
1388
Inserts property tags and interface annotation tags.
652
xmlstring = dbus.service.Object.Introspect(self, object_path,
1390
xmlstring = DBusObjectWithAnnotations.Introspect(self,
655
1394
document = xml.dom.minidom.parseString(xmlstring)
656
1396
def make_tag(document, name, prop):
657
e = document.createElement(u"property")
658
e.setAttribute(u"name", name)
659
e.setAttribute(u"type", prop._dbus_signature)
660
e.setAttribute(u"access", prop._dbus_access)
1397
e = document.createElement("property")
1398
e.setAttribute("name", name)
1399
e.setAttribute("type", prop._dbus_signature)
1400
e.setAttribute("access", prop._dbus_access)
662
for if_tag in document.getElementsByTagName(u"interface"):
1403
for if_tag in document.getElementsByTagName("interface"):
663
1405
for tag in (make_tag(document, name, prop)
665
in self._get_all_dbus_properties()
1407
in self._get_all_dbus_things("property")
666
1408
if prop._dbus_interface
667
== if_tag.getAttribute(u"name")):
1409
== if_tag.getAttribute("name")):
668
1410
if_tag.appendChild(tag)
1411
# Add annotation tags for properties
1412
for tag in if_tag.getElementsByTagName("property"):
1414
for name, prop in self._get_all_dbus_things(
1416
if (name == tag.getAttribute("name")
1417
and prop._dbus_interface
1418
== if_tag.getAttribute("name")):
1419
annots.update(getattr(
1420
prop, "_dbus_annotations", {}))
1421
for name, value in annots.items():
1422
ann_tag = document.createElement(
1424
ann_tag.setAttribute("name", name)
1425
ann_tag.setAttribute("value", value)
1426
tag.appendChild(ann_tag)
669
1427
# Add the names to the return values for the
670
1428
# "org.freedesktop.DBus.Properties" methods
671
if (if_tag.getAttribute(u"name")
672
== u"org.freedesktop.DBus.Properties"):
673
for cn in if_tag.getElementsByTagName(u"method"):
674
if cn.getAttribute(u"name") == u"Get":
675
for arg in cn.getElementsByTagName(u"arg"):
676
if (arg.getAttribute(u"direction")
678
arg.setAttribute(u"name", u"value")
679
elif cn.getAttribute(u"name") == u"GetAll":
680
for arg in cn.getElementsByTagName(u"arg"):
681
if (arg.getAttribute(u"direction")
683
arg.setAttribute(u"name", u"props")
684
xmlstring = document.toxml(u"utf-8")
686
except (AttributeError, xml.dom.DOMException,
687
xml.parsers.expat.ExpatError), error:
688
logger.error(u"Failed to override Introspection method",
1429
if (if_tag.getAttribute("name")
1430
== "org.freedesktop.DBus.Properties"):
1431
for cn in if_tag.getElementsByTagName("method"):
1432
if cn.getAttribute("name") == "Get":
1433
for arg in cn.getElementsByTagName("arg"):
1434
if (arg.getAttribute("direction")
1436
arg.setAttribute("name", "value")
1437
elif cn.getAttribute("name") == "GetAll":
1438
for arg in cn.getElementsByTagName("arg"):
1439
if (arg.getAttribute("direction")
1441
arg.setAttribute("name", "props")
1442
xmlstring = document.toxml("utf-8")
1444
except (AttributeError, xml.dom.DOMException,
1445
xml.parsers.expat.ExpatError) as error:
1446
logger.error("Failed to override Introspection method",
1451
dbus.OBJECT_MANAGER_IFACE
1452
except AttributeError:
1453
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1455
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1456
"""A D-Bus object with an ObjectManager.
1458
Classes inheriting from this exposes the standard
1459
GetManagedObjects call and the InterfacesAdded and
1460
InterfacesRemoved signals on the standard
1461
"org.freedesktop.DBus.ObjectManager" interface.
1463
Note: No signals are sent automatically; they must be sent
1466
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1467
out_signature = "a{oa{sa{sv}}}")
1468
def GetManagedObjects(self):
1469
"""This function must be overridden"""
1470
raise NotImplementedError()
1472
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1473
signature = "oa{sa{sv}}")
1474
def InterfacesAdded(self, object_path, interfaces_and_properties):
1477
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1478
def InterfacesRemoved(self, object_path, interfaces):
1481
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1482
out_signature = "s",
1483
path_keyword = 'object_path',
1484
connection_keyword = 'connection')
1485
def Introspect(self, object_path, connection):
1486
"""Overloading of standard D-Bus method.
1488
Override return argument name of GetManagedObjects to be
1489
"objpath_interfaces_and_properties"
1491
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1495
document = xml.dom.minidom.parseString(xmlstring)
1497
for if_tag in document.getElementsByTagName("interface"):
1498
# Fix argument name for the GetManagedObjects method
1499
if (if_tag.getAttribute("name")
1500
== dbus.OBJECT_MANAGER_IFACE):
1501
for cn in if_tag.getElementsByTagName("method"):
1502
if (cn.getAttribute("name")
1503
== "GetManagedObjects"):
1504
for arg in cn.getElementsByTagName("arg"):
1505
if (arg.getAttribute("direction")
1509
"objpath_interfaces"
1511
xmlstring = document.toxml("utf-8")
1513
except (AttributeError, xml.dom.DOMException,
1514
xml.parsers.expat.ExpatError) as error:
1515
logger.error("Failed to override Introspection method",
1519
def datetime_to_dbus(dt, variant_level=0):
1520
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1522
return dbus.String("", variant_level = variant_level)
1523
return dbus.String(dt.isoformat(), variant_level=variant_level)
1526
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1527
"""A class decorator; applied to a subclass of
1528
dbus.service.Object, it will add alternate D-Bus attributes with
1529
interface names according to the "alt_interface_names" mapping.
1532
@alternate_dbus_interfaces({"org.example.Interface":
1533
"net.example.AlternateInterface"})
1534
class SampleDBusObject(dbus.service.Object):
1535
@dbus.service.method("org.example.Interface")
1536
def SampleDBusMethod():
1539
The above "SampleDBusMethod" on "SampleDBusObject" will be
1540
reachable via two interfaces: "org.example.Interface" and
1541
"net.example.AlternateInterface", the latter of which will have
1542
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1543
"true", unless "deprecate" is passed with a False value.
1545
This works for methods and signals, and also for D-Bus properties
1546
(from DBusObjectWithProperties) and interfaces (from the
1547
dbus_interface_annotations decorator).
1551
for orig_interface_name, alt_interface_name in (
1552
alt_interface_names.items()):
1554
interface_names = set()
1555
# Go though all attributes of the class
1556
for attrname, attribute in inspect.getmembers(cls):
1557
# Ignore non-D-Bus attributes, and D-Bus attributes
1558
# with the wrong interface name
1559
if (not hasattr(attribute, "_dbus_interface")
1560
or not attribute._dbus_interface.startswith(
1561
orig_interface_name)):
1563
# Create an alternate D-Bus interface name based on
1565
alt_interface = attribute._dbus_interface.replace(
1566
orig_interface_name, alt_interface_name)
1567
interface_names.add(alt_interface)
1568
# Is this a D-Bus signal?
1569
if getattr(attribute, "_dbus_is_signal", False):
1570
# Extract the original non-method undecorated
1571
# function by black magic
1572
if sys.version_info.major == 2:
1573
nonmethod_func = (dict(
1574
zip(attribute.func_code.co_freevars,
1575
attribute.__closure__))
1576
["func"].cell_contents)
1578
nonmethod_func = (dict(
1579
zip(attribute.__code__.co_freevars,
1580
attribute.__closure__))
1581
["func"].cell_contents)
1582
# Create a new, but exactly alike, function
1583
# object, and decorate it to be a new D-Bus signal
1584
# with the alternate D-Bus interface name
1585
new_function = copy_function(nonmethod_func)
1586
new_function = (dbus.service.signal(
1588
attribute._dbus_signature)(new_function))
1589
# Copy annotations, if any
1591
new_function._dbus_annotations = dict(
1592
attribute._dbus_annotations)
1593
except AttributeError:
1595
# Define a creator of a function to call both the
1596
# original and alternate functions, so both the
1597
# original and alternate signals gets sent when
1598
# the function is called
1599
def fixscope(func1, func2):
1600
"""This function is a scope container to pass
1601
func1 and func2 to the "call_both" function
1602
outside of its arguments"""
1604
@functools.wraps(func2)
1605
def call_both(*args, **kwargs):
1606
"""This function will emit two D-Bus
1607
signals by calling func1 and func2"""
1608
func1(*args, **kwargs)
1609
func2(*args, **kwargs)
1610
# Make wrapper function look like a D-Bus signal
1611
for name, attr in inspect.getmembers(func2):
1612
if name.startswith("_dbus_"):
1613
setattr(call_both, name, attr)
1616
# Create the "call_both" function and add it to
1618
attr[attrname] = fixscope(attribute, new_function)
1619
# Is this a D-Bus method?
1620
elif getattr(attribute, "_dbus_is_method", False):
1621
# Create a new, but exactly alike, function
1622
# object. Decorate it to be a new D-Bus method
1623
# with the alternate D-Bus interface name. Add it
1626
dbus.service.method(
1628
attribute._dbus_in_signature,
1629
attribute._dbus_out_signature)
1630
(copy_function(attribute)))
1631
# Copy annotations, if any
1633
attr[attrname]._dbus_annotations = dict(
1634
attribute._dbus_annotations)
1635
except AttributeError:
1637
# Is this a D-Bus property?
1638
elif getattr(attribute, "_dbus_is_property", False):
1639
# Create a new, but exactly alike, function
1640
# object, and decorate it to be a new D-Bus
1641
# property with the alternate D-Bus interface
1642
# name. Add it to the class.
1643
attr[attrname] = (dbus_service_property(
1644
alt_interface, attribute._dbus_signature,
1645
attribute._dbus_access,
1646
attribute._dbus_get_args_options
1648
(copy_function(attribute)))
1649
# Copy annotations, if any
1651
attr[attrname]._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1653
except AttributeError:
1655
# Is this a D-Bus interface?
1656
elif getattr(attribute, "_dbus_is_interface", False):
1657
# Create a new, but exactly alike, function
1658
# object. Decorate it to be a new D-Bus interface
1659
# with the alternate D-Bus interface name. Add it
1662
dbus_interface_annotations(alt_interface)
1663
(copy_function(attribute)))
1665
# Deprecate all alternate interfaces
1666
iname="_AlternateDBusNames_interface_annotation{}"
1667
for interface_name in interface_names:
1669
@dbus_interface_annotations(interface_name)
1671
return { "org.freedesktop.DBus.Deprecated":
1673
# Find an unused name
1674
for aname in (iname.format(i)
1675
for i in itertools.count()):
1676
if aname not in attr:
1680
# Replace the class with a new subclass of it with
1681
# methods, signals, etc. as created above.
1682
if sys.version_info.major == 2:
1683
cls = type(b"{}Alternate".format(cls.__name__),
1686
cls = type("{}Alternate".format(cls.__name__),
1693
@alternate_dbus_interfaces({"se.recompile.Mandos":
1694
"se.bsnet.fukt.Mandos"})
693
1695
class ClientDBus(Client, DBusObjectWithProperties):
694
1696
"""A Client class using D-Bus
704
1712
Client.__init__(self, *args, **kwargs)
705
1713
# Only now, when this client is initialized, can it show up on
707
self.dbus_object_path = (dbus.ObjectPath
709
+ self.name.replace(u".", u"_")))
1715
client_object_name = str(self.name).translate(
1716
{ord("."): ord("_"),
1717
ord("-"): ord("_")})
1718
self.dbus_object_path = dbus.ObjectPath(
1719
"/clients/" + client_object_name)
710
1720
DBusObjectWithProperties.__init__(self, self.bus,
711
1721
self.dbus_object_path)
714
def _datetime_to_dbus(dt, variant_level=0):
715
"""Convert a UTC datetime.datetime() to a D-Bus type."""
716
return dbus.String(dt.isoformat(),
717
variant_level=variant_level)
720
oldstate = getattr(self, u"enabled", False)
721
r = Client.enable(self)
722
if oldstate != self.enabled:
724
self.PropertyChanged(dbus.String(u"enabled"),
725
dbus.Boolean(True, variant_level=1))
726
self.PropertyChanged(
727
dbus.String(u"last_enabled"),
728
self._datetime_to_dbus(self.last_enabled,
732
def disable(self, quiet = False):
733
oldstate = getattr(self, u"enabled", False)
734
r = Client.disable(self, quiet=quiet)
735
if not quiet and oldstate != self.enabled:
737
self.PropertyChanged(dbus.String(u"enabled"),
738
dbus.Boolean(False, variant_level=1))
1723
def notifychangeproperty(transform_func, dbus_name,
1724
type_func=lambda x: x,
1726
invalidate_only=False,
1727
_interface=_interface):
1728
""" Modify a variable so that it's a property which announces
1729
its changes to DBus.
1731
transform_fun: Function that takes a value and a variant_level
1732
and transforms it to a D-Bus type.
1733
dbus_name: D-Bus name of the variable
1734
type_func: Function that transform the value before sending it
1735
to the D-Bus. Default: no transform
1736
variant_level: D-Bus variant level. Default: 1
1738
attrname = "_{}".format(dbus_name)
1740
def setter(self, value):
1741
if hasattr(self, "dbus_object_path"):
1742
if (not hasattr(self, attrname) or
1743
type_func(getattr(self, attrname, None))
1744
!= type_func(value)):
1746
self.PropertiesChanged(
1747
_interface, dbus.Dictionary(),
1748
dbus.Array((dbus_name, )))
1750
dbus_value = transform_func(
1752
variant_level = variant_level)
1753
self.PropertyChanged(dbus.String(dbus_name),
1755
self.PropertiesChanged(
1757
dbus.Dictionary({ dbus.String(dbus_name):
1760
setattr(self, attrname, value)
1762
return property(lambda self: getattr(self, attrname), setter)
1764
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1765
approvals_pending = notifychangeproperty(dbus.Boolean,
1768
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1769
last_enabled = notifychangeproperty(datetime_to_dbus,
1771
checker = notifychangeproperty(
1772
dbus.Boolean, "CheckerRunning",
1773
type_func = lambda checker: checker is not None)
1774
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1776
last_checker_status = notifychangeproperty(dbus.Int16,
1777
"LastCheckerStatus")
1778
last_approval_request = notifychangeproperty(
1779
datetime_to_dbus, "LastApprovalRequest")
1780
approved_by_default = notifychangeproperty(dbus.Boolean,
1781
"ApprovedByDefault")
1782
approval_delay = notifychangeproperty(
1783
dbus.UInt64, "ApprovalDelay",
1784
type_func = lambda td: td.total_seconds() * 1000)
1785
approval_duration = notifychangeproperty(
1786
dbus.UInt64, "ApprovalDuration",
1787
type_func = lambda td: td.total_seconds() * 1000)
1788
host = notifychangeproperty(dbus.String, "Host")
1789
timeout = notifychangeproperty(
1790
dbus.UInt64, "Timeout",
1791
type_func = lambda td: td.total_seconds() * 1000)
1792
extended_timeout = notifychangeproperty(
1793
dbus.UInt64, "ExtendedTimeout",
1794
type_func = lambda td: td.total_seconds() * 1000)
1795
interval = notifychangeproperty(
1796
dbus.UInt64, "Interval",
1797
type_func = lambda td: td.total_seconds() * 1000)
1798
checker_command = notifychangeproperty(dbus.String, "Checker")
1799
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1800
invalidate_only=True)
1802
del notifychangeproperty
741
1804
def __del__(self, *args, **kwargs):
743
1806
self.remove_from_connection()
744
1807
except LookupError:
746
if hasattr(DBusObjectWithProperties, u"__del__"):
1809
if hasattr(DBusObjectWithProperties, "__del__"):
747
1810
DBusObjectWithProperties.__del__(self, *args, **kwargs)
748
1811
Client.__del__(self, *args, **kwargs)
750
def checker_callback(self, pid, condition, command,
752
self.checker_callback_tag = None
755
self.PropertyChanged(dbus.String(u"checker_running"),
756
dbus.Boolean(False, variant_level=1))
757
if os.WIFEXITED(condition):
758
exitstatus = os.WEXITSTATUS(condition)
1813
def checker_callback(self, source, condition,
1814
connection, command, *args, **kwargs):
1815
ret = Client.checker_callback(self, source, condition,
1816
connection, command, *args,
1818
exitstatus = self.last_checker_status
759
1820
# Emit D-Bus signal
760
1821
self.CheckerCompleted(dbus.Int16(exitstatus),
761
dbus.Int64(condition),
1822
# This is specific to GNU libC
1823
dbus.Int64(exitstatus << 8),
762
1824
dbus.String(command))
764
1826
# Emit D-Bus signal
765
1827
self.CheckerCompleted(dbus.Int16(-1),
766
dbus.Int64(condition),
1829
# This is specific to GNU libC
1831
| self.last_checker_signal),
767
1832
dbus.String(command))
769
return Client.checker_callback(self, pid, condition, command,
772
def checked_ok(self, *args, **kwargs):
773
r = Client.checked_ok(self, *args, **kwargs)
775
self.PropertyChanged(
776
dbus.String(u"last_checked_ok"),
777
(self._datetime_to_dbus(self.last_checked_ok,
781
1835
def start_checker(self, *args, **kwargs):
782
old_checker = self.checker
783
if self.checker is not None:
784
old_checker_pid = self.checker.pid
786
old_checker_pid = None
1836
old_checker_pid = getattr(self.checker, "pid", None)
787
1837
r = Client.start_checker(self, *args, **kwargs)
788
1838
# Only if new checker process was started
789
1839
if (self.checker is not None
790
1840
and old_checker_pid != self.checker.pid):
791
1841
# Emit D-Bus signal
792
1842
self.CheckerStarted(self.current_checker_command)
793
self.PropertyChanged(
794
dbus.String(u"checker_running"),
795
dbus.Boolean(True, variant_level=1))
798
def stop_checker(self, *args, **kwargs):
799
old_checker = getattr(self, u"checker", None)
800
r = Client.stop_checker(self, *args, **kwargs)
801
if (old_checker is not None
802
and getattr(self, u"checker", None) is None):
803
self.PropertyChanged(dbus.String(u"checker_running"),
804
dbus.Boolean(False, variant_level=1))
807
1845
def _reset_approved(self):
808
self._approved = None
1846
self.approved = None
811
1849
def approve(self, value=True):
812
self._approved = value
813
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration, self._reset_approved))
815
def approved_pending(self):
816
return self.approvals_pending > 0
1850
self.approved = value
1851
GLib.timeout_add(int(self.approval_duration.total_seconds()
1852
* 1000), self._reset_approved)
1853
self.send_changedstate()
819
1855
## D-Bus methods, signals & properties
820
_interface = u"se.bsnet.fukt.Mandos.Client"
824
1861
# CheckerCompleted - signal
825
@dbus.service.signal(_interface, signature=u"nxs")
1862
@dbus.service.signal(_interface, signature="nxs")
826
1863
def CheckerCompleted(self, exitcode, waitstatus, command):
830
1867
# CheckerStarted - signal
831
@dbus.service.signal(_interface, signature=u"s")
1868
@dbus.service.signal(_interface, signature="s")
832
1869
def CheckerStarted(self, command):
836
1873
# PropertyChanged - signal
837
@dbus.service.signal(_interface, signature=u"sv")
1874
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1875
@dbus.service.signal(_interface, signature="sv")
838
1876
def PropertyChanged(self, property, value):
842
1880
# GotSecret - signal
843
# Is sent after succesfull transfer of secret from mandos-server to mandos-client
844
1881
@dbus.service.signal(_interface)
845
1882
def GotSecret(self):
1884
Is sent after a successful transfer of secret from the Mandos
1885
server to mandos-client
849
1889
# Rejected - signal
850
@dbus.service.signal(_interface, signature=u"s")
1890
@dbus.service.signal(_interface, signature="s")
851
1891
def Rejected(self, reason):
855
1895
# NeedApproval - signal
856
@dbus.service.signal(_interface, signature=u"db")
1896
@dbus.service.signal(_interface, signature="tb")
857
1897
def NeedApproval(self, timeout, default):
1899
return self.need_approval()
863
1903
# Approve - method
864
@dbus.service.method(_interface, in_signature=u"b")
1904
@dbus.service.method(_interface, in_signature="b")
865
1905
def Approve(self, value):
866
1906
self.approve(value)
868
1908
# CheckedOK - method
869
1909
@dbus.service.method(_interface)
870
1910
def CheckedOK(self):
871
return self.checked_ok()
873
1913
# Enable - method
1914
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
874
1915
@dbus.service.method(_interface)
875
1916
def Enable(self):
879
1920
# StartChecker - method
1921
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
880
1922
@dbus.service.method(_interface)
881
1923
def StartChecker(self):
883
1925
self.start_checker()
885
1927
# Disable - method
1928
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
886
1929
@dbus.service.method(_interface)
887
1930
def Disable(self):
891
1934
# StopChecker - method
1935
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
892
1936
@dbus.service.method(_interface)
893
1937
def StopChecker(self):
894
1938
self.stop_checker()
898
# approved_pending - property
899
@dbus_service_property(_interface, signature=u"b", access=u"read")
900
def approved_pending_dbus_property(self):
901
return dbus.Boolean(self.approved_pending())
903
# approved_by_default - property
904
@dbus_service_property(_interface, signature=u"b",
906
def approved_by_default_dbus_property(self):
907
return dbus.Boolean(self.approved_by_default)
909
# approved_delay - property
910
@dbus_service_property(_interface, signature=u"t",
912
def approved_delay_dbus_property(self):
913
return dbus.UInt64(self.approved_delay_milliseconds())
915
# approved_duration - property
916
@dbus_service_property(_interface, signature=u"t",
918
def approved_duration_dbus_property(self):
919
return dbus.UInt64(self._timedelta_to_milliseconds(
920
self.approved_duration))
923
@dbus_service_property(_interface, signature=u"s", access=u"read")
924
def name_dbus_property(self):
1942
# ApprovalPending - property
1943
@dbus_service_property(_interface, signature="b", access="read")
1944
def ApprovalPending_dbus_property(self):
1945
return dbus.Boolean(bool(self.approvals_pending))
1947
# ApprovedByDefault - property
1948
@dbus_service_property(_interface,
1951
def ApprovedByDefault_dbus_property(self, value=None):
1952
if value is None: # get
1953
return dbus.Boolean(self.approved_by_default)
1954
self.approved_by_default = bool(value)
1956
# ApprovalDelay - property
1957
@dbus_service_property(_interface,
1960
def ApprovalDelay_dbus_property(self, value=None):
1961
if value is None: # get
1962
return dbus.UInt64(self.approval_delay.total_seconds()
1964
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1966
# ApprovalDuration - property
1967
@dbus_service_property(_interface,
1970
def ApprovalDuration_dbus_property(self, value=None):
1971
if value is None: # get
1972
return dbus.UInt64(self.approval_duration.total_seconds()
1974
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1978
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1979
@dbus_service_property(_interface, signature="s", access="read")
1980
def Name_dbus_property(self):
925
1981
return dbus.String(self.name)
927
# fingerprint - property
928
@dbus_service_property(_interface, signature=u"s", access=u"read")
929
def fingerprint_dbus_property(self):
1983
# Fingerprint - property
1985
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1986
@dbus_service_property(_interface, signature="s", access="read")
1987
def Fingerprint_dbus_property(self):
930
1988
return dbus.String(self.fingerprint)
933
@dbus_service_property(_interface, signature=u"s",
935
def host_dbus_property(self, value=None):
1991
@dbus_service_property(_interface,
1994
def Host_dbus_property(self, value=None):
936
1995
if value is None: # get
937
1996
return dbus.String(self.host)
940
self.PropertyChanged(dbus.String(u"host"),
941
dbus.String(value, variant_level=1))
944
@dbus_service_property(_interface, signature=u"s", access=u"read")
945
def created_dbus_property(self):
946
return dbus.String(self._datetime_to_dbus(self.created))
948
# last_enabled - property
949
@dbus_service_property(_interface, signature=u"s", access=u"read")
950
def last_enabled_dbus_property(self):
951
if self.last_enabled is None:
952
return dbus.String(u"")
953
return dbus.String(self._datetime_to_dbus(self.last_enabled))
956
@dbus_service_property(_interface, signature=u"b",
958
def enabled_dbus_property(self, value=None):
1997
self.host = str(value)
1999
# Created - property
2001
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2002
@dbus_service_property(_interface, signature="s", access="read")
2003
def Created_dbus_property(self):
2004
return datetime_to_dbus(self.created)
2006
# LastEnabled - property
2007
@dbus_service_property(_interface, signature="s", access="read")
2008
def LastEnabled_dbus_property(self):
2009
return datetime_to_dbus(self.last_enabled)
2011
# Enabled - property
2012
@dbus_service_property(_interface,
2015
def Enabled_dbus_property(self, value=None):
959
2016
if value is None: # get
960
2017
return dbus.Boolean(self.enabled)
1398
2504
gnutls_priority GnuTLS priority string
1399
2505
use_dbus: Boolean; to emit D-Bus signals or not
1401
Assumes a gobject.MainLoop event loop.
2507
Assumes a GLib.MainLoop event loop.
1403
2510
def __init__(self, server_address, RequestHandlerClass,
1404
interface=None, use_ipv6=True, clients=None,
1405
gnutls_priority=None, use_dbus=True):
2514
gnutls_priority=None,
1406
2517
self.enabled = False
1407
2518
self.clients = clients
1408
2519
if self.clients is None:
1409
self.clients = set()
1410
2521
self.use_dbus = use_dbus
1411
2522
self.gnutls_priority = gnutls_priority
1412
2523
IPv6_TCPServer.__init__(self, server_address,
1413
2524
RequestHandlerClass,
1414
2525
interface = interface,
1415
use_ipv6 = use_ipv6)
2526
use_ipv6 = use_ipv6,
2527
socketfd = socketfd)
1416
2529
def server_activate(self):
1417
2530
if self.enabled:
1418
2531
return socketserver.TCPServer.server_activate(self)
1419
2533
def enable(self):
1420
2534
self.enabled = True
1421
def add_pipe(self, parent_pipe):
2536
def add_pipe(self, parent_pipe, proc):
1422
2537
# Call "handle_ipc" for both data and EOF events
1423
gobject.io_add_watch(parent_pipe.fileno(),
1424
gobject.IO_IN | gobject.IO_HUP,
1425
functools.partial(self.handle_ipc,
1426
parent_pipe = parent_pipe))
1428
def handle_ipc(self, source, condition, parent_pipe=None,
2539
parent_pipe.fileno(),
2540
GLib.IO_IN | GLib.IO_HUP,
2541
functools.partial(self.handle_ipc,
2542
parent_pipe = parent_pipe,
2545
def handle_ipc(self, source, condition,
1429
2548
client_object=None):
1431
gobject.IO_IN: u"IN", # There is data to read.
1432
gobject.IO_OUT: u"OUT", # Data can be written (without
1434
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1435
gobject.IO_ERR: u"ERR", # Error condition.
1436
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1437
# broken, usually for pipes and
1440
conditions_string = ' | '.join(name
1442
condition_names.iteritems()
1443
if cond & condition)
1444
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1447
# error or the other end of multiprocessing.Pipe has closed
1448
if condition & gobject.IO_HUP or condition & gobject.IO_ERR:
2549
# error, or the other end of multiprocessing.Pipe has closed
2550
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2551
# Wait for other process to exit
1451
2555
# Read a request from the child
1452
2556
request = parent_pipe.recv()
1453
logger.debug(u"IPC request: %s", repr(request))
1454
2557
command = request[0]
1456
2559
if command == 'init':
1457
2560
fpr = request[1]
1458
2561
address = request[2]
1460
for c in self.clients:
2563
for c in self.clients.values():
1461
2564
if c.fingerprint == fpr:
1465
logger.warning(u"Client not found for fingerprint: %s, ad"
1466
u"dress: %s", fpr, address)
2568
logger.info("Client not found for fingerprint: %s, ad"
2569
"dress: %s", fpr, address)
1467
2570
if self.use_dbus:
1468
2571
# Emit D-Bus signal
1469
mandos_dbus_service.ClientNotFound(fpr, address)
2572
mandos_dbus_service.ClientNotFound(fpr,
1470
2574
parent_pipe.send(False)
1473
gobject.io_add_watch(parent_pipe.fileno(),
1474
gobject.IO_IN | gobject.IO_HUP,
1475
functools.partial(self.handle_ipc,
1476
parent_pipe = parent_pipe,
1477
client_object = client))
2578
parent_pipe.fileno(),
2579
GLib.IO_IN | GLib.IO_HUP,
2580
functools.partial(self.handle_ipc,
2581
parent_pipe = parent_pipe,
2583
client_object = client))
1478
2584
parent_pipe.send(True)
1479
# remove the old hook in favor of the new above hook on same fileno
2585
# remove the old hook in favor of the new above hook on
1481
2588
if command == 'funcall':
1482
2589
funcname = request[1]
1483
2590
args = request[2]
1484
2591
kwargs = request[3]
1486
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2593
parent_pipe.send(('data', getattr(client_object,
1488
2597
if command == 'getattr':
1489
2598
attrname = request[1]
1490
if callable(client_object.__getattribute__(attrname)):
1491
parent_pipe.send(('function',))
2599
if isinstance(client_object.__getattribute__(attrname),
2600
collections.Callable):
2601
parent_pipe.send(('function', ))
1493
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2604
'data', client_object.__getattribute__(attrname)))
1495
2606
if command == 'setattr':
1496
2607
attrname = request[1]
1497
2608
value = request[2]
1498
2609
setattr(client_object, attrname, value)
2614
def rfc3339_duration_to_delta(duration):
2615
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2617
>>> rfc3339_duration_to_delta("P7D")
2618
datetime.timedelta(7)
2619
>>> rfc3339_duration_to_delta("PT60S")
2620
datetime.timedelta(0, 60)
2621
>>> rfc3339_duration_to_delta("PT60M")
2622
datetime.timedelta(0, 3600)
2623
>>> rfc3339_duration_to_delta("PT24H")
2624
datetime.timedelta(1)
2625
>>> rfc3339_duration_to_delta("P1W")
2626
datetime.timedelta(7)
2627
>>> rfc3339_duration_to_delta("PT5M30S")
2628
datetime.timedelta(0, 330)
2629
>>> rfc3339_duration_to_delta("P1DT3M20S")
2630
datetime.timedelta(1, 200)
2633
# Parsing an RFC 3339 duration with regular expressions is not
2634
# possible - there would have to be multiple places for the same
2635
# values, like seconds. The current code, while more esoteric, is
2636
# cleaner without depending on a parsing library. If Python had a
2637
# built-in library for parsing we would use it, but we'd like to
2638
# avoid excessive use of external libraries.
2640
# New type for defining tokens, syntax, and semantics all-in-one
2641
Token = collections.namedtuple("Token", (
2642
"regexp", # To match token; if "value" is not None, must have
2643
# a "group" containing digits
2644
"value", # datetime.timedelta or None
2645
"followers")) # Tokens valid after this token
2646
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2647
# the "duration" ABNF definition in RFC 3339, Appendix A.
2648
token_end = Token(re.compile(r"$"), None, frozenset())
2649
token_second = Token(re.compile(r"(\d+)S"),
2650
datetime.timedelta(seconds=1),
2651
frozenset((token_end, )))
2652
token_minute = Token(re.compile(r"(\d+)M"),
2653
datetime.timedelta(minutes=1),
2654
frozenset((token_second, token_end)))
2655
token_hour = Token(re.compile(r"(\d+)H"),
2656
datetime.timedelta(hours=1),
2657
frozenset((token_minute, token_end)))
2658
token_time = Token(re.compile(r"T"),
2660
frozenset((token_hour, token_minute,
2662
token_day = Token(re.compile(r"(\d+)D"),
2663
datetime.timedelta(days=1),
2664
frozenset((token_time, token_end)))
2665
token_month = Token(re.compile(r"(\d+)M"),
2666
datetime.timedelta(weeks=4),
2667
frozenset((token_day, token_end)))
2668
token_year = Token(re.compile(r"(\d+)Y"),
2669
datetime.timedelta(weeks=52),
2670
frozenset((token_month, token_end)))
2671
token_week = Token(re.compile(r"(\d+)W"),
2672
datetime.timedelta(weeks=1),
2673
frozenset((token_end, )))
2674
token_duration = Token(re.compile(r"P"), None,
2675
frozenset((token_year, token_month,
2676
token_day, token_time,
2678
# Define starting values
2679
value = datetime.timedelta() # Value so far
2681
followers = frozenset((token_duration, )) # Following valid tokens
2682
s = duration # String left to parse
2683
# Loop until end token is found
2684
while found_token is not token_end:
2685
# Search for any currently valid tokens
2686
for token in followers:
2687
match = token.regexp.match(s)
2688
if match is not None:
2690
if token.value is not None:
2691
# Value found, parse digits
2692
factor = int(match.group(1), 10)
2693
# Add to value so far
2694
value += factor * token.value
2695
# Strip token from string
2696
s = token.regexp.sub("", s, 1)
2699
# Set valid next tokens
2700
followers = found_token.followers
2703
# No currently valid tokens were found
2704
raise ValueError("Invalid RFC 3339 duration: {!r}"
1503
2710
def string_to_delta(interval):
1504
2711
"""Parse a string and return a datetime.timedelta
1506
>>> string_to_delta(u'7d')
2713
>>> string_to_delta('7d')
1507
2714
datetime.timedelta(7)
1508
>>> string_to_delta(u'60s')
2715
>>> string_to_delta('60s')
1509
2716
datetime.timedelta(0, 60)
1510
>>> string_to_delta(u'60m')
2717
>>> string_to_delta('60m')
1511
2718
datetime.timedelta(0, 3600)
1512
>>> string_to_delta(u'24h')
2719
>>> string_to_delta('24h')
1513
2720
datetime.timedelta(1)
1514
>>> string_to_delta(u'1w')
2721
>>> string_to_delta('1w')
1515
2722
datetime.timedelta(7)
1516
>>> string_to_delta(u'5m 30s')
2723
>>> string_to_delta('5m 30s')
1517
2724
datetime.timedelta(0, 330)
2728
return rfc3339_duration_to_delta(interval)
1519
2732
timevalue = datetime.timedelta(0)
1520
2733
for s in interval.split():
1522
suffix = unicode(s[-1])
1523
2736
value = int(s[:-1])
1525
2738
delta = datetime.timedelta(value)
1526
elif suffix == u"s":
1527
2740
delta = datetime.timedelta(0, value)
1528
elif suffix == u"m":
1529
2742
delta = datetime.timedelta(0, 0, 0, 0, value)
1530
elif suffix == u"h":
1531
2744
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1532
elif suffix == u"w":
1533
2746
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1535
raise ValueError(u"Unknown suffix %r" % suffix)
1536
except (ValueError, IndexError), e:
1537
raise ValueError(e.message)
2748
raise ValueError("Unknown suffix {!r}".format(suffix))
2749
except IndexError as e:
2750
raise ValueError(*(e.args))
1538
2751
timevalue += delta
1539
2752
return timevalue
1542
def if_nametoindex(interface):
1543
"""Call the C function if_nametoindex(), or equivalent
1545
Note: This function cannot accept a unicode string."""
1546
global if_nametoindex
1548
if_nametoindex = (ctypes.cdll.LoadLibrary
1549
(ctypes.util.find_library(u"c"))
1551
except (OSError, AttributeError):
1552
logger.warning(u"Doing if_nametoindex the hard way")
1553
def if_nametoindex(interface):
1554
"Get an interface index the hard way, i.e. using fcntl()"
1555
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1556
with contextlib.closing(socket.socket()) as s:
1557
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1558
struct.pack(str(u"16s16x"),
1560
interface_index = struct.unpack(str(u"I"),
1562
return interface_index
1563
return if_nametoindex(interface)
1566
2755
def daemon(nochdir = False, noclose = False):
1567
2756
"""See daemon(3). Standard BSD Unix function.
1593
2782
##################################################################
1594
2783
# Parsing of options, both command line and config file
1596
parser = optparse.OptionParser(version = "%%prog %s" % version)
1597
parser.add_option("-i", u"--interface", type=u"string",
1598
metavar="IF", help=u"Bind to interface IF")
1599
parser.add_option("-a", u"--address", type=u"string",
1600
help=u"Address to listen for requests on")
1601
parser.add_option("-p", u"--port", type=u"int",
1602
help=u"Port number to receive requests on")
1603
parser.add_option("--check", action=u"store_true",
1604
help=u"Run self-test")
1605
parser.add_option("--debug", action=u"store_true",
1606
help=u"Debug mode; run in foreground and log to"
1608
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1609
u" priority string (see GnuTLS documentation)")
1610
parser.add_option("--servicename", type=u"string",
1611
metavar=u"NAME", help=u"Zeroconf service name")
1612
parser.add_option("--configdir", type=u"string",
1613
default=u"/etc/mandos", metavar=u"DIR",
1614
help=u"Directory to search for configuration"
1616
parser.add_option("--no-dbus", action=u"store_false",
1617
dest=u"use_dbus", help=u"Do not provide D-Bus"
1618
u" system bus interface")
1619
parser.add_option("--no-ipv6", action=u"store_false",
1620
dest=u"use_ipv6", help=u"Do not use IPv6")
1621
options = parser.parse_args()[0]
2785
parser = argparse.ArgumentParser()
2786
parser.add_argument("-v", "--version", action="version",
2787
version = "%(prog)s {}".format(version),
2788
help="show version number and exit")
2789
parser.add_argument("-i", "--interface", metavar="IF",
2790
help="Bind to interface IF")
2791
parser.add_argument("-a", "--address",
2792
help="Address to listen for requests on")
2793
parser.add_argument("-p", "--port", type=int,
2794
help="Port number to receive requests on")
2795
parser.add_argument("--check", action="store_true",
2796
help="Run self-test")
2797
parser.add_argument("--debug", action="store_true",
2798
help="Debug mode; run in foreground and log"
2799
" to terminal", default=None)
2800
parser.add_argument("--debuglevel", metavar="LEVEL",
2801
help="Debug level for stdout output")
2802
parser.add_argument("--priority", help="GnuTLS"
2803
" priority string (see GnuTLS documentation)")
2804
parser.add_argument("--servicename",
2805
metavar="NAME", help="Zeroconf service name")
2806
parser.add_argument("--configdir",
2807
default="/etc/mandos", metavar="DIR",
2808
help="Directory to search for configuration"
2810
parser.add_argument("--no-dbus", action="store_false",
2811
dest="use_dbus", help="Do not provide D-Bus"
2812
" system bus interface", default=None)
2813
parser.add_argument("--no-ipv6", action="store_false",
2814
dest="use_ipv6", help="Do not use IPv6",
2816
parser.add_argument("--no-restore", action="store_false",
2817
dest="restore", help="Do not restore stored"
2818
" state", default=None)
2819
parser.add_argument("--socket", type=int,
2820
help="Specify a file descriptor to a network"
2821
" socket to use instead of creating one")
2822
parser.add_argument("--statedir", metavar="DIR",
2823
help="Directory to save/restore state in")
2824
parser.add_argument("--foreground", action="store_true",
2825
help="Run in foreground", default=None)
2826
parser.add_argument("--no-zeroconf", action="store_false",
2827
dest="zeroconf", help="Do not use Zeroconf",
2830
options = parser.parse_args()
1623
2832
if options.check:
2834
fail_count, test_count = doctest.testmod()
2835
sys.exit(os.EX_OK if fail_count == 0 else 1)
1628
2837
# Default values for config file for server-global settings
1629
server_defaults = { u"interface": u"",
1634
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1635
u"servicename": u"Mandos",
1636
u"use_dbus": u"True",
1637
u"use_ipv6": u"True",
2838
server_defaults = { "interface": "",
2843
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2844
":+SIGN-DSA-SHA256",
2845
"servicename": "Mandos",
2851
"statedir": "/var/lib/mandos",
2852
"foreground": "False",
1640
2856
# Parse config file for server-global settings
1641
2857
server_config = configparser.SafeConfigParser(server_defaults)
1642
2858
del server_defaults
1643
server_config.read(os.path.join(options.configdir,
2859
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1645
2860
# Convert the SafeConfigParser object to a dict
1646
2861
server_settings = server_config.defaults()
1647
2862
# Use the appropriate methods on the non-string config options
1648
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1649
server_settings[option] = server_config.getboolean(u"DEFAULT",
2863
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2864
server_settings[option] = server_config.getboolean("DEFAULT",
1651
2866
if server_settings["port"]:
1652
server_settings["port"] = server_config.getint(u"DEFAULT",
2867
server_settings["port"] = server_config.getint("DEFAULT",
2869
if server_settings["socket"]:
2870
server_settings["socket"] = server_config.getint("DEFAULT",
2872
# Later, stdin will, and stdout and stderr might, be dup'ed
2873
# over with an opened os.devnull. But we don't want this to
2874
# happen with a supplied network socket.
2875
if 0 <= server_settings["socket"] <= 2:
2876
server_settings["socket"] = os.dup(server_settings
1654
2878
del server_config
1656
2880
# Override the settings from the config file with command line
1657
2881
# options, if set.
1658
for option in (u"interface", u"address", u"port", u"debug",
1659
u"priority", u"servicename", u"configdir",
1660
u"use_dbus", u"use_ipv6"):
2882
for option in ("interface", "address", "port", "debug",
2883
"priority", "servicename", "configdir", "use_dbus",
2884
"use_ipv6", "debuglevel", "restore", "statedir",
2885
"socket", "foreground", "zeroconf"):
1661
2886
value = getattr(options, option)
1662
2887
if value is not None:
1663
2888
server_settings[option] = value
1665
2890
# Force all strings to be unicode
1666
2891
for option in server_settings.keys():
1667
if type(server_settings[option]) is str:
1668
server_settings[option] = unicode(server_settings[option])
2892
if isinstance(server_settings[option], bytes):
2893
server_settings[option] = (server_settings[option]
2895
# Force all boolean options to be boolean
2896
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2897
"foreground", "zeroconf"):
2898
server_settings[option] = bool(server_settings[option])
2899
# Debug implies foreground
2900
if server_settings["debug"]:
2901
server_settings["foreground"] = True
1669
2902
# Now we have our good server settings in "server_settings"
1671
2904
##################################################################
2906
if (not server_settings["zeroconf"]
2907
and not (server_settings["port"]
2908
or server_settings["socket"] != "")):
2909
parser.error("Needs port or socket to work without Zeroconf")
1673
2911
# For convenience
1674
debug = server_settings[u"debug"]
1675
use_dbus = server_settings[u"use_dbus"]
1676
use_ipv6 = server_settings[u"use_ipv6"]
1679
syslogger.setLevel(logging.WARNING)
1680
console.setLevel(logging.WARNING)
1682
if server_settings[u"servicename"] != u"Mandos":
1683
syslogger.setFormatter(logging.Formatter
1684
(u'Mandos (%s) [%%(process)d]:'
1685
u' %%(levelname)s: %%(message)s'
1686
% server_settings[u"servicename"]))
2912
debug = server_settings["debug"]
2913
debuglevel = server_settings["debuglevel"]
2914
use_dbus = server_settings["use_dbus"]
2915
use_ipv6 = server_settings["use_ipv6"]
2916
stored_state_path = os.path.join(server_settings["statedir"],
2918
foreground = server_settings["foreground"]
2919
zeroconf = server_settings["zeroconf"]
2922
initlogger(debug, logging.DEBUG)
2927
level = getattr(logging, debuglevel.upper())
2928
initlogger(debug, level)
2930
if server_settings["servicename"] != "Mandos":
2931
syslogger.setFormatter(
2932
logging.Formatter('Mandos ({}) [%(process)d]:'
2933
' %(levelname)s: %(message)s'.format(
2934
server_settings["servicename"])))
1688
2936
# Parse config file with clients
1689
client_defaults = { u"timeout": u"1h",
1691
u"checker": u"fping -q -- %%(host)s",
1693
u"approved_delay": u"5m",
1694
u"approved_duration": u"1s",
1696
client_config = configparser.SafeConfigParser(client_defaults)
1697
client_config.read(os.path.join(server_settings[u"configdir"],
2937
client_config = configparser.SafeConfigParser(Client
2939
client_config.read(os.path.join(server_settings["configdir"],
1700
2942
global mandos_dbus_service
1701
2943
mandos_dbus_service = None
1703
tcp_server = MandosServer((server_settings[u"address"],
1704
server_settings[u"port"]),
1706
interface=server_settings[u"interface"],
1709
server_settings[u"priority"],
1711
pidfilename = u"/var/run/mandos.pid"
1713
pidfile = open(pidfilename, u"w")
1715
logger.error(u"Could not open file %r", pidfilename)
2946
if server_settings["socket"] != "":
2947
socketfd = server_settings["socket"]
2948
tcp_server = MandosServer(
2949
(server_settings["address"], server_settings["port"]),
2951
interface=(server_settings["interface"] or None),
2953
gnutls_priority=server_settings["priority"],
2957
pidfilename = "/run/mandos.pid"
2958
if not os.path.isdir("/run/."):
2959
pidfilename = "/var/run/mandos.pid"
2962
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2963
except IOError as e:
2964
logger.error("Could not open file %r", pidfilename,
1718
uid = pwd.getpwnam(u"_mandos").pw_uid
1719
gid = pwd.getpwnam(u"_mandos").pw_gid
2967
for name, group in (("_mandos", "_mandos"),
2968
("mandos", "mandos"),
2969
("nobody", "nogroup")):
1722
uid = pwd.getpwnam(u"mandos").pw_uid
1723
gid = pwd.getpwnam(u"mandos").pw_gid
2971
uid = pwd.getpwnam(name).pw_uid
2972
gid = pwd.getpwnam(group).pw_gid
1724
2974
except KeyError:
1726
uid = pwd.getpwnam(u"nobody").pw_uid
1727
gid = pwd.getpwnam(u"nobody").pw_gid
1734
except OSError, error:
1735
if error[0] != errno.EPERM:
2983
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2985
except OSError as error:
2986
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2987
.format(uid, gid, os.strerror(error.errno)))
2988
if error.errno != errno.EPERM:
1738
# Enable all possible GnuTLS debugging
2992
# Enable all possible GnuTLS debugging
1740
2994
# "Use a log level over 10 to enable all debugging options."
1741
2995
# - GnuTLS manual
1742
gnutls.library.functions.gnutls_global_set_log_level(11)
2996
gnutls.global_set_log_level(11)
1744
@gnutls.library.types.gnutls_log_func
1745
2999
def debug_gnutls(level, string):
1746
logger.debug(u"GnuTLS: %s", string[:-1])
1748
(gnutls.library.functions
1749
.gnutls_global_set_log_function(debug_gnutls))
3000
logger.debug("GnuTLS: %s", string[:-1])
3002
gnutls.global_set_log_function(debug_gnutls)
3004
# Redirect stdin so all checkers get /dev/null
3005
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3006
os.dup2(null, sys.stdin.fileno())
3010
# Need to fork before connecting to D-Bus
3012
# Close all input and output, do double fork, etc.
3015
# multiprocessing will use threads, so before we use GLib we need
3016
# to inform GLib that threads will be used.
1751
3019
global main_loop
1752
3020
# From the Avahi example code
1753
DBusGMainLoop(set_as_default=True )
1754
main_loop = gobject.MainLoop()
3021
DBusGMainLoop(set_as_default=True)
3022
main_loop = GLib.MainLoop()
1755
3023
bus = dbus.SystemBus()
1756
3024
# End of Avahi example code
1759
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1760
bus, do_not_queue=True)
1761
except dbus.exceptions.NameExistsException, e:
1762
logger.error(unicode(e) + u", disabling D-Bus")
3027
bus_name = dbus.service.BusName("se.recompile.Mandos",
3030
old_bus_name = dbus.service.BusName(
3031
"se.bsnet.fukt.Mandos", bus,
3033
except dbus.exceptions.DBusException as e:
3034
logger.error("Disabling D-Bus:", exc_info=e)
1763
3035
use_dbus = False
1764
server_settings[u"use_dbus"] = False
3036
server_settings["use_dbus"] = False
1765
3037
tcp_server.use_dbus = False
1766
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1767
service = AvahiService(name = server_settings[u"servicename"],
1768
servicetype = u"_mandos._tcp",
1769
protocol = protocol, bus = bus)
1770
if server_settings["interface"]:
1771
service.interface = (if_nametoindex
1772
(str(server_settings[u"interface"])))
3039
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3040
service = AvahiServiceToSyslog(
3041
name = server_settings["servicename"],
3042
servicetype = "_mandos._tcp",
3043
protocol = protocol,
3045
if server_settings["interface"]:
3046
service.interface = if_nametoindex(
3047
server_settings["interface"].encode("utf-8"))
1774
3049
global multiprocessing_manager
1775
3050
multiprocessing_manager = multiprocessing.Manager()
1777
3052
client_class = Client
1779
3054
client_class = functools.partial(ClientDBus, bus = bus)
1780
def client_config_items(config, section):
1781
special_settings = {
1782
"approved_by_default":
1783
lambda: config.getboolean(section,
1784
"approved_by_default"),
1786
for name, value in config.items(section):
3056
client_settings = Client.config_parser(client_config)
3057
old_client_settings = {}
3060
# This is used to redirect stdout and stderr for checker processes
3062
wnull = open(os.devnull, "w") # A writable /dev/null
3063
# Only used if server is running in foreground but not in debug
3065
if debug or not foreground:
3068
# Get client data and settings from last running state.
3069
if server_settings["restore"]:
3071
with open(stored_state_path, "rb") as stored_state:
3072
if sys.version_info.major == 2:
3073
clients_data, old_client_settings = pickle.load(
3076
bytes_clients_data, bytes_old_client_settings = (
3077
pickle.load(stored_state, encoding = "bytes"))
3078
### Fix bytes to strings
3081
clients_data = { (key.decode("utf-8")
3082
if isinstance(key, bytes)
3085
bytes_clients_data.items() }
3086
del bytes_clients_data
3087
for key in clients_data:
3088
value = { (k.decode("utf-8")
3089
if isinstance(k, bytes) else k): v
3091
clients_data[key].items() }
3092
clients_data[key] = value
3094
value["client_structure"] = [
3096
if isinstance(s, bytes)
3098
value["client_structure"] ]
3100
for k in ("name", "host"):
3101
if isinstance(value[k], bytes):
3102
value[k] = value[k].decode("utf-8")
3103
## old_client_settings
3105
old_client_settings = {
3106
(key.decode("utf-8")
3107
if isinstance(key, bytes)
3110
bytes_old_client_settings.items() }
3111
del bytes_old_client_settings
3113
for value in old_client_settings.values():
3114
if isinstance(value["host"], bytes):
3115
value["host"] = (value["host"]
3117
os.remove(stored_state_path)
3118
except IOError as e:
3119
if e.errno == errno.ENOENT:
3120
logger.warning("Could not load persistent state:"
3121
" {}".format(os.strerror(e.errno)))
3123
logger.critical("Could not load persistent state:",
3126
except EOFError as e:
3127
logger.warning("Could not load persistent state: "
3131
with PGPEngine() as pgp:
3132
for client_name, client in clients_data.items():
3133
# Skip removed clients
3134
if client_name not in client_settings:
3137
# Decide which value to use after restoring saved state.
3138
# We have three different values: Old config file,
3139
# new config file, and saved state.
3140
# New config value takes precedence if it differs from old
3141
# config value, otherwise use saved state.
3142
for name, value in client_settings[client_name].items():
3144
# For each value in new config, check if it
3145
# differs from the old config value (Except for
3146
# the "secret" attribute)
3147
if (name != "secret"
3149
old_client_settings[client_name][name])):
3150
client[name] = value
3154
# Clients who has passed its expire date can still be
3155
# enabled if its last checker was successful. A Client
3156
# whose checker succeeded before we stored its state is
3157
# assumed to have successfully run all checkers during
3159
if client["enabled"]:
3160
if datetime.datetime.utcnow() >= client["expires"]:
3161
if not client["last_checked_ok"]:
3163
"disabling client {} - Client never "
3164
"performed a successful checker".format(
3166
client["enabled"] = False
3167
elif client["last_checker_status"] != 0:
3169
"disabling client {} - Client last"
3170
" checker failed with error code"
3173
client["last_checker_status"]))
3174
client["enabled"] = False
3176
client["expires"] = (
3177
datetime.datetime.utcnow()
3178
+ client["timeout"])
3179
logger.debug("Last checker succeeded,"
3180
" keeping {} enabled".format(
1788
yield (name, special_settings[name]())
1792
tcp_server.clients.update(set(
1793
client_class(name = section,
1794
config= dict(client_config_items(
1795
client_config, section)))
1796
for section in client_config.sections()))
3183
client["secret"] = pgp.decrypt(
3184
client["encrypted_secret"],
3185
client_settings[client_name]["secret"])
3187
# If decryption fails, we use secret from new settings
3188
logger.debug("Failed to decrypt {} old secret".format(
3190
client["secret"] = (client_settings[client_name]
3193
# Add/remove clients based on new changes made to config
3194
for client_name in (set(old_client_settings)
3195
- set(client_settings)):
3196
del clients_data[client_name]
3197
for client_name in (set(client_settings)
3198
- set(old_client_settings)):
3199
clients_data[client_name] = client_settings[client_name]
3201
# Create all client objects
3202
for client_name, client in clients_data.items():
3203
tcp_server.clients[client_name] = client_class(
3206
server_settings = server_settings)
1797
3208
if not tcp_server.clients:
1798
logger.warning(u"No clients defined")
1801
# Redirect stdin so all checkers get /dev/null
1802
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1803
os.dup2(null, sys.stdin.fileno())
1807
# No console logging
1808
logger.removeHandler(console)
1809
# Close all input and output, do double fork, etc.
3209
logger.warning("No clients defined")
3212
if pidfile is not None:
1814
3213
pid = os.getpid()
1815
pidfile.write(str(pid) + "\n")
3216
print(pid, file=pidfile)
3218
logger.error("Could not write to file %r with PID %d",
1818
logger.error(u"Could not write to file %r with PID %d",
1821
# "pidfile" was never created
1826
signal.signal(signal.SIGINT, signal.SIG_IGN)
1827
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1828
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3223
for termsig in (signal.SIGHUP, signal.SIGTERM):
3224
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3225
lambda: main_loop.quit() and False)
1831
class MandosDBusService(dbus.service.Object):
3229
@alternate_dbus_interfaces(
3230
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3231
class MandosDBusService(DBusObjectWithObjectManager):
1832
3232
"""A D-Bus proxy object"""
1833
3234
def __init__(self):
1834
dbus.service.Object.__init__(self, bus, u"/")
1835
_interface = u"se.bsnet.fukt.Mandos"
1837
@dbus.service.signal(_interface, signature=u"o")
3235
dbus.service.Object.__init__(self, bus, "/")
3237
_interface = "se.recompile.Mandos"
3239
@dbus.service.signal(_interface, signature="o")
1838
3240
def ClientAdded(self, objpath):
1842
@dbus.service.signal(_interface, signature=u"ss")
3244
@dbus.service.signal(_interface, signature="ss")
1843
3245
def ClientNotFound(self, fingerprint, address):
1847
@dbus.service.signal(_interface, signature=u"os")
3249
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3251
@dbus.service.signal(_interface, signature="os")
1848
3252
def ClientRemoved(self, objpath, name):
1852
@dbus.service.method(_interface, out_signature=u"ao")
3256
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3258
@dbus.service.method(_interface, out_signature="ao")
1853
3259
def GetAllClients(self):
1855
return dbus.Array(c.dbus_object_path
1856
for c in tcp_server.clients)
3261
return dbus.Array(c.dbus_object_path for c in
3262
tcp_server.clients.values())
3264
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1858
3266
@dbus.service.method(_interface,
1859
out_signature=u"a{oa{sv}}")
3267
out_signature="a{oa{sv}}")
1860
3268
def GetAllClientsWithProperties(self):
1862
3270
return dbus.Dictionary(
1863
((c.dbus_object_path, c.GetAll(u""))
1864
for c in tcp_server.clients),
1865
signature=u"oa{sv}")
3271
{ c.dbus_object_path: c.GetAll(
3272
"se.recompile.Mandos.Client")
3273
for c in tcp_server.clients.values() },
1867
@dbus.service.method(_interface, in_signature=u"o")
3276
@dbus.service.method(_interface, in_signature="o")
1868
3277
def RemoveClient(self, object_path):
1870
for c in tcp_server.clients:
3279
for c in tcp_server.clients.values():
1871
3280
if c.dbus_object_path == object_path:
1872
tcp_server.clients.remove(c)
3281
del tcp_server.clients[c.name]
1873
3282
c.remove_from_connection()
1874
# Don't signal anything except ClientRemoved
3283
# Don't signal the disabling
1875
3284
c.disable(quiet=True)
1877
self.ClientRemoved(object_path, c.name)
3285
# Emit D-Bus signal for removal
3286
self.client_removed_signal(c)
1879
3288
raise KeyError(object_path)
3292
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3293
out_signature = "a{oa{sa{sv}}}")
3294
def GetManagedObjects(self):
3296
return dbus.Dictionary(
3297
{ client.dbus_object_path:
3299
{ interface: client.GetAll(interface)
3301
client._get_all_interface_names()})
3302
for client in tcp_server.clients.values()})
3304
def client_added_signal(self, client):
3305
"""Send the new standard signal and the old signal"""
3307
# New standard signal
3308
self.InterfacesAdded(
3309
client.dbus_object_path,
3311
{ interface: client.GetAll(interface)
3313
client._get_all_interface_names()}))
3315
self.ClientAdded(client.dbus_object_path)
3317
def client_removed_signal(self, client):
3318
"""Send the new standard signal and the old signal"""
3320
# New standard signal
3321
self.InterfacesRemoved(
3322
client.dbus_object_path,
3323
client._get_all_interface_names())
3325
self.ClientRemoved(client.dbus_object_path,
1883
3328
mandos_dbus_service = MandosDBusService()
3330
# Save modules to variables to exempt the modules from being
3331
# unloaded before the function registered with atexit() is run.
3332
mp = multiprocessing
1886
3335
"Cleanup function; run on exit"
3339
mp.active_children()
3341
if not (tcp_server.clients or client_settings):
3344
# Store client before exiting. Secrets are encrypted with key
3345
# based on what config file has. If config file is
3346
# removed/edited, old secret will thus be unrecovable.
3348
with PGPEngine() as pgp:
3349
for client in tcp_server.clients.values():
3350
key = client_settings[client.name]["secret"]
3351
client.encrypted_secret = pgp.encrypt(client.secret,
3355
# A list of attributes that can not be pickled
3357
exclude = { "bus", "changedstate", "secret",
3358
"checker", "server_settings" }
3359
for name, typ in inspect.getmembers(dbus.service
3363
client_dict["encrypted_secret"] = (client
3365
for attr in client.client_structure:
3366
if attr not in exclude:
3367
client_dict[attr] = getattr(client, attr)
3369
clients[client.name] = client_dict
3370
del client_settings[client.name]["secret"]
3373
with tempfile.NamedTemporaryFile(
3377
dir=os.path.dirname(stored_state_path),
3378
delete=False) as stored_state:
3379
pickle.dump((clients, client_settings), stored_state,
3381
tempname = stored_state.name
3382
os.rename(tempname, stored_state_path)
3383
except (IOError, OSError) as e:
3389
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3390
logger.warning("Could not save persistent state: {}"
3391
.format(os.strerror(e.errno)))
3393
logger.warning("Could not save persistent state:",
3397
# Delete all clients, and settings from config
1889
3398
while tcp_server.clients:
1890
client = tcp_server.clients.pop()
3399
name, client = tcp_server.clients.popitem()
1892
3401
client.remove_from_connection()
1893
client.disable_hook = None
1894
# Don't signal anything except ClientRemoved
3402
# Don't signal the disabling
1895
3403
client.disable(quiet=True)
3404
# Emit D-Bus signal for removal
1898
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3406
mandos_dbus_service.client_removed_signal(client)
3407
client_settings.clear()
1901
3409
atexit.register(cleanup)
1903
for client in tcp_server.clients:
3411
for client in tcp_server.clients.values():
1906
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3413
# Emit D-Bus signal for adding
3414
mandos_dbus_service.client_added_signal(client)
3415
# Need to initiate checking of clients
3417
client.init_checker()
1909
3419
tcp_server.enable()
1910
3420
tcp_server.server_activate()
1912
3422
# Find out what port we got
1913
service.port = tcp_server.socket.getsockname()[1]
3424
service.port = tcp_server.socket.getsockname()[1]
1915
logger.info(u"Now listening on address %r, port %d,"
1916
" flowinfo %d, scope_id %d"
1917
% tcp_server.socket.getsockname())
3426
logger.info("Now listening on address %r, port %d,"
3427
" flowinfo %d, scope_id %d",
3428
*tcp_server.socket.getsockname())
1919
logger.info(u"Now listening on address %r, port %d"
1920
% tcp_server.socket.getsockname())
3430
logger.info("Now listening on address %r, port %d",
3431
*tcp_server.socket.getsockname())
1922
3433
#service.interface = tcp_server.socket.getsockname()[3]
1925
# From the Avahi example code
1928
except dbus.exceptions.DBusException, error:
1929
logger.critical(u"DBusException: %s", error)
1932
# End of Avahi example code
1934
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1935
lambda *args, **kwargs:
1936
(tcp_server.handle_request
1937
(*args[2:], **kwargs) or True))
1939
logger.debug(u"Starting main loop")
3437
# From the Avahi example code
3440
except dbus.exceptions.DBusException as error:
3441
logger.critical("D-Bus Exception", exc_info=error)
3444
# End of Avahi example code
3446
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3447
lambda *args, **kwargs:
3448
(tcp_server.handle_request
3449
(*args[2:], **kwargs) or True))
3451
logger.debug("Starting main loop")
1940
3452
main_loop.run()
1941
except AvahiError, error:
1942
logger.critical(u"AvahiError: %s", error)
3453
except AvahiError as error:
3454
logger.critical("Avahi Error", exc_info=error)
1945
3457
except KeyboardInterrupt:
1948
logger.debug(u"Server received KeyboardInterrupt")
1949
logger.debug(u"Server exiting")
3459
print("", file=sys.stderr)
3460
logger.debug("Server received KeyboardInterrupt")
3461
logger.debug("Server exiting")
1950
3462
# Must run before the D-Bus bus name gets deregistered
1953
3466
if __name__ == '__main__':