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 = AvahiService.rename(self, *args, **kwargs)
500
syslogger.setFormatter(logging.Formatter(
501
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
506
# Pretend that we have a GnuTLS module
507
class GnuTLS(object):
508
"""This isn't so much a class as it is a module-like namespace.
509
It is instantiated once, and simulates having a GnuTLS module."""
511
library = ctypes.util.find_library("gnutls")
513
library = ctypes.util.find_library("gnutls-deb0")
514
_library = ctypes.cdll.LoadLibrary(library)
516
_need_version = b"3.3.0"
519
# Need to use "self" here, since this method is called before
520
# the assignment to the "gnutls" global variable happens.
521
if self.check_version(self._need_version) is None:
522
raise self.Error("Needs GnuTLS {} or later"
523
.format(self._need_version))
525
# Unless otherwise indicated, the constants and types below are
526
# all from the gnutls/gnutls.h C header file.
536
E_NO_CERTIFICATE_FOUND = -49
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
540
class session_int(ctypes.Structure):
542
session_t = ctypes.POINTER(session_int)
544
class certificate_credentials_st(ctypes.Structure):
546
certificate_credentials_t = ctypes.POINTER(
547
certificate_credentials_st)
548
certificate_type_t = ctypes.c_int
550
class datum_t(ctypes.Structure):
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
('size', ctypes.c_uint)]
554
class openpgp_crt_int(ctypes.Structure):
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
credentials_type_t = ctypes.c_int
560
transport_ptr_t = ctypes.c_void_p
561
close_request_t = ctypes.c_int
564
class Error(Exception):
565
# We need to use the class name "GnuTLS" here, since this
566
# exception might be raised from within GnuTLS.__init__,
567
# which is called before the assignment to the "gnutls"
568
# global variable has happened.
569
def __init__(self, message=None, code=None, args=()):
570
# Default usage is by a message string, but if a return
571
# code is passed, convert it to a string with
574
if message is None and code is not None:
575
message = GnuTLS.strerror(code)
576
return super(GnuTLS.Error, self).__init__(
579
class CertificateSecurityError(Error):
583
class Credentials(object):
585
self._c_object = gnutls.certificate_credentials_t()
586
gnutls.certificate_allocate_credentials(
587
ctypes.byref(self._c_object))
588
self.type = gnutls.CRD_CERTIFICATE
591
gnutls.certificate_free_credentials(self._c_object)
593
class ClientSession(object):
594
def __init__(self, socket, credentials=None):
595
self._c_object = gnutls.session_t()
596
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
597
gnutls.set_default_priority(self._c_object)
598
gnutls.transport_set_ptr(self._c_object, socket.fileno())
599
gnutls.handshake_set_private_extensions(self._c_object,
602
if credentials is None:
603
credentials = gnutls.Credentials()
604
gnutls.credentials_set(self._c_object, credentials.type,
605
ctypes.cast(credentials._c_object,
607
self.credentials = credentials
610
gnutls.deinit(self._c_object)
613
return gnutls.handshake(self._c_object)
615
def send(self, data):
619
data_len -= gnutls.record_send(self._c_object,
624
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
626
# Error handling functions
627
def _error_code(result):
628
"""A function to raise exceptions on errors, suitable
629
for the 'restype' attribute on ctypes functions"""
632
if result == gnutls.E_NO_CERTIFICATE_FOUND:
633
raise gnutls.CertificateSecurityError(code=result)
634
raise gnutls.Error(code=result)
636
def _retry_on_error(result, func, arguments):
637
"""A function to retry on some errors, suitable
638
for the 'errcheck' attribute on ctypes functions"""
640
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
641
return _error_code(result)
642
result = func(*arguments)
645
# Unless otherwise indicated, the function declarations below are
646
# all from the gnutls/gnutls.h C header file.
649
priority_set_direct = _library.gnutls_priority_set_direct
650
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
651
ctypes.POINTER(ctypes.c_char_p)]
652
priority_set_direct.restype = _error_code
654
init = _library.gnutls_init
655
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
656
init.restype = _error_code
658
set_default_priority = _library.gnutls_set_default_priority
659
set_default_priority.argtypes = [session_t]
660
set_default_priority.restype = _error_code
662
record_send = _library.gnutls_record_send
663
record_send.argtypes = [session_t, ctypes.c_void_p,
665
record_send.restype = ctypes.c_ssize_t
666
record_send.errcheck = _retry_on_error
668
certificate_allocate_credentials = (
669
_library.gnutls_certificate_allocate_credentials)
670
certificate_allocate_credentials.argtypes = [
671
ctypes.POINTER(certificate_credentials_t)]
672
certificate_allocate_credentials.restype = _error_code
674
certificate_free_credentials = (
675
_library.gnutls_certificate_free_credentials)
676
certificate_free_credentials.argtypes = [
677
certificate_credentials_t]
678
certificate_free_credentials.restype = None
680
handshake_set_private_extensions = (
681
_library.gnutls_handshake_set_private_extensions)
682
handshake_set_private_extensions.argtypes = [session_t,
684
handshake_set_private_extensions.restype = None
686
credentials_set = _library.gnutls_credentials_set
687
credentials_set.argtypes = [session_t, credentials_type_t,
689
credentials_set.restype = _error_code
691
strerror = _library.gnutls_strerror
692
strerror.argtypes = [ctypes.c_int]
693
strerror.restype = ctypes.c_char_p
695
certificate_type_get = _library.gnutls_certificate_type_get
696
certificate_type_get.argtypes = [session_t]
697
certificate_type_get.restype = _error_code
699
certificate_get_peers = _library.gnutls_certificate_get_peers
700
certificate_get_peers.argtypes = [session_t,
701
ctypes.POINTER(ctypes.c_uint)]
702
certificate_get_peers.restype = ctypes.POINTER(datum_t)
704
global_set_log_level = _library.gnutls_global_set_log_level
705
global_set_log_level.argtypes = [ctypes.c_int]
706
global_set_log_level.restype = None
708
global_set_log_function = _library.gnutls_global_set_log_function
709
global_set_log_function.argtypes = [log_func]
710
global_set_log_function.restype = None
712
deinit = _library.gnutls_deinit
713
deinit.argtypes = [session_t]
714
deinit.restype = None
716
handshake = _library.gnutls_handshake
717
handshake.argtypes = [session_t]
718
handshake.restype = _error_code
719
handshake.errcheck = _retry_on_error
721
transport_set_ptr = _library.gnutls_transport_set_ptr
722
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
723
transport_set_ptr.restype = None
725
bye = _library.gnutls_bye
726
bye.argtypes = [session_t, close_request_t]
727
bye.restype = _error_code
728
bye.errcheck = _retry_on_error
730
check_version = _library.gnutls_check_version
731
check_version.argtypes = [ctypes.c_char_p]
732
check_version.restype = ctypes.c_char_p
734
# All the function declarations below are from gnutls/openpgp.h
736
openpgp_crt_init = _library.gnutls_openpgp_crt_init
737
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
738
openpgp_crt_init.restype = _error_code
740
openpgp_crt_import = _library.gnutls_openpgp_crt_import
741
openpgp_crt_import.argtypes = [openpgp_crt_t,
742
ctypes.POINTER(datum_t),
744
openpgp_crt_import.restype = _error_code
746
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
747
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
748
ctypes.POINTER(ctypes.c_uint)]
749
openpgp_crt_verify_self.restype = _error_code
751
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
752
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
753
openpgp_crt_deinit.restype = None
755
openpgp_crt_get_fingerprint = (
756
_library.gnutls_openpgp_crt_get_fingerprint)
757
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
761
openpgp_crt_get_fingerprint.restype = _error_code
763
# Remove non-public functions
764
del _error_code, _retry_on_error
765
# Create the global "gnutls" object, simulating a module
769
def call_pipe(connection, # : multiprocessing.Connection
770
func, *args, **kwargs):
771
"""This function is meant to be called by multiprocessing.Process
773
This function runs func(*args, **kwargs), and writes the resulting
774
return value on the provided multiprocessing.Connection.
776
connection.send(func(*args, **kwargs))
404
780
class Client(object):
405
781
"""A representation of a client host served by this server.
408
784
approved: bool(); 'None' if not yet approved/disapproved
409
785
approval_delay: datetime.timedelta(); Time to wait for approval
582
960
logger.info("Disabling client %s", self.name)
583
961
if getattr(self, "disable_initiator_tag", None) is not None:
584
gobject.source_remove(self.disable_initiator_tag)
962
GLib.source_remove(self.disable_initiator_tag)
585
963
self.disable_initiator_tag = None
586
964
self.expires = None
587
965
if getattr(self, "checker_initiator_tag", None) is not None:
588
gobject.source_remove(self.checker_initiator_tag)
966
GLib.source_remove(self.checker_initiator_tag)
589
967
self.checker_initiator_tag = None
590
968
self.stop_checker()
591
969
self.enabled = False
593
971
self.send_changedstate()
594
# Do not run this again if called by a gobject.timeout_add
972
# Do not run this again if called by a GLib.timeout_add
597
975
def __del__(self):
600
978
def init_checker(self):
601
979
# Schedule a new checker to be started an 'interval' from now,
602
980
# and every interval from then on.
603
981
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),
982
GLib.source_remove(self.checker_initiator_tag)
983
self.checker_initiator_tag = GLib.timeout_add(
984
int(self.interval.total_seconds() * 1000),
609
986
# Schedule a disable() when 'timeout' has passed
610
987
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),
988
GLib.source_remove(self.disable_initiator_tag)
989
self.disable_initiator_tag = GLib.timeout_add(
990
int(self.timeout.total_seconds() * 1000), self.disable)
616
991
# Also start a new checker *right now*.
617
992
self.start_checker()
619
def checker_callback(self, pid, condition, command):
994
def checker_callback(self, source, condition, connection,
620
996
"""The checker has completed, so take appropriate actions."""
621
997
self.checker_callback_tag = None
622
998
self.checker = None
623
if os.WIFEXITED(condition):
624
self.last_checker_status = os.WEXITSTATUS(condition)
999
# Read return code from connection (see call_pipe)
1000
returncode = connection.recv()
1004
self.last_checker_status = returncode
1005
self.last_checker_signal = None
625
1006
if self.last_checker_status == 0:
626
1007
logger.info("Checker for %(name)s succeeded",
628
1009
self.checked_ok()
630
logger.info("Checker for %(name)s failed",
1011
logger.info("Checker for %(name)s failed", vars(self))
633
1013
self.last_checker_status = -1
1014
self.last_checker_signal = -returncode
634
1015
logger.warning("Checker for %(name)s crashed?",
637
1019
def checked_ok(self):
638
1020
"""Assert that the client has been seen, alive and well."""
639
1021
self.last_checked_ok = datetime.datetime.utcnow()
640
1022
self.last_checker_status = 0
1023
self.last_checker_signal = None
641
1024
self.bump_timeout()
643
1026
def bump_timeout(self, timeout=None):
644
1027
"""Bump up the timeout for this client."""
645
1028
if timeout is None:
646
1029
timeout = self.timeout
647
1030
if self.disable_initiator_tag is not None:
648
gobject.source_remove(self.disable_initiator_tag)
1031
GLib.source_remove(self.disable_initiator_tag)
649
1032
self.disable_initiator_tag = None
650
1033
if getattr(self, "enabled", False):
651
self.disable_initiator_tag = (gobject.timeout_add
652
(int(timeout.total_seconds()
653
* 1000), self.disable))
1034
self.disable_initiator_tag = GLib.timeout_add(
1035
int(timeout.total_seconds() * 1000), self.disable)
654
1036
self.expires = datetime.datetime.utcnow() + timeout
656
1038
def need_approval(self):
657
1039
self.last_approval_request = datetime.datetime.utcnow()
659
1041
def start_checker(self):
660
1042
"""Start a new checker subprocess if one is not running.
662
1044
If a checker already exists, leave it running and do
664
1046
# The reason for not killing a running checker is that if we
669
1051
# checkers alone, the checker would have to take more time
670
1052
# 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)
1055
if self.checker is not None and not self.checker.is_alive():
1056
logger.warning("Checker was not alive; joining")
687
1059
# Start a new checker if needed
688
1060
if self.checker is None:
689
1061
# Escape attributes for the shell
690
escaped_attrs = { attr:
691
re.escape(str(getattr(self, attr)))
692
for attr in self.runtime_expansions }
1063
attr: re.escape(str(getattr(self, attr)))
1064
for attr in self.runtime_expansions}
694
1066
command = self.checker_command % escaped_attrs
695
1067
except TypeError as error:
696
1068
logger.error('Could not format string "%s"',
697
self.checker_command, exc_info=error)
698
return True # Try again later
1069
self.checker_command,
1071
return True # Try again later
699
1072
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
1073
logger.info("Starting checker %r for %s", command,
1075
# We don't need to redirect stdout and stderr, since
1076
# in normal mode, that is already done by daemon(),
1077
# and in debug mode we don't want to. (Stdin is
1078
# always replaced by /dev/null.)
1079
# The exception is when not debugging but nevertheless
1080
# running in the foreground; use the previously
1082
popen_args = {"close_fds": True,
1085
if (not self.server_settings["debug"]
1086
and self.server_settings["foreground"]):
1087
popen_args.update({"stdout": wnull,
1089
pipe = multiprocessing.Pipe(duplex=False)
1090
self.checker = multiprocessing.Process(
1092
args=(pipe[1], subprocess.call, command),
1094
self.checker.start()
1095
self.checker_callback_tag = GLib.io_add_watch(
1096
pipe[0].fileno(), GLib.IO_IN,
1097
self.checker_callback, pipe[0], command)
1098
# Re-run this periodically if run by GLib.timeout_add
744
1101
def stop_checker(self):
745
1102
"""Force the checker process, if any, to stop."""
746
1103
if self.checker_callback_tag:
747
gobject.source_remove(self.checker_callback_tag)
1104
GLib.source_remove(self.checker_callback_tag)
748
1105
self.checker_callback_tag = None
749
1106
if getattr(self, "checker", None) is None:
751
1108
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
1109
self.checker.terminate()
760
1110
self.checker = None
763
def dbus_service_property(dbus_interface, signature="v",
764
access="readwrite", byte_arrays=False):
1113
def dbus_service_property(dbus_interface,
765
1117
"""Decorators for marking methods of a DBusObjectWithProperties to
766
1118
become properties on the D-Bus.
768
1120
The decorated method will be called with no arguments by "Get"
769
1121
and with one argument by "Set".
771
1123
The parameters, where they are supported, are the same as
772
1124
dbus.service.method, except there is only "signature", since the
773
1125
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.
1208
class DBusObjectWithAnnotations(dbus.service.Object):
1209
"""A D-Bus object with annotations.
1211
Classes inheriting from this can use the dbus_annotations
1212
decorator to add annotations to methods or signals.
856
1216
def _is_dbus_thing(thing):
857
1217
"""Returns a function testing if an attribute is a D-Bus thing
859
1219
If called like _is_dbus_thing("method") it returns a function
860
1220
suitable for use as predicate to inspect.getmembers().
862
1222
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
865
1225
def _get_all_dbus_things(self, thing):
866
1226
"""Returns a generator of (name, attribute) pairs
868
return ((getattr(athing.__get__(self), "_dbus_name",
1228
return ((getattr(athing.__get__(self), "_dbus_name", name),
870
1229
athing.__get__(self))
871
1230
for cls in self.__class__.__mro__
872
1231
for name, athing in
873
inspect.getmembers(cls,
874
self._is_dbus_thing(thing)))
1232
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1234
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1236
path_keyword='object_path',
1237
connection_keyword='connection')
1238
def Introspect(self, object_path, connection):
1239
"""Overloading of standard D-Bus method.
1241
Inserts annotation tags on methods and signals.
1243
xmlstring = dbus.service.Object.Introspect(self, object_path,
1246
document = xml.dom.minidom.parseString(xmlstring)
1248
for if_tag in document.getElementsByTagName("interface"):
1249
# Add annotation tags
1250
for typ in ("method", "signal"):
1251
for tag in if_tag.getElementsByTagName(typ):
1253
for name, prop in (self.
1254
_get_all_dbus_things(typ)):
1255
if (name == tag.getAttribute("name")
1256
and prop._dbus_interface
1257
== if_tag.getAttribute("name")):
1258
annots.update(getattr(
1259
prop, "_dbus_annotations", {}))
1260
for name, value in annots.items():
1261
ann_tag = document.createElement(
1263
ann_tag.setAttribute("name", name)
1264
ann_tag.setAttribute("value", value)
1265
tag.appendChild(ann_tag)
1266
# Add interface annotation tags
1267
for annotation, value in dict(
1268
itertools.chain.from_iterable(
1269
annotations().items()
1270
for name, annotations
1271
in self._get_all_dbus_things("interface")
1272
if name == if_tag.getAttribute("name")
1274
ann_tag = document.createElement("annotation")
1275
ann_tag.setAttribute("name", annotation)
1276
ann_tag.setAttribute("value", value)
1277
if_tag.appendChild(ann_tag)
1278
# Fix argument name for the Introspect method itself
1279
if (if_tag.getAttribute("name")
1280
== dbus.INTROSPECTABLE_IFACE):
1281
for cn in if_tag.getElementsByTagName("method"):
1282
if cn.getAttribute("name") == "Introspect":
1283
for arg in cn.getElementsByTagName("arg"):
1284
if (arg.getAttribute("direction")
1286
arg.setAttribute("name",
1288
xmlstring = document.toxml("utf-8")
1290
except (AttributeError, xml.dom.DOMException,
1291
xml.parsers.expat.ExpatError) as error:
1292
logger.error("Failed to override Introspection method",
1297
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1298
"""A D-Bus object with properties.
1300
Classes inheriting from this can use the dbus_service_property
1301
decorator to expose methods as D-Bus properties. It exposes the
1302
standard Get(), Set(), and GetAll() methods on the D-Bus.
876
1305
def _get_dbus_property(self, interface_name, property_name):
877
1306
"""Returns a bound method if one exists which is a D-Bus
878
1307
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"))):
1309
for cls in self.__class__.__mro__:
1310
for name, value in inspect.getmembers(
1311
cls, self._is_dbus_thing("property")):
884
1312
if (value._dbus_name == property_name
885
1313
and value._dbus_interface == interface_name):
886
1314
return value.__get__(self)
888
1316
# No such property
889
raise DBusPropertyNotFound(self.dbus_object_path + ":"
890
+ interface_name + "."
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1317
raise DBusPropertyNotFound("{}:{}.{}".format(
1318
self.dbus_object_path, interface_name, property_name))
1321
def _get_all_interface_names(cls):
1322
"""Get a sequence of all interfaces supported by an object"""
1323
return (name for name in set(getattr(getattr(x, attr),
1324
"_dbus_interface", None)
1325
for x in (inspect.getmro(cls))
1327
if name is not None)
1329
@dbus.service.method(dbus.PROPERTIES_IFACE,
894
1331
out_signature="v")
895
1332
def Get(self, interface_name, property_name):
896
1333
"""Standard D-Bus property Get() method, see D-Bus standard.
1036
1462
return xmlstring
1466
dbus.OBJECT_MANAGER_IFACE
1467
except AttributeError:
1468
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1471
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1472
"""A D-Bus object with an ObjectManager.
1474
Classes inheriting from this exposes the standard
1475
GetManagedObjects call and the InterfacesAdded and
1476
InterfacesRemoved signals on the standard
1477
"org.freedesktop.DBus.ObjectManager" interface.
1479
Note: No signals are sent automatically; they must be sent
1482
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1483
out_signature="a{oa{sa{sv}}}")
1484
def GetManagedObjects(self):
1485
"""This function must be overridden"""
1486
raise NotImplementedError()
1488
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1489
signature="oa{sa{sv}}")
1490
def InterfacesAdded(self, object_path, interfaces_and_properties):
1493
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1494
def InterfacesRemoved(self, object_path, interfaces):
1497
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1499
path_keyword='object_path',
1500
connection_keyword='connection')
1501
def Introspect(self, object_path, connection):
1502
"""Overloading of standard D-Bus method.
1504
Override return argument name of GetManagedObjects to be
1505
"objpath_interfaces_and_properties"
1507
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1511
document = xml.dom.minidom.parseString(xmlstring)
1513
for if_tag in document.getElementsByTagName("interface"):
1514
# Fix argument name for the GetManagedObjects method
1515
if (if_tag.getAttribute("name")
1516
== dbus.OBJECT_MANAGER_IFACE):
1517
for cn in if_tag.getElementsByTagName("method"):
1518
if (cn.getAttribute("name")
1519
== "GetManagedObjects"):
1520
for arg in cn.getElementsByTagName("arg"):
1521
if (arg.getAttribute("direction")
1525
"objpath_interfaces"
1527
xmlstring = document.toxml("utf-8")
1529
except (AttributeError, xml.dom.DOMException,
1530
xml.parsers.expat.ExpatError) as error:
1531
logger.error("Failed to override Introspection method",
1039
1536
def datetime_to_dbus(dt, variant_level=0):
1040
1537
"""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)
1539
return dbus.String("", variant_level=variant_level)
1540
return dbus.String(dt.isoformat(), variant_level=variant_level)
1047
1543
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1077
1574
# Ignore non-D-Bus attributes, and D-Bus attributes
1078
1575
# with the wrong interface name
1079
1576
if (not hasattr(attribute, "_dbus_interface")
1080
or not attribute._dbus_interface
1081
.startswith(orig_interface_name)):
1577
or not attribute._dbus_interface.startswith(
1578
orig_interface_name)):
1083
1580
# Create an alternate D-Bus interface name based on
1084
1581
# the current name
1085
alt_interface = (attribute._dbus_interface
1086
.replace(orig_interface_name,
1087
alt_interface_name))
1582
alt_interface = attribute._dbus_interface.replace(
1583
orig_interface_name, alt_interface_name)
1088
1584
interface_names.add(alt_interface)
1089
1585
# Is this a D-Bus signal?
1090
1586
if getattr(attribute, "_dbus_is_signal", False):
1091
1587
# Extract the original non-method undecorated
1092
1588
# function by black magic
1093
nonmethod_func = (dict(
1589
if sys.version_info.major == 2:
1590
nonmethod_func = (dict(
1094
1591
zip(attribute.func_code.co_freevars,
1095
attribute.__closure__))["func"]
1592
attribute.__closure__))
1593
["func"].cell_contents)
1595
nonmethod_func = (dict(
1596
zip(attribute.__code__.co_freevars,
1597
attribute.__closure__))
1598
["func"].cell_contents)
1097
1599
# Create a new, but exactly alike, function
1098
1600
# object, and decorate it to be a new D-Bus signal
1099
1601
# 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)))
1602
new_function = copy_function(nonmethod_func)
1603
new_function = (dbus.service.signal(
1605
attribute._dbus_signature)(new_function))
1109
1606
# Copy annotations, if any
1111
new_function._dbus_annotations = (
1112
dict(attribute._dbus_annotations))
1608
new_function._dbus_annotations = dict(
1609
attribute._dbus_annotations)
1113
1610
except AttributeError:
1115
1613
# Define a creator of a function to call both the
1116
1614
# original and alternate functions, so both the
1117
1615
# original and alternate signals gets sent when
1258
1755
variant_level: D-Bus variant level. Default: 1
1260
1757
attrname = "_{}".format(dbus_name)
1261
1759
def setter(self, value):
1262
1760
if hasattr(self, "dbus_object_path"):
1263
1761
if (not hasattr(self, attrname) or
1264
1762
type_func(getattr(self, attrname, None))
1265
1763
!= type_func(value)):
1266
1764
if invalidate_only:
1267
self.PropertiesChanged(_interface,
1765
self.PropertiesChanged(
1766
_interface, dbus.Dictionary(),
1767
dbus.Array((dbus_name, )))
1272
dbus_value = transform_func(type_func(value),
1769
dbus_value = transform_func(
1771
variant_level=variant_level)
1275
1772
self.PropertyChanged(dbus.String(dbus_name),
1277
self.PropertiesChanged(_interface,
1279
dbus.String(dbus_name):
1280
dbus_value }), dbus.Array())
1774
self.PropertiesChanged(
1776
dbus.Dictionary({dbus.String(dbus_name):
1281
1779
setattr(self, attrname, value)
1283
1781
return property(lambda self: getattr(self, attrname), setter)
1285
1783
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1286
1784
approvals_pending = notifychangeproperty(dbus.Boolean,
1287
1785
"ApprovalPending",
1289
1787
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1290
1788
last_enabled = notifychangeproperty(datetime_to_dbus,
1292
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1293
type_func = lambda checker:
1294
checker is not None)
1790
checker = notifychangeproperty(
1791
dbus.Boolean, "CheckerRunning",
1792
type_func=lambda checker: checker is not None)
1295
1793
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1296
1794
"LastCheckedOK")
1297
1795
last_checker_status = notifychangeproperty(dbus.Int16,
1407
1904
server to mandos-client
1411
1908
# Rejected - signal
1412
1909
@dbus.service.signal(_interface, signature="s")
1413
1910
def Rejected(self, reason):
1417
1914
# NeedApproval - signal
1418
1915
@dbus.service.signal(_interface, signature="tb")
1419
1916
def NeedApproval(self, timeout, default):
1421
1918
return self.need_approval()
1425
1922
# Approve - method
1426
1923
@dbus.service.method(_interface, in_signature="b")
1427
1924
def Approve(self, value):
1428
1925
self.approve(value)
1430
1927
# CheckedOK - method
1431
1928
@dbus.service.method(_interface)
1432
1929
def CheckedOK(self):
1433
1930
self.checked_ok()
1435
1932
# Enable - method
1933
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1436
1934
@dbus.service.method(_interface)
1437
1935
def Enable(self):
1441
1939
# StartChecker - method
1940
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1442
1941
@dbus.service.method(_interface)
1443
1942
def StartChecker(self):
1445
1944
self.start_checker()
1447
1946
# Disable - method
1947
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1448
1948
@dbus.service.method(_interface)
1449
1949
def Disable(self):
1453
1953
# StopChecker - method
1954
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1454
1955
@dbus.service.method(_interface)
1455
1956
def StopChecker(self):
1456
1957
self.stop_checker()
1460
1961
# ApprovalPending - property
1461
1962
@dbus_service_property(_interface, signature="b", access="read")
1462
1963
def ApprovalPending_dbus_property(self):
1463
1964
return dbus.Boolean(bool(self.approvals_pending))
1465
1966
# ApprovedByDefault - property
1466
@dbus_service_property(_interface, signature="b",
1967
@dbus_service_property(_interface,
1467
1969
access="readwrite")
1468
1970
def ApprovedByDefault_dbus_property(self, value=None):
1469
1971
if value is None: # get
1470
1972
return dbus.Boolean(self.approved_by_default)
1471
1973
self.approved_by_default = bool(value)
1473
1975
# ApprovalDelay - property
1474
@dbus_service_property(_interface, signature="t",
1976
@dbus_service_property(_interface,
1475
1978
access="readwrite")
1476
1979
def ApprovalDelay_dbus_property(self, value=None):
1477
1980
if value is None: # get
1478
1981
return dbus.UInt64(self.approval_delay.total_seconds()
1480
1983
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1482
1985
# ApprovalDuration - property
1483
@dbus_service_property(_interface, signature="t",
1986
@dbus_service_property(_interface,
1484
1988
access="readwrite")
1485
1989
def ApprovalDuration_dbus_property(self, value=None):
1486
1990
if value is None: # get
1487
1991
return dbus.UInt64(self.approval_duration.total_seconds()
1489
1993
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1491
1995
# Name - property
1997
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1492
1998
@dbus_service_property(_interface, signature="s", access="read")
1493
1999
def Name_dbus_property(self):
1494
2000
return dbus.String(self.name)
1496
2002
# Fingerprint - property
2004
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1497
2005
@dbus_service_property(_interface, signature="s", access="read")
1498
2006
def Fingerprint_dbus_property(self):
1499
2007
return dbus.String(self.fingerprint)
1501
2009
# Host - property
1502
@dbus_service_property(_interface, signature="s",
2010
@dbus_service_property(_interface,
1503
2012
access="readwrite")
1504
2013
def Host_dbus_property(self, value=None):
1505
2014
if value is None: # get
1506
2015
return dbus.String(self.host)
1507
2016
self.host = str(value)
1509
2018
# Created - property
2020
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1510
2021
@dbus_service_property(_interface, signature="s", access="read")
1511
2022
def Created_dbus_property(self):
1512
2023
return datetime_to_dbus(self.created)
1514
2025
# LastEnabled - property
1515
2026
@dbus_service_property(_interface, signature="s", access="read")
1516
2027
def LastEnabled_dbus_property(self):
1517
2028
return datetime_to_dbus(self.last_enabled)
1519
2030
# Enabled - property
1520
@dbus_service_property(_interface, signature="b",
2031
@dbus_service_property(_interface,
1521
2033
access="readwrite")
1522
2034
def Enabled_dbus_property(self, value=None):
1523
2035
if value is None: # get
1788
2305
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))
2308
session.send(client.secret)
2309
except gnutls.Error as error:
2310
logger.warning("gnutls send failed",
1803
2314
logger.info("Sending secret to %s", client.name)
1804
2315
# bump the timeout using extended_timeout
1805
2316
client.bump_timeout(client.extended_timeout)
1806
2317
if self.server.use_dbus:
1807
2318
# Emit D-Bus signal
1808
2319
client.GotSecret()
1811
2322
if approval_required:
1812
2323
client.approvals_pending -= 1
1815
except gnutls.errors.GNUTLSError as error:
2326
except gnutls.Error as error:
1816
2327
logger.warning("GnuTLS bye failed",
1817
2328
exc_info=error)
1820
2331
def peer_certificate(session):
1821
2332
"Return the peer's OpenPGP certificate as a bytestring"
1822
2333
# 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
2334
if (gnutls.certificate_type_get(session._c_object)
2335
!= gnutls.CRT_OPENPGP):
2336
# ...return invalid data
1828
2338
list_size = ctypes.c_uint(1)
1829
cert_list = (gnutls.library.functions
1830
.gnutls_certificate_get_peers
2339
cert_list = (gnutls.certificate_get_peers
1831
2340
(session._c_object, ctypes.byref(list_size)))
1832
2341
if not bool(cert_list) and list_size.value != 0:
1833
raise gnutls.errors.GNUTLSError("error getting peer"
2342
raise gnutls.Error("error getting peer certificate")
1835
2343
if list_size.value == 0:
1837
2345
cert = cert_list[0]
1838
2346
return ctypes.string_at(cert.data, cert.size)
1841
2349
def fingerprint(openpgp):
1842
2350
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1843
2351
# 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))))
2352
datum = gnutls.datum_t(
2353
ctypes.cast(ctypes.c_char_p(openpgp),
2354
ctypes.POINTER(ctypes.c_ubyte)),
2355
ctypes.c_uint(len(openpgp)))
1849
2356
# 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)))
2357
crt = gnutls.openpgp_crt_t()
2358
gnutls.openpgp_crt_init(ctypes.byref(crt))
1853
2359
# 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))
2360
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2361
gnutls.OPENPGP_FMT_RAW)
1858
2362
# Verify the self signature in the key
1859
2363
crtverify = ctypes.c_uint()
1860
(gnutls.library.functions
1861
.gnutls_openpgp_crt_verify_self(crt, 0,
1862
ctypes.byref(crtverify)))
2364
gnutls.openpgp_crt_verify_self(crt, 0,
2365
ctypes.byref(crtverify))
1863
2366
if crtverify.value != 0:
1864
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1865
raise (gnutls.errors.CertificateSecurityError
2367
gnutls.openpgp_crt_deinit(crt)
2368
raise gnutls.CertificateSecurityError("Verify failed")
1867
2369
# New buffer for the fingerprint
1868
2370
buf = ctypes.create_string_buffer(20)
1869
2371
buf_len = ctypes.c_size_t()
1870
2372
# 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)))
2373
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2374
ctypes.byref(buf_len))
1874
2375
# Deinit the certificate
1875
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2376
gnutls.openpgp_crt_deinit(crt)
1876
2377
# Convert the buffer to a Python bytestring
1877
2378
fpr = ctypes.string_at(buf, buf_len.value)
1878
2379
# Convert the bytestring to hexadecimal notation
1961
2468
# socket_wrapper(), if socketfd was set.
1962
2469
socketserver.TCPServer.__init__(self, server_address,
1963
2470
RequestHandlerClass)
1965
2472
def server_bind(self):
1966
2473
"""This overrides the normal server_bind() function
1967
2474
to bind to an interface if one was specified, and also NOT to
1968
2475
bind to an address or port if they were not specified."""
2476
global SO_BINDTODEVICE
1969
2477
if self.interface is not None:
1970
2478
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)
2479
# Fall back to a hard-coded value which seems to be
2481
logger.warning("SO_BINDTODEVICE not found, trying 25")
2482
SO_BINDTODEVICE = 25
2484
self.socket.setsockopt(
2485
socket.SOL_SOCKET, SO_BINDTODEVICE,
2486
(self.interface + "\0").encode("utf-8"))
2487
except socket.error as error:
2488
if error.errno == errno.EPERM:
2489
logger.error("No permission to bind to"
2490
" interface %s", self.interface)
2491
elif error.errno == errno.ENOPROTOOPT:
2492
logger.error("SO_BINDTODEVICE not available;"
2493
" cannot bind to interface %s",
2495
elif error.errno == errno.ENODEV:
2496
logger.error("Interface %s does not exist,"
2497
" cannot bind", self.interface)
1993
2500
# Only bind(2) the socket if we really need to.
1994
2501
if self.server_address[0] or self.server_address[1]:
1995
2502
if not self.server_address[0]:
1996
2503
if self.address_family == socket.AF_INET6:
1997
any_address = "::" # in6addr_any
2504
any_address = "::" # in6addr_any
1999
any_address = "0.0.0.0" # INADDR_ANY
2506
any_address = "0.0.0.0" # INADDR_ANY
2000
2507
self.server_address = (any_address,
2001
2508
self.server_address[1])
2002
2509
elif not self.server_address[1]:
2003
self.server_address = (self.server_address[0],
2510
self.server_address = (self.server_address[0], 0)
2005
2511
# if self.interface:
2006
2512
# self.server_address = (self.server_address[0],
2438
2952
level = getattr(logging, debuglevel.upper())
2439
2953
initlogger(debug, level)
2441
2955
if server_settings["servicename"] != "Mandos":
2442
syslogger.setFormatter(logging.Formatter
2443
('Mandos ({}) [%(process)d]:'
2444
' %(levelname)s: %(message)s'
2445
.format(server_settings
2956
syslogger.setFormatter(
2957
logging.Formatter('Mandos ({}) [%(process)d]:'
2958
' %(levelname)s: %(message)s'.format(
2959
server_settings["servicename"])))
2448
2961
# Parse config file with clients
2449
2962
client_config = configparser.SafeConfigParser(Client
2450
2963
.client_defaults)
2451
2964
client_config.read(os.path.join(server_settings["configdir"],
2452
2965
"clients.conf"))
2454
2967
global mandos_dbus_service
2455
2968
mandos_dbus_service = None
2457
2970
socketfd = None
2458
2971
if server_settings["socket"] != "":
2459
2972
socketfd = server_settings["socket"]
2460
tcp_server = MandosServer((server_settings["address"],
2461
server_settings["port"]),
2463
interface=(server_settings["interface"]
2467
server_settings["priority"],
2973
tcp_server = MandosServer(
2974
(server_settings["address"], server_settings["port"]),
2976
interface=(server_settings["interface"] or None),
2978
gnutls_priority=server_settings["priority"],
2470
2981
if not foreground:
2471
2982
pidfilename = "/run/mandos.pid"
2472
2983
if not os.path.isdir("/run/."):
2473
2984
pidfilename = "/var/run/mandos.pid"
2476
pidfile = open(pidfilename, "w")
2987
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2477
2988
except IOError as e:
2478
2989
logger.error("Could not open file %r", pidfilename,
2481
for name in ("_mandos", "mandos", "nobody"):
2992
for name, group in (("_mandos", "_mandos"),
2993
("mandos", "mandos"),
2994
("nobody", "nogroup")):
2483
2996
uid = pwd.getpwnam(name).pw_uid
2484
gid = pwd.getpwnam(name).pw_gid
2997
gid = pwd.getpwnam(group).pw_gid
2486
2999
except KeyError:
3008
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2494
3010
except OSError as error:
3011
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3012
.format(uid, gid, os.strerror(error.errno)))
2495
3013
if error.errno != errno.EPERM:
2499
3017
# Enable all possible GnuTLS debugging
2501
3019
# "Use a log level over 10 to enable all debugging options."
2502
3020
# - GnuTLS manual
2503
gnutls.library.functions.gnutls_global_set_log_level(11)
2505
@gnutls.library.types.gnutls_log_func
3021
gnutls.global_set_log_level(11)
2506
3024
def debug_gnutls(level, string):
2507
3025
logger.debug("GnuTLS: %s", string[:-1])
2509
(gnutls.library.functions
2510
.gnutls_global_set_log_function(debug_gnutls))
3027
gnutls.global_set_log_function(debug_gnutls)
2512
3029
# Redirect stdin so all checkers get /dev/null
2513
3030
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2514
3031
os.dup2(null, sys.stdin.fileno())
2518
3035
# Need to fork before connecting to D-Bus
2519
3036
if not foreground:
2520
3037
# 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()
3040
# multiprocessing will use threads, so before we use GLib we need
3041
# to inform GLib that threads will be used.
2527
3044
global main_loop
2528
3045
# From the Avahi example code
2529
3046
DBusGMainLoop(set_as_default=True)
2530
main_loop = gobject.MainLoop()
3047
main_loop = GLib.MainLoop()
2531
3048
bus = dbus.SystemBus()
2532
3049
# End of Avahi example code
2535
3052
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:
3055
old_bus_name = dbus.service.BusName(
3056
"se.bsnet.fukt.Mandos", bus,
3058
except dbus.exceptions.DBusException as e:
2541
3059
logger.error("Disabling D-Bus:", exc_info=e)
2542
3060
use_dbus = False
2543
3061
server_settings["use_dbus"] = False
2544
3062
tcp_server.use_dbus = False
2546
3064
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)
3065
service = AvahiServiceToSyslog(
3066
name=server_settings["servicename"],
3067
servicetype="_mandos._tcp",
2551
3070
if server_settings["interface"]:
2552
service.interface = (if_nametoindex
2553
(server_settings["interface"]
3071
service.interface = if_nametoindex(
3072
server_settings["interface"].encode("utf-8"))
2556
3074
global multiprocessing_manager
2557
3075
multiprocessing_manager = multiprocessing.Manager()
2559
3077
client_class = Client
2561
client_class = functools.partial(ClientDBus, bus = bus)
3079
client_class = functools.partial(ClientDBus, bus=bus)
2563
3081
client_settings = Client.config_parser(client_config)
2564
3082
old_client_settings = {}
2565
3083
clients_data = {}
2567
3085
# This is used to redirect stdout and stderr for checker processes
2569
wnull = open(os.devnull, "w") # A writable /dev/null
3087
wnull = open(os.devnull, "w") # A writable /dev/null
2570
3088
# Only used if server is running in foreground but not in debug
2572
3090
if debug or not foreground:
2575
3093
# Get client data and settings from last running state.
2576
3094
if server_settings["restore"]:
2578
3096
with open(stored_state_path, "rb") as stored_state:
2579
clients_data, old_client_settings = (pickle.load
3097
if sys.version_info.major == 2:
3098
clients_data, old_client_settings = pickle.load(
3101
bytes_clients_data, bytes_old_client_settings = (
3102
pickle.load(stored_state, encoding="bytes"))
3103
# Fix bytes to strings
3106
clients_data = {(key.decode("utf-8")
3107
if isinstance(key, bytes)
3110
bytes_clients_data.items()}
3111
del bytes_clients_data
3112
for key in clients_data:
3113
value = {(k.decode("utf-8")
3114
if isinstance(k, bytes) else k): v
3116
clients_data[key].items()}
3117
clients_data[key] = value
3119
value["client_structure"] = [
3121
if isinstance(s, bytes)
3123
value["client_structure"]]
3125
for k in ("name", "host"):
3126
if isinstance(value[k], bytes):
3127
value[k] = value[k].decode("utf-8")
3128
# old_client_settings
3130
old_client_settings = {
3131
(key.decode("utf-8")
3132
if isinstance(key, bytes)
3135
bytes_old_client_settings.items()}
3136
del bytes_old_client_settings
3138
for value in old_client_settings.values():
3139
if isinstance(value["host"], bytes):
3140
value["host"] = (value["host"]
2581
3142
os.remove(stored_state_path)
2582
3143
except IOError as e:
2583
3144
if e.errno == errno.ENOENT:
2584
logger.warning("Could not load persistent state: {}"
2585
.format(os.strerror(e.errno)))
3145
logger.warning("Could not load persistent state:"
3146
" {}".format(os.strerror(e.errno)))
2587
3148
logger.critical("Could not load persistent state:",
2590
3151
except EOFError as e:
2591
3152
logger.warning("Could not load persistent state: "
2592
"EOFError:", exc_info=e)
2594
3156
with PGPEngine() as pgp:
2595
3157
for client_name, client in clients_data.items():
2596
3158
# Skip removed clients
2597
3159
if client_name not in client_settings:
2600
3162
# Decide which value to use after restoring saved state.
2601
3163
# We have three different values: Old config file,
2602
3164
# new config file, and saved state.
2660
3222
for client_name in (set(client_settings)
2661
3223
- set(old_client_settings)):
2662
3224
clients_data[client_name] = client_settings[client_name]
2664
3226
# Create all client objects
2665
3227
for client_name, client in clients_data.items():
2666
3228
tcp_server.clients[client_name] = client_class(
2667
name = client_name, settings = client,
2668
server_settings = server_settings)
3231
server_settings=server_settings)
2670
3233
if not tcp_server.clients:
2671
3234
logger.warning("No clients defined")
2673
3236
if not foreground:
2674
3237
if pidfile is not None:
2678
pidfile.write("{}\n".format(pid).encode("utf-8"))
3241
print(pid, file=pidfile)
2679
3242
except IOError:
2680
3243
logger.error("Could not write to file %r with PID %d",
2681
3244
pidfilename, pid)
2683
3246
del pidfilename
2685
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2686
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3248
for termsig in (signal.SIGHUP, signal.SIGTERM):
3249
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3250
lambda: main_loop.quit() and False)
2689
@alternate_dbus_interfaces({"se.recompile.Mandos":
2690
"se.bsnet.fukt.Mandos"})
2691
class MandosDBusService(DBusObjectWithProperties):
3254
@alternate_dbus_interfaces(
3255
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3256
class MandosDBusService(DBusObjectWithObjectManager):
2692
3257
"""A D-Bus proxy object"""
2693
3259
def __init__(self):
2694
3260
dbus.service.Object.__init__(self, bus, "/")
2695
3262
_interface = "se.recompile.Mandos"
2697
@dbus_interface_annotations(_interface)
2699
return { "org.freedesktop.DBus.Property"
2700
".EmitsChangedSignal":
2703
3264
@dbus.service.signal(_interface, signature="o")
2704
3265
def ClientAdded(self, objpath):
2708
3269
@dbus.service.signal(_interface, signature="ss")
2709
3270
def ClientNotFound(self, fingerprint, address):
3274
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2713
3276
@dbus.service.signal(_interface, signature="os")
2714
3277
def ClientRemoved(self, objpath, name):
3281
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2718
3283
@dbus.service.method(_interface, out_signature="ao")
2719
3284
def GetAllClients(self):
2721
return dbus.Array(c.dbus_object_path
2723
tcp_server.clients.itervalues())
3286
return dbus.Array(c.dbus_object_path for c in
3287
tcp_server.clients.values())
3289
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2725
3291
@dbus.service.method(_interface,
2726
3292
out_signature="a{oa{sv}}")
2727
3293
def GetAllClientsWithProperties(self):
2729
3295
return dbus.Dictionary(
2730
{ c.dbus_object_path: c.GetAll("")
2731
for c in tcp_server.clients.itervalues() },
3296
{c.dbus_object_path: c.GetAll(
3297
"se.recompile.Mandos.Client")
3298
for c in tcp_server.clients.values()},
2732
3299
signature="oa{sv}")
2734
3301
@dbus.service.method(_interface, in_signature="o")
2735
3302
def RemoveClient(self, object_path):
2737
for c in tcp_server.clients.itervalues():
3304
for c in tcp_server.clients.values():
2738
3305
if c.dbus_object_path == object_path:
2739
3306
del tcp_server.clients[c.name]
2740
3307
c.remove_from_connection()
2741
# Don't signal anything except ClientRemoved
3308
# Don't signal the disabling
2742
3309
c.disable(quiet=True)
2744
self.ClientRemoved(object_path, c.name)
3310
# Emit D-Bus signal for removal
3311
self.client_removed_signal(c)
2746
3313
raise KeyError(object_path)
3317
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3318
out_signature="a{oa{sa{sv}}}")
3319
def GetManagedObjects(self):
3321
return dbus.Dictionary(
3322
{client.dbus_object_path:
3324
{interface: client.GetAll(interface)
3326
client._get_all_interface_names()})
3327
for client in tcp_server.clients.values()})
3329
def client_added_signal(self, client):
3330
"""Send the new standard signal and the old signal"""
3332
# New standard signal
3333
self.InterfacesAdded(
3334
client.dbus_object_path,
3336
{interface: client.GetAll(interface)
3338
client._get_all_interface_names()}))
3340
self.ClientAdded(client.dbus_object_path)
3342
def client_removed_signal(self, client):
3343
"""Send the new standard signal and the old signal"""
3345
# New standard signal
3346
self.InterfacesRemoved(
3347
client.dbus_object_path,
3348
client._get_all_interface_names())
3350
self.ClientRemoved(client.dbus_object_path,
2750
3353
mandos_dbus_service = MandosDBusService()
3355
# Save modules to variables to exempt the modules from being
3356
# unloaded before the function registered with atexit() is run.
3357
mp = multiprocessing
2753
3361
"Cleanup function; run on exit"
2755
3363
service.cleanup()
2757
multiprocessing.active_children()
3365
mp.active_children()
2759
3367
if not (tcp_server.clients or client_settings):
2762
3370
# Store client before exiting. Secrets are encrypted with key
2763
3371
# based on what config file has. If config file is
2764
3372
# removed/edited, old secret will thus be unrecovable.
2766
3374
with PGPEngine() as pgp:
2767
for client in tcp_server.clients.itervalues():
3375
for client in tcp_server.clients.values():
2768
3376
key = client_settings[client.name]["secret"]
2769
3377
client.encrypted_secret = pgp.encrypt(client.secret,
2771
3379
client_dict = {}
2773
3381
# 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)):
3383
exclude = {"bus", "changedstate", "secret",
3384
"checker", "server_settings"}
3385
for name, typ in inspect.getmembers(dbus.service
2779
3387
exclude.add(name)
2781
3389
client_dict["encrypted_secret"] = (client
2782
3390
.encrypted_secret)
2783
3391
for attr in client.client_structure:
2784
3392
if attr not in exclude:
2785
3393
client_dict[attr] = getattr(client, attr)
2787
3395
clients[client.name] = client_dict
2788
3396
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
3399
with tempfile.NamedTemporaryFile(
3403
dir=os.path.dirname(stored_state_path),
3404
delete=False) as stored_state:
3405
pickle.dump((clients, client_settings), stored_state,
3407
tempname = stored_state.name
2797
3408
os.rename(tempname, stored_state_path)
2798
3409
except (IOError, OSError) as e: