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"
125
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
85
SO_BINDTODEVICE = None
90
stored_state_path = "/var/lib/mandos/clients.pickle"
92
#logger = logging.getLogger('mandos')
93
logger = logging.Logger('mandos')
94
syslogger = (logging.handlers.SysLogHandler
95
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
96
address = str("/dev/log")))
97
syslogger.setFormatter(logging.Formatter
98
('Mandos [%(process)d]: %(levelname)s:'
100
logger.addHandler(syslogger)
102
console = logging.StreamHandler()
103
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
106
logger.addHandler(console)
307
108
class AvahiError(Exception):
308
109
def __init__(self, value, *args, **kwargs):
309
110
self.value = value
310
return super(AvahiError, self).__init__(value, *args,
111
super(AvahiError, self).__init__(value, *args, **kwargs)
112
def __unicode__(self):
113
return unicode(repr(self.value))
314
115
class AvahiServiceError(AvahiError):
318
118
class AvahiGroupError(AvahiError):
322
122
class AvahiService(object):
323
123
"""An Avahi (Zeroconf) service.
326
126
interface: integer; avahi.IF_UNSPEC or an interface index.
327
127
Used to optionally bind to the specified interface.
328
128
name: string; Example: 'Mandos'
329
129
type: string; Example: '_mandos._tcp'.
330
See <https://www.iana.org/assignments/service-names-port-numbers>
130
See <http://www.dns-sd.org/ServiceTypes.html>
331
131
port: integer; what port to announce
332
132
TXT: list of strings; TXT record for the service
333
133
domain: string; Domain to publish on, default to .local if empty.
492
266
follow_name_owner_changes=True),
493
267
avahi.DBUS_INTERFACE_SERVER)
494
268
self.server.connect_to_signal("StateChanged",
495
self.server_state_changed)
269
self.server_state_changed)
496
270
self.server_state_changed(self.server.GetState())
499
class AvahiServiceToSyslog(AvahiService):
500
def rename(self, *args, **kwargs):
501
"""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'
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))
273
def _timedelta_to_milliseconds(td):
274
"Convert a datetime.timedelta() to milliseconds"
275
return ((td.days * 24 * 60 * 60 * 1000)
276
+ (td.seconds * 1000)
277
+ (td.microseconds // 1000))
821
279
class Client(object):
822
280
"""A representation of a client host served by this server.
825
approved: bool(); 'None' if not yet approved/disapproved
283
_approved: bool(); 'None' if not yet approved/disapproved
826
284
approval_delay: datetime.timedelta(); Time to wait for approval
827
285
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
286
checker: subprocess.Popen(); a running checker process used
287
to see if the client lives.
288
'None' if no process is running.
289
checker_callback_tag: a gobject event source tag, or None
832
290
checker_command: string; External command which is run to check
833
291
if client lives. %() expansions are done at
834
292
runtime with vars(self) as dict, so that for
835
293
instance %(name)s can be used in the command.
836
checker_initiator_tag: a GLib event source tag, or None
294
checker_initiator_tag: a gobject event source tag, or None
837
295
created: datetime.datetime(); (UTC) object creation
838
296
client_structure: Object describing what attributes a client has
839
297
and is used for storing the client at exit
840
298
current_checker_command: string; current running checker_command
841
disable_initiator_tag: a GLib event source tag, or None
299
disable_initiator_tag: a gobject event source tag, or None
843
301
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
302
uniquely identify the client
847
303
host: string; available for use by the checker command
848
304
interval: datetime.timedelta(); How often to start a new checker
849
305
last_approval_request: datetime.datetime(); (UTC) or None
850
306
last_checked_ok: datetime.datetime(); (UTC) or None
851
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
307
Last_checker_status: integer between 0 and 255 reflecting exit status
308
of last checker. -1 reflect crashed checker.
309
last_enabled: datetime.datetime(); (UTC)
857
310
name: string; from the config file, used in log messages and
858
311
D-Bus identifiers
859
312
secret: bytestring; sent verbatim (over TLS) to client
860
313
timeout: datetime.timedelta(); How long from last_checked_ok
861
314
until this client is disabled
862
extended_timeout: extra long timeout when secret has been sent
315
extended_timeout: extra long timeout when password has been sent
863
316
runtime_expansions: Allowed attributes for runtime expansion.
864
317
expires: datetime.datetime(); time (UTC) when a client will be
865
318
disabled, or None
866
server_settings: The server_settings dict from main()
869
321
runtime_expansions = ("approval_delay", "approval_duration",
870
"created", "enabled", "expires", "key_id",
871
"fingerprint", "host", "interval",
872
"last_approval_request", "last_checked_ok",
322
"created", "enabled", "fingerprint",
323
"host", "interval", "last_checked_ok",
873
324
"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):
326
def timeout_milliseconds(self):
327
"Return the 'timeout' attribute in milliseconds"
328
return _timedelta_to_milliseconds(self.timeout)
330
def extended_timeout_milliseconds(self):
331
"Return the 'extended_timeout' attribute in milliseconds"
332
return _timedelta_to_milliseconds(self.extended_timeout)
334
def interval_milliseconds(self):
335
"Return the 'interval' attribute in milliseconds"
336
return _timedelta_to_milliseconds(self.interval)
338
def approval_delay_milliseconds(self):
339
return _timedelta_to_milliseconds(self.approval_delay)
341
def __init__(self, name = None, config=None):
342
"""Note: the 'checker' key in 'config' sets the
343
'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
348
logger.debug("Creating client %r", self.name)
960
logger.debug(" Key ID: %s", self.key_id)
349
# Uppercase and remove spaces from fingerprint for later
350
# comparison purposes with return value from the fingerprint()
352
self.fingerprint = (config["fingerprint"].upper()
961
354
logger.debug(" Fingerprint: %s", self.fingerprint)
962
self.created = settings.get("created",
963
datetime.datetime.utcnow())
965
# attributes specific for this server instance
355
if "secret" in config:
356
self.secret = config["secret"].decode("base64")
357
elif "secfile" in config:
358
with open(os.path.expanduser(os.path.expandvars
359
(config["secfile"])),
361
self.secret = secfile.read()
363
raise TypeError("No secret or secfile for client %s"
365
self.host = config.get("host", "")
366
self.created = datetime.datetime.utcnow()
368
self.last_approval_request = None
369
self.last_enabled = datetime.datetime.utcnow()
370
self.last_checked_ok = None
371
self.last_checker_status = 0
372
self.timeout = string_to_delta(config["timeout"])
373
self.extended_timeout = string_to_delta(config
374
["extended_timeout"])
375
self.interval = string_to_delta(config["interval"])
966
376
self.checker = None
967
377
self.checker_initiator_tag = None
968
378
self.disable_initiator_tag = None
379
self.expires = datetime.datetime.utcnow() + self.timeout
969
380
self.checker_callback_tag = None
381
self.checker_command = config["checker"]
970
382
self.current_checker_command = None
383
self._approved = None
384
self.approved_by_default = config.get("approved_by_default",
972
386
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()
977
if not attr.startswith("_")]
387
self.approval_delay = string_to_delta(
388
config["approval_delay"])
389
self.approval_duration = string_to_delta(
390
config["approval_duration"])
391
self.changedstate = (multiprocessing_manager
392
.Condition(multiprocessing_manager
394
self.client_structure = [attr for attr in self.__dict__.iterkeys() if not attr.startswith("_")]
978
395
self.client_structure.append("client_structure")
980
for name, t in inspect.getmembers(
981
type(self), lambda obj: isinstance(obj, property)):
398
for name, t in inspect.getmembers(type(self),
399
lambda obj: isinstance(obj, property)):
982
400
if not name.startswith("_"):
983
401
self.client_structure.append(name)
985
# Send notice to process children that client state has changed
986
404
def send_changedstate(self):
987
with self.changedstate:
988
self.changedstate.notify_all()
405
self.changedstate.acquire()
406
self.changedstate.notify_all()
407
self.changedstate.release()
990
409
def enable(self):
991
410
"""Start this client's checker and timeout hooks"""
992
411
if getattr(self, "enabled", False):
993
412
# Already enabled
414
self.send_changedstate()
995
415
self.expires = datetime.datetime.utcnow() + self.timeout
996
416
self.enabled = True
997
417
self.last_enabled = datetime.datetime.utcnow()
998
418
self.init_checker()
999
self.send_changedstate()
1001
420
def disable(self, quiet=True):
1002
421
"""Disable this client."""
1003
422
if not getattr(self, "enabled", False):
425
self.send_changedstate()
1006
427
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)
428
if getattr(self, "disable_initiator_tag", False):
429
gobject.source_remove(self.disable_initiator_tag)
1009
430
self.disable_initiator_tag = None
1010
431
self.expires = None
1011
if getattr(self, "checker_initiator_tag", None) is not None:
1012
GLib.source_remove(self.checker_initiator_tag)
432
if getattr(self, "checker_initiator_tag", False):
433
gobject.source_remove(self.checker_initiator_tag)
1013
434
self.checker_initiator_tag = None
1014
435
self.stop_checker()
1015
436
self.enabled = False
1017
self.send_changedstate()
1018
# Do not run this again if called by a GLib.timeout_add
437
# Do not run this again if called by a gobject.timeout_add
1021
440
def __del__(self):
1024
443
def init_checker(self):
1025
444
# Schedule a new checker to be started an 'interval' from now,
1026
445
# 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),
446
self.checker_initiator_tag = (gobject.timeout_add
447
(self.interval_milliseconds(),
1032
449
# 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)
450
self.disable_initiator_tag = (gobject.timeout_add
451
(self.timeout_milliseconds(),
1037
453
# Also start a new checker *right now*.
1038
454
self.start_checker()
1040
def checker_callback(self, source, condition, connection,
457
def checker_callback(self, pid, condition, command):
1042
458
"""The checker has completed, so take appropriate actions."""
1043
# Read return code from connection (see call_pipe)
1044
returncode = connection.recv()
1047
459
self.checker_callback_tag = None
1048
460
self.checker = None
1051
self.last_checker_status = returncode
1052
self.last_checker_signal = None
461
if os.WIFEXITED(condition):
462
self.last_checker_status = os.WEXITSTATUS(condition)
1053
463
if self.last_checker_status == 0:
1054
464
logger.info("Checker for %(name)s succeeded",
1056
466
self.checked_ok()
1058
logger.info("Checker for %(name)s failed", vars(self))
468
logger.info("Checker for %(name)s failed",
1060
471
self.last_checker_status = -1
1061
self.last_checker_signal = -returncode
1062
472
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."""
475
def checked_ok(self, timeout=None):
476
"""Bump up the timeout for this client.
478
This should only be called when the client has been seen,
1075
481
if timeout is None:
1076
482
timeout = self.timeout
483
self.last_checked_ok = datetime.datetime.utcnow()
1077
484
if self.disable_initiator_tag is not None:
1078
GLib.source_remove(self.disable_initiator_tag)
1079
self.disable_initiator_tag = None
485
gobject.source_remove(self.disable_initiator_tag)
1080
486
if getattr(self, "enabled", False):
1081
self.disable_initiator_tag = GLib.timeout_add(
1082
int(timeout.total_seconds() * 1000), self.disable)
487
self.disable_initiator_tag = (gobject.timeout_add
488
(_timedelta_to_milliseconds
489
(timeout), self.disable))
1083
490
self.expires = datetime.datetime.utcnow() + timeout
1085
492
def need_approval(self):
1086
493
self.last_approval_request = datetime.datetime.utcnow()
1088
495
def start_checker(self):
1089
496
"""Start a new checker subprocess if one is not running.
1091
498
If a checker already exists, leave it running and do
1093
500
# 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
501
# did that, then if a checker (for some reason) started
502
# running slowly and taking more than 'interval' time, the
503
# client would inevitably timeout, since no checker would get
504
# a chance to run to completion. If we instead leave running
1098
505
# checkers alone, the checker would have to take more time
1099
506
# 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")
509
# If a checker exists, make sure it is not a zombie
511
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
512
except (AttributeError, OSError) as error:
513
if (isinstance(error, OSError)
514
and error.errno != errno.ECHILD):
518
logger.warning("Checker was a zombie")
519
gobject.source_remove(self.checker_callback_tag)
520
self.checker_callback(pid, status,
521
self.current_checker_command)
1106
522
# Start a new checker if needed
1107
523
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
525
# In case checker_command has exactly one % operator
526
command = self.checker_command % self.host
528
# Escape attributes for the shell
529
escaped_attrs = dict(
531
re.escape(unicode(str(getattr(self, attr, "")),
535
self.runtime_expansions)
538
command = self.checker_command % escaped_attrs
539
except TypeError as error:
540
logger.error('Could not format string "%s":'
541
' %s', self.checker_command, error)
542
return True # Try again later
1119
543
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
545
logger.info("Starting checker %r for %s",
547
# We don't need to redirect stdout and stderr, since
548
# in normal mode, that is already done by daemon(),
549
# and in debug mode we don't want to. (Stdin is
550
# always replaced by /dev/null.)
551
self.checker = subprocess.Popen(command,
554
self.checker_callback_tag = (gobject.child_watch_add
556
self.checker_callback,
558
# The checker may have completed before the gobject
559
# watch was added. Check for this.
560
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
562
gobject.source_remove(self.checker_callback_tag)
563
self.checker_callback(pid, status, command)
564
except OSError as error:
565
logger.error("Failed to start subprocess: %s",
567
# Re-run this periodically if run by gobject.timeout_add
1148
570
def stop_checker(self):
1149
571
"""Force the checker process, if any, to stop."""
1150
572
if self.checker_callback_tag:
1151
GLib.source_remove(self.checker_callback_tag)
573
gobject.source_remove(self.checker_callback_tag)
1152
574
self.checker_callback_tag = None
1153
575
if getattr(self, "checker", None) is None:
1155
577
logger.debug("Stopping checker for %(name)s", vars(self))
1156
self.checker.terminate()
579
os.kill(self.checker.pid, signal.SIGTERM)
581
#if self.checker.poll() is None:
582
# os.kill(self.checker.pid, signal.SIGKILL)
583
except OSError as error:
584
if error.errno != errno.ESRCH: # No such process
1157
586
self.checker = None
1160
def dbus_service_property(dbus_interface,
588
# Encrypts a client secret and stores it in a varible encrypted_secret
589
def encrypt_secret(self, key):
590
# Encryption-key need to be specific size, so we hash inputed key
591
hasheng = hashlib.sha256()
593
encryptionkey = hasheng.digest()
595
# Create validation hash so we know at decryption if it was sucessful
596
hasheng = hashlib.sha256()
597
hasheng.update(self.secret)
598
validationhash = hasheng.digest()
601
iv = os.urandom(Crypto.Cipher.AES.block_size)
602
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
603
Crypto.Cipher.AES.MODE_CFB, iv)
604
ciphertext = ciphereng.encrypt(validationhash+self.secret)
605
self.encrypted_secret = (ciphertext, iv)
607
# Decrypt a encrypted client secret
608
def decrypt_secret(self, key):
609
# Decryption-key need to be specific size, so we hash inputed key
610
hasheng = hashlib.sha256()
612
encryptionkey = hasheng.digest()
614
# Decrypt encrypted secret
615
ciphertext, iv = self.encrypted_secret
616
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
617
Crypto.Cipher.AES.MODE_CFB, iv)
618
plain = ciphereng.decrypt(ciphertext)
620
# Validate decrypted secret to know if it was succesful
621
hasheng = hashlib.sha256()
622
validationhash = plain[:hasheng.digest_size]
623
secret = plain[hasheng.digest_size:]
624
hasheng.update(secret)
626
# if validation fails, we use key as new secret. Otherwhise, we use
627
# the decrypted secret
628
if hasheng.digest() == validationhash:
632
del self.encrypted_secret
635
def dbus_service_property(dbus_interface, signature="v",
636
access="readwrite", byte_arrays=False):
1164
637
"""Decorators for marking methods of a DBusObjectWithProperties to
1165
638
become properties on the D-Bus.
1167
640
The decorated method will be called with no arguments by "Get"
1168
641
and with one argument by "Set".
1170
643
The parameters, where they are supported, are the same as
1171
644
dbus.service.method, except there is only "signature", since the
1172
645
type from Get() and the type sent to Set() is the same.
1505
815
except (AttributeError, xml.dom.DOMException,
1506
816
xml.parsers.expat.ExpatError) as error:
1507
817
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):
822
def datetime_to_dbus (dt, variant_level=0):
1584
823
"""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).
825
return dbus.String("", variant_level = variant_level)
826
return dbus.String(dt.isoformat(),
827
variant_level=variant_level)
829
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
831
"""Applied to an empty subclass of a D-Bus object, this metaclass
832
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):
834
def __new__(mcs, name, bases, attr):
835
# Go through all the base classes which could have D-Bus
836
# methods, signals, or properties in them
837
for base in (b for b in bases
838
if issubclass(b, dbus.service.Object)):
839
# Go though all attributes of the base class
840
for attrname, attribute in inspect.getmembers(base):
1621
841
# Ignore non-D-Bus attributes, and D-Bus attributes
1622
842
# with the wrong interface name
1623
843
if (not hasattr(attribute, "_dbus_interface")
1624
or not attribute._dbus_interface.startswith(
1625
orig_interface_name)):
844
or not attribute._dbus_interface
845
.startswith("se.recompile.Mandos")):
1627
847
# Create an alternate D-Bus interface name based on
1628
848
# the current name
1629
alt_interface = attribute._dbus_interface.replace(
1630
orig_interface_name, alt_interface_name)
1631
interface_names.add(alt_interface)
849
alt_interface = (attribute._dbus_interface
850
.replace("se.recompile.Mandos",
851
"se.bsnet.fukt.Mandos"))
1632
852
# Is this a D-Bus signal?
1633
853
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(
854
# Extract the original non-method function by
856
nonmethod_func = (dict(
1638
857
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)
858
attribute.__closure__))["func"]
1646
860
# Create a new, but exactly alike, function
1647
861
# object, and decorate it to be a new D-Bus signal
1648
862
# 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:
863
new_function = (dbus.service.signal
865
attribute._dbus_signature)
867
nonmethod_func.func_code,
868
nonmethod_func.func_globals,
869
nonmethod_func.func_name,
870
nonmethod_func.func_defaults,
871
nonmethod_func.func_closure)))
1660
872
# 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
873
# old and new functions, so both the old and new
874
# signals gets sent when the function is called
1664
875
def fixscope(func1, func2):
1665
876
"""This function is a scope container to pass
1666
877
func1 and func2 to the "call_both" function
1667
878
outside of its arguments"""
1669
@functools.wraps(func2)
1670
879
def call_both(*args, **kwargs):
1671
880
"""This function will emit two D-Bus
1672
881
signals by calling func1 and func2"""
1673
882
func1(*args, **kwargs)
1674
883
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
884
return call_both
1682
885
# Create the "call_both" function and add it to
1684
attr[attrname] = fixscope(attribute, new_function)
887
attr[attrname] = fixscope(attribute,
1685
889
# Is this a D-Bus method?
1686
890
elif getattr(attribute, "_dbus_is_method", False):
1687
891
# Create a new, but exactly alike, function
1688
892
# object. Decorate it to be a new D-Bus method
1689
893
# 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:
895
attr[attrname] = (dbus.service.method
897
attribute._dbus_in_signature,
898
attribute._dbus_out_signature)
900
(attribute.func_code,
901
attribute.func_globals,
903
attribute.func_defaults,
904
attribute.func_closure)))
1703
905
# Is this a D-Bus property?
1704
906
elif getattr(attribute, "_dbus_is_property", False):
1705
907
# Create a new, but exactly alike, function
1706
908
# object, and decorate it to be a new D-Bus
1707
909
# property with the alternate D-Bus interface
1708
910
# 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"})
911
attr[attrname] = (dbus_service_property
913
attribute._dbus_signature,
914
attribute._dbus_access,
916
._dbus_get_args_options
919
(attribute.func_code,
920
attribute.func_globals,
922
attribute.func_defaults,
923
attribute.func_closure)))
924
return type.__new__(mcs, name, bases, attr)
1761
926
class ClientDBus(Client, DBusObjectWithProperties):
1762
927
"""A Client class using D-Bus
1765
930
dbus_object_path: dbus.ObjectPath
1766
931
bus: dbus.SystemBus()
1769
934
runtime_expansions = (Client.runtime_expansions
1770
+ ("dbus_object_path", ))
1772
_interface = "se.recompile.Mandos.Client"
935
+ ("dbus_object_path",))
1774
937
# dbus.service.Object doesn't use super(), so we can't either.
1776
def __init__(self, bus=None, *args, **kwargs):
939
def __init__(self, bus = None, *args, **kwargs):
1778
941
Client.__init__(self, *args, **kwargs)
943
self._approvals_pending = 0
1779
944
# Only now, when this client is initialized, can it show up on
1781
client_object_name = str(self.name).translate(
946
client_object_name = unicode(self.name).translate(
1782
947
{ord("."): ord("_"),
1783
948
ord("-"): ord("_")})
1784
self.dbus_object_path = dbus.ObjectPath(
1785
"/clients/" + client_object_name)
949
self.dbus_object_path = (dbus.ObjectPath
950
("/clients/" + client_object_name))
1786
951
DBusObjectWithProperties.__init__(self, self.bus,
1787
952
self.dbus_object_path)
1789
def notifychangeproperty(transform_func, dbus_name,
1790
type_func=lambda x: x,
1792
invalidate_only=False,
1793
_interface=_interface):
954
def notifychangeproperty(transform_func,
955
dbus_name, type_func=lambda x: x,
1794
957
""" Modify a variable so that it's a property which announces
1795
958
its changes to DBus.
2190
1310
self.start_checker()
2192
1312
self.stop_checker()
2194
1314
# ObjectPath - property
2196
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2197
"org.freedesktop.DBus.Deprecated": "true"})
2198
1315
@dbus_service_property(_interface, signature="o", access="read")
2199
1316
def ObjectPath_dbus_property(self):
2200
return self.dbus_object_path # is already a dbus.ObjectPath
1317
return self.dbus_object_path # is already a dbus.ObjectPath
2202
1319
# Secret = property
2204
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2206
@dbus_service_property(_interface,
1320
@dbus_service_property(_interface, signature="ay",
1321
access="write", byte_arrays=True)
2210
1322
def Secret_dbus_property(self, value):
2211
self.secret = bytes(value)
1323
self.secret = str(value)
2216
1328
class ProxyClient(object):
2217
def __init__(self, child_pipe, key_id, fpr, address):
1329
def __init__(self, child_pipe, fpr, address):
2218
1330
self._pipe = child_pipe
2219
self._pipe.send(('init', key_id, fpr, address))
1331
self._pipe.send(('init', fpr, address))
2220
1332
if not self._pipe.recv():
2221
raise KeyError(key_id or fpr)
2223
1335
def __getattribute__(self, name):
1336
if(name == '_pipe'):
2225
1337
return super(ProxyClient, self).__getattribute__(name)
2226
1338
self._pipe.send(('getattr', name))
2227
1339
data = self._pipe.recv()
2228
1340
if data[0] == 'data':
2230
1342
if data[0] == 'function':
2232
1343
def func(*args, **kwargs):
2233
1344
self._pipe.send(('funcall', name, args, kwargs))
2234
1345
return self._pipe.recv()[1]
2238
1348
def __setattr__(self, name, value):
1349
if(name == '_pipe'):
2240
1350
return super(ProxyClient, self).__setattr__(name, value)
2241
1351
self._pipe.send(('setattr', name, value))
1353
class ClientDBusTransitional(ClientDBus):
1354
__metaclass__ = AlternateDBusNamesMetaclass
2244
1356
class ClientHandler(socketserver.BaseRequestHandler, object):
2245
1357
"""A class to handle client connections.
2247
1359
Instantiated once for each connection to handle it.
2248
1360
Note: This will run in its own forked process."""
2250
1362
def handle(self):
2251
1363
with contextlib.closing(self.server.child_pipe) as child_pipe:
2252
1364
logger.info("TCP connection from: %s",
2253
str(self.client_address))
1365
unicode(self.client_address))
2254
1366
logger.debug("Pipe FD: %d",
2255
1367
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",
1369
session = (gnutls.connection
1370
.ClientSession(self.request,
1372
.X509Credentials()))
1374
# Note: gnutls.connection.X509Credentials is really a
1375
# generic GnuTLS certificate credentials object so long as
1376
# no X.509 keys are added to it. Therefore, we can use it
1377
# here despite using OpenPGP certificates.
1379
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1380
# "+AES-256-CBC", "+SHA1",
1381
# "+COMP-NULL", "+CTYPE-OPENPGP",
2263
1383
# Use a fallback default, since this MUST be set.
2264
1384
priority = self.server.gnutls_priority
2265
1385
if priority is None:
2266
1386
priority = "NORMAL"
2267
gnutls.priority_set_direct(session._c_object,
2268
priority.encode("utf-8"),
1387
(gnutls.library.functions
1388
.gnutls_priority_set_direct(session._c_object,
2271
1391
# Start communication using the Mandos protocol
2272
1392
# Get protocol number
2273
1393
line = self.request.makefile().readline()
2274
1394
logger.debug("Protocol version: %r", line)
2276
1396
if int(line.strip().split()[0]) > 1:
2277
raise RuntimeError(line)
2278
1398
except (ValueError, IndexError, RuntimeError) as error:
2279
1399
logger.error("Unknown protocol version: %s", error)
2282
1402
# Start GnuTLS connection
2284
1404
session.handshake()
2285
except gnutls.Error as error:
1405
except gnutls.errors.GNUTLSError as error:
2286
1406
logger.warning("Handshake failed: %s", error)
2287
1407
# Do not run session.bye() here: the session is not
2288
1408
# established. Just abandon the request.
2290
1410
logger.debug("Handshake succeeded")
2292
1412
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,
1415
fpr = self.fingerprint(self.peer_certificate
1418
gnutls.errors.GNUTLSError) as error:
1419
logger.warning("Bad certificate: %s", error)
1421
logger.debug("Fingerprint: %s", fpr)
1424
client = ProxyClient(child_pipe, fpr,
2316
1425
self.client_address)
2317
1426
except KeyError:
2320
1429
if client.approval_delay:
2321
1430
delay = client.approval_delay
2322
1431
client.approvals_pending += 1
2323
1432
approval_required = True
2326
1435
if not client.enabled:
2327
1436
logger.info("Client %s is disabled",
2329
1438
if self.server.use_dbus:
2330
1439
# Emit D-Bus signal
2331
1440
client.Rejected("Disabled")
2334
if client.approved or not client.approval_delay:
2335
# We are approved or approval is disabled
1443
if client._approved or not client.approval_delay:
1444
#We are approved or approval is disabled
2337
elif client.approved is None:
1446
elif client._approved is None:
2338
1447
logger.info("Client %s needs approval",
2340
1449
if self.server.use_dbus:
2341
1450
# Emit D-Bus signal
2342
1451
client.NeedApproval(
2343
client.approval_delay.total_seconds()
2344
* 1000, client.approved_by_default)
1452
client.approval_delay_milliseconds(),
1453
client.approved_by_default)
2346
1455
logger.warning("Client %s was not approved",
2371
1482
delay -= time2 - time
2374
session.send(client.secret)
2375
except gnutls.Error as error:
2376
logger.warning("gnutls send failed",
1485
while sent_size < len(client.secret):
1487
sent = session.send(client.secret[sent_size:])
1488
except gnutls.errors.GNUTLSError as error:
1489
logger.warning("gnutls send failed")
1491
logger.debug("Sent: %d, remaining: %d",
1492
sent, len(client.secret)
1493
- (sent_size + sent))
2380
1496
logger.info("Sending secret to %s", client.name)
2381
1497
# bump the timeout using extended_timeout
2382
client.bump_timeout(client.extended_timeout)
1498
client.checked_ok(client.extended_timeout)
2383
1499
if self.server.use_dbus:
2384
1500
# Emit D-Bus signal
2385
1501
client.GotSecret()
2388
1504
if approval_required:
2389
1505
client.approvals_pending -= 1
2392
except gnutls.Error as error:
2393
logger.warning("GnuTLS bye failed",
1508
except gnutls.errors.GNUTLSError as error:
1509
logger.warning("GnuTLS bye failed")
2397
1512
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
1513
"Return the peer's OpenPGP certificate as a bytestring"
1514
# If not an OpenPGP certificate...
1515
if (gnutls.library.functions
1516
.gnutls_certificate_type_get(session._c_object)
1517
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1518
# ...do the normal thing
1519
return session.peer_certificate
2414
1520
list_size = ctypes.c_uint(1)
2415
cert_list = (gnutls.certificate_get_peers
1521
cert_list = (gnutls.library.functions
1522
.gnutls_certificate_get_peers
2416
1523
(session._c_object, ctypes.byref(list_size)))
2417
1524
if not bool(cert_list) and list_size.value != 0:
2418
raise gnutls.Error("error getting peer certificate")
1525
raise gnutls.errors.GNUTLSError("error getting peer"
2419
1527
if list_size.value == 0:
2421
1529
cert = cert_list[0]
2422
1530
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
1533
def fingerprint(openpgp):
2460
1534
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2461
1535
# 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)))
1536
datum = (gnutls.library.types
1537
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1540
ctypes.c_uint(len(openpgp))))
2466
1541
# New empty GnuTLS certificate
2467
crt = gnutls.openpgp_crt_t()
2468
gnutls.openpgp_crt_init(ctypes.byref(crt))
1542
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1543
(gnutls.library.functions
1544
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2469
1545
# Import the OpenPGP public key into the certificate
2470
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2471
gnutls.OPENPGP_FMT_RAW)
1546
(gnutls.library.functions
1547
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1548
gnutls.library.constants
1549
.GNUTLS_OPENPGP_FMT_RAW))
2472
1550
# Verify the self signature in the key
2473
1551
crtverify = ctypes.c_uint()
2474
gnutls.openpgp_crt_verify_self(crt, 0,
2475
ctypes.byref(crtverify))
1552
(gnutls.library.functions
1553
.gnutls_openpgp_crt_verify_self(crt, 0,
1554
ctypes.byref(crtverify)))
2476
1555
if crtverify.value != 0:
2477
gnutls.openpgp_crt_deinit(crt)
2478
raise gnutls.CertificateSecurityError(code
1556
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1557
raise (gnutls.errors.CertificateSecurityError
2480
1559
# New buffer for the fingerprint
2481
1560
buf = ctypes.create_string_buffer(20)
2482
1561
buf_len = ctypes.c_size_t()
2483
1562
# Get the fingerprint from the certificate into the buffer
2484
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2485
ctypes.byref(buf_len))
1563
(gnutls.library.functions
1564
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1565
ctypes.byref(buf_len)))
2486
1566
# Deinit the certificate
2487
gnutls.openpgp_crt_deinit(crt)
1567
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2488
1568
# Convert the buffer to a Python bytestring
2489
1569
fpr = ctypes.string_at(buf, buf_len.value)
2490
1570
# Convert the bytestring to hexadecimal notation
2491
hex_fpr = binascii.hexlify(fpr).upper()
1571
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2495
1575
class MultiprocessingMixIn(object):
2496
1576
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2498
1577
def sub_process_main(self, request, address):
2500
1579
self.finish_request(request, address)
2502
1581
self.handle_error(request, address)
2503
1582
self.close_request(request)
2505
1584
def process_request(self, request, address):
2506
1585
"""Start a new process to process the request."""
2507
proc = multiprocessing.Process(target=self.sub_process_main,
2508
args=(request, address))
1586
proc = multiprocessing.Process(target = self.sub_process_main,
2513
1593
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2514
1594
""" adds a pipe to the MixIn """
2516
1595
def process_request(self, request, client_address):
2517
1596
"""Overrides and wraps the original process_request().
2519
1598
This function creates a new pipe in self.pipe
2521
1600
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2523
1602
proc = MultiprocessingMixIn.process_request(self, request,
2524
1603
client_address)
2525
1604
self.child_pipe.close()
2526
1605
self.add_pipe(parent_pipe, proc)
2528
1607
def add_pipe(self, parent_pipe, proc):
2529
1608
"""Dummy function; override as necessary"""
2530
raise NotImplementedError()
1609
raise NotImplementedError
2533
1612
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2534
1613
socketserver.TCPServer, object):
2535
1614
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2538
1617
enabled: Boolean; whether this server is activated yet
2539
1618
interface: None or a network interface name (string)
2540
1619
use_ipv6: Boolean; to use IPv6 or not
2543
1621
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().
1622
interface=None, use_ipv6=True):
2550
1623
self.interface = interface
2552
1625
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
1626
socketserver.TCPServer.__init__(self, server_address,
2581
1627
RequestHandlerClass)
2583
1628
def server_bind(self):
2584
1629
"""This overrides the normal server_bind() function
2585
1630
to bind to an interface if one was specified, and also NOT to
2586
1631
bind to an address or port if they were not specified."""
2587
global SO_BINDTODEVICE
2588
1632
if self.interface is not None:
2589
1633
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)
1634
logger.error("SO_BINDTODEVICE does not exist;"
1635
" cannot bind to interface %s",
1639
self.socket.setsockopt(socket.SOL_SOCKET,
1643
except socket.error as error:
1644
if error[0] == errno.EPERM:
1645
logger.error("No permission to"
1646
" bind to interface %s",
1648
elif error[0] == errno.ENOPROTOOPT:
1649
logger.error("SO_BINDTODEVICE not available;"
1650
" cannot bind to interface %s",
2611
1654
# Only bind(2) the socket if we really need to.
2612
1655
if self.server_address[0] or self.server_address[1]:
2613
if self.server_address[1]:
2614
self.allow_reuse_address = True
2615
1656
if not self.server_address[0]:
2616
1657
if self.address_family == socket.AF_INET6:
2617
any_address = "::" # in6addr_any
1658
any_address = "::" # in6addr_any
2619
any_address = "0.0.0.0" # INADDR_ANY
1660
any_address = socket.INADDR_ANY
2620
1661
self.server_address = (any_address,
2621
1662
self.server_address[1])
2622
1663
elif not self.server_address[1]:
2623
self.server_address = (self.server_address[0], 0)
1664
self.server_address = (self.server_address[0],
2624
1666
# if self.interface:
2625
1667
# self.server_address = (self.server_address[0],
2953
1913
parser.add_argument("--no-dbus", action="store_false",
2954
1914
dest="use_dbus", help="Do not provide D-Bus"
2955
" system bus interface", default=None)
1915
" system bus interface")
2956
1916
parser.add_argument("--no-ipv6", action="store_false",
2957
dest="use_ipv6", help="Do not use IPv6",
1917
dest="use_ipv6", help="Do not use IPv6")
2959
1918
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",
1919
dest="restore", help="Do not restore old state",
2973
1922
options = parser.parse_args()
2975
1924
if options.check:
2977
fail_count, test_count = doctest.testmod()
2978
sys.exit(os.EX_OK if fail_count == 0 else 1)
2980
1929
# 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",
1930
server_defaults = { "interface": "",
1935
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1936
"servicename": "Mandos",
3004
1942
# Parse config file for server-global settings
3005
server_config = configparser.ConfigParser(server_defaults)
1943
server_config = configparser.SafeConfigParser(server_defaults)
3006
1944
del server_defaults
3007
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3008
# Convert the ConfigParser object to a dict
1945
server_config.read(os.path.join(options.configdir,
1947
# Convert the SafeConfigParser object to a dict
3009
1948
server_settings = server_config.defaults()
3010
1949
# Use the appropriate methods on the non-string config options
3011
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3012
"foreground", "zeroconf"):
1950
for option in ("debug", "use_dbus", "use_ipv6"):
3013
1951
server_settings[option] = server_config.getboolean("DEFAULT",
3015
1953
if server_settings["port"]:
3016
1954
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
1956
del server_config
3029
1958
# Override the settings from the config file with command line
3030
1959
# options, if set.
3031
1960
for option in ("interface", "address", "port", "debug",
3032
"priority", "servicename", "configdir", "use_dbus",
3033
"use_ipv6", "debuglevel", "restore", "statedir",
3034
"socket", "foreground", "zeroconf"):
1961
"priority", "servicename", "configdir",
1962
"use_dbus", "use_ipv6", "debuglevel", "restore"):
3035
1963
value = getattr(options, option)
3036
1964
if value is not None:
3037
1965
server_settings[option] = value
3039
1967
# Force all strings to be unicode
3040
1968
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
1969
if type(server_settings[option]) is str:
1970
server_settings[option] = unicode(server_settings[option])
3051
1971
# Now we have our good server settings in "server_settings"
3053
1973
##################################################################
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
1975
# For convenience
3061
1976
debug = server_settings["debug"]
3062
1977
debuglevel = server_settings["debuglevel"]
3063
1978
use_dbus = server_settings["use_dbus"]
3064
1979
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
1981
if server_settings["servicename"] != "Mandos":
3080
syslogger.setFormatter(
3081
logging.Formatter('Mandos ({}) [%(process)d]:'
3082
' %(levelname)s: %(message)s'.format(
3083
server_settings["servicename"])))
1982
syslogger.setFormatter(logging.Formatter
1983
('Mandos (%s) [%%(process)d]:'
1984
' %%(levelname)s: %%(message)s'
1985
% server_settings["servicename"]))
3085
1987
# Parse config file with clients
3086
client_config = configparser.ConfigParser(Client.client_defaults)
1988
client_defaults = { "timeout": "5m",
1989
"extended_timeout": "15m",
1991
"checker": "fping -q -- %%(host)s",
1993
"approval_delay": "0s",
1994
"approval_duration": "1s",
1996
client_config = configparser.SafeConfigParser(client_defaults)
3087
1997
client_config.read(os.path.join(server_settings["configdir"],
3088
1998
"clients.conf"))
3090
2000
global mandos_dbus_service
3091
2001
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
2003
tcp_server = MandosServer((server_settings["address"],
2004
server_settings["port"]),
2006
interface=(server_settings["interface"]
2010
server_settings["priority"],
2013
pidfilename = "/var/run/mandos.pid"
2015
pidfile = open(pidfilename, "w")
2017
logger.error("Could not open file %r", pidfilename)
2020
uid = pwd.getpwnam("_mandos").pw_uid
2021
gid = pwd.getpwnam("_mandos").pw_gid
2024
uid = pwd.getpwnam("mandos").pw_uid
2025
gid = pwd.getpwnam("mandos").pw_gid
3122
2026
except KeyError:
2028
uid = pwd.getpwnam("nobody").pw_uid
2029
gid = pwd.getpwnam("nobody").pw_gid
3131
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3133
2036
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:
2037
if error[0] != errno.EPERM:
2040
if not debug and not debuglevel:
2041
syslogger.setLevel(logging.WARNING)
2042
console.setLevel(logging.WARNING)
2044
level = getattr(logging, debuglevel.upper())
2045
syslogger.setLevel(level)
2046
console.setLevel(level)
3140
2049
# Enable all possible GnuTLS debugging
3142
2051
# "Use a log level over 10 to enable all debugging options."
3143
2052
# - GnuTLS manual
3144
gnutls.global_set_log_level(11)
2053
gnutls.library.functions.gnutls_global_set_log_level(11)
2055
@gnutls.library.types.gnutls_log_func
3147
2056
def debug_gnutls(level, string):
3148
2057
logger.debug("GnuTLS: %s", string[:-1])
3150
gnutls.global_set_log_function(debug_gnutls)
2059
(gnutls.library.functions
2060
.gnutls_global_set_log_function(debug_gnutls))
3152
2062
# Redirect stdin so all checkers get /dev/null
3153
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2063
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3154
2064
os.dup2(null, sys.stdin.fileno())
2068
# No console logging
2069
logger.removeHandler(console)
3158
2071
# Need to fork before connecting to D-Bus
3160
2073
# 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
2076
global main_loop
3169
2077
# From the Avahi example code
3170
DBusGMainLoop(set_as_default=True)
3171
main_loop = GLib.MainLoop()
2078
DBusGMainLoop(set_as_default=True )
2079
main_loop = gobject.MainLoop()
3172
2080
bus = dbus.SystemBus()
3173
2081
# End of Avahi example code
3176
2084
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)
2085
bus, do_not_queue=True)
2086
old_bus_name = (dbus.service.BusName
2087
("se.bsnet.fukt.Mandos", bus,
2089
except dbus.exceptions.NameExistsException as e:
2090
logger.error(unicode(e) + ", disabling D-Bus")
3184
2091
use_dbus = False
3185
2092
server_settings["use_dbus"] = False
3186
2093
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"))
2094
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2095
service = AvahiService(name = server_settings["servicename"],
2096
servicetype = "_mandos._tcp",
2097
protocol = protocol, bus = bus)
2098
if server_settings["interface"]:
2099
service.interface = (if_nametoindex
2100
(str(server_settings["interface"])))
3198
2102
global multiprocessing_manager
3199
2103
multiprocessing_manager = multiprocessing.Manager()
3201
2105
client_class = Client
3203
client_class = functools.partial(ClientDBus, bus=bus)
3205
client_settings = Client.config_parser(client_config)
2107
client_class = functools.partial(ClientDBusTransitional,
2110
special_settings = {
2111
# Some settings need to be accessd by special methods;
2112
# booleans need .getboolean(), etc. Here is a list of them:
2113
"approved_by_default":
2115
client_config.getboolean(section, "approved_by_default"),
2117
# Construct a new dict of client settings of this form:
2118
# { client_name: {setting_name: value, ...}, ...}
2119
# with exceptions for any special settings as defined above
2120
client_settings = dict((clientname,
2122
(value if setting not in special_settings
2123
else special_settings[setting](clientname)))
2124
for setting, value in client_config.items(clientname)))
2125
for clientname in client_config.sections())
3206
2127
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.
3218
2130
if server_settings["restore"]:
3220
2132
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"]
2133
clients_data, old_client_settings = pickle.load(stored_state)
3270
2134
os.remove(stored_state_path)
3271
2135
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:",
2136
logger.warning("Could not load persistant state: {0}".format(e))
2137
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(
2140
for client in clients_data:
2141
client_name = client["name"]
2143
# Decide which value to use after restoring saved state.
2144
# We have three different values: Old config file,
2145
# new config file, and saved state.
2146
# New config value takes precedence if it differs from old
2147
# config value, otherwise use saved state.
2148
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)
2150
# For each value in new config, check if it differs
2151
# from the old config value (Except for the "secret"
2153
if name != "secret" and value != old_client_settings[client_name][name]:
2154
setattr(client, name, value)
2158
# Clients who has passed its expire date, can still be enabled if its
2159
# last checker was sucessful. Clients who checkers failed before we
2160
# stored it state is asumed to had failed checker during downtime.
2161
if client["enabled"] and client["last_checked_ok"]:
2162
if ((datetime.datetime.utcnow() - client["last_checked_ok"])
2163
> client["interval"]):
2164
if client["last_checker_status"] != 0:
2165
client["enabled"] = False
2167
client["expires"] = datetime.datetime.utcnow() + client["timeout"]
2169
client["changedstate"] = (multiprocessing_manager
2170
.Condition(multiprocessing_manager
2173
new_client = ClientDBusTransitional.__new__(ClientDBusTransitional)
2174
tcp_server.clients[client_name] = new_client
2175
new_client.bus = bus
2176
for name, value in client.iteritems():
2177
setattr(new_client, name, value)
2178
client_object_name = unicode(client_name).translate(
2179
{ord("."): ord("_"),
2180
ord("-"): ord("_")})
2181
new_client.dbus_object_path = (dbus.ObjectPath
2182
("/clients/" + client_object_name))
2183
DBusObjectWithProperties.__init__(new_client,
2185
new_client.dbus_object_path)
2187
tcp_server.clients[client_name] = Client.__new__(Client)
2188
for name, value in client.iteritems():
2189
setattr(tcp_server.clients[client_name], name, value)
2191
tcp_server.clients[client_name].decrypt_secret(
2192
client_settings[client_name]["secret"])
2194
# Create/remove clients based on new changes made to config
2195
for clientname in set(old_client_settings) - set(client_settings):
2196
del tcp_server.clients[clientname]
2197
for clientname in set(client_settings) - set(old_client_settings):
2198
tcp_server.clients[clientname] = (client_class(name = clientname,
3361
2204
if not tcp_server.clients:
3362
2205
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",
2211
pidfile.write(str(pid) + "\n".encode("utf-8"))
2214
logger.error("Could not write to file %r with PID %d",
2217
# "pidfile" was never created
3374
2219
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)
2221
signal.signal(signal.SIGINT, signal.SIG_IGN)
2223
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2224
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):
2227
class MandosDBusService(dbus.service.Object):
3385
2228
"""A D-Bus proxy object"""
3387
2229
def __init__(self):
3388
2230
dbus.service.Object.__init__(self, bus, "/")
3390
2231
_interface = "se.recompile.Mandos"
3392
2233
@dbus.service.signal(_interface, signature="o")
3393
2234
def ClientAdded(self, objpath):
3397
2238
@dbus.service.signal(_interface, signature="ss")
3398
def ClientNotFound(self, key_id, address):
2239
def ClientNotFound(self, fingerprint, address):
3402
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3404
2243
@dbus.service.signal(_interface, signature="os")
3405
2244
def ClientRemoved(self, objpath, name):
3409
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3411
2248
@dbus.service.method(_interface, out_signature="ao")
3412
2249
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":
2251
return dbus.Array(c.dbus_object_path
2253
tcp_server.clients.itervalues())
3419
2255
@dbus.service.method(_interface,
3420
2256
out_signature="a{oa{sv}}")
3421
2257
def GetAllClientsWithProperties(self):
3423
2259
return dbus.Dictionary(
3424
{c.dbus_object_path: c.GetAll(
3425
"se.recompile.Mandos.Client")
3426
for c in tcp_server.clients.values()},
2260
((c.dbus_object_path, c.GetAll(""))
2261
for c in tcp_server.clients.itervalues()),
3427
2262
signature="oa{sv}")
3429
2264
@dbus.service.method(_interface, in_signature="o")
3430
2265
def RemoveClient(self, object_path):
3432
for c in tcp_server.clients.values():
2267
for c in tcp_server.clients.itervalues():
3433
2268
if c.dbus_object_path == object_path:
3434
2269
del tcp_server.clients[c.name]
3435
2270
c.remove_from_connection()
3436
# Don't signal the disabling
2271
# Don't signal anything except ClientRemoved
3437
2272
c.disable(quiet=True)
3438
# Emit D-Bus signal for removal
3439
self.client_removed_signal(c)
2274
self.ClientRemoved(object_path, c.name)
3441
2276
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
2280
class MandosDBusServiceTransitional(MandosDBusService):
2281
__metaclass__ = AlternateDBusNamesMetaclass
2282
mandos_dbus_service = MandosDBusServiceTransitional()
3489
2285
"Cleanup function; run on exit"
3493
mp.active_children()
2288
multiprocessing.active_children()
3495
2289
if not (tcp_server.clients or client_settings):
3498
# Store client before exiting. Secrets are encrypted with key
3499
# based on what config file has. If config file is
3500
# 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"]
2292
# Store client before exiting. Secrets are encrypted with key based
2293
# on what config file has. If config file is removed/edited, old
2294
# secret will thus be unrecovable.
2296
for client in tcp_server.clients.itervalues():
2297
client.encrypt_secret(client_settings[client.name]["secret"])
2301
# A list of attributes that will not be stored when shuting down.
2302
exclude = set(("bus", "changedstate", "secret"))
2303
for name, typ in inspect.getmembers(dbus.service.Object):
2306
client_dict["encrypted_secret"] = client.encrypted_secret
2307
for attr in client.client_structure:
2308
if attr not in exclude:
2309
client_dict[attr] = getattr(client, attr)
2311
clients.append(client_dict)
2312
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:",
2315
with os.fdopen(os.open(stored_state_path, os.O_CREAT|os.O_WRONLY|os.O_TRUNC, 0600), "wb") as stored_state:
2316
pickle.dump((clients, client_settings), stored_state)
2317
except IOError as e:
2318
logger.warning("Could not save persistant state: {0}".format(e))
2319
if e.errno != errno.ENOENT:
3551
2322
# Delete all clients, and settings from config