63
import cPickle as pickle
70
import cPickle as pickle
64
73
import multiprocessing
68
83
import dbus.service
85
from gi.repository import GLib
71
86
from dbus.mainloop.glib import DBusGMainLoop
74
89
import xml.dom.minidom
92
if sys.version_info.major == 2:
95
# Show warnings by default
96
if not sys.warnoptions:
98
warnings.simplefilter("default")
100
# Try to find the value of SO_BINDTODEVICE:
102
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
103
# newer, and it is also the most natural place for it:
78
104
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
79
105
except AttributeError:
107
# This is where SO_BINDTODEVICE was up to and including Python
81
109
from IN import SO_BINDTODEVICE
82
110
except ImportError:
83
SO_BINDTODEVICE = None
88
#logger = logging.getLogger('mandos')
89
logger = logging.Logger('mandos')
90
syslogger = (logging.handlers.SysLogHandler
91
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
address = str("/dev/log")))
93
syslogger.setFormatter(logging.Formatter
94
('Mandos [%(process)d]: %(levelname)s:'
96
logger.addHandler(syslogger)
98
console = logging.StreamHandler()
99
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
102
logger.addHandler(console)
111
# In Python 2.7 it seems to have been removed entirely.
112
# Try running the C preprocessor:
114
cc = subprocess.Popen(["cc", "--language=c", "-E",
116
stdin=subprocess.PIPE,
117
stdout=subprocess.PIPE)
118
stdout = cc.communicate(
119
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
120
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
121
except (OSError, ValueError, IndexError):
123
SO_BINDTODEVICE = None
125
if sys.version_info.major == 2:
128
if sys.version_info < (3, 2):
129
configparser.Configparser = configparser.SafeConfigParser
132
stored_state_file = "clients.pickle"
134
logger = logging.getLogger()
135
logging.captureWarnings(True) # Show warnings via the logging system
139
if_nametoindex = ctypes.cdll.LoadLibrary(
140
ctypes.util.find_library("c")).if_nametoindex
141
except (OSError, AttributeError):
143
def if_nametoindex(interface):
144
"Get an interface index the hard way, i.e. using fcntl()"
145
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
146
with contextlib.closing(socket.socket()) as s:
147
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
148
struct.pack(b"16s16x", interface))
149
interface_index = struct.unpack("I", ifreq[16:20])[0]
150
return interface_index
153
def copy_function(func):
154
"""Make a copy of a function"""
155
if sys.version_info.major == 2:
156
return types.FunctionType(func.func_code,
162
return types.FunctionType(func.__code__,
169
def initlogger(debug, level=logging.WARNING):
170
"""init logger and add loglevel"""
173
syslogger = (logging.handlers.SysLogHandler(
174
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
176
syslogger.setFormatter(logging.Formatter
177
('Mandos [%(process)d]: %(levelname)s:'
179
logger.addHandler(syslogger)
182
console = logging.StreamHandler()
183
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
187
logger.addHandler(console)
188
logger.setLevel(level)
191
class PGPError(Exception):
192
"""Exception if encryption/decryption fails"""
197
"""A simple class for OpenPGP symmetric encryption & decryption"""
200
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
203
output = subprocess.check_output(["gpgconf"])
204
for line in output.splitlines():
205
name, text, path = line.split(b":")
210
if e.errno != errno.ENOENT:
212
self.gnupgargs = ['--batch',
213
'--homedir', self.tempdir,
216
# Only GPG version 1 has the --no-use-agent option.
217
if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
218
self.gnupgargs.append("--no-use-agent")
223
def __exit__(self, exc_type, exc_value, traceback):
231
if self.tempdir is not None:
232
# Delete contents of tempdir
233
for root, dirs, files in os.walk(self.tempdir,
235
for filename in files:
236
os.remove(os.path.join(root, filename))
238
os.rmdir(os.path.join(root, dirname))
240
os.rmdir(self.tempdir)
243
def password_encode(self, password):
244
# Passphrase can not be empty and can not contain newlines or
245
# NUL bytes. So we prefix it and hex encode it.
246
encoded = b"mandos" + binascii.hexlify(password)
247
if len(encoded) > 2048:
248
# GnuPG can't handle long passwords, so encode differently
249
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
250
.replace(b"\n", b"\\n")
251
.replace(b"\0", b"\\x00"))
254
def encrypt(self, data, password):
255
passphrase = self.password_encode(password)
256
with tempfile.NamedTemporaryFile(
257
dir=self.tempdir) as passfile:
258
passfile.write(passphrase)
260
proc = subprocess.Popen([self.gpg, '--symmetric',
264
stdin=subprocess.PIPE,
265
stdout=subprocess.PIPE,
266
stderr=subprocess.PIPE)
267
ciphertext, err = proc.communicate(input=data)
268
if proc.returncode != 0:
272
def decrypt(self, data, password):
273
passphrase = self.password_encode(password)
274
with tempfile.NamedTemporaryFile(
275
dir=self.tempdir) as passfile:
276
passfile.write(passphrase)
278
proc = subprocess.Popen([self.gpg, '--decrypt',
282
stdin=subprocess.PIPE,
283
stdout=subprocess.PIPE,
284
stderr=subprocess.PIPE)
285
decrypted_plaintext, err = proc.communicate(input=data)
286
if proc.returncode != 0:
288
return decrypted_plaintext
291
# Pretend that we have an Avahi module
293
"""This isn't so much a class as it is a module-like namespace."""
294
IF_UNSPEC = -1 # avahi-common/address.h
295
PROTO_UNSPEC = -1 # avahi-common/address.h
296
PROTO_INET = 0 # avahi-common/address.h
297
PROTO_INET6 = 1 # avahi-common/address.h
298
DBUS_NAME = "org.freedesktop.Avahi"
299
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
300
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
301
DBUS_PATH_SERVER = "/"
304
def string_array_to_txt_array(t):
305
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
306
for s in t), signature="ay")
307
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
308
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
309
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
310
SERVER_INVALID = 0 # avahi-common/defs.h
311
SERVER_REGISTERING = 1 # avahi-common/defs.h
312
SERVER_RUNNING = 2 # avahi-common/defs.h
313
SERVER_COLLISION = 3 # avahi-common/defs.h
314
SERVER_FAILURE = 4 # avahi-common/defs.h
104
317
class AvahiError(Exception):
105
318
def __init__(self, value, *args, **kwargs):
106
319
self.value = value
107
super(AvahiError, self).__init__(value, *args, **kwargs)
108
def __unicode__(self):
109
return unicode(repr(self.value))
320
return super(AvahiError, self).__init__(value, *args,
111
324
class AvahiServiceError(AvahiError):
114
328
class AvahiGroupError(AvahiError):
118
class AvahiService(object):
119
333
"""An Avahi (Zeroconf) service.
122
336
interface: integer; avahi.IF_UNSPEC or an interface index.
123
337
Used to optionally bind to the specified interface.
124
338
name: string; Example: 'Mandos'
125
339
type: string; Example: '_mandos._tcp'.
126
See <http://www.dns-sd.org/ServiceTypes.html>
340
See <https://www.iana.org/assignments/service-names-port-numbers>
127
341
port: integer; what port to announce
128
342
TXT: list of strings; TXT record for the service
129
343
domain: string; Domain to publish on, default to .local if empty.
262
502
follow_name_owner_changes=True),
263
503
avahi.DBUS_INTERFACE_SERVER)
264
504
self.server.connect_to_signal("StateChanged",
265
self.server_state_changed)
505
self.server_state_changed)
266
506
self.server_state_changed(self.server.GetState())
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
275
class Client(object):
509
class AvahiServiceToSyslog(AvahiService):
510
def rename(self, *args, **kwargs):
511
"""Add the new name to the syslog messages"""
512
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
513
syslogger.setFormatter(logging.Formatter(
514
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
519
# Pretend that we have a GnuTLS module
521
"""This isn't so much a class as it is a module-like namespace."""
523
library = ctypes.util.find_library("gnutls")
525
library = ctypes.util.find_library("gnutls-deb0")
526
_library = ctypes.cdll.LoadLibrary(library)
529
# Unless otherwise indicated, the constants and types below are
530
# all from the gnutls/gnutls.h C header file.
541
E_NO_CERTIFICATE_FOUND = -49
546
KEYID_USE_SHA256 = 1 # gnutls/x509.h
547
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
550
class session_int(ctypes.Structure):
552
session_t = ctypes.POINTER(session_int)
554
class certificate_credentials_st(ctypes.Structure):
556
certificate_credentials_t = ctypes.POINTER(
557
certificate_credentials_st)
558
certificate_type_t = ctypes.c_int
560
class datum_t(ctypes.Structure):
561
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
562
('size', ctypes.c_uint)]
564
class openpgp_crt_int(ctypes.Structure):
566
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
567
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
568
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
569
credentials_type_t = ctypes.c_int
570
transport_ptr_t = ctypes.c_void_p
571
close_request_t = ctypes.c_int
574
class Error(Exception):
575
def __init__(self, message=None, code=None, args=()):
576
# Default usage is by a message string, but if a return
577
# code is passed, convert it to a string with
580
if message is None and code is not None:
581
message = gnutls.strerror(code)
582
return super(gnutls.Error, self).__init__(
585
class CertificateSecurityError(Error):
591
self._c_object = gnutls.certificate_credentials_t()
592
gnutls.certificate_allocate_credentials(
593
ctypes.byref(self._c_object))
594
self.type = gnutls.CRD_CERTIFICATE
597
gnutls.certificate_free_credentials(self._c_object)
600
def __init__(self, socket, credentials=None):
601
self._c_object = gnutls.session_t()
602
gnutls_flags = gnutls.CLIENT
603
if gnutls.check_version(b"3.5.6"):
604
gnutls_flags |= gnutls.NO_TICKETS
606
gnutls_flags |= gnutls.ENABLE_RAWPK
607
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
609
gnutls.set_default_priority(self._c_object)
610
gnutls.transport_set_ptr(self._c_object, socket.fileno())
611
gnutls.handshake_set_private_extensions(self._c_object,
614
if credentials is None:
615
credentials = gnutls.Credentials()
616
gnutls.credentials_set(self._c_object, credentials.type,
617
ctypes.cast(credentials._c_object,
619
self.credentials = credentials
622
gnutls.deinit(self._c_object)
625
return gnutls.handshake(self._c_object)
627
def send(self, data):
631
data_len -= gnutls.record_send(self._c_object,
636
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
638
# Error handling functions
639
def _error_code(result):
640
"""A function to raise exceptions on errors, suitable
641
for the 'restype' attribute on ctypes functions"""
644
if result == gnutls.E_NO_CERTIFICATE_FOUND:
645
raise gnutls.CertificateSecurityError(code=result)
646
raise gnutls.Error(code=result)
648
def _retry_on_error(result, func, arguments):
649
"""A function to retry on some errors, suitable
650
for the 'errcheck' attribute on ctypes functions"""
652
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
653
return _error_code(result)
654
result = func(*arguments)
657
# Unless otherwise indicated, the function declarations below are
658
# all from the gnutls/gnutls.h C header file.
661
priority_set_direct = _library.gnutls_priority_set_direct
662
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
663
ctypes.POINTER(ctypes.c_char_p)]
664
priority_set_direct.restype = _error_code
666
init = _library.gnutls_init
667
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
668
init.restype = _error_code
670
set_default_priority = _library.gnutls_set_default_priority
671
set_default_priority.argtypes = [session_t]
672
set_default_priority.restype = _error_code
674
record_send = _library.gnutls_record_send
675
record_send.argtypes = [session_t, ctypes.c_void_p,
677
record_send.restype = ctypes.c_ssize_t
678
record_send.errcheck = _retry_on_error
680
certificate_allocate_credentials = (
681
_library.gnutls_certificate_allocate_credentials)
682
certificate_allocate_credentials.argtypes = [
683
ctypes.POINTER(certificate_credentials_t)]
684
certificate_allocate_credentials.restype = _error_code
686
certificate_free_credentials = (
687
_library.gnutls_certificate_free_credentials)
688
certificate_free_credentials.argtypes = [
689
certificate_credentials_t]
690
certificate_free_credentials.restype = None
692
handshake_set_private_extensions = (
693
_library.gnutls_handshake_set_private_extensions)
694
handshake_set_private_extensions.argtypes = [session_t,
696
handshake_set_private_extensions.restype = None
698
credentials_set = _library.gnutls_credentials_set
699
credentials_set.argtypes = [session_t, credentials_type_t,
701
credentials_set.restype = _error_code
703
strerror = _library.gnutls_strerror
704
strerror.argtypes = [ctypes.c_int]
705
strerror.restype = ctypes.c_char_p
707
certificate_type_get = _library.gnutls_certificate_type_get
708
certificate_type_get.argtypes = [session_t]
709
certificate_type_get.restype = _error_code
711
certificate_get_peers = _library.gnutls_certificate_get_peers
712
certificate_get_peers.argtypes = [session_t,
713
ctypes.POINTER(ctypes.c_uint)]
714
certificate_get_peers.restype = ctypes.POINTER(datum_t)
716
global_set_log_level = _library.gnutls_global_set_log_level
717
global_set_log_level.argtypes = [ctypes.c_int]
718
global_set_log_level.restype = None
720
global_set_log_function = _library.gnutls_global_set_log_function
721
global_set_log_function.argtypes = [log_func]
722
global_set_log_function.restype = None
724
deinit = _library.gnutls_deinit
725
deinit.argtypes = [session_t]
726
deinit.restype = None
728
handshake = _library.gnutls_handshake
729
handshake.argtypes = [session_t]
730
handshake.restype = _error_code
731
handshake.errcheck = _retry_on_error
733
transport_set_ptr = _library.gnutls_transport_set_ptr
734
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
735
transport_set_ptr.restype = None
737
bye = _library.gnutls_bye
738
bye.argtypes = [session_t, close_request_t]
739
bye.restype = _error_code
740
bye.errcheck = _retry_on_error
742
check_version = _library.gnutls_check_version
743
check_version.argtypes = [ctypes.c_char_p]
744
check_version.restype = ctypes.c_char_p
746
_need_version = b"3.3.0"
747
if check_version(_need_version) is None:
748
raise self.Error("Needs GnuTLS {} or later"
749
.format(_need_version))
751
_tls_rawpk_version = b"3.6.6"
752
has_rawpk = bool(check_version(_tls_rawpk_version))
756
class pubkey_st(ctypes.Structure):
758
pubkey_t = ctypes.POINTER(pubkey_st)
760
x509_crt_fmt_t = ctypes.c_int
762
# All the function declarations below are from gnutls/abstract.h
763
pubkey_init = _library.gnutls_pubkey_init
764
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
765
pubkey_init.restype = _error_code
767
pubkey_import = _library.gnutls_pubkey_import
768
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
770
pubkey_import.restype = _error_code
772
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
773
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
774
ctypes.POINTER(ctypes.c_ubyte),
775
ctypes.POINTER(ctypes.c_size_t)]
776
pubkey_get_key_id.restype = _error_code
778
pubkey_deinit = _library.gnutls_pubkey_deinit
779
pubkey_deinit.argtypes = [pubkey_t]
780
pubkey_deinit.restype = None
782
# All the function declarations below are from gnutls/openpgp.h
784
openpgp_crt_init = _library.gnutls_openpgp_crt_init
785
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
786
openpgp_crt_init.restype = _error_code
788
openpgp_crt_import = _library.gnutls_openpgp_crt_import
789
openpgp_crt_import.argtypes = [openpgp_crt_t,
790
ctypes.POINTER(datum_t),
792
openpgp_crt_import.restype = _error_code
794
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
795
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
796
ctypes.POINTER(ctypes.c_uint)]
797
openpgp_crt_verify_self.restype = _error_code
799
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
800
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
801
openpgp_crt_deinit.restype = None
803
openpgp_crt_get_fingerprint = (
804
_library.gnutls_openpgp_crt_get_fingerprint)
805
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
809
openpgp_crt_get_fingerprint.restype = _error_code
811
if check_version(b"3.6.4"):
812
certificate_type_get2 = _library.gnutls_certificate_type_get2
813
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
814
certificate_type_get2.restype = _error_code
816
# Remove non-public functions
817
del _error_code, _retry_on_error
820
def call_pipe(connection, # : multiprocessing.Connection
821
func, *args, **kwargs):
822
"""This function is meant to be called by multiprocessing.Process
824
This function runs func(*args, **kwargs), and writes the resulting
825
return value on the provided multiprocessing.Connection.
827
connection.send(func(*args, **kwargs))
276
832
"""A representation of a client host served by this server.
279
_approved: bool(); 'None' if not yet approved/disapproved
835
approved: bool(); 'None' if not yet approved/disapproved
280
836
approval_delay: datetime.timedelta(); Time to wait for approval
281
837
approval_duration: datetime.timedelta(); Duration of one approval
282
checker: subprocess.Popen(); a running checker process used
283
to see if the client lives.
284
'None' if no process is running.
285
checker_callback_tag: a gobject event source tag, or None
838
checker: multiprocessing.Process(); a running checker process used
839
to see if the client lives. 'None' if no process is
841
checker_callback_tag: a GLib event source tag, or None
286
842
checker_command: string; External command which is run to check
287
843
if client lives. %() expansions are done at
288
844
runtime with vars(self) as dict, so that for
289
845
instance %(name)s can be used in the command.
290
checker_initiator_tag: a gobject event source tag, or None
846
checker_initiator_tag: a GLib event source tag, or None
291
847
created: datetime.datetime(); (UTC) object creation
848
client_structure: Object describing what attributes a client has
849
and is used for storing the client at exit
292
850
current_checker_command: string; current running checker_command
293
disable_hook: If set, called by disable() as disable_hook(self)
294
disable_initiator_tag: a gobject event source tag, or None
851
disable_initiator_tag: a GLib event source tag, or None
296
853
fingerprint: string (40 or 32 hexadecimal digits); used to
297
uniquely identify the client
854
uniquely identify an OpenPGP client
855
key_id: string (64 hexadecimal digits); used to uniquely identify
856
a client using raw public keys
298
857
host: string; available for use by the checker command
299
858
interval: datetime.timedelta(); How often to start a new checker
300
859
last_approval_request: datetime.datetime(); (UTC) or None
301
860
last_checked_ok: datetime.datetime(); (UTC) or None
302
last_enabled: datetime.datetime(); (UTC)
861
last_checker_status: integer between 0 and 255 reflecting exit
862
status of last checker. -1 reflects crashed
863
checker, -2 means no checker completed yet.
864
last_checker_signal: The signal which killed the last checker, if
865
last_checker_status is -1
866
last_enabled: datetime.datetime(); (UTC) or None
303
867
name: string; from the config file, used in log messages and
304
868
D-Bus identifiers
305
869
secret: bytestring; sent verbatim (over TLS) to client
306
870
timeout: datetime.timedelta(); How long from last_checked_ok
307
871
until this client is disabled
308
extended_timeout: extra long timeout when password has been sent
872
extended_timeout: extra long timeout when secret has been sent
309
873
runtime_expansions: Allowed attributes for runtime expansion.
310
874
expires: datetime.datetime(); time (UTC) when a client will be
311
875
disabled, or None
876
server_settings: The server_settings dict from main()
314
879
runtime_expansions = ("approval_delay", "approval_duration",
315
"created", "enabled", "fingerprint",
316
"host", "interval", "last_checked_ok",
880
"created", "enabled", "expires", "key_id",
881
"fingerprint", "host", "interval",
882
"last_approval_request", "last_checked_ok",
317
883
"last_enabled", "name", "timeout")
319
def timeout_milliseconds(self):
320
"Return the 'timeout' attribute in milliseconds"
321
return _timedelta_to_milliseconds(self.timeout)
323
def extended_timeout_milliseconds(self):
324
"Return the 'extended_timeout' attribute in milliseconds"
325
return _timedelta_to_milliseconds(self.extended_timeout)
327
def interval_milliseconds(self):
328
"Return the 'interval' attribute in milliseconds"
329
return _timedelta_to_milliseconds(self.interval)
331
def approval_delay_milliseconds(self):
332
return _timedelta_to_milliseconds(self.approval_delay)
334
def __init__(self, name = None, disable_hook=None, config=None):
335
"""Note: the 'checker' key in 'config' sets the
336
'checker_command' attribute and *not* the 'checker'
886
"extended_timeout": "PT15M",
888
"checker": "fping -q -- %%(host)s",
890
"approval_delay": "PT0S",
891
"approval_duration": "PT1S",
892
"approved_by_default": "True",
897
def config_parser(config):
898
"""Construct a new dict of client settings of this form:
899
{ client_name: {setting_name: value, ...}, ...}
900
with exceptions for any special settings as defined above.
901
NOTE: Must be a pure function. Must return the same result
902
value given the same arguments.
905
for client_name in config.sections():
906
section = dict(config.items(client_name))
907
client = settings[client_name] = {}
909
client["host"] = section["host"]
910
# Reformat values from string types to Python types
911
client["approved_by_default"] = config.getboolean(
912
client_name, "approved_by_default")
913
client["enabled"] = config.getboolean(client_name,
916
# Uppercase and remove spaces from key_id and fingerprint
917
# for later comparison purposes with return value from the
918
# key_id() and fingerprint() functions
919
client["key_id"] = (section.get("key_id", "").upper()
921
client["fingerprint"] = (section["fingerprint"].upper()
923
if "secret" in section:
924
client["secret"] = codecs.decode(section["secret"]
927
elif "secfile" in section:
928
with open(os.path.expanduser(os.path.expandvars
929
(section["secfile"])),
931
client["secret"] = secfile.read()
933
raise TypeError("No secret or secfile for section {}"
935
client["timeout"] = string_to_delta(section["timeout"])
936
client["extended_timeout"] = string_to_delta(
937
section["extended_timeout"])
938
client["interval"] = string_to_delta(section["interval"])
939
client["approval_delay"] = string_to_delta(
940
section["approval_delay"])
941
client["approval_duration"] = string_to_delta(
942
section["approval_duration"])
943
client["checker_command"] = section["checker"]
944
client["last_approval_request"] = None
945
client["last_checked_ok"] = None
946
client["last_checker_status"] = -2
950
def __init__(self, settings, name=None, server_settings=None):
952
if server_settings is None:
954
self.server_settings = server_settings
955
# adding all client settings
956
for setting, value in settings.items():
957
setattr(self, setting, value)
960
if not hasattr(self, "last_enabled"):
961
self.last_enabled = datetime.datetime.utcnow()
962
if not hasattr(self, "expires"):
963
self.expires = (datetime.datetime.utcnow()
966
self.last_enabled = None
341
969
logger.debug("Creating client %r", self.name)
342
# Uppercase and remove spaces from fingerprint for later
343
# comparison purposes with return value from the fingerprint()
345
self.fingerprint = (config["fingerprint"].upper()
970
logger.debug(" Key ID: %s", self.key_id)
347
971
logger.debug(" Fingerprint: %s", self.fingerprint)
348
if "secret" in config:
349
self.secret = config["secret"].decode("base64")
350
elif "secfile" in config:
351
with open(os.path.expanduser(os.path.expandvars
352
(config["secfile"])),
354
self.secret = secfile.read()
356
raise TypeError("No secret or secfile for client %s"
358
self.host = config.get("host", "")
359
self.created = datetime.datetime.utcnow()
361
self.last_approval_request = None
362
self.last_enabled = None
363
self.last_checked_ok = None
364
self.timeout = string_to_delta(config["timeout"])
365
self.extended_timeout = string_to_delta(config
366
["extended_timeout"])
367
self.interval = string_to_delta(config["interval"])
368
self.disable_hook = disable_hook
972
self.created = settings.get("created",
973
datetime.datetime.utcnow())
975
# attributes specific for this server instance
369
976
self.checker = None
370
977
self.checker_initiator_tag = None
371
978
self.disable_initiator_tag = None
373
979
self.checker_callback_tag = None
374
self.checker_command = config["checker"]
375
980
self.current_checker_command = None
376
self.last_connect = None
377
self._approved = None
378
self.approved_by_default = config.get("approved_by_default",
380
982
self.approvals_pending = 0
381
self.approval_delay = string_to_delta(
382
config["approval_delay"])
383
self.approval_duration = string_to_delta(
384
config["approval_duration"])
385
self.changedstate = (multiprocessing_manager
386
.Condition(multiprocessing_manager
983
self.changedstate = multiprocessing_manager.Condition(
984
multiprocessing_manager.Lock())
985
self.client_structure = [attr
986
for attr in self.__dict__.keys()
987
if not attr.startswith("_")]
988
self.client_structure.append("client_structure")
990
for name, t in inspect.getmembers(
991
type(self), lambda obj: isinstance(obj, property)):
992
if not name.startswith("_"):
993
self.client_structure.append(name)
995
# Send notice to process children that client state has changed
389
996
def send_changedstate(self):
390
self.changedstate.acquire()
391
self.changedstate.notify_all()
392
self.changedstate.release()
997
with self.changedstate:
998
self.changedstate.notify_all()
394
1000
def enable(self):
395
1001
"""Start this client's checker and timeout hooks"""
396
1002
if getattr(self, "enabled", False):
397
1003
# Already enabled
399
self.send_changedstate()
400
# Schedule a new checker to be started an 'interval' from now,
401
# and every interval from then on.
402
self.checker_initiator_tag = (gobject.timeout_add
403
(self.interval_milliseconds(),
405
# Schedule a disable() when 'timeout' has passed
406
1005
self.expires = datetime.datetime.utcnow() + self.timeout
407
self.disable_initiator_tag = (gobject.timeout_add
408
(self.timeout_milliseconds(),
410
1006
self.enabled = True
411
1007
self.last_enabled = datetime.datetime.utcnow()
412
# Also start a new checker *right now*.
1009
self.send_changedstate()
415
1011
def disable(self, quiet=True):
416
1012
"""Disable this client."""
417
1013
if not getattr(self, "enabled", False):
420
self.send_changedstate()
422
1016
logger.info("Disabling client %s", self.name)
423
if getattr(self, "disable_initiator_tag", False):
424
gobject.source_remove(self.disable_initiator_tag)
1017
if getattr(self, "disable_initiator_tag", None) is not None:
1018
GLib.source_remove(self.disable_initiator_tag)
425
1019
self.disable_initiator_tag = None
426
1020
self.expires = None
427
if getattr(self, "checker_initiator_tag", False):
428
gobject.source_remove(self.checker_initiator_tag)
1021
if getattr(self, "checker_initiator_tag", None) is not None:
1022
GLib.source_remove(self.checker_initiator_tag)
429
1023
self.checker_initiator_tag = None
430
1024
self.stop_checker()
431
if self.disable_hook:
432
self.disable_hook(self)
433
1025
self.enabled = False
434
# Do not run this again if called by a gobject.timeout_add
1027
self.send_changedstate()
1028
# Do not run this again if called by a GLib.timeout_add
437
1031
def __del__(self):
438
self.disable_hook = None
441
def checker_callback(self, pid, condition, command):
1034
def init_checker(self):
1035
# Schedule a new checker to be started an 'interval' from now,
1036
# and every interval from then on.
1037
if self.checker_initiator_tag is not None:
1038
GLib.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = GLib.timeout_add(
1040
int(self.interval.total_seconds() * 1000),
1042
# Schedule a disable() when 'timeout' has passed
1043
if self.disable_initiator_tag is not None:
1044
GLib.source_remove(self.disable_initiator_tag)
1045
self.disable_initiator_tag = GLib.timeout_add(
1046
int(self.timeout.total_seconds() * 1000), self.disable)
1047
# Also start a new checker *right now*.
1048
self.start_checker()
1050
def checker_callback(self, source, condition, connection,
442
1052
"""The checker has completed, so take appropriate actions."""
1053
# Read return code from connection (see call_pipe)
1054
returncode = connection.recv()
1056
if self.checker is not None:
443
1058
self.checker_callback_tag = None
444
1059
self.checker = None
445
if os.WIFEXITED(condition):
446
exitstatus = os.WEXITSTATUS(condition)
1062
self.last_checker_status = returncode
1063
self.last_checker_signal = None
1064
if self.last_checker_status == 0:
448
1065
logger.info("Checker for %(name)s succeeded",
450
1067
self.checked_ok()
452
logger.info("Checker for %(name)s failed",
1069
logger.info("Checker for %(name)s failed", vars(self))
1071
self.last_checker_status = -1
1072
self.last_checker_signal = -returncode
455
1073
logger.warning("Checker for %(name)s crashed?",
458
def checked_ok(self, timeout=None):
459
"""Bump up the timeout for this client.
461
This should only be called when the client has been seen,
1077
def checked_ok(self):
1078
"""Assert that the client has been seen, alive and well."""
1079
self.last_checked_ok = datetime.datetime.utcnow()
1080
self.last_checker_status = 0
1081
self.last_checker_signal = None
1084
def bump_timeout(self, timeout=None):
1085
"""Bump up the timeout for this client."""
464
1086
if timeout is None:
465
1087
timeout = self.timeout
466
self.last_checked_ok = datetime.datetime.utcnow()
467
1088
if self.disable_initiator_tag is not None:
468
gobject.source_remove(self.disable_initiator_tag)
1089
GLib.source_remove(self.disable_initiator_tag)
1090
self.disable_initiator_tag = None
469
1091
if getattr(self, "enabled", False):
470
self.disable_initiator_tag = (gobject.timeout_add
471
(_timedelta_to_milliseconds
472
(timeout), self.disable))
1092
self.disable_initiator_tag = GLib.timeout_add(
1093
int(timeout.total_seconds() * 1000), self.disable)
473
1094
self.expires = datetime.datetime.utcnow() + timeout
475
1096
def need_approval(self):
476
1097
self.last_approval_request = datetime.datetime.utcnow()
478
1099
def start_checker(self):
479
1100
"""Start a new checker subprocess if one is not running.
481
1102
If a checker already exists, leave it running and do
483
1104
# The reason for not killing a running checker is that if we
484
# did that, then if a checker (for some reason) started
485
# running slowly and taking more than 'interval' time, the
486
# client would inevitably timeout, since no checker would get
487
# a chance to run to completion. If we instead leave running
1105
# did that, and if a checker (for some reason) started running
1106
# slowly and taking more than 'interval' time, then the client
1107
# would inevitably timeout, since no checker would get a
1108
# chance to run to completion. If we instead leave running
488
1109
# checkers alone, the checker would have to take more time
489
1110
# than 'timeout' for the client to be disabled, which is as it
492
# If a checker exists, make sure it is not a zombie
494
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
495
except (AttributeError, OSError) as error:
496
if (isinstance(error, OSError)
497
and error.errno != errno.ECHILD):
501
logger.warning("Checker was a zombie")
502
gobject.source_remove(self.checker_callback_tag)
503
self.checker_callback(pid, status,
504
self.current_checker_command)
1113
if self.checker is not None and not self.checker.is_alive():
1114
logger.warning("Checker was not alive; joining")
505
1117
# Start a new checker if needed
506
1118
if self.checker is None:
1119
# Escape attributes for the shell
1121
attr: re.escape(str(getattr(self, attr)))
1122
for attr in self.runtime_expansions}
508
# In case checker_command has exactly one % operator
509
command = self.checker_command % self.host
511
# Escape attributes for the shell
512
escaped_attrs = dict(
514
re.escape(unicode(str(getattr(self, attr, "")),
518
self.runtime_expansions)
521
command = self.checker_command % escaped_attrs
522
except TypeError as error:
523
logger.error('Could not format string "%s":'
524
' %s', self.checker_command, error)
525
return True # Try again later
1124
command = self.checker_command % escaped_attrs
1125
except TypeError as error:
1126
logger.error('Could not format string "%s"',
1127
self.checker_command,
1129
return True # Try again later
526
1130
self.current_checker_command = command
528
logger.info("Starting checker %r for %s",
530
# We don't need to redirect stdout and stderr, since
531
# in normal mode, that is already done by daemon(),
532
# and in debug mode we don't want to. (Stdin is
533
# always replaced by /dev/null.)
534
self.checker = subprocess.Popen(command,
537
self.checker_callback_tag = (gobject.child_watch_add
539
self.checker_callback,
541
# The checker may have completed before the gobject
542
# watch was added. Check for this.
543
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
545
gobject.source_remove(self.checker_callback_tag)
546
self.checker_callback(pid, status, command)
547
except OSError as error:
548
logger.error("Failed to start subprocess: %s",
550
# Re-run this periodically if run by gobject.timeout_add
1131
logger.info("Starting checker %r for %s", command,
1133
# We don't need to redirect stdout and stderr, since
1134
# in normal mode, that is already done by daemon(),
1135
# and in debug mode we don't want to. (Stdin is
1136
# always replaced by /dev/null.)
1137
# The exception is when not debugging but nevertheless
1138
# running in the foreground; use the previously
1140
popen_args = {"close_fds": True,
1143
if (not self.server_settings["debug"]
1144
and self.server_settings["foreground"]):
1145
popen_args.update({"stdout": wnull,
1147
pipe = multiprocessing.Pipe(duplex=False)
1148
self.checker = multiprocessing.Process(
1150
args=(pipe[1], subprocess.call, command),
1152
self.checker.start()
1153
self.checker_callback_tag = GLib.io_add_watch(
1154
GLib.IOChannel.unix_new(pipe[0].fileno()),
1155
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1156
self.checker_callback, pipe[0], command)
1157
# Re-run this periodically if run by GLib.timeout_add
553
1160
def stop_checker(self):
554
1161
"""Force the checker process, if any, to stop."""
555
1162
if self.checker_callback_tag:
556
gobject.source_remove(self.checker_callback_tag)
1163
GLib.source_remove(self.checker_callback_tag)
557
1164
self.checker_callback_tag = None
558
1165
if getattr(self, "checker", None) is None:
560
1167
logger.debug("Stopping checker for %(name)s", vars(self))
562
os.kill(self.checker.pid, signal.SIGTERM)
564
#if self.checker.poll() is None:
565
# os.kill(self.checker.pid, signal.SIGKILL)
566
except OSError as error:
567
if error.errno != errno.ESRCH: # No such process
1168
self.checker.terminate()
569
1169
self.checker = None
572
def dbus_service_property(dbus_interface, signature="v",
573
access="readwrite", byte_arrays=False):
1172
def dbus_service_property(dbus_interface,
574
1176
"""Decorators for marking methods of a DBusObjectWithProperties to
575
1177
become properties on the D-Bus.
577
1179
The decorated method will be called with no arguments by "Get"
578
1180
and with one argument by "Set".
580
1182
The parameters, where they are supported, are the same as
581
1183
dbus.service.method, except there is only "signature", since the
582
1184
type from Get() and the type sent to Set() is the same.
752
1517
except (AttributeError, xml.dom.DOMException,
753
1518
xml.parsers.expat.ExpatError) as error:
754
1519
logger.error("Failed to override Introspection method",
759
def datetime_to_dbus (dt, variant_level=0):
1525
dbus.OBJECT_MANAGER_IFACE
1526
except AttributeError:
1527
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1530
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1531
"""A D-Bus object with an ObjectManager.
1533
Classes inheriting from this exposes the standard
1534
GetManagedObjects call and the InterfacesAdded and
1535
InterfacesRemoved signals on the standard
1536
"org.freedesktop.DBus.ObjectManager" interface.
1538
Note: No signals are sent automatically; they must be sent
1541
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1542
out_signature="a{oa{sa{sv}}}")
1543
def GetManagedObjects(self):
1544
"""This function must be overridden"""
1545
raise NotImplementedError()
1547
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1548
signature="oa{sa{sv}}")
1549
def InterfacesAdded(self, object_path, interfaces_and_properties):
1552
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1553
def InterfacesRemoved(self, object_path, interfaces):
1556
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1558
path_keyword='object_path',
1559
connection_keyword='connection')
1560
def Introspect(self, object_path, connection):
1561
"""Overloading of standard D-Bus method.
1563
Override return argument name of GetManagedObjects to be
1564
"objpath_interfaces_and_properties"
1566
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1570
document = xml.dom.minidom.parseString(xmlstring)
1572
for if_tag in document.getElementsByTagName("interface"):
1573
# Fix argument name for the GetManagedObjects method
1574
if (if_tag.getAttribute("name")
1575
== dbus.OBJECT_MANAGER_IFACE):
1576
for cn in if_tag.getElementsByTagName("method"):
1577
if (cn.getAttribute("name")
1578
== "GetManagedObjects"):
1579
for arg in cn.getElementsByTagName("arg"):
1580
if (arg.getAttribute("direction")
1584
"objpath_interfaces"
1586
xmlstring = document.toxml("utf-8")
1588
except (AttributeError, xml.dom.DOMException,
1589
xml.parsers.expat.ExpatError) as error:
1590
logger.error("Failed to override Introspection method",
1595
def datetime_to_dbus(dt, variant_level=0):
760
1596
"""Convert a UTC datetime.datetime() to a D-Bus type."""
762
return dbus.String("", variant_level = variant_level)
763
return dbus.String(dt.isoformat(),
764
variant_level=variant_level)
766
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
768
"""Applied to an empty subclass of a D-Bus object, this metaclass
769
will add additional D-Bus attributes matching a certain pattern.
1598
return dbus.String("", variant_level=variant_level)
1599
return dbus.String(dt.isoformat(), variant_level=variant_level)
1602
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1603
"""A class decorator; applied to a subclass of
1604
dbus.service.Object, it will add alternate D-Bus attributes with
1605
interface names according to the "alt_interface_names" mapping.
1608
@alternate_dbus_interfaces({"org.example.Interface":
1609
"net.example.AlternateInterface"})
1610
class SampleDBusObject(dbus.service.Object):
1611
@dbus.service.method("org.example.Interface")
1612
def SampleDBusMethod():
1615
The above "SampleDBusMethod" on "SampleDBusObject" will be
1616
reachable via two interfaces: "org.example.Interface" and
1617
"net.example.AlternateInterface", the latter of which will have
1618
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1619
"true", unless "deprecate" is passed with a False value.
1621
This works for methods and signals, and also for D-Bus properties
1622
(from DBusObjectWithProperties) and interfaces (from the
1623
dbus_interface_annotations decorator).
771
def __new__(mcs, name, bases, attr):
772
# Go through all the base classes which could have D-Bus
773
# methods, signals, or properties in them
774
for base in (b for b in bases
775
if issubclass(b, dbus.service.Object)):
776
# Go though all attributes of the base class
777
for attrname, attribute in inspect.getmembers(base):
1627
for orig_interface_name, alt_interface_name in (
1628
alt_interface_names.items()):
1630
interface_names = set()
1631
# Go though all attributes of the class
1632
for attrname, attribute in inspect.getmembers(cls):
778
1633
# Ignore non-D-Bus attributes, and D-Bus attributes
779
1634
# with the wrong interface name
780
1635
if (not hasattr(attribute, "_dbus_interface")
781
or not attribute._dbus_interface
782
.startswith("se.recompile.Mandos")):
1636
or not attribute._dbus_interface.startswith(
1637
orig_interface_name)):
784
1639
# Create an alternate D-Bus interface name based on
785
1640
# the current name
786
alt_interface = (attribute._dbus_interface
787
.replace("se.recompile.Mandos",
788
"se.bsnet.fukt.Mandos"))
1641
alt_interface = attribute._dbus_interface.replace(
1642
orig_interface_name, alt_interface_name)
1643
interface_names.add(alt_interface)
789
1644
# Is this a D-Bus signal?
790
1645
if getattr(attribute, "_dbus_is_signal", False):
791
# Extract the original non-method function by
793
nonmethod_func = (dict(
1646
# Extract the original non-method undecorated
1647
# function by black magic
1648
if sys.version_info.major == 2:
1649
nonmethod_func = (dict(
794
1650
zip(attribute.func_code.co_freevars,
795
attribute.__closure__))["func"]
1651
attribute.__closure__))
1652
["func"].cell_contents)
1654
nonmethod_func = (dict(
1655
zip(attribute.__code__.co_freevars,
1656
attribute.__closure__))
1657
["func"].cell_contents)
797
1658
# Create a new, but exactly alike, function
798
1659
# object, and decorate it to be a new D-Bus signal
799
1660
# with the alternate D-Bus interface name
800
new_function = (dbus.service.signal
802
attribute._dbus_signature)
804
nonmethod_func.func_code,
805
nonmethod_func.func_globals,
806
nonmethod_func.func_name,
807
nonmethod_func.func_defaults,
808
nonmethod_func.func_closure)))
1661
new_function = copy_function(nonmethod_func)
1662
new_function = (dbus.service.signal(
1664
attribute._dbus_signature)(new_function))
1665
# Copy annotations, if any
1667
new_function._dbus_annotations = dict(
1668
attribute._dbus_annotations)
1669
except AttributeError:
809
1672
# Define a creator of a function to call both the
810
# old and new functions, so both the old and new
811
# signals gets sent when the function is called
1673
# original and alternate functions, so both the
1674
# original and alternate signals gets sent when
1675
# the function is called
812
1676
def fixscope(func1, func2):
813
1677
"""This function is a scope container to pass
814
1678
func1 and func2 to the "call_both" function
815
1679
outside of its arguments"""
1681
@functools.wraps(func2)
816
1682
def call_both(*args, **kwargs):
817
1683
"""This function will emit two D-Bus
818
1684
signals by calling func1 and func2"""
819
1685
func1(*args, **kwargs)
820
1686
func2(*args, **kwargs)
1687
# Make wrapper function look like a D-Bus
1689
for name, attr in inspect.getmembers(func2):
1690
if name.startswith("_dbus_"):
1691
setattr(call_both, name, attr)
821
1693
return call_both
822
1694
# Create the "call_both" function and add it to
824
attr[attrname] = fixscope(attribute,
1696
attr[attrname] = fixscope(attribute, new_function)
826
1697
# Is this a D-Bus method?
827
1698
elif getattr(attribute, "_dbus_is_method", False):
828
1699
# Create a new, but exactly alike, function
829
1700
# object. Decorate it to be a new D-Bus method
830
1701
# with the alternate D-Bus interface name. Add it
832
attr[attrname] = (dbus.service.method
834
attribute._dbus_in_signature,
835
attribute._dbus_out_signature)
837
(attribute.func_code,
838
attribute.func_globals,
840
attribute.func_defaults,
841
attribute.func_closure)))
1704
dbus.service.method(
1706
attribute._dbus_in_signature,
1707
attribute._dbus_out_signature)
1708
(copy_function(attribute)))
1709
# Copy annotations, if any
1711
attr[attrname]._dbus_annotations = dict(
1712
attribute._dbus_annotations)
1713
except AttributeError:
842
1715
# Is this a D-Bus property?
843
1716
elif getattr(attribute, "_dbus_is_property", False):
844
1717
# Create a new, but exactly alike, function
845
1718
# object, and decorate it to be a new D-Bus
846
1719
# property with the alternate D-Bus interface
847
1720
# name. Add it to the class.
848
attr[attrname] = (dbus_service_property
850
attribute._dbus_signature,
851
attribute._dbus_access,
853
._dbus_get_args_options
856
(attribute.func_code,
857
attribute.func_globals,
859
attribute.func_defaults,
860
attribute.func_closure)))
861
return type.__new__(mcs, name, bases, attr)
1721
attr[attrname] = (dbus_service_property(
1722
alt_interface, attribute._dbus_signature,
1723
attribute._dbus_access,
1724
attribute._dbus_get_args_options
1726
(copy_function(attribute)))
1727
# Copy annotations, if any
1729
attr[attrname]._dbus_annotations = dict(
1730
attribute._dbus_annotations)
1731
except AttributeError:
1733
# Is this a D-Bus interface?
1734
elif getattr(attribute, "_dbus_is_interface", False):
1735
# Create a new, but exactly alike, function
1736
# object. Decorate it to be a new D-Bus interface
1737
# with the alternate D-Bus interface name. Add it
1740
dbus_interface_annotations(alt_interface)
1741
(copy_function(attribute)))
1743
# Deprecate all alternate interfaces
1744
iname = "_AlternateDBusNames_interface_annotation{}"
1745
for interface_name in interface_names:
1747
@dbus_interface_annotations(interface_name)
1749
return {"org.freedesktop.DBus.Deprecated":
1751
# Find an unused name
1752
for aname in (iname.format(i)
1753
for i in itertools.count()):
1754
if aname not in attr:
1758
# Replace the class with a new subclass of it with
1759
# methods, signals, etc. as created above.
1760
if sys.version_info.major == 2:
1761
cls = type(b"{}Alternate".format(cls.__name__),
1764
cls = type("{}Alternate".format(cls.__name__),
1771
@alternate_dbus_interfaces({"se.recompile.Mandos":
1772
"se.bsnet.fukt.Mandos"})
863
1773
class ClientDBus(Client, DBusObjectWithProperties):
864
1774
"""A Client class using D-Bus
867
1777
dbus_object_path: dbus.ObjectPath
868
1778
bus: dbus.SystemBus()
871
1781
runtime_expansions = (Client.runtime_expansions
872
+ ("dbus_object_path",))
1782
+ ("dbus_object_path", ))
1784
_interface = "se.recompile.Mandos.Client"
874
1786
# dbus.service.Object doesn't use super(), so we can't either.
876
def __init__(self, bus = None, *args, **kwargs):
877
self._approvals_pending = 0
1788
def __init__(self, bus=None, *args, **kwargs):
879
1790
Client.__init__(self, *args, **kwargs)
880
1791
# Only now, when this client is initialized, can it show up on
882
client_object_name = unicode(self.name).translate(
1793
client_object_name = str(self.name).translate(
883
1794
{ord("."): ord("_"),
884
1795
ord("-"): ord("_")})
885
self.dbus_object_path = (dbus.ObjectPath
886
("/clients/" + client_object_name))
1796
self.dbus_object_path = dbus.ObjectPath(
1797
"/clients/" + client_object_name)
887
1798
DBusObjectWithProperties.__init__(self, self.bus,
888
1799
self.dbus_object_path)
890
def notifychangeproperty(transform_func,
891
dbus_name, type_func=lambda x: x,
1801
def notifychangeproperty(transform_func, dbus_name,
1802
type_func=lambda x: x,
1804
invalidate_only=False,
1805
_interface=_interface):
893
1806
""" Modify a variable so that it's a property which announces
894
1807
its changes to DBus.
1246
2202
self.start_checker()
1248
2204
self.stop_checker()
1250
2206
# ObjectPath - property
2208
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2209
"org.freedesktop.DBus.Deprecated": "true"})
1251
2210
@dbus_service_property(_interface, signature="o", access="read")
1252
2211
def ObjectPath_dbus_property(self):
1253
return self.dbus_object_path # is already a dbus.ObjectPath
2212
return self.dbus_object_path # is already a dbus.ObjectPath
1255
2214
# Secret = property
1256
@dbus_service_property(_interface, signature="ay",
1257
access="write", byte_arrays=True)
2216
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2218
@dbus_service_property(_interface,
1258
2222
def Secret_dbus_property(self, value):
1259
self.secret = str(value)
2223
self.secret = bytes(value)
1264
class ProxyClient(object):
1265
def __init__(self, child_pipe, fpr, address):
2229
def __init__(self, child_pipe, key_id, fpr, address):
1266
2230
self._pipe = child_pipe
1267
self._pipe.send(('init', fpr, address))
2231
self._pipe.send(('init', key_id, fpr, address))
1268
2232
if not self._pipe.recv():
2233
raise KeyError(key_id or fpr)
1271
2235
def __getattribute__(self, name):
1272
if(name == '_pipe'):
1273
2237
return super(ProxyClient, self).__getattribute__(name)
1274
2238
self._pipe.send(('getattr', name))
1275
2239
data = self._pipe.recv()
1276
2240
if data[0] == 'data':
1278
2242
if data[0] == 'function':
1279
2244
def func(*args, **kwargs):
1280
2245
self._pipe.send(('funcall', name, args, kwargs))
1281
2246
return self._pipe.recv()[1]
1284
2250
def __setattr__(self, name, value):
1285
if(name == '_pipe'):
1286
2252
return super(ProxyClient, self).__setattr__(name, value)
1287
2253
self._pipe.send(('setattr', name, value))
1289
class ClientDBusTransitional(ClientDBus):
1290
__metaclass__ = AlternateDBusNamesMetaclass
1292
2256
class ClientHandler(socketserver.BaseRequestHandler, object):
1293
2257
"""A class to handle client connections.
1295
2259
Instantiated once for each connection to handle it.
1296
2260
Note: This will run in its own forked process."""
1298
2262
def handle(self):
1299
2263
with contextlib.closing(self.server.child_pipe) as child_pipe:
1300
2264
logger.info("TCP connection from: %s",
1301
unicode(self.client_address))
2265
str(self.client_address))
1302
2266
logger.debug("Pipe FD: %d",
1303
2267
self.server.child_pipe.fileno())
1305
session = (gnutls.connection
1306
.ClientSession(self.request,
1308
.X509Credentials()))
1310
# Note: gnutls.connection.X509Credentials is really a
1311
# generic GnuTLS certificate credentials object so long as
1312
# no X.509 keys are added to it. Therefore, we can use it
1313
# here despite using OpenPGP certificates.
1315
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1316
# "+AES-256-CBC", "+SHA1",
1317
# "+COMP-NULL", "+CTYPE-OPENPGP",
2269
session = gnutls.ClientSession(self.request)
2271
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2272
# "+AES-256-CBC", "+SHA1",
2273
# "+COMP-NULL", "+CTYPE-OPENPGP",
1319
2275
# Use a fallback default, since this MUST be set.
1320
2276
priority = self.server.gnutls_priority
1321
2277
if priority is None:
1322
2278
priority = "NORMAL"
1323
(gnutls.library.functions
1324
.gnutls_priority_set_direct(session._c_object,
2279
gnutls.priority_set_direct(session._c_object,
2280
priority.encode("utf-8"),
1327
2283
# Start communication using the Mandos protocol
1328
2284
# Get protocol number
1329
2285
line = self.request.makefile().readline()
1330
2286
logger.debug("Protocol version: %r", line)
1332
2288
if int(line.strip().split()[0]) > 1:
2289
raise RuntimeError(line)
1334
2290
except (ValueError, IndexError, RuntimeError) as error:
1335
2291
logger.error("Unknown protocol version: %s", error)
1338
2294
# Start GnuTLS connection
1340
2296
session.handshake()
1341
except gnutls.errors.GNUTLSError as error:
2297
except gnutls.Error as error:
1342
2298
logger.warning("Handshake failed: %s", error)
1343
2299
# Do not run session.bye() here: the session is not
1344
2300
# established. Just abandon the request.
1346
2302
logger.debug("Handshake succeeded")
1348
2304
approval_required = False
1351
fpr = self.fingerprint(self.peer_certificate
1354
gnutls.errors.GNUTLSError) as error:
1355
logger.warning("Bad certificate: %s", error)
1357
logger.debug("Fingerprint: %s", fpr)
1360
client = ProxyClient(child_pipe, fpr,
2306
if gnutls.has_rawpk:
2309
key_id = self.key_id(
2310
self.peer_certificate(session))
2311
except (TypeError, gnutls.Error) as error:
2312
logger.warning("Bad certificate: %s", error)
2314
logger.debug("Key ID: %s", key_id)
2319
fpr = self.fingerprint(
2320
self.peer_certificate(session))
2321
except (TypeError, gnutls.Error) as error:
2322
logger.warning("Bad certificate: %s", error)
2324
logger.debug("Fingerprint: %s", fpr)
2327
client = ProxyClient(child_pipe, key_id, fpr,
1361
2328
self.client_address)
1362
2329
except KeyError:
1365
2332
if client.approval_delay:
1366
2333
delay = client.approval_delay
1367
2334
client.approvals_pending += 1
1368
2335
approval_required = True
1371
2338
if not client.enabled:
1372
2339
logger.info("Client %s is disabled",
1374
2341
if self.server.use_dbus:
1375
2342
# Emit D-Bus signal
1376
2343
client.Rejected("Disabled")
1379
if client._approved or not client.approval_delay:
1380
#We are approved or approval is disabled
2346
if client.approved or not client.approval_delay:
2347
# We are approved or approval is disabled
1382
elif client._approved is None:
2349
elif client.approved is None:
1383
2350
logger.info("Client %s needs approval",
1385
2352
if self.server.use_dbus:
1386
2353
# Emit D-Bus signal
1387
2354
client.NeedApproval(
1388
client.approval_delay_milliseconds(),
1389
client.approved_by_default)
2355
client.approval_delay.total_seconds()
2356
* 1000, client.approved_by_default)
1391
2358
logger.warning("Client %s was not approved",
1418
2383
delay -= time2 - time
1421
while sent_size < len(client.secret):
1423
sent = session.send(client.secret[sent_size:])
1424
except gnutls.errors.GNUTLSError as error:
1425
logger.warning("gnutls send failed")
1427
logger.debug("Sent: %d, remaining: %d",
1428
sent, len(client.secret)
1429
- (sent_size + sent))
2386
session.send(client.secret)
2387
except gnutls.Error as error:
2388
logger.warning("gnutls send failed",
1432
2392
logger.info("Sending secret to %s", client.name)
1433
2393
# bump the timeout using extended_timeout
1434
client.checked_ok(client.extended_timeout)
2394
client.bump_timeout(client.extended_timeout)
1435
2395
if self.server.use_dbus:
1436
2396
# Emit D-Bus signal
1437
2397
client.GotSecret()
1440
2400
if approval_required:
1441
2401
client.approvals_pending -= 1
1444
except gnutls.errors.GNUTLSError as error:
1445
logger.warning("GnuTLS bye failed")
2404
except gnutls.Error as error:
2405
logger.warning("GnuTLS bye failed",
1448
2409
def peer_certificate(session):
1449
"Return the peer's OpenPGP certificate as a bytestring"
1450
# If not an OpenPGP certificate...
1451
if (gnutls.library.functions
1452
.gnutls_certificate_type_get(session._c_object)
1453
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1454
# ...do the normal thing
1455
return session.peer_certificate
2410
"Return the peer's certificate as a bytestring"
2412
cert_type = gnutls.certificate_type_get2(session._c_object,
2414
except AttributeError:
2415
cert_type = gnutls.certificate_type_get(session._c_object)
2416
if gnutls.has_rawpk:
2417
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2419
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2420
# If not a valid certificate type...
2421
if cert_type not in valid_cert_types:
2422
logger.info("Cert type %r not in %r", cert_type,
2424
# ...return invalid data
1456
2426
list_size = ctypes.c_uint(1)
1457
cert_list = (gnutls.library.functions
1458
.gnutls_certificate_get_peers
2427
cert_list = (gnutls.certificate_get_peers
1459
2428
(session._c_object, ctypes.byref(list_size)))
1460
2429
if not bool(cert_list) and list_size.value != 0:
1461
raise gnutls.errors.GNUTLSError("error getting peer"
2430
raise gnutls.Error("error getting peer certificate")
1463
2431
if list_size.value == 0:
1465
2433
cert = cert_list[0]
1466
2434
return ctypes.string_at(cert.data, cert.size)
2437
def key_id(certificate):
2438
"Convert a certificate bytestring to a hexdigit key ID"
2439
# New GnuTLS "datum" with the public key
2440
datum = gnutls.datum_t(
2441
ctypes.cast(ctypes.c_char_p(certificate),
2442
ctypes.POINTER(ctypes.c_ubyte)),
2443
ctypes.c_uint(len(certificate)))
2444
# XXX all these need to be created in the gnutls "module"
2445
# New empty GnuTLS certificate
2446
pubkey = gnutls.pubkey_t()
2447
gnutls.pubkey_init(ctypes.byref(pubkey))
2448
# Import the raw public key into the certificate
2449
gnutls.pubkey_import(pubkey,
2450
ctypes.byref(datum),
2451
gnutls.X509_FMT_DER)
2452
# New buffer for the key ID
2453
buf = ctypes.create_string_buffer(32)
2454
buf_len = ctypes.c_size_t(len(buf))
2455
# Get the key ID from the raw public key into the buffer
2456
gnutls.pubkey_get_key_id(pubkey,
2457
gnutls.KEYID_USE_SHA256,
2458
ctypes.cast(ctypes.byref(buf),
2459
ctypes.POINTER(ctypes.c_ubyte)),
2460
ctypes.byref(buf_len))
2461
# Deinit the certificate
2462
gnutls.pubkey_deinit(pubkey)
2464
# Convert the buffer to a Python bytestring
2465
key_id = ctypes.string_at(buf, buf_len.value)
2466
# Convert the bytestring to hexadecimal notation
2467
hex_key_id = binascii.hexlify(key_id).upper()
1469
2471
def fingerprint(openpgp):
1470
2472
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1471
2473
# New GnuTLS "datum" with the OpenPGP public key
1472
datum = (gnutls.library.types
1473
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1476
ctypes.c_uint(len(openpgp))))
2474
datum = gnutls.datum_t(
2475
ctypes.cast(ctypes.c_char_p(openpgp),
2476
ctypes.POINTER(ctypes.c_ubyte)),
2477
ctypes.c_uint(len(openpgp)))
1477
2478
# New empty GnuTLS certificate
1478
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1479
(gnutls.library.functions
1480
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2479
crt = gnutls.openpgp_crt_t()
2480
gnutls.openpgp_crt_init(ctypes.byref(crt))
1481
2481
# Import the OpenPGP public key into the certificate
1482
(gnutls.library.functions
1483
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1484
gnutls.library.constants
1485
.GNUTLS_OPENPGP_FMT_RAW))
2482
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2483
gnutls.OPENPGP_FMT_RAW)
1486
2484
# Verify the self signature in the key
1487
2485
crtverify = ctypes.c_uint()
1488
(gnutls.library.functions
1489
.gnutls_openpgp_crt_verify_self(crt, 0,
1490
ctypes.byref(crtverify)))
2486
gnutls.openpgp_crt_verify_self(crt, 0,
2487
ctypes.byref(crtverify))
1491
2488
if crtverify.value != 0:
1492
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1493
raise (gnutls.errors.CertificateSecurityError
2489
gnutls.openpgp_crt_deinit(crt)
2490
raise gnutls.CertificateSecurityError(code
1495
2492
# New buffer for the fingerprint
1496
2493
buf = ctypes.create_string_buffer(20)
1497
2494
buf_len = ctypes.c_size_t()
1498
2495
# Get the fingerprint from the certificate into the buffer
1499
(gnutls.library.functions
1500
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1501
ctypes.byref(buf_len)))
2496
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2497
ctypes.byref(buf_len))
1502
2498
# Deinit the certificate
1503
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2499
gnutls.openpgp_crt_deinit(crt)
1504
2500
# Convert the buffer to a Python bytestring
1505
2501
fpr = ctypes.string_at(buf, buf_len.value)
1506
2502
# Convert the bytestring to hexadecimal notation
1507
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2503
hex_fpr = binascii.hexlify(fpr).upper()
1511
class MultiprocessingMixIn(object):
2507
class MultiprocessingMixIn:
1512
2508
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1513
2510
def sub_process_main(self, request, address):
1515
2512
self.finish_request(request, address)
1517
2514
self.handle_error(request, address)
1518
2515
self.close_request(request)
1520
2517
def process_request(self, request, address):
1521
2518
"""Start a new process to process the request."""
1522
proc = multiprocessing.Process(target = self.sub_process_main,
2519
proc = multiprocessing.Process(target=self.sub_process_main,
2520
args=(request, address))
1529
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2525
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1530
2526
""" adds a pipe to the MixIn """
1531
2528
def process_request(self, request, client_address):
1532
2529
"""Overrides and wraps the original process_request().
1534
2531
This function creates a new pipe in self.pipe
1536
2533
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1538
2535
proc = MultiprocessingMixIn.process_request(self, request,
1539
2536
client_address)
1540
2537
self.child_pipe.close()
1541
2538
self.add_pipe(parent_pipe, proc)
1543
2540
def add_pipe(self, parent_pipe, proc):
1544
2541
"""Dummy function; override as necessary"""
1545
raise NotImplementedError
2542
raise NotImplementedError()
1548
2545
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1549
socketserver.TCPServer, object):
2546
socketserver.TCPServer):
1550
2547
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1553
2550
enabled: Boolean; whether this server is activated yet
1554
2551
interface: None or a network interface name (string)
1555
2552
use_ipv6: Boolean; to use IPv6 or not
1557
2555
def __init__(self, server_address, RequestHandlerClass,
1558
interface=None, use_ipv6=True):
2559
"""If socketfd is set, use that file descriptor instead of
2560
creating a new one with socket.socket().
1559
2562
self.interface = interface
1561
2564
self.address_family = socket.AF_INET6
2565
if socketfd is not None:
2566
# Save the file descriptor
2567
self.socketfd = socketfd
2568
# Save the original socket.socket() function
2569
self.socket_socket = socket.socket
2571
# To implement --socket, we monkey patch socket.socket.
2573
# (When socketserver.TCPServer is a new-style class, we
2574
# could make self.socket into a property instead of monkey
2575
# patching socket.socket.)
2577
# Create a one-time-only replacement for socket.socket()
2578
@functools.wraps(socket.socket)
2579
def socket_wrapper(*args, **kwargs):
2580
# Restore original function so subsequent calls are
2582
socket.socket = self.socket_socket
2583
del self.socket_socket
2584
# This time only, return a new socket object from the
2585
# saved file descriptor.
2586
return socket.fromfd(self.socketfd, *args, **kwargs)
2587
# Replace socket.socket() function with wrapper
2588
socket.socket = socket_wrapper
2589
# The socketserver.TCPServer.__init__ will call
2590
# socket.socket(), which might be our replacement,
2591
# socket_wrapper(), if socketfd was set.
1562
2592
socketserver.TCPServer.__init__(self, server_address,
1563
2593
RequestHandlerClass)
1564
2595
def server_bind(self):
1565
2596
"""This overrides the normal server_bind() function
1566
2597
to bind to an interface if one was specified, and also NOT to
1567
2598
bind to an address or port if they were not specified."""
2599
global SO_BINDTODEVICE
1568
2600
if self.interface is not None:
1569
2601
if SO_BINDTODEVICE is None:
1570
logger.error("SO_BINDTODEVICE does not exist;"
1571
" cannot bind to interface %s",
1575
self.socket.setsockopt(socket.SOL_SOCKET,
1579
except socket.error as error:
1580
if error[0] == errno.EPERM:
1581
logger.error("No permission to"
1582
" bind to interface %s",
1584
elif error[0] == errno.ENOPROTOOPT:
1585
logger.error("SO_BINDTODEVICE not available;"
1586
" cannot bind to interface %s",
2602
# Fall back to a hard-coded value which seems to be
2604
logger.warning("SO_BINDTODEVICE not found, trying 25")
2605
SO_BINDTODEVICE = 25
2607
self.socket.setsockopt(
2608
socket.SOL_SOCKET, SO_BINDTODEVICE,
2609
(self.interface + "\0").encode("utf-8"))
2610
except socket.error as error:
2611
if error.errno == errno.EPERM:
2612
logger.error("No permission to bind to"
2613
" interface %s", self.interface)
2614
elif error.errno == errno.ENOPROTOOPT:
2615
logger.error("SO_BINDTODEVICE not available;"
2616
" cannot bind to interface %s",
2618
elif error.errno == errno.ENODEV:
2619
logger.error("Interface %s does not exist,"
2620
" cannot bind", self.interface)
1590
2623
# Only bind(2) the socket if we really need to.
1591
2624
if self.server_address[0] or self.server_address[1]:
2625
if self.server_address[1]:
2626
self.allow_reuse_address = True
1592
2627
if not self.server_address[0]:
1593
2628
if self.address_family == socket.AF_INET6:
1594
any_address = "::" # in6addr_any
2629
any_address = "::" # in6addr_any
1596
any_address = socket.INADDR_ANY
2631
any_address = "0.0.0.0" # INADDR_ANY
1597
2632
self.server_address = (any_address,
1598
2633
self.server_address[1])
1599
2634
elif not self.server_address[1]:
1600
self.server_address = (self.server_address[0],
2635
self.server_address = (self.server_address[0], 0)
1602
2636
# if self.interface:
1603
2637
# self.server_address = (self.server_address[0],
1849
2965
parser.add_argument("--no-dbus", action="store_false",
1850
2966
dest="use_dbus", help="Do not provide D-Bus"
1851
" system bus interface")
2967
" system bus interface", default=None)
1852
2968
parser.add_argument("--no-ipv6", action="store_false",
1853
dest="use_ipv6", help="Do not use IPv6")
2969
dest="use_ipv6", help="Do not use IPv6",
2971
parser.add_argument("--no-restore", action="store_false",
2972
dest="restore", help="Do not restore stored"
2973
" state", default=None)
2974
parser.add_argument("--socket", type=int,
2975
help="Specify a file descriptor to a network"
2976
" socket to use instead of creating one")
2977
parser.add_argument("--statedir", metavar="DIR",
2978
help="Directory to save/restore state in")
2979
parser.add_argument("--foreground", action="store_true",
2980
help="Run in foreground", default=None)
2981
parser.add_argument("--no-zeroconf", action="store_false",
2982
dest="zeroconf", help="Do not use Zeroconf",
1854
2985
options = parser.parse_args()
1861
2987
# Default values for config file for server-global settings
1862
server_defaults = { "interface": "",
1867
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1868
"servicename": "Mandos",
2988
if gnutls.has_rawpk:
2989
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2990
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2992
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2993
":+SIGN-DSA-SHA256")
2994
server_defaults = {"interface": "",
2998
"priority": priority,
2999
"servicename": "Mandos",
3005
"statedir": "/var/lib/mandos",
3006
"foreground": "False",
1874
3011
# Parse config file for server-global settings
1875
server_config = configparser.SafeConfigParser(server_defaults)
3012
server_config = configparser.ConfigParser(server_defaults)
1876
3013
del server_defaults
1877
server_config.read(os.path.join(options.configdir,
1879
# Convert the SafeConfigParser object to a dict
3014
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3015
# Convert the ConfigParser object to a dict
1880
3016
server_settings = server_config.defaults()
1881
3017
# Use the appropriate methods on the non-string config options
1882
for option in ("debug", "use_dbus", "use_ipv6"):
3018
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3019
"foreground", "zeroconf"):
1883
3020
server_settings[option] = server_config.getboolean("DEFAULT",
1885
3022
if server_settings["port"]:
1886
3023
server_settings["port"] = server_config.getint("DEFAULT",
3025
if server_settings["socket"]:
3026
server_settings["socket"] = server_config.getint("DEFAULT",
3028
# Later, stdin will, and stdout and stderr might, be dup'ed
3029
# over with an opened os.devnull. But we don't want this to
3030
# happen with a supplied network socket.
3031
if 0 <= server_settings["socket"] <= 2:
3032
server_settings["socket"] = os.dup(server_settings
1888
3034
del server_config
1890
3036
# Override the settings from the config file with command line
1891
3037
# options, if set.
1892
3038
for option in ("interface", "address", "port", "debug",
1893
"priority", "servicename", "configdir",
1894
"use_dbus", "use_ipv6", "debuglevel"):
3039
"priority", "servicename", "configdir", "use_dbus",
3040
"use_ipv6", "debuglevel", "restore", "statedir",
3041
"socket", "foreground", "zeroconf"):
1895
3042
value = getattr(options, option)
1896
3043
if value is not None:
1897
3044
server_settings[option] = value
1899
3046
# Force all strings to be unicode
1900
3047
for option in server_settings.keys():
1901
if type(server_settings[option]) is str:
1902
server_settings[option] = unicode(server_settings[option])
3048
if isinstance(server_settings[option], bytes):
3049
server_settings[option] = (server_settings[option]
3051
# Force all boolean options to be boolean
3052
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3053
"foreground", "zeroconf"):
3054
server_settings[option] = bool(server_settings[option])
3055
# Debug implies foreground
3056
if server_settings["debug"]:
3057
server_settings["foreground"] = True
1903
3058
# Now we have our good server settings in "server_settings"
1905
3060
##################################################################
3062
if (not server_settings["zeroconf"]
3063
and not (server_settings["port"]
3064
or server_settings["socket"] != "")):
3065
parser.error("Needs port or socket to work without Zeroconf")
1907
3067
# For convenience
1908
3068
debug = server_settings["debug"]
1909
3069
debuglevel = server_settings["debuglevel"]
1910
3070
use_dbus = server_settings["use_dbus"]
1911
3071
use_ipv6 = server_settings["use_ipv6"]
3072
stored_state_path = os.path.join(server_settings["statedir"],
3074
foreground = server_settings["foreground"]
3075
zeroconf = server_settings["zeroconf"]
3078
initlogger(debug, logging.DEBUG)
3083
level = getattr(logging, debuglevel.upper())
3084
initlogger(debug, level)
1913
3086
if server_settings["servicename"] != "Mandos":
1914
syslogger.setFormatter(logging.Formatter
1915
('Mandos (%s) [%%(process)d]:'
1916
' %%(levelname)s: %%(message)s'
1917
% server_settings["servicename"]))
3087
syslogger.setFormatter(
3088
logging.Formatter('Mandos ({}) [%(process)d]:'
3089
' %(levelname)s: %(message)s'.format(
3090
server_settings["servicename"])))
1919
3092
# Parse config file with clients
1920
client_defaults = { "timeout": "5m",
1921
"extended_timeout": "15m",
1923
"checker": "fping -q -- %%(host)s",
1925
"approval_delay": "0s",
1926
"approval_duration": "1s",
1928
client_config = configparser.SafeConfigParser(client_defaults)
3093
client_config = configparser.ConfigParser(Client.client_defaults)
1929
3094
client_config.read(os.path.join(server_settings["configdir"],
1930
3095
"clients.conf"))
1932
3097
global mandos_dbus_service
1933
3098
mandos_dbus_service = None
1935
tcp_server = MandosServer((server_settings["address"],
1936
server_settings["port"]),
1938
interface=(server_settings["interface"]
1942
server_settings["priority"],
1945
pidfilename = "/var/run/mandos.pid"
1947
pidfile = open(pidfilename, "w")
1949
logger.error("Could not open file %r", pidfilename)
1952
uid = pwd.getpwnam("_mandos").pw_uid
1953
gid = pwd.getpwnam("_mandos").pw_gid
1956
uid = pwd.getpwnam("mandos").pw_uid
1957
gid = pwd.getpwnam("mandos").pw_gid
3101
if server_settings["socket"] != "":
3102
socketfd = server_settings["socket"]
3103
tcp_server = MandosServer(
3104
(server_settings["address"], server_settings["port"]),
3106
interface=(server_settings["interface"] or None),
3108
gnutls_priority=server_settings["priority"],
3112
pidfilename = "/run/mandos.pid"
3113
if not os.path.isdir("/run/."):
3114
pidfilename = "/var/run/mandos.pid"
3117
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3118
except IOError as e:
3119
logger.error("Could not open file %r", pidfilename,
3122
for name, group in (("_mandos", "_mandos"),
3123
("mandos", "mandos"),
3124
("nobody", "nogroup")):
3126
uid = pwd.getpwnam(name).pw_uid
3127
gid = pwd.getpwnam(group).pw_gid
1958
3129
except KeyError:
1960
uid = pwd.getpwnam("nobody").pw_uid
1961
gid = pwd.getpwnam("nobody").pw_gid
3138
logger.debug("Did setuid/setgid to {}:{}".format(uid,
1968
3140
except OSError as error:
1969
if error[0] != errno.EPERM:
1972
if not debug and not debuglevel:
1973
syslogger.setLevel(logging.WARNING)
1974
console.setLevel(logging.WARNING)
1976
level = getattr(logging, debuglevel.upper())
1977
syslogger.setLevel(level)
1978
console.setLevel(level)
3141
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3142
.format(uid, gid, os.strerror(error.errno)))
3143
if error.errno != errno.EPERM:
1981
3147
# Enable all possible GnuTLS debugging
1983
3149
# "Use a log level over 10 to enable all debugging options."
1984
3150
# - GnuTLS manual
1985
gnutls.library.functions.gnutls_global_set_log_level(11)
1987
@gnutls.library.types.gnutls_log_func
3151
gnutls.global_set_log_level(11)
1988
3154
def debug_gnutls(level, string):
1989
3155
logger.debug("GnuTLS: %s", string[:-1])
1991
(gnutls.library.functions
1992
.gnutls_global_set_log_function(debug_gnutls))
3157
gnutls.global_set_log_function(debug_gnutls)
1994
3159
# Redirect stdin so all checkers get /dev/null
1995
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3160
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1996
3161
os.dup2(null, sys.stdin.fileno())
2000
# No console logging
2001
logger.removeHandler(console)
2003
3165
# Need to fork before connecting to D-Bus
2005
3167
# Close all input and output, do double fork, etc.
3170
if gi.version_info < (3, 10, 2):
3171
# multiprocessing will use threads, so before we use GLib we
3172
# need to inform GLib that threads will be used.
2008
3175
global main_loop
2009
3176
# From the Avahi example code
2010
DBusGMainLoop(set_as_default=True )
2011
main_loop = gobject.MainLoop()
3177
DBusGMainLoop(set_as_default=True)
3178
main_loop = GLib.MainLoop()
2012
3179
bus = dbus.SystemBus()
2013
3180
# End of Avahi example code
2016
3183
bus_name = dbus.service.BusName("se.recompile.Mandos",
2017
bus, do_not_queue=True)
2018
old_bus_name = (dbus.service.BusName
2019
("se.bsnet.fukt.Mandos", bus,
2021
except dbus.exceptions.NameExistsException as e:
2022
logger.error(unicode(e) + ", disabling D-Bus")
3186
old_bus_name = dbus.service.BusName(
3187
"se.bsnet.fukt.Mandos", bus,
3189
except dbus.exceptions.DBusException as e:
3190
logger.error("Disabling D-Bus:", exc_info=e)
2023
3191
use_dbus = False
2024
3192
server_settings["use_dbus"] = False
2025
3193
tcp_server.use_dbus = False
2026
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2027
service = AvahiService(name = server_settings["servicename"],
2028
servicetype = "_mandos._tcp",
2029
protocol = protocol, bus = bus)
2030
if server_settings["interface"]:
2031
service.interface = (if_nametoindex
2032
(str(server_settings["interface"])))
3195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3196
service = AvahiServiceToSyslog(
3197
name=server_settings["servicename"],
3198
servicetype="_mandos._tcp",
3201
if server_settings["interface"]:
3202
service.interface = if_nametoindex(
3203
server_settings["interface"].encode("utf-8"))
2034
3205
global multiprocessing_manager
2035
3206
multiprocessing_manager = multiprocessing.Manager()
2037
3208
client_class = Client
2039
client_class = functools.partial(ClientDBusTransitional,
2041
def client_config_items(config, section):
2042
special_settings = {
2043
"approved_by_default":
2044
lambda: config.getboolean(section,
2045
"approved_by_default"),
2047
for name, value in config.items(section):
3210
client_class = functools.partial(ClientDBus, bus=bus)
3212
client_settings = Client.config_parser(client_config)
3213
old_client_settings = {}
3216
# This is used to redirect stdout and stderr for checker processes
3218
wnull = open(os.devnull, "w") # A writable /dev/null
3219
# Only used if server is running in foreground but not in debug
3221
if debug or not foreground:
3224
# Get client data and settings from last running state.
3225
if server_settings["restore"]:
3227
with open(stored_state_path, "rb") as stored_state:
3228
if sys.version_info.major == 2:
3229
clients_data, old_client_settings = pickle.load(
3232
bytes_clients_data, bytes_old_client_settings = (
3233
pickle.load(stored_state, encoding="bytes"))
3234
# Fix bytes to strings
3237
clients_data = {(key.decode("utf-8")
3238
if isinstance(key, bytes)
3241
bytes_clients_data.items()}
3242
del bytes_clients_data
3243
for key in clients_data:
3244
value = {(k.decode("utf-8")
3245
if isinstance(k, bytes) else k): v
3247
clients_data[key].items()}
3248
clients_data[key] = value
3250
value["client_structure"] = [
3252
if isinstance(s, bytes)
3254
value["client_structure"]]
3255
# .name, .host, and .checker_command
3256
for k in ("name", "host", "checker_command"):
3257
if isinstance(value[k], bytes):
3258
value[k] = value[k].decode("utf-8")
3259
if "key_id" not in value:
3260
value["key_id"] = ""
3261
elif "fingerprint" not in value:
3262
value["fingerprint"] = ""
3263
# old_client_settings
3265
old_client_settings = {
3266
(key.decode("utf-8")
3267
if isinstance(key, bytes)
3270
bytes_old_client_settings.items()}
3271
del bytes_old_client_settings
3272
# .host and .checker_command
3273
for value in old_client_settings.values():
3274
for attribute in ("host", "checker_command"):
3275
if isinstance(value[attribute], bytes):
3276
value[attribute] = (value[attribute]
3278
os.remove(stored_state_path)
3279
except IOError as e:
3280
if e.errno == errno.ENOENT:
3281
logger.warning("Could not load persistent state:"
3282
" {}".format(os.strerror(e.errno)))
3284
logger.critical("Could not load persistent state:",
3287
except EOFError as e:
3288
logger.warning("Could not load persistent state: "
3292
with PGPEngine() as pgp:
3293
for client_name, client in clients_data.items():
3294
# Skip removed clients
3295
if client_name not in client_settings:
3298
# Decide which value to use after restoring saved state.
3299
# We have three different values: Old config file,
3300
# new config file, and saved state.
3301
# New config value takes precedence if it differs from old
3302
# config value, otherwise use saved state.
3303
for name, value in client_settings[client_name].items():
3305
# For each value in new config, check if it
3306
# differs from the old config value (Except for
3307
# the "secret" attribute)
3308
if (name != "secret"
3310
old_client_settings[client_name][name])):
3311
client[name] = value
3315
# Clients who has passed its expire date can still be
3316
# enabled if its last checker was successful. A Client
3317
# whose checker succeeded before we stored its state is
3318
# assumed to have successfully run all checkers during
3320
if client["enabled"]:
3321
if datetime.datetime.utcnow() >= client["expires"]:
3322
if not client["last_checked_ok"]:
3324
"disabling client {} - Client never "
3325
"performed a successful checker".format(
3327
client["enabled"] = False
3328
elif client["last_checker_status"] != 0:
3330
"disabling client {} - Client last"
3331
" checker failed with error code"
3334
client["last_checker_status"]))
3335
client["enabled"] = False
3337
client["expires"] = (
3338
datetime.datetime.utcnow()
3339
+ client["timeout"])
3340
logger.debug("Last checker succeeded,"
3341
" keeping {} enabled".format(
2049
yield (name, special_settings[name]())
2053
tcp_server.clients.update(set(
2054
client_class(name = section,
2055
config= dict(client_config_items(
2056
client_config, section)))
2057
for section in client_config.sections()))
3344
client["secret"] = pgp.decrypt(
3345
client["encrypted_secret"],
3346
client_settings[client_name]["secret"])
3348
# If decryption fails, we use secret from new settings
3349
logger.debug("Failed to decrypt {} old secret".format(
3351
client["secret"] = (client_settings[client_name]
3354
# Add/remove clients based on new changes made to config
3355
for client_name in (set(old_client_settings)
3356
- set(client_settings)):
3357
del clients_data[client_name]
3358
for client_name in (set(client_settings)
3359
- set(old_client_settings)):
3360
clients_data[client_name] = client_settings[client_name]
3362
# Create all client objects
3363
for client_name, client in clients_data.items():
3364
tcp_server.clients[client_name] = client_class(
3367
server_settings=server_settings)
2058
3369
if not tcp_server.clients:
2059
3370
logger.warning("No clients defined")
2065
pidfile.write(str(pid) + "\n".encode("utf-8"))
2068
logger.error("Could not write to file %r with PID %d",
2071
# "pidfile" was never created
3373
if pidfile is not None:
3377
print(pid, file=pidfile)
3379
logger.error("Could not write to file %r with PID %d",
2073
3382
del pidfilename
2075
signal.signal(signal.SIGINT, signal.SIG_IGN)
2077
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2078
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3384
for termsig in (signal.SIGHUP, signal.SIGTERM):
3385
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3386
lambda: main_loop.quit() and False)
2081
class MandosDBusService(dbus.service.Object):
3390
@alternate_dbus_interfaces(
3391
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3392
class MandosDBusService(DBusObjectWithObjectManager):
2082
3393
"""A D-Bus proxy object"""
2083
3395
def __init__(self):
2084
3396
dbus.service.Object.__init__(self, bus, "/")
2085
3398
_interface = "se.recompile.Mandos"
2087
3400
@dbus.service.signal(_interface, signature="o")
2088
3401
def ClientAdded(self, objpath):
2092
3405
@dbus.service.signal(_interface, signature="ss")
2093
def ClientNotFound(self, fingerprint, address):
3406
def ClientNotFound(self, key_id, address):
3410
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2097
3412
@dbus.service.signal(_interface, signature="os")
2098
3413
def ClientRemoved(self, objpath, name):
3417
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2102
3419
@dbus.service.method(_interface, out_signature="ao")
2103
3420
def GetAllClients(self):
2105
return dbus.Array(c.dbus_object_path
2106
for c in tcp_server.clients)
3422
return dbus.Array(c.dbus_object_path for c in
3423
tcp_server.clients.values())
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2108
3427
@dbus.service.method(_interface,
2109
3428
out_signature="a{oa{sv}}")
2110
3429
def GetAllClientsWithProperties(self):
2112
3431
return dbus.Dictionary(
2113
((c.dbus_object_path, c.GetAll(""))
2114
for c in tcp_server.clients),
3432
{c.dbus_object_path: c.GetAll(
3433
"se.recompile.Mandos.Client")
3434
for c in tcp_server.clients.values()},
2115
3435
signature="oa{sv}")
2117
3437
@dbus.service.method(_interface, in_signature="o")
2118
3438
def RemoveClient(self, object_path):
2120
for c in tcp_server.clients:
3440
for c in tcp_server.clients.values():
2121
3441
if c.dbus_object_path == object_path:
2122
tcp_server.clients.remove(c)
3442
del tcp_server.clients[c.name]
2123
3443
c.remove_from_connection()
2124
# Don't signal anything except ClientRemoved
3444
# Don't signal the disabling
2125
3445
c.disable(quiet=True)
2127
self.ClientRemoved(object_path, c.name)
3446
# Emit D-Bus signal for removal
3447
self.client_removed_signal(c)
2129
3449
raise KeyError(object_path)
2133
class MandosDBusServiceTransitional(MandosDBusService):
2134
__metaclass__ = AlternateDBusNamesMetaclass
2135
mandos_dbus_service = MandosDBusServiceTransitional()
3453
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3454
out_signature="a{oa{sa{sv}}}")
3455
def GetManagedObjects(self):
3457
return dbus.Dictionary(
3458
{client.dbus_object_path:
3460
{interface: client.GetAll(interface)
3462
client._get_all_interface_names()})
3463
for client in tcp_server.clients.values()})
3465
def client_added_signal(self, client):
3466
"""Send the new standard signal and the old signal"""
3468
# New standard signal
3469
self.InterfacesAdded(
3470
client.dbus_object_path,
3472
{interface: client.GetAll(interface)
3474
client._get_all_interface_names()}))
3476
self.ClientAdded(client.dbus_object_path)
3478
def client_removed_signal(self, client):
3479
"""Send the new standard signal and the old signal"""
3481
# New standard signal
3482
self.InterfacesRemoved(
3483
client.dbus_object_path,
3484
client._get_all_interface_names())
3486
self.ClientRemoved(client.dbus_object_path,
3489
mandos_dbus_service = MandosDBusService()
3491
# Save modules to variables to exempt the modules from being
3492
# unloaded before the function registered with atexit() is run.
3493
mp = multiprocessing
2138
3497
"Cleanup function; run on exit"
2141
multiprocessing.active_children()
3501
mp.active_children()
3503
if not (tcp_server.clients or client_settings):
3506
# Store client before exiting. Secrets are encrypted with key
3507
# based on what config file has. If config file is
3508
# removed/edited, old secret will thus be unrecovable.
3510
with PGPEngine() as pgp:
3511
for client in tcp_server.clients.values():
3512
key = client_settings[client.name]["secret"]
3513
client.encrypted_secret = pgp.encrypt(client.secret,
3517
# A list of attributes that can not be pickled
3519
exclude = {"bus", "changedstate", "secret",
3520
"checker", "server_settings"}
3521
for name, typ in inspect.getmembers(dbus.service
3525
client_dict["encrypted_secret"] = (client
3527
for attr in client.client_structure:
3528
if attr not in exclude:
3529
client_dict[attr] = getattr(client, attr)
3531
clients[client.name] = client_dict
3532
del client_settings[client.name]["secret"]
3535
with tempfile.NamedTemporaryFile(
3539
dir=os.path.dirname(stored_state_path),
3540
delete=False) as stored_state:
3541
pickle.dump((clients, client_settings), stored_state,
3543
tempname = stored_state.name
3544
os.rename(tempname, stored_state_path)
3545
except (IOError, OSError) as e:
3551
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3552
logger.warning("Could not save persistent state: {}"
3553
.format(os.strerror(e.errno)))
3555
logger.warning("Could not save persistent state:",
3559
# Delete all clients, and settings from config
2142
3560
while tcp_server.clients:
2143
client = tcp_server.clients.pop()
3561
name, client = tcp_server.clients.popitem()
2145
3563
client.remove_from_connection()
2146
client.disable_hook = None
2147
# Don't signal anything except ClientRemoved
3564
# Don't signal the disabling
2148
3565
client.disable(quiet=True)
3566
# Emit D-Bus signal for removal
2151
mandos_dbus_service.ClientRemoved(client
3568
mandos_dbus_service.client_removed_signal(client)
3569
client_settings.clear()
2155
3571
atexit.register(cleanup)
2157
for client in tcp_server.clients:
3573
for client in tcp_server.clients.values():
2160
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3575
# Emit D-Bus signal for adding
3576
mandos_dbus_service.client_added_signal(client)
3577
# Need to initiate checking of clients
3579
client.init_checker()
2163
3581
tcp_server.enable()
2164
3582
tcp_server.server_activate()
2166
3584
# Find out what port we got
2167
service.port = tcp_server.socket.getsockname()[1]
3586
service.port = tcp_server.socket.getsockname()[1]
2169
3588
logger.info("Now listening on address %r, port %d,"
2170
" flowinfo %d, scope_id %d"
2171
% tcp_server.socket.getsockname())
3589
" flowinfo %d, scope_id %d",
3590
*tcp_server.socket.getsockname())
2173
logger.info("Now listening on address %r, port %d"
2174
% tcp_server.socket.getsockname())
2176
#service.interface = tcp_server.socket.getsockname()[3]
3592
logger.info("Now listening on address %r, port %d",
3593
*tcp_server.socket.getsockname())
3595
# service.interface = tcp_server.socket.getsockname()[3]
2179
# From the Avahi example code
2182
except dbus.exceptions.DBusException as error:
2183
logger.critical("DBusException: %s", error)
2186
# End of Avahi example code
2188
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2189
lambda *args, **kwargs:
2190
(tcp_server.handle_request
2191
(*args[2:], **kwargs) or True))
3599
# From the Avahi example code
3602
except dbus.exceptions.DBusException as error:
3603
logger.critical("D-Bus Exception", exc_info=error)
3606
# End of Avahi example code
3609
GLib.IOChannel.unix_new(tcp_server.fileno()),
3610
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3611
lambda *args, **kwargs: (tcp_server.handle_request
3612
(*args[2:], **kwargs) or True))
2193
3614
logger.debug("Starting main loop")
2194
3615
main_loop.run()
2195
3616
except AvahiError as error:
2196
logger.critical("AvahiError: %s", error)
3617
logger.critical("Avahi Error", exc_info=error)
2199
3620
except KeyboardInterrupt: