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-2017 Teddy Hogeborn
15
# Copyright © 2008-2017 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(self, *args,
501
syslogger.setFormatter(logging.Formatter(
502
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
507
# Pretend that we have a GnuTLS module
508
class GnuTLS(object):
509
"""This isn't so much a class as it is a module-like namespace.
510
It is instantiated once, and simulates having a GnuTLS module."""
512
library = ctypes.util.find_library("gnutls")
514
library = ctypes.util.find_library("gnutls-deb0")
515
_library = ctypes.cdll.LoadLibrary(library)
517
_need_version = b"3.3.0"
520
# Need to use "self" here, since this method is called before
521
# the assignment to the "gnutls" global variable happens.
522
if self.check_version(self._need_version) is None:
523
raise self.Error("Needs GnuTLS {} or later"
524
.format(self._need_version))
526
# Unless otherwise indicated, the constants and types below are
527
# all from the gnutls/gnutls.h C header file.
537
E_NO_CERTIFICATE_FOUND = -49
538
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
541
class session_int(ctypes.Structure):
543
session_t = ctypes.POINTER(session_int)
545
class certificate_credentials_st(ctypes.Structure):
547
certificate_credentials_t = ctypes.POINTER(
548
certificate_credentials_st)
549
certificate_type_t = ctypes.c_int
551
class datum_t(ctypes.Structure):
552
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
553
('size', ctypes.c_uint)]
555
class openpgp_crt_int(ctypes.Structure):
557
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
558
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
559
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
560
credentials_type_t = ctypes.c_int
561
transport_ptr_t = ctypes.c_void_p
562
close_request_t = ctypes.c_int
565
class Error(Exception):
566
# We need to use the class name "GnuTLS" here, since this
567
# exception might be raised from within GnuTLS.__init__,
568
# which is called before the assignment to the "gnutls"
569
# global variable has happened.
570
def __init__(self, message=None, code=None, args=()):
571
# Default usage is by a message string, but if a return
572
# code is passed, convert it to a string with
575
if message is None and code is not None:
576
message = GnuTLS.strerror(code)
577
return super(GnuTLS.Error, self).__init__(
580
class CertificateSecurityError(Error):
584
class Credentials(object):
586
self._c_object = gnutls.certificate_credentials_t()
587
gnutls.certificate_allocate_credentials(
588
ctypes.byref(self._c_object))
589
self.type = gnutls.CRD_CERTIFICATE
592
gnutls.certificate_free_credentials(self._c_object)
594
class ClientSession(object):
595
def __init__(self, socket, credentials=None):
596
self._c_object = gnutls.session_t()
597
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
598
gnutls.set_default_priority(self._c_object)
599
gnutls.transport_set_ptr(self._c_object, socket.fileno())
600
gnutls.handshake_set_private_extensions(self._c_object,
603
if credentials is None:
604
credentials = gnutls.Credentials()
605
gnutls.credentials_set(self._c_object, credentials.type,
606
ctypes.cast(credentials._c_object,
608
self.credentials = credentials
611
gnutls.deinit(self._c_object)
614
return gnutls.handshake(self._c_object)
616
def send(self, data):
620
data_len -= gnutls.record_send(self._c_object,
625
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
627
# Error handling functions
628
def _error_code(result):
629
"""A function to raise exceptions on errors, suitable
630
for the 'restype' attribute on ctypes functions"""
633
if result == gnutls.E_NO_CERTIFICATE_FOUND:
634
raise gnutls.CertificateSecurityError(code=result)
635
raise gnutls.Error(code=result)
637
def _retry_on_error(result, func, arguments):
638
"""A function to retry on some errors, suitable
639
for the 'errcheck' attribute on ctypes functions"""
641
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
642
return _error_code(result)
643
result = func(*arguments)
646
# Unless otherwise indicated, the function declarations below are
647
# all from the gnutls/gnutls.h C header file.
650
priority_set_direct = _library.gnutls_priority_set_direct
651
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
652
ctypes.POINTER(ctypes.c_char_p)]
653
priority_set_direct.restype = _error_code
655
init = _library.gnutls_init
656
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
657
init.restype = _error_code
659
set_default_priority = _library.gnutls_set_default_priority
660
set_default_priority.argtypes = [session_t]
661
set_default_priority.restype = _error_code
663
record_send = _library.gnutls_record_send
664
record_send.argtypes = [session_t, ctypes.c_void_p,
666
record_send.restype = ctypes.c_ssize_t
667
record_send.errcheck = _retry_on_error
669
certificate_allocate_credentials = (
670
_library.gnutls_certificate_allocate_credentials)
671
certificate_allocate_credentials.argtypes = [
672
ctypes.POINTER(certificate_credentials_t)]
673
certificate_allocate_credentials.restype = _error_code
675
certificate_free_credentials = (
676
_library.gnutls_certificate_free_credentials)
677
certificate_free_credentials.argtypes = [
678
certificate_credentials_t]
679
certificate_free_credentials.restype = None
681
handshake_set_private_extensions = (
682
_library.gnutls_handshake_set_private_extensions)
683
handshake_set_private_extensions.argtypes = [session_t,
685
handshake_set_private_extensions.restype = None
687
credentials_set = _library.gnutls_credentials_set
688
credentials_set.argtypes = [session_t, credentials_type_t,
690
credentials_set.restype = _error_code
692
strerror = _library.gnutls_strerror
693
strerror.argtypes = [ctypes.c_int]
694
strerror.restype = ctypes.c_char_p
696
certificate_type_get = _library.gnutls_certificate_type_get
697
certificate_type_get.argtypes = [session_t]
698
certificate_type_get.restype = _error_code
700
certificate_get_peers = _library.gnutls_certificate_get_peers
701
certificate_get_peers.argtypes = [session_t,
702
ctypes.POINTER(ctypes.c_uint)]
703
certificate_get_peers.restype = ctypes.POINTER(datum_t)
705
global_set_log_level = _library.gnutls_global_set_log_level
706
global_set_log_level.argtypes = [ctypes.c_int]
707
global_set_log_level.restype = None
709
global_set_log_function = _library.gnutls_global_set_log_function
710
global_set_log_function.argtypes = [log_func]
711
global_set_log_function.restype = None
713
deinit = _library.gnutls_deinit
714
deinit.argtypes = [session_t]
715
deinit.restype = None
717
handshake = _library.gnutls_handshake
718
handshake.argtypes = [session_t]
719
handshake.restype = _error_code
720
handshake.errcheck = _retry_on_error
722
transport_set_ptr = _library.gnutls_transport_set_ptr
723
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
724
transport_set_ptr.restype = None
726
bye = _library.gnutls_bye
727
bye.argtypes = [session_t, close_request_t]
728
bye.restype = _error_code
729
bye.errcheck = _retry_on_error
731
check_version = _library.gnutls_check_version
732
check_version.argtypes = [ctypes.c_char_p]
733
check_version.restype = ctypes.c_char_p
735
# All the function declarations below are from gnutls/openpgp.h
737
openpgp_crt_init = _library.gnutls_openpgp_crt_init
738
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
739
openpgp_crt_init.restype = _error_code
741
openpgp_crt_import = _library.gnutls_openpgp_crt_import
742
openpgp_crt_import.argtypes = [openpgp_crt_t,
743
ctypes.POINTER(datum_t),
745
openpgp_crt_import.restype = _error_code
747
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
748
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
749
ctypes.POINTER(ctypes.c_uint)]
750
openpgp_crt_verify_self.restype = _error_code
752
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
753
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
754
openpgp_crt_deinit.restype = None
756
openpgp_crt_get_fingerprint = (
757
_library.gnutls_openpgp_crt_get_fingerprint)
758
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
762
openpgp_crt_get_fingerprint.restype = _error_code
764
# Remove non-public functions
765
del _error_code, _retry_on_error
766
# Create the global "gnutls" object, simulating a module
770
def call_pipe(connection, # : multiprocessing.Connection
771
func, *args, **kwargs):
772
"""This function is meant to be called by multiprocessing.Process
774
This function runs func(*args, **kwargs), and writes the resulting
775
return value on the provided multiprocessing.Connection.
777
connection.send(func(*args, **kwargs))
401
781
class Client(object):
402
782
"""A representation of a client host served by this server.
405
785
approved: bool(); 'None' if not yet approved/disapproved
406
786
approval_delay: datetime.timedelta(); Time to wait for approval
579
961
logger.info("Disabling client %s", self.name)
580
962
if getattr(self, "disable_initiator_tag", None) is not None:
581
gobject.source_remove(self.disable_initiator_tag)
963
GLib.source_remove(self.disable_initiator_tag)
582
964
self.disable_initiator_tag = None
583
965
self.expires = None
584
966
if getattr(self, "checker_initiator_tag", None) is not None:
585
gobject.source_remove(self.checker_initiator_tag)
967
GLib.source_remove(self.checker_initiator_tag)
586
968
self.checker_initiator_tag = None
587
969
self.stop_checker()
588
970
self.enabled = False
590
972
self.send_changedstate()
591
# Do not run this again if called by a gobject.timeout_add
973
# Do not run this again if called by a GLib.timeout_add
594
976
def __del__(self):
597
979
def init_checker(self):
598
980
# Schedule a new checker to be started an 'interval' from now,
599
981
# and every interval from then on.
600
982
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),
983
GLib.source_remove(self.checker_initiator_tag)
984
self.checker_initiator_tag = GLib.timeout_add(
985
int(self.interval.total_seconds() * 1000),
606
987
# Schedule a disable() when 'timeout' has passed
607
988
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),
989
GLib.source_remove(self.disable_initiator_tag)
990
self.disable_initiator_tag = GLib.timeout_add(
991
int(self.timeout.total_seconds() * 1000), self.disable)
613
992
# Also start a new checker *right now*.
614
993
self.start_checker()
616
def checker_callback(self, pid, condition, command):
995
def checker_callback(self, source, condition, connection,
617
997
"""The checker has completed, so take appropriate actions."""
618
998
self.checker_callback_tag = None
619
999
self.checker = None
620
if os.WIFEXITED(condition):
621
self.last_checker_status = os.WEXITSTATUS(condition)
1000
# Read return code from connection (see call_pipe)
1001
returncode = connection.recv()
1005
self.last_checker_status = returncode
1006
self.last_checker_signal = None
622
1007
if self.last_checker_status == 0:
623
1008
logger.info("Checker for %(name)s succeeded",
625
1010
self.checked_ok()
627
logger.info("Checker for %(name)s failed",
1012
logger.info("Checker for %(name)s failed", vars(self))
630
1014
self.last_checker_status = -1
1015
self.last_checker_signal = -returncode
631
1016
logger.warning("Checker for %(name)s crashed?",
634
1020
def checked_ok(self):
635
1021
"""Assert that the client has been seen, alive and well."""
636
1022
self.last_checked_ok = datetime.datetime.utcnow()
637
1023
self.last_checker_status = 0
1024
self.last_checker_signal = None
638
1025
self.bump_timeout()
640
1027
def bump_timeout(self, timeout=None):
641
1028
"""Bump up the timeout for this client."""
642
1029
if timeout is None:
643
1030
timeout = self.timeout
644
1031
if self.disable_initiator_tag is not None:
645
gobject.source_remove(self.disable_initiator_tag)
1032
GLib.source_remove(self.disable_initiator_tag)
646
1033
self.disable_initiator_tag = None
647
1034
if getattr(self, "enabled", False):
648
self.disable_initiator_tag = (gobject.timeout_add
649
(int(timeout.total_seconds()
650
* 1000), self.disable))
1035
self.disable_initiator_tag = GLib.timeout_add(
1036
int(timeout.total_seconds() * 1000), self.disable)
651
1037
self.expires = datetime.datetime.utcnow() + timeout
653
1039
def need_approval(self):
654
1040
self.last_approval_request = datetime.datetime.utcnow()
656
1042
def start_checker(self):
657
1043
"""Start a new checker subprocess if one is not running.
659
1045
If a checker already exists, leave it running and do
661
1047
# The reason for not killing a running checker is that if we
666
1052
# checkers alone, the checker would have to take more time
667
1053
# 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)
1056
if self.checker is not None and not self.checker.is_alive():
1057
logger.warning("Checker was not alive; joining")
684
1060
# Start a new checker if needed
685
1061
if self.checker is None:
686
1062
# Escape attributes for the shell
687
escaped_attrs = { attr:
688
re.escape(unicode(getattr(self,
690
for attr in self.runtime_expansions }
1064
attr: re.escape(str(getattr(self, attr)))
1065
for attr in self.runtime_expansions}
692
1067
command = self.checker_command % escaped_attrs
693
1068
except TypeError as error:
694
1069
logger.error('Could not format string "%s"',
695
self.checker_command, exc_info=error)
696
return True # Try again later
1070
self.checker_command,
1072
return True # Try again later
697
1073
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
1074
logger.info("Starting checker %r for %s", command,
1076
# We don't need to redirect stdout and stderr, since
1077
# in normal mode, that is already done by daemon(),
1078
# and in debug mode we don't want to. (Stdin is
1079
# always replaced by /dev/null.)
1080
# The exception is when not debugging but nevertheless
1081
# running in the foreground; use the previously
1083
popen_args = {"close_fds": True,
1086
if (not self.server_settings["debug"]
1087
and self.server_settings["foreground"]):
1088
popen_args.update({"stdout": wnull,
1090
pipe = multiprocessing.Pipe(duplex=False)
1091
self.checker = multiprocessing.Process(
1093
args=(pipe[1], subprocess.call, command),
1095
self.checker.start()
1096
self.checker_callback_tag = GLib.io_add_watch(
1097
pipe[0].fileno(), GLib.IO_IN,
1098
self.checker_callback, pipe[0], command)
1099
# Re-run this periodically if run by GLib.timeout_add
742
1102
def stop_checker(self):
743
1103
"""Force the checker process, if any, to stop."""
744
1104
if self.checker_callback_tag:
745
gobject.source_remove(self.checker_callback_tag)
1105
GLib.source_remove(self.checker_callback_tag)
746
1106
self.checker_callback_tag = None
747
1107
if getattr(self, "checker", None) is None:
749
1109
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
1110
self.checker.terminate()
758
1111
self.checker = None
761
def dbus_service_property(dbus_interface, signature="v",
762
access="readwrite", byte_arrays=False):
1114
def dbus_service_property(dbus_interface,
763
1118
"""Decorators for marking methods of a DBusObjectWithProperties to
764
1119
become properties on the D-Bus.
766
1121
The decorated method will be called with no arguments by "Get"
767
1122
and with one argument by "Set".
769
1124
The parameters, where they are supported, are the same as
770
1125
dbus.service.method, except there is only "signature", since the
771
1126
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.
1209
class DBusObjectWithAnnotations(dbus.service.Object):
1210
"""A D-Bus object with annotations.
1212
Classes inheriting from this can use the dbus_annotations
1213
decorator to add annotations to methods or signals.
854
1217
def _is_dbus_thing(thing):
855
1218
"""Returns a function testing if an attribute is a D-Bus thing
857
1220
If called like _is_dbus_thing("method") it returns a function
858
1221
suitable for use as predicate to inspect.getmembers().
860
1223
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
863
1226
def _get_all_dbus_things(self, thing):
864
1227
"""Returns a generator of (name, attribute) pairs
866
return ((getattr(athing.__get__(self), "_dbus_name",
1229
return ((getattr(athing.__get__(self), "_dbus_name", name),
868
1230
athing.__get__(self))
869
1231
for cls in self.__class__.__mro__
870
1232
for name, athing in
871
inspect.getmembers(cls,
872
self._is_dbus_thing(thing)))
1233
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1235
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1237
path_keyword='object_path',
1238
connection_keyword='connection')
1239
def Introspect(self, object_path, connection):
1240
"""Overloading of standard D-Bus method.
1242
Inserts annotation tags on methods and signals.
1244
xmlstring = dbus.service.Object.Introspect(self, object_path,
1247
document = xml.dom.minidom.parseString(xmlstring)
1249
for if_tag in document.getElementsByTagName("interface"):
1250
# Add annotation tags
1251
for typ in ("method", "signal"):
1252
for tag in if_tag.getElementsByTagName(typ):
1254
for name, prop in (self.
1255
_get_all_dbus_things(typ)):
1256
if (name == tag.getAttribute("name")
1257
and prop._dbus_interface
1258
== if_tag.getAttribute("name")):
1259
annots.update(getattr(
1260
prop, "_dbus_annotations", {}))
1261
for name, value in annots.items():
1262
ann_tag = document.createElement(
1264
ann_tag.setAttribute("name", name)
1265
ann_tag.setAttribute("value", value)
1266
tag.appendChild(ann_tag)
1267
# Add interface annotation tags
1268
for annotation, value in dict(
1269
itertools.chain.from_iterable(
1270
annotations().items()
1271
for name, annotations
1272
in self._get_all_dbus_things("interface")
1273
if name == if_tag.getAttribute("name")
1275
ann_tag = document.createElement("annotation")
1276
ann_tag.setAttribute("name", annotation)
1277
ann_tag.setAttribute("value", value)
1278
if_tag.appendChild(ann_tag)
1279
# Fix argument name for the Introspect method itself
1280
if (if_tag.getAttribute("name")
1281
== dbus.INTROSPECTABLE_IFACE):
1282
for cn in if_tag.getElementsByTagName("method"):
1283
if cn.getAttribute("name") == "Introspect":
1284
for arg in cn.getElementsByTagName("arg"):
1285
if (arg.getAttribute("direction")
1287
arg.setAttribute("name",
1289
xmlstring = document.toxml("utf-8")
1291
except (AttributeError, xml.dom.DOMException,
1292
xml.parsers.expat.ExpatError) as error:
1293
logger.error("Failed to override Introspection method",
1298
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1299
"""A D-Bus object with properties.
1301
Classes inheriting from this can use the dbus_service_property
1302
decorator to expose methods as D-Bus properties. It exposes the
1303
standard Get(), Set(), and GetAll() methods on the D-Bus.
874
1306
def _get_dbus_property(self, interface_name, property_name):
875
1307
"""Returns a bound method if one exists which is a D-Bus
876
1308
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"))):
1310
for cls in self.__class__.__mro__:
1311
for name, value in inspect.getmembers(
1312
cls, self._is_dbus_thing("property")):
882
1313
if (value._dbus_name == property_name
883
1314
and value._dbus_interface == interface_name):
884
1315
return value.__get__(self)
886
1317
# No such property
887
raise DBusPropertyNotFound(self.dbus_object_path + ":"
888
+ interface_name + "."
891
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1318
raise DBusPropertyNotFound("{}:{}.{}".format(
1319
self.dbus_object_path, interface_name, property_name))
1322
def _get_all_interface_names(cls):
1323
"""Get a sequence of all interfaces supported by an object"""
1324
return (name for name in set(getattr(getattr(x, attr),
1325
"_dbus_interface", None)
1326
for x in (inspect.getmro(cls))
1328
if name is not None)
1330
@dbus.service.method(dbus.PROPERTIES_IFACE,
892
1332
out_signature="v")
893
1333
def Get(self, interface_name, property_name):
894
1334
"""Standard D-Bus property Get() method, see D-Bus standard.
1026
1463
return xmlstring
1467
dbus.OBJECT_MANAGER_IFACE
1468
except AttributeError:
1469
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1472
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1473
"""A D-Bus object with an ObjectManager.
1475
Classes inheriting from this exposes the standard
1476
GetManagedObjects call and the InterfacesAdded and
1477
InterfacesRemoved signals on the standard
1478
"org.freedesktop.DBus.ObjectManager" interface.
1480
Note: No signals are sent automatically; they must be sent
1483
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1484
out_signature="a{oa{sa{sv}}}")
1485
def GetManagedObjects(self):
1486
"""This function must be overridden"""
1487
raise NotImplementedError()
1489
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1490
signature="oa{sa{sv}}")
1491
def InterfacesAdded(self, object_path, interfaces_and_properties):
1494
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1495
def InterfacesRemoved(self, object_path, interfaces):
1498
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1500
path_keyword='object_path',
1501
connection_keyword='connection')
1502
def Introspect(self, object_path, connection):
1503
"""Overloading of standard D-Bus method.
1505
Override return argument name of GetManagedObjects to be
1506
"objpath_interfaces_and_properties"
1508
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1512
document = xml.dom.minidom.parseString(xmlstring)
1514
for if_tag in document.getElementsByTagName("interface"):
1515
# Fix argument name for the GetManagedObjects method
1516
if (if_tag.getAttribute("name")
1517
== dbus.OBJECT_MANAGER_IFACE):
1518
for cn in if_tag.getElementsByTagName("method"):
1519
if (cn.getAttribute("name")
1520
== "GetManagedObjects"):
1521
for arg in cn.getElementsByTagName("arg"):
1522
if (arg.getAttribute("direction")
1526
"objpath_interfaces"
1528
xmlstring = document.toxml("utf-8")
1530
except (AttributeError, xml.dom.DOMException,
1531
xml.parsers.expat.ExpatError) as error:
1532
logger.error("Failed to override Introspection method",
1029
1537
def datetime_to_dbus(dt, variant_level=0):
1030
1538
"""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)
1540
return dbus.String("", variant_level=variant_level)
1541
return dbus.String(dt.isoformat(), variant_level=variant_level)
1037
1544
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1067
1575
# Ignore non-D-Bus attributes, and D-Bus attributes
1068
1576
# with the wrong interface name
1069
1577
if (not hasattr(attribute, "_dbus_interface")
1070
or not attribute._dbus_interface
1071
.startswith(orig_interface_name)):
1578
or not attribute._dbus_interface.startswith(
1579
orig_interface_name)):
1073
1581
# Create an alternate D-Bus interface name based on
1074
1582
# the current name
1075
alt_interface = (attribute._dbus_interface
1076
.replace(orig_interface_name,
1077
alt_interface_name))
1583
alt_interface = attribute._dbus_interface.replace(
1584
orig_interface_name, alt_interface_name)
1078
1585
interface_names.add(alt_interface)
1079
1586
# Is this a D-Bus signal?
1080
1587
if getattr(attribute, "_dbus_is_signal", False):
1081
1588
# Extract the original non-method undecorated
1082
1589
# function by black magic
1083
nonmethod_func = (dict(
1590
if sys.version_info.major == 2:
1591
nonmethod_func = (dict(
1084
1592
zip(attribute.func_code.co_freevars,
1085
attribute.__closure__))["func"]
1593
attribute.__closure__))
1594
["func"].cell_contents)
1596
nonmethod_func = (dict(
1597
zip(attribute.__code__.co_freevars,
1598
attribute.__closure__))
1599
["func"].cell_contents)
1087
1600
# Create a new, but exactly alike, function
1088
1601
# object, and decorate it to be a new D-Bus signal
1089
1602
# 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)))
1603
new_function = copy_function(nonmethod_func)
1604
new_function = (dbus.service.signal(
1606
attribute._dbus_signature)(new_function))
1099
1607
# Copy annotations, if any
1101
new_function._dbus_annotations = (
1102
dict(attribute._dbus_annotations))
1609
new_function._dbus_annotations = dict(
1610
attribute._dbus_annotations)
1103
1611
except AttributeError:
1105
1614
# Define a creator of a function to call both the
1106
1615
# original and alternate functions, so both the
1107
1616
# original and alternate signals gets sent when
1197
1699
if interface_names:
1198
1700
# Replace the class with a new subclass of it with
1199
1701
# methods, signals, etc. as created above.
1200
cls = type(b"{}Alternate".format(cls.__name__),
1702
if sys.version_info.major == 2:
1703
cls = type(b"{}Alternate".format(cls.__name__),
1706
cls = type("{}Alternate".format(cls.__name__),
1206
1713
@alternate_dbus_interfaces({"se.recompile.Mandos":
1207
"se.bsnet.fukt.Mandos"})
1714
"se.bsnet.fukt.Mandos"})
1208
1715
class ClientDBus(Client, DBusObjectWithProperties):
1209
1716
"""A Client class using D-Bus
1212
1719
dbus_object_path: dbus.ObjectPath
1213
1720
bus: dbus.SystemBus()
1216
1723
runtime_expansions = (Client.runtime_expansions
1217
+ ("dbus_object_path",))
1724
+ ("dbus_object_path", ))
1726
_interface = "se.recompile.Mandos.Client"
1219
1728
# dbus.service.Object doesn't use super(), so we can't either.
1221
def __init__(self, bus = None, *args, **kwargs):
1730
def __init__(self, bus=None, *args, **kwargs):
1223
1732
Client.__init__(self, *args, **kwargs)
1224
1733
# Only now, when this client is initialized, can it show up on
1226
client_object_name = unicode(self.name).translate(
1735
client_object_name = str(self.name).translate(
1227
1736
{ord("."): ord("_"),
1228
1737
ord("-"): ord("_")})
1229
self.dbus_object_path = (dbus.ObjectPath
1230
("/clients/" + client_object_name))
1738
self.dbus_object_path = dbus.ObjectPath(
1739
"/clients/" + client_object_name)
1231
1740
DBusObjectWithProperties.__init__(self, self.bus,
1232
1741
self.dbus_object_path)
1234
def notifychangeproperty(transform_func,
1235
dbus_name, type_func=lambda x: x,
1743
def notifychangeproperty(transform_func, dbus_name,
1744
type_func=lambda x: x,
1746
invalidate_only=False,
1747
_interface=_interface):
1237
1748
""" Modify a variable so that it's a property which announces
1238
1749
its changes to DBus.
1240
1751
transform_fun: Function that takes a value and a variant_level
1241
1752
and transforms it to a D-Bus type.
1242
1753
dbus_name: D-Bus name of the variable
1387
1905
server to mandos-client
1391
1909
# Rejected - signal
1392
1910
@dbus.service.signal(_interface, signature="s")
1393
1911
def Rejected(self, reason):
1397
1915
# NeedApproval - signal
1398
1916
@dbus.service.signal(_interface, signature="tb")
1399
1917
def NeedApproval(self, timeout, default):
1401
1919
return self.need_approval()
1405
1923
# Approve - method
1406
1924
@dbus.service.method(_interface, in_signature="b")
1407
1925
def Approve(self, value):
1408
1926
self.approve(value)
1410
1928
# CheckedOK - method
1411
1929
@dbus.service.method(_interface)
1412
1930
def CheckedOK(self):
1413
1931
self.checked_ok()
1415
1933
# Enable - method
1934
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1416
1935
@dbus.service.method(_interface)
1417
1936
def Enable(self):
1421
1940
# StartChecker - method
1941
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1422
1942
@dbus.service.method(_interface)
1423
1943
def StartChecker(self):
1425
1945
self.start_checker()
1427
1947
# Disable - method
1948
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1428
1949
@dbus.service.method(_interface)
1429
1950
def Disable(self):
1433
1954
# StopChecker - method
1955
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1434
1956
@dbus.service.method(_interface)
1435
1957
def StopChecker(self):
1436
1958
self.stop_checker()
1440
1962
# ApprovalPending - property
1441
1963
@dbus_service_property(_interface, signature="b", access="read")
1442
1964
def ApprovalPending_dbus_property(self):
1443
1965
return dbus.Boolean(bool(self.approvals_pending))
1445
1967
# ApprovedByDefault - property
1446
@dbus_service_property(_interface, signature="b",
1968
@dbus_service_property(_interface,
1447
1970
access="readwrite")
1448
1971
def ApprovedByDefault_dbus_property(self, value=None):
1449
1972
if value is None: # get
1450
1973
return dbus.Boolean(self.approved_by_default)
1451
1974
self.approved_by_default = bool(value)
1453
1976
# ApprovalDelay - property
1454
@dbus_service_property(_interface, signature="t",
1977
@dbus_service_property(_interface,
1455
1979
access="readwrite")
1456
1980
def ApprovalDelay_dbus_property(self, value=None):
1457
1981
if value is None: # get
1458
1982
return dbus.UInt64(self.approval_delay.total_seconds()
1460
1984
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1462
1986
# ApprovalDuration - property
1463
@dbus_service_property(_interface, signature="t",
1987
@dbus_service_property(_interface,
1464
1989
access="readwrite")
1465
1990
def ApprovalDuration_dbus_property(self, value=None):
1466
1991
if value is None: # get
1467
1992
return dbus.UInt64(self.approval_duration.total_seconds()
1469
1994
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1471
1996
# Name - property
1998
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1472
1999
@dbus_service_property(_interface, signature="s", access="read")
1473
2000
def Name_dbus_property(self):
1474
2001
return dbus.String(self.name)
1476
2003
# Fingerprint - property
2005
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1477
2006
@dbus_service_property(_interface, signature="s", access="read")
1478
2007
def Fingerprint_dbus_property(self):
1479
2008
return dbus.String(self.fingerprint)
1481
2010
# Host - property
1482
@dbus_service_property(_interface, signature="s",
2011
@dbus_service_property(_interface,
1483
2013
access="readwrite")
1484
2014
def Host_dbus_property(self, value=None):
1485
2015
if value is None: # get
1486
2016
return dbus.String(self.host)
1487
self.host = unicode(value)
2017
self.host = str(value)
1489
2019
# Created - property
2021
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1490
2022
@dbus_service_property(_interface, signature="s", access="read")
1491
2023
def Created_dbus_property(self):
1492
2024
return datetime_to_dbus(self.created)
1494
2026
# LastEnabled - property
1495
2027
@dbus_service_property(_interface, signature="s", access="read")
1496
2028
def LastEnabled_dbus_property(self):
1497
2029
return datetime_to_dbus(self.last_enabled)
1499
2031
# Enabled - property
1500
@dbus_service_property(_interface, signature="b",
2032
@dbus_service_property(_interface,
1501
2034
access="readwrite")
1502
2035
def Enabled_dbus_property(self, value=None):
1503
2036
if value is None: # get
1644
2191
class ClientHandler(socketserver.BaseRequestHandler, object):
1645
2192
"""A class to handle client connections.
1647
2194
Instantiated once for each connection to handle it.
1648
2195
Note: This will run in its own forked process."""
1650
2197
def handle(self):
1651
2198
with contextlib.closing(self.server.child_pipe) as child_pipe:
1652
2199
logger.info("TCP connection from: %s",
1653
unicode(self.client_address))
2200
str(self.client_address))
1654
2201
logger.debug("Pipe FD: %d",
1655
2202
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",
2204
session = gnutls.ClientSession(self.request)
2206
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2207
# "+AES-256-CBC", "+SHA1",
2208
# "+COMP-NULL", "+CTYPE-OPENPGP",
1671
2210
# Use a fallback default, since this MUST be set.
1672
2211
priority = self.server.gnutls_priority
1673
2212
if priority is None:
1674
2213
priority = "NORMAL"
1675
(gnutls.library.functions
1676
.gnutls_priority_set_direct(session._c_object,
2214
gnutls.priority_set_direct(session._c_object,
2215
priority.encode("utf-8"),
1679
2218
# Start communication using the Mandos protocol
1680
2219
# Get protocol number
1681
2220
line = self.request.makefile().readline()
1768
2306
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))
2309
session.send(client.secret)
2310
except gnutls.Error as error:
2311
logger.warning("gnutls send failed",
1783
2315
logger.info("Sending secret to %s", client.name)
1784
2316
# bump the timeout using extended_timeout
1785
2317
client.bump_timeout(client.extended_timeout)
1786
2318
if self.server.use_dbus:
1787
2319
# Emit D-Bus signal
1788
2320
client.GotSecret()
1791
2323
if approval_required:
1792
2324
client.approvals_pending -= 1
1795
except gnutls.errors.GNUTLSError as error:
2327
except gnutls.Error as error:
1796
2328
logger.warning("GnuTLS bye failed",
1797
2329
exc_info=error)
1800
2332
def peer_certificate(session):
1801
2333
"Return the peer's OpenPGP certificate as a bytestring"
1802
2334
# 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
2335
if (gnutls.certificate_type_get(session._c_object)
2336
!= gnutls.CRT_OPENPGP):
2337
# ...return invalid data
1808
2339
list_size = ctypes.c_uint(1)
1809
cert_list = (gnutls.library.functions
1810
.gnutls_certificate_get_peers
2340
cert_list = (gnutls.certificate_get_peers
1811
2341
(session._c_object, ctypes.byref(list_size)))
1812
2342
if not bool(cert_list) and list_size.value != 0:
1813
raise gnutls.errors.GNUTLSError("error getting peer"
2343
raise gnutls.Error("error getting peer certificate")
1815
2344
if list_size.value == 0:
1817
2346
cert = cert_list[0]
1818
2347
return ctypes.string_at(cert.data, cert.size)
1821
2350
def fingerprint(openpgp):
1822
2351
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1823
2352
# 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))))
2353
datum = gnutls.datum_t(
2354
ctypes.cast(ctypes.c_char_p(openpgp),
2355
ctypes.POINTER(ctypes.c_ubyte)),
2356
ctypes.c_uint(len(openpgp)))
1829
2357
# 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)))
2358
crt = gnutls.openpgp_crt_t()
2359
gnutls.openpgp_crt_init(ctypes.byref(crt))
1833
2360
# 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))
2361
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2362
gnutls.OPENPGP_FMT_RAW)
1838
2363
# Verify the self signature in the key
1839
2364
crtverify = ctypes.c_uint()
1840
(gnutls.library.functions
1841
.gnutls_openpgp_crt_verify_self(crt, 0,
1842
ctypes.byref(crtverify)))
2365
gnutls.openpgp_crt_verify_self(crt, 0,
2366
ctypes.byref(crtverify))
1843
2367
if crtverify.value != 0:
1844
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1845
raise (gnutls.errors.CertificateSecurityError
2368
gnutls.openpgp_crt_deinit(crt)
2369
raise gnutls.CertificateSecurityError("Verify failed")
1847
2370
# New buffer for the fingerprint
1848
2371
buf = ctypes.create_string_buffer(20)
1849
2372
buf_len = ctypes.c_size_t()
1850
2373
# 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)))
2374
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2375
ctypes.byref(buf_len))
1854
2376
# Deinit the certificate
1855
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2377
gnutls.openpgp_crt_deinit(crt)
1856
2378
# Convert the buffer to a Python bytestring
1857
2379
fpr = ctypes.string_at(buf, buf_len.value)
1858
2380
# Convert the bytestring to hexadecimal notation
1941
2469
# socket_wrapper(), if socketfd was set.
1942
2470
socketserver.TCPServer.__init__(self, server_address,
1943
2471
RequestHandlerClass)
1945
2473
def server_bind(self):
1946
2474
"""This overrides the normal server_bind() function
1947
2475
to bind to an interface if one was specified, and also NOT to
1948
2476
bind to an address or port if they were not specified."""
2477
global SO_BINDTODEVICE
1949
2478
if self.interface is not None:
1950
2479
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)
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)
1973
2501
# Only bind(2) the socket if we really need to.
1974
2502
if self.server_address[0] or self.server_address[1]:
1975
2503
if not self.server_address[0]:
1976
2504
if self.address_family == socket.AF_INET6:
1977
any_address = "::" # in6addr_any
2505
any_address = "::" # in6addr_any
1979
any_address = "0.0.0.0" # INADDR_ANY
2507
any_address = "0.0.0.0" # INADDR_ANY
1980
2508
self.server_address = (any_address,
1981
2509
self.server_address[1])
1982
2510
elif not self.server_address[1]:
1983
self.server_address = (self.server_address[0],
2511
self.server_address = (self.server_address[0], 0)
1985
2512
# if self.interface:
1986
2513
# self.server_address = (self.server_address[0],
2418
2953
level = getattr(logging, debuglevel.upper())
2419
2954
initlogger(debug, level)
2421
2956
if server_settings["servicename"] != "Mandos":
2422
syslogger.setFormatter(logging.Formatter
2423
('Mandos ({}) [%(process)d]:'
2424
' %(levelname)s: %(message)s'
2425
.format(server_settings
2957
syslogger.setFormatter(
2958
logging.Formatter('Mandos ({}) [%(process)d]:'
2959
' %(levelname)s: %(message)s'.format(
2960
server_settings["servicename"])))
2428
2962
# Parse config file with clients
2429
2963
client_config = configparser.SafeConfigParser(Client
2430
2964
.client_defaults)
2431
2965
client_config.read(os.path.join(server_settings["configdir"],
2432
2966
"clients.conf"))
2434
2968
global mandos_dbus_service
2435
2969
mandos_dbus_service = None
2437
2971
socketfd = None
2438
2972
if server_settings["socket"] != "":
2439
2973
socketfd = server_settings["socket"]
2440
tcp_server = MandosServer((server_settings["address"],
2441
server_settings["port"]),
2443
interface=(server_settings["interface"]
2447
server_settings["priority"],
2974
tcp_server = MandosServer(
2975
(server_settings["address"], server_settings["port"]),
2977
interface=(server_settings["interface"] or None),
2979
gnutls_priority=server_settings["priority"],
2450
2982
if not foreground:
2451
2983
pidfilename = "/run/mandos.pid"
2452
2984
if not os.path.isdir("/run/."):
2453
2985
pidfilename = "/var/run/mandos.pid"
2456
pidfile = open(pidfilename, "w")
2988
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2457
2989
except IOError as e:
2458
2990
logger.error("Could not open file %r", pidfilename,
2461
for name in ("_mandos", "mandos", "nobody"):
2993
for name, group in (("_mandos", "_mandos"),
2994
("mandos", "mandos"),
2995
("nobody", "nogroup")):
2463
2997
uid = pwd.getpwnam(name).pw_uid
2464
gid = pwd.getpwnam(name).pw_gid
2998
gid = pwd.getpwnam(group).pw_gid
2466
3000
except KeyError:
3009
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2474
3011
except OSError as error:
3012
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3013
.format(uid, gid, os.strerror(error.errno)))
2475
3014
if error.errno != errno.EPERM:
2479
3018
# Enable all possible GnuTLS debugging
2481
3020
# "Use a log level over 10 to enable all debugging options."
2482
3021
# - GnuTLS manual
2483
gnutls.library.functions.gnutls_global_set_log_level(11)
2485
@gnutls.library.types.gnutls_log_func
3022
gnutls.global_set_log_level(11)
2486
3025
def debug_gnutls(level, string):
2487
3026
logger.debug("GnuTLS: %s", string[:-1])
2489
(gnutls.library.functions
2490
.gnutls_global_set_log_function(debug_gnutls))
3028
gnutls.global_set_log_function(debug_gnutls)
2492
3030
# Redirect stdin so all checkers get /dev/null
2493
3031
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2494
3032
os.dup2(null, sys.stdin.fileno())
2498
3036
# Need to fork before connecting to D-Bus
2499
3037
if not foreground:
2500
3038
# 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()
3041
# multiprocessing will use threads, so before we use GLib we need
3042
# to inform GLib that threads will be used.
2507
3045
global main_loop
2508
3046
# From the Avahi example code
2509
3047
DBusGMainLoop(set_as_default=True)
2510
main_loop = gobject.MainLoop()
3048
main_loop = GLib.MainLoop()
2511
3049
bus = dbus.SystemBus()
2512
3050
# End of Avahi example code
2515
3053
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:
3056
old_bus_name = dbus.service.BusName(
3057
"se.bsnet.fukt.Mandos", bus,
3059
except dbus.exceptions.DBusException as e:
2521
3060
logger.error("Disabling D-Bus:", exc_info=e)
2522
3061
use_dbus = False
2523
3062
server_settings["use_dbus"] = False
2524
3063
tcp_server.use_dbus = False
2526
3065
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)
3066
service = AvahiServiceToSyslog(
3067
name=server_settings["servicename"],
3068
servicetype="_mandos._tcp",
2531
3071
if server_settings["interface"]:
2532
service.interface = (if_nametoindex
2533
(server_settings["interface"]
3072
service.interface = if_nametoindex(
3073
server_settings["interface"].encode("utf-8"))
2536
3075
global multiprocessing_manager
2537
3076
multiprocessing_manager = multiprocessing.Manager()
2539
3078
client_class = Client
2541
client_class = functools.partial(ClientDBus, bus = bus)
3080
client_class = functools.partial(ClientDBus, bus=bus)
2543
3082
client_settings = Client.config_parser(client_config)
2544
3083
old_client_settings = {}
2545
3084
clients_data = {}
2547
3086
# This is used to redirect stdout and stderr for checker processes
2549
wnull = open(os.devnull, "w") # A writable /dev/null
3088
wnull = open(os.devnull, "w") # A writable /dev/null
2550
3089
# Only used if server is running in foreground but not in debug
2552
3091
if debug or not foreground:
2555
3094
# Get client data and settings from last running state.
2556
3095
if server_settings["restore"]:
2558
3097
with open(stored_state_path, "rb") as stored_state:
2559
clients_data, old_client_settings = (pickle.load
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"]
2561
3143
os.remove(stored_state_path)
2562
3144
except IOError as e:
2563
3145
if e.errno == errno.ENOENT:
2564
logger.warning("Could not load persistent state: {}"
2565
.format(os.strerror(e.errno)))
3146
logger.warning("Could not load persistent state:"
3147
" {}".format(os.strerror(e.errno)))
2567
3149
logger.critical("Could not load persistent state:",
2570
3152
except EOFError as e:
2571
3153
logger.warning("Could not load persistent state: "
2572
"EOFError:", exc_info=e)
2574
3157
with PGPEngine() as pgp:
2575
3158
for client_name, client in clients_data.items():
2576
3159
# Skip removed clients
2577
3160
if client_name not in client_settings:
2580
3163
# Decide which value to use after restoring saved state.
2581
3164
# We have three different values: Old config file,
2582
3165
# new config file, and saved state.
2640
3223
for client_name in (set(client_settings)
2641
3224
- set(old_client_settings)):
2642
3225
clients_data[client_name] = client_settings[client_name]
2644
3227
# Create all client objects
2645
3228
for client_name, client in clients_data.items():
2646
3229
tcp_server.clients[client_name] = client_class(
2647
name = client_name, settings = client,
2648
server_settings = server_settings)
3232
server_settings=server_settings)
2650
3234
if not tcp_server.clients:
2651
3235
logger.warning("No clients defined")
2653
3237
if not foreground:
2654
3238
if pidfile is not None:
2658
pidfile.write("{}\n".format(pid).encode("utf-8"))
3242
print(pid, file=pidfile)
2659
3243
except IOError:
2660
3244
logger.error("Could not write to file %r with PID %d",
2661
3245
pidfilename, pid)
2663
3247
del pidfilename
2665
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2666
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3249
for termsig in (signal.SIGHUP, signal.SIGTERM):
3250
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3251
lambda: main_loop.quit() and False)
2669
@alternate_dbus_interfaces({"se.recompile.Mandos":
2670
"se.bsnet.fukt.Mandos"})
2671
class MandosDBusService(DBusObjectWithProperties):
3255
@alternate_dbus_interfaces(
3256
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3257
class MandosDBusService(DBusObjectWithObjectManager):
2672
3258
"""A D-Bus proxy object"""
2673
3260
def __init__(self):
2674
3261
dbus.service.Object.__init__(self, bus, "/")
2675
3263
_interface = "se.recompile.Mandos"
2677
@dbus_interface_annotations(_interface)
2679
return { "org.freedesktop.DBus.Property"
2680
".EmitsChangedSignal":
2683
3265
@dbus.service.signal(_interface, signature="o")
2684
3266
def ClientAdded(self, objpath):
2688
3270
@dbus.service.signal(_interface, signature="ss")
2689
3271
def ClientNotFound(self, fingerprint, address):
3275
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2693
3277
@dbus.service.signal(_interface, signature="os")
2694
3278
def ClientRemoved(self, objpath, name):
3282
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2698
3284
@dbus.service.method(_interface, out_signature="ao")
2699
3285
def GetAllClients(self):
2701
return dbus.Array(c.dbus_object_path
2703
tcp_server.clients.itervalues())
3287
return dbus.Array(c.dbus_object_path for c in
3288
tcp_server.clients.values())
3290
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2705
3292
@dbus.service.method(_interface,
2706
3293
out_signature="a{oa{sv}}")
2707
3294
def GetAllClientsWithProperties(self):
2709
3296
return dbus.Dictionary(
2710
((c.dbus_object_path, c.GetAll(""))
2711
for c in tcp_server.clients.itervalues()),
3297
{c.dbus_object_path: c.GetAll(
3298
"se.recompile.Mandos.Client")
3299
for c in tcp_server.clients.values()},
2712
3300
signature="oa{sv}")
2714
3302
@dbus.service.method(_interface, in_signature="o")
2715
3303
def RemoveClient(self, object_path):
2717
for c in tcp_server.clients.itervalues():
3305
for c in tcp_server.clients.values():
2718
3306
if c.dbus_object_path == object_path:
2719
3307
del tcp_server.clients[c.name]
2720
3308
c.remove_from_connection()
2721
# Don't signal anything except ClientRemoved
3309
# Don't signal the disabling
2722
3310
c.disable(quiet=True)
2724
self.ClientRemoved(object_path, c.name)
3311
# Emit D-Bus signal for removal
3312
self.client_removed_signal(c)
2726
3314
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,
2730
3354
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
2733
3362
"Cleanup function; run on exit"
2735
3364
service.cleanup()
2737
multiprocessing.active_children()
3366
mp.active_children()
2739
3368
if not (tcp_server.clients or client_settings):
2742
3371
# Store client before exiting. Secrets are encrypted with key
2743
3372
# based on what config file has. If config file is
2744
3373
# removed/edited, old secret will thus be unrecovable.
2746
3375
with PGPEngine() as pgp:
2747
for client in tcp_server.clients.itervalues():
3376
for client in tcp_server.clients.values():
2748
3377
key = client_settings[client.name]["secret"]
2749
3378
client.encrypted_secret = pgp.encrypt(client.secret,
2751
3380
client_dict = {}
2753
3382
# 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)):
3384
exclude = {"bus", "changedstate", "secret",
3385
"checker", "server_settings"}
3386
for name, typ in inspect.getmembers(dbus.service
2759
3388
exclude.add(name)
2761
3390
client_dict["encrypted_secret"] = (client
2762
3391
.encrypted_secret)
2763
3392
for attr in client.client_structure:
2764
3393
if attr not in exclude:
2765
3394
client_dict[attr] = getattr(client, attr)
2767
3396
clients[client.name] = client_dict
2768
3397
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
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
2777
3409
os.rename(tempname, stored_state_path)
2778
3410
except (IOError, OSError) as e: