63
import cPickle as pickle
70
import cPickle as pickle
64
73
import multiprocessing
67
84
import dbus.service
86
from gi.repository import GLib
70
87
from dbus.mainloop.glib import DBusGMainLoop
73
90
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:
77
115
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
78
116
except AttributeError:
118
# This is where SO_BINDTODEVICE was up to and including Python
80
120
from IN import SO_BINDTODEVICE
81
121
except ImportError:
82
SO_BINDTODEVICE = None
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
89
syslogger = (logging.handlers.SysLogHandler
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
address = str("/dev/log")))
92
syslogger.setFormatter(logging.Formatter
93
('Mandos [%(process)d]: %(levelname)s:'
95
logger.addHandler(syslogger)
97
console = logging.StreamHandler()
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
101
logger.addHandler(console)
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
103
325
class AvahiError(Exception):
104
326
def __init__(self, value, *args, **kwargs):
105
327
self.value = value
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
328
return super(AvahiError, self).__init__(value, *args,
110
332
class AvahiServiceError(AvahiError):
113
336
class AvahiGroupError(AvahiError):
117
class AvahiService(object):
118
341
"""An Avahi (Zeroconf) service.
121
344
interface: integer; avahi.IF_UNSPEC or an interface index.
122
345
Used to optionally bind to the specified interface.
123
346
name: string; Example: 'Mandos'
124
347
type: string; Example: '_mandos._tcp'.
125
See <http://www.dns-sd.org/ServiceTypes.html>
348
See <https://www.iana.org/assignments/service-names-port-numbers>
126
349
port: integer; what port to announce
127
350
TXT: list of strings; TXT record for the service
128
351
domain: string; Domain to publish on, default to .local if empty.
210
453
elif state == avahi.ENTRY_GROUP_FAILURE:
211
454
logger.critical("Avahi: Error in group state changed %s",
213
raise AvahiGroupError("State changed: %s"
456
raise AvahiGroupError("State changed: {!s}".format(error))
215
458
def cleanup(self):
216
459
"""Derived from the Avahi example code"""
217
460
if self.group is not None:
463
except (dbus.exceptions.UnknownMethodException,
464
dbus.exceptions.DBusException):
219
466
self.group = None
220
def server_state_changed(self, state):
469
def server_state_changed(self, state, error=None):
221
470
"""Derived from the Avahi example code"""
222
471
logger.debug("Avahi server state change: %i", state)
223
if state == avahi.SERVER_COLLISION:
224
logger.error("Zeroconf server name collision")
473
avahi.SERVER_INVALID: "Zeroconf server invalid",
474
avahi.SERVER_REGISTERING: None,
475
avahi.SERVER_COLLISION: "Zeroconf server name collision",
476
avahi.SERVER_FAILURE: "Zeroconf server failure",
478
if state in bad_states:
479
if bad_states[state] is not None:
481
logger.error(bad_states[state])
483
logger.error(bad_states[state] + ": %r", error)
226
485
elif state == avahi.SERVER_RUNNING:
488
except dbus.exceptions.DBusException as error:
489
if (error.get_dbus_name()
490
== "org.freedesktop.Avahi.CollisionError"):
491
logger.info("Local Zeroconf service name"
493
return self.rename(remove=False)
495
logger.critical("D-Bus Exception", exc_info=error)
500
logger.debug("Unknown state: %r", state)
502
logger.debug("Unknown state: %r: %r", state, error)
228
504
def activate(self):
229
505
"""Derived from the Avahi example code"""
230
506
if self.server is None:
231
507
self.server = dbus.Interface(
232
508
self.bus.get_object(avahi.DBUS_NAME,
233
avahi.DBUS_PATH_SERVER),
509
avahi.DBUS_PATH_SERVER,
510
follow_name_owner_changes=True),
234
511
avahi.DBUS_INTERFACE_SERVER)
235
512
self.server.connect_to_signal("StateChanged",
236
self.server_state_changed)
513
self.server_state_changed)
237
514
self.server_state_changed(self.server.GetState())
240
class Client(object):
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))
241
840
"""A representation of a client host served by this server.
244
_approved: bool(); 'None' if not yet approved/disapproved
843
approved: bool(); 'None' if not yet approved/disapproved
245
844
approval_delay: datetime.timedelta(); Time to wait for approval
246
845
approval_duration: datetime.timedelta(); Duration of one approval
247
checker: subprocess.Popen(); a running checker process used
248
to see if the client lives.
249
'None' if no process is running.
250
checker_callback_tag: a gobject event source tag, or None
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
251
850
checker_command: string; External command which is run to check
252
851
if client lives. %() expansions are done at
253
852
runtime with vars(self) as dict, so that for
254
853
instance %(name)s can be used in the command.
255
checker_initiator_tag: a gobject event source tag, or None
854
checker_initiator_tag: a GLib event source tag, or None
256
855
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
257
858
current_checker_command: string; current running checker_command
258
disable_hook: If set, called by disable() as disable_hook(self)
259
disable_initiator_tag: a gobject event source tag, or None
859
disable_initiator_tag: a GLib event source tag, or None
261
861
fingerprint: string (40 or 32 hexadecimal digits); used to
262
uniquely identify the client
862
uniquely identify an OpenPGP client
863
key_id: string (64 hexadecimal digits); used to uniquely identify
864
a client using raw public keys
263
865
host: string; available for use by the checker command
264
866
interval: datetime.timedelta(); How often to start a new checker
265
867
last_approval_request: datetime.datetime(); (UTC) or None
266
868
last_checked_ok: datetime.datetime(); (UTC) or None
267
last_enabled: datetime.datetime(); (UTC)
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
268
875
name: string; from the config file, used in log messages and
269
876
D-Bus identifiers
270
877
secret: bytestring; sent verbatim (over TLS) to client
271
878
timeout: datetime.timedelta(); How long from last_checked_ok
272
879
until this client is disabled
880
extended_timeout: extra long timeout when secret has been sent
273
881
runtime_expansions: Allowed attributes for runtime expansion.
882
expires: datetime.datetime(); time (UTC) when a client will be
884
server_settings: The server_settings dict from main()
276
887
runtime_expansions = ("approval_delay", "approval_duration",
277
"created", "enabled", "fingerprint",
278
"host", "interval", "last_checked_ok",
888
"created", "enabled", "expires", "key_id",
889
"fingerprint", "host", "interval",
890
"last_approval_request", "last_checked_ok",
279
891
"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",
282
def _timedelta_to_milliseconds(td):
283
"Convert a datetime.timedelta() to milliseconds"
284
return ((td.days * 24 * 60 * 60 * 1000)
285
+ (td.seconds * 1000)
286
+ (td.microseconds // 1000))
288
def timeout_milliseconds(self):
289
"Return the 'timeout' attribute in milliseconds"
290
return self._timedelta_to_milliseconds(self.timeout)
292
def interval_milliseconds(self):
293
"Return the 'interval' attribute in milliseconds"
294
return self._timedelta_to_milliseconds(self.interval)
296
def approval_delay_milliseconds(self):
297
return self._timedelta_to_milliseconds(self.approval_delay)
299
def __init__(self, name = None, disable_hook=None, config=None):
300
"""Note: the 'checker' key in 'config' sets the
301
'checker_command' attribute and *not* the 'checker'
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):
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
306
977
logger.debug("Creating client %r", self.name)
307
# Uppercase and remove spaces from fingerprint for later
308
# comparison purposes with return value from the fingerprint()
310
self.fingerprint = (config["fingerprint"].upper()
978
logger.debug(" Key ID: %s", self.key_id)
312
979
logger.debug(" Fingerprint: %s", self.fingerprint)
313
if "secret" in config:
314
self.secret = config["secret"].decode("base64")
315
elif "secfile" in config:
316
with open(os.path.expanduser(os.path.expandvars
317
(config["secfile"])),
319
self.secret = secfile.read()
321
raise TypeError("No secret or secfile for client %s"
323
self.host = config.get("host", "")
324
self.created = datetime.datetime.utcnow()
326
self.last_approval_request = None
327
self.last_enabled = None
328
self.last_checked_ok = None
329
self.timeout = string_to_delta(config["timeout"])
330
self.interval = string_to_delta(config["interval"])
331
self.disable_hook = disable_hook
980
self.created = settings.get("created",
981
datetime.datetime.utcnow())
983
# attributes specific for this server instance
332
984
self.checker = None
333
985
self.checker_initiator_tag = None
334
986
self.disable_initiator_tag = None
335
987
self.checker_callback_tag = None
336
self.checker_command = config["checker"]
337
988
self.current_checker_command = None
338
self.last_connect = None
339
self._approved = None
340
self.approved_by_default = config.get("approved_by_default",
342
990
self.approvals_pending = 0
343
self.approval_delay = string_to_delta(
344
config["approval_delay"])
345
self.approval_duration = string_to_delta(
346
config["approval_duration"])
347
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
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
349
1004
def send_changedstate(self):
350
self.changedstate.acquire()
351
self.changedstate.notify_all()
352
self.changedstate.release()
1005
with self.changedstate:
1006
self.changedstate.notify_all()
354
1008
def enable(self):
355
1009
"""Start this client's checker and timeout hooks"""
356
1010
if getattr(self, "enabled", False):
357
1011
# Already enabled
359
self.send_changedstate()
1013
self.expires = datetime.datetime.utcnow() + self.timeout
360
1015
self.last_enabled = datetime.datetime.utcnow()
361
# Schedule a new checker to be started an 'interval' from now,
362
# and every interval from then on.
363
self.checker_initiator_tag = (gobject.timeout_add
364
(self.interval_milliseconds(),
366
# Schedule a disable() when 'timeout' has passed
367
self.disable_initiator_tag = (gobject.timeout_add
368
(self.timeout_milliseconds(),
371
# Also start a new checker *right now*.
1017
self.send_changedstate()
374
1019
def disable(self, quiet=True):
375
1020
"""Disable this client."""
376
1021
if not getattr(self, "enabled", False):
379
self.send_changedstate()
381
1024
logger.info("Disabling client %s", self.name)
382
if getattr(self, "disable_initiator_tag", False):
383
gobject.source_remove(self.disable_initiator_tag)
1025
if getattr(self, "disable_initiator_tag", None) is not None:
1026
GLib.source_remove(self.disable_initiator_tag)
384
1027
self.disable_initiator_tag = None
385
if getattr(self, "checker_initiator_tag", False):
386
gobject.source_remove(self.checker_initiator_tag)
1029
if getattr(self, "checker_initiator_tag", None) is not None:
1030
GLib.source_remove(self.checker_initiator_tag)
387
1031
self.checker_initiator_tag = None
388
1032
self.stop_checker()
389
if self.disable_hook:
390
self.disable_hook(self)
391
1033
self.enabled = False
392
# Do not run this again if called by a gobject.timeout_add
1035
self.send_changedstate()
1036
# Do not run this again if called by a GLib.timeout_add
395
1039
def __del__(self):
396
self.disable_hook = None
399
def checker_callback(self, pid, condition, command):
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,
400
1061
"""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:
401
1067
self.checker_callback_tag = None
402
1068
self.checker = None
403
if os.WIFEXITED(condition):
404
exitstatus = os.WEXITSTATUS(condition)
1071
self.last_checker_status = returncode
1072
self.last_checker_signal = None
1073
if self.last_checker_status == 0:
406
1074
logger.info("Checker for %(name)s succeeded",
408
1076
self.checked_ok()
410
logger.info("Checker for %(name)s failed",
1078
logger.info("Checker for %(name)s failed", vars(self))
1080
self.last_checker_status = -1
1081
self.last_checker_signal = -returncode
413
1082
logger.warning("Checker for %(name)s crashed?",
416
1086
def checked_ok(self):
417
"""Bump up the timeout for this client.
419
This should only be called when the client has been seen,
1087
"""Assert that the client has been seen, alive and well."""
422
1088
self.last_checked_ok = datetime.datetime.utcnow()
423
gobject.source_remove(self.disable_initiator_tag)
424
self.disable_initiator_tag = (gobject.timeout_add
425
(self.timeout_milliseconds(),
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."""
1096
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
428
1105
def need_approval(self):
429
1106
self.last_approval_request = datetime.datetime.utcnow()
431
1108
def start_checker(self):
432
1109
"""Start a new checker subprocess if one is not running.
434
1111
If a checker already exists, leave it running and do
436
1113
# The reason for not killing a running checker is that if we
437
# did that, then if a checker (for some reason) started
438
# running slowly and taking more than 'interval' time, the
439
# client would inevitably timeout, since no checker would get
440
# a chance to run to completion. If we instead leave running
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
441
1118
# checkers alone, the checker would have to take more time
442
1119
# than 'timeout' for the client to be disabled, which is as it
445
# If a checker exists, make sure it is not a zombie
447
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
448
except (AttributeError, OSError), error:
449
if (isinstance(error, OSError)
450
and error.errno != errno.ECHILD):
454
logger.warning("Checker was a zombie")
455
gobject.source_remove(self.checker_callback_tag)
456
self.checker_callback(pid, status,
457
self.current_checker_command)
1122
if self.checker is not None and not self.checker.is_alive():
1123
logger.warning("Checker was not alive; joining")
458
1126
# Start a new checker if needed
459
1127
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}
461
# In case checker_command has exactly one % operator
462
command = self.checker_command % self.host
464
# Escape attributes for the shell
465
escaped_attrs = dict(
467
re.escape(unicode(str(getattr(self, attr, "")),
471
self.runtime_expansions)
474
command = self.checker_command % escaped_attrs
475
except TypeError, error:
476
logger.error('Could not format string "%s":'
477
' %s', self.checker_command, error)
478
return True # Try again later
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
479
1139
self.current_checker_command = command
481
logger.info("Starting checker %r for %s",
483
# We don't need to redirect stdout and stderr, since
484
# in normal mode, that is already done by daemon(),
485
# and in debug mode we don't want to. (Stdin is
486
# always replaced by /dev/null.)
487
self.checker = subprocess.Popen(command,
490
self.checker_callback_tag = (gobject.child_watch_add
492
self.checker_callback,
494
# The checker may have completed before the gobject
495
# watch was added. Check for this.
496
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
498
gobject.source_remove(self.checker_callback_tag)
499
self.checker_callback(pid, status, command)
500
except OSError, error:
501
logger.error("Failed to start subprocess: %s",
503
# Re-run this periodically if run by gobject.timeout_add
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
506
1169
def stop_checker(self):
507
1170
"""Force the checker process, if any, to stop."""
508
1171
if self.checker_callback_tag:
509
gobject.source_remove(self.checker_callback_tag)
1172
GLib.source_remove(self.checker_callback_tag)
510
1173
self.checker_callback_tag = None
511
1174
if getattr(self, "checker", None) is None:
513
1176
logger.debug("Stopping checker for %(name)s", vars(self))
515
os.kill(self.checker.pid, signal.SIGTERM)
517
#if self.checker.poll() is None:
518
# os.kill(self.checker.pid, signal.SIGKILL)
519
except OSError, error:
520
if error.errno != errno.ESRCH: # No such process
1177
self.checker.terminate()
522
1178
self.checker = None
524
def dbus_service_property(dbus_interface, signature="v",
525
access="readwrite", byte_arrays=False):
1181
def dbus_service_property(dbus_interface,
526
1185
"""Decorators for marking methods of a DBusObjectWithProperties to
527
1186
become properties on the D-Bus.
529
1188
The decorated method will be called with no arguments by "Get"
530
1189
and with one argument by "Set".
532
1191
The parameters, where they are supported, are the same as
533
1192
dbus.service.method, except there is only "signature", since the
534
1193
type from Get() and the type sent to Set() is the same.
704
1523
xmlstring = document.toxml("utf-8")
705
1524
document.unlink()
706
1525
except (AttributeError, xml.dom.DOMException,
707
xml.parsers.expat.ExpatError), error:
708
logger.error("Failed to override Introspection method",
1526
xml.parsers.expat.ExpatError) as error:
1527
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):
1604
"""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"})
713
1781
class ClientDBus(Client, DBusObjectWithProperties):
714
1782
"""A Client class using D-Bus
717
1785
dbus_object_path: dbus.ObjectPath
718
1786
bus: dbus.SystemBus()
721
1789
runtime_expansions = (Client.runtime_expansions
722
+ ("dbus_object_path",))
1790
+ ("dbus_object_path", ))
1792
_interface = "se.recompile.Mandos.Client"
724
1794
# dbus.service.Object doesn't use super(), so we can't either.
726
def __init__(self, bus = None, *args, **kwargs):
727
self._approvals_pending = 0
1796
def __init__(self, bus=None, *args, **kwargs):
729
1798
Client.__init__(self, *args, **kwargs)
730
1799
# Only now, when this client is initialized, can it show up on
732
client_object_name = unicode(self.name).translate(
1801
client_object_name = str(self.name).translate(
733
1802
{ord("."): ord("_"),
734
1803
ord("-"): ord("_")})
735
self.dbus_object_path = (dbus.ObjectPath
736
("/clients/" + client_object_name))
1804
self.dbus_object_path = dbus.ObjectPath(
1805
"/clients/" + client_object_name)
737
1806
DBusObjectWithProperties.__init__(self, self.bus,
738
1807
self.dbus_object_path)
740
def _get_approvals_pending(self):
741
return self._approvals_pending
742
def _set_approvals_pending(self, value):
743
old_value = self._approvals_pending
744
self._approvals_pending = value
746
if (hasattr(self, "dbus_object_path")
747
and bval is not bool(old_value)):
748
dbus_bool = dbus.Boolean(bval, variant_level=1)
749
self.PropertyChanged(dbus.String("ApprovalPending"),
752
approvals_pending = property(_get_approvals_pending,
753
_set_approvals_pending)
754
del _get_approvals_pending, _set_approvals_pending
757
def _datetime_to_dbus(dt, variant_level=0):
758
"""Convert a UTC datetime.datetime() to a D-Bus type."""
759
return dbus.String(dt.isoformat(),
760
variant_level=variant_level)
763
oldstate = getattr(self, "enabled", False)
764
r = Client.enable(self)
765
if oldstate != self.enabled:
767
self.PropertyChanged(dbus.String("Enabled"),
768
dbus.Boolean(True, variant_level=1))
769
self.PropertyChanged(
770
dbus.String("LastEnabled"),
771
self._datetime_to_dbus(self.last_enabled,
775
def disable(self, quiet = False):
776
oldstate = getattr(self, "enabled", False)
777
r = Client.disable(self, quiet=quiet)
778
if not quiet and oldstate != self.enabled:
780
self.PropertyChanged(dbus.String("Enabled"),
781
dbus.Boolean(False, variant_level=1))
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
1820
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
1824
attrname = "_{}".format(dbus_name)
1826
def setter(self, value):
1827
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)
1850
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1851
approvals_pending = notifychangeproperty(dbus.Boolean,
1854
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1855
last_enabled = notifychangeproperty(datetime_to_dbus,
1857
checker = notifychangeproperty(
1858
dbus.Boolean, "CheckerRunning",
1859
type_func=lambda checker: checker is not None)
1860
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1862
last_checker_status = notifychangeproperty(dbus.Int16,
1863
"LastCheckerStatus")
1864
last_approval_request = notifychangeproperty(
1865
datetime_to_dbus, "LastApprovalRequest")
1866
approved_by_default = notifychangeproperty(dbus.Boolean,
1867
"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)
1874
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)
1884
checker_command = notifychangeproperty(dbus.String, "Checker")
1885
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1886
invalidate_only=True)
1888
del notifychangeproperty
784
1890
def __del__(self, *args, **kwargs):
786
1892
self.remove_from_connection()
1289
2391
delay -= time2 - time
1292
while sent_size < len(client.secret):
1294
sent = session.send(client.secret[sent_size:])
1295
except (gnutls.errors.GNUTLSError), error:
1296
logger.warning("gnutls send failed")
1298
logger.debug("Sent: %d, remaining: %d",
1299
sent, len(client.secret)
1300
- (sent_size + sent))
2394
session.send(client.secret)
2395
except gnutls.Error as error:
2396
logger.warning("gnutls send failed",
1303
2400
logger.info("Sending secret to %s", client.name)
1304
# bump the timeout as if seen
2401
# bump the timeout using extended_timeout
2402
client.bump_timeout(client.extended_timeout)
1306
2403
if self.server.use_dbus:
1307
2404
# Emit D-Bus signal
1308
2405
client.GotSecret()
1311
2408
if approval_required:
1312
2409
client.approvals_pending -= 1
1315
except (gnutls.errors.GNUTLSError), error:
1316
logger.warning("GnuTLS bye failed")
2412
except gnutls.Error as error:
2413
logger.warning("GnuTLS bye failed",
1319
2417
def peer_certificate(session):
1320
"Return the peer's OpenPGP certificate as a bytestring"
1321
# If not an OpenPGP certificate...
1322
if (gnutls.library.functions
1323
.gnutls_certificate_type_get(session._c_object)
1324
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1325
# ...do the normal thing
1326
return session.peer_certificate
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
1327
2434
list_size = ctypes.c_uint(1)
1328
cert_list = (gnutls.library.functions
1329
.gnutls_certificate_get_peers
2435
cert_list = (gnutls.certificate_get_peers
1330
2436
(session._c_object, ctypes.byref(list_size)))
1331
2437
if not bool(cert_list) and list_size.value != 0:
1332
raise gnutls.errors.GNUTLSError("error getting peer"
2438
raise gnutls.Error("error getting peer certificate")
1334
2439
if list_size.value == 0:
1336
2441
cert = cert_list[0]
1337
2442
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()
1340
2479
def fingerprint(openpgp):
1341
2480
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1342
2481
# New GnuTLS "datum" with the OpenPGP public key
1343
datum = (gnutls.library.types
1344
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1347
ctypes.c_uint(len(openpgp))))
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)))
1348
2486
# New empty GnuTLS certificate
1349
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1350
(gnutls.library.functions
1351
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2487
crt = gnutls.openpgp_crt_t()
2488
gnutls.openpgp_crt_init(ctypes.byref(crt))
1352
2489
# Import the OpenPGP public key into the certificate
1353
(gnutls.library.functions
1354
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1355
gnutls.library.constants
1356
.GNUTLS_OPENPGP_FMT_RAW))
2490
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2491
gnutls.OPENPGP_FMT_RAW)
1357
2492
# Verify the self signature in the key
1358
2493
crtverify = ctypes.c_uint()
1359
(gnutls.library.functions
1360
.gnutls_openpgp_crt_verify_self(crt, 0,
1361
ctypes.byref(crtverify)))
2494
gnutls.openpgp_crt_verify_self(crt, 0,
2495
ctypes.byref(crtverify))
1362
2496
if crtverify.value != 0:
1363
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1364
raise (gnutls.errors.CertificateSecurityError
2497
gnutls.openpgp_crt_deinit(crt)
2498
raise gnutls.CertificateSecurityError(code
1366
2500
# New buffer for the fingerprint
1367
2501
buf = ctypes.create_string_buffer(20)
1368
2502
buf_len = ctypes.c_size_t()
1369
2503
# Get the fingerprint from the certificate into the buffer
1370
(gnutls.library.functions
1371
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1372
ctypes.byref(buf_len)))
2504
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2505
ctypes.byref(buf_len))
1373
2506
# Deinit the certificate
1374
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2507
gnutls.openpgp_crt_deinit(crt)
1375
2508
# Convert the buffer to a Python bytestring
1376
2509
fpr = ctypes.string_at(buf, buf_len.value)
1377
2510
# Convert the bytestring to hexadecimal notation
1378
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2511
hex_fpr = binascii.hexlify(fpr).upper()
1382
class MultiprocessingMixIn(object):
2515
class MultiprocessingMixIn:
1383
2516
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1384
2518
def sub_process_main(self, request, address):
1386
2520
self.finish_request(request, address)
1388
2522
self.handle_error(request, address)
1389
2523
self.close_request(request)
1391
2525
def process_request(self, request, address):
1392
2526
"""Start a new process to process the request."""
1393
multiprocessing.Process(target = self.sub_process_main,
1394
args = (request, address)).start()
1396
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2527
proc = multiprocessing.Process(target=self.sub_process_main,
2528
args=(request, address))
2533
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1397
2534
""" adds a pipe to the MixIn """
1398
2536
def process_request(self, request, client_address):
1399
2537
"""Overrides and wraps the original process_request().
1401
2539
This function creates a new pipe in self.pipe
1403
2541
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1405
super(MultiprocessingMixInWithPipe,
1406
self).process_request(request, client_address)
2543
proc = MultiprocessingMixIn.process_request(self, request,
1407
2545
self.child_pipe.close()
1408
self.add_pipe(parent_pipe)
2546
self.add_pipe(parent_pipe, proc)
1410
def add_pipe(self, parent_pipe):
2548
def add_pipe(self, parent_pipe, proc):
1411
2549
"""Dummy function; override as necessary"""
1412
raise NotImplementedError
2550
raise NotImplementedError()
1414
2553
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1415
socketserver.TCPServer, object):
2554
socketserver.TCPServer):
1416
2555
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1419
2558
enabled: Boolean; whether this server is activated yet
1420
2559
interface: None or a network interface name (string)
1421
2560
use_ipv6: Boolean; to use IPv6 or not
1423
2563
def __init__(self, server_address, RequestHandlerClass,
1424
interface=None, use_ipv6=True):
2567
"""If socketfd is set, use that file descriptor instead of
2568
creating a new one with socket.socket().
1425
2570
self.interface = interface
1427
2572
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.
1428
2600
socketserver.TCPServer.__init__(self, server_address,
1429
2601
RequestHandlerClass)
1430
2603
def server_bind(self):
1431
2604
"""This overrides the normal server_bind() function
1432
2605
to bind to an interface if one was specified, and also NOT to
1433
2606
bind to an address or port if they were not specified."""
2607
global SO_BINDTODEVICE
1434
2608
if self.interface is not None:
1435
2609
if SO_BINDTODEVICE is None:
1436
logger.error("SO_BINDTODEVICE does not exist;"
1437
" cannot bind to interface %s",
1441
self.socket.setsockopt(socket.SOL_SOCKET,
1445
except socket.error, error:
1446
if error[0] == errno.EPERM:
1447
logger.error("No permission to"
1448
" bind to interface %s",
1450
elif error[0] == errno.ENOPROTOOPT:
1451
logger.error("SO_BINDTODEVICE not available;"
1452
" cannot bind to interface %s",
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)
1456
2631
# Only bind(2) the socket if we really need to.
1457
2632
if self.server_address[0] or self.server_address[1]:
2633
if self.server_address[1]:
2634
self.allow_reuse_address = True
1458
2635
if not self.server_address[0]:
1459
2636
if self.address_family == socket.AF_INET6:
1460
any_address = "::" # in6addr_any
2637
any_address = "::" # in6addr_any
1462
any_address = socket.INADDR_ANY
2639
any_address = "0.0.0.0" # INADDR_ANY
1463
2640
self.server_address = (any_address,
1464
2641
self.server_address[1])
1465
2642
elif not self.server_address[1]:
1466
self.server_address = (self.server_address[0],
2643
self.server_address = (self.server_address[0], 0)
1468
2644
# if self.interface:
1469
2645
# self.server_address = (self.server_address[0],
1673
2945
##################################################################
1674
2946
# Parsing of options, both command line and config file
1676
parser = optparse.OptionParser(version = "%%prog %s" % version)
1677
parser.add_option("-i", "--interface", type="string",
1678
metavar="IF", help="Bind to interface IF")
1679
parser.add_option("-a", "--address", type="string",
1680
help="Address to listen for requests on")
1681
parser.add_option("-p", "--port", type="int",
1682
help="Port number to receive requests on")
1683
parser.add_option("--check", action="store_true",
1684
help="Run self-test")
1685
parser.add_option("--debug", action="store_true",
1686
help="Debug mode; run in foreground and log to"
1688
parser.add_option("--debuglevel", type="string", metavar="LEVEL",
1689
help="Debug level for stdout output")
1690
parser.add_option("--priority", type="string", help="GnuTLS"
1691
" priority string (see GnuTLS documentation)")
1692
parser.add_option("--servicename", type="string",
1693
metavar="NAME", help="Zeroconf service name")
1694
parser.add_option("--configdir", type="string",
1695
default="/etc/mandos", metavar="DIR",
1696
help="Directory to search for configuration"
1698
parser.add_option("--no-dbus", action="store_false",
1699
dest="use_dbus", help="Do not provide D-Bus"
1700
" system bus interface")
1701
parser.add_option("--no-ipv6", action="store_false",
1702
dest="use_ipv6", help="Do not use IPv6")
1703
options = parser.parse_args()[0]
2948
parser = argparse.ArgumentParser()
2949
parser.add_argument("-v", "--version", action="version",
2950
version="%(prog)s {}".format(version),
2951
help="show version number and exit")
2952
parser.add_argument("-i", "--interface", metavar="IF",
2953
help="Bind to interface IF")
2954
parser.add_argument("-a", "--address",
2955
help="Address to listen for requests on")
2956
parser.add_argument("-p", "--port", type=int,
2957
help="Port number to receive requests on")
2958
parser.add_argument("--check", action="store_true",
2959
help="Run self-test")
2960
parser.add_argument("--debug", action="store_true",
2961
help="Debug mode; run in foreground and log"
2962
" to terminal", default=None)
2963
parser.add_argument("--debuglevel", metavar="LEVEL",
2964
help="Debug level for stdout output")
2965
parser.add_argument("--priority", help="GnuTLS"
2966
" priority string (see GnuTLS documentation)")
2967
parser.add_argument("--servicename",
2968
metavar="NAME", help="Zeroconf service name")
2969
parser.add_argument("--configdir",
2970
default="/etc/mandos", metavar="DIR",
2971
help="Directory to search for configuration"
2973
parser.add_argument("--no-dbus", action="store_false",
2974
dest="use_dbus", help="Do not provide D-Bus"
2975
" system bus interface", default=None)
2976
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",
2993
options = parser.parse_args()
1710
2995
# Default values for config file for server-global settings
1711
server_defaults = { "interface": "",
1716
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1717
"servicename": "Mandos",
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",
1723
3019
# Parse config file for server-global settings
1724
server_config = configparser.SafeConfigParser(server_defaults)
3020
server_config = configparser.ConfigParser(server_defaults)
1725
3021
del server_defaults
1726
server_config.read(os.path.join(options.configdir,
1728
# Convert the SafeConfigParser object to a dict
3022
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3023
# Convert the ConfigParser object to a dict
1729
3024
server_settings = server_config.defaults()
1730
3025
# Use the appropriate methods on the non-string config options
1731
for option in ("debug", "use_dbus", "use_ipv6"):
3026
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3027
"foreground", "zeroconf"):
1732
3028
server_settings[option] = server_config.getboolean("DEFAULT",
1734
3030
if server_settings["port"]:
1735
3031
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
1737
3042
del server_config
1739
3044
# Override the settings from the config file with command line
1740
3045
# options, if set.
1741
3046
for option in ("interface", "address", "port", "debug",
1742
"priority", "servicename", "configdir",
1743
"use_dbus", "use_ipv6", "debuglevel"):
3047
"priority", "servicename", "configdir", "use_dbus",
3048
"use_ipv6", "debuglevel", "restore", "statedir",
3049
"socket", "foreground", "zeroconf"):
1744
3050
value = getattr(options, option)
1745
3051
if value is not None:
1746
3052
server_settings[option] = value
1748
3054
# Force all strings to be unicode
1749
3055
for option in server_settings.keys():
1750
if type(server_settings[option]) is str:
1751
server_settings[option] = unicode(server_settings[option])
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
1752
3066
# Now we have our good server settings in "server_settings"
1754
3068
##################################################################
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")
1756
3075
# For convenience
1757
3076
debug = server_settings["debug"]
1758
3077
debuglevel = server_settings["debuglevel"]
1759
3078
use_dbus = server_settings["use_dbus"]
1760
3079
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)
1762
3094
if server_settings["servicename"] != "Mandos":
1763
syslogger.setFormatter(logging.Formatter
1764
('Mandos (%s) [%%(process)d]:'
1765
' %%(levelname)s: %%(message)s'
1766
% server_settings["servicename"]))
3095
syslogger.setFormatter(
3096
logging.Formatter('Mandos ({}) [%(process)d]:'
3097
' %(levelname)s: %(message)s'.format(
3098
server_settings["servicename"])))
1768
3100
# Parse config file with clients
1769
client_defaults = { "timeout": "1h",
1771
"checker": "fping -q -- %%(host)s",
1773
"approval_delay": "0s",
1774
"approval_duration": "1s",
1776
client_config = configparser.SafeConfigParser(client_defaults)
3101
client_config = configparser.ConfigParser(Client.client_defaults)
1777
3102
client_config.read(os.path.join(server_settings["configdir"],
1778
3103
"clients.conf"))
1780
3105
global mandos_dbus_service
1781
3106
mandos_dbus_service = None
1783
tcp_server = MandosServer((server_settings["address"],
1784
server_settings["port"]),
1786
interface=(server_settings["interface"]
1790
server_settings["priority"],
1793
pidfilename = "/var/run/mandos.pid"
1795
pidfile = open(pidfilename, "w")
1797
logger.error("Could not open file %r", pidfilename)
1800
uid = pwd.getpwnam("_mandos").pw_uid
1801
gid = pwd.getpwnam("_mandos").pw_gid
1804
uid = pwd.getpwnam("mandos").pw_uid
1805
gid = pwd.getpwnam("mandos").pw_gid
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
1806
3137
except KeyError:
1808
uid = pwd.getpwnam("nobody").pw_uid
1809
gid = pwd.getpwnam("nobody").pw_gid
1816
except OSError, error:
1817
if error[0] != errno.EPERM:
1820
if not debug and not debuglevel:
1821
syslogger.setLevel(logging.WARNING)
1822
console.setLevel(logging.WARNING)
1824
level = getattr(logging, debuglevel.upper())
1825
syslogger.setLevel(level)
1826
console.setLevel(level)
3146
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3148
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:
1829
3155
# Enable all possible GnuTLS debugging
1831
3157
# "Use a log level over 10 to enable all debugging options."
1832
3158
# - GnuTLS manual
1833
gnutls.library.functions.gnutls_global_set_log_level(11)
1835
@gnutls.library.types.gnutls_log_func
3159
gnutls.global_set_log_level(11)
1836
3162
def debug_gnutls(level, string):
1837
3163
logger.debug("GnuTLS: %s", string[:-1])
1839
(gnutls.library.functions
1840
.gnutls_global_set_log_function(debug_gnutls))
3165
gnutls.global_set_log_function(debug_gnutls)
1842
3167
# Redirect stdin so all checkers get /dev/null
1843
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3168
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1844
3169
os.dup2(null, sys.stdin.fileno())
1848
# No console logging
1849
logger.removeHandler(console)
1851
3173
# Need to fork before connecting to D-Bus
1853
3175
# 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.
1856
3183
global main_loop
1857
3184
# From the Avahi example code
1858
DBusGMainLoop(set_as_default=True )
1859
main_loop = gobject.MainLoop()
3185
DBusGMainLoop(set_as_default=True)
3186
main_loop = GLib.MainLoop()
1860
3187
bus = dbus.SystemBus()
1861
3188
# End of Avahi example code
1864
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1865
bus, do_not_queue=True)
1866
except dbus.exceptions.NameExistsException, e:
1867
logger.error(unicode(e) + ", disabling D-Bus")
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)
1868
3199
use_dbus = False
1869
3200
server_settings["use_dbus"] = False
1870
3201
tcp_server.use_dbus = False
1871
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1872
service = AvahiService(name = server_settings["servicename"],
1873
servicetype = "_mandos._tcp",
1874
protocol = protocol, bus = bus)
1875
if server_settings["interface"]:
1876
service.interface = (if_nametoindex
1877
(str(server_settings["interface"])))
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"))
1879
3213
global multiprocessing_manager
1880
3214
multiprocessing_manager = multiprocessing.Manager()
1882
3216
client_class = Client
1884
client_class = functools.partial(ClientDBus, bus = bus)
1885
def client_config_items(config, section):
1886
special_settings = {
1887
"approved_by_default":
1888
lambda: config.getboolean(section,
1889
"approved_by_default"),
1891
for name, value in config.items(section):
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(
1893
yield (name, special_settings[name]())
1897
tcp_server.clients.update(set(
1898
client_class(name = section,
1899
config= dict(client_config_items(
1900
client_config, section)))
1901
for section in client_config.sections()))
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)
1902
3377
if not tcp_server.clients:
1903
3378
logger.warning("No clients defined")
1909
pidfile.write(str(pid) + "\n".encode("utf-8"))
1912
logger.error("Could not write to file %r with PID %d",
1915
# "pidfile" was never created
3381
if pidfile is not None:
3385
print(pid, file=pidfile)
3387
logger.error("Could not write to file %r with PID %d",
1917
3390
del pidfilename
1919
signal.signal(signal.SIGINT, signal.SIG_IGN)
1921
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1922
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3392
for termsig in (signal.SIGHUP, signal.SIGTERM):
3393
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3394
lambda: main_loop.quit() and False)
1925
class MandosDBusService(dbus.service.Object):
3398
@alternate_dbus_interfaces(
3399
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3400
class MandosDBusService(DBusObjectWithObjectManager):
1926
3401
"""A D-Bus proxy object"""
1927
3403
def __init__(self):
1928
3404
dbus.service.Object.__init__(self, bus, "/")
1929
_interface = "se.bsnet.fukt.Mandos"
3406
_interface = "se.recompile.Mandos"
1931
3408
@dbus.service.signal(_interface, signature="o")
1932
3409
def ClientAdded(self, objpath):
1936
3413
@dbus.service.signal(_interface, signature="ss")
1937
def ClientNotFound(self, fingerprint, address):
3414
def ClientNotFound(self, key_id, address):
3418
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1941
3420
@dbus.service.signal(_interface, signature="os")
1942
3421
def ClientRemoved(self, objpath, name):
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1946
3427
@dbus.service.method(_interface, out_signature="ao")
1947
3428
def GetAllClients(self):
1949
return dbus.Array(c.dbus_object_path
1950
for c in tcp_server.clients)
3430
return dbus.Array(c.dbus_object_path for c in
3431
tcp_server.clients.values())
3433
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1952
3435
@dbus.service.method(_interface,
1953
3436
out_signature="a{oa{sv}}")
1954
3437
def GetAllClientsWithProperties(self):
1956
3439
return dbus.Dictionary(
1957
((c.dbus_object_path, c.GetAll(""))
1958
for c in tcp_server.clients),
3440
{c.dbus_object_path: c.GetAll(
3441
"se.recompile.Mandos.Client")
3442
for c in tcp_server.clients.values()},
1959
3443
signature="oa{sv}")
1961
3445
@dbus.service.method(_interface, in_signature="o")
1962
3446
def RemoveClient(self, object_path):
1964
for c in tcp_server.clients:
3448
for c in tcp_server.clients.values():
1965
3449
if c.dbus_object_path == object_path:
1966
tcp_server.clients.remove(c)
3450
del tcp_server.clients[c.name]
1967
3451
c.remove_from_connection()
1968
# Don't signal anything except ClientRemoved
3452
# Don't signal the disabling
1969
3453
c.disable(quiet=True)
1971
self.ClientRemoved(object_path, c.name)
3454
# Emit D-Bus signal for removal
3455
self.client_removed_signal(c)
1973
3457
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,
1977
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
1980
3505
"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
1983
3568
while tcp_server.clients:
1984
client = tcp_server.clients.pop()
3569
name, client = tcp_server.clients.popitem()
1986
3571
client.remove_from_connection()
1987
client.disable_hook = None
1988
# Don't signal anything except ClientRemoved
3572
# Don't signal the disabling
1989
3573
client.disable(quiet=True)
3574
# Emit D-Bus signal for removal
1992
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3576
mandos_dbus_service.client_removed_signal(client)
3577
client_settings.clear()
1995
3579
atexit.register(cleanup)
1997
for client in tcp_server.clients:
3581
for client in tcp_server.clients.values():
2000
mandos_dbus_service.ClientAdded(client.dbus_object_path)
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()
2003
3589
tcp_server.enable()
2004
3590
tcp_server.server_activate()
2006
3592
# Find out what port we got
2007
service.port = tcp_server.socket.getsockname()[1]
3594
service.port = tcp_server.socket.getsockname()[1]
2009
3596
logger.info("Now listening on address %r, port %d,"
2010
" flowinfo %d, scope_id %d"
2011
% tcp_server.socket.getsockname())
3597
" flowinfo %d, scope_id %d",
3598
*tcp_server.socket.getsockname())
2013
logger.info("Now listening on address %r, port %d"
2014
% tcp_server.socket.getsockname())
2016
#service.interface = tcp_server.socket.getsockname()[3]
3600
logger.info("Now listening on address %r, port %d",
3601
*tcp_server.socket.getsockname())
3603
# service.interface = tcp_server.socket.getsockname()[3]
2019
# From the Avahi example code
2022
except dbus.exceptions.DBusException, error:
2023
logger.critical("DBusException: %s", error)
2026
# End of Avahi example code
2028
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2029
lambda *args, **kwargs:
2030
(tcp_server.handle_request
2031
(*args[2:], **kwargs) or True))
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))
2033
3622
logger.debug("Starting main loop")
2034
3623
main_loop.run()
2035
except AvahiError, error:
2036
logger.critical("AvahiError: %s", error)
3624
except AvahiError as error:
3625
logger.critical("Avahi Error", exc_info=error)
2039
3628
except KeyboardInterrupt: