63
import cPickle as pickle
70
import cPickle as pickle
64
73
import multiprocessing
71
83
import dbus.service
85
from gi.repository import GLib
74
86
from dbus.mainloop.glib import DBusGMainLoop
77
89
import xml.dom.minidom
92
if sys.version_info.major == 2:
95
# Show warnings by default
96
if not sys.warnoptions:
98
warnings.simplefilter("default")
100
# Try to find the value of SO_BINDTODEVICE:
102
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
103
# newer, and it is also the most natural place for it:
82
104
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
83
105
except AttributeError:
107
# This is where SO_BINDTODEVICE was up to and including Python
85
109
from IN import SO_BINDTODEVICE
86
110
except ImportError:
87
SO_BINDTODEVICE = None
111
# In Python 2.7 it seems to have been removed entirely.
112
# Try running the C preprocessor:
114
cc = subprocess.Popen(["cc", "--language=c", "-E",
116
stdin=subprocess.PIPE,
117
stdout=subprocess.PIPE)
118
stdout = cc.communicate(
119
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
120
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
121
except (OSError, ValueError, IndexError):
123
SO_BINDTODEVICE = None
125
if sys.version_info.major == 2:
128
if sys.version_info < (3, 2):
129
configparser.Configparser = configparser.SafeConfigParser
90
132
stored_state_file = "clients.pickle"
92
134
logger = logging.getLogger()
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
135
logging.captureWarnings(True) # Show warnings via the logging system
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
139
if_nametoindex = ctypes.cdll.LoadLibrary(
140
ctypes.util.find_library("c")).if_nametoindex
101
141
except (OSError, AttributeError):
102
143
def if_nametoindex(interface):
103
144
"Get an interface index the hard way, i.e. using fcntl()"
104
145
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
146
with contextlib.closing(socket.socket()) as s:
106
147
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
109
interface_index = struct.unpack(str("I"),
148
struct.pack(b"16s16x", interface))
149
interface_index = struct.unpack("I", ifreq[16:20])[0]
111
150
return interface_index
153
def copy_function(func):
154
"""Make a copy of a function"""
155
if sys.version_info.major == 2:
156
return types.FunctionType(func.func_code,
162
return types.FunctionType(func.__code__,
114
169
def initlogger(debug, level=logging.WARNING):
115
170
"""init logger and add loglevel"""
173
syslogger = (logging.handlers.SysLogHandler(
174
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
117
176
syslogger.setFormatter(logging.Formatter
118
177
('Mandos [%(process)d]: %(levelname)s:'
120
179
logger.addHandler(syslogger)
123
182
console = logging.StreamHandler()
124
183
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
169
240
os.rmdir(self.tempdir)
170
241
self.tempdir = None
172
243
def password_encode(self, password):
173
244
# Passphrase can not be empty and can not contain newlines or
174
245
# NUL bytes. So we prefix it and hex encode it.
175
return b"mandos" + binascii.hexlify(password)
246
encoded = b"mandos" + binascii.hexlify(password)
247
if len(encoded) > 2048:
248
# GnuPG can't handle long passwords, so encode differently
249
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
250
.replace(b"\n", b"\\n")
251
.replace(b"\0", b"\\x00"))
177
254
def encrypt(self, data, password):
178
self.gnupg.passphrase = self.password_encode(password)
179
with open(os.devnull, "w") as devnull:
181
proc = self.gnupg.run(['--symmetric'],
182
create_fhs=['stdin', 'stdout'],
183
attach_fhs={'stderr': devnull})
184
with contextlib.closing(proc.handles['stdin']) as f:
186
with contextlib.closing(proc.handles['stdout']) as f:
187
ciphertext = f.read()
191
self.gnupg.passphrase = None
255
passphrase = self.password_encode(password)
256
with tempfile.NamedTemporaryFile(
257
dir=self.tempdir) as passfile:
258
passfile.write(passphrase)
260
proc = subprocess.Popen([self.gpg, '--symmetric',
264
stdin=subprocess.PIPE,
265
stdout=subprocess.PIPE,
266
stderr=subprocess.PIPE)
267
ciphertext, err = proc.communicate(input=data)
268
if proc.returncode != 0:
192
270
return ciphertext
194
272
def decrypt(self, data, password):
195
self.gnupg.passphrase = self.password_encode(password)
196
with open(os.devnull, "w") as devnull:
198
proc = self.gnupg.run(['--decrypt'],
199
create_fhs=['stdin', 'stdout'],
200
attach_fhs={'stderr': devnull})
201
with contextlib.closing(proc.handles['stdin']) as f:
203
with contextlib.closing(proc.handles['stdout']) as f:
204
decrypted_plaintext = f.read()
208
self.gnupg.passphrase = None
273
passphrase = self.password_encode(password)
274
with tempfile.NamedTemporaryFile(
275
dir=self.tempdir) as passfile:
276
passfile.write(passphrase)
278
proc = subprocess.Popen([self.gpg, '--decrypt',
282
stdin=subprocess.PIPE,
283
stdout=subprocess.PIPE,
284
stderr=subprocess.PIPE)
285
decrypted_plaintext, err = proc.communicate(input=data)
286
if proc.returncode != 0:
209
288
return decrypted_plaintext
291
# Pretend that we have an Avahi module
293
"""This isn't so much a class as it is a module-like namespace."""
294
IF_UNSPEC = -1 # avahi-common/address.h
295
PROTO_UNSPEC = -1 # avahi-common/address.h
296
PROTO_INET = 0 # avahi-common/address.h
297
PROTO_INET6 = 1 # avahi-common/address.h
298
DBUS_NAME = "org.freedesktop.Avahi"
299
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
300
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
301
DBUS_PATH_SERVER = "/"
304
def string_array_to_txt_array(t):
305
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
306
for s in t), signature="ay")
307
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
308
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
309
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
310
SERVER_INVALID = 0 # avahi-common/defs.h
311
SERVER_REGISTERING = 1 # avahi-common/defs.h
312
SERVER_RUNNING = 2 # avahi-common/defs.h
313
SERVER_COLLISION = 3 # avahi-common/defs.h
314
SERVER_FAILURE = 4 # avahi-common/defs.h
213
317
class AvahiError(Exception):
214
318
def __init__(self, value, *args, **kwargs):
215
319
self.value = value
216
super(AvahiError, self).__init__(value, *args, **kwargs)
217
def __unicode__(self):
218
return unicode(repr(self.value))
320
return super(AvahiError, self).__init__(value, *args,
220
324
class AvahiServiceError(AvahiError):
223
328
class AvahiGroupError(AvahiError):
227
class AvahiService(object):
228
333
"""An Avahi (Zeroconf) service.
231
336
interface: integer; avahi.IF_UNSPEC or an interface index.
232
337
Used to optionally bind to the specified interface.
233
338
name: string; Example: 'Mandos'
234
339
type: string; Example: '_mandos._tcp'.
235
See <http://www.dns-sd.org/ServiceTypes.html>
340
See <https://www.iana.org/assignments/service-names-port-numbers>
236
341
port: integer; what port to announce
237
342
TXT: list of strings; TXT record for the service
238
343
domain: string; Domain to publish on, default to .local if empty.
367
502
follow_name_owner_changes=True),
368
503
avahi.DBUS_INTERFACE_SERVER)
369
504
self.server.connect_to_signal("StateChanged",
370
self.server_state_changed)
505
self.server_state_changed)
371
506
self.server_state_changed(self.server.GetState())
373
509
class AvahiServiceToSyslog(AvahiService):
510
def rename(self, *args, **kwargs):
375
511
"""Add the new name to the syslog messages"""
376
ret = AvahiService.rename(self)
377
syslogger.setFormatter(logging.Formatter
378
('Mandos (%s) [%%(process)d]:'
379
' %%(levelname)s: %%(message)s'
512
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
513
syslogger.setFormatter(logging.Formatter(
514
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
383
def timedelta_to_milliseconds(td):
384
"Convert a datetime.timedelta() to milliseconds"
385
return ((td.days * 24 * 60 * 60 * 1000)
386
+ (td.seconds * 1000)
387
+ (td.microseconds // 1000))
389
class Client(object):
519
# Pretend that we have a GnuTLS module
521
"""This isn't so much a class as it is a module-like namespace."""
523
library = ctypes.util.find_library("gnutls")
525
library = ctypes.util.find_library("gnutls-deb0")
526
_library = ctypes.cdll.LoadLibrary(library)
529
# Unless otherwise indicated, the constants and types below are
530
# all from the gnutls/gnutls.h C header file.
541
E_NO_CERTIFICATE_FOUND = -49
546
KEYID_USE_SHA256 = 1 # gnutls/x509.h
547
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
550
class session_int(ctypes.Structure):
552
session_t = ctypes.POINTER(session_int)
554
class certificate_credentials_st(ctypes.Structure):
556
certificate_credentials_t = ctypes.POINTER(
557
certificate_credentials_st)
558
certificate_type_t = ctypes.c_int
560
class datum_t(ctypes.Structure):
561
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
562
('size', ctypes.c_uint)]
564
class openpgp_crt_int(ctypes.Structure):
566
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
567
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
568
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
569
credentials_type_t = ctypes.c_int
570
transport_ptr_t = ctypes.c_void_p
571
close_request_t = ctypes.c_int
574
class Error(Exception):
575
def __init__(self, message=None, code=None, args=()):
576
# Default usage is by a message string, but if a return
577
# code is passed, convert it to a string with
580
if message is None and code is not None:
581
message = gnutls.strerror(code)
582
return super(gnutls.Error, self).__init__(
585
class CertificateSecurityError(Error):
591
self._c_object = gnutls.certificate_credentials_t()
592
gnutls.certificate_allocate_credentials(
593
ctypes.byref(self._c_object))
594
self.type = gnutls.CRD_CERTIFICATE
597
gnutls.certificate_free_credentials(self._c_object)
600
def __init__(self, socket, credentials=None):
601
self._c_object = gnutls.session_t()
602
gnutls_flags = gnutls.CLIENT
603
if gnutls.check_version(b"3.5.6"):
604
gnutls_flags |= gnutls.NO_TICKETS
606
gnutls_flags |= gnutls.ENABLE_RAWPK
607
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
609
gnutls.set_default_priority(self._c_object)
610
gnutls.transport_set_ptr(self._c_object, socket.fileno())
611
gnutls.handshake_set_private_extensions(self._c_object,
614
if credentials is None:
615
credentials = gnutls.Credentials()
616
gnutls.credentials_set(self._c_object, credentials.type,
617
ctypes.cast(credentials._c_object,
619
self.credentials = credentials
622
gnutls.deinit(self._c_object)
625
return gnutls.handshake(self._c_object)
627
def send(self, data):
631
data_len -= gnutls.record_send(self._c_object,
636
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
638
# Error handling functions
639
def _error_code(result):
640
"""A function to raise exceptions on errors, suitable
641
for the 'restype' attribute on ctypes functions"""
644
if result == gnutls.E_NO_CERTIFICATE_FOUND:
645
raise gnutls.CertificateSecurityError(code=result)
646
raise gnutls.Error(code=result)
648
def _retry_on_error(result, func, arguments):
649
"""A function to retry on some errors, suitable
650
for the 'errcheck' attribute on ctypes functions"""
652
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
653
return _error_code(result)
654
result = func(*arguments)
657
# Unless otherwise indicated, the function declarations below are
658
# all from the gnutls/gnutls.h C header file.
661
priority_set_direct = _library.gnutls_priority_set_direct
662
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
663
ctypes.POINTER(ctypes.c_char_p)]
664
priority_set_direct.restype = _error_code
666
init = _library.gnutls_init
667
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
668
init.restype = _error_code
670
set_default_priority = _library.gnutls_set_default_priority
671
set_default_priority.argtypes = [session_t]
672
set_default_priority.restype = _error_code
674
record_send = _library.gnutls_record_send
675
record_send.argtypes = [session_t, ctypes.c_void_p,
677
record_send.restype = ctypes.c_ssize_t
678
record_send.errcheck = _retry_on_error
680
certificate_allocate_credentials = (
681
_library.gnutls_certificate_allocate_credentials)
682
certificate_allocate_credentials.argtypes = [
683
ctypes.POINTER(certificate_credentials_t)]
684
certificate_allocate_credentials.restype = _error_code
686
certificate_free_credentials = (
687
_library.gnutls_certificate_free_credentials)
688
certificate_free_credentials.argtypes = [
689
certificate_credentials_t]
690
certificate_free_credentials.restype = None
692
handshake_set_private_extensions = (
693
_library.gnutls_handshake_set_private_extensions)
694
handshake_set_private_extensions.argtypes = [session_t,
696
handshake_set_private_extensions.restype = None
698
credentials_set = _library.gnutls_credentials_set
699
credentials_set.argtypes = [session_t, credentials_type_t,
701
credentials_set.restype = _error_code
703
strerror = _library.gnutls_strerror
704
strerror.argtypes = [ctypes.c_int]
705
strerror.restype = ctypes.c_char_p
707
certificate_type_get = _library.gnutls_certificate_type_get
708
certificate_type_get.argtypes = [session_t]
709
certificate_type_get.restype = _error_code
711
certificate_get_peers = _library.gnutls_certificate_get_peers
712
certificate_get_peers.argtypes = [session_t,
713
ctypes.POINTER(ctypes.c_uint)]
714
certificate_get_peers.restype = ctypes.POINTER(datum_t)
716
global_set_log_level = _library.gnutls_global_set_log_level
717
global_set_log_level.argtypes = [ctypes.c_int]
718
global_set_log_level.restype = None
720
global_set_log_function = _library.gnutls_global_set_log_function
721
global_set_log_function.argtypes = [log_func]
722
global_set_log_function.restype = None
724
deinit = _library.gnutls_deinit
725
deinit.argtypes = [session_t]
726
deinit.restype = None
728
handshake = _library.gnutls_handshake
729
handshake.argtypes = [session_t]
730
handshake.restype = _error_code
731
handshake.errcheck = _retry_on_error
733
transport_set_ptr = _library.gnutls_transport_set_ptr
734
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
735
transport_set_ptr.restype = None
737
bye = _library.gnutls_bye
738
bye.argtypes = [session_t, close_request_t]
739
bye.restype = _error_code
740
bye.errcheck = _retry_on_error
742
check_version = _library.gnutls_check_version
743
check_version.argtypes = [ctypes.c_char_p]
744
check_version.restype = ctypes.c_char_p
746
_need_version = b"3.3.0"
747
if check_version(_need_version) is None:
748
raise self.Error("Needs GnuTLS {} or later"
749
.format(_need_version))
751
_tls_rawpk_version = b"3.6.6"
752
has_rawpk = bool(check_version(_tls_rawpk_version))
756
class pubkey_st(ctypes.Structure):
758
pubkey_t = ctypes.POINTER(pubkey_st)
760
x509_crt_fmt_t = ctypes.c_int
762
# All the function declarations below are from gnutls/abstract.h
763
pubkey_init = _library.gnutls_pubkey_init
764
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
765
pubkey_init.restype = _error_code
767
pubkey_import = _library.gnutls_pubkey_import
768
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
770
pubkey_import.restype = _error_code
772
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
773
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
774
ctypes.POINTER(ctypes.c_ubyte),
775
ctypes.POINTER(ctypes.c_size_t)]
776
pubkey_get_key_id.restype = _error_code
778
pubkey_deinit = _library.gnutls_pubkey_deinit
779
pubkey_deinit.argtypes = [pubkey_t]
780
pubkey_deinit.restype = None
782
# All the function declarations below are from gnutls/openpgp.h
784
openpgp_crt_init = _library.gnutls_openpgp_crt_init
785
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
786
openpgp_crt_init.restype = _error_code
788
openpgp_crt_import = _library.gnutls_openpgp_crt_import
789
openpgp_crt_import.argtypes = [openpgp_crt_t,
790
ctypes.POINTER(datum_t),
792
openpgp_crt_import.restype = _error_code
794
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
795
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
796
ctypes.POINTER(ctypes.c_uint)]
797
openpgp_crt_verify_self.restype = _error_code
799
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
800
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
801
openpgp_crt_deinit.restype = None
803
openpgp_crt_get_fingerprint = (
804
_library.gnutls_openpgp_crt_get_fingerprint)
805
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
809
openpgp_crt_get_fingerprint.restype = _error_code
811
if check_version(b"3.6.4"):
812
certificate_type_get2 = _library.gnutls_certificate_type_get2
813
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
814
certificate_type_get2.restype = _error_code
816
# Remove non-public functions
817
del _error_code, _retry_on_error
820
def call_pipe(connection, # : multiprocessing.Connection
821
func, *args, **kwargs):
822
"""This function is meant to be called by multiprocessing.Process
824
This function runs func(*args, **kwargs), and writes the resulting
825
return value on the provided multiprocessing.Connection.
827
connection.send(func(*args, **kwargs))
390
832
"""A representation of a client host served by this server.
393
835
approved: bool(); 'None' if not yet approved/disapproved
394
836
approval_delay: datetime.timedelta(); Time to wait for approval
395
837
approval_duration: datetime.timedelta(); Duration of one approval
396
checker: subprocess.Popen(); a running checker process used
397
to see if the client lives.
398
'None' if no process is running.
399
checker_callback_tag: a gobject event source tag, or None
838
checker: multiprocessing.Process(); a running checker process used
839
to see if the client lives. 'None' if no process is
841
checker_callback_tag: a GLib event source tag, or None
400
842
checker_command: string; External command which is run to check
401
843
if client lives. %() expansions are done at
402
844
runtime with vars(self) as dict, so that for
403
845
instance %(name)s can be used in the command.
404
checker_initiator_tag: a gobject event source tag, or None
846
checker_initiator_tag: a GLib event source tag, or None
405
847
created: datetime.datetime(); (UTC) object creation
406
848
client_structure: Object describing what attributes a client has
407
849
and is used for storing the client at exit
408
850
current_checker_command: string; current running checker_command
409
disable_initiator_tag: a gobject event source tag, or None
851
disable_initiator_tag: a GLib event source tag, or None
411
853
fingerprint: string (40 or 32 hexadecimal digits); used to
412
uniquely identify the client
854
uniquely identify an OpenPGP client
855
key_id: string (64 hexadecimal digits); used to uniquely identify
856
a client using raw public keys
413
857
host: string; available for use by the checker command
414
858
interval: datetime.timedelta(); How often to start a new checker
415
859
last_approval_request: datetime.datetime(); (UTC) or None
542
980
self.current_checker_command = None
543
981
self.approved = None
544
982
self.approvals_pending = 0
545
self.changedstate = (multiprocessing_manager
546
.Condition(multiprocessing_manager
548
self.client_structure = [attr for attr in
549
self.__dict__.iterkeys()
983
self.changedstate = multiprocessing_manager.Condition(
984
multiprocessing_manager.Lock())
985
self.client_structure = [attr
986
for attr in self.__dict__.keys()
550
987
if not attr.startswith("_")]
551
988
self.client_structure.append("client_structure")
553
for name, t in inspect.getmembers(type(self),
990
for name, t in inspect.getmembers(
991
type(self), lambda obj: isinstance(obj, property)):
557
992
if not name.startswith("_"):
558
993
self.client_structure.append(name)
560
995
# Send notice to process children that client state has changed
561
996
def send_changedstate(self):
562
997
with self.changedstate:
563
998
self.changedstate.notify_all()
565
1000
def enable(self):
566
1001
"""Start this client's checker and timeout hooks"""
567
1002
if getattr(self, "enabled", False):
568
1003
# Already enabled
570
self.send_changedstate()
571
1005
self.expires = datetime.datetime.utcnow() + self.timeout
572
1006
self.enabled = True
573
1007
self.last_enabled = datetime.datetime.utcnow()
574
1008
self.init_checker()
1009
self.send_changedstate()
576
1011
def disable(self, quiet=True):
577
1012
"""Disable this client."""
578
1013
if not getattr(self, "enabled", False):
581
self.send_changedstate()
583
1016
logger.info("Disabling client %s", self.name)
584
if getattr(self, "disable_initiator_tag", False):
585
gobject.source_remove(self.disable_initiator_tag)
1017
if getattr(self, "disable_initiator_tag", None) is not None:
1018
GLib.source_remove(self.disable_initiator_tag)
586
1019
self.disable_initiator_tag = None
587
1020
self.expires = None
588
if getattr(self, "checker_initiator_tag", False):
589
gobject.source_remove(self.checker_initiator_tag)
1021
if getattr(self, "checker_initiator_tag", None) is not None:
1022
GLib.source_remove(self.checker_initiator_tag)
590
1023
self.checker_initiator_tag = None
591
1024
self.stop_checker()
592
1025
self.enabled = False
593
# Do not run this again if called by a gobject.timeout_add
1027
self.send_changedstate()
1028
# Do not run this again if called by a GLib.timeout_add
596
1031
def __del__(self):
599
1034
def init_checker(self):
600
1035
# Schedule a new checker to be started an 'interval' from now,
601
1036
# and every interval from then on.
602
self.checker_initiator_tag = (gobject.timeout_add
603
(self.interval_milliseconds(),
1037
if self.checker_initiator_tag is not None:
1038
GLib.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = GLib.timeout_add(
1040
int(self.interval.total_seconds() * 1000),
605
1042
# Schedule a disable() when 'timeout' has passed
606
self.disable_initiator_tag = (gobject.timeout_add
607
(self.timeout_milliseconds(),
1043
if self.disable_initiator_tag is not None:
1044
GLib.source_remove(self.disable_initiator_tag)
1045
self.disable_initiator_tag = GLib.timeout_add(
1046
int(self.timeout.total_seconds() * 1000), self.disable)
609
1047
# Also start a new checker *right now*.
610
1048
self.start_checker()
612
def checker_callback(self, pid, condition, command):
1050
def checker_callback(self, source, condition, connection,
613
1052
"""The checker has completed, so take appropriate actions."""
1053
# Read return code from connection (see call_pipe)
1054
returncode = connection.recv()
1056
if self.checker is not None:
614
1058
self.checker_callback_tag = None
615
1059
self.checker = None
616
if os.WIFEXITED(condition):
617
self.last_checker_status = os.WEXITSTATUS(condition)
1062
self.last_checker_status = returncode
1063
self.last_checker_signal = None
618
1064
if self.last_checker_status == 0:
619
1065
logger.info("Checker for %(name)s succeeded",
621
1067
self.checked_ok()
623
logger.info("Checker for %(name)s failed",
1069
logger.info("Checker for %(name)s failed", vars(self))
626
1071
self.last_checker_status = -1
1072
self.last_checker_signal = -returncode
627
1073
logger.warning("Checker for %(name)s crashed?",
630
1077
def checked_ok(self):
631
1078
"""Assert that the client has been seen, alive and well."""
632
1079
self.last_checked_ok = datetime.datetime.utcnow()
633
1080
self.last_checker_status = 0
1081
self.last_checker_signal = None
634
1082
self.bump_timeout()
636
1084
def bump_timeout(self, timeout=None):
637
1085
"""Bump up the timeout for this client."""
638
1086
if timeout is None:
639
1087
timeout = self.timeout
640
1088
if self.disable_initiator_tag is not None:
641
gobject.source_remove(self.disable_initiator_tag)
1089
GLib.source_remove(self.disable_initiator_tag)
1090
self.disable_initiator_tag = None
642
1091
if getattr(self, "enabled", False):
643
self.disable_initiator_tag = (gobject.timeout_add
644
(timedelta_to_milliseconds
645
(timeout), self.disable))
1092
self.disable_initiator_tag = GLib.timeout_add(
1093
int(timeout.total_seconds() * 1000), self.disable)
646
1094
self.expires = datetime.datetime.utcnow() + timeout
648
1096
def need_approval(self):
649
1097
self.last_approval_request = datetime.datetime.utcnow()
651
1099
def start_checker(self):
652
1100
"""Start a new checker subprocess if one is not running.
654
1102
If a checker already exists, leave it running and do
656
1104
# The reason for not killing a running checker is that if we
657
# did that, then if a checker (for some reason) started
658
# running slowly and taking more than 'interval' time, the
659
# client would inevitably timeout, since no checker would get
660
# a chance to run to completion. If we instead leave running
1105
# did that, and if a checker (for some reason) started running
1106
# slowly and taking more than 'interval' time, then the client
1107
# would inevitably timeout, since no checker would get a
1108
# chance to run to completion. If we instead leave running
661
1109
# checkers alone, the checker would have to take more time
662
1110
# than 'timeout' for the client to be disabled, which is as it
665
# If a checker exists, make sure it is not a zombie
667
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
668
except (AttributeError, OSError) as error:
669
if (isinstance(error, OSError)
670
and error.errno != errno.ECHILD):
674
logger.warning("Checker was a zombie")
675
gobject.source_remove(self.checker_callback_tag)
676
self.checker_callback(pid, status,
677
self.current_checker_command)
1113
if self.checker is not None and not self.checker.is_alive():
1114
logger.warning("Checker was not alive; joining")
678
1117
# Start a new checker if needed
679
1118
if self.checker is None:
1119
# Escape attributes for the shell
1121
attr: re.escape(str(getattr(self, attr)))
1122
for attr in self.runtime_expansions}
681
# In case checker_command has exactly one % operator
682
command = self.checker_command % self.host
684
# Escape attributes for the shell
685
escaped_attrs = dict(
687
re.escape(unicode(str(getattr(self, attr, "")),
691
self.runtime_expansions)
694
command = self.checker_command % escaped_attrs
695
except TypeError as error:
696
logger.error('Could not format string "%s":'
697
' %s', self.checker_command, error)
698
return True # Try again later
1124
command = self.checker_command % escaped_attrs
1125
except TypeError as error:
1126
logger.error('Could not format string "%s"',
1127
self.checker_command,
1129
return True # Try again later
699
1130
self.current_checker_command = command
701
logger.info("Starting checker %r for %s",
703
# We don't need to redirect stdout and stderr, since
704
# in normal mode, that is already done by daemon(),
705
# and in debug mode we don't want to. (Stdin is
706
# always replaced by /dev/null.)
707
self.checker = subprocess.Popen(command,
710
self.checker_callback_tag = (gobject.child_watch_add
712
self.checker_callback,
714
# The checker may have completed before the gobject
715
# watch was added. Check for this.
716
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
718
gobject.source_remove(self.checker_callback_tag)
719
self.checker_callback(pid, status, command)
720
except OSError as error:
721
logger.error("Failed to start subprocess: %s",
723
# Re-run this periodically if run by gobject.timeout_add
1131
logger.info("Starting checker %r for %s", command,
1133
# We don't need to redirect stdout and stderr, since
1134
# in normal mode, that is already done by daemon(),
1135
# and in debug mode we don't want to. (Stdin is
1136
# always replaced by /dev/null.)
1137
# The exception is when not debugging but nevertheless
1138
# running in the foreground; use the previously
1140
popen_args = {"close_fds": True,
1143
if (not self.server_settings["debug"]
1144
and self.server_settings["foreground"]):
1145
popen_args.update({"stdout": wnull,
1147
pipe = multiprocessing.Pipe(duplex=False)
1148
self.checker = multiprocessing.Process(
1150
args=(pipe[1], subprocess.call, command),
1152
self.checker.start()
1153
self.checker_callback_tag = GLib.io_add_watch(
1154
GLib.IOChannel.unix_new(pipe[0].fileno()),
1155
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1156
self.checker_callback, pipe[0], command)
1157
# Re-run this periodically if run by GLib.timeout_add
726
1160
def stop_checker(self):
727
1161
"""Force the checker process, if any, to stop."""
728
1162
if self.checker_callback_tag:
729
gobject.source_remove(self.checker_callback_tag)
1163
GLib.source_remove(self.checker_callback_tag)
730
1164
self.checker_callback_tag = None
731
1165
if getattr(self, "checker", None) is None:
733
1167
logger.debug("Stopping checker for %(name)s", vars(self))
735
os.kill(self.checker.pid, signal.SIGTERM)
737
#if self.checker.poll() is None:
738
# os.kill(self.checker.pid, signal.SIGKILL)
739
except OSError as error:
740
if error.errno != errno.ESRCH: # No such process
1168
self.checker.terminate()
742
1169
self.checker = None
745
def dbus_service_property(dbus_interface, signature="v",
746
access="readwrite", byte_arrays=False):
1172
def dbus_service_property(dbus_interface,
747
1176
"""Decorators for marking methods of a DBusObjectWithProperties to
748
1177
become properties on the D-Bus.
750
1179
The decorated method will be called with no arguments by "Get"
751
1180
and with one argument by "Set".
753
1182
The parameters, where they are supported, are the same as
754
1183
dbus.service.method, except there is only "signature", since the
755
1184
type from Get() and the type sent to Set() is the same.
813
class DBusObjectWithProperties(dbus.service.Object):
814
"""A D-Bus object with properties.
816
Classes inheriting from this can use the dbus_service_property
817
decorator to expose methods as D-Bus properties. It exposes the
818
standard Get(), Set(), and GetAll() methods on the D-Bus.
1267
class DBusObjectWithAnnotations(dbus.service.Object):
1268
"""A D-Bus object with annotations.
1270
Classes inheriting from this can use the dbus_annotations
1271
decorator to add annotations to methods or signals.
822
1275
def _is_dbus_thing(thing):
823
1276
"""Returns a function testing if an attribute is a D-Bus thing
825
1278
If called like _is_dbus_thing("method") it returns a function
826
1279
suitable for use as predicate to inspect.getmembers().
828
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1281
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
831
1284
def _get_all_dbus_things(self, thing):
832
1285
"""Returns a generator of (name, attribute) pairs
834
return ((athing.__get__(self)._dbus_name,
1287
return ((getattr(athing.__get__(self), "_dbus_name", name),
835
1288
athing.__get__(self))
836
1289
for cls in self.__class__.__mro__
837
1290
for name, athing in
838
inspect.getmembers(cls,
839
self._is_dbus_thing(thing)))
1291
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1293
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1295
path_keyword='object_path',
1296
connection_keyword='connection')
1297
def Introspect(self, object_path, connection):
1298
"""Overloading of standard D-Bus method.
1300
Inserts annotation tags on methods and signals.
1302
xmlstring = dbus.service.Object.Introspect(self, object_path,
1305
document = xml.dom.minidom.parseString(xmlstring)
1307
for if_tag in document.getElementsByTagName("interface"):
1308
# Add annotation tags
1309
for typ in ("method", "signal"):
1310
for tag in if_tag.getElementsByTagName(typ):
1312
for name, prop in (self.
1313
_get_all_dbus_things(typ)):
1314
if (name == tag.getAttribute("name")
1315
and prop._dbus_interface
1316
== if_tag.getAttribute("name")):
1317
annots.update(getattr(
1318
prop, "_dbus_annotations", {}))
1319
for name, value in annots.items():
1320
ann_tag = document.createElement(
1322
ann_tag.setAttribute("name", name)
1323
ann_tag.setAttribute("value", value)
1324
tag.appendChild(ann_tag)
1325
# Add interface annotation tags
1326
for annotation, value in dict(
1327
itertools.chain.from_iterable(
1328
annotations().items()
1329
for name, annotations
1330
in self._get_all_dbus_things("interface")
1331
if name == if_tag.getAttribute("name")
1333
ann_tag = document.createElement("annotation")
1334
ann_tag.setAttribute("name", annotation)
1335
ann_tag.setAttribute("value", value)
1336
if_tag.appendChild(ann_tag)
1337
# Fix argument name for the Introspect method itself
1338
if (if_tag.getAttribute("name")
1339
== dbus.INTROSPECTABLE_IFACE):
1340
for cn in if_tag.getElementsByTagName("method"):
1341
if cn.getAttribute("name") == "Introspect":
1342
for arg in cn.getElementsByTagName("arg"):
1343
if (arg.getAttribute("direction")
1345
arg.setAttribute("name",
1347
xmlstring = document.toxml("utf-8")
1349
except (AttributeError, xml.dom.DOMException,
1350
xml.parsers.expat.ExpatError) as error:
1351
logger.error("Failed to override Introspection method",
1356
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1357
"""A D-Bus object with properties.
1359
Classes inheriting from this can use the dbus_service_property
1360
decorator to expose methods as D-Bus properties. It exposes the
1361
standard Get(), Set(), and GetAll() methods on the D-Bus.
841
1364
def _get_dbus_property(self, interface_name, property_name):
842
1365
"""Returns a bound method if one exists which is a D-Bus
843
1366
property with the specified name and interface.
845
for cls in self.__class__.__mro__:
846
for name, value in (inspect.getmembers
848
self._is_dbus_thing("property"))):
1368
for cls in self.__class__.__mro__:
1369
for name, value in inspect.getmembers(
1370
cls, self._is_dbus_thing("property")):
849
1371
if (value._dbus_name == property_name
850
1372
and value._dbus_interface == interface_name):
851
1373
return value.__get__(self)
853
1375
# No such property
854
raise DBusPropertyNotFound(self.dbus_object_path + ":"
855
+ interface_name + "."
858
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1376
raise DBusPropertyNotFound("{}:{}.{}".format(
1377
self.dbus_object_path, interface_name, property_name))
1380
def _get_all_interface_names(cls):
1381
"""Get a sequence of all interfaces supported by an object"""
1382
return (name for name in set(getattr(getattr(x, attr),
1383
"_dbus_interface", None)
1384
for x in (inspect.getmro(cls))
1386
if name is not None)
1388
@dbus.service.method(dbus.PROPERTIES_IFACE,
859
1390
out_signature="v")
860
1391
def Get(self, interface_name, property_name):
861
1392
"""Standard D-Bus property Get() method, see D-Bus standard.
968
1517
except (AttributeError, xml.dom.DOMException,
969
1518
xml.parsers.expat.ExpatError) as error:
970
1519
logger.error("Failed to override Introspection method",
975
def datetime_to_dbus (dt, variant_level=0):
1525
dbus.OBJECT_MANAGER_IFACE
1526
except AttributeError:
1527
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1530
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1531
"""A D-Bus object with an ObjectManager.
1533
Classes inheriting from this exposes the standard
1534
GetManagedObjects call and the InterfacesAdded and
1535
InterfacesRemoved signals on the standard
1536
"org.freedesktop.DBus.ObjectManager" interface.
1538
Note: No signals are sent automatically; they must be sent
1541
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1542
out_signature="a{oa{sa{sv}}}")
1543
def GetManagedObjects(self):
1544
"""This function must be overridden"""
1545
raise NotImplementedError()
1547
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1548
signature="oa{sa{sv}}")
1549
def InterfacesAdded(self, object_path, interfaces_and_properties):
1552
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1553
def InterfacesRemoved(self, object_path, interfaces):
1556
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1558
path_keyword='object_path',
1559
connection_keyword='connection')
1560
def Introspect(self, object_path, connection):
1561
"""Overloading of standard D-Bus method.
1563
Override return argument name of GetManagedObjects to be
1564
"objpath_interfaces_and_properties"
1566
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1570
document = xml.dom.minidom.parseString(xmlstring)
1572
for if_tag in document.getElementsByTagName("interface"):
1573
# Fix argument name for the GetManagedObjects method
1574
if (if_tag.getAttribute("name")
1575
== dbus.OBJECT_MANAGER_IFACE):
1576
for cn in if_tag.getElementsByTagName("method"):
1577
if (cn.getAttribute("name")
1578
== "GetManagedObjects"):
1579
for arg in cn.getElementsByTagName("arg"):
1580
if (arg.getAttribute("direction")
1584
"objpath_interfaces"
1586
xmlstring = document.toxml("utf-8")
1588
except (AttributeError, xml.dom.DOMException,
1589
xml.parsers.expat.ExpatError) as error:
1590
logger.error("Failed to override Introspection method",
1595
def datetime_to_dbus(dt, variant_level=0):
976
1596
"""Convert a UTC datetime.datetime() to a D-Bus type."""
978
return dbus.String("", variant_level = variant_level)
979
return dbus.String(dt.isoformat(),
980
variant_level=variant_level)
983
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
985
"""Applied to an empty subclass of a D-Bus object, this metaclass
986
will add additional D-Bus attributes matching a certain pattern.
1598
return dbus.String("", variant_level=variant_level)
1599
return dbus.String(dt.isoformat(), variant_level=variant_level)
1602
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1603
"""A class decorator; applied to a subclass of
1604
dbus.service.Object, it will add alternate D-Bus attributes with
1605
interface names according to the "alt_interface_names" mapping.
1608
@alternate_dbus_interfaces({"org.example.Interface":
1609
"net.example.AlternateInterface"})
1610
class SampleDBusObject(dbus.service.Object):
1611
@dbus.service.method("org.example.Interface")
1612
def SampleDBusMethod():
1615
The above "SampleDBusMethod" on "SampleDBusObject" will be
1616
reachable via two interfaces: "org.example.Interface" and
1617
"net.example.AlternateInterface", the latter of which will have
1618
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1619
"true", unless "deprecate" is passed with a False value.
1621
This works for methods and signals, and also for D-Bus properties
1622
(from DBusObjectWithProperties) and interfaces (from the
1623
dbus_interface_annotations decorator).
988
def __new__(mcs, name, bases, attr):
989
# Go through all the base classes which could have D-Bus
990
# methods, signals, or properties in them
991
old_interface_names = []
992
for base in (b for b in bases
993
if issubclass(b, dbus.service.Object)):
994
# Go though all attributes of the base class
995
for attrname, attribute in inspect.getmembers(base):
1627
for orig_interface_name, alt_interface_name in (
1628
alt_interface_names.items()):
1630
interface_names = set()
1631
# Go though all attributes of the class
1632
for attrname, attribute in inspect.getmembers(cls):
996
1633
# Ignore non-D-Bus attributes, and D-Bus attributes
997
1634
# with the wrong interface name
998
1635
if (not hasattr(attribute, "_dbus_interface")
999
or not attribute._dbus_interface
1000
.startswith("se.recompile.Mandos")):
1636
or not attribute._dbus_interface.startswith(
1637
orig_interface_name)):
1002
1639
# Create an alternate D-Bus interface name based on
1003
1640
# the current name
1004
alt_interface = (attribute._dbus_interface
1005
.replace("se.recompile.Mandos",
1006
"se.bsnet.fukt.Mandos"))
1007
if alt_interface != attribute._dbus_interface:
1008
old_interface_names.append(alt_interface)
1641
alt_interface = attribute._dbus_interface.replace(
1642
orig_interface_name, alt_interface_name)
1643
interface_names.add(alt_interface)
1009
1644
# Is this a D-Bus signal?
1010
1645
if getattr(attribute, "_dbus_is_signal", False):
1011
# Extract the original non-method function by
1013
nonmethod_func = (dict(
1646
# Extract the original non-method undecorated
1647
# function by black magic
1648
if sys.version_info.major == 2:
1649
nonmethod_func = (dict(
1014
1650
zip(attribute.func_code.co_freevars,
1015
attribute.__closure__))["func"]
1651
attribute.__closure__))
1652
["func"].cell_contents)
1654
nonmethod_func = (dict(
1655
zip(attribute.__code__.co_freevars,
1656
attribute.__closure__))
1657
["func"].cell_contents)
1017
1658
# Create a new, but exactly alike, function
1018
1659
# object, and decorate it to be a new D-Bus signal
1019
1660
# with the alternate D-Bus interface name
1020
new_function = (dbus.service.signal
1022
attribute._dbus_signature)
1023
(types.FunctionType(
1024
nonmethod_func.func_code,
1025
nonmethod_func.func_globals,
1026
nonmethod_func.func_name,
1027
nonmethod_func.func_defaults,
1028
nonmethod_func.func_closure)))
1661
new_function = copy_function(nonmethod_func)
1662
new_function = (dbus.service.signal(
1664
attribute._dbus_signature)(new_function))
1665
# Copy annotations, if any
1667
new_function._dbus_annotations = dict(
1668
attribute._dbus_annotations)
1669
except AttributeError:
1029
1672
# Define a creator of a function to call both the
1030
# old and new functions, so both the old and new
1031
# signals gets sent when the function is called
1673
# original and alternate functions, so both the
1674
# original and alternate signals gets sent when
1675
# the function is called
1032
1676
def fixscope(func1, func2):
1033
1677
"""This function is a scope container to pass
1034
1678
func1 and func2 to the "call_both" function
1035
1679
outside of its arguments"""
1681
@functools.wraps(func2)
1036
1682
def call_both(*args, **kwargs):
1037
1683
"""This function will emit two D-Bus
1038
1684
signals by calling func1 and func2"""
1039
1685
func1(*args, **kwargs)
1040
1686
func2(*args, **kwargs)
1687
# Make wrapper function look like a D-Bus
1689
for name, attr in inspect.getmembers(func2):
1690
if name.startswith("_dbus_"):
1691
setattr(call_both, name, attr)
1041
1693
return call_both
1042
1694
# Create the "call_both" function and add it to
1044
attr[attrname] = fixscope(attribute,
1696
attr[attrname] = fixscope(attribute, new_function)
1046
1697
# Is this a D-Bus method?
1047
1698
elif getattr(attribute, "_dbus_is_method", False):
1048
1699
# Create a new, but exactly alike, function
1049
1700
# object. Decorate it to be a new D-Bus method
1050
1701
# with the alternate D-Bus interface name. Add it
1051
1702
# to the class.
1052
attr[attrname] = (dbus.service.method
1054
attribute._dbus_in_signature,
1055
attribute._dbus_out_signature)
1057
(attribute.func_code,
1058
attribute.func_globals,
1059
attribute.func_name,
1060
attribute.func_defaults,
1061
attribute.func_closure)))
1704
dbus.service.method(
1706
attribute._dbus_in_signature,
1707
attribute._dbus_out_signature)
1708
(copy_function(attribute)))
1709
# Copy annotations, if any
1711
attr[attrname]._dbus_annotations = dict(
1712
attribute._dbus_annotations)
1713
except AttributeError:
1062
1715
# Is this a D-Bus property?
1063
1716
elif getattr(attribute, "_dbus_is_property", False):
1064
1717
# Create a new, but exactly alike, function
1065
1718
# object, and decorate it to be a new D-Bus
1066
1719
# property with the alternate D-Bus interface
1067
1720
# name. Add it to the class.
1068
attr[attrname] = (dbus_service_property
1070
attribute._dbus_signature,
1071
attribute._dbus_access,
1073
._dbus_get_args_options
1076
(attribute.func_code,
1077
attribute.func_globals,
1078
attribute.func_name,
1079
attribute.func_defaults,
1080
attribute.func_closure)))
1721
attr[attrname] = (dbus_service_property(
1722
alt_interface, attribute._dbus_signature,
1723
attribute._dbus_access,
1724
attribute._dbus_get_args_options
1726
(copy_function(attribute)))
1727
# Copy annotations, if any
1729
attr[attrname]._dbus_annotations = dict(
1730
attribute._dbus_annotations)
1731
except AttributeError:
1081
1733
# Is this a D-Bus interface?
1082
1734
elif getattr(attribute, "_dbus_is_interface", False):
1083
1735
# Create a new, but exactly alike, function
1084
1736
# object. Decorate it to be a new D-Bus interface
1085
1737
# with the alternate D-Bus interface name. Add it
1086
1738
# to the class.
1087
attr[attrname] = (dbus_interface_annotations
1090
(attribute.func_code,
1091
attribute.func_globals,
1092
attribute.func_name,
1093
attribute.func_defaults,
1094
attribute.func_closure)))
1095
# Deprecate all old interfaces
1096
basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"
1097
for old_interface_name in old_interface_names:
1098
@dbus_interface_annotations(old_interface_name)
1100
return { "org.freedesktop.DBus.Deprecated": "true" }
1101
# Find an unused name
1102
for aname in (basename.format(i) for i in
1104
if aname not in attr:
1107
return type.__new__(mcs, name, bases, attr)
1740
dbus_interface_annotations(alt_interface)
1741
(copy_function(attribute)))
1743
# Deprecate all alternate interfaces
1744
iname = "_AlternateDBusNames_interface_annotation{}"
1745
for interface_name in interface_names:
1747
@dbus_interface_annotations(interface_name)
1749
return {"org.freedesktop.DBus.Deprecated":
1751
# Find an unused name
1752
for aname in (iname.format(i)
1753
for i in itertools.count()):
1754
if aname not in attr:
1758
# Replace the class with a new subclass of it with
1759
# methods, signals, etc. as created above.
1760
if sys.version_info.major == 2:
1761
cls = type(b"{}Alternate".format(cls.__name__),
1764
cls = type("{}Alternate".format(cls.__name__),
1771
@alternate_dbus_interfaces({"se.recompile.Mandos":
1772
"se.bsnet.fukt.Mandos"})
1110
1773
class ClientDBus(Client, DBusObjectWithProperties):
1111
1774
"""A Client class using D-Bus
1114
1777
dbus_object_path: dbus.ObjectPath
1115
1778
bus: dbus.SystemBus()
1118
1781
runtime_expansions = (Client.runtime_expansions
1119
+ ("dbus_object_path",))
1782
+ ("dbus_object_path", ))
1784
_interface = "se.recompile.Mandos.Client"
1121
1786
# dbus.service.Object doesn't use super(), so we can't either.
1123
def __init__(self, bus = None, *args, **kwargs):
1788
def __init__(self, bus=None, *args, **kwargs):
1125
1790
Client.__init__(self, *args, **kwargs)
1126
1791
# Only now, when this client is initialized, can it show up on
1128
client_object_name = unicode(self.name).translate(
1793
client_object_name = str(self.name).translate(
1129
1794
{ord("."): ord("_"),
1130
1795
ord("-"): ord("_")})
1131
self.dbus_object_path = (dbus.ObjectPath
1132
("/clients/" + client_object_name))
1796
self.dbus_object_path = dbus.ObjectPath(
1797
"/clients/" + client_object_name)
1133
1798
DBusObjectWithProperties.__init__(self, self.bus,
1134
1799
self.dbus_object_path)
1136
def notifychangeproperty(transform_func,
1137
dbus_name, type_func=lambda x: x,
1801
def notifychangeproperty(transform_func, dbus_name,
1802
type_func=lambda x: x,
1804
invalidate_only=False,
1805
_interface=_interface):
1139
1806
""" Modify a variable so that it's a property which announces
1140
1807
its changes to DBus.
1142
1809
transform_fun: Function that takes a value and a variant_level
1143
1810
and transforms it to a D-Bus type.
1144
1811
dbus_name: D-Bus name of the variable
1294
1963
server to mandos-client
1298
1967
# Rejected - signal
1299
1968
@dbus.service.signal(_interface, signature="s")
1300
1969
def Rejected(self, reason):
1304
1973
# NeedApproval - signal
1305
1974
@dbus.service.signal(_interface, signature="tb")
1306
1975
def NeedApproval(self, timeout, default):
1308
1977
return self.need_approval()
1312
1981
# Approve - method
1313
1982
@dbus.service.method(_interface, in_signature="b")
1314
1983
def Approve(self, value):
1315
1984
self.approve(value)
1317
1986
# CheckedOK - method
1318
1987
@dbus.service.method(_interface)
1319
1988
def CheckedOK(self):
1320
1989
self.checked_ok()
1322
1991
# Enable - method
1992
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1323
1993
@dbus.service.method(_interface)
1324
1994
def Enable(self):
1328
1998
# StartChecker - method
1999
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1329
2000
@dbus.service.method(_interface)
1330
2001
def StartChecker(self):
1332
2003
self.start_checker()
1334
2005
# Disable - method
2006
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1335
2007
@dbus.service.method(_interface)
1336
2008
def Disable(self):
1340
2012
# StopChecker - method
2013
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1341
2014
@dbus.service.method(_interface)
1342
2015
def StopChecker(self):
1343
2016
self.stop_checker()
1347
2020
# ApprovalPending - property
1348
2021
@dbus_service_property(_interface, signature="b", access="read")
1349
2022
def ApprovalPending_dbus_property(self):
1350
2023
return dbus.Boolean(bool(self.approvals_pending))
1352
2025
# ApprovedByDefault - property
1353
@dbus_service_property(_interface, signature="b",
2026
@dbus_service_property(_interface,
1354
2028
access="readwrite")
1355
2029
def ApprovedByDefault_dbus_property(self, value=None):
1356
2030
if value is None: # get
1357
2031
return dbus.Boolean(self.approved_by_default)
1358
2032
self.approved_by_default = bool(value)
1360
2034
# ApprovalDelay - property
1361
@dbus_service_property(_interface, signature="t",
2035
@dbus_service_property(_interface,
1362
2037
access="readwrite")
1363
2038
def ApprovalDelay_dbus_property(self, value=None):
1364
2039
if value is None: # get
1365
return dbus.UInt64(self.approval_delay_milliseconds())
2040
return dbus.UInt64(self.approval_delay.total_seconds()
1366
2042
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1368
2044
# ApprovalDuration - property
1369
@dbus_service_property(_interface, signature="t",
2045
@dbus_service_property(_interface,
1370
2047
access="readwrite")
1371
2048
def ApprovalDuration_dbus_property(self, value=None):
1372
2049
if value is None: # get
1373
return dbus.UInt64(timedelta_to_milliseconds(
1374
self.approval_duration))
2050
return dbus.UInt64(self.approval_duration.total_seconds()
1375
2052
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1377
2054
# Name - property
2056
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1378
2057
@dbus_service_property(_interface, signature="s", access="read")
1379
2058
def Name_dbus_property(self):
1380
2059
return dbus.String(self.name)
2063
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2064
@dbus_service_property(_interface, signature="s", access="read")
2065
def KeyID_dbus_property(self):
2066
return dbus.String(self.key_id)
1382
2068
# Fingerprint - property
2070
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1383
2071
@dbus_service_property(_interface, signature="s", access="read")
1384
2072
def Fingerprint_dbus_property(self):
1385
2073
return dbus.String(self.fingerprint)
1387
2075
# Host - property
1388
@dbus_service_property(_interface, signature="s",
2076
@dbus_service_property(_interface,
1389
2078
access="readwrite")
1390
2079
def Host_dbus_property(self, value=None):
1391
2080
if value is None: # get
1392
2081
return dbus.String(self.host)
1393
self.host = unicode(value)
2082
self.host = str(value)
1395
2084
# Created - property
2086
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1396
2087
@dbus_service_property(_interface, signature="s", access="read")
1397
2088
def Created_dbus_property(self):
1398
2089
return datetime_to_dbus(self.created)
1400
2091
# LastEnabled - property
1401
2092
@dbus_service_property(_interface, signature="s", access="read")
1402
2093
def LastEnabled_dbus_property(self):
1403
2094
return datetime_to_dbus(self.last_enabled)
1405
2096
# Enabled - property
1406
@dbus_service_property(_interface, signature="b",
2097
@dbus_service_property(_interface,
1407
2099
access="readwrite")
1408
2100
def Enabled_dbus_property(self, value=None):
1409
2101
if value is None: # get
1416
2108
# LastCheckedOK - property
1417
@dbus_service_property(_interface, signature="s",
2109
@dbus_service_property(_interface,
1418
2111
access="readwrite")
1419
2112
def LastCheckedOK_dbus_property(self, value=None):
1420
2113
if value is not None:
1421
2114
self.checked_ok()
1423
2116
return datetime_to_dbus(self.last_checked_ok)
1425
2118
# LastCheckerStatus - property
1426
@dbus_service_property(_interface, signature="n",
2119
@dbus_service_property(_interface, signature="n", access="read")
1428
2120
def LastCheckerStatus_dbus_property(self):
1429
2121
return dbus.Int16(self.last_checker_status)
1431
2123
# Expires - property
1432
2124
@dbus_service_property(_interface, signature="s", access="read")
1433
2125
def Expires_dbus_property(self):
1434
2126
return datetime_to_dbus(self.expires)
1436
2128
# LastApprovalRequest - property
1437
2129
@dbus_service_property(_interface, signature="s", access="read")
1438
2130
def LastApprovalRequest_dbus_property(self):
1439
2131
return datetime_to_dbus(self.last_approval_request)
1441
2133
# Timeout - property
1442
@dbus_service_property(_interface, signature="t",
2134
@dbus_service_property(_interface,
1443
2136
access="readwrite")
1444
2137
def Timeout_dbus_property(self, value=None):
1445
2138
if value is None: # get
1446
return dbus.UInt64(self.timeout_milliseconds())
2139
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2140
old_timeout = self.timeout
1447
2141
self.timeout = datetime.timedelta(0, 0, 0, value)
1448
# Reschedule timeout
2142
# Reschedule disabling
1449
2143
if self.enabled:
1450
2144
now = datetime.datetime.utcnow()
1451
time_to_die = timedelta_to_milliseconds(
1452
(self.last_checked_ok + self.timeout) - now)
1453
if time_to_die <= 0:
2145
self.expires += self.timeout - old_timeout
2146
if self.expires <= now:
1454
2147
# The timeout has passed
1457
self.expires = (now +
1458
datetime.timedelta(milliseconds =
1460
2150
if (getattr(self, "disable_initiator_tag", None)
1463
gobject.source_remove(self.disable_initiator_tag)
1464
self.disable_initiator_tag = (gobject.timeout_add
2153
GLib.source_remove(self.disable_initiator_tag)
2154
self.disable_initiator_tag = GLib.timeout_add(
2155
int((self.expires - now).total_seconds() * 1000),
1468
2158
# ExtendedTimeout - property
1469
@dbus_service_property(_interface, signature="t",
2159
@dbus_service_property(_interface,
1470
2161
access="readwrite")
1471
2162
def ExtendedTimeout_dbus_property(self, value=None):
1472
2163
if value is None: # get
1473
return dbus.UInt64(self.extended_timeout_milliseconds())
2164
return dbus.UInt64(self.extended_timeout.total_seconds()
1474
2166
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1476
2168
# Interval - property
1477
@dbus_service_property(_interface, signature="t",
2169
@dbus_service_property(_interface,
1478
2171
access="readwrite")
1479
2172
def Interval_dbus_property(self, value=None):
1480
2173
if value is None: # get
1481
return dbus.UInt64(self.interval_milliseconds())
2174
return dbus.UInt64(self.interval.total_seconds() * 1000)
1482
2175
self.interval = datetime.timedelta(0, 0, 0, value)
1483
2176
if getattr(self, "checker_initiator_tag", None) is None:
1485
2178
if self.enabled:
1486
2179
# Reschedule checker run
1487
gobject.source_remove(self.checker_initiator_tag)
1488
self.checker_initiator_tag = (gobject.timeout_add
1489
(value, self.start_checker))
1490
self.start_checker() # Start one now, too
2180
GLib.source_remove(self.checker_initiator_tag)
2181
self.checker_initiator_tag = GLib.timeout_add(
2182
value, self.start_checker)
2183
self.start_checker() # Start one now, too
1492
2185
# Checker - property
1493
@dbus_service_property(_interface, signature="s",
2186
@dbus_service_property(_interface,
1494
2188
access="readwrite")
1495
2189
def Checker_dbus_property(self, value=None):
1496
2190
if value is None: # get
1497
2191
return dbus.String(self.checker_command)
1498
self.checker_command = unicode(value)
2192
self.checker_command = str(value)
1500
2194
# CheckerRunning - property
1501
@dbus_service_property(_interface, signature="b",
2195
@dbus_service_property(_interface,
1502
2197
access="readwrite")
1503
2198
def CheckerRunning_dbus_property(self, value=None):
1504
2199
if value is None: # get
1537
2240
if data[0] == 'data':
1539
2242
if data[0] == 'function':
1540
2244
def func(*args, **kwargs):
1541
2245
self._pipe.send(('funcall', name, args, kwargs))
1542
2246
return self._pipe.recv()[1]
1545
2250
def __setattr__(self, name, value):
1546
2251
if name == '_pipe':
1547
2252
return super(ProxyClient, self).__setattr__(name, value)
1548
2253
self._pipe.send(('setattr', name, value))
1551
class ClientDBusTransitional(ClientDBus):
1552
__metaclass__ = AlternateDBusNamesMetaclass
1555
2256
class ClientHandler(socketserver.BaseRequestHandler, object):
1556
2257
"""A class to handle client connections.
1558
2259
Instantiated once for each connection to handle it.
1559
2260
Note: This will run in its own forked process."""
1561
2262
def handle(self):
1562
2263
with contextlib.closing(self.server.child_pipe) as child_pipe:
1563
2264
logger.info("TCP connection from: %s",
1564
unicode(self.client_address))
2265
str(self.client_address))
1565
2266
logger.debug("Pipe FD: %d",
1566
2267
self.server.child_pipe.fileno())
1568
session = (gnutls.connection
1569
.ClientSession(self.request,
1571
.X509Credentials()))
1573
# Note: gnutls.connection.X509Credentials is really a
1574
# generic GnuTLS certificate credentials object so long as
1575
# no X.509 keys are added to it. Therefore, we can use it
1576
# here despite using OpenPGP certificates.
1578
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1579
# "+AES-256-CBC", "+SHA1",
1580
# "+COMP-NULL", "+CTYPE-OPENPGP",
2269
session = gnutls.ClientSession(self.request)
2271
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2272
# "+AES-256-CBC", "+SHA1",
2273
# "+COMP-NULL", "+CTYPE-OPENPGP",
1582
2275
# Use a fallback default, since this MUST be set.
1583
2276
priority = self.server.gnutls_priority
1584
2277
if priority is None:
1585
2278
priority = "NORMAL"
1586
(gnutls.library.functions
1587
.gnutls_priority_set_direct(session._c_object,
2279
gnutls.priority_set_direct(session._c_object,
2280
priority.encode("utf-8"),
1590
2283
# Start communication using the Mandos protocol
1591
2284
# Get protocol number
1592
2285
line = self.request.makefile().readline()
1593
2286
logger.debug("Protocol version: %r", line)
1595
2288
if int(line.strip().split()[0]) > 1:
2289
raise RuntimeError(line)
1597
2290
except (ValueError, IndexError, RuntimeError) as error:
1598
2291
logger.error("Unknown protocol version: %s", error)
1601
2294
# Start GnuTLS connection
1603
2296
session.handshake()
1604
except gnutls.errors.GNUTLSError as error:
2297
except gnutls.Error as error:
1605
2298
logger.warning("Handshake failed: %s", error)
1606
2299
# Do not run session.bye() here: the session is not
1607
2300
# established. Just abandon the request.
1609
2302
logger.debug("Handshake succeeded")
1611
2304
approval_required = False
1614
fpr = self.fingerprint(self.peer_certificate
1617
gnutls.errors.GNUTLSError) as error:
1618
logger.warning("Bad certificate: %s", error)
1620
logger.debug("Fingerprint: %s", fpr)
1623
client = ProxyClient(child_pipe, fpr,
2306
if gnutls.has_rawpk:
2309
key_id = self.key_id(
2310
self.peer_certificate(session))
2311
except (TypeError, gnutls.Error) as error:
2312
logger.warning("Bad certificate: %s", error)
2314
logger.debug("Key ID: %s", key_id)
2319
fpr = self.fingerprint(
2320
self.peer_certificate(session))
2321
except (TypeError, gnutls.Error) as error:
2322
logger.warning("Bad certificate: %s", error)
2324
logger.debug("Fingerprint: %s", fpr)
2327
client = ProxyClient(child_pipe, key_id, fpr,
1624
2328
self.client_address)
1625
2329
except KeyError:
1628
2332
if client.approval_delay:
1629
2333
delay = client.approval_delay
1630
2334
client.approvals_pending += 1
1631
2335
approval_required = True
1634
2338
if not client.enabled:
1635
2339
logger.info("Client %s is disabled",
1637
2341
if self.server.use_dbus:
1638
2342
# Emit D-Bus signal
1639
2343
client.Rejected("Disabled")
1642
2346
if client.approved or not client.approval_delay:
1643
#We are approved or approval is disabled
2347
# We are approved or approval is disabled
1645
2349
elif client.approved is None:
1646
2350
logger.info("Client %s needs approval",
1681
2383
delay -= time2 - time
1684
while sent_size < len(client.secret):
1686
sent = session.send(client.secret[sent_size:])
1687
except gnutls.errors.GNUTLSError as error:
1688
logger.warning("gnutls send failed")
1690
logger.debug("Sent: %d, remaining: %d",
1691
sent, len(client.secret)
1692
- (sent_size + sent))
2386
session.send(client.secret)
2387
except gnutls.Error as error:
2388
logger.warning("gnutls send failed",
1695
2392
logger.info("Sending secret to %s", client.name)
1696
2393
# bump the timeout using extended_timeout
1697
2394
client.bump_timeout(client.extended_timeout)
1698
2395
if self.server.use_dbus:
1699
2396
# Emit D-Bus signal
1700
2397
client.GotSecret()
1703
2400
if approval_required:
1704
2401
client.approvals_pending -= 1
1707
except gnutls.errors.GNUTLSError as error:
1708
logger.warning("GnuTLS bye failed")
2404
except gnutls.Error as error:
2405
logger.warning("GnuTLS bye failed",
1711
2409
def peer_certificate(session):
1712
"Return the peer's OpenPGP certificate as a bytestring"
1713
# If not an OpenPGP certificate...
1714
if (gnutls.library.functions
1715
.gnutls_certificate_type_get(session._c_object)
1716
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1717
# ...do the normal thing
1718
return session.peer_certificate
2410
"Return the peer's certificate as a bytestring"
2412
cert_type = gnutls.certificate_type_get2(session._c_object,
2414
except AttributeError:
2415
cert_type = gnutls.certificate_type_get(session._c_object)
2416
if gnutls.has_rawpk:
2417
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2419
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2420
# If not a valid certificate type...
2421
if cert_type not in valid_cert_types:
2422
logger.info("Cert type %r not in %r", cert_type,
2424
# ...return invalid data
1719
2426
list_size = ctypes.c_uint(1)
1720
cert_list = (gnutls.library.functions
1721
.gnutls_certificate_get_peers
2427
cert_list = (gnutls.certificate_get_peers
1722
2428
(session._c_object, ctypes.byref(list_size)))
1723
2429
if not bool(cert_list) and list_size.value != 0:
1724
raise gnutls.errors.GNUTLSError("error getting peer"
2430
raise gnutls.Error("error getting peer certificate")
1726
2431
if list_size.value == 0:
1728
2433
cert = cert_list[0]
1729
2434
return ctypes.string_at(cert.data, cert.size)
2437
def key_id(certificate):
2438
"Convert a certificate bytestring to a hexdigit key ID"
2439
# New GnuTLS "datum" with the public key
2440
datum = gnutls.datum_t(
2441
ctypes.cast(ctypes.c_char_p(certificate),
2442
ctypes.POINTER(ctypes.c_ubyte)),
2443
ctypes.c_uint(len(certificate)))
2444
# XXX all these need to be created in the gnutls "module"
2445
# New empty GnuTLS certificate
2446
pubkey = gnutls.pubkey_t()
2447
gnutls.pubkey_init(ctypes.byref(pubkey))
2448
# Import the raw public key into the certificate
2449
gnutls.pubkey_import(pubkey,
2450
ctypes.byref(datum),
2451
gnutls.X509_FMT_DER)
2452
# New buffer for the key ID
2453
buf = ctypes.create_string_buffer(32)
2454
buf_len = ctypes.c_size_t(len(buf))
2455
# Get the key ID from the raw public key into the buffer
2456
gnutls.pubkey_get_key_id(pubkey,
2457
gnutls.KEYID_USE_SHA256,
2458
ctypes.cast(ctypes.byref(buf),
2459
ctypes.POINTER(ctypes.c_ubyte)),
2460
ctypes.byref(buf_len))
2461
# Deinit the certificate
2462
gnutls.pubkey_deinit(pubkey)
2464
# Convert the buffer to a Python bytestring
2465
key_id = ctypes.string_at(buf, buf_len.value)
2466
# Convert the bytestring to hexadecimal notation
2467
hex_key_id = binascii.hexlify(key_id).upper()
1732
2471
def fingerprint(openpgp):
1733
2472
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1734
2473
# New GnuTLS "datum" with the OpenPGP public key
1735
datum = (gnutls.library.types
1736
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1739
ctypes.c_uint(len(openpgp))))
2474
datum = gnutls.datum_t(
2475
ctypes.cast(ctypes.c_char_p(openpgp),
2476
ctypes.POINTER(ctypes.c_ubyte)),
2477
ctypes.c_uint(len(openpgp)))
1740
2478
# New empty GnuTLS certificate
1741
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1742
(gnutls.library.functions
1743
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2479
crt = gnutls.openpgp_crt_t()
2480
gnutls.openpgp_crt_init(ctypes.byref(crt))
1744
2481
# Import the OpenPGP public key into the certificate
1745
(gnutls.library.functions
1746
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1747
gnutls.library.constants
1748
.GNUTLS_OPENPGP_FMT_RAW))
2482
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2483
gnutls.OPENPGP_FMT_RAW)
1749
2484
# Verify the self signature in the key
1750
2485
crtverify = ctypes.c_uint()
1751
(gnutls.library.functions
1752
.gnutls_openpgp_crt_verify_self(crt, 0,
1753
ctypes.byref(crtverify)))
2486
gnutls.openpgp_crt_verify_self(crt, 0,
2487
ctypes.byref(crtverify))
1754
2488
if crtverify.value != 0:
1755
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1756
raise (gnutls.errors.CertificateSecurityError
2489
gnutls.openpgp_crt_deinit(crt)
2490
raise gnutls.CertificateSecurityError(code
1758
2492
# New buffer for the fingerprint
1759
2493
buf = ctypes.create_string_buffer(20)
1760
2494
buf_len = ctypes.c_size_t()
1761
2495
# Get the fingerprint from the certificate into the buffer
1762
(gnutls.library.functions
1763
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1764
ctypes.byref(buf_len)))
2496
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2497
ctypes.byref(buf_len))
1765
2498
# Deinit the certificate
1766
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2499
gnutls.openpgp_crt_deinit(crt)
1767
2500
# Convert the buffer to a Python bytestring
1768
2501
fpr = ctypes.string_at(buf, buf_len.value)
1769
2502
# Convert the bytestring to hexadecimal notation
1774
class MultiprocessingMixIn(object):
2507
class MultiprocessingMixIn:
1775
2508
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1776
2510
def sub_process_main(self, request, address):
1778
2512
self.finish_request(request, address)
1779
2513
except Exception:
1780
2514
self.handle_error(request, address)
1781
2515
self.close_request(request)
1783
2517
def process_request(self, request, address):
1784
2518
"""Start a new process to process the request."""
1785
proc = multiprocessing.Process(target = self.sub_process_main,
2519
proc = multiprocessing.Process(target=self.sub_process_main,
2520
args=(request, address))
1792
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2525
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1793
2526
""" adds a pipe to the MixIn """
1794
2528
def process_request(self, request, client_address):
1795
2529
"""Overrides and wraps the original process_request().
1797
2531
This function creates a new pipe in self.pipe
1799
2533
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1801
2535
proc = MultiprocessingMixIn.process_request(self, request,
1802
2536
client_address)
1803
2537
self.child_pipe.close()
1804
2538
self.add_pipe(parent_pipe, proc)
1806
2540
def add_pipe(self, parent_pipe, proc):
1807
2541
"""Dummy function; override as necessary"""
1808
raise NotImplementedError
2542
raise NotImplementedError()
1811
2545
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1812
socketserver.TCPServer, object):
2546
socketserver.TCPServer):
1813
2547
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1816
2550
enabled: Boolean; whether this server is activated yet
1817
2551
interface: None or a network interface name (string)
1818
2552
use_ipv6: Boolean; to use IPv6 or not
1820
2555
def __init__(self, server_address, RequestHandlerClass,
1821
interface=None, use_ipv6=True):
2559
"""If socketfd is set, use that file descriptor instead of
2560
creating a new one with socket.socket().
1822
2562
self.interface = interface
1824
2564
self.address_family = socket.AF_INET6
2565
if socketfd is not None:
2566
# Save the file descriptor
2567
self.socketfd = socketfd
2568
# Save the original socket.socket() function
2569
self.socket_socket = socket.socket
2571
# To implement --socket, we monkey patch socket.socket.
2573
# (When socketserver.TCPServer is a new-style class, we
2574
# could make self.socket into a property instead of monkey
2575
# patching socket.socket.)
2577
# Create a one-time-only replacement for socket.socket()
2578
@functools.wraps(socket.socket)
2579
def socket_wrapper(*args, **kwargs):
2580
# Restore original function so subsequent calls are
2582
socket.socket = self.socket_socket
2583
del self.socket_socket
2584
# This time only, return a new socket object from the
2585
# saved file descriptor.
2586
return socket.fromfd(self.socketfd, *args, **kwargs)
2587
# Replace socket.socket() function with wrapper
2588
socket.socket = socket_wrapper
2589
# The socketserver.TCPServer.__init__ will call
2590
# socket.socket(), which might be our replacement,
2591
# socket_wrapper(), if socketfd was set.
1825
2592
socketserver.TCPServer.__init__(self, server_address,
1826
2593
RequestHandlerClass)
1827
2595
def server_bind(self):
1828
2596
"""This overrides the normal server_bind() function
1829
2597
to bind to an interface if one was specified, and also NOT to
1830
2598
bind to an address or port if they were not specified."""
2599
global SO_BINDTODEVICE
1831
2600
if self.interface is not None:
1832
2601
if SO_BINDTODEVICE is None:
1833
logger.error("SO_BINDTODEVICE does not exist;"
1834
" cannot bind to interface %s",
1838
self.socket.setsockopt(socket.SOL_SOCKET,
1842
except socket.error as error:
1843
if error[0] == errno.EPERM:
1844
logger.error("No permission to"
1845
" bind to interface %s",
1847
elif error[0] == errno.ENOPROTOOPT:
1848
logger.error("SO_BINDTODEVICE not available;"
1849
" cannot bind to interface %s",
2602
# Fall back to a hard-coded value which seems to be
2604
logger.warning("SO_BINDTODEVICE not found, trying 25")
2605
SO_BINDTODEVICE = 25
2607
self.socket.setsockopt(
2608
socket.SOL_SOCKET, SO_BINDTODEVICE,
2609
(self.interface + "\0").encode("utf-8"))
2610
except socket.error as error:
2611
if error.errno == errno.EPERM:
2612
logger.error("No permission to bind to"
2613
" interface %s", self.interface)
2614
elif error.errno == errno.ENOPROTOOPT:
2615
logger.error("SO_BINDTODEVICE not available;"
2616
" cannot bind to interface %s",
2618
elif error.errno == errno.ENODEV:
2619
logger.error("Interface %s does not exist,"
2620
" cannot bind", self.interface)
1853
2623
# Only bind(2) the socket if we really need to.
1854
2624
if self.server_address[0] or self.server_address[1]:
2625
if self.server_address[1]:
2626
self.allow_reuse_address = True
1855
2627
if not self.server_address[0]:
1856
2628
if self.address_family == socket.AF_INET6:
1857
any_address = "::" # in6addr_any
2629
any_address = "::" # in6addr_any
1859
any_address = socket.INADDR_ANY
2631
any_address = "0.0.0.0" # INADDR_ANY
1860
2632
self.server_address = (any_address,
1861
2633
self.server_address[1])
1862
2634
elif not self.server_address[1]:
1863
self.server_address = (self.server_address[0],
2635
self.server_address = (self.server_address[0], 0)
1865
2636
# if self.interface:
1866
2637
# self.server_address = (self.server_address[0],
1892
2668
self.gnutls_priority = gnutls_priority
1893
2669
IPv6_TCPServer.__init__(self, server_address,
1894
2670
RequestHandlerClass,
1895
interface = interface,
1896
use_ipv6 = use_ipv6)
2671
interface=interface,
1897
2675
def server_activate(self):
1898
2676
if self.enabled:
1899
2677
return socketserver.TCPServer.server_activate(self)
1901
2679
def enable(self):
1902
2680
self.enabled = True
1904
2682
def add_pipe(self, parent_pipe, proc):
1905
2683
# Call "handle_ipc" for both data and EOF events
1906
gobject.io_add_watch(parent_pipe.fileno(),
1907
gobject.IO_IN | gobject.IO_HUP,
1908
functools.partial(self.handle_ipc,
1913
def handle_ipc(self, source, condition, parent_pipe=None,
1914
proc = None, client_object=None):
1916
gobject.IO_IN: "IN", # There is data to read.
1917
gobject.IO_OUT: "OUT", # Data can be written (without
1919
gobject.IO_PRI: "PRI", # There is urgent data to read.
1920
gobject.IO_ERR: "ERR", # Error condition.
1921
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1922
# broken, usually for pipes and
1925
conditions_string = ' | '.join(name
1927
condition_names.iteritems()
1928
if cond & condition)
2685
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2686
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2687
functools.partial(self.handle_ipc,
2688
parent_pipe=parent_pipe,
2691
def handle_ipc(self, source, condition,
2694
client_object=None):
1929
2695
# error, or the other end of multiprocessing.Pipe has closed
1930
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2696
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1931
2697
# Wait for other process to exit
1935
2701
# Read a request from the child
1936
2702
request = parent_pipe.recv()
1937
2703
command = request[0]
1939
2705
if command == 'init':
1941
address = request[2]
1943
for c in self.clients.itervalues():
1944
if c.fingerprint == fpr:
2706
key_id = request[1].decode("ascii")
2707
fpr = request[2].decode("ascii")
2708
address = request[3]
2710
for c in self.clients.values():
2711
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2713
if key_id and c.key_id == key_id:
2716
if fpr and c.fingerprint == fpr:
1948
logger.info("Client not found for fingerprint: %s, ad"
1949
"dress: %s", fpr, address)
2720
logger.info("Client not found for key ID: %s, address"
2721
": %s", key_id or fpr, address)
1950
2722
if self.use_dbus:
1951
2723
# Emit D-Bus signal
1952
mandos_dbus_service.ClientNotFound(fpr,
2724
mandos_dbus_service.ClientNotFound(key_id or fpr,
1954
2726
parent_pipe.send(False)
1957
gobject.io_add_watch(parent_pipe.fileno(),
1958
gobject.IO_IN | gobject.IO_HUP,
1959
functools.partial(self.handle_ipc,
2730
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2731
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2732
functools.partial(self.handle_ipc,
2733
parent_pipe=parent_pipe,
2735
client_object=client))
1965
2736
parent_pipe.send(True)
1966
2737
# remove the old hook in favor of the new above hook on
1970
2741
funcname = request[1]
1971
2742
args = request[2]
1972
2743
kwargs = request[3]
1974
2745
parent_pipe.send(('data', getattr(client_object,
1975
2746
funcname)(*args,
1978
2749
if command == 'getattr':
1979
2750
attrname = request[1]
1980
if callable(client_object.__getattribute__(attrname)):
1981
parent_pipe.send(('function',))
2751
if isinstance(client_object.__getattribute__(attrname),
2752
collections.Callable):
2753
parent_pipe.send(('function', ))
1983
parent_pipe.send(('data', client_object
1984
.__getattribute__(attrname)))
2756
'data', client_object.__getattribute__(attrname)))
1986
2758
if command == 'setattr':
1987
2759
attrname = request[1]
1988
2760
value = request[2]
1989
2761
setattr(client_object, attrname, value)
2766
def rfc3339_duration_to_delta(duration):
2767
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2769
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2771
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2773
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2775
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2777
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2779
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2781
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2785
# Parsing an RFC 3339 duration with regular expressions is not
2786
# possible - there would have to be multiple places for the same
2787
# values, like seconds. The current code, while more esoteric, is
2788
# cleaner without depending on a parsing library. If Python had a
2789
# built-in library for parsing we would use it, but we'd like to
2790
# avoid excessive use of external libraries.
2792
# New type for defining tokens, syntax, and semantics all-in-one
2793
Token = collections.namedtuple("Token", (
2794
"regexp", # To match token; if "value" is not None, must have
2795
# a "group" containing digits
2796
"value", # datetime.timedelta or None
2797
"followers")) # Tokens valid after this token
2798
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2799
# the "duration" ABNF definition in RFC 3339, Appendix A.
2800
token_end = Token(re.compile(r"$"), None, frozenset())
2801
token_second = Token(re.compile(r"(\d+)S"),
2802
datetime.timedelta(seconds=1),
2803
frozenset((token_end, )))
2804
token_minute = Token(re.compile(r"(\d+)M"),
2805
datetime.timedelta(minutes=1),
2806
frozenset((token_second, token_end)))
2807
token_hour = Token(re.compile(r"(\d+)H"),
2808
datetime.timedelta(hours=1),
2809
frozenset((token_minute, token_end)))
2810
token_time = Token(re.compile(r"T"),
2812
frozenset((token_hour, token_minute,
2814
token_day = Token(re.compile(r"(\d+)D"),
2815
datetime.timedelta(days=1),
2816
frozenset((token_time, token_end)))
2817
token_month = Token(re.compile(r"(\d+)M"),
2818
datetime.timedelta(weeks=4),
2819
frozenset((token_day, token_end)))
2820
token_year = Token(re.compile(r"(\d+)Y"),
2821
datetime.timedelta(weeks=52),
2822
frozenset((token_month, token_end)))
2823
token_week = Token(re.compile(r"(\d+)W"),
2824
datetime.timedelta(weeks=1),
2825
frozenset((token_end, )))
2826
token_duration = Token(re.compile(r"P"), None,
2827
frozenset((token_year, token_month,
2828
token_day, token_time,
2830
# Define starting values:
2832
value = datetime.timedelta()
2834
# Following valid tokens
2835
followers = frozenset((token_duration, ))
2836
# String left to parse
2838
# Loop until end token is found
2839
while found_token is not token_end:
2840
# Search for any currently valid tokens
2841
for token in followers:
2842
match = token.regexp.match(s)
2843
if match is not None:
2845
if token.value is not None:
2846
# Value found, parse digits
2847
factor = int(match.group(1), 10)
2848
# Add to value so far
2849
value += factor * token.value
2850
# Strip token from string
2851
s = token.regexp.sub("", s, 1)
2854
# Set valid next tokens
2855
followers = found_token.followers
2858
# No currently valid tokens were found
2859
raise ValueError("Invalid RFC 3339 duration: {!r}"
1994
2865
def string_to_delta(interval):
1995
2866
"""Parse a string and return a datetime.timedelta
1997
>>> string_to_delta('7d')
1998
datetime.timedelta(7)
1999
>>> string_to_delta('60s')
2000
datetime.timedelta(0, 60)
2001
>>> string_to_delta('60m')
2002
datetime.timedelta(0, 3600)
2003
>>> string_to_delta('24h')
2004
datetime.timedelta(1)
2005
>>> string_to_delta('1w')
2006
datetime.timedelta(7)
2007
>>> string_to_delta('5m 30s')
2008
datetime.timedelta(0, 330)
2868
>>> string_to_delta('7d') == datetime.timedelta(7)
2870
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2872
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2874
>>> string_to_delta('24h') == datetime.timedelta(1)
2876
>>> string_to_delta('1w') == datetime.timedelta(7)
2878
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2883
return rfc3339_duration_to_delta(interval)
2010
2887
timevalue = datetime.timedelta(0)
2011
2888
for s in interval.split():
2013
suffix = unicode(s[-1])
2014
2891
value = int(s[:-1])
2015
2892
if suffix == "d":
2016
2893
delta = datetime.timedelta(value)
2088
2965
parser.add_argument("--no-dbus", action="store_false",
2089
2966
dest="use_dbus", help="Do not provide D-Bus"
2090
" system bus interface")
2967
" system bus interface", default=None)
2091
2968
parser.add_argument("--no-ipv6", action="store_false",
2092
dest="use_ipv6", help="Do not use IPv6")
2969
dest="use_ipv6", help="Do not use IPv6",
2093
2971
parser.add_argument("--no-restore", action="store_false",
2094
2972
dest="restore", help="Do not restore stored"
2973
" state", default=None)
2974
parser.add_argument("--socket", type=int,
2975
help="Specify a file descriptor to a network"
2976
" socket to use instead of creating one")
2096
2977
parser.add_argument("--statedir", metavar="DIR",
2097
2978
help="Directory to save/restore state in")
2979
parser.add_argument("--foreground", action="store_true",
2980
help="Run in foreground", default=None)
2981
parser.add_argument("--no-zeroconf", action="store_false",
2982
dest="zeroconf", help="Do not use Zeroconf",
2099
2985
options = parser.parse_args()
2106
2987
# Default values for config file for server-global settings
2107
server_defaults = { "interface": "",
2112
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2113
"servicename": "Mandos",
2118
"statedir": "/var/lib/mandos"
2988
if gnutls.has_rawpk:
2989
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2990
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2992
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2993
":+SIGN-DSA-SHA256")
2994
server_defaults = {"interface": "",
2998
"priority": priority,
2999
"servicename": "Mandos",
3005
"statedir": "/var/lib/mandos",
3006
"foreground": "False",
2121
3011
# Parse config file for server-global settings
2122
server_config = configparser.SafeConfigParser(server_defaults)
3012
server_config = configparser.ConfigParser(server_defaults)
2123
3013
del server_defaults
2124
server_config.read(os.path.join(options.configdir,
2126
# Convert the SafeConfigParser object to a dict
3014
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3015
# Convert the ConfigParser object to a dict
2127
3016
server_settings = server_config.defaults()
2128
3017
# Use the appropriate methods on the non-string config options
2129
for option in ("debug", "use_dbus", "use_ipv6"):
3018
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3019
"foreground", "zeroconf"):
2130
3020
server_settings[option] = server_config.getboolean("DEFAULT",
2132
3022
if server_settings["port"]:
2133
3023
server_settings["port"] = server_config.getint("DEFAULT",
3025
if server_settings["socket"]:
3026
server_settings["socket"] = server_config.getint("DEFAULT",
3028
# Later, stdin will, and stdout and stderr might, be dup'ed
3029
# over with an opened os.devnull. But we don't want this to
3030
# happen with a supplied network socket.
3031
if 0 <= server_settings["socket"] <= 2:
3032
server_settings["socket"] = os.dup(server_settings
2135
3034
del server_config
2137
3036
# Override the settings from the config file with command line
2138
3037
# options, if set.
2139
3038
for option in ("interface", "address", "port", "debug",
2140
"priority", "servicename", "configdir",
2141
"use_dbus", "use_ipv6", "debuglevel", "restore",
3039
"priority", "servicename", "configdir", "use_dbus",
3040
"use_ipv6", "debuglevel", "restore", "statedir",
3041
"socket", "foreground", "zeroconf"):
2143
3042
value = getattr(options, option)
2144
3043
if value is not None:
2145
3044
server_settings[option] = value
2147
3046
# Force all strings to be unicode
2148
3047
for option in server_settings.keys():
2149
if type(server_settings[option]) is str:
2150
server_settings[option] = unicode(server_settings[option])
3048
if isinstance(server_settings[option], bytes):
3049
server_settings[option] = (server_settings[option]
3051
# Force all boolean options to be boolean
3052
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3053
"foreground", "zeroconf"):
3054
server_settings[option] = bool(server_settings[option])
3055
# Debug implies foreground
3056
if server_settings["debug"]:
3057
server_settings["foreground"] = True
2151
3058
# Now we have our good server settings in "server_settings"
2153
3060
##################################################################
3062
if (not server_settings["zeroconf"]
3063
and not (server_settings["port"]
3064
or server_settings["socket"] != "")):
3065
parser.error("Needs port or socket to work without Zeroconf")
2155
3067
# For convenience
2156
3068
debug = server_settings["debug"]
2157
3069
debuglevel = server_settings["debuglevel"]
2169
3083
level = getattr(logging, debuglevel.upper())
2170
3084
initlogger(debug, level)
2172
3086
if server_settings["servicename"] != "Mandos":
2173
syslogger.setFormatter(logging.Formatter
2174
('Mandos (%s) [%%(process)d]:'
2175
' %%(levelname)s: %%(message)s'
2176
% server_settings["servicename"]))
3087
syslogger.setFormatter(
3088
logging.Formatter('Mandos ({}) [%(process)d]:'
3089
' %(levelname)s: %(message)s'.format(
3090
server_settings["servicename"])))
2178
3092
# Parse config file with clients
2179
client_config = configparser.SafeConfigParser(Client
3093
client_config = configparser.ConfigParser(Client.client_defaults)
2181
3094
client_config.read(os.path.join(server_settings["configdir"],
2182
3095
"clients.conf"))
2184
3097
global mandos_dbus_service
2185
3098
mandos_dbus_service = None
2187
tcp_server = MandosServer((server_settings["address"],
2188
server_settings["port"]),
2190
interface=(server_settings["interface"]
2194
server_settings["priority"],
2197
pidfilename = "/var/run/mandos.pid"
2199
pidfile = open(pidfilename, "w")
2201
logger.error("Could not open file %r", pidfilename)
2204
uid = pwd.getpwnam("_mandos").pw_uid
2205
gid = pwd.getpwnam("_mandos").pw_gid
2208
uid = pwd.getpwnam("mandos").pw_uid
2209
gid = pwd.getpwnam("mandos").pw_gid
3101
if server_settings["socket"] != "":
3102
socketfd = server_settings["socket"]
3103
tcp_server = MandosServer(
3104
(server_settings["address"], server_settings["port"]),
3106
interface=(server_settings["interface"] or None),
3108
gnutls_priority=server_settings["priority"],
3112
pidfilename = "/run/mandos.pid"
3113
if not os.path.isdir("/run/."):
3114
pidfilename = "/var/run/mandos.pid"
3117
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3118
except IOError as e:
3119
logger.error("Could not open file %r", pidfilename,
3122
for name, group in (("_mandos", "_mandos"),
3123
("mandos", "mandos"),
3124
("nobody", "nogroup")):
3126
uid = pwd.getpwnam(name).pw_uid
3127
gid = pwd.getpwnam(group).pw_gid
2210
3129
except KeyError:
2212
uid = pwd.getpwnam("nobody").pw_uid
2213
gid = pwd.getpwnam("nobody").pw_gid
3138
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2220
3140
except OSError as error:
2221
if error[0] != errno.EPERM:
3141
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3142
.format(uid, gid, os.strerror(error.errno)))
3143
if error.errno != errno.EPERM:
2225
3147
# Enable all possible GnuTLS debugging
2227
3149
# "Use a log level over 10 to enable all debugging options."
2228
3150
# - GnuTLS manual
2229
gnutls.library.functions.gnutls_global_set_log_level(11)
2231
@gnutls.library.types.gnutls_log_func
3151
gnutls.global_set_log_level(11)
2232
3154
def debug_gnutls(level, string):
2233
3155
logger.debug("GnuTLS: %s", string[:-1])
2235
(gnutls.library.functions
2236
.gnutls_global_set_log_function(debug_gnutls))
3157
gnutls.global_set_log_function(debug_gnutls)
2238
3159
# Redirect stdin so all checkers get /dev/null
2239
3160
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2240
3161
os.dup2(null, sys.stdin.fileno())
2244
3165
# Need to fork before connecting to D-Bus
2246
3167
# Close all input and output, do double fork, etc.
2249
gobject.threads_init()
3170
if gi.version_info < (3, 10, 2):
3171
# multiprocessing will use threads, so before we use GLib we
3172
# need to inform GLib that threads will be used.
2251
3175
global main_loop
2252
3176
# From the Avahi example code
2253
3177
DBusGMainLoop(set_as_default=True)
2254
main_loop = gobject.MainLoop()
3178
main_loop = GLib.MainLoop()
2255
3179
bus = dbus.SystemBus()
2256
3180
# End of Avahi example code
2259
3183
bus_name = dbus.service.BusName("se.recompile.Mandos",
2260
bus, do_not_queue=True)
2261
old_bus_name = (dbus.service.BusName
2262
("se.bsnet.fukt.Mandos", bus,
2264
except dbus.exceptions.NameExistsException as e:
2265
logger.error(unicode(e) + ", disabling D-Bus")
3186
old_bus_name = dbus.service.BusName(
3187
"se.bsnet.fukt.Mandos", bus,
3189
except dbus.exceptions.DBusException as e:
3190
logger.error("Disabling D-Bus:", exc_info=e)
2266
3191
use_dbus = False
2267
3192
server_settings["use_dbus"] = False
2268
3193
tcp_server.use_dbus = False
2269
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2270
service = AvahiServiceToSyslog(name =
2271
server_settings["servicename"],
2272
servicetype = "_mandos._tcp",
2273
protocol = protocol, bus = bus)
2274
if server_settings["interface"]:
2275
service.interface = (if_nametoindex
2276
(str(server_settings["interface"])))
3195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3196
service = AvahiServiceToSyslog(
3197
name=server_settings["servicename"],
3198
servicetype="_mandos._tcp",
3201
if server_settings["interface"]:
3202
service.interface = if_nametoindex(
3203
server_settings["interface"].encode("utf-8"))
2278
3205
global multiprocessing_manager
2279
3206
multiprocessing_manager = multiprocessing.Manager()
2281
3208
client_class = Client
2283
client_class = functools.partial(ClientDBusTransitional,
3210
client_class = functools.partial(ClientDBus, bus=bus)
2286
3212
client_settings = Client.config_parser(client_config)
2287
3213
old_client_settings = {}
2288
3214
clients_data = {}
3216
# This is used to redirect stdout and stderr for checker processes
3218
wnull = open(os.devnull, "w") # A writable /dev/null
3219
# Only used if server is running in foreground but not in debug
3221
if debug or not foreground:
2290
3224
# Get client data and settings from last running state.
2291
3225
if server_settings["restore"]:
2293
3227
with open(stored_state_path, "rb") as stored_state:
2294
clients_data, old_client_settings = (pickle.load
3228
if sys.version_info.major == 2:
3229
clients_data, old_client_settings = pickle.load(
3232
bytes_clients_data, bytes_old_client_settings = (
3233
pickle.load(stored_state, encoding="bytes"))
3234
# Fix bytes to strings
3237
clients_data = {(key.decode("utf-8")
3238
if isinstance(key, bytes)
3241
bytes_clients_data.items()}
3242
del bytes_clients_data
3243
for key in clients_data:
3244
value = {(k.decode("utf-8")
3245
if isinstance(k, bytes) else k): v
3247
clients_data[key].items()}
3248
clients_data[key] = value
3250
value["client_structure"] = [
3252
if isinstance(s, bytes)
3254
value["client_structure"]]
3255
# .name, .host, and .checker_command
3256
for k in ("name", "host", "checker_command"):
3257
if isinstance(value[k], bytes):
3258
value[k] = value[k].decode("utf-8")
3259
if "key_id" not in value:
3260
value["key_id"] = ""
3261
elif "fingerprint" not in value:
3262
value["fingerprint"] = ""
3263
# old_client_settings
3265
old_client_settings = {
3266
(key.decode("utf-8")
3267
if isinstance(key, bytes)
3270
bytes_old_client_settings.items()}
3271
del bytes_old_client_settings
3272
# .host and .checker_command
3273
for value in old_client_settings.values():
3274
for attribute in ("host", "checker_command"):
3275
if isinstance(value[attribute], bytes):
3276
value[attribute] = (value[attribute]
2296
3278
os.remove(stored_state_path)
2297
3279
except IOError as e:
2298
logger.warning("Could not load persistent state: {0}"
2300
if e.errno != errno.ENOENT:
3280
if e.errno == errno.ENOENT:
3281
logger.warning("Could not load persistent state:"
3282
" {}".format(os.strerror(e.errno)))
3284
logger.critical("Could not load persistent state:",
2302
3287
except EOFError as e:
2303
3288
logger.warning("Could not load persistent state: "
2304
"EOFError: {0}".format(e))
2306
3292
with PGPEngine() as pgp:
2307
for client_name, client in clients_data.iteritems():
3293
for client_name, client in clients_data.items():
3294
# Skip removed clients
3295
if client_name not in client_settings:
2308
3298
# Decide which value to use after restoring saved state.
2309
3299
# We have three different values: Old config file,
2310
3300
# new config file, and saved state.
2371
3360
clients_data[client_name] = client_settings[client_name]
2373
3362
# Create all client objects
2374
for client_name, client in clients_data.iteritems():
3363
for client_name, client in clients_data.items():
2375
3364
tcp_server.clients[client_name] = client_class(
2376
name = client_name, settings = client)
3367
server_settings=server_settings)
2378
3369
if not tcp_server.clients:
2379
3370
logger.warning("No clients defined")
2385
pidfile.write(str(pid) + "\n".encode("utf-8"))
2388
logger.error("Could not write to file %r with PID %d",
2391
# "pidfile" was never created
3373
if pidfile is not None:
3377
print(pid, file=pidfile)
3379
logger.error("Could not write to file %r with PID %d",
2393
3382
del pidfilename
2394
signal.signal(signal.SIGINT, signal.SIG_IGN)
2396
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2397
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3384
for termsig in (signal.SIGHUP, signal.SIGTERM):
3385
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3386
lambda: main_loop.quit() and False)
2400
class MandosDBusService(DBusObjectWithProperties):
3390
@alternate_dbus_interfaces(
3391
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3392
class MandosDBusService(DBusObjectWithObjectManager):
2401
3393
"""A D-Bus proxy object"""
2402
3395
def __init__(self):
2403
3396
dbus.service.Object.__init__(self, bus, "/")
2404
3398
_interface = "se.recompile.Mandos"
2406
@dbus_interface_annotations(_interface)
2408
return { "org.freedesktop.DBus.Property"
2409
".EmitsChangedSignal":
2412
3400
@dbus.service.signal(_interface, signature="o")
2413
3401
def ClientAdded(self, objpath):
2417
3405
@dbus.service.signal(_interface, signature="ss")
2418
def ClientNotFound(self, fingerprint, address):
3406
def ClientNotFound(self, key_id, address):
3410
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2422
3412
@dbus.service.signal(_interface, signature="os")
2423
3413
def ClientRemoved(self, objpath, name):
3417
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2427
3419
@dbus.service.method(_interface, out_signature="ao")
2428
3420
def GetAllClients(self):
2430
return dbus.Array(c.dbus_object_path
2432
tcp_server.clients.itervalues())
3422
return dbus.Array(c.dbus_object_path for c in
3423
tcp_server.clients.values())
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2434
3427
@dbus.service.method(_interface,
2435
3428
out_signature="a{oa{sv}}")
2436
3429
def GetAllClientsWithProperties(self):
2438
3431
return dbus.Dictionary(
2439
((c.dbus_object_path, c.GetAll(""))
2440
for c in tcp_server.clients.itervalues()),
3432
{c.dbus_object_path: c.GetAll(
3433
"se.recompile.Mandos.Client")
3434
for c in tcp_server.clients.values()},
2441
3435
signature="oa{sv}")
2443
3437
@dbus.service.method(_interface, in_signature="o")
2444
3438
def RemoveClient(self, object_path):
2446
for c in tcp_server.clients.itervalues():
3440
for c in tcp_server.clients.values():
2447
3441
if c.dbus_object_path == object_path:
2448
3442
del tcp_server.clients[c.name]
2449
3443
c.remove_from_connection()
2450
# Don't signal anything except ClientRemoved
3444
# Don't signal the disabling
2451
3445
c.disable(quiet=True)
2453
self.ClientRemoved(object_path, c.name)
3446
# Emit D-Bus signal for removal
3447
self.client_removed_signal(c)
2455
3449
raise KeyError(object_path)
2459
class MandosDBusServiceTransitional(MandosDBusService):
2460
__metaclass__ = AlternateDBusNamesMetaclass
2461
mandos_dbus_service = MandosDBusServiceTransitional()
3453
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3454
out_signature="a{oa{sa{sv}}}")
3455
def GetManagedObjects(self):
3457
return dbus.Dictionary(
3458
{client.dbus_object_path:
3460
{interface: client.GetAll(interface)
3462
client._get_all_interface_names()})
3463
for client in tcp_server.clients.values()})
3465
def client_added_signal(self, client):
3466
"""Send the new standard signal and the old signal"""
3468
# New standard signal
3469
self.InterfacesAdded(
3470
client.dbus_object_path,
3472
{interface: client.GetAll(interface)
3474
client._get_all_interface_names()}))
3476
self.ClientAdded(client.dbus_object_path)
3478
def client_removed_signal(self, client):
3479
"""Send the new standard signal and the old signal"""
3481
# New standard signal
3482
self.InterfacesRemoved(
3483
client.dbus_object_path,
3484
client._get_all_interface_names())
3486
self.ClientRemoved(client.dbus_object_path,
3489
mandos_dbus_service = MandosDBusService()
3491
# Save modules to variables to exempt the modules from being
3492
# unloaded before the function registered with atexit() is run.
3493
mp = multiprocessing
2464
3497
"Cleanup function; run on exit"
2467
multiprocessing.active_children()
3501
mp.active_children()
2468
3503
if not (tcp_server.clients or client_settings):
2471
3506
# Store client before exiting. Secrets are encrypted with key
2472
3507
# based on what config file has. If config file is
2473
3508
# removed/edited, old secret will thus be unrecovable.
2475
3510
with PGPEngine() as pgp:
2476
for client in tcp_server.clients.itervalues():
3511
for client in tcp_server.clients.values():
2477
3512
key = client_settings[client.name]["secret"]
2478
3513
client.encrypted_secret = pgp.encrypt(client.secret,
2480
3515
client_dict = {}
2482
3517
# A list of attributes that can not be pickled
2484
exclude = set(("bus", "changedstate", "secret",
2486
for name, typ in (inspect.getmembers
2487
(dbus.service.Object)):
3519
exclude = {"bus", "changedstate", "secret",
3520
"checker", "server_settings"}
3521
for name, typ in inspect.getmembers(dbus.service
2488
3523
exclude.add(name)
2490
3525
client_dict["encrypted_secret"] = (client
2491
3526
.encrypted_secret)
2492
3527
for attr in client.client_structure:
2493
3528
if attr not in exclude:
2494
3529
client_dict[attr] = getattr(client, attr)
2496
3531
clients[client.name] = client_dict
2497
3532
del client_settings[client.name]["secret"]
2500
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2503
(stored_state_path))
2504
with os.fdopen(tempfd, "wb") as stored_state:
2505
pickle.dump((clients, client_settings), stored_state)
3535
with tempfile.NamedTemporaryFile(
3539
dir=os.path.dirname(stored_state_path),
3540
delete=False) as stored_state:
3541
pickle.dump((clients, client_settings), stored_state,
3543
tempname = stored_state.name
2506
3544
os.rename(tempname, stored_state_path)
2507
3545
except (IOError, OSError) as e:
2508
logger.warning("Could not save persistent state: {0}"
2512
3548
os.remove(tempname)
2513
3549
except NameError:
2515
if e.errno not in set((errno.ENOENT, errno.EACCES,
3551
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3552
logger.warning("Could not save persistent state: {}"
3553
.format(os.strerror(e.errno)))
3555
logger.warning("Could not save persistent state:",
2519
3559
# Delete all clients, and settings from config
2520
3560
while tcp_server.clients:
2521
3561
name, client = tcp_server.clients.popitem()
2523
3563
client.remove_from_connection()
2524
# Don't signal anything except ClientRemoved
3564
# Don't signal the disabling
2525
3565
client.disable(quiet=True)
3566
# Emit D-Bus signal for removal
2528
mandos_dbus_service.ClientRemoved(client
3568
mandos_dbus_service.client_removed_signal(client)
2531
3569
client_settings.clear()
2533
3571
atexit.register(cleanup)
2535
for client in tcp_server.clients.itervalues():
3573
for client in tcp_server.clients.values():
2538
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3575
# Emit D-Bus signal for adding
3576
mandos_dbus_service.client_added_signal(client)
2539
3577
# Need to initiate checking of clients
2540
3578
if client.enabled:
2541
3579
client.init_checker()
2543
3581
tcp_server.enable()
2544
3582
tcp_server.server_activate()
2546
3584
# Find out what port we got
2547
service.port = tcp_server.socket.getsockname()[1]
3586
service.port = tcp_server.socket.getsockname()[1]
2549
3588
logger.info("Now listening on address %r, port %d,"
2550
" flowinfo %d, scope_id %d"
2551
% tcp_server.socket.getsockname())
3589
" flowinfo %d, scope_id %d",
3590
*tcp_server.socket.getsockname())
2553
logger.info("Now listening on address %r, port %d"
2554
% tcp_server.socket.getsockname())
2556
#service.interface = tcp_server.socket.getsockname()[3]
3592
logger.info("Now listening on address %r, port %d",
3593
*tcp_server.socket.getsockname())
3595
# service.interface = tcp_server.socket.getsockname()[3]
2559
# From the Avahi example code
2562
except dbus.exceptions.DBusException as error:
2563
logger.critical("DBusException: %s", error)
2566
# End of Avahi example code
2568
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2569
lambda *args, **kwargs:
2570
(tcp_server.handle_request
2571
(*args[2:], **kwargs) or True))
3599
# From the Avahi example code
3602
except dbus.exceptions.DBusException as error:
3603
logger.critical("D-Bus Exception", exc_info=error)
3606
# End of Avahi example code
3609
GLib.IOChannel.unix_new(tcp_server.fileno()),
3610
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3611
lambda *args, **kwargs: (tcp_server.handle_request
3612
(*args[2:], **kwargs) or True))
2573
3614
logger.debug("Starting main loop")
2574
3615
main_loop.run()
2575
3616
except AvahiError as error:
2576
logger.critical("AvahiError: %s", error)
3617
logger.critical("Avahi Error", exc_info=error)
2579
3620
except KeyboardInterrupt: