63
import cPickle as pickle
70
import cPickle as pickle
64
73
import multiprocessing
67
82
import dbus.service
84
from gi.repository import GLib
70
85
from dbus.mainloop.glib import DBusGMainLoop
73
88
import xml.dom.minidom
91
if sys.version_info.major == 2:
94
# Try to find the value of SO_BINDTODEVICE:
96
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
97
# newer, and it is also the most natural place for it:
77
98
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
78
99
except AttributeError:
101
# This is where SO_BINDTODEVICE was up to and including Python
80
103
from IN import SO_BINDTODEVICE
81
104
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)
105
# In Python 2.7 it seems to have been removed entirely.
106
# Try running the C preprocessor:
108
cc = subprocess.Popen(["cc", "--language=c", "-E",
110
stdin=subprocess.PIPE,
111
stdout=subprocess.PIPE)
112
stdout = cc.communicate(
113
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
114
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
115
except (OSError, ValueError, IndexError):
117
SO_BINDTODEVICE = None
119
if sys.version_info.major == 2:
122
if sys.version_info < (3, 2):
123
configparser.Configparser = configparser.SafeConfigParser
126
stored_state_file = "clients.pickle"
128
logger = logging.getLogger()
132
if_nametoindex = ctypes.cdll.LoadLibrary(
133
ctypes.util.find_library("c")).if_nametoindex
134
except (OSError, AttributeError):
136
def if_nametoindex(interface):
137
"Get an interface index the hard way, i.e. using fcntl()"
138
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
139
with contextlib.closing(socket.socket()) as s:
140
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
141
struct.pack(b"16s16x", interface))
142
interface_index = struct.unpack("I", ifreq[16:20])[0]
143
return interface_index
146
def copy_function(func):
147
"""Make a copy of a function"""
148
if sys.version_info.major == 2:
149
return types.FunctionType(func.func_code,
155
return types.FunctionType(func.__code__,
162
def initlogger(debug, level=logging.WARNING):
163
"""init logger and add loglevel"""
166
syslogger = (logging.handlers.SysLogHandler(
167
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
169
syslogger.setFormatter(logging.Formatter
170
('Mandos [%(process)d]: %(levelname)s:'
172
logger.addHandler(syslogger)
175
console = logging.StreamHandler()
176
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
180
logger.addHandler(console)
181
logger.setLevel(level)
184
class PGPError(Exception):
185
"""Exception if encryption/decryption fails"""
190
"""A simple class for OpenPGP symmetric encryption & decryption"""
193
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
196
output = subprocess.check_output(["gpgconf"])
197
for line in output.splitlines():
198
name, text, path = line.split(b":")
203
if e.errno != errno.ENOENT:
205
self.gnupgargs = ['--batch',
206
'--homedir', self.tempdir,
209
# Only GPG version 1 has the --no-use-agent option.
210
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
211
self.gnupgargs.append("--no-use-agent")
216
def __exit__(self, exc_type, exc_value, traceback):
224
if self.tempdir is not None:
225
# Delete contents of tempdir
226
for root, dirs, files in os.walk(self.tempdir,
228
for filename in files:
229
os.remove(os.path.join(root, filename))
231
os.rmdir(os.path.join(root, dirname))
233
os.rmdir(self.tempdir)
236
def password_encode(self, password):
237
# Passphrase can not be empty and can not contain newlines or
238
# NUL bytes. So we prefix it and hex encode it.
239
encoded = b"mandos" + binascii.hexlify(password)
240
if len(encoded) > 2048:
241
# GnuPG can't handle long passwords, so encode differently
242
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
243
.replace(b"\n", b"\\n")
244
.replace(b"\0", b"\\x00"))
247
def encrypt(self, data, password):
248
passphrase = self.password_encode(password)
249
with tempfile.NamedTemporaryFile(
250
dir=self.tempdir) as passfile:
251
passfile.write(passphrase)
253
proc = subprocess.Popen([self.gpg, '--symmetric',
257
stdin=subprocess.PIPE,
258
stdout=subprocess.PIPE,
259
stderr=subprocess.PIPE)
260
ciphertext, err = proc.communicate(input=data)
261
if proc.returncode != 0:
265
def decrypt(self, data, password):
266
passphrase = self.password_encode(password)
267
with tempfile.NamedTemporaryFile(
268
dir=self.tempdir) as passfile:
269
passfile.write(passphrase)
271
proc = subprocess.Popen([self.gpg, '--decrypt',
275
stdin=subprocess.PIPE,
276
stdout=subprocess.PIPE,
277
stderr=subprocess.PIPE)
278
decrypted_plaintext, err = proc.communicate(input=data)
279
if proc.returncode != 0:
281
return decrypted_plaintext
284
# Pretend that we have an Avahi module
286
"""This isn't so much a class as it is a module-like namespace."""
287
IF_UNSPEC = -1 # avahi-common/address.h
288
PROTO_UNSPEC = -1 # avahi-common/address.h
289
PROTO_INET = 0 # avahi-common/address.h
290
PROTO_INET6 = 1 # avahi-common/address.h
291
DBUS_NAME = "org.freedesktop.Avahi"
292
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
293
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
294
DBUS_PATH_SERVER = "/"
297
def string_array_to_txt_array(t):
298
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
299
for s in t), signature="ay")
300
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
301
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
302
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
303
SERVER_INVALID = 0 # avahi-common/defs.h
304
SERVER_REGISTERING = 1 # avahi-common/defs.h
305
SERVER_RUNNING = 2 # avahi-common/defs.h
306
SERVER_COLLISION = 3 # avahi-common/defs.h
307
SERVER_FAILURE = 4 # avahi-common/defs.h
103
310
class AvahiError(Exception):
104
311
def __init__(self, value, *args, **kwargs):
105
312
self.value = value
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
313
return super(AvahiError, self).__init__(value, *args,
110
317
class AvahiServiceError(AvahiError):
113
321
class AvahiGroupError(AvahiError):
117
class AvahiService(object):
118
326
"""An Avahi (Zeroconf) service.
121
329
interface: integer; avahi.IF_UNSPEC or an interface index.
122
330
Used to optionally bind to the specified interface.
123
331
name: string; Example: 'Mandos'
124
332
type: string; Example: '_mandos._tcp'.
125
See <http://www.dns-sd.org/ServiceTypes.html>
333
See <https://www.iana.org/assignments/service-names-port-numbers>
126
334
port: integer; what port to announce
127
335
TXT: list of strings; TXT record for the service
128
336
domain: string; Domain to publish on, default to .local if empty.
210
438
elif state == avahi.ENTRY_GROUP_FAILURE:
211
439
logger.critical("Avahi: Error in group state changed %s",
213
raise AvahiGroupError("State changed: %s"
441
raise AvahiGroupError("State changed: {!s}".format(error))
215
443
def cleanup(self):
216
444
"""Derived from the Avahi example code"""
217
445
if self.group is not None:
448
except (dbus.exceptions.UnknownMethodException,
449
dbus.exceptions.DBusException):
219
451
self.group = None
220
def server_state_changed(self, state):
454
def server_state_changed(self, state, error=None):
221
455
"""Derived from the Avahi example code"""
222
456
logger.debug("Avahi server state change: %i", state)
223
if state == avahi.SERVER_COLLISION:
224
logger.error("Zeroconf server name collision")
458
avahi.SERVER_INVALID: "Zeroconf server invalid",
459
avahi.SERVER_REGISTERING: None,
460
avahi.SERVER_COLLISION: "Zeroconf server name collision",
461
avahi.SERVER_FAILURE: "Zeroconf server failure",
463
if state in bad_states:
464
if bad_states[state] is not None:
466
logger.error(bad_states[state])
468
logger.error(bad_states[state] + ": %r", error)
226
470
elif state == avahi.SERVER_RUNNING:
473
except dbus.exceptions.DBusException as error:
474
if (error.get_dbus_name()
475
== "org.freedesktop.Avahi.CollisionError"):
476
logger.info("Local Zeroconf service name"
478
return self.rename(remove=False)
480
logger.critical("D-Bus Exception", exc_info=error)
485
logger.debug("Unknown state: %r", state)
487
logger.debug("Unknown state: %r: %r", state, error)
228
489
def activate(self):
229
490
"""Derived from the Avahi example code"""
230
491
if self.server is None:
231
492
self.server = dbus.Interface(
232
493
self.bus.get_object(avahi.DBUS_NAME,
233
avahi.DBUS_PATH_SERVER),
494
avahi.DBUS_PATH_SERVER,
495
follow_name_owner_changes=True),
234
496
avahi.DBUS_INTERFACE_SERVER)
235
497
self.server.connect_to_signal("StateChanged",
236
self.server_state_changed)
498
self.server_state_changed)
237
499
self.server_state_changed(self.server.GetState())
240
class Client(object):
502
class AvahiServiceToSyslog(AvahiService):
503
def rename(self, *args, **kwargs):
504
"""Add the new name to the syslog messages"""
505
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
506
syslogger.setFormatter(logging.Formatter(
507
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
512
# Pretend that we have a GnuTLS module
514
"""This isn't so much a class as it is a module-like namespace."""
516
library = ctypes.util.find_library("gnutls")
518
library = ctypes.util.find_library("gnutls-deb0")
519
_library = ctypes.cdll.LoadLibrary(library)
522
# Unless otherwise indicated, the constants and types below are
523
# all from the gnutls/gnutls.h C header file.
534
E_NO_CERTIFICATE_FOUND = -49
539
KEYID_USE_SHA256 = 1 # gnutls/x509.h
540
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
543
class session_int(ctypes.Structure):
545
session_t = ctypes.POINTER(session_int)
547
class certificate_credentials_st(ctypes.Structure):
549
certificate_credentials_t = ctypes.POINTER(
550
certificate_credentials_st)
551
certificate_type_t = ctypes.c_int
553
class datum_t(ctypes.Structure):
554
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
555
('size', ctypes.c_uint)]
557
class openpgp_crt_int(ctypes.Structure):
559
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
560
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
561
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
562
credentials_type_t = ctypes.c_int
563
transport_ptr_t = ctypes.c_void_p
564
close_request_t = ctypes.c_int
567
class Error(Exception):
568
def __init__(self, message=None, code=None, args=()):
569
# Default usage is by a message string, but if a return
570
# code is passed, convert it to a string with
573
if message is None and code is not None:
574
message = gnutls.strerror(code)
575
return super(gnutls.Error, self).__init__(
578
class CertificateSecurityError(Error):
584
self._c_object = gnutls.certificate_credentials_t()
585
gnutls.certificate_allocate_credentials(
586
ctypes.byref(self._c_object))
587
self.type = gnutls.CRD_CERTIFICATE
590
gnutls.certificate_free_credentials(self._c_object)
593
def __init__(self, socket, credentials=None):
594
self._c_object = gnutls.session_t()
595
gnutls_flags = gnutls.CLIENT
596
if gnutls.check_version(b"3.5.6"):
597
gnutls_flags |= gnutls.NO_TICKETS
599
gnutls_flags |= gnutls.ENABLE_RAWPK
600
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
602
gnutls.set_default_priority(self._c_object)
603
gnutls.transport_set_ptr(self._c_object, socket.fileno())
604
gnutls.handshake_set_private_extensions(self._c_object,
607
if credentials is None:
608
credentials = gnutls.Credentials()
609
gnutls.credentials_set(self._c_object, credentials.type,
610
ctypes.cast(credentials._c_object,
612
self.credentials = credentials
615
gnutls.deinit(self._c_object)
618
return gnutls.handshake(self._c_object)
620
def send(self, data):
624
data_len -= gnutls.record_send(self._c_object,
629
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
631
# Error handling functions
632
def _error_code(result):
633
"""A function to raise exceptions on errors, suitable
634
for the 'restype' attribute on ctypes functions"""
637
if result == gnutls.E_NO_CERTIFICATE_FOUND:
638
raise gnutls.CertificateSecurityError(code=result)
639
raise gnutls.Error(code=result)
641
def _retry_on_error(result, func, arguments):
642
"""A function to retry on some errors, suitable
643
for the 'errcheck' attribute on ctypes functions"""
645
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
646
return _error_code(result)
647
result = func(*arguments)
650
# Unless otherwise indicated, the function declarations below are
651
# all from the gnutls/gnutls.h C header file.
654
priority_set_direct = _library.gnutls_priority_set_direct
655
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
656
ctypes.POINTER(ctypes.c_char_p)]
657
priority_set_direct.restype = _error_code
659
init = _library.gnutls_init
660
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
661
init.restype = _error_code
663
set_default_priority = _library.gnutls_set_default_priority
664
set_default_priority.argtypes = [session_t]
665
set_default_priority.restype = _error_code
667
record_send = _library.gnutls_record_send
668
record_send.argtypes = [session_t, ctypes.c_void_p,
670
record_send.restype = ctypes.c_ssize_t
671
record_send.errcheck = _retry_on_error
673
certificate_allocate_credentials = (
674
_library.gnutls_certificate_allocate_credentials)
675
certificate_allocate_credentials.argtypes = [
676
ctypes.POINTER(certificate_credentials_t)]
677
certificate_allocate_credentials.restype = _error_code
679
certificate_free_credentials = (
680
_library.gnutls_certificate_free_credentials)
681
certificate_free_credentials.argtypes = [
682
certificate_credentials_t]
683
certificate_free_credentials.restype = None
685
handshake_set_private_extensions = (
686
_library.gnutls_handshake_set_private_extensions)
687
handshake_set_private_extensions.argtypes = [session_t,
689
handshake_set_private_extensions.restype = None
691
credentials_set = _library.gnutls_credentials_set
692
credentials_set.argtypes = [session_t, credentials_type_t,
694
credentials_set.restype = _error_code
696
strerror = _library.gnutls_strerror
697
strerror.argtypes = [ctypes.c_int]
698
strerror.restype = ctypes.c_char_p
700
certificate_type_get = _library.gnutls_certificate_type_get
701
certificate_type_get.argtypes = [session_t]
702
certificate_type_get.restype = _error_code
704
certificate_get_peers = _library.gnutls_certificate_get_peers
705
certificate_get_peers.argtypes = [session_t,
706
ctypes.POINTER(ctypes.c_uint)]
707
certificate_get_peers.restype = ctypes.POINTER(datum_t)
709
global_set_log_level = _library.gnutls_global_set_log_level
710
global_set_log_level.argtypes = [ctypes.c_int]
711
global_set_log_level.restype = None
713
global_set_log_function = _library.gnutls_global_set_log_function
714
global_set_log_function.argtypes = [log_func]
715
global_set_log_function.restype = None
717
deinit = _library.gnutls_deinit
718
deinit.argtypes = [session_t]
719
deinit.restype = None
721
handshake = _library.gnutls_handshake
722
handshake.argtypes = [session_t]
723
handshake.restype = _error_code
724
handshake.errcheck = _retry_on_error
726
transport_set_ptr = _library.gnutls_transport_set_ptr
727
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
728
transport_set_ptr.restype = None
730
bye = _library.gnutls_bye
731
bye.argtypes = [session_t, close_request_t]
732
bye.restype = _error_code
733
bye.errcheck = _retry_on_error
735
check_version = _library.gnutls_check_version
736
check_version.argtypes = [ctypes.c_char_p]
737
check_version.restype = ctypes.c_char_p
739
_need_version = b"3.3.0"
740
if check_version(_need_version) is None:
741
raise self.Error("Needs GnuTLS {} or later"
742
.format(_need_version))
744
_tls_rawpk_version = b"3.6.6"
745
has_rawpk = bool(check_version(_tls_rawpk_version))
749
class pubkey_st(ctypes.Structure):
751
pubkey_t = ctypes.POINTER(pubkey_st)
753
x509_crt_fmt_t = ctypes.c_int
755
# All the function declarations below are from gnutls/abstract.h
756
pubkey_init = _library.gnutls_pubkey_init
757
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
758
pubkey_init.restype = _error_code
760
pubkey_import = _library.gnutls_pubkey_import
761
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
763
pubkey_import.restype = _error_code
765
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
766
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
767
ctypes.POINTER(ctypes.c_ubyte),
768
ctypes.POINTER(ctypes.c_size_t)]
769
pubkey_get_key_id.restype = _error_code
771
pubkey_deinit = _library.gnutls_pubkey_deinit
772
pubkey_deinit.argtypes = [pubkey_t]
773
pubkey_deinit.restype = None
775
# All the function declarations below are from gnutls/openpgp.h
777
openpgp_crt_init = _library.gnutls_openpgp_crt_init
778
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
779
openpgp_crt_init.restype = _error_code
781
openpgp_crt_import = _library.gnutls_openpgp_crt_import
782
openpgp_crt_import.argtypes = [openpgp_crt_t,
783
ctypes.POINTER(datum_t),
785
openpgp_crt_import.restype = _error_code
787
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
788
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
789
ctypes.POINTER(ctypes.c_uint)]
790
openpgp_crt_verify_self.restype = _error_code
792
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
793
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
794
openpgp_crt_deinit.restype = None
796
openpgp_crt_get_fingerprint = (
797
_library.gnutls_openpgp_crt_get_fingerprint)
798
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
802
openpgp_crt_get_fingerprint.restype = _error_code
804
if check_version(b"3.6.4"):
805
certificate_type_get2 = _library.gnutls_certificate_type_get2
806
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
807
certificate_type_get2.restype = _error_code
809
# Remove non-public functions
810
del _error_code, _retry_on_error
813
def call_pipe(connection, # : multiprocessing.Connection
814
func, *args, **kwargs):
815
"""This function is meant to be called by multiprocessing.Process
817
This function runs func(*args, **kwargs), and writes the resulting
818
return value on the provided multiprocessing.Connection.
820
connection.send(func(*args, **kwargs))
241
825
"""A representation of a client host served by this server.
244
_approved: bool(); 'None' if not yet approved/disapproved
828
approved: bool(); 'None' if not yet approved/disapproved
245
829
approval_delay: datetime.timedelta(); Time to wait for approval
246
830
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
831
checker: multiprocessing.Process(); a running checker process used
832
to see if the client lives. 'None' if no process is
834
checker_callback_tag: a GLib event source tag, or None
251
835
checker_command: string; External command which is run to check
252
836
if client lives. %() expansions are done at
253
837
runtime with vars(self) as dict, so that for
254
838
instance %(name)s can be used in the command.
255
checker_initiator_tag: a gobject event source tag, or None
839
checker_initiator_tag: a GLib event source tag, or None
256
840
created: datetime.datetime(); (UTC) object creation
841
client_structure: Object describing what attributes a client has
842
and is used for storing the client at exit
257
843
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
844
disable_initiator_tag: a GLib event source tag, or None
261
846
fingerprint: string (40 or 32 hexadecimal digits); used to
262
uniquely identify the client
847
uniquely identify an OpenPGP client
848
key_id: string (64 hexadecimal digits); used to uniquely identify
849
a client using raw public keys
263
850
host: string; available for use by the checker command
264
851
interval: datetime.timedelta(); How often to start a new checker
265
852
last_approval_request: datetime.datetime(); (UTC) or None
266
853
last_checked_ok: datetime.datetime(); (UTC) or None
267
last_enabled: datetime.datetime(); (UTC)
854
last_checker_status: integer between 0 and 255 reflecting exit
855
status of last checker. -1 reflects crashed
856
checker, -2 means no checker completed yet.
857
last_checker_signal: The signal which killed the last checker, if
858
last_checker_status is -1
859
last_enabled: datetime.datetime(); (UTC) or None
268
860
name: string; from the config file, used in log messages and
269
861
D-Bus identifiers
270
862
secret: bytestring; sent verbatim (over TLS) to client
271
863
timeout: datetime.timedelta(); How long from last_checked_ok
272
864
until this client is disabled
865
extended_timeout: extra long timeout when secret has been sent
273
866
runtime_expansions: Allowed attributes for runtime expansion.
867
expires: datetime.datetime(); time (UTC) when a client will be
869
server_settings: The server_settings dict from main()
276
872
runtime_expansions = ("approval_delay", "approval_duration",
277
"created", "enabled", "fingerprint",
278
"host", "interval", "last_checked_ok",
873
"created", "enabled", "expires", "key_id",
874
"fingerprint", "host", "interval",
875
"last_approval_request", "last_checked_ok",
279
876
"last_enabled", "name", "timeout")
879
"extended_timeout": "PT15M",
881
"checker": "fping -q -- %%(host)s",
883
"approval_delay": "PT0S",
884
"approval_duration": "PT1S",
885
"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'
890
def config_parser(config):
891
"""Construct a new dict of client settings of this form:
892
{ client_name: {setting_name: value, ...}, ...}
893
with exceptions for any special settings as defined above.
894
NOTE: Must be a pure function. Must return the same result
895
value given the same arguments.
898
for client_name in config.sections():
899
section = dict(config.items(client_name))
900
client = settings[client_name] = {}
902
client["host"] = section["host"]
903
# Reformat values from string types to Python types
904
client["approved_by_default"] = config.getboolean(
905
client_name, "approved_by_default")
906
client["enabled"] = config.getboolean(client_name,
909
# Uppercase and remove spaces from key_id and fingerprint
910
# for later comparison purposes with return value from the
911
# key_id() and fingerprint() functions
912
client["key_id"] = (section.get("key_id", "").upper()
914
client["fingerprint"] = (section["fingerprint"].upper()
916
if "secret" in section:
917
client["secret"] = codecs.decode(section["secret"]
920
elif "secfile" in section:
921
with open(os.path.expanduser(os.path.expandvars
922
(section["secfile"])),
924
client["secret"] = secfile.read()
926
raise TypeError("No secret or secfile for section {}"
928
client["timeout"] = string_to_delta(section["timeout"])
929
client["extended_timeout"] = string_to_delta(
930
section["extended_timeout"])
931
client["interval"] = string_to_delta(section["interval"])
932
client["approval_delay"] = string_to_delta(
933
section["approval_delay"])
934
client["approval_duration"] = string_to_delta(
935
section["approval_duration"])
936
client["checker_command"] = section["checker"]
937
client["last_approval_request"] = None
938
client["last_checked_ok"] = None
939
client["last_checker_status"] = -2
943
def __init__(self, settings, name=None, server_settings=None):
945
if server_settings is None:
947
self.server_settings = server_settings
948
# adding all client settings
949
for setting, value in settings.items():
950
setattr(self, setting, value)
953
if not hasattr(self, "last_enabled"):
954
self.last_enabled = datetime.datetime.utcnow()
955
if not hasattr(self, "expires"):
956
self.expires = (datetime.datetime.utcnow()
959
self.last_enabled = None
306
962
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()
963
logger.debug(" Key ID: %s", self.key_id)
312
964
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
965
self.created = settings.get("created",
966
datetime.datetime.utcnow())
968
# attributes specific for this server instance
332
969
self.checker = None
333
970
self.checker_initiator_tag = None
334
971
self.disable_initiator_tag = None
335
972
self.checker_callback_tag = None
336
self.checker_command = config["checker"]
337
973
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
975
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())
976
self.changedstate = multiprocessing_manager.Condition(
977
multiprocessing_manager.Lock())
978
self.client_structure = [attr
979
for attr in self.__dict__.keys()
980
if not attr.startswith("_")]
981
self.client_structure.append("client_structure")
983
for name, t in inspect.getmembers(
984
type(self), lambda obj: isinstance(obj, property)):
985
if not name.startswith("_"):
986
self.client_structure.append(name)
988
# Send notice to process children that client state has changed
349
989
def send_changedstate(self):
350
self.changedstate.acquire()
351
self.changedstate.notify_all()
352
self.changedstate.release()
990
with self.changedstate:
991
self.changedstate.notify_all()
354
993
def enable(self):
355
994
"""Start this client's checker and timeout hooks"""
356
995
if getattr(self, "enabled", False):
357
996
# Already enabled
359
self.send_changedstate()
998
self.expires = datetime.datetime.utcnow() + self.timeout
360
1000
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*.
1002
self.send_changedstate()
374
1004
def disable(self, quiet=True):
375
1005
"""Disable this client."""
376
1006
if not getattr(self, "enabled", False):
379
self.send_changedstate()
381
1009
logger.info("Disabling client %s", self.name)
382
if getattr(self, "disable_initiator_tag", False):
383
gobject.source_remove(self.disable_initiator_tag)
1010
if getattr(self, "disable_initiator_tag", None) is not None:
1011
GLib.source_remove(self.disable_initiator_tag)
384
1012
self.disable_initiator_tag = None
385
if getattr(self, "checker_initiator_tag", False):
386
gobject.source_remove(self.checker_initiator_tag)
1014
if getattr(self, "checker_initiator_tag", None) is not None:
1015
GLib.source_remove(self.checker_initiator_tag)
387
1016
self.checker_initiator_tag = None
388
1017
self.stop_checker()
389
if self.disable_hook:
390
self.disable_hook(self)
391
1018
self.enabled = False
392
# Do not run this again if called by a gobject.timeout_add
1020
self.send_changedstate()
1021
# Do not run this again if called by a GLib.timeout_add
395
1024
def __del__(self):
396
self.disable_hook = None
399
def checker_callback(self, pid, condition, command):
1027
def init_checker(self):
1028
# Schedule a new checker to be started an 'interval' from now,
1029
# and every interval from then on.
1030
if self.checker_initiator_tag is not None:
1031
GLib.source_remove(self.checker_initiator_tag)
1032
self.checker_initiator_tag = GLib.timeout_add(
1033
int(self.interval.total_seconds() * 1000),
1035
# Schedule a disable() when 'timeout' has passed
1036
if self.disable_initiator_tag is not None:
1037
GLib.source_remove(self.disable_initiator_tag)
1038
self.disable_initiator_tag = GLib.timeout_add(
1039
int(self.timeout.total_seconds() * 1000), self.disable)
1040
# Also start a new checker *right now*.
1041
self.start_checker()
1043
def checker_callback(self, source, condition, connection,
400
1045
"""The checker has completed, so take appropriate actions."""
1046
# Read return code from connection (see call_pipe)
1047
returncode = connection.recv()
401
1050
self.checker_callback_tag = None
402
1051
self.checker = None
403
if os.WIFEXITED(condition):
404
exitstatus = os.WEXITSTATUS(condition)
1054
self.last_checker_status = returncode
1055
self.last_checker_signal = None
1056
if self.last_checker_status == 0:
406
1057
logger.info("Checker for %(name)s succeeded",
408
1059
self.checked_ok()
410
logger.info("Checker for %(name)s failed",
1061
logger.info("Checker for %(name)s failed", vars(self))
1063
self.last_checker_status = -1
1064
self.last_checker_signal = -returncode
413
1065
logger.warning("Checker for %(name)s crashed?",
416
1069
def checked_ok(self):
417
"""Bump up the timeout for this client.
419
This should only be called when the client has been seen,
1070
"""Assert that the client has been seen, alive and well."""
422
1071
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(),
1072
self.last_checker_status = 0
1073
self.last_checker_signal = None
1076
def bump_timeout(self, timeout=None):
1077
"""Bump up the timeout for this client."""
1079
timeout = self.timeout
1080
if self.disable_initiator_tag is not None:
1081
GLib.source_remove(self.disable_initiator_tag)
1082
self.disable_initiator_tag = None
1083
if getattr(self, "enabled", False):
1084
self.disable_initiator_tag = GLib.timeout_add(
1085
int(timeout.total_seconds() * 1000), self.disable)
1086
self.expires = datetime.datetime.utcnow() + timeout
428
1088
def need_approval(self):
429
1089
self.last_approval_request = datetime.datetime.utcnow()
431
1091
def start_checker(self):
432
1092
"""Start a new checker subprocess if one is not running.
434
1094
If a checker already exists, leave it running and do
436
1096
# 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
1097
# did that, and if a checker (for some reason) started running
1098
# slowly and taking more than 'interval' time, then the client
1099
# would inevitably timeout, since no checker would get a
1100
# chance to run to completion. If we instead leave running
441
1101
# checkers alone, the checker would have to take more time
442
1102
# 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)
1105
if self.checker is not None and not self.checker.is_alive():
1106
logger.warning("Checker was not alive; joining")
458
1109
# Start a new checker if needed
459
1110
if self.checker is None:
1111
# Escape attributes for the shell
1113
attr: re.escape(str(getattr(self, attr)))
1114
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
1116
command = self.checker_command % escaped_attrs
1117
except TypeError as error:
1118
logger.error('Could not format string "%s"',
1119
self.checker_command,
1121
return True # Try again later
479
1122
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
1123
logger.info("Starting checker %r for %s", command,
1125
# We don't need to redirect stdout and stderr, since
1126
# in normal mode, that is already done by daemon(),
1127
# and in debug mode we don't want to. (Stdin is
1128
# always replaced by /dev/null.)
1129
# The exception is when not debugging but nevertheless
1130
# running in the foreground; use the previously
1132
popen_args = {"close_fds": True,
1135
if (not self.server_settings["debug"]
1136
and self.server_settings["foreground"]):
1137
popen_args.update({"stdout": wnull,
1139
pipe = multiprocessing.Pipe(duplex=False)
1140
self.checker = multiprocessing.Process(
1142
args=(pipe[1], subprocess.call, command),
1144
self.checker.start()
1145
self.checker_callback_tag = GLib.io_add_watch(
1146
pipe[0].fileno(), GLib.IO_IN,
1147
self.checker_callback, pipe[0], command)
1148
# Re-run this periodically if run by GLib.timeout_add
506
1151
def stop_checker(self):
507
1152
"""Force the checker process, if any, to stop."""
508
1153
if self.checker_callback_tag:
509
gobject.source_remove(self.checker_callback_tag)
1154
GLib.source_remove(self.checker_callback_tag)
510
1155
self.checker_callback_tag = None
511
1156
if getattr(self, "checker", None) is None:
513
1158
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
1159
self.checker.terminate()
522
1160
self.checker = None
524
def dbus_service_property(dbus_interface, signature="v",
525
access="readwrite", byte_arrays=False):
1163
def dbus_service_property(dbus_interface,
526
1167
"""Decorators for marking methods of a DBusObjectWithProperties to
527
1168
become properties on the D-Bus.
529
1170
The decorated method will be called with no arguments by "Get"
530
1171
and with one argument by "Set".
532
1173
The parameters, where they are supported, are the same as
533
1174
dbus.service.method, except there is only "signature", since the
534
1175
type from Get() and the type sent to Set() is the same.
704
1506
xmlstring = document.toxml("utf-8")
705
1507
document.unlink()
706
1508
except (AttributeError, xml.dom.DOMException,
707
xml.parsers.expat.ExpatError), error:
708
logger.error("Failed to override Introspection method",
1509
xml.parsers.expat.ExpatError) as error:
1510
logger.error("Failed to override Introspection method",
1516
dbus.OBJECT_MANAGER_IFACE
1517
except AttributeError:
1518
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1521
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1522
"""A D-Bus object with an ObjectManager.
1524
Classes inheriting from this exposes the standard
1525
GetManagedObjects call and the InterfacesAdded and
1526
InterfacesRemoved signals on the standard
1527
"org.freedesktop.DBus.ObjectManager" interface.
1529
Note: No signals are sent automatically; they must be sent
1532
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1533
out_signature="a{oa{sa{sv}}}")
1534
def GetManagedObjects(self):
1535
"""This function must be overridden"""
1536
raise NotImplementedError()
1538
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1539
signature="oa{sa{sv}}")
1540
def InterfacesAdded(self, object_path, interfaces_and_properties):
1543
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1544
def InterfacesRemoved(self, object_path, interfaces):
1547
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1549
path_keyword='object_path',
1550
connection_keyword='connection')
1551
def Introspect(self, object_path, connection):
1552
"""Overloading of standard D-Bus method.
1554
Override return argument name of GetManagedObjects to be
1555
"objpath_interfaces_and_properties"
1557
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1561
document = xml.dom.minidom.parseString(xmlstring)
1563
for if_tag in document.getElementsByTagName("interface"):
1564
# Fix argument name for the GetManagedObjects method
1565
if (if_tag.getAttribute("name")
1566
== dbus.OBJECT_MANAGER_IFACE):
1567
for cn in if_tag.getElementsByTagName("method"):
1568
if (cn.getAttribute("name")
1569
== "GetManagedObjects"):
1570
for arg in cn.getElementsByTagName("arg"):
1571
if (arg.getAttribute("direction")
1575
"objpath_interfaces"
1577
xmlstring = document.toxml("utf-8")
1579
except (AttributeError, xml.dom.DOMException,
1580
xml.parsers.expat.ExpatError) as error:
1581
logger.error("Failed to override Introspection method",
1586
def datetime_to_dbus(dt, variant_level=0):
1587
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1589
return dbus.String("", variant_level=variant_level)
1590
return dbus.String(dt.isoformat(), variant_level=variant_level)
1593
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1594
"""A class decorator; applied to a subclass of
1595
dbus.service.Object, it will add alternate D-Bus attributes with
1596
interface names according to the "alt_interface_names" mapping.
1599
@alternate_dbus_interfaces({"org.example.Interface":
1600
"net.example.AlternateInterface"})
1601
class SampleDBusObject(dbus.service.Object):
1602
@dbus.service.method("org.example.Interface")
1603
def SampleDBusMethod():
1606
The above "SampleDBusMethod" on "SampleDBusObject" will be
1607
reachable via two interfaces: "org.example.Interface" and
1608
"net.example.AlternateInterface", the latter of which will have
1609
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1610
"true", unless "deprecate" is passed with a False value.
1612
This works for methods and signals, and also for D-Bus properties
1613
(from DBusObjectWithProperties) and interfaces (from the
1614
dbus_interface_annotations decorator).
1618
for orig_interface_name, alt_interface_name in (
1619
alt_interface_names.items()):
1621
interface_names = set()
1622
# Go though all attributes of the class
1623
for attrname, attribute in inspect.getmembers(cls):
1624
# Ignore non-D-Bus attributes, and D-Bus attributes
1625
# with the wrong interface name
1626
if (not hasattr(attribute, "_dbus_interface")
1627
or not attribute._dbus_interface.startswith(
1628
orig_interface_name)):
1630
# Create an alternate D-Bus interface name based on
1632
alt_interface = attribute._dbus_interface.replace(
1633
orig_interface_name, alt_interface_name)
1634
interface_names.add(alt_interface)
1635
# Is this a D-Bus signal?
1636
if getattr(attribute, "_dbus_is_signal", False):
1637
# Extract the original non-method undecorated
1638
# function by black magic
1639
if sys.version_info.major == 2:
1640
nonmethod_func = (dict(
1641
zip(attribute.func_code.co_freevars,
1642
attribute.__closure__))
1643
["func"].cell_contents)
1645
nonmethod_func = (dict(
1646
zip(attribute.__code__.co_freevars,
1647
attribute.__closure__))
1648
["func"].cell_contents)
1649
# Create a new, but exactly alike, function
1650
# object, and decorate it to be a new D-Bus signal
1651
# with the alternate D-Bus interface name
1652
new_function = copy_function(nonmethod_func)
1653
new_function = (dbus.service.signal(
1655
attribute._dbus_signature)(new_function))
1656
# Copy annotations, if any
1658
new_function._dbus_annotations = dict(
1659
attribute._dbus_annotations)
1660
except AttributeError:
1663
# Define a creator of a function to call both the
1664
# original and alternate functions, so both the
1665
# original and alternate signals gets sent when
1666
# the function is called
1667
def fixscope(func1, func2):
1668
"""This function is a scope container to pass
1669
func1 and func2 to the "call_both" function
1670
outside of its arguments"""
1672
@functools.wraps(func2)
1673
def call_both(*args, **kwargs):
1674
"""This function will emit two D-Bus
1675
signals by calling func1 and func2"""
1676
func1(*args, **kwargs)
1677
func2(*args, **kwargs)
1678
# Make wrapper function look like a D-Bus
1680
for name, attr in inspect.getmembers(func2):
1681
if name.startswith("_dbus_"):
1682
setattr(call_both, name, attr)
1685
# Create the "call_both" function and add it to
1687
attr[attrname] = fixscope(attribute, new_function)
1688
# Is this a D-Bus method?
1689
elif getattr(attribute, "_dbus_is_method", False):
1690
# Create a new, but exactly alike, function
1691
# object. Decorate it to be a new D-Bus method
1692
# with the alternate D-Bus interface name. Add it
1695
dbus.service.method(
1697
attribute._dbus_in_signature,
1698
attribute._dbus_out_signature)
1699
(copy_function(attribute)))
1700
# Copy annotations, if any
1702
attr[attrname]._dbus_annotations = dict(
1703
attribute._dbus_annotations)
1704
except AttributeError:
1706
# Is this a D-Bus property?
1707
elif getattr(attribute, "_dbus_is_property", False):
1708
# Create a new, but exactly alike, function
1709
# object, and decorate it to be a new D-Bus
1710
# property with the alternate D-Bus interface
1711
# name. Add it to the class.
1712
attr[attrname] = (dbus_service_property(
1713
alt_interface, attribute._dbus_signature,
1714
attribute._dbus_access,
1715
attribute._dbus_get_args_options
1717
(copy_function(attribute)))
1718
# Copy annotations, if any
1720
attr[attrname]._dbus_annotations = dict(
1721
attribute._dbus_annotations)
1722
except AttributeError:
1724
# Is this a D-Bus interface?
1725
elif getattr(attribute, "_dbus_is_interface", False):
1726
# Create a new, but exactly alike, function
1727
# object. Decorate it to be a new D-Bus interface
1728
# with the alternate D-Bus interface name. Add it
1731
dbus_interface_annotations(alt_interface)
1732
(copy_function(attribute)))
1734
# Deprecate all alternate interfaces
1735
iname = "_AlternateDBusNames_interface_annotation{}"
1736
for interface_name in interface_names:
1738
@dbus_interface_annotations(interface_name)
1740
return {"org.freedesktop.DBus.Deprecated":
1742
# Find an unused name
1743
for aname in (iname.format(i)
1744
for i in itertools.count()):
1745
if aname not in attr:
1749
# Replace the class with a new subclass of it with
1750
# methods, signals, etc. as created above.
1751
if sys.version_info.major == 2:
1752
cls = type(b"{}Alternate".format(cls.__name__),
1755
cls = type("{}Alternate".format(cls.__name__),
1762
@alternate_dbus_interfaces({"se.recompile.Mandos":
1763
"se.bsnet.fukt.Mandos"})
713
1764
class ClientDBus(Client, DBusObjectWithProperties):
714
1765
"""A Client class using D-Bus
717
1768
dbus_object_path: dbus.ObjectPath
718
1769
bus: dbus.SystemBus()
721
1772
runtime_expansions = (Client.runtime_expansions
722
+ ("dbus_object_path",))
1773
+ ("dbus_object_path", ))
1775
_interface = "se.recompile.Mandos.Client"
724
1777
# 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
1779
def __init__(self, bus=None, *args, **kwargs):
729
1781
Client.__init__(self, *args, **kwargs)
730
1782
# Only now, when this client is initialized, can it show up on
732
client_object_name = unicode(self.name).translate(
1784
client_object_name = str(self.name).translate(
733
1785
{ord("."): ord("_"),
734
1786
ord("-"): ord("_")})
735
self.dbus_object_path = (dbus.ObjectPath
736
("/clients/" + client_object_name))
1787
self.dbus_object_path = dbus.ObjectPath(
1788
"/clients/" + client_object_name)
737
1789
DBusObjectWithProperties.__init__(self, self.bus,
738
1790
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))
1792
def notifychangeproperty(transform_func, dbus_name,
1793
type_func=lambda x: x,
1795
invalidate_only=False,
1796
_interface=_interface):
1797
""" Modify a variable so that it's a property which announces
1798
its changes to DBus.
1800
transform_fun: Function that takes a value and a variant_level
1801
and transforms it to a D-Bus type.
1802
dbus_name: D-Bus name of the variable
1803
type_func: Function that transform the value before sending it
1804
to the D-Bus. Default: no transform
1805
variant_level: D-Bus variant level. Default: 1
1807
attrname = "_{}".format(dbus_name)
1809
def setter(self, value):
1810
if hasattr(self, "dbus_object_path"):
1811
if (not hasattr(self, attrname) or
1812
type_func(getattr(self, attrname, None))
1813
!= type_func(value)):
1815
self.PropertiesChanged(
1816
_interface, dbus.Dictionary(),
1817
dbus.Array((dbus_name, )))
1819
dbus_value = transform_func(
1821
variant_level=variant_level)
1822
self.PropertyChanged(dbus.String(dbus_name),
1824
self.PropertiesChanged(
1826
dbus.Dictionary({dbus.String(dbus_name):
1829
setattr(self, attrname, value)
1831
return property(lambda self: getattr(self, attrname), setter)
1833
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1834
approvals_pending = notifychangeproperty(dbus.Boolean,
1837
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1838
last_enabled = notifychangeproperty(datetime_to_dbus,
1840
checker = notifychangeproperty(
1841
dbus.Boolean, "CheckerRunning",
1842
type_func=lambda checker: checker is not None)
1843
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1845
last_checker_status = notifychangeproperty(dbus.Int16,
1846
"LastCheckerStatus")
1847
last_approval_request = notifychangeproperty(
1848
datetime_to_dbus, "LastApprovalRequest")
1849
approved_by_default = notifychangeproperty(dbus.Boolean,
1850
"ApprovedByDefault")
1851
approval_delay = notifychangeproperty(
1852
dbus.UInt64, "ApprovalDelay",
1853
type_func=lambda td: td.total_seconds() * 1000)
1854
approval_duration = notifychangeproperty(
1855
dbus.UInt64, "ApprovalDuration",
1856
type_func=lambda td: td.total_seconds() * 1000)
1857
host = notifychangeproperty(dbus.String, "Host")
1858
timeout = notifychangeproperty(
1859
dbus.UInt64, "Timeout",
1860
type_func=lambda td: td.total_seconds() * 1000)
1861
extended_timeout = notifychangeproperty(
1862
dbus.UInt64, "ExtendedTimeout",
1863
type_func=lambda td: td.total_seconds() * 1000)
1864
interval = notifychangeproperty(
1865
dbus.UInt64, "Interval",
1866
type_func=lambda td: td.total_seconds() * 1000)
1867
checker_command = notifychangeproperty(dbus.String, "Checker")
1868
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1869
invalidate_only=True)
1871
del notifychangeproperty
784
1873
def __del__(self, *args, **kwargs):
786
1875
self.remove_from_connection()
1289
2374
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))
2377
session.send(client.secret)
2378
except gnutls.Error as error:
2379
logger.warning("gnutls send failed",
1303
2383
logger.info("Sending secret to %s", client.name)
1304
# bump the timeout as if seen
2384
# bump the timeout using extended_timeout
2385
client.bump_timeout(client.extended_timeout)
1306
2386
if self.server.use_dbus:
1307
2387
# Emit D-Bus signal
1308
2388
client.GotSecret()
1311
2391
if approval_required:
1312
2392
client.approvals_pending -= 1
1315
except (gnutls.errors.GNUTLSError), error:
1316
logger.warning("GnuTLS bye failed")
2395
except gnutls.Error as error:
2396
logger.warning("GnuTLS bye failed",
1319
2400
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
2401
"Return the peer's certificate as a bytestring"
2403
cert_type = gnutls.certificate_type_get2(session._c_object,
2405
except AttributeError:
2406
cert_type = gnutls.certificate_type_get(session._c_object)
2407
if gnutls.has_rawpk:
2408
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2410
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2411
# If not a valid certificate type...
2412
if cert_type not in valid_cert_types:
2413
logger.info("Cert type %r not in %r", cert_type,
2415
# ...return invalid data
1327
2417
list_size = ctypes.c_uint(1)
1328
cert_list = (gnutls.library.functions
1329
.gnutls_certificate_get_peers
2418
cert_list = (gnutls.certificate_get_peers
1330
2419
(session._c_object, ctypes.byref(list_size)))
1331
2420
if not bool(cert_list) and list_size.value != 0:
1332
raise gnutls.errors.GNUTLSError("error getting peer"
2421
raise gnutls.Error("error getting peer certificate")
1334
2422
if list_size.value == 0:
1336
2424
cert = cert_list[0]
1337
2425
return ctypes.string_at(cert.data, cert.size)
2428
def key_id(certificate):
2429
"Convert a certificate bytestring to a hexdigit key ID"
2430
# New GnuTLS "datum" with the public key
2431
datum = gnutls.datum_t(
2432
ctypes.cast(ctypes.c_char_p(certificate),
2433
ctypes.POINTER(ctypes.c_ubyte)),
2434
ctypes.c_uint(len(certificate)))
2435
# XXX all these need to be created in the gnutls "module"
2436
# New empty GnuTLS certificate
2437
pubkey = gnutls.pubkey_t()
2438
gnutls.pubkey_init(ctypes.byref(pubkey))
2439
# Import the raw public key into the certificate
2440
gnutls.pubkey_import(pubkey,
2441
ctypes.byref(datum),
2442
gnutls.X509_FMT_DER)
2443
# New buffer for the key ID
2444
buf = ctypes.create_string_buffer(32)
2445
buf_len = ctypes.c_size_t(len(buf))
2446
# Get the key ID from the raw public key into the buffer
2447
gnutls.pubkey_get_key_id(pubkey,
2448
gnutls.KEYID_USE_SHA256,
2449
ctypes.cast(ctypes.byref(buf),
2450
ctypes.POINTER(ctypes.c_ubyte)),
2451
ctypes.byref(buf_len))
2452
# Deinit the certificate
2453
gnutls.pubkey_deinit(pubkey)
2455
# Convert the buffer to a Python bytestring
2456
key_id = ctypes.string_at(buf, buf_len.value)
2457
# Convert the bytestring to hexadecimal notation
2458
hex_key_id = binascii.hexlify(key_id).upper()
1340
2462
def fingerprint(openpgp):
1341
2463
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1342
2464
# 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))))
2465
datum = gnutls.datum_t(
2466
ctypes.cast(ctypes.c_char_p(openpgp),
2467
ctypes.POINTER(ctypes.c_ubyte)),
2468
ctypes.c_uint(len(openpgp)))
1348
2469
# 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)))
2470
crt = gnutls.openpgp_crt_t()
2471
gnutls.openpgp_crt_init(ctypes.byref(crt))
1352
2472
# 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))
2473
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2474
gnutls.OPENPGP_FMT_RAW)
1357
2475
# Verify the self signature in the key
1358
2476
crtverify = ctypes.c_uint()
1359
(gnutls.library.functions
1360
.gnutls_openpgp_crt_verify_self(crt, 0,
1361
ctypes.byref(crtverify)))
2477
gnutls.openpgp_crt_verify_self(crt, 0,
2478
ctypes.byref(crtverify))
1362
2479
if crtverify.value != 0:
1363
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1364
raise (gnutls.errors.CertificateSecurityError
2480
gnutls.openpgp_crt_deinit(crt)
2481
raise gnutls.CertificateSecurityError(code
1366
2483
# New buffer for the fingerprint
1367
2484
buf = ctypes.create_string_buffer(20)
1368
2485
buf_len = ctypes.c_size_t()
1369
2486
# 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)))
2487
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2488
ctypes.byref(buf_len))
1373
2489
# Deinit the certificate
1374
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2490
gnutls.openpgp_crt_deinit(crt)
1375
2491
# Convert the buffer to a Python bytestring
1376
2492
fpr = ctypes.string_at(buf, buf_len.value)
1377
2493
# Convert the bytestring to hexadecimal notation
1378
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2494
hex_fpr = binascii.hexlify(fpr).upper()
1382
class MultiprocessingMixIn(object):
2498
class MultiprocessingMixIn:
1383
2499
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1384
2501
def sub_process_main(self, request, address):
1386
2503
self.finish_request(request, address)
1388
2505
self.handle_error(request, address)
1389
2506
self.close_request(request)
1391
2508
def process_request(self, request, address):
1392
2509
"""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):
2510
proc = multiprocessing.Process(target=self.sub_process_main,
2511
args=(request, address))
2516
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1397
2517
""" adds a pipe to the MixIn """
1398
2519
def process_request(self, request, client_address):
1399
2520
"""Overrides and wraps the original process_request().
1401
2522
This function creates a new pipe in self.pipe
1403
2524
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1405
super(MultiprocessingMixInWithPipe,
1406
self).process_request(request, client_address)
2526
proc = MultiprocessingMixIn.process_request(self, request,
1407
2528
self.child_pipe.close()
1408
self.add_pipe(parent_pipe)
2529
self.add_pipe(parent_pipe, proc)
1410
def add_pipe(self, parent_pipe):
2531
def add_pipe(self, parent_pipe, proc):
1411
2532
"""Dummy function; override as necessary"""
1412
raise NotImplementedError
2533
raise NotImplementedError()
1414
2536
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1415
socketserver.TCPServer, object):
2537
socketserver.TCPServer):
1416
2538
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1419
2541
enabled: Boolean; whether this server is activated yet
1420
2542
interface: None or a network interface name (string)
1421
2543
use_ipv6: Boolean; to use IPv6 or not
1423
2546
def __init__(self, server_address, RequestHandlerClass,
1424
interface=None, use_ipv6=True):
2550
"""If socketfd is set, use that file descriptor instead of
2551
creating a new one with socket.socket().
1425
2553
self.interface = interface
1427
2555
self.address_family = socket.AF_INET6
2556
if socketfd is not None:
2557
# Save the file descriptor
2558
self.socketfd = socketfd
2559
# Save the original socket.socket() function
2560
self.socket_socket = socket.socket
2562
# To implement --socket, we monkey patch socket.socket.
2564
# (When socketserver.TCPServer is a new-style class, we
2565
# could make self.socket into a property instead of monkey
2566
# patching socket.socket.)
2568
# Create a one-time-only replacement for socket.socket()
2569
@functools.wraps(socket.socket)
2570
def socket_wrapper(*args, **kwargs):
2571
# Restore original function so subsequent calls are
2573
socket.socket = self.socket_socket
2574
del self.socket_socket
2575
# This time only, return a new socket object from the
2576
# saved file descriptor.
2577
return socket.fromfd(self.socketfd, *args, **kwargs)
2578
# Replace socket.socket() function with wrapper
2579
socket.socket = socket_wrapper
2580
# The socketserver.TCPServer.__init__ will call
2581
# socket.socket(), which might be our replacement,
2582
# socket_wrapper(), if socketfd was set.
1428
2583
socketserver.TCPServer.__init__(self, server_address,
1429
2584
RequestHandlerClass)
1430
2586
def server_bind(self):
1431
2587
"""This overrides the normal server_bind() function
1432
2588
to bind to an interface if one was specified, and also NOT to
1433
2589
bind to an address or port if they were not specified."""
2590
global SO_BINDTODEVICE
1434
2591
if self.interface is not None:
1435
2592
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",
2593
# Fall back to a hard-coded value which seems to be
2595
logger.warning("SO_BINDTODEVICE not found, trying 25")
2596
SO_BINDTODEVICE = 25
2598
self.socket.setsockopt(
2599
socket.SOL_SOCKET, SO_BINDTODEVICE,
2600
(self.interface + "\0").encode("utf-8"))
2601
except socket.error as error:
2602
if error.errno == errno.EPERM:
2603
logger.error("No permission to bind to"
2604
" interface %s", self.interface)
2605
elif error.errno == errno.ENOPROTOOPT:
2606
logger.error("SO_BINDTODEVICE not available;"
2607
" cannot bind to interface %s",
2609
elif error.errno == errno.ENODEV:
2610
logger.error("Interface %s does not exist,"
2611
" cannot bind", self.interface)
1456
2614
# Only bind(2) the socket if we really need to.
1457
2615
if self.server_address[0] or self.server_address[1]:
2616
if self.server_address[1]:
2617
self.allow_reuse_address = True
1458
2618
if not self.server_address[0]:
1459
2619
if self.address_family == socket.AF_INET6:
1460
any_address = "::" # in6addr_any
2620
any_address = "::" # in6addr_any
1462
any_address = socket.INADDR_ANY
2622
any_address = "0.0.0.0" # INADDR_ANY
1463
2623
self.server_address = (any_address,
1464
2624
self.server_address[1])
1465
2625
elif not self.server_address[1]:
1466
self.server_address = (self.server_address[0],
2626
self.server_address = (self.server_address[0], 0)
1468
2627
# if self.interface:
1469
2628
# self.server_address = (self.server_address[0],
1673
2928
##################################################################
1674
2929
# 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]
2931
parser = argparse.ArgumentParser()
2932
parser.add_argument("-v", "--version", action="version",
2933
version="%(prog)s {}".format(version),
2934
help="show version number and exit")
2935
parser.add_argument("-i", "--interface", metavar="IF",
2936
help="Bind to interface IF")
2937
parser.add_argument("-a", "--address",
2938
help="Address to listen for requests on")
2939
parser.add_argument("-p", "--port", type=int,
2940
help="Port number to receive requests on")
2941
parser.add_argument("--check", action="store_true",
2942
help="Run self-test")
2943
parser.add_argument("--debug", action="store_true",
2944
help="Debug mode; run in foreground and log"
2945
" to terminal", default=None)
2946
parser.add_argument("--debuglevel", metavar="LEVEL",
2947
help="Debug level for stdout output")
2948
parser.add_argument("--priority", help="GnuTLS"
2949
" priority string (see GnuTLS documentation)")
2950
parser.add_argument("--servicename",
2951
metavar="NAME", help="Zeroconf service name")
2952
parser.add_argument("--configdir",
2953
default="/etc/mandos", metavar="DIR",
2954
help="Directory to search for configuration"
2956
parser.add_argument("--no-dbus", action="store_false",
2957
dest="use_dbus", help="Do not provide D-Bus"
2958
" system bus interface", default=None)
2959
parser.add_argument("--no-ipv6", action="store_false",
2960
dest="use_ipv6", help="Do not use IPv6",
2962
parser.add_argument("--no-restore", action="store_false",
2963
dest="restore", help="Do not restore stored"
2964
" state", default=None)
2965
parser.add_argument("--socket", type=int,
2966
help="Specify a file descriptor to a network"
2967
" socket to use instead of creating one")
2968
parser.add_argument("--statedir", metavar="DIR",
2969
help="Directory to save/restore state in")
2970
parser.add_argument("--foreground", action="store_true",
2971
help="Run in foreground", default=None)
2972
parser.add_argument("--no-zeroconf", action="store_false",
2973
dest="zeroconf", help="Do not use Zeroconf",
2976
options = parser.parse_args()
1705
2978
if options.check:
2980
fail_count, test_count = doctest.testmod()
2981
sys.exit(os.EX_OK if fail_count == 0 else 1)
1710
2983
# Default values for config file for server-global settings
1711
server_defaults = { "interface": "",
1716
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1717
"servicename": "Mandos",
2984
if gnutls.has_rawpk:
2985
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2986
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2988
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2989
":+SIGN-DSA-SHA256")
2990
server_defaults = {"interface": "",
2994
"priority": priority,
2995
"servicename": "Mandos",
3001
"statedir": "/var/lib/mandos",
3002
"foreground": "False",
1723
3007
# Parse config file for server-global settings
1724
server_config = configparser.SafeConfigParser(server_defaults)
3008
server_config = configparser.ConfigParser(server_defaults)
1725
3009
del server_defaults
1726
server_config.read(os.path.join(options.configdir,
1728
# Convert the SafeConfigParser object to a dict
3010
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3011
# Convert the ConfigParser object to a dict
1729
3012
server_settings = server_config.defaults()
1730
3013
# Use the appropriate methods on the non-string config options
1731
for option in ("debug", "use_dbus", "use_ipv6"):
3014
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3015
"foreground", "zeroconf"):
1732
3016
server_settings[option] = server_config.getboolean("DEFAULT",
1734
3018
if server_settings["port"]:
1735
3019
server_settings["port"] = server_config.getint("DEFAULT",
3021
if server_settings["socket"]:
3022
server_settings["socket"] = server_config.getint("DEFAULT",
3024
# Later, stdin will, and stdout and stderr might, be dup'ed
3025
# over with an opened os.devnull. But we don't want this to
3026
# happen with a supplied network socket.
3027
if 0 <= server_settings["socket"] <= 2:
3028
server_settings["socket"] = os.dup(server_settings
1737
3030
del server_config
1739
3032
# Override the settings from the config file with command line
1740
3033
# options, if set.
1741
3034
for option in ("interface", "address", "port", "debug",
1742
"priority", "servicename", "configdir",
1743
"use_dbus", "use_ipv6", "debuglevel"):
3035
"priority", "servicename", "configdir", "use_dbus",
3036
"use_ipv6", "debuglevel", "restore", "statedir",
3037
"socket", "foreground", "zeroconf"):
1744
3038
value = getattr(options, option)
1745
3039
if value is not None:
1746
3040
server_settings[option] = value
1748
3042
# Force all strings to be unicode
1749
3043
for option in server_settings.keys():
1750
if type(server_settings[option]) is str:
1751
server_settings[option] = unicode(server_settings[option])
3044
if isinstance(server_settings[option], bytes):
3045
server_settings[option] = (server_settings[option]
3047
# Force all boolean options to be boolean
3048
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3049
"foreground", "zeroconf"):
3050
server_settings[option] = bool(server_settings[option])
3051
# Debug implies foreground
3052
if server_settings["debug"]:
3053
server_settings["foreground"] = True
1752
3054
# Now we have our good server settings in "server_settings"
1754
3056
##################################################################
3058
if (not server_settings["zeroconf"]
3059
and not (server_settings["port"]
3060
or server_settings["socket"] != "")):
3061
parser.error("Needs port or socket to work without Zeroconf")
1756
3063
# For convenience
1757
3064
debug = server_settings["debug"]
1758
3065
debuglevel = server_settings["debuglevel"]
1759
3066
use_dbus = server_settings["use_dbus"]
1760
3067
use_ipv6 = server_settings["use_ipv6"]
3068
stored_state_path = os.path.join(server_settings["statedir"],
3070
foreground = server_settings["foreground"]
3071
zeroconf = server_settings["zeroconf"]
3074
initlogger(debug, logging.DEBUG)
3079
level = getattr(logging, debuglevel.upper())
3080
initlogger(debug, level)
1762
3082
if server_settings["servicename"] != "Mandos":
1763
syslogger.setFormatter(logging.Formatter
1764
('Mandos (%s) [%%(process)d]:'
1765
' %%(levelname)s: %%(message)s'
1766
% server_settings["servicename"]))
3083
syslogger.setFormatter(
3084
logging.Formatter('Mandos ({}) [%(process)d]:'
3085
' %(levelname)s: %(message)s'.format(
3086
server_settings["servicename"])))
1768
3088
# 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)
3089
client_config = configparser.ConfigParser(Client.client_defaults)
1777
3090
client_config.read(os.path.join(server_settings["configdir"],
1778
3091
"clients.conf"))
1780
3093
global mandos_dbus_service
1781
3094
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
3097
if server_settings["socket"] != "":
3098
socketfd = server_settings["socket"]
3099
tcp_server = MandosServer(
3100
(server_settings["address"], server_settings["port"]),
3102
interface=(server_settings["interface"] or None),
3104
gnutls_priority=server_settings["priority"],
3108
pidfilename = "/run/mandos.pid"
3109
if not os.path.isdir("/run/."):
3110
pidfilename = "/var/run/mandos.pid"
3113
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3114
except IOError as e:
3115
logger.error("Could not open file %r", pidfilename,
3118
for name, group in (("_mandos", "_mandos"),
3119
("mandos", "mandos"),
3120
("nobody", "nogroup")):
3122
uid = pwd.getpwnam(name).pw_uid
3123
gid = pwd.getpwnam(group).pw_gid
1806
3125
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)
3134
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3136
except OSError as error:
3137
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3138
.format(uid, gid, os.strerror(error.errno)))
3139
if error.errno != errno.EPERM:
1829
3143
# Enable all possible GnuTLS debugging
1831
3145
# "Use a log level over 10 to enable all debugging options."
1832
3146
# - GnuTLS manual
1833
gnutls.library.functions.gnutls_global_set_log_level(11)
1835
@gnutls.library.types.gnutls_log_func
3147
gnutls.global_set_log_level(11)
1836
3150
def debug_gnutls(level, string):
1837
3151
logger.debug("GnuTLS: %s", string[:-1])
1839
(gnutls.library.functions
1840
.gnutls_global_set_log_function(debug_gnutls))
3153
gnutls.global_set_log_function(debug_gnutls)
1842
3155
# Redirect stdin so all checkers get /dev/null
1843
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3156
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1844
3157
os.dup2(null, sys.stdin.fileno())
1848
# No console logging
1849
logger.removeHandler(console)
1851
3161
# Need to fork before connecting to D-Bus
1853
3163
# Close all input and output, do double fork, etc.
3166
if gi.version_info < (3, 10, 2):
3167
# multiprocessing will use threads, so before we use GLib we
3168
# need to inform GLib that threads will be used.
1856
3171
global main_loop
1857
3172
# From the Avahi example code
1858
DBusGMainLoop(set_as_default=True )
1859
main_loop = gobject.MainLoop()
3173
DBusGMainLoop(set_as_default=True)
3174
main_loop = GLib.MainLoop()
1860
3175
bus = dbus.SystemBus()
1861
3176
# 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")
3179
bus_name = dbus.service.BusName("se.recompile.Mandos",
3182
old_bus_name = dbus.service.BusName(
3183
"se.bsnet.fukt.Mandos", bus,
3185
except dbus.exceptions.DBusException as e:
3186
logger.error("Disabling D-Bus:", exc_info=e)
1868
3187
use_dbus = False
1869
3188
server_settings["use_dbus"] = False
1870
3189
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"])))
3191
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3192
service = AvahiServiceToSyslog(
3193
name=server_settings["servicename"],
3194
servicetype="_mandos._tcp",
3197
if server_settings["interface"]:
3198
service.interface = if_nametoindex(
3199
server_settings["interface"].encode("utf-8"))
1879
3201
global multiprocessing_manager
1880
3202
multiprocessing_manager = multiprocessing.Manager()
1882
3204
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):
3206
client_class = functools.partial(ClientDBus, bus=bus)
3208
client_settings = Client.config_parser(client_config)
3209
old_client_settings = {}
3212
# This is used to redirect stdout and stderr for checker processes
3214
wnull = open(os.devnull, "w") # A writable /dev/null
3215
# Only used if server is running in foreground but not in debug
3217
if debug or not foreground:
3220
# Get client data and settings from last running state.
3221
if server_settings["restore"]:
3223
with open(stored_state_path, "rb") as stored_state:
3224
if sys.version_info.major == 2:
3225
clients_data, old_client_settings = pickle.load(
3228
bytes_clients_data, bytes_old_client_settings = (
3229
pickle.load(stored_state, encoding="bytes"))
3230
# Fix bytes to strings
3233
clients_data = {(key.decode("utf-8")
3234
if isinstance(key, bytes)
3237
bytes_clients_data.items()}
3238
del bytes_clients_data
3239
for key in clients_data:
3240
value = {(k.decode("utf-8")
3241
if isinstance(k, bytes) else k): v
3243
clients_data[key].items()}
3244
clients_data[key] = value
3246
value["client_structure"] = [
3248
if isinstance(s, bytes)
3250
value["client_structure"]]
3252
for k in ("name", "host"):
3253
if isinstance(value[k], bytes):
3254
value[k] = value[k].decode("utf-8")
3255
if "key_id" not in value:
3256
value["key_id"] = ""
3257
elif "fingerprint" not in value:
3258
value["fingerprint"] = ""
3259
# old_client_settings
3261
old_client_settings = {
3262
(key.decode("utf-8")
3263
if isinstance(key, bytes)
3266
bytes_old_client_settings.items()}
3267
del bytes_old_client_settings
3269
for value in old_client_settings.values():
3270
if isinstance(value["host"], bytes):
3271
value["host"] = (value["host"]
3273
os.remove(stored_state_path)
3274
except IOError as e:
3275
if e.errno == errno.ENOENT:
3276
logger.warning("Could not load persistent state:"
3277
" {}".format(os.strerror(e.errno)))
3279
logger.critical("Could not load persistent state:",
3282
except EOFError as e:
3283
logger.warning("Could not load persistent state: "
3287
with PGPEngine() as pgp:
3288
for client_name, client in clients_data.items():
3289
# Skip removed clients
3290
if client_name not in client_settings:
3293
# Decide which value to use after restoring saved state.
3294
# We have three different values: Old config file,
3295
# new config file, and saved state.
3296
# New config value takes precedence if it differs from old
3297
# config value, otherwise use saved state.
3298
for name, value in client_settings[client_name].items():
3300
# For each value in new config, check if it
3301
# differs from the old config value (Except for
3302
# the "secret" attribute)
3303
if (name != "secret"
3305
old_client_settings[client_name][name])):
3306
client[name] = value
3310
# Clients who has passed its expire date can still be
3311
# enabled if its last checker was successful. A Client
3312
# whose checker succeeded before we stored its state is
3313
# assumed to have successfully run all checkers during
3315
if client["enabled"]:
3316
if datetime.datetime.utcnow() >= client["expires"]:
3317
if not client["last_checked_ok"]:
3319
"disabling client {} - Client never "
3320
"performed a successful checker".format(
3322
client["enabled"] = False
3323
elif client["last_checker_status"] != 0:
3325
"disabling client {} - Client last"
3326
" checker failed with error code"
3329
client["last_checker_status"]))
3330
client["enabled"] = False
3332
client["expires"] = (
3333
datetime.datetime.utcnow()
3334
+ client["timeout"])
3335
logger.debug("Last checker succeeded,"
3336
" 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()))
3339
client["secret"] = pgp.decrypt(
3340
client["encrypted_secret"],
3341
client_settings[client_name]["secret"])
3343
# If decryption fails, we use secret from new settings
3344
logger.debug("Failed to decrypt {} old secret".format(
3346
client["secret"] = (client_settings[client_name]
3349
# Add/remove clients based on new changes made to config
3350
for client_name in (set(old_client_settings)
3351
- set(client_settings)):
3352
del clients_data[client_name]
3353
for client_name in (set(client_settings)
3354
- set(old_client_settings)):
3355
clients_data[client_name] = client_settings[client_name]
3357
# Create all client objects
3358
for client_name, client in clients_data.items():
3359
tcp_server.clients[client_name] = client_class(
3362
server_settings=server_settings)
1902
3364
if not tcp_server.clients:
1903
3365
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
3368
if pidfile is not None:
3372
print(pid, file=pidfile)
3374
logger.error("Could not write to file %r with PID %d",
1917
3377
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())
3379
for termsig in (signal.SIGHUP, signal.SIGTERM):
3380
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3381
lambda: main_loop.quit() and False)
1925
class MandosDBusService(dbus.service.Object):
3385
@alternate_dbus_interfaces(
3386
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3387
class MandosDBusService(DBusObjectWithObjectManager):
1926
3388
"""A D-Bus proxy object"""
1927
3390
def __init__(self):
1928
3391
dbus.service.Object.__init__(self, bus, "/")
1929
_interface = "se.bsnet.fukt.Mandos"
3393
_interface = "se.recompile.Mandos"
1931
3395
@dbus.service.signal(_interface, signature="o")
1932
3396
def ClientAdded(self, objpath):
1936
3400
@dbus.service.signal(_interface, signature="ss")
1937
def ClientNotFound(self, fingerprint, address):
3401
def ClientNotFound(self, key_id, address):
3405
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1941
3407
@dbus.service.signal(_interface, signature="os")
1942
3408
def ClientRemoved(self, objpath, name):
3412
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1946
3414
@dbus.service.method(_interface, out_signature="ao")
1947
3415
def GetAllClients(self):
1949
return dbus.Array(c.dbus_object_path
1950
for c in tcp_server.clients)
3417
return dbus.Array(c.dbus_object_path for c in
3418
tcp_server.clients.values())
3420
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1952
3422
@dbus.service.method(_interface,
1953
3423
out_signature="a{oa{sv}}")
1954
3424
def GetAllClientsWithProperties(self):
1956
3426
return dbus.Dictionary(
1957
((c.dbus_object_path, c.GetAll(""))
1958
for c in tcp_server.clients),
3427
{c.dbus_object_path: c.GetAll(
3428
"se.recompile.Mandos.Client")
3429
for c in tcp_server.clients.values()},
1959
3430
signature="oa{sv}")
1961
3432
@dbus.service.method(_interface, in_signature="o")
1962
3433
def RemoveClient(self, object_path):
1964
for c in tcp_server.clients:
3435
for c in tcp_server.clients.values():
1965
3436
if c.dbus_object_path == object_path:
1966
tcp_server.clients.remove(c)
3437
del tcp_server.clients[c.name]
1967
3438
c.remove_from_connection()
1968
# Don't signal anything except ClientRemoved
3439
# Don't signal the disabling
1969
3440
c.disable(quiet=True)
1971
self.ClientRemoved(object_path, c.name)
3441
# Emit D-Bus signal for removal
3442
self.client_removed_signal(c)
1973
3444
raise KeyError(object_path)
3448
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3449
out_signature="a{oa{sa{sv}}}")
3450
def GetManagedObjects(self):
3452
return dbus.Dictionary(
3453
{client.dbus_object_path:
3455
{interface: client.GetAll(interface)
3457
client._get_all_interface_names()})
3458
for client in tcp_server.clients.values()})
3460
def client_added_signal(self, client):
3461
"""Send the new standard signal and the old signal"""
3463
# New standard signal
3464
self.InterfacesAdded(
3465
client.dbus_object_path,
3467
{interface: client.GetAll(interface)
3469
client._get_all_interface_names()}))
3471
self.ClientAdded(client.dbus_object_path)
3473
def client_removed_signal(self, client):
3474
"""Send the new standard signal and the old signal"""
3476
# New standard signal
3477
self.InterfacesRemoved(
3478
client.dbus_object_path,
3479
client._get_all_interface_names())
3481
self.ClientRemoved(client.dbus_object_path,
1977
3484
mandos_dbus_service = MandosDBusService()
3486
# Save modules to variables to exempt the modules from being
3487
# unloaded before the function registered with atexit() is run.
3488
mp = multiprocessing
1980
3492
"Cleanup function; run on exit"
3496
mp.active_children()
3498
if not (tcp_server.clients or client_settings):
3501
# Store client before exiting. Secrets are encrypted with key
3502
# based on what config file has. If config file is
3503
# removed/edited, old secret will thus be unrecovable.
3505
with PGPEngine() as pgp:
3506
for client in tcp_server.clients.values():
3507
key = client_settings[client.name]["secret"]
3508
client.encrypted_secret = pgp.encrypt(client.secret,
3512
# A list of attributes that can not be pickled
3514
exclude = {"bus", "changedstate", "secret",
3515
"checker", "server_settings"}
3516
for name, typ in inspect.getmembers(dbus.service
3520
client_dict["encrypted_secret"] = (client
3522
for attr in client.client_structure:
3523
if attr not in exclude:
3524
client_dict[attr] = getattr(client, attr)
3526
clients[client.name] = client_dict
3527
del client_settings[client.name]["secret"]
3530
with tempfile.NamedTemporaryFile(
3534
dir=os.path.dirname(stored_state_path),
3535
delete=False) as stored_state:
3536
pickle.dump((clients, client_settings), stored_state,
3538
tempname = stored_state.name
3539
os.rename(tempname, stored_state_path)
3540
except (IOError, OSError) as e:
3546
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3547
logger.warning("Could not save persistent state: {}"
3548
.format(os.strerror(e.errno)))
3550
logger.warning("Could not save persistent state:",
3554
# Delete all clients, and settings from config
1983
3555
while tcp_server.clients:
1984
client = tcp_server.clients.pop()
3556
name, client = tcp_server.clients.popitem()
1986
3558
client.remove_from_connection()
1987
client.disable_hook = None
1988
# Don't signal anything except ClientRemoved
3559
# Don't signal the disabling
1989
3560
client.disable(quiet=True)
3561
# Emit D-Bus signal for removal
1992
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3563
mandos_dbus_service.client_removed_signal(client)
3564
client_settings.clear()
1995
3566
atexit.register(cleanup)
1997
for client in tcp_server.clients:
3568
for client in tcp_server.clients.values():
2000
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3570
# Emit D-Bus signal for adding
3571
mandos_dbus_service.client_added_signal(client)
3572
# Need to initiate checking of clients
3574
client.init_checker()
2003
3576
tcp_server.enable()
2004
3577
tcp_server.server_activate()
2006
3579
# Find out what port we got
2007
service.port = tcp_server.socket.getsockname()[1]
3581
service.port = tcp_server.socket.getsockname()[1]
2009
3583
logger.info("Now listening on address %r, port %d,"
2010
" flowinfo %d, scope_id %d"
2011
% tcp_server.socket.getsockname())
3584
" flowinfo %d, scope_id %d",
3585
*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]
3587
logger.info("Now listening on address %r, port %d",
3588
*tcp_server.socket.getsockname())
3590
# 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))
3594
# From the Avahi example code
3597
except dbus.exceptions.DBusException as error:
3598
logger.critical("D-Bus Exception", exc_info=error)
3601
# End of Avahi example code
3603
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3604
lambda *args, **kwargs:
3605
(tcp_server.handle_request
3606
(*args[2:], **kwargs) or True))
2033
3608
logger.debug("Starting main loop")
2034
3609
main_loop.run()
2035
except AvahiError, error:
2036
logger.critical("AvahiError: %s", error)
3610
except AvahiError as error:
3611
logger.critical("Avahi Error", exc_info=error)
2039
3614
except KeyboardInterrupt: