65
import cPickle as pickle
69
import cPickle as pickle
66
72
import multiprocessing
73
81
import dbus.service
82
from gi.repository import GLib
76
83
from dbus.mainloop.glib import DBusGMainLoop
79
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:
84
93
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
94
except AttributeError:
96
# This is where SO_BINDTODEVICE was up to and including Python
87
98
from IN import SO_BINDTODEVICE
88
99
except ImportError:
89
SO_BINDTODEVICE = None
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:
92
118
stored_state_file = "clients.pickle"
94
120
logger = logging.getLogger()
95
syslogger = (logging.handlers.SysLogHandler
96
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
address = str("/dev/log")))
100
if_nametoindex = (ctypes.cdll.LoadLibrary
101
(ctypes.util.find_library("c"))
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
ctypes.util.find_library("c")).if_nametoindex
103
126
except (OSError, AttributeError):
104
128
def if_nametoindex(interface):
105
129
"Get an interface index the hard way, i.e. using fcntl()"
106
130
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
107
131
with contextlib.closing(socket.socket()) as s:
108
132
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
109
struct.pack(str("16s16x"),
111
interface_index = struct.unpack(str("I"),
133
struct.pack(b"16s16x", interface))
134
interface_index = struct.unpack("I", ifreq[16:20])[0]
113
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__,
116
154
def initlogger(debug, level=logging.WARNING):
117
155
"""init logger and add loglevel"""
158
syslogger = (logging.handlers.SysLogHandler(
159
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
119
161
syslogger.setFormatter(logging.Formatter
120
162
('Mandos [%(process)d]: %(levelname)s:'
122
164
logger.addHandler(syslogger)
125
167
console = logging.StreamHandler()
126
168
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
171
225
os.rmdir(self.tempdir)
172
226
self.tempdir = None
174
228
def password_encode(self, password):
175
229
# Passphrase can not be empty and can not contain newlines or
176
230
# NUL bytes. So we prefix it and hex encode it.
177
return b"mandos" + binascii.hexlify(password)
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"))
179
239
def encrypt(self, data, password):
180
self.gnupg.passphrase = self.password_encode(password)
181
with open(os.devnull, "w") as devnull:
183
proc = self.gnupg.run(['--symmetric'],
184
create_fhs=['stdin', 'stdout'],
185
attach_fhs={'stderr': devnull})
186
with contextlib.closing(proc.handles['stdin']) as f:
188
with contextlib.closing(proc.handles['stdout']) as f:
189
ciphertext = f.read()
193
self.gnupg.passphrase = None
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:
194
255
return ciphertext
196
257
def decrypt(self, data, password):
197
self.gnupg.passphrase = self.password_encode(password)
198
with open(os.devnull, "w") as devnull:
200
proc = self.gnupg.run(['--decrypt'],
201
create_fhs=['stdin', 'stdout'],
202
attach_fhs={'stderr': devnull})
203
with contextlib.closing(proc.handles['stdin']) as f:
205
with contextlib.closing(proc.handles['stdout']) as f:
206
decrypted_plaintext = f.read()
210
self.gnupg.passphrase = None
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:
211
273
return decrypted_plaintext
276
# Pretend that we have an Avahi module
278
"""This isn't so much a class as it is a module-like namespace.
279
It is instantiated once, and simulates having an Avahi module."""
280
IF_UNSPEC = -1 # avahi-common/address.h
281
PROTO_UNSPEC = -1 # avahi-common/address.h
282
PROTO_INET = 0 # avahi-common/address.h
283
PROTO_INET6 = 1 # avahi-common/address.h
284
DBUS_NAME = "org.freedesktop.Avahi"
285
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
286
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
287
DBUS_PATH_SERVER = "/"
289
def string_array_to_txt_array(self, t):
290
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
291
for s in t), signature="ay")
292
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
293
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
294
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
295
SERVER_INVALID = 0 # avahi-common/defs.h
296
SERVER_REGISTERING = 1 # avahi-common/defs.h
297
SERVER_RUNNING = 2 # avahi-common/defs.h
298
SERVER_COLLISION = 3 # avahi-common/defs.h
299
SERVER_FAILURE = 4 # avahi-common/defs.h
214
303
class AvahiError(Exception):
215
304
def __init__(self, value, *args, **kwargs):
216
305
self.value = value
217
super(AvahiError, self).__init__(value, *args, **kwargs)
218
def __unicode__(self):
219
return unicode(repr(self.value))
306
return super(AvahiError, self).__init__(value, *args,
221
310
class AvahiServiceError(AvahiError):
224
314
class AvahiGroupError(AvahiError):
228
318
class AvahiService(object):
229
319
"""An Avahi (Zeroconf) service.
232
322
interface: integer; avahi.IF_UNSPEC or an interface index.
233
323
Used to optionally bind to the specified interface.
234
324
name: string; Example: 'Mandos'
235
325
type: string; Example: '_mandos._tcp'.
236
See <http://www.dns-sd.org/ServiceTypes.html>
326
See <https://www.iana.org/assignments/service-names-port-numbers>
237
327
port: integer; what port to announce
238
328
TXT: list of strings; TXT record for the service
239
329
domain: string; Domain to publish on, default to .local if empty.
376
488
follow_name_owner_changes=True),
377
489
avahi.DBUS_INTERFACE_SERVER)
378
490
self.server.connect_to_signal("StateChanged",
379
self.server_state_changed)
491
self.server_state_changed)
380
492
self.server_state_changed(self.server.GetState())
382
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
384
497
"""Add the new name to the syslog messages"""
385
ret = AvahiService.rename(self)
386
syslogger.setFormatter(logging.Formatter
387
('Mandos ({0}) [%(process)d]:'
388
' %(levelname)s: %(message)s'
498
ret = AvahiService.rename(self, *args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
392
def timedelta_to_milliseconds(td):
393
"Convert a datetime.timedelta() to milliseconds"
394
return ((td.days * 24 * 60 * 60 * 1000)
395
+ (td.seconds * 1000)
396
+ (td.microseconds // 1000))
505
# Pretend that we have a GnuTLS module
506
class GnuTLS(object):
507
"""This isn't so much a class as it is a module-like namespace.
508
It is instantiated once, and simulates having a GnuTLS module."""
510
library = ctypes.util.find_library("gnutls")
512
library = ctypes.util.find_library("gnutls-deb0")
513
_library = ctypes.cdll.LoadLibrary(library)
515
_need_version = b"3.3.0"
518
# Need to use "self" here, since this method is called before
519
# the assignment to the "gnutls" global variable happens.
520
if self.check_version(self._need_version) is None:
521
raise self.Error("Needs GnuTLS {} or later"
522
.format(self._need_version))
524
# Unless otherwise indicated, the constants and types below are
525
# all from the gnutls/gnutls.h C header file.
535
E_NO_CERTIFICATE_FOUND = -49
536
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
539
class session_int(ctypes.Structure):
541
session_t = ctypes.POINTER(session_int)
543
class certificate_credentials_st(ctypes.Structure):
545
certificate_credentials_t = ctypes.POINTER(
546
certificate_credentials_st)
547
certificate_type_t = ctypes.c_int
549
class datum_t(ctypes.Structure):
550
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
551
('size', ctypes.c_uint)]
553
class openpgp_crt_int(ctypes.Structure):
555
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
556
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
557
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
558
credentials_type_t = ctypes.c_int
559
transport_ptr_t = ctypes.c_void_p
560
close_request_t = ctypes.c_int
563
class Error(Exception):
564
# We need to use the class name "GnuTLS" here, since this
565
# exception might be raised from within GnuTLS.__init__,
566
# which is called before the assignment to the "gnutls"
567
# global variable has happened.
568
def __init__(self, message=None, code=None, args=()):
569
# Default usage is by a message string, but if a return
570
# code is passed, convert it to a string with
573
if message is None and code is not None:
574
message = GnuTLS.strerror(code)
575
return super(GnuTLS.Error, self).__init__(
578
class CertificateSecurityError(Error):
582
class Credentials(object):
584
self._c_object = gnutls.certificate_credentials_t()
585
gnutls.certificate_allocate_credentials(
586
ctypes.byref(self._c_object))
587
self.type = gnutls.CRD_CERTIFICATE
590
gnutls.certificate_free_credentials(self._c_object)
592
class ClientSession(object):
593
def __init__(self, socket, credentials=None):
594
self._c_object = gnutls.session_t()
595
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
596
gnutls.set_default_priority(self._c_object)
597
gnutls.transport_set_ptr(self._c_object, socket.fileno())
598
gnutls.handshake_set_private_extensions(self._c_object,
601
if credentials is None:
602
credentials = gnutls.Credentials()
603
gnutls.credentials_set(self._c_object, credentials.type,
604
ctypes.cast(credentials._c_object,
606
self.credentials = credentials
609
gnutls.deinit(self._c_object)
612
return gnutls.handshake(self._c_object)
614
def send(self, data):
618
data_len -= gnutls.record_send(self._c_object,
623
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
625
# Error handling functions
626
def _error_code(result):
627
"""A function to raise exceptions on errors, suitable
628
for the 'restype' attribute on ctypes functions"""
631
if result == gnutls.E_NO_CERTIFICATE_FOUND:
632
raise gnutls.CertificateSecurityError(code=result)
633
raise gnutls.Error(code=result)
635
def _retry_on_error(result, func, arguments):
636
"""A function to retry on some errors, suitable
637
for the 'errcheck' attribute on ctypes functions"""
639
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
640
return _error_code(result)
641
result = func(*arguments)
644
# Unless otherwise indicated, the function declarations below are
645
# all from the gnutls/gnutls.h C header file.
648
priority_set_direct = _library.gnutls_priority_set_direct
649
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
650
ctypes.POINTER(ctypes.c_char_p)]
651
priority_set_direct.restype = _error_code
653
init = _library.gnutls_init
654
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
655
init.restype = _error_code
657
set_default_priority = _library.gnutls_set_default_priority
658
set_default_priority.argtypes = [session_t]
659
set_default_priority.restype = _error_code
661
record_send = _library.gnutls_record_send
662
record_send.argtypes = [session_t, ctypes.c_void_p,
664
record_send.restype = ctypes.c_ssize_t
665
record_send.errcheck = _retry_on_error
667
certificate_allocate_credentials = (
668
_library.gnutls_certificate_allocate_credentials)
669
certificate_allocate_credentials.argtypes = [
670
ctypes.POINTER(certificate_credentials_t)]
671
certificate_allocate_credentials.restype = _error_code
673
certificate_free_credentials = (
674
_library.gnutls_certificate_free_credentials)
675
certificate_free_credentials.argtypes = [
676
certificate_credentials_t]
677
certificate_free_credentials.restype = None
679
handshake_set_private_extensions = (
680
_library.gnutls_handshake_set_private_extensions)
681
handshake_set_private_extensions.argtypes = [session_t,
683
handshake_set_private_extensions.restype = None
685
credentials_set = _library.gnutls_credentials_set
686
credentials_set.argtypes = [session_t, credentials_type_t,
688
credentials_set.restype = _error_code
690
strerror = _library.gnutls_strerror
691
strerror.argtypes = [ctypes.c_int]
692
strerror.restype = ctypes.c_char_p
694
certificate_type_get = _library.gnutls_certificate_type_get
695
certificate_type_get.argtypes = [session_t]
696
certificate_type_get.restype = _error_code
698
certificate_get_peers = _library.gnutls_certificate_get_peers
699
certificate_get_peers.argtypes = [session_t,
700
ctypes.POINTER(ctypes.c_uint)]
701
certificate_get_peers.restype = ctypes.POINTER(datum_t)
703
global_set_log_level = _library.gnutls_global_set_log_level
704
global_set_log_level.argtypes = [ctypes.c_int]
705
global_set_log_level.restype = None
707
global_set_log_function = _library.gnutls_global_set_log_function
708
global_set_log_function.argtypes = [log_func]
709
global_set_log_function.restype = None
711
deinit = _library.gnutls_deinit
712
deinit.argtypes = [session_t]
713
deinit.restype = None
715
handshake = _library.gnutls_handshake
716
handshake.argtypes = [session_t]
717
handshake.restype = _error_code
718
handshake.errcheck = _retry_on_error
720
transport_set_ptr = _library.gnutls_transport_set_ptr
721
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
722
transport_set_ptr.restype = None
724
bye = _library.gnutls_bye
725
bye.argtypes = [session_t, close_request_t]
726
bye.restype = _error_code
727
bye.errcheck = _retry_on_error
729
check_version = _library.gnutls_check_version
730
check_version.argtypes = [ctypes.c_char_p]
731
check_version.restype = ctypes.c_char_p
733
# All the function declarations below are from gnutls/openpgp.h
735
openpgp_crt_init = _library.gnutls_openpgp_crt_init
736
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
737
openpgp_crt_init.restype = _error_code
739
openpgp_crt_import = _library.gnutls_openpgp_crt_import
740
openpgp_crt_import.argtypes = [openpgp_crt_t,
741
ctypes.POINTER(datum_t),
743
openpgp_crt_import.restype = _error_code
745
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
746
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
747
ctypes.POINTER(ctypes.c_uint)]
748
openpgp_crt_verify_self.restype = _error_code
750
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
751
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
752
openpgp_crt_deinit.restype = None
754
openpgp_crt_get_fingerprint = (
755
_library.gnutls_openpgp_crt_get_fingerprint)
756
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
760
openpgp_crt_get_fingerprint.restype = _error_code
762
# Remove non-public functions
763
del _error_code, _retry_on_error
764
# Create the global "gnutls" object, simulating a module
768
def call_pipe(connection, # : multiprocessing.Connection
769
func, *args, **kwargs):
770
"""This function is meant to be called by multiprocessing.Process
772
This function runs func(*args, **kwargs), and writes the resulting
773
return value on the provided multiprocessing.Connection.
775
connection.send(func(*args, **kwargs))
398
779
class Client(object):
399
780
"""A representation of a client host served by this server.
402
783
approved: bool(); 'None' if not yet approved/disapproved
403
784
approval_delay: datetime.timedelta(); Time to wait for approval
436
819
runtime_expansions: Allowed attributes for runtime expansion.
437
820
expires: datetime.datetime(); time (UTC) when a client will be
438
821
disabled, or None
822
server_settings: The server_settings dict from main()
441
825
runtime_expansions = ("approval_delay", "approval_duration",
442
"created", "enabled", "fingerprint",
443
"host", "interval", "last_checked_ok",
826
"created", "enabled", "expires",
827
"fingerprint", "host", "interval",
828
"last_approval_request", "last_checked_ok",
444
829
"last_enabled", "name", "timeout")
445
client_defaults = { "timeout": "5m",
446
"extended_timeout": "15m",
448
"checker": "fping -q -- %%(host)s",
450
"approval_delay": "0s",
451
"approval_duration": "1s",
452
"approved_by_default": "True",
456
def timeout_milliseconds(self):
457
"Return the 'timeout' attribute in milliseconds"
458
return timedelta_to_milliseconds(self.timeout)
460
def extended_timeout_milliseconds(self):
461
"Return the 'extended_timeout' attribute in milliseconds"
462
return timedelta_to_milliseconds(self.extended_timeout)
464
def interval_milliseconds(self):
465
"Return the 'interval' attribute in milliseconds"
466
return timedelta_to_milliseconds(self.interval)
468
def approval_delay_milliseconds(self):
469
return timedelta_to_milliseconds(self.approval_delay)
832
"extended_timeout": "PT15M",
834
"checker": "fping -q -- %%(host)s",
836
"approval_delay": "PT0S",
837
"approval_duration": "PT1S",
838
"approved_by_default": "True",
472
843
def config_parser(config):
473
844
"""Construct a new dict of client settings of this form:
547
923
self.current_checker_command = None
548
924
self.approved = None
549
925
self.approvals_pending = 0
550
self.changedstate = (multiprocessing_manager
551
.Condition(multiprocessing_manager
553
self.client_structure = [attr for attr in
554
self.__dict__.iterkeys()
926
self.changedstate = multiprocessing_manager.Condition(
927
multiprocessing_manager.Lock())
928
self.client_structure = [attr
929
for attr in self.__dict__.keys()
555
930
if not attr.startswith("_")]
556
931
self.client_structure.append("client_structure")
558
for name, t in inspect.getmembers(type(self),
933
for name, t in inspect.getmembers(
934
type(self), lambda obj: isinstance(obj, property)):
562
935
if not name.startswith("_"):
563
936
self.client_structure.append(name)
565
938
# Send notice to process children that client state has changed
566
939
def send_changedstate(self):
567
940
with self.changedstate:
568
941
self.changedstate.notify_all()
570
943
def enable(self):
571
944
"""Start this client's checker and timeout hooks"""
572
945
if getattr(self, "enabled", False):
573
946
# Already enabled
575
self.send_changedstate()
576
948
self.expires = datetime.datetime.utcnow() + self.timeout
577
949
self.enabled = True
578
950
self.last_enabled = datetime.datetime.utcnow()
579
951
self.init_checker()
952
self.send_changedstate()
581
954
def disable(self, quiet=True):
582
955
"""Disable this client."""
583
956
if not getattr(self, "enabled", False):
586
self.send_changedstate()
588
959
logger.info("Disabling client %s", self.name)
589
if getattr(self, "disable_initiator_tag", False):
590
gobject.source_remove(self.disable_initiator_tag)
960
if getattr(self, "disable_initiator_tag", None) is not None:
961
GLib.source_remove(self.disable_initiator_tag)
591
962
self.disable_initiator_tag = None
592
963
self.expires = None
593
if getattr(self, "checker_initiator_tag", False):
594
gobject.source_remove(self.checker_initiator_tag)
964
if getattr(self, "checker_initiator_tag", None) is not None:
965
GLib.source_remove(self.checker_initiator_tag)
595
966
self.checker_initiator_tag = None
596
967
self.stop_checker()
597
968
self.enabled = False
598
# Do not run this again if called by a gobject.timeout_add
970
self.send_changedstate()
971
# Do not run this again if called by a GLib.timeout_add
601
974
def __del__(self):
604
977
def init_checker(self):
605
978
# Schedule a new checker to be started an 'interval' from now,
606
979
# and every interval from then on.
607
self.checker_initiator_tag = (gobject.timeout_add
608
(self.interval_milliseconds(),
980
if self.checker_initiator_tag is not None:
981
GLib.source_remove(self.checker_initiator_tag)
982
self.checker_initiator_tag = GLib.timeout_add(
983
int(self.interval.total_seconds() * 1000),
610
985
# Schedule a disable() when 'timeout' has passed
611
self.disable_initiator_tag = (gobject.timeout_add
612
(self.timeout_milliseconds(),
986
if self.disable_initiator_tag is not None:
987
GLib.source_remove(self.disable_initiator_tag)
988
self.disable_initiator_tag = GLib.timeout_add(
989
int(self.timeout.total_seconds() * 1000), self.disable)
614
990
# Also start a new checker *right now*.
615
991
self.start_checker()
617
def checker_callback(self, pid, condition, command):
993
def checker_callback(self, source, condition, connection,
618
995
"""The checker has completed, so take appropriate actions."""
619
996
self.checker_callback_tag = None
620
997
self.checker = None
621
if os.WIFEXITED(condition):
622
self.last_checker_status = os.WEXITSTATUS(condition)
998
# Read return code from connection (see call_pipe)
999
returncode = connection.recv()
1003
self.last_checker_status = returncode
1004
self.last_checker_signal = None
623
1005
if self.last_checker_status == 0:
624
1006
logger.info("Checker for %(name)s succeeded",
626
1008
self.checked_ok()
628
logger.info("Checker for %(name)s failed",
1010
logger.info("Checker for %(name)s failed", vars(self))
631
1012
self.last_checker_status = -1
1013
self.last_checker_signal = -returncode
632
1014
logger.warning("Checker for %(name)s crashed?",
635
1018
def checked_ok(self):
636
1019
"""Assert that the client has been seen, alive and well."""
637
1020
self.last_checked_ok = datetime.datetime.utcnow()
638
1021
self.last_checker_status = 0
1022
self.last_checker_signal = None
639
1023
self.bump_timeout()
641
1025
def bump_timeout(self, timeout=None):
642
1026
"""Bump up the timeout for this client."""
643
1027
if timeout is None:
644
1028
timeout = self.timeout
645
1029
if self.disable_initiator_tag is not None:
646
gobject.source_remove(self.disable_initiator_tag)
1030
GLib.source_remove(self.disable_initiator_tag)
1031
self.disable_initiator_tag = None
647
1032
if getattr(self, "enabled", False):
648
self.disable_initiator_tag = (gobject.timeout_add
649
(timedelta_to_milliseconds
650
(timeout), self.disable))
1033
self.disable_initiator_tag = GLib.timeout_add(
1034
int(timeout.total_seconds() * 1000), self.disable)
651
1035
self.expires = datetime.datetime.utcnow() + timeout
653
1037
def need_approval(self):
654
1038
self.last_approval_request = datetime.datetime.utcnow()
656
1040
def start_checker(self):
657
1041
"""Start a new checker subprocess if one is not running.
659
1043
If a checker already exists, leave it running and do
661
1045
# The reason for not killing a running checker is that if we
666
1050
# checkers alone, the checker would have to take more time
667
1051
# than 'timeout' for the client to be disabled, which is as it
670
# If a checker exists, make sure it is not a zombie
672
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
673
except (AttributeError, OSError) as error:
674
if (isinstance(error, OSError)
675
and error.errno != errno.ECHILD):
679
logger.warning("Checker was a zombie")
680
gobject.source_remove(self.checker_callback_tag)
681
self.checker_callback(pid, status,
682
self.current_checker_command)
1054
if self.checker is not None and not self.checker.is_alive():
1055
logger.warning("Checker was not alive; joining")
683
1058
# Start a new checker if needed
684
1059
if self.checker is None:
1060
# Escape attributes for the shell
1062
attr: re.escape(str(getattr(self, attr)))
1063
for attr in self.runtime_expansions}
686
# In case checker_command has exactly one % operator
687
command = self.checker_command % self.host
689
# Escape attributes for the shell
690
escaped_attrs = dict(
692
re.escape(unicode(str(getattr(self, attr, "")),
696
self.runtime_expansions)
699
command = self.checker_command % escaped_attrs
700
except TypeError as error:
701
logger.error('Could not format string "%s"',
702
self.checker_command, exc_info=error)
703
return True # Try again later
1065
command = self.checker_command % escaped_attrs
1066
except TypeError as error:
1067
logger.error('Could not format string "%s"',
1068
self.checker_command,
1070
return True # Try again later
704
1071
self.current_checker_command = command
706
logger.info("Starting checker %r for %s",
708
# We don't need to redirect stdout and stderr, since
709
# in normal mode, that is already done by daemon(),
710
# and in debug mode we don't want to. (Stdin is
711
# always replaced by /dev/null.)
712
self.checker = subprocess.Popen(command,
715
self.checker_callback_tag = (gobject.child_watch_add
717
self.checker_callback,
719
# The checker may have completed before the gobject
720
# watch was added. Check for this.
721
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
723
gobject.source_remove(self.checker_callback_tag)
724
self.checker_callback(pid, status, command)
725
except OSError as error:
726
logger.error("Failed to start subprocess",
728
# Re-run this periodically if run by gobject.timeout_add
1072
logger.info("Starting checker %r for %s", command,
1074
# We don't need to redirect stdout and stderr, since
1075
# in normal mode, that is already done by daemon(),
1076
# and in debug mode we don't want to. (Stdin is
1077
# always replaced by /dev/null.)
1078
# The exception is when not debugging but nevertheless
1079
# running in the foreground; use the previously
1081
popen_args = {"close_fds": True,
1084
if (not self.server_settings["debug"]
1085
and self.server_settings["foreground"]):
1086
popen_args.update({"stdout": wnull,
1088
pipe = multiprocessing.Pipe(duplex=False)
1089
self.checker = multiprocessing.Process(
1091
args=(pipe[1], subprocess.call, command),
1093
self.checker.start()
1094
self.checker_callback_tag = GLib.io_add_watch(
1095
pipe[0].fileno(), GLib.IO_IN,
1096
self.checker_callback, pipe[0], command)
1097
# Re-run this periodically if run by GLib.timeout_add
731
1100
def stop_checker(self):
732
1101
"""Force the checker process, if any, to stop."""
733
1102
if self.checker_callback_tag:
734
gobject.source_remove(self.checker_callback_tag)
1103
GLib.source_remove(self.checker_callback_tag)
735
1104
self.checker_callback_tag = None
736
1105
if getattr(self, "checker", None) is None:
738
1107
logger.debug("Stopping checker for %(name)s", vars(self))
740
self.checker.terminate()
742
#if self.checker.poll() is None:
743
# self.checker.kill()
744
except OSError as error:
745
if error.errno != errno.ESRCH: # No such process
1108
self.checker.terminate()
747
1109
self.checker = None
750
def dbus_service_property(dbus_interface, signature="v",
751
access="readwrite", byte_arrays=False):
1112
def dbus_service_property(dbus_interface,
752
1116
"""Decorators for marking methods of a DBusObjectWithProperties to
753
1117
become properties on the D-Bus.
755
1119
The decorated method will be called with no arguments by "Get"
756
1120
and with one argument by "Set".
758
1122
The parameters, where they are supported, are the same as
759
1123
dbus.service.method, except there is only "signature", since the
760
1124
type from Get() and the type sent to Set() is the same.
836
class DBusObjectWithProperties(dbus.service.Object):
837
"""A D-Bus object with properties.
839
Classes inheriting from this can use the dbus_service_property
840
decorator to expose methods as D-Bus properties. It exposes the
841
standard Get(), Set(), and GetAll() methods on the D-Bus.
1207
class DBusObjectWithAnnotations(dbus.service.Object):
1208
"""A D-Bus object with annotations.
1210
Classes inheriting from this can use the dbus_annotations
1211
decorator to add annotations to methods or signals.
845
1215
def _is_dbus_thing(thing):
846
1216
"""Returns a function testing if an attribute is a D-Bus thing
848
1218
If called like _is_dbus_thing("method") it returns a function
849
1219
suitable for use as predicate to inspect.getmembers().
851
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1221
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
854
1224
def _get_all_dbus_things(self, thing):
855
1225
"""Returns a generator of (name, attribute) pairs
857
return ((getattr(athing.__get__(self), "_dbus_name",
1227
return ((getattr(athing.__get__(self), "_dbus_name", name),
859
1228
athing.__get__(self))
860
1229
for cls in self.__class__.__mro__
861
1230
for name, athing in
862
inspect.getmembers(cls,
863
self._is_dbus_thing(thing)))
1231
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1233
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1235
path_keyword='object_path',
1236
connection_keyword='connection')
1237
def Introspect(self, object_path, connection):
1238
"""Overloading of standard D-Bus method.
1240
Inserts annotation tags on methods and signals.
1242
xmlstring = dbus.service.Object.Introspect(self, object_path,
1245
document = xml.dom.minidom.parseString(xmlstring)
1247
for if_tag in document.getElementsByTagName("interface"):
1248
# Add annotation tags
1249
for typ in ("method", "signal"):
1250
for tag in if_tag.getElementsByTagName(typ):
1252
for name, prop in (self.
1253
_get_all_dbus_things(typ)):
1254
if (name == tag.getAttribute("name")
1255
and prop._dbus_interface
1256
== if_tag.getAttribute("name")):
1257
annots.update(getattr(
1258
prop, "_dbus_annotations", {}))
1259
for name, value in annots.items():
1260
ann_tag = document.createElement(
1262
ann_tag.setAttribute("name", name)
1263
ann_tag.setAttribute("value", value)
1264
tag.appendChild(ann_tag)
1265
# Add interface annotation tags
1266
for annotation, value in dict(
1267
itertools.chain.from_iterable(
1268
annotations().items()
1269
for name, annotations
1270
in self._get_all_dbus_things("interface")
1271
if name == if_tag.getAttribute("name")
1273
ann_tag = document.createElement("annotation")
1274
ann_tag.setAttribute("name", annotation)
1275
ann_tag.setAttribute("value", value)
1276
if_tag.appendChild(ann_tag)
1277
# Fix argument name for the Introspect method itself
1278
if (if_tag.getAttribute("name")
1279
== dbus.INTROSPECTABLE_IFACE):
1280
for cn in if_tag.getElementsByTagName("method"):
1281
if cn.getAttribute("name") == "Introspect":
1282
for arg in cn.getElementsByTagName("arg"):
1283
if (arg.getAttribute("direction")
1285
arg.setAttribute("name",
1287
xmlstring = document.toxml("utf-8")
1289
except (AttributeError, xml.dom.DOMException,
1290
xml.parsers.expat.ExpatError) as error:
1291
logger.error("Failed to override Introspection method",
1296
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1297
"""A D-Bus object with properties.
1299
Classes inheriting from this can use the dbus_service_property
1300
decorator to expose methods as D-Bus properties. It exposes the
1301
standard Get(), Set(), and GetAll() methods on the D-Bus.
865
1304
def _get_dbus_property(self, interface_name, property_name):
866
1305
"""Returns a bound method if one exists which is a D-Bus
867
1306
property with the specified name and interface.
869
for cls in self.__class__.__mro__:
870
for name, value in (inspect.getmembers
872
self._is_dbus_thing("property"))):
1308
for cls in self.__class__.__mro__:
1309
for name, value in inspect.getmembers(
1310
cls, self._is_dbus_thing("property")):
873
1311
if (value._dbus_name == property_name
874
1312
and value._dbus_interface == interface_name):
875
1313
return value.__get__(self)
877
1315
# No such property
878
raise DBusPropertyNotFound(self.dbus_object_path + ":"
879
+ interface_name + "."
882
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1316
raise DBusPropertyNotFound("{}:{}.{}".format(
1317
self.dbus_object_path, interface_name, property_name))
1320
def _get_all_interface_names(cls):
1321
"""Get a sequence of all interfaces supported by an object"""
1322
return (name for name in set(getattr(getattr(x, attr),
1323
"_dbus_interface", None)
1324
for x in (inspect.getmro(cls))
1326
if name is not None)
1328
@dbus.service.method(dbus.PROPERTIES_IFACE,
883
1330
out_signature="v")
884
1331
def Get(self, interface_name, property_name):
885
1332
"""Standard D-Bus property Get() method, see D-Bus standard.
1014
1460
exc_info=error)
1015
1461
return xmlstring
1018
def datetime_to_dbus (dt, variant_level=0):
1464
dbus.OBJECT_MANAGER_IFACE
1465
except AttributeError:
1466
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1469
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1470
"""A D-Bus object with an ObjectManager.
1472
Classes inheriting from this exposes the standard
1473
GetManagedObjects call and the InterfacesAdded and
1474
InterfacesRemoved signals on the standard
1475
"org.freedesktop.DBus.ObjectManager" interface.
1477
Note: No signals are sent automatically; they must be sent
1480
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1481
out_signature="a{oa{sa{sv}}}")
1482
def GetManagedObjects(self):
1483
"""This function must be overridden"""
1484
raise NotImplementedError()
1486
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1487
signature="oa{sa{sv}}")
1488
def InterfacesAdded(self, object_path, interfaces_and_properties):
1491
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1492
def InterfacesRemoved(self, object_path, interfaces):
1495
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1497
path_keyword='object_path',
1498
connection_keyword='connection')
1499
def Introspect(self, object_path, connection):
1500
"""Overloading of standard D-Bus method.
1502
Override return argument name of GetManagedObjects to be
1503
"objpath_interfaces_and_properties"
1505
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1509
document = xml.dom.minidom.parseString(xmlstring)
1511
for if_tag in document.getElementsByTagName("interface"):
1512
# Fix argument name for the GetManagedObjects method
1513
if (if_tag.getAttribute("name")
1514
== dbus.OBJECT_MANAGER_IFACE):
1515
for cn in if_tag.getElementsByTagName("method"):
1516
if (cn.getAttribute("name")
1517
== "GetManagedObjects"):
1518
for arg in cn.getElementsByTagName("arg"):
1519
if (arg.getAttribute("direction")
1523
"objpath_interfaces"
1525
xmlstring = document.toxml("utf-8")
1527
except (AttributeError, xml.dom.DOMException,
1528
xml.parsers.expat.ExpatError) as error:
1529
logger.error("Failed to override Introspection method",
1534
def datetime_to_dbus(dt, variant_level=0):
1019
1535
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1021
return dbus.String("", variant_level = variant_level)
1022
return dbus.String(dt.isoformat(),
1023
variant_level=variant_level)
1537
return dbus.String("", variant_level=variant_level)
1538
return dbus.String(dt.isoformat(), variant_level=variant_level)
1026
1541
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1056
1572
# Ignore non-D-Bus attributes, and D-Bus attributes
1057
1573
# with the wrong interface name
1058
1574
if (not hasattr(attribute, "_dbus_interface")
1059
or not attribute._dbus_interface
1060
.startswith(orig_interface_name)):
1575
or not attribute._dbus_interface.startswith(
1576
orig_interface_name)):
1062
1578
# Create an alternate D-Bus interface name based on
1063
1579
# the current name
1064
alt_interface = (attribute._dbus_interface
1065
.replace(orig_interface_name,
1066
alt_interface_name))
1580
alt_interface = attribute._dbus_interface.replace(
1581
orig_interface_name, alt_interface_name)
1067
1582
interface_names.add(alt_interface)
1068
1583
# Is this a D-Bus signal?
1069
1584
if getattr(attribute, "_dbus_is_signal", False):
1070
# Extract the original non-method function by
1072
nonmethod_func = (dict(
1585
# Extract the original non-method undecorated
1586
# function by black magic
1587
if sys.version_info.major == 2:
1588
nonmethod_func = (dict(
1073
1589
zip(attribute.func_code.co_freevars,
1074
attribute.__closure__))["func"]
1590
attribute.__closure__))
1591
["func"].cell_contents)
1593
nonmethod_func = (dict(
1594
zip(attribute.__code__.co_freevars,
1595
attribute.__closure__))
1596
["func"].cell_contents)
1076
1597
# Create a new, but exactly alike, function
1077
1598
# object, and decorate it to be a new D-Bus signal
1078
1599
# with the alternate D-Bus interface name
1079
new_function = (dbus.service.signal
1081
attribute._dbus_signature)
1082
(types.FunctionType(
1083
nonmethod_func.func_code,
1084
nonmethod_func.func_globals,
1085
nonmethod_func.func_name,
1086
nonmethod_func.func_defaults,
1087
nonmethod_func.func_closure)))
1600
new_function = copy_function(nonmethod_func)
1601
new_function = (dbus.service.signal(
1603
attribute._dbus_signature)(new_function))
1088
1604
# Copy annotations, if any
1090
new_function._dbus_annotations = (
1091
dict(attribute._dbus_annotations))
1606
new_function._dbus_annotations = dict(
1607
attribute._dbus_annotations)
1092
1608
except AttributeError:
1094
1611
# Define a creator of a function to call both the
1095
1612
# original and alternate functions, so both the
1096
1613
# original and alternate signals gets sent when
1186
1696
if interface_names:
1187
1697
# Replace the class with a new subclass of it with
1188
1698
# methods, signals, etc. as created above.
1189
cls = type(b"{0}Alternate".format(cls.__name__),
1699
if sys.version_info.major == 2:
1700
cls = type(b"{}Alternate".format(cls.__name__),
1703
cls = type("{}Alternate".format(cls.__name__),
1195
1710
@alternate_dbus_interfaces({"se.recompile.Mandos":
1196
"se.bsnet.fukt.Mandos"})
1711
"se.bsnet.fukt.Mandos"})
1197
1712
class ClientDBus(Client, DBusObjectWithProperties):
1198
1713
"""A Client class using D-Bus
1201
1716
dbus_object_path: dbus.ObjectPath
1202
1717
bus: dbus.SystemBus()
1205
1720
runtime_expansions = (Client.runtime_expansions
1206
+ ("dbus_object_path",))
1721
+ ("dbus_object_path", ))
1723
_interface = "se.recompile.Mandos.Client"
1208
1725
# dbus.service.Object doesn't use super(), so we can't either.
1210
def __init__(self, bus = None, *args, **kwargs):
1727
def __init__(self, bus=None, *args, **kwargs):
1212
1729
Client.__init__(self, *args, **kwargs)
1213
1730
# Only now, when this client is initialized, can it show up on
1215
client_object_name = unicode(self.name).translate(
1732
client_object_name = str(self.name).translate(
1216
1733
{ord("."): ord("_"),
1217
1734
ord("-"): ord("_")})
1218
self.dbus_object_path = (dbus.ObjectPath
1219
("/clients/" + client_object_name))
1735
self.dbus_object_path = dbus.ObjectPath(
1736
"/clients/" + client_object_name)
1220
1737
DBusObjectWithProperties.__init__(self, self.bus,
1221
1738
self.dbus_object_path)
1223
def notifychangeproperty(transform_func,
1224
dbus_name, type_func=lambda x: x,
1740
def notifychangeproperty(transform_func, dbus_name,
1741
type_func=lambda x: x,
1743
invalidate_only=False,
1744
_interface=_interface):
1226
1745
""" Modify a variable so that it's a property which announces
1227
1746
its changes to DBus.
1229
1748
transform_fun: Function that takes a value and a variant_level
1230
1749
and transforms it to a D-Bus type.
1231
1750
dbus_name: D-Bus name of the variable
1296
1826
if hasattr(DBusObjectWithProperties, "__del__"):
1297
1827
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1298
1828
Client.__del__(self, *args, **kwargs)
1300
def checker_callback(self, pid, condition, command,
1302
self.checker_callback_tag = None
1304
if os.WIFEXITED(condition):
1305
exitstatus = os.WEXITSTATUS(condition)
1830
def checker_callback(self, source, condition,
1831
connection, command, *args, **kwargs):
1832
ret = Client.checker_callback(self, source, condition,
1833
connection, command, *args,
1835
exitstatus = self.last_checker_status
1306
1837
# Emit D-Bus signal
1307
1838
self.CheckerCompleted(dbus.Int16(exitstatus),
1308
dbus.Int64(condition),
1839
# This is specific to GNU libC
1840
dbus.Int64(exitstatus << 8),
1309
1841
dbus.String(command))
1311
1843
# Emit D-Bus signal
1312
1844
self.CheckerCompleted(dbus.Int16(-1),
1313
dbus.Int64(condition),
1846
# This is specific to GNU libC
1848
| self.last_checker_signal),
1314
1849
dbus.String(command))
1316
return Client.checker_callback(self, pid, condition, command,
1319
1852
def start_checker(self, *args, **kwargs):
1320
old_checker = self.checker
1321
if self.checker is not None:
1322
old_checker_pid = self.checker.pid
1324
old_checker_pid = None
1853
old_checker_pid = getattr(self.checker, "pid", None)
1325
1854
r = Client.start_checker(self, *args, **kwargs)
1326
1855
# Only if new checker process was started
1327
1856
if (self.checker is not None
1379
1902
server to mandos-client
1383
1906
# Rejected - signal
1384
1907
@dbus.service.signal(_interface, signature="s")
1385
1908
def Rejected(self, reason):
1389
1912
# NeedApproval - signal
1390
1913
@dbus.service.signal(_interface, signature="tb")
1391
1914
def NeedApproval(self, timeout, default):
1393
1916
return self.need_approval()
1397
1920
# Approve - method
1398
1921
@dbus.service.method(_interface, in_signature="b")
1399
1922
def Approve(self, value):
1400
1923
self.approve(value)
1402
1925
# CheckedOK - method
1403
1926
@dbus.service.method(_interface)
1404
1927
def CheckedOK(self):
1405
1928
self.checked_ok()
1407
1930
# Enable - method
1931
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1408
1932
@dbus.service.method(_interface)
1409
1933
def Enable(self):
1413
1937
# StartChecker - method
1938
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1414
1939
@dbus.service.method(_interface)
1415
1940
def StartChecker(self):
1417
1942
self.start_checker()
1419
1944
# Disable - method
1945
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1420
1946
@dbus.service.method(_interface)
1421
1947
def Disable(self):
1425
1951
# StopChecker - method
1952
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1426
1953
@dbus.service.method(_interface)
1427
1954
def StopChecker(self):
1428
1955
self.stop_checker()
1432
1959
# ApprovalPending - property
1433
1960
@dbus_service_property(_interface, signature="b", access="read")
1434
1961
def ApprovalPending_dbus_property(self):
1435
1962
return dbus.Boolean(bool(self.approvals_pending))
1437
1964
# ApprovedByDefault - property
1438
@dbus_service_property(_interface, signature="b",
1965
@dbus_service_property(_interface,
1439
1967
access="readwrite")
1440
1968
def ApprovedByDefault_dbus_property(self, value=None):
1441
1969
if value is None: # get
1442
1970
return dbus.Boolean(self.approved_by_default)
1443
1971
self.approved_by_default = bool(value)
1445
1973
# ApprovalDelay - property
1446
@dbus_service_property(_interface, signature="t",
1974
@dbus_service_property(_interface,
1447
1976
access="readwrite")
1448
1977
def ApprovalDelay_dbus_property(self, value=None):
1449
1978
if value is None: # get
1450
return dbus.UInt64(self.approval_delay_milliseconds())
1979
return dbus.UInt64(self.approval_delay.total_seconds()
1451
1981
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1453
1983
# ApprovalDuration - property
1454
@dbus_service_property(_interface, signature="t",
1984
@dbus_service_property(_interface,
1455
1986
access="readwrite")
1456
1987
def ApprovalDuration_dbus_property(self, value=None):
1457
1988
if value is None: # get
1458
return dbus.UInt64(timedelta_to_milliseconds(
1459
self.approval_duration))
1989
return dbus.UInt64(self.approval_duration.total_seconds()
1460
1991
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1462
1993
# Name - property
1995
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1463
1996
@dbus_service_property(_interface, signature="s", access="read")
1464
1997
def Name_dbus_property(self):
1465
1998
return dbus.String(self.name)
1467
2000
# Fingerprint - property
2002
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1468
2003
@dbus_service_property(_interface, signature="s", access="read")
1469
2004
def Fingerprint_dbus_property(self):
1470
2005
return dbus.String(self.fingerprint)
1472
2007
# Host - property
1473
@dbus_service_property(_interface, signature="s",
2008
@dbus_service_property(_interface,
1474
2010
access="readwrite")
1475
2011
def Host_dbus_property(self, value=None):
1476
2012
if value is None: # get
1477
2013
return dbus.String(self.host)
1478
self.host = unicode(value)
2014
self.host = str(value)
1480
2016
# Created - property
2018
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1481
2019
@dbus_service_property(_interface, signature="s", access="read")
1482
2020
def Created_dbus_property(self):
1483
2021
return datetime_to_dbus(self.created)
1485
2023
# LastEnabled - property
1486
2024
@dbus_service_property(_interface, signature="s", access="read")
1487
2025
def LastEnabled_dbus_property(self):
1488
2026
return datetime_to_dbus(self.last_enabled)
1490
2028
# Enabled - property
1491
@dbus_service_property(_interface, signature="b",
2029
@dbus_service_property(_interface,
1492
2031
access="readwrite")
1493
2032
def Enabled_dbus_property(self, value=None):
1494
2033
if value is None: # get
1501
2040
# LastCheckedOK - property
1502
@dbus_service_property(_interface, signature="s",
2041
@dbus_service_property(_interface,
1503
2043
access="readwrite")
1504
2044
def LastCheckedOK_dbus_property(self, value=None):
1505
2045
if value is not None:
1506
2046
self.checked_ok()
1508
2048
return datetime_to_dbus(self.last_checked_ok)
1510
2050
# LastCheckerStatus - property
1511
@dbus_service_property(_interface, signature="n",
2051
@dbus_service_property(_interface, signature="n", access="read")
1513
2052
def LastCheckerStatus_dbus_property(self):
1514
2053
return dbus.Int16(self.last_checker_status)
1516
2055
# Expires - property
1517
2056
@dbus_service_property(_interface, signature="s", access="read")
1518
2057
def Expires_dbus_property(self):
1519
2058
return datetime_to_dbus(self.expires)
1521
2060
# LastApprovalRequest - property
1522
2061
@dbus_service_property(_interface, signature="s", access="read")
1523
2062
def LastApprovalRequest_dbus_property(self):
1524
2063
return datetime_to_dbus(self.last_approval_request)
1526
2065
# Timeout - property
1527
@dbus_service_property(_interface, signature="t",
2066
@dbus_service_property(_interface,
1528
2068
access="readwrite")
1529
2069
def Timeout_dbus_property(self, value=None):
1530
2070
if value is None: # get
1531
return dbus.UInt64(self.timeout_milliseconds())
2071
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2072
old_timeout = self.timeout
1532
2073
self.timeout = datetime.timedelta(0, 0, 0, value)
1533
# Reschedule timeout
2074
# Reschedule disabling
1534
2075
if self.enabled:
1535
2076
now = datetime.datetime.utcnow()
1536
time_to_die = timedelta_to_milliseconds(
1537
(self.last_checked_ok + self.timeout) - now)
1538
if time_to_die <= 0:
2077
self.expires += self.timeout - old_timeout
2078
if self.expires <= now:
1539
2079
# The timeout has passed
1542
self.expires = (now +
1543
datetime.timedelta(milliseconds =
1545
2082
if (getattr(self, "disable_initiator_tag", None)
1548
gobject.source_remove(self.disable_initiator_tag)
1549
self.disable_initiator_tag = (gobject.timeout_add
2085
GLib.source_remove(self.disable_initiator_tag)
2086
self.disable_initiator_tag = GLib.timeout_add(
2087
int((self.expires - now).total_seconds() * 1000),
1553
2090
# ExtendedTimeout - property
1554
@dbus_service_property(_interface, signature="t",
2091
@dbus_service_property(_interface,
1555
2093
access="readwrite")
1556
2094
def ExtendedTimeout_dbus_property(self, value=None):
1557
2095
if value is None: # get
1558
return dbus.UInt64(self.extended_timeout_milliseconds())
2096
return dbus.UInt64(self.extended_timeout.total_seconds()
1559
2098
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1561
2100
# Interval - property
1562
@dbus_service_property(_interface, signature="t",
2101
@dbus_service_property(_interface,
1563
2103
access="readwrite")
1564
2104
def Interval_dbus_property(self, value=None):
1565
2105
if value is None: # get
1566
return dbus.UInt64(self.interval_milliseconds())
2106
return dbus.UInt64(self.interval.total_seconds() * 1000)
1567
2107
self.interval = datetime.timedelta(0, 0, 0, value)
1568
2108
if getattr(self, "checker_initiator_tag", None) is None:
1570
2110
if self.enabled:
1571
2111
# Reschedule checker run
1572
gobject.source_remove(self.checker_initiator_tag)
1573
self.checker_initiator_tag = (gobject.timeout_add
1574
(value, self.start_checker))
1575
self.start_checker() # Start one now, too
2112
GLib.source_remove(self.checker_initiator_tag)
2113
self.checker_initiator_tag = GLib.timeout_add(
2114
value, self.start_checker)
2115
self.start_checker() # Start one now, too
1577
2117
# Checker - property
1578
@dbus_service_property(_interface, signature="s",
2118
@dbus_service_property(_interface,
1579
2120
access="readwrite")
1580
2121
def Checker_dbus_property(self, value=None):
1581
2122
if value is None: # get
1582
2123
return dbus.String(self.checker_command)
1583
self.checker_command = unicode(value)
2124
self.checker_command = str(value)
1585
2126
# CheckerRunning - property
1586
@dbus_service_property(_interface, signature="b",
2127
@dbus_service_property(_interface,
1587
2129
access="readwrite")
1588
2130
def CheckerRunning_dbus_property(self, value=None):
1589
2131
if value is None: # get
1636
2188
class ClientHandler(socketserver.BaseRequestHandler, object):
1637
2189
"""A class to handle client connections.
1639
2191
Instantiated once for each connection to handle it.
1640
2192
Note: This will run in its own forked process."""
1642
2194
def handle(self):
1643
2195
with contextlib.closing(self.server.child_pipe) as child_pipe:
1644
2196
logger.info("TCP connection from: %s",
1645
unicode(self.client_address))
2197
str(self.client_address))
1646
2198
logger.debug("Pipe FD: %d",
1647
2199
self.server.child_pipe.fileno())
1649
session = (gnutls.connection
1650
.ClientSession(self.request,
1652
.X509Credentials()))
1654
# Note: gnutls.connection.X509Credentials is really a
1655
# generic GnuTLS certificate credentials object so long as
1656
# no X.509 keys are added to it. Therefore, we can use it
1657
# here despite using OpenPGP certificates.
1659
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1660
# "+AES-256-CBC", "+SHA1",
1661
# "+COMP-NULL", "+CTYPE-OPENPGP",
2201
session = gnutls.ClientSession(self.request)
2203
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2204
# "+AES-256-CBC", "+SHA1",
2205
# "+COMP-NULL", "+CTYPE-OPENPGP",
1663
2207
# Use a fallback default, since this MUST be set.
1664
2208
priority = self.server.gnutls_priority
1665
2209
if priority is None:
1666
2210
priority = "NORMAL"
1667
(gnutls.library.functions
1668
.gnutls_priority_set_direct(session._c_object,
2211
gnutls.priority_set_direct(session._c_object,
2212
priority.encode("utf-8"),
1671
2215
# Start communication using the Mandos protocol
1672
2216
# Get protocol number
1673
2217
line = self.request.makefile().readline()
1674
2218
logger.debug("Protocol version: %r", line)
1676
2220
if int(line.strip().split()[0]) > 1:
2221
raise RuntimeError(line)
1678
2222
except (ValueError, IndexError, RuntimeError) as error:
1679
2223
logger.error("Unknown protocol version: %s", error)
1682
2226
# Start GnuTLS connection
1684
2228
session.handshake()
1685
except gnutls.errors.GNUTLSError as error:
2229
except gnutls.Error as error:
1686
2230
logger.warning("Handshake failed: %s", error)
1687
2231
# Do not run session.bye() here: the session is not
1688
2232
# established. Just abandon the request.
1690
2234
logger.debug("Handshake succeeded")
1692
2236
approval_required = False
1695
fpr = self.fingerprint(self.peer_certificate
1698
gnutls.errors.GNUTLSError) as error:
2239
fpr = self.fingerprint(
2240
self.peer_certificate(session))
2241
except (TypeError, gnutls.Error) as error:
1699
2242
logger.warning("Bad certificate: %s", error)
1701
2244
logger.debug("Fingerprint: %s", fpr)
1704
2247
client = ProxyClient(child_pipe, fpr,
1705
2248
self.client_address)
1706
2249
except KeyError:
1709
2252
if client.approval_delay:
1710
2253
delay = client.approval_delay
1711
2254
client.approvals_pending += 1
1712
2255
approval_required = True
1715
2258
if not client.enabled:
1716
2259
logger.info("Client %s is disabled",
1718
2261
if self.server.use_dbus:
1719
2262
# Emit D-Bus signal
1720
2263
client.Rejected("Disabled")
1723
2266
if client.approved or not client.approval_delay:
1724
#We are approved or approval is disabled
2267
# We are approved or approval is disabled
1726
2269
elif client.approved is None:
1727
2270
logger.info("Client %s needs approval",
1762
2303
delay -= time2 - time
1765
while sent_size < len(client.secret):
1767
sent = session.send(client.secret[sent_size:])
1768
except gnutls.errors.GNUTLSError as error:
1769
logger.warning("gnutls send failed",
1772
logger.debug("Sent: %d, remaining: %d",
1773
sent, len(client.secret)
1774
- (sent_size + sent))
2306
session.send(client.secret)
2307
except gnutls.Error as error:
2308
logger.warning("gnutls send failed",
1777
2312
logger.info("Sending secret to %s", client.name)
1778
2313
# bump the timeout using extended_timeout
1779
2314
client.bump_timeout(client.extended_timeout)
1780
2315
if self.server.use_dbus:
1781
2316
# Emit D-Bus signal
1782
2317
client.GotSecret()
1785
2320
if approval_required:
1786
2321
client.approvals_pending -= 1
1789
except gnutls.errors.GNUTLSError as error:
2324
except gnutls.Error as error:
1790
2325
logger.warning("GnuTLS bye failed",
1791
2326
exc_info=error)
1794
2329
def peer_certificate(session):
1795
2330
"Return the peer's OpenPGP certificate as a bytestring"
1796
2331
# If not an OpenPGP certificate...
1797
if (gnutls.library.functions
1798
.gnutls_certificate_type_get(session._c_object)
1799
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1800
# ...do the normal thing
1801
return session.peer_certificate
2332
if (gnutls.certificate_type_get(session._c_object)
2333
!= gnutls.CRT_OPENPGP):
2334
# ...return invalid data
1802
2336
list_size = ctypes.c_uint(1)
1803
cert_list = (gnutls.library.functions
1804
.gnutls_certificate_get_peers
2337
cert_list = (gnutls.certificate_get_peers
1805
2338
(session._c_object, ctypes.byref(list_size)))
1806
2339
if not bool(cert_list) and list_size.value != 0:
1807
raise gnutls.errors.GNUTLSError("error getting peer"
2340
raise gnutls.Error("error getting peer certificate")
1809
2341
if list_size.value == 0:
1811
2343
cert = cert_list[0]
1812
2344
return ctypes.string_at(cert.data, cert.size)
1815
2347
def fingerprint(openpgp):
1816
2348
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1817
2349
# New GnuTLS "datum" with the OpenPGP public key
1818
datum = (gnutls.library.types
1819
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1822
ctypes.c_uint(len(openpgp))))
2350
datum = gnutls.datum_t(
2351
ctypes.cast(ctypes.c_char_p(openpgp),
2352
ctypes.POINTER(ctypes.c_ubyte)),
2353
ctypes.c_uint(len(openpgp)))
1823
2354
# New empty GnuTLS certificate
1824
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1825
(gnutls.library.functions
1826
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2355
crt = gnutls.openpgp_crt_t()
2356
gnutls.openpgp_crt_init(ctypes.byref(crt))
1827
2357
# Import the OpenPGP public key into the certificate
1828
(gnutls.library.functions
1829
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1830
gnutls.library.constants
1831
.GNUTLS_OPENPGP_FMT_RAW))
2358
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2359
gnutls.OPENPGP_FMT_RAW)
1832
2360
# Verify the self signature in the key
1833
2361
crtverify = ctypes.c_uint()
1834
(gnutls.library.functions
1835
.gnutls_openpgp_crt_verify_self(crt, 0,
1836
ctypes.byref(crtverify)))
2362
gnutls.openpgp_crt_verify_self(crt, 0,
2363
ctypes.byref(crtverify))
1837
2364
if crtverify.value != 0:
1838
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1839
raise (gnutls.errors.CertificateSecurityError
2365
gnutls.openpgp_crt_deinit(crt)
2366
raise gnutls.CertificateSecurityError("Verify failed")
1841
2367
# New buffer for the fingerprint
1842
2368
buf = ctypes.create_string_buffer(20)
1843
2369
buf_len = ctypes.c_size_t()
1844
2370
# Get the fingerprint from the certificate into the buffer
1845
(gnutls.library.functions
1846
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1847
ctypes.byref(buf_len)))
2371
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2372
ctypes.byref(buf_len))
1848
2373
# Deinit the certificate
1849
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2374
gnutls.openpgp_crt_deinit(crt)
1850
2375
# Convert the buffer to a Python bytestring
1851
2376
fpr = ctypes.string_at(buf, buf_len.value)
1852
2377
# Convert the bytestring to hexadecimal notation
1857
2382
class MultiprocessingMixIn(object):
1858
2383
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1859
2385
def sub_process_main(self, request, address):
1861
2387
self.finish_request(request, address)
1862
2388
except Exception:
1863
2389
self.handle_error(request, address)
1864
2390
self.close_request(request)
1866
2392
def process_request(self, request, address):
1867
2393
"""Start a new process to process the request."""
1868
proc = multiprocessing.Process(target = self.sub_process_main,
1869
args = (request, address))
2394
proc = multiprocessing.Process(target=self.sub_process_main,
2395
args=(request, address))
1874
2400
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1875
2401
""" adds a pipe to the MixIn """
1876
2403
def process_request(self, request, client_address):
1877
2404
"""Overrides and wraps the original process_request().
1879
2406
This function creates a new pipe in self.pipe
1881
2408
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1883
2410
proc = MultiprocessingMixIn.process_request(self, request,
1884
2411
client_address)
1885
2412
self.child_pipe.close()
1886
2413
self.add_pipe(parent_pipe, proc)
1888
2415
def add_pipe(self, parent_pipe, proc):
1889
2416
"""Dummy function; override as necessary"""
1890
raise NotImplementedError
2417
raise NotImplementedError()
1893
2420
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1894
2421
socketserver.TCPServer, object):
1895
2422
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1898
2425
enabled: Boolean; whether this server is activated yet
1899
2426
interface: None or a network interface name (string)
1900
2427
use_ipv6: Boolean; to use IPv6 or not
1902
2430
def __init__(self, server_address, RequestHandlerClass,
1903
interface=None, use_ipv6=True):
2434
"""If socketfd is set, use that file descriptor instead of
2435
creating a new one with socket.socket().
1904
2437
self.interface = interface
1906
2439
self.address_family = socket.AF_INET6
2440
if socketfd is not None:
2441
# Save the file descriptor
2442
self.socketfd = socketfd
2443
# Save the original socket.socket() function
2444
self.socket_socket = socket.socket
2446
# To implement --socket, we monkey patch socket.socket.
2448
# (When socketserver.TCPServer is a new-style class, we
2449
# could make self.socket into a property instead of monkey
2450
# patching socket.socket.)
2452
# Create a one-time-only replacement for socket.socket()
2453
@functools.wraps(socket.socket)
2454
def socket_wrapper(*args, **kwargs):
2455
# Restore original function so subsequent calls are
2457
socket.socket = self.socket_socket
2458
del self.socket_socket
2459
# This time only, return a new socket object from the
2460
# saved file descriptor.
2461
return socket.fromfd(self.socketfd, *args, **kwargs)
2462
# Replace socket.socket() function with wrapper
2463
socket.socket = socket_wrapper
2464
# The socketserver.TCPServer.__init__ will call
2465
# socket.socket(), which might be our replacement,
2466
# socket_wrapper(), if socketfd was set.
1907
2467
socketserver.TCPServer.__init__(self, server_address,
1908
2468
RequestHandlerClass)
1909
2470
def server_bind(self):
1910
2471
"""This overrides the normal server_bind() function
1911
2472
to bind to an interface if one was specified, and also NOT to
1912
2473
bind to an address or port if they were not specified."""
2474
global SO_BINDTODEVICE
1913
2475
if self.interface is not None:
1914
2476
if SO_BINDTODEVICE is None:
1915
logger.error("SO_BINDTODEVICE does not exist;"
1916
" cannot bind to interface %s",
1920
self.socket.setsockopt(socket.SOL_SOCKET,
1924
except socket.error as error:
1925
if error[0] == errno.EPERM:
1926
logger.error("No permission to"
1927
" bind to interface %s",
1929
elif error[0] == errno.ENOPROTOOPT:
1930
logger.error("SO_BINDTODEVICE not available;"
1931
" cannot bind to interface %s",
2477
# Fall back to a hard-coded value which seems to be
2479
logger.warning("SO_BINDTODEVICE not found, trying 25")
2480
SO_BINDTODEVICE = 25
2482
self.socket.setsockopt(
2483
socket.SOL_SOCKET, SO_BINDTODEVICE,
2484
(self.interface + "\0").encode("utf-8"))
2485
except socket.error as error:
2486
if error.errno == errno.EPERM:
2487
logger.error("No permission to bind to"
2488
" interface %s", self.interface)
2489
elif error.errno == errno.ENOPROTOOPT:
2490
logger.error("SO_BINDTODEVICE not available;"
2491
" cannot bind to interface %s",
2493
elif error.errno == errno.ENODEV:
2494
logger.error("Interface %s does not exist,"
2495
" cannot bind", self.interface)
1935
2498
# Only bind(2) the socket if we really need to.
1936
2499
if self.server_address[0] or self.server_address[1]:
1937
2500
if not self.server_address[0]:
1938
2501
if self.address_family == socket.AF_INET6:
1939
any_address = "::" # in6addr_any
2502
any_address = "::" # in6addr_any
1941
any_address = socket.INADDR_ANY
2504
any_address = "0.0.0.0" # INADDR_ANY
1942
2505
self.server_address = (any_address,
1943
2506
self.server_address[1])
1944
2507
elif not self.server_address[1]:
1945
self.server_address = (self.server_address[0],
2508
self.server_address = (self.server_address[0], 0)
1947
2509
# if self.interface:
1948
2510
# self.server_address = (self.server_address[0],
2038
2608
funcname = request[1]
2039
2609
args = request[2]
2040
2610
kwargs = request[3]
2042
2612
parent_pipe.send(('data', getattr(client_object,
2043
2613
funcname)(*args,
2046
2616
if command == 'getattr':
2047
2617
attrname = request[1]
2048
if callable(client_object.__getattribute__(attrname)):
2049
parent_pipe.send(('function',))
2618
if isinstance(client_object.__getattribute__(attrname),
2619
collections.Callable):
2620
parent_pipe.send(('function', ))
2051
parent_pipe.send(('data', client_object
2052
.__getattribute__(attrname)))
2623
'data', client_object.__getattribute__(attrname)))
2054
2625
if command == 'setattr':
2055
2626
attrname = request[1]
2056
2627
value = request[2]
2057
2628
setattr(client_object, attrname, value)
2633
def rfc3339_duration_to_delta(duration):
2634
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2636
>>> rfc3339_duration_to_delta("P7D")
2637
datetime.timedelta(7)
2638
>>> rfc3339_duration_to_delta("PT60S")
2639
datetime.timedelta(0, 60)
2640
>>> rfc3339_duration_to_delta("PT60M")
2641
datetime.timedelta(0, 3600)
2642
>>> rfc3339_duration_to_delta("PT24H")
2643
datetime.timedelta(1)
2644
>>> rfc3339_duration_to_delta("P1W")
2645
datetime.timedelta(7)
2646
>>> rfc3339_duration_to_delta("PT5M30S")
2647
datetime.timedelta(0, 330)
2648
>>> rfc3339_duration_to_delta("P1DT3M20S")
2649
datetime.timedelta(1, 200)
2652
# Parsing an RFC 3339 duration with regular expressions is not
2653
# possible - there would have to be multiple places for the same
2654
# values, like seconds. The current code, while more esoteric, is
2655
# cleaner without depending on a parsing library. If Python had a
2656
# built-in library for parsing we would use it, but we'd like to
2657
# avoid excessive use of external libraries.
2659
# New type for defining tokens, syntax, and semantics all-in-one
2660
Token = collections.namedtuple("Token", (
2661
"regexp", # To match token; if "value" is not None, must have
2662
# a "group" containing digits
2663
"value", # datetime.timedelta or None
2664
"followers")) # Tokens valid after this token
2665
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2666
# the "duration" ABNF definition in RFC 3339, Appendix A.
2667
token_end = Token(re.compile(r"$"), None, frozenset())
2668
token_second = Token(re.compile(r"(\d+)S"),
2669
datetime.timedelta(seconds=1),
2670
frozenset((token_end, )))
2671
token_minute = Token(re.compile(r"(\d+)M"),
2672
datetime.timedelta(minutes=1),
2673
frozenset((token_second, token_end)))
2674
token_hour = Token(re.compile(r"(\d+)H"),
2675
datetime.timedelta(hours=1),
2676
frozenset((token_minute, token_end)))
2677
token_time = Token(re.compile(r"T"),
2679
frozenset((token_hour, token_minute,
2681
token_day = Token(re.compile(r"(\d+)D"),
2682
datetime.timedelta(days=1),
2683
frozenset((token_time, token_end)))
2684
token_month = Token(re.compile(r"(\d+)M"),
2685
datetime.timedelta(weeks=4),
2686
frozenset((token_day, token_end)))
2687
token_year = Token(re.compile(r"(\d+)Y"),
2688
datetime.timedelta(weeks=52),
2689
frozenset((token_month, token_end)))
2690
token_week = Token(re.compile(r"(\d+)W"),
2691
datetime.timedelta(weeks=1),
2692
frozenset((token_end, )))
2693
token_duration = Token(re.compile(r"P"), None,
2694
frozenset((token_year, token_month,
2695
token_day, token_time,
2697
# Define starting values:
2699
value = datetime.timedelta()
2701
# Following valid tokens
2702
followers = frozenset((token_duration, ))
2703
# String left to parse
2705
# Loop until end token is found
2706
while found_token is not token_end:
2707
# Search for any currently valid tokens
2708
for token in followers:
2709
match = token.regexp.match(s)
2710
if match is not None:
2712
if token.value is not None:
2713
# Value found, parse digits
2714
factor = int(match.group(1), 10)
2715
# Add to value so far
2716
value += factor * token.value
2717
# Strip token from string
2718
s = token.regexp.sub("", s, 1)
2721
# Set valid next tokens
2722
followers = found_token.followers
2725
# No currently valid tokens were found
2726
raise ValueError("Invalid RFC 3339 duration: {!r}"
2062
2732
def string_to_delta(interval):
2063
2733
"""Parse a string and return a datetime.timedelta
2065
2735
>>> string_to_delta('7d')
2066
2736
datetime.timedelta(7)
2067
2737
>>> string_to_delta('60s')
2157
2832
parser.add_argument("--no-dbus", action="store_false",
2158
2833
dest="use_dbus", help="Do not provide D-Bus"
2159
" system bus interface")
2834
" system bus interface", default=None)
2160
2835
parser.add_argument("--no-ipv6", action="store_false",
2161
dest="use_ipv6", help="Do not use IPv6")
2836
dest="use_ipv6", help="Do not use IPv6",
2162
2838
parser.add_argument("--no-restore", action="store_false",
2163
2839
dest="restore", help="Do not restore stored"
2840
" state", default=None)
2841
parser.add_argument("--socket", type=int,
2842
help="Specify a file descriptor to a network"
2843
" socket to use instead of creating one")
2165
2844
parser.add_argument("--statedir", metavar="DIR",
2166
2845
help="Directory to save/restore state in")
2846
parser.add_argument("--foreground", action="store_true",
2847
help="Run in foreground", default=None)
2848
parser.add_argument("--no-zeroconf", action="store_false",
2849
dest="zeroconf", help="Do not use Zeroconf",
2168
2852
options = parser.parse_args()
2170
2854
if options.check:
2856
fail_count, test_count = doctest.testmod()
2857
sys.exit(os.EX_OK if fail_count == 0 else 1)
2175
2859
# Default values for config file for server-global settings
2176
server_defaults = { "interface": "",
2181
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2182
"servicename": "Mandos",
2187
"statedir": "/var/lib/mandos"
2860
server_defaults = {"interface": "",
2865
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2866
":+SIGN-DSA-SHA256",
2867
"servicename": "Mandos",
2873
"statedir": "/var/lib/mandos",
2874
"foreground": "False",
2190
2878
# Parse config file for server-global settings
2191
2879
server_config = configparser.SafeConfigParser(server_defaults)
2192
2880
del server_defaults
2193
server_config.read(os.path.join(options.configdir,
2881
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2195
2882
# Convert the SafeConfigParser object to a dict
2196
2883
server_settings = server_config.defaults()
2197
2884
# Use the appropriate methods on the non-string config options
2198
for option in ("debug", "use_dbus", "use_ipv6"):
2885
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2199
2886
server_settings[option] = server_config.getboolean("DEFAULT",
2201
2888
if server_settings["port"]:
2202
2889
server_settings["port"] = server_config.getint("DEFAULT",
2891
if server_settings["socket"]:
2892
server_settings["socket"] = server_config.getint("DEFAULT",
2894
# Later, stdin will, and stdout and stderr might, be dup'ed
2895
# over with an opened os.devnull. But we don't want this to
2896
# happen with a supplied network socket.
2897
if 0 <= server_settings["socket"] <= 2:
2898
server_settings["socket"] = os.dup(server_settings
2204
2900
del server_config
2206
2902
# Override the settings from the config file with command line
2207
2903
# options, if set.
2208
2904
for option in ("interface", "address", "port", "debug",
2209
"priority", "servicename", "configdir",
2210
"use_dbus", "use_ipv6", "debuglevel", "restore",
2905
"priority", "servicename", "configdir", "use_dbus",
2906
"use_ipv6", "debuglevel", "restore", "statedir",
2907
"socket", "foreground", "zeroconf"):
2212
2908
value = getattr(options, option)
2213
2909
if value is not None:
2214
2910
server_settings[option] = value
2216
2912
# Force all strings to be unicode
2217
2913
for option in server_settings.keys():
2218
if type(server_settings[option]) is str:
2219
server_settings[option] = unicode(server_settings[option])
2914
if isinstance(server_settings[option], bytes):
2915
server_settings[option] = (server_settings[option]
2917
# Force all boolean options to be boolean
2918
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2919
"foreground", "zeroconf"):
2920
server_settings[option] = bool(server_settings[option])
2921
# Debug implies foreground
2922
if server_settings["debug"]:
2923
server_settings["foreground"] = True
2220
2924
# Now we have our good server settings in "server_settings"
2222
2926
##################################################################
2928
if (not server_settings["zeroconf"]
2929
and not (server_settings["port"]
2930
or server_settings["socket"] != "")):
2931
parser.error("Needs port or socket to work without Zeroconf")
2224
2933
# For convenience
2225
2934
debug = server_settings["debug"]
2226
2935
debuglevel = server_settings["debuglevel"]
2238
2949
level = getattr(logging, debuglevel.upper())
2239
2950
initlogger(debug, level)
2241
2952
if server_settings["servicename"] != "Mandos":
2242
syslogger.setFormatter(logging.Formatter
2243
('Mandos ({0}) [%(process)d]:'
2244
' %(levelname)s: %(message)s'
2245
.format(server_settings
2953
syslogger.setFormatter(
2954
logging.Formatter('Mandos ({}) [%(process)d]:'
2955
' %(levelname)s: %(message)s'.format(
2956
server_settings["servicename"])))
2248
2958
# Parse config file with clients
2249
2959
client_config = configparser.SafeConfigParser(Client
2250
2960
.client_defaults)
2251
2961
client_config.read(os.path.join(server_settings["configdir"],
2252
2962
"clients.conf"))
2254
2964
global mandos_dbus_service
2255
2965
mandos_dbus_service = None
2257
tcp_server = MandosServer((server_settings["address"],
2258
server_settings["port"]),
2260
interface=(server_settings["interface"]
2264
server_settings["priority"],
2267
pidfilename = "/var/run/mandos.pid"
2968
if server_settings["socket"] != "":
2969
socketfd = server_settings["socket"]
2970
tcp_server = MandosServer(
2971
(server_settings["address"], server_settings["port"]),
2973
interface=(server_settings["interface"] or None),
2975
gnutls_priority=server_settings["priority"],
2979
pidfilename = "/run/mandos.pid"
2980
if not os.path.isdir("/run/."):
2981
pidfilename = "/var/run/mandos.pid"
2269
pidfile = open(pidfilename, "w")
2984
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2270
2985
except IOError as e:
2271
2986
logger.error("Could not open file %r", pidfilename,
2274
for name in ("_mandos", "mandos", "nobody"):
2989
for name, group in (("_mandos", "_mandos"),
2990
("mandos", "mandos"),
2991
("nobody", "nogroup")):
2276
2993
uid = pwd.getpwnam(name).pw_uid
2277
gid = pwd.getpwnam(name).pw_gid
2994
gid = pwd.getpwnam(group).pw_gid
2279
2996
except KeyError:
3005
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2287
3007
except OSError as error:
2288
if error[0] != errno.EPERM:
3008
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3009
.format(uid, gid, os.strerror(error.errno)))
3010
if error.errno != errno.EPERM:
2292
3014
# Enable all possible GnuTLS debugging
2294
3016
# "Use a log level over 10 to enable all debugging options."
2295
3017
# - GnuTLS manual
2296
gnutls.library.functions.gnutls_global_set_log_level(11)
2298
@gnutls.library.types.gnutls_log_func
3018
gnutls.global_set_log_level(11)
2299
3021
def debug_gnutls(level, string):
2300
3022
logger.debug("GnuTLS: %s", string[:-1])
2302
(gnutls.library.functions
2303
.gnutls_global_set_log_function(debug_gnutls))
3024
gnutls.global_set_log_function(debug_gnutls)
2305
3026
# Redirect stdin so all checkers get /dev/null
2306
3027
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2307
3028
os.dup2(null, sys.stdin.fileno())
2311
3032
# Need to fork before connecting to D-Bus
2313
3034
# Close all input and output, do double fork, etc.
2316
gobject.threads_init()
3037
# multiprocessing will use threads, so before we use GLib we need
3038
# to inform GLib that threads will be used.
2318
3041
global main_loop
2319
3042
# From the Avahi example code
2320
3043
DBusGMainLoop(set_as_default=True)
2321
main_loop = gobject.MainLoop()
3044
main_loop = GLib.MainLoop()
2322
3045
bus = dbus.SystemBus()
2323
3046
# End of Avahi example code
2326
3049
bus_name = dbus.service.BusName("se.recompile.Mandos",
2327
bus, do_not_queue=True)
2328
old_bus_name = (dbus.service.BusName
2329
("se.bsnet.fukt.Mandos", bus,
2331
except dbus.exceptions.NameExistsException as e:
3052
old_bus_name = dbus.service.BusName(
3053
"se.bsnet.fukt.Mandos", bus,
3055
except dbus.exceptions.DBusException as e:
2332
3056
logger.error("Disabling D-Bus:", exc_info=e)
2333
3057
use_dbus = False
2334
3058
server_settings["use_dbus"] = False
2335
3059
tcp_server.use_dbus = False
2336
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2337
service = AvahiServiceToSyslog(name =
2338
server_settings["servicename"],
2339
servicetype = "_mandos._tcp",
2340
protocol = protocol, bus = bus)
2341
if server_settings["interface"]:
2342
service.interface = (if_nametoindex
2343
(str(server_settings["interface"])))
3061
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3062
service = AvahiServiceToSyslog(
3063
name=server_settings["servicename"],
3064
servicetype="_mandos._tcp",
3067
if server_settings["interface"]:
3068
service.interface = if_nametoindex(
3069
server_settings["interface"].encode("utf-8"))
2345
3071
global multiprocessing_manager
2346
3072
multiprocessing_manager = multiprocessing.Manager()
2348
3074
client_class = Client
2350
client_class = functools.partial(ClientDBus, bus = bus)
3076
client_class = functools.partial(ClientDBus, bus=bus)
2352
3078
client_settings = Client.config_parser(client_config)
2353
3079
old_client_settings = {}
2354
3080
clients_data = {}
3082
# This is used to redirect stdout and stderr for checker processes
3084
wnull = open(os.devnull, "w") # A writable /dev/null
3085
# Only used if server is running in foreground but not in debug
3087
if debug or not foreground:
2356
3090
# Get client data and settings from last running state.
2357
3091
if server_settings["restore"]:
2359
3093
with open(stored_state_path, "rb") as stored_state:
2360
clients_data, old_client_settings = (pickle.load
3094
if sys.version_info.major == 2:
3095
clients_data, old_client_settings = pickle.load(
3098
bytes_clients_data, bytes_old_client_settings = (
3099
pickle.load(stored_state, encoding="bytes"))
3100
# Fix bytes to strings
3103
clients_data = {(key.decode("utf-8")
3104
if isinstance(key, bytes)
3107
bytes_clients_data.items()}
3108
del bytes_clients_data
3109
for key in clients_data:
3110
value = {(k.decode("utf-8")
3111
if isinstance(k, bytes) else k): v
3113
clients_data[key].items()}
3114
clients_data[key] = value
3116
value["client_structure"] = [
3118
if isinstance(s, bytes)
3120
value["client_structure"]]
3122
for k in ("name", "host"):
3123
if isinstance(value[k], bytes):
3124
value[k] = value[k].decode("utf-8")
3125
# old_client_settings
3127
old_client_settings = {
3128
(key.decode("utf-8")
3129
if isinstance(key, bytes)
3132
bytes_old_client_settings.items()}
3133
del bytes_old_client_settings
3135
for value in old_client_settings.values():
3136
if isinstance(value["host"], bytes):
3137
value["host"] = (value["host"]
2362
3139
os.remove(stored_state_path)
2363
3140
except IOError as e:
2364
3141
if e.errno == errno.ENOENT:
2365
logger.warning("Could not load persistent state: {0}"
2366
.format(os.strerror(e.errno)))
3142
logger.warning("Could not load persistent state:"
3143
" {}".format(os.strerror(e.errno)))
2368
3145
logger.critical("Could not load persistent state:",
2371
3148
except EOFError as e:
2372
3149
logger.warning("Could not load persistent state: "
2373
"EOFError:", exc_info=e)
2375
3153
with PGPEngine() as pgp:
2376
for client_name, client in clients_data.iteritems():
3154
for client_name, client in clients_data.items():
3155
# Skip removed clients
3156
if client_name not in client_settings:
2377
3159
# Decide which value to use after restoring saved state.
2378
3160
# We have three different values: Old config file,
2379
3161
# new config file, and saved state.
2437
3219
for client_name in (set(client_settings)
2438
3220
- set(old_client_settings)):
2439
3221
clients_data[client_name] = client_settings[client_name]
2441
3223
# Create all client objects
2442
for client_name, client in clients_data.iteritems():
3224
for client_name, client in clients_data.items():
2443
3225
tcp_server.clients[client_name] = client_class(
2444
name = client_name, settings = client)
3228
server_settings=server_settings)
2446
3230
if not tcp_server.clients:
2447
3231
logger.warning("No clients defined")
2453
pidfile.write(str(pid) + "\n".encode("utf-8"))
2456
logger.error("Could not write to file %r with PID %d",
2459
# "pidfile" was never created
3234
if pidfile is not None:
3238
print(pid, file=pidfile)
3240
logger.error("Could not write to file %r with PID %d",
2461
3243
del pidfilename
2462
signal.signal(signal.SIGINT, signal.SIG_IGN)
2464
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2465
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3245
for termsig in (signal.SIGHUP, signal.SIGTERM):
3246
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3247
lambda: main_loop.quit() and False)
2468
@alternate_dbus_interfaces({"se.recompile.Mandos":
2469
"se.bsnet.fukt.Mandos"})
2470
class MandosDBusService(DBusObjectWithProperties):
3251
@alternate_dbus_interfaces(
3252
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3253
class MandosDBusService(DBusObjectWithObjectManager):
2471
3254
"""A D-Bus proxy object"""
2472
3256
def __init__(self):
2473
3257
dbus.service.Object.__init__(self, bus, "/")
2474
3259
_interface = "se.recompile.Mandos"
2476
@dbus_interface_annotations(_interface)
2478
return { "org.freedesktop.DBus.Property"
2479
".EmitsChangedSignal":
2482
3261
@dbus.service.signal(_interface, signature="o")
2483
3262
def ClientAdded(self, objpath):
2487
3266
@dbus.service.signal(_interface, signature="ss")
2488
3267
def ClientNotFound(self, fingerprint, address):
3271
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2492
3273
@dbus.service.signal(_interface, signature="os")
2493
3274
def ClientRemoved(self, objpath, name):
3278
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2497
3280
@dbus.service.method(_interface, out_signature="ao")
2498
3281
def GetAllClients(self):
2500
return dbus.Array(c.dbus_object_path
2502
tcp_server.clients.itervalues())
3283
return dbus.Array(c.dbus_object_path for c in
3284
tcp_server.clients.values())
3286
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2504
3288
@dbus.service.method(_interface,
2505
3289
out_signature="a{oa{sv}}")
2506
3290
def GetAllClientsWithProperties(self):
2508
3292
return dbus.Dictionary(
2509
((c.dbus_object_path, c.GetAll(""))
2510
for c in tcp_server.clients.itervalues()),
3293
{c.dbus_object_path: c.GetAll(
3294
"se.recompile.Mandos.Client")
3295
for c in tcp_server.clients.values()},
2511
3296
signature="oa{sv}")
2513
3298
@dbus.service.method(_interface, in_signature="o")
2514
3299
def RemoveClient(self, object_path):
2516
for c in tcp_server.clients.itervalues():
3301
for c in tcp_server.clients.values():
2517
3302
if c.dbus_object_path == object_path:
2518
3303
del tcp_server.clients[c.name]
2519
3304
c.remove_from_connection()
2520
# Don't signal anything except ClientRemoved
3305
# Don't signal the disabling
2521
3306
c.disable(quiet=True)
2523
self.ClientRemoved(object_path, c.name)
3307
# Emit D-Bus signal for removal
3308
self.client_removed_signal(c)
2525
3310
raise KeyError(object_path)
3314
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3315
out_signature="a{oa{sa{sv}}}")
3316
def GetManagedObjects(self):
3318
return dbus.Dictionary(
3319
{client.dbus_object_path:
3321
{interface: client.GetAll(interface)
3323
client._get_all_interface_names()})
3324
for client in tcp_server.clients.values()})
3326
def client_added_signal(self, client):
3327
"""Send the new standard signal and the old signal"""
3329
# New standard signal
3330
self.InterfacesAdded(
3331
client.dbus_object_path,
3333
{interface: client.GetAll(interface)
3335
client._get_all_interface_names()}))
3337
self.ClientAdded(client.dbus_object_path)
3339
def client_removed_signal(self, client):
3340
"""Send the new standard signal and the old signal"""
3342
# New standard signal
3343
self.InterfacesRemoved(
3344
client.dbus_object_path,
3345
client._get_all_interface_names())
3347
self.ClientRemoved(client.dbus_object_path,
2529
3350
mandos_dbus_service = MandosDBusService()
3352
# Save modules to variables to exempt the modules from being
3353
# unloaded before the function registered with atexit() is run.
3354
mp = multiprocessing
2532
3358
"Cleanup function; run on exit"
2535
multiprocessing.active_children()
3362
mp.active_children()
2536
3364
if not (tcp_server.clients or client_settings):
2539
3367
# Store client before exiting. Secrets are encrypted with key
2540
3368
# based on what config file has. If config file is
2541
3369
# removed/edited, old secret will thus be unrecovable.
2543
3371
with PGPEngine() as pgp:
2544
for client in tcp_server.clients.itervalues():
3372
for client in tcp_server.clients.values():
2545
3373
key = client_settings[client.name]["secret"]
2546
3374
client.encrypted_secret = pgp.encrypt(client.secret,
2548
3376
client_dict = {}
2550
3378
# A list of attributes that can not be pickled
2552
exclude = set(("bus", "changedstate", "secret",
2554
for name, typ in (inspect.getmembers
2555
(dbus.service.Object)):
3380
exclude = {"bus", "changedstate", "secret",
3381
"checker", "server_settings"}
3382
for name, typ in inspect.getmembers(dbus.service
2556
3384
exclude.add(name)
2558
3386
client_dict["encrypted_secret"] = (client
2559
3387
.encrypted_secret)
2560
3388
for attr in client.client_structure:
2561
3389
if attr not in exclude:
2562
3390
client_dict[attr] = getattr(client, attr)
2564
3392
clients[client.name] = client_dict
2565
3393
del client_settings[client.name]["secret"]
2568
with (tempfile.NamedTemporaryFile
2569
(mode='wb', suffix=".pickle", prefix='clients-',
2570
dir=os.path.dirname(stored_state_path),
2571
delete=False)) as stored_state:
2572
pickle.dump((clients, client_settings), stored_state)
2573
tempname=stored_state.name
3396
with tempfile.NamedTemporaryFile(
3400
dir=os.path.dirname(stored_state_path),
3401
delete=False) as stored_state:
3402
pickle.dump((clients, client_settings), stored_state,
3404
tempname = stored_state.name
2574
3405
os.rename(tempname, stored_state_path)
2575
3406
except (IOError, OSError) as e: