70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
84
68
import dbus.service
86
from gi.repository import GLib
87
71
from dbus.mainloop.glib import DBusGMainLoop
90
74
import xml.dom.minidom
93
if sys.version_info.major == 2:
97
# Add collections.abc.Callable if it does not exist
99
collections.abc.Callable
100
except AttributeError:
102
Callable = collections.Callable
103
collections.abc = abc
106
# Show warnings by default
107
if not sys.warnoptions:
109
warnings.simplefilter("default")
111
# Try to find the value of SO_BINDTODEVICE:
113
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
114
# newer, and it is also the most natural place for it:
115
78
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
116
79
except AttributeError:
118
# This is where SO_BINDTODEVICE was up to and including Python
120
81
from IN import SO_BINDTODEVICE
121
82
except ImportError:
122
# In Python 2.7 it seems to have been removed entirely.
123
# Try running the C preprocessor:
125
cc = subprocess.Popen(["cc", "--language=c", "-E",
127
stdin=subprocess.PIPE,
128
stdout=subprocess.PIPE)
129
stdout = cc.communicate(
130
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
131
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
132
except (OSError, ValueError, IndexError):
134
SO_BINDTODEVICE = None
136
if sys.version_info < (3, 2):
137
configparser.Configparser = configparser.SafeConfigParser
140
stored_state_file = "clients.pickle"
142
logger = logging.getLogger()
143
logging.captureWarnings(True) # Show warnings via the logging system
147
if_nametoindex = ctypes.cdll.LoadLibrary(
148
ctypes.util.find_library("c")).if_nametoindex
149
except (OSError, AttributeError):
151
def if_nametoindex(interface):
152
"Get an interface index the hard way, i.e. using fcntl()"
153
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
154
with contextlib.closing(socket.socket()) as s:
155
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
156
struct.pack(b"16s16x", interface))
157
interface_index = struct.unpack("I", ifreq[16:20])[0]
158
return interface_index
161
def copy_function(func):
162
"""Make a copy of a function"""
163
if sys.version_info.major == 2:
164
return types.FunctionType(func.func_code,
170
return types.FunctionType(func.__code__,
177
def initlogger(debug, level=logging.WARNING):
178
"""init logger and add loglevel"""
181
syslogger = (logging.handlers.SysLogHandler(
182
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
184
syslogger.setFormatter(logging.Formatter
185
('Mandos [%(process)d]: %(levelname)s:'
187
logger.addHandler(syslogger)
190
console = logging.StreamHandler()
191
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
195
logger.addHandler(console)
196
logger.setLevel(level)
199
class PGPError(Exception):
200
"""Exception if encryption/decryption fails"""
205
"""A simple class for OpenPGP symmetric encryption & decryption"""
208
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
211
output = subprocess.check_output(["gpgconf"])
212
for line in output.splitlines():
213
name, text, path = line.split(b":")
218
if e.errno != errno.ENOENT:
220
self.gnupgargs = ['--batch',
221
'--homedir', self.tempdir,
224
# Only GPG version 1 has the --no-use-agent option.
225
if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
226
self.gnupgargs.append("--no-use-agent")
231
def __exit__(self, exc_type, exc_value, traceback):
239
if self.tempdir is not None:
240
# Delete contents of tempdir
241
for root, dirs, files in os.walk(self.tempdir,
243
for filename in files:
244
os.remove(os.path.join(root, filename))
246
os.rmdir(os.path.join(root, dirname))
248
os.rmdir(self.tempdir)
251
def password_encode(self, password):
252
# Passphrase can not be empty and can not contain newlines or
253
# NUL bytes. So we prefix it and hex encode it.
254
encoded = b"mandos" + binascii.hexlify(password)
255
if len(encoded) > 2048:
256
# GnuPG can't handle long passwords, so encode differently
257
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
258
.replace(b"\n", b"\\n")
259
.replace(b"\0", b"\\x00"))
262
def encrypt(self, data, password):
263
passphrase = self.password_encode(password)
264
with tempfile.NamedTemporaryFile(
265
dir=self.tempdir) as passfile:
266
passfile.write(passphrase)
268
proc = subprocess.Popen([self.gpg, '--symmetric',
272
stdin=subprocess.PIPE,
273
stdout=subprocess.PIPE,
274
stderr=subprocess.PIPE)
275
ciphertext, err = proc.communicate(input=data)
276
if proc.returncode != 0:
280
def decrypt(self, data, password):
281
passphrase = self.password_encode(password)
282
with tempfile.NamedTemporaryFile(
283
dir=self.tempdir) as passfile:
284
passfile.write(passphrase)
286
proc = subprocess.Popen([self.gpg, '--decrypt',
290
stdin=subprocess.PIPE,
291
stdout=subprocess.PIPE,
292
stderr=subprocess.PIPE)
293
decrypted_plaintext, err = proc.communicate(input=data)
294
if proc.returncode != 0:
296
return decrypted_plaintext
299
# Pretend that we have an Avahi module
301
"""This isn't so much a class as it is a module-like namespace."""
302
IF_UNSPEC = -1 # avahi-common/address.h
303
PROTO_UNSPEC = -1 # avahi-common/address.h
304
PROTO_INET = 0 # avahi-common/address.h
305
PROTO_INET6 = 1 # avahi-common/address.h
306
DBUS_NAME = "org.freedesktop.Avahi"
307
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
308
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
309
DBUS_PATH_SERVER = "/"
312
def string_array_to_txt_array(t):
313
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
314
for s in t), signature="ay")
315
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
316
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
317
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
318
SERVER_INVALID = 0 # avahi-common/defs.h
319
SERVER_REGISTERING = 1 # avahi-common/defs.h
320
SERVER_RUNNING = 2 # avahi-common/defs.h
321
SERVER_COLLISION = 3 # avahi-common/defs.h
322
SERVER_FAILURE = 4 # avahi-common/defs.h
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)
325
104
class AvahiError(Exception):
326
105
def __init__(self, value, *args, **kwargs):
327
106
self.value = value
328
return super(AvahiError, self).__init__(value, *args,
107
super(AvahiError, self).__init__(value, *args, **kwargs)
108
def __unicode__(self):
109
return unicode(repr(self.value))
332
111
class AvahiServiceError(AvahiError):
336
114
class AvahiGroupError(AvahiError):
118
class AvahiService(object):
341
119
"""An Avahi (Zeroconf) service.
344
122
interface: integer; avahi.IF_UNSPEC or an interface index.
345
123
Used to optionally bind to the specified interface.
346
124
name: string; Example: 'Mandos'
347
125
type: string; Example: '_mandos._tcp'.
348
See <https://www.iana.org/assignments/service-names-port-numbers>
126
See <http://www.dns-sd.org/ServiceTypes.html>
349
127
port: integer; what port to announce
350
128
TXT: list of strings; TXT record for the service
351
129
domain: string; Domain to publish on, default to .local if empty.
510
261
follow_name_owner_changes=True),
511
262
avahi.DBUS_INTERFACE_SERVER)
512
263
self.server.connect_to_signal("StateChanged",
513
self.server_state_changed)
264
self.server_state_changed)
514
265
self.server_state_changed(self.server.GetState())
517
class AvahiServiceToSyslog(AvahiService):
518
def rename(self, *args, **kwargs):
519
"""Add the new name to the syslog messages"""
520
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
521
syslogger.setFormatter(logging.Formatter(
522
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
527
# Pretend that we have a GnuTLS module
529
"""This isn't so much a class as it is a module-like namespace."""
531
library = ctypes.util.find_library("gnutls")
533
library = ctypes.util.find_library("gnutls-deb0")
534
_library = ctypes.cdll.LoadLibrary(library)
537
# Unless otherwise indicated, the constants and types below are
538
# all from the gnutls/gnutls.h C header file.
549
E_NO_CERTIFICATE_FOUND = -49
554
KEYID_USE_SHA256 = 1 # gnutls/x509.h
555
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
558
class session_int(ctypes.Structure):
560
session_t = ctypes.POINTER(session_int)
562
class certificate_credentials_st(ctypes.Structure):
564
certificate_credentials_t = ctypes.POINTER(
565
certificate_credentials_st)
566
certificate_type_t = ctypes.c_int
568
class datum_t(ctypes.Structure):
569
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
570
('size', ctypes.c_uint)]
572
class openpgp_crt_int(ctypes.Structure):
574
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
575
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
576
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
577
credentials_type_t = ctypes.c_int
578
transport_ptr_t = ctypes.c_void_p
579
close_request_t = ctypes.c_int
582
class Error(Exception):
583
def __init__(self, message=None, code=None, args=()):
584
# Default usage is by a message string, but if a return
585
# code is passed, convert it to a string with
588
if message is None and code is not None:
589
message = gnutls.strerror(code)
590
return super(gnutls.Error, self).__init__(
593
class CertificateSecurityError(Error):
599
self._c_object = gnutls.certificate_credentials_t()
600
gnutls.certificate_allocate_credentials(
601
ctypes.byref(self._c_object))
602
self.type = gnutls.CRD_CERTIFICATE
605
gnutls.certificate_free_credentials(self._c_object)
608
def __init__(self, socket, credentials=None):
609
self._c_object = gnutls.session_t()
610
gnutls_flags = gnutls.CLIENT
611
if gnutls.check_version(b"3.5.6"):
612
gnutls_flags |= gnutls.NO_TICKETS
614
gnutls_flags |= gnutls.ENABLE_RAWPK
615
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
617
gnutls.set_default_priority(self._c_object)
618
gnutls.transport_set_ptr(self._c_object, socket.fileno())
619
gnutls.handshake_set_private_extensions(self._c_object,
622
if credentials is None:
623
credentials = gnutls.Credentials()
624
gnutls.credentials_set(self._c_object, credentials.type,
625
ctypes.cast(credentials._c_object,
627
self.credentials = credentials
630
gnutls.deinit(self._c_object)
633
return gnutls.handshake(self._c_object)
635
def send(self, data):
639
data_len -= gnutls.record_send(self._c_object,
644
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
646
# Error handling functions
647
def _error_code(result):
648
"""A function to raise exceptions on errors, suitable
649
for the 'restype' attribute on ctypes functions"""
652
if result == gnutls.E_NO_CERTIFICATE_FOUND:
653
raise gnutls.CertificateSecurityError(code=result)
654
raise gnutls.Error(code=result)
656
def _retry_on_error(result, func, arguments):
657
"""A function to retry on some errors, suitable
658
for the 'errcheck' attribute on ctypes functions"""
660
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
661
return _error_code(result)
662
result = func(*arguments)
665
# Unless otherwise indicated, the function declarations below are
666
# all from the gnutls/gnutls.h C header file.
669
priority_set_direct = _library.gnutls_priority_set_direct
670
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
671
ctypes.POINTER(ctypes.c_char_p)]
672
priority_set_direct.restype = _error_code
674
init = _library.gnutls_init
675
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
676
init.restype = _error_code
678
set_default_priority = _library.gnutls_set_default_priority
679
set_default_priority.argtypes = [session_t]
680
set_default_priority.restype = _error_code
682
record_send = _library.gnutls_record_send
683
record_send.argtypes = [session_t, ctypes.c_void_p,
685
record_send.restype = ctypes.c_ssize_t
686
record_send.errcheck = _retry_on_error
688
certificate_allocate_credentials = (
689
_library.gnutls_certificate_allocate_credentials)
690
certificate_allocate_credentials.argtypes = [
691
ctypes.POINTER(certificate_credentials_t)]
692
certificate_allocate_credentials.restype = _error_code
694
certificate_free_credentials = (
695
_library.gnutls_certificate_free_credentials)
696
certificate_free_credentials.argtypes = [
697
certificate_credentials_t]
698
certificate_free_credentials.restype = None
700
handshake_set_private_extensions = (
701
_library.gnutls_handshake_set_private_extensions)
702
handshake_set_private_extensions.argtypes = [session_t,
704
handshake_set_private_extensions.restype = None
706
credentials_set = _library.gnutls_credentials_set
707
credentials_set.argtypes = [session_t, credentials_type_t,
709
credentials_set.restype = _error_code
711
strerror = _library.gnutls_strerror
712
strerror.argtypes = [ctypes.c_int]
713
strerror.restype = ctypes.c_char_p
715
certificate_type_get = _library.gnutls_certificate_type_get
716
certificate_type_get.argtypes = [session_t]
717
certificate_type_get.restype = _error_code
719
certificate_get_peers = _library.gnutls_certificate_get_peers
720
certificate_get_peers.argtypes = [session_t,
721
ctypes.POINTER(ctypes.c_uint)]
722
certificate_get_peers.restype = ctypes.POINTER(datum_t)
724
global_set_log_level = _library.gnutls_global_set_log_level
725
global_set_log_level.argtypes = [ctypes.c_int]
726
global_set_log_level.restype = None
728
global_set_log_function = _library.gnutls_global_set_log_function
729
global_set_log_function.argtypes = [log_func]
730
global_set_log_function.restype = None
732
deinit = _library.gnutls_deinit
733
deinit.argtypes = [session_t]
734
deinit.restype = None
736
handshake = _library.gnutls_handshake
737
handshake.argtypes = [session_t]
738
handshake.restype = _error_code
739
handshake.errcheck = _retry_on_error
741
transport_set_ptr = _library.gnutls_transport_set_ptr
742
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
743
transport_set_ptr.restype = None
745
bye = _library.gnutls_bye
746
bye.argtypes = [session_t, close_request_t]
747
bye.restype = _error_code
748
bye.errcheck = _retry_on_error
750
check_version = _library.gnutls_check_version
751
check_version.argtypes = [ctypes.c_char_p]
752
check_version.restype = ctypes.c_char_p
754
_need_version = b"3.3.0"
755
if check_version(_need_version) is None:
756
raise self.Error("Needs GnuTLS {} or later"
757
.format(_need_version))
759
_tls_rawpk_version = b"3.6.6"
760
has_rawpk = bool(check_version(_tls_rawpk_version))
764
class pubkey_st(ctypes.Structure):
766
pubkey_t = ctypes.POINTER(pubkey_st)
768
x509_crt_fmt_t = ctypes.c_int
770
# All the function declarations below are from gnutls/abstract.h
771
pubkey_init = _library.gnutls_pubkey_init
772
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
773
pubkey_init.restype = _error_code
775
pubkey_import = _library.gnutls_pubkey_import
776
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
778
pubkey_import.restype = _error_code
780
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
781
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
782
ctypes.POINTER(ctypes.c_ubyte),
783
ctypes.POINTER(ctypes.c_size_t)]
784
pubkey_get_key_id.restype = _error_code
786
pubkey_deinit = _library.gnutls_pubkey_deinit
787
pubkey_deinit.argtypes = [pubkey_t]
788
pubkey_deinit.restype = None
790
# All the function declarations below are from gnutls/openpgp.h
792
openpgp_crt_init = _library.gnutls_openpgp_crt_init
793
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
794
openpgp_crt_init.restype = _error_code
796
openpgp_crt_import = _library.gnutls_openpgp_crt_import
797
openpgp_crt_import.argtypes = [openpgp_crt_t,
798
ctypes.POINTER(datum_t),
800
openpgp_crt_import.restype = _error_code
802
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
803
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
804
ctypes.POINTER(ctypes.c_uint)]
805
openpgp_crt_verify_self.restype = _error_code
807
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
808
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
809
openpgp_crt_deinit.restype = None
811
openpgp_crt_get_fingerprint = (
812
_library.gnutls_openpgp_crt_get_fingerprint)
813
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
817
openpgp_crt_get_fingerprint.restype = _error_code
819
if check_version(b"3.6.4"):
820
certificate_type_get2 = _library.gnutls_certificate_type_get2
821
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
822
certificate_type_get2.restype = _error_code
824
# Remove non-public functions
825
del _error_code, _retry_on_error
828
def call_pipe(connection, # : multiprocessing.Connection
829
func, *args, **kwargs):
830
"""This function is meant to be called by multiprocessing.Process
832
This function runs func(*args, **kwargs), and writes the resulting
833
return value on the provided multiprocessing.Connection.
835
connection.send(func(*args, **kwargs))
268
def _timedelta_to_milliseconds(td):
269
"Convert a datetime.timedelta() to milliseconds"
270
return ((td.days * 24 * 60 * 60 * 1000)
271
+ (td.seconds * 1000)
272
+ (td.microseconds // 1000))
274
class Client(object):
840
275
"""A representation of a client host served by this server.
843
approved: bool(); 'None' if not yet approved/disapproved
278
_approved: bool(); 'None' if not yet approved/disapproved
844
279
approval_delay: datetime.timedelta(); Time to wait for approval
845
280
approval_duration: datetime.timedelta(); Duration of one approval
846
checker: multiprocessing.Process(); a running checker process used
847
to see if the client lives. 'None' if no process is
849
checker_callback_tag: a GLib event source tag, or None
281
checker: subprocess.Popen(); a running checker process used
282
to see if the client lives.
283
'None' if no process is running.
284
checker_callback_tag: a gobject event source tag, or None
850
285
checker_command: string; External command which is run to check
851
286
if client lives. %() expansions are done at
852
287
runtime with vars(self) as dict, so that for
853
288
instance %(name)s can be used in the command.
854
checker_initiator_tag: a GLib event source tag, or None
289
checker_initiator_tag: a gobject event source tag, or None
855
290
created: datetime.datetime(); (UTC) object creation
856
client_structure: Object describing what attributes a client has
857
and is used for storing the client at exit
858
291
current_checker_command: string; current running checker_command
859
disable_initiator_tag: a GLib event source tag, or None
292
disable_hook: If set, called by disable() as disable_hook(self)
293
disable_initiator_tag: a gobject event source tag, or None
861
295
fingerprint: string (40 or 32 hexadecimal digits); used to
862
uniquely identify an OpenPGP client
863
key_id: string (64 hexadecimal digits); used to uniquely identify
864
a client using raw public keys
296
uniquely identify the client
865
297
host: string; available for use by the checker command
866
298
interval: datetime.timedelta(); How often to start a new checker
867
299
last_approval_request: datetime.datetime(); (UTC) or None
868
300
last_checked_ok: datetime.datetime(); (UTC) or None
869
last_checker_status: integer between 0 and 255 reflecting exit
870
status of last checker. -1 reflects crashed
871
checker, -2 means no checker completed yet.
872
last_checker_signal: The signal which killed the last checker, if
873
last_checker_status is -1
874
last_enabled: datetime.datetime(); (UTC) or None
301
last_enabled: datetime.datetime(); (UTC)
875
302
name: string; from the config file, used in log messages and
876
303
D-Bus identifiers
877
304
secret: bytestring; sent verbatim (over TLS) to client
878
305
timeout: datetime.timedelta(); How long from last_checked_ok
879
306
until this client is disabled
880
extended_timeout: extra long timeout when secret has been sent
307
extended_timeout: extra long timeout when password has been sent
881
308
runtime_expansions: Allowed attributes for runtime expansion.
882
309
expires: datetime.datetime(); time (UTC) when a client will be
883
310
disabled, or None
884
server_settings: The server_settings dict from main()
887
313
runtime_expansions = ("approval_delay", "approval_duration",
888
"created", "enabled", "expires", "key_id",
889
"fingerprint", "host", "interval",
890
"last_approval_request", "last_checked_ok",
314
"created", "enabled", "fingerprint",
315
"host", "interval", "last_checked_ok",
891
316
"last_enabled", "name", "timeout")
894
"extended_timeout": "PT15M",
896
"checker": "fping -q -- %%(host)s",
898
"approval_delay": "PT0S",
899
"approval_duration": "PT1S",
900
"approved_by_default": "True",
905
def config_parser(config):
906
"""Construct a new dict of client settings of this form:
907
{ client_name: {setting_name: value, ...}, ...}
908
with exceptions for any special settings as defined above.
909
NOTE: Must be a pure function. Must return the same result
910
value given the same arguments.
913
for client_name in config.sections():
914
section = dict(config.items(client_name))
915
client = settings[client_name] = {}
917
client["host"] = section["host"]
918
# Reformat values from string types to Python types
919
client["approved_by_default"] = config.getboolean(
920
client_name, "approved_by_default")
921
client["enabled"] = config.getboolean(client_name,
924
# Uppercase and remove spaces from key_id and fingerprint
925
# for later comparison purposes with return value from the
926
# key_id() and fingerprint() functions
927
client["key_id"] = (section.get("key_id", "").upper()
929
client["fingerprint"] = (section["fingerprint"].upper()
931
if "secret" in section:
932
client["secret"] = codecs.decode(section["secret"]
935
elif "secfile" in section:
936
with open(os.path.expanduser(os.path.expandvars
937
(section["secfile"])),
939
client["secret"] = secfile.read()
941
raise TypeError("No secret or secfile for section {}"
943
client["timeout"] = string_to_delta(section["timeout"])
944
client["extended_timeout"] = string_to_delta(
945
section["extended_timeout"])
946
client["interval"] = string_to_delta(section["interval"])
947
client["approval_delay"] = string_to_delta(
948
section["approval_delay"])
949
client["approval_duration"] = string_to_delta(
950
section["approval_duration"])
951
client["checker_command"] = section["checker"]
952
client["last_approval_request"] = None
953
client["last_checked_ok"] = None
954
client["last_checker_status"] = -2
958
def __init__(self, settings, name=None, server_settings=None):
318
def timeout_milliseconds(self):
319
"Return the 'timeout' attribute in milliseconds"
320
return _timedelta_to_milliseconds(self.timeout)
322
def extended_timeout_milliseconds(self):
323
"Return the 'extended_timeout' attribute in milliseconds"
324
return _timedelta_to_milliseconds(self.extended_timeout)
326
def interval_milliseconds(self):
327
"Return the 'interval' attribute in milliseconds"
328
return _timedelta_to_milliseconds(self.interval)
330
def approval_delay_milliseconds(self):
331
return _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'
960
if server_settings is None:
962
self.server_settings = server_settings
963
# adding all client settings
964
for setting, value in settings.items():
965
setattr(self, setting, value)
968
if not hasattr(self, "last_enabled"):
969
self.last_enabled = datetime.datetime.utcnow()
970
if not hasattr(self, "expires"):
971
self.expires = (datetime.datetime.utcnow()
974
self.last_enabled = None
977
340
logger.debug("Creating client %r", self.name)
978
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()
979
346
logger.debug(" Fingerprint: %s", self.fingerprint)
980
self.created = settings.get("created",
981
datetime.datetime.utcnow())
983
# 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
984
367
self.checker = None
985
368
self.checker_initiator_tag = None
986
369
self.disable_initiator_tag = None
987
371
self.checker_callback_tag = None
372
self.checker_command = config["checker"]
988
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",
990
378
self.approvals_pending = 0
991
self.changedstate = multiprocessing_manager.Condition(
992
multiprocessing_manager.Lock())
993
self.client_structure = [attr
994
for attr in self.__dict__.keys()
995
if not attr.startswith("_")]
996
self.client_structure.append("client_structure")
998
for name, t in inspect.getmembers(
999
type(self), lambda obj: isinstance(obj, property)):
1000
if not name.startswith("_"):
1001
self.client_structure.append(name)
1003
# 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())
1004
385
def send_changedstate(self):
1005
with self.changedstate:
1006
self.changedstate.notify_all()
386
self.changedstate.acquire()
387
self.changedstate.notify_all()
388
self.changedstate.release()
1008
390
def enable(self):
1009
391
"""Start this client's checker and timeout hooks"""
1010
392
if getattr(self, "enabled", False):
1011
393
# Already enabled
395
self.send_changedstate()
396
# Schedule a new checker to be started an 'interval' from now,
397
# and every interval from then on.
398
self.checker_initiator_tag = (gobject.timeout_add
399
(self.interval_milliseconds(),
401
# Schedule a disable() when 'timeout' has passed
1013
402
self.expires = datetime.datetime.utcnow() + self.timeout
403
self.disable_initiator_tag = (gobject.timeout_add
404
(self.timeout_milliseconds(),
1014
406
self.enabled = True
1015
407
self.last_enabled = datetime.datetime.utcnow()
1017
self.send_changedstate()
408
# Also start a new checker *right now*.
1019
411
def disable(self, quiet=True):
1020
412
"""Disable this client."""
1021
413
if not getattr(self, "enabled", False):
416
self.send_changedstate()
1024
418
logger.info("Disabling client %s", self.name)
1025
if getattr(self, "disable_initiator_tag", None) is not None:
1026
GLib.source_remove(self.disable_initiator_tag)
419
if getattr(self, "disable_initiator_tag", False):
420
gobject.source_remove(self.disable_initiator_tag)
1027
421
self.disable_initiator_tag = None
1028
422
self.expires = None
1029
if getattr(self, "checker_initiator_tag", None) is not None:
1030
GLib.source_remove(self.checker_initiator_tag)
423
if getattr(self, "checker_initiator_tag", False):
424
gobject.source_remove(self.checker_initiator_tag)
1031
425
self.checker_initiator_tag = None
1032
426
self.stop_checker()
427
if self.disable_hook:
428
self.disable_hook(self)
1033
429
self.enabled = False
1035
self.send_changedstate()
1036
# 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
1039
433
def __del__(self):
434
self.disable_hook = None
1042
def init_checker(self):
1043
# Schedule a new checker to be started an 'interval' from now,
1044
# and every interval from then on.
1045
if self.checker_initiator_tag is not None:
1046
GLib.source_remove(self.checker_initiator_tag)
1047
self.checker_initiator_tag = GLib.timeout_add(
1048
random.randrange(int(self.interval.total_seconds() * 1000
1051
# Schedule a disable() when 'timeout' has passed
1052
if self.disable_initiator_tag is not None:
1053
GLib.source_remove(self.disable_initiator_tag)
1054
self.disable_initiator_tag = GLib.timeout_add(
1055
int(self.timeout.total_seconds() * 1000), self.disable)
1056
# Also start a new checker *right now*.
1057
self.start_checker()
1059
def checker_callback(self, source, condition, connection,
437
def checker_callback(self, pid, condition, command):
1061
438
"""The checker has completed, so take appropriate actions."""
1062
# Read return code from connection (see call_pipe)
1063
returncode = connection.recv()
1065
if self.checker is not None:
1067
439
self.checker_callback_tag = None
1068
440
self.checker = None
1071
self.last_checker_status = returncode
1072
self.last_checker_signal = None
1073
if self.last_checker_status == 0:
441
if os.WIFEXITED(condition):
442
exitstatus = os.WEXITSTATUS(condition)
1074
444
logger.info("Checker for %(name)s succeeded",
1076
446
self.checked_ok()
1078
logger.info("Checker for %(name)s failed", vars(self))
448
logger.info("Checker for %(name)s failed",
1080
self.last_checker_status = -1
1081
self.last_checker_signal = -returncode
1082
451
logger.warning("Checker for %(name)s crashed?",
1086
def checked_ok(self):
1087
"""Assert that the client has been seen, alive and well."""
1088
self.last_checked_ok = datetime.datetime.utcnow()
1089
self.last_checker_status = 0
1090
self.last_checker_signal = None
1093
def bump_timeout(self, timeout=None):
1094
"""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,
1095
460
if timeout is None:
1096
461
timeout = self.timeout
1097
if self.disable_initiator_tag is not None:
1098
GLib.source_remove(self.disable_initiator_tag)
1099
self.disable_initiator_tag = None
1100
if getattr(self, "enabled", False):
1101
self.disable_initiator_tag = GLib.timeout_add(
1102
int(timeout.total_seconds() * 1000), self.disable)
1103
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
(_timedelta_to_milliseconds(timeout),
1105
469
def need_approval(self):
1106
470
self.last_approval_request = datetime.datetime.utcnow()
1108
472
def start_checker(self):
1109
473
"""Start a new checker subprocess if one is not running.
1111
475
If a checker already exists, leave it running and do
1113
477
# The reason for not killing a running checker is that if we
1114
# did that, and if a checker (for some reason) started running
1115
# slowly and taking more than 'interval' time, then the client
1116
# would inevitably timeout, since no checker would get a
1117
# 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
1118
482
# checkers alone, the checker would have to take more time
1119
483
# than 'timeout' for the client to be disabled, which is as it
1122
if self.checker is not None and not self.checker.is_alive():
1123
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)
1126
499
# Start a new checker if needed
1127
500
if self.checker is None:
1128
# Escape attributes for the shell
1130
attr: re.escape(str(getattr(self, attr)))
1131
for attr in self.runtime_expansions}
1133
command = self.checker_command % escaped_attrs
1134
except TypeError as error:
1135
logger.error('Could not format string "%s"',
1136
self.checker_command,
1138
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
1139
520
self.current_checker_command = command
1140
logger.info("Starting checker %r for %s", command,
1142
# We don't need to redirect stdout and stderr, since
1143
# in normal mode, that is already done by daemon(),
1144
# and in debug mode we don't want to. (Stdin is
1145
# always replaced by /dev/null.)
1146
# The exception is when not debugging but nevertheless
1147
# running in the foreground; use the previously
1149
popen_args = {"close_fds": True,
1152
if (not self.server_settings["debug"]
1153
and self.server_settings["foreground"]):
1154
popen_args.update({"stdout": wnull,
1156
pipe = multiprocessing.Pipe(duplex=False)
1157
self.checker = multiprocessing.Process(
1159
args=(pipe[1], subprocess.call, command),
1161
self.checker.start()
1162
self.checker_callback_tag = GLib.io_add_watch(
1163
GLib.IOChannel.unix_new(pipe[0].fileno()),
1164
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1165
self.checker_callback, pipe[0], command)
1166
# 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
1169
547
def stop_checker(self):
1170
548
"""Force the checker process, if any, to stop."""
1171
549
if self.checker_callback_tag:
1172
GLib.source_remove(self.checker_callback_tag)
550
gobject.source_remove(self.checker_callback_tag)
1173
551
self.checker_callback_tag = None
1174
552
if getattr(self, "checker", None) is None:
1176
554
logger.debug("Stopping checker for %(name)s", vars(self))
1177
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
1178
563
self.checker = None
1181
def dbus_service_property(dbus_interface,
566
def dbus_service_property(dbus_interface, signature="v",
567
access="readwrite", byte_arrays=False):
1185
568
"""Decorators for marking methods of a DBusObjectWithProperties to
1186
569
become properties on the D-Bus.
1188
571
The decorated method will be called with no arguments by "Get"
1189
572
and with one argument by "Set".
1191
574
The parameters, where they are supported, are the same as
1192
575
dbus.service.method, except there is only "signature", since the
1193
576
type from Get() and the type sent to Set() is the same.
1525
744
except (AttributeError, xml.dom.DOMException,
1526
745
xml.parsers.expat.ExpatError) as error:
1527
746
logger.error("Failed to override Introspection method",
1533
dbus.OBJECT_MANAGER_IFACE
1534
except AttributeError:
1535
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1538
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1539
"""A D-Bus object with an ObjectManager.
1541
Classes inheriting from this exposes the standard
1542
GetManagedObjects call and the InterfacesAdded and
1543
InterfacesRemoved signals on the standard
1544
"org.freedesktop.DBus.ObjectManager" interface.
1546
Note: No signals are sent automatically; they must be sent
1549
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1550
out_signature="a{oa{sa{sv}}}")
1551
def GetManagedObjects(self):
1552
"""This function must be overridden"""
1553
raise NotImplementedError()
1555
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1556
signature="oa{sa{sv}}")
1557
def InterfacesAdded(self, object_path, interfaces_and_properties):
1560
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1561
def InterfacesRemoved(self, object_path, interfaces):
1564
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1566
path_keyword='object_path',
1567
connection_keyword='connection')
1568
def Introspect(self, object_path, connection):
1569
"""Overloading of standard D-Bus method.
1571
Override return argument name of GetManagedObjects to be
1572
"objpath_interfaces_and_properties"
1574
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1578
document = xml.dom.minidom.parseString(xmlstring)
1580
for if_tag in document.getElementsByTagName("interface"):
1581
# Fix argument name for the GetManagedObjects method
1582
if (if_tag.getAttribute("name")
1583
== dbus.OBJECT_MANAGER_IFACE):
1584
for cn in if_tag.getElementsByTagName("method"):
1585
if (cn.getAttribute("name")
1586
== "GetManagedObjects"):
1587
for arg in cn.getElementsByTagName("arg"):
1588
if (arg.getAttribute("direction")
1592
"objpath_interfaces"
1594
xmlstring = document.toxml("utf-8")
1596
except (AttributeError, xml.dom.DOMException,
1597
xml.parsers.expat.ExpatError) as error:
1598
logger.error("Failed to override Introspection method",
1603
def datetime_to_dbus(dt, variant_level=0):
751
def datetime_to_dbus (dt, variant_level=0):
1604
752
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1606
return dbus.String("", variant_level=variant_level)
1607
return dbus.String(dt.isoformat(), variant_level=variant_level)
1610
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1611
"""A class decorator; applied to a subclass of
1612
dbus.service.Object, it will add alternate D-Bus attributes with
1613
interface names according to the "alt_interface_names" mapping.
1616
@alternate_dbus_interfaces({"org.example.Interface":
1617
"net.example.AlternateInterface"})
1618
class SampleDBusObject(dbus.service.Object):
1619
@dbus.service.method("org.example.Interface")
1620
def SampleDBusMethod():
1623
The above "SampleDBusMethod" on "SampleDBusObject" will be
1624
reachable via two interfaces: "org.example.Interface" and
1625
"net.example.AlternateInterface", the latter of which will have
1626
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1627
"true", unless "deprecate" is passed with a False value.
1629
This works for methods and signals, and also for D-Bus properties
1630
(from DBusObjectWithProperties) and interfaces (from the
1631
dbus_interface_annotations decorator).
1635
for orig_interface_name, alt_interface_name in (
1636
alt_interface_names.items()):
1638
interface_names = set()
1639
# Go though all attributes of the class
1640
for attrname, attribute in inspect.getmembers(cls):
1641
# Ignore non-D-Bus attributes, and D-Bus attributes
1642
# with the wrong interface name
1643
if (not hasattr(attribute, "_dbus_interface")
1644
or not attribute._dbus_interface.startswith(
1645
orig_interface_name)):
1647
# Create an alternate D-Bus interface name based on
1649
alt_interface = attribute._dbus_interface.replace(
1650
orig_interface_name, alt_interface_name)
1651
interface_names.add(alt_interface)
1652
# Is this a D-Bus signal?
1653
if getattr(attribute, "_dbus_is_signal", False):
1654
# Extract the original non-method undecorated
1655
# function by black magic
1656
if sys.version_info.major == 2:
1657
nonmethod_func = (dict(
1658
zip(attribute.func_code.co_freevars,
1659
attribute.__closure__))
1660
["func"].cell_contents)
1662
nonmethod_func = (dict(
1663
zip(attribute.__code__.co_freevars,
1664
attribute.__closure__))
1665
["func"].cell_contents)
1666
# Create a new, but exactly alike, function
1667
# object, and decorate it to be a new D-Bus signal
1668
# with the alternate D-Bus interface name
1669
new_function = copy_function(nonmethod_func)
1670
new_function = (dbus.service.signal(
1672
attribute._dbus_signature)(new_function))
1673
# Copy annotations, if any
1675
new_function._dbus_annotations = dict(
1676
attribute._dbus_annotations)
1677
except AttributeError:
1680
# Define a creator of a function to call both the
1681
# original and alternate functions, so both the
1682
# original and alternate signals gets sent when
1683
# the function is called
1684
def fixscope(func1, func2):
1685
"""This function is a scope container to pass
1686
func1 and func2 to the "call_both" function
1687
outside of its arguments"""
1689
@functools.wraps(func2)
1690
def call_both(*args, **kwargs):
1691
"""This function will emit two D-Bus
1692
signals by calling func1 and func2"""
1693
func1(*args, **kwargs)
1694
func2(*args, **kwargs)
1695
# Make wrapper function look like a D-Bus
1697
for name, attr in inspect.getmembers(func2):
1698
if name.startswith("_dbus_"):
1699
setattr(call_both, name, attr)
1702
# Create the "call_both" function and add it to
1704
attr[attrname] = fixscope(attribute, new_function)
1705
# Is this a D-Bus method?
1706
elif getattr(attribute, "_dbus_is_method", False):
1707
# Create a new, but exactly alike, function
1708
# object. Decorate it to be a new D-Bus method
1709
# with the alternate D-Bus interface name. Add it
1712
dbus.service.method(
1714
attribute._dbus_in_signature,
1715
attribute._dbus_out_signature)
1716
(copy_function(attribute)))
1717
# Copy annotations, if any
1719
attr[attrname]._dbus_annotations = dict(
1720
attribute._dbus_annotations)
1721
except AttributeError:
1723
# Is this a D-Bus property?
1724
elif getattr(attribute, "_dbus_is_property", False):
1725
# Create a new, but exactly alike, function
1726
# object, and decorate it to be a new D-Bus
1727
# property with the alternate D-Bus interface
1728
# name. Add it to the class.
1729
attr[attrname] = (dbus_service_property(
1730
alt_interface, attribute._dbus_signature,
1731
attribute._dbus_access,
1732
attribute._dbus_get_args_options
1734
(copy_function(attribute)))
1735
# Copy annotations, if any
1737
attr[attrname]._dbus_annotations = dict(
1738
attribute._dbus_annotations)
1739
except AttributeError:
1741
# Is this a D-Bus interface?
1742
elif getattr(attribute, "_dbus_is_interface", False):
1743
# Create a new, but exactly alike, function
1744
# object. Decorate it to be a new D-Bus interface
1745
# with the alternate D-Bus interface name. Add it
1748
dbus_interface_annotations(alt_interface)
1749
(copy_function(attribute)))
1751
# Deprecate all alternate interfaces
1752
iname = "_AlternateDBusNames_interface_annotation{}"
1753
for interface_name in interface_names:
1755
@dbus_interface_annotations(interface_name)
1757
return {"org.freedesktop.DBus.Deprecated":
1759
# Find an unused name
1760
for aname in (iname.format(i)
1761
for i in itertools.count()):
1762
if aname not in attr:
1766
# Replace the class with a new subclass of it with
1767
# methods, signals, etc. as created above.
1768
if sys.version_info.major == 2:
1769
cls = type(b"{}Alternate".format(cls.__name__),
1772
cls = type("{}Alternate".format(cls.__name__),
1779
@alternate_dbus_interfaces({"se.recompile.Mandos":
1780
"se.bsnet.fukt.Mandos"})
754
return dbus.String("", variant_level = variant_level)
755
return dbus.String(dt.isoformat(),
756
variant_level=variant_level)
758
class transitional_dbus_metaclass(DBusObjectWithProperties.__metaclass__):
759
def __new__(mcs, name, bases, attr):
760
for attrname, old_dbusobj in inspect.getmembers(bases[0]):
761
new_interface = getattr(old_dbusobj, "_dbus_interface", "").replace("se.bsnet.fukt.", "se.recompile.")
762
if (getattr(old_dbusobj, "_dbus_is_signal", False)
763
and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
764
unwrappedfunc = dict(zip(old_dbusobj.func_code.co_freevars,
765
old_dbusobj.__closure__))["func"].cell_contents
766
newfunc = types.FunctionType(unwrappedfunc.func_code,
767
unwrappedfunc.func_globals,
768
unwrappedfunc.func_name,
769
unwrappedfunc.func_defaults,
770
unwrappedfunc.func_closure)
771
new_dbusfunc = dbus.service.signal(
772
new_interface, old_dbusobj._dbus_signature)(newfunc)
773
attr["_transitional_" + attrname] = new_dbusfunc
775
def fixscope(func1, func2):
776
def newcall(*args, **kwargs):
777
func1(*args, **kwargs)
778
func2(*args, **kwargs)
781
attr[attrname] = fixscope(old_dbusobj, new_dbusfunc)
783
elif (getattr(old_dbusobj, "_dbus_is_method", False)
784
and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
785
new_dbusfunc = (dbus.service.method
787
old_dbusobj._dbus_in_signature,
788
old_dbusobj._dbus_out_signature)
790
(old_dbusobj.func_code,
791
old_dbusobj.func_globals,
792
old_dbusobj.func_name,
793
old_dbusobj.func_defaults,
794
old_dbusobj.func_closure)))
796
attr[attrname] = new_dbusfunc
797
elif (getattr(old_dbusobj, "_dbus_is_property", False)
798
and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
799
new_dbusfunc = (dbus_service_property
801
old_dbusobj._dbus_signature,
802
old_dbusobj._dbus_access,
803
old_dbusobj._dbus_get_args_options["byte_arrays"])
805
(old_dbusobj.func_code,
806
old_dbusobj.func_globals,
807
old_dbusobj.func_name,
808
old_dbusobj.func_defaults,
809
old_dbusobj.func_closure)))
811
attr[attrname] = new_dbusfunc
812
return type.__new__(mcs, name, bases, attr)
1781
814
class ClientDBus(Client, DBusObjectWithProperties):
1782
815
"""A Client class using D-Bus
1785
818
dbus_object_path: dbus.ObjectPath
1786
819
bus: dbus.SystemBus()
1789
822
runtime_expansions = (Client.runtime_expansions
1790
+ ("dbus_object_path", ))
1792
_interface = "se.recompile.Mandos.Client"
823
+ ("dbus_object_path",))
1794
825
# dbus.service.Object doesn't use super(), so we can't either.
1796
def __init__(self, bus=None, *args, **kwargs):
827
def __init__(self, bus = None, *args, **kwargs):
828
self._approvals_pending = 0
1798
830
Client.__init__(self, *args, **kwargs)
1799
831
# Only now, when this client is initialized, can it show up on
1801
client_object_name = str(self.name).translate(
833
client_object_name = unicode(self.name).translate(
1802
834
{ord("."): ord("_"),
1803
835
ord("-"): ord("_")})
1804
self.dbus_object_path = dbus.ObjectPath(
1805
"/clients/" + client_object_name)
836
self.dbus_object_path = (dbus.ObjectPath
837
("/clients/" + client_object_name))
1806
838
DBusObjectWithProperties.__init__(self, self.bus,
1807
839
self.dbus_object_path)
1809
def notifychangeproperty(transform_func, dbus_name,
1810
type_func=lambda x: x,
1812
invalidate_only=False,
1813
_interface=_interface):
1814
""" Modify a variable so that it's a property which announces
1815
its changes to DBus.
1817
transform_fun: Function that takes a value and a variant_level
1818
and transforms it to a D-Bus type.
1819
dbus_name: D-Bus name of the variable
841
def notifychangeproperty(transform_func,
842
dbus_name, type_func=lambda x: x,
844
""" Modify a variable so that its a property that announce its
846
transform_fun: Function that takes a value and transform it to
848
dbus_name: DBus name of the variable
1820
849
type_func: Function that transform the value before sending it
1821
to the D-Bus. Default: no transform
1822
variant_level: D-Bus variant level. Default: 1
851
variant_level: DBus variant level. default: 1
1824
attrname = "_{}".format(dbus_name)
1826
854
def setter(self, value):
855
old_value = real_value[0]
856
real_value[0] = value
1827
857
if hasattr(self, "dbus_object_path"):
1828
if (not hasattr(self, attrname) or
1829
type_func(getattr(self, attrname, None))
1830
!= type_func(value)):
1832
self.PropertiesChanged(
1833
_interface, dbus.Dictionary(),
1834
dbus.Array((dbus_name, )))
1836
dbus_value = transform_func(
1838
variant_level=variant_level)
1839
self.PropertyChanged(dbus.String(dbus_name),
1841
self.PropertiesChanged(
1843
dbus.Dictionary({dbus.String(dbus_name):
1846
setattr(self, attrname, value)
1848
return property(lambda self: getattr(self, attrname), setter)
858
if type_func(old_value) != type_func(real_value[0]):
859
dbus_value = transform_func(type_func(real_value[0]),
861
self.PropertyChanged(dbus.String(dbus_name),
864
return property(lambda self: real_value[0], setter)
1850
867
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1851
868
approvals_pending = notifychangeproperty(dbus.Boolean,
1852
869
"ApprovalPending",
1854
871
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1855
872
last_enabled = notifychangeproperty(datetime_to_dbus,
1857
checker = notifychangeproperty(
1858
dbus.Boolean, "CheckerRunning",
1859
type_func=lambda checker: checker is not None)
874
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
875
type_func = lambda checker: checker is not None)
1860
876
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1861
877
"LastCheckedOK")
1862
last_checker_status = notifychangeproperty(dbus.Int16,
1863
"LastCheckerStatus")
1864
last_approval_request = notifychangeproperty(
1865
datetime_to_dbus, "LastApprovalRequest")
878
last_approval_request = notifychangeproperty(datetime_to_dbus,
879
"LastApprovalRequest")
1866
880
approved_by_default = notifychangeproperty(dbus.Boolean,
1867
881
"ApprovedByDefault")
1868
approval_delay = notifychangeproperty(
1869
dbus.UInt64, "ApprovalDelay",
1870
type_func=lambda td: td.total_seconds() * 1000)
1871
approval_duration = notifychangeproperty(
1872
dbus.UInt64, "ApprovalDuration",
1873
type_func=lambda td: td.total_seconds() * 1000)
882
approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",
883
type_func = _timedelta_to_milliseconds)
884
approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",
885
type_func = _timedelta_to_milliseconds)
1874
886
host = notifychangeproperty(dbus.String, "Host")
1875
timeout = notifychangeproperty(
1876
dbus.UInt64, "Timeout",
1877
type_func=lambda td: td.total_seconds() * 1000)
1878
extended_timeout = notifychangeproperty(
1879
dbus.UInt64, "ExtendedTimeout",
1880
type_func=lambda td: td.total_seconds() * 1000)
1881
interval = notifychangeproperty(
1882
dbus.UInt64, "Interval",
1883
type_func=lambda td: td.total_seconds() * 1000)
887
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
888
type_func = _timedelta_to_milliseconds)
889
extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",
890
type_func = _timedelta_to_milliseconds)
891
interval = notifychangeproperty(dbus.UInt16, "Interval",
892
type_func = _timedelta_to_milliseconds)
1884
893
checker_command = notifychangeproperty(dbus.String, "Checker")
1885
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1886
invalidate_only=True)
1888
895
del notifychangeproperty
1890
897
def __del__(self, *args, **kwargs):
1892
899
self.remove_from_connection()
2210
1186
self.start_checker()
2212
1188
self.stop_checker()
2214
1190
# ObjectPath - property
2216
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2217
"org.freedesktop.DBus.Deprecated": "true"})
2218
1191
@dbus_service_property(_interface, signature="o", access="read")
2219
1192
def ObjectPath_dbus_property(self):
2220
return self.dbus_object_path # is already a dbus.ObjectPath
1193
return self.dbus_object_path # is already a dbus.ObjectPath
2222
1195
# Secret = property
2224
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2226
@dbus_service_property(_interface,
1196
@dbus_service_property(_interface, signature="ay",
1197
access="write", byte_arrays=True)
2230
1198
def Secret_dbus_property(self, value):
2231
self.secret = bytes(value)
1199
self.secret = str(value)
2237
def __init__(self, child_pipe, key_id, fpr, address):
1204
class ProxyClient(object):
1205
def __init__(self, child_pipe, fpr, address):
2238
1206
self._pipe = child_pipe
2239
self._pipe.send(('init', key_id, fpr, address))
1207
self._pipe.send(('init', fpr, address))
2240
1208
if not self._pipe.recv():
2241
raise KeyError(key_id or fpr)
2243
1211
def __getattribute__(self, name):
1212
if(name == '_pipe'):
2245
1213
return super(ProxyClient, self).__getattribute__(name)
2246
1214
self._pipe.send(('getattr', name))
2247
1215
data = self._pipe.recv()
2248
1216
if data[0] == 'data':
2250
1218
if data[0] == 'function':
2252
1219
def func(*args, **kwargs):
2253
1220
self._pipe.send(('funcall', name, args, kwargs))
2254
1221
return self._pipe.recv()[1]
2258
1224
def __setattr__(self, name, value):
1225
if(name == '_pipe'):
2260
1226
return super(ProxyClient, self).__setattr__(name, value)
2261
1227
self._pipe.send(('setattr', name, value))
1229
class ClientDBusTransitional(ClientDBus):
1230
__metaclass__ = transitional_dbus_metaclass
2264
1232
class ClientHandler(socketserver.BaseRequestHandler, object):
2265
1233
"""A class to handle client connections.
2267
1235
Instantiated once for each connection to handle it.
2268
1236
Note: This will run in its own forked process."""
2270
1238
def handle(self):
2271
1239
with contextlib.closing(self.server.child_pipe) as child_pipe:
2272
1240
logger.info("TCP connection from: %s",
2273
str(self.client_address))
1241
unicode(self.client_address))
2274
1242
logger.debug("Pipe FD: %d",
2275
1243
self.server.child_pipe.fileno())
2277
session = gnutls.ClientSession(self.request)
2279
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2280
# "+AES-256-CBC", "+SHA1",
2281
# "+COMP-NULL", "+CTYPE-OPENPGP",
1245
session = (gnutls.connection
1246
.ClientSession(self.request,
1248
.X509Credentials()))
1250
# Note: gnutls.connection.X509Credentials is really a
1251
# generic GnuTLS certificate credentials object so long as
1252
# no X.509 keys are added to it. Therefore, we can use it
1253
# here despite using OpenPGP certificates.
1255
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1256
# "+AES-256-CBC", "+SHA1",
1257
# "+COMP-NULL", "+CTYPE-OPENPGP",
2283
1259
# Use a fallback default, since this MUST be set.
2284
1260
priority = self.server.gnutls_priority
2285
1261
if priority is None:
2286
1262
priority = "NORMAL"
2287
gnutls.priority_set_direct(session._c_object,
2288
priority.encode("utf-8"),
1263
(gnutls.library.functions
1264
.gnutls_priority_set_direct(session._c_object,
2291
1267
# Start communication using the Mandos protocol
2292
1268
# Get protocol number
2293
1269
line = self.request.makefile().readline()
2294
1270
logger.debug("Protocol version: %r", line)
2296
1272
if int(line.strip().split()[0]) > 1:
2297
raise RuntimeError(line)
2298
1274
except (ValueError, IndexError, RuntimeError) as error:
2299
1275
logger.error("Unknown protocol version: %s", error)
2302
1278
# Start GnuTLS connection
2304
1280
session.handshake()
2305
except gnutls.Error as error:
1281
except gnutls.errors.GNUTLSError as error:
2306
1282
logger.warning("Handshake failed: %s", error)
2307
1283
# Do not run session.bye() here: the session is not
2308
1284
# established. Just abandon the request.
2310
1286
logger.debug("Handshake succeeded")
2312
1288
approval_required = False
2314
if gnutls.has_rawpk:
2317
key_id = self.key_id(
2318
self.peer_certificate(session))
2319
except (TypeError, gnutls.Error) as error:
2320
logger.warning("Bad certificate: %s", error)
2322
logger.debug("Key ID: %s", key_id)
2327
fpr = self.fingerprint(
2328
self.peer_certificate(session))
2329
except (TypeError, gnutls.Error) as error:
2330
logger.warning("Bad certificate: %s", error)
2332
logger.debug("Fingerprint: %s", fpr)
2335
client = ProxyClient(child_pipe, key_id, fpr,
1291
fpr = self.fingerprint(self.peer_certificate
1294
gnutls.errors.GNUTLSError) as error:
1295
logger.warning("Bad certificate: %s", error)
1297
logger.debug("Fingerprint: %s", fpr)
1300
client = ProxyClient(child_pipe, fpr,
2336
1301
self.client_address)
2337
1302
except KeyError:
2340
1305
if client.approval_delay:
2341
1306
delay = client.approval_delay
2342
1307
client.approvals_pending += 1
2343
1308
approval_required = True
2346
1311
if not client.enabled:
2347
1312
logger.info("Client %s is disabled",
2349
1314
if self.server.use_dbus:
2350
1315
# Emit D-Bus signal
2351
client.Rejected("Disabled")
1316
client.Rejected("Disabled")
2354
if client.approved or not client.approval_delay:
2355
# We are approved or approval is disabled
1319
if client._approved or not client.approval_delay:
1320
#We are approved or approval is disabled
2357
elif client.approved is None:
1322
elif client._approved is None:
2358
1323
logger.info("Client %s needs approval",
2360
1325
if self.server.use_dbus:
2361
1326
# Emit D-Bus signal
2362
1327
client.NeedApproval(
2363
client.approval_delay.total_seconds()
2364
* 1000, client.approved_by_default)
1328
client.approval_delay_milliseconds(),
1329
client.approved_by_default)
2366
1331
logger.warning("Client %s was not approved",
2391
1357
delay -= time2 - time
2394
session.send(client.secret)
2395
except gnutls.Error as error:
2396
logger.warning("gnutls send failed",
1360
while sent_size < len(client.secret):
1362
sent = session.send(client.secret[sent_size:])
1363
except gnutls.errors.GNUTLSError as error:
1364
logger.warning("gnutls send failed")
1366
logger.debug("Sent: %d, remaining: %d",
1367
sent, len(client.secret)
1368
- (sent_size + sent))
2400
1371
logger.info("Sending secret to %s", client.name)
2401
# bump the timeout using extended_timeout
2402
client.bump_timeout(client.extended_timeout)
1372
# bump the timeout as if seen
1373
client.checked_ok(client.extended_timeout)
2403
1374
if self.server.use_dbus:
2404
1375
# Emit D-Bus signal
2405
1376
client.GotSecret()
2408
1379
if approval_required:
2409
1380
client.approvals_pending -= 1
2412
except gnutls.Error as error:
2413
logger.warning("GnuTLS bye failed",
1383
except gnutls.errors.GNUTLSError as error:
1384
logger.warning("GnuTLS bye failed")
2417
1387
def peer_certificate(session):
2418
"Return the peer's certificate as a bytestring"
2420
cert_type = gnutls.certificate_type_get2(session._c_object,
2422
except AttributeError:
2423
cert_type = gnutls.certificate_type_get(session._c_object)
2424
if gnutls.has_rawpk:
2425
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2427
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2428
# If not a valid certificate type...
2429
if cert_type not in valid_cert_types:
2430
logger.info("Cert type %r not in %r", cert_type,
2432
# ...return invalid data
1388
"Return the peer's OpenPGP certificate as a bytestring"
1389
# If not an OpenPGP certificate...
1390
if (gnutls.library.functions
1391
.gnutls_certificate_type_get(session._c_object)
1392
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1393
# ...do the normal thing
1394
return session.peer_certificate
2434
1395
list_size = ctypes.c_uint(1)
2435
cert_list = (gnutls.certificate_get_peers
1396
cert_list = (gnutls.library.functions
1397
.gnutls_certificate_get_peers
2436
1398
(session._c_object, ctypes.byref(list_size)))
2437
1399
if not bool(cert_list) and list_size.value != 0:
2438
raise gnutls.Error("error getting peer certificate")
1400
raise gnutls.errors.GNUTLSError("error getting peer"
2439
1402
if list_size.value == 0:
2441
1404
cert = cert_list[0]
2442
1405
return ctypes.string_at(cert.data, cert.size)
2445
def key_id(certificate):
2446
"Convert a certificate bytestring to a hexdigit key ID"
2447
# New GnuTLS "datum" with the public key
2448
datum = gnutls.datum_t(
2449
ctypes.cast(ctypes.c_char_p(certificate),
2450
ctypes.POINTER(ctypes.c_ubyte)),
2451
ctypes.c_uint(len(certificate)))
2452
# XXX all these need to be created in the gnutls "module"
2453
# New empty GnuTLS certificate
2454
pubkey = gnutls.pubkey_t()
2455
gnutls.pubkey_init(ctypes.byref(pubkey))
2456
# Import the raw public key into the certificate
2457
gnutls.pubkey_import(pubkey,
2458
ctypes.byref(datum),
2459
gnutls.X509_FMT_DER)
2460
# New buffer for the key ID
2461
buf = ctypes.create_string_buffer(32)
2462
buf_len = ctypes.c_size_t(len(buf))
2463
# Get the key ID from the raw public key into the buffer
2464
gnutls.pubkey_get_key_id(pubkey,
2465
gnutls.KEYID_USE_SHA256,
2466
ctypes.cast(ctypes.byref(buf),
2467
ctypes.POINTER(ctypes.c_ubyte)),
2468
ctypes.byref(buf_len))
2469
# Deinit the certificate
2470
gnutls.pubkey_deinit(pubkey)
2472
# Convert the buffer to a Python bytestring
2473
key_id = ctypes.string_at(buf, buf_len.value)
2474
# Convert the bytestring to hexadecimal notation
2475
hex_key_id = binascii.hexlify(key_id).upper()
2479
1408
def fingerprint(openpgp):
2480
1409
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2481
1410
# New GnuTLS "datum" with the OpenPGP public key
2482
datum = gnutls.datum_t(
2483
ctypes.cast(ctypes.c_char_p(openpgp),
2484
ctypes.POINTER(ctypes.c_ubyte)),
2485
ctypes.c_uint(len(openpgp)))
1411
datum = (gnutls.library.types
1412
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1415
ctypes.c_uint(len(openpgp))))
2486
1416
# New empty GnuTLS certificate
2487
crt = gnutls.openpgp_crt_t()
2488
gnutls.openpgp_crt_init(ctypes.byref(crt))
1417
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1418
(gnutls.library.functions
1419
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2489
1420
# Import the OpenPGP public key into the certificate
2490
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2491
gnutls.OPENPGP_FMT_RAW)
1421
(gnutls.library.functions
1422
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1423
gnutls.library.constants
1424
.GNUTLS_OPENPGP_FMT_RAW))
2492
1425
# Verify the self signature in the key
2493
1426
crtverify = ctypes.c_uint()
2494
gnutls.openpgp_crt_verify_self(crt, 0,
2495
ctypes.byref(crtverify))
1427
(gnutls.library.functions
1428
.gnutls_openpgp_crt_verify_self(crt, 0,
1429
ctypes.byref(crtverify)))
2496
1430
if crtverify.value != 0:
2497
gnutls.openpgp_crt_deinit(crt)
2498
raise gnutls.CertificateSecurityError(code
1431
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1432
raise (gnutls.errors.CertificateSecurityError
2500
1434
# New buffer for the fingerprint
2501
1435
buf = ctypes.create_string_buffer(20)
2502
1436
buf_len = ctypes.c_size_t()
2503
1437
# Get the fingerprint from the certificate into the buffer
2504
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2505
ctypes.byref(buf_len))
1438
(gnutls.library.functions
1439
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1440
ctypes.byref(buf_len)))
2506
1441
# Deinit the certificate
2507
gnutls.openpgp_crt_deinit(crt)
1442
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2508
1443
# Convert the buffer to a Python bytestring
2509
1444
fpr = ctypes.string_at(buf, buf_len.value)
2510
1445
# Convert the bytestring to hexadecimal notation
2511
hex_fpr = binascii.hexlify(fpr).upper()
1446
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2515
class MultiprocessingMixIn:
1450
class MultiprocessingMixIn(object):
2516
1451
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2518
1452
def sub_process_main(self, request, address):
2520
1454
self.finish_request(request, address)
2522
1456
self.handle_error(request, address)
2523
1457
self.close_request(request)
2525
1459
def process_request(self, request, address):
2526
1460
"""Start a new process to process the request."""
2527
proc = multiprocessing.Process(target=self.sub_process_main,
2528
args=(request, address))
2533
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1461
multiprocessing.Process(target = self.sub_process_main,
1462
args = (request, address)).start()
1465
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2534
1466
""" adds a pipe to the MixIn """
2536
1467
def process_request(self, request, client_address):
2537
1468
"""Overrides and wraps the original process_request().
2539
1470
This function creates a new pipe in self.pipe
2541
1472
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2543
proc = MultiprocessingMixIn.process_request(self, request,
1474
super(MultiprocessingMixInWithPipe,
1475
self).process_request(request, client_address)
2545
1476
self.child_pipe.close()
2546
self.add_pipe(parent_pipe, proc)
2548
def add_pipe(self, parent_pipe, proc):
1477
self.add_pipe(parent_pipe)
1479
def add_pipe(self, parent_pipe):
2549
1480
"""Dummy function; override as necessary"""
2550
raise NotImplementedError()
1481
raise NotImplementedError
2553
1484
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2554
socketserver.TCPServer):
1485
socketserver.TCPServer, object):
2555
1486
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2558
1489
enabled: Boolean; whether this server is activated yet
2559
1490
interface: None or a network interface name (string)
2560
1491
use_ipv6: Boolean; to use IPv6 or not
2563
1493
def __init__(self, server_address, RequestHandlerClass,
2567
"""If socketfd is set, use that file descriptor instead of
2568
creating a new one with socket.socket().
1494
interface=None, use_ipv6=True):
2570
1495
self.interface = interface
2572
1497
self.address_family = socket.AF_INET6
2573
if socketfd is not None:
2574
# Save the file descriptor
2575
self.socketfd = socketfd
2576
# Save the original socket.socket() function
2577
self.socket_socket = socket.socket
2579
# To implement --socket, we monkey patch socket.socket.
2581
# (When socketserver.TCPServer is a new-style class, we
2582
# could make self.socket into a property instead of monkey
2583
# patching socket.socket.)
2585
# Create a one-time-only replacement for socket.socket()
2586
@functools.wraps(socket.socket)
2587
def socket_wrapper(*args, **kwargs):
2588
# Restore original function so subsequent calls are
2590
socket.socket = self.socket_socket
2591
del self.socket_socket
2592
# This time only, return a new socket object from the
2593
# saved file descriptor.
2594
return socket.fromfd(self.socketfd, *args, **kwargs)
2595
# Replace socket.socket() function with wrapper
2596
socket.socket = socket_wrapper
2597
# The socketserver.TCPServer.__init__ will call
2598
# socket.socket(), which might be our replacement,
2599
# socket_wrapper(), if socketfd was set.
2600
1498
socketserver.TCPServer.__init__(self, server_address,
2601
1499
RequestHandlerClass)
2603
1500
def server_bind(self):
2604
1501
"""This overrides the normal server_bind() function
2605
1502
to bind to an interface if one was specified, and also NOT to
2606
1503
bind to an address or port if they were not specified."""
2607
global SO_BINDTODEVICE
2608
1504
if self.interface is not None:
2609
1505
if SO_BINDTODEVICE is None:
2610
# Fall back to a hard-coded value which seems to be
2612
logger.warning("SO_BINDTODEVICE not found, trying 25")
2613
SO_BINDTODEVICE = 25
2615
self.socket.setsockopt(
2616
socket.SOL_SOCKET, SO_BINDTODEVICE,
2617
(self.interface + "\0").encode("utf-8"))
2618
except socket.error as error:
2619
if error.errno == errno.EPERM:
2620
logger.error("No permission to bind to"
2621
" interface %s", self.interface)
2622
elif error.errno == errno.ENOPROTOOPT:
2623
logger.error("SO_BINDTODEVICE not available;"
2624
" cannot bind to interface %s",
2626
elif error.errno == errno.ENODEV:
2627
logger.error("Interface %s does not exist,"
2628
" cannot bind", self.interface)
1506
logger.error("SO_BINDTODEVICE does not exist;"
1507
" cannot bind to interface %s",
1511
self.socket.setsockopt(socket.SOL_SOCKET,
1515
except socket.error as error:
1516
if error[0] == errno.EPERM:
1517
logger.error("No permission to"
1518
" bind to interface %s",
1520
elif error[0] == errno.ENOPROTOOPT:
1521
logger.error("SO_BINDTODEVICE not available;"
1522
" cannot bind to interface %s",
2631
1526
# Only bind(2) the socket if we really need to.
2632
1527
if self.server_address[0] or self.server_address[1]:
2633
if self.server_address[1]:
2634
self.allow_reuse_address = True
2635
1528
if not self.server_address[0]:
2636
1529
if self.address_family == socket.AF_INET6:
2637
any_address = "::" # in6addr_any
1530
any_address = "::" # in6addr_any
2639
any_address = "0.0.0.0" # INADDR_ANY
1532
any_address = socket.INADDR_ANY
2640
1533
self.server_address = (any_address,
2641
1534
self.server_address[1])
2642
1535
elif not self.server_address[1]:
2643
self.server_address = (self.server_address[0], 0)
1536
self.server_address = (self.server_address[0],
2644
1538
# if self.interface:
2645
1539
# self.server_address = (self.server_address[0],
2653
1547
class MandosServer(IPv6_TCPServer):
2654
1548
"""Mandos server.
2657
1551
clients: set of Client objects
2658
1552
gnutls_priority GnuTLS priority string
2659
1553
use_dbus: Boolean; to emit D-Bus signals or not
2661
Assumes a GLib.MainLoop event loop.
1555
Assumes a gobject.MainLoop event loop.
2664
1557
def __init__(self, server_address, RequestHandlerClass,
2668
gnutls_priority=None,
1558
interface=None, use_ipv6=True, clients=None,
1559
gnutls_priority=None, use_dbus=True):
2671
1560
self.enabled = False
2672
1561
self.clients = clients
2673
1562
if self.clients is None:
1563
self.clients = set()
2675
1564
self.use_dbus = use_dbus
2676
1565
self.gnutls_priority = gnutls_priority
2677
1566
IPv6_TCPServer.__init__(self, server_address,
2678
1567
RequestHandlerClass,
2679
interface=interface,
1568
interface = interface,
1569
use_ipv6 = use_ipv6)
2683
1570
def server_activate(self):
2684
1571
if self.enabled:
2685
1572
return socketserver.TCPServer.server_activate(self)
2687
1573
def enable(self):
2688
1574
self.enabled = True
2690
def add_pipe(self, parent_pipe, proc):
1575
def add_pipe(self, parent_pipe):
2691
1576
# Call "handle_ipc" for both data and EOF events
2693
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2694
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2695
functools.partial(self.handle_ipc,
2696
parent_pipe=parent_pipe,
2699
def handle_ipc(self, source, condition,
1577
gobject.io_add_watch(parent_pipe.fileno(),
1578
gobject.IO_IN | gobject.IO_HUP,
1579
functools.partial(self.handle_ipc,
1580
parent_pipe = parent_pipe))
1582
def handle_ipc(self, source, condition, parent_pipe=None,
2702
1583
client_object=None):
2703
# error, or the other end of multiprocessing.Pipe has closed
2704
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2705
# Wait for other process to exit
1585
gobject.IO_IN: "IN", # There is data to read.
1586
gobject.IO_OUT: "OUT", # Data can be written (without
1588
gobject.IO_PRI: "PRI", # There is urgent data to read.
1589
gobject.IO_ERR: "ERR", # Error condition.
1590
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1591
# broken, usually for pipes and
1594
conditions_string = ' | '.join(name
1596
condition_names.iteritems()
1597
if cond & condition)
1598
# error or the other end of multiprocessing.Pipe has closed
1599
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2709
1602
# Read a request from the child
2710
1603
request = parent_pipe.recv()
2711
1604
command = request[0]
2713
1606
if command == 'init':
2714
key_id = request[1].decode("ascii")
2715
fpr = request[2].decode("ascii")
2716
address = request[3]
2718
for c in self.clients.values():
2719
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2721
if key_id and c.key_id == key_id:
2724
if fpr and c.fingerprint == fpr:
1608
address = request[2]
1610
for c in self.clients:
1611
if c.fingerprint == fpr:
2728
logger.info("Client not found for key ID: %s, address"
2729
": %s", key_id or fpr, address)
1615
logger.info("Client not found for fingerprint: %s, ad"
1616
"dress: %s", fpr, address)
2730
1617
if self.use_dbus:
2731
1618
# Emit D-Bus signal
2732
mandos_dbus_service.ClientNotFound(key_id or fpr,
1619
mandos_dbus_service.ClientNotFound(fpr, address[0])
2734
1620
parent_pipe.send(False)
2738
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2739
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2740
functools.partial(self.handle_ipc,
2741
parent_pipe=parent_pipe,
2743
client_object=client))
1623
gobject.io_add_watch(parent_pipe.fileno(),
1624
gobject.IO_IN | gobject.IO_HUP,
1625
functools.partial(self.handle_ipc,
1626
parent_pipe = parent_pipe,
1627
client_object = client))
2744
1628
parent_pipe.send(True)
2745
# remove the old hook in favor of the new above hook on
1629
# remove the old hook in favor of the new above hook on same fileno
2748
1631
if command == 'funcall':
2749
1632
funcname = request[1]
2750
1633
args = request[2]
2751
1634
kwargs = request[3]
2753
parent_pipe.send(('data', getattr(client_object,
1636
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2757
1638
if command == 'getattr':
2758
1639
attrname = request[1]
2759
if isinstance(client_object.__getattribute__(attrname),
2760
collections.abc.Callable):
2761
parent_pipe.send(('function', ))
1640
if callable(client_object.__getattribute__(attrname)):
1641
parent_pipe.send(('function',))
2764
'data', client_object.__getattribute__(attrname)))
1643
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2766
1645
if command == 'setattr':
2767
1646
attrname = request[1]
2768
1647
value = request[2]
2769
1648
setattr(client_object, attrname, value)
2774
def rfc3339_duration_to_delta(duration):
2775
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2777
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2779
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2781
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2783
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2785
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2787
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2789
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2793
# Parsing an RFC 3339 duration with regular expressions is not
2794
# possible - there would have to be multiple places for the same
2795
# values, like seconds. The current code, while more esoteric, is
2796
# cleaner without depending on a parsing library. If Python had a
2797
# built-in library for parsing we would use it, but we'd like to
2798
# avoid excessive use of external libraries.
2800
# New type for defining tokens, syntax, and semantics all-in-one
2801
Token = collections.namedtuple("Token", (
2802
"regexp", # To match token; if "value" is not None, must have
2803
# a "group" containing digits
2804
"value", # datetime.timedelta or None
2805
"followers")) # Tokens valid after this token
2806
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2807
# the "duration" ABNF definition in RFC 3339, Appendix A.
2808
token_end = Token(re.compile(r"$"), None, frozenset())
2809
token_second = Token(re.compile(r"(\d+)S"),
2810
datetime.timedelta(seconds=1),
2811
frozenset((token_end, )))
2812
token_minute = Token(re.compile(r"(\d+)M"),
2813
datetime.timedelta(minutes=1),
2814
frozenset((token_second, token_end)))
2815
token_hour = Token(re.compile(r"(\d+)H"),
2816
datetime.timedelta(hours=1),
2817
frozenset((token_minute, token_end)))
2818
token_time = Token(re.compile(r"T"),
2820
frozenset((token_hour, token_minute,
2822
token_day = Token(re.compile(r"(\d+)D"),
2823
datetime.timedelta(days=1),
2824
frozenset((token_time, token_end)))
2825
token_month = Token(re.compile(r"(\d+)M"),
2826
datetime.timedelta(weeks=4),
2827
frozenset((token_day, token_end)))
2828
token_year = Token(re.compile(r"(\d+)Y"),
2829
datetime.timedelta(weeks=52),
2830
frozenset((token_month, token_end)))
2831
token_week = Token(re.compile(r"(\d+)W"),
2832
datetime.timedelta(weeks=1),
2833
frozenset((token_end, )))
2834
token_duration = Token(re.compile(r"P"), None,
2835
frozenset((token_year, token_month,
2836
token_day, token_time,
2838
# Define starting values:
2840
value = datetime.timedelta()
2842
# Following valid tokens
2843
followers = frozenset((token_duration, ))
2844
# String left to parse
2846
# Loop until end token is found
2847
while found_token is not token_end:
2848
# Search for any currently valid tokens
2849
for token in followers:
2850
match = token.regexp.match(s)
2851
if match is not None:
2853
if token.value is not None:
2854
# Value found, parse digits
2855
factor = int(match.group(1), 10)
2856
# Add to value so far
2857
value += factor * token.value
2858
# Strip token from string
2859
s = token.regexp.sub("", s, 1)
2862
# Set valid next tokens
2863
followers = found_token.followers
2866
# No currently valid tokens were found
2867
raise ValueError("Invalid RFC 3339 duration: {!r}"
2873
1653
def string_to_delta(interval):
2874
1654
"""Parse a string and return a datetime.timedelta
2876
>>> string_to_delta('7d') == datetime.timedelta(7)
2878
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2880
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2882
>>> string_to_delta('24h') == datetime.timedelta(1)
2884
>>> string_to_delta('1w') == datetime.timedelta(7)
2886
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
1656
>>> string_to_delta('7d')
1657
datetime.timedelta(7)
1658
>>> string_to_delta('60s')
1659
datetime.timedelta(0, 60)
1660
>>> string_to_delta('60m')
1661
datetime.timedelta(0, 3600)
1662
>>> string_to_delta('24h')
1663
datetime.timedelta(1)
1664
>>> string_to_delta('1w')
1665
datetime.timedelta(7)
1666
>>> string_to_delta('5m 30s')
1667
datetime.timedelta(0, 330)
2891
return rfc3339_duration_to_delta(interval)
2895
1669
timevalue = datetime.timedelta(0)
2896
1670
for s in interval.split():
1672
suffix = unicode(s[-1])
2899
1673
value = int(s[:-1])
2900
1674
if suffix == "d":
2901
1675
delta = datetime.timedelta(value)
2973
1771
parser.add_argument("--no-dbus", action="store_false",
2974
1772
dest="use_dbus", help="Do not provide D-Bus"
2975
" system bus interface", default=None)
1773
" system bus interface")
2976
1774
parser.add_argument("--no-ipv6", action="store_false",
2977
dest="use_ipv6", help="Do not use IPv6",
2979
parser.add_argument("--no-restore", action="store_false",
2980
dest="restore", help="Do not restore stored"
2981
" state", default=None)
2982
parser.add_argument("--socket", type=int,
2983
help="Specify a file descriptor to a network"
2984
" socket to use instead of creating one")
2985
parser.add_argument("--statedir", metavar="DIR",
2986
help="Directory to save/restore state in")
2987
parser.add_argument("--foreground", action="store_true",
2988
help="Run in foreground", default=None)
2989
parser.add_argument("--no-zeroconf", action="store_false",
2990
dest="zeroconf", help="Do not use Zeroconf",
1775
dest="use_ipv6", help="Do not use IPv6")
2993
1776
options = parser.parse_args()
2995
1783
# Default values for config file for server-global settings
2996
if gnutls.has_rawpk:
2997
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2998
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3000
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3001
":+SIGN-DSA-SHA256")
3002
server_defaults = {"interface": "",
3006
"priority": priority,
3007
"servicename": "Mandos",
3013
"statedir": "/var/lib/mandos",
3014
"foreground": "False",
1784
server_defaults = { "interface": "",
1789
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1790
"servicename": "Mandos",
3019
1796
# Parse config file for server-global settings
3020
server_config = configparser.ConfigParser(server_defaults)
1797
server_config = configparser.SafeConfigParser(server_defaults)
3021
1798
del server_defaults
3022
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3023
# Convert the ConfigParser object to a dict
1799
server_config.read(os.path.join(options.configdir,
1801
# Convert the SafeConfigParser object to a dict
3024
1802
server_settings = server_config.defaults()
3025
1803
# Use the appropriate methods on the non-string config options
3026
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3027
"foreground", "zeroconf"):
1804
for option in ("debug", "use_dbus", "use_ipv6"):
3028
1805
server_settings[option] = server_config.getboolean("DEFAULT",
3030
1807
if server_settings["port"]:
3031
1808
server_settings["port"] = server_config.getint("DEFAULT",
3033
if server_settings["socket"]:
3034
server_settings["socket"] = server_config.getint("DEFAULT",
3036
# Later, stdin will, and stdout and stderr might, be dup'ed
3037
# over with an opened os.devnull. But we don't want this to
3038
# happen with a supplied network socket.
3039
if 0 <= server_settings["socket"] <= 2:
3040
server_settings["socket"] = os.dup(server_settings
3042
1810
del server_config
3044
1812
# Override the settings from the config file with command line
3045
1813
# options, if set.
3046
1814
for option in ("interface", "address", "port", "debug",
3047
"priority", "servicename", "configdir", "use_dbus",
3048
"use_ipv6", "debuglevel", "restore", "statedir",
3049
"socket", "foreground", "zeroconf"):
1815
"priority", "servicename", "configdir",
1816
"use_dbus", "use_ipv6", "debuglevel"):
3050
1817
value = getattr(options, option)
3051
1818
if value is not None:
3052
1819
server_settings[option] = value
3054
1821
# Force all strings to be unicode
3055
1822
for option in server_settings.keys():
3056
if isinstance(server_settings[option], bytes):
3057
server_settings[option] = (server_settings[option]
3059
# Force all boolean options to be boolean
3060
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3061
"foreground", "zeroconf"):
3062
server_settings[option] = bool(server_settings[option])
3063
# Debug implies foreground
3064
if server_settings["debug"]:
3065
server_settings["foreground"] = True
1823
if type(server_settings[option]) is str:
1824
server_settings[option] = unicode(server_settings[option])
3066
1825
# Now we have our good server settings in "server_settings"
3068
1827
##################################################################
3070
if (not server_settings["zeroconf"]
3071
and not (server_settings["port"]
3072
or server_settings["socket"] != "")):
3073
parser.error("Needs port or socket to work without Zeroconf")
3075
1829
# For convenience
3076
1830
debug = server_settings["debug"]
3077
1831
debuglevel = server_settings["debuglevel"]
3078
1832
use_dbus = server_settings["use_dbus"]
3079
1833
use_ipv6 = server_settings["use_ipv6"]
3080
stored_state_path = os.path.join(server_settings["statedir"],
3082
foreground = server_settings["foreground"]
3083
zeroconf = server_settings["zeroconf"]
3086
initlogger(debug, logging.DEBUG)
3091
level = getattr(logging, debuglevel.upper())
3092
initlogger(debug, level)
3094
1835
if server_settings["servicename"] != "Mandos":
3095
syslogger.setFormatter(
3096
logging.Formatter('Mandos ({}) [%(process)d]:'
3097
' %(levelname)s: %(message)s'.format(
3098
server_settings["servicename"])))
1836
syslogger.setFormatter(logging.Formatter
1837
('Mandos (%s) [%%(process)d]:'
1838
' %%(levelname)s: %%(message)s'
1839
% server_settings["servicename"]))
3100
1841
# Parse config file with clients
3101
client_config = configparser.ConfigParser(Client.client_defaults)
1842
client_defaults = { "timeout": "5m",
1843
"extended_timeout": "15m",
1845
"checker": "fping -q -- %%(host)s",
1847
"approval_delay": "0s",
1848
"approval_duration": "1s",
1850
client_config = configparser.SafeConfigParser(client_defaults)
3102
1851
client_config.read(os.path.join(server_settings["configdir"],
3103
1852
"clients.conf"))
3105
1854
global mandos_dbus_service
3106
1855
mandos_dbus_service = None
3109
if server_settings["socket"] != "":
3110
socketfd = server_settings["socket"]
3111
tcp_server = MandosServer(
3112
(server_settings["address"], server_settings["port"]),
3114
interface=(server_settings["interface"] or None),
3116
gnutls_priority=server_settings["priority"],
3120
pidfilename = "/run/mandos.pid"
3121
if not os.path.isdir("/run/."):
3122
pidfilename = "/var/run/mandos.pid"
3125
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3126
except IOError as e:
3127
logger.error("Could not open file %r", pidfilename,
3130
for name, group in (("_mandos", "_mandos"),
3131
("mandos", "mandos"),
3132
("nobody", "nogroup")):
3134
uid = pwd.getpwnam(name).pw_uid
3135
gid = pwd.getpwnam(group).pw_gid
1857
tcp_server = MandosServer((server_settings["address"],
1858
server_settings["port"]),
1860
interface=(server_settings["interface"]
1864
server_settings["priority"],
1867
pidfilename = "/var/run/mandos.pid"
1869
pidfile = open(pidfilename, "w")
1871
logger.error("Could not open file %r", pidfilename)
1874
uid = pwd.getpwnam("_mandos").pw_uid
1875
gid = pwd.getpwnam("_mandos").pw_gid
1878
uid = pwd.getpwnam("mandos").pw_uid
1879
gid = pwd.getpwnam("mandos").pw_gid
3137
1880
except KeyError:
1882
uid = pwd.getpwnam("nobody").pw_uid
1883
gid = pwd.getpwnam("nobody").pw_gid
3146
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3148
1890
except OSError as error:
3149
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3150
.format(uid, gid, os.strerror(error.errno)))
3151
if error.errno != errno.EPERM:
1891
if error[0] != errno.EPERM:
1894
if not debug and not debuglevel:
1895
syslogger.setLevel(logging.WARNING)
1896
console.setLevel(logging.WARNING)
1898
level = getattr(logging, debuglevel.upper())
1899
syslogger.setLevel(level)
1900
console.setLevel(level)
3155
1903
# Enable all possible GnuTLS debugging
3157
1905
# "Use a log level over 10 to enable all debugging options."
3158
1906
# - GnuTLS manual
3159
gnutls.global_set_log_level(11)
1907
gnutls.library.functions.gnutls_global_set_log_level(11)
1909
@gnutls.library.types.gnutls_log_func
3162
1910
def debug_gnutls(level, string):
3163
1911
logger.debug("GnuTLS: %s", string[:-1])
3165
gnutls.global_set_log_function(debug_gnutls)
1913
(gnutls.library.functions
1914
.gnutls_global_set_log_function(debug_gnutls))
3167
1916
# Redirect stdin so all checkers get /dev/null
3168
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1917
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3169
1918
os.dup2(null, sys.stdin.fileno())
1922
# No console logging
1923
logger.removeHandler(console)
3173
1925
# Need to fork before connecting to D-Bus
3175
1927
# Close all input and output, do double fork, etc.
3178
if gi.version_info < (3, 10, 2):
3179
# multiprocessing will use threads, so before we use GLib we
3180
# need to inform GLib that threads will be used.
3183
1930
global main_loop
3184
1931
# From the Avahi example code
3185
DBusGMainLoop(set_as_default=True)
3186
main_loop = GLib.MainLoop()
1932
DBusGMainLoop(set_as_default=True )
1933
main_loop = gobject.MainLoop()
3187
1934
bus = dbus.SystemBus()
3188
1935
# End of Avahi example code
3191
bus_name = dbus.service.BusName("se.recompile.Mandos",
3194
old_bus_name = dbus.service.BusName(
3195
"se.bsnet.fukt.Mandos", bus,
3197
except dbus.exceptions.DBusException as e:
3198
logger.error("Disabling D-Bus:", exc_info=e)
1938
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1939
bus, do_not_queue=True)
1940
bus_name2 = dbus.service.BusName("se.recompile.Mandos",
1941
bus, do_not_queue=True)
1942
except dbus.exceptions.NameExistsException as e:
1943
logger.error(unicode(e) + ", disabling D-Bus")
3199
1944
use_dbus = False
3200
1945
server_settings["use_dbus"] = False
3201
1946
tcp_server.use_dbus = False
3203
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3204
service = AvahiServiceToSyslog(
3205
name=server_settings["servicename"],
3206
servicetype="_mandos._tcp",
3209
if server_settings["interface"]:
3210
service.interface = if_nametoindex(
3211
server_settings["interface"].encode("utf-8"))
1947
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1948
service = AvahiService(name = server_settings["servicename"],
1949
servicetype = "_mandos._tcp",
1950
protocol = protocol, bus = bus)
1951
if server_settings["interface"]:
1952
service.interface = (if_nametoindex
1953
(str(server_settings["interface"])))
3213
1955
global multiprocessing_manager
3214
1956
multiprocessing_manager = multiprocessing.Manager()
3216
1958
client_class = Client
3218
client_class = functools.partial(ClientDBus, bus=bus)
3220
client_settings = Client.config_parser(client_config)
3221
old_client_settings = {}
3224
# This is used to redirect stdout and stderr for checker processes
3226
wnull = open(os.devnull, "w") # A writable /dev/null
3227
# Only used if server is running in foreground but not in debug
3229
if debug or not foreground:
3232
# Get client data and settings from last running state.
3233
if server_settings["restore"]:
3235
with open(stored_state_path, "rb") as stored_state:
3236
if sys.version_info.major == 2:
3237
clients_data, old_client_settings = pickle.load(
3240
bytes_clients_data, bytes_old_client_settings = (
3241
pickle.load(stored_state, encoding="bytes"))
3242
# Fix bytes to strings
3245
clients_data = {(key.decode("utf-8")
3246
if isinstance(key, bytes)
3249
bytes_clients_data.items()}
3250
del bytes_clients_data
3251
for key in clients_data:
3252
value = {(k.decode("utf-8")
3253
if isinstance(k, bytes) else k): v
3255
clients_data[key].items()}
3256
clients_data[key] = value
3258
value["client_structure"] = [
3260
if isinstance(s, bytes)
3262
value["client_structure"]]
3263
# .name, .host, and .checker_command
3264
for k in ("name", "host", "checker_command"):
3265
if isinstance(value[k], bytes):
3266
value[k] = value[k].decode("utf-8")
3267
if "key_id" not in value:
3268
value["key_id"] = ""
3269
elif "fingerprint" not in value:
3270
value["fingerprint"] = ""
3271
# old_client_settings
3273
old_client_settings = {
3274
(key.decode("utf-8")
3275
if isinstance(key, bytes)
3278
bytes_old_client_settings.items()}
3279
del bytes_old_client_settings
3280
# .host and .checker_command
3281
for value in old_client_settings.values():
3282
for attribute in ("host", "checker_command"):
3283
if isinstance(value[attribute], bytes):
3284
value[attribute] = (value[attribute]
3286
os.remove(stored_state_path)
3287
except IOError as e:
3288
if e.errno == errno.ENOENT:
3289
logger.warning("Could not load persistent state:"
3290
" {}".format(os.strerror(e.errno)))
3292
logger.critical("Could not load persistent state:",
3295
except EOFError as e:
3296
logger.warning("Could not load persistent state: "
3300
with PGPEngine() as pgp:
3301
for client_name, client in clients_data.items():
3302
# Skip removed clients
3303
if client_name not in client_settings:
3306
# Decide which value to use after restoring saved state.
3307
# We have three different values: Old config file,
3308
# new config file, and saved state.
3309
# New config value takes precedence if it differs from old
3310
# config value, otherwise use saved state.
3311
for name, value in client_settings[client_name].items():
3313
# For each value in new config, check if it
3314
# differs from the old config value (Except for
3315
# the "secret" attribute)
3316
if (name != "secret"
3318
old_client_settings[client_name][name])):
3319
client[name] = value
3323
# Clients who has passed its expire date can still be
3324
# enabled if its last checker was successful. A Client
3325
# whose checker succeeded before we stored its state is
3326
# assumed to have successfully run all checkers during
3328
if client["enabled"]:
3329
if datetime.datetime.utcnow() >= client["expires"]:
3330
if not client["last_checked_ok"]:
3332
"disabling client {} - Client never "
3333
"performed a successful checker".format(
3335
client["enabled"] = False
3336
elif client["last_checker_status"] != 0:
3338
"disabling client {} - Client last"
3339
" checker failed with error code"
3342
client["last_checker_status"]))
3343
client["enabled"] = False
3345
client["expires"] = (
3346
datetime.datetime.utcnow()
3347
+ client["timeout"])
3348
logger.debug("Last checker succeeded,"
3349
" keeping {} enabled".format(
1960
client_class = functools.partial(ClientDBusTransitional, bus = bus)
1961
def client_config_items(config, section):
1962
special_settings = {
1963
"approved_by_default":
1964
lambda: config.getboolean(section,
1965
"approved_by_default"),
1967
for name, value in config.items(section):
3352
client["secret"] = pgp.decrypt(
3353
client["encrypted_secret"],
3354
client_settings[client_name]["secret"])
3356
# If decryption fails, we use secret from new settings
3357
logger.debug("Failed to decrypt {} old secret".format(
3359
client["secret"] = (client_settings[client_name]
3362
# Add/remove clients based on new changes made to config
3363
for client_name in (set(old_client_settings)
3364
- set(client_settings)):
3365
del clients_data[client_name]
3366
for client_name in (set(client_settings)
3367
- set(old_client_settings)):
3368
clients_data[client_name] = client_settings[client_name]
3370
# Create all client objects
3371
for client_name, client in clients_data.items():
3372
tcp_server.clients[client_name] = client_class(
3375
server_settings=server_settings)
1969
yield (name, special_settings[name]())
1973
tcp_server.clients.update(set(
1974
client_class(name = section,
1975
config= dict(client_config_items(
1976
client_config, section)))
1977
for section in client_config.sections()))
3377
1978
if not tcp_server.clients:
3378
1979
logger.warning("No clients defined")
3381
if pidfile is not None:
3385
print(pid, file=pidfile)
3387
logger.error("Could not write to file %r with PID %d",
1985
pidfile.write(str(pid) + "\n".encode("utf-8"))
1988
logger.error("Could not write to file %r with PID %d",
1991
# "pidfile" was never created
3390
1993
del pidfilename
3392
for termsig in (signal.SIGHUP, signal.SIGTERM):
3393
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3394
lambda: main_loop.quit() and False)
1995
signal.signal(signal.SIGINT, signal.SIG_IGN)
1997
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1998
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3398
@alternate_dbus_interfaces(
3399
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3400
class MandosDBusService(DBusObjectWithObjectManager):
2001
class MandosDBusService(dbus.service.Object):
3401
2002
"""A D-Bus proxy object"""
3403
2003
def __init__(self):
3404
2004
dbus.service.Object.__init__(self, bus, "/")
3406
_interface = "se.recompile.Mandos"
2005
_interface = "se.bsnet.fukt.Mandos"
3408
2007
@dbus.service.signal(_interface, signature="o")
3409
2008
def ClientAdded(self, objpath):
3413
2012
@dbus.service.signal(_interface, signature="ss")
3414
def ClientNotFound(self, key_id, address):
2013
def ClientNotFound(self, fingerprint, address):
3418
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3420
2017
@dbus.service.signal(_interface, signature="os")
3421
2018
def ClientRemoved(self, objpath, name):
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3427
2022
@dbus.service.method(_interface, out_signature="ao")
3428
2023
def GetAllClients(self):
3430
return dbus.Array(c.dbus_object_path for c in
3431
tcp_server.clients.values())
3433
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2025
return dbus.Array(c.dbus_object_path
2026
for c in tcp_server.clients)
3435
2028
@dbus.service.method(_interface,
3436
2029
out_signature="a{oa{sv}}")
3437
2030
def GetAllClientsWithProperties(self):
3439
2032
return dbus.Dictionary(
3440
{c.dbus_object_path: c.GetAll(
3441
"se.recompile.Mandos.Client")
3442
for c in tcp_server.clients.values()},
2033
((c.dbus_object_path, c.GetAll(""))
2034
for c in tcp_server.clients),
3443
2035
signature="oa{sv}")
3445
2037
@dbus.service.method(_interface, in_signature="o")
3446
2038
def RemoveClient(self, object_path):
3448
for c in tcp_server.clients.values():
2040
for c in tcp_server.clients:
3449
2041
if c.dbus_object_path == object_path:
3450
del tcp_server.clients[c.name]
2042
tcp_server.clients.remove(c)
3451
2043
c.remove_from_connection()
3452
# Don't signal the disabling
2044
# Don't signal anything except ClientRemoved
3453
2045
c.disable(quiet=True)
3454
# Emit D-Bus signal for removal
3455
self.client_removed_signal(c)
2047
self.ClientRemoved(object_path, c.name)
3457
2049
raise KeyError(object_path)
3461
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3462
out_signature="a{oa{sa{sv}}}")
3463
def GetManagedObjects(self):
3465
return dbus.Dictionary(
3466
{client.dbus_object_path:
3468
{interface: client.GetAll(interface)
3470
client._get_all_interface_names()})
3471
for client in tcp_server.clients.values()})
3473
def client_added_signal(self, client):
3474
"""Send the new standard signal and the old signal"""
3476
# New standard signal
3477
self.InterfacesAdded(
3478
client.dbus_object_path,
3480
{interface: client.GetAll(interface)
3482
client._get_all_interface_names()}))
3484
self.ClientAdded(client.dbus_object_path)
3486
def client_removed_signal(self, client):
3487
"""Send the new standard signal and the old signal"""
3489
# New standard signal
3490
self.InterfacesRemoved(
3491
client.dbus_object_path,
3492
client._get_all_interface_names())
3494
self.ClientRemoved(client.dbus_object_path,
3497
mandos_dbus_service = MandosDBusService()
3499
# Save modules to variables to exempt the modules from being
3500
# unloaded before the function registered with atexit() is run.
3501
mp = multiprocessing
2053
class MandosDBusServiceTransitional(MandosDBusService):
2054
__metaclass__ = transitional_dbus_metaclass
2055
mandos_dbus_service = MandosDBusServiceTransitional()
3505
2058
"Cleanup function; run on exit"
3509
mp.active_children()
3511
if not (tcp_server.clients or client_settings):
3514
# Store client before exiting. Secrets are encrypted with key
3515
# based on what config file has. If config file is
3516
# removed/edited, old secret will thus be unrecovable.
3518
with PGPEngine() as pgp:
3519
for client in tcp_server.clients.values():
3520
key = client_settings[client.name]["secret"]
3521
client.encrypted_secret = pgp.encrypt(client.secret,
3525
# A list of attributes that can not be pickled
3527
exclude = {"bus", "changedstate", "secret",
3528
"checker", "server_settings"}
3529
for name, typ in inspect.getmembers(dbus.service
3533
client_dict["encrypted_secret"] = (client
3535
for attr in client.client_structure:
3536
if attr not in exclude:
3537
client_dict[attr] = getattr(client, attr)
3539
clients[client.name] = client_dict
3540
del client_settings[client.name]["secret"]
3543
with tempfile.NamedTemporaryFile(
3547
dir=os.path.dirname(stored_state_path),
3548
delete=False) as stored_state:
3549
pickle.dump((clients, client_settings), stored_state,
3551
tempname = stored_state.name
3552
os.rename(tempname, stored_state_path)
3553
except (IOError, OSError) as e:
3559
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3560
logger.warning("Could not save persistent state: {}"
3561
.format(os.strerror(e.errno)))
3563
logger.warning("Could not save persistent state:",
3567
# Delete all clients, and settings from config
3568
2061
while tcp_server.clients:
3569
name, client = tcp_server.clients.popitem()
2062
client = tcp_server.clients.pop()
3571
2064
client.remove_from_connection()
3572
# Don't signal the disabling
2065
client.disable_hook = None
2066
# Don't signal anything except ClientRemoved
3573
2067
client.disable(quiet=True)
3574
# Emit D-Bus signal for removal
3576
mandos_dbus_service.client_removed_signal(client)
3577
client_settings.clear()
2070
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3579
2073
atexit.register(cleanup)
3581
for client in tcp_server.clients.values():
2075
for client in tcp_server.clients:
3583
# Emit D-Bus signal for adding
3584
mandos_dbus_service.client_added_signal(client)
3585
# Need to initiate checking of clients
3587
client.init_checker()
2078
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3589
2081
tcp_server.enable()
3590
2082
tcp_server.server_activate()
3592
2084
# Find out what port we got
3594
service.port = tcp_server.socket.getsockname()[1]
2085
service.port = tcp_server.socket.getsockname()[1]
3596
2087
logger.info("Now listening on address %r, port %d,"
3597
" flowinfo %d, scope_id %d",
3598
*tcp_server.socket.getsockname())
2088
" flowinfo %d, scope_id %d"
2089
% tcp_server.socket.getsockname())
3600
logger.info("Now listening on address %r, port %d",
3601
*tcp_server.socket.getsockname())
3603
# service.interface = tcp_server.socket.getsockname()[3]
2091
logger.info("Now listening on address %r, port %d"
2092
% tcp_server.socket.getsockname())
2094
#service.interface = tcp_server.socket.getsockname()[3]
3607
# From the Avahi example code
3610
except dbus.exceptions.DBusException as error:
3611
logger.critical("D-Bus Exception", exc_info=error)
3614
# End of Avahi example code
3617
GLib.IOChannel.unix_new(tcp_server.fileno()),
3618
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3619
lambda *args, **kwargs: (tcp_server.handle_request
3620
(*args[2:], **kwargs) or True))
2097
# From the Avahi example code
2100
except dbus.exceptions.DBusException as error:
2101
logger.critical("DBusException: %s", error)
2104
# End of Avahi example code
2106
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2107
lambda *args, **kwargs:
2108
(tcp_server.handle_request
2109
(*args[2:], **kwargs) or True))
3622
2111
logger.debug("Starting main loop")
3623
2112
main_loop.run()
3624
2113
except AvahiError as error:
3625
logger.critical("Avahi Error", exc_info=error)
2114
logger.critical("AvahiError: %s", error)
3628
2117
except KeyboardInterrupt: