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
91
if sys.version_info.major == 2:
94
# Try to find the value of SO_BINDTODEVICE:
77
import Crypto.Cipher.AES
96
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
97
# newer, and it is also the most natural place for it:
98
80
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
99
81
except AttributeError:
101
# This is where SO_BINDTODEVICE was up to and including Python
103
83
from IN import SO_BINDTODEVICE
104
84
except ImportError:
105
# In Python 2.7 it seems to have been removed entirely.
106
# Try running the C preprocessor:
108
cc = subprocess.Popen(["cc", "--language=c", "-E",
110
stdin=subprocess.PIPE,
111
stdout=subprocess.PIPE)
112
stdout = cc.communicate(
113
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
114
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
115
except (OSError, ValueError, IndexError):
117
SO_BINDTODEVICE = None
119
if sys.version_info.major == 2:
122
if sys.version_info < (3, 2):
123
configparser.Configparser = configparser.SafeConfigParser
126
stored_state_file = "clients.pickle"
85
SO_BINDTODEVICE = None
128
90
logger = logging.getLogger()
132
if_nametoindex = ctypes.cdll.LoadLibrary(
133
ctypes.util.find_library("c")).if_nametoindex
134
except (OSError, AttributeError):
136
def if_nametoindex(interface):
137
"Get an interface index the hard way, i.e. using fcntl()"
138
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
139
with contextlib.closing(socket.socket()) as s:
140
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
141
struct.pack(b"16s16x", interface))
142
interface_index = struct.unpack("I", ifreq[16:20])[0]
143
return interface_index
146
def copy_function(func):
147
"""Make a copy of a function"""
148
if sys.version_info.major == 2:
149
return types.FunctionType(func.func_code,
155
return types.FunctionType(func.__code__,
162
def initlogger(debug, level=logging.WARNING):
163
"""init logger and add loglevel"""
166
syslogger = (logging.handlers.SysLogHandler(
167
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
169
syslogger.setFormatter(logging.Formatter
170
('Mandos [%(process)d]: %(levelname)s:'
172
logger.addHandler(syslogger)
175
console = logging.StreamHandler()
176
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
180
logger.addHandler(console)
181
logger.setLevel(level)
184
class PGPError(Exception):
185
"""Exception if encryption/decryption fails"""
190
"""A simple class for OpenPGP symmetric encryption & decryption"""
193
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
196
output = subprocess.check_output(["gpgconf"])
197
for line in output.splitlines():
198
name, text, path = line.split(b":")
203
if e.errno != errno.ENOENT:
205
self.gnupgargs = ['--batch',
206
'--homedir', self.tempdir,
209
# Only GPG version 1 has the --no-use-agent option.
210
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
211
self.gnupgargs.append("--no-use-agent")
216
def __exit__(self, exc_type, exc_value, traceback):
224
if self.tempdir is not None:
225
# Delete contents of tempdir
226
for root, dirs, files in os.walk(self.tempdir,
228
for filename in files:
229
os.remove(os.path.join(root, filename))
231
os.rmdir(os.path.join(root, dirname))
233
os.rmdir(self.tempdir)
236
def password_encode(self, password):
237
# Passphrase can not be empty and can not contain newlines or
238
# NUL bytes. So we prefix it and hex encode it.
239
encoded = b"mandos" + binascii.hexlify(password)
240
if len(encoded) > 2048:
241
# GnuPG can't handle long passwords, so encode differently
242
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
243
.replace(b"\n", b"\\n")
244
.replace(b"\0", b"\\x00"))
247
def encrypt(self, data, password):
248
passphrase = self.password_encode(password)
249
with tempfile.NamedTemporaryFile(
250
dir=self.tempdir) as passfile:
251
passfile.write(passphrase)
253
proc = subprocess.Popen([self.gpg, '--symmetric',
257
stdin=subprocess.PIPE,
258
stdout=subprocess.PIPE,
259
stderr=subprocess.PIPE)
260
ciphertext, err = proc.communicate(input=data)
261
if proc.returncode != 0:
265
def decrypt(self, data, password):
266
passphrase = self.password_encode(password)
267
with tempfile.NamedTemporaryFile(
268
dir=self.tempdir) as passfile:
269
passfile.write(passphrase)
271
proc = subprocess.Popen([self.gpg, '--decrypt',
275
stdin=subprocess.PIPE,
276
stdout=subprocess.PIPE,
277
stderr=subprocess.PIPE)
278
decrypted_plaintext, err = proc.communicate(input=data)
279
if proc.returncode != 0:
281
return decrypted_plaintext
284
# Pretend that we have an Avahi module
286
"""This isn't so much a class as it is a module-like namespace."""
287
IF_UNSPEC = -1 # avahi-common/address.h
288
PROTO_UNSPEC = -1 # avahi-common/address.h
289
PROTO_INET = 0 # avahi-common/address.h
290
PROTO_INET6 = 1 # avahi-common/address.h
291
DBUS_NAME = "org.freedesktop.Avahi"
292
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
293
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
294
DBUS_PATH_SERVER = "/"
297
def string_array_to_txt_array(t):
298
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
299
for s in t), signature="ay")
300
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
301
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
302
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
303
SERVER_INVALID = 0 # avahi-common/defs.h
304
SERVER_REGISTERING = 1 # avahi-common/defs.h
305
SERVER_RUNNING = 2 # avahi-common/defs.h
306
SERVER_COLLISION = 3 # avahi-common/defs.h
307
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)
310
109
class AvahiError(Exception):
311
110
def __init__(self, value, *args, **kwargs):
312
111
self.value = value
313
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))
317
116
class AvahiServiceError(AvahiError):
321
119
class AvahiGroupError(AvahiError):
123
class AvahiService(object):
326
124
"""An Avahi (Zeroconf) service.
329
127
interface: integer; avahi.IF_UNSPEC or an interface index.
330
128
Used to optionally bind to the specified interface.
331
129
name: string; Example: 'Mandos'
332
130
type: string; Example: '_mandos._tcp'.
333
See <https://www.iana.org/assignments/service-names-port-numbers>
131
See <http://www.dns-sd.org/ServiceTypes.html>
334
132
port: integer; what port to announce
335
133
TXT: list of strings; TXT record for the service
336
134
domain: string; Domain to publish on, default to .local if empty.
495
263
follow_name_owner_changes=True),
496
264
avahi.DBUS_INTERFACE_SERVER)
497
265
self.server.connect_to_signal("StateChanged",
498
self.server_state_changed)
266
self.server_state_changed)
499
267
self.server_state_changed(self.server.GetState())
502
269
class AvahiServiceToSyslog(AvahiService):
503
def rename(self, *args, **kwargs):
504
271
"""Add the new name to the syslog messages"""
505
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
506
syslogger.setFormatter(logging.Formatter(
507
'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'
512
# Pretend that we have a GnuTLS module
514
"""This isn't so much a class as it is a module-like namespace."""
516
library = ctypes.util.find_library("gnutls")
518
library = ctypes.util.find_library("gnutls-deb0")
519
_library = ctypes.cdll.LoadLibrary(library)
522
# Unless otherwise indicated, the constants and types below are
523
# all from the gnutls/gnutls.h C header file.
534
E_NO_CERTIFICATE_FOUND = -49
539
KEYID_USE_SHA256 = 1 # gnutls/x509.h
540
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
543
class session_int(ctypes.Structure):
545
session_t = ctypes.POINTER(session_int)
547
class certificate_credentials_st(ctypes.Structure):
549
certificate_credentials_t = ctypes.POINTER(
550
certificate_credentials_st)
551
certificate_type_t = ctypes.c_int
553
class datum_t(ctypes.Structure):
554
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
555
('size', ctypes.c_uint)]
557
class openpgp_crt_int(ctypes.Structure):
559
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
560
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
561
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
562
credentials_type_t = ctypes.c_int
563
transport_ptr_t = ctypes.c_void_p
564
close_request_t = ctypes.c_int
567
class Error(Exception):
568
def __init__(self, message=None, code=None, args=()):
569
# Default usage is by a message string, but if a return
570
# code is passed, convert it to a string with
573
if message is None and code is not None:
574
message = gnutls.strerror(code)
575
return super(gnutls.Error, self).__init__(
578
class CertificateSecurityError(Error):
584
self._c_object = gnutls.certificate_credentials_t()
585
gnutls.certificate_allocate_credentials(
586
ctypes.byref(self._c_object))
587
self.type = gnutls.CRD_CERTIFICATE
590
gnutls.certificate_free_credentials(self._c_object)
593
def __init__(self, socket, credentials=None):
594
self._c_object = gnutls.session_t()
595
gnutls_flags = gnutls.CLIENT
596
if gnutls.check_version(b"3.5.6"):
597
gnutls_flags |= gnutls.NO_TICKETS
599
gnutls_flags |= gnutls.ENABLE_RAWPK
600
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
602
gnutls.set_default_priority(self._c_object)
603
gnutls.transport_set_ptr(self._c_object, socket.fileno())
604
gnutls.handshake_set_private_extensions(self._c_object,
607
if credentials is None:
608
credentials = gnutls.Credentials()
609
gnutls.credentials_set(self._c_object, credentials.type,
610
ctypes.cast(credentials._c_object,
612
self.credentials = credentials
615
gnutls.deinit(self._c_object)
618
return gnutls.handshake(self._c_object)
620
def send(self, data):
624
data_len -= gnutls.record_send(self._c_object,
629
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
631
# Error handling functions
632
def _error_code(result):
633
"""A function to raise exceptions on errors, suitable
634
for the 'restype' attribute on ctypes functions"""
637
if result == gnutls.E_NO_CERTIFICATE_FOUND:
638
raise gnutls.CertificateSecurityError(code=result)
639
raise gnutls.Error(code=result)
641
def _retry_on_error(result, func, arguments):
642
"""A function to retry on some errors, suitable
643
for the 'errcheck' attribute on ctypes functions"""
645
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
646
return _error_code(result)
647
result = func(*arguments)
650
# Unless otherwise indicated, the function declarations below are
651
# all from the gnutls/gnutls.h C header file.
654
priority_set_direct = _library.gnutls_priority_set_direct
655
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
656
ctypes.POINTER(ctypes.c_char_p)]
657
priority_set_direct.restype = _error_code
659
init = _library.gnutls_init
660
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
661
init.restype = _error_code
663
set_default_priority = _library.gnutls_set_default_priority
664
set_default_priority.argtypes = [session_t]
665
set_default_priority.restype = _error_code
667
record_send = _library.gnutls_record_send
668
record_send.argtypes = [session_t, ctypes.c_void_p,
670
record_send.restype = ctypes.c_ssize_t
671
record_send.errcheck = _retry_on_error
673
certificate_allocate_credentials = (
674
_library.gnutls_certificate_allocate_credentials)
675
certificate_allocate_credentials.argtypes = [
676
ctypes.POINTER(certificate_credentials_t)]
677
certificate_allocate_credentials.restype = _error_code
679
certificate_free_credentials = (
680
_library.gnutls_certificate_free_credentials)
681
certificate_free_credentials.argtypes = [
682
certificate_credentials_t]
683
certificate_free_credentials.restype = None
685
handshake_set_private_extensions = (
686
_library.gnutls_handshake_set_private_extensions)
687
handshake_set_private_extensions.argtypes = [session_t,
689
handshake_set_private_extensions.restype = None
691
credentials_set = _library.gnutls_credentials_set
692
credentials_set.argtypes = [session_t, credentials_type_t,
694
credentials_set.restype = _error_code
696
strerror = _library.gnutls_strerror
697
strerror.argtypes = [ctypes.c_int]
698
strerror.restype = ctypes.c_char_p
700
certificate_type_get = _library.gnutls_certificate_type_get
701
certificate_type_get.argtypes = [session_t]
702
certificate_type_get.restype = _error_code
704
certificate_get_peers = _library.gnutls_certificate_get_peers
705
certificate_get_peers.argtypes = [session_t,
706
ctypes.POINTER(ctypes.c_uint)]
707
certificate_get_peers.restype = ctypes.POINTER(datum_t)
709
global_set_log_level = _library.gnutls_global_set_log_level
710
global_set_log_level.argtypes = [ctypes.c_int]
711
global_set_log_level.restype = None
713
global_set_log_function = _library.gnutls_global_set_log_function
714
global_set_log_function.argtypes = [log_func]
715
global_set_log_function.restype = None
717
deinit = _library.gnutls_deinit
718
deinit.argtypes = [session_t]
719
deinit.restype = None
721
handshake = _library.gnutls_handshake
722
handshake.argtypes = [session_t]
723
handshake.restype = _error_code
724
handshake.errcheck = _retry_on_error
726
transport_set_ptr = _library.gnutls_transport_set_ptr
727
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
728
transport_set_ptr.restype = None
730
bye = _library.gnutls_bye
731
bye.argtypes = [session_t, close_request_t]
732
bye.restype = _error_code
733
bye.errcheck = _retry_on_error
735
check_version = _library.gnutls_check_version
736
check_version.argtypes = [ctypes.c_char_p]
737
check_version.restype = ctypes.c_char_p
739
_need_version = b"3.3.0"
740
if check_version(_need_version) is None:
741
raise self.Error("Needs GnuTLS {} or later"
742
.format(_need_version))
744
_tls_rawpk_version = b"3.6.6"
745
has_rawpk = bool(check_version(_tls_rawpk_version))
749
class pubkey_st(ctypes.Structure):
751
pubkey_t = ctypes.POINTER(pubkey_st)
753
x509_crt_fmt_t = ctypes.c_int
755
# All the function declarations below are from gnutls/abstract.h
756
pubkey_init = _library.gnutls_pubkey_init
757
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
758
pubkey_init.restype = _error_code
760
pubkey_import = _library.gnutls_pubkey_import
761
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
763
pubkey_import.restype = _error_code
765
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
766
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
767
ctypes.POINTER(ctypes.c_ubyte),
768
ctypes.POINTER(ctypes.c_size_t)]
769
pubkey_get_key_id.restype = _error_code
771
pubkey_deinit = _library.gnutls_pubkey_deinit
772
pubkey_deinit.argtypes = [pubkey_t]
773
pubkey_deinit.restype = None
775
# All the function declarations below are from gnutls/openpgp.h
777
openpgp_crt_init = _library.gnutls_openpgp_crt_init
778
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
779
openpgp_crt_init.restype = _error_code
781
openpgp_crt_import = _library.gnutls_openpgp_crt_import
782
openpgp_crt_import.argtypes = [openpgp_crt_t,
783
ctypes.POINTER(datum_t),
785
openpgp_crt_import.restype = _error_code
787
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
788
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
789
ctypes.POINTER(ctypes.c_uint)]
790
openpgp_crt_verify_self.restype = _error_code
792
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
793
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
794
openpgp_crt_deinit.restype = None
796
openpgp_crt_get_fingerprint = (
797
_library.gnutls_openpgp_crt_get_fingerprint)
798
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
802
openpgp_crt_get_fingerprint.restype = _error_code
804
if check_version(b"3.6.4"):
805
certificate_type_get2 = _library.gnutls_certificate_type_get2
806
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
807
certificate_type_get2.restype = _error_code
809
# Remove non-public functions
810
del _error_code, _retry_on_error
813
def call_pipe(connection, # : multiprocessing.Connection
814
func, *args, **kwargs):
815
"""This function is meant to be called by multiprocessing.Process
817
This function runs func(*args, **kwargs), and writes the resulting
818
return value on the provided multiprocessing.Connection.
820
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))
285
class Client(object):
825
286
"""A representation of a client host served by this server.
828
approved: bool(); 'None' if not yet approved/disapproved
289
_approved: bool(); 'None' if not yet approved/disapproved
829
290
approval_delay: datetime.timedelta(); Time to wait for approval
830
291
approval_duration: datetime.timedelta(); Duration of one approval
831
checker: multiprocessing.Process(); a running checker process used
832
to see if the client lives. 'None' if no process is
834
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
835
296
checker_command: string; External command which is run to check
836
297
if client lives. %() expansions are done at
837
298
runtime with vars(self) as dict, so that for
838
299
instance %(name)s can be used in the command.
839
checker_initiator_tag: a GLib event source tag, or None
300
checker_initiator_tag: a gobject event source tag, or None
840
301
created: datetime.datetime(); (UTC) object creation
841
302
client_structure: Object describing what attributes a client has
842
303
and is used for storing the client at exit
843
304
current_checker_command: string; current running checker_command
844
disable_initiator_tag: a GLib event source tag, or None
305
disable_initiator_tag: a gobject event source tag, or None
846
307
fingerprint: string (40 or 32 hexadecimal digits); used to
847
uniquely identify an OpenPGP client
848
key_id: string (64 hexadecimal digits); used to uniquely identify
849
a client using raw public keys
308
uniquely identify the client
850
309
host: string; available for use by the checker command
851
310
interval: datetime.timedelta(); How often to start a new checker
852
311
last_approval_request: datetime.datetime(); (UTC) or None
853
312
last_checked_ok: datetime.datetime(); (UTC) or None
854
313
last_checker_status: integer between 0 and 255 reflecting exit
855
status of last checker. -1 reflects crashed
856
checker, -2 means no checker completed yet.
857
last_checker_signal: The signal which killed the last checker, if
858
last_checker_status is -1
859
last_enabled: datetime.datetime(); (UTC) or None
314
status of last checker. -1 reflect crashed
316
last_enabled: datetime.datetime(); (UTC)
860
317
name: string; from the config file, used in log messages and
861
318
D-Bus identifiers
862
319
secret: bytestring; sent verbatim (over TLS) to client
863
320
timeout: datetime.timedelta(); How long from last_checked_ok
864
321
until this client is disabled
865
extended_timeout: extra long timeout when secret has been sent
322
extended_timeout: extra long timeout when password has been sent
866
323
runtime_expansions: Allowed attributes for runtime expansion.
867
324
expires: datetime.datetime(); time (UTC) when a client will be
868
325
disabled, or None
869
server_settings: The server_settings dict from main()
872
328
runtime_expansions = ("approval_delay", "approval_duration",
873
"created", "enabled", "expires", "key_id",
874
"fingerprint", "host", "interval",
875
"last_approval_request", "last_checked_ok",
329
"created", "enabled", "fingerprint",
330
"host", "interval", "last_checked_ok",
876
331
"last_enabled", "name", "timeout")
879
"extended_timeout": "PT15M",
881
"checker": "fping -q -- %%(host)s",
883
"approval_delay": "PT0S",
884
"approval_duration": "PT1S",
885
"approved_by_default": "True",
890
def config_parser(config):
891
"""Construct a new dict of client settings of this form:
892
{ client_name: {setting_name: value, ...}, ...}
893
with exceptions for any special settings as defined above.
894
NOTE: Must be a pure function. Must return the same result
895
value given the same arguments.
898
for client_name in config.sections():
899
section = dict(config.items(client_name))
900
client = settings[client_name] = {}
902
client["host"] = section["host"]
903
# Reformat values from string types to Python types
904
client["approved_by_default"] = config.getboolean(
905
client_name, "approved_by_default")
906
client["enabled"] = config.getboolean(client_name,
909
# Uppercase and remove spaces from key_id and fingerprint
910
# for later comparison purposes with return value from the
911
# key_id() and fingerprint() functions
912
client["key_id"] = (section.get("key_id", "").upper()
914
client["fingerprint"] = (section["fingerprint"].upper()
916
if "secret" in section:
917
client["secret"] = codecs.decode(section["secret"]
920
elif "secfile" in section:
921
with open(os.path.expanduser(os.path.expandvars
922
(section["secfile"])),
924
client["secret"] = secfile.read()
926
raise TypeError("No secret or secfile for section {}"
928
client["timeout"] = string_to_delta(section["timeout"])
929
client["extended_timeout"] = string_to_delta(
930
section["extended_timeout"])
931
client["interval"] = string_to_delta(section["interval"])
932
client["approval_delay"] = string_to_delta(
933
section["approval_delay"])
934
client["approval_duration"] = string_to_delta(
935
section["approval_duration"])
936
client["checker_command"] = section["checker"]
937
client["last_approval_request"] = None
938
client["last_checked_ok"] = None
939
client["last_checker_status"] = -2
943
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'
945
if server_settings is None:
947
self.server_settings = server_settings
948
# adding all client settings
949
for setting, value in settings.items():
950
setattr(self, setting, value)
953
if not hasattr(self, "last_enabled"):
954
self.last_enabled = datetime.datetime.utcnow()
955
if not hasattr(self, "expires"):
956
self.expires = (datetime.datetime.utcnow()
959
self.last_enabled = None
962
355
logger.debug("Creating client %r", self.name)
963
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()
964
361
logger.debug(" Fingerprint: %s", self.fingerprint)
965
self.created = settings.get("created",
966
datetime.datetime.utcnow())
968
# 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"])
969
383
self.checker = None
970
384
self.checker_initiator_tag = None
971
385
self.disable_initiator_tag = None
386
self.expires = datetime.datetime.utcnow() + self.timeout
972
387
self.checker_callback_tag = None
388
self.checker_command = config["checker"]
973
389
self.current_checker_command = None
390
self._approved = None
391
self.approved_by_default = config.get("approved_by_default",
975
393
self.approvals_pending = 0
976
self.changedstate = multiprocessing_manager.Condition(
977
multiprocessing_manager.Lock())
978
self.client_structure = [attr
979
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()
980
403
if not attr.startswith("_")]
981
404
self.client_structure.append("client_structure")
983
for name, t in inspect.getmembers(
984
type(self), lambda obj: isinstance(obj, property)):
407
for name, t in inspect.getmembers(type(self),
985
411
if not name.startswith("_"):
986
412
self.client_structure.append(name)
988
414
# Send notice to process children that client state has changed
989
415
def send_changedstate(self):
990
416
with self.changedstate:
991
417
self.changedstate.notify_all()
993
419
def enable(self):
994
420
"""Start this client's checker and timeout hooks"""
995
421
if getattr(self, "enabled", False):
996
422
# Already enabled
424
self.send_changedstate()
998
425
self.expires = datetime.datetime.utcnow() + self.timeout
999
426
self.enabled = True
1000
427
self.last_enabled = datetime.datetime.utcnow()
1001
428
self.init_checker()
1002
self.send_changedstate()
1004
430
def disable(self, quiet=True):
1005
431
"""Disable this client."""
1006
432
if not getattr(self, "enabled", False):
435
self.send_changedstate()
1009
437
logger.info("Disabling client %s", self.name)
1010
if getattr(self, "disable_initiator_tag", None) is not None:
1011
GLib.source_remove(self.disable_initiator_tag)
438
if getattr(self, "disable_initiator_tag", False):
439
gobject.source_remove(self.disable_initiator_tag)
1012
440
self.disable_initiator_tag = None
1013
441
self.expires = None
1014
if getattr(self, "checker_initiator_tag", None) is not None:
1015
GLib.source_remove(self.checker_initiator_tag)
442
if getattr(self, "checker_initiator_tag", False):
443
gobject.source_remove(self.checker_initiator_tag)
1016
444
self.checker_initiator_tag = None
1017
445
self.stop_checker()
1018
446
self.enabled = False
1020
self.send_changedstate()
1021
# 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
1024
450
def __del__(self):
1027
453
def init_checker(self):
1028
454
# Schedule a new checker to be started an 'interval' from now,
1029
455
# and every interval from then on.
1030
if self.checker_initiator_tag is not None:
1031
GLib.source_remove(self.checker_initiator_tag)
1032
self.checker_initiator_tag = GLib.timeout_add(
1033
int(self.interval.total_seconds() * 1000),
456
self.checker_initiator_tag = (gobject.timeout_add
457
(self.interval_milliseconds(),
1035
459
# Schedule a disable() when 'timeout' has passed
1036
if self.disable_initiator_tag is not None:
1037
GLib.source_remove(self.disable_initiator_tag)
1038
self.disable_initiator_tag = GLib.timeout_add(
1039
int(self.timeout.total_seconds() * 1000), self.disable)
460
self.disable_initiator_tag = (gobject.timeout_add
461
(self.timeout_milliseconds(),
1040
463
# Also start a new checker *right now*.
1041
464
self.start_checker()
1043
def checker_callback(self, source, condition, connection,
467
def checker_callback(self, pid, condition, command):
1045
468
"""The checker has completed, so take appropriate actions."""
1046
# Read return code from connection (see call_pipe)
1047
returncode = connection.recv()
1050
469
self.checker_callback_tag = None
1051
470
self.checker = None
1054
self.last_checker_status = returncode
1055
self.last_checker_signal = None
471
if os.WIFEXITED(condition):
472
self.last_checker_status = os.WEXITSTATUS(condition)
1056
473
if self.last_checker_status == 0:
1057
474
logger.info("Checker for %(name)s succeeded",
1059
476
self.checked_ok()
1061
logger.info("Checker for %(name)s failed", vars(self))
478
logger.info("Checker for %(name)s failed",
1063
481
self.last_checker_status = -1
1064
self.last_checker_signal = -returncode
1065
482
logger.warning("Checker for %(name)s crashed?",
1069
def checked_ok(self):
1070
"""Assert that the client has been seen, alive and well."""
1071
self.last_checked_ok = datetime.datetime.utcnow()
1072
self.last_checker_status = 0
1073
self.last_checker_signal = None
1076
def bump_timeout(self, timeout=None):
1077
"""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,
1078
491
if timeout is None:
1079
492
timeout = self.timeout
493
self.last_checked_ok = datetime.datetime.utcnow()
1080
494
if self.disable_initiator_tag is not None:
1081
GLib.source_remove(self.disable_initiator_tag)
1082
self.disable_initiator_tag = None
495
gobject.source_remove(self.disable_initiator_tag)
1083
496
if getattr(self, "enabled", False):
1084
self.disable_initiator_tag = GLib.timeout_add(
1085
int(timeout.total_seconds() * 1000), self.disable)
497
self.disable_initiator_tag = (gobject.timeout_add
498
(_timedelta_to_milliseconds
499
(timeout), self.disable))
1086
500
self.expires = datetime.datetime.utcnow() + timeout
1088
502
def need_approval(self):
1089
503
self.last_approval_request = datetime.datetime.utcnow()
1091
505
def start_checker(self):
1092
506
"""Start a new checker subprocess if one is not running.
1094
508
If a checker already exists, leave it running and do
1096
510
# The reason for not killing a running checker is that if we
1097
# did that, and if a checker (for some reason) started running
1098
# slowly and taking more than 'interval' time, then the client
1099
# would inevitably timeout, since no checker would get a
1100
# 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
1101
515
# checkers alone, the checker would have to take more time
1102
516
# than 'timeout' for the client to be disabled, which is as it
1105
if self.checker is not None and not self.checker.is_alive():
1106
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)
1109
532
# Start a new checker if needed
1110
533
if self.checker is None:
1111
# Escape attributes for the shell
1113
attr: re.escape(str(getattr(self, attr)))
1114
for attr in self.runtime_expansions}
1116
command = self.checker_command % escaped_attrs
1117
except TypeError as error:
1118
logger.error('Could not format string "%s"',
1119
self.checker_command,
1121
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
1122
553
self.current_checker_command = command
1123
logger.info("Starting checker %r for %s", command,
1125
# We don't need to redirect stdout and stderr, since
1126
# in normal mode, that is already done by daemon(),
1127
# and in debug mode we don't want to. (Stdin is
1128
# always replaced by /dev/null.)
1129
# The exception is when not debugging but nevertheless
1130
# running in the foreground; use the previously
1132
popen_args = {"close_fds": True,
1135
if (not self.server_settings["debug"]
1136
and self.server_settings["foreground"]):
1137
popen_args.update({"stdout": wnull,
1139
pipe = multiprocessing.Pipe(duplex=False)
1140
self.checker = multiprocessing.Process(
1142
args=(pipe[1], subprocess.call, command),
1144
self.checker.start()
1145
self.checker_callback_tag = GLib.io_add_watch(
1146
pipe[0].fileno(), GLib.IO_IN,
1147
self.checker_callback, pipe[0], command)
1148
# 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
1151
580
def stop_checker(self):
1152
581
"""Force the checker process, if any, to stop."""
1153
582
if self.checker_callback_tag:
1154
GLib.source_remove(self.checker_callback_tag)
583
gobject.source_remove(self.checker_callback_tag)
1155
584
self.checker_callback_tag = None
1156
585
if getattr(self, "checker", None) is None:
1158
587
logger.debug("Stopping checker for %(name)s", vars(self))
1159
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
1160
596
self.checker = None
1163
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):
1167
651
"""Decorators for marking methods of a DBusObjectWithProperties to
1168
652
become properties on the D-Bus.
1170
654
The decorated method will be called with no arguments by "Get"
1171
655
and with one argument by "Set".
1173
657
The parameters, where they are supported, are the same as
1174
658
dbus.service.method, except there is only "signature", since the
1175
659
type from Get() and the type sent to Set() is the same.
1508
829
except (AttributeError, xml.dom.DOMException,
1509
830
xml.parsers.expat.ExpatError) as error:
1510
831
logger.error("Failed to override Introspection method",
1516
dbus.OBJECT_MANAGER_IFACE
1517
except AttributeError:
1518
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1521
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1522
"""A D-Bus object with an ObjectManager.
1524
Classes inheriting from this exposes the standard
1525
GetManagedObjects call and the InterfacesAdded and
1526
InterfacesRemoved signals on the standard
1527
"org.freedesktop.DBus.ObjectManager" interface.
1529
Note: No signals are sent automatically; they must be sent
1532
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1533
out_signature="a{oa{sa{sv}}}")
1534
def GetManagedObjects(self):
1535
"""This function must be overridden"""
1536
raise NotImplementedError()
1538
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1539
signature="oa{sa{sv}}")
1540
def InterfacesAdded(self, object_path, interfaces_and_properties):
1543
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1544
def InterfacesRemoved(self, object_path, interfaces):
1547
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1549
path_keyword='object_path',
1550
connection_keyword='connection')
1551
def Introspect(self, object_path, connection):
1552
"""Overloading of standard D-Bus method.
1554
Override return argument name of GetManagedObjects to be
1555
"objpath_interfaces_and_properties"
1557
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1561
document = xml.dom.minidom.parseString(xmlstring)
1563
for if_tag in document.getElementsByTagName("interface"):
1564
# Fix argument name for the GetManagedObjects method
1565
if (if_tag.getAttribute("name")
1566
== dbus.OBJECT_MANAGER_IFACE):
1567
for cn in if_tag.getElementsByTagName("method"):
1568
if (cn.getAttribute("name")
1569
== "GetManagedObjects"):
1570
for arg in cn.getElementsByTagName("arg"):
1571
if (arg.getAttribute("direction")
1575
"objpath_interfaces"
1577
xmlstring = document.toxml("utf-8")
1579
except (AttributeError, xml.dom.DOMException,
1580
xml.parsers.expat.ExpatError) as error:
1581
logger.error("Failed to override Introspection method",
1586
def datetime_to_dbus(dt, variant_level=0):
836
def datetime_to_dbus (dt, variant_level=0):
1587
837
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1589
return dbus.String("", variant_level=variant_level)
1590
return dbus.String(dt.isoformat(), variant_level=variant_level)
1593
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1594
"""A class decorator; applied to a subclass of
1595
dbus.service.Object, it will add alternate D-Bus attributes with
1596
interface names according to the "alt_interface_names" mapping.
1599
@alternate_dbus_interfaces({"org.example.Interface":
1600
"net.example.AlternateInterface"})
1601
class SampleDBusObject(dbus.service.Object):
1602
@dbus.service.method("org.example.Interface")
1603
def SampleDBusMethod():
1606
The above "SampleDBusMethod" on "SampleDBusObject" will be
1607
reachable via two interfaces: "org.example.Interface" and
1608
"net.example.AlternateInterface", the latter of which will have
1609
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1610
"true", unless "deprecate" is passed with a False value.
1612
This works for methods and signals, and also for D-Bus properties
1613
(from DBusObjectWithProperties) and interfaces (from the
1614
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.
1618
for orig_interface_name, alt_interface_name in (
1619
alt_interface_names.items()):
1621
interface_names = set()
1622
# Go though all attributes of the class
1623
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):
1624
855
# Ignore non-D-Bus attributes, and D-Bus attributes
1625
856
# with the wrong interface name
1626
857
if (not hasattr(attribute, "_dbus_interface")
1627
or not attribute._dbus_interface.startswith(
1628
orig_interface_name)):
858
or not attribute._dbus_interface
859
.startswith("se.recompile.Mandos")):
1630
861
# Create an alternate D-Bus interface name based on
1631
862
# the current name
1632
alt_interface = attribute._dbus_interface.replace(
1633
orig_interface_name, alt_interface_name)
1634
interface_names.add(alt_interface)
863
alt_interface = (attribute._dbus_interface
864
.replace("se.recompile.Mandos",
865
"se.bsnet.fukt.Mandos"))
1635
866
# Is this a D-Bus signal?
1636
867
if getattr(attribute, "_dbus_is_signal", False):
1637
# Extract the original non-method undecorated
1638
# function by black magic
1639
if sys.version_info.major == 2:
1640
nonmethod_func = (dict(
868
# Extract the original non-method function by
870
nonmethod_func = (dict(
1641
871
zip(attribute.func_code.co_freevars,
1642
attribute.__closure__))
1643
["func"].cell_contents)
1645
nonmethod_func = (dict(
1646
zip(attribute.__code__.co_freevars,
1647
attribute.__closure__))
1648
["func"].cell_contents)
872
attribute.__closure__))["func"]
1649
874
# Create a new, but exactly alike, function
1650
875
# object, and decorate it to be a new D-Bus signal
1651
876
# with the alternate D-Bus interface name
1652
new_function = copy_function(nonmethod_func)
1653
new_function = (dbus.service.signal(
1655
attribute._dbus_signature)(new_function))
1656
# Copy annotations, if any
1658
new_function._dbus_annotations = dict(
1659
attribute._dbus_annotations)
1660
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)))
1663
886
# Define a creator of a function to call both the
1664
# original and alternate functions, so both the
1665
# original and alternate signals gets sent when
1666
# the function is called
887
# old and new functions, so both the old and new
888
# signals gets sent when the function is called
1667
889
def fixscope(func1, func2):
1668
890
"""This function is a scope container to pass
1669
891
func1 and func2 to the "call_both" function
1670
892
outside of its arguments"""
1672
@functools.wraps(func2)
1673
893
def call_both(*args, **kwargs):
1674
894
"""This function will emit two D-Bus
1675
895
signals by calling func1 and func2"""
1676
896
func1(*args, **kwargs)
1677
897
func2(*args, **kwargs)
1678
# Make wrapper function look like a D-Bus
1680
for name, attr in inspect.getmembers(func2):
1681
if name.startswith("_dbus_"):
1682
setattr(call_both, name, attr)
1684
898
return call_both
1685
899
# Create the "call_both" function and add it to
1687
attr[attrname] = fixscope(attribute, new_function)
901
attr[attrname] = fixscope(attribute,
1688
903
# Is this a D-Bus method?
1689
904
elif getattr(attribute, "_dbus_is_method", False):
1690
905
# Create a new, but exactly alike, function
1691
906
# object. Decorate it to be a new D-Bus method
1692
907
# with the alternate D-Bus interface name. Add it
1695
dbus.service.method(
1697
attribute._dbus_in_signature,
1698
attribute._dbus_out_signature)
1699
(copy_function(attribute)))
1700
# Copy annotations, if any
1702
attr[attrname]._dbus_annotations = dict(
1703
attribute._dbus_annotations)
1704
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)))
1706
919
# Is this a D-Bus property?
1707
920
elif getattr(attribute, "_dbus_is_property", False):
1708
921
# Create a new, but exactly alike, function
1709
922
# object, and decorate it to be a new D-Bus
1710
923
# property with the alternate D-Bus interface
1711
924
# name. Add it to the class.
1712
attr[attrname] = (dbus_service_property(
1713
alt_interface, attribute._dbus_signature,
1714
attribute._dbus_access,
1715
attribute._dbus_get_args_options
1717
(copy_function(attribute)))
1718
# Copy annotations, if any
1720
attr[attrname]._dbus_annotations = dict(
1721
attribute._dbus_annotations)
1722
except AttributeError:
1724
# Is this a D-Bus interface?
1725
elif getattr(attribute, "_dbus_is_interface", False):
1726
# Create a new, but exactly alike, function
1727
# object. Decorate it to be a new D-Bus interface
1728
# with the alternate D-Bus interface name. Add it
1731
dbus_interface_annotations(alt_interface)
1732
(copy_function(attribute)))
1734
# Deprecate all alternate interfaces
1735
iname = "_AlternateDBusNames_interface_annotation{}"
1736
for interface_name in interface_names:
1738
@dbus_interface_annotations(interface_name)
1740
return {"org.freedesktop.DBus.Deprecated":
1742
# Find an unused name
1743
for aname in (iname.format(i)
1744
for i in itertools.count()):
1745
if aname not in attr:
1749
# Replace the class with a new subclass of it with
1750
# methods, signals, etc. as created above.
1751
if sys.version_info.major == 2:
1752
cls = type(b"{}Alternate".format(cls.__name__),
1755
cls = type("{}Alternate".format(cls.__name__),
1762
@alternate_dbus_interfaces({"se.recompile.Mandos":
1763
"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)
1764
940
class ClientDBus(Client, DBusObjectWithProperties):
1765
941
"""A Client class using D-Bus
1768
944
dbus_object_path: dbus.ObjectPath
1769
945
bus: dbus.SystemBus()
1772
948
runtime_expansions = (Client.runtime_expansions
1773
+ ("dbus_object_path", ))
1775
_interface = "se.recompile.Mandos.Client"
949
+ ("dbus_object_path",))
1777
951
# dbus.service.Object doesn't use super(), so we can't either.
1779
def __init__(self, bus=None, *args, **kwargs):
953
def __init__(self, bus = None, *args, **kwargs):
955
self._approvals_pending = 0
1781
956
Client.__init__(self, *args, **kwargs)
959
def add_to_dbus(self):
1782
960
# Only now, when this client is initialized, can it show up on
1784
client_object_name = str(self.name).translate(
962
client_object_name = unicode(self.name).translate(
1785
963
{ord("."): ord("_"),
1786
964
ord("-"): ord("_")})
1787
self.dbus_object_path = dbus.ObjectPath(
1788
"/clients/" + client_object_name)
965
self.dbus_object_path = (dbus.ObjectPath
966
("/clients/" + client_object_name))
1789
967
DBusObjectWithProperties.__init__(self, self.bus,
1790
968
self.dbus_object_path)
1792
def notifychangeproperty(transform_func, dbus_name,
1793
type_func=lambda x: x,
1795
invalidate_only=False,
1796
_interface=_interface):
970
def notifychangeproperty(transform_func,
971
dbus_name, type_func=lambda x: x,
1797
973
""" Modify a variable so that it's a property which announces
1798
974
its changes to DBus.
2193
1326
self.start_checker()
2195
1328
self.stop_checker()
2197
1330
# ObjectPath - property
2199
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2200
"org.freedesktop.DBus.Deprecated": "true"})
2201
1331
@dbus_service_property(_interface, signature="o", access="read")
2202
1332
def ObjectPath_dbus_property(self):
2203
return self.dbus_object_path # is already a dbus.ObjectPath
1333
return self.dbus_object_path # is already a dbus.ObjectPath
2205
1335
# Secret = property
2207
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2209
@dbus_service_property(_interface,
1336
@dbus_service_property(_interface, signature="ay",
1337
access="write", byte_arrays=True)
2213
1338
def Secret_dbus_property(self, value):
2214
self.secret = bytes(value)
1339
self.secret = str(value)
2220
def __init__(self, child_pipe, key_id, fpr, address):
1344
class ProxyClient(object):
1345
def __init__(self, child_pipe, fpr, address):
2221
1346
self._pipe = child_pipe
2222
self._pipe.send(('init', key_id, fpr, address))
1347
self._pipe.send(('init', fpr, address))
2223
1348
if not self._pipe.recv():
2224
raise KeyError(key_id or fpr)
2226
1351
def __getattribute__(self, name):
1352
if(name == '_pipe'):
2228
1353
return super(ProxyClient, self).__getattribute__(name)
2229
1354
self._pipe.send(('getattr', name))
2230
1355
data = self._pipe.recv()
2231
1356
if data[0] == 'data':
2233
1358
if data[0] == 'function':
2235
1359
def func(*args, **kwargs):
2236
1360
self._pipe.send(('funcall', name, args, kwargs))
2237
1361
return self._pipe.recv()[1]
2241
1364
def __setattr__(self, name, value):
1365
if(name == '_pipe'):
2243
1366
return super(ProxyClient, self).__setattr__(name, value)
2244
1367
self._pipe.send(('setattr', name, value))
1369
class ClientDBusTransitional(ClientDBus):
1370
__metaclass__ = AlternateDBusNamesMetaclass
2247
1372
class ClientHandler(socketserver.BaseRequestHandler, object):
2248
1373
"""A class to handle client connections.
2250
1375
Instantiated once for each connection to handle it.
2251
1376
Note: This will run in its own forked process."""
2253
1378
def handle(self):
2254
1379
with contextlib.closing(self.server.child_pipe) as child_pipe:
2255
1380
logger.info("TCP connection from: %s",
2256
str(self.client_address))
1381
unicode(self.client_address))
2257
1382
logger.debug("Pipe FD: %d",
2258
1383
self.server.child_pipe.fileno())
2260
session = gnutls.ClientSession(self.request)
2262
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2263
# "+AES-256-CBC", "+SHA1",
2264
# "+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",
2266
1399
# Use a fallback default, since this MUST be set.
2267
1400
priority = self.server.gnutls_priority
2268
1401
if priority is None:
2269
1402
priority = "NORMAL"
2270
gnutls.priority_set_direct(session._c_object,
2271
priority.encode("utf-8"),
1403
(gnutls.library.functions
1404
.gnutls_priority_set_direct(session._c_object,
2274
1407
# Start communication using the Mandos protocol
2275
1408
# Get protocol number
2276
1409
line = self.request.makefile().readline()
2277
1410
logger.debug("Protocol version: %r", line)
2279
1412
if int(line.strip().split()[0]) > 1:
2280
raise RuntimeError(line)
2281
1414
except (ValueError, IndexError, RuntimeError) as error:
2282
1415
logger.error("Unknown protocol version: %s", error)
2285
1418
# Start GnuTLS connection
2287
1420
session.handshake()
2288
except gnutls.Error as error:
1421
except gnutls.errors.GNUTLSError as error:
2289
1422
logger.warning("Handshake failed: %s", error)
2290
1423
# Do not run session.bye() here: the session is not
2291
1424
# established. Just abandon the request.
2293
1426
logger.debug("Handshake succeeded")
2295
1428
approval_required = False
2297
if gnutls.has_rawpk:
2300
key_id = self.key_id(
2301
self.peer_certificate(session))
2302
except (TypeError, gnutls.Error) as error:
2303
logger.warning("Bad certificate: %s", error)
2305
logger.debug("Key ID: %s", key_id)
2310
fpr = self.fingerprint(
2311
self.peer_certificate(session))
2312
except (TypeError, gnutls.Error) as error:
2313
logger.warning("Bad certificate: %s", error)
2315
logger.debug("Fingerprint: %s", fpr)
2318
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,
2319
1441
self.client_address)
2320
1442
except KeyError:
2323
1445
if client.approval_delay:
2324
1446
delay = client.approval_delay
2325
1447
client.approvals_pending += 1
2326
1448
approval_required = True
2329
1451
if not client.enabled:
2330
1452
logger.info("Client %s is disabled",
2332
1454
if self.server.use_dbus:
2333
1455
# Emit D-Bus signal
2334
1456
client.Rejected("Disabled")
2337
if client.approved or not client.approval_delay:
2338
# We are approved or approval is disabled
1459
if client._approved or not client.approval_delay:
1460
#We are approved or approval is disabled
2340
elif client.approved is None:
1462
elif client._approved is None:
2341
1463
logger.info("Client %s needs approval",
2343
1465
if self.server.use_dbus:
2344
1466
# Emit D-Bus signal
2345
1467
client.NeedApproval(
2346
client.approval_delay.total_seconds()
2347
* 1000, client.approved_by_default)
1468
client.approval_delay_milliseconds(),
1469
client.approved_by_default)
2349
1471
logger.warning("Client %s was not approved",
2374
1498
delay -= time2 - time
2377
session.send(client.secret)
2378
except gnutls.Error as error:
2379
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))
2383
1512
logger.info("Sending secret to %s", client.name)
2384
1513
# bump the timeout using extended_timeout
2385
client.bump_timeout(client.extended_timeout)
1514
client.checked_ok(client.extended_timeout)
2386
1515
if self.server.use_dbus:
2387
1516
# Emit D-Bus signal
2388
1517
client.GotSecret()
2391
1520
if approval_required:
2392
1521
client.approvals_pending -= 1
2395
except gnutls.Error as error:
2396
logger.warning("GnuTLS bye failed",
1524
except gnutls.errors.GNUTLSError as error:
1525
logger.warning("GnuTLS bye failed")
2400
1528
def peer_certificate(session):
2401
"Return the peer's certificate as a bytestring"
2403
cert_type = gnutls.certificate_type_get2(session._c_object,
2405
except AttributeError:
2406
cert_type = gnutls.certificate_type_get(session._c_object)
2407
if gnutls.has_rawpk:
2408
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2410
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2411
# If not a valid certificate type...
2412
if cert_type not in valid_cert_types:
2413
logger.info("Cert type %r not in %r", cert_type,
2415
# ...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
2417
1536
list_size = ctypes.c_uint(1)
2418
cert_list = (gnutls.certificate_get_peers
1537
cert_list = (gnutls.library.functions
1538
.gnutls_certificate_get_peers
2419
1539
(session._c_object, ctypes.byref(list_size)))
2420
1540
if not bool(cert_list) and list_size.value != 0:
2421
raise gnutls.Error("error getting peer certificate")
1541
raise gnutls.errors.GNUTLSError("error getting peer"
2422
1543
if list_size.value == 0:
2424
1545
cert = cert_list[0]
2425
1546
return ctypes.string_at(cert.data, cert.size)
2428
def key_id(certificate):
2429
"Convert a certificate bytestring to a hexdigit key ID"
2430
# New GnuTLS "datum" with the public key
2431
datum = gnutls.datum_t(
2432
ctypes.cast(ctypes.c_char_p(certificate),
2433
ctypes.POINTER(ctypes.c_ubyte)),
2434
ctypes.c_uint(len(certificate)))
2435
# XXX all these need to be created in the gnutls "module"
2436
# New empty GnuTLS certificate
2437
pubkey = gnutls.pubkey_t()
2438
gnutls.pubkey_init(ctypes.byref(pubkey))
2439
# Import the raw public key into the certificate
2440
gnutls.pubkey_import(pubkey,
2441
ctypes.byref(datum),
2442
gnutls.X509_FMT_DER)
2443
# New buffer for the key ID
2444
buf = ctypes.create_string_buffer(32)
2445
buf_len = ctypes.c_size_t(len(buf))
2446
# Get the key ID from the raw public key into the buffer
2447
gnutls.pubkey_get_key_id(pubkey,
2448
gnutls.KEYID_USE_SHA256,
2449
ctypes.cast(ctypes.byref(buf),
2450
ctypes.POINTER(ctypes.c_ubyte)),
2451
ctypes.byref(buf_len))
2452
# Deinit the certificate
2453
gnutls.pubkey_deinit(pubkey)
2455
# Convert the buffer to a Python bytestring
2456
key_id = ctypes.string_at(buf, buf_len.value)
2457
# Convert the bytestring to hexadecimal notation
2458
hex_key_id = binascii.hexlify(key_id).upper()
2462
1549
def fingerprint(openpgp):
2463
1550
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2464
1551
# New GnuTLS "datum" with the OpenPGP public key
2465
datum = gnutls.datum_t(
2466
ctypes.cast(ctypes.c_char_p(openpgp),
2467
ctypes.POINTER(ctypes.c_ubyte)),
2468
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))))
2469
1557
# New empty GnuTLS certificate
2470
crt = gnutls.openpgp_crt_t()
2471
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)))
2472
1561
# Import the OpenPGP public key into the certificate
2473
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2474
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))
2475
1566
# Verify the self signature in the key
2476
1567
crtverify = ctypes.c_uint()
2477
gnutls.openpgp_crt_verify_self(crt, 0,
2478
ctypes.byref(crtverify))
1568
(gnutls.library.functions
1569
.gnutls_openpgp_crt_verify_self(crt, 0,
1570
ctypes.byref(crtverify)))
2479
1571
if crtverify.value != 0:
2480
gnutls.openpgp_crt_deinit(crt)
2481
raise gnutls.CertificateSecurityError(code
1572
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1573
raise (gnutls.errors.CertificateSecurityError
2483
1575
# New buffer for the fingerprint
2484
1576
buf = ctypes.create_string_buffer(20)
2485
1577
buf_len = ctypes.c_size_t()
2486
1578
# Get the fingerprint from the certificate into the buffer
2487
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2488
ctypes.byref(buf_len))
1579
(gnutls.library.functions
1580
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1581
ctypes.byref(buf_len)))
2489
1582
# Deinit the certificate
2490
gnutls.openpgp_crt_deinit(crt)
1583
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2491
1584
# Convert the buffer to a Python bytestring
2492
1585
fpr = ctypes.string_at(buf, buf_len.value)
2493
1586
# Convert the bytestring to hexadecimal notation
2494
hex_fpr = binascii.hexlify(fpr).upper()
1587
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2498
class MultiprocessingMixIn:
1591
class MultiprocessingMixIn(object):
2499
1592
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2501
1593
def sub_process_main(self, request, address):
2503
1595
self.finish_request(request, address)
2505
1597
self.handle_error(request, address)
2506
1598
self.close_request(request)
2508
1600
def process_request(self, request, address):
2509
1601
"""Start a new process to process the request."""
2510
proc = multiprocessing.Process(target=self.sub_process_main,
2511
args=(request, address))
1602
proc = multiprocessing.Process(target = self.sub_process_main,
2516
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1609
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2517
1610
""" adds a pipe to the MixIn """
2519
1611
def process_request(self, request, client_address):
2520
1612
"""Overrides and wraps the original process_request().
2522
1614
This function creates a new pipe in self.pipe
2524
1616
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2526
1618
proc = MultiprocessingMixIn.process_request(self, request,
2527
1619
client_address)
2528
1620
self.child_pipe.close()
2529
1621
self.add_pipe(parent_pipe, proc)
2531
1623
def add_pipe(self, parent_pipe, proc):
2532
1624
"""Dummy function; override as necessary"""
2533
raise NotImplementedError()
1625
raise NotImplementedError
2536
1628
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2537
socketserver.TCPServer):
1629
socketserver.TCPServer, object):
2538
1630
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2541
1633
enabled: Boolean; whether this server is activated yet
2542
1634
interface: None or a network interface name (string)
2543
1635
use_ipv6: Boolean; to use IPv6 or not
2546
1637
def __init__(self, server_address, RequestHandlerClass,
2550
"""If socketfd is set, use that file descriptor instead of
2551
creating a new one with socket.socket().
1638
interface=None, use_ipv6=True):
2553
1639
self.interface = interface
2555
1641
self.address_family = socket.AF_INET6
2556
if socketfd is not None:
2557
# Save the file descriptor
2558
self.socketfd = socketfd
2559
# Save the original socket.socket() function
2560
self.socket_socket = socket.socket
2562
# To implement --socket, we monkey patch socket.socket.
2564
# (When socketserver.TCPServer is a new-style class, we
2565
# could make self.socket into a property instead of monkey
2566
# patching socket.socket.)
2568
# Create a one-time-only replacement for socket.socket()
2569
@functools.wraps(socket.socket)
2570
def socket_wrapper(*args, **kwargs):
2571
# Restore original function so subsequent calls are
2573
socket.socket = self.socket_socket
2574
del self.socket_socket
2575
# This time only, return a new socket object from the
2576
# saved file descriptor.
2577
return socket.fromfd(self.socketfd, *args, **kwargs)
2578
# Replace socket.socket() function with wrapper
2579
socket.socket = socket_wrapper
2580
# The socketserver.TCPServer.__init__ will call
2581
# socket.socket(), which might be our replacement,
2582
# socket_wrapper(), if socketfd was set.
2583
1642
socketserver.TCPServer.__init__(self, server_address,
2584
1643
RequestHandlerClass)
2586
1644
def server_bind(self):
2587
1645
"""This overrides the normal server_bind() function
2588
1646
to bind to an interface if one was specified, and also NOT to
2589
1647
bind to an address or port if they were not specified."""
2590
global SO_BINDTODEVICE
2591
1648
if self.interface is not None:
2592
1649
if SO_BINDTODEVICE is None:
2593
# Fall back to a hard-coded value which seems to be
2595
logger.warning("SO_BINDTODEVICE not found, trying 25")
2596
SO_BINDTODEVICE = 25
2598
self.socket.setsockopt(
2599
socket.SOL_SOCKET, SO_BINDTODEVICE,
2600
(self.interface + "\0").encode("utf-8"))
2601
except socket.error as error:
2602
if error.errno == errno.EPERM:
2603
logger.error("No permission to bind to"
2604
" interface %s", self.interface)
2605
elif error.errno == errno.ENOPROTOOPT:
2606
logger.error("SO_BINDTODEVICE not available;"
2607
" cannot bind to interface %s",
2609
elif error.errno == errno.ENODEV:
2610
logger.error("Interface %s does not exist,"
2611
" 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",
2614
1670
# Only bind(2) the socket if we really need to.
2615
1671
if self.server_address[0] or self.server_address[1]:
2616
if self.server_address[1]:
2617
self.allow_reuse_address = True
2618
1672
if not self.server_address[0]:
2619
1673
if self.address_family == socket.AF_INET6:
2620
any_address = "::" # in6addr_any
1674
any_address = "::" # in6addr_any
2622
any_address = "0.0.0.0" # INADDR_ANY
1676
any_address = socket.INADDR_ANY
2623
1677
self.server_address = (any_address,
2624
1678
self.server_address[1])
2625
1679
elif not self.server_address[1]:
2626
self.server_address = (self.server_address[0], 0)
1680
self.server_address = (self.server_address[0],
2627
1682
# if self.interface:
2628
1683
# self.server_address = (self.server_address[0],
2956
1929
parser.add_argument("--no-dbus", action="store_false",
2957
1930
dest="use_dbus", help="Do not provide D-Bus"
2958
" system bus interface", default=None)
1931
" system bus interface")
2959
1932
parser.add_argument("--no-ipv6", action="store_false",
2960
dest="use_ipv6", help="Do not use IPv6",
1933
dest="use_ipv6", help="Do not use IPv6")
2962
1934
parser.add_argument("--no-restore", action="store_false",
2963
dest="restore", help="Do not restore stored"
2964
" state", default=None)
2965
parser.add_argument("--socket", type=int,
2966
help="Specify a file descriptor to a network"
2967
" socket to use instead of creating one")
2968
parser.add_argument("--statedir", metavar="DIR",
2969
help="Directory to save/restore state in")
2970
parser.add_argument("--foreground", action="store_true",
2971
help="Run in foreground", default=None)
2972
parser.add_argument("--no-zeroconf", action="store_false",
2973
dest="zeroconf", help="Do not use Zeroconf",
1936
help="Do not restore stored state",
2976
1939
options = parser.parse_args()
2978
1941
if options.check:
2980
fail_count, test_count = doctest.testmod()
2981
sys.exit(os.EX_OK if fail_count == 0 else 1)
2983
1946
# Default values for config file for server-global settings
2984
if gnutls.has_rawpk:
2985
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2986
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2988
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2989
":+SIGN-DSA-SHA256")
2990
server_defaults = {"interface": "",
2994
"priority": priority,
2995
"servicename": "Mandos",
3001
"statedir": "/var/lib/mandos",
3002
"foreground": "False",
1947
server_defaults = { "interface": "",
1952
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1953
"servicename": "Mandos",
3007
1959
# Parse config file for server-global settings
3008
server_config = configparser.ConfigParser(server_defaults)
1960
server_config = configparser.SafeConfigParser(server_defaults)
3009
1961
del server_defaults
3010
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3011
# Convert the ConfigParser object to a dict
1962
server_config.read(os.path.join(options.configdir,
1964
# Convert the SafeConfigParser object to a dict
3012
1965
server_settings = server_config.defaults()
3013
1966
# Use the appropriate methods on the non-string config options
3014
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3015
"foreground", "zeroconf"):
1967
for option in ("debug", "use_dbus", "use_ipv6"):
3016
1968
server_settings[option] = server_config.getboolean("DEFAULT",
3018
1970
if server_settings["port"]:
3019
1971
server_settings["port"] = server_config.getint("DEFAULT",
3021
if server_settings["socket"]:
3022
server_settings["socket"] = server_config.getint("DEFAULT",
3024
# Later, stdin will, and stdout and stderr might, be dup'ed
3025
# over with an opened os.devnull. But we don't want this to
3026
# happen with a supplied network socket.
3027
if 0 <= server_settings["socket"] <= 2:
3028
server_settings["socket"] = os.dup(server_settings
3030
1973
del server_config
3032
1975
# Override the settings from the config file with command line
3033
1976
# options, if set.
3034
1977
for option in ("interface", "address", "port", "debug",
3035
"priority", "servicename", "configdir", "use_dbus",
3036
"use_ipv6", "debuglevel", "restore", "statedir",
3037
"socket", "foreground", "zeroconf"):
1978
"priority", "servicename", "configdir",
1979
"use_dbus", "use_ipv6", "debuglevel", "restore"):
3038
1980
value = getattr(options, option)
3039
1981
if value is not None:
3040
1982
server_settings[option] = value
3042
1984
# Force all strings to be unicode
3043
1985
for option in server_settings.keys():
3044
if isinstance(server_settings[option], bytes):
3045
server_settings[option] = (server_settings[option]
3047
# Force all boolean options to be boolean
3048
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3049
"foreground", "zeroconf"):
3050
server_settings[option] = bool(server_settings[option])
3051
# Debug implies foreground
3052
if server_settings["debug"]:
3053
server_settings["foreground"] = True
1986
if type(server_settings[option]) is str:
1987
server_settings[option] = unicode(server_settings[option])
3054
1988
# Now we have our good server settings in "server_settings"
3056
1990
##################################################################
3058
if (not server_settings["zeroconf"]
3059
and not (server_settings["port"]
3060
or server_settings["socket"] != "")):
3061
parser.error("Needs port or socket to work without Zeroconf")
3063
1992
# For convenience
3064
1993
debug = server_settings["debug"]
3065
1994
debuglevel = server_settings["debuglevel"]
3066
1995
use_dbus = server_settings["use_dbus"]
3067
1996
use_ipv6 = server_settings["use_ipv6"]
3068
stored_state_path = os.path.join(server_settings["statedir"],
3070
foreground = server_settings["foreground"]
3071
zeroconf = server_settings["zeroconf"]
3074
initlogger(debug, logging.DEBUG)
3079
level = getattr(logging, debuglevel.upper())
3080
initlogger(debug, level)
3082
1998
if server_settings["servicename"] != "Mandos":
3083
syslogger.setFormatter(
3084
logging.Formatter('Mandos ({}) [%(process)d]:'
3085
' %(levelname)s: %(message)s'.format(
3086
server_settings["servicename"])))
1999
syslogger.setFormatter(logging.Formatter
2000
('Mandos (%s) [%%(process)d]:'
2001
' %%(levelname)s: %%(message)s'
2002
% server_settings["servicename"]))
3088
2004
# Parse config file with clients
3089
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)
3090
2014
client_config.read(os.path.join(server_settings["configdir"],
3091
2015
"clients.conf"))
3093
2017
global mandos_dbus_service
3094
2018
mandos_dbus_service = None
3097
if server_settings["socket"] != "":
3098
socketfd = server_settings["socket"]
3099
tcp_server = MandosServer(
3100
(server_settings["address"], server_settings["port"]),
3102
interface=(server_settings["interface"] or None),
3104
gnutls_priority=server_settings["priority"],
3108
pidfilename = "/run/mandos.pid"
3109
if not os.path.isdir("/run/."):
3110
pidfilename = "/var/run/mandos.pid"
3113
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3114
except IOError as e:
3115
logger.error("Could not open file %r", pidfilename,
3118
for name, group in (("_mandos", "_mandos"),
3119
("mandos", "mandos"),
3120
("nobody", "nogroup")):
3122
uid = pwd.getpwnam(name).pw_uid
3123
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
3125
2043
except KeyError:
2045
uid = pwd.getpwnam("nobody").pw_uid
2046
gid = pwd.getpwnam("nobody").pw_gid
3134
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3136
2053
except OSError as error:
3137
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3138
.format(uid, gid, os.strerror(error.errno)))
3139
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)
3143
2065
# Enable all possible GnuTLS debugging
3145
2067
# "Use a log level over 10 to enable all debugging options."
3146
2068
# - GnuTLS manual
3147
gnutls.global_set_log_level(11)
2069
gnutls.library.functions.gnutls_global_set_log_level(11)
2071
@gnutls.library.types.gnutls_log_func
3150
2072
def debug_gnutls(level, string):
3151
2073
logger.debug("GnuTLS: %s", string[:-1])
3153
gnutls.global_set_log_function(debug_gnutls)
2075
(gnutls.library.functions
2076
.gnutls_global_set_log_function(debug_gnutls))
3155
2078
# Redirect stdin so all checkers get /dev/null
3156
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2079
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3157
2080
os.dup2(null, sys.stdin.fileno())
2084
# No console logging
2085
logger.removeHandler(console)
3161
2087
# Need to fork before connecting to D-Bus
3163
2089
# Close all input and output, do double fork, etc.
3166
if gi.version_info < (3, 10, 2):
3167
# multiprocessing will use threads, so before we use GLib we
3168
# need to inform GLib that threads will be used.
3171
2092
global main_loop
3172
2093
# From the Avahi example code
3173
DBusGMainLoop(set_as_default=True)
3174
main_loop = GLib.MainLoop()
2094
DBusGMainLoop(set_as_default=True )
2095
main_loop = gobject.MainLoop()
3175
2096
bus = dbus.SystemBus()
3176
2097
# End of Avahi example code
3179
2100
bus_name = dbus.service.BusName("se.recompile.Mandos",
3182
old_bus_name = dbus.service.BusName(
3183
"se.bsnet.fukt.Mandos", bus,
3185
except dbus.exceptions.DBusException as e:
3186
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")
3187
2107
use_dbus = False
3188
2108
server_settings["use_dbus"] = False
3189
2109
tcp_server.use_dbus = False
3191
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3192
service = AvahiServiceToSyslog(
3193
name=server_settings["servicename"],
3194
servicetype="_mandos._tcp",
3197
if server_settings["interface"]:
3198
service.interface = if_nametoindex(
3199
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"])))
3201
2119
global multiprocessing_manager
3202
2120
multiprocessing_manager = multiprocessing.Manager()
3204
2122
client_class = Client
3206
client_class = functools.partial(ClientDBus, bus=bus)
3208
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())
3209
2147
old_client_settings = {}
3212
# This is used to redirect stdout and stderr for checker processes
3214
wnull = open(os.devnull, "w") # A writable /dev/null
3215
# Only used if server is running in foreground but not in debug
3217
if debug or not foreground:
3220
# Get client data and settings from last running state.
2150
# Get client data and settings from last running state.
3221
2151
if server_settings["restore"]:
3223
2153
with open(stored_state_path, "rb") as stored_state:
3224
if sys.version_info.major == 2:
3225
clients_data, old_client_settings = pickle.load(
3228
bytes_clients_data, bytes_old_client_settings = (
3229
pickle.load(stored_state, encoding="bytes"))
3230
# Fix bytes to strings
3233
clients_data = {(key.decode("utf-8")
3234
if isinstance(key, bytes)
3237
bytes_clients_data.items()}
3238
del bytes_clients_data
3239
for key in clients_data:
3240
value = {(k.decode("utf-8")
3241
if isinstance(k, bytes) else k): v
3243
clients_data[key].items()}
3244
clients_data[key] = value
3246
value["client_structure"] = [
3248
if isinstance(s, bytes)
3250
value["client_structure"]]
3252
for k in ("name", "host"):
3253
if isinstance(value[k], bytes):
3254
value[k] = value[k].decode("utf-8")
3255
if "key_id" not in value:
3256
value["key_id"] = ""
3257
elif "fingerprint" not in value:
3258
value["fingerprint"] = ""
3259
# old_client_settings
3261
old_client_settings = {
3262
(key.decode("utf-8")
3263
if isinstance(key, bytes)
3266
bytes_old_client_settings.items()}
3267
del bytes_old_client_settings
3269
for value in old_client_settings.values():
3270
if isinstance(value["host"], bytes):
3271
value["host"] = (value["host"]
2154
clients_data, old_client_settings = (
2155
pickle.load(stored_state))
3273
2156
os.remove(stored_state_path)
3274
2157
except IOError as e:
3275
if e.errno == errno.ENOENT:
3276
logger.warning("Could not load persistent state:"
3277
" {}".format(os.strerror(e.errno)))
3279
logger.critical("Could not load persistent state:",
2158
logger.warning("Could not load persistant state: {0}"
2160
if e.errno != errno.ENOENT:
3282
except EOFError as e:
3283
logger.warning("Could not load persistent state: "
3287
with PGPEngine() as pgp:
3288
for client_name, client in clients_data.items():
3289
# Skip removed clients
3290
if client_name not in client_settings:
3293
# Decide which value to use after restoring saved state.
3294
# We have three different values: Old config file,
3295
# new config file, and saved state.
3296
# New config value takes precedence if it differs from old
3297
# config value, otherwise use saved state.
3298
for name, value in client_settings[client_name].items():
3300
# For each value in new config, check if it
3301
# differs from the old config value (Except for
3302
# the "secret" attribute)
3303
if (name != "secret"
3305
old_client_settings[client_name][name])):
3306
client[name] = value
3310
# Clients who has passed its expire date can still be
3311
# enabled if its last checker was successful. A Client
3312
# whose checker succeeded before we stored its state is
3313
# assumed to have successfully run all checkers during
3315
if client["enabled"]:
3316
if datetime.datetime.utcnow() >= client["expires"]:
3317
if not client["last_checked_ok"]:
3319
"disabling client {} - Client never "
3320
"performed a successful checker".format(
3322
client["enabled"] = False
3323
elif client["last_checker_status"] != 0:
3325
"disabling client {} - Client last"
3326
" checker failed with error code"
3329
client["last_checker_status"]))
3330
client["enabled"] = False
3332
client["expires"] = (
3333
datetime.datetime.utcnow()
3334
+ client["timeout"])
3335
logger.debug("Last checker succeeded,"
3336
" 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():
3339
client["secret"] = pgp.decrypt(
3340
client["encrypted_secret"],
3341
client_settings[client_name]["secret"])
3343
# If decryption fails, we use secret from new settings
3344
logger.debug("Failed to decrypt {} old secret".format(
3346
client["secret"] = (client_settings[client_name]
3349
# Add/remove clients based on new changes made to config
3350
for client_name in (set(old_client_settings)
3351
- set(client_settings)):
3352
del clients_data[client_name]
3353
for client_name in (set(client_settings)
3354
- set(old_client_settings)):
3355
clients_data[client_name] = client_settings[client_name]
3357
# Create all client objects
3358
for client_name, client in clients_data.items():
3359
tcp_server.clients[client_name] = client_class(
3362
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
3364
2225
if not tcp_server.clients:
3365
2226
logger.warning("No clients defined")
3368
if pidfile is not None:
3372
print(pid, file=pidfile)
3374
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
3377
2240
del pidfilename
3379
for termsig in (signal.SIGHUP, signal.SIGTERM):
3380
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3381
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())
3385
@alternate_dbus_interfaces(
3386
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3387
class MandosDBusService(DBusObjectWithObjectManager):
2248
class MandosDBusService(dbus.service.Object):
3388
2249
"""A D-Bus proxy object"""
3390
2250
def __init__(self):
3391
2251
dbus.service.Object.__init__(self, bus, "/")
3393
2252
_interface = "se.recompile.Mandos"
3395
2254
@dbus.service.signal(_interface, signature="o")
3396
2255
def ClientAdded(self, objpath):
3400
2259
@dbus.service.signal(_interface, signature="ss")
3401
def ClientNotFound(self, key_id, address):
2260
def ClientNotFound(self, fingerprint, address):
3405
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3407
2264
@dbus.service.signal(_interface, signature="os")
3408
2265
def ClientRemoved(self, objpath, name):
3412
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3414
2269
@dbus.service.method(_interface, out_signature="ao")
3415
2270
def GetAllClients(self):
3417
return dbus.Array(c.dbus_object_path for c in
3418
tcp_server.clients.values())
3420
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2272
return dbus.Array(c.dbus_object_path
2274
tcp_server.clients.itervalues())
3422
2276
@dbus.service.method(_interface,
3423
2277
out_signature="a{oa{sv}}")
3424
2278
def GetAllClientsWithProperties(self):
3426
2280
return dbus.Dictionary(
3427
{c.dbus_object_path: c.GetAll(
3428
"se.recompile.Mandos.Client")
3429
for c in tcp_server.clients.values()},
2281
((c.dbus_object_path, c.GetAll(""))
2282
for c in tcp_server.clients.itervalues()),
3430
2283
signature="oa{sv}")
3432
2285
@dbus.service.method(_interface, in_signature="o")
3433
2286
def RemoveClient(self, object_path):
3435
for c in tcp_server.clients.values():
2288
for c in tcp_server.clients.itervalues():
3436
2289
if c.dbus_object_path == object_path:
3437
2290
del tcp_server.clients[c.name]
3438
2291
c.remove_from_connection()
3439
# Don't signal the disabling
2292
# Don't signal anything except ClientRemoved
3440
2293
c.disable(quiet=True)
3441
# Emit D-Bus signal for removal
3442
self.client_removed_signal(c)
2295
self.ClientRemoved(object_path, c.name)
3444
2297
raise KeyError(object_path)
3448
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3449
out_signature="a{oa{sa{sv}}}")
3450
def GetManagedObjects(self):
3452
return dbus.Dictionary(
3453
{client.dbus_object_path:
3455
{interface: client.GetAll(interface)
3457
client._get_all_interface_names()})
3458
for client in tcp_server.clients.values()})
3460
def client_added_signal(self, client):
3461
"""Send the new standard signal and the old signal"""
3463
# New standard signal
3464
self.InterfacesAdded(
3465
client.dbus_object_path,
3467
{interface: client.GetAll(interface)
3469
client._get_all_interface_names()}))
3471
self.ClientAdded(client.dbus_object_path)
3473
def client_removed_signal(self, client):
3474
"""Send the new standard signal and the old signal"""
3476
# New standard signal
3477
self.InterfacesRemoved(
3478
client.dbus_object_path,
3479
client._get_all_interface_names())
3481
self.ClientRemoved(client.dbus_object_path,
3484
mandos_dbus_service = MandosDBusService()
3486
# Save modules to variables to exempt the modules from being
3487
# unloaded before the function registered with atexit() is run.
3488
mp = multiprocessing
2301
class MandosDBusServiceTransitional(MandosDBusService):
2302
__metaclass__ = AlternateDBusNamesMetaclass
2303
mandos_dbus_service = MandosDBusServiceTransitional()
3492
2306
"Cleanup function; run on exit"
3496
mp.active_children()
2309
multiprocessing.active_children()
3498
2310
if not (tcp_server.clients or client_settings):
3501
2313
# Store client before exiting. Secrets are encrypted with key
3502
2314
# based on what config file has. If config file is
3503
2315
# removed/edited, old secret will thus be unrecovable.
3505
with PGPEngine() as pgp:
3506
for client in tcp_server.clients.values():
3507
key = client_settings[client.name]["secret"]
3508
client.encrypted_secret = pgp.encrypt(client.secret,
3512
# A list of attributes that can not be pickled
3514
exclude = {"bus", "changedstate", "secret",
3515
"checker", "server_settings"}
3516
for name, typ in inspect.getmembers(dbus.service
3520
client_dict["encrypted_secret"] = (client
3522
for attr in client.client_structure:
3523
if attr not in exclude:
3524
client_dict[attr] = getattr(client, attr)
3526
clients[client.name] = client_dict
3527
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"]
3530
with tempfile.NamedTemporaryFile(
3534
dir=os.path.dirname(stored_state_path),
3535
delete=False) as stored_state:
3536
pickle.dump((clients, client_settings), stored_state,
3538
tempname = stored_state.name
3539
os.rename(tempname, stored_state_path)
3540
except (IOError, OSError) as e:
3546
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3547
logger.warning("Could not save persistent state: {}"
3548
.format(os.strerror(e.errno)))
3550
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:
3554
2349
# Delete all clients, and settings from config