70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
82
67
import dbus.service
83
from gi.repository import GLib
84
70
from dbus.mainloop.glib import DBusGMainLoop
87
73
import xml.dom.minidom
90
# Try to find the value of SO_BINDTODEVICE:
92
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
93
# newer, and it is also the most natural place for it:
94
77
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
95
78
except AttributeError:
97
# This is where SO_BINDTODEVICE was up to and including Python
99
80
from IN import SO_BINDTODEVICE
100
81
except ImportError:
101
# In Python 2.7 it seems to have been removed entirely.
102
# Try running the C preprocessor:
104
cc = subprocess.Popen(["cc", "--language=c", "-E",
106
stdin=subprocess.PIPE,
107
stdout=subprocess.PIPE)
108
stdout = cc.communicate(
109
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
110
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
111
except (OSError, ValueError, IndexError):
113
SO_BINDTODEVICE = None
115
if sys.version_info.major == 2:
119
stored_state_file = "clients.pickle"
121
logger = logging.getLogger()
125
if_nametoindex = ctypes.cdll.LoadLibrary(
126
ctypes.util.find_library("c")).if_nametoindex
127
except (OSError, AttributeError):
129
def if_nametoindex(interface):
130
"Get an interface index the hard way, i.e. using fcntl()"
131
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
132
with contextlib.closing(socket.socket()) as s:
133
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
134
struct.pack(b"16s16x", interface))
135
interface_index = struct.unpack("I", ifreq[16:20])[0]
136
return interface_index
139
def copy_function(func):
140
"""Make a copy of a function"""
141
if sys.version_info.major == 2:
142
return types.FunctionType(func.func_code,
148
return types.FunctionType(func.__code__,
155
def initlogger(debug, level=logging.WARNING):
156
"""init logger and add loglevel"""
159
syslogger = (logging.handlers.SysLogHandler(
160
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
162
syslogger.setFormatter(logging.Formatter
163
('Mandos [%(process)d]: %(levelname)s:'
165
logger.addHandler(syslogger)
168
console = logging.StreamHandler()
169
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
173
logger.addHandler(console)
174
logger.setLevel(level)
177
class PGPError(Exception):
178
"""Exception if encryption/decryption fails"""
182
class PGPEngine(object):
183
"""A simple class for OpenPGP symmetric encryption & decryption"""
186
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
189
output = subprocess.check_output(["gpgconf"])
190
for line in output.splitlines():
191
name, text, path = line.split(b":")
196
if e.errno != errno.ENOENT:
198
self.gnupgargs = ['--batch',
199
'--homedir', self.tempdir,
202
# Only GPG version 1 has the --no-use-agent option.
203
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
204
self.gnupgargs.append("--no-use-agent")
209
def __exit__(self, exc_type, exc_value, traceback):
217
if self.tempdir is not None:
218
# Delete contents of tempdir
219
for root, dirs, files in os.walk(self.tempdir,
221
for filename in files:
222
os.remove(os.path.join(root, filename))
224
os.rmdir(os.path.join(root, dirname))
226
os.rmdir(self.tempdir)
229
def password_encode(self, password):
230
# Passphrase can not be empty and can not contain newlines or
231
# NUL bytes. So we prefix it and hex encode it.
232
encoded = b"mandos" + binascii.hexlify(password)
233
if len(encoded) > 2048:
234
# GnuPG can't handle long passwords, so encode differently
235
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
236
.replace(b"\n", b"\\n")
237
.replace(b"\0", b"\\x00"))
240
def encrypt(self, data, password):
241
passphrase = self.password_encode(password)
242
with tempfile.NamedTemporaryFile(
243
dir=self.tempdir) as passfile:
244
passfile.write(passphrase)
246
proc = subprocess.Popen([self.gpg, '--symmetric',
250
stdin=subprocess.PIPE,
251
stdout=subprocess.PIPE,
252
stderr=subprocess.PIPE)
253
ciphertext, err = proc.communicate(input=data)
254
if proc.returncode != 0:
258
def decrypt(self, data, password):
259
passphrase = self.password_encode(password)
260
with tempfile.NamedTemporaryFile(
261
dir=self.tempdir) as passfile:
262
passfile.write(passphrase)
264
proc = subprocess.Popen([self.gpg, '--decrypt',
268
stdin=subprocess.PIPE,
269
stdout=subprocess.PIPE,
270
stderr=subprocess.PIPE)
271
decrypted_plaintext, err = proc.communicate(input=data)
272
if proc.returncode != 0:
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
IF_UNSPEC = -1 # avahi-common/address.h
281
PROTO_UNSPEC = -1 # avahi-common/address.h
282
PROTO_INET = 0 # avahi-common/address.h
283
PROTO_INET6 = 1 # avahi-common/address.h
284
DBUS_NAME = "org.freedesktop.Avahi"
285
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
286
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
287
DBUS_PATH_SERVER = "/"
290
def string_array_to_txt_array(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
82
SO_BINDTODEVICE = None
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
89
syslogger = (logging.handlers.SysLogHandler
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
address = str("/dev/log")))
92
syslogger.setFormatter(logging.Formatter
93
('Mandos [%(process)d]: %(levelname)s:'
95
logger.addHandler(syslogger)
97
console = logging.StreamHandler()
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
101
logger.addHandler(console)
303
103
class AvahiError(Exception):
304
104
def __init__(self, value, *args, **kwargs):
305
105
self.value = value
306
return super(AvahiError, self).__init__(value, *args,
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
310
110
class AvahiServiceError(AvahiError):
314
113
class AvahiGroupError(AvahiError):
318
117
class AvahiService(object):
319
118
"""An Avahi (Zeroconf) service.
322
121
interface: integer; avahi.IF_UNSPEC or an interface index.
323
122
Used to optionally bind to the specified interface.
324
123
name: string; Example: 'Mandos'
325
124
type: string; Example: '_mandos._tcp'.
326
See <https://www.iana.org/assignments/service-names-port-numbers>
125
See <http://www.dns-sd.org/ServiceTypes.html>
327
126
port: integer; what port to announce
328
127
TXT: list of strings; TXT record for the service
329
128
domain: string; Domain to publish on, default to .local if empty.
488
260
follow_name_owner_changes=True),
489
261
avahi.DBUS_INTERFACE_SERVER)
490
262
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
263
self.server_state_changed)
492
264
self.server_state_changed(self.server.GetState())
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
"""Add the new name to the syslog messages"""
498
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
505
# Pretend that we have a GnuTLS module
506
class gnutls(object):
507
"""This isn't so much a class as it is a module-like namespace."""
509
library = ctypes.util.find_library("gnutls")
511
library = ctypes.util.find_library("gnutls-deb0")
512
_library = ctypes.cdll.LoadLibrary(library)
515
# Unless otherwise indicated, the constants and types below are
516
# all from the gnutls/gnutls.h C header file.
527
E_NO_CERTIFICATE_FOUND = -49
532
KEYID_USE_SHA256 = 1 # gnutls/x509.h
533
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
536
class session_int(ctypes.Structure):
538
session_t = ctypes.POINTER(session_int)
540
class certificate_credentials_st(ctypes.Structure):
542
certificate_credentials_t = ctypes.POINTER(
543
certificate_credentials_st)
544
certificate_type_t = ctypes.c_int
546
class datum_t(ctypes.Structure):
547
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
548
('size', ctypes.c_uint)]
550
class openpgp_crt_int(ctypes.Structure):
552
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
553
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
554
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
555
credentials_type_t = ctypes.c_int
556
transport_ptr_t = ctypes.c_void_p
557
close_request_t = ctypes.c_int
560
class Error(Exception):
561
def __init__(self, message=None, code=None, args=()):
562
# Default usage is by a message string, but if a return
563
# code is passed, convert it to a string with
566
if message is None and code is not None:
567
message = gnutls.strerror(code)
568
return super(gnutls.Error, self).__init__(
571
class CertificateSecurityError(Error):
575
class Credentials(object):
577
self._c_object = gnutls.certificate_credentials_t()
578
gnutls.certificate_allocate_credentials(
579
ctypes.byref(self._c_object))
580
self.type = gnutls.CRD_CERTIFICATE
583
gnutls.certificate_free_credentials(self._c_object)
585
class ClientSession(object):
586
def __init__(self, socket, credentials=None):
587
self._c_object = gnutls.session_t()
588
gnutls_flags = gnutls.CLIENT
589
if gnutls.check_version("3.5.6"):
590
gnutls_flags |= gnutls.NO_TICKETS
592
gnutls_flags |= gnutls.ENABLE_RAWPK
593
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
595
gnutls.set_default_priority(self._c_object)
596
gnutls.transport_set_ptr(self._c_object, socket.fileno())
597
gnutls.handshake_set_private_extensions(self._c_object,
600
if credentials is None:
601
credentials = gnutls.Credentials()
602
gnutls.credentials_set(self._c_object, credentials.type,
603
ctypes.cast(credentials._c_object,
605
self.credentials = credentials
608
gnutls.deinit(self._c_object)
611
return gnutls.handshake(self._c_object)
613
def send(self, data):
617
data_len -= gnutls.record_send(self._c_object,
622
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
624
# Error handling functions
625
def _error_code(result):
626
"""A function to raise exceptions on errors, suitable
627
for the 'restype' attribute on ctypes functions"""
630
if result == gnutls.E_NO_CERTIFICATE_FOUND:
631
raise gnutls.CertificateSecurityError(code=result)
632
raise gnutls.Error(code=result)
634
def _retry_on_error(result, func, arguments):
635
"""A function to retry on some errors, suitable
636
for the 'errcheck' attribute on ctypes functions"""
638
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
639
return _error_code(result)
640
result = func(*arguments)
643
# Unless otherwise indicated, the function declarations below are
644
# all from the gnutls/gnutls.h C header file.
647
priority_set_direct = _library.gnutls_priority_set_direct
648
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
649
ctypes.POINTER(ctypes.c_char_p)]
650
priority_set_direct.restype = _error_code
652
init = _library.gnutls_init
653
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
654
init.restype = _error_code
656
set_default_priority = _library.gnutls_set_default_priority
657
set_default_priority.argtypes = [session_t]
658
set_default_priority.restype = _error_code
660
record_send = _library.gnutls_record_send
661
record_send.argtypes = [session_t, ctypes.c_void_p,
663
record_send.restype = ctypes.c_ssize_t
664
record_send.errcheck = _retry_on_error
666
certificate_allocate_credentials = (
667
_library.gnutls_certificate_allocate_credentials)
668
certificate_allocate_credentials.argtypes = [
669
ctypes.POINTER(certificate_credentials_t)]
670
certificate_allocate_credentials.restype = _error_code
672
certificate_free_credentials = (
673
_library.gnutls_certificate_free_credentials)
674
certificate_free_credentials.argtypes = [
675
certificate_credentials_t]
676
certificate_free_credentials.restype = None
678
handshake_set_private_extensions = (
679
_library.gnutls_handshake_set_private_extensions)
680
handshake_set_private_extensions.argtypes = [session_t,
682
handshake_set_private_extensions.restype = None
684
credentials_set = _library.gnutls_credentials_set
685
credentials_set.argtypes = [session_t, credentials_type_t,
687
credentials_set.restype = _error_code
689
strerror = _library.gnutls_strerror
690
strerror.argtypes = [ctypes.c_int]
691
strerror.restype = ctypes.c_char_p
693
certificate_type_get = _library.gnutls_certificate_type_get
694
certificate_type_get.argtypes = [session_t]
695
certificate_type_get.restype = _error_code
697
certificate_get_peers = _library.gnutls_certificate_get_peers
698
certificate_get_peers.argtypes = [session_t,
699
ctypes.POINTER(ctypes.c_uint)]
700
certificate_get_peers.restype = ctypes.POINTER(datum_t)
702
global_set_log_level = _library.gnutls_global_set_log_level
703
global_set_log_level.argtypes = [ctypes.c_int]
704
global_set_log_level.restype = None
706
global_set_log_function = _library.gnutls_global_set_log_function
707
global_set_log_function.argtypes = [log_func]
708
global_set_log_function.restype = None
710
deinit = _library.gnutls_deinit
711
deinit.argtypes = [session_t]
712
deinit.restype = None
714
handshake = _library.gnutls_handshake
715
handshake.argtypes = [session_t]
716
handshake.restype = _error_code
717
handshake.errcheck = _retry_on_error
719
transport_set_ptr = _library.gnutls_transport_set_ptr
720
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
721
transport_set_ptr.restype = None
723
bye = _library.gnutls_bye
724
bye.argtypes = [session_t, close_request_t]
725
bye.restype = _error_code
726
bye.errcheck = _retry_on_error
728
check_version = _library.gnutls_check_version
729
check_version.argtypes = [ctypes.c_char_p]
730
check_version.restype = ctypes.c_char_p
732
_need_version = b"3.3.0"
733
if check_version(_need_version) is None:
734
raise self.Error("Needs GnuTLS {} or later"
735
.format(_need_version))
737
_tls_rawpk_version = b"3.6.6"
738
has_rawpk = bool(check_version(_tls_rawpk_version))
742
class pubkey_st(ctypes.Structure):
744
pubkey_t = ctypes.POINTER(pubkey_st)
746
x509_crt_fmt_t = ctypes.c_int
748
# All the function declarations below are from gnutls/abstract.h
749
pubkey_init = _library.gnutls_pubkey_init
750
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
751
pubkey_init.restype = _error_code
753
pubkey_import = _library.gnutls_pubkey_import
754
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
756
pubkey_import.restype = _error_code
758
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
759
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
760
ctypes.POINTER(ctypes.c_ubyte),
761
ctypes.POINTER(ctypes.c_size_t)]
762
pubkey_get_key_id.restype = _error_code
764
pubkey_deinit = _library.gnutls_pubkey_deinit
765
pubkey_deinit.argtypes = [pubkey_t]
766
pubkey_deinit.restype = None
768
# All the function declarations below are from gnutls/openpgp.h
770
openpgp_crt_init = _library.gnutls_openpgp_crt_init
771
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
772
openpgp_crt_init.restype = _error_code
774
openpgp_crt_import = _library.gnutls_openpgp_crt_import
775
openpgp_crt_import.argtypes = [openpgp_crt_t,
776
ctypes.POINTER(datum_t),
778
openpgp_crt_import.restype = _error_code
780
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
781
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
782
ctypes.POINTER(ctypes.c_uint)]
783
openpgp_crt_verify_self.restype = _error_code
785
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
786
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
787
openpgp_crt_deinit.restype = None
789
openpgp_crt_get_fingerprint = (
790
_library.gnutls_openpgp_crt_get_fingerprint)
791
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
795
openpgp_crt_get_fingerprint.restype = _error_code
797
if check_version("3.6.4"):
798
certificate_type_get2 = _library.gnutls_certificate_type_get2
799
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
800
certificate_type_get2.restype = _error_code
802
# Remove non-public functions
803
del _error_code, _retry_on_error
806
def call_pipe(connection, # : multiprocessing.Connection
807
func, *args, **kwargs):
808
"""This function is meant to be called by multiprocessing.Process
810
This function runs func(*args, **kwargs), and writes the resulting
811
return value on the provided multiprocessing.Connection.
813
connection.send(func(*args, **kwargs))
817
267
class Client(object):
818
268
"""A representation of a client host served by this server.
821
approved: bool(); 'None' if not yet approved/disapproved
271
_approved: bool(); 'None' if not yet approved/disapproved
822
272
approval_delay: datetime.timedelta(); Time to wait for approval
823
273
approval_duration: datetime.timedelta(); Duration of one approval
824
274
checker: subprocess.Popen(); a running checker process used
825
275
to see if the client lives.
826
276
'None' if no process is running.
827
checker_callback_tag: a GLib event source tag, or None
277
checker_callback_tag: a gobject event source tag, or None
828
278
checker_command: string; External command which is run to check
829
279
if client lives. %() expansions are done at
830
280
runtime with vars(self) as dict, so that for
831
281
instance %(name)s can be used in the command.
832
checker_initiator_tag: a GLib event source tag, or None
282
checker_initiator_tag: a gobject event source tag, or None
833
283
created: datetime.datetime(); (UTC) object creation
834
client_structure: Object describing what attributes a client has
835
and is used for storing the client at exit
836
284
current_checker_command: string; current running checker_command
837
disable_initiator_tag: a GLib event source tag, or None
285
disable_hook: If set, called by disable() as disable_hook(self)
286
disable_initiator_tag: a gobject event source tag, or None
839
288
fingerprint: string (40 or 32 hexadecimal digits); used to
840
uniquely identify an OpenPGP client
841
key_id: string (64 hexadecimal digits); used to uniquely identify
842
a client using raw public keys
289
uniquely identify the client
843
290
host: string; available for use by the checker command
844
291
interval: datetime.timedelta(); How often to start a new checker
845
292
last_approval_request: datetime.datetime(); (UTC) or None
846
293
last_checked_ok: datetime.datetime(); (UTC) or None
847
last_checker_status: integer between 0 and 255 reflecting exit
848
status of last checker. -1 reflects crashed
849
checker, -2 means no checker completed yet.
850
last_checker_signal: The signal which killed the last checker, if
851
last_checker_status is -1
852
last_enabled: datetime.datetime(); (UTC) or None
294
last_enabled: datetime.datetime(); (UTC)
853
295
name: string; from the config file, used in log messages and
854
296
D-Bus identifiers
855
297
secret: bytestring; sent verbatim (over TLS) to client
856
298
timeout: datetime.timedelta(); How long from last_checked_ok
857
299
until this client is disabled
858
extended_timeout: extra long timeout when secret has been sent
300
extended_timeout: extra long timeout when password has been sent
859
301
runtime_expansions: Allowed attributes for runtime expansion.
860
302
expires: datetime.datetime(); time (UTC) when a client will be
861
303
disabled, or None
862
server_settings: The server_settings dict from main()
865
306
runtime_expansions = ("approval_delay", "approval_duration",
866
"created", "enabled", "expires", "key_id",
867
"fingerprint", "host", "interval",
868
"last_approval_request", "last_checked_ok",
307
"created", "enabled", "fingerprint",
308
"host", "interval", "last_checked_ok",
869
309
"last_enabled", "name", "timeout")
872
"extended_timeout": "PT15M",
874
"checker": "fping -q -- %%(host)s",
876
"approval_delay": "PT0S",
877
"approval_duration": "PT1S",
878
"approved_by_default": "True",
883
def config_parser(config):
884
"""Construct a new dict of client settings of this form:
885
{ client_name: {setting_name: value, ...}, ...}
886
with exceptions for any special settings as defined above.
887
NOTE: Must be a pure function. Must return the same result
888
value given the same arguments.
891
for client_name in config.sections():
892
section = dict(config.items(client_name))
893
client = settings[client_name] = {}
895
client["host"] = section["host"]
896
# Reformat values from string types to Python types
897
client["approved_by_default"] = config.getboolean(
898
client_name, "approved_by_default")
899
client["enabled"] = config.getboolean(client_name,
902
# Uppercase and remove spaces from key_id and fingerprint
903
# for later comparison purposes with return value from the
904
# key_id() and fingerprint() functions
905
client["key_id"] = (section.get("key_id", "").upper()
907
client["fingerprint"] = (section["fingerprint"].upper()
909
if "secret" in section:
910
client["secret"] = codecs.decode(section["secret"]
913
elif "secfile" in section:
914
with open(os.path.expanduser(os.path.expandvars
915
(section["secfile"])),
917
client["secret"] = secfile.read()
919
raise TypeError("No secret or secfile for section {}"
921
client["timeout"] = string_to_delta(section["timeout"])
922
client["extended_timeout"] = string_to_delta(
923
section["extended_timeout"])
924
client["interval"] = string_to_delta(section["interval"])
925
client["approval_delay"] = string_to_delta(
926
section["approval_delay"])
927
client["approval_duration"] = string_to_delta(
928
section["approval_duration"])
929
client["checker_command"] = section["checker"]
930
client["last_approval_request"] = None
931
client["last_checked_ok"] = None
932
client["last_checker_status"] = -2
936
def __init__(self, settings, name=None, server_settings=None):
312
def _timedelta_to_milliseconds(td):
313
"Convert a datetime.timedelta() to milliseconds"
314
return ((td.days * 24 * 60 * 60 * 1000)
315
+ (td.seconds * 1000)
316
+ (td.microseconds // 1000))
318
def timeout_milliseconds(self):
319
"Return the 'timeout' attribute in milliseconds"
320
return self._timedelta_to_milliseconds(self.timeout)
322
def extended_timeout_milliseconds(self):
323
"Return the 'extended_timeout' attribute in milliseconds"
324
return self._timedelta_to_milliseconds(self.extended_timeout)
326
def interval_milliseconds(self):
327
"Return the 'interval' attribute in milliseconds"
328
return self._timedelta_to_milliseconds(self.interval)
330
def approval_delay_milliseconds(self):
331
return self._timedelta_to_milliseconds(self.approval_delay)
333
def __init__(self, name = None, disable_hook=None, config=None):
334
"""Note: the 'checker' key in 'config' sets the
335
'checker_command' attribute and *not* the 'checker'
938
if server_settings is None:
940
self.server_settings = server_settings
941
# adding all client settings
942
for setting, value in settings.items():
943
setattr(self, setting, value)
946
if not hasattr(self, "last_enabled"):
947
self.last_enabled = datetime.datetime.utcnow()
948
if not hasattr(self, "expires"):
949
self.expires = (datetime.datetime.utcnow()
952
self.last_enabled = None
955
340
logger.debug("Creating client %r", self.name)
956
logger.debug(" Key ID: %s", self.key_id)
341
# Uppercase and remove spaces from fingerprint for later
342
# comparison purposes with return value from the fingerprint()
344
self.fingerprint = (config["fingerprint"].upper()
957
346
logger.debug(" Fingerprint: %s", self.fingerprint)
958
self.created = settings.get("created",
959
datetime.datetime.utcnow())
961
# attributes specific for this server instance
347
if "secret" in config:
348
self.secret = config["secret"].decode("base64")
349
elif "secfile" in config:
350
with open(os.path.expanduser(os.path.expandvars
351
(config["secfile"])),
353
self.secret = secfile.read()
355
raise TypeError("No secret or secfile for client %s"
357
self.host = config.get("host", "")
358
self.created = datetime.datetime.utcnow()
360
self.last_approval_request = None
361
self.last_enabled = None
362
self.last_checked_ok = None
363
self.timeout = string_to_delta(config["timeout"])
364
self.extended_timeout = string_to_delta(config["extended_timeout"])
365
self.interval = string_to_delta(config["interval"])
366
self.disable_hook = disable_hook
962
367
self.checker = None
963
368
self.checker_initiator_tag = None
964
369
self.disable_initiator_tag = None
965
371
self.checker_callback_tag = None
372
self.checker_command = config["checker"]
966
373
self.current_checker_command = None
374
self.last_connect = None
375
self._approved = None
376
self.approved_by_default = config.get("approved_by_default",
968
378
self.approvals_pending = 0
969
self.changedstate = multiprocessing_manager.Condition(
970
multiprocessing_manager.Lock())
971
self.client_structure = [attr
972
for attr in self.__dict__.keys()
973
if not attr.startswith("_")]
974
self.client_structure.append("client_structure")
976
for name, t in inspect.getmembers(
977
type(self), lambda obj: isinstance(obj, property)):
978
if not name.startswith("_"):
979
self.client_structure.append(name)
981
# Send notice to process children that client state has changed
379
self.approval_delay = string_to_delta(
380
config["approval_delay"])
381
self.approval_duration = string_to_delta(
382
config["approval_duration"])
383
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
982
385
def send_changedstate(self):
983
with self.changedstate:
984
self.changedstate.notify_all()
386
self.changedstate.acquire()
387
self.changedstate.notify_all()
388
self.changedstate.release()
986
390
def enable(self):
987
391
"""Start this client's checker and timeout hooks"""
988
392
if getattr(self, "enabled", False):
989
393
# Already enabled
395
self.send_changedstate()
396
self.last_enabled = datetime.datetime.utcnow()
397
# Schedule a new checker to be started an 'interval' from now,
398
# and every interval from then on.
399
self.checker_initiator_tag = (gobject.timeout_add
400
(self.interval_milliseconds(),
402
# Schedule a disable() when 'timeout' has passed
991
403
self.expires = datetime.datetime.utcnow() + self.timeout
404
self.disable_initiator_tag = (gobject.timeout_add
405
(self.timeout_milliseconds(),
992
407
self.enabled = True
993
self.last_enabled = datetime.datetime.utcnow()
995
self.send_changedstate()
408
# Also start a new checker *right now*.
997
411
def disable(self, quiet=True):
998
412
"""Disable this client."""
999
413
if not getattr(self, "enabled", False):
416
self.send_changedstate()
1002
418
logger.info("Disabling client %s", self.name)
1003
if getattr(self, "disable_initiator_tag", None) is not None:
1004
GLib.source_remove(self.disable_initiator_tag)
419
if getattr(self, "disable_initiator_tag", False):
420
gobject.source_remove(self.disable_initiator_tag)
1005
421
self.disable_initiator_tag = None
1006
422
self.expires = None
1007
if getattr(self, "checker_initiator_tag", None) is not None:
1008
GLib.source_remove(self.checker_initiator_tag)
423
if getattr(self, "checker_initiator_tag", False):
424
gobject.source_remove(self.checker_initiator_tag)
1009
425
self.checker_initiator_tag = None
1010
426
self.stop_checker()
427
if self.disable_hook:
428
self.disable_hook(self)
1011
429
self.enabled = False
1013
self.send_changedstate()
1014
# Do not run this again if called by a GLib.timeout_add
430
# Do not run this again if called by a gobject.timeout_add
1017
433
def __del__(self):
434
self.disable_hook = None
1020
def init_checker(self):
1021
# Schedule a new checker to be started an 'interval' from now,
1022
# and every interval from then on.
1023
if self.checker_initiator_tag is not None:
1024
GLib.source_remove(self.checker_initiator_tag)
1025
self.checker_initiator_tag = GLib.timeout_add(
1026
int(self.interval.total_seconds() * 1000),
1028
# Schedule a disable() when 'timeout' has passed
1029
if self.disable_initiator_tag is not None:
1030
GLib.source_remove(self.disable_initiator_tag)
1031
self.disable_initiator_tag = GLib.timeout_add(
1032
int(self.timeout.total_seconds() * 1000), self.disable)
1033
# Also start a new checker *right now*.
1034
self.start_checker()
1036
def checker_callback(self, source, condition, connection,
437
def checker_callback(self, pid, condition, command):
1038
438
"""The checker has completed, so take appropriate actions."""
1039
439
self.checker_callback_tag = None
1040
440
self.checker = None
1041
# Read return code from connection (see call_pipe)
1042
returncode = connection.recv()
1046
self.last_checker_status = returncode
1047
self.last_checker_signal = None
1048
if self.last_checker_status == 0:
441
if os.WIFEXITED(condition):
442
exitstatus = os.WEXITSTATUS(condition)
1049
444
logger.info("Checker for %(name)s succeeded",
1051
446
self.checked_ok()
1053
logger.info("Checker for %(name)s failed", vars(self))
448
logger.info("Checker for %(name)s failed",
1055
self.last_checker_status = -1
1056
self.last_checker_signal = -returncode
1057
451
logger.warning("Checker for %(name)s crashed?",
1061
def checked_ok(self):
1062
"""Assert that the client has been seen, alive and well."""
1063
self.last_checked_ok = datetime.datetime.utcnow()
1064
self.last_checker_status = 0
1065
self.last_checker_signal = None
1068
def bump_timeout(self, timeout=None):
1069
"""Bump up the timeout for this client."""
454
def checked_ok(self, timeout=None):
455
"""Bump up the timeout for this client.
457
This should only be called when the client has been seen,
1070
460
if timeout is None:
1071
461
timeout = self.timeout
1072
if self.disable_initiator_tag is not None:
1073
GLib.source_remove(self.disable_initiator_tag)
1074
self.disable_initiator_tag = None
1075
if getattr(self, "enabled", False):
1076
self.disable_initiator_tag = GLib.timeout_add(
1077
int(timeout.total_seconds() * 1000), self.disable)
1078
self.expires = datetime.datetime.utcnow() + timeout
462
self.last_checked_ok = datetime.datetime.utcnow()
463
gobject.source_remove(self.disable_initiator_tag)
464
self.expires = datetime.datetime.utcnow() + timeout
465
self.disable_initiator_tag = (gobject.timeout_add
466
(self._timedelta_to_milliseconds(timeout),
1080
469
def need_approval(self):
1081
470
self.last_approval_request = datetime.datetime.utcnow()
1083
472
def start_checker(self):
1084
473
"""Start a new checker subprocess if one is not running.
1086
475
If a checker already exists, leave it running and do
1088
477
# The reason for not killing a running checker is that if we
1089
# did that, and if a checker (for some reason) started running
1090
# slowly and taking more than 'interval' time, then the client
1091
# would inevitably timeout, since no checker would get a
1092
# chance to run to completion. If we instead leave running
478
# did that, then if a checker (for some reason) started
479
# running slowly and taking more than 'interval' time, the
480
# client would inevitably timeout, since no checker would get
481
# a chance to run to completion. If we instead leave running
1093
482
# checkers alone, the checker would have to take more time
1094
483
# than 'timeout' for the client to be disabled, which is as it
1097
if self.checker is not None and not self.checker.is_alive():
1098
logger.warning("Checker was not alive; joining")
486
# If a checker exists, make sure it is not a zombie
488
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
489
except (AttributeError, OSError) as error:
490
if (isinstance(error, OSError)
491
and error.errno != errno.ECHILD):
495
logger.warning("Checker was a zombie")
496
gobject.source_remove(self.checker_callback_tag)
497
self.checker_callback(pid, status,
498
self.current_checker_command)
1101
499
# Start a new checker if needed
1102
500
if self.checker is None:
1103
# Escape attributes for the shell
1105
attr: re.escape(str(getattr(self, attr)))
1106
for attr in self.runtime_expansions}
1108
command = self.checker_command % escaped_attrs
1109
except TypeError as error:
1110
logger.error('Could not format string "%s"',
1111
self.checker_command,
1113
return True # Try again later
502
# In case checker_command has exactly one % operator
503
command = self.checker_command % self.host
505
# Escape attributes for the shell
506
escaped_attrs = dict(
508
re.escape(unicode(str(getattr(self, attr, "")),
512
self.runtime_expansions)
515
command = self.checker_command % escaped_attrs
516
except TypeError as error:
517
logger.error('Could not format string "%s":'
518
' %s', self.checker_command, error)
519
return True # Try again later
1114
520
self.current_checker_command = command
1115
logger.info("Starting checker %r for %s", command,
1117
# We don't need to redirect stdout and stderr, since
1118
# in normal mode, that is already done by daemon(),
1119
# and in debug mode we don't want to. (Stdin is
1120
# always replaced by /dev/null.)
1121
# The exception is when not debugging but nevertheless
1122
# running in the foreground; use the previously
1124
popen_args = {"close_fds": True,
1127
if (not self.server_settings["debug"]
1128
and self.server_settings["foreground"]):
1129
popen_args.update({"stdout": wnull,
1131
pipe = multiprocessing.Pipe(duplex=False)
1132
self.checker = multiprocessing.Process(
1134
args=(pipe[1], subprocess.call, command),
1136
self.checker.start()
1137
self.checker_callback_tag = GLib.io_add_watch(
1138
pipe[0].fileno(), GLib.IO_IN,
1139
self.checker_callback, pipe[0], command)
1140
# Re-run this periodically if run by GLib.timeout_add
522
logger.info("Starting checker %r for %s",
524
# We don't need to redirect stdout and stderr, since
525
# in normal mode, that is already done by daemon(),
526
# and in debug mode we don't want to. (Stdin is
527
# always replaced by /dev/null.)
528
self.checker = subprocess.Popen(command,
531
self.checker_callback_tag = (gobject.child_watch_add
533
self.checker_callback,
535
# The checker may have completed before the gobject
536
# watch was added. Check for this.
537
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
539
gobject.source_remove(self.checker_callback_tag)
540
self.checker_callback(pid, status, command)
541
except OSError as error:
542
logger.error("Failed to start subprocess: %s",
544
# Re-run this periodically if run by gobject.timeout_add
1143
547
def stop_checker(self):
1144
548
"""Force the checker process, if any, to stop."""
1145
549
if self.checker_callback_tag:
1146
GLib.source_remove(self.checker_callback_tag)
550
gobject.source_remove(self.checker_callback_tag)
1147
551
self.checker_callback_tag = None
1148
552
if getattr(self, "checker", None) is None:
1150
554
logger.debug("Stopping checker for %(name)s", vars(self))
1151
self.checker.terminate()
556
os.kill(self.checker.pid, signal.SIGTERM)
558
#if self.checker.poll() is None:
559
# os.kill(self.checker.pid, signal.SIGKILL)
560
except OSError as error:
561
if error.errno != errno.ESRCH: # No such process
1152
563
self.checker = None
1155
def dbus_service_property(dbus_interface,
565
def dbus_service_property(dbus_interface, signature="v",
566
access="readwrite", byte_arrays=False):
1159
567
"""Decorators for marking methods of a DBusObjectWithProperties to
1160
568
become properties on the D-Bus.
1162
570
The decorated method will be called with no arguments by "Get"
1163
571
and with one argument by "Set".
1165
573
The parameters, where they are supported, are the same as
1166
574
dbus.service.method, except there is only "signature", since the
1167
575
type from Get() and the type sent to Set() is the same.
1500
747
except (AttributeError, xml.dom.DOMException,
1501
748
xml.parsers.expat.ExpatError) as error:
1502
749
logger.error("Failed to override Introspection method",
1508
dbus.OBJECT_MANAGER_IFACE
1509
except AttributeError:
1510
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1513
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1514
"""A D-Bus object with an ObjectManager.
1516
Classes inheriting from this exposes the standard
1517
GetManagedObjects call and the InterfacesAdded and
1518
InterfacesRemoved signals on the standard
1519
"org.freedesktop.DBus.ObjectManager" interface.
1521
Note: No signals are sent automatically; they must be sent
1524
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1525
out_signature="a{oa{sa{sv}}}")
1526
def GetManagedObjects(self):
1527
"""This function must be overridden"""
1528
raise NotImplementedError()
1530
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1531
signature="oa{sa{sv}}")
1532
def InterfacesAdded(self, object_path, interfaces_and_properties):
1535
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1536
def InterfacesRemoved(self, object_path, interfaces):
1539
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1541
path_keyword='object_path',
1542
connection_keyword='connection')
1543
def Introspect(self, object_path, connection):
1544
"""Overloading of standard D-Bus method.
1546
Override return argument name of GetManagedObjects to be
1547
"objpath_interfaces_and_properties"
1549
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1553
document = xml.dom.minidom.parseString(xmlstring)
1555
for if_tag in document.getElementsByTagName("interface"):
1556
# Fix argument name for the GetManagedObjects method
1557
if (if_tag.getAttribute("name")
1558
== dbus.OBJECT_MANAGER_IFACE):
1559
for cn in if_tag.getElementsByTagName("method"):
1560
if (cn.getAttribute("name")
1561
== "GetManagedObjects"):
1562
for arg in cn.getElementsByTagName("arg"):
1563
if (arg.getAttribute("direction")
1567
"objpath_interfaces"
1569
xmlstring = document.toxml("utf-8")
1571
except (AttributeError, xml.dom.DOMException,
1572
xml.parsers.expat.ExpatError) as error:
1573
logger.error("Failed to override Introspection method",
1578
def datetime_to_dbus(dt, variant_level=0):
1579
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1581
return dbus.String("", variant_level=variant_level)
1582
return dbus.String(dt.isoformat(), variant_level=variant_level)
1585
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1586
"""A class decorator; applied to a subclass of
1587
dbus.service.Object, it will add alternate D-Bus attributes with
1588
interface names according to the "alt_interface_names" mapping.
1591
@alternate_dbus_interfaces({"org.example.Interface":
1592
"net.example.AlternateInterface"})
1593
class SampleDBusObject(dbus.service.Object):
1594
@dbus.service.method("org.example.Interface")
1595
def SampleDBusMethod():
1598
The above "SampleDBusMethod" on "SampleDBusObject" will be
1599
reachable via two interfaces: "org.example.Interface" and
1600
"net.example.AlternateInterface", the latter of which will have
1601
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1602
"true", unless "deprecate" is passed with a False value.
1604
This works for methods and signals, and also for D-Bus properties
1605
(from DBusObjectWithProperties) and interfaces (from the
1606
dbus_interface_annotations decorator).
1610
for orig_interface_name, alt_interface_name in (
1611
alt_interface_names.items()):
1613
interface_names = set()
1614
# Go though all attributes of the class
1615
for attrname, attribute in inspect.getmembers(cls):
1616
# Ignore non-D-Bus attributes, and D-Bus attributes
1617
# with the wrong interface name
1618
if (not hasattr(attribute, "_dbus_interface")
1619
or not attribute._dbus_interface.startswith(
1620
orig_interface_name)):
1622
# Create an alternate D-Bus interface name based on
1624
alt_interface = attribute._dbus_interface.replace(
1625
orig_interface_name, alt_interface_name)
1626
interface_names.add(alt_interface)
1627
# Is this a D-Bus signal?
1628
if getattr(attribute, "_dbus_is_signal", False):
1629
# Extract the original non-method undecorated
1630
# function by black magic
1631
if sys.version_info.major == 2:
1632
nonmethod_func = (dict(
1633
zip(attribute.func_code.co_freevars,
1634
attribute.__closure__))
1635
["func"].cell_contents)
1637
nonmethod_func = (dict(
1638
zip(attribute.__code__.co_freevars,
1639
attribute.__closure__))
1640
["func"].cell_contents)
1641
# Create a new, but exactly alike, function
1642
# object, and decorate it to be a new D-Bus signal
1643
# with the alternate D-Bus interface name
1644
new_function = copy_function(nonmethod_func)
1645
new_function = (dbus.service.signal(
1647
attribute._dbus_signature)(new_function))
1648
# Copy annotations, if any
1650
new_function._dbus_annotations = dict(
1651
attribute._dbus_annotations)
1652
except AttributeError:
1655
# Define a creator of a function to call both the
1656
# original and alternate functions, so both the
1657
# original and alternate signals gets sent when
1658
# the function is called
1659
def fixscope(func1, func2):
1660
"""This function is a scope container to pass
1661
func1 and func2 to the "call_both" function
1662
outside of its arguments"""
1664
@functools.wraps(func2)
1665
def call_both(*args, **kwargs):
1666
"""This function will emit two D-Bus
1667
signals by calling func1 and func2"""
1668
func1(*args, **kwargs)
1669
func2(*args, **kwargs)
1670
# Make wrapper function look like a D-Bus
1672
for name, attr in inspect.getmembers(func2):
1673
if name.startswith("_dbus_"):
1674
setattr(call_both, name, attr)
1677
# Create the "call_both" function and add it to
1679
attr[attrname] = fixscope(attribute, new_function)
1680
# Is this a D-Bus method?
1681
elif getattr(attribute, "_dbus_is_method", False):
1682
# Create a new, but exactly alike, function
1683
# object. Decorate it to be a new D-Bus method
1684
# with the alternate D-Bus interface name. Add it
1687
dbus.service.method(
1689
attribute._dbus_in_signature,
1690
attribute._dbus_out_signature)
1691
(copy_function(attribute)))
1692
# Copy annotations, if any
1694
attr[attrname]._dbus_annotations = dict(
1695
attribute._dbus_annotations)
1696
except AttributeError:
1698
# Is this a D-Bus property?
1699
elif getattr(attribute, "_dbus_is_property", False):
1700
# Create a new, but exactly alike, function
1701
# object, and decorate it to be a new D-Bus
1702
# property with the alternate D-Bus interface
1703
# name. Add it to the class.
1704
attr[attrname] = (dbus_service_property(
1705
alt_interface, attribute._dbus_signature,
1706
attribute._dbus_access,
1707
attribute._dbus_get_args_options
1709
(copy_function(attribute)))
1710
# Copy annotations, if any
1712
attr[attrname]._dbus_annotations = dict(
1713
attribute._dbus_annotations)
1714
except AttributeError:
1716
# Is this a D-Bus interface?
1717
elif getattr(attribute, "_dbus_is_interface", False):
1718
# Create a new, but exactly alike, function
1719
# object. Decorate it to be a new D-Bus interface
1720
# with the alternate D-Bus interface name. Add it
1723
dbus_interface_annotations(alt_interface)
1724
(copy_function(attribute)))
1726
# Deprecate all alternate interfaces
1727
iname = "_AlternateDBusNames_interface_annotation{}"
1728
for interface_name in interface_names:
1730
@dbus_interface_annotations(interface_name)
1732
return {"org.freedesktop.DBus.Deprecated":
1734
# Find an unused name
1735
for aname in (iname.format(i)
1736
for i in itertools.count()):
1737
if aname not in attr:
1741
# Replace the class with a new subclass of it with
1742
# methods, signals, etc. as created above.
1743
if sys.version_info.major == 2:
1744
cls = type(b"{}Alternate".format(cls.__name__),
1747
cls = type("{}Alternate".format(cls.__name__),
1754
@alternate_dbus_interfaces({"se.recompile.Mandos":
1755
"se.bsnet.fukt.Mandos"})
1756
754
class ClientDBus(Client, DBusObjectWithProperties):
1757
755
"""A Client class using D-Bus
1760
758
dbus_object_path: dbus.ObjectPath
1761
759
bus: dbus.SystemBus()
1764
762
runtime_expansions = (Client.runtime_expansions
1765
+ ("dbus_object_path", ))
1767
_interface = "se.recompile.Mandos.Client"
763
+ ("dbus_object_path",))
1769
765
# dbus.service.Object doesn't use super(), so we can't either.
1771
def __init__(self, bus=None, *args, **kwargs):
767
def __init__(self, bus = None, *args, **kwargs):
768
self._approvals_pending = 0
1773
770
Client.__init__(self, *args, **kwargs)
1774
771
# Only now, when this client is initialized, can it show up on
1776
client_object_name = str(self.name).translate(
773
client_object_name = unicode(self.name).translate(
1777
774
{ord("."): ord("_"),
1778
775
ord("-"): ord("_")})
1779
self.dbus_object_path = dbus.ObjectPath(
1780
"/clients/" + client_object_name)
776
self.dbus_object_path = (dbus.ObjectPath
777
("/clients/" + client_object_name))
1781
778
DBusObjectWithProperties.__init__(self, self.bus,
1782
779
self.dbus_object_path)
1784
def notifychangeproperty(transform_func, dbus_name,
1785
type_func=lambda x: x,
1787
invalidate_only=False,
1788
_interface=_interface):
1789
""" Modify a variable so that it's a property which announces
1790
its changes to DBus.
1792
transform_fun: Function that takes a value and a variant_level
1793
and transforms it to a D-Bus type.
1794
dbus_name: D-Bus name of the variable
1795
type_func: Function that transform the value before sending it
1796
to the D-Bus. Default: no transform
1797
variant_level: D-Bus variant level. Default: 1
1799
attrname = "_{}".format(dbus_name)
1801
def setter(self, value):
1802
if hasattr(self, "dbus_object_path"):
1803
if (not hasattr(self, attrname) or
1804
type_func(getattr(self, attrname, None))
1805
!= type_func(value)):
1807
self.PropertiesChanged(
1808
_interface, dbus.Dictionary(),
1809
dbus.Array((dbus_name, )))
1811
dbus_value = transform_func(
1813
variant_level=variant_level)
1814
self.PropertyChanged(dbus.String(dbus_name),
1816
self.PropertiesChanged(
1818
dbus.Dictionary({dbus.String(dbus_name):
1821
setattr(self, attrname, value)
1823
return property(lambda self: getattr(self, attrname), setter)
1825
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1826
approvals_pending = notifychangeproperty(dbus.Boolean,
1829
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1830
last_enabled = notifychangeproperty(datetime_to_dbus,
1832
checker = notifychangeproperty(
1833
dbus.Boolean, "CheckerRunning",
1834
type_func=lambda checker: checker is not None)
1835
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1837
last_checker_status = notifychangeproperty(dbus.Int16,
1838
"LastCheckerStatus")
1839
last_approval_request = notifychangeproperty(
1840
datetime_to_dbus, "LastApprovalRequest")
1841
approved_by_default = notifychangeproperty(dbus.Boolean,
1842
"ApprovedByDefault")
1843
approval_delay = notifychangeproperty(
1844
dbus.UInt64, "ApprovalDelay",
1845
type_func=lambda td: td.total_seconds() * 1000)
1846
approval_duration = notifychangeproperty(
1847
dbus.UInt64, "ApprovalDuration",
1848
type_func=lambda td: td.total_seconds() * 1000)
1849
host = notifychangeproperty(dbus.String, "Host")
1850
timeout = notifychangeproperty(
1851
dbus.UInt64, "Timeout",
1852
type_func=lambda td: td.total_seconds() * 1000)
1853
extended_timeout = notifychangeproperty(
1854
dbus.UInt64, "ExtendedTimeout",
1855
type_func=lambda td: td.total_seconds() * 1000)
1856
interval = notifychangeproperty(
1857
dbus.UInt64, "Interval",
1858
type_func=lambda td: td.total_seconds() * 1000)
1859
checker_command = notifychangeproperty(dbus.String, "Checker")
1860
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1861
invalidate_only=True)
1863
del notifychangeproperty
780
def _set_expires(self, value):
781
old_value = getattr(self, "_expires", None)
782
self._expires = value
783
if hasattr(self, "dbus_object_path") and old_value != value:
784
dbus_time = (self._datetime_to_dbus(self._expires,
786
self.PropertyChanged(dbus.String("Expires"),
788
expires = property(lambda self: self._expires, _set_expires)
791
def _get_approvals_pending(self):
792
return self._approvals_pending
793
def _set_approvals_pending(self, value):
794
old_value = self._approvals_pending
795
self._approvals_pending = value
797
if (hasattr(self, "dbus_object_path")
798
and bval is not bool(old_value)):
799
dbus_bool = dbus.Boolean(bval, variant_level=1)
800
self.PropertyChanged(dbus.String("ApprovalPending"),
803
approvals_pending = property(_get_approvals_pending,
804
_set_approvals_pending)
805
del _get_approvals_pending, _set_approvals_pending
808
def _datetime_to_dbus(dt, variant_level=0):
809
"""Convert a UTC datetime.datetime() to a D-Bus type."""
811
return dbus.String("", variant_level = variant_level)
812
return dbus.String(dt.isoformat(),
813
variant_level=variant_level)
816
oldstate = getattr(self, "enabled", False)
817
r = Client.enable(self)
818
if oldstate != self.enabled:
820
self.PropertyChanged(dbus.String("Enabled"),
821
dbus.Boolean(True, variant_level=1))
822
self.PropertyChanged(
823
dbus.String("LastEnabled"),
824
self._datetime_to_dbus(self.last_enabled,
828
def disable(self, quiet = False):
829
oldstate = getattr(self, "enabled", False)
830
r = Client.disable(self, quiet=quiet)
831
if not quiet and oldstate != self.enabled:
833
self.PropertyChanged(dbus.String("Enabled"),
834
dbus.Boolean(False, variant_level=1))
1865
837
def __del__(self, *args, **kwargs):
1867
839
self.remove_from_connection()
2366
1368
delay -= time2 - time
2369
session.send(client.secret)
2370
except gnutls.Error as error:
2371
logger.warning("gnutls send failed",
1371
while sent_size < len(client.secret):
1373
sent = session.send(client.secret[sent_size:])
1374
except gnutls.errors.GNUTLSError as error:
1375
logger.warning("gnutls send failed")
1377
logger.debug("Sent: %d, remaining: %d",
1378
sent, len(client.secret)
1379
- (sent_size + sent))
2375
1382
logger.info("Sending secret to %s", client.name)
2376
# bump the timeout using extended_timeout
2377
client.bump_timeout(client.extended_timeout)
1383
# bump the timeout as if seen
1384
client.checked_ok(client.extended_timeout)
2378
1385
if self.server.use_dbus:
2379
1386
# Emit D-Bus signal
2380
1387
client.GotSecret()
2383
1390
if approval_required:
2384
1391
client.approvals_pending -= 1
2387
except gnutls.Error as error:
2388
logger.warning("GnuTLS bye failed",
1394
except gnutls.errors.GNUTLSError as error:
1395
logger.warning("GnuTLS bye failed")
2392
1398
def peer_certificate(session):
2393
"Return the peer's certificate as a bytestring"
2395
cert_type = gnutls.certificate_type_get2(session._c_object,
2397
except AttributeError:
2398
cert_type = gnutls.certificate_type_get(session._c_object)
2399
if gnutls.has_rawpk:
2400
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2402
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2403
# If not a valid certificate type...
2404
if cert_type not in valid_cert_types:
2405
logger.info("Cert type %r not in %r", cert_type,
2407
# ...return invalid data
1399
"Return the peer's OpenPGP certificate as a bytestring"
1400
# If not an OpenPGP certificate...
1401
if (gnutls.library.functions
1402
.gnutls_certificate_type_get(session._c_object)
1403
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1404
# ...do the normal thing
1405
return session.peer_certificate
2409
1406
list_size = ctypes.c_uint(1)
2410
cert_list = (gnutls.certificate_get_peers
1407
cert_list = (gnutls.library.functions
1408
.gnutls_certificate_get_peers
2411
1409
(session._c_object, ctypes.byref(list_size)))
2412
1410
if not bool(cert_list) and list_size.value != 0:
2413
raise gnutls.Error("error getting peer certificate")
1411
raise gnutls.errors.GNUTLSError("error getting peer"
2414
1413
if list_size.value == 0:
2416
1415
cert = cert_list[0]
2417
1416
return ctypes.string_at(cert.data, cert.size)
2420
def key_id(certificate):
2421
"Convert a certificate bytestring to a hexdigit key ID"
2422
# New GnuTLS "datum" with the public key
2423
datum = gnutls.datum_t(
2424
ctypes.cast(ctypes.c_char_p(certificate),
2425
ctypes.POINTER(ctypes.c_ubyte)),
2426
ctypes.c_uint(len(certificate)))
2427
# XXX all these need to be created in the gnutls "module"
2428
# New empty GnuTLS certificate
2429
pubkey = gnutls.pubkey_t()
2430
gnutls.pubkey_init(ctypes.byref(pubkey))
2431
# Import the raw public key into the certificate
2432
gnutls.pubkey_import(pubkey,
2433
ctypes.byref(datum),
2434
gnutls.X509_FMT_DER)
2435
# New buffer for the key ID
2436
buf = ctypes.create_string_buffer(32)
2437
buf_len = ctypes.c_size_t(len(buf))
2438
# Get the key ID from the raw public key into the buffer
2439
gnutls.pubkey_get_key_id(pubkey,
2440
gnutls.KEYID_USE_SHA256,
2441
ctypes.cast(ctypes.byref(buf),
2442
ctypes.POINTER(ctypes.c_ubyte)),
2443
ctypes.byref(buf_len))
2444
# Deinit the certificate
2445
gnutls.pubkey_deinit(pubkey)
2447
# Convert the buffer to a Python bytestring
2448
key_id = ctypes.string_at(buf, buf_len.value)
2449
# Convert the bytestring to hexadecimal notation
2450
hex_key_id = binascii.hexlify(key_id).upper()
2454
1419
def fingerprint(openpgp):
2455
1420
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2456
1421
# New GnuTLS "datum" with the OpenPGP public key
2457
datum = gnutls.datum_t(
2458
ctypes.cast(ctypes.c_char_p(openpgp),
2459
ctypes.POINTER(ctypes.c_ubyte)),
2460
ctypes.c_uint(len(openpgp)))
1422
datum = (gnutls.library.types
1423
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1426
ctypes.c_uint(len(openpgp))))
2461
1427
# New empty GnuTLS certificate
2462
crt = gnutls.openpgp_crt_t()
2463
gnutls.openpgp_crt_init(ctypes.byref(crt))
1428
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1429
(gnutls.library.functions
1430
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2464
1431
# Import the OpenPGP public key into the certificate
2465
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2466
gnutls.OPENPGP_FMT_RAW)
1432
(gnutls.library.functions
1433
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1434
gnutls.library.constants
1435
.GNUTLS_OPENPGP_FMT_RAW))
2467
1436
# Verify the self signature in the key
2468
1437
crtverify = ctypes.c_uint()
2469
gnutls.openpgp_crt_verify_self(crt, 0,
2470
ctypes.byref(crtverify))
1438
(gnutls.library.functions
1439
.gnutls_openpgp_crt_verify_self(crt, 0,
1440
ctypes.byref(crtverify)))
2471
1441
if crtverify.value != 0:
2472
gnutls.openpgp_crt_deinit(crt)
2473
raise gnutls.CertificateSecurityError(code
1442
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1443
raise (gnutls.errors.CertificateSecurityError
2475
1445
# New buffer for the fingerprint
2476
1446
buf = ctypes.create_string_buffer(20)
2477
1447
buf_len = ctypes.c_size_t()
2478
1448
# Get the fingerprint from the certificate into the buffer
2479
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2480
ctypes.byref(buf_len))
1449
(gnutls.library.functions
1450
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1451
ctypes.byref(buf_len)))
2481
1452
# Deinit the certificate
2482
gnutls.openpgp_crt_deinit(crt)
1453
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2483
1454
# Convert the buffer to a Python bytestring
2484
1455
fpr = ctypes.string_at(buf, buf_len.value)
2485
1456
# Convert the bytestring to hexadecimal notation
2486
hex_fpr = binascii.hexlify(fpr).upper()
1457
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2490
1461
class MultiprocessingMixIn(object):
2491
1462
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2493
1463
def sub_process_main(self, request, address):
2495
1465
self.finish_request(request, address)
2497
1467
self.handle_error(request, address)
2498
1468
self.close_request(request)
2500
1470
def process_request(self, request, address):
2501
1471
"""Start a new process to process the request."""
2502
proc = multiprocessing.Process(target=self.sub_process_main,
2503
args=(request, address))
1472
multiprocessing.Process(target = self.sub_process_main,
1473
args = (request, address)).start()
2508
1475
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2509
1476
""" adds a pipe to the MixIn """
2511
1477
def process_request(self, request, client_address):
2512
1478
"""Overrides and wraps the original process_request().
2514
1480
This function creates a new pipe in self.pipe
2516
1482
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2518
proc = MultiprocessingMixIn.process_request(self, request,
1484
super(MultiprocessingMixInWithPipe,
1485
self).process_request(request, client_address)
2520
1486
self.child_pipe.close()
2521
self.add_pipe(parent_pipe, proc)
1487
self.add_pipe(parent_pipe)
2523
def add_pipe(self, parent_pipe, proc):
1489
def add_pipe(self, parent_pipe):
2524
1490
"""Dummy function; override as necessary"""
2525
raise NotImplementedError()
1491
raise NotImplementedError
2528
1493
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2529
1494
socketserver.TCPServer, object):
2530
1495
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2533
1498
enabled: Boolean; whether this server is activated yet
2534
1499
interface: None or a network interface name (string)
2535
1500
use_ipv6: Boolean; to use IPv6 or not
2538
1502
def __init__(self, server_address, RequestHandlerClass,
2542
"""If socketfd is set, use that file descriptor instead of
2543
creating a new one with socket.socket().
1503
interface=None, use_ipv6=True):
2545
1504
self.interface = interface
2547
1506
self.address_family = socket.AF_INET6
2548
if socketfd is not None:
2549
# Save the file descriptor
2550
self.socketfd = socketfd
2551
# Save the original socket.socket() function
2552
self.socket_socket = socket.socket
2554
# To implement --socket, we monkey patch socket.socket.
2556
# (When socketserver.TCPServer is a new-style class, we
2557
# could make self.socket into a property instead of monkey
2558
# patching socket.socket.)
2560
# Create a one-time-only replacement for socket.socket()
2561
@functools.wraps(socket.socket)
2562
def socket_wrapper(*args, **kwargs):
2563
# Restore original function so subsequent calls are
2565
socket.socket = self.socket_socket
2566
del self.socket_socket
2567
# This time only, return a new socket object from the
2568
# saved file descriptor.
2569
return socket.fromfd(self.socketfd, *args, **kwargs)
2570
# Replace socket.socket() function with wrapper
2571
socket.socket = socket_wrapper
2572
# The socketserver.TCPServer.__init__ will call
2573
# socket.socket(), which might be our replacement,
2574
# socket_wrapper(), if socketfd was set.
2575
1507
socketserver.TCPServer.__init__(self, server_address,
2576
1508
RequestHandlerClass)
2578
1509
def server_bind(self):
2579
1510
"""This overrides the normal server_bind() function
2580
1511
to bind to an interface if one was specified, and also NOT to
2581
1512
bind to an address or port if they were not specified."""
2582
global SO_BINDTODEVICE
2583
1513
if self.interface is not None:
2584
1514
if SO_BINDTODEVICE is None:
2585
# Fall back to a hard-coded value which seems to be
2587
logger.warning("SO_BINDTODEVICE not found, trying 25")
2588
SO_BINDTODEVICE = 25
2590
self.socket.setsockopt(
2591
socket.SOL_SOCKET, SO_BINDTODEVICE,
2592
(self.interface + "\0").encode("utf-8"))
2593
except socket.error as error:
2594
if error.errno == errno.EPERM:
2595
logger.error("No permission to bind to"
2596
" interface %s", self.interface)
2597
elif error.errno == errno.ENOPROTOOPT:
2598
logger.error("SO_BINDTODEVICE not available;"
2599
" cannot bind to interface %s",
2601
elif error.errno == errno.ENODEV:
2602
logger.error("Interface %s does not exist,"
2603
" cannot bind", self.interface)
1515
logger.error("SO_BINDTODEVICE does not exist;"
1516
" cannot bind to interface %s",
1520
self.socket.setsockopt(socket.SOL_SOCKET,
1524
except socket.error as error:
1525
if error[0] == errno.EPERM:
1526
logger.error("No permission to"
1527
" bind to interface %s",
1529
elif error[0] == errno.ENOPROTOOPT:
1530
logger.error("SO_BINDTODEVICE not available;"
1531
" cannot bind to interface %s",
2606
1535
# Only bind(2) the socket if we really need to.
2607
1536
if self.server_address[0] or self.server_address[1]:
2608
1537
if not self.server_address[0]:
2609
1538
if self.address_family == socket.AF_INET6:
2610
any_address = "::" # in6addr_any
1539
any_address = "::" # in6addr_any
2612
any_address = "0.0.0.0" # INADDR_ANY
1541
any_address = socket.INADDR_ANY
2613
1542
self.server_address = (any_address,
2614
1543
self.server_address[1])
2615
1544
elif not self.server_address[1]:
2616
self.server_address = (self.server_address[0], 0)
1545
self.server_address = (self.server_address[0],
2617
1547
# if self.interface:
2618
1548
# self.server_address = (self.server_address[0],
2946
1780
parser.add_argument("--no-dbus", action="store_false",
2947
1781
dest="use_dbus", help="Do not provide D-Bus"
2948
" system bus interface", default=None)
1782
" system bus interface")
2949
1783
parser.add_argument("--no-ipv6", action="store_false",
2950
dest="use_ipv6", help="Do not use IPv6",
2952
parser.add_argument("--no-restore", action="store_false",
2953
dest="restore", help="Do not restore stored"
2954
" state", default=None)
2955
parser.add_argument("--socket", type=int,
2956
help="Specify a file descriptor to a network"
2957
" socket to use instead of creating one")
2958
parser.add_argument("--statedir", metavar="DIR",
2959
help="Directory to save/restore state in")
2960
parser.add_argument("--foreground", action="store_true",
2961
help="Run in foreground", default=None)
2962
parser.add_argument("--no-zeroconf", action="store_false",
2963
dest="zeroconf", help="Do not use Zeroconf",
1784
dest="use_ipv6", help="Do not use IPv6")
2966
1785
options = parser.parse_args()
2968
1787
if options.check:
2970
fail_count, test_count = doctest.testmod()
2971
sys.exit(os.EX_OK if fail_count == 0 else 1)
2973
1792
# Default values for config file for server-global settings
2974
if gnutls.has_rawpk:
2975
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2976
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2978
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2979
":+SIGN-DSA-SHA256")
2980
server_defaults = {"interface": "",
2984
"priority": priority,
2985
"servicename": "Mandos",
2991
"statedir": "/var/lib/mandos",
2992
"foreground": "False",
1793
server_defaults = { "interface": "",
1798
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1799
"servicename": "Mandos",
2997
1805
# Parse config file for server-global settings
2998
1806
server_config = configparser.SafeConfigParser(server_defaults)
2999
1807
del server_defaults
3000
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1808
server_config.read(os.path.join(options.configdir,
3001
1810
# Convert the SafeConfigParser object to a dict
3002
1811
server_settings = server_config.defaults()
3003
1812
# Use the appropriate methods on the non-string config options
3004
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3005
"foreground", "zeroconf"):
1813
for option in ("debug", "use_dbus", "use_ipv6"):
3006
1814
server_settings[option] = server_config.getboolean("DEFAULT",
3008
1816
if server_settings["port"]:
3009
1817
server_settings["port"] = server_config.getint("DEFAULT",
3011
if server_settings["socket"]:
3012
server_settings["socket"] = server_config.getint("DEFAULT",
3014
# Later, stdin will, and stdout and stderr might, be dup'ed
3015
# over with an opened os.devnull. But we don't want this to
3016
# happen with a supplied network socket.
3017
if 0 <= server_settings["socket"] <= 2:
3018
server_settings["socket"] = os.dup(server_settings
3020
1819
del server_config
3022
1821
# Override the settings from the config file with command line
3023
1822
# options, if set.
3024
1823
for option in ("interface", "address", "port", "debug",
3025
"priority", "servicename", "configdir", "use_dbus",
3026
"use_ipv6", "debuglevel", "restore", "statedir",
3027
"socket", "foreground", "zeroconf"):
1824
"priority", "servicename", "configdir",
1825
"use_dbus", "use_ipv6", "debuglevel"):
3028
1826
value = getattr(options, option)
3029
1827
if value is not None:
3030
1828
server_settings[option] = value
3032
1830
# Force all strings to be unicode
3033
1831
for option in server_settings.keys():
3034
if isinstance(server_settings[option], bytes):
3035
server_settings[option] = (server_settings[option]
3037
# Force all boolean options to be boolean
3038
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3039
"foreground", "zeroconf"):
3040
server_settings[option] = bool(server_settings[option])
3041
# Debug implies foreground
3042
if server_settings["debug"]:
3043
server_settings["foreground"] = True
1832
if type(server_settings[option]) is str:
1833
server_settings[option] = unicode(server_settings[option])
3044
1834
# Now we have our good server settings in "server_settings"
3046
1836
##################################################################
3048
if (not server_settings["zeroconf"]
3049
and not (server_settings["port"]
3050
or server_settings["socket"] != "")):
3051
parser.error("Needs port or socket to work without Zeroconf")
3053
1838
# For convenience
3054
1839
debug = server_settings["debug"]
3055
1840
debuglevel = server_settings["debuglevel"]
3056
1841
use_dbus = server_settings["use_dbus"]
3057
1842
use_ipv6 = server_settings["use_ipv6"]
3058
stored_state_path = os.path.join(server_settings["statedir"],
3060
foreground = server_settings["foreground"]
3061
zeroconf = server_settings["zeroconf"]
3064
initlogger(debug, logging.DEBUG)
3069
level = getattr(logging, debuglevel.upper())
3070
initlogger(debug, level)
3072
1844
if server_settings["servicename"] != "Mandos":
3073
syslogger.setFormatter(
3074
logging.Formatter('Mandos ({}) [%(process)d]:'
3075
' %(levelname)s: %(message)s'.format(
3076
server_settings["servicename"])))
1845
syslogger.setFormatter(logging.Formatter
1846
('Mandos (%s) [%%(process)d]:'
1847
' %%(levelname)s: %%(message)s'
1848
% server_settings["servicename"]))
3078
1850
# Parse config file with clients
3079
client_config = configparser.SafeConfigParser(Client
1851
client_defaults = { "timeout": "5m",
1852
"extended_timeout": "15m",
1854
"checker": "fping -q -- %%(host)s",
1856
"approval_delay": "0s",
1857
"approval_duration": "1s",
1859
client_config = configparser.SafeConfigParser(client_defaults)
3081
1860
client_config.read(os.path.join(server_settings["configdir"],
3082
1861
"clients.conf"))
3084
1863
global mandos_dbus_service
3085
1864
mandos_dbus_service = None
3088
if server_settings["socket"] != "":
3089
socketfd = server_settings["socket"]
3090
tcp_server = MandosServer(
3091
(server_settings["address"], server_settings["port"]),
3093
interface=(server_settings["interface"] or None),
3095
gnutls_priority=server_settings["priority"],
3099
pidfilename = "/run/mandos.pid"
3100
if not os.path.isdir("/run/."):
3101
pidfilename = "/var/run/mandos.pid"
3104
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3105
except IOError as e:
3106
logger.error("Could not open file %r", pidfilename,
3109
for name, group in (("_mandos", "_mandos"),
3110
("mandos", "mandos"),
3111
("nobody", "nogroup")):
3113
uid = pwd.getpwnam(name).pw_uid
3114
gid = pwd.getpwnam(group).pw_gid
1866
tcp_server = MandosServer((server_settings["address"],
1867
server_settings["port"]),
1869
interface=(server_settings["interface"]
1873
server_settings["priority"],
1876
pidfilename = "/var/run/mandos.pid"
1878
pidfile = open(pidfilename, "w")
1880
logger.error("Could not open file %r", pidfilename)
1883
uid = pwd.getpwnam("_mandos").pw_uid
1884
gid = pwd.getpwnam("_mandos").pw_gid
1887
uid = pwd.getpwnam("mandos").pw_uid
1888
gid = pwd.getpwnam("mandos").pw_gid
3116
1889
except KeyError:
1891
uid = pwd.getpwnam("nobody").pw_uid
1892
gid = pwd.getpwnam("nobody").pw_gid
3125
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3127
1899
except OSError as error:
3128
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3129
.format(uid, gid, os.strerror(error.errno)))
3130
if error.errno != errno.EPERM:
1900
if error[0] != errno.EPERM:
1903
if not debug and not debuglevel:
1904
syslogger.setLevel(logging.WARNING)
1905
console.setLevel(logging.WARNING)
1907
level = getattr(logging, debuglevel.upper())
1908
syslogger.setLevel(level)
1909
console.setLevel(level)
3134
1912
# Enable all possible GnuTLS debugging
3136
1914
# "Use a log level over 10 to enable all debugging options."
3137
1915
# - GnuTLS manual
3138
gnutls.global_set_log_level(11)
1916
gnutls.library.functions.gnutls_global_set_log_level(11)
1918
@gnutls.library.types.gnutls_log_func
3141
1919
def debug_gnutls(level, string):
3142
1920
logger.debug("GnuTLS: %s", string[:-1])
3144
gnutls.global_set_log_function(debug_gnutls)
1922
(gnutls.library.functions
1923
.gnutls_global_set_log_function(debug_gnutls))
3146
1925
# Redirect stdin so all checkers get /dev/null
3147
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1926
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3148
1927
os.dup2(null, sys.stdin.fileno())
1931
# No console logging
1932
logger.removeHandler(console)
3152
1934
# Need to fork before connecting to D-Bus
3154
1936
# Close all input and output, do double fork, etc.
3157
# multiprocessing will use threads, so before we use GLib we need
3158
# to inform GLib that threads will be used.
3161
1939
global main_loop
3162
1940
# From the Avahi example code
3163
DBusGMainLoop(set_as_default=True)
3164
main_loop = GLib.MainLoop()
1941
DBusGMainLoop(set_as_default=True )
1942
main_loop = gobject.MainLoop()
3165
1943
bus = dbus.SystemBus()
3166
1944
# End of Avahi example code
3169
bus_name = dbus.service.BusName("se.recompile.Mandos",
3172
old_bus_name = dbus.service.BusName(
3173
"se.bsnet.fukt.Mandos", bus,
3175
except dbus.exceptions.DBusException as e:
3176
logger.error("Disabling D-Bus:", exc_info=e)
1947
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1948
bus, do_not_queue=True)
1949
except dbus.exceptions.NameExistsException as e:
1950
logger.error(unicode(e) + ", disabling D-Bus")
3177
1951
use_dbus = False
3178
1952
server_settings["use_dbus"] = False
3179
1953
tcp_server.use_dbus = False
3181
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3182
service = AvahiServiceToSyslog(
3183
name=server_settings["servicename"],
3184
servicetype="_mandos._tcp",
3187
if server_settings["interface"]:
3188
service.interface = if_nametoindex(
3189
server_settings["interface"].encode("utf-8"))
1954
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1955
service = AvahiService(name = server_settings["servicename"],
1956
servicetype = "_mandos._tcp",
1957
protocol = protocol, bus = bus)
1958
if server_settings["interface"]:
1959
service.interface = (if_nametoindex
1960
(str(server_settings["interface"])))
3191
1962
global multiprocessing_manager
3192
1963
multiprocessing_manager = multiprocessing.Manager()
3194
1965
client_class = Client
3196
client_class = functools.partial(ClientDBus, bus=bus)
3198
client_settings = Client.config_parser(client_config)
3199
old_client_settings = {}
3202
# This is used to redirect stdout and stderr for checker processes
3204
wnull = open(os.devnull, "w") # A writable /dev/null
3205
# Only used if server is running in foreground but not in debug
3207
if debug or not foreground:
3210
# Get client data and settings from last running state.
3211
if server_settings["restore"]:
3213
with open(stored_state_path, "rb") as stored_state:
3214
if sys.version_info.major == 2:
3215
clients_data, old_client_settings = pickle.load(
3218
bytes_clients_data, bytes_old_client_settings = (
3219
pickle.load(stored_state, encoding="bytes"))
3220
# Fix bytes to strings
3223
clients_data = {(key.decode("utf-8")
3224
if isinstance(key, bytes)
3227
bytes_clients_data.items()}
3228
del bytes_clients_data
3229
for key in clients_data:
3230
value = {(k.decode("utf-8")
3231
if isinstance(k, bytes) else k): v
3233
clients_data[key].items()}
3234
clients_data[key] = value
3236
value["client_structure"] = [
3238
if isinstance(s, bytes)
3240
value["client_structure"]]
3242
for k in ("name", "host"):
3243
if isinstance(value[k], bytes):
3244
value[k] = value[k].decode("utf-8")
3245
if not value.has_key("key_id"):
3246
value["key_id"] = ""
3247
elif not value.has_key("fingerprint"):
3248
value["fingerprint"] = ""
3249
# old_client_settings
3251
old_client_settings = {
3252
(key.decode("utf-8")
3253
if isinstance(key, bytes)
3256
bytes_old_client_settings.items()}
3257
del bytes_old_client_settings
3259
for value in old_client_settings.values():
3260
if isinstance(value["host"], bytes):
3261
value["host"] = (value["host"]
3263
os.remove(stored_state_path)
3264
except IOError as e:
3265
if e.errno == errno.ENOENT:
3266
logger.warning("Could not load persistent state:"
3267
" {}".format(os.strerror(e.errno)))
3269
logger.critical("Could not load persistent state:",
3272
except EOFError as e:
3273
logger.warning("Could not load persistent state: "
3277
with PGPEngine() as pgp:
3278
for client_name, client in clients_data.items():
3279
# Skip removed clients
3280
if client_name not in client_settings:
3283
# Decide which value to use after restoring saved state.
3284
# We have three different values: Old config file,
3285
# new config file, and saved state.
3286
# New config value takes precedence if it differs from old
3287
# config value, otherwise use saved state.
3288
for name, value in client_settings[client_name].items():
3290
# For each value in new config, check if it
3291
# differs from the old config value (Except for
3292
# the "secret" attribute)
3293
if (name != "secret"
3295
old_client_settings[client_name][name])):
3296
client[name] = value
3300
# Clients who has passed its expire date can still be
3301
# enabled if its last checker was successful. A Client
3302
# whose checker succeeded before we stored its state is
3303
# assumed to have successfully run all checkers during
3305
if client["enabled"]:
3306
if datetime.datetime.utcnow() >= client["expires"]:
3307
if not client["last_checked_ok"]:
3309
"disabling client {} - Client never "
3310
"performed a successful checker".format(
3312
client["enabled"] = False
3313
elif client["last_checker_status"] != 0:
3315
"disabling client {} - Client last"
3316
" checker failed with error code"
3319
client["last_checker_status"]))
3320
client["enabled"] = False
3322
client["expires"] = (
3323
datetime.datetime.utcnow()
3324
+ client["timeout"])
3325
logger.debug("Last checker succeeded,"
3326
" keeping {} enabled".format(
1967
client_class = functools.partial(ClientDBus, bus = bus)
1968
def client_config_items(config, section):
1969
special_settings = {
1970
"approved_by_default":
1971
lambda: config.getboolean(section,
1972
"approved_by_default"),
1974
for name, value in config.items(section):
3329
client["secret"] = pgp.decrypt(
3330
client["encrypted_secret"],
3331
client_settings[client_name]["secret"])
3333
# If decryption fails, we use secret from new settings
3334
logger.debug("Failed to decrypt {} old secret".format(
3336
client["secret"] = (client_settings[client_name]
3339
# Add/remove clients based on new changes made to config
3340
for client_name in (set(old_client_settings)
3341
- set(client_settings)):
3342
del clients_data[client_name]
3343
for client_name in (set(client_settings)
3344
- set(old_client_settings)):
3345
clients_data[client_name] = client_settings[client_name]
3347
# Create all client objects
3348
for client_name, client in clients_data.items():
3349
tcp_server.clients[client_name] = client_class(
3352
server_settings=server_settings)
1976
yield (name, special_settings[name]())
1980
tcp_server.clients.update(set(
1981
client_class(name = section,
1982
config= dict(client_config_items(
1983
client_config, section)))
1984
for section in client_config.sections()))
3354
1985
if not tcp_server.clients:
3355
1986
logger.warning("No clients defined")
3358
if pidfile is not None:
3362
print(pid, file=pidfile)
3364
logger.error("Could not write to file %r with PID %d",
1992
pidfile.write(str(pid) + "\n".encode("utf-8"))
1995
logger.error("Could not write to file %r with PID %d",
1998
# "pidfile" was never created
3367
2000
del pidfilename
3369
for termsig in (signal.SIGHUP, signal.SIGTERM):
3370
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3371
lambda: main_loop.quit() and False)
2002
signal.signal(signal.SIGINT, signal.SIG_IGN)
2004
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2005
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3375
@alternate_dbus_interfaces(
3376
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3377
class MandosDBusService(DBusObjectWithObjectManager):
2008
class MandosDBusService(dbus.service.Object):
3378
2009
"""A D-Bus proxy object"""
3380
2010
def __init__(self):
3381
2011
dbus.service.Object.__init__(self, bus, "/")
3383
_interface = "se.recompile.Mandos"
2012
_interface = "se.bsnet.fukt.Mandos"
3385
2014
@dbus.service.signal(_interface, signature="o")
3386
2015
def ClientAdded(self, objpath):
3390
2019
@dbus.service.signal(_interface, signature="ss")
3391
def ClientNotFound(self, key_id, address):
2020
def ClientNotFound(self, fingerprint, address):
3395
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3397
2024
@dbus.service.signal(_interface, signature="os")
3398
2025
def ClientRemoved(self, objpath, name):
3402
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3404
2029
@dbus.service.method(_interface, out_signature="ao")
3405
2030
def GetAllClients(self):
3407
return dbus.Array(c.dbus_object_path for c in
3408
tcp_server.clients.values())
3410
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2032
return dbus.Array(c.dbus_object_path
2033
for c in tcp_server.clients)
3412
2035
@dbus.service.method(_interface,
3413
2036
out_signature="a{oa{sv}}")
3414
2037
def GetAllClientsWithProperties(self):
3416
2039
return dbus.Dictionary(
3417
{c.dbus_object_path: c.GetAll(
3418
"se.recompile.Mandos.Client")
3419
for c in tcp_server.clients.values()},
2040
((c.dbus_object_path, c.GetAll(""))
2041
for c in tcp_server.clients),
3420
2042
signature="oa{sv}")
3422
2044
@dbus.service.method(_interface, in_signature="o")
3423
2045
def RemoveClient(self, object_path):
3425
for c in tcp_server.clients.values():
2047
for c in tcp_server.clients:
3426
2048
if c.dbus_object_path == object_path:
3427
del tcp_server.clients[c.name]
2049
tcp_server.clients.remove(c)
3428
2050
c.remove_from_connection()
3429
# Don't signal the disabling
2051
# Don't signal anything except ClientRemoved
3430
2052
c.disable(quiet=True)
3431
# Emit D-Bus signal for removal
3432
self.client_removed_signal(c)
2054
self.ClientRemoved(object_path, c.name)
3434
2056
raise KeyError(object_path)
3438
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3439
out_signature="a{oa{sa{sv}}}")
3440
def GetManagedObjects(self):
3442
return dbus.Dictionary(
3443
{client.dbus_object_path:
3445
{interface: client.GetAll(interface)
3447
client._get_all_interface_names()})
3448
for client in tcp_server.clients.values()})
3450
def client_added_signal(self, client):
3451
"""Send the new standard signal and the old signal"""
3453
# New standard signal
3454
self.InterfacesAdded(
3455
client.dbus_object_path,
3457
{interface: client.GetAll(interface)
3459
client._get_all_interface_names()}))
3461
self.ClientAdded(client.dbus_object_path)
3463
def client_removed_signal(self, client):
3464
"""Send the new standard signal and the old signal"""
3466
# New standard signal
3467
self.InterfacesRemoved(
3468
client.dbus_object_path,
3469
client._get_all_interface_names())
3471
self.ClientRemoved(client.dbus_object_path,
3474
2060
mandos_dbus_service = MandosDBusService()
3476
# Save modules to variables to exempt the modules from being
3477
# unloaded before the function registered with atexit() is run.
3478
mp = multiprocessing
3482
2063
"Cleanup function; run on exit"
3486
mp.active_children()
3488
if not (tcp_server.clients or client_settings):
3491
# Store client before exiting. Secrets are encrypted with key
3492
# based on what config file has. If config file is
3493
# removed/edited, old secret will thus be unrecovable.
3495
with PGPEngine() as pgp:
3496
for client in tcp_server.clients.values():
3497
key = client_settings[client.name]["secret"]
3498
client.encrypted_secret = pgp.encrypt(client.secret,
3502
# A list of attributes that can not be pickled
3504
exclude = {"bus", "changedstate", "secret",
3505
"checker", "server_settings"}
3506
for name, typ in inspect.getmembers(dbus.service
3510
client_dict["encrypted_secret"] = (client
3512
for attr in client.client_structure:
3513
if attr not in exclude:
3514
client_dict[attr] = getattr(client, attr)
3516
clients[client.name] = client_dict
3517
del client_settings[client.name]["secret"]
3520
with tempfile.NamedTemporaryFile(
3524
dir=os.path.dirname(stored_state_path),
3525
delete=False) as stored_state:
3526
pickle.dump((clients, client_settings), stored_state,
3528
tempname = stored_state.name
3529
os.rename(tempname, stored_state_path)
3530
except (IOError, OSError) as e:
3536
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3537
logger.warning("Could not save persistent state: {}"
3538
.format(os.strerror(e.errno)))
3540
logger.warning("Could not save persistent state:",
3544
# Delete all clients, and settings from config
3545
2066
while tcp_server.clients:
3546
name, client = tcp_server.clients.popitem()
2067
client = tcp_server.clients.pop()
3548
2069
client.remove_from_connection()
3549
# Don't signal the disabling
2070
client.disable_hook = None
2071
# Don't signal anything except ClientRemoved
3550
2072
client.disable(quiet=True)
3551
# Emit D-Bus signal for removal
3553
mandos_dbus_service.client_removed_signal(client)
3554
client_settings.clear()
2075
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3556
2078
atexit.register(cleanup)
3558
for client in tcp_server.clients.values():
2080
for client in tcp_server.clients:
3560
# Emit D-Bus signal for adding
3561
mandos_dbus_service.client_added_signal(client)
3562
# Need to initiate checking of clients
3564
client.init_checker()
2083
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3566
2086
tcp_server.enable()
3567
2087
tcp_server.server_activate()
3569
2089
# Find out what port we got
3571
service.port = tcp_server.socket.getsockname()[1]
2090
service.port = tcp_server.socket.getsockname()[1]
3573
2092
logger.info("Now listening on address %r, port %d,"
3574
" flowinfo %d, scope_id %d",
3575
*tcp_server.socket.getsockname())
2093
" flowinfo %d, scope_id %d"
2094
% tcp_server.socket.getsockname())
3577
logger.info("Now listening on address %r, port %d",
3578
*tcp_server.socket.getsockname())
3580
# service.interface = tcp_server.socket.getsockname()[3]
2096
logger.info("Now listening on address %r, port %d"
2097
% tcp_server.socket.getsockname())
2099
#service.interface = tcp_server.socket.getsockname()[3]
3584
# From the Avahi example code
3587
except dbus.exceptions.DBusException as error:
3588
logger.critical("D-Bus Exception", exc_info=error)
3591
# End of Avahi example code
3593
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3594
lambda *args, **kwargs:
3595
(tcp_server.handle_request
3596
(*args[2:], **kwargs) or True))
2102
# From the Avahi example code
2105
except dbus.exceptions.DBusException as error:
2106
logger.critical("DBusException: %s", error)
2109
# End of Avahi example code
2111
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2112
lambda *args, **kwargs:
2113
(tcp_server.handle_request
2114
(*args[2:], **kwargs) or True))
3598
2116
logger.debug("Starting main loop")
3599
2117
main_loop.run()
3600
2118
except AvahiError as error:
3601
logger.critical("Avahi Error", exc_info=error)
2119
logger.critical("AvahiError: %s", error)
3604
2122
except KeyboardInterrupt: