70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
83
67
import dbus.service
85
from gi.repository import GLib
86
70
from dbus.mainloop.glib import DBusGMainLoop
89
73
import xml.dom.minidom
92
if sys.version_info.major == 2:
96
# Show warnings by default
97
if not sys.warnoptions:
99
warnings.simplefilter("default")
101
# Try to find the value of SO_BINDTODEVICE:
103
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
104
# newer, and it is also the most natural place for it:
105
77
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
106
78
except AttributeError:
108
# This is where SO_BINDTODEVICE was up to and including Python
110
80
from IN import SO_BINDTODEVICE
111
81
except ImportError:
112
# In Python 2.7 it seems to have been removed entirely.
113
# Try running the C preprocessor:
115
cc = subprocess.Popen(["cc", "--language=c", "-E",
117
stdin=subprocess.PIPE,
118
stdout=subprocess.PIPE)
119
stdout = cc.communicate(
120
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
121
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
122
except (OSError, ValueError, IndexError):
124
SO_BINDTODEVICE = None
126
if sys.version_info < (3, 2):
127
configparser.Configparser = configparser.SafeConfigParser
130
stored_state_file = "clients.pickle"
132
logger = logging.getLogger()
133
logging.captureWarnings(True) # Show warnings via the logging system
137
if_nametoindex = ctypes.cdll.LoadLibrary(
138
ctypes.util.find_library("c")).if_nametoindex
139
except (OSError, AttributeError):
141
def if_nametoindex(interface):
142
"Get an interface index the hard way, i.e. using fcntl()"
143
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
144
with contextlib.closing(socket.socket()) as s:
145
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
146
struct.pack(b"16s16x", interface))
147
interface_index = struct.unpack("I", ifreq[16:20])[0]
148
return interface_index
151
def copy_function(func):
152
"""Make a copy of a function"""
153
if sys.version_info.major == 2:
154
return types.FunctionType(func.func_code,
160
return types.FunctionType(func.__code__,
167
def initlogger(debug, level=logging.WARNING):
168
"""init logger and add loglevel"""
171
syslogger = (logging.handlers.SysLogHandler(
172
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
174
syslogger.setFormatter(logging.Formatter
175
('Mandos [%(process)d]: %(levelname)s:'
177
logger.addHandler(syslogger)
180
console = logging.StreamHandler()
181
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
185
logger.addHandler(console)
186
logger.setLevel(level)
189
class PGPError(Exception):
190
"""Exception if encryption/decryption fails"""
195
"""A simple class for OpenPGP symmetric encryption & decryption"""
198
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
201
output = subprocess.check_output(["gpgconf"])
202
for line in output.splitlines():
203
name, text, path = line.split(b":")
208
if e.errno != errno.ENOENT:
210
self.gnupgargs = ['--batch',
211
'--homedir', self.tempdir,
214
# Only GPG version 1 has the --no-use-agent option.
215
if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
216
self.gnupgargs.append("--no-use-agent")
221
def __exit__(self, exc_type, exc_value, traceback):
229
if self.tempdir is not None:
230
# Delete contents of tempdir
231
for root, dirs, files in os.walk(self.tempdir,
233
for filename in files:
234
os.remove(os.path.join(root, filename))
236
os.rmdir(os.path.join(root, dirname))
238
os.rmdir(self.tempdir)
241
def password_encode(self, password):
242
# Passphrase can not be empty and can not contain newlines or
243
# NUL bytes. So we prefix it and hex encode it.
244
encoded = b"mandos" + binascii.hexlify(password)
245
if len(encoded) > 2048:
246
# GnuPG can't handle long passwords, so encode differently
247
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
248
.replace(b"\n", b"\\n")
249
.replace(b"\0", b"\\x00"))
252
def encrypt(self, data, password):
253
passphrase = self.password_encode(password)
254
with tempfile.NamedTemporaryFile(
255
dir=self.tempdir) as passfile:
256
passfile.write(passphrase)
258
proc = subprocess.Popen([self.gpg, '--symmetric',
262
stdin=subprocess.PIPE,
263
stdout=subprocess.PIPE,
264
stderr=subprocess.PIPE)
265
ciphertext, err = proc.communicate(input=data)
266
if proc.returncode != 0:
270
def decrypt(self, data, password):
271
passphrase = self.password_encode(password)
272
with tempfile.NamedTemporaryFile(
273
dir=self.tempdir) as passfile:
274
passfile.write(passphrase)
276
proc = subprocess.Popen([self.gpg, '--decrypt',
280
stdin=subprocess.PIPE,
281
stdout=subprocess.PIPE,
282
stderr=subprocess.PIPE)
283
decrypted_plaintext, err = proc.communicate(input=data)
284
if proc.returncode != 0:
286
return decrypted_plaintext
289
# Pretend that we have an Avahi module
291
"""This isn't so much a class as it is a module-like namespace."""
292
IF_UNSPEC = -1 # avahi-common/address.h
293
PROTO_UNSPEC = -1 # avahi-common/address.h
294
PROTO_INET = 0 # avahi-common/address.h
295
PROTO_INET6 = 1 # avahi-common/address.h
296
DBUS_NAME = "org.freedesktop.Avahi"
297
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
298
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
299
DBUS_PATH_SERVER = "/"
302
def string_array_to_txt_array(t):
303
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
304
for s in t), signature="ay")
305
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
306
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
307
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
308
SERVER_INVALID = 0 # avahi-common/defs.h
309
SERVER_REGISTERING = 1 # avahi-common/defs.h
310
SERVER_RUNNING = 2 # avahi-common/defs.h
311
SERVER_COLLISION = 3 # avahi-common/defs.h
312
SERVER_FAILURE = 4 # avahi-common/defs.h
82
SO_BINDTODEVICE = None
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
89
syslogger = (logging.handlers.SysLogHandler
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
address = str("/dev/log")))
92
syslogger.setFormatter(logging.Formatter
93
('Mandos [%(process)d]: %(levelname)s:'
95
logger.addHandler(syslogger)
97
console = logging.StreamHandler()
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
101
logger.addHandler(console)
315
103
class AvahiError(Exception):
316
104
def __init__(self, value, *args, **kwargs):
317
105
self.value = value
318
return super(AvahiError, self).__init__(value, *args,
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
322
110
class AvahiServiceError(AvahiError):
326
113
class AvahiGroupError(AvahiError):
117
class AvahiService(object):
331
118
"""An Avahi (Zeroconf) service.
334
121
interface: integer; avahi.IF_UNSPEC or an interface index.
335
122
Used to optionally bind to the specified interface.
336
123
name: string; Example: 'Mandos'
337
124
type: string; Example: '_mandos._tcp'.
338
See <https://www.iana.org/assignments/service-names-port-numbers>
125
See <http://www.dns-sd.org/ServiceTypes.html>
339
126
port: integer; what port to announce
340
127
TXT: list of strings; TXT record for the service
341
128
domain: string; Domain to publish on, default to .local if empty.
500
252
follow_name_owner_changes=True),
501
253
avahi.DBUS_INTERFACE_SERVER)
502
254
self.server.connect_to_signal("StateChanged",
503
self.server_state_changed)
255
self.server_state_changed)
504
256
self.server_state_changed(self.server.GetState())
507
class AvahiServiceToSyslog(AvahiService):
508
def rename(self, *args, **kwargs):
509
"""Add the new name to the syslog messages"""
510
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
511
syslogger.setFormatter(logging.Formatter(
512
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
517
# Pretend that we have a GnuTLS module
519
"""This isn't so much a class as it is a module-like namespace."""
521
library = ctypes.util.find_library("gnutls")
523
library = ctypes.util.find_library("gnutls-deb0")
524
_library = ctypes.cdll.LoadLibrary(library)
527
# Unless otherwise indicated, the constants and types below are
528
# all from the gnutls/gnutls.h C header file.
539
E_NO_CERTIFICATE_FOUND = -49
544
KEYID_USE_SHA256 = 1 # gnutls/x509.h
545
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
548
class session_int(ctypes.Structure):
550
session_t = ctypes.POINTER(session_int)
552
class certificate_credentials_st(ctypes.Structure):
554
certificate_credentials_t = ctypes.POINTER(
555
certificate_credentials_st)
556
certificate_type_t = ctypes.c_int
558
class datum_t(ctypes.Structure):
559
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
560
('size', ctypes.c_uint)]
562
class openpgp_crt_int(ctypes.Structure):
564
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
565
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
566
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
567
credentials_type_t = ctypes.c_int
568
transport_ptr_t = ctypes.c_void_p
569
close_request_t = ctypes.c_int
572
class Error(Exception):
573
def __init__(self, message=None, code=None, args=()):
574
# Default usage is by a message string, but if a return
575
# code is passed, convert it to a string with
578
if message is None and code is not None:
579
message = gnutls.strerror(code)
580
return super(gnutls.Error, self).__init__(
583
class CertificateSecurityError(Error):
589
self._c_object = gnutls.certificate_credentials_t()
590
gnutls.certificate_allocate_credentials(
591
ctypes.byref(self._c_object))
592
self.type = gnutls.CRD_CERTIFICATE
595
gnutls.certificate_free_credentials(self._c_object)
598
def __init__(self, socket, credentials=None):
599
self._c_object = gnutls.session_t()
600
gnutls_flags = gnutls.CLIENT
601
if gnutls.check_version(b"3.5.6"):
602
gnutls_flags |= gnutls.NO_TICKETS
604
gnutls_flags |= gnutls.ENABLE_RAWPK
605
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
607
gnutls.set_default_priority(self._c_object)
608
gnutls.transport_set_ptr(self._c_object, socket.fileno())
609
gnutls.handshake_set_private_extensions(self._c_object,
612
if credentials is None:
613
credentials = gnutls.Credentials()
614
gnutls.credentials_set(self._c_object, credentials.type,
615
ctypes.cast(credentials._c_object,
617
self.credentials = credentials
620
gnutls.deinit(self._c_object)
623
return gnutls.handshake(self._c_object)
625
def send(self, data):
629
data_len -= gnutls.record_send(self._c_object,
634
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
636
# Error handling functions
637
def _error_code(result):
638
"""A function to raise exceptions on errors, suitable
639
for the 'restype' attribute on ctypes functions"""
642
if result == gnutls.E_NO_CERTIFICATE_FOUND:
643
raise gnutls.CertificateSecurityError(code=result)
644
raise gnutls.Error(code=result)
646
def _retry_on_error(result, func, arguments):
647
"""A function to retry on some errors, suitable
648
for the 'errcheck' attribute on ctypes functions"""
650
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
651
return _error_code(result)
652
result = func(*arguments)
655
# Unless otherwise indicated, the function declarations below are
656
# all from the gnutls/gnutls.h C header file.
659
priority_set_direct = _library.gnutls_priority_set_direct
660
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
661
ctypes.POINTER(ctypes.c_char_p)]
662
priority_set_direct.restype = _error_code
664
init = _library.gnutls_init
665
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
666
init.restype = _error_code
668
set_default_priority = _library.gnutls_set_default_priority
669
set_default_priority.argtypes = [session_t]
670
set_default_priority.restype = _error_code
672
record_send = _library.gnutls_record_send
673
record_send.argtypes = [session_t, ctypes.c_void_p,
675
record_send.restype = ctypes.c_ssize_t
676
record_send.errcheck = _retry_on_error
678
certificate_allocate_credentials = (
679
_library.gnutls_certificate_allocate_credentials)
680
certificate_allocate_credentials.argtypes = [
681
ctypes.POINTER(certificate_credentials_t)]
682
certificate_allocate_credentials.restype = _error_code
684
certificate_free_credentials = (
685
_library.gnutls_certificate_free_credentials)
686
certificate_free_credentials.argtypes = [
687
certificate_credentials_t]
688
certificate_free_credentials.restype = None
690
handshake_set_private_extensions = (
691
_library.gnutls_handshake_set_private_extensions)
692
handshake_set_private_extensions.argtypes = [session_t,
694
handshake_set_private_extensions.restype = None
696
credentials_set = _library.gnutls_credentials_set
697
credentials_set.argtypes = [session_t, credentials_type_t,
699
credentials_set.restype = _error_code
701
strerror = _library.gnutls_strerror
702
strerror.argtypes = [ctypes.c_int]
703
strerror.restype = ctypes.c_char_p
705
certificate_type_get = _library.gnutls_certificate_type_get
706
certificate_type_get.argtypes = [session_t]
707
certificate_type_get.restype = _error_code
709
certificate_get_peers = _library.gnutls_certificate_get_peers
710
certificate_get_peers.argtypes = [session_t,
711
ctypes.POINTER(ctypes.c_uint)]
712
certificate_get_peers.restype = ctypes.POINTER(datum_t)
714
global_set_log_level = _library.gnutls_global_set_log_level
715
global_set_log_level.argtypes = [ctypes.c_int]
716
global_set_log_level.restype = None
718
global_set_log_function = _library.gnutls_global_set_log_function
719
global_set_log_function.argtypes = [log_func]
720
global_set_log_function.restype = None
722
deinit = _library.gnutls_deinit
723
deinit.argtypes = [session_t]
724
deinit.restype = None
726
handshake = _library.gnutls_handshake
727
handshake.argtypes = [session_t]
728
handshake.restype = _error_code
729
handshake.errcheck = _retry_on_error
731
transport_set_ptr = _library.gnutls_transport_set_ptr
732
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
733
transport_set_ptr.restype = None
735
bye = _library.gnutls_bye
736
bye.argtypes = [session_t, close_request_t]
737
bye.restype = _error_code
738
bye.errcheck = _retry_on_error
740
check_version = _library.gnutls_check_version
741
check_version.argtypes = [ctypes.c_char_p]
742
check_version.restype = ctypes.c_char_p
744
_need_version = b"3.3.0"
745
if check_version(_need_version) is None:
746
raise self.Error("Needs GnuTLS {} or later"
747
.format(_need_version))
749
_tls_rawpk_version = b"3.6.6"
750
has_rawpk = bool(check_version(_tls_rawpk_version))
754
class pubkey_st(ctypes.Structure):
756
pubkey_t = ctypes.POINTER(pubkey_st)
758
x509_crt_fmt_t = ctypes.c_int
760
# All the function declarations below are from gnutls/abstract.h
761
pubkey_init = _library.gnutls_pubkey_init
762
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
763
pubkey_init.restype = _error_code
765
pubkey_import = _library.gnutls_pubkey_import
766
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
768
pubkey_import.restype = _error_code
770
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
771
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
772
ctypes.POINTER(ctypes.c_ubyte),
773
ctypes.POINTER(ctypes.c_size_t)]
774
pubkey_get_key_id.restype = _error_code
776
pubkey_deinit = _library.gnutls_pubkey_deinit
777
pubkey_deinit.argtypes = [pubkey_t]
778
pubkey_deinit.restype = None
780
# All the function declarations below are from gnutls/openpgp.h
782
openpgp_crt_init = _library.gnutls_openpgp_crt_init
783
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
784
openpgp_crt_init.restype = _error_code
786
openpgp_crt_import = _library.gnutls_openpgp_crt_import
787
openpgp_crt_import.argtypes = [openpgp_crt_t,
788
ctypes.POINTER(datum_t),
790
openpgp_crt_import.restype = _error_code
792
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
793
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
794
ctypes.POINTER(ctypes.c_uint)]
795
openpgp_crt_verify_self.restype = _error_code
797
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
798
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
799
openpgp_crt_deinit.restype = None
801
openpgp_crt_get_fingerprint = (
802
_library.gnutls_openpgp_crt_get_fingerprint)
803
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
807
openpgp_crt_get_fingerprint.restype = _error_code
809
if check_version(b"3.6.4"):
810
certificate_type_get2 = _library.gnutls_certificate_type_get2
811
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
812
certificate_type_get2.restype = _error_code
814
# Remove non-public functions
815
del _error_code, _retry_on_error
818
def call_pipe(connection, # : multiprocessing.Connection
819
func, *args, **kwargs):
820
"""This function is meant to be called by multiprocessing.Process
822
This function runs func(*args, **kwargs), and writes the resulting
823
return value on the provided multiprocessing.Connection.
825
connection.send(func(*args, **kwargs))
259
class Client(object):
830
260
"""A representation of a client host served by this server.
833
approved: bool(); 'None' if not yet approved/disapproved
263
_approved: bool(); 'None' if not yet approved/disapproved
834
264
approval_delay: datetime.timedelta(); Time to wait for approval
835
265
approval_duration: datetime.timedelta(); Duration of one approval
836
checker: multiprocessing.Process(); a running checker process used
837
to see if the client lives. 'None' if no process is
839
checker_callback_tag: a GLib event source tag, or None
266
checker: subprocess.Popen(); a running checker process used
267
to see if the client lives.
268
'None' if no process is running.
269
checker_callback_tag: a gobject event source tag, or None
840
270
checker_command: string; External command which is run to check
841
271
if client lives. %() expansions are done at
842
272
runtime with vars(self) as dict, so that for
843
273
instance %(name)s can be used in the command.
844
checker_initiator_tag: a GLib event source tag, or None
274
checker_initiator_tag: a gobject event source tag, or None
845
275
created: datetime.datetime(); (UTC) object creation
846
client_structure: Object describing what attributes a client has
847
and is used for storing the client at exit
848
276
current_checker_command: string; current running checker_command
849
disable_initiator_tag: a GLib event source tag, or None
277
disable_hook: If set, called by disable() as disable_hook(self)
278
disable_initiator_tag: a gobject event source tag, or None
851
280
fingerprint: string (40 or 32 hexadecimal digits); used to
852
uniquely identify an OpenPGP client
853
key_id: string (64 hexadecimal digits); used to uniquely identify
854
a client using raw public keys
281
uniquely identify the client
855
282
host: string; available for use by the checker command
856
283
interval: datetime.timedelta(); How often to start a new checker
857
284
last_approval_request: datetime.datetime(); (UTC) or None
858
285
last_checked_ok: datetime.datetime(); (UTC) or None
859
last_checker_status: integer between 0 and 255 reflecting exit
860
status of last checker. -1 reflects crashed
861
checker, -2 means no checker completed yet.
862
last_checker_signal: The signal which killed the last checker, if
863
last_checker_status is -1
864
last_enabled: datetime.datetime(); (UTC) or None
286
last_enabled: datetime.datetime(); (UTC)
865
287
name: string; from the config file, used in log messages and
866
288
D-Bus identifiers
867
289
secret: bytestring; sent verbatim (over TLS) to client
868
290
timeout: datetime.timedelta(); How long from last_checked_ok
869
291
until this client is disabled
870
extended_timeout: extra long timeout when secret has been sent
871
292
runtime_expansions: Allowed attributes for runtime expansion.
872
expires: datetime.datetime(); time (UTC) when a client will be
874
server_settings: The server_settings dict from main()
877
295
runtime_expansions = ("approval_delay", "approval_duration",
878
"created", "enabled", "expires", "key_id",
879
"fingerprint", "host", "interval",
880
"last_approval_request", "last_checked_ok",
296
"created", "enabled", "fingerprint",
297
"host", "interval", "last_checked_ok",
881
298
"last_enabled", "name", "timeout")
884
"extended_timeout": "PT15M",
886
"checker": "fping -q -- %%(host)s",
888
"approval_delay": "PT0S",
889
"approval_duration": "PT1S",
890
"approved_by_default": "True",
895
def config_parser(config):
896
"""Construct a new dict of client settings of this form:
897
{ client_name: {setting_name: value, ...}, ...}
898
with exceptions for any special settings as defined above.
899
NOTE: Must be a pure function. Must return the same result
900
value given the same arguments.
903
for client_name in config.sections():
904
section = dict(config.items(client_name))
905
client = settings[client_name] = {}
907
client["host"] = section["host"]
908
# Reformat values from string types to Python types
909
client["approved_by_default"] = config.getboolean(
910
client_name, "approved_by_default")
911
client["enabled"] = config.getboolean(client_name,
914
# Uppercase and remove spaces from key_id and fingerprint
915
# for later comparison purposes with return value from the
916
# key_id() and fingerprint() functions
917
client["key_id"] = (section.get("key_id", "").upper()
919
client["fingerprint"] = (section["fingerprint"].upper()
921
if "secret" in section:
922
client["secret"] = codecs.decode(section["secret"]
925
elif "secfile" in section:
926
with open(os.path.expanduser(os.path.expandvars
927
(section["secfile"])),
929
client["secret"] = secfile.read()
931
raise TypeError("No secret or secfile for section {}"
933
client["timeout"] = string_to_delta(section["timeout"])
934
client["extended_timeout"] = string_to_delta(
935
section["extended_timeout"])
936
client["interval"] = string_to_delta(section["interval"])
937
client["approval_delay"] = string_to_delta(
938
section["approval_delay"])
939
client["approval_duration"] = string_to_delta(
940
section["approval_duration"])
941
client["checker_command"] = section["checker"]
942
client["last_approval_request"] = None
943
client["last_checked_ok"] = None
944
client["last_checker_status"] = -2
948
def __init__(self, settings, name=None, server_settings=None):
301
def _timedelta_to_milliseconds(td):
302
"Convert a datetime.timedelta() to milliseconds"
303
return ((td.days * 24 * 60 * 60 * 1000)
304
+ (td.seconds * 1000)
305
+ (td.microseconds // 1000))
307
def timeout_milliseconds(self):
308
"Return the 'timeout' attribute in milliseconds"
309
return self._timedelta_to_milliseconds(self.timeout)
311
def interval_milliseconds(self):
312
"Return the 'interval' attribute in milliseconds"
313
return self._timedelta_to_milliseconds(self.interval)
315
def approval_delay_milliseconds(self):
316
return self._timedelta_to_milliseconds(self.approval_delay)
318
def __init__(self, name = None, disable_hook=None, config=None):
319
"""Note: the 'checker' key in 'config' sets the
320
'checker_command' attribute and *not* the 'checker'
950
if server_settings is None:
952
self.server_settings = server_settings
953
# adding all client settings
954
for setting, value in settings.items():
955
setattr(self, setting, value)
958
if not hasattr(self, "last_enabled"):
959
self.last_enabled = datetime.datetime.utcnow()
960
if not hasattr(self, "expires"):
961
self.expires = (datetime.datetime.utcnow()
964
self.last_enabled = None
967
325
logger.debug("Creating client %r", self.name)
968
logger.debug(" Key ID: %s", self.key_id)
326
# Uppercase and remove spaces from fingerprint for later
327
# comparison purposes with return value from the fingerprint()
329
self.fingerprint = (config["fingerprint"].upper()
969
331
logger.debug(" Fingerprint: %s", self.fingerprint)
970
self.created = settings.get("created",
971
datetime.datetime.utcnow())
973
# attributes specific for this server instance
332
if "secret" in config:
333
self.secret = config["secret"].decode("base64")
334
elif "secfile" in config:
335
with open(os.path.expanduser(os.path.expandvars
336
(config["secfile"])),
338
self.secret = secfile.read()
340
raise TypeError("No secret or secfile for client %s"
342
self.host = config.get("host", "")
343
self.created = datetime.datetime.utcnow()
345
self.last_approval_request = None
346
self.last_enabled = None
347
self.last_checked_ok = None
348
self.timeout = string_to_delta(config["timeout"])
349
self.interval = string_to_delta(config["interval"])
350
self.disable_hook = disable_hook
974
351
self.checker = None
975
352
self.checker_initiator_tag = None
976
353
self.disable_initiator_tag = None
977
354
self.checker_callback_tag = None
355
self.checker_command = config["checker"]
978
356
self.current_checker_command = None
357
self.last_connect = None
358
self._approved = None
359
self.approved_by_default = config.get("approved_by_default",
980
361
self.approvals_pending = 0
981
self.changedstate = multiprocessing_manager.Condition(
982
multiprocessing_manager.Lock())
983
self.client_structure = [attr
984
for attr in self.__dict__.keys()
985
if not attr.startswith("_")]
986
self.client_structure.append("client_structure")
988
for name, t in inspect.getmembers(
989
type(self), lambda obj: isinstance(obj, property)):
990
if not name.startswith("_"):
991
self.client_structure.append(name)
993
# Send notice to process children that client state has changed
362
self.approval_delay = string_to_delta(
363
config["approval_delay"])
364
self.approval_duration = string_to_delta(
365
config["approval_duration"])
366
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
994
368
def send_changedstate(self):
995
with self.changedstate:
996
self.changedstate.notify_all()
369
self.changedstate.acquire()
370
self.changedstate.notify_all()
371
self.changedstate.release()
998
373
def enable(self):
999
374
"""Start this client's checker and timeout hooks"""
1000
375
if getattr(self, "enabled", False):
1001
376
# Already enabled
1003
self.expires = datetime.datetime.utcnow() + self.timeout
378
self.send_changedstate()
1005
379
self.last_enabled = datetime.datetime.utcnow()
1007
self.send_changedstate()
380
# Schedule a new checker to be started an 'interval' from now,
381
# and every interval from then on.
382
self.checker_initiator_tag = (gobject.timeout_add
383
(self.interval_milliseconds(),
385
# Schedule a disable() when 'timeout' has passed
386
self.disable_initiator_tag = (gobject.timeout_add
387
(self.timeout_milliseconds(),
390
# Also start a new checker *right now*.
1009
393
def disable(self, quiet=True):
1010
394
"""Disable this client."""
1011
395
if not getattr(self, "enabled", False):
398
self.send_changedstate()
1014
400
logger.info("Disabling client %s", self.name)
1015
if getattr(self, "disable_initiator_tag", None) is not None:
1016
GLib.source_remove(self.disable_initiator_tag)
401
if getattr(self, "disable_initiator_tag", False):
402
gobject.source_remove(self.disable_initiator_tag)
1017
403
self.disable_initiator_tag = None
1019
if getattr(self, "checker_initiator_tag", None) is not None:
1020
GLib.source_remove(self.checker_initiator_tag)
404
if getattr(self, "checker_initiator_tag", False):
405
gobject.source_remove(self.checker_initiator_tag)
1021
406
self.checker_initiator_tag = None
1022
407
self.stop_checker()
408
if self.disable_hook:
409
self.disable_hook(self)
1023
410
self.enabled = False
1025
self.send_changedstate()
1026
# Do not run this again if called by a GLib.timeout_add
411
# Do not run this again if called by a gobject.timeout_add
1029
414
def __del__(self):
415
self.disable_hook = None
1032
def init_checker(self):
1033
# Schedule a new checker to be started an 'interval' from now,
1034
# and every interval from then on.
1035
if self.checker_initiator_tag is not None:
1036
GLib.source_remove(self.checker_initiator_tag)
1037
self.checker_initiator_tag = GLib.timeout_add(
1038
int(self.interval.total_seconds() * 1000),
1040
# Schedule a disable() when 'timeout' has passed
1041
if self.disable_initiator_tag is not None:
1042
GLib.source_remove(self.disable_initiator_tag)
1043
self.disable_initiator_tag = GLib.timeout_add(
1044
int(self.timeout.total_seconds() * 1000), self.disable)
1045
# Also start a new checker *right now*.
1046
self.start_checker()
1048
def checker_callback(self, source, condition, connection,
418
def checker_callback(self, pid, condition, command):
1050
419
"""The checker has completed, so take appropriate actions."""
1051
# Read return code from connection (see call_pipe)
1052
returncode = connection.recv()
1054
if self.checker is not None:
1056
420
self.checker_callback_tag = None
1057
421
self.checker = None
1060
self.last_checker_status = returncode
1061
self.last_checker_signal = None
1062
if self.last_checker_status == 0:
422
if os.WIFEXITED(condition):
423
exitstatus = os.WEXITSTATUS(condition)
1063
425
logger.info("Checker for %(name)s succeeded",
1065
427
self.checked_ok()
1067
logger.info("Checker for %(name)s failed", vars(self))
429
logger.info("Checker for %(name)s failed",
1069
self.last_checker_status = -1
1070
self.last_checker_signal = -returncode
1071
432
logger.warning("Checker for %(name)s crashed?",
1075
435
def checked_ok(self):
1076
"""Assert that the client has been seen, alive and well."""
436
"""Bump up the timeout for this client.
438
This should only be called when the client has been seen,
1077
441
self.last_checked_ok = datetime.datetime.utcnow()
1078
self.last_checker_status = 0
1079
self.last_checker_signal = None
1082
def bump_timeout(self, timeout=None):
1083
"""Bump up the timeout for this client."""
1085
timeout = self.timeout
1086
if self.disable_initiator_tag is not None:
1087
GLib.source_remove(self.disable_initiator_tag)
1088
self.disable_initiator_tag = None
1089
if getattr(self, "enabled", False):
1090
self.disable_initiator_tag = GLib.timeout_add(
1091
int(timeout.total_seconds() * 1000), self.disable)
1092
self.expires = datetime.datetime.utcnow() + timeout
442
gobject.source_remove(self.disable_initiator_tag)
443
self.disable_initiator_tag = (gobject.timeout_add
444
(self.timeout_milliseconds(),
1094
447
def need_approval(self):
1095
448
self.last_approval_request = datetime.datetime.utcnow()
1097
450
def start_checker(self):
1098
451
"""Start a new checker subprocess if one is not running.
1100
453
If a checker already exists, leave it running and do
1102
455
# The reason for not killing a running checker is that if we
1103
# did that, and if a checker (for some reason) started running
1104
# slowly and taking more than 'interval' time, then the client
1105
# would inevitably timeout, since no checker would get a
1106
# chance to run to completion. If we instead leave running
456
# did that, then if a checker (for some reason) started
457
# running slowly and taking more than 'interval' time, the
458
# client would inevitably timeout, since no checker would get
459
# a chance to run to completion. If we instead leave running
1107
460
# checkers alone, the checker would have to take more time
1108
461
# than 'timeout' for the client to be disabled, which is as it
1111
if self.checker is not None and not self.checker.is_alive():
1112
logger.warning("Checker was not alive; joining")
464
# If a checker exists, make sure it is not a zombie
466
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
467
except (AttributeError, OSError) as error:
468
if (isinstance(error, OSError)
469
and error.errno != errno.ECHILD):
473
logger.warning("Checker was a zombie")
474
gobject.source_remove(self.checker_callback_tag)
475
self.checker_callback(pid, status,
476
self.current_checker_command)
1115
477
# Start a new checker if needed
1116
478
if self.checker is None:
1117
# Escape attributes for the shell
1119
attr: re.escape(str(getattr(self, attr)))
1120
for attr in self.runtime_expansions}
1122
command = self.checker_command % escaped_attrs
1123
except TypeError as error:
1124
logger.error('Could not format string "%s"',
1125
self.checker_command,
1127
return True # Try again later
480
# In case checker_command has exactly one % operator
481
command = self.checker_command % self.host
483
# Escape attributes for the shell
484
escaped_attrs = dict(
486
re.escape(unicode(str(getattr(self, attr, "")),
490
self.runtime_expansions)
493
command = self.checker_command % escaped_attrs
494
except TypeError as error:
495
logger.error('Could not format string "%s":'
496
' %s', self.checker_command, error)
497
return True # Try again later
1128
498
self.current_checker_command = command
1129
logger.info("Starting checker %r for %s", command,
1131
# We don't need to redirect stdout and stderr, since
1132
# in normal mode, that is already done by daemon(),
1133
# and in debug mode we don't want to. (Stdin is
1134
# always replaced by /dev/null.)
1135
# The exception is when not debugging but nevertheless
1136
# running in the foreground; use the previously
1138
popen_args = {"close_fds": True,
1141
if (not self.server_settings["debug"]
1142
and self.server_settings["foreground"]):
1143
popen_args.update({"stdout": wnull,
1145
pipe = multiprocessing.Pipe(duplex=False)
1146
self.checker = multiprocessing.Process(
1148
args=(pipe[1], subprocess.call, command),
1150
self.checker.start()
1151
self.checker_callback_tag = GLib.io_add_watch(
1152
GLib.IOChannel.unix_new(pipe[0].fileno()),
1153
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1154
self.checker_callback, pipe[0], command)
1155
# Re-run this periodically if run by GLib.timeout_add
500
logger.info("Starting checker %r for %s",
502
# We don't need to redirect stdout and stderr, since
503
# in normal mode, that is already done by daemon(),
504
# and in debug mode we don't want to. (Stdin is
505
# always replaced by /dev/null.)
506
self.checker = subprocess.Popen(command,
509
self.checker_callback_tag = (gobject.child_watch_add
511
self.checker_callback,
513
# The checker may have completed before the gobject
514
# watch was added. Check for this.
515
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
517
gobject.source_remove(self.checker_callback_tag)
518
self.checker_callback(pid, status, command)
519
except OSError as error:
520
logger.error("Failed to start subprocess: %s",
522
# Re-run this periodically if run by gobject.timeout_add
1158
525
def stop_checker(self):
1159
526
"""Force the checker process, if any, to stop."""
1160
527
if self.checker_callback_tag:
1161
GLib.source_remove(self.checker_callback_tag)
528
gobject.source_remove(self.checker_callback_tag)
1162
529
self.checker_callback_tag = None
1163
530
if getattr(self, "checker", None) is None:
1165
532
logger.debug("Stopping checker for %(name)s", vars(self))
1166
self.checker.terminate()
534
os.kill(self.checker.pid, signal.SIGTERM)
536
#if self.checker.poll() is None:
537
# os.kill(self.checker.pid, signal.SIGKILL)
538
except OSError as error:
539
if error.errno != errno.ESRCH: # No such process
1167
541
self.checker = None
1170
def dbus_service_property(dbus_interface,
543
def dbus_service_property(dbus_interface, signature="v",
544
access="readwrite", byte_arrays=False):
1174
545
"""Decorators for marking methods of a DBusObjectWithProperties to
1175
546
become properties on the D-Bus.
1177
548
The decorated method will be called with no arguments by "Get"
1178
549
and with one argument by "Set".
1180
551
The parameters, where they are supported, are the same as
1181
552
dbus.service.method, except there is only "signature", since the
1182
553
type from Get() and the type sent to Set() is the same.
1514
725
except (AttributeError, xml.dom.DOMException,
1515
726
xml.parsers.expat.ExpatError) as error:
1516
727
logger.error("Failed to override Introspection method",
1522
dbus.OBJECT_MANAGER_IFACE
1523
except AttributeError:
1524
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1527
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1528
"""A D-Bus object with an ObjectManager.
1530
Classes inheriting from this exposes the standard
1531
GetManagedObjects call and the InterfacesAdded and
1532
InterfacesRemoved signals on the standard
1533
"org.freedesktop.DBus.ObjectManager" interface.
1535
Note: No signals are sent automatically; they must be sent
1538
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1539
out_signature="a{oa{sa{sv}}}")
1540
def GetManagedObjects(self):
1541
"""This function must be overridden"""
1542
raise NotImplementedError()
1544
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1545
signature="oa{sa{sv}}")
1546
def InterfacesAdded(self, object_path, interfaces_and_properties):
1549
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1550
def InterfacesRemoved(self, object_path, interfaces):
1553
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1555
path_keyword='object_path',
1556
connection_keyword='connection')
1557
def Introspect(self, object_path, connection):
1558
"""Overloading of standard D-Bus method.
1560
Override return argument name of GetManagedObjects to be
1561
"objpath_interfaces_and_properties"
1563
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1567
document = xml.dom.minidom.parseString(xmlstring)
1569
for if_tag in document.getElementsByTagName("interface"):
1570
# Fix argument name for the GetManagedObjects method
1571
if (if_tag.getAttribute("name")
1572
== dbus.OBJECT_MANAGER_IFACE):
1573
for cn in if_tag.getElementsByTagName("method"):
1574
if (cn.getAttribute("name")
1575
== "GetManagedObjects"):
1576
for arg in cn.getElementsByTagName("arg"):
1577
if (arg.getAttribute("direction")
1581
"objpath_interfaces"
1583
xmlstring = document.toxml("utf-8")
1585
except (AttributeError, xml.dom.DOMException,
1586
xml.parsers.expat.ExpatError) as error:
1587
logger.error("Failed to override Introspection method",
1592
def datetime_to_dbus(dt, variant_level=0):
1593
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1595
return dbus.String("", variant_level=variant_level)
1596
return dbus.String(dt.isoformat(), variant_level=variant_level)
1599
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1600
"""A class decorator; applied to a subclass of
1601
dbus.service.Object, it will add alternate D-Bus attributes with
1602
interface names according to the "alt_interface_names" mapping.
1605
@alternate_dbus_interfaces({"org.example.Interface":
1606
"net.example.AlternateInterface"})
1607
class SampleDBusObject(dbus.service.Object):
1608
@dbus.service.method("org.example.Interface")
1609
def SampleDBusMethod():
1612
The above "SampleDBusMethod" on "SampleDBusObject" will be
1613
reachable via two interfaces: "org.example.Interface" and
1614
"net.example.AlternateInterface", the latter of which will have
1615
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1616
"true", unless "deprecate" is passed with a False value.
1618
This works for methods and signals, and also for D-Bus properties
1619
(from DBusObjectWithProperties) and interfaces (from the
1620
dbus_interface_annotations decorator).
1624
for orig_interface_name, alt_interface_name in (
1625
alt_interface_names.items()):
1627
interface_names = set()
1628
# Go though all attributes of the class
1629
for attrname, attribute in inspect.getmembers(cls):
1630
# Ignore non-D-Bus attributes, and D-Bus attributes
1631
# with the wrong interface name
1632
if (not hasattr(attribute, "_dbus_interface")
1633
or not attribute._dbus_interface.startswith(
1634
orig_interface_name)):
1636
# Create an alternate D-Bus interface name based on
1638
alt_interface = attribute._dbus_interface.replace(
1639
orig_interface_name, alt_interface_name)
1640
interface_names.add(alt_interface)
1641
# Is this a D-Bus signal?
1642
if getattr(attribute, "_dbus_is_signal", False):
1643
# Extract the original non-method undecorated
1644
# function by black magic
1645
if sys.version_info.major == 2:
1646
nonmethod_func = (dict(
1647
zip(attribute.func_code.co_freevars,
1648
attribute.__closure__))
1649
["func"].cell_contents)
1651
nonmethod_func = (dict(
1652
zip(attribute.__code__.co_freevars,
1653
attribute.__closure__))
1654
["func"].cell_contents)
1655
# Create a new, but exactly alike, function
1656
# object, and decorate it to be a new D-Bus signal
1657
# with the alternate D-Bus interface name
1658
new_function = copy_function(nonmethod_func)
1659
new_function = (dbus.service.signal(
1661
attribute._dbus_signature)(new_function))
1662
# Copy annotations, if any
1664
new_function._dbus_annotations = dict(
1665
attribute._dbus_annotations)
1666
except AttributeError:
1669
# Define a creator of a function to call both the
1670
# original and alternate functions, so both the
1671
# original and alternate signals gets sent when
1672
# the function is called
1673
def fixscope(func1, func2):
1674
"""This function is a scope container to pass
1675
func1 and func2 to the "call_both" function
1676
outside of its arguments"""
1678
@functools.wraps(func2)
1679
def call_both(*args, **kwargs):
1680
"""This function will emit two D-Bus
1681
signals by calling func1 and func2"""
1682
func1(*args, **kwargs)
1683
func2(*args, **kwargs)
1684
# Make wrapper function look like a D-Bus
1686
for name, attr in inspect.getmembers(func2):
1687
if name.startswith("_dbus_"):
1688
setattr(call_both, name, attr)
1691
# Create the "call_both" function and add it to
1693
attr[attrname] = fixscope(attribute, new_function)
1694
# Is this a D-Bus method?
1695
elif getattr(attribute, "_dbus_is_method", False):
1696
# Create a new, but exactly alike, function
1697
# object. Decorate it to be a new D-Bus method
1698
# with the alternate D-Bus interface name. Add it
1701
dbus.service.method(
1703
attribute._dbus_in_signature,
1704
attribute._dbus_out_signature)
1705
(copy_function(attribute)))
1706
# Copy annotations, if any
1708
attr[attrname]._dbus_annotations = dict(
1709
attribute._dbus_annotations)
1710
except AttributeError:
1712
# Is this a D-Bus property?
1713
elif getattr(attribute, "_dbus_is_property", False):
1714
# Create a new, but exactly alike, function
1715
# object, and decorate it to be a new D-Bus
1716
# property with the alternate D-Bus interface
1717
# name. Add it to the class.
1718
attr[attrname] = (dbus_service_property(
1719
alt_interface, attribute._dbus_signature,
1720
attribute._dbus_access,
1721
attribute._dbus_get_args_options
1723
(copy_function(attribute)))
1724
# Copy annotations, if any
1726
attr[attrname]._dbus_annotations = dict(
1727
attribute._dbus_annotations)
1728
except AttributeError:
1730
# Is this a D-Bus interface?
1731
elif getattr(attribute, "_dbus_is_interface", False):
1732
# Create a new, but exactly alike, function
1733
# object. Decorate it to be a new D-Bus interface
1734
# with the alternate D-Bus interface name. Add it
1737
dbus_interface_annotations(alt_interface)
1738
(copy_function(attribute)))
1740
# Deprecate all alternate interfaces
1741
iname = "_AlternateDBusNames_interface_annotation{}"
1742
for interface_name in interface_names:
1744
@dbus_interface_annotations(interface_name)
1746
return {"org.freedesktop.DBus.Deprecated":
1748
# Find an unused name
1749
for aname in (iname.format(i)
1750
for i in itertools.count()):
1751
if aname not in attr:
1755
# Replace the class with a new subclass of it with
1756
# methods, signals, etc. as created above.
1757
if sys.version_info.major == 2:
1758
cls = type(b"{}Alternate".format(cls.__name__),
1761
cls = type("{}Alternate".format(cls.__name__),
1768
@alternate_dbus_interfaces({"se.recompile.Mandos":
1769
"se.bsnet.fukt.Mandos"})
1770
732
class ClientDBus(Client, DBusObjectWithProperties):
1771
733
"""A Client class using D-Bus
1774
736
dbus_object_path: dbus.ObjectPath
1775
737
bus: dbus.SystemBus()
1778
740
runtime_expansions = (Client.runtime_expansions
1779
+ ("dbus_object_path", ))
1781
_interface = "se.recompile.Mandos.Client"
741
+ ("dbus_object_path",))
1783
743
# dbus.service.Object doesn't use super(), so we can't either.
1785
def __init__(self, bus=None, *args, **kwargs):
745
def __init__(self, bus = None, *args, **kwargs):
746
self._approvals_pending = 0
1787
748
Client.__init__(self, *args, **kwargs)
1788
749
# Only now, when this client is initialized, can it show up on
1790
client_object_name = str(self.name).translate(
751
client_object_name = unicode(self.name).translate(
1791
752
{ord("."): ord("_"),
1792
753
ord("-"): ord("_")})
1793
self.dbus_object_path = dbus.ObjectPath(
1794
"/clients/" + client_object_name)
754
self.dbus_object_path = (dbus.ObjectPath
755
("/clients/" + client_object_name))
1795
756
DBusObjectWithProperties.__init__(self, self.bus,
1796
757
self.dbus_object_path)
1798
def notifychangeproperty(transform_func, dbus_name,
1799
type_func=lambda x: x,
1801
invalidate_only=False,
1802
_interface=_interface):
1803
""" Modify a variable so that it's a property which announces
1804
its changes to DBus.
1806
transform_fun: Function that takes a value and a variant_level
1807
and transforms it to a D-Bus type.
1808
dbus_name: D-Bus name of the variable
1809
type_func: Function that transform the value before sending it
1810
to the D-Bus. Default: no transform
1811
variant_level: D-Bus variant level. Default: 1
1813
attrname = "_{}".format(dbus_name)
1815
def setter(self, value):
1816
if hasattr(self, "dbus_object_path"):
1817
if (not hasattr(self, attrname) or
1818
type_func(getattr(self, attrname, None))
1819
!= type_func(value)):
1821
self.PropertiesChanged(
1822
_interface, dbus.Dictionary(),
1823
dbus.Array((dbus_name, )))
1825
dbus_value = transform_func(
1827
variant_level=variant_level)
1828
self.PropertyChanged(dbus.String(dbus_name),
1830
self.PropertiesChanged(
1832
dbus.Dictionary({dbus.String(dbus_name):
1835
setattr(self, attrname, value)
1837
return property(lambda self: getattr(self, attrname), setter)
1839
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1840
approvals_pending = notifychangeproperty(dbus.Boolean,
1843
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1844
last_enabled = notifychangeproperty(datetime_to_dbus,
1846
checker = notifychangeproperty(
1847
dbus.Boolean, "CheckerRunning",
1848
type_func=lambda checker: checker is not None)
1849
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1851
last_checker_status = notifychangeproperty(dbus.Int16,
1852
"LastCheckerStatus")
1853
last_approval_request = notifychangeproperty(
1854
datetime_to_dbus, "LastApprovalRequest")
1855
approved_by_default = notifychangeproperty(dbus.Boolean,
1856
"ApprovedByDefault")
1857
approval_delay = notifychangeproperty(
1858
dbus.UInt64, "ApprovalDelay",
1859
type_func=lambda td: td.total_seconds() * 1000)
1860
approval_duration = notifychangeproperty(
1861
dbus.UInt64, "ApprovalDuration",
1862
type_func=lambda td: td.total_seconds() * 1000)
1863
host = notifychangeproperty(dbus.String, "Host")
1864
timeout = notifychangeproperty(
1865
dbus.UInt64, "Timeout",
1866
type_func=lambda td: td.total_seconds() * 1000)
1867
extended_timeout = notifychangeproperty(
1868
dbus.UInt64, "ExtendedTimeout",
1869
type_func=lambda td: td.total_seconds() * 1000)
1870
interval = notifychangeproperty(
1871
dbus.UInt64, "Interval",
1872
type_func=lambda td: td.total_seconds() * 1000)
1873
checker_command = notifychangeproperty(dbus.String, "Checker")
1874
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1875
invalidate_only=True)
1877
del notifychangeproperty
759
def _get_approvals_pending(self):
760
return self._approvals_pending
761
def _set_approvals_pending(self, value):
762
old_value = self._approvals_pending
763
self._approvals_pending = value
765
if (hasattr(self, "dbus_object_path")
766
and bval is not bool(old_value)):
767
dbus_bool = dbus.Boolean(bval, variant_level=1)
768
self.PropertyChanged(dbus.String("ApprovalPending"),
771
approvals_pending = property(_get_approvals_pending,
772
_set_approvals_pending)
773
del _get_approvals_pending, _set_approvals_pending
776
def _datetime_to_dbus(dt, variant_level=0):
777
"""Convert a UTC datetime.datetime() to a D-Bus type."""
778
return dbus.String(dt.isoformat(),
779
variant_level=variant_level)
782
oldstate = getattr(self, "enabled", False)
783
r = Client.enable(self)
784
if oldstate != self.enabled:
786
self.PropertyChanged(dbus.String("Enabled"),
787
dbus.Boolean(True, variant_level=1))
788
self.PropertyChanged(
789
dbus.String("LastEnabled"),
790
self._datetime_to_dbus(self.last_enabled,
794
def disable(self, quiet = False):
795
oldstate = getattr(self, "enabled", False)
796
r = Client.disable(self, quiet=quiet)
797
if not quiet and oldstate != self.enabled:
799
self.PropertyChanged(dbus.String("Enabled"),
800
dbus.Boolean(False, variant_level=1))
1879
803
def __del__(self, *args, **kwargs):
1881
805
self.remove_from_connection()
2380
1308
delay -= time2 - time
2383
session.send(client.secret)
2384
except gnutls.Error as error:
2385
logger.warning("gnutls send failed",
1311
while sent_size < len(client.secret):
1313
sent = session.send(client.secret[sent_size:])
1314
except gnutls.errors.GNUTLSError as error:
1315
logger.warning("gnutls send failed")
1317
logger.debug("Sent: %d, remaining: %d",
1318
sent, len(client.secret)
1319
- (sent_size + sent))
2389
1322
logger.info("Sending secret to %s", client.name)
2390
# bump the timeout using extended_timeout
2391
client.bump_timeout(client.extended_timeout)
1323
# bump the timeout as if seen
2392
1325
if self.server.use_dbus:
2393
1326
# Emit D-Bus signal
2394
1327
client.GotSecret()
2397
1330
if approval_required:
2398
1331
client.approvals_pending -= 1
2401
except gnutls.Error as error:
2402
logger.warning("GnuTLS bye failed",
1334
except gnutls.errors.GNUTLSError as error:
1335
logger.warning("GnuTLS bye failed")
2406
1338
def peer_certificate(session):
2407
"Return the peer's certificate as a bytestring"
2409
cert_type = gnutls.certificate_type_get2(session._c_object,
2411
except AttributeError:
2412
cert_type = gnutls.certificate_type_get(session._c_object)
2413
if gnutls.has_rawpk:
2414
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2416
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2417
# If not a valid certificate type...
2418
if cert_type not in valid_cert_types:
2419
logger.info("Cert type %r not in %r", cert_type,
2421
# ...return invalid data
1339
"Return the peer's OpenPGP certificate as a bytestring"
1340
# If not an OpenPGP certificate...
1341
if (gnutls.library.functions
1342
.gnutls_certificate_type_get(session._c_object)
1343
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1344
# ...do the normal thing
1345
return session.peer_certificate
2423
1346
list_size = ctypes.c_uint(1)
2424
cert_list = (gnutls.certificate_get_peers
1347
cert_list = (gnutls.library.functions
1348
.gnutls_certificate_get_peers
2425
1349
(session._c_object, ctypes.byref(list_size)))
2426
1350
if not bool(cert_list) and list_size.value != 0:
2427
raise gnutls.Error("error getting peer certificate")
1351
raise gnutls.errors.GNUTLSError("error getting peer"
2428
1353
if list_size.value == 0:
2430
1355
cert = cert_list[0]
2431
1356
return ctypes.string_at(cert.data, cert.size)
2434
def key_id(certificate):
2435
"Convert a certificate bytestring to a hexdigit key ID"
2436
# New GnuTLS "datum" with the public key
2437
datum = gnutls.datum_t(
2438
ctypes.cast(ctypes.c_char_p(certificate),
2439
ctypes.POINTER(ctypes.c_ubyte)),
2440
ctypes.c_uint(len(certificate)))
2441
# XXX all these need to be created in the gnutls "module"
2442
# New empty GnuTLS certificate
2443
pubkey = gnutls.pubkey_t()
2444
gnutls.pubkey_init(ctypes.byref(pubkey))
2445
# Import the raw public key into the certificate
2446
gnutls.pubkey_import(pubkey,
2447
ctypes.byref(datum),
2448
gnutls.X509_FMT_DER)
2449
# New buffer for the key ID
2450
buf = ctypes.create_string_buffer(32)
2451
buf_len = ctypes.c_size_t(len(buf))
2452
# Get the key ID from the raw public key into the buffer
2453
gnutls.pubkey_get_key_id(pubkey,
2454
gnutls.KEYID_USE_SHA256,
2455
ctypes.cast(ctypes.byref(buf),
2456
ctypes.POINTER(ctypes.c_ubyte)),
2457
ctypes.byref(buf_len))
2458
# Deinit the certificate
2459
gnutls.pubkey_deinit(pubkey)
2461
# Convert the buffer to a Python bytestring
2462
key_id = ctypes.string_at(buf, buf_len.value)
2463
# Convert the bytestring to hexadecimal notation
2464
hex_key_id = binascii.hexlify(key_id).upper()
2468
1359
def fingerprint(openpgp):
2469
1360
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2470
1361
# New GnuTLS "datum" with the OpenPGP public key
2471
datum = gnutls.datum_t(
2472
ctypes.cast(ctypes.c_char_p(openpgp),
2473
ctypes.POINTER(ctypes.c_ubyte)),
2474
ctypes.c_uint(len(openpgp)))
1362
datum = (gnutls.library.types
1363
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1366
ctypes.c_uint(len(openpgp))))
2475
1367
# New empty GnuTLS certificate
2476
crt = gnutls.openpgp_crt_t()
2477
gnutls.openpgp_crt_init(ctypes.byref(crt))
1368
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1369
(gnutls.library.functions
1370
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2478
1371
# Import the OpenPGP public key into the certificate
2479
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2480
gnutls.OPENPGP_FMT_RAW)
1372
(gnutls.library.functions
1373
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1374
gnutls.library.constants
1375
.GNUTLS_OPENPGP_FMT_RAW))
2481
1376
# Verify the self signature in the key
2482
1377
crtverify = ctypes.c_uint()
2483
gnutls.openpgp_crt_verify_self(crt, 0,
2484
ctypes.byref(crtverify))
1378
(gnutls.library.functions
1379
.gnutls_openpgp_crt_verify_self(crt, 0,
1380
ctypes.byref(crtverify)))
2485
1381
if crtverify.value != 0:
2486
gnutls.openpgp_crt_deinit(crt)
2487
raise gnutls.CertificateSecurityError(code
1382
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1383
raise (gnutls.errors.CertificateSecurityError
2489
1385
# New buffer for the fingerprint
2490
1386
buf = ctypes.create_string_buffer(20)
2491
1387
buf_len = ctypes.c_size_t()
2492
1388
# Get the fingerprint from the certificate into the buffer
2493
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2494
ctypes.byref(buf_len))
1389
(gnutls.library.functions
1390
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1391
ctypes.byref(buf_len)))
2495
1392
# Deinit the certificate
2496
gnutls.openpgp_crt_deinit(crt)
1393
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2497
1394
# Convert the buffer to a Python bytestring
2498
1395
fpr = ctypes.string_at(buf, buf_len.value)
2499
1396
# Convert the bytestring to hexadecimal notation
2500
hex_fpr = binascii.hexlify(fpr).upper()
1397
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2504
class MultiprocessingMixIn:
1401
class MultiprocessingMixIn(object):
2505
1402
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2507
1403
def sub_process_main(self, request, address):
2509
1405
self.finish_request(request, address)
2511
1407
self.handle_error(request, address)
2512
1408
self.close_request(request)
2514
1410
def process_request(self, request, address):
2515
1411
"""Start a new process to process the request."""
2516
proc = multiprocessing.Process(target=self.sub_process_main,
2517
args=(request, address))
2522
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1412
multiprocessing.Process(target = self.sub_process_main,
1413
args = (request, address)).start()
1415
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2523
1416
""" adds a pipe to the MixIn """
2525
1417
def process_request(self, request, client_address):
2526
1418
"""Overrides and wraps the original process_request().
2528
1420
This function creates a new pipe in self.pipe
2530
1422
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2532
proc = MultiprocessingMixIn.process_request(self, request,
1424
super(MultiprocessingMixInWithPipe,
1425
self).process_request(request, client_address)
2534
1426
self.child_pipe.close()
2535
self.add_pipe(parent_pipe, proc)
1427
self.add_pipe(parent_pipe)
2537
def add_pipe(self, parent_pipe, proc):
1429
def add_pipe(self, parent_pipe):
2538
1430
"""Dummy function; override as necessary"""
2539
raise NotImplementedError()
1431
raise NotImplementedError
2542
1433
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2543
socketserver.TCPServer):
1434
socketserver.TCPServer, object):
2544
1435
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2547
1438
enabled: Boolean; whether this server is activated yet
2548
1439
interface: None or a network interface name (string)
2549
1440
use_ipv6: Boolean; to use IPv6 or not
2552
1442
def __init__(self, server_address, RequestHandlerClass,
2556
"""If socketfd is set, use that file descriptor instead of
2557
creating a new one with socket.socket().
1443
interface=None, use_ipv6=True):
2559
1444
self.interface = interface
2561
1446
self.address_family = socket.AF_INET6
2562
if socketfd is not None:
2563
# Save the file descriptor
2564
self.socketfd = socketfd
2565
# Save the original socket.socket() function
2566
self.socket_socket = socket.socket
2568
# To implement --socket, we monkey patch socket.socket.
2570
# (When socketserver.TCPServer is a new-style class, we
2571
# could make self.socket into a property instead of monkey
2572
# patching socket.socket.)
2574
# Create a one-time-only replacement for socket.socket()
2575
@functools.wraps(socket.socket)
2576
def socket_wrapper(*args, **kwargs):
2577
# Restore original function so subsequent calls are
2579
socket.socket = self.socket_socket
2580
del self.socket_socket
2581
# This time only, return a new socket object from the
2582
# saved file descriptor.
2583
return socket.fromfd(self.socketfd, *args, **kwargs)
2584
# Replace socket.socket() function with wrapper
2585
socket.socket = socket_wrapper
2586
# The socketserver.TCPServer.__init__ will call
2587
# socket.socket(), which might be our replacement,
2588
# socket_wrapper(), if socketfd was set.
2589
1447
socketserver.TCPServer.__init__(self, server_address,
2590
1448
RequestHandlerClass)
2592
1449
def server_bind(self):
2593
1450
"""This overrides the normal server_bind() function
2594
1451
to bind to an interface if one was specified, and also NOT to
2595
1452
bind to an address or port if they were not specified."""
2596
global SO_BINDTODEVICE
2597
1453
if self.interface is not None:
2598
1454
if SO_BINDTODEVICE is None:
2599
# Fall back to a hard-coded value which seems to be
2601
logger.warning("SO_BINDTODEVICE not found, trying 25")
2602
SO_BINDTODEVICE = 25
2604
self.socket.setsockopt(
2605
socket.SOL_SOCKET, SO_BINDTODEVICE,
2606
(self.interface + "\0").encode("utf-8"))
2607
except socket.error as error:
2608
if error.errno == errno.EPERM:
2609
logger.error("No permission to bind to"
2610
" interface %s", self.interface)
2611
elif error.errno == errno.ENOPROTOOPT:
2612
logger.error("SO_BINDTODEVICE not available;"
2613
" cannot bind to interface %s",
2615
elif error.errno == errno.ENODEV:
2616
logger.error("Interface %s does not exist,"
2617
" cannot bind", self.interface)
1455
logger.error("SO_BINDTODEVICE does not exist;"
1456
" cannot bind to interface %s",
1460
self.socket.setsockopt(socket.SOL_SOCKET,
1464
except socket.error as error:
1465
if error[0] == errno.EPERM:
1466
logger.error("No permission to"
1467
" bind to interface %s",
1469
elif error[0] == errno.ENOPROTOOPT:
1470
logger.error("SO_BINDTODEVICE not available;"
1471
" cannot bind to interface %s",
2620
1475
# Only bind(2) the socket if we really need to.
2621
1476
if self.server_address[0] or self.server_address[1]:
2622
if self.server_address[1]:
2623
self.allow_reuse_address = True
2624
1477
if not self.server_address[0]:
2625
1478
if self.address_family == socket.AF_INET6:
2626
any_address = "::" # in6addr_any
1479
any_address = "::" # in6addr_any
2628
any_address = "0.0.0.0" # INADDR_ANY
1481
any_address = socket.INADDR_ANY
2629
1482
self.server_address = (any_address,
2630
1483
self.server_address[1])
2631
1484
elif not self.server_address[1]:
2632
self.server_address = (self.server_address[0], 0)
1485
self.server_address = (self.server_address[0],
2633
1487
# if self.interface:
2634
1488
# self.server_address = (self.server_address[0],
2962
1720
parser.add_argument("--no-dbus", action="store_false",
2963
1721
dest="use_dbus", help="Do not provide D-Bus"
2964
" system bus interface", default=None)
1722
" system bus interface")
2965
1723
parser.add_argument("--no-ipv6", action="store_false",
2966
dest="use_ipv6", help="Do not use IPv6",
2968
parser.add_argument("--no-restore", action="store_false",
2969
dest="restore", help="Do not restore stored"
2970
" state", default=None)
2971
parser.add_argument("--socket", type=int,
2972
help="Specify a file descriptor to a network"
2973
" socket to use instead of creating one")
2974
parser.add_argument("--statedir", metavar="DIR",
2975
help="Directory to save/restore state in")
2976
parser.add_argument("--foreground", action="store_true",
2977
help="Run in foreground", default=None)
2978
parser.add_argument("--no-zeroconf", action="store_false",
2979
dest="zeroconf", help="Do not use Zeroconf",
1724
dest="use_ipv6", help="Do not use IPv6")
2982
1725
options = parser.parse_args()
2984
1732
# Default values for config file for server-global settings
2985
if gnutls.has_rawpk:
2986
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2987
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2989
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2990
":+SIGN-DSA-SHA256")
2991
server_defaults = {"interface": "",
2995
"priority": priority,
2996
"servicename": "Mandos",
3002
"statedir": "/var/lib/mandos",
3003
"foreground": "False",
1733
server_defaults = { "interface": "",
1738
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1739
"servicename": "Mandos",
3008
1745
# Parse config file for server-global settings
3009
server_config = configparser.ConfigParser(server_defaults)
1746
server_config = configparser.SafeConfigParser(server_defaults)
3010
1747
del server_defaults
3011
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3012
# Convert the ConfigParser object to a dict
1748
server_config.read(os.path.join(options.configdir,
1750
# Convert the SafeConfigParser object to a dict
3013
1751
server_settings = server_config.defaults()
3014
1752
# Use the appropriate methods on the non-string config options
3015
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3016
"foreground", "zeroconf"):
1753
for option in ("debug", "use_dbus", "use_ipv6"):
3017
1754
server_settings[option] = server_config.getboolean("DEFAULT",
3019
1756
if server_settings["port"]:
3020
1757
server_settings["port"] = server_config.getint("DEFAULT",
3022
if server_settings["socket"]:
3023
server_settings["socket"] = server_config.getint("DEFAULT",
3025
# Later, stdin will, and stdout and stderr might, be dup'ed
3026
# over with an opened os.devnull. But we don't want this to
3027
# happen with a supplied network socket.
3028
if 0 <= server_settings["socket"] <= 2:
3029
server_settings["socket"] = os.dup(server_settings
3031
1759
del server_config
3033
1761
# Override the settings from the config file with command line
3034
1762
# options, if set.
3035
1763
for option in ("interface", "address", "port", "debug",
3036
"priority", "servicename", "configdir", "use_dbus",
3037
"use_ipv6", "debuglevel", "restore", "statedir",
3038
"socket", "foreground", "zeroconf"):
1764
"priority", "servicename", "configdir",
1765
"use_dbus", "use_ipv6", "debuglevel"):
3039
1766
value = getattr(options, option)
3040
1767
if value is not None:
3041
1768
server_settings[option] = value
3043
1770
# Force all strings to be unicode
3044
1771
for option in server_settings.keys():
3045
if isinstance(server_settings[option], bytes):
3046
server_settings[option] = (server_settings[option]
3048
# Force all boolean options to be boolean
3049
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3050
"foreground", "zeroconf"):
3051
server_settings[option] = bool(server_settings[option])
3052
# Debug implies foreground
3053
if server_settings["debug"]:
3054
server_settings["foreground"] = True
1772
if type(server_settings[option]) is str:
1773
server_settings[option] = unicode(server_settings[option])
3055
1774
# Now we have our good server settings in "server_settings"
3057
1776
##################################################################
3059
if (not server_settings["zeroconf"]
3060
and not (server_settings["port"]
3061
or server_settings["socket"] != "")):
3062
parser.error("Needs port or socket to work without Zeroconf")
3064
1778
# For convenience
3065
1779
debug = server_settings["debug"]
3066
1780
debuglevel = server_settings["debuglevel"]
3067
1781
use_dbus = server_settings["use_dbus"]
3068
1782
use_ipv6 = server_settings["use_ipv6"]
3069
stored_state_path = os.path.join(server_settings["statedir"],
3071
foreground = server_settings["foreground"]
3072
zeroconf = server_settings["zeroconf"]
3075
initlogger(debug, logging.DEBUG)
3080
level = getattr(logging, debuglevel.upper())
3081
initlogger(debug, level)
3083
1784
if server_settings["servicename"] != "Mandos":
3084
syslogger.setFormatter(
3085
logging.Formatter('Mandos ({}) [%(process)d]:'
3086
' %(levelname)s: %(message)s'.format(
3087
server_settings["servicename"])))
1785
syslogger.setFormatter(logging.Formatter
1786
('Mandos (%s) [%%(process)d]:'
1787
' %%(levelname)s: %%(message)s'
1788
% server_settings["servicename"]))
3089
1790
# Parse config file with clients
3090
client_config = configparser.ConfigParser(Client.client_defaults)
1791
client_defaults = { "timeout": "1h",
1793
"checker": "fping -q -- %%(host)s",
1795
"approval_delay": "0s",
1796
"approval_duration": "1s",
1798
client_config = configparser.SafeConfigParser(client_defaults)
3091
1799
client_config.read(os.path.join(server_settings["configdir"],
3092
1800
"clients.conf"))
3094
1802
global mandos_dbus_service
3095
1803
mandos_dbus_service = None
3098
if server_settings["socket"] != "":
3099
socketfd = server_settings["socket"]
3100
tcp_server = MandosServer(
3101
(server_settings["address"], server_settings["port"]),
3103
interface=(server_settings["interface"] or None),
3105
gnutls_priority=server_settings["priority"],
3109
pidfilename = "/run/mandos.pid"
3110
if not os.path.isdir("/run/."):
3111
pidfilename = "/var/run/mandos.pid"
3114
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3115
except IOError as e:
3116
logger.error("Could not open file %r", pidfilename,
3119
for name, group in (("_mandos", "_mandos"),
3120
("mandos", "mandos"),
3121
("nobody", "nogroup")):
3123
uid = pwd.getpwnam(name).pw_uid
3124
gid = pwd.getpwnam(group).pw_gid
1805
tcp_server = MandosServer((server_settings["address"],
1806
server_settings["port"]),
1808
interface=(server_settings["interface"]
1812
server_settings["priority"],
1815
pidfilename = "/var/run/mandos.pid"
1817
pidfile = open(pidfilename, "w")
1819
logger.error("Could not open file %r", pidfilename)
1822
uid = pwd.getpwnam("_mandos").pw_uid
1823
gid = pwd.getpwnam("_mandos").pw_gid
1826
uid = pwd.getpwnam("mandos").pw_uid
1827
gid = pwd.getpwnam("mandos").pw_gid
3126
1828
except KeyError:
1830
uid = pwd.getpwnam("nobody").pw_uid
1831
gid = pwd.getpwnam("nobody").pw_gid
3135
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3137
1838
except OSError as error:
3138
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3139
.format(uid, gid, os.strerror(error.errno)))
3140
if error.errno != errno.EPERM:
1839
if error[0] != errno.EPERM:
1842
if not debug and not debuglevel:
1843
syslogger.setLevel(logging.WARNING)
1844
console.setLevel(logging.WARNING)
1846
level = getattr(logging, debuglevel.upper())
1847
syslogger.setLevel(level)
1848
console.setLevel(level)
3144
1851
# Enable all possible GnuTLS debugging
3146
1853
# "Use a log level over 10 to enable all debugging options."
3147
1854
# - GnuTLS manual
3148
gnutls.global_set_log_level(11)
1855
gnutls.library.functions.gnutls_global_set_log_level(11)
1857
@gnutls.library.types.gnutls_log_func
3151
1858
def debug_gnutls(level, string):
3152
1859
logger.debug("GnuTLS: %s", string[:-1])
3154
gnutls.global_set_log_function(debug_gnutls)
1861
(gnutls.library.functions
1862
.gnutls_global_set_log_function(debug_gnutls))
3156
1864
# Redirect stdin so all checkers get /dev/null
3157
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1865
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3158
1866
os.dup2(null, sys.stdin.fileno())
1870
# No console logging
1871
logger.removeHandler(console)
3162
1873
# Need to fork before connecting to D-Bus
3164
1875
# Close all input and output, do double fork, etc.
3167
if gi.version_info < (3, 10, 2):
3168
# multiprocessing will use threads, so before we use GLib we
3169
# need to inform GLib that threads will be used.
3172
1878
global main_loop
3173
1879
# From the Avahi example code
3174
DBusGMainLoop(set_as_default=True)
3175
main_loop = GLib.MainLoop()
1880
DBusGMainLoop(set_as_default=True )
1881
main_loop = gobject.MainLoop()
3176
1882
bus = dbus.SystemBus()
3177
1883
# End of Avahi example code
3180
bus_name = dbus.service.BusName("se.recompile.Mandos",
3183
old_bus_name = dbus.service.BusName(
3184
"se.bsnet.fukt.Mandos", bus,
3186
except dbus.exceptions.DBusException as e:
3187
logger.error("Disabling D-Bus:", exc_info=e)
1886
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1887
bus, do_not_queue=True)
1888
except dbus.exceptions.NameExistsException as e:
1889
logger.error(unicode(e) + ", disabling D-Bus")
3188
1890
use_dbus = False
3189
1891
server_settings["use_dbus"] = False
3190
1892
tcp_server.use_dbus = False
3192
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3193
service = AvahiServiceToSyslog(
3194
name=server_settings["servicename"],
3195
servicetype="_mandos._tcp",
3198
if server_settings["interface"]:
3199
service.interface = if_nametoindex(
3200
server_settings["interface"].encode("utf-8"))
1893
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1894
service = AvahiService(name = server_settings["servicename"],
1895
servicetype = "_mandos._tcp",
1896
protocol = protocol, bus = bus)
1897
if server_settings["interface"]:
1898
service.interface = (if_nametoindex
1899
(str(server_settings["interface"])))
3202
1901
global multiprocessing_manager
3203
1902
multiprocessing_manager = multiprocessing.Manager()
3205
1904
client_class = Client
3207
client_class = functools.partial(ClientDBus, bus=bus)
3209
client_settings = Client.config_parser(client_config)
3210
old_client_settings = {}
3213
# This is used to redirect stdout and stderr for checker processes
3215
wnull = open(os.devnull, "w") # A writable /dev/null
3216
# Only used if server is running in foreground but not in debug
3218
if debug or not foreground:
3221
# Get client data and settings from last running state.
3222
if server_settings["restore"]:
3224
with open(stored_state_path, "rb") as stored_state:
3225
if sys.version_info.major == 2:
3226
clients_data, old_client_settings = pickle.load(
3229
bytes_clients_data, bytes_old_client_settings = (
3230
pickle.load(stored_state, encoding="bytes"))
3231
# Fix bytes to strings
3234
clients_data = {(key.decode("utf-8")
3235
if isinstance(key, bytes)
3238
bytes_clients_data.items()}
3239
del bytes_clients_data
3240
for key in clients_data:
3241
value = {(k.decode("utf-8")
3242
if isinstance(k, bytes) else k): v
3244
clients_data[key].items()}
3245
clients_data[key] = value
3247
value["client_structure"] = [
3249
if isinstance(s, bytes)
3251
value["client_structure"]]
3252
# .name, .host, and .checker_command
3253
for k in ("name", "host", "checker_command"):
3254
if isinstance(value[k], bytes):
3255
value[k] = value[k].decode("utf-8")
3256
if "key_id" not in value:
3257
value["key_id"] = ""
3258
elif "fingerprint" not in value:
3259
value["fingerprint"] = ""
3260
# old_client_settings
3262
old_client_settings = {
3263
(key.decode("utf-8")
3264
if isinstance(key, bytes)
3267
bytes_old_client_settings.items()}
3268
del bytes_old_client_settings
3269
# .host and .checker_command
3270
for value in old_client_settings.values():
3271
for attribute in ("host", "checker_command"):
3272
if isinstance(value[attribute], bytes):
3273
value[attribute] = (value[attribute]
3275
os.remove(stored_state_path)
3276
except IOError as e:
3277
if e.errno == errno.ENOENT:
3278
logger.warning("Could not load persistent state:"
3279
" {}".format(os.strerror(e.errno)))
3281
logger.critical("Could not load persistent state:",
3284
except EOFError as e:
3285
logger.warning("Could not load persistent state: "
3289
with PGPEngine() as pgp:
3290
for client_name, client in clients_data.items():
3291
# Skip removed clients
3292
if client_name not in client_settings:
3295
# Decide which value to use after restoring saved state.
3296
# We have three different values: Old config file,
3297
# new config file, and saved state.
3298
# New config value takes precedence if it differs from old
3299
# config value, otherwise use saved state.
3300
for name, value in client_settings[client_name].items():
3302
# For each value in new config, check if it
3303
# differs from the old config value (Except for
3304
# the "secret" attribute)
3305
if (name != "secret"
3307
old_client_settings[client_name][name])):
3308
client[name] = value
3312
# Clients who has passed its expire date can still be
3313
# enabled if its last checker was successful. A Client
3314
# whose checker succeeded before we stored its state is
3315
# assumed to have successfully run all checkers during
3317
if client["enabled"]:
3318
if datetime.datetime.utcnow() >= client["expires"]:
3319
if not client["last_checked_ok"]:
3321
"disabling client {} - Client never "
3322
"performed a successful checker".format(
3324
client["enabled"] = False
3325
elif client["last_checker_status"] != 0:
3327
"disabling client {} - Client last"
3328
" checker failed with error code"
3331
client["last_checker_status"]))
3332
client["enabled"] = False
3334
client["expires"] = (
3335
datetime.datetime.utcnow()
3336
+ client["timeout"])
3337
logger.debug("Last checker succeeded,"
3338
" keeping {} enabled".format(
1906
client_class = functools.partial(ClientDBus, bus = bus)
1907
def client_config_items(config, section):
1908
special_settings = {
1909
"approved_by_default":
1910
lambda: config.getboolean(section,
1911
"approved_by_default"),
1913
for name, value in config.items(section):
3341
client["secret"] = pgp.decrypt(
3342
client["encrypted_secret"],
3343
client_settings[client_name]["secret"])
3345
# If decryption fails, we use secret from new settings
3346
logger.debug("Failed to decrypt {} old secret".format(
3348
client["secret"] = (client_settings[client_name]
3351
# Add/remove clients based on new changes made to config
3352
for client_name in (set(old_client_settings)
3353
- set(client_settings)):
3354
del clients_data[client_name]
3355
for client_name in (set(client_settings)
3356
- set(old_client_settings)):
3357
clients_data[client_name] = client_settings[client_name]
3359
# Create all client objects
3360
for client_name, client in clients_data.items():
3361
tcp_server.clients[client_name] = client_class(
3364
server_settings=server_settings)
1915
yield (name, special_settings[name]())
1919
tcp_server.clients.update(set(
1920
client_class(name = section,
1921
config= dict(client_config_items(
1922
client_config, section)))
1923
for section in client_config.sections()))
3366
1924
if not tcp_server.clients:
3367
1925
logger.warning("No clients defined")
3370
if pidfile is not None:
3374
print(pid, file=pidfile)
3376
logger.error("Could not write to file %r with PID %d",
1931
pidfile.write(str(pid) + "\n".encode("utf-8"))
1934
logger.error("Could not write to file %r with PID %d",
1937
# "pidfile" was never created
3379
1939
del pidfilename
3381
for termsig in (signal.SIGHUP, signal.SIGTERM):
3382
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3383
lambda: main_loop.quit() and False)
1941
signal.signal(signal.SIGINT, signal.SIG_IGN)
1943
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1944
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3387
@alternate_dbus_interfaces(
3388
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3389
class MandosDBusService(DBusObjectWithObjectManager):
1947
class MandosDBusService(dbus.service.Object):
3390
1948
"""A D-Bus proxy object"""
3392
1949
def __init__(self):
3393
1950
dbus.service.Object.__init__(self, bus, "/")
3395
_interface = "se.recompile.Mandos"
1951
_interface = "se.bsnet.fukt.Mandos"
3397
1953
@dbus.service.signal(_interface, signature="o")
3398
1954
def ClientAdded(self, objpath):
3402
1958
@dbus.service.signal(_interface, signature="ss")
3403
def ClientNotFound(self, key_id, address):
1959
def ClientNotFound(self, fingerprint, address):
3407
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3409
1963
@dbus.service.signal(_interface, signature="os")
3410
1964
def ClientRemoved(self, objpath, name):
3414
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3416
1968
@dbus.service.method(_interface, out_signature="ao")
3417
1969
def GetAllClients(self):
3419
return dbus.Array(c.dbus_object_path for c in
3420
tcp_server.clients.values())
3422
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1971
return dbus.Array(c.dbus_object_path
1972
for c in tcp_server.clients)
3424
1974
@dbus.service.method(_interface,
3425
1975
out_signature="a{oa{sv}}")
3426
1976
def GetAllClientsWithProperties(self):
3428
1978
return dbus.Dictionary(
3429
{c.dbus_object_path: c.GetAll(
3430
"se.recompile.Mandos.Client")
3431
for c in tcp_server.clients.values()},
1979
((c.dbus_object_path, c.GetAll(""))
1980
for c in tcp_server.clients),
3432
1981
signature="oa{sv}")
3434
1983
@dbus.service.method(_interface, in_signature="o")
3435
1984
def RemoveClient(self, object_path):
3437
for c in tcp_server.clients.values():
1986
for c in tcp_server.clients:
3438
1987
if c.dbus_object_path == object_path:
3439
del tcp_server.clients[c.name]
1988
tcp_server.clients.remove(c)
3440
1989
c.remove_from_connection()
3441
# Don't signal the disabling
1990
# Don't signal anything except ClientRemoved
3442
1991
c.disable(quiet=True)
3443
# Emit D-Bus signal for removal
3444
self.client_removed_signal(c)
1993
self.ClientRemoved(object_path, c.name)
3446
1995
raise KeyError(object_path)
3450
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3451
out_signature="a{oa{sa{sv}}}")
3452
def GetManagedObjects(self):
3454
return dbus.Dictionary(
3455
{client.dbus_object_path:
3457
{interface: client.GetAll(interface)
3459
client._get_all_interface_names()})
3460
for client in tcp_server.clients.values()})
3462
def client_added_signal(self, client):
3463
"""Send the new standard signal and the old signal"""
3465
# New standard signal
3466
self.InterfacesAdded(
3467
client.dbus_object_path,
3469
{interface: client.GetAll(interface)
3471
client._get_all_interface_names()}))
3473
self.ClientAdded(client.dbus_object_path)
3475
def client_removed_signal(self, client):
3476
"""Send the new standard signal and the old signal"""
3478
# New standard signal
3479
self.InterfacesRemoved(
3480
client.dbus_object_path,
3481
client._get_all_interface_names())
3483
self.ClientRemoved(client.dbus_object_path,
3486
1999
mandos_dbus_service = MandosDBusService()
3488
# Save modules to variables to exempt the modules from being
3489
# unloaded before the function registered with atexit() is run.
3490
mp = multiprocessing
3494
2002
"Cleanup function; run on exit"
3498
mp.active_children()
3500
if not (tcp_server.clients or client_settings):
3503
# Store client before exiting. Secrets are encrypted with key
3504
# based on what config file has. If config file is
3505
# removed/edited, old secret will thus be unrecovable.
3507
with PGPEngine() as pgp:
3508
for client in tcp_server.clients.values():
3509
key = client_settings[client.name]["secret"]
3510
client.encrypted_secret = pgp.encrypt(client.secret,
3514
# A list of attributes that can not be pickled
3516
exclude = {"bus", "changedstate", "secret",
3517
"checker", "server_settings"}
3518
for name, typ in inspect.getmembers(dbus.service
3522
client_dict["encrypted_secret"] = (client
3524
for attr in client.client_structure:
3525
if attr not in exclude:
3526
client_dict[attr] = getattr(client, attr)
3528
clients[client.name] = client_dict
3529
del client_settings[client.name]["secret"]
3532
with tempfile.NamedTemporaryFile(
3536
dir=os.path.dirname(stored_state_path),
3537
delete=False) as stored_state:
3538
pickle.dump((clients, client_settings), stored_state,
3540
tempname = stored_state.name
3541
os.rename(tempname, stored_state_path)
3542
except (IOError, OSError) as e:
3548
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3549
logger.warning("Could not save persistent state: {}"
3550
.format(os.strerror(e.errno)))
3552
logger.warning("Could not save persistent state:",
3556
# Delete all clients, and settings from config
3557
2005
while tcp_server.clients:
3558
name, client = tcp_server.clients.popitem()
2006
client = tcp_server.clients.pop()
3560
2008
client.remove_from_connection()
3561
# Don't signal the disabling
2009
client.disable_hook = None
2010
# Don't signal anything except ClientRemoved
3562
2011
client.disable(quiet=True)
3563
# Emit D-Bus signal for removal
3565
mandos_dbus_service.client_removed_signal(client)
3566
client_settings.clear()
2014
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3568
2017
atexit.register(cleanup)
3570
for client in tcp_server.clients.values():
2019
for client in tcp_server.clients:
3572
# Emit D-Bus signal for adding
3573
mandos_dbus_service.client_added_signal(client)
3574
# Need to initiate checking of clients
3576
client.init_checker()
2022
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3578
2025
tcp_server.enable()
3579
2026
tcp_server.server_activate()
3581
2028
# Find out what port we got
3583
service.port = tcp_server.socket.getsockname()[1]
2029
service.port = tcp_server.socket.getsockname()[1]
3585
2031
logger.info("Now listening on address %r, port %d,"
3586
" flowinfo %d, scope_id %d",
3587
*tcp_server.socket.getsockname())
2032
" flowinfo %d, scope_id %d"
2033
% tcp_server.socket.getsockname())
3589
logger.info("Now listening on address %r, port %d",
3590
*tcp_server.socket.getsockname())
3592
# service.interface = tcp_server.socket.getsockname()[3]
2035
logger.info("Now listening on address %r, port %d"
2036
% tcp_server.socket.getsockname())
2038
#service.interface = tcp_server.socket.getsockname()[3]
3596
# From the Avahi example code
3599
except dbus.exceptions.DBusException as error:
3600
logger.critical("D-Bus Exception", exc_info=error)
3603
# End of Avahi example code
3606
GLib.IOChannel.unix_new(tcp_server.fileno()),
3607
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3608
lambda *args, **kwargs: (tcp_server.handle_request
3609
(*args[2:], **kwargs) or True))
2041
# From the Avahi example code
2044
except dbus.exceptions.DBusException as error:
2045
logger.critical("DBusException: %s", error)
2048
# End of Avahi example code
2050
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2051
lambda *args, **kwargs:
2052
(tcp_server.handle_request
2053
(*args[2:], **kwargs) or True))
3611
2055
logger.debug("Starting main loop")
3612
2056
main_loop.run()
3613
2057
except AvahiError as error:
3614
logger.critical("Avahi Error", exc_info=error)
2058
logger.critical("AvahiError: %s", error)
3617
2061
except KeyboardInterrupt: