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-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
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
21
19
# the Free Software Foundation, either version 3 of the License, or
22
20
# (at your option) any later version.
24
# Mandos is distributed in the hope that it will be useful, but
25
# WITHOUT ANY WARRANTY; without even the implied warranty of
22
# This program is distributed in the hope that it will be useful,
23
# but WITHOUT ANY WARRANTY; without even the implied warranty of
26
24
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
27
25
# GNU General Public License for more details.
29
27
# You should have received a copy of the GNU General Public License
30
# along with Mandos. If not, see <http://www.gnu.org/licenses/>.
28
# along with this program. If not, see
29
# <http://www.gnu.org/licenses/>.
32
31
# Contact the authors at <mandos@recompile.se>.
35
34
from __future__ import (division, absolute_import, print_function,
39
from future_builtins import *
37
from future_builtins import *
44
import SocketServer as socketserver
39
import SocketServer as socketserver
52
import ConfigParser as configparser
45
import gnutls.connection
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
236
180
.replace(b"\n", b"\\n")
237
181
.replace(b"\0", b"\\x00"))
240
184
def encrypt(self, data, password):
241
185
passphrase = self.password_encode(password)
242
with tempfile.NamedTemporaryFile(
243
dir=self.tempdir) as passfile:
186
with tempfile.NamedTemporaryFile(dir=self.tempdir
244
188
passfile.write(passphrase)
246
proc = subprocess.Popen([self.gpg, '--symmetric',
190
proc = subprocess.Popen(['gpg', '--symmetric',
247
191
'--passphrase-file',
249
193
+ self.gnupgargs,
250
stdin=subprocess.PIPE,
251
stdout=subprocess.PIPE,
252
stderr=subprocess.PIPE)
253
ciphertext, err = proc.communicate(input=data)
194
stdin = subprocess.PIPE,
195
stdout = subprocess.PIPE,
196
stderr = subprocess.PIPE)
197
ciphertext, err = proc.communicate(input = data)
254
198
if proc.returncode != 0:
255
199
raise PGPError(err)
256
200
return ciphertext
258
202
def decrypt(self, data, password):
259
203
passphrase = self.password_encode(password)
260
with tempfile.NamedTemporaryFile(
261
dir=self.tempdir) as passfile:
204
with tempfile.NamedTemporaryFile(dir = self.tempdir
262
206
passfile.write(passphrase)
264
proc = subprocess.Popen([self.gpg, '--decrypt',
208
proc = subprocess.Popen(['gpg', '--decrypt',
265
209
'--passphrase-file',
267
211
+ self.gnupgargs,
268
stdin=subprocess.PIPE,
269
stdout=subprocess.PIPE,
270
stderr=subprocess.PIPE)
271
decrypted_plaintext, err = proc.communicate(input=data)
212
stdin = subprocess.PIPE,
213
stdout = subprocess.PIPE,
214
stderr = subprocess.PIPE)
215
decrypted_plaintext, err = proc.communicate(input
272
217
if proc.returncode != 0:
273
218
raise PGPError(err)
274
219
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
304
222
class AvahiError(Exception):
305
223
def __init__(self, value, *args, **kwargs):
306
224
self.value = value
307
225
return super(AvahiError, self).__init__(value, *args,
311
228
class AvahiServiceError(AvahiError):
315
231
class AvahiGroupError(AvahiError):
319
235
class AvahiService(object):
320
236
"""An Avahi (Zeroconf) service.
323
239
interface: integer; avahi.IF_UNSPEC or an interface index.
324
240
Used to optionally bind to the specified interface.
489
383
follow_name_owner_changes=True),
490
384
avahi.DBUS_INTERFACE_SERVER)
491
385
self.server.connect_to_signal("StateChanged",
492
self.server_state_changed)
386
self.server_state_changed)
493
387
self.server_state_changed(self.server.GetState())
496
390
class AvahiServiceToSyslog(AvahiService):
497
def rename(self, *args, **kwargs):
498
392
"""Add the new name to the syslog messages"""
499
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
500
syslogger.setFormatter(logging.Formatter(
501
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
393
ret = AvahiService.rename(self)
394
syslogger.setFormatter(logging.Formatter
395
('Mandos ({}) [%(process)d]:'
396
' %(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))
780
401
class Client(object):
781
402
"""A representation of a client host served by this server.
784
405
approved: bool(); 'None' if not yet approved/disapproved
785
406
approval_delay: datetime.timedelta(); Time to wait for approval
960
579
logger.info("Disabling client %s", self.name)
961
580
if getattr(self, "disable_initiator_tag", None) is not None:
962
GLib.source_remove(self.disable_initiator_tag)
581
gobject.source_remove(self.disable_initiator_tag)
963
582
self.disable_initiator_tag = None
964
583
self.expires = None
965
584
if getattr(self, "checker_initiator_tag", None) is not None:
966
GLib.source_remove(self.checker_initiator_tag)
585
gobject.source_remove(self.checker_initiator_tag)
967
586
self.checker_initiator_tag = None
968
587
self.stop_checker()
969
588
self.enabled = False
971
590
self.send_changedstate()
972
# Do not run this again if called by a GLib.timeout_add
591
# Do not run this again if called by a gobject.timeout_add
975
594
def __del__(self):
978
597
def init_checker(self):
979
598
# Schedule a new checker to be started an 'interval' from now,
980
599
# and every interval from then on.
981
600
if self.checker_initiator_tag is not None:
982
GLib.source_remove(self.checker_initiator_tag)
983
self.checker_initiator_tag = GLib.timeout_add(
984
int(self.interval.total_seconds() * 1000),
601
gobject.source_remove(self.checker_initiator_tag)
602
self.checker_initiator_tag = (gobject.timeout_add
604
.total_seconds() * 1000),
986
606
# Schedule a disable() when 'timeout' has passed
987
607
if self.disable_initiator_tag is not None:
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)
608
gobject.source_remove(self.disable_initiator_tag)
609
self.disable_initiator_tag = (gobject.timeout_add
611
.total_seconds() * 1000),
991
613
# Also start a new checker *right now*.
992
614
self.start_checker()
994
def checker_callback(self, source, condition, connection,
616
def checker_callback(self, pid, condition, command):
996
617
"""The checker has completed, so take appropriate actions."""
997
618
self.checker_callback_tag = None
998
619
self.checker = None
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
620
if os.WIFEXITED(condition):
621
self.last_checker_status = os.WEXITSTATUS(condition)
1006
622
if self.last_checker_status == 0:
1007
623
logger.info("Checker for %(name)s succeeded",
1009
625
self.checked_ok()
1011
logger.info("Checker for %(name)s failed", vars(self))
627
logger.info("Checker for %(name)s failed",
1013
630
self.last_checker_status = -1
1014
self.last_checker_signal = -returncode
1015
631
logger.warning("Checker for %(name)s crashed?",
1019
634
def checked_ok(self):
1020
635
"""Assert that the client has been seen, alive and well."""
1021
636
self.last_checked_ok = datetime.datetime.utcnow()
1022
637
self.last_checker_status = 0
1023
self.last_checker_signal = None
1024
638
self.bump_timeout()
1026
640
def bump_timeout(self, timeout=None):
1027
641
"""Bump up the timeout for this client."""
1028
642
if timeout is None:
1029
643
timeout = self.timeout
1030
644
if self.disable_initiator_tag is not None:
1031
GLib.source_remove(self.disable_initiator_tag)
645
gobject.source_remove(self.disable_initiator_tag)
1032
646
self.disable_initiator_tag = None
1033
647
if getattr(self, "enabled", False):
1034
self.disable_initiator_tag = GLib.timeout_add(
1035
int(timeout.total_seconds() * 1000), self.disable)
648
self.disable_initiator_tag = (gobject.timeout_add
649
(int(timeout.total_seconds()
650
* 1000), self.disable))
1036
651
self.expires = datetime.datetime.utcnow() + timeout
1038
653
def need_approval(self):
1039
654
self.last_approval_request = datetime.datetime.utcnow()
1041
656
def start_checker(self):
1042
657
"""Start a new checker subprocess if one is not running.
1044
659
If a checker already exists, leave it running and do
1046
661
# The reason for not killing a running checker is that if we
1051
666
# checkers alone, the checker would have to take more time
1052
667
# than 'timeout' for the client to be disabled, which is as it
1055
if self.checker is not None and not self.checker.is_alive():
1056
logger.warning("Checker was not alive; joining")
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)
1059
684
# Start a new checker if needed
1060
685
if self.checker is None:
1061
686
# Escape attributes for the shell
1063
attr: re.escape(str(getattr(self, attr)))
1064
for attr in self.runtime_expansions}
687
escaped_attrs = { attr:
688
re.escape(unicode(getattr(self,
690
for attr in self.runtime_expansions }
1066
692
command = self.checker_command % escaped_attrs
1067
693
except TypeError as error:
1068
694
logger.error('Could not format string "%s"',
1069
self.checker_command,
695
self.checker_command, exc_info=error)
696
return True # Try again later
697
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",
1071
return True # Try again later
1072
self.current_checker_command = command
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
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
1101
742
def stop_checker(self):
1102
743
"""Force the checker process, if any, to stop."""
1103
744
if self.checker_callback_tag:
1104
GLib.source_remove(self.checker_callback_tag)
745
gobject.source_remove(self.checker_callback_tag)
1105
746
self.checker_callback_tag = None
1106
747
if getattr(self, "checker", None) is None:
1108
749
logger.debug("Stopping checker for %(name)s", vars(self))
1109
self.checker.terminate()
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
1110
758
self.checker = None
1113
def dbus_service_property(dbus_interface,
761
def dbus_service_property(dbus_interface, signature="v",
762
access="readwrite", byte_arrays=False):
1117
763
"""Decorators for marking methods of a DBusObjectWithProperties to
1118
764
become properties on the D-Bus.
1120
766
The decorated method will be called with no arguments by "Get"
1121
767
and with one argument by "Set".
1123
769
The parameters, where they are supported, are the same as
1124
770
dbus.service.method, except there is only "signature", since the
1125
771
type from Get() and the type sent to Set() is the same.
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.
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.
1216
854
def _is_dbus_thing(thing):
1217
855
"""Returns a function testing if an attribute is a D-Bus thing
1219
857
If called like _is_dbus_thing("method") it returns a function
1220
858
suitable for use as predicate to inspect.getmembers().
1222
860
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1225
863
def _get_all_dbus_things(self, thing):
1226
864
"""Returns a generator of (name, attribute) pairs
1228
return ((getattr(athing.__get__(self), "_dbus_name", name),
866
return ((getattr(athing.__get__(self), "_dbus_name",
1229
868
athing.__get__(self))
1230
869
for cls in self.__class__.__mro__
1231
870
for name, athing in
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.
871
inspect.getmembers(cls,
872
self._is_dbus_thing(thing)))
1305
874
def _get_dbus_property(self, interface_name, property_name):
1306
875
"""Returns a bound method if one exists which is a D-Bus
1307
876
property with the specified name and interface.
1309
for cls in self.__class__.__mro__:
1310
for name, value in inspect.getmembers(
1311
cls, self._is_dbus_thing("property")):
878
for cls in self.__class__.__mro__:
879
for name, value in (inspect.getmembers
881
self._is_dbus_thing("property"))):
1312
882
if (value._dbus_name == property_name
1313
883
and value._dbus_interface == interface_name):
1314
884
return value.__get__(self)
1316
886
# No such property
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,
887
raise DBusPropertyNotFound(self.dbus_object_path + ":"
888
+ interface_name + "."
891
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1331
892
out_signature="v")
1332
893
def Get(self, interface_name, property_name):
1333
894
"""Standard D-Bus property Get() method, see D-Bus standard.
1462
1026
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",
1536
1029
def datetime_to_dbus(dt, variant_level=0):
1537
1030
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1539
return dbus.String("", variant_level=variant_level)
1540
return dbus.String(dt.isoformat(), variant_level=variant_level)
1032
return dbus.String("", variant_level = variant_level)
1033
return dbus.String(dt.isoformat(),
1034
variant_level=variant_level)
1543
1037
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1574
1067
# Ignore non-D-Bus attributes, and D-Bus attributes
1575
1068
# with the wrong interface name
1576
1069
if (not hasattr(attribute, "_dbus_interface")
1577
or not attribute._dbus_interface.startswith(
1578
orig_interface_name)):
1070
or not attribute._dbus_interface
1071
.startswith(orig_interface_name)):
1580
1073
# Create an alternate D-Bus interface name based on
1581
1074
# the current name
1582
alt_interface = attribute._dbus_interface.replace(
1583
orig_interface_name, alt_interface_name)
1075
alt_interface = (attribute._dbus_interface
1076
.replace(orig_interface_name,
1077
alt_interface_name))
1584
1078
interface_names.add(alt_interface)
1585
1079
# Is this a D-Bus signal?
1586
1080
if getattr(attribute, "_dbus_is_signal", False):
1587
1081
# Extract the original non-method undecorated
1588
1082
# function by black magic
1589
if sys.version_info.major == 2:
1590
nonmethod_func = (dict(
1083
nonmethod_func = (dict(
1591
1084
zip(attribute.func_code.co_freevars,
1592
attribute.__closure__))
1593
["func"].cell_contents)
1595
nonmethod_func = (dict(
1596
zip(attribute.__code__.co_freevars,
1597
attribute.__closure__))
1598
["func"].cell_contents)
1085
attribute.__closure__))["func"]
1599
1087
# Create a new, but exactly alike, function
1600
1088
# object, and decorate it to be a new D-Bus signal
1601
1089
# with the alternate D-Bus interface name
1602
new_function = copy_function(nonmethod_func)
1603
new_function = (dbus.service.signal(
1605
attribute._dbus_signature)(new_function))
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)))
1606
1099
# Copy annotations, if any
1608
new_function._dbus_annotations = dict(
1609
attribute._dbus_annotations)
1101
new_function._dbus_annotations = (
1102
dict(attribute._dbus_annotations))
1610
1103
except AttributeError:
1613
1105
# Define a creator of a function to call both the
1614
1106
# original and alternate functions, so both the
1615
1107
# original and alternate signals gets sent when
1698
1197
if interface_names:
1699
1198
# Replace the class with a new subclass of it with
1700
1199
# methods, signals, etc. as created above.
1701
if sys.version_info.major == 2:
1702
cls = type(b"{}Alternate".format(cls.__name__),
1705
cls = type("{}Alternate".format(cls.__name__),
1200
cls = type(b"{}Alternate".format(cls.__name__),
1712
1206
@alternate_dbus_interfaces({"se.recompile.Mandos":
1713
"se.bsnet.fukt.Mandos"})
1207
"se.bsnet.fukt.Mandos"})
1714
1208
class ClientDBus(Client, DBusObjectWithProperties):
1715
1209
"""A Client class using D-Bus
1718
1212
dbus_object_path: dbus.ObjectPath
1719
1213
bus: dbus.SystemBus()
1722
1216
runtime_expansions = (Client.runtime_expansions
1723
+ ("dbus_object_path", ))
1725
_interface = "se.recompile.Mandos.Client"
1217
+ ("dbus_object_path",))
1727
1219
# dbus.service.Object doesn't use super(), so we can't either.
1729
def __init__(self, bus=None, *args, **kwargs):
1221
def __init__(self, bus = None, *args, **kwargs):
1731
1223
Client.__init__(self, *args, **kwargs)
1732
1224
# Only now, when this client is initialized, can it show up on
1734
client_object_name = str(self.name).translate(
1226
client_object_name = unicode(self.name).translate(
1735
1227
{ord("."): ord("_"),
1736
1228
ord("-"): ord("_")})
1737
self.dbus_object_path = dbus.ObjectPath(
1738
"/clients/" + client_object_name)
1229
self.dbus_object_path = (dbus.ObjectPath
1230
("/clients/" + client_object_name))
1739
1231
DBusObjectWithProperties.__init__(self, self.bus,
1740
1232
self.dbus_object_path)
1742
def notifychangeproperty(transform_func, dbus_name,
1743
type_func=lambda x: x,
1745
invalidate_only=False,
1746
_interface=_interface):
1234
def notifychangeproperty(transform_func,
1235
dbus_name, type_func=lambda x: x,
1747
1237
""" Modify a variable so that it's a property which announces
1748
1238
its changes to DBus.
1750
1240
transform_fun: Function that takes a value and a variant_level
1751
1241
and transforms it to a D-Bus type.
1752
1242
dbus_name: D-Bus name of the variable
1904
1387
server to mandos-client
1908
1391
# Rejected - signal
1909
1392
@dbus.service.signal(_interface, signature="s")
1910
1393
def Rejected(self, reason):
1914
1397
# NeedApproval - signal
1915
1398
@dbus.service.signal(_interface, signature="tb")
1916
1399
def NeedApproval(self, timeout, default):
1918
1401
return self.need_approval()
1922
1405
# Approve - method
1923
1406
@dbus.service.method(_interface, in_signature="b")
1924
1407
def Approve(self, value):
1925
1408
self.approve(value)
1927
1410
# CheckedOK - method
1928
1411
@dbus.service.method(_interface)
1929
1412
def CheckedOK(self):
1930
1413
self.checked_ok()
1932
1415
# Enable - method
1933
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1934
1416
@dbus.service.method(_interface)
1935
1417
def Enable(self):
1939
1421
# StartChecker - method
1940
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1941
1422
@dbus.service.method(_interface)
1942
1423
def StartChecker(self):
1944
1425
self.start_checker()
1946
1427
# Disable - method
1947
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1948
1428
@dbus.service.method(_interface)
1949
1429
def Disable(self):
1953
1433
# StopChecker - method
1954
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1955
1434
@dbus.service.method(_interface)
1956
1435
def StopChecker(self):
1957
1436
self.stop_checker()
1961
1440
# ApprovalPending - property
1962
1441
@dbus_service_property(_interface, signature="b", access="read")
1963
1442
def ApprovalPending_dbus_property(self):
1964
1443
return dbus.Boolean(bool(self.approvals_pending))
1966
1445
# ApprovedByDefault - property
1967
@dbus_service_property(_interface,
1446
@dbus_service_property(_interface, signature="b",
1969
1447
access="readwrite")
1970
1448
def ApprovedByDefault_dbus_property(self, value=None):
1971
1449
if value is None: # get
1972
1450
return dbus.Boolean(self.approved_by_default)
1973
1451
self.approved_by_default = bool(value)
1975
1453
# ApprovalDelay - property
1976
@dbus_service_property(_interface,
1454
@dbus_service_property(_interface, signature="t",
1978
1455
access="readwrite")
1979
1456
def ApprovalDelay_dbus_property(self, value=None):
1980
1457
if value is None: # get
1981
1458
return dbus.UInt64(self.approval_delay.total_seconds()
1983
1460
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1985
1462
# ApprovalDuration - property
1986
@dbus_service_property(_interface,
1463
@dbus_service_property(_interface, signature="t",
1988
1464
access="readwrite")
1989
1465
def ApprovalDuration_dbus_property(self, value=None):
1990
1466
if value is None: # get
1991
1467
return dbus.UInt64(self.approval_duration.total_seconds()
1993
1469
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1995
1471
# Name - property
1997
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1998
1472
@dbus_service_property(_interface, signature="s", access="read")
1999
1473
def Name_dbus_property(self):
2000
1474
return dbus.String(self.name)
2002
1476
# Fingerprint - property
2004
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2005
1477
@dbus_service_property(_interface, signature="s", access="read")
2006
1478
def Fingerprint_dbus_property(self):
2007
1479
return dbus.String(self.fingerprint)
2009
1481
# Host - property
2010
@dbus_service_property(_interface,
1482
@dbus_service_property(_interface, signature="s",
2012
1483
access="readwrite")
2013
1484
def Host_dbus_property(self, value=None):
2014
1485
if value is None: # get
2015
1486
return dbus.String(self.host)
2016
self.host = str(value)
1487
self.host = unicode(value)
2018
1489
# Created - property
2020
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2021
1490
@dbus_service_property(_interface, signature="s", access="read")
2022
1491
def Created_dbus_property(self):
2023
1492
return datetime_to_dbus(self.created)
2025
1494
# LastEnabled - property
2026
1495
@dbus_service_property(_interface, signature="s", access="read")
2027
1496
def LastEnabled_dbus_property(self):
2028
1497
return datetime_to_dbus(self.last_enabled)
2030
1499
# Enabled - property
2031
@dbus_service_property(_interface,
1500
@dbus_service_property(_interface, signature="b",
2033
1501
access="readwrite")
2034
1502
def Enabled_dbus_property(self, value=None):
2035
1503
if value is None: # get
2190
1644
class ClientHandler(socketserver.BaseRequestHandler, object):
2191
1645
"""A class to handle client connections.
2193
1647
Instantiated once for each connection to handle it.
2194
1648
Note: This will run in its own forked process."""
2196
1650
def handle(self):
2197
1651
with contextlib.closing(self.server.child_pipe) as child_pipe:
2198
1652
logger.info("TCP connection from: %s",
2199
str(self.client_address))
1653
unicode(self.client_address))
2200
1654
logger.debug("Pipe FD: %d",
2201
1655
self.server.child_pipe.fileno())
2203
session = gnutls.ClientSession(self.request)
2205
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2206
# "+AES-256-CBC", "+SHA1",
2207
# "+COMP-NULL", "+CTYPE-OPENPGP",
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",
2209
1671
# Use a fallback default, since this MUST be set.
2210
1672
priority = self.server.gnutls_priority
2211
1673
if priority is None:
2212
1674
priority = "NORMAL"
2213
gnutls.priority_set_direct(session._c_object,
2214
priority.encode("utf-8"),
1675
(gnutls.library.functions
1676
.gnutls_priority_set_direct(session._c_object,
2217
1679
# Start communication using the Mandos protocol
2218
1680
# Get protocol number
2219
1681
line = self.request.makefile().readline()
2305
1768
delay -= time2 - time
2308
session.send(client.secret)
2309
except gnutls.Error as error:
2310
logger.warning("gnutls send failed",
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))
2314
1783
logger.info("Sending secret to %s", client.name)
2315
1784
# bump the timeout using extended_timeout
2316
1785
client.bump_timeout(client.extended_timeout)
2317
1786
if self.server.use_dbus:
2318
1787
# Emit D-Bus signal
2319
1788
client.GotSecret()
2322
1791
if approval_required:
2323
1792
client.approvals_pending -= 1
2326
except gnutls.Error as error:
1795
except gnutls.errors.GNUTLSError as error:
2327
1796
logger.warning("GnuTLS bye failed",
2328
1797
exc_info=error)
2331
1800
def peer_certificate(session):
2332
1801
"Return the peer's OpenPGP certificate as a bytestring"
2333
1802
# If not an OpenPGP certificate...
2334
if (gnutls.certificate_type_get(session._c_object)
2335
!= gnutls.CRT_OPENPGP):
2336
# ...return invalid data
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
2338
1808
list_size = ctypes.c_uint(1)
2339
cert_list = (gnutls.certificate_get_peers
1809
cert_list = (gnutls.library.functions
1810
.gnutls_certificate_get_peers
2340
1811
(session._c_object, ctypes.byref(list_size)))
2341
1812
if not bool(cert_list) and list_size.value != 0:
2342
raise gnutls.Error("error getting peer certificate")
1813
raise gnutls.errors.GNUTLSError("error getting peer"
2343
1815
if list_size.value == 0:
2345
1817
cert = cert_list[0]
2346
1818
return ctypes.string_at(cert.data, cert.size)
2349
1821
def fingerprint(openpgp):
2350
1822
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2351
1823
# New GnuTLS "datum" with the OpenPGP public key
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)))
1824
datum = (gnutls.library.types
1825
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1828
ctypes.c_uint(len(openpgp))))
2356
1829
# New empty GnuTLS certificate
2357
crt = gnutls.openpgp_crt_t()
2358
gnutls.openpgp_crt_init(ctypes.byref(crt))
1830
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1831
(gnutls.library.functions
1832
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2359
1833
# Import the OpenPGP public key into the certificate
2360
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2361
gnutls.OPENPGP_FMT_RAW)
1834
(gnutls.library.functions
1835
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1836
gnutls.library.constants
1837
.GNUTLS_OPENPGP_FMT_RAW))
2362
1838
# Verify the self signature in the key
2363
1839
crtverify = ctypes.c_uint()
2364
gnutls.openpgp_crt_verify_self(crt, 0,
2365
ctypes.byref(crtverify))
1840
(gnutls.library.functions
1841
.gnutls_openpgp_crt_verify_self(crt, 0,
1842
ctypes.byref(crtverify)))
2366
1843
if crtverify.value != 0:
2367
gnutls.openpgp_crt_deinit(crt)
2368
raise gnutls.CertificateSecurityError(code
1844
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1845
raise (gnutls.errors.CertificateSecurityError
2370
1847
# New buffer for the fingerprint
2371
1848
buf = ctypes.create_string_buffer(20)
2372
1849
buf_len = ctypes.c_size_t()
2373
1850
# Get the fingerprint from the certificate into the buffer
2374
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2375
ctypes.byref(buf_len))
1851
(gnutls.library.functions
1852
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1853
ctypes.byref(buf_len)))
2376
1854
# Deinit the certificate
2377
gnutls.openpgp_crt_deinit(crt)
1855
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2378
1856
# Convert the buffer to a Python bytestring
2379
1857
fpr = ctypes.string_at(buf, buf_len.value)
2380
1858
# Convert the bytestring to hexadecimal notation
2469
1941
# socket_wrapper(), if socketfd was set.
2470
1942
socketserver.TCPServer.__init__(self, server_address,
2471
1943
RequestHandlerClass)
2473
1945
def server_bind(self):
2474
1946
"""This overrides the normal server_bind() function
2475
1947
to bind to an interface if one was specified, and also NOT to
2476
1948
bind to an address or port if they were not specified."""
2477
global SO_BINDTODEVICE
2478
1949
if self.interface is not None:
2479
1950
if SO_BINDTODEVICE is None:
2480
# Fall back to a hard-coded value which seems to be
2482
logger.warning("SO_BINDTODEVICE not found, trying 25")
2483
SO_BINDTODEVICE = 25
2485
self.socket.setsockopt(
2486
socket.SOL_SOCKET, SO_BINDTODEVICE,
2487
(self.interface + "\0").encode("utf-8"))
2488
except socket.error as error:
2489
if error.errno == errno.EPERM:
2490
logger.error("No permission to bind to"
2491
" interface %s", self.interface)
2492
elif error.errno == errno.ENOPROTOOPT:
2493
logger.error("SO_BINDTODEVICE not available;"
2494
" cannot bind to interface %s",
2496
elif error.errno == errno.ENODEV:
2497
logger.error("Interface %s does not exist,"
2498
" cannot bind", self.interface)
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)
2501
1973
# Only bind(2) the socket if we really need to.
2502
1974
if self.server_address[0] or self.server_address[1]:
2503
1975
if not self.server_address[0]:
2504
1976
if self.address_family == socket.AF_INET6:
2505
any_address = "::" # in6addr_any
1977
any_address = "::" # in6addr_any
2507
any_address = "0.0.0.0" # INADDR_ANY
1979
any_address = "0.0.0.0" # INADDR_ANY
2508
1980
self.server_address = (any_address,
2509
1981
self.server_address[1])
2510
1982
elif not self.server_address[1]:
2511
self.server_address = (self.server_address[0], 0)
1983
self.server_address = (self.server_address[0],
2512
1985
# if self.interface:
2513
1986
# self.server_address = (self.server_address[0],
2953
2418
level = getattr(logging, debuglevel.upper())
2954
2419
initlogger(debug, level)
2956
2421
if server_settings["servicename"] != "Mandos":
2957
syslogger.setFormatter(
2958
logging.Formatter('Mandos ({}) [%(process)d]:'
2959
' %(levelname)s: %(message)s'.format(
2960
server_settings["servicename"])))
2422
syslogger.setFormatter(logging.Formatter
2423
('Mandos ({}) [%(process)d]:'
2424
' %(levelname)s: %(message)s'
2425
.format(server_settings
2962
2428
# Parse config file with clients
2963
2429
client_config = configparser.SafeConfigParser(Client
2964
2430
.client_defaults)
2965
2431
client_config.read(os.path.join(server_settings["configdir"],
2966
2432
"clients.conf"))
2968
2434
global mandos_dbus_service
2969
2435
mandos_dbus_service = None
2971
2437
socketfd = None
2972
2438
if server_settings["socket"] != "":
2973
2439
socketfd = server_settings["socket"]
2974
tcp_server = MandosServer(
2975
(server_settings["address"], server_settings["port"]),
2977
interface=(server_settings["interface"] or None),
2979
gnutls_priority=server_settings["priority"],
2440
tcp_server = MandosServer((server_settings["address"],
2441
server_settings["port"]),
2443
interface=(server_settings["interface"]
2447
server_settings["priority"],
2982
2450
if not foreground:
2983
2451
pidfilename = "/run/mandos.pid"
2984
2452
if not os.path.isdir("/run/."):
2985
2453
pidfilename = "/var/run/mandos.pid"
2988
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2456
pidfile = open(pidfilename, "w")
2989
2457
except IOError as e:
2990
2458
logger.error("Could not open file %r", pidfilename,
2993
for name, group in (("_mandos", "_mandos"),
2994
("mandos", "mandos"),
2995
("nobody", "nogroup")):
2461
for name in ("_mandos", "mandos", "nobody"):
2997
2463
uid = pwd.getpwnam(name).pw_uid
2998
gid = pwd.getpwnam(group).pw_gid
2464
gid = pwd.getpwnam(name).pw_gid
3000
2466
except KeyError:
3009
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3011
2474
except OSError as error:
3012
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3013
.format(uid, gid, os.strerror(error.errno)))
3014
2475
if error.errno != errno.EPERM:
3018
2479
# Enable all possible GnuTLS debugging
3020
2481
# "Use a log level over 10 to enable all debugging options."
3021
2482
# - GnuTLS manual
3022
gnutls.global_set_log_level(11)
2483
gnutls.library.functions.gnutls_global_set_log_level(11)
2485
@gnutls.library.types.gnutls_log_func
3025
2486
def debug_gnutls(level, string):
3026
2487
logger.debug("GnuTLS: %s", string[:-1])
3028
gnutls.global_set_log_function(debug_gnutls)
2489
(gnutls.library.functions
2490
.gnutls_global_set_log_function(debug_gnutls))
3030
2492
# Redirect stdin so all checkers get /dev/null
3031
2493
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3032
2494
os.dup2(null, sys.stdin.fileno())
3036
2498
# Need to fork before connecting to D-Bus
3037
2499
if not foreground:
3038
2500
# Close all input and output, do double fork, etc.
3041
# multiprocessing will use threads, so before we use GLib we need
3042
# to inform GLib that threads will be used.
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()
3045
2507
global main_loop
3046
2508
# From the Avahi example code
3047
2509
DBusGMainLoop(set_as_default=True)
3048
main_loop = GLib.MainLoop()
2510
main_loop = gobject.MainLoop()
3049
2511
bus = dbus.SystemBus()
3050
2512
# End of Avahi example code
3053
2515
bus_name = dbus.service.BusName("se.recompile.Mandos",
3056
old_bus_name = dbus.service.BusName(
3057
"se.bsnet.fukt.Mandos", bus,
3059
except dbus.exceptions.DBusException as e:
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:
3060
2521
logger.error("Disabling D-Bus:", exc_info=e)
3061
2522
use_dbus = False
3062
2523
server_settings["use_dbus"] = False
3063
2524
tcp_server.use_dbus = False
3065
2526
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3066
service = AvahiServiceToSyslog(
3067
name=server_settings["servicename"],
3068
servicetype="_mandos._tcp",
2527
service = AvahiServiceToSyslog(name =
2528
server_settings["servicename"],
2529
servicetype = "_mandos._tcp",
2530
protocol = protocol, bus = bus)
3071
2531
if server_settings["interface"]:
3072
service.interface = if_nametoindex(
3073
server_settings["interface"].encode("utf-8"))
2532
service.interface = (if_nametoindex
2533
(server_settings["interface"]
3075
2536
global multiprocessing_manager
3076
2537
multiprocessing_manager = multiprocessing.Manager()
3078
2539
client_class = Client
3080
client_class = functools.partial(ClientDBus, bus=bus)
2541
client_class = functools.partial(ClientDBus, bus = bus)
3082
2543
client_settings = Client.config_parser(client_config)
3083
2544
old_client_settings = {}
3084
2545
clients_data = {}
3086
2547
# This is used to redirect stdout and stderr for checker processes
3088
wnull = open(os.devnull, "w") # A writable /dev/null
2549
wnull = open(os.devnull, "w") # A writable /dev/null
3089
2550
# Only used if server is running in foreground but not in debug
3091
2552
if debug or not foreground:
3094
2555
# Get client data and settings from last running state.
3095
2556
if server_settings["restore"]:
3097
2558
with open(stored_state_path, "rb") as stored_state:
3098
if sys.version_info.major == 2:
3099
clients_data, old_client_settings = pickle.load(
3102
bytes_clients_data, bytes_old_client_settings = (
3103
pickle.load(stored_state, encoding="bytes"))
3104
# Fix bytes to strings
3107
clients_data = {(key.decode("utf-8")
3108
if isinstance(key, bytes)
3111
bytes_clients_data.items()}
3112
del bytes_clients_data
3113
for key in clients_data:
3114
value = {(k.decode("utf-8")
3115
if isinstance(k, bytes) else k): v
3117
clients_data[key].items()}
3118
clients_data[key] = value
3120
value["client_structure"] = [
3122
if isinstance(s, bytes)
3124
value["client_structure"]]
3126
for k in ("name", "host"):
3127
if isinstance(value[k], bytes):
3128
value[k] = value[k].decode("utf-8")
3129
# old_client_settings
3131
old_client_settings = {
3132
(key.decode("utf-8")
3133
if isinstance(key, bytes)
3136
bytes_old_client_settings.items()}
3137
del bytes_old_client_settings
3139
for value in old_client_settings.values():
3140
if isinstance(value["host"], bytes):
3141
value["host"] = (value["host"]
2559
clients_data, old_client_settings = (pickle.load
3143
2561
os.remove(stored_state_path)
3144
2562
except IOError as e:
3145
2563
if e.errno == errno.ENOENT:
3146
logger.warning("Could not load persistent state:"
3147
" {}".format(os.strerror(e.errno)))
2564
logger.warning("Could not load persistent state: {}"
2565
.format(os.strerror(e.errno)))
3149
2567
logger.critical("Could not load persistent state:",
3152
2570
except EOFError as e:
3153
2571
logger.warning("Could not load persistent state: "
2572
"EOFError:", exc_info=e)
3157
2574
with PGPEngine() as pgp:
3158
2575
for client_name, client in clients_data.items():
3159
2576
# Skip removed clients
3160
2577
if client_name not in client_settings:
3163
2580
# Decide which value to use after restoring saved state.
3164
2581
# We have three different values: Old config file,
3165
2582
# new config file, and saved state.
3223
2640
for client_name in (set(client_settings)
3224
2641
- set(old_client_settings)):
3225
2642
clients_data[client_name] = client_settings[client_name]
3227
2644
# Create all client objects
3228
2645
for client_name, client in clients_data.items():
3229
2646
tcp_server.clients[client_name] = client_class(
3232
server_settings=server_settings)
2647
name = client_name, settings = client,
2648
server_settings = server_settings)
3234
2650
if not tcp_server.clients:
3235
2651
logger.warning("No clients defined")
3237
2653
if not foreground:
3238
2654
if pidfile is not None:
3242
print(pid, file=pidfile)
2658
pidfile.write("{}\n".format(pid).encode("utf-8"))
3243
2659
except IOError:
3244
2660
logger.error("Could not write to file %r with PID %d",
3245
2661
pidfilename, pid)
3247
2663
del pidfilename
3249
for termsig in (signal.SIGHUP, signal.SIGTERM):
3250
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3251
lambda: main_loop.quit() and False)
2665
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2666
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3255
@alternate_dbus_interfaces(
3256
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3257
class MandosDBusService(DBusObjectWithObjectManager):
2669
@alternate_dbus_interfaces({"se.recompile.Mandos":
2670
"se.bsnet.fukt.Mandos"})
2671
class MandosDBusService(DBusObjectWithProperties):
3258
2672
"""A D-Bus proxy object"""
3260
2673
def __init__(self):
3261
2674
dbus.service.Object.__init__(self, bus, "/")
3263
2675
_interface = "se.recompile.Mandos"
2677
@dbus_interface_annotations(_interface)
2679
return { "org.freedesktop.DBus.Property"
2680
".EmitsChangedSignal":
3265
2683
@dbus.service.signal(_interface, signature="o")
3266
2684
def ClientAdded(self, objpath):
3270
2688
@dbus.service.signal(_interface, signature="ss")
3271
2689
def ClientNotFound(self, fingerprint, address):
3275
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3277
2693
@dbus.service.signal(_interface, signature="os")
3278
2694
def ClientRemoved(self, objpath, name):
3282
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3284
2698
@dbus.service.method(_interface, out_signature="ao")
3285
2699
def GetAllClients(self):
3287
return dbus.Array(c.dbus_object_path for c in
3288
tcp_server.clients.values())
3290
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2701
return dbus.Array(c.dbus_object_path
2703
tcp_server.clients.itervalues())
3292
2705
@dbus.service.method(_interface,
3293
2706
out_signature="a{oa{sv}}")
3294
2707
def GetAllClientsWithProperties(self):
3296
2709
return dbus.Dictionary(
3297
{c.dbus_object_path: c.GetAll(
3298
"se.recompile.Mandos.Client")
3299
for c in tcp_server.clients.values()},
2710
((c.dbus_object_path, c.GetAll(""))
2711
for c in tcp_server.clients.itervalues()),
3300
2712
signature="oa{sv}")
3302
2714
@dbus.service.method(_interface, in_signature="o")
3303
2715
def RemoveClient(self, object_path):
3305
for c in tcp_server.clients.values():
2717
for c in tcp_server.clients.itervalues():
3306
2718
if c.dbus_object_path == object_path:
3307
2719
del tcp_server.clients[c.name]
3308
2720
c.remove_from_connection()
3309
# Don't signal the disabling
2721
# Don't signal anything except ClientRemoved
3310
2722
c.disable(quiet=True)
3311
# Emit D-Bus signal for removal
3312
self.client_removed_signal(c)
2724
self.ClientRemoved(object_path, c.name)
3314
2726
raise KeyError(object_path)
3318
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3319
out_signature="a{oa{sa{sv}}}")
3320
def GetManagedObjects(self):
3322
return dbus.Dictionary(
3323
{client.dbus_object_path:
3325
{interface: client.GetAll(interface)
3327
client._get_all_interface_names()})
3328
for client in tcp_server.clients.values()})
3330
def client_added_signal(self, client):
3331
"""Send the new standard signal and the old signal"""
3333
# New standard signal
3334
self.InterfacesAdded(
3335
client.dbus_object_path,
3337
{interface: client.GetAll(interface)
3339
client._get_all_interface_names()}))
3341
self.ClientAdded(client.dbus_object_path)
3343
def client_removed_signal(self, client):
3344
"""Send the new standard signal and the old signal"""
3346
# New standard signal
3347
self.InterfacesRemoved(
3348
client.dbus_object_path,
3349
client._get_all_interface_names())
3351
self.ClientRemoved(client.dbus_object_path,
3354
2730
mandos_dbus_service = MandosDBusService()
3356
# Save modules to variables to exempt the modules from being
3357
# unloaded before the function registered with atexit() is run.
3358
mp = multiprocessing
3362
2733
"Cleanup function; run on exit"
3364
2735
service.cleanup()
3366
mp.active_children()
2737
multiprocessing.active_children()
3368
2739
if not (tcp_server.clients or client_settings):
3371
2742
# Store client before exiting. Secrets are encrypted with key
3372
2743
# based on what config file has. If config file is
3373
2744
# removed/edited, old secret will thus be unrecovable.
3375
2746
with PGPEngine() as pgp:
3376
for client in tcp_server.clients.values():
2747
for client in tcp_server.clients.itervalues():
3377
2748
key = client_settings[client.name]["secret"]
3378
2749
client.encrypted_secret = pgp.encrypt(client.secret,
3380
2751
client_dict = {}
3382
2753
# A list of attributes that can not be pickled
3384
exclude = {"bus", "changedstate", "secret",
3385
"checker", "server_settings"}
3386
for name, typ in inspect.getmembers(dbus.service
2755
exclude = { "bus", "changedstate", "secret",
2756
"checker", "server_settings" }
2757
for name, typ in (inspect.getmembers
2758
(dbus.service.Object)):
3388
2759
exclude.add(name)
3390
2761
client_dict["encrypted_secret"] = (client
3391
2762
.encrypted_secret)
3392
2763
for attr in client.client_structure:
3393
2764
if attr not in exclude:
3394
2765
client_dict[attr] = getattr(client, attr)
3396
2767
clients[client.name] = client_dict
3397
2768
del client_settings[client.name]["secret"]
3400
with tempfile.NamedTemporaryFile(
3404
dir=os.path.dirname(stored_state_path),
3405
delete=False) as stored_state:
3406
pickle.dump((clients, client_settings), stored_state,
3408
tempname = stored_state.name
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
3409
2777
os.rename(tempname, stored_state_path)
3410
2778
except (IOError, OSError) as e: