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
183
236
.replace(b"\n", b"\\n")
184
237
.replace(b"\0", b"\\x00"))
187
240
def encrypt(self, data, password):
188
241
passphrase = self.password_encode(password)
189
with tempfile.NamedTemporaryFile(dir=self.tempdir
242
with tempfile.NamedTemporaryFile(
243
dir=self.tempdir) as passfile:
191
244
passfile.write(passphrase)
193
proc = subprocess.Popen(['gpg', '--symmetric',
246
proc = subprocess.Popen([self.gpg, '--symmetric',
194
247
'--passphrase-file',
196
249
+ self.gnupgargs,
197
stdin = subprocess.PIPE,
198
stdout = subprocess.PIPE,
199
stderr = subprocess.PIPE)
200
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)
201
254
if proc.returncode != 0:
202
255
raise PGPError(err)
203
256
return ciphertext
205
258
def decrypt(self, data, password):
206
259
passphrase = self.password_encode(password)
207
with tempfile.NamedTemporaryFile(dir = self.tempdir
260
with tempfile.NamedTemporaryFile(
261
dir=self.tempdir) as passfile:
209
262
passfile.write(passphrase)
211
proc = subprocess.Popen(['gpg', '--decrypt',
264
proc = subprocess.Popen([self.gpg, '--decrypt',
212
265
'--passphrase-file',
214
267
+ self.gnupgargs,
215
stdin = subprocess.PIPE,
216
stdout = subprocess.PIPE,
217
stderr = subprocess.PIPE)
218
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)
220
272
if proc.returncode != 0:
221
273
raise PGPError(err)
222
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
225
304
class AvahiError(Exception):
226
305
def __init__(self, value, *args, **kwargs):
227
306
self.value = value
228
307
return super(AvahiError, self).__init__(value, *args,
231
311
class AvahiServiceError(AvahiError):
234
315
class AvahiGroupError(AvahiError):
238
319
class AvahiService(object):
239
320
"""An Avahi (Zeroconf) service.
242
323
interface: integer; avahi.IF_UNSPEC or an interface index.
243
324
Used to optionally bind to the specified interface.
386
489
follow_name_owner_changes=True),
387
490
avahi.DBUS_INTERFACE_SERVER)
388
491
self.server.connect_to_signal("StateChanged",
389
self.server_state_changed)
492
self.server_state_changed)
390
493
self.server_state_changed(self.server.GetState())
393
496
class AvahiServiceToSyslog(AvahiService):
497
def rename(self, *args, **kwargs):
395
498
"""Add the new name to the syslog messages"""
396
ret = AvahiService.rename(self)
397
syslogger.setFormatter(logging.Formatter
398
('Mandos ({}) [%(process)d]:'
399
' %(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))
404
781
class Client(object):
405
782
"""A representation of a client host served by this server.
408
785
approved: bool(); 'None' if not yet approved/disapproved
409
786
approval_delay: datetime.timedelta(); Time to wait for approval
582
961
logger.info("Disabling client %s", self.name)
583
962
if getattr(self, "disable_initiator_tag", None) is not None:
584
gobject.source_remove(self.disable_initiator_tag)
963
GLib.source_remove(self.disable_initiator_tag)
585
964
self.disable_initiator_tag = None
586
965
self.expires = None
587
966
if getattr(self, "checker_initiator_tag", None) is not None:
588
gobject.source_remove(self.checker_initiator_tag)
967
GLib.source_remove(self.checker_initiator_tag)
589
968
self.checker_initiator_tag = None
590
969
self.stop_checker()
591
970
self.enabled = False
593
972
self.send_changedstate()
594
# 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
597
976
def __del__(self):
600
979
def init_checker(self):
601
980
# Schedule a new checker to be started an 'interval' from now,
602
981
# and every interval from then on.
603
982
if self.checker_initiator_tag is not None:
604
gobject.source_remove(self.checker_initiator_tag)
605
self.checker_initiator_tag = (gobject.timeout_add
607
.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),
609
987
# Schedule a disable() when 'timeout' has passed
610
988
if self.disable_initiator_tag is not None:
611
gobject.source_remove(self.disable_initiator_tag)
612
self.disable_initiator_tag = (gobject.timeout_add
614
.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)
616
992
# Also start a new checker *right now*.
617
993
self.start_checker()
619
def checker_callback(self, pid, condition, command):
995
def checker_callback(self, source, condition, connection,
620
997
"""The checker has completed, so take appropriate actions."""
621
998
self.checker_callback_tag = None
622
999
self.checker = None
623
if os.WIFEXITED(condition):
624
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
625
1007
if self.last_checker_status == 0:
626
1008
logger.info("Checker for %(name)s succeeded",
628
1010
self.checked_ok()
630
logger.info("Checker for %(name)s failed",
1012
logger.info("Checker for %(name)s failed", vars(self))
633
1014
self.last_checker_status = -1
1015
self.last_checker_signal = -returncode
634
1016
logger.warning("Checker for %(name)s crashed?",
637
1020
def checked_ok(self):
638
1021
"""Assert that the client has been seen, alive and well."""
639
1022
self.last_checked_ok = datetime.datetime.utcnow()
640
1023
self.last_checker_status = 0
1024
self.last_checker_signal = None
641
1025
self.bump_timeout()
643
1027
def bump_timeout(self, timeout=None):
644
1028
"""Bump up the timeout for this client."""
645
1029
if timeout is None:
646
1030
timeout = self.timeout
647
1031
if self.disable_initiator_tag is not None:
648
gobject.source_remove(self.disable_initiator_tag)
1032
GLib.source_remove(self.disable_initiator_tag)
649
1033
self.disable_initiator_tag = None
650
1034
if getattr(self, "enabled", False):
651
self.disable_initiator_tag = (gobject.timeout_add
652
(int(timeout.total_seconds()
653
* 1000), self.disable))
1035
self.disable_initiator_tag = GLib.timeout_add(
1036
int(timeout.total_seconds() * 1000), self.disable)
654
1037
self.expires = datetime.datetime.utcnow() + timeout
656
1039
def need_approval(self):
657
1040
self.last_approval_request = datetime.datetime.utcnow()
659
1042
def start_checker(self):
660
1043
"""Start a new checker subprocess if one is not running.
662
1045
If a checker already exists, leave it running and do
664
1047
# The reason for not killing a running checker is that if we
669
1052
# checkers alone, the checker would have to take more time
670
1053
# than 'timeout' for the client to be disabled, which is as it
673
# If a checker exists, make sure it is not a zombie
675
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
676
except AttributeError:
678
except OSError as error:
679
if error.errno != errno.ECHILD:
683
logger.warning("Checker was a zombie")
684
gobject.source_remove(self.checker_callback_tag)
685
self.checker_callback(pid, status,
686
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")
687
1060
# Start a new checker if needed
688
1061
if self.checker is None:
689
1062
# Escape attributes for the shell
690
escaped_attrs = { attr:
691
re.escape(str(getattr(self, attr)))
692
for attr in self.runtime_expansions }
1064
attr: re.escape(str(getattr(self, attr)))
1065
for attr in self.runtime_expansions}
694
1067
command = self.checker_command % escaped_attrs
695
1068
except TypeError as error:
696
1069
logger.error('Could not format string "%s"',
697
self.checker_command, exc_info=error)
698
return True # Try again later
1070
self.checker_command,
1072
return True # Try again later
699
1073
self.current_checker_command = command
701
logger.info("Starting checker %r for %s",
703
# We don't need to redirect stdout and stderr, since
704
# in normal mode, that is already done by daemon(),
705
# and in debug mode we don't want to. (Stdin is
706
# always replaced by /dev/null.)
707
# The exception is when not debugging but nevertheless
708
# running in the foreground; use the previously
711
if (not self.server_settings["debug"]
712
and self.server_settings["foreground"]):
713
popen_args.update({"stdout": wnull,
715
self.checker = subprocess.Popen(command,
719
except OSError as error:
720
logger.error("Failed to start subprocess",
723
self.checker_callback_tag = (gobject.child_watch_add
725
self.checker_callback,
727
# The checker may have completed before the gobject
728
# watch was added. Check for this.
730
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
731
except OSError as error:
732
if error.errno == errno.ECHILD:
733
# This should never happen
734
logger.error("Child process vanished",
739
gobject.source_remove(self.checker_callback_tag)
740
self.checker_callback(pid, status, command)
741
# 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
744
1102
def stop_checker(self):
745
1103
"""Force the checker process, if any, to stop."""
746
1104
if self.checker_callback_tag:
747
gobject.source_remove(self.checker_callback_tag)
1105
GLib.source_remove(self.checker_callback_tag)
748
1106
self.checker_callback_tag = None
749
1107
if getattr(self, "checker", None) is None:
751
1109
logger.debug("Stopping checker for %(name)s", vars(self))
753
self.checker.terminate()
755
#if self.checker.poll() is None:
756
# self.checker.kill()
757
except OSError as error:
758
if error.errno != errno.ESRCH: # No such process
1110
self.checker.terminate()
760
1111
self.checker = None
763
def dbus_service_property(dbus_interface, signature="v",
764
access="readwrite", byte_arrays=False):
1114
def dbus_service_property(dbus_interface,
765
1118
"""Decorators for marking methods of a DBusObjectWithProperties to
766
1119
become properties on the D-Bus.
768
1121
The decorated method will be called with no arguments by "Get"
769
1122
and with one argument by "Set".
771
1124
The parameters, where they are supported, are the same as
772
1125
dbus.service.method, except there is only "signature", since the
773
1126
type from Get() and the type sent to Set() is the same.
847
class DBusObjectWithProperties(dbus.service.Object):
848
"""A D-Bus object with properties.
850
Classes inheriting from this can use the dbus_service_property
851
decorator to expose methods as D-Bus properties. It exposes the
852
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.
856
1217
def _is_dbus_thing(thing):
857
1218
"""Returns a function testing if an attribute is a D-Bus thing
859
1220
If called like _is_dbus_thing("method") it returns a function
860
1221
suitable for use as predicate to inspect.getmembers().
862
1223
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
865
1226
def _get_all_dbus_things(self, thing):
866
1227
"""Returns a generator of (name, attribute) pairs
868
return ((getattr(athing.__get__(self), "_dbus_name",
1229
return ((getattr(athing.__get__(self), "_dbus_name", name),
870
1230
athing.__get__(self))
871
1231
for cls in self.__class__.__mro__
872
1232
for name, athing in
873
inspect.getmembers(cls,
874
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.
876
1306
def _get_dbus_property(self, interface_name, property_name):
877
1307
"""Returns a bound method if one exists which is a D-Bus
878
1308
property with the specified name and interface.
880
for cls in self.__class__.__mro__:
881
for name, value in (inspect.getmembers
883
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")):
884
1313
if (value._dbus_name == property_name
885
1314
and value._dbus_interface == interface_name):
886
1315
return value.__get__(self)
888
1317
# No such property
889
raise DBusPropertyNotFound(self.dbus_object_path + ":"
890
+ interface_name + "."
893
@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,
894
1332
out_signature="v")
895
1333
def Get(self, interface_name, property_name):
896
1334
"""Standard D-Bus property Get() method, see D-Bus standard.
1036
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",
1039
1537
def datetime_to_dbus(dt, variant_level=0):
1040
1538
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1042
return dbus.String("", variant_level = variant_level)
1043
return dbus.String(dt.isoformat(),
1044
variant_level=variant_level)
1540
return dbus.String("", variant_level=variant_level)
1541
return dbus.String(dt.isoformat(), variant_level=variant_level)
1047
1544
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1077
1575
# Ignore non-D-Bus attributes, and D-Bus attributes
1078
1576
# with the wrong interface name
1079
1577
if (not hasattr(attribute, "_dbus_interface")
1080
or not attribute._dbus_interface
1081
.startswith(orig_interface_name)):
1578
or not attribute._dbus_interface.startswith(
1579
orig_interface_name)):
1083
1581
# Create an alternate D-Bus interface name based on
1084
1582
# the current name
1085
alt_interface = (attribute._dbus_interface
1086
.replace(orig_interface_name,
1087
alt_interface_name))
1583
alt_interface = attribute._dbus_interface.replace(
1584
orig_interface_name, alt_interface_name)
1088
1585
interface_names.add(alt_interface)
1089
1586
# Is this a D-Bus signal?
1090
1587
if getattr(attribute, "_dbus_is_signal", False):
1091
1588
# Extract the original non-method undecorated
1092
1589
# function by black magic
1093
nonmethod_func = (dict(
1590
if sys.version_info.major == 2:
1591
nonmethod_func = (dict(
1094
1592
zip(attribute.func_code.co_freevars,
1095
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)
1097
1600
# Create a new, but exactly alike, function
1098
1601
# object, and decorate it to be a new D-Bus signal
1099
1602
# with the alternate D-Bus interface name
1100
new_function = (dbus.service.signal
1102
attribute._dbus_signature)
1103
(types.FunctionType(
1104
nonmethod_func.func_code,
1105
nonmethod_func.func_globals,
1106
nonmethod_func.func_name,
1107
nonmethod_func.func_defaults,
1108
nonmethod_func.func_closure)))
1603
new_function = copy_function(nonmethod_func)
1604
new_function = (dbus.service.signal(
1606
attribute._dbus_signature)(new_function))
1109
1607
# Copy annotations, if any
1111
new_function._dbus_annotations = (
1112
dict(attribute._dbus_annotations))
1609
new_function._dbus_annotations = dict(
1610
attribute._dbus_annotations)
1113
1611
except AttributeError:
1115
1614
# Define a creator of a function to call both the
1116
1615
# original and alternate functions, so both the
1117
1616
# original and alternate signals gets sent when
1258
1756
variant_level: D-Bus variant level. Default: 1
1260
1758
attrname = "_{}".format(dbus_name)
1261
1760
def setter(self, value):
1262
1761
if hasattr(self, "dbus_object_path"):
1263
1762
if (not hasattr(self, attrname) or
1264
1763
type_func(getattr(self, attrname, None))
1265
1764
!= type_func(value)):
1266
1765
if invalidate_only:
1267
self.PropertiesChanged(_interface,
1766
self.PropertiesChanged(
1767
_interface, dbus.Dictionary(),
1768
dbus.Array((dbus_name, )))
1272
dbus_value = transform_func(type_func(value),
1770
dbus_value = transform_func(
1772
variant_level=variant_level)
1275
1773
self.PropertyChanged(dbus.String(dbus_name),
1277
self.PropertiesChanged(_interface,
1279
dbus.String(dbus_name):
1280
dbus_value }), dbus.Array())
1775
self.PropertiesChanged(
1777
dbus.Dictionary({dbus.String(dbus_name):
1281
1780
setattr(self, attrname, value)
1283
1782
return property(lambda self: getattr(self, attrname), setter)
1285
1784
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1286
1785
approvals_pending = notifychangeproperty(dbus.Boolean,
1287
1786
"ApprovalPending",
1289
1788
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1290
1789
last_enabled = notifychangeproperty(datetime_to_dbus,
1292
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1293
type_func = lambda checker:
1294
checker is not None)
1791
checker = notifychangeproperty(
1792
dbus.Boolean, "CheckerRunning",
1793
type_func=lambda checker: checker is not None)
1295
1794
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1296
1795
"LastCheckedOK")
1297
1796
last_checker_status = notifychangeproperty(dbus.Int16,
1407
1905
server to mandos-client
1411
1909
# Rejected - signal
1412
1910
@dbus.service.signal(_interface, signature="s")
1413
1911
def Rejected(self, reason):
1417
1915
# NeedApproval - signal
1418
1916
@dbus.service.signal(_interface, signature="tb")
1419
1917
def NeedApproval(self, timeout, default):
1421
1919
return self.need_approval()
1425
1923
# Approve - method
1426
1924
@dbus.service.method(_interface, in_signature="b")
1427
1925
def Approve(self, value):
1428
1926
self.approve(value)
1430
1928
# CheckedOK - method
1431
1929
@dbus.service.method(_interface)
1432
1930
def CheckedOK(self):
1433
1931
self.checked_ok()
1435
1933
# Enable - method
1934
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1436
1935
@dbus.service.method(_interface)
1437
1936
def Enable(self):
1441
1940
# StartChecker - method
1941
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1442
1942
@dbus.service.method(_interface)
1443
1943
def StartChecker(self):
1445
1945
self.start_checker()
1447
1947
# Disable - method
1948
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1448
1949
@dbus.service.method(_interface)
1449
1950
def Disable(self):
1453
1954
# StopChecker - method
1955
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1454
1956
@dbus.service.method(_interface)
1455
1957
def StopChecker(self):
1456
1958
self.stop_checker()
1460
1962
# ApprovalPending - property
1461
1963
@dbus_service_property(_interface, signature="b", access="read")
1462
1964
def ApprovalPending_dbus_property(self):
1463
1965
return dbus.Boolean(bool(self.approvals_pending))
1465
1967
# ApprovedByDefault - property
1466
@dbus_service_property(_interface, signature="b",
1968
@dbus_service_property(_interface,
1467
1970
access="readwrite")
1468
1971
def ApprovedByDefault_dbus_property(self, value=None):
1469
1972
if value is None: # get
1470
1973
return dbus.Boolean(self.approved_by_default)
1471
1974
self.approved_by_default = bool(value)
1473
1976
# ApprovalDelay - property
1474
@dbus_service_property(_interface, signature="t",
1977
@dbus_service_property(_interface,
1475
1979
access="readwrite")
1476
1980
def ApprovalDelay_dbus_property(self, value=None):
1477
1981
if value is None: # get
1478
1982
return dbus.UInt64(self.approval_delay.total_seconds()
1480
1984
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1482
1986
# ApprovalDuration - property
1483
@dbus_service_property(_interface, signature="t",
1987
@dbus_service_property(_interface,
1484
1989
access="readwrite")
1485
1990
def ApprovalDuration_dbus_property(self, value=None):
1486
1991
if value is None: # get
1487
1992
return dbus.UInt64(self.approval_duration.total_seconds()
1489
1994
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1491
1996
# Name - property
1998
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1492
1999
@dbus_service_property(_interface, signature="s", access="read")
1493
2000
def Name_dbus_property(self):
1494
2001
return dbus.String(self.name)
1496
2003
# Fingerprint - property
2005
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1497
2006
@dbus_service_property(_interface, signature="s", access="read")
1498
2007
def Fingerprint_dbus_property(self):
1499
2008
return dbus.String(self.fingerprint)
1501
2010
# Host - property
1502
@dbus_service_property(_interface, signature="s",
2011
@dbus_service_property(_interface,
1503
2013
access="readwrite")
1504
2014
def Host_dbus_property(self, value=None):
1505
2015
if value is None: # get
1506
2016
return dbus.String(self.host)
1507
2017
self.host = str(value)
1509
2019
# Created - property
2021
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1510
2022
@dbus_service_property(_interface, signature="s", access="read")
1511
2023
def Created_dbus_property(self):
1512
2024
return datetime_to_dbus(self.created)
1514
2026
# LastEnabled - property
1515
2027
@dbus_service_property(_interface, signature="s", access="read")
1516
2028
def LastEnabled_dbus_property(self):
1517
2029
return datetime_to_dbus(self.last_enabled)
1519
2031
# Enabled - property
1520
@dbus_service_property(_interface, signature="b",
2032
@dbus_service_property(_interface,
1521
2034
access="readwrite")
1522
2035
def Enabled_dbus_property(self, value=None):
1523
2036
if value is None: # get
1788
2306
delay -= time2 - time
1791
while sent_size < len(client.secret):
1793
sent = session.send(client.secret[sent_size:])
1794
except gnutls.errors.GNUTLSError as error:
1795
logger.warning("gnutls send failed",
1798
logger.debug("Sent: %d, remaining: %d",
1799
sent, len(client.secret)
1800
- (sent_size + sent))
2309
session.send(client.secret)
2310
except gnutls.Error as error:
2311
logger.warning("gnutls send failed",
1803
2315
logger.info("Sending secret to %s", client.name)
1804
2316
# bump the timeout using extended_timeout
1805
2317
client.bump_timeout(client.extended_timeout)
1806
2318
if self.server.use_dbus:
1807
2319
# Emit D-Bus signal
1808
2320
client.GotSecret()
1811
2323
if approval_required:
1812
2324
client.approvals_pending -= 1
1815
except gnutls.errors.GNUTLSError as error:
2327
except gnutls.Error as error:
1816
2328
logger.warning("GnuTLS bye failed",
1817
2329
exc_info=error)
1820
2332
def peer_certificate(session):
1821
2333
"Return the peer's OpenPGP certificate as a bytestring"
1822
2334
# If not an OpenPGP certificate...
1823
if (gnutls.library.functions
1824
.gnutls_certificate_type_get(session._c_object)
1825
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1826
# ...do the normal thing
1827
return session.peer_certificate
2335
if (gnutls.certificate_type_get(session._c_object)
2336
!= gnutls.CRT_OPENPGP):
2337
# ...return invalid data
1828
2339
list_size = ctypes.c_uint(1)
1829
cert_list = (gnutls.library.functions
1830
.gnutls_certificate_get_peers
2340
cert_list = (gnutls.certificate_get_peers
1831
2341
(session._c_object, ctypes.byref(list_size)))
1832
2342
if not bool(cert_list) and list_size.value != 0:
1833
raise gnutls.errors.GNUTLSError("error getting peer"
2343
raise gnutls.Error("error getting peer certificate")
1835
2344
if list_size.value == 0:
1837
2346
cert = cert_list[0]
1838
2347
return ctypes.string_at(cert.data, cert.size)
1841
2350
def fingerprint(openpgp):
1842
2351
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1843
2352
# New GnuTLS "datum" with the OpenPGP public key
1844
datum = (gnutls.library.types
1845
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1848
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)))
1849
2357
# New empty GnuTLS certificate
1850
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1851
(gnutls.library.functions
1852
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2358
crt = gnutls.openpgp_crt_t()
2359
gnutls.openpgp_crt_init(ctypes.byref(crt))
1853
2360
# Import the OpenPGP public key into the certificate
1854
(gnutls.library.functions
1855
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1856
gnutls.library.constants
1857
.GNUTLS_OPENPGP_FMT_RAW))
2361
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2362
gnutls.OPENPGP_FMT_RAW)
1858
2363
# Verify the self signature in the key
1859
2364
crtverify = ctypes.c_uint()
1860
(gnutls.library.functions
1861
.gnutls_openpgp_crt_verify_self(crt, 0,
1862
ctypes.byref(crtverify)))
2365
gnutls.openpgp_crt_verify_self(crt, 0,
2366
ctypes.byref(crtverify))
1863
2367
if crtverify.value != 0:
1864
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1865
raise (gnutls.errors.CertificateSecurityError
2368
gnutls.openpgp_crt_deinit(crt)
2369
raise gnutls.CertificateSecurityError("Verify failed")
1867
2370
# New buffer for the fingerprint
1868
2371
buf = ctypes.create_string_buffer(20)
1869
2372
buf_len = ctypes.c_size_t()
1870
2373
# Get the fingerprint from the certificate into the buffer
1871
(gnutls.library.functions
1872
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1873
ctypes.byref(buf_len)))
2374
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2375
ctypes.byref(buf_len))
1874
2376
# Deinit the certificate
1875
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2377
gnutls.openpgp_crt_deinit(crt)
1876
2378
# Convert the buffer to a Python bytestring
1877
2379
fpr = ctypes.string_at(buf, buf_len.value)
1878
2380
# Convert the bytestring to hexadecimal notation
1961
2469
# socket_wrapper(), if socketfd was set.
1962
2470
socketserver.TCPServer.__init__(self, server_address,
1963
2471
RequestHandlerClass)
1965
2473
def server_bind(self):
1966
2474
"""This overrides the normal server_bind() function
1967
2475
to bind to an interface if one was specified, and also NOT to
1968
2476
bind to an address or port if they were not specified."""
2477
global SO_BINDTODEVICE
1969
2478
if self.interface is not None:
1970
2479
if SO_BINDTODEVICE is None:
1971
logger.error("SO_BINDTODEVICE does not exist;"
1972
" cannot bind to interface %s",
1976
self.socket.setsockopt(socket.SOL_SOCKET,
1978
(self.interface + "\0")
1980
except socket.error as error:
1981
if error.errno == errno.EPERM:
1982
logger.error("No permission to bind to"
1983
" interface %s", self.interface)
1984
elif error.errno == errno.ENOPROTOOPT:
1985
logger.error("SO_BINDTODEVICE not available;"
1986
" cannot bind to interface %s",
1988
elif error.errno == errno.ENODEV:
1989
logger.error("Interface %s does not exist,"
1990
" 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)
1993
2501
# Only bind(2) the socket if we really need to.
1994
2502
if self.server_address[0] or self.server_address[1]:
1995
2503
if not self.server_address[0]:
1996
2504
if self.address_family == socket.AF_INET6:
1997
any_address = "::" # in6addr_any
2505
any_address = "::" # in6addr_any
1999
any_address = "0.0.0.0" # INADDR_ANY
2507
any_address = "0.0.0.0" # INADDR_ANY
2000
2508
self.server_address = (any_address,
2001
2509
self.server_address[1])
2002
2510
elif not self.server_address[1]:
2003
self.server_address = (self.server_address[0],
2511
self.server_address = (self.server_address[0], 0)
2005
2512
# if self.interface:
2006
2513
# self.server_address = (self.server_address[0],
2438
2953
level = getattr(logging, debuglevel.upper())
2439
2954
initlogger(debug, level)
2441
2956
if server_settings["servicename"] != "Mandos":
2442
syslogger.setFormatter(logging.Formatter
2443
('Mandos ({}) [%(process)d]:'
2444
' %(levelname)s: %(message)s'
2445
.format(server_settings
2957
syslogger.setFormatter(
2958
logging.Formatter('Mandos ({}) [%(process)d]:'
2959
' %(levelname)s: %(message)s'.format(
2960
server_settings["servicename"])))
2448
2962
# Parse config file with clients
2449
2963
client_config = configparser.SafeConfigParser(Client
2450
2964
.client_defaults)
2451
2965
client_config.read(os.path.join(server_settings["configdir"],
2452
2966
"clients.conf"))
2454
2968
global mandos_dbus_service
2455
2969
mandos_dbus_service = None
2457
2971
socketfd = None
2458
2972
if server_settings["socket"] != "":
2459
2973
socketfd = server_settings["socket"]
2460
tcp_server = MandosServer((server_settings["address"],
2461
server_settings["port"]),
2463
interface=(server_settings["interface"]
2467
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"],
2470
2982
if not foreground:
2471
2983
pidfilename = "/run/mandos.pid"
2472
2984
if not os.path.isdir("/run/."):
2473
2985
pidfilename = "/var/run/mandos.pid"
2476
pidfile = open(pidfilename, "w")
2988
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2477
2989
except IOError as e:
2478
2990
logger.error("Could not open file %r", pidfilename,
2481
for name in ("_mandos", "mandos", "nobody"):
2993
for name, group in (("_mandos", "_mandos"),
2994
("mandos", "mandos"),
2995
("nobody", "nogroup")):
2483
2997
uid = pwd.getpwnam(name).pw_uid
2484
gid = pwd.getpwnam(name).pw_gid
2998
gid = pwd.getpwnam(group).pw_gid
2486
3000
except KeyError:
3009
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2494
3011
except OSError as error:
3012
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3013
.format(uid, gid, os.strerror(error.errno)))
2495
3014
if error.errno != errno.EPERM:
2499
3018
# Enable all possible GnuTLS debugging
2501
3020
# "Use a log level over 10 to enable all debugging options."
2502
3021
# - GnuTLS manual
2503
gnutls.library.functions.gnutls_global_set_log_level(11)
2505
@gnutls.library.types.gnutls_log_func
3022
gnutls.global_set_log_level(11)
2506
3025
def debug_gnutls(level, string):
2507
3026
logger.debug("GnuTLS: %s", string[:-1])
2509
(gnutls.library.functions
2510
.gnutls_global_set_log_function(debug_gnutls))
3028
gnutls.global_set_log_function(debug_gnutls)
2512
3030
# Redirect stdin so all checkers get /dev/null
2513
3031
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2514
3032
os.dup2(null, sys.stdin.fileno())
2518
3036
# Need to fork before connecting to D-Bus
2519
3037
if not foreground:
2520
3038
# Close all input and output, do double fork, etc.
2523
# multiprocessing will use threads, so before we use gobject we
2524
# need to inform gobject that threads will be used.
2525
gobject.threads_init()
3041
# multiprocessing will use threads, so before we use GLib we need
3042
# to inform GLib that threads will be used.
2527
3045
global main_loop
2528
3046
# From the Avahi example code
2529
3047
DBusGMainLoop(set_as_default=True)
2530
main_loop = gobject.MainLoop()
3048
main_loop = GLib.MainLoop()
2531
3049
bus = dbus.SystemBus()
2532
3050
# End of Avahi example code
2535
3053
bus_name = dbus.service.BusName("se.recompile.Mandos",
2536
bus, do_not_queue=True)
2537
old_bus_name = (dbus.service.BusName
2538
("se.bsnet.fukt.Mandos", bus,
2540
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:
2541
3060
logger.error("Disabling D-Bus:", exc_info=e)
2542
3061
use_dbus = False
2543
3062
server_settings["use_dbus"] = False
2544
3063
tcp_server.use_dbus = False
2546
3065
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2547
service = AvahiServiceToSyslog(name =
2548
server_settings["servicename"],
2549
servicetype = "_mandos._tcp",
2550
protocol = protocol, bus = bus)
3066
service = AvahiServiceToSyslog(
3067
name=server_settings["servicename"],
3068
servicetype="_mandos._tcp",
2551
3071
if server_settings["interface"]:
2552
service.interface = (if_nametoindex
2553
(server_settings["interface"]
3072
service.interface = if_nametoindex(
3073
server_settings["interface"].encode("utf-8"))
2556
3075
global multiprocessing_manager
2557
3076
multiprocessing_manager = multiprocessing.Manager()
2559
3078
client_class = Client
2561
client_class = functools.partial(ClientDBus, bus = bus)
3080
client_class = functools.partial(ClientDBus, bus=bus)
2563
3082
client_settings = Client.config_parser(client_config)
2564
3083
old_client_settings = {}
2565
3084
clients_data = {}
2567
3086
# This is used to redirect stdout and stderr for checker processes
2569
wnull = open(os.devnull, "w") # A writable /dev/null
3088
wnull = open(os.devnull, "w") # A writable /dev/null
2570
3089
# Only used if server is running in foreground but not in debug
2572
3091
if debug or not foreground:
2575
3094
# Get client data and settings from last running state.
2576
3095
if server_settings["restore"]:
2578
3097
with open(stored_state_path, "rb") as stored_state:
2579
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"]
2581
3143
os.remove(stored_state_path)
2582
3144
except IOError as e:
2583
3145
if e.errno == errno.ENOENT:
2584
logger.warning("Could not load persistent state: {}"
2585
.format(os.strerror(e.errno)))
3146
logger.warning("Could not load persistent state:"
3147
" {}".format(os.strerror(e.errno)))
2587
3149
logger.critical("Could not load persistent state:",
2590
3152
except EOFError as e:
2591
3153
logger.warning("Could not load persistent state: "
2592
"EOFError:", exc_info=e)
2594
3157
with PGPEngine() as pgp:
2595
3158
for client_name, client in clients_data.items():
2596
3159
# Skip removed clients
2597
3160
if client_name not in client_settings:
2600
3163
# Decide which value to use after restoring saved state.
2601
3164
# We have three different values: Old config file,
2602
3165
# new config file, and saved state.
2660
3223
for client_name in (set(client_settings)
2661
3224
- set(old_client_settings)):
2662
3225
clients_data[client_name] = client_settings[client_name]
2664
3227
# Create all client objects
2665
3228
for client_name, client in clients_data.items():
2666
3229
tcp_server.clients[client_name] = client_class(
2667
name = client_name, settings = client,
2668
server_settings = server_settings)
3232
server_settings=server_settings)
2670
3234
if not tcp_server.clients:
2671
3235
logger.warning("No clients defined")
2673
3237
if not foreground:
2674
3238
if pidfile is not None:
2678
pidfile.write("{}\n".format(pid).encode("utf-8"))
3242
print(pid, file=pidfile)
2679
3243
except IOError:
2680
3244
logger.error("Could not write to file %r with PID %d",
2681
3245
pidfilename, pid)
2683
3247
del pidfilename
2685
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2686
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)
2689
@alternate_dbus_interfaces({"se.recompile.Mandos":
2690
"se.bsnet.fukt.Mandos"})
2691
class MandosDBusService(DBusObjectWithProperties):
3255
@alternate_dbus_interfaces(
3256
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3257
class MandosDBusService(DBusObjectWithObjectManager):
2692
3258
"""A D-Bus proxy object"""
2693
3260
def __init__(self):
2694
3261
dbus.service.Object.__init__(self, bus, "/")
2695
3263
_interface = "se.recompile.Mandos"
2697
@dbus_interface_annotations(_interface)
2699
return { "org.freedesktop.DBus.Property"
2700
".EmitsChangedSignal":
2703
3265
@dbus.service.signal(_interface, signature="o")
2704
3266
def ClientAdded(self, objpath):
2708
3270
@dbus.service.signal(_interface, signature="ss")
2709
3271
def ClientNotFound(self, fingerprint, address):
3275
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2713
3277
@dbus.service.signal(_interface, signature="os")
2714
3278
def ClientRemoved(self, objpath, name):
3282
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2718
3284
@dbus.service.method(_interface, out_signature="ao")
2719
3285
def GetAllClients(self):
2721
return dbus.Array(c.dbus_object_path
2723
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":
2725
3292
@dbus.service.method(_interface,
2726
3293
out_signature="a{oa{sv}}")
2727
3294
def GetAllClientsWithProperties(self):
2729
3296
return dbus.Dictionary(
2730
{ c.dbus_object_path: c.GetAll("")
2731
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()},
2732
3300
signature="oa{sv}")
2734
3302
@dbus.service.method(_interface, in_signature="o")
2735
3303
def RemoveClient(self, object_path):
2737
for c in tcp_server.clients.itervalues():
3305
for c in tcp_server.clients.values():
2738
3306
if c.dbus_object_path == object_path:
2739
3307
del tcp_server.clients[c.name]
2740
3308
c.remove_from_connection()
2741
# Don't signal anything except ClientRemoved
3309
# Don't signal the disabling
2742
3310
c.disable(quiet=True)
2744
self.ClientRemoved(object_path, c.name)
3311
# Emit D-Bus signal for removal
3312
self.client_removed_signal(c)
2746
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,
2750
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
2753
3362
"Cleanup function; run on exit"
2755
3364
service.cleanup()
2757
multiprocessing.active_children()
3366
mp.active_children()
2759
3368
if not (tcp_server.clients or client_settings):
2762
3371
# Store client before exiting. Secrets are encrypted with key
2763
3372
# based on what config file has. If config file is
2764
3373
# removed/edited, old secret will thus be unrecovable.
2766
3375
with PGPEngine() as pgp:
2767
for client in tcp_server.clients.itervalues():
3376
for client in tcp_server.clients.values():
2768
3377
key = client_settings[client.name]["secret"]
2769
3378
client.encrypted_secret = pgp.encrypt(client.secret,
2771
3380
client_dict = {}
2773
3382
# A list of attributes that can not be pickled
2775
exclude = { "bus", "changedstate", "secret",
2776
"checker", "server_settings" }
2777
for name, typ in (inspect.getmembers
2778
(dbus.service.Object)):
3384
exclude = {"bus", "changedstate", "secret",
3385
"checker", "server_settings"}
3386
for name, typ in inspect.getmembers(dbus.service
2779
3388
exclude.add(name)
2781
3390
client_dict["encrypted_secret"] = (client
2782
3391
.encrypted_secret)
2783
3392
for attr in client.client_structure:
2784
3393
if attr not in exclude:
2785
3394
client_dict[attr] = getattr(client, attr)
2787
3396
clients[client.name] = client_dict
2788
3397
del client_settings[client.name]["secret"]
2791
with (tempfile.NamedTemporaryFile
2792
(mode='wb', suffix=".pickle", prefix='clients-',
2793
dir=os.path.dirname(stored_state_path),
2794
delete=False)) as stored_state:
2795
pickle.dump((clients, client_settings), stored_state)
2796
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
2797
3409
os.rename(tempname, stored_state_path)
2798
3410
except (IOError, OSError) as e: