70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
82
69
import dbus.service
84
from gi.repository import GLib
85
72
from dbus.mainloop.glib import DBusGMainLoop
88
75
import xml.dom.minidom
77
import Crypto.Cipher.AES
91
# Try to find the value of SO_BINDTODEVICE:
93
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
94
# newer, and it is also the most natural place for it:
95
80
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
96
81
except AttributeError:
98
# This is where SO_BINDTODEVICE was up to and including Python
100
83
from IN import SO_BINDTODEVICE
101
84
except ImportError:
102
# In Python 2.7 it seems to have been removed entirely.
103
# Try running the C preprocessor:
105
cc = subprocess.Popen(["cc", "--language=c", "-E",
107
stdin=subprocess.PIPE,
108
stdout=subprocess.PIPE)
109
stdout = cc.communicate(
110
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
111
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
112
except (OSError, ValueError, IndexError):
114
SO_BINDTODEVICE = None
116
if sys.version_info.major == 2:
119
if sys.version_info < (3, 2):
120
configparser.Configparser = configparser.SafeConfigParser
123
stored_state_file = "clients.pickle"
85
SO_BINDTODEVICE = None
125
90
logger = logging.getLogger()
129
if_nametoindex = ctypes.cdll.LoadLibrary(
130
ctypes.util.find_library("c")).if_nametoindex
131
except (OSError, AttributeError):
133
def if_nametoindex(interface):
134
"Get an interface index the hard way, i.e. using fcntl()"
135
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
136
with contextlib.closing(socket.socket()) as s:
137
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
138
struct.pack(b"16s16x", interface))
139
interface_index = struct.unpack("I", ifreq[16:20])[0]
140
return interface_index
143
def copy_function(func):
144
"""Make a copy of a function"""
145
if sys.version_info.major == 2:
146
return types.FunctionType(func.func_code,
152
return types.FunctionType(func.__code__,
159
def initlogger(debug, level=logging.WARNING):
160
"""init logger and add loglevel"""
163
syslogger = (logging.handlers.SysLogHandler(
164
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
166
syslogger.setFormatter(logging.Formatter
167
('Mandos [%(process)d]: %(levelname)s:'
169
logger.addHandler(syslogger)
172
console = logging.StreamHandler()
173
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
177
logger.addHandler(console)
178
logger.setLevel(level)
181
class PGPError(Exception):
182
"""Exception if encryption/decryption fails"""
186
class PGPEngine(object):
187
"""A simple class for OpenPGP symmetric encryption & decryption"""
190
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
193
output = subprocess.check_output(["gpgconf"])
194
for line in output.splitlines():
195
name, text, path = line.split(b":")
200
if e.errno != errno.ENOENT:
202
self.gnupgargs = ['--batch',
203
'--homedir', self.tempdir,
206
# Only GPG version 1 has the --no-use-agent option.
207
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
208
self.gnupgargs.append("--no-use-agent")
213
def __exit__(self, exc_type, exc_value, traceback):
221
if self.tempdir is not None:
222
# Delete contents of tempdir
223
for root, dirs, files in os.walk(self.tempdir,
225
for filename in files:
226
os.remove(os.path.join(root, filename))
228
os.rmdir(os.path.join(root, dirname))
230
os.rmdir(self.tempdir)
233
def password_encode(self, password):
234
# Passphrase can not be empty and can not contain newlines or
235
# NUL bytes. So we prefix it and hex encode it.
236
encoded = b"mandos" + binascii.hexlify(password)
237
if len(encoded) > 2048:
238
# GnuPG can't handle long passwords, so encode differently
239
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
240
.replace(b"\n", b"\\n")
241
.replace(b"\0", b"\\x00"))
244
def encrypt(self, data, password):
245
passphrase = self.password_encode(password)
246
with tempfile.NamedTemporaryFile(
247
dir=self.tempdir) as passfile:
248
passfile.write(passphrase)
250
proc = subprocess.Popen([self.gpg, '--symmetric',
254
stdin=subprocess.PIPE,
255
stdout=subprocess.PIPE,
256
stderr=subprocess.PIPE)
257
ciphertext, err = proc.communicate(input=data)
258
if proc.returncode != 0:
262
def decrypt(self, data, password):
263
passphrase = self.password_encode(password)
264
with tempfile.NamedTemporaryFile(
265
dir=self.tempdir) as passfile:
266
passfile.write(passphrase)
268
proc = subprocess.Popen([self.gpg, '--decrypt',
272
stdin=subprocess.PIPE,
273
stdout=subprocess.PIPE,
274
stderr=subprocess.PIPE)
275
decrypted_plaintext, err = proc.communicate(input=data)
276
if proc.returncode != 0:
278
return decrypted_plaintext
281
# Pretend that we have an Avahi module
283
"""This isn't so much a class as it is a module-like namespace."""
284
IF_UNSPEC = -1 # avahi-common/address.h
285
PROTO_UNSPEC = -1 # avahi-common/address.h
286
PROTO_INET = 0 # avahi-common/address.h
287
PROTO_INET6 = 1 # avahi-common/address.h
288
DBUS_NAME = "org.freedesktop.Avahi"
289
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
290
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
291
DBUS_PATH_SERVER = "/"
294
def string_array_to_txt_array(t):
295
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
296
for s in t), signature="ay")
297
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
298
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
299
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
300
SERVER_INVALID = 0 # avahi-common/defs.h
301
SERVER_REGISTERING = 1 # avahi-common/defs.h
302
SERVER_RUNNING = 2 # avahi-common/defs.h
303
SERVER_COLLISION = 3 # avahi-common/defs.h
304
SERVER_FAILURE = 4 # avahi-common/defs.h
91
stored_state_path = "/var/lib/mandos/clients.pickle"
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
96
syslogger.setFormatter(logging.Formatter
97
('Mandos [%(process)d]: %(levelname)s:'
99
logger.addHandler(syslogger)
101
console = logging.StreamHandler()
102
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
106
logger.addHandler(console)
307
109
class AvahiError(Exception):
308
110
def __init__(self, value, *args, **kwargs):
309
111
self.value = value
310
return super(AvahiError, self).__init__(value, *args,
112
super(AvahiError, self).__init__(value, *args, **kwargs)
113
def __unicode__(self):
114
return unicode(repr(self.value))
314
116
class AvahiServiceError(AvahiError):
318
119
class AvahiGroupError(AvahiError):
322
123
class AvahiService(object):
323
124
"""An Avahi (Zeroconf) service.
326
127
interface: integer; avahi.IF_UNSPEC or an interface index.
327
128
Used to optionally bind to the specified interface.
328
129
name: string; Example: 'Mandos'
329
130
type: string; Example: '_mandos._tcp'.
330
See <https://www.iana.org/assignments/service-names-port-numbers>
131
See <http://www.dns-sd.org/ServiceTypes.html>
331
132
port: integer; what port to announce
332
133
TXT: list of strings; TXT record for the service
333
134
domain: string; Domain to publish on, default to .local if empty.
492
263
follow_name_owner_changes=True),
493
264
avahi.DBUS_INTERFACE_SERVER)
494
265
self.server.connect_to_signal("StateChanged",
495
self.server_state_changed)
266
self.server_state_changed)
496
267
self.server_state_changed(self.server.GetState())
499
269
class AvahiServiceToSyslog(AvahiService):
500
def rename(self, *args, **kwargs):
501
271
"""Add the new name to the syslog messages"""
502
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
503
syslogger.setFormatter(logging.Formatter(
504
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
272
ret = AvahiService.rename(self)
273
syslogger.setFormatter(logging.Formatter
274
('Mandos (%s) [%%(process)d]:'
275
' %%(levelname)s: %%(message)s'
509
# Pretend that we have a GnuTLS module
510
class gnutls(object):
511
"""This isn't so much a class as it is a module-like namespace."""
513
library = ctypes.util.find_library("gnutls")
515
library = ctypes.util.find_library("gnutls-deb0")
516
_library = ctypes.cdll.LoadLibrary(library)
519
# Unless otherwise indicated, the constants and types below are
520
# all from the gnutls/gnutls.h C header file.
531
E_NO_CERTIFICATE_FOUND = -49
536
KEYID_USE_SHA256 = 1 # gnutls/x509.h
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
540
class session_int(ctypes.Structure):
542
session_t = ctypes.POINTER(session_int)
544
class certificate_credentials_st(ctypes.Structure):
546
certificate_credentials_t = ctypes.POINTER(
547
certificate_credentials_st)
548
certificate_type_t = ctypes.c_int
550
class datum_t(ctypes.Structure):
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
('size', ctypes.c_uint)]
554
class openpgp_crt_int(ctypes.Structure):
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
credentials_type_t = ctypes.c_int
560
transport_ptr_t = ctypes.c_void_p
561
close_request_t = ctypes.c_int
564
class Error(Exception):
565
def __init__(self, message=None, code=None, args=()):
566
# Default usage is by a message string, but if a return
567
# code is passed, convert it to a string with
570
if message is None and code is not None:
571
message = gnutls.strerror(code)
572
return super(gnutls.Error, self).__init__(
575
class CertificateSecurityError(Error):
579
class Credentials(object):
581
self._c_object = gnutls.certificate_credentials_t()
582
gnutls.certificate_allocate_credentials(
583
ctypes.byref(self._c_object))
584
self.type = gnutls.CRD_CERTIFICATE
587
gnutls.certificate_free_credentials(self._c_object)
589
class ClientSession(object):
590
def __init__(self, socket, credentials=None):
591
self._c_object = gnutls.session_t()
592
gnutls_flags = gnutls.CLIENT
593
if gnutls.check_version(b"3.5.6"):
594
gnutls_flags |= gnutls.NO_TICKETS
596
gnutls_flags |= gnutls.ENABLE_RAWPK
597
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
599
gnutls.set_default_priority(self._c_object)
600
gnutls.transport_set_ptr(self._c_object, socket.fileno())
601
gnutls.handshake_set_private_extensions(self._c_object,
604
if credentials is None:
605
credentials = gnutls.Credentials()
606
gnutls.credentials_set(self._c_object, credentials.type,
607
ctypes.cast(credentials._c_object,
609
self.credentials = credentials
612
gnutls.deinit(self._c_object)
615
return gnutls.handshake(self._c_object)
617
def send(self, data):
621
data_len -= gnutls.record_send(self._c_object,
626
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
628
# Error handling functions
629
def _error_code(result):
630
"""A function to raise exceptions on errors, suitable
631
for the 'restype' attribute on ctypes functions"""
634
if result == gnutls.E_NO_CERTIFICATE_FOUND:
635
raise gnutls.CertificateSecurityError(code=result)
636
raise gnutls.Error(code=result)
638
def _retry_on_error(result, func, arguments):
639
"""A function to retry on some errors, suitable
640
for the 'errcheck' attribute on ctypes functions"""
642
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
643
return _error_code(result)
644
result = func(*arguments)
647
# Unless otherwise indicated, the function declarations below are
648
# all from the gnutls/gnutls.h C header file.
651
priority_set_direct = _library.gnutls_priority_set_direct
652
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
653
ctypes.POINTER(ctypes.c_char_p)]
654
priority_set_direct.restype = _error_code
656
init = _library.gnutls_init
657
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
658
init.restype = _error_code
660
set_default_priority = _library.gnutls_set_default_priority
661
set_default_priority.argtypes = [session_t]
662
set_default_priority.restype = _error_code
664
record_send = _library.gnutls_record_send
665
record_send.argtypes = [session_t, ctypes.c_void_p,
667
record_send.restype = ctypes.c_ssize_t
668
record_send.errcheck = _retry_on_error
670
certificate_allocate_credentials = (
671
_library.gnutls_certificate_allocate_credentials)
672
certificate_allocate_credentials.argtypes = [
673
ctypes.POINTER(certificate_credentials_t)]
674
certificate_allocate_credentials.restype = _error_code
676
certificate_free_credentials = (
677
_library.gnutls_certificate_free_credentials)
678
certificate_free_credentials.argtypes = [
679
certificate_credentials_t]
680
certificate_free_credentials.restype = None
682
handshake_set_private_extensions = (
683
_library.gnutls_handshake_set_private_extensions)
684
handshake_set_private_extensions.argtypes = [session_t,
686
handshake_set_private_extensions.restype = None
688
credentials_set = _library.gnutls_credentials_set
689
credentials_set.argtypes = [session_t, credentials_type_t,
691
credentials_set.restype = _error_code
693
strerror = _library.gnutls_strerror
694
strerror.argtypes = [ctypes.c_int]
695
strerror.restype = ctypes.c_char_p
697
certificate_type_get = _library.gnutls_certificate_type_get
698
certificate_type_get.argtypes = [session_t]
699
certificate_type_get.restype = _error_code
701
certificate_get_peers = _library.gnutls_certificate_get_peers
702
certificate_get_peers.argtypes = [session_t,
703
ctypes.POINTER(ctypes.c_uint)]
704
certificate_get_peers.restype = ctypes.POINTER(datum_t)
706
global_set_log_level = _library.gnutls_global_set_log_level
707
global_set_log_level.argtypes = [ctypes.c_int]
708
global_set_log_level.restype = None
710
global_set_log_function = _library.gnutls_global_set_log_function
711
global_set_log_function.argtypes = [log_func]
712
global_set_log_function.restype = None
714
deinit = _library.gnutls_deinit
715
deinit.argtypes = [session_t]
716
deinit.restype = None
718
handshake = _library.gnutls_handshake
719
handshake.argtypes = [session_t]
720
handshake.restype = _error_code
721
handshake.errcheck = _retry_on_error
723
transport_set_ptr = _library.gnutls_transport_set_ptr
724
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
725
transport_set_ptr.restype = None
727
bye = _library.gnutls_bye
728
bye.argtypes = [session_t, close_request_t]
729
bye.restype = _error_code
730
bye.errcheck = _retry_on_error
732
check_version = _library.gnutls_check_version
733
check_version.argtypes = [ctypes.c_char_p]
734
check_version.restype = ctypes.c_char_p
736
_need_version = b"3.3.0"
737
if check_version(_need_version) is None:
738
raise self.Error("Needs GnuTLS {} or later"
739
.format(_need_version))
741
_tls_rawpk_version = b"3.6.6"
742
has_rawpk = bool(check_version(_tls_rawpk_version))
746
class pubkey_st(ctypes.Structure):
748
pubkey_t = ctypes.POINTER(pubkey_st)
750
x509_crt_fmt_t = ctypes.c_int
752
# All the function declarations below are from gnutls/abstract.h
753
pubkey_init = _library.gnutls_pubkey_init
754
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
755
pubkey_init.restype = _error_code
757
pubkey_import = _library.gnutls_pubkey_import
758
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
760
pubkey_import.restype = _error_code
762
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
763
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
764
ctypes.POINTER(ctypes.c_ubyte),
765
ctypes.POINTER(ctypes.c_size_t)]
766
pubkey_get_key_id.restype = _error_code
768
pubkey_deinit = _library.gnutls_pubkey_deinit
769
pubkey_deinit.argtypes = [pubkey_t]
770
pubkey_deinit.restype = None
772
# All the function declarations below are from gnutls/openpgp.h
774
openpgp_crt_init = _library.gnutls_openpgp_crt_init
775
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
776
openpgp_crt_init.restype = _error_code
778
openpgp_crt_import = _library.gnutls_openpgp_crt_import
779
openpgp_crt_import.argtypes = [openpgp_crt_t,
780
ctypes.POINTER(datum_t),
782
openpgp_crt_import.restype = _error_code
784
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
785
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
786
ctypes.POINTER(ctypes.c_uint)]
787
openpgp_crt_verify_self.restype = _error_code
789
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
790
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
791
openpgp_crt_deinit.restype = None
793
openpgp_crt_get_fingerprint = (
794
_library.gnutls_openpgp_crt_get_fingerprint)
795
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
799
openpgp_crt_get_fingerprint.restype = _error_code
801
if check_version(b"3.6.4"):
802
certificate_type_get2 = _library.gnutls_certificate_type_get2
803
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
804
certificate_type_get2.restype = _error_code
806
# Remove non-public functions
807
del _error_code, _retry_on_error
810
def call_pipe(connection, # : multiprocessing.Connection
811
func, *args, **kwargs):
812
"""This function is meant to be called by multiprocessing.Process
814
This function runs func(*args, **kwargs), and writes the resulting
815
return value on the provided multiprocessing.Connection.
817
connection.send(func(*args, **kwargs))
279
def _timedelta_to_milliseconds(td):
280
"Convert a datetime.timedelta() to milliseconds"
281
return ((td.days * 24 * 60 * 60 * 1000)
282
+ (td.seconds * 1000)
283
+ (td.microseconds // 1000))
821
285
class Client(object):
822
286
"""A representation of a client host served by this server.
825
approved: bool(); 'None' if not yet approved/disapproved
289
_approved: bool(); 'None' if not yet approved/disapproved
826
290
approval_delay: datetime.timedelta(); Time to wait for approval
827
291
approval_duration: datetime.timedelta(); Duration of one approval
828
checker: multiprocessing.Process(); a running checker process used
829
to see if the client lives. 'None' if no process is
831
checker_callback_tag: a GLib event source tag, or None
292
checker: subprocess.Popen(); a running checker process used
293
to see if the client lives.
294
'None' if no process is running.
295
checker_callback_tag: a gobject event source tag, or None
832
296
checker_command: string; External command which is run to check
833
297
if client lives. %() expansions are done at
834
298
runtime with vars(self) as dict, so that for
835
299
instance %(name)s can be used in the command.
836
checker_initiator_tag: a GLib event source tag, or None
300
checker_initiator_tag: a gobject event source tag, or None
837
301
created: datetime.datetime(); (UTC) object creation
838
302
client_structure: Object describing what attributes a client has
839
303
and is used for storing the client at exit
840
304
current_checker_command: string; current running checker_command
841
disable_initiator_tag: a GLib event source tag, or None
305
disable_initiator_tag: a gobject event source tag, or None
843
307
fingerprint: string (40 or 32 hexadecimal digits); used to
844
uniquely identify an OpenPGP client
845
key_id: string (64 hexadecimal digits); used to uniquely identify
846
a client using raw public keys
308
uniquely identify the client
847
309
host: string; available for use by the checker command
848
310
interval: datetime.timedelta(); How often to start a new checker
849
311
last_approval_request: datetime.datetime(); (UTC) or None
850
312
last_checked_ok: datetime.datetime(); (UTC) or None
851
313
last_checker_status: integer between 0 and 255 reflecting exit
852
status of last checker. -1 reflects crashed
853
checker, -2 means no checker completed yet.
854
last_checker_signal: The signal which killed the last checker, if
855
last_checker_status is -1
856
last_enabled: datetime.datetime(); (UTC) or None
314
status of last checker. -1 reflect crashed
316
last_enabled: datetime.datetime(); (UTC)
857
317
name: string; from the config file, used in log messages and
858
318
D-Bus identifiers
859
319
secret: bytestring; sent verbatim (over TLS) to client
860
320
timeout: datetime.timedelta(); How long from last_checked_ok
861
321
until this client is disabled
862
extended_timeout: extra long timeout when secret has been sent
322
extended_timeout: extra long timeout when password has been sent
863
323
runtime_expansions: Allowed attributes for runtime expansion.
864
324
expires: datetime.datetime(); time (UTC) when a client will be
865
325
disabled, or None
866
server_settings: The server_settings dict from main()
869
328
runtime_expansions = ("approval_delay", "approval_duration",
870
"created", "enabled", "expires", "key_id",
871
"fingerprint", "host", "interval",
872
"last_approval_request", "last_checked_ok",
329
"created", "enabled", "fingerprint",
330
"host", "interval", "last_checked_ok",
873
331
"last_enabled", "name", "timeout")
876
"extended_timeout": "PT15M",
878
"checker": "fping -q -- %%(host)s",
880
"approval_delay": "PT0S",
881
"approval_duration": "PT1S",
882
"approved_by_default": "True",
887
def config_parser(config):
888
"""Construct a new dict of client settings of this form:
889
{ client_name: {setting_name: value, ...}, ...}
890
with exceptions for any special settings as defined above.
891
NOTE: Must be a pure function. Must return the same result
892
value given the same arguments.
895
for client_name in config.sections():
896
section = dict(config.items(client_name))
897
client = settings[client_name] = {}
899
client["host"] = section["host"]
900
# Reformat values from string types to Python types
901
client["approved_by_default"] = config.getboolean(
902
client_name, "approved_by_default")
903
client["enabled"] = config.getboolean(client_name,
906
# Uppercase and remove spaces from key_id and fingerprint
907
# for later comparison purposes with return value from the
908
# key_id() and fingerprint() functions
909
client["key_id"] = (section.get("key_id", "").upper()
911
client["fingerprint"] = (section["fingerprint"].upper()
913
if "secret" in section:
914
client["secret"] = codecs.decode(section["secret"]
917
elif "secfile" in section:
918
with open(os.path.expanduser(os.path.expandvars
919
(section["secfile"])),
921
client["secret"] = secfile.read()
923
raise TypeError("No secret or secfile for section {}"
925
client["timeout"] = string_to_delta(section["timeout"])
926
client["extended_timeout"] = string_to_delta(
927
section["extended_timeout"])
928
client["interval"] = string_to_delta(section["interval"])
929
client["approval_delay"] = string_to_delta(
930
section["approval_delay"])
931
client["approval_duration"] = string_to_delta(
932
section["approval_duration"])
933
client["checker_command"] = section["checker"]
934
client["last_approval_request"] = None
935
client["last_checked_ok"] = None
936
client["last_checker_status"] = -2
940
def __init__(self, settings, name=None, server_settings=None):
333
def timeout_milliseconds(self):
334
"Return the 'timeout' attribute in milliseconds"
335
return _timedelta_to_milliseconds(self.timeout)
337
def extended_timeout_milliseconds(self):
338
"Return the 'extended_timeout' attribute in milliseconds"
339
return _timedelta_to_milliseconds(self.extended_timeout)
341
def interval_milliseconds(self):
342
"Return the 'interval' attribute in milliseconds"
343
return _timedelta_to_milliseconds(self.interval)
345
def approval_delay_milliseconds(self):
346
return _timedelta_to_milliseconds(self.approval_delay)
348
def __init__(self, name = None, config=None):
349
"""Note: the 'checker' key in 'config' sets the
350
'checker_command' attribute and *not* the 'checker'
942
if server_settings is None:
944
self.server_settings = server_settings
945
# adding all client settings
946
for setting, value in settings.items():
947
setattr(self, setting, value)
950
if not hasattr(self, "last_enabled"):
951
self.last_enabled = datetime.datetime.utcnow()
952
if not hasattr(self, "expires"):
953
self.expires = (datetime.datetime.utcnow()
956
self.last_enabled = None
959
355
logger.debug("Creating client %r", self.name)
960
logger.debug(" Key ID: %s", self.key_id)
356
# Uppercase and remove spaces from fingerprint for later
357
# comparison purposes with return value from the fingerprint()
359
self.fingerprint = (config["fingerprint"].upper()
961
361
logger.debug(" Fingerprint: %s", self.fingerprint)
962
self.created = settings.get("created",
963
datetime.datetime.utcnow())
965
# attributes specific for this server instance
362
if "secret" in config:
363
self.secret = config["secret"].decode("base64")
364
elif "secfile" in config:
365
with open(os.path.expanduser(os.path.expandvars
366
(config["secfile"])),
368
self.secret = secfile.read()
370
raise TypeError("No secret or secfile for client %s"
372
self.host = config.get("host", "")
373
self.created = datetime.datetime.utcnow()
375
self.last_approval_request = None
376
self.last_enabled = datetime.datetime.utcnow()
377
self.last_checked_ok = None
378
self.last_checker_status = None
379
self.timeout = string_to_delta(config["timeout"])
380
self.extended_timeout = string_to_delta(config
381
["extended_timeout"])
382
self.interval = string_to_delta(config["interval"])
966
383
self.checker = None
967
384
self.checker_initiator_tag = None
968
385
self.disable_initiator_tag = None
386
self.expires = datetime.datetime.utcnow() + self.timeout
969
387
self.checker_callback_tag = None
388
self.checker_command = config["checker"]
970
389
self.current_checker_command = None
390
self._approved = None
391
self.approved_by_default = config.get("approved_by_default",
972
393
self.approvals_pending = 0
973
self.changedstate = multiprocessing_manager.Condition(
974
multiprocessing_manager.Lock())
975
self.client_structure = [attr
976
for attr in self.__dict__.keys()
394
self.approval_delay = string_to_delta(
395
config["approval_delay"])
396
self.approval_duration = string_to_delta(
397
config["approval_duration"])
398
self.changedstate = (multiprocessing_manager
399
.Condition(multiprocessing_manager
401
self.client_structure = [attr for attr
402
in self.__dict__.iterkeys()
977
403
if not attr.startswith("_")]
978
404
self.client_structure.append("client_structure")
980
for name, t in inspect.getmembers(
981
type(self), lambda obj: isinstance(obj, property)):
407
for name, t in inspect.getmembers(type(self),
982
411
if not name.startswith("_"):
983
412
self.client_structure.append(name)
985
414
# Send notice to process children that client state has changed
986
415
def send_changedstate(self):
987
416
with self.changedstate:
988
417
self.changedstate.notify_all()
990
419
def enable(self):
991
420
"""Start this client's checker and timeout hooks"""
992
421
if getattr(self, "enabled", False):
993
422
# Already enabled
424
self.send_changedstate()
995
425
self.expires = datetime.datetime.utcnow() + self.timeout
996
426
self.enabled = True
997
427
self.last_enabled = datetime.datetime.utcnow()
998
428
self.init_checker()
999
self.send_changedstate()
1001
430
def disable(self, quiet=True):
1002
431
"""Disable this client."""
1003
432
if not getattr(self, "enabled", False):
435
self.send_changedstate()
1006
437
logger.info("Disabling client %s", self.name)
1007
if getattr(self, "disable_initiator_tag", None) is not None:
1008
GLib.source_remove(self.disable_initiator_tag)
438
if getattr(self, "disable_initiator_tag", False):
439
gobject.source_remove(self.disable_initiator_tag)
1009
440
self.disable_initiator_tag = None
1010
441
self.expires = None
1011
if getattr(self, "checker_initiator_tag", None) is not None:
1012
GLib.source_remove(self.checker_initiator_tag)
442
if getattr(self, "checker_initiator_tag", False):
443
gobject.source_remove(self.checker_initiator_tag)
1013
444
self.checker_initiator_tag = None
1014
445
self.stop_checker()
1015
446
self.enabled = False
1017
self.send_changedstate()
1018
# Do not run this again if called by a GLib.timeout_add
447
# Do not run this again if called by a gobject.timeout_add
1021
450
def __del__(self):
1024
453
def init_checker(self):
1025
454
# Schedule a new checker to be started an 'interval' from now,
1026
455
# and every interval from then on.
1027
if self.checker_initiator_tag is not None:
1028
GLib.source_remove(self.checker_initiator_tag)
1029
self.checker_initiator_tag = GLib.timeout_add(
1030
int(self.interval.total_seconds() * 1000),
456
self.checker_initiator_tag = (gobject.timeout_add
457
(self.interval_milliseconds(),
1032
459
# Schedule a disable() when 'timeout' has passed
1033
if self.disable_initiator_tag is not None:
1034
GLib.source_remove(self.disable_initiator_tag)
1035
self.disable_initiator_tag = GLib.timeout_add(
1036
int(self.timeout.total_seconds() * 1000), self.disable)
460
self.disable_initiator_tag = (gobject.timeout_add
461
(self.timeout_milliseconds(),
1037
463
# Also start a new checker *right now*.
1038
464
self.start_checker()
1040
def checker_callback(self, source, condition, connection,
467
def checker_callback(self, pid, condition, command):
1042
468
"""The checker has completed, so take appropriate actions."""
1043
# Read return code from connection (see call_pipe)
1044
returncode = connection.recv()
1047
469
self.checker_callback_tag = None
1048
470
self.checker = None
1051
self.last_checker_status = returncode
1052
self.last_checker_signal = None
471
if os.WIFEXITED(condition):
472
self.last_checker_status = os.WEXITSTATUS(condition)
1053
473
if self.last_checker_status == 0:
1054
474
logger.info("Checker for %(name)s succeeded",
1056
476
self.checked_ok()
1058
logger.info("Checker for %(name)s failed", vars(self))
478
logger.info("Checker for %(name)s failed",
1060
481
self.last_checker_status = -1
1061
self.last_checker_signal = -returncode
1062
482
logger.warning("Checker for %(name)s crashed?",
1066
def checked_ok(self):
1067
"""Assert that the client has been seen, alive and well."""
1068
self.last_checked_ok = datetime.datetime.utcnow()
1069
self.last_checker_status = 0
1070
self.last_checker_signal = None
1073
def bump_timeout(self, timeout=None):
1074
"""Bump up the timeout for this client."""
485
def checked_ok(self, timeout=None):
486
"""Bump up the timeout for this client.
488
This should only be called when the client has been seen,
1075
491
if timeout is None:
1076
492
timeout = self.timeout
493
self.last_checked_ok = datetime.datetime.utcnow()
1077
494
if self.disable_initiator_tag is not None:
1078
GLib.source_remove(self.disable_initiator_tag)
1079
self.disable_initiator_tag = None
495
gobject.source_remove(self.disable_initiator_tag)
1080
496
if getattr(self, "enabled", False):
1081
self.disable_initiator_tag = GLib.timeout_add(
1082
int(timeout.total_seconds() * 1000), self.disable)
497
self.disable_initiator_tag = (gobject.timeout_add
498
(_timedelta_to_milliseconds
499
(timeout), self.disable))
1083
500
self.expires = datetime.datetime.utcnow() + timeout
1085
502
def need_approval(self):
1086
503
self.last_approval_request = datetime.datetime.utcnow()
1088
505
def start_checker(self):
1089
506
"""Start a new checker subprocess if one is not running.
1091
508
If a checker already exists, leave it running and do
1093
510
# The reason for not killing a running checker is that if we
1094
# did that, and if a checker (for some reason) started running
1095
# slowly and taking more than 'interval' time, then the client
1096
# would inevitably timeout, since no checker would get a
1097
# chance to run to completion. If we instead leave running
511
# did that, then if a checker (for some reason) started
512
# running slowly and taking more than 'interval' time, the
513
# client would inevitably timeout, since no checker would get
514
# a chance to run to completion. If we instead leave running
1098
515
# checkers alone, the checker would have to take more time
1099
516
# than 'timeout' for the client to be disabled, which is as it
1102
if self.checker is not None and not self.checker.is_alive():
1103
logger.warning("Checker was not alive; joining")
519
# If a checker exists, make sure it is not a zombie
521
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
522
except (AttributeError, OSError) as error:
523
if (isinstance(error, OSError)
524
and error.errno != errno.ECHILD):
528
logger.warning("Checker was a zombie")
529
gobject.source_remove(self.checker_callback_tag)
530
self.checker_callback(pid, status,
531
self.current_checker_command)
1106
532
# Start a new checker if needed
1107
533
if self.checker is None:
1108
# Escape attributes for the shell
1110
attr: re.escape(str(getattr(self, attr)))
1111
for attr in self.runtime_expansions}
1113
command = self.checker_command % escaped_attrs
1114
except TypeError as error:
1115
logger.error('Could not format string "%s"',
1116
self.checker_command,
1118
return True # Try again later
535
# In case checker_command has exactly one % operator
536
command = self.checker_command % self.host
538
# Escape attributes for the shell
539
escaped_attrs = dict(
541
re.escape(unicode(str(getattr(self, attr, "")),
545
self.runtime_expansions)
548
command = self.checker_command % escaped_attrs
549
except TypeError as error:
550
logger.error('Could not format string "%s":'
551
' %s', self.checker_command, error)
552
return True # Try again later
1119
553
self.current_checker_command = command
1120
logger.info("Starting checker %r for %s", command,
1122
# We don't need to redirect stdout and stderr, since
1123
# in normal mode, that is already done by daemon(),
1124
# and in debug mode we don't want to. (Stdin is
1125
# always replaced by /dev/null.)
1126
# The exception is when not debugging but nevertheless
1127
# running in the foreground; use the previously
1129
popen_args = {"close_fds": True,
1132
if (not self.server_settings["debug"]
1133
and self.server_settings["foreground"]):
1134
popen_args.update({"stdout": wnull,
1136
pipe = multiprocessing.Pipe(duplex=False)
1137
self.checker = multiprocessing.Process(
1139
args=(pipe[1], subprocess.call, command),
1141
self.checker.start()
1142
self.checker_callback_tag = GLib.io_add_watch(
1143
pipe[0].fileno(), GLib.IO_IN,
1144
self.checker_callback, pipe[0], command)
1145
# Re-run this periodically if run by GLib.timeout_add
555
logger.info("Starting checker %r for %s",
557
# We don't need to redirect stdout and stderr, since
558
# in normal mode, that is already done by daemon(),
559
# and in debug mode we don't want to. (Stdin is
560
# always replaced by /dev/null.)
561
self.checker = subprocess.Popen(command,
564
self.checker_callback_tag = (gobject.child_watch_add
566
self.checker_callback,
568
# The checker may have completed before the gobject
569
# watch was added. Check for this.
570
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
572
gobject.source_remove(self.checker_callback_tag)
573
self.checker_callback(pid, status, command)
574
except OSError as error:
575
logger.error("Failed to start subprocess: %s",
577
# Re-run this periodically if run by gobject.timeout_add
1148
580
def stop_checker(self):
1149
581
"""Force the checker process, if any, to stop."""
1150
582
if self.checker_callback_tag:
1151
GLib.source_remove(self.checker_callback_tag)
583
gobject.source_remove(self.checker_callback_tag)
1152
584
self.checker_callback_tag = None
1153
585
if getattr(self, "checker", None) is None:
1155
587
logger.debug("Stopping checker for %(name)s", vars(self))
1156
self.checker.terminate()
589
os.kill(self.checker.pid, signal.SIGTERM)
591
#if self.checker.poll() is None:
592
# os.kill(self.checker.pid, signal.SIGKILL)
593
except OSError as error:
594
if error.errno != errno.ESRCH: # No such process
1157
596
self.checker = None
1160
def dbus_service_property(dbus_interface,
598
# Encrypts a client secret and stores it in a varible
600
def encrypt_secret(self, key):
601
# Encryption-key need to be of a specific size, so we hash
603
hasheng = hashlib.sha256()
605
encryptionkey = hasheng.digest()
607
# Create validation hash so we know at decryption if it was
609
hasheng = hashlib.sha256()
610
hasheng.update(self.secret)
611
validationhash = hasheng.digest()
614
iv = os.urandom(Crypto.Cipher.AES.block_size)
615
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
616
Crypto.Cipher.AES.MODE_CFB, iv)
617
ciphertext = ciphereng.encrypt(validationhash+self.secret)
618
self.encrypted_secret = (ciphertext, iv)
620
# Decrypt a encrypted client secret
621
def decrypt_secret(self, key):
622
# Decryption-key need to be of a specific size, so we hash
624
hasheng = hashlib.sha256()
626
encryptionkey = hasheng.digest()
628
# Decrypt encrypted secret
629
ciphertext, iv = self.encrypted_secret
630
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
631
Crypto.Cipher.AES.MODE_CFB, iv)
632
plain = ciphereng.decrypt(ciphertext)
634
# Validate decrypted secret to know if it was succesful
635
hasheng = hashlib.sha256()
636
validationhash = plain[:hasheng.digest_size]
637
secret = plain[hasheng.digest_size:]
638
hasheng.update(secret)
640
# If validation fails, we use key as new secret. Otherwise, we
641
# use the decrypted secret
642
if hasheng.digest() == validationhash:
646
del self.encrypted_secret
649
def dbus_service_property(dbus_interface, signature="v",
650
access="readwrite", byte_arrays=False):
1164
651
"""Decorators for marking methods of a DBusObjectWithProperties to
1165
652
become properties on the D-Bus.
1167
654
The decorated method will be called with no arguments by "Get"
1168
655
and with one argument by "Set".
1170
657
The parameters, where they are supported, are the same as
1171
658
dbus.service.method, except there is only "signature", since the
1172
659
type from Get() and the type sent to Set() is the same.
1505
829
except (AttributeError, xml.dom.DOMException,
1506
830
xml.parsers.expat.ExpatError) as error:
1507
831
logger.error("Failed to override Introspection method",
1513
dbus.OBJECT_MANAGER_IFACE
1514
except AttributeError:
1515
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1518
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1519
"""A D-Bus object with an ObjectManager.
1521
Classes inheriting from this exposes the standard
1522
GetManagedObjects call and the InterfacesAdded and
1523
InterfacesRemoved signals on the standard
1524
"org.freedesktop.DBus.ObjectManager" interface.
1526
Note: No signals are sent automatically; they must be sent
1529
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1530
out_signature="a{oa{sa{sv}}}")
1531
def GetManagedObjects(self):
1532
"""This function must be overridden"""
1533
raise NotImplementedError()
1535
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1536
signature="oa{sa{sv}}")
1537
def InterfacesAdded(self, object_path, interfaces_and_properties):
1540
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1541
def InterfacesRemoved(self, object_path, interfaces):
1544
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1546
path_keyword='object_path',
1547
connection_keyword='connection')
1548
def Introspect(self, object_path, connection):
1549
"""Overloading of standard D-Bus method.
1551
Override return argument name of GetManagedObjects to be
1552
"objpath_interfaces_and_properties"
1554
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1558
document = xml.dom.minidom.parseString(xmlstring)
1560
for if_tag in document.getElementsByTagName("interface"):
1561
# Fix argument name for the GetManagedObjects method
1562
if (if_tag.getAttribute("name")
1563
== dbus.OBJECT_MANAGER_IFACE):
1564
for cn in if_tag.getElementsByTagName("method"):
1565
if (cn.getAttribute("name")
1566
== "GetManagedObjects"):
1567
for arg in cn.getElementsByTagName("arg"):
1568
if (arg.getAttribute("direction")
1572
"objpath_interfaces"
1574
xmlstring = document.toxml("utf-8")
1576
except (AttributeError, xml.dom.DOMException,
1577
xml.parsers.expat.ExpatError) as error:
1578
logger.error("Failed to override Introspection method",
1583
def datetime_to_dbus(dt, variant_level=0):
836
def datetime_to_dbus (dt, variant_level=0):
1584
837
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1586
return dbus.String("", variant_level=variant_level)
1587
return dbus.String(dt.isoformat(), variant_level=variant_level)
1590
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1591
"""A class decorator; applied to a subclass of
1592
dbus.service.Object, it will add alternate D-Bus attributes with
1593
interface names according to the "alt_interface_names" mapping.
1596
@alternate_dbus_interfaces({"org.example.Interface":
1597
"net.example.AlternateInterface"})
1598
class SampleDBusObject(dbus.service.Object):
1599
@dbus.service.method("org.example.Interface")
1600
def SampleDBusMethod():
1603
The above "SampleDBusMethod" on "SampleDBusObject" will be
1604
reachable via two interfaces: "org.example.Interface" and
1605
"net.example.AlternateInterface", the latter of which will have
1606
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1607
"true", unless "deprecate" is passed with a False value.
1609
This works for methods and signals, and also for D-Bus properties
1610
(from DBusObjectWithProperties) and interfaces (from the
1611
dbus_interface_annotations decorator).
839
return dbus.String("", variant_level = variant_level)
840
return dbus.String(dt.isoformat(),
841
variant_level=variant_level)
843
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
845
"""Applied to an empty subclass of a D-Bus object, this metaclass
846
will add additional D-Bus attributes matching a certain pattern.
1615
for orig_interface_name, alt_interface_name in (
1616
alt_interface_names.items()):
1618
interface_names = set()
1619
# Go though all attributes of the class
1620
for attrname, attribute in inspect.getmembers(cls):
848
def __new__(mcs, name, bases, attr):
849
# Go through all the base classes which could have D-Bus
850
# methods, signals, or properties in them
851
for base in (b for b in bases
852
if issubclass(b, dbus.service.Object)):
853
# Go though all attributes of the base class
854
for attrname, attribute in inspect.getmembers(base):
1621
855
# Ignore non-D-Bus attributes, and D-Bus attributes
1622
856
# with the wrong interface name
1623
857
if (not hasattr(attribute, "_dbus_interface")
1624
or not attribute._dbus_interface.startswith(
1625
orig_interface_name)):
858
or not attribute._dbus_interface
859
.startswith("se.recompile.Mandos")):
1627
861
# Create an alternate D-Bus interface name based on
1628
862
# the current name
1629
alt_interface = attribute._dbus_interface.replace(
1630
orig_interface_name, alt_interface_name)
1631
interface_names.add(alt_interface)
863
alt_interface = (attribute._dbus_interface
864
.replace("se.recompile.Mandos",
865
"se.bsnet.fukt.Mandos"))
1632
866
# Is this a D-Bus signal?
1633
867
if getattr(attribute, "_dbus_is_signal", False):
1634
# Extract the original non-method undecorated
1635
# function by black magic
1636
if sys.version_info.major == 2:
1637
nonmethod_func = (dict(
868
# Extract the original non-method function by
870
nonmethod_func = (dict(
1638
871
zip(attribute.func_code.co_freevars,
1639
attribute.__closure__))
1640
["func"].cell_contents)
1642
nonmethod_func = (dict(
1643
zip(attribute.__code__.co_freevars,
1644
attribute.__closure__))
1645
["func"].cell_contents)
872
attribute.__closure__))["func"]
1646
874
# Create a new, but exactly alike, function
1647
875
# object, and decorate it to be a new D-Bus signal
1648
876
# with the alternate D-Bus interface name
1649
new_function = copy_function(nonmethod_func)
1650
new_function = (dbus.service.signal(
1652
attribute._dbus_signature)(new_function))
1653
# Copy annotations, if any
1655
new_function._dbus_annotations = dict(
1656
attribute._dbus_annotations)
1657
except AttributeError:
877
new_function = (dbus.service.signal
879
attribute._dbus_signature)
881
nonmethod_func.func_code,
882
nonmethod_func.func_globals,
883
nonmethod_func.func_name,
884
nonmethod_func.func_defaults,
885
nonmethod_func.func_closure)))
1660
886
# Define a creator of a function to call both the
1661
# original and alternate functions, so both the
1662
# original and alternate signals gets sent when
1663
# the function is called
887
# old and new functions, so both the old and new
888
# signals gets sent when the function is called
1664
889
def fixscope(func1, func2):
1665
890
"""This function is a scope container to pass
1666
891
func1 and func2 to the "call_both" function
1667
892
outside of its arguments"""
1669
@functools.wraps(func2)
1670
893
def call_both(*args, **kwargs):
1671
894
"""This function will emit two D-Bus
1672
895
signals by calling func1 and func2"""
1673
896
func1(*args, **kwargs)
1674
897
func2(*args, **kwargs)
1675
# Make wrapper function look like a D-Bus
1677
for name, attr in inspect.getmembers(func2):
1678
if name.startswith("_dbus_"):
1679
setattr(call_both, name, attr)
1681
898
return call_both
1682
899
# Create the "call_both" function and add it to
1684
attr[attrname] = fixscope(attribute, new_function)
901
attr[attrname] = fixscope(attribute,
1685
903
# Is this a D-Bus method?
1686
904
elif getattr(attribute, "_dbus_is_method", False):
1687
905
# Create a new, but exactly alike, function
1688
906
# object. Decorate it to be a new D-Bus method
1689
907
# with the alternate D-Bus interface name. Add it
1692
dbus.service.method(
1694
attribute._dbus_in_signature,
1695
attribute._dbus_out_signature)
1696
(copy_function(attribute)))
1697
# Copy annotations, if any
1699
attr[attrname]._dbus_annotations = dict(
1700
attribute._dbus_annotations)
1701
except AttributeError:
909
attr[attrname] = (dbus.service.method
911
attribute._dbus_in_signature,
912
attribute._dbus_out_signature)
914
(attribute.func_code,
915
attribute.func_globals,
917
attribute.func_defaults,
918
attribute.func_closure)))
1703
919
# Is this a D-Bus property?
1704
920
elif getattr(attribute, "_dbus_is_property", False):
1705
921
# Create a new, but exactly alike, function
1706
922
# object, and decorate it to be a new D-Bus
1707
923
# property with the alternate D-Bus interface
1708
924
# name. Add it to the class.
1709
attr[attrname] = (dbus_service_property(
1710
alt_interface, attribute._dbus_signature,
1711
attribute._dbus_access,
1712
attribute._dbus_get_args_options
1714
(copy_function(attribute)))
1715
# Copy annotations, if any
1717
attr[attrname]._dbus_annotations = dict(
1718
attribute._dbus_annotations)
1719
except AttributeError:
1721
# Is this a D-Bus interface?
1722
elif getattr(attribute, "_dbus_is_interface", False):
1723
# Create a new, but exactly alike, function
1724
# object. Decorate it to be a new D-Bus interface
1725
# with the alternate D-Bus interface name. Add it
1728
dbus_interface_annotations(alt_interface)
1729
(copy_function(attribute)))
1731
# Deprecate all alternate interfaces
1732
iname = "_AlternateDBusNames_interface_annotation{}"
1733
for interface_name in interface_names:
1735
@dbus_interface_annotations(interface_name)
1737
return {"org.freedesktop.DBus.Deprecated":
1739
# Find an unused name
1740
for aname in (iname.format(i)
1741
for i in itertools.count()):
1742
if aname not in attr:
1746
# Replace the class with a new subclass of it with
1747
# methods, signals, etc. as created above.
1748
if sys.version_info.major == 2:
1749
cls = type(b"{}Alternate".format(cls.__name__),
1752
cls = type("{}Alternate".format(cls.__name__),
1759
@alternate_dbus_interfaces({"se.recompile.Mandos":
1760
"se.bsnet.fukt.Mandos"})
925
attr[attrname] = (dbus_service_property
927
attribute._dbus_signature,
928
attribute._dbus_access,
930
._dbus_get_args_options
933
(attribute.func_code,
934
attribute.func_globals,
936
attribute.func_defaults,
937
attribute.func_closure)))
938
return type.__new__(mcs, name, bases, attr)
1761
940
class ClientDBus(Client, DBusObjectWithProperties):
1762
941
"""A Client class using D-Bus
1765
944
dbus_object_path: dbus.ObjectPath
1766
945
bus: dbus.SystemBus()
1769
948
runtime_expansions = (Client.runtime_expansions
1770
+ ("dbus_object_path", ))
1772
_interface = "se.recompile.Mandos.Client"
949
+ ("dbus_object_path",))
1774
951
# dbus.service.Object doesn't use super(), so we can't either.
1776
def __init__(self, bus=None, *args, **kwargs):
953
def __init__(self, bus = None, *args, **kwargs):
955
self._approvals_pending = 0
1778
956
Client.__init__(self, *args, **kwargs)
959
def add_to_dbus(self):
1779
960
# Only now, when this client is initialized, can it show up on
1781
client_object_name = str(self.name).translate(
962
client_object_name = unicode(self.name).translate(
1782
963
{ord("."): ord("_"),
1783
964
ord("-"): ord("_")})
1784
self.dbus_object_path = dbus.ObjectPath(
1785
"/clients/" + client_object_name)
965
self.dbus_object_path = (dbus.ObjectPath
966
("/clients/" + client_object_name))
1786
967
DBusObjectWithProperties.__init__(self, self.bus,
1787
968
self.dbus_object_path)
1789
def notifychangeproperty(transform_func, dbus_name,
1790
type_func=lambda x: x,
1792
invalidate_only=False,
1793
_interface=_interface):
970
def notifychangeproperty(transform_func,
971
dbus_name, type_func=lambda x: x,
1794
973
""" Modify a variable so that it's a property which announces
1795
974
its changes to DBus.
2190
1326
self.start_checker()
2192
1328
self.stop_checker()
2194
1330
# ObjectPath - property
2196
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2197
"org.freedesktop.DBus.Deprecated": "true"})
2198
1331
@dbus_service_property(_interface, signature="o", access="read")
2199
1332
def ObjectPath_dbus_property(self):
2200
return self.dbus_object_path # is already a dbus.ObjectPath
1333
return self.dbus_object_path # is already a dbus.ObjectPath
2202
1335
# Secret = property
2204
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2206
@dbus_service_property(_interface,
1336
@dbus_service_property(_interface, signature="ay",
1337
access="write", byte_arrays=True)
2210
1338
def Secret_dbus_property(self, value):
2211
self.secret = bytes(value)
1339
self.secret = str(value)
2216
1344
class ProxyClient(object):
2217
def __init__(self, child_pipe, key_id, fpr, address):
1345
def __init__(self, child_pipe, fpr, address):
2218
1346
self._pipe = child_pipe
2219
self._pipe.send(('init', key_id, fpr, address))
1347
self._pipe.send(('init', fpr, address))
2220
1348
if not self._pipe.recv():
2221
raise KeyError(key_id or fpr)
2223
1351
def __getattribute__(self, name):
1352
if(name == '_pipe'):
2225
1353
return super(ProxyClient, self).__getattribute__(name)
2226
1354
self._pipe.send(('getattr', name))
2227
1355
data = self._pipe.recv()
2228
1356
if data[0] == 'data':
2230
1358
if data[0] == 'function':
2232
1359
def func(*args, **kwargs):
2233
1360
self._pipe.send(('funcall', name, args, kwargs))
2234
1361
return self._pipe.recv()[1]
2238
1364
def __setattr__(self, name, value):
1365
if(name == '_pipe'):
2240
1366
return super(ProxyClient, self).__setattr__(name, value)
2241
1367
self._pipe.send(('setattr', name, value))
1369
class ClientDBusTransitional(ClientDBus):
1370
__metaclass__ = AlternateDBusNamesMetaclass
2244
1372
class ClientHandler(socketserver.BaseRequestHandler, object):
2245
1373
"""A class to handle client connections.
2247
1375
Instantiated once for each connection to handle it.
2248
1376
Note: This will run in its own forked process."""
2250
1378
def handle(self):
2251
1379
with contextlib.closing(self.server.child_pipe) as child_pipe:
2252
1380
logger.info("TCP connection from: %s",
2253
str(self.client_address))
1381
unicode(self.client_address))
2254
1382
logger.debug("Pipe FD: %d",
2255
1383
self.server.child_pipe.fileno())
2257
session = gnutls.ClientSession(self.request)
2259
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2260
# "+AES-256-CBC", "+SHA1",
2261
# "+COMP-NULL", "+CTYPE-OPENPGP",
1385
session = (gnutls.connection
1386
.ClientSession(self.request,
1388
.X509Credentials()))
1390
# Note: gnutls.connection.X509Credentials is really a
1391
# generic GnuTLS certificate credentials object so long as
1392
# no X.509 keys are added to it. Therefore, we can use it
1393
# here despite using OpenPGP certificates.
1395
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1396
# "+AES-256-CBC", "+SHA1",
1397
# "+COMP-NULL", "+CTYPE-OPENPGP",
2263
1399
# Use a fallback default, since this MUST be set.
2264
1400
priority = self.server.gnutls_priority
2265
1401
if priority is None:
2266
1402
priority = "NORMAL"
2267
gnutls.priority_set_direct(session._c_object,
2268
priority.encode("utf-8"),
1403
(gnutls.library.functions
1404
.gnutls_priority_set_direct(session._c_object,
2271
1407
# Start communication using the Mandos protocol
2272
1408
# Get protocol number
2273
1409
line = self.request.makefile().readline()
2274
1410
logger.debug("Protocol version: %r", line)
2276
1412
if int(line.strip().split()[0]) > 1:
2277
raise RuntimeError(line)
2278
1414
except (ValueError, IndexError, RuntimeError) as error:
2279
1415
logger.error("Unknown protocol version: %s", error)
2282
1418
# Start GnuTLS connection
2284
1420
session.handshake()
2285
except gnutls.Error as error:
1421
except gnutls.errors.GNUTLSError as error:
2286
1422
logger.warning("Handshake failed: %s", error)
2287
1423
# Do not run session.bye() here: the session is not
2288
1424
# established. Just abandon the request.
2290
1426
logger.debug("Handshake succeeded")
2292
1428
approval_required = False
2294
if gnutls.has_rawpk:
2297
key_id = self.key_id(
2298
self.peer_certificate(session))
2299
except (TypeError, gnutls.Error) as error:
2300
logger.warning("Bad certificate: %s", error)
2302
logger.debug("Key ID: %s", key_id)
2307
fpr = self.fingerprint(
2308
self.peer_certificate(session))
2309
except (TypeError, gnutls.Error) as error:
2310
logger.warning("Bad certificate: %s", error)
2312
logger.debug("Fingerprint: %s", fpr)
2315
client = ProxyClient(child_pipe, key_id, fpr,
1431
fpr = self.fingerprint(self.peer_certificate
1434
gnutls.errors.GNUTLSError) as error:
1435
logger.warning("Bad certificate: %s", error)
1437
logger.debug("Fingerprint: %s", fpr)
1440
client = ProxyClient(child_pipe, fpr,
2316
1441
self.client_address)
2317
1442
except KeyError:
2320
1445
if client.approval_delay:
2321
1446
delay = client.approval_delay
2322
1447
client.approvals_pending += 1
2323
1448
approval_required = True
2326
1451
if not client.enabled:
2327
1452
logger.info("Client %s is disabled",
2329
1454
if self.server.use_dbus:
2330
1455
# Emit D-Bus signal
2331
1456
client.Rejected("Disabled")
2334
if client.approved or not client.approval_delay:
2335
# We are approved or approval is disabled
1459
if client._approved or not client.approval_delay:
1460
#We are approved or approval is disabled
2337
elif client.approved is None:
1462
elif client._approved is None:
2338
1463
logger.info("Client %s needs approval",
2340
1465
if self.server.use_dbus:
2341
1466
# Emit D-Bus signal
2342
1467
client.NeedApproval(
2343
client.approval_delay.total_seconds()
2344
* 1000, client.approved_by_default)
1468
client.approval_delay_milliseconds(),
1469
client.approved_by_default)
2346
1471
logger.warning("Client %s was not approved",
2371
1498
delay -= time2 - time
2374
session.send(client.secret)
2375
except gnutls.Error as error:
2376
logger.warning("gnutls send failed",
1501
while sent_size < len(client.secret):
1503
sent = session.send(client.secret[sent_size:])
1504
except gnutls.errors.GNUTLSError as error:
1505
logger.warning("gnutls send failed")
1507
logger.debug("Sent: %d, remaining: %d",
1508
sent, len(client.secret)
1509
- (sent_size + sent))
2380
1512
logger.info("Sending secret to %s", client.name)
2381
1513
# bump the timeout using extended_timeout
2382
client.bump_timeout(client.extended_timeout)
1514
client.checked_ok(client.extended_timeout)
2383
1515
if self.server.use_dbus:
2384
1516
# Emit D-Bus signal
2385
1517
client.GotSecret()
2388
1520
if approval_required:
2389
1521
client.approvals_pending -= 1
2392
except gnutls.Error as error:
2393
logger.warning("GnuTLS bye failed",
1524
except gnutls.errors.GNUTLSError as error:
1525
logger.warning("GnuTLS bye failed")
2397
1528
def peer_certificate(session):
2398
"Return the peer's certificate as a bytestring"
2400
cert_type = gnutls.certificate_type_get2(session._c_object,
2402
except AttributeError:
2403
cert_type = gnutls.certificate_type_get(session._c_object)
2404
if gnutls.has_rawpk:
2405
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2407
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2408
# If not a valid certificate type...
2409
if cert_type not in valid_cert_types:
2410
logger.info("Cert type %r not in %r", cert_type,
2412
# ...return invalid data
1529
"Return the peer's OpenPGP certificate as a bytestring"
1530
# If not an OpenPGP certificate...
1531
if (gnutls.library.functions
1532
.gnutls_certificate_type_get(session._c_object)
1533
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1534
# ...do the normal thing
1535
return session.peer_certificate
2414
1536
list_size = ctypes.c_uint(1)
2415
cert_list = (gnutls.certificate_get_peers
1537
cert_list = (gnutls.library.functions
1538
.gnutls_certificate_get_peers
2416
1539
(session._c_object, ctypes.byref(list_size)))
2417
1540
if not bool(cert_list) and list_size.value != 0:
2418
raise gnutls.Error("error getting peer certificate")
1541
raise gnutls.errors.GNUTLSError("error getting peer"
2419
1543
if list_size.value == 0:
2421
1545
cert = cert_list[0]
2422
1546
return ctypes.string_at(cert.data, cert.size)
2425
def key_id(certificate):
2426
"Convert a certificate bytestring to a hexdigit key ID"
2427
# New GnuTLS "datum" with the public key
2428
datum = gnutls.datum_t(
2429
ctypes.cast(ctypes.c_char_p(certificate),
2430
ctypes.POINTER(ctypes.c_ubyte)),
2431
ctypes.c_uint(len(certificate)))
2432
# XXX all these need to be created in the gnutls "module"
2433
# New empty GnuTLS certificate
2434
pubkey = gnutls.pubkey_t()
2435
gnutls.pubkey_init(ctypes.byref(pubkey))
2436
# Import the raw public key into the certificate
2437
gnutls.pubkey_import(pubkey,
2438
ctypes.byref(datum),
2439
gnutls.X509_FMT_DER)
2440
# New buffer for the key ID
2441
buf = ctypes.create_string_buffer(32)
2442
buf_len = ctypes.c_size_t(len(buf))
2443
# Get the key ID from the raw public key into the buffer
2444
gnutls.pubkey_get_key_id(pubkey,
2445
gnutls.KEYID_USE_SHA256,
2446
ctypes.cast(ctypes.byref(buf),
2447
ctypes.POINTER(ctypes.c_ubyte)),
2448
ctypes.byref(buf_len))
2449
# Deinit the certificate
2450
gnutls.pubkey_deinit(pubkey)
2452
# Convert the buffer to a Python bytestring
2453
key_id = ctypes.string_at(buf, buf_len.value)
2454
# Convert the bytestring to hexadecimal notation
2455
hex_key_id = binascii.hexlify(key_id).upper()
2459
1549
def fingerprint(openpgp):
2460
1550
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2461
1551
# New GnuTLS "datum" with the OpenPGP public key
2462
datum = gnutls.datum_t(
2463
ctypes.cast(ctypes.c_char_p(openpgp),
2464
ctypes.POINTER(ctypes.c_ubyte)),
2465
ctypes.c_uint(len(openpgp)))
1552
datum = (gnutls.library.types
1553
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1556
ctypes.c_uint(len(openpgp))))
2466
1557
# New empty GnuTLS certificate
2467
crt = gnutls.openpgp_crt_t()
2468
gnutls.openpgp_crt_init(ctypes.byref(crt))
1558
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1559
(gnutls.library.functions
1560
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2469
1561
# Import the OpenPGP public key into the certificate
2470
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2471
gnutls.OPENPGP_FMT_RAW)
1562
(gnutls.library.functions
1563
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1564
gnutls.library.constants
1565
.GNUTLS_OPENPGP_FMT_RAW))
2472
1566
# Verify the self signature in the key
2473
1567
crtverify = ctypes.c_uint()
2474
gnutls.openpgp_crt_verify_self(crt, 0,
2475
ctypes.byref(crtverify))
1568
(gnutls.library.functions
1569
.gnutls_openpgp_crt_verify_self(crt, 0,
1570
ctypes.byref(crtverify)))
2476
1571
if crtverify.value != 0:
2477
gnutls.openpgp_crt_deinit(crt)
2478
raise gnutls.CertificateSecurityError(code
1572
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1573
raise (gnutls.errors.CertificateSecurityError
2480
1575
# New buffer for the fingerprint
2481
1576
buf = ctypes.create_string_buffer(20)
2482
1577
buf_len = ctypes.c_size_t()
2483
1578
# Get the fingerprint from the certificate into the buffer
2484
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2485
ctypes.byref(buf_len))
1579
(gnutls.library.functions
1580
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1581
ctypes.byref(buf_len)))
2486
1582
# Deinit the certificate
2487
gnutls.openpgp_crt_deinit(crt)
1583
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2488
1584
# Convert the buffer to a Python bytestring
2489
1585
fpr = ctypes.string_at(buf, buf_len.value)
2490
1586
# Convert the bytestring to hexadecimal notation
2491
hex_fpr = binascii.hexlify(fpr).upper()
1587
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2495
1591
class MultiprocessingMixIn(object):
2496
1592
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2498
1593
def sub_process_main(self, request, address):
2500
1595
self.finish_request(request, address)
2502
1597
self.handle_error(request, address)
2503
1598
self.close_request(request)
2505
1600
def process_request(self, request, address):
2506
1601
"""Start a new process to process the request."""
2507
proc = multiprocessing.Process(target=self.sub_process_main,
2508
args=(request, address))
1602
proc = multiprocessing.Process(target = self.sub_process_main,
2513
1609
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2514
1610
""" adds a pipe to the MixIn """
2516
1611
def process_request(self, request, client_address):
2517
1612
"""Overrides and wraps the original process_request().
2519
1614
This function creates a new pipe in self.pipe
2521
1616
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2523
1618
proc = MultiprocessingMixIn.process_request(self, request,
2524
1619
client_address)
2525
1620
self.child_pipe.close()
2526
1621
self.add_pipe(parent_pipe, proc)
2528
1623
def add_pipe(self, parent_pipe, proc):
2529
1624
"""Dummy function; override as necessary"""
2530
raise NotImplementedError()
1625
raise NotImplementedError
2533
1628
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2534
1629
socketserver.TCPServer, object):
2535
1630
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2538
1633
enabled: Boolean; whether this server is activated yet
2539
1634
interface: None or a network interface name (string)
2540
1635
use_ipv6: Boolean; to use IPv6 or not
2543
1637
def __init__(self, server_address, RequestHandlerClass,
2547
"""If socketfd is set, use that file descriptor instead of
2548
creating a new one with socket.socket().
1638
interface=None, use_ipv6=True):
2550
1639
self.interface = interface
2552
1641
self.address_family = socket.AF_INET6
2553
if socketfd is not None:
2554
# Save the file descriptor
2555
self.socketfd = socketfd
2556
# Save the original socket.socket() function
2557
self.socket_socket = socket.socket
2559
# To implement --socket, we monkey patch socket.socket.
2561
# (When socketserver.TCPServer is a new-style class, we
2562
# could make self.socket into a property instead of monkey
2563
# patching socket.socket.)
2565
# Create a one-time-only replacement for socket.socket()
2566
@functools.wraps(socket.socket)
2567
def socket_wrapper(*args, **kwargs):
2568
# Restore original function so subsequent calls are
2570
socket.socket = self.socket_socket
2571
del self.socket_socket
2572
# This time only, return a new socket object from the
2573
# saved file descriptor.
2574
return socket.fromfd(self.socketfd, *args, **kwargs)
2575
# Replace socket.socket() function with wrapper
2576
socket.socket = socket_wrapper
2577
# The socketserver.TCPServer.__init__ will call
2578
# socket.socket(), which might be our replacement,
2579
# socket_wrapper(), if socketfd was set.
2580
1642
socketserver.TCPServer.__init__(self, server_address,
2581
1643
RequestHandlerClass)
2583
1644
def server_bind(self):
2584
1645
"""This overrides the normal server_bind() function
2585
1646
to bind to an interface if one was specified, and also NOT to
2586
1647
bind to an address or port if they were not specified."""
2587
global SO_BINDTODEVICE
2588
1648
if self.interface is not None:
2589
1649
if SO_BINDTODEVICE is None:
2590
# Fall back to a hard-coded value which seems to be
2592
logger.warning("SO_BINDTODEVICE not found, trying 25")
2593
SO_BINDTODEVICE = 25
2595
self.socket.setsockopt(
2596
socket.SOL_SOCKET, SO_BINDTODEVICE,
2597
(self.interface + "\0").encode("utf-8"))
2598
except socket.error as error:
2599
if error.errno == errno.EPERM:
2600
logger.error("No permission to bind to"
2601
" interface %s", self.interface)
2602
elif error.errno == errno.ENOPROTOOPT:
2603
logger.error("SO_BINDTODEVICE not available;"
2604
" cannot bind to interface %s",
2606
elif error.errno == errno.ENODEV:
2607
logger.error("Interface %s does not exist,"
2608
" cannot bind", self.interface)
1650
logger.error("SO_BINDTODEVICE does not exist;"
1651
" cannot bind to interface %s",
1655
self.socket.setsockopt(socket.SOL_SOCKET,
1659
except socket.error as error:
1660
if error[0] == errno.EPERM:
1661
logger.error("No permission to"
1662
" bind to interface %s",
1664
elif error[0] == errno.ENOPROTOOPT:
1665
logger.error("SO_BINDTODEVICE not available;"
1666
" cannot bind to interface %s",
2611
1670
# Only bind(2) the socket if we really need to.
2612
1671
if self.server_address[0] or self.server_address[1]:
2613
if self.server_address[1]:
2614
self.allow_reuse_address = True
2615
1672
if not self.server_address[0]:
2616
1673
if self.address_family == socket.AF_INET6:
2617
any_address = "::" # in6addr_any
1674
any_address = "::" # in6addr_any
2619
any_address = "0.0.0.0" # INADDR_ANY
1676
any_address = socket.INADDR_ANY
2620
1677
self.server_address = (any_address,
2621
1678
self.server_address[1])
2622
1679
elif not self.server_address[1]:
2623
self.server_address = (self.server_address[0], 0)
1680
self.server_address = (self.server_address[0],
2624
1682
# if self.interface:
2625
1683
# self.server_address = (self.server_address[0],
2953
1929
parser.add_argument("--no-dbus", action="store_false",
2954
1930
dest="use_dbus", help="Do not provide D-Bus"
2955
" system bus interface", default=None)
1931
" system bus interface")
2956
1932
parser.add_argument("--no-ipv6", action="store_false",
2957
dest="use_ipv6", help="Do not use IPv6",
1933
dest="use_ipv6", help="Do not use IPv6")
2959
1934
parser.add_argument("--no-restore", action="store_false",
2960
dest="restore", help="Do not restore stored"
2961
" state", default=None)
2962
parser.add_argument("--socket", type=int,
2963
help="Specify a file descriptor to a network"
2964
" socket to use instead of creating one")
2965
parser.add_argument("--statedir", metavar="DIR",
2966
help="Directory to save/restore state in")
2967
parser.add_argument("--foreground", action="store_true",
2968
help="Run in foreground", default=None)
2969
parser.add_argument("--no-zeroconf", action="store_false",
2970
dest="zeroconf", help="Do not use Zeroconf",
1936
help="Do not restore stored state",
2973
1939
options = parser.parse_args()
2975
1941
if options.check:
2977
fail_count, test_count = doctest.testmod()
2978
sys.exit(os.EX_OK if fail_count == 0 else 1)
2980
1946
# Default values for config file for server-global settings
2981
if gnutls.has_rawpk:
2982
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2983
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2985
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2986
":+SIGN-DSA-SHA256")
2987
server_defaults = {"interface": "",
2991
"priority": priority,
2992
"servicename": "Mandos",
2998
"statedir": "/var/lib/mandos",
2999
"foreground": "False",
1947
server_defaults = { "interface": "",
1952
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1953
"servicename": "Mandos",
3004
1959
# Parse config file for server-global settings
3005
server_config = configparser.ConfigParser(server_defaults)
1960
server_config = configparser.SafeConfigParser(server_defaults)
3006
1961
del server_defaults
3007
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3008
# Convert the ConfigParser object to a dict
1962
server_config.read(os.path.join(options.configdir,
1964
# Convert the SafeConfigParser object to a dict
3009
1965
server_settings = server_config.defaults()
3010
1966
# Use the appropriate methods on the non-string config options
3011
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3012
"foreground", "zeroconf"):
1967
for option in ("debug", "use_dbus", "use_ipv6"):
3013
1968
server_settings[option] = server_config.getboolean("DEFAULT",
3015
1970
if server_settings["port"]:
3016
1971
server_settings["port"] = server_config.getint("DEFAULT",
3018
if server_settings["socket"]:
3019
server_settings["socket"] = server_config.getint("DEFAULT",
3021
# Later, stdin will, and stdout and stderr might, be dup'ed
3022
# over with an opened os.devnull. But we don't want this to
3023
# happen with a supplied network socket.
3024
if 0 <= server_settings["socket"] <= 2:
3025
server_settings["socket"] = os.dup(server_settings
3027
1973
del server_config
3029
1975
# Override the settings from the config file with command line
3030
1976
# options, if set.
3031
1977
for option in ("interface", "address", "port", "debug",
3032
"priority", "servicename", "configdir", "use_dbus",
3033
"use_ipv6", "debuglevel", "restore", "statedir",
3034
"socket", "foreground", "zeroconf"):
1978
"priority", "servicename", "configdir",
1979
"use_dbus", "use_ipv6", "debuglevel", "restore"):
3035
1980
value = getattr(options, option)
3036
1981
if value is not None:
3037
1982
server_settings[option] = value
3039
1984
# Force all strings to be unicode
3040
1985
for option in server_settings.keys():
3041
if isinstance(server_settings[option], bytes):
3042
server_settings[option] = (server_settings[option]
3044
# Force all boolean options to be boolean
3045
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3046
"foreground", "zeroconf"):
3047
server_settings[option] = bool(server_settings[option])
3048
# Debug implies foreground
3049
if server_settings["debug"]:
3050
server_settings["foreground"] = True
1986
if type(server_settings[option]) is str:
1987
server_settings[option] = unicode(server_settings[option])
3051
1988
# Now we have our good server settings in "server_settings"
3053
1990
##################################################################
3055
if (not server_settings["zeroconf"]
3056
and not (server_settings["port"]
3057
or server_settings["socket"] != "")):
3058
parser.error("Needs port or socket to work without Zeroconf")
3060
1992
# For convenience
3061
1993
debug = server_settings["debug"]
3062
1994
debuglevel = server_settings["debuglevel"]
3063
1995
use_dbus = server_settings["use_dbus"]
3064
1996
use_ipv6 = server_settings["use_ipv6"]
3065
stored_state_path = os.path.join(server_settings["statedir"],
3067
foreground = server_settings["foreground"]
3068
zeroconf = server_settings["zeroconf"]
3071
initlogger(debug, logging.DEBUG)
3076
level = getattr(logging, debuglevel.upper())
3077
initlogger(debug, level)
3079
1998
if server_settings["servicename"] != "Mandos":
3080
syslogger.setFormatter(
3081
logging.Formatter('Mandos ({}) [%(process)d]:'
3082
' %(levelname)s: %(message)s'.format(
3083
server_settings["servicename"])))
1999
syslogger.setFormatter(logging.Formatter
2000
('Mandos (%s) [%%(process)d]:'
2001
' %%(levelname)s: %%(message)s'
2002
% server_settings["servicename"]))
3085
2004
# Parse config file with clients
3086
client_config = configparser.ConfigParser(Client.client_defaults)
2005
client_defaults = { "timeout": "5m",
2006
"extended_timeout": "15m",
2008
"checker": "fping -q -- %%(host)s",
2010
"approval_delay": "0s",
2011
"approval_duration": "1s",
2013
client_config = configparser.SafeConfigParser(client_defaults)
3087
2014
client_config.read(os.path.join(server_settings["configdir"],
3088
2015
"clients.conf"))
3090
2017
global mandos_dbus_service
3091
2018
mandos_dbus_service = None
3094
if server_settings["socket"] != "":
3095
socketfd = server_settings["socket"]
3096
tcp_server = MandosServer(
3097
(server_settings["address"], server_settings["port"]),
3099
interface=(server_settings["interface"] or None),
3101
gnutls_priority=server_settings["priority"],
3105
pidfilename = "/run/mandos.pid"
3106
if not os.path.isdir("/run/."):
3107
pidfilename = "/var/run/mandos.pid"
3110
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3111
except IOError as e:
3112
logger.error("Could not open file %r", pidfilename,
3115
for name, group in (("_mandos", "_mandos"),
3116
("mandos", "mandos"),
3117
("nobody", "nogroup")):
3119
uid = pwd.getpwnam(name).pw_uid
3120
gid = pwd.getpwnam(group).pw_gid
2020
tcp_server = MandosServer((server_settings["address"],
2021
server_settings["port"]),
2023
interface=(server_settings["interface"]
2027
server_settings["priority"],
2030
pidfilename = "/var/run/mandos.pid"
2032
pidfile = open(pidfilename, "w")
2034
logger.error("Could not open file %r", pidfilename)
2037
uid = pwd.getpwnam("_mandos").pw_uid
2038
gid = pwd.getpwnam("_mandos").pw_gid
2041
uid = pwd.getpwnam("mandos").pw_uid
2042
gid = pwd.getpwnam("mandos").pw_gid
3122
2043
except KeyError:
2045
uid = pwd.getpwnam("nobody").pw_uid
2046
gid = pwd.getpwnam("nobody").pw_gid
3131
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3133
2053
except OSError as error:
3134
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3135
.format(uid, gid, os.strerror(error.errno)))
3136
if error.errno != errno.EPERM:
2054
if error[0] != errno.EPERM:
2057
if not debug and not debuglevel:
2058
logger.setLevel(logging.WARNING)
2060
level = getattr(logging, debuglevel.upper())
2061
logger.setLevel(level)
2064
logger.setLevel(logging.DEBUG)
3140
2065
# Enable all possible GnuTLS debugging
3142
2067
# "Use a log level over 10 to enable all debugging options."
3143
2068
# - GnuTLS manual
3144
gnutls.global_set_log_level(11)
2069
gnutls.library.functions.gnutls_global_set_log_level(11)
2071
@gnutls.library.types.gnutls_log_func
3147
2072
def debug_gnutls(level, string):
3148
2073
logger.debug("GnuTLS: %s", string[:-1])
3150
gnutls.global_set_log_function(debug_gnutls)
2075
(gnutls.library.functions
2076
.gnutls_global_set_log_function(debug_gnutls))
3152
2078
# Redirect stdin so all checkers get /dev/null
3153
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2079
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3154
2080
os.dup2(null, sys.stdin.fileno())
2084
# No console logging
2085
logger.removeHandler(console)
3158
2087
# Need to fork before connecting to D-Bus
3160
2089
# Close all input and output, do double fork, etc.
3163
if gi.version_info < (3, 10, 2):
3164
# multiprocessing will use threads, so before we use GLib we
3165
# need to inform GLib that threads will be used.
3168
2092
global main_loop
3169
2093
# From the Avahi example code
3170
DBusGMainLoop(set_as_default=True)
3171
main_loop = GLib.MainLoop()
2094
DBusGMainLoop(set_as_default=True )
2095
main_loop = gobject.MainLoop()
3172
2096
bus = dbus.SystemBus()
3173
2097
# End of Avahi example code
3176
2100
bus_name = dbus.service.BusName("se.recompile.Mandos",
3179
old_bus_name = dbus.service.BusName(
3180
"se.bsnet.fukt.Mandos", bus,
3182
except dbus.exceptions.DBusException as e:
3183
logger.error("Disabling D-Bus:", exc_info=e)
2101
bus, do_not_queue=True)
2102
old_bus_name = (dbus.service.BusName
2103
("se.bsnet.fukt.Mandos", bus,
2105
except dbus.exceptions.NameExistsException as e:
2106
logger.error(unicode(e) + ", disabling D-Bus")
3184
2107
use_dbus = False
3185
2108
server_settings["use_dbus"] = False
3186
2109
tcp_server.use_dbus = False
3188
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3189
service = AvahiServiceToSyslog(
3190
name=server_settings["servicename"],
3191
servicetype="_mandos._tcp",
3194
if server_settings["interface"]:
3195
service.interface = if_nametoindex(
3196
server_settings["interface"].encode("utf-8"))
2110
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2111
service = AvahiServiceToSyslog(name =
2112
server_settings["servicename"],
2113
servicetype = "_mandos._tcp",
2114
protocol = protocol, bus = bus)
2115
if server_settings["interface"]:
2116
service.interface = (if_nametoindex
2117
(str(server_settings["interface"])))
3198
2119
global multiprocessing_manager
3199
2120
multiprocessing_manager = multiprocessing.Manager()
3201
2122
client_class = Client
3203
client_class = functools.partial(ClientDBus, bus=bus)
3205
client_settings = Client.config_parser(client_config)
2124
client_class = functools.partial(ClientDBusTransitional,
2127
special_settings = {
2128
# Some settings need to be accessd by special methods;
2129
# booleans need .getboolean(), etc. Here is a list of them:
2130
"approved_by_default":
2132
client_config.getboolean(section, "approved_by_default"),
2134
# Construct a new dict of client settings of this form:
2135
# { client_name: {setting_name: value, ...}, ...}
2136
# with exceptions for any special settings as defined above
2137
client_settings = dict((clientname,
2140
setting not in special_settings
2141
else special_settings[setting]
2144
in client_config.items(clientname)))
2145
for clientname in client_config.sections())
3206
2147
old_client_settings = {}
3209
# This is used to redirect stdout and stderr for checker processes
3211
wnull = open(os.devnull, "w") # A writable /dev/null
3212
# Only used if server is running in foreground but not in debug
3214
if debug or not foreground:
3217
# Get client data and settings from last running state.
2150
# Get client data and settings from last running state.
3218
2151
if server_settings["restore"]:
3220
2153
with open(stored_state_path, "rb") as stored_state:
3221
if sys.version_info.major == 2:
3222
clients_data, old_client_settings = pickle.load(
3225
bytes_clients_data, bytes_old_client_settings = (
3226
pickle.load(stored_state, encoding="bytes"))
3227
# Fix bytes to strings
3230
clients_data = {(key.decode("utf-8")
3231
if isinstance(key, bytes)
3234
bytes_clients_data.items()}
3235
del bytes_clients_data
3236
for key in clients_data:
3237
value = {(k.decode("utf-8")
3238
if isinstance(k, bytes) else k): v
3240
clients_data[key].items()}
3241
clients_data[key] = value
3243
value["client_structure"] = [
3245
if isinstance(s, bytes)
3247
value["client_structure"]]
3249
for k in ("name", "host"):
3250
if isinstance(value[k], bytes):
3251
value[k] = value[k].decode("utf-8")
3252
if "key_id" not in value:
3253
value["key_id"] = ""
3254
elif "fingerprint" not in value:
3255
value["fingerprint"] = ""
3256
# old_client_settings
3258
old_client_settings = {
3259
(key.decode("utf-8")
3260
if isinstance(key, bytes)
3263
bytes_old_client_settings.items()}
3264
del bytes_old_client_settings
3266
for value in old_client_settings.values():
3267
if isinstance(value["host"], bytes):
3268
value["host"] = (value["host"]
2154
clients_data, old_client_settings = (
2155
pickle.load(stored_state))
3270
2156
os.remove(stored_state_path)
3271
2157
except IOError as e:
3272
if e.errno == errno.ENOENT:
3273
logger.warning("Could not load persistent state:"
3274
" {}".format(os.strerror(e.errno)))
3276
logger.critical("Could not load persistent state:",
2158
logger.warning("Could not load persistant state: {0}"
2160
if e.errno != errno.ENOENT:
3279
except EOFError as e:
3280
logger.warning("Could not load persistent state: "
3284
with PGPEngine() as pgp:
3285
for client_name, client in clients_data.items():
3286
# Skip removed clients
3287
if client_name not in client_settings:
3290
# Decide which value to use after restoring saved state.
3291
# We have three different values: Old config file,
3292
# new config file, and saved state.
3293
# New config value takes precedence if it differs from old
3294
# config value, otherwise use saved state.
3295
for name, value in client_settings[client_name].items():
3297
# For each value in new config, check if it
3298
# differs from the old config value (Except for
3299
# the "secret" attribute)
3300
if (name != "secret"
3302
old_client_settings[client_name][name])):
3303
client[name] = value
3307
# Clients who has passed its expire date can still be
3308
# enabled if its last checker was successful. A Client
3309
# whose checker succeeded before we stored its state is
3310
# assumed to have successfully run all checkers during
3312
if client["enabled"]:
3313
if datetime.datetime.utcnow() >= client["expires"]:
3314
if not client["last_checked_ok"]:
3316
"disabling client {} - Client never "
3317
"performed a successful checker".format(
3319
client["enabled"] = False
3320
elif client["last_checker_status"] != 0:
3322
"disabling client {} - Client last"
3323
" checker failed with error code"
3326
client["last_checker_status"]))
3327
client["enabled"] = False
3329
client["expires"] = (
3330
datetime.datetime.utcnow()
3331
+ client["timeout"])
3332
logger.debug("Last checker succeeded,"
3333
" keeping {} enabled".format(
2163
for client in clients_data:
2164
client_name = client["name"]
2166
# Decide which value to use after restoring saved state.
2167
# We have three different values: Old config file,
2168
# new config file, and saved state.
2169
# New config value takes precedence if it differs from old
2170
# config value, otherwise use saved state.
2171
for name, value in client_settings[client_name].items():
3336
client["secret"] = pgp.decrypt(
3337
client["encrypted_secret"],
3338
client_settings[client_name]["secret"])
3340
# If decryption fails, we use secret from new settings
3341
logger.debug("Failed to decrypt {} old secret".format(
3343
client["secret"] = (client_settings[client_name]
3346
# Add/remove clients based on new changes made to config
3347
for client_name in (set(old_client_settings)
3348
- set(client_settings)):
3349
del clients_data[client_name]
3350
for client_name in (set(client_settings)
3351
- set(old_client_settings)):
3352
clients_data[client_name] = client_settings[client_name]
3354
# Create all client objects
3355
for client_name, client in clients_data.items():
3356
tcp_server.clients[client_name] = client_class(
3359
server_settings=server_settings)
2173
# For each value in new config, check if it differs
2174
# from the old config value (Except for the "secret"
2176
if (name != "secret" and
2177
value != old_client_settings[client_name][name]):
2178
setattr(client, name, value)
2182
# Clients who has passed its expire date, can still be enabled
2183
# if its last checker was sucessful. Clients who checkers
2184
# failed before we stored it state is asumed to had failed
2185
# checker during downtime.
2186
if client["enabled"] and client["last_checked_ok"]:
2187
if ((datetime.datetime.utcnow()
2188
- client["last_checked_ok"]) > client["interval"]):
2189
if client["last_checker_status"] != 0:
2190
client["enabled"] = False
2192
client["expires"] = (datetime.datetime.utcnow()
2193
+ client["timeout"])
2195
client["changedstate"] = (multiprocessing_manager
2196
.Condition(multiprocessing_manager
2199
new_client = ClientDBusTransitional.__new__(
2200
ClientDBusTransitional)
2201
tcp_server.clients[client_name] = new_client
2202
new_client.bus = bus
2203
for name, value in client.iteritems():
2204
setattr(new_client, name, value)
2205
new_client._approvals_pending = 0
2206
new_client.add_to_dbus()
2208
tcp_server.clients[client_name] = Client.__new__(Client)
2209
for name, value in client.iteritems():
2210
setattr(tcp_server.clients[client_name], name, value)
2212
tcp_server.clients[client_name].decrypt_secret(
2213
client_settings[client_name]["secret"])
2215
# Create/remove clients based on new changes made to config
2216
for clientname in set(old_client_settings) - set(client_settings):
2217
del tcp_server.clients[clientname]
2218
for clientname in set(client_settings) - set(old_client_settings):
2219
tcp_server.clients[clientname] = client_class(name
3361
2225
if not tcp_server.clients:
3362
2226
logger.warning("No clients defined")
3365
if pidfile is not None:
3369
print(pid, file=pidfile)
3371
logger.error("Could not write to file %r with PID %d",
2232
pidfile.write(str(pid) + "\n".encode("utf-8"))
2235
logger.error("Could not write to file %r with PID %d",
2238
# "pidfile" was never created
3374
2240
del pidfilename
3376
for termsig in (signal.SIGHUP, signal.SIGTERM):
3377
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3378
lambda: main_loop.quit() and False)
2242
signal.signal(signal.SIGINT, signal.SIG_IGN)
2244
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2245
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3382
@alternate_dbus_interfaces(
3383
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3384
class MandosDBusService(DBusObjectWithObjectManager):
2248
class MandosDBusService(dbus.service.Object):
3385
2249
"""A D-Bus proxy object"""
3387
2250
def __init__(self):
3388
2251
dbus.service.Object.__init__(self, bus, "/")
3390
2252
_interface = "se.recompile.Mandos"
3392
2254
@dbus.service.signal(_interface, signature="o")
3393
2255
def ClientAdded(self, objpath):
3397
2259
@dbus.service.signal(_interface, signature="ss")
3398
def ClientNotFound(self, key_id, address):
2260
def ClientNotFound(self, fingerprint, address):
3402
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3404
2264
@dbus.service.signal(_interface, signature="os")
3405
2265
def ClientRemoved(self, objpath, name):
3409
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3411
2269
@dbus.service.method(_interface, out_signature="ao")
3412
2270
def GetAllClients(self):
3414
return dbus.Array(c.dbus_object_path for c in
3415
tcp_server.clients.values())
3417
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2272
return dbus.Array(c.dbus_object_path
2274
tcp_server.clients.itervalues())
3419
2276
@dbus.service.method(_interface,
3420
2277
out_signature="a{oa{sv}}")
3421
2278
def GetAllClientsWithProperties(self):
3423
2280
return dbus.Dictionary(
3424
{c.dbus_object_path: c.GetAll(
3425
"se.recompile.Mandos.Client")
3426
for c in tcp_server.clients.values()},
2281
((c.dbus_object_path, c.GetAll(""))
2282
for c in tcp_server.clients.itervalues()),
3427
2283
signature="oa{sv}")
3429
2285
@dbus.service.method(_interface, in_signature="o")
3430
2286
def RemoveClient(self, object_path):
3432
for c in tcp_server.clients.values():
2288
for c in tcp_server.clients.itervalues():
3433
2289
if c.dbus_object_path == object_path:
3434
2290
del tcp_server.clients[c.name]
3435
2291
c.remove_from_connection()
3436
# Don't signal the disabling
2292
# Don't signal anything except ClientRemoved
3437
2293
c.disable(quiet=True)
3438
# Emit D-Bus signal for removal
3439
self.client_removed_signal(c)
2295
self.ClientRemoved(object_path, c.name)
3441
2297
raise KeyError(object_path)
3445
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3446
out_signature="a{oa{sa{sv}}}")
3447
def GetManagedObjects(self):
3449
return dbus.Dictionary(
3450
{client.dbus_object_path:
3452
{interface: client.GetAll(interface)
3454
client._get_all_interface_names()})
3455
for client in tcp_server.clients.values()})
3457
def client_added_signal(self, client):
3458
"""Send the new standard signal and the old signal"""
3460
# New standard signal
3461
self.InterfacesAdded(
3462
client.dbus_object_path,
3464
{interface: client.GetAll(interface)
3466
client._get_all_interface_names()}))
3468
self.ClientAdded(client.dbus_object_path)
3470
def client_removed_signal(self, client):
3471
"""Send the new standard signal and the old signal"""
3473
# New standard signal
3474
self.InterfacesRemoved(
3475
client.dbus_object_path,
3476
client._get_all_interface_names())
3478
self.ClientRemoved(client.dbus_object_path,
3481
mandos_dbus_service = MandosDBusService()
3483
# Save modules to variables to exempt the modules from being
3484
# unloaded before the function registered with atexit() is run.
3485
mp = multiprocessing
2301
class MandosDBusServiceTransitional(MandosDBusService):
2302
__metaclass__ = AlternateDBusNamesMetaclass
2303
mandos_dbus_service = MandosDBusServiceTransitional()
3489
2306
"Cleanup function; run on exit"
3493
mp.active_children()
2309
multiprocessing.active_children()
3495
2310
if not (tcp_server.clients or client_settings):
3498
2313
# Store client before exiting. Secrets are encrypted with key
3499
2314
# based on what config file has. If config file is
3500
2315
# removed/edited, old secret will thus be unrecovable.
3502
with PGPEngine() as pgp:
3503
for client in tcp_server.clients.values():
3504
key = client_settings[client.name]["secret"]
3505
client.encrypted_secret = pgp.encrypt(client.secret,
3509
# A list of attributes that can not be pickled
3511
exclude = {"bus", "changedstate", "secret",
3512
"checker", "server_settings"}
3513
for name, typ in inspect.getmembers(dbus.service
3517
client_dict["encrypted_secret"] = (client
3519
for attr in client.client_structure:
3520
if attr not in exclude:
3521
client_dict[attr] = getattr(client, attr)
3523
clients[client.name] = client_dict
3524
del client_settings[client.name]["secret"]
2317
for client in tcp_server.clients.itervalues():
2318
client.encrypt_secret(
2319
client_settings[client.name]["secret"])
2323
# A list of attributes that will not be stored when
2325
exclude = set(("bus", "changedstate", "secret"))
2326
for name, typ in inspect.getmembers(dbus.service.Object):
2329
client_dict["encrypted_secret"] = client.encrypted_secret
2330
for attr in client.client_structure:
2331
if attr not in exclude:
2332
client_dict[attr] = getattr(client, attr)
2334
clients.append(client_dict)
2335
del client_settings[client.name]["secret"]
3527
with tempfile.NamedTemporaryFile(
3531
dir=os.path.dirname(stored_state_path),
3532
delete=False) as stored_state:
3533
pickle.dump((clients, client_settings), stored_state,
3535
tempname = stored_state.name
3536
os.rename(tempname, stored_state_path)
3537
except (IOError, OSError) as e:
3543
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3544
logger.warning("Could not save persistent state: {}"
3545
.format(os.strerror(e.errno)))
3547
logger.warning("Could not save persistent state:",
2338
with os.fdopen(os.open(stored_state_path,
2339
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2340
stat.S_IRUSR | stat.S_IWUSR),
2341
"wb") as stored_state:
2342
pickle.dump((clients, client_settings), stored_state)
2343
except IOError as e:
2344
logger.warning("Could not save persistant state: {0}"
2346
if e.errno != errno.ENOENT:
3551
2349
# Delete all clients, and settings from config