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 == "gpg" or self.gpg.endswith("/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()
443
1057
self.checker_callback_tag = None
444
1058
self.checker = None
445
if os.WIFEXITED(condition):
446
exitstatus = os.WEXITSTATUS(condition)
1061
self.last_checker_status = returncode
1062
self.last_checker_signal = None
1063
if self.last_checker_status == 0:
448
1064
logger.info("Checker for %(name)s succeeded",
450
1066
self.checked_ok()
452
logger.info("Checker for %(name)s failed",
1068
logger.info("Checker for %(name)s failed", vars(self))
1070
self.last_checker_status = -1
1071
self.last_checker_signal = -returncode
455
1072
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,
1076
def checked_ok(self):
1077
"""Assert that the client has been seen, alive and well."""
1078
self.last_checked_ok = datetime.datetime.utcnow()
1079
self.last_checker_status = 0
1080
self.last_checker_signal = None
1083
def bump_timeout(self, timeout=None):
1084
"""Bump up the timeout for this client."""
464
1085
if timeout is None:
465
1086
timeout = self.timeout
466
self.last_checked_ok = datetime.datetime.utcnow()
467
1087
if self.disable_initiator_tag is not None:
468
gobject.source_remove(self.disable_initiator_tag)
1088
GLib.source_remove(self.disable_initiator_tag)
1089
self.disable_initiator_tag = None
469
1090
if getattr(self, "enabled", False):
470
self.disable_initiator_tag = (gobject.timeout_add
471
(_timedelta_to_milliseconds
472
(timeout), self.disable))
1091
self.disable_initiator_tag = GLib.timeout_add(
1092
int(timeout.total_seconds() * 1000), self.disable)
473
1093
self.expires = datetime.datetime.utcnow() + timeout
475
1095
def need_approval(self):
476
1096
self.last_approval_request = datetime.datetime.utcnow()
478
1098
def start_checker(self):
479
1099
"""Start a new checker subprocess if one is not running.
481
1101
If a checker already exists, leave it running and do
483
1103
# 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
1104
# did that, and if a checker (for some reason) started running
1105
# slowly and taking more than 'interval' time, then the client
1106
# would inevitably timeout, since no checker would get a
1107
# chance to run to completion. If we instead leave running
488
1108
# checkers alone, the checker would have to take more time
489
1109
# 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)
1112
if self.checker is not None and not self.checker.is_alive():
1113
logger.warning("Checker was not alive; joining")
505
1116
# Start a new checker if needed
506
1117
if self.checker is None:
1118
# Escape attributes for the shell
1120
attr: re.escape(str(getattr(self, attr)))
1121
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
1123
command = self.checker_command % escaped_attrs
1124
except TypeError as error:
1125
logger.error('Could not format string "%s"',
1126
self.checker_command,
1128
return True # Try again later
526
1129
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
1130
logger.info("Starting checker %r for %s", command,
1132
# We don't need to redirect stdout and stderr, since
1133
# in normal mode, that is already done by daemon(),
1134
# and in debug mode we don't want to. (Stdin is
1135
# always replaced by /dev/null.)
1136
# The exception is when not debugging but nevertheless
1137
# running in the foreground; use the previously
1139
popen_args = {"close_fds": True,
1142
if (not self.server_settings["debug"]
1143
and self.server_settings["foreground"]):
1144
popen_args.update({"stdout": wnull,
1146
pipe = multiprocessing.Pipe(duplex=False)
1147
self.checker = multiprocessing.Process(
1149
args=(pipe[1], subprocess.call, command),
1151
self.checker.start()
1152
self.checker_callback_tag = GLib.io_add_watch(
1153
pipe[0].fileno(), GLib.IO_IN,
1154
self.checker_callback, pipe[0], command)
1155
# Re-run this periodically if run by GLib.timeout_add
553
1158
def stop_checker(self):
554
1159
"""Force the checker process, if any, to stop."""
555
1160
if self.checker_callback_tag:
556
gobject.source_remove(self.checker_callback_tag)
1161
GLib.source_remove(self.checker_callback_tag)
557
1162
self.checker_callback_tag = None
558
1163
if getattr(self, "checker", None) is None:
560
1165
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
1166
self.checker.terminate()
569
1167
self.checker = None
572
def dbus_service_property(dbus_interface, signature="v",
573
access="readwrite", byte_arrays=False):
1170
def dbus_service_property(dbus_interface,
574
1174
"""Decorators for marking methods of a DBusObjectWithProperties to
575
1175
become properties on the D-Bus.
577
1177
The decorated method will be called with no arguments by "Get"
578
1178
and with one argument by "Set".
580
1180
The parameters, where they are supported, are the same as
581
1181
dbus.service.method, except there is only "signature", since the
582
1182
type from Get() and the type sent to Set() is the same.
752
1515
except (AttributeError, xml.dom.DOMException,
753
1516
xml.parsers.expat.ExpatError) as error:
754
1517
logger.error("Failed to override Introspection method",
759
def datetime_to_dbus (dt, variant_level=0):
1523
dbus.OBJECT_MANAGER_IFACE
1524
except AttributeError:
1525
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1528
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1529
"""A D-Bus object with an ObjectManager.
1531
Classes inheriting from this exposes the standard
1532
GetManagedObjects call and the InterfacesAdded and
1533
InterfacesRemoved signals on the standard
1534
"org.freedesktop.DBus.ObjectManager" interface.
1536
Note: No signals are sent automatically; they must be sent
1539
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1540
out_signature="a{oa{sa{sv}}}")
1541
def GetManagedObjects(self):
1542
"""This function must be overridden"""
1543
raise NotImplementedError()
1545
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1546
signature="oa{sa{sv}}")
1547
def InterfacesAdded(self, object_path, interfaces_and_properties):
1550
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1551
def InterfacesRemoved(self, object_path, interfaces):
1554
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1556
path_keyword='object_path',
1557
connection_keyword='connection')
1558
def Introspect(self, object_path, connection):
1559
"""Overloading of standard D-Bus method.
1561
Override return argument name of GetManagedObjects to be
1562
"objpath_interfaces_and_properties"
1564
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1568
document = xml.dom.minidom.parseString(xmlstring)
1570
for if_tag in document.getElementsByTagName("interface"):
1571
# Fix argument name for the GetManagedObjects method
1572
if (if_tag.getAttribute("name")
1573
== dbus.OBJECT_MANAGER_IFACE):
1574
for cn in if_tag.getElementsByTagName("method"):
1575
if (cn.getAttribute("name")
1576
== "GetManagedObjects"):
1577
for arg in cn.getElementsByTagName("arg"):
1578
if (arg.getAttribute("direction")
1582
"objpath_interfaces"
1584
xmlstring = document.toxml("utf-8")
1586
except (AttributeError, xml.dom.DOMException,
1587
xml.parsers.expat.ExpatError) as error:
1588
logger.error("Failed to override Introspection method",
1593
def datetime_to_dbus(dt, variant_level=0):
760
1594
"""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.
1596
return dbus.String("", variant_level=variant_level)
1597
return dbus.String(dt.isoformat(), variant_level=variant_level)
1600
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1601
"""A class decorator; applied to a subclass of
1602
dbus.service.Object, it will add alternate D-Bus attributes with
1603
interface names according to the "alt_interface_names" mapping.
1606
@alternate_dbus_interfaces({"org.example.Interface":
1607
"net.example.AlternateInterface"})
1608
class SampleDBusObject(dbus.service.Object):
1609
@dbus.service.method("org.example.Interface")
1610
def SampleDBusMethod():
1613
The above "SampleDBusMethod" on "SampleDBusObject" will be
1614
reachable via two interfaces: "org.example.Interface" and
1615
"net.example.AlternateInterface", the latter of which will have
1616
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1617
"true", unless "deprecate" is passed with a False value.
1619
This works for methods and signals, and also for D-Bus properties
1620
(from DBusObjectWithProperties) and interfaces (from the
1621
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):
1625
for orig_interface_name, alt_interface_name in (
1626
alt_interface_names.items()):
1628
interface_names = set()
1629
# Go though all attributes of the class
1630
for attrname, attribute in inspect.getmembers(cls):
778
1631
# Ignore non-D-Bus attributes, and D-Bus attributes
779
1632
# with the wrong interface name
780
1633
if (not hasattr(attribute, "_dbus_interface")
781
or not attribute._dbus_interface
782
.startswith("se.recompile.Mandos")):
1634
or not attribute._dbus_interface.startswith(
1635
orig_interface_name)):
784
1637
# Create an alternate D-Bus interface name based on
785
1638
# the current name
786
alt_interface = (attribute._dbus_interface
787
.replace("se.recompile.Mandos",
788
"se.bsnet.fukt.Mandos"))
1639
alt_interface = attribute._dbus_interface.replace(
1640
orig_interface_name, alt_interface_name)
1641
interface_names.add(alt_interface)
789
1642
# Is this a D-Bus signal?
790
1643
if getattr(attribute, "_dbus_is_signal", False):
791
# Extract the original non-method function by
793
nonmethod_func = (dict(
1644
# Extract the original non-method undecorated
1645
# function by black magic
1646
if sys.version_info.major == 2:
1647
nonmethod_func = (dict(
794
1648
zip(attribute.func_code.co_freevars,
795
attribute.__closure__))["func"]
1649
attribute.__closure__))
1650
["func"].cell_contents)
1652
nonmethod_func = (dict(
1653
zip(attribute.__code__.co_freevars,
1654
attribute.__closure__))
1655
["func"].cell_contents)
797
1656
# Create a new, but exactly alike, function
798
1657
# object, and decorate it to be a new D-Bus signal
799
1658
# 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)))
1659
new_function = copy_function(nonmethod_func)
1660
new_function = (dbus.service.signal(
1662
attribute._dbus_signature)(new_function))
1663
# Copy annotations, if any
1665
new_function._dbus_annotations = dict(
1666
attribute._dbus_annotations)
1667
except AttributeError:
809
1670
# 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
1671
# original and alternate functions, so both the
1672
# original and alternate signals gets sent when
1673
# the function is called
812
1674
def fixscope(func1, func2):
813
1675
"""This function is a scope container to pass
814
1676
func1 and func2 to the "call_both" function
815
1677
outside of its arguments"""
1679
@functools.wraps(func2)
816
1680
def call_both(*args, **kwargs):
817
1681
"""This function will emit two D-Bus
818
1682
signals by calling func1 and func2"""
819
1683
func1(*args, **kwargs)
820
1684
func2(*args, **kwargs)
1685
# Make wrapper function look like a D-Bus
1687
for name, attr in inspect.getmembers(func2):
1688
if name.startswith("_dbus_"):
1689
setattr(call_both, name, attr)
821
1691
return call_both
822
1692
# Create the "call_both" function and add it to
824
attr[attrname] = fixscope(attribute,
1694
attr[attrname] = fixscope(attribute, new_function)
826
1695
# Is this a D-Bus method?
827
1696
elif getattr(attribute, "_dbus_is_method", False):
828
1697
# Create a new, but exactly alike, function
829
1698
# object. Decorate it to be a new D-Bus method
830
1699
# 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)))
1702
dbus.service.method(
1704
attribute._dbus_in_signature,
1705
attribute._dbus_out_signature)
1706
(copy_function(attribute)))
1707
# Copy annotations, if any
1709
attr[attrname]._dbus_annotations = dict(
1710
attribute._dbus_annotations)
1711
except AttributeError:
842
1713
# Is this a D-Bus property?
843
1714
elif getattr(attribute, "_dbus_is_property", False):
844
1715
# Create a new, but exactly alike, function
845
1716
# object, and decorate it to be a new D-Bus
846
1717
# property with the alternate D-Bus interface
847
1718
# 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)
1719
attr[attrname] = (dbus_service_property(
1720
alt_interface, attribute._dbus_signature,
1721
attribute._dbus_access,
1722
attribute._dbus_get_args_options
1724
(copy_function(attribute)))
1725
# Copy annotations, if any
1727
attr[attrname]._dbus_annotations = dict(
1728
attribute._dbus_annotations)
1729
except AttributeError:
1731
# Is this a D-Bus interface?
1732
elif getattr(attribute, "_dbus_is_interface", False):
1733
# Create a new, but exactly alike, function
1734
# object. Decorate it to be a new D-Bus interface
1735
# with the alternate D-Bus interface name. Add it
1738
dbus_interface_annotations(alt_interface)
1739
(copy_function(attribute)))
1741
# Deprecate all alternate interfaces
1742
iname = "_AlternateDBusNames_interface_annotation{}"
1743
for interface_name in interface_names:
1745
@dbus_interface_annotations(interface_name)
1747
return {"org.freedesktop.DBus.Deprecated":
1749
# Find an unused name
1750
for aname in (iname.format(i)
1751
for i in itertools.count()):
1752
if aname not in attr:
1756
# Replace the class with a new subclass of it with
1757
# methods, signals, etc. as created above.
1758
if sys.version_info.major == 2:
1759
cls = type(b"{}Alternate".format(cls.__name__),
1762
cls = type("{}Alternate".format(cls.__name__),
1769
@alternate_dbus_interfaces({"se.recompile.Mandos":
1770
"se.bsnet.fukt.Mandos"})
863
1771
class ClientDBus(Client, DBusObjectWithProperties):
864
1772
"""A Client class using D-Bus
867
1775
dbus_object_path: dbus.ObjectPath
868
1776
bus: dbus.SystemBus()
871
1779
runtime_expansions = (Client.runtime_expansions
872
+ ("dbus_object_path",))
1780
+ ("dbus_object_path", ))
1782
_interface = "se.recompile.Mandos.Client"
874
1784
# 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
1786
def __init__(self, bus=None, *args, **kwargs):
879
1788
Client.__init__(self, *args, **kwargs)
880
1789
# Only now, when this client is initialized, can it show up on
882
client_object_name = unicode(self.name).translate(
1791
client_object_name = str(self.name).translate(
883
1792
{ord("."): ord("_"),
884
1793
ord("-"): ord("_")})
885
self.dbus_object_path = (dbus.ObjectPath
886
("/clients/" + client_object_name))
1794
self.dbus_object_path = dbus.ObjectPath(
1795
"/clients/" + client_object_name)
887
1796
DBusObjectWithProperties.__init__(self, self.bus,
888
1797
self.dbus_object_path)
890
def notifychangeproperty(transform_func,
891
dbus_name, type_func=lambda x: x,
1799
def notifychangeproperty(transform_func, dbus_name,
1800
type_func=lambda x: x,
1802
invalidate_only=False,
1803
_interface=_interface):
893
1804
""" Modify a variable so that it's a property which announces
894
1805
its changes to DBus.
1246
2200
self.start_checker()
1248
2202
self.stop_checker()
1250
2204
# ObjectPath - property
2206
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2207
"org.freedesktop.DBus.Deprecated": "true"})
1251
2208
@dbus_service_property(_interface, signature="o", access="read")
1252
2209
def ObjectPath_dbus_property(self):
1253
return self.dbus_object_path # is already a dbus.ObjectPath
2210
return self.dbus_object_path # is already a dbus.ObjectPath
1255
2212
# Secret = property
1256
@dbus_service_property(_interface, signature="ay",
1257
access="write", byte_arrays=True)
2214
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2216
@dbus_service_property(_interface,
1258
2220
def Secret_dbus_property(self, value):
1259
self.secret = str(value)
2221
self.secret = bytes(value)
1264
class ProxyClient(object):
1265
def __init__(self, child_pipe, fpr, address):
2227
def __init__(self, child_pipe, key_id, fpr, address):
1266
2228
self._pipe = child_pipe
1267
self._pipe.send(('init', fpr, address))
2229
self._pipe.send(('init', key_id, fpr, address))
1268
2230
if not self._pipe.recv():
2231
raise KeyError(key_id or fpr)
1271
2233
def __getattribute__(self, name):
1272
if(name == '_pipe'):
1273
2235
return super(ProxyClient, self).__getattribute__(name)
1274
2236
self._pipe.send(('getattr', name))
1275
2237
data = self._pipe.recv()
1276
2238
if data[0] == 'data':
1278
2240
if data[0] == 'function':
1279
2242
def func(*args, **kwargs):
1280
2243
self._pipe.send(('funcall', name, args, kwargs))
1281
2244
return self._pipe.recv()[1]
1284
2248
def __setattr__(self, name, value):
1285
if(name == '_pipe'):
1286
2250
return super(ProxyClient, self).__setattr__(name, value)
1287
2251
self._pipe.send(('setattr', name, value))
1289
class ClientDBusTransitional(ClientDBus):
1290
__metaclass__ = AlternateDBusNamesMetaclass
1292
2254
class ClientHandler(socketserver.BaseRequestHandler, object):
1293
2255
"""A class to handle client connections.
1295
2257
Instantiated once for each connection to handle it.
1296
2258
Note: This will run in its own forked process."""
1298
2260
def handle(self):
1299
2261
with contextlib.closing(self.server.child_pipe) as child_pipe:
1300
2262
logger.info("TCP connection from: %s",
1301
unicode(self.client_address))
2263
str(self.client_address))
1302
2264
logger.debug("Pipe FD: %d",
1303
2265
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",
2267
session = gnutls.ClientSession(self.request)
2269
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2270
# "+AES-256-CBC", "+SHA1",
2271
# "+COMP-NULL", "+CTYPE-OPENPGP",
1319
2273
# Use a fallback default, since this MUST be set.
1320
2274
priority = self.server.gnutls_priority
1321
2275
if priority is None:
1322
2276
priority = "NORMAL"
1323
(gnutls.library.functions
1324
.gnutls_priority_set_direct(session._c_object,
2277
gnutls.priority_set_direct(session._c_object,
2278
priority.encode("utf-8"),
1327
2281
# Start communication using the Mandos protocol
1328
2282
# Get protocol number
1329
2283
line = self.request.makefile().readline()
1330
2284
logger.debug("Protocol version: %r", line)
1332
2286
if int(line.strip().split()[0]) > 1:
2287
raise RuntimeError(line)
1334
2288
except (ValueError, IndexError, RuntimeError) as error:
1335
2289
logger.error("Unknown protocol version: %s", error)
1338
2292
# Start GnuTLS connection
1340
2294
session.handshake()
1341
except gnutls.errors.GNUTLSError as error:
2295
except gnutls.Error as error:
1342
2296
logger.warning("Handshake failed: %s", error)
1343
2297
# Do not run session.bye() here: the session is not
1344
2298
# established. Just abandon the request.
1346
2300
logger.debug("Handshake succeeded")
1348
2302
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,
2304
if gnutls.has_rawpk:
2307
key_id = self.key_id(
2308
self.peer_certificate(session))
2309
except (TypeError, gnutls.Error) as error:
2310
logger.warning("Bad certificate: %s", error)
2312
logger.debug("Key ID: %s", key_id)
2317
fpr = self.fingerprint(
2318
self.peer_certificate(session))
2319
except (TypeError, gnutls.Error) as error:
2320
logger.warning("Bad certificate: %s", error)
2322
logger.debug("Fingerprint: %s", fpr)
2325
client = ProxyClient(child_pipe, key_id, fpr,
1361
2326
self.client_address)
1362
2327
except KeyError:
1365
2330
if client.approval_delay:
1366
2331
delay = client.approval_delay
1367
2332
client.approvals_pending += 1
1368
2333
approval_required = True
1371
2336
if not client.enabled:
1372
2337
logger.info("Client %s is disabled",
1374
2339
if self.server.use_dbus:
1375
2340
# Emit D-Bus signal
1376
2341
client.Rejected("Disabled")
1379
if client._approved or not client.approval_delay:
1380
#We are approved or approval is disabled
2344
if client.approved or not client.approval_delay:
2345
# We are approved or approval is disabled
1382
elif client._approved is None:
2347
elif client.approved is None:
1383
2348
logger.info("Client %s needs approval",
1385
2350
if self.server.use_dbus:
1386
2351
# Emit D-Bus signal
1387
2352
client.NeedApproval(
1388
client.approval_delay_milliseconds(),
1389
client.approved_by_default)
2353
client.approval_delay.total_seconds()
2354
* 1000, client.approved_by_default)
1391
2356
logger.warning("Client %s was not approved",
1418
2381
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))
2384
session.send(client.secret)
2385
except gnutls.Error as error:
2386
logger.warning("gnutls send failed",
1432
2390
logger.info("Sending secret to %s", client.name)
1433
2391
# bump the timeout using extended_timeout
1434
client.checked_ok(client.extended_timeout)
2392
client.bump_timeout(client.extended_timeout)
1435
2393
if self.server.use_dbus:
1436
2394
# Emit D-Bus signal
1437
2395
client.GotSecret()
1440
2398
if approval_required:
1441
2399
client.approvals_pending -= 1
1444
except gnutls.errors.GNUTLSError as error:
1445
logger.warning("GnuTLS bye failed")
2402
except gnutls.Error as error:
2403
logger.warning("GnuTLS bye failed",
1448
2407
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
2408
"Return the peer's certificate as a bytestring"
2410
cert_type = gnutls.certificate_type_get2(session._c_object,
2412
except AttributeError:
2413
cert_type = gnutls.certificate_type_get(session._c_object)
2414
if gnutls.has_rawpk:
2415
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2417
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2418
# If not a valid certificate type...
2419
if cert_type not in valid_cert_types:
2420
logger.info("Cert type %r not in %r", cert_type,
2422
# ...return invalid data
1456
2424
list_size = ctypes.c_uint(1)
1457
cert_list = (gnutls.library.functions
1458
.gnutls_certificate_get_peers
2425
cert_list = (gnutls.certificate_get_peers
1459
2426
(session._c_object, ctypes.byref(list_size)))
1460
2427
if not bool(cert_list) and list_size.value != 0:
1461
raise gnutls.errors.GNUTLSError("error getting peer"
2428
raise gnutls.Error("error getting peer certificate")
1463
2429
if list_size.value == 0:
1465
2431
cert = cert_list[0]
1466
2432
return ctypes.string_at(cert.data, cert.size)
2435
def key_id(certificate):
2436
"Convert a certificate bytestring to a hexdigit key ID"
2437
# New GnuTLS "datum" with the public key
2438
datum = gnutls.datum_t(
2439
ctypes.cast(ctypes.c_char_p(certificate),
2440
ctypes.POINTER(ctypes.c_ubyte)),
2441
ctypes.c_uint(len(certificate)))
2442
# XXX all these need to be created in the gnutls "module"
2443
# New empty GnuTLS certificate
2444
pubkey = gnutls.pubkey_t()
2445
gnutls.pubkey_init(ctypes.byref(pubkey))
2446
# Import the raw public key into the certificate
2447
gnutls.pubkey_import(pubkey,
2448
ctypes.byref(datum),
2449
gnutls.X509_FMT_DER)
2450
# New buffer for the key ID
2451
buf = ctypes.create_string_buffer(32)
2452
buf_len = ctypes.c_size_t(len(buf))
2453
# Get the key ID from the raw public key into the buffer
2454
gnutls.pubkey_get_key_id(pubkey,
2455
gnutls.KEYID_USE_SHA256,
2456
ctypes.cast(ctypes.byref(buf),
2457
ctypes.POINTER(ctypes.c_ubyte)),
2458
ctypes.byref(buf_len))
2459
# Deinit the certificate
2460
gnutls.pubkey_deinit(pubkey)
2462
# Convert the buffer to a Python bytestring
2463
key_id = ctypes.string_at(buf, buf_len.value)
2464
# Convert the bytestring to hexadecimal notation
2465
hex_key_id = binascii.hexlify(key_id).upper()
1469
2469
def fingerprint(openpgp):
1470
2470
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1471
2471
# 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))))
2472
datum = gnutls.datum_t(
2473
ctypes.cast(ctypes.c_char_p(openpgp),
2474
ctypes.POINTER(ctypes.c_ubyte)),
2475
ctypes.c_uint(len(openpgp)))
1477
2476
# 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)))
2477
crt = gnutls.openpgp_crt_t()
2478
gnutls.openpgp_crt_init(ctypes.byref(crt))
1481
2479
# 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))
2480
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2481
gnutls.OPENPGP_FMT_RAW)
1486
2482
# Verify the self signature in the key
1487
2483
crtverify = ctypes.c_uint()
1488
(gnutls.library.functions
1489
.gnutls_openpgp_crt_verify_self(crt, 0,
1490
ctypes.byref(crtverify)))
2484
gnutls.openpgp_crt_verify_self(crt, 0,
2485
ctypes.byref(crtverify))
1491
2486
if crtverify.value != 0:
1492
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1493
raise (gnutls.errors.CertificateSecurityError
2487
gnutls.openpgp_crt_deinit(crt)
2488
raise gnutls.CertificateSecurityError(code
1495
2490
# New buffer for the fingerprint
1496
2491
buf = ctypes.create_string_buffer(20)
1497
2492
buf_len = ctypes.c_size_t()
1498
2493
# 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)))
2494
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2495
ctypes.byref(buf_len))
1502
2496
# Deinit the certificate
1503
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2497
gnutls.openpgp_crt_deinit(crt)
1504
2498
# Convert the buffer to a Python bytestring
1505
2499
fpr = ctypes.string_at(buf, buf_len.value)
1506
2500
# Convert the bytestring to hexadecimal notation
1507
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2501
hex_fpr = binascii.hexlify(fpr).upper()
1511
class MultiprocessingMixIn(object):
2505
class MultiprocessingMixIn:
1512
2506
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1513
2508
def sub_process_main(self, request, address):
1515
2510
self.finish_request(request, address)
1517
2512
self.handle_error(request, address)
1518
2513
self.close_request(request)
1520
2515
def process_request(self, request, address):
1521
2516
"""Start a new process to process the request."""
1522
proc = multiprocessing.Process(target = self.sub_process_main,
2517
proc = multiprocessing.Process(target=self.sub_process_main,
2518
args=(request, address))
1529
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2523
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1530
2524
""" adds a pipe to the MixIn """
1531
2526
def process_request(self, request, client_address):
1532
2527
"""Overrides and wraps the original process_request().
1534
2529
This function creates a new pipe in self.pipe
1536
2531
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1538
2533
proc = MultiprocessingMixIn.process_request(self, request,
1539
2534
client_address)
1540
2535
self.child_pipe.close()
1541
2536
self.add_pipe(parent_pipe, proc)
1543
2538
def add_pipe(self, parent_pipe, proc):
1544
2539
"""Dummy function; override as necessary"""
1545
raise NotImplementedError
2540
raise NotImplementedError()
1548
2543
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1549
socketserver.TCPServer, object):
2544
socketserver.TCPServer):
1550
2545
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1553
2548
enabled: Boolean; whether this server is activated yet
1554
2549
interface: None or a network interface name (string)
1555
2550
use_ipv6: Boolean; to use IPv6 or not
1557
2553
def __init__(self, server_address, RequestHandlerClass,
1558
interface=None, use_ipv6=True):
2557
"""If socketfd is set, use that file descriptor instead of
2558
creating a new one with socket.socket().
1559
2560
self.interface = interface
1561
2562
self.address_family = socket.AF_INET6
2563
if socketfd is not None:
2564
# Save the file descriptor
2565
self.socketfd = socketfd
2566
# Save the original socket.socket() function
2567
self.socket_socket = socket.socket
2569
# To implement --socket, we monkey patch socket.socket.
2571
# (When socketserver.TCPServer is a new-style class, we
2572
# could make self.socket into a property instead of monkey
2573
# patching socket.socket.)
2575
# Create a one-time-only replacement for socket.socket()
2576
@functools.wraps(socket.socket)
2577
def socket_wrapper(*args, **kwargs):
2578
# Restore original function so subsequent calls are
2580
socket.socket = self.socket_socket
2581
del self.socket_socket
2582
# This time only, return a new socket object from the
2583
# saved file descriptor.
2584
return socket.fromfd(self.socketfd, *args, **kwargs)
2585
# Replace socket.socket() function with wrapper
2586
socket.socket = socket_wrapper
2587
# The socketserver.TCPServer.__init__ will call
2588
# socket.socket(), which might be our replacement,
2589
# socket_wrapper(), if socketfd was set.
1562
2590
socketserver.TCPServer.__init__(self, server_address,
1563
2591
RequestHandlerClass)
1564
2593
def server_bind(self):
1565
2594
"""This overrides the normal server_bind() function
1566
2595
to bind to an interface if one was specified, and also NOT to
1567
2596
bind to an address or port if they were not specified."""
2597
global SO_BINDTODEVICE
1568
2598
if self.interface is not None:
1569
2599
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",
2600
# Fall back to a hard-coded value which seems to be
2602
logger.warning("SO_BINDTODEVICE not found, trying 25")
2603
SO_BINDTODEVICE = 25
2605
self.socket.setsockopt(
2606
socket.SOL_SOCKET, SO_BINDTODEVICE,
2607
(self.interface + "\0").encode("utf-8"))
2608
except socket.error as error:
2609
if error.errno == errno.EPERM:
2610
logger.error("No permission to bind to"
2611
" interface %s", self.interface)
2612
elif error.errno == errno.ENOPROTOOPT:
2613
logger.error("SO_BINDTODEVICE not available;"
2614
" cannot bind to interface %s",
2616
elif error.errno == errno.ENODEV:
2617
logger.error("Interface %s does not exist,"
2618
" cannot bind", self.interface)
1590
2621
# Only bind(2) the socket if we really need to.
1591
2622
if self.server_address[0] or self.server_address[1]:
2623
if self.server_address[1]:
2624
self.allow_reuse_address = True
1592
2625
if not self.server_address[0]:
1593
2626
if self.address_family == socket.AF_INET6:
1594
any_address = "::" # in6addr_any
2627
any_address = "::" # in6addr_any
1596
any_address = socket.INADDR_ANY
2629
any_address = "0.0.0.0" # INADDR_ANY
1597
2630
self.server_address = (any_address,
1598
2631
self.server_address[1])
1599
2632
elif not self.server_address[1]:
1600
self.server_address = (self.server_address[0],
2633
self.server_address = (self.server_address[0], 0)
1602
2634
# if self.interface:
1603
2635
# self.server_address = (self.server_address[0],
1849
2963
parser.add_argument("--no-dbus", action="store_false",
1850
2964
dest="use_dbus", help="Do not provide D-Bus"
1851
" system bus interface")
2965
" system bus interface", default=None)
1852
2966
parser.add_argument("--no-ipv6", action="store_false",
1853
dest="use_ipv6", help="Do not use IPv6")
2967
dest="use_ipv6", help="Do not use IPv6",
2969
parser.add_argument("--no-restore", action="store_false",
2970
dest="restore", help="Do not restore stored"
2971
" state", default=None)
2972
parser.add_argument("--socket", type=int,
2973
help="Specify a file descriptor to a network"
2974
" socket to use instead of creating one")
2975
parser.add_argument("--statedir", metavar="DIR",
2976
help="Directory to save/restore state in")
2977
parser.add_argument("--foreground", action="store_true",
2978
help="Run in foreground", default=None)
2979
parser.add_argument("--no-zeroconf", action="store_false",
2980
dest="zeroconf", help="Do not use Zeroconf",
1854
2983
options = parser.parse_args()
1861
2985
# Default values for config file for server-global settings
1862
server_defaults = { "interface": "",
1867
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1868
"servicename": "Mandos",
2986
if gnutls.has_rawpk:
2987
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2988
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2990
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2991
":+SIGN-DSA-SHA256")
2992
server_defaults = {"interface": "",
2996
"priority": priority,
2997
"servicename": "Mandos",
3003
"statedir": "/var/lib/mandos",
3004
"foreground": "False",
1874
3009
# Parse config file for server-global settings
1875
server_config = configparser.SafeConfigParser(server_defaults)
3010
server_config = configparser.ConfigParser(server_defaults)
1876
3011
del server_defaults
1877
server_config.read(os.path.join(options.configdir,
1879
# Convert the SafeConfigParser object to a dict
3012
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3013
# Convert the ConfigParser object to a dict
1880
3014
server_settings = server_config.defaults()
1881
3015
# Use the appropriate methods on the non-string config options
1882
for option in ("debug", "use_dbus", "use_ipv6"):
3016
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3017
"foreground", "zeroconf"):
1883
3018
server_settings[option] = server_config.getboolean("DEFAULT",
1885
3020
if server_settings["port"]:
1886
3021
server_settings["port"] = server_config.getint("DEFAULT",
3023
if server_settings["socket"]:
3024
server_settings["socket"] = server_config.getint("DEFAULT",
3026
# Later, stdin will, and stdout and stderr might, be dup'ed
3027
# over with an opened os.devnull. But we don't want this to
3028
# happen with a supplied network socket.
3029
if 0 <= server_settings["socket"] <= 2:
3030
server_settings["socket"] = os.dup(server_settings
1888
3032
del server_config
1890
3034
# Override the settings from the config file with command line
1891
3035
# options, if set.
1892
3036
for option in ("interface", "address", "port", "debug",
1893
"priority", "servicename", "configdir",
1894
"use_dbus", "use_ipv6", "debuglevel"):
3037
"priority", "servicename", "configdir", "use_dbus",
3038
"use_ipv6", "debuglevel", "restore", "statedir",
3039
"socket", "foreground", "zeroconf"):
1895
3040
value = getattr(options, option)
1896
3041
if value is not None:
1897
3042
server_settings[option] = value
1899
3044
# Force all strings to be unicode
1900
3045
for option in server_settings.keys():
1901
if type(server_settings[option]) is str:
1902
server_settings[option] = unicode(server_settings[option])
3046
if isinstance(server_settings[option], bytes):
3047
server_settings[option] = (server_settings[option]
3049
# Force all boolean options to be boolean
3050
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3051
"foreground", "zeroconf"):
3052
server_settings[option] = bool(server_settings[option])
3053
# Debug implies foreground
3054
if server_settings["debug"]:
3055
server_settings["foreground"] = True
1903
3056
# Now we have our good server settings in "server_settings"
1905
3058
##################################################################
3060
if (not server_settings["zeroconf"]
3061
and not (server_settings["port"]
3062
or server_settings["socket"] != "")):
3063
parser.error("Needs port or socket to work without Zeroconf")
1907
3065
# For convenience
1908
3066
debug = server_settings["debug"]
1909
3067
debuglevel = server_settings["debuglevel"]
1910
3068
use_dbus = server_settings["use_dbus"]
1911
3069
use_ipv6 = server_settings["use_ipv6"]
3070
stored_state_path = os.path.join(server_settings["statedir"],
3072
foreground = server_settings["foreground"]
3073
zeroconf = server_settings["zeroconf"]
3076
initlogger(debug, logging.DEBUG)
3081
level = getattr(logging, debuglevel.upper())
3082
initlogger(debug, level)
1913
3084
if server_settings["servicename"] != "Mandos":
1914
syslogger.setFormatter(logging.Formatter
1915
('Mandos (%s) [%%(process)d]:'
1916
' %%(levelname)s: %%(message)s'
1917
% server_settings["servicename"]))
3085
syslogger.setFormatter(
3086
logging.Formatter('Mandos ({}) [%(process)d]:'
3087
' %(levelname)s: %(message)s'.format(
3088
server_settings["servicename"])))
1919
3090
# 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)
3091
client_config = configparser.ConfigParser(Client.client_defaults)
1929
3092
client_config.read(os.path.join(server_settings["configdir"],
1930
3093
"clients.conf"))
1932
3095
global mandos_dbus_service
1933
3096
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
3099
if server_settings["socket"] != "":
3100
socketfd = server_settings["socket"]
3101
tcp_server = MandosServer(
3102
(server_settings["address"], server_settings["port"]),
3104
interface=(server_settings["interface"] or None),
3106
gnutls_priority=server_settings["priority"],
3110
pidfilename = "/run/mandos.pid"
3111
if not os.path.isdir("/run/."):
3112
pidfilename = "/var/run/mandos.pid"
3115
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3116
except IOError as e:
3117
logger.error("Could not open file %r", pidfilename,
3120
for name, group in (("_mandos", "_mandos"),
3121
("mandos", "mandos"),
3122
("nobody", "nogroup")):
3124
uid = pwd.getpwnam(name).pw_uid
3125
gid = pwd.getpwnam(group).pw_gid
1958
3127
except KeyError:
1960
uid = pwd.getpwnam("nobody").pw_uid
1961
gid = pwd.getpwnam("nobody").pw_gid
3136
logger.debug("Did setuid/setgid to {}:{}".format(uid,
1968
3138
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)
3139
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3140
.format(uid, gid, os.strerror(error.errno)))
3141
if error.errno != errno.EPERM:
1981
3145
# Enable all possible GnuTLS debugging
1983
3147
# "Use a log level over 10 to enable all debugging options."
1984
3148
# - GnuTLS manual
1985
gnutls.library.functions.gnutls_global_set_log_level(11)
1987
@gnutls.library.types.gnutls_log_func
3149
gnutls.global_set_log_level(11)
1988
3152
def debug_gnutls(level, string):
1989
3153
logger.debug("GnuTLS: %s", string[:-1])
1991
(gnutls.library.functions
1992
.gnutls_global_set_log_function(debug_gnutls))
3155
gnutls.global_set_log_function(debug_gnutls)
1994
3157
# Redirect stdin so all checkers get /dev/null
1995
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3158
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1996
3159
os.dup2(null, sys.stdin.fileno())
2000
# No console logging
2001
logger.removeHandler(console)
2003
3163
# Need to fork before connecting to D-Bus
2005
3165
# Close all input and output, do double fork, etc.
3168
if gi.version_info < (3, 10, 2):
3169
# multiprocessing will use threads, so before we use GLib we
3170
# need to inform GLib that threads will be used.
2008
3173
global main_loop
2009
3174
# From the Avahi example code
2010
DBusGMainLoop(set_as_default=True )
2011
main_loop = gobject.MainLoop()
3175
DBusGMainLoop(set_as_default=True)
3176
main_loop = GLib.MainLoop()
2012
3177
bus = dbus.SystemBus()
2013
3178
# End of Avahi example code
2016
3181
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")
3184
old_bus_name = dbus.service.BusName(
3185
"se.bsnet.fukt.Mandos", bus,
3187
except dbus.exceptions.DBusException as e:
3188
logger.error("Disabling D-Bus:", exc_info=e)
2023
3189
use_dbus = False
2024
3190
server_settings["use_dbus"] = False
2025
3191
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"])))
3193
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3194
service = AvahiServiceToSyslog(
3195
name=server_settings["servicename"],
3196
servicetype="_mandos._tcp",
3199
if server_settings["interface"]:
3200
service.interface = if_nametoindex(
3201
server_settings["interface"].encode("utf-8"))
2034
3203
global multiprocessing_manager
2035
3204
multiprocessing_manager = multiprocessing.Manager()
2037
3206
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):
3208
client_class = functools.partial(ClientDBus, bus=bus)
3210
client_settings = Client.config_parser(client_config)
3211
old_client_settings = {}
3214
# This is used to redirect stdout and stderr for checker processes
3216
wnull = open(os.devnull, "w") # A writable /dev/null
3217
# Only used if server is running in foreground but not in debug
3219
if debug or not foreground:
3222
# Get client data and settings from last running state.
3223
if server_settings["restore"]:
3225
with open(stored_state_path, "rb") as stored_state:
3226
if sys.version_info.major == 2:
3227
clients_data, old_client_settings = pickle.load(
3230
bytes_clients_data, bytes_old_client_settings = (
3231
pickle.load(stored_state, encoding="bytes"))
3232
# Fix bytes to strings
3235
clients_data = {(key.decode("utf-8")
3236
if isinstance(key, bytes)
3239
bytes_clients_data.items()}
3240
del bytes_clients_data
3241
for key in clients_data:
3242
value = {(k.decode("utf-8")
3243
if isinstance(k, bytes) else k): v
3245
clients_data[key].items()}
3246
clients_data[key] = value
3248
value["client_structure"] = [
3250
if isinstance(s, bytes)
3252
value["client_structure"]]
3254
for k in ("name", "host"):
3255
if isinstance(value[k], bytes):
3256
value[k] = value[k].decode("utf-8")
3257
if "key_id" not in value:
3258
value["key_id"] = ""
3259
elif "fingerprint" not in value:
3260
value["fingerprint"] = ""
3261
# old_client_settings
3263
old_client_settings = {
3264
(key.decode("utf-8")
3265
if isinstance(key, bytes)
3268
bytes_old_client_settings.items()}
3269
del bytes_old_client_settings
3271
for value in old_client_settings.values():
3272
if isinstance(value["host"], bytes):
3273
value["host"] = (value["host"]
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(
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()))
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)
2058
3366
if not tcp_server.clients:
2059
3367
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
3370
if pidfile is not None:
3374
print(pid, file=pidfile)
3376
logger.error("Could not write to file %r with PID %d",
2073
3379
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())
3381
for termsig in (signal.SIGHUP, signal.SIGTERM):
3382
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3383
lambda: main_loop.quit() and False)
2081
class MandosDBusService(dbus.service.Object):
3387
@alternate_dbus_interfaces(
3388
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3389
class MandosDBusService(DBusObjectWithObjectManager):
2082
3390
"""A D-Bus proxy object"""
2083
3392
def __init__(self):
2084
3393
dbus.service.Object.__init__(self, bus, "/")
2085
3395
_interface = "se.recompile.Mandos"
2087
3397
@dbus.service.signal(_interface, signature="o")
2088
3398
def ClientAdded(self, objpath):
2092
3402
@dbus.service.signal(_interface, signature="ss")
2093
def ClientNotFound(self, fingerprint, address):
3403
def ClientNotFound(self, key_id, address):
3407
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2097
3409
@dbus.service.signal(_interface, signature="os")
2098
3410
def ClientRemoved(self, objpath, name):
3414
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2102
3416
@dbus.service.method(_interface, out_signature="ao")
2103
3417
def GetAllClients(self):
2105
return dbus.Array(c.dbus_object_path
2106
for c in tcp_server.clients)
3419
return dbus.Array(c.dbus_object_path for c in
3420
tcp_server.clients.values())
3422
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2108
3424
@dbus.service.method(_interface,
2109
3425
out_signature="a{oa{sv}}")
2110
3426
def GetAllClientsWithProperties(self):
2112
3428
return dbus.Dictionary(
2113
((c.dbus_object_path, c.GetAll(""))
2114
for c in tcp_server.clients),
3429
{c.dbus_object_path: c.GetAll(
3430
"se.recompile.Mandos.Client")
3431
for c in tcp_server.clients.values()},
2115
3432
signature="oa{sv}")
2117
3434
@dbus.service.method(_interface, in_signature="o")
2118
3435
def RemoveClient(self, object_path):
2120
for c in tcp_server.clients:
3437
for c in tcp_server.clients.values():
2121
3438
if c.dbus_object_path == object_path:
2122
tcp_server.clients.remove(c)
3439
del tcp_server.clients[c.name]
2123
3440
c.remove_from_connection()
2124
# Don't signal anything except ClientRemoved
3441
# Don't signal the disabling
2125
3442
c.disable(quiet=True)
2127
self.ClientRemoved(object_path, c.name)
3443
# Emit D-Bus signal for removal
3444
self.client_removed_signal(c)
2129
3446
raise KeyError(object_path)
2133
class MandosDBusServiceTransitional(MandosDBusService):
2134
__metaclass__ = AlternateDBusNamesMetaclass
2135
mandos_dbus_service = MandosDBusServiceTransitional()
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
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
2138
3494
"Cleanup function; run on exit"
2141
multiprocessing.active_children()
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
2142
3557
while tcp_server.clients:
2143
client = tcp_server.clients.pop()
3558
name, client = tcp_server.clients.popitem()
2145
3560
client.remove_from_connection()
2146
client.disable_hook = None
2147
# Don't signal anything except ClientRemoved
3561
# Don't signal the disabling
2148
3562
client.disable(quiet=True)
3563
# Emit D-Bus signal for removal
2151
mandos_dbus_service.ClientRemoved(client
3565
mandos_dbus_service.client_removed_signal(client)
3566
client_settings.clear()
2155
3568
atexit.register(cleanup)
2157
for client in tcp_server.clients:
3570
for client in tcp_server.clients.values():
2160
mandos_dbus_service.ClientAdded(client.dbus_object_path)
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()
2163
3578
tcp_server.enable()
2164
3579
tcp_server.server_activate()
2166
3581
# Find out what port we got
2167
service.port = tcp_server.socket.getsockname()[1]
3583
service.port = tcp_server.socket.getsockname()[1]
2169
3585
logger.info("Now listening on address %r, port %d,"
2170
" flowinfo %d, scope_id %d"
2171
% tcp_server.socket.getsockname())
3586
" flowinfo %d, scope_id %d",
3587
*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]
3589
logger.info("Now listening on address %r, port %d",
3590
*tcp_server.socket.getsockname())
3592
# 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))
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
3605
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3606
lambda *args, **kwargs:
3607
(tcp_server.handle_request
3608
(*args[2:], **kwargs) or True))
2193
3610
logger.debug("Starting main loop")
2194
3611
main_loop.run()
2195
3612
except AvahiError as error:
2196
logger.critical("AvahiError: %s", error)
3613
logger.critical("Avahi Error", exc_info=error)
2199
3616
except KeyboardInterrupt: