63
import cPickle as pickle
70
import cPickle as pickle
64
73
import multiprocessing
68
82
import dbus.service
83
from gi.repository import GLib
71
84
from dbus.mainloop.glib import DBusGMainLoop
74
87
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:
78
94
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
79
95
except AttributeError:
97
# This is where SO_BINDTODEVICE was up to and including Python
81
99
from IN import SO_BINDTODEVICE
82
100
except ImportError:
83
SO_BINDTODEVICE = None
88
#logger = logging.getLogger('mandos')
89
logger = logging.Logger('mandos')
90
syslogger = (logging.handlers.SysLogHandler
91
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
address = str("/dev/log")))
93
syslogger.setFormatter(logging.Formatter
94
('Mandos [%(process)d]: %(levelname)s:'
96
logger.addHandler(syslogger)
98
console = logging.StreamHandler()
99
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
102
logger.addHandler(console)
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
104
303
class AvahiError(Exception):
105
304
def __init__(self, value, *args, **kwargs):
106
305
self.value = value
107
super(AvahiError, self).__init__(value, *args, **kwargs)
108
def __unicode__(self):
109
return unicode(repr(self.value))
306
return super(AvahiError, self).__init__(value, *args,
111
310
class AvahiServiceError(AvahiError):
114
314
class AvahiGroupError(AvahiError):
118
318
class AvahiService(object):
119
319
"""An Avahi (Zeroconf) service.
122
322
interface: integer; avahi.IF_UNSPEC or an interface index.
123
323
Used to optionally bind to the specified interface.
124
324
name: string; Example: 'Mandos'
125
325
type: string; Example: '_mandos._tcp'.
126
See <http://www.dns-sd.org/ServiceTypes.html>
326
See <https://www.iana.org/assignments/service-names-port-numbers>
127
327
port: integer; what port to announce
128
328
TXT: list of strings; TXT record for the service
129
329
domain: string; Domain to publish on, default to .local if empty.
262
488
follow_name_owner_changes=True),
263
489
avahi.DBUS_INTERFACE_SERVER)
264
490
self.server.connect_to_signal("StateChanged",
265
self.server_state_changed)
491
self.server_state_changed)
266
492
self.server_state_changed(self.server.GetState())
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
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(b"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(b"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))
275
817
class Client(object):
276
818
"""A representation of a client host served by this server.
279
_approved: bool(); 'None' if not yet approved/disapproved
821
approved: bool(); 'None' if not yet approved/disapproved
280
822
approval_delay: datetime.timedelta(); Time to wait for approval
281
823
approval_duration: datetime.timedelta(); Duration of one approval
282
checker: subprocess.Popen(); a running checker process used
283
to see if the client lives.
284
'None' if no process is running.
285
checker_callback_tag: a gobject event source tag, or None
824
checker: multiprocessing.Process(); a running checker process used
825
to see if the client lives. 'None' if no process is
827
checker_callback_tag: a GLib event source tag, or None
286
828
checker_command: string; External command which is run to check
287
829
if client lives. %() expansions are done at
288
830
runtime with vars(self) as dict, so that for
289
831
instance %(name)s can be used in the command.
290
checker_initiator_tag: a gobject event source tag, or None
832
checker_initiator_tag: a GLib event source tag, or None
291
833
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
292
836
current_checker_command: string; current running checker_command
293
disable_hook: If set, called by disable() as disable_hook(self)
294
disable_initiator_tag: a gobject event source tag, or None
837
disable_initiator_tag: a GLib event source tag, or None
296
839
fingerprint: string (40 or 32 hexadecimal digits); used to
297
uniquely identify the client
840
uniquely identify an OpenPGP client
841
key_id: string (64 hexadecimal digits); used to uniquely identify
842
a client using raw public keys
298
843
host: string; available for use by the checker command
299
844
interval: datetime.timedelta(); How often to start a new checker
300
845
last_approval_request: datetime.datetime(); (UTC) or None
301
846
last_checked_ok: datetime.datetime(); (UTC) or None
302
last_enabled: datetime.datetime(); (UTC)
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
303
853
name: string; from the config file, used in log messages and
304
854
D-Bus identifiers
305
855
secret: bytestring; sent verbatim (over TLS) to client
306
856
timeout: datetime.timedelta(); How long from last_checked_ok
307
857
until this client is disabled
308
extended_timeout: extra long timeout when password has been sent
858
extended_timeout: extra long timeout when secret has been sent
309
859
runtime_expansions: Allowed attributes for runtime expansion.
310
860
expires: datetime.datetime(); time (UTC) when a client will be
311
861
disabled, or None
862
server_settings: The server_settings dict from main()
314
865
runtime_expansions = ("approval_delay", "approval_duration",
315
"created", "enabled", "fingerprint",
316
"host", "interval", "last_checked_ok",
866
"created", "enabled", "expires", "key_id",
867
"fingerprint", "host", "interval",
868
"last_approval_request", "last_checked_ok",
317
869
"last_enabled", "name", "timeout")
319
def timeout_milliseconds(self):
320
"Return the 'timeout' attribute in milliseconds"
321
return _timedelta_to_milliseconds(self.timeout)
323
def extended_timeout_milliseconds(self):
324
"Return the 'extended_timeout' attribute in milliseconds"
325
return _timedelta_to_milliseconds(self.extended_timeout)
327
def interval_milliseconds(self):
328
"Return the 'interval' attribute in milliseconds"
329
return _timedelta_to_milliseconds(self.interval)
331
def approval_delay_milliseconds(self):
332
return _timedelta_to_milliseconds(self.approval_delay)
334
def __init__(self, name = None, disable_hook=None, config=None):
335
"""Note: the 'checker' key in 'config' sets the
336
'checker_command' attribute and *not* the 'checker'
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):
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
341
955
logger.debug("Creating client %r", self.name)
342
# Uppercase and remove spaces from fingerprint for later
343
# comparison purposes with return value from the fingerprint()
345
self.fingerprint = (config["fingerprint"].upper()
956
logger.debug(" Key ID: %s", self.key_id)
347
957
logger.debug(" Fingerprint: %s", self.fingerprint)
348
if "secret" in config:
349
self.secret = config["secret"].decode("base64")
350
elif "secfile" in config:
351
with open(os.path.expanduser(os.path.expandvars
352
(config["secfile"])),
354
self.secret = secfile.read()
356
raise TypeError("No secret or secfile for client %s"
358
self.host = config.get("host", "")
359
self.created = datetime.datetime.utcnow()
361
self.last_approval_request = None
362
self.last_enabled = None
363
self.last_checked_ok = None
364
self.timeout = string_to_delta(config["timeout"])
365
self.extended_timeout = string_to_delta(config
366
["extended_timeout"])
367
self.interval = string_to_delta(config["interval"])
368
self.disable_hook = disable_hook
958
self.created = settings.get("created",
959
datetime.datetime.utcnow())
961
# attributes specific for this server instance
369
962
self.checker = None
370
963
self.checker_initiator_tag = None
371
964
self.disable_initiator_tag = None
373
965
self.checker_callback_tag = None
374
self.checker_command = config["checker"]
375
966
self.current_checker_command = None
376
self.last_connect = None
377
self._approved = None
378
self.approved_by_default = config.get("approved_by_default",
380
968
self.approvals_pending = 0
381
self.approval_delay = string_to_delta(
382
config["approval_delay"])
383
self.approval_duration = string_to_delta(
384
config["approval_duration"])
385
self.changedstate = (multiprocessing_manager
386
.Condition(multiprocessing_manager
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
389
982
def send_changedstate(self):
390
self.changedstate.acquire()
391
self.changedstate.notify_all()
392
self.changedstate.release()
983
with self.changedstate:
984
self.changedstate.notify_all()
394
986
def enable(self):
395
987
"""Start this client's checker and timeout hooks"""
396
988
if getattr(self, "enabled", False):
397
989
# Already enabled
399
self.send_changedstate()
400
# Schedule a new checker to be started an 'interval' from now,
401
# and every interval from then on.
402
self.checker_initiator_tag = (gobject.timeout_add
403
(self.interval_milliseconds(),
405
# Schedule a disable() when 'timeout' has passed
406
991
self.expires = datetime.datetime.utcnow() + self.timeout
407
self.disable_initiator_tag = (gobject.timeout_add
408
(self.timeout_milliseconds(),
410
992
self.enabled = True
411
993
self.last_enabled = datetime.datetime.utcnow()
412
# Also start a new checker *right now*.
995
self.send_changedstate()
415
997
def disable(self, quiet=True):
416
998
"""Disable this client."""
417
999
if not getattr(self, "enabled", False):
420
self.send_changedstate()
422
1002
logger.info("Disabling client %s", self.name)
423
if getattr(self, "disable_initiator_tag", False):
424
gobject.source_remove(self.disable_initiator_tag)
1003
if getattr(self, "disable_initiator_tag", None) is not None:
1004
GLib.source_remove(self.disable_initiator_tag)
425
1005
self.disable_initiator_tag = None
426
1006
self.expires = None
427
if getattr(self, "checker_initiator_tag", False):
428
gobject.source_remove(self.checker_initiator_tag)
1007
if getattr(self, "checker_initiator_tag", None) is not None:
1008
GLib.source_remove(self.checker_initiator_tag)
429
1009
self.checker_initiator_tag = None
430
1010
self.stop_checker()
431
if self.disable_hook:
432
self.disable_hook(self)
433
1011
self.enabled = False
434
# Do not run this again if called by a gobject.timeout_add
1013
self.send_changedstate()
1014
# Do not run this again if called by a GLib.timeout_add
437
1017
def __del__(self):
438
self.disable_hook = None
441
def checker_callback(self, pid, condition, command):
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,
442
1038
"""The checker has completed, so take appropriate actions."""
1039
# Read return code from connection (see call_pipe)
1040
returncode = connection.recv()
443
1043
self.checker_callback_tag = None
444
1044
self.checker = None
445
if os.WIFEXITED(condition):
446
exitstatus = os.WEXITSTATUS(condition)
1047
self.last_checker_status = returncode
1048
self.last_checker_signal = None
1049
if self.last_checker_status == 0:
448
1050
logger.info("Checker for %(name)s succeeded",
450
1052
self.checked_ok()
452
logger.info("Checker for %(name)s failed",
1054
logger.info("Checker for %(name)s failed", vars(self))
1056
self.last_checker_status = -1
1057
self.last_checker_signal = -returncode
455
1058
logger.warning("Checker for %(name)s crashed?",
458
def checked_ok(self, timeout=None):
459
"""Bump up the timeout for this client.
461
This should only be called when the client has been seen,
1062
def checked_ok(self):
1063
"""Assert that the client has been seen, alive and well."""
1064
self.last_checked_ok = datetime.datetime.utcnow()
1065
self.last_checker_status = 0
1066
self.last_checker_signal = None
1069
def bump_timeout(self, timeout=None):
1070
"""Bump up the timeout for this client."""
464
1071
if timeout is None:
465
1072
timeout = self.timeout
466
self.last_checked_ok = datetime.datetime.utcnow()
467
1073
if self.disable_initiator_tag is not None:
468
gobject.source_remove(self.disable_initiator_tag)
1074
GLib.source_remove(self.disable_initiator_tag)
1075
self.disable_initiator_tag = None
469
1076
if getattr(self, "enabled", False):
470
self.disable_initiator_tag = (gobject.timeout_add
471
(_timedelta_to_milliseconds
472
(timeout), self.disable))
1077
self.disable_initiator_tag = GLib.timeout_add(
1078
int(timeout.total_seconds() * 1000), self.disable)
473
1079
self.expires = datetime.datetime.utcnow() + timeout
475
1081
def need_approval(self):
476
1082
self.last_approval_request = datetime.datetime.utcnow()
478
1084
def start_checker(self):
479
1085
"""Start a new checker subprocess if one is not running.
481
1087
If a checker already exists, leave it running and do
483
1089
# The reason for not killing a running checker is that if we
484
# did that, then if a checker (for some reason) started
485
# running slowly and taking more than 'interval' time, the
486
# client would inevitably timeout, since no checker would get
487
# a chance to run to completion. If we instead leave running
1090
# did that, and if a checker (for some reason) started running
1091
# slowly and taking more than 'interval' time, then the client
1092
# would inevitably timeout, since no checker would get a
1093
# chance to run to completion. If we instead leave running
488
1094
# checkers alone, the checker would have to take more time
489
1095
# than 'timeout' for the client to be disabled, which is as it
492
# If a checker exists, make sure it is not a zombie
494
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
495
except (AttributeError, OSError) as error:
496
if (isinstance(error, OSError)
497
and error.errno != errno.ECHILD):
501
logger.warning("Checker was a zombie")
502
gobject.source_remove(self.checker_callback_tag)
503
self.checker_callback(pid, status,
504
self.current_checker_command)
1098
if self.checker is not None and not self.checker.is_alive():
1099
logger.warning("Checker was not alive; joining")
505
1102
# Start a new checker if needed
506
1103
if self.checker is None:
1104
# Escape attributes for the shell
1106
attr: re.escape(str(getattr(self, attr)))
1107
for attr in self.runtime_expansions}
508
# In case checker_command has exactly one % operator
509
command = self.checker_command % self.host
511
# Escape attributes for the shell
512
escaped_attrs = dict(
514
re.escape(unicode(str(getattr(self, attr, "")),
518
self.runtime_expansions)
521
command = self.checker_command % escaped_attrs
522
except TypeError as error:
523
logger.error('Could not format string "%s":'
524
' %s', self.checker_command, error)
525
return True # Try again later
1109
command = self.checker_command % escaped_attrs
1110
except TypeError as error:
1111
logger.error('Could not format string "%s"',
1112
self.checker_command,
1114
return True # Try again later
526
1115
self.current_checker_command = command
528
logger.info("Starting checker %r for %s",
530
# We don't need to redirect stdout and stderr, since
531
# in normal mode, that is already done by daemon(),
532
# and in debug mode we don't want to. (Stdin is
533
# always replaced by /dev/null.)
534
self.checker = subprocess.Popen(command,
537
self.checker_callback_tag = (gobject.child_watch_add
539
self.checker_callback,
541
# The checker may have completed before the gobject
542
# watch was added. Check for this.
543
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
545
gobject.source_remove(self.checker_callback_tag)
546
self.checker_callback(pid, status, command)
547
except OSError as error:
548
logger.error("Failed to start subprocess: %s",
550
# Re-run this periodically if run by gobject.timeout_add
1116
logger.info("Starting checker %r for %s", command,
1118
# We don't need to redirect stdout and stderr, since
1119
# in normal mode, that is already done by daemon(),
1120
# and in debug mode we don't want to. (Stdin is
1121
# always replaced by /dev/null.)
1122
# The exception is when not debugging but nevertheless
1123
# running in the foreground; use the previously
1125
popen_args = {"close_fds": True,
1128
if (not self.server_settings["debug"]
1129
and self.server_settings["foreground"]):
1130
popen_args.update({"stdout": wnull,
1132
pipe = multiprocessing.Pipe(duplex=False)
1133
self.checker = multiprocessing.Process(
1135
args=(pipe[1], subprocess.call, command),
1137
self.checker.start()
1138
self.checker_callback_tag = GLib.io_add_watch(
1139
pipe[0].fileno(), GLib.IO_IN,
1140
self.checker_callback, pipe[0], command)
1141
# Re-run this periodically if run by GLib.timeout_add
553
1144
def stop_checker(self):
554
1145
"""Force the checker process, if any, to stop."""
555
1146
if self.checker_callback_tag:
556
gobject.source_remove(self.checker_callback_tag)
1147
GLib.source_remove(self.checker_callback_tag)
557
1148
self.checker_callback_tag = None
558
1149
if getattr(self, "checker", None) is None:
560
1151
logger.debug("Stopping checker for %(name)s", vars(self))
562
os.kill(self.checker.pid, signal.SIGTERM)
564
#if self.checker.poll() is None:
565
# os.kill(self.checker.pid, signal.SIGKILL)
566
except OSError as error:
567
if error.errno != errno.ESRCH: # No such process
1152
self.checker.terminate()
569
1153
self.checker = None
572
def dbus_service_property(dbus_interface, signature="v",
573
access="readwrite", byte_arrays=False):
1156
def dbus_service_property(dbus_interface,
574
1160
"""Decorators for marking methods of a DBusObjectWithProperties to
575
1161
become properties on the D-Bus.
577
1163
The decorated method will be called with no arguments by "Get"
578
1164
and with one argument by "Set".
580
1166
The parameters, where they are supported, are the same as
581
1167
dbus.service.method, except there is only "signature", since the
582
1168
type from Get() and the type sent to Set() is the same.
752
1501
except (AttributeError, xml.dom.DOMException,
753
1502
xml.parsers.expat.ExpatError) as error:
754
1503
logger.error("Failed to override Introspection method",
759
def datetime_to_dbus (dt, variant_level=0):
1509
dbus.OBJECT_MANAGER_IFACE
1510
except AttributeError:
1511
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1514
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1515
"""A D-Bus object with an ObjectManager.
1517
Classes inheriting from this exposes the standard
1518
GetManagedObjects call and the InterfacesAdded and
1519
InterfacesRemoved signals on the standard
1520
"org.freedesktop.DBus.ObjectManager" interface.
1522
Note: No signals are sent automatically; they must be sent
1525
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1526
out_signature="a{oa{sa{sv}}}")
1527
def GetManagedObjects(self):
1528
"""This function must be overridden"""
1529
raise NotImplementedError()
1531
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1532
signature="oa{sa{sv}}")
1533
def InterfacesAdded(self, object_path, interfaces_and_properties):
1536
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1537
def InterfacesRemoved(self, object_path, interfaces):
1540
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1542
path_keyword='object_path',
1543
connection_keyword='connection')
1544
def Introspect(self, object_path, connection):
1545
"""Overloading of standard D-Bus method.
1547
Override return argument name of GetManagedObjects to be
1548
"objpath_interfaces_and_properties"
1550
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1554
document = xml.dom.minidom.parseString(xmlstring)
1556
for if_tag in document.getElementsByTagName("interface"):
1557
# Fix argument name for the GetManagedObjects method
1558
if (if_tag.getAttribute("name")
1559
== dbus.OBJECT_MANAGER_IFACE):
1560
for cn in if_tag.getElementsByTagName("method"):
1561
if (cn.getAttribute("name")
1562
== "GetManagedObjects"):
1563
for arg in cn.getElementsByTagName("arg"):
1564
if (arg.getAttribute("direction")
1568
"objpath_interfaces"
1570
xmlstring = document.toxml("utf-8")
1572
except (AttributeError, xml.dom.DOMException,
1573
xml.parsers.expat.ExpatError) as error:
1574
logger.error("Failed to override Introspection method",
1579
def datetime_to_dbus(dt, variant_level=0):
760
1580
"""Convert a UTC datetime.datetime() to a D-Bus type."""
762
return dbus.String("", variant_level = variant_level)
763
return dbus.String(dt.isoformat(),
764
variant_level=variant_level)
766
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
768
"""Applied to an empty subclass of a D-Bus object, this metaclass
769
will add additional D-Bus attributes matching a certain pattern.
1582
return dbus.String("", variant_level=variant_level)
1583
return dbus.String(dt.isoformat(), variant_level=variant_level)
1586
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1587
"""A class decorator; applied to a subclass of
1588
dbus.service.Object, it will add alternate D-Bus attributes with
1589
interface names according to the "alt_interface_names" mapping.
1592
@alternate_dbus_interfaces({"org.example.Interface":
1593
"net.example.AlternateInterface"})
1594
class SampleDBusObject(dbus.service.Object):
1595
@dbus.service.method("org.example.Interface")
1596
def SampleDBusMethod():
1599
The above "SampleDBusMethod" on "SampleDBusObject" will be
1600
reachable via two interfaces: "org.example.Interface" and
1601
"net.example.AlternateInterface", the latter of which will have
1602
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1603
"true", unless "deprecate" is passed with a False value.
1605
This works for methods and signals, and also for D-Bus properties
1606
(from DBusObjectWithProperties) and interfaces (from the
1607
dbus_interface_annotations decorator).
771
def __new__(mcs, name, bases, attr):
772
# Go through all the base classes which could have D-Bus
773
# methods, signals, or properties in them
774
for base in (b for b in bases
775
if issubclass(b, dbus.service.Object)):
776
# Go though all attributes of the base class
777
for attrname, attribute in inspect.getmembers(base):
1611
for orig_interface_name, alt_interface_name in (
1612
alt_interface_names.items()):
1614
interface_names = set()
1615
# Go though all attributes of the class
1616
for attrname, attribute in inspect.getmembers(cls):
778
1617
# Ignore non-D-Bus attributes, and D-Bus attributes
779
1618
# with the wrong interface name
780
1619
if (not hasattr(attribute, "_dbus_interface")
781
or not attribute._dbus_interface
782
.startswith("se.recompile.Mandos")):
1620
or not attribute._dbus_interface.startswith(
1621
orig_interface_name)):
784
1623
# Create an alternate D-Bus interface name based on
785
1624
# the current name
786
alt_interface = (attribute._dbus_interface
787
.replace("se.recompile.Mandos",
788
"se.bsnet.fukt.Mandos"))
1625
alt_interface = attribute._dbus_interface.replace(
1626
orig_interface_name, alt_interface_name)
1627
interface_names.add(alt_interface)
789
1628
# Is this a D-Bus signal?
790
1629
if getattr(attribute, "_dbus_is_signal", False):
791
# Extract the original non-method function by
793
nonmethod_func = (dict(
1630
# Extract the original non-method undecorated
1631
# function by black magic
1632
if sys.version_info.major == 2:
1633
nonmethod_func = (dict(
794
1634
zip(attribute.func_code.co_freevars,
795
attribute.__closure__))["func"]
1635
attribute.__closure__))
1636
["func"].cell_contents)
1638
nonmethod_func = (dict(
1639
zip(attribute.__code__.co_freevars,
1640
attribute.__closure__))
1641
["func"].cell_contents)
797
1642
# Create a new, but exactly alike, function
798
1643
# object, and decorate it to be a new D-Bus signal
799
1644
# with the alternate D-Bus interface name
800
new_function = (dbus.service.signal
802
attribute._dbus_signature)
804
nonmethod_func.func_code,
805
nonmethod_func.func_globals,
806
nonmethod_func.func_name,
807
nonmethod_func.func_defaults,
808
nonmethod_func.func_closure)))
1645
new_function = copy_function(nonmethod_func)
1646
new_function = (dbus.service.signal(
1648
attribute._dbus_signature)(new_function))
1649
# Copy annotations, if any
1651
new_function._dbus_annotations = dict(
1652
attribute._dbus_annotations)
1653
except AttributeError:
809
1656
# Define a creator of a function to call both the
810
# old and new functions, so both the old and new
811
# signals gets sent when the function is called
1657
# original and alternate functions, so both the
1658
# original and alternate signals gets sent when
1659
# the function is called
812
1660
def fixscope(func1, func2):
813
1661
"""This function is a scope container to pass
814
1662
func1 and func2 to the "call_both" function
815
1663
outside of its arguments"""
1665
@functools.wraps(func2)
816
1666
def call_both(*args, **kwargs):
817
1667
"""This function will emit two D-Bus
818
1668
signals by calling func1 and func2"""
819
1669
func1(*args, **kwargs)
820
1670
func2(*args, **kwargs)
1671
# Make wrapper function look like a D-Bus
1673
for name, attr in inspect.getmembers(func2):
1674
if name.startswith("_dbus_"):
1675
setattr(call_both, name, attr)
821
1677
return call_both
822
1678
# Create the "call_both" function and add it to
824
attr[attrname] = fixscope(attribute,
1680
attr[attrname] = fixscope(attribute, new_function)
826
1681
# Is this a D-Bus method?
827
1682
elif getattr(attribute, "_dbus_is_method", False):
828
1683
# Create a new, but exactly alike, function
829
1684
# object. Decorate it to be a new D-Bus method
830
1685
# with the alternate D-Bus interface name. Add it
832
attr[attrname] = (dbus.service.method
834
attribute._dbus_in_signature,
835
attribute._dbus_out_signature)
837
(attribute.func_code,
838
attribute.func_globals,
840
attribute.func_defaults,
841
attribute.func_closure)))
1688
dbus.service.method(
1690
attribute._dbus_in_signature,
1691
attribute._dbus_out_signature)
1692
(copy_function(attribute)))
1693
# Copy annotations, if any
1695
attr[attrname]._dbus_annotations = dict(
1696
attribute._dbus_annotations)
1697
except AttributeError:
842
1699
# Is this a D-Bus property?
843
1700
elif getattr(attribute, "_dbus_is_property", False):
844
1701
# Create a new, but exactly alike, function
845
1702
# object, and decorate it to be a new D-Bus
846
1703
# property with the alternate D-Bus interface
847
1704
# name. Add it to the class.
848
attr[attrname] = (dbus_service_property
850
attribute._dbus_signature,
851
attribute._dbus_access,
853
._dbus_get_args_options
856
(attribute.func_code,
857
attribute.func_globals,
859
attribute.func_defaults,
860
attribute.func_closure)))
861
return type.__new__(mcs, name, bases, attr)
1705
attr[attrname] = (dbus_service_property(
1706
alt_interface, attribute._dbus_signature,
1707
attribute._dbus_access,
1708
attribute._dbus_get_args_options
1710
(copy_function(attribute)))
1711
# Copy annotations, if any
1713
attr[attrname]._dbus_annotations = dict(
1714
attribute._dbus_annotations)
1715
except AttributeError:
1717
# Is this a D-Bus interface?
1718
elif getattr(attribute, "_dbus_is_interface", False):
1719
# Create a new, but exactly alike, function
1720
# object. Decorate it to be a new D-Bus interface
1721
# with the alternate D-Bus interface name. Add it
1724
dbus_interface_annotations(alt_interface)
1725
(copy_function(attribute)))
1727
# Deprecate all alternate interfaces
1728
iname = "_AlternateDBusNames_interface_annotation{}"
1729
for interface_name in interface_names:
1731
@dbus_interface_annotations(interface_name)
1733
return {"org.freedesktop.DBus.Deprecated":
1735
# Find an unused name
1736
for aname in (iname.format(i)
1737
for i in itertools.count()):
1738
if aname not in attr:
1742
# Replace the class with a new subclass of it with
1743
# methods, signals, etc. as created above.
1744
if sys.version_info.major == 2:
1745
cls = type(b"{}Alternate".format(cls.__name__),
1748
cls = type("{}Alternate".format(cls.__name__),
1755
@alternate_dbus_interfaces({"se.recompile.Mandos":
1756
"se.bsnet.fukt.Mandos"})
863
1757
class ClientDBus(Client, DBusObjectWithProperties):
864
1758
"""A Client class using D-Bus
867
1761
dbus_object_path: dbus.ObjectPath
868
1762
bus: dbus.SystemBus()
871
1765
runtime_expansions = (Client.runtime_expansions
872
+ ("dbus_object_path",))
1766
+ ("dbus_object_path", ))
1768
_interface = "se.recompile.Mandos.Client"
874
1770
# dbus.service.Object doesn't use super(), so we can't either.
876
def __init__(self, bus = None, *args, **kwargs):
877
self._approvals_pending = 0
1772
def __init__(self, bus=None, *args, **kwargs):
879
1774
Client.__init__(self, *args, **kwargs)
880
1775
# Only now, when this client is initialized, can it show up on
882
client_object_name = unicode(self.name).translate(
1777
client_object_name = str(self.name).translate(
883
1778
{ord("."): ord("_"),
884
1779
ord("-"): ord("_")})
885
self.dbus_object_path = (dbus.ObjectPath
886
("/clients/" + client_object_name))
1780
self.dbus_object_path = dbus.ObjectPath(
1781
"/clients/" + client_object_name)
887
1782
DBusObjectWithProperties.__init__(self, self.bus,
888
1783
self.dbus_object_path)
890
def notifychangeproperty(transform_func,
891
dbus_name, type_func=lambda x: x,
1785
def notifychangeproperty(transform_func, dbus_name,
1786
type_func=lambda x: x,
1788
invalidate_only=False,
1789
_interface=_interface):
893
1790
""" Modify a variable so that it's a property which announces
894
1791
its changes to DBus.
1246
2186
self.start_checker()
1248
2188
self.stop_checker()
1250
2190
# ObjectPath - property
2192
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2193
"org.freedesktop.DBus.Deprecated": "true"})
1251
2194
@dbus_service_property(_interface, signature="o", access="read")
1252
2195
def ObjectPath_dbus_property(self):
1253
return self.dbus_object_path # is already a dbus.ObjectPath
2196
return self.dbus_object_path # is already a dbus.ObjectPath
1255
2198
# Secret = property
1256
@dbus_service_property(_interface, signature="ay",
1257
access="write", byte_arrays=True)
2200
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2202
@dbus_service_property(_interface,
1258
2206
def Secret_dbus_property(self, value):
1259
self.secret = str(value)
2207
self.secret = bytes(value)
1264
2212
class ProxyClient(object):
1265
def __init__(self, child_pipe, fpr, address):
2213
def __init__(self, child_pipe, key_id, fpr, address):
1266
2214
self._pipe = child_pipe
1267
self._pipe.send(('init', fpr, address))
2215
self._pipe.send(('init', key_id, fpr, address))
1268
2216
if not self._pipe.recv():
2217
raise KeyError(key_id or fpr)
1271
2219
def __getattribute__(self, name):
1272
if(name == '_pipe'):
1273
2221
return super(ProxyClient, self).__getattribute__(name)
1274
2222
self._pipe.send(('getattr', name))
1275
2223
data = self._pipe.recv()
1276
2224
if data[0] == 'data':
1278
2226
if data[0] == 'function':
1279
2228
def func(*args, **kwargs):
1280
2229
self._pipe.send(('funcall', name, args, kwargs))
1281
2230
return self._pipe.recv()[1]
1284
2234
def __setattr__(self, name, value):
1285
if(name == '_pipe'):
1286
2236
return super(ProxyClient, self).__setattr__(name, value)
1287
2237
self._pipe.send(('setattr', name, value))
1289
class ClientDBusTransitional(ClientDBus):
1290
__metaclass__ = AlternateDBusNamesMetaclass
1292
2240
class ClientHandler(socketserver.BaseRequestHandler, object):
1293
2241
"""A class to handle client connections.
1295
2243
Instantiated once for each connection to handle it.
1296
2244
Note: This will run in its own forked process."""
1298
2246
def handle(self):
1299
2247
with contextlib.closing(self.server.child_pipe) as child_pipe:
1300
2248
logger.info("TCP connection from: %s",
1301
unicode(self.client_address))
2249
str(self.client_address))
1302
2250
logger.debug("Pipe FD: %d",
1303
2251
self.server.child_pipe.fileno())
1305
session = (gnutls.connection
1306
.ClientSession(self.request,
1308
.X509Credentials()))
1310
# Note: gnutls.connection.X509Credentials is really a
1311
# generic GnuTLS certificate credentials object so long as
1312
# no X.509 keys are added to it. Therefore, we can use it
1313
# here despite using OpenPGP certificates.
1315
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1316
# "+AES-256-CBC", "+SHA1",
1317
# "+COMP-NULL", "+CTYPE-OPENPGP",
2253
session = gnutls.ClientSession(self.request)
2255
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2256
# "+AES-256-CBC", "+SHA1",
2257
# "+COMP-NULL", "+CTYPE-OPENPGP",
1319
2259
# Use a fallback default, since this MUST be set.
1320
2260
priority = self.server.gnutls_priority
1321
2261
if priority is None:
1322
2262
priority = "NORMAL"
1323
(gnutls.library.functions
1324
.gnutls_priority_set_direct(session._c_object,
2263
gnutls.priority_set_direct(session._c_object,
2264
priority.encode("utf-8"),
1327
2267
# Start communication using the Mandos protocol
1328
2268
# Get protocol number
1329
2269
line = self.request.makefile().readline()
1330
2270
logger.debug("Protocol version: %r", line)
1332
2272
if int(line.strip().split()[0]) > 1:
2273
raise RuntimeError(line)
1334
2274
except (ValueError, IndexError, RuntimeError) as error:
1335
2275
logger.error("Unknown protocol version: %s", error)
1338
2278
# Start GnuTLS connection
1340
2280
session.handshake()
1341
except gnutls.errors.GNUTLSError as error:
2281
except gnutls.Error as error:
1342
2282
logger.warning("Handshake failed: %s", error)
1343
2283
# Do not run session.bye() here: the session is not
1344
2284
# established. Just abandon the request.
1346
2286
logger.debug("Handshake succeeded")
1348
2288
approval_required = False
1351
fpr = self.fingerprint(self.peer_certificate
1354
gnutls.errors.GNUTLSError) as error:
1355
logger.warning("Bad certificate: %s", error)
1357
logger.debug("Fingerprint: %s", fpr)
1360
client = ProxyClient(child_pipe, fpr,
2290
if gnutls.has_rawpk:
2293
key_id = self.key_id(
2294
self.peer_certificate(session))
2295
except (TypeError, gnutls.Error) as error:
2296
logger.warning("Bad certificate: %s", error)
2298
logger.debug("Key ID: %s", key_id)
2303
fpr = self.fingerprint(
2304
self.peer_certificate(session))
2305
except (TypeError, gnutls.Error) as error:
2306
logger.warning("Bad certificate: %s", error)
2308
logger.debug("Fingerprint: %s", fpr)
2311
client = ProxyClient(child_pipe, key_id, fpr,
1361
2312
self.client_address)
1362
2313
except KeyError:
1365
2316
if client.approval_delay:
1366
2317
delay = client.approval_delay
1367
2318
client.approvals_pending += 1
1368
2319
approval_required = True
1371
2322
if not client.enabled:
1372
2323
logger.info("Client %s is disabled",
1374
2325
if self.server.use_dbus:
1375
2326
# Emit D-Bus signal
1376
2327
client.Rejected("Disabled")
1379
if client._approved or not client.approval_delay:
1380
#We are approved or approval is disabled
2330
if client.approved or not client.approval_delay:
2331
# We are approved or approval is disabled
1382
elif client._approved is None:
2333
elif client.approved is None:
1383
2334
logger.info("Client %s needs approval",
1385
2336
if self.server.use_dbus:
1386
2337
# Emit D-Bus signal
1387
2338
client.NeedApproval(
1388
client.approval_delay_milliseconds(),
1389
client.approved_by_default)
2339
client.approval_delay.total_seconds()
2340
* 1000, client.approved_by_default)
1391
2342
logger.warning("Client %s was not approved",
1418
2367
delay -= time2 - time
1421
while sent_size < len(client.secret):
1423
sent = session.send(client.secret[sent_size:])
1424
except gnutls.errors.GNUTLSError as error:
1425
logger.warning("gnutls send failed")
1427
logger.debug("Sent: %d, remaining: %d",
1428
sent, len(client.secret)
1429
- (sent_size + sent))
2370
session.send(client.secret)
2371
except gnutls.Error as error:
2372
logger.warning("gnutls send failed",
1432
2376
logger.info("Sending secret to %s", client.name)
1433
2377
# bump the timeout using extended_timeout
1434
client.checked_ok(client.extended_timeout)
2378
client.bump_timeout(client.extended_timeout)
1435
2379
if self.server.use_dbus:
1436
2380
# Emit D-Bus signal
1437
2381
client.GotSecret()
1440
2384
if approval_required:
1441
2385
client.approvals_pending -= 1
1444
except gnutls.errors.GNUTLSError as error:
1445
logger.warning("GnuTLS bye failed")
2388
except gnutls.Error as error:
2389
logger.warning("GnuTLS bye failed",
1448
2393
def peer_certificate(session):
1449
"Return the peer's OpenPGP certificate as a bytestring"
1450
# If not an OpenPGP certificate...
1451
if (gnutls.library.functions
1452
.gnutls_certificate_type_get(session._c_object)
1453
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1454
# ...do the normal thing
1455
return session.peer_certificate
2394
"Return the peer's certificate as a bytestring"
2396
cert_type = gnutls.certificate_type_get2(session._c_object,
2398
except AttributeError:
2399
cert_type = gnutls.certificate_type_get(session._c_object)
2400
if gnutls.has_rawpk:
2401
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2403
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2404
# If not a valid certificate type...
2405
if cert_type not in valid_cert_types:
2406
logger.info("Cert type %r not in %r", cert_type,
2408
# ...return invalid data
1456
2410
list_size = ctypes.c_uint(1)
1457
cert_list = (gnutls.library.functions
1458
.gnutls_certificate_get_peers
2411
cert_list = (gnutls.certificate_get_peers
1459
2412
(session._c_object, ctypes.byref(list_size)))
1460
2413
if not bool(cert_list) and list_size.value != 0:
1461
raise gnutls.errors.GNUTLSError("error getting peer"
2414
raise gnutls.Error("error getting peer certificate")
1463
2415
if list_size.value == 0:
1465
2417
cert = cert_list[0]
1466
2418
return ctypes.string_at(cert.data, cert.size)
2421
def key_id(certificate):
2422
"Convert a certificate bytestring to a hexdigit key ID"
2423
# New GnuTLS "datum" with the public key
2424
datum = gnutls.datum_t(
2425
ctypes.cast(ctypes.c_char_p(certificate),
2426
ctypes.POINTER(ctypes.c_ubyte)),
2427
ctypes.c_uint(len(certificate)))
2428
# XXX all these need to be created in the gnutls "module"
2429
# New empty GnuTLS certificate
2430
pubkey = gnutls.pubkey_t()
2431
gnutls.pubkey_init(ctypes.byref(pubkey))
2432
# Import the raw public key into the certificate
2433
gnutls.pubkey_import(pubkey,
2434
ctypes.byref(datum),
2435
gnutls.X509_FMT_DER)
2436
# New buffer for the key ID
2437
buf = ctypes.create_string_buffer(32)
2438
buf_len = ctypes.c_size_t(len(buf))
2439
# Get the key ID from the raw public key into the buffer
2440
gnutls.pubkey_get_key_id(pubkey,
2441
gnutls.KEYID_USE_SHA256,
2442
ctypes.cast(ctypes.byref(buf),
2443
ctypes.POINTER(ctypes.c_ubyte)),
2444
ctypes.byref(buf_len))
2445
# Deinit the certificate
2446
gnutls.pubkey_deinit(pubkey)
2448
# Convert the buffer to a Python bytestring
2449
key_id = ctypes.string_at(buf, buf_len.value)
2450
# Convert the bytestring to hexadecimal notation
2451
hex_key_id = binascii.hexlify(key_id).upper()
1469
2455
def fingerprint(openpgp):
1470
2456
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1471
2457
# New GnuTLS "datum" with the OpenPGP public key
1472
datum = (gnutls.library.types
1473
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1476
ctypes.c_uint(len(openpgp))))
2458
datum = gnutls.datum_t(
2459
ctypes.cast(ctypes.c_char_p(openpgp),
2460
ctypes.POINTER(ctypes.c_ubyte)),
2461
ctypes.c_uint(len(openpgp)))
1477
2462
# New empty GnuTLS certificate
1478
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1479
(gnutls.library.functions
1480
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2463
crt = gnutls.openpgp_crt_t()
2464
gnutls.openpgp_crt_init(ctypes.byref(crt))
1481
2465
# Import the OpenPGP public key into the certificate
1482
(gnutls.library.functions
1483
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1484
gnutls.library.constants
1485
.GNUTLS_OPENPGP_FMT_RAW))
2466
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2467
gnutls.OPENPGP_FMT_RAW)
1486
2468
# Verify the self signature in the key
1487
2469
crtverify = ctypes.c_uint()
1488
(gnutls.library.functions
1489
.gnutls_openpgp_crt_verify_self(crt, 0,
1490
ctypes.byref(crtverify)))
2470
gnutls.openpgp_crt_verify_self(crt, 0,
2471
ctypes.byref(crtverify))
1491
2472
if crtverify.value != 0:
1492
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1493
raise (gnutls.errors.CertificateSecurityError
2473
gnutls.openpgp_crt_deinit(crt)
2474
raise gnutls.CertificateSecurityError(code
1495
2476
# New buffer for the fingerprint
1496
2477
buf = ctypes.create_string_buffer(20)
1497
2478
buf_len = ctypes.c_size_t()
1498
2479
# Get the fingerprint from the certificate into the buffer
1499
(gnutls.library.functions
1500
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1501
ctypes.byref(buf_len)))
2480
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2481
ctypes.byref(buf_len))
1502
2482
# Deinit the certificate
1503
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2483
gnutls.openpgp_crt_deinit(crt)
1504
2484
# Convert the buffer to a Python bytestring
1505
2485
fpr = ctypes.string_at(buf, buf_len.value)
1506
2486
# Convert the bytestring to hexadecimal notation
1507
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2487
hex_fpr = binascii.hexlify(fpr).upper()
1511
2491
class MultiprocessingMixIn(object):
1512
2492
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1513
2494
def sub_process_main(self, request, address):
1515
2496
self.finish_request(request, address)
1517
2498
self.handle_error(request, address)
1518
2499
self.close_request(request)
1520
2501
def process_request(self, request, address):
1521
2502
"""Start a new process to process the request."""
1522
proc = multiprocessing.Process(target = self.sub_process_main,
2503
proc = multiprocessing.Process(target=self.sub_process_main,
2504
args=(request, address))
1529
2509
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1530
2510
""" adds a pipe to the MixIn """
1531
2512
def process_request(self, request, client_address):
1532
2513
"""Overrides and wraps the original process_request().
1534
2515
This function creates a new pipe in self.pipe
1536
2517
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1538
2519
proc = MultiprocessingMixIn.process_request(self, request,
1539
2520
client_address)
1540
2521
self.child_pipe.close()
1541
2522
self.add_pipe(parent_pipe, proc)
1543
2524
def add_pipe(self, parent_pipe, proc):
1544
2525
"""Dummy function; override as necessary"""
1545
raise NotImplementedError
2526
raise NotImplementedError()
1548
2529
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1549
2530
socketserver.TCPServer, object):
1550
2531
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1553
2534
enabled: Boolean; whether this server is activated yet
1554
2535
interface: None or a network interface name (string)
1555
2536
use_ipv6: Boolean; to use IPv6 or not
1557
2539
def __init__(self, server_address, RequestHandlerClass,
1558
interface=None, use_ipv6=True):
2543
"""If socketfd is set, use that file descriptor instead of
2544
creating a new one with socket.socket().
1559
2546
self.interface = interface
1561
2548
self.address_family = socket.AF_INET6
2549
if socketfd is not None:
2550
# Save the file descriptor
2551
self.socketfd = socketfd
2552
# Save the original socket.socket() function
2553
self.socket_socket = socket.socket
2555
# To implement --socket, we monkey patch socket.socket.
2557
# (When socketserver.TCPServer is a new-style class, we
2558
# could make self.socket into a property instead of monkey
2559
# patching socket.socket.)
2561
# Create a one-time-only replacement for socket.socket()
2562
@functools.wraps(socket.socket)
2563
def socket_wrapper(*args, **kwargs):
2564
# Restore original function so subsequent calls are
2566
socket.socket = self.socket_socket
2567
del self.socket_socket
2568
# This time only, return a new socket object from the
2569
# saved file descriptor.
2570
return socket.fromfd(self.socketfd, *args, **kwargs)
2571
# Replace socket.socket() function with wrapper
2572
socket.socket = socket_wrapper
2573
# The socketserver.TCPServer.__init__ will call
2574
# socket.socket(), which might be our replacement,
2575
# socket_wrapper(), if socketfd was set.
1562
2576
socketserver.TCPServer.__init__(self, server_address,
1563
2577
RequestHandlerClass)
1564
2579
def server_bind(self):
1565
2580
"""This overrides the normal server_bind() function
1566
2581
to bind to an interface if one was specified, and also NOT to
1567
2582
bind to an address or port if they were not specified."""
2583
global SO_BINDTODEVICE
1568
2584
if self.interface is not None:
1569
2585
if SO_BINDTODEVICE is None:
1570
logger.error("SO_BINDTODEVICE does not exist;"
1571
" cannot bind to interface %s",
1575
self.socket.setsockopt(socket.SOL_SOCKET,
1579
except socket.error as error:
1580
if error[0] == errno.EPERM:
1581
logger.error("No permission to"
1582
" bind to interface %s",
1584
elif error[0] == errno.ENOPROTOOPT:
1585
logger.error("SO_BINDTODEVICE not available;"
1586
" cannot bind to interface %s",
2586
# Fall back to a hard-coded value which seems to be
2588
logger.warning("SO_BINDTODEVICE not found, trying 25")
2589
SO_BINDTODEVICE = 25
2591
self.socket.setsockopt(
2592
socket.SOL_SOCKET, SO_BINDTODEVICE,
2593
(self.interface + "\0").encode("utf-8"))
2594
except socket.error as error:
2595
if error.errno == errno.EPERM:
2596
logger.error("No permission to bind to"
2597
" interface %s", self.interface)
2598
elif error.errno == errno.ENOPROTOOPT:
2599
logger.error("SO_BINDTODEVICE not available;"
2600
" cannot bind to interface %s",
2602
elif error.errno == errno.ENODEV:
2603
logger.error("Interface %s does not exist,"
2604
" cannot bind", self.interface)
1590
2607
# Only bind(2) the socket if we really need to.
1591
2608
if self.server_address[0] or self.server_address[1]:
2609
if self.server_address[1]:
2610
self.allow_reuse_address = True
1592
2611
if not self.server_address[0]:
1593
2612
if self.address_family == socket.AF_INET6:
1594
any_address = "::" # in6addr_any
2613
any_address = "::" # in6addr_any
1596
any_address = socket.INADDR_ANY
2615
any_address = "0.0.0.0" # INADDR_ANY
1597
2616
self.server_address = (any_address,
1598
2617
self.server_address[1])
1599
2618
elif not self.server_address[1]:
1600
self.server_address = (self.server_address[0],
2619
self.server_address = (self.server_address[0], 0)
1602
2620
# if self.interface:
1603
2621
# self.server_address = (self.server_address[0],
1849
2949
parser.add_argument("--no-dbus", action="store_false",
1850
2950
dest="use_dbus", help="Do not provide D-Bus"
1851
" system bus interface")
2951
" system bus interface", default=None)
1852
2952
parser.add_argument("--no-ipv6", action="store_false",
1853
dest="use_ipv6", help="Do not use IPv6")
2953
dest="use_ipv6", help="Do not use IPv6",
2955
parser.add_argument("--no-restore", action="store_false",
2956
dest="restore", help="Do not restore stored"
2957
" state", default=None)
2958
parser.add_argument("--socket", type=int,
2959
help="Specify a file descriptor to a network"
2960
" socket to use instead of creating one")
2961
parser.add_argument("--statedir", metavar="DIR",
2962
help="Directory to save/restore state in")
2963
parser.add_argument("--foreground", action="store_true",
2964
help="Run in foreground", default=None)
2965
parser.add_argument("--no-zeroconf", action="store_false",
2966
dest="zeroconf", help="Do not use Zeroconf",
1854
2969
options = parser.parse_args()
1856
2971
if options.check:
2973
fail_count, test_count = doctest.testmod()
2974
sys.exit(os.EX_OK if fail_count == 0 else 1)
1861
2976
# Default values for config file for server-global settings
1862
server_defaults = { "interface": "",
1867
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1868
"servicename": "Mandos",
2977
if gnutls.has_rawpk:
2978
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2979
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2981
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2982
":+SIGN-DSA-SHA256")
2983
server_defaults = {"interface": "",
2987
"priority": priority,
2988
"servicename": "Mandos",
2994
"statedir": "/var/lib/mandos",
2995
"foreground": "False",
1874
3000
# Parse config file for server-global settings
1875
3001
server_config = configparser.SafeConfigParser(server_defaults)
1876
3002
del server_defaults
1877
server_config.read(os.path.join(options.configdir,
3003
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1879
3004
# Convert the SafeConfigParser object to a dict
1880
3005
server_settings = server_config.defaults()
1881
3006
# Use the appropriate methods on the non-string config options
1882
for option in ("debug", "use_dbus", "use_ipv6"):
3007
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3008
"foreground", "zeroconf"):
1883
3009
server_settings[option] = server_config.getboolean("DEFAULT",
1885
3011
if server_settings["port"]:
1886
3012
server_settings["port"] = server_config.getint("DEFAULT",
3014
if server_settings["socket"]:
3015
server_settings["socket"] = server_config.getint("DEFAULT",
3017
# Later, stdin will, and stdout and stderr might, be dup'ed
3018
# over with an opened os.devnull. But we don't want this to
3019
# happen with a supplied network socket.
3020
if 0 <= server_settings["socket"] <= 2:
3021
server_settings["socket"] = os.dup(server_settings
1888
3023
del server_config
1890
3025
# Override the settings from the config file with command line
1891
3026
# options, if set.
1892
3027
for option in ("interface", "address", "port", "debug",
1893
"priority", "servicename", "configdir",
1894
"use_dbus", "use_ipv6", "debuglevel"):
3028
"priority", "servicename", "configdir", "use_dbus",
3029
"use_ipv6", "debuglevel", "restore", "statedir",
3030
"socket", "foreground", "zeroconf"):
1895
3031
value = getattr(options, option)
1896
3032
if value is not None:
1897
3033
server_settings[option] = value
1899
3035
# Force all strings to be unicode
1900
3036
for option in server_settings.keys():
1901
if type(server_settings[option]) is str:
1902
server_settings[option] = unicode(server_settings[option])
3037
if isinstance(server_settings[option], bytes):
3038
server_settings[option] = (server_settings[option]
3040
# Force all boolean options to be boolean
3041
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3042
"foreground", "zeroconf"):
3043
server_settings[option] = bool(server_settings[option])
3044
# Debug implies foreground
3045
if server_settings["debug"]:
3046
server_settings["foreground"] = True
1903
3047
# Now we have our good server settings in "server_settings"
1905
3049
##################################################################
3051
if (not server_settings["zeroconf"]
3052
and not (server_settings["port"]
3053
or server_settings["socket"] != "")):
3054
parser.error("Needs port or socket to work without Zeroconf")
1907
3056
# For convenience
1908
3057
debug = server_settings["debug"]
1909
3058
debuglevel = server_settings["debuglevel"]
1910
3059
use_dbus = server_settings["use_dbus"]
1911
3060
use_ipv6 = server_settings["use_ipv6"]
3061
stored_state_path = os.path.join(server_settings["statedir"],
3063
foreground = server_settings["foreground"]
3064
zeroconf = server_settings["zeroconf"]
3067
initlogger(debug, logging.DEBUG)
3072
level = getattr(logging, debuglevel.upper())
3073
initlogger(debug, level)
1913
3075
if server_settings["servicename"] != "Mandos":
1914
syslogger.setFormatter(logging.Formatter
1915
('Mandos (%s) [%%(process)d]:'
1916
' %%(levelname)s: %%(message)s'
1917
% server_settings["servicename"]))
3076
syslogger.setFormatter(
3077
logging.Formatter('Mandos ({}) [%(process)d]:'
3078
' %(levelname)s: %(message)s'.format(
3079
server_settings["servicename"])))
1919
3081
# Parse config file with clients
1920
client_defaults = { "timeout": "5m",
1921
"extended_timeout": "15m",
1923
"checker": "fping -q -- %%(host)s",
1925
"approval_delay": "0s",
1926
"approval_duration": "1s",
1928
client_config = configparser.SafeConfigParser(client_defaults)
3082
client_config = configparser.SafeConfigParser(Client
1929
3084
client_config.read(os.path.join(server_settings["configdir"],
1930
3085
"clients.conf"))
1932
3087
global mandos_dbus_service
1933
3088
mandos_dbus_service = None
1935
tcp_server = MandosServer((server_settings["address"],
1936
server_settings["port"]),
1938
interface=(server_settings["interface"]
1942
server_settings["priority"],
1945
pidfilename = "/var/run/mandos.pid"
1947
pidfile = open(pidfilename, "w")
1949
logger.error("Could not open file %r", pidfilename)
1952
uid = pwd.getpwnam("_mandos").pw_uid
1953
gid = pwd.getpwnam("_mandos").pw_gid
1956
uid = pwd.getpwnam("mandos").pw_uid
1957
gid = pwd.getpwnam("mandos").pw_gid
3091
if server_settings["socket"] != "":
3092
socketfd = server_settings["socket"]
3093
tcp_server = MandosServer(
3094
(server_settings["address"], server_settings["port"]),
3096
interface=(server_settings["interface"] or None),
3098
gnutls_priority=server_settings["priority"],
3102
pidfilename = "/run/mandos.pid"
3103
if not os.path.isdir("/run/."):
3104
pidfilename = "/var/run/mandos.pid"
3107
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3108
except IOError as e:
3109
logger.error("Could not open file %r", pidfilename,
3112
for name, group in (("_mandos", "_mandos"),
3113
("mandos", "mandos"),
3114
("nobody", "nogroup")):
3116
uid = pwd.getpwnam(name).pw_uid
3117
gid = pwd.getpwnam(group).pw_gid
1958
3119
except KeyError:
1960
uid = pwd.getpwnam("nobody").pw_uid
1961
gid = pwd.getpwnam("nobody").pw_gid
3128
logger.debug("Did setuid/setgid to {}:{}".format(uid,
1968
3130
except OSError as error:
1969
if error[0] != errno.EPERM:
1972
if not debug and not debuglevel:
1973
syslogger.setLevel(logging.WARNING)
1974
console.setLevel(logging.WARNING)
1976
level = getattr(logging, debuglevel.upper())
1977
syslogger.setLevel(level)
1978
console.setLevel(level)
3131
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3132
.format(uid, gid, os.strerror(error.errno)))
3133
if error.errno != errno.EPERM:
1981
3137
# Enable all possible GnuTLS debugging
1983
3139
# "Use a log level over 10 to enable all debugging options."
1984
3140
# - GnuTLS manual
1985
gnutls.library.functions.gnutls_global_set_log_level(11)
1987
@gnutls.library.types.gnutls_log_func
3141
gnutls.global_set_log_level(11)
1988
3144
def debug_gnutls(level, string):
1989
3145
logger.debug("GnuTLS: %s", string[:-1])
1991
(gnutls.library.functions
1992
.gnutls_global_set_log_function(debug_gnutls))
3147
gnutls.global_set_log_function(debug_gnutls)
1994
3149
# Redirect stdin so all checkers get /dev/null
1995
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3150
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1996
3151
os.dup2(null, sys.stdin.fileno())
2000
# No console logging
2001
logger.removeHandler(console)
2003
3155
# Need to fork before connecting to D-Bus
2005
3157
# Close all input and output, do double fork, etc.
3160
# multiprocessing will use threads, so before we use GLib we need
3161
# to inform GLib that threads will be used.
2008
3164
global main_loop
2009
3165
# From the Avahi example code
2010
DBusGMainLoop(set_as_default=True )
2011
main_loop = gobject.MainLoop()
3166
DBusGMainLoop(set_as_default=True)
3167
main_loop = GLib.MainLoop()
2012
3168
bus = dbus.SystemBus()
2013
3169
# End of Avahi example code
2016
3172
bus_name = dbus.service.BusName("se.recompile.Mandos",
2017
bus, do_not_queue=True)
2018
old_bus_name = (dbus.service.BusName
2019
("se.bsnet.fukt.Mandos", bus,
2021
except dbus.exceptions.NameExistsException as e:
2022
logger.error(unicode(e) + ", disabling D-Bus")
3175
old_bus_name = dbus.service.BusName(
3176
"se.bsnet.fukt.Mandos", bus,
3178
except dbus.exceptions.DBusException as e:
3179
logger.error("Disabling D-Bus:", exc_info=e)
2023
3180
use_dbus = False
2024
3181
server_settings["use_dbus"] = False
2025
3182
tcp_server.use_dbus = False
2026
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2027
service = AvahiService(name = server_settings["servicename"],
2028
servicetype = "_mandos._tcp",
2029
protocol = protocol, bus = bus)
2030
if server_settings["interface"]:
2031
service.interface = (if_nametoindex
2032
(str(server_settings["interface"])))
3184
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3185
service = AvahiServiceToSyslog(
3186
name=server_settings["servicename"],
3187
servicetype="_mandos._tcp",
3190
if server_settings["interface"]:
3191
service.interface = if_nametoindex(
3192
server_settings["interface"].encode("utf-8"))
2034
3194
global multiprocessing_manager
2035
3195
multiprocessing_manager = multiprocessing.Manager()
2037
3197
client_class = Client
2039
client_class = functools.partial(ClientDBusTransitional,
2041
def client_config_items(config, section):
2042
special_settings = {
2043
"approved_by_default":
2044
lambda: config.getboolean(section,
2045
"approved_by_default"),
2047
for name, value in config.items(section):
3199
client_class = functools.partial(ClientDBus, bus=bus)
3201
client_settings = Client.config_parser(client_config)
3202
old_client_settings = {}
3205
# This is used to redirect stdout and stderr for checker processes
3207
wnull = open(os.devnull, "w") # A writable /dev/null
3208
# Only used if server is running in foreground but not in debug
3210
if debug or not foreground:
3213
# Get client data and settings from last running state.
3214
if server_settings["restore"]:
3216
with open(stored_state_path, "rb") as stored_state:
3217
if sys.version_info.major == 2:
3218
clients_data, old_client_settings = pickle.load(
3221
bytes_clients_data, bytes_old_client_settings = (
3222
pickle.load(stored_state, encoding="bytes"))
3223
# Fix bytes to strings
3226
clients_data = {(key.decode("utf-8")
3227
if isinstance(key, bytes)
3230
bytes_clients_data.items()}
3231
del bytes_clients_data
3232
for key in clients_data:
3233
value = {(k.decode("utf-8")
3234
if isinstance(k, bytes) else k): v
3236
clients_data[key].items()}
3237
clients_data[key] = value
3239
value["client_structure"] = [
3241
if isinstance(s, bytes)
3243
value["client_structure"]]
3245
for k in ("name", "host"):
3246
if isinstance(value[k], bytes):
3247
value[k] = value[k].decode("utf-8")
3248
if "key_id" not in value:
3249
value["key_id"] = ""
3250
elif "fingerprint" not in value:
3251
value["fingerprint"] = ""
3252
# old_client_settings
3254
old_client_settings = {
3255
(key.decode("utf-8")
3256
if isinstance(key, bytes)
3259
bytes_old_client_settings.items()}
3260
del bytes_old_client_settings
3262
for value in old_client_settings.values():
3263
if isinstance(value["host"], bytes):
3264
value["host"] = (value["host"]
3266
os.remove(stored_state_path)
3267
except IOError as e:
3268
if e.errno == errno.ENOENT:
3269
logger.warning("Could not load persistent state:"
3270
" {}".format(os.strerror(e.errno)))
3272
logger.critical("Could not load persistent state:",
3275
except EOFError as e:
3276
logger.warning("Could not load persistent state: "
3280
with PGPEngine() as pgp:
3281
for client_name, client in clients_data.items():
3282
# Skip removed clients
3283
if client_name not in client_settings:
3286
# Decide which value to use after restoring saved state.
3287
# We have three different values: Old config file,
3288
# new config file, and saved state.
3289
# New config value takes precedence if it differs from old
3290
# config value, otherwise use saved state.
3291
for name, value in client_settings[client_name].items():
3293
# For each value in new config, check if it
3294
# differs from the old config value (Except for
3295
# the "secret" attribute)
3296
if (name != "secret"
3298
old_client_settings[client_name][name])):
3299
client[name] = value
3303
# Clients who has passed its expire date can still be
3304
# enabled if its last checker was successful. A Client
3305
# whose checker succeeded before we stored its state is
3306
# assumed to have successfully run all checkers during
3308
if client["enabled"]:
3309
if datetime.datetime.utcnow() >= client["expires"]:
3310
if not client["last_checked_ok"]:
3312
"disabling client {} - Client never "
3313
"performed a successful checker".format(
3315
client["enabled"] = False
3316
elif client["last_checker_status"] != 0:
3318
"disabling client {} - Client last"
3319
" checker failed with error code"
3322
client["last_checker_status"]))
3323
client["enabled"] = False
3325
client["expires"] = (
3326
datetime.datetime.utcnow()
3327
+ client["timeout"])
3328
logger.debug("Last checker succeeded,"
3329
" keeping {} enabled".format(
2049
yield (name, special_settings[name]())
2053
tcp_server.clients.update(set(
2054
client_class(name = section,
2055
config= dict(client_config_items(
2056
client_config, section)))
2057
for section in client_config.sections()))
3332
client["secret"] = pgp.decrypt(
3333
client["encrypted_secret"],
3334
client_settings[client_name]["secret"])
3336
# If decryption fails, we use secret from new settings
3337
logger.debug("Failed to decrypt {} old secret".format(
3339
client["secret"] = (client_settings[client_name]
3342
# Add/remove clients based on new changes made to config
3343
for client_name in (set(old_client_settings)
3344
- set(client_settings)):
3345
del clients_data[client_name]
3346
for client_name in (set(client_settings)
3347
- set(old_client_settings)):
3348
clients_data[client_name] = client_settings[client_name]
3350
# Create all client objects
3351
for client_name, client in clients_data.items():
3352
tcp_server.clients[client_name] = client_class(
3355
server_settings=server_settings)
2058
3357
if not tcp_server.clients:
2059
3358
logger.warning("No clients defined")
2065
pidfile.write(str(pid) + "\n".encode("utf-8"))
2068
logger.error("Could not write to file %r with PID %d",
2071
# "pidfile" was never created
3361
if pidfile is not None:
3365
print(pid, file=pidfile)
3367
logger.error("Could not write to file %r with PID %d",
2073
3370
del pidfilename
2075
signal.signal(signal.SIGINT, signal.SIG_IGN)
2077
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2078
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3372
for termsig in (signal.SIGHUP, signal.SIGTERM):
3373
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3374
lambda: main_loop.quit() and False)
2081
class MandosDBusService(dbus.service.Object):
3378
@alternate_dbus_interfaces(
3379
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3380
class MandosDBusService(DBusObjectWithObjectManager):
2082
3381
"""A D-Bus proxy object"""
2083
3383
def __init__(self):
2084
3384
dbus.service.Object.__init__(self, bus, "/")
2085
3386
_interface = "se.recompile.Mandos"
2087
3388
@dbus.service.signal(_interface, signature="o")
2088
3389
def ClientAdded(self, objpath):
2092
3393
@dbus.service.signal(_interface, signature="ss")
2093
def ClientNotFound(self, fingerprint, address):
3394
def ClientNotFound(self, key_id, address):
3398
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2097
3400
@dbus.service.signal(_interface, signature="os")
2098
3401
def ClientRemoved(self, objpath, name):
3405
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2102
3407
@dbus.service.method(_interface, out_signature="ao")
2103
3408
def GetAllClients(self):
2105
return dbus.Array(c.dbus_object_path
2106
for c in tcp_server.clients)
3410
return dbus.Array(c.dbus_object_path for c in
3411
tcp_server.clients.values())
3413
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2108
3415
@dbus.service.method(_interface,
2109
3416
out_signature="a{oa{sv}}")
2110
3417
def GetAllClientsWithProperties(self):
2112
3419
return dbus.Dictionary(
2113
((c.dbus_object_path, c.GetAll(""))
2114
for c in tcp_server.clients),
3420
{c.dbus_object_path: c.GetAll(
3421
"se.recompile.Mandos.Client")
3422
for c in tcp_server.clients.values()},
2115
3423
signature="oa{sv}")
2117
3425
@dbus.service.method(_interface, in_signature="o")
2118
3426
def RemoveClient(self, object_path):
2120
for c in tcp_server.clients:
3428
for c in tcp_server.clients.values():
2121
3429
if c.dbus_object_path == object_path:
2122
tcp_server.clients.remove(c)
3430
del tcp_server.clients[c.name]
2123
3431
c.remove_from_connection()
2124
# Don't signal anything except ClientRemoved
3432
# Don't signal the disabling
2125
3433
c.disable(quiet=True)
2127
self.ClientRemoved(object_path, c.name)
3434
# Emit D-Bus signal for removal
3435
self.client_removed_signal(c)
2129
3437
raise KeyError(object_path)
2133
class MandosDBusServiceTransitional(MandosDBusService):
2134
__metaclass__ = AlternateDBusNamesMetaclass
2135
mandos_dbus_service = MandosDBusServiceTransitional()
3441
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3442
out_signature="a{oa{sa{sv}}}")
3443
def GetManagedObjects(self):
3445
return dbus.Dictionary(
3446
{client.dbus_object_path:
3448
{interface: client.GetAll(interface)
3450
client._get_all_interface_names()})
3451
for client in tcp_server.clients.values()})
3453
def client_added_signal(self, client):
3454
"""Send the new standard signal and the old signal"""
3456
# New standard signal
3457
self.InterfacesAdded(
3458
client.dbus_object_path,
3460
{interface: client.GetAll(interface)
3462
client._get_all_interface_names()}))
3464
self.ClientAdded(client.dbus_object_path)
3466
def client_removed_signal(self, client):
3467
"""Send the new standard signal and the old signal"""
3469
# New standard signal
3470
self.InterfacesRemoved(
3471
client.dbus_object_path,
3472
client._get_all_interface_names())
3474
self.ClientRemoved(client.dbus_object_path,
3477
mandos_dbus_service = MandosDBusService()
3479
# Save modules to variables to exempt the modules from being
3480
# unloaded before the function registered with atexit() is run.
3481
mp = multiprocessing
2138
3485
"Cleanup function; run on exit"
2141
multiprocessing.active_children()
3489
mp.active_children()
3491
if not (tcp_server.clients or client_settings):
3494
# Store client before exiting. Secrets are encrypted with key
3495
# based on what config file has. If config file is
3496
# removed/edited, old secret will thus be unrecovable.
3498
with PGPEngine() as pgp:
3499
for client in tcp_server.clients.values():
3500
key = client_settings[client.name]["secret"]
3501
client.encrypted_secret = pgp.encrypt(client.secret,
3505
# A list of attributes that can not be pickled
3507
exclude = {"bus", "changedstate", "secret",
3508
"checker", "server_settings"}
3509
for name, typ in inspect.getmembers(dbus.service
3513
client_dict["encrypted_secret"] = (client
3515
for attr in client.client_structure:
3516
if attr not in exclude:
3517
client_dict[attr] = getattr(client, attr)
3519
clients[client.name] = client_dict
3520
del client_settings[client.name]["secret"]
3523
with tempfile.NamedTemporaryFile(
3527
dir=os.path.dirname(stored_state_path),
3528
delete=False) as stored_state:
3529
pickle.dump((clients, client_settings), stored_state,
3531
tempname = stored_state.name
3532
os.rename(tempname, stored_state_path)
3533
except (IOError, OSError) as e:
3539
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3540
logger.warning("Could not save persistent state: {}"
3541
.format(os.strerror(e.errno)))
3543
logger.warning("Could not save persistent state:",
3547
# Delete all clients, and settings from config
2142
3548
while tcp_server.clients:
2143
client = tcp_server.clients.pop()
3549
name, client = tcp_server.clients.popitem()
2145
3551
client.remove_from_connection()
2146
client.disable_hook = None
2147
# Don't signal anything except ClientRemoved
3552
# Don't signal the disabling
2148
3553
client.disable(quiet=True)
3554
# Emit D-Bus signal for removal
2151
mandos_dbus_service.ClientRemoved(client
3556
mandos_dbus_service.client_removed_signal(client)
3557
client_settings.clear()
2155
3559
atexit.register(cleanup)
2157
for client in tcp_server.clients:
3561
for client in tcp_server.clients.values():
2160
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3563
# Emit D-Bus signal for adding
3564
mandos_dbus_service.client_added_signal(client)
3565
# Need to initiate checking of clients
3567
client.init_checker()
2163
3569
tcp_server.enable()
2164
3570
tcp_server.server_activate()
2166
3572
# Find out what port we got
2167
service.port = tcp_server.socket.getsockname()[1]
3574
service.port = tcp_server.socket.getsockname()[1]
2169
3576
logger.info("Now listening on address %r, port %d,"
2170
" flowinfo %d, scope_id %d"
2171
% tcp_server.socket.getsockname())
3577
" flowinfo %d, scope_id %d",
3578
*tcp_server.socket.getsockname())
2173
logger.info("Now listening on address %r, port %d"
2174
% tcp_server.socket.getsockname())
2176
#service.interface = tcp_server.socket.getsockname()[3]
3580
logger.info("Now listening on address %r, port %d",
3581
*tcp_server.socket.getsockname())
3583
# service.interface = tcp_server.socket.getsockname()[3]
2179
# From the Avahi example code
2182
except dbus.exceptions.DBusException as error:
2183
logger.critical("DBusException: %s", error)
2186
# End of Avahi example code
2188
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2189
lambda *args, **kwargs:
2190
(tcp_server.handle_request
2191
(*args[2:], **kwargs) or True))
3587
# From the Avahi example code
3590
except dbus.exceptions.DBusException as error:
3591
logger.critical("D-Bus Exception", exc_info=error)
3594
# End of Avahi example code
3596
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3597
lambda *args, **kwargs:
3598
(tcp_server.handle_request
3599
(*args[2:], **kwargs) or True))
2193
3601
logger.debug("Starting main loop")
2194
3602
main_loop.run()
2195
3603
except AvahiError as error:
2196
logger.critical("AvahiError: %s", error)
3604
logger.critical("Avahi Error", exc_info=error)
2199
3607
except KeyboardInterrupt: