2
2
# -*- mode: python; coding: utf-8 -*-
4
4
# Mandos server - give out binary blobs to connecting clients.
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
13
13
# Everything else is
14
# Copyright © 2008-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 Björn Påhlsson
17
# This program is free software: you can redistribute it and/or modify
18
# it under the terms of the GNU General Public License as published by
14
# Copyright © 2008-2018 Teddy Hogeborn
15
# Copyright © 2008-2018 Björn Påhlsson
17
# This file is part of Mandos.
19
# Mandos is free software: you can redistribute it and/or modify it
20
# under the terms of the GNU General Public License as published by
19
21
# the Free Software Foundation, either version 3 of the License, or
20
22
# (at your option) any later version.
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
24
26
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25
27
# GNU General Public License for more details.
27
29
# You should have received a copy of the GNU General Public License
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
31
32
# Contact the authors at <mandos@recompile.se>.
34
35
from __future__ import (division, absolute_import, print_function,
37
from future_builtins import *
39
from future_builtins import *
39
import SocketServer as socketserver
44
import SocketServer as socketserver
45
import gnutls.connection
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
52
import ConfigParser as configparser
180
236
.replace(b"\n", b"\\n")
181
237
.replace(b"\0", b"\\x00"))
184
240
def encrypt(self, data, password):
185
241
passphrase = self.password_encode(password)
186
with tempfile.NamedTemporaryFile(dir=self.tempdir
242
with tempfile.NamedTemporaryFile(
243
dir=self.tempdir) as passfile:
188
244
passfile.write(passphrase)
190
proc = subprocess.Popen(['gpg', '--symmetric',
246
proc = subprocess.Popen([self.gpg, '--symmetric',
191
247
'--passphrase-file',
193
249
+ self.gnupgargs,
194
stdin = subprocess.PIPE,
195
stdout = subprocess.PIPE,
196
stderr = subprocess.PIPE)
197
ciphertext, err = proc.communicate(input = data)
250
stdin=subprocess.PIPE,
251
stdout=subprocess.PIPE,
252
stderr=subprocess.PIPE)
253
ciphertext, err = proc.communicate(input=data)
198
254
if proc.returncode != 0:
199
255
raise PGPError(err)
200
256
return ciphertext
202
258
def decrypt(self, data, password):
203
259
passphrase = self.password_encode(password)
204
with tempfile.NamedTemporaryFile(dir = self.tempdir
260
with tempfile.NamedTemporaryFile(
261
dir=self.tempdir) as passfile:
206
262
passfile.write(passphrase)
208
proc = subprocess.Popen(['gpg', '--decrypt',
264
proc = subprocess.Popen([self.gpg, '--decrypt',
209
265
'--passphrase-file',
211
267
+ self.gnupgargs,
212
stdin = subprocess.PIPE,
213
stdout = subprocess.PIPE,
214
stderr = subprocess.PIPE)
215
decrypted_plaintext, err = proc.communicate(input
268
stdin=subprocess.PIPE,
269
stdout=subprocess.PIPE,
270
stderr=subprocess.PIPE)
271
decrypted_plaintext, err = proc.communicate(input=data)
217
272
if proc.returncode != 0:
218
273
raise PGPError(err)
219
274
return decrypted_plaintext
277
# Pretend that we have an Avahi module
279
"""This isn't so much a class as it is a module-like namespace.
280
It is instantiated once, and simulates having an Avahi module."""
281
IF_UNSPEC = -1 # avahi-common/address.h
282
PROTO_UNSPEC = -1 # avahi-common/address.h
283
PROTO_INET = 0 # avahi-common/address.h
284
PROTO_INET6 = 1 # avahi-common/address.h
285
DBUS_NAME = "org.freedesktop.Avahi"
286
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
287
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
288
DBUS_PATH_SERVER = "/"
290
def string_array_to_txt_array(self, t):
291
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
292
for s in t), signature="ay")
293
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
294
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
295
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
296
SERVER_INVALID = 0 # avahi-common/defs.h
297
SERVER_REGISTERING = 1 # avahi-common/defs.h
298
SERVER_RUNNING = 2 # avahi-common/defs.h
299
SERVER_COLLISION = 3 # avahi-common/defs.h
300
SERVER_FAILURE = 4 # avahi-common/defs.h
222
304
class AvahiError(Exception):
223
305
def __init__(self, value, *args, **kwargs):
224
306
self.value = value
225
307
return super(AvahiError, self).__init__(value, *args,
228
311
class AvahiServiceError(AvahiError):
231
315
class AvahiGroupError(AvahiError):
235
319
class AvahiService(object):
236
320
"""An Avahi (Zeroconf) service.
239
323
interface: integer; avahi.IF_UNSPEC or an interface index.
240
324
Used to optionally bind to the specified interface.
383
489
follow_name_owner_changes=True),
384
490
avahi.DBUS_INTERFACE_SERVER)
385
491
self.server.connect_to_signal("StateChanged",
386
self.server_state_changed)
492
self.server_state_changed)
387
493
self.server_state_changed(self.server.GetState())
390
496
class AvahiServiceToSyslog(AvahiService):
497
def rename(self, *args, **kwargs):
392
498
"""Add the new name to the syslog messages"""
393
ret = AvahiService.rename(self)
394
syslogger.setFormatter(logging.Formatter
395
('Mandos ({}) [%(process)d]:'
396
' %(levelname)s: %(message)s'
499
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
500
syslogger.setFormatter(logging.Formatter(
501
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
506
# Pretend that we have a GnuTLS module
507
class GnuTLS(object):
508
"""This isn't so much a class as it is a module-like namespace.
509
It is instantiated once, and simulates having a GnuTLS module."""
511
library = ctypes.util.find_library("gnutls")
513
library = ctypes.util.find_library("gnutls-deb0")
514
_library = ctypes.cdll.LoadLibrary(library)
516
_need_version = b"3.3.0"
519
# Need to use "self" here, since this method is called before
520
# the assignment to the "gnutls" global variable happens.
521
if self.check_version(self._need_version) is None:
522
raise self.Error("Needs GnuTLS {} or later"
523
.format(self._need_version))
525
# Unless otherwise indicated, the constants and types below are
526
# all from the gnutls/gnutls.h C header file.
536
E_NO_CERTIFICATE_FOUND = -49
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
540
class session_int(ctypes.Structure):
542
session_t = ctypes.POINTER(session_int)
544
class certificate_credentials_st(ctypes.Structure):
546
certificate_credentials_t = ctypes.POINTER(
547
certificate_credentials_st)
548
certificate_type_t = ctypes.c_int
550
class datum_t(ctypes.Structure):
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
('size', ctypes.c_uint)]
554
class openpgp_crt_int(ctypes.Structure):
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
credentials_type_t = ctypes.c_int
560
transport_ptr_t = ctypes.c_void_p
561
close_request_t = ctypes.c_int
564
class Error(Exception):
565
# We need to use the class name "GnuTLS" here, since this
566
# exception might be raised from within GnuTLS.__init__,
567
# which is called before the assignment to the "gnutls"
568
# global variable has happened.
569
def __init__(self, message=None, code=None, args=()):
570
# Default usage is by a message string, but if a return
571
# code is passed, convert it to a string with
574
if message is None and code is not None:
575
message = GnuTLS.strerror(code)
576
return super(GnuTLS.Error, self).__init__(
579
class CertificateSecurityError(Error):
583
class Credentials(object):
585
self._c_object = gnutls.certificate_credentials_t()
586
gnutls.certificate_allocate_credentials(
587
ctypes.byref(self._c_object))
588
self.type = gnutls.CRD_CERTIFICATE
591
gnutls.certificate_free_credentials(self._c_object)
593
class ClientSession(object):
594
def __init__(self, socket, credentials=None):
595
self._c_object = gnutls.session_t()
596
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
597
gnutls.set_default_priority(self._c_object)
598
gnutls.transport_set_ptr(self._c_object, socket.fileno())
599
gnutls.handshake_set_private_extensions(self._c_object,
602
if credentials is None:
603
credentials = gnutls.Credentials()
604
gnutls.credentials_set(self._c_object, credentials.type,
605
ctypes.cast(credentials._c_object,
607
self.credentials = credentials
610
gnutls.deinit(self._c_object)
613
return gnutls.handshake(self._c_object)
615
def send(self, data):
619
data_len -= gnutls.record_send(self._c_object,
624
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
626
# Error handling functions
627
def _error_code(result):
628
"""A function to raise exceptions on errors, suitable
629
for the 'restype' attribute on ctypes functions"""
632
if result == gnutls.E_NO_CERTIFICATE_FOUND:
633
raise gnutls.CertificateSecurityError(code=result)
634
raise gnutls.Error(code=result)
636
def _retry_on_error(result, func, arguments):
637
"""A function to retry on some errors, suitable
638
for the 'errcheck' attribute on ctypes functions"""
640
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
641
return _error_code(result)
642
result = func(*arguments)
645
# Unless otherwise indicated, the function declarations below are
646
# all from the gnutls/gnutls.h C header file.
649
priority_set_direct = _library.gnutls_priority_set_direct
650
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
651
ctypes.POINTER(ctypes.c_char_p)]
652
priority_set_direct.restype = _error_code
654
init = _library.gnutls_init
655
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
656
init.restype = _error_code
658
set_default_priority = _library.gnutls_set_default_priority
659
set_default_priority.argtypes = [session_t]
660
set_default_priority.restype = _error_code
662
record_send = _library.gnutls_record_send
663
record_send.argtypes = [session_t, ctypes.c_void_p,
665
record_send.restype = ctypes.c_ssize_t
666
record_send.errcheck = _retry_on_error
668
certificate_allocate_credentials = (
669
_library.gnutls_certificate_allocate_credentials)
670
certificate_allocate_credentials.argtypes = [
671
ctypes.POINTER(certificate_credentials_t)]
672
certificate_allocate_credentials.restype = _error_code
674
certificate_free_credentials = (
675
_library.gnutls_certificate_free_credentials)
676
certificate_free_credentials.argtypes = [
677
certificate_credentials_t]
678
certificate_free_credentials.restype = None
680
handshake_set_private_extensions = (
681
_library.gnutls_handshake_set_private_extensions)
682
handshake_set_private_extensions.argtypes = [session_t,
684
handshake_set_private_extensions.restype = None
686
credentials_set = _library.gnutls_credentials_set
687
credentials_set.argtypes = [session_t, credentials_type_t,
689
credentials_set.restype = _error_code
691
strerror = _library.gnutls_strerror
692
strerror.argtypes = [ctypes.c_int]
693
strerror.restype = ctypes.c_char_p
695
certificate_type_get = _library.gnutls_certificate_type_get
696
certificate_type_get.argtypes = [session_t]
697
certificate_type_get.restype = _error_code
699
certificate_get_peers = _library.gnutls_certificate_get_peers
700
certificate_get_peers.argtypes = [session_t,
701
ctypes.POINTER(ctypes.c_uint)]
702
certificate_get_peers.restype = ctypes.POINTER(datum_t)
704
global_set_log_level = _library.gnutls_global_set_log_level
705
global_set_log_level.argtypes = [ctypes.c_int]
706
global_set_log_level.restype = None
708
global_set_log_function = _library.gnutls_global_set_log_function
709
global_set_log_function.argtypes = [log_func]
710
global_set_log_function.restype = None
712
deinit = _library.gnutls_deinit
713
deinit.argtypes = [session_t]
714
deinit.restype = None
716
handshake = _library.gnutls_handshake
717
handshake.argtypes = [session_t]
718
handshake.restype = _error_code
719
handshake.errcheck = _retry_on_error
721
transport_set_ptr = _library.gnutls_transport_set_ptr
722
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
723
transport_set_ptr.restype = None
725
bye = _library.gnutls_bye
726
bye.argtypes = [session_t, close_request_t]
727
bye.restype = _error_code
728
bye.errcheck = _retry_on_error
730
check_version = _library.gnutls_check_version
731
check_version.argtypes = [ctypes.c_char_p]
732
check_version.restype = ctypes.c_char_p
734
# All the function declarations below are from gnutls/openpgp.h
736
openpgp_crt_init = _library.gnutls_openpgp_crt_init
737
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
738
openpgp_crt_init.restype = _error_code
740
openpgp_crt_import = _library.gnutls_openpgp_crt_import
741
openpgp_crt_import.argtypes = [openpgp_crt_t,
742
ctypes.POINTER(datum_t),
744
openpgp_crt_import.restype = _error_code
746
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
747
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
748
ctypes.POINTER(ctypes.c_uint)]
749
openpgp_crt_verify_self.restype = _error_code
751
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
752
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
753
openpgp_crt_deinit.restype = None
755
openpgp_crt_get_fingerprint = (
756
_library.gnutls_openpgp_crt_get_fingerprint)
757
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
761
openpgp_crt_get_fingerprint.restype = _error_code
763
# Remove non-public functions
764
del _error_code, _retry_on_error
765
# Create the global "gnutls" object, simulating a module
769
def call_pipe(connection, # : multiprocessing.Connection
770
func, *args, **kwargs):
771
"""This function is meant to be called by multiprocessing.Process
773
This function runs func(*args, **kwargs), and writes the resulting
774
return value on the provided multiprocessing.Connection.
776
connection.send(func(*args, **kwargs))
401
780
class Client(object):
402
781
"""A representation of a client host served by this server.
405
784
approved: bool(); 'None' if not yet approved/disapproved
406
785
approval_delay: datetime.timedelta(); Time to wait for approval
579
960
logger.info("Disabling client %s", self.name)
580
961
if getattr(self, "disable_initiator_tag", None) is not None:
581
gobject.source_remove(self.disable_initiator_tag)
962
GLib.source_remove(self.disable_initiator_tag)
582
963
self.disable_initiator_tag = None
583
964
self.expires = None
584
965
if getattr(self, "checker_initiator_tag", None) is not None:
585
gobject.source_remove(self.checker_initiator_tag)
966
GLib.source_remove(self.checker_initiator_tag)
586
967
self.checker_initiator_tag = None
587
968
self.stop_checker()
588
969
self.enabled = False
590
971
self.send_changedstate()
591
# Do not run this again if called by a gobject.timeout_add
972
# Do not run this again if called by a GLib.timeout_add
594
975
def __del__(self):
597
978
def init_checker(self):
598
979
# Schedule a new checker to be started an 'interval' from now,
599
980
# and every interval from then on.
600
981
if self.checker_initiator_tag is not None:
601
gobject.source_remove(self.checker_initiator_tag)
602
self.checker_initiator_tag = (gobject.timeout_add
604
.total_seconds() * 1000),
982
GLib.source_remove(self.checker_initiator_tag)
983
self.checker_initiator_tag = GLib.timeout_add(
984
int(self.interval.total_seconds() * 1000),
606
986
# Schedule a disable() when 'timeout' has passed
607
987
if self.disable_initiator_tag is not None:
608
gobject.source_remove(self.disable_initiator_tag)
609
self.disable_initiator_tag = (gobject.timeout_add
611
.total_seconds() * 1000),
988
GLib.source_remove(self.disable_initiator_tag)
989
self.disable_initiator_tag = GLib.timeout_add(
990
int(self.timeout.total_seconds() * 1000), self.disable)
613
991
# Also start a new checker *right now*.
614
992
self.start_checker()
616
def checker_callback(self, pid, condition, command):
994
def checker_callback(self, source, condition, connection,
617
996
"""The checker has completed, so take appropriate actions."""
618
997
self.checker_callback_tag = None
619
998
self.checker = None
620
if os.WIFEXITED(condition):
621
self.last_checker_status = os.WEXITSTATUS(condition)
999
# Read return code from connection (see call_pipe)
1000
returncode = connection.recv()
1004
self.last_checker_status = returncode
1005
self.last_checker_signal = None
622
1006
if self.last_checker_status == 0:
623
1007
logger.info("Checker for %(name)s succeeded",
625
1009
self.checked_ok()
627
logger.info("Checker for %(name)s failed",
1011
logger.info("Checker for %(name)s failed", vars(self))
630
1013
self.last_checker_status = -1
1014
self.last_checker_signal = -returncode
631
1015
logger.warning("Checker for %(name)s crashed?",
634
1019
def checked_ok(self):
635
1020
"""Assert that the client has been seen, alive and well."""
636
1021
self.last_checked_ok = datetime.datetime.utcnow()
637
1022
self.last_checker_status = 0
1023
self.last_checker_signal = None
638
1024
self.bump_timeout()
640
1026
def bump_timeout(self, timeout=None):
641
1027
"""Bump up the timeout for this client."""
642
1028
if timeout is None:
643
1029
timeout = self.timeout
644
1030
if self.disable_initiator_tag is not None:
645
gobject.source_remove(self.disable_initiator_tag)
1031
GLib.source_remove(self.disable_initiator_tag)
646
1032
self.disable_initiator_tag = None
647
1033
if getattr(self, "enabled", False):
648
self.disable_initiator_tag = (gobject.timeout_add
649
(int(timeout.total_seconds()
650
* 1000), self.disable))
1034
self.disable_initiator_tag = GLib.timeout_add(
1035
int(timeout.total_seconds() * 1000), self.disable)
651
1036
self.expires = datetime.datetime.utcnow() + timeout
653
1038
def need_approval(self):
654
1039
self.last_approval_request = datetime.datetime.utcnow()
656
1041
def start_checker(self):
657
1042
"""Start a new checker subprocess if one is not running.
659
1044
If a checker already exists, leave it running and do
661
1046
# The reason for not killing a running checker is that if we
666
1051
# checkers alone, the checker would have to take more time
667
1052
# than 'timeout' for the client to be disabled, which is as it
670
# If a checker exists, make sure it is not a zombie
672
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
673
except AttributeError:
675
except OSError as error:
676
if error.errno != errno.ECHILD:
680
logger.warning("Checker was a zombie")
681
gobject.source_remove(self.checker_callback_tag)
682
self.checker_callback(pid, status,
683
self.current_checker_command)
1055
if self.checker is not None and not self.checker.is_alive():
1056
logger.warning("Checker was not alive; joining")
684
1059
# Start a new checker if needed
685
1060
if self.checker is None:
686
1061
# Escape attributes for the shell
687
escaped_attrs = { attr:
688
re.escape(unicode(getattr(self,
690
for attr in self.runtime_expansions }
1063
attr: re.escape(str(getattr(self, attr)))
1064
for attr in self.runtime_expansions}
692
1066
command = self.checker_command % escaped_attrs
693
1067
except TypeError as error:
694
1068
logger.error('Could not format string "%s"',
695
self.checker_command, exc_info=error)
696
return True # Try again later
1069
self.checker_command,
1071
return True # Try again later
697
1072
self.current_checker_command = command
699
logger.info("Starting checker %r for %s",
701
# We don't need to redirect stdout and stderr, since
702
# in normal mode, that is already done by daemon(),
703
# and in debug mode we don't want to. (Stdin is
704
# always replaced by /dev/null.)
705
# The exception is when not debugging but nevertheless
706
# running in the foreground; use the previously
709
if (not self.server_settings["debug"]
710
and self.server_settings["foreground"]):
711
popen_args.update({"stdout": wnull,
713
self.checker = subprocess.Popen(command,
717
except OSError as error:
718
logger.error("Failed to start subprocess",
721
self.checker_callback_tag = (gobject.child_watch_add
723
self.checker_callback,
725
# The checker may have completed before the gobject
726
# watch was added. Check for this.
728
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
729
except OSError as error:
730
if error.errno == errno.ECHILD:
731
# This should never happen
732
logger.error("Child process vanished",
737
gobject.source_remove(self.checker_callback_tag)
738
self.checker_callback(pid, status, command)
739
# Re-run this periodically if run by gobject.timeout_add
1073
logger.info("Starting checker %r for %s", command,
1075
# We don't need to redirect stdout and stderr, since
1076
# in normal mode, that is already done by daemon(),
1077
# and in debug mode we don't want to. (Stdin is
1078
# always replaced by /dev/null.)
1079
# The exception is when not debugging but nevertheless
1080
# running in the foreground; use the previously
1082
popen_args = {"close_fds": True,
1085
if (not self.server_settings["debug"]
1086
and self.server_settings["foreground"]):
1087
popen_args.update({"stdout": wnull,
1089
pipe = multiprocessing.Pipe(duplex=False)
1090
self.checker = multiprocessing.Process(
1092
args=(pipe[1], subprocess.call, command),
1094
self.checker.start()
1095
self.checker_callback_tag = GLib.io_add_watch(
1096
pipe[0].fileno(), GLib.IO_IN,
1097
self.checker_callback, pipe[0], command)
1098
# Re-run this periodically if run by GLib.timeout_add
742
1101
def stop_checker(self):
743
1102
"""Force the checker process, if any, to stop."""
744
1103
if self.checker_callback_tag:
745
gobject.source_remove(self.checker_callback_tag)
1104
GLib.source_remove(self.checker_callback_tag)
746
1105
self.checker_callback_tag = None
747
1106
if getattr(self, "checker", None) is None:
749
1108
logger.debug("Stopping checker for %(name)s", vars(self))
751
self.checker.terminate()
753
#if self.checker.poll() is None:
754
# self.checker.kill()
755
except OSError as error:
756
if error.errno != errno.ESRCH: # No such process
1109
self.checker.terminate()
758
1110
self.checker = None
761
def dbus_service_property(dbus_interface, signature="v",
762
access="readwrite", byte_arrays=False):
1113
def dbus_service_property(dbus_interface,
763
1117
"""Decorators for marking methods of a DBusObjectWithProperties to
764
1118
become properties on the D-Bus.
766
1120
The decorated method will be called with no arguments by "Get"
767
1121
and with one argument by "Set".
769
1123
The parameters, where they are supported, are the same as
770
1124
dbus.service.method, except there is only "signature", since the
771
1125
type from Get() and the type sent to Set() is the same.
845
class DBusObjectWithProperties(dbus.service.Object):
846
"""A D-Bus object with properties.
848
Classes inheriting from this can use the dbus_service_property
849
decorator to expose methods as D-Bus properties. It exposes the
850
standard Get(), Set(), and GetAll() methods on the D-Bus.
1208
class DBusObjectWithAnnotations(dbus.service.Object):
1209
"""A D-Bus object with annotations.
1211
Classes inheriting from this can use the dbus_annotations
1212
decorator to add annotations to methods or signals.
854
1216
def _is_dbus_thing(thing):
855
1217
"""Returns a function testing if an attribute is a D-Bus thing
857
1219
If called like _is_dbus_thing("method") it returns a function
858
1220
suitable for use as predicate to inspect.getmembers().
860
1222
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
863
1225
def _get_all_dbus_things(self, thing):
864
1226
"""Returns a generator of (name, attribute) pairs
866
return ((getattr(athing.__get__(self), "_dbus_name",
1228
return ((getattr(athing.__get__(self), "_dbus_name", name),
868
1229
athing.__get__(self))
869
1230
for cls in self.__class__.__mro__
870
1231
for name, athing in
871
inspect.getmembers(cls,
872
self._is_dbus_thing(thing)))
1232
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1234
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1236
path_keyword='object_path',
1237
connection_keyword='connection')
1238
def Introspect(self, object_path, connection):
1239
"""Overloading of standard D-Bus method.
1241
Inserts annotation tags on methods and signals.
1243
xmlstring = dbus.service.Object.Introspect(self, object_path,
1246
document = xml.dom.minidom.parseString(xmlstring)
1248
for if_tag in document.getElementsByTagName("interface"):
1249
# Add annotation tags
1250
for typ in ("method", "signal"):
1251
for tag in if_tag.getElementsByTagName(typ):
1253
for name, prop in (self.
1254
_get_all_dbus_things(typ)):
1255
if (name == tag.getAttribute("name")
1256
and prop._dbus_interface
1257
== if_tag.getAttribute("name")):
1258
annots.update(getattr(
1259
prop, "_dbus_annotations", {}))
1260
for name, value in annots.items():
1261
ann_tag = document.createElement(
1263
ann_tag.setAttribute("name", name)
1264
ann_tag.setAttribute("value", value)
1265
tag.appendChild(ann_tag)
1266
# Add interface annotation tags
1267
for annotation, value in dict(
1268
itertools.chain.from_iterable(
1269
annotations().items()
1270
for name, annotations
1271
in self._get_all_dbus_things("interface")
1272
if name == if_tag.getAttribute("name")
1274
ann_tag = document.createElement("annotation")
1275
ann_tag.setAttribute("name", annotation)
1276
ann_tag.setAttribute("value", value)
1277
if_tag.appendChild(ann_tag)
1278
# Fix argument name for the Introspect method itself
1279
if (if_tag.getAttribute("name")
1280
== dbus.INTROSPECTABLE_IFACE):
1281
for cn in if_tag.getElementsByTagName("method"):
1282
if cn.getAttribute("name") == "Introspect":
1283
for arg in cn.getElementsByTagName("arg"):
1284
if (arg.getAttribute("direction")
1286
arg.setAttribute("name",
1288
xmlstring = document.toxml("utf-8")
1290
except (AttributeError, xml.dom.DOMException,
1291
xml.parsers.expat.ExpatError) as error:
1292
logger.error("Failed to override Introspection method",
1297
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1298
"""A D-Bus object with properties.
1300
Classes inheriting from this can use the dbus_service_property
1301
decorator to expose methods as D-Bus properties. It exposes the
1302
standard Get(), Set(), and GetAll() methods on the D-Bus.
874
1305
def _get_dbus_property(self, interface_name, property_name):
875
1306
"""Returns a bound method if one exists which is a D-Bus
876
1307
property with the specified name and interface.
878
for cls in self.__class__.__mro__:
879
for name, value in (inspect.getmembers
881
self._is_dbus_thing("property"))):
1309
for cls in self.__class__.__mro__:
1310
for name, value in inspect.getmembers(
1311
cls, self._is_dbus_thing("property")):
882
1312
if (value._dbus_name == property_name
883
1313
and value._dbus_interface == interface_name):
884
1314
return value.__get__(self)
886
1316
# No such property
887
raise DBusPropertyNotFound(self.dbus_object_path + ":"
888
+ interface_name + "."
891
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1317
raise DBusPropertyNotFound("{}:{}.{}".format(
1318
self.dbus_object_path, interface_name, property_name))
1321
def _get_all_interface_names(cls):
1322
"""Get a sequence of all interfaces supported by an object"""
1323
return (name for name in set(getattr(getattr(x, attr),
1324
"_dbus_interface", None)
1325
for x in (inspect.getmro(cls))
1327
if name is not None)
1329
@dbus.service.method(dbus.PROPERTIES_IFACE,
892
1331
out_signature="v")
893
1332
def Get(self, interface_name, property_name):
894
1333
"""Standard D-Bus property Get() method, see D-Bus standard.
1026
1462
return xmlstring
1466
dbus.OBJECT_MANAGER_IFACE
1467
except AttributeError:
1468
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1471
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1472
"""A D-Bus object with an ObjectManager.
1474
Classes inheriting from this exposes the standard
1475
GetManagedObjects call and the InterfacesAdded and
1476
InterfacesRemoved signals on the standard
1477
"org.freedesktop.DBus.ObjectManager" interface.
1479
Note: No signals are sent automatically; they must be sent
1482
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1483
out_signature="a{oa{sa{sv}}}")
1484
def GetManagedObjects(self):
1485
"""This function must be overridden"""
1486
raise NotImplementedError()
1488
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1489
signature="oa{sa{sv}}")
1490
def InterfacesAdded(self, object_path, interfaces_and_properties):
1493
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1494
def InterfacesRemoved(self, object_path, interfaces):
1497
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1499
path_keyword='object_path',
1500
connection_keyword='connection')
1501
def Introspect(self, object_path, connection):
1502
"""Overloading of standard D-Bus method.
1504
Override return argument name of GetManagedObjects to be
1505
"objpath_interfaces_and_properties"
1507
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1511
document = xml.dom.minidom.parseString(xmlstring)
1513
for if_tag in document.getElementsByTagName("interface"):
1514
# Fix argument name for the GetManagedObjects method
1515
if (if_tag.getAttribute("name")
1516
== dbus.OBJECT_MANAGER_IFACE):
1517
for cn in if_tag.getElementsByTagName("method"):
1518
if (cn.getAttribute("name")
1519
== "GetManagedObjects"):
1520
for arg in cn.getElementsByTagName("arg"):
1521
if (arg.getAttribute("direction")
1525
"objpath_interfaces"
1527
xmlstring = document.toxml("utf-8")
1529
except (AttributeError, xml.dom.DOMException,
1530
xml.parsers.expat.ExpatError) as error:
1531
logger.error("Failed to override Introspection method",
1029
1536
def datetime_to_dbus(dt, variant_level=0):
1030
1537
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1032
return dbus.String("", variant_level = variant_level)
1033
return dbus.String(dt.isoformat(),
1034
variant_level=variant_level)
1539
return dbus.String("", variant_level=variant_level)
1540
return dbus.String(dt.isoformat(), variant_level=variant_level)
1037
1543
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1067
1574
# Ignore non-D-Bus attributes, and D-Bus attributes
1068
1575
# with the wrong interface name
1069
1576
if (not hasattr(attribute, "_dbus_interface")
1070
or not attribute._dbus_interface
1071
.startswith(orig_interface_name)):
1577
or not attribute._dbus_interface.startswith(
1578
orig_interface_name)):
1073
1580
# Create an alternate D-Bus interface name based on
1074
1581
# the current name
1075
alt_interface = (attribute._dbus_interface
1076
.replace(orig_interface_name,
1077
alt_interface_name))
1582
alt_interface = attribute._dbus_interface.replace(
1583
orig_interface_name, alt_interface_name)
1078
1584
interface_names.add(alt_interface)
1079
1585
# Is this a D-Bus signal?
1080
1586
if getattr(attribute, "_dbus_is_signal", False):
1081
1587
# Extract the original non-method undecorated
1082
1588
# function by black magic
1083
nonmethod_func = (dict(
1589
if sys.version_info.major == 2:
1590
nonmethod_func = (dict(
1084
1591
zip(attribute.func_code.co_freevars,
1085
attribute.__closure__))["func"]
1592
attribute.__closure__))
1593
["func"].cell_contents)
1595
nonmethod_func = (dict(
1596
zip(attribute.__code__.co_freevars,
1597
attribute.__closure__))
1598
["func"].cell_contents)
1087
1599
# Create a new, but exactly alike, function
1088
1600
# object, and decorate it to be a new D-Bus signal
1089
1601
# with the alternate D-Bus interface name
1090
new_function = (dbus.service.signal
1092
attribute._dbus_signature)
1093
(types.FunctionType(
1094
nonmethod_func.func_code,
1095
nonmethod_func.func_globals,
1096
nonmethod_func.func_name,
1097
nonmethod_func.func_defaults,
1098
nonmethod_func.func_closure)))
1602
new_function = copy_function(nonmethod_func)
1603
new_function = (dbus.service.signal(
1605
attribute._dbus_signature)(new_function))
1099
1606
# Copy annotations, if any
1101
new_function._dbus_annotations = (
1102
dict(attribute._dbus_annotations))
1608
new_function._dbus_annotations = dict(
1609
attribute._dbus_annotations)
1103
1610
except AttributeError:
1105
1613
# Define a creator of a function to call both the
1106
1614
# original and alternate functions, so both the
1107
1615
# original and alternate signals gets sent when
1197
1698
if interface_names:
1198
1699
# Replace the class with a new subclass of it with
1199
1700
# methods, signals, etc. as created above.
1200
cls = type(b"{}Alternate".format(cls.__name__),
1701
if sys.version_info.major == 2:
1702
cls = type(b"{}Alternate".format(cls.__name__),
1705
cls = type("{}Alternate".format(cls.__name__),
1206
1712
@alternate_dbus_interfaces({"se.recompile.Mandos":
1207
"se.bsnet.fukt.Mandos"})
1713
"se.bsnet.fukt.Mandos"})
1208
1714
class ClientDBus(Client, DBusObjectWithProperties):
1209
1715
"""A Client class using D-Bus
1212
1718
dbus_object_path: dbus.ObjectPath
1213
1719
bus: dbus.SystemBus()
1216
1722
runtime_expansions = (Client.runtime_expansions
1217
+ ("dbus_object_path",))
1723
+ ("dbus_object_path", ))
1725
_interface = "se.recompile.Mandos.Client"
1219
1727
# dbus.service.Object doesn't use super(), so we can't either.
1221
def __init__(self, bus = None, *args, **kwargs):
1729
def __init__(self, bus=None, *args, **kwargs):
1223
1731
Client.__init__(self, *args, **kwargs)
1224
1732
# Only now, when this client is initialized, can it show up on
1226
client_object_name = unicode(self.name).translate(
1734
client_object_name = str(self.name).translate(
1227
1735
{ord("."): ord("_"),
1228
1736
ord("-"): ord("_")})
1229
self.dbus_object_path = (dbus.ObjectPath
1230
("/clients/" + client_object_name))
1737
self.dbus_object_path = dbus.ObjectPath(
1738
"/clients/" + client_object_name)
1231
1739
DBusObjectWithProperties.__init__(self, self.bus,
1232
1740
self.dbus_object_path)
1234
def notifychangeproperty(transform_func,
1235
dbus_name, type_func=lambda x: x,
1742
def notifychangeproperty(transform_func, dbus_name,
1743
type_func=lambda x: x,
1745
invalidate_only=False,
1746
_interface=_interface):
1237
1747
""" Modify a variable so that it's a property which announces
1238
1748
its changes to DBus.
1240
1750
transform_fun: Function that takes a value and a variant_level
1241
1751
and transforms it to a D-Bus type.
1242
1752
dbus_name: D-Bus name of the variable
1387
1904
server to mandos-client
1391
1908
# Rejected - signal
1392
1909
@dbus.service.signal(_interface, signature="s")
1393
1910
def Rejected(self, reason):
1397
1914
# NeedApproval - signal
1398
1915
@dbus.service.signal(_interface, signature="tb")
1399
1916
def NeedApproval(self, timeout, default):
1401
1918
return self.need_approval()
1405
1922
# Approve - method
1406
1923
@dbus.service.method(_interface, in_signature="b")
1407
1924
def Approve(self, value):
1408
1925
self.approve(value)
1410
1927
# CheckedOK - method
1411
1928
@dbus.service.method(_interface)
1412
1929
def CheckedOK(self):
1413
1930
self.checked_ok()
1415
1932
# Enable - method
1933
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1416
1934
@dbus.service.method(_interface)
1417
1935
def Enable(self):
1421
1939
# StartChecker - method
1940
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1422
1941
@dbus.service.method(_interface)
1423
1942
def StartChecker(self):
1425
1944
self.start_checker()
1427
1946
# Disable - method
1947
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1428
1948
@dbus.service.method(_interface)
1429
1949
def Disable(self):
1433
1953
# StopChecker - method
1954
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1434
1955
@dbus.service.method(_interface)
1435
1956
def StopChecker(self):
1436
1957
self.stop_checker()
1440
1961
# ApprovalPending - property
1441
1962
@dbus_service_property(_interface, signature="b", access="read")
1442
1963
def ApprovalPending_dbus_property(self):
1443
1964
return dbus.Boolean(bool(self.approvals_pending))
1445
1966
# ApprovedByDefault - property
1446
@dbus_service_property(_interface, signature="b",
1967
@dbus_service_property(_interface,
1447
1969
access="readwrite")
1448
1970
def ApprovedByDefault_dbus_property(self, value=None):
1449
1971
if value is None: # get
1450
1972
return dbus.Boolean(self.approved_by_default)
1451
1973
self.approved_by_default = bool(value)
1453
1975
# ApprovalDelay - property
1454
@dbus_service_property(_interface, signature="t",
1976
@dbus_service_property(_interface,
1455
1978
access="readwrite")
1456
1979
def ApprovalDelay_dbus_property(self, value=None):
1457
1980
if value is None: # get
1458
1981
return dbus.UInt64(self.approval_delay.total_seconds()
1460
1983
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1462
1985
# ApprovalDuration - property
1463
@dbus_service_property(_interface, signature="t",
1986
@dbus_service_property(_interface,
1464
1988
access="readwrite")
1465
1989
def ApprovalDuration_dbus_property(self, value=None):
1466
1990
if value is None: # get
1467
1991
return dbus.UInt64(self.approval_duration.total_seconds()
1469
1993
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1471
1995
# Name - property
1997
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1472
1998
@dbus_service_property(_interface, signature="s", access="read")
1473
1999
def Name_dbus_property(self):
1474
2000
return dbus.String(self.name)
1476
2002
# Fingerprint - property
2004
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1477
2005
@dbus_service_property(_interface, signature="s", access="read")
1478
2006
def Fingerprint_dbus_property(self):
1479
2007
return dbus.String(self.fingerprint)
1481
2009
# Host - property
1482
@dbus_service_property(_interface, signature="s",
2010
@dbus_service_property(_interface,
1483
2012
access="readwrite")
1484
2013
def Host_dbus_property(self, value=None):
1485
2014
if value is None: # get
1486
2015
return dbus.String(self.host)
1487
self.host = unicode(value)
2016
self.host = str(value)
1489
2018
# Created - property
2020
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1490
2021
@dbus_service_property(_interface, signature="s", access="read")
1491
2022
def Created_dbus_property(self):
1492
2023
return datetime_to_dbus(self.created)
1494
2025
# LastEnabled - property
1495
2026
@dbus_service_property(_interface, signature="s", access="read")
1496
2027
def LastEnabled_dbus_property(self):
1497
2028
return datetime_to_dbus(self.last_enabled)
1499
2030
# Enabled - property
1500
@dbus_service_property(_interface, signature="b",
2031
@dbus_service_property(_interface,
1501
2033
access="readwrite")
1502
2034
def Enabled_dbus_property(self, value=None):
1503
2035
if value is None: # get
1644
2190
class ClientHandler(socketserver.BaseRequestHandler, object):
1645
2191
"""A class to handle client connections.
1647
2193
Instantiated once for each connection to handle it.
1648
2194
Note: This will run in its own forked process."""
1650
2196
def handle(self):
1651
2197
with contextlib.closing(self.server.child_pipe) as child_pipe:
1652
2198
logger.info("TCP connection from: %s",
1653
unicode(self.client_address))
2199
str(self.client_address))
1654
2200
logger.debug("Pipe FD: %d",
1655
2201
self.server.child_pipe.fileno())
1657
session = (gnutls.connection
1658
.ClientSession(self.request,
1660
.X509Credentials()))
1662
# Note: gnutls.connection.X509Credentials is really a
1663
# generic GnuTLS certificate credentials object so long as
1664
# no X.509 keys are added to it. Therefore, we can use it
1665
# here despite using OpenPGP certificates.
1667
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1668
# "+AES-256-CBC", "+SHA1",
1669
# "+COMP-NULL", "+CTYPE-OPENPGP",
2203
session = gnutls.ClientSession(self.request)
2205
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2206
# "+AES-256-CBC", "+SHA1",
2207
# "+COMP-NULL", "+CTYPE-OPENPGP",
1671
2209
# Use a fallback default, since this MUST be set.
1672
2210
priority = self.server.gnutls_priority
1673
2211
if priority is None:
1674
2212
priority = "NORMAL"
1675
(gnutls.library.functions
1676
.gnutls_priority_set_direct(session._c_object,
2213
gnutls.priority_set_direct(session._c_object,
2214
priority.encode("utf-8"),
1679
2217
# Start communication using the Mandos protocol
1680
2218
# Get protocol number
1681
2219
line = self.request.makefile().readline()
1768
2305
delay -= time2 - time
1771
while sent_size < len(client.secret):
1773
sent = session.send(client.secret[sent_size:])
1774
except gnutls.errors.GNUTLSError as error:
1775
logger.warning("gnutls send failed",
1778
logger.debug("Sent: %d, remaining: %d",
1779
sent, len(client.secret)
1780
- (sent_size + sent))
2308
session.send(client.secret)
2309
except gnutls.Error as error:
2310
logger.warning("gnutls send failed",
1783
2314
logger.info("Sending secret to %s", client.name)
1784
2315
# bump the timeout using extended_timeout
1785
2316
client.bump_timeout(client.extended_timeout)
1786
2317
if self.server.use_dbus:
1787
2318
# Emit D-Bus signal
1788
2319
client.GotSecret()
1791
2322
if approval_required:
1792
2323
client.approvals_pending -= 1
1795
except gnutls.errors.GNUTLSError as error:
2326
except gnutls.Error as error:
1796
2327
logger.warning("GnuTLS bye failed",
1797
2328
exc_info=error)
1800
2331
def peer_certificate(session):
1801
2332
"Return the peer's OpenPGP certificate as a bytestring"
1802
2333
# If not an OpenPGP certificate...
1803
if (gnutls.library.functions
1804
.gnutls_certificate_type_get(session._c_object)
1805
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1806
# ...do the normal thing
1807
return session.peer_certificate
2334
if (gnutls.certificate_type_get(session._c_object)
2335
!= gnutls.CRT_OPENPGP):
2336
# ...return invalid data
1808
2338
list_size = ctypes.c_uint(1)
1809
cert_list = (gnutls.library.functions
1810
.gnutls_certificate_get_peers
2339
cert_list = (gnutls.certificate_get_peers
1811
2340
(session._c_object, ctypes.byref(list_size)))
1812
2341
if not bool(cert_list) and list_size.value != 0:
1813
raise gnutls.errors.GNUTLSError("error getting peer"
2342
raise gnutls.Error("error getting peer certificate")
1815
2343
if list_size.value == 0:
1817
2345
cert = cert_list[0]
1818
2346
return ctypes.string_at(cert.data, cert.size)
1821
2349
def fingerprint(openpgp):
1822
2350
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1823
2351
# New GnuTLS "datum" with the OpenPGP public key
1824
datum = (gnutls.library.types
1825
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1828
ctypes.c_uint(len(openpgp))))
2352
datum = gnutls.datum_t(
2353
ctypes.cast(ctypes.c_char_p(openpgp),
2354
ctypes.POINTER(ctypes.c_ubyte)),
2355
ctypes.c_uint(len(openpgp)))
1829
2356
# New empty GnuTLS certificate
1830
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1831
(gnutls.library.functions
1832
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2357
crt = gnutls.openpgp_crt_t()
2358
gnutls.openpgp_crt_init(ctypes.byref(crt))
1833
2359
# Import the OpenPGP public key into the certificate
1834
(gnutls.library.functions
1835
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1836
gnutls.library.constants
1837
.GNUTLS_OPENPGP_FMT_RAW))
2360
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2361
gnutls.OPENPGP_FMT_RAW)
1838
2362
# Verify the self signature in the key
1839
2363
crtverify = ctypes.c_uint()
1840
(gnutls.library.functions
1841
.gnutls_openpgp_crt_verify_self(crt, 0,
1842
ctypes.byref(crtverify)))
2364
gnutls.openpgp_crt_verify_self(crt, 0,
2365
ctypes.byref(crtverify))
1843
2366
if crtverify.value != 0:
1844
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1845
raise (gnutls.errors.CertificateSecurityError
2367
gnutls.openpgp_crt_deinit(crt)
2368
raise gnutls.CertificateSecurityError("Verify failed")
1847
2369
# New buffer for the fingerprint
1848
2370
buf = ctypes.create_string_buffer(20)
1849
2371
buf_len = ctypes.c_size_t()
1850
2372
# Get the fingerprint from the certificate into the buffer
1851
(gnutls.library.functions
1852
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1853
ctypes.byref(buf_len)))
2373
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2374
ctypes.byref(buf_len))
1854
2375
# Deinit the certificate
1855
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2376
gnutls.openpgp_crt_deinit(crt)
1856
2377
# Convert the buffer to a Python bytestring
1857
2378
fpr = ctypes.string_at(buf, buf_len.value)
1858
2379
# Convert the bytestring to hexadecimal notation
1941
2468
# socket_wrapper(), if socketfd was set.
1942
2469
socketserver.TCPServer.__init__(self, server_address,
1943
2470
RequestHandlerClass)
1945
2472
def server_bind(self):
1946
2473
"""This overrides the normal server_bind() function
1947
2474
to bind to an interface if one was specified, and also NOT to
1948
2475
bind to an address or port if they were not specified."""
2476
global SO_BINDTODEVICE
1949
2477
if self.interface is not None:
1950
2478
if SO_BINDTODEVICE is None:
1951
logger.error("SO_BINDTODEVICE does not exist;"
1952
" cannot bind to interface %s",
1956
self.socket.setsockopt(socket.SOL_SOCKET,
1958
(self.interface + "\0")
1960
except socket.error as error:
1961
if error.errno == errno.EPERM:
1962
logger.error("No permission to bind to"
1963
" interface %s", self.interface)
1964
elif error.errno == errno.ENOPROTOOPT:
1965
logger.error("SO_BINDTODEVICE not available;"
1966
" cannot bind to interface %s",
1968
elif error.errno == errno.ENODEV:
1969
logger.error("Interface %s does not exist,"
1970
" cannot bind", self.interface)
2479
# Fall back to a hard-coded value which seems to be
2481
logger.warning("SO_BINDTODEVICE not found, trying 25")
2482
SO_BINDTODEVICE = 25
2484
self.socket.setsockopt(
2485
socket.SOL_SOCKET, SO_BINDTODEVICE,
2486
(self.interface + "\0").encode("utf-8"))
2487
except socket.error as error:
2488
if error.errno == errno.EPERM:
2489
logger.error("No permission to bind to"
2490
" interface %s", self.interface)
2491
elif error.errno == errno.ENOPROTOOPT:
2492
logger.error("SO_BINDTODEVICE not available;"
2493
" cannot bind to interface %s",
2495
elif error.errno == errno.ENODEV:
2496
logger.error("Interface %s does not exist,"
2497
" cannot bind", self.interface)
1973
2500
# Only bind(2) the socket if we really need to.
1974
2501
if self.server_address[0] or self.server_address[1]:
1975
2502
if not self.server_address[0]:
1976
2503
if self.address_family == socket.AF_INET6:
1977
any_address = "::" # in6addr_any
2504
any_address = "::" # in6addr_any
1979
any_address = "0.0.0.0" # INADDR_ANY
2506
any_address = "0.0.0.0" # INADDR_ANY
1980
2507
self.server_address = (any_address,
1981
2508
self.server_address[1])
1982
2509
elif not self.server_address[1]:
1983
self.server_address = (self.server_address[0],
2510
self.server_address = (self.server_address[0], 0)
1985
2511
# if self.interface:
1986
2512
# self.server_address = (self.server_address[0],
2418
2952
level = getattr(logging, debuglevel.upper())
2419
2953
initlogger(debug, level)
2421
2955
if server_settings["servicename"] != "Mandos":
2422
syslogger.setFormatter(logging.Formatter
2423
('Mandos ({}) [%(process)d]:'
2424
' %(levelname)s: %(message)s'
2425
.format(server_settings
2956
syslogger.setFormatter(
2957
logging.Formatter('Mandos ({}) [%(process)d]:'
2958
' %(levelname)s: %(message)s'.format(
2959
server_settings["servicename"])))
2428
2961
# Parse config file with clients
2429
2962
client_config = configparser.SafeConfigParser(Client
2430
2963
.client_defaults)
2431
2964
client_config.read(os.path.join(server_settings["configdir"],
2432
2965
"clients.conf"))
2434
2967
global mandos_dbus_service
2435
2968
mandos_dbus_service = None
2437
2970
socketfd = None
2438
2971
if server_settings["socket"] != "":
2439
2972
socketfd = server_settings["socket"]
2440
tcp_server = MandosServer((server_settings["address"],
2441
server_settings["port"]),
2443
interface=(server_settings["interface"]
2447
server_settings["priority"],
2973
tcp_server = MandosServer(
2974
(server_settings["address"], server_settings["port"]),
2976
interface=(server_settings["interface"] or None),
2978
gnutls_priority=server_settings["priority"],
2450
2981
if not foreground:
2451
2982
pidfilename = "/run/mandos.pid"
2452
2983
if not os.path.isdir("/run/."):
2453
2984
pidfilename = "/var/run/mandos.pid"
2456
pidfile = open(pidfilename, "w")
2987
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2457
2988
except IOError as e:
2458
2989
logger.error("Could not open file %r", pidfilename,
2461
for name in ("_mandos", "mandos", "nobody"):
2992
for name, group in (("_mandos", "_mandos"),
2993
("mandos", "mandos"),
2994
("nobody", "nogroup")):
2463
2996
uid = pwd.getpwnam(name).pw_uid
2464
gid = pwd.getpwnam(name).pw_gid
2997
gid = pwd.getpwnam(group).pw_gid
2466
2999
except KeyError:
3008
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2474
3010
except OSError as error:
3011
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3012
.format(uid, gid, os.strerror(error.errno)))
2475
3013
if error.errno != errno.EPERM:
2479
3017
# Enable all possible GnuTLS debugging
2481
3019
# "Use a log level over 10 to enable all debugging options."
2482
3020
# - GnuTLS manual
2483
gnutls.library.functions.gnutls_global_set_log_level(11)
2485
@gnutls.library.types.gnutls_log_func
3021
gnutls.global_set_log_level(11)
2486
3024
def debug_gnutls(level, string):
2487
3025
logger.debug("GnuTLS: %s", string[:-1])
2489
(gnutls.library.functions
2490
.gnutls_global_set_log_function(debug_gnutls))
3027
gnutls.global_set_log_function(debug_gnutls)
2492
3029
# Redirect stdin so all checkers get /dev/null
2493
3030
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2494
3031
os.dup2(null, sys.stdin.fileno())
2498
3035
# Need to fork before connecting to D-Bus
2499
3036
if not foreground:
2500
3037
# Close all input and output, do double fork, etc.
2503
# multiprocessing will use threads, so before we use gobject we
2504
# need to inform gobject that threads will be used.
2505
gobject.threads_init()
3040
# multiprocessing will use threads, so before we use GLib we need
3041
# to inform GLib that threads will be used.
2507
3044
global main_loop
2508
3045
# From the Avahi example code
2509
3046
DBusGMainLoop(set_as_default=True)
2510
main_loop = gobject.MainLoop()
3047
main_loop = GLib.MainLoop()
2511
3048
bus = dbus.SystemBus()
2512
3049
# End of Avahi example code
2515
3052
bus_name = dbus.service.BusName("se.recompile.Mandos",
2516
bus, do_not_queue=True)
2517
old_bus_name = (dbus.service.BusName
2518
("se.bsnet.fukt.Mandos", bus,
2520
except dbus.exceptions.NameExistsException as e:
3055
old_bus_name = dbus.service.BusName(
3056
"se.bsnet.fukt.Mandos", bus,
3058
except dbus.exceptions.DBusException as e:
2521
3059
logger.error("Disabling D-Bus:", exc_info=e)
2522
3060
use_dbus = False
2523
3061
server_settings["use_dbus"] = False
2524
3062
tcp_server.use_dbus = False
2526
3064
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2527
service = AvahiServiceToSyslog(name =
2528
server_settings["servicename"],
2529
servicetype = "_mandos._tcp",
2530
protocol = protocol, bus = bus)
3065
service = AvahiServiceToSyslog(
3066
name=server_settings["servicename"],
3067
servicetype="_mandos._tcp",
2531
3070
if server_settings["interface"]:
2532
service.interface = (if_nametoindex
2533
(server_settings["interface"]
3071
service.interface = if_nametoindex(
3072
server_settings["interface"].encode("utf-8"))
2536
3074
global multiprocessing_manager
2537
3075
multiprocessing_manager = multiprocessing.Manager()
2539
3077
client_class = Client
2541
client_class = functools.partial(ClientDBus, bus = bus)
3079
client_class = functools.partial(ClientDBus, bus=bus)
2543
3081
client_settings = Client.config_parser(client_config)
2544
3082
old_client_settings = {}
2545
3083
clients_data = {}
2547
3085
# This is used to redirect stdout and stderr for checker processes
2549
wnull = open(os.devnull, "w") # A writable /dev/null
3087
wnull = open(os.devnull, "w") # A writable /dev/null
2550
3088
# Only used if server is running in foreground but not in debug
2552
3090
if debug or not foreground:
2555
3093
# Get client data and settings from last running state.
2556
3094
if server_settings["restore"]:
2558
3096
with open(stored_state_path, "rb") as stored_state:
2559
clients_data, old_client_settings = (pickle.load
3097
if sys.version_info.major == 2:
3098
clients_data, old_client_settings = pickle.load(
3101
bytes_clients_data, bytes_old_client_settings = (
3102
pickle.load(stored_state, encoding="bytes"))
3103
# Fix bytes to strings
3106
clients_data = {(key.decode("utf-8")
3107
if isinstance(key, bytes)
3110
bytes_clients_data.items()}
3111
del bytes_clients_data
3112
for key in clients_data:
3113
value = {(k.decode("utf-8")
3114
if isinstance(k, bytes) else k): v
3116
clients_data[key].items()}
3117
clients_data[key] = value
3119
value["client_structure"] = [
3121
if isinstance(s, bytes)
3123
value["client_structure"]]
3125
for k in ("name", "host"):
3126
if isinstance(value[k], bytes):
3127
value[k] = value[k].decode("utf-8")
3128
# old_client_settings
3130
old_client_settings = {
3131
(key.decode("utf-8")
3132
if isinstance(key, bytes)
3135
bytes_old_client_settings.items()}
3136
del bytes_old_client_settings
3138
for value in old_client_settings.values():
3139
if isinstance(value["host"], bytes):
3140
value["host"] = (value["host"]
2561
3142
os.remove(stored_state_path)
2562
3143
except IOError as e:
2563
3144
if e.errno == errno.ENOENT:
2564
logger.warning("Could not load persistent state: {}"
2565
.format(os.strerror(e.errno)))
3145
logger.warning("Could not load persistent state:"
3146
" {}".format(os.strerror(e.errno)))
2567
3148
logger.critical("Could not load persistent state:",
2570
3151
except EOFError as e:
2571
3152
logger.warning("Could not load persistent state: "
2572
"EOFError:", exc_info=e)
2574
3156
with PGPEngine() as pgp:
2575
3157
for client_name, client in clients_data.items():
2576
3158
# Skip removed clients
2577
3159
if client_name not in client_settings:
2580
3162
# Decide which value to use after restoring saved state.
2581
3163
# We have three different values: Old config file,
2582
3164
# new config file, and saved state.
2640
3222
for client_name in (set(client_settings)
2641
3223
- set(old_client_settings)):
2642
3224
clients_data[client_name] = client_settings[client_name]
2644
3226
# Create all client objects
2645
3227
for client_name, client in clients_data.items():
2646
3228
tcp_server.clients[client_name] = client_class(
2647
name = client_name, settings = client,
2648
server_settings = server_settings)
3231
server_settings=server_settings)
2650
3233
if not tcp_server.clients:
2651
3234
logger.warning("No clients defined")
2653
3236
if not foreground:
2654
3237
if pidfile is not None:
2658
pidfile.write("{}\n".format(pid).encode("utf-8"))
3241
print(pid, file=pidfile)
2659
3242
except IOError:
2660
3243
logger.error("Could not write to file %r with PID %d",
2661
3244
pidfilename, pid)
2663
3246
del pidfilename
2665
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2666
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3248
for termsig in (signal.SIGHUP, signal.SIGTERM):
3249
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3250
lambda: main_loop.quit() and False)
2669
@alternate_dbus_interfaces({"se.recompile.Mandos":
2670
"se.bsnet.fukt.Mandos"})
2671
class MandosDBusService(DBusObjectWithProperties):
3254
@alternate_dbus_interfaces(
3255
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3256
class MandosDBusService(DBusObjectWithObjectManager):
2672
3257
"""A D-Bus proxy object"""
2673
3259
def __init__(self):
2674
3260
dbus.service.Object.__init__(self, bus, "/")
2675
3262
_interface = "se.recompile.Mandos"
2677
@dbus_interface_annotations(_interface)
2679
return { "org.freedesktop.DBus.Property"
2680
".EmitsChangedSignal":
2683
3264
@dbus.service.signal(_interface, signature="o")
2684
3265
def ClientAdded(self, objpath):
2688
3269
@dbus.service.signal(_interface, signature="ss")
2689
3270
def ClientNotFound(self, fingerprint, address):
3274
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2693
3276
@dbus.service.signal(_interface, signature="os")
2694
3277
def ClientRemoved(self, objpath, name):
3281
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2698
3283
@dbus.service.method(_interface, out_signature="ao")
2699
3284
def GetAllClients(self):
2701
return dbus.Array(c.dbus_object_path
2703
tcp_server.clients.itervalues())
3286
return dbus.Array(c.dbus_object_path for c in
3287
tcp_server.clients.values())
3289
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2705
3291
@dbus.service.method(_interface,
2706
3292
out_signature="a{oa{sv}}")
2707
3293
def GetAllClientsWithProperties(self):
2709
3295
return dbus.Dictionary(
2710
((c.dbus_object_path, c.GetAll(""))
2711
for c in tcp_server.clients.itervalues()),
3296
{c.dbus_object_path: c.GetAll(
3297
"se.recompile.Mandos.Client")
3298
for c in tcp_server.clients.values()},
2712
3299
signature="oa{sv}")
2714
3301
@dbus.service.method(_interface, in_signature="o")
2715
3302
def RemoveClient(self, object_path):
2717
for c in tcp_server.clients.itervalues():
3304
for c in tcp_server.clients.values():
2718
3305
if c.dbus_object_path == object_path:
2719
3306
del tcp_server.clients[c.name]
2720
3307
c.remove_from_connection()
2721
# Don't signal anything except ClientRemoved
3308
# Don't signal the disabling
2722
3309
c.disable(quiet=True)
2724
self.ClientRemoved(object_path, c.name)
3310
# Emit D-Bus signal for removal
3311
self.client_removed_signal(c)
2726
3313
raise KeyError(object_path)
3317
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3318
out_signature="a{oa{sa{sv}}}")
3319
def GetManagedObjects(self):
3321
return dbus.Dictionary(
3322
{client.dbus_object_path:
3324
{interface: client.GetAll(interface)
3326
client._get_all_interface_names()})
3327
for client in tcp_server.clients.values()})
3329
def client_added_signal(self, client):
3330
"""Send the new standard signal and the old signal"""
3332
# New standard signal
3333
self.InterfacesAdded(
3334
client.dbus_object_path,
3336
{interface: client.GetAll(interface)
3338
client._get_all_interface_names()}))
3340
self.ClientAdded(client.dbus_object_path)
3342
def client_removed_signal(self, client):
3343
"""Send the new standard signal and the old signal"""
3345
# New standard signal
3346
self.InterfacesRemoved(
3347
client.dbus_object_path,
3348
client._get_all_interface_names())
3350
self.ClientRemoved(client.dbus_object_path,
2730
3353
mandos_dbus_service = MandosDBusService()
3355
# Save modules to variables to exempt the modules from being
3356
# unloaded before the function registered with atexit() is run.
3357
mp = multiprocessing
2733
3361
"Cleanup function; run on exit"
2735
3363
service.cleanup()
2737
multiprocessing.active_children()
3365
mp.active_children()
2739
3367
if not (tcp_server.clients or client_settings):
2742
3370
# Store client before exiting. Secrets are encrypted with key
2743
3371
# based on what config file has. If config file is
2744
3372
# removed/edited, old secret will thus be unrecovable.
2746
3374
with PGPEngine() as pgp:
2747
for client in tcp_server.clients.itervalues():
3375
for client in tcp_server.clients.values():
2748
3376
key = client_settings[client.name]["secret"]
2749
3377
client.encrypted_secret = pgp.encrypt(client.secret,
2751
3379
client_dict = {}
2753
3381
# A list of attributes that can not be pickled
2755
exclude = { "bus", "changedstate", "secret",
2756
"checker", "server_settings" }
2757
for name, typ in (inspect.getmembers
2758
(dbus.service.Object)):
3383
exclude = {"bus", "changedstate", "secret",
3384
"checker", "server_settings"}
3385
for name, typ in inspect.getmembers(dbus.service
2759
3387
exclude.add(name)
2761
3389
client_dict["encrypted_secret"] = (client
2762
3390
.encrypted_secret)
2763
3391
for attr in client.client_structure:
2764
3392
if attr not in exclude:
2765
3393
client_dict[attr] = getattr(client, attr)
2767
3395
clients[client.name] = client_dict
2768
3396
del client_settings[client.name]["secret"]
2771
with (tempfile.NamedTemporaryFile
2772
(mode='wb', suffix=".pickle", prefix='clients-',
2773
dir=os.path.dirname(stored_state_path),
2774
delete=False)) as stored_state:
2775
pickle.dump((clients, client_settings), stored_state)
2776
tempname=stored_state.name
3399
with tempfile.NamedTemporaryFile(
3403
dir=os.path.dirname(stored_state_path),
3404
delete=False) as stored_state:
3405
pickle.dump((clients, client_settings), stored_state,
3407
tempname = stored_state.name
2777
3408
os.rename(tempname, stored_state_path)
2778
3409
except (IOError, OSError) as e: