63
import cPickle as pickle
70
import cPickle as pickle
64
73
import multiprocessing
69
82
import dbus.service
83
from gi.repository import GLib
72
84
from dbus.mainloop.glib import DBusGMainLoop
75
87
import xml.dom.minidom
77
import Crypto.Cipher.AES
90
# Try to find the value of SO_BINDTODEVICE:
92
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
93
# newer, and it is also the most natural place for it:
80
94
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
81
95
except AttributeError:
97
# This is where SO_BINDTODEVICE was up to and including Python
83
99
from IN import SO_BINDTODEVICE
84
100
except ImportError:
85
SO_BINDTODEVICE = None
89
stored_state_path = "/var/lib/mandos/clients.pickle"
101
# In Python 2.7 it seems to have been removed entirely.
102
# Try running the C preprocessor:
104
cc = subprocess.Popen(["cc", "--language=c", "-E",
106
stdin=subprocess.PIPE,
107
stdout=subprocess.PIPE)
108
stdout = cc.communicate(
109
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
110
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
111
except (OSError, ValueError, IndexError):
113
SO_BINDTODEVICE = None
115
if sys.version_info.major == 2:
119
stored_state_file = "clients.pickle"
91
121
logger = logging.getLogger()
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
96
def initlogger(level=logging.WARNING):
125
if_nametoindex = ctypes.cdll.LoadLibrary(
126
ctypes.util.find_library("c")).if_nametoindex
127
except (OSError, AttributeError):
129
def if_nametoindex(interface):
130
"Get an interface index the hard way, i.e. using fcntl()"
131
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
132
with contextlib.closing(socket.socket()) as s:
133
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
134
struct.pack(b"16s16x", interface))
135
interface_index = struct.unpack("I", ifreq[16:20])[0]
136
return interface_index
139
def copy_function(func):
140
"""Make a copy of a function"""
141
if sys.version_info.major == 2:
142
return types.FunctionType(func.func_code,
148
return types.FunctionType(func.__code__,
155
def initlogger(debug, level=logging.WARNING):
97
156
"""init logger and add loglevel"""
159
syslogger = (logging.handlers.SysLogHandler(
160
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
99
162
syslogger.setFormatter(logging.Formatter
100
163
('Mandos [%(process)d]: %(levelname)s:'
102
165
logger.addHandler(syslogger)
104
console = logging.StreamHandler()
105
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
109
logger.addHandler(console)
168
console = logging.StreamHandler()
169
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
173
logger.addHandler(console)
110
174
logger.setLevel(level)
177
class PGPError(Exception):
178
"""Exception if encryption/decryption fails"""
182
class PGPEngine(object):
183
"""A simple class for OpenPGP symmetric encryption & decryption"""
186
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
189
output = subprocess.check_output(["gpgconf"])
190
for line in output.splitlines():
191
name, text, path = line.split(b":")
196
if e.errno != errno.ENOENT:
198
self.gnupgargs = ['--batch',
199
'--homedir', self.tempdir,
202
# Only GPG version 1 has the --no-use-agent option.
203
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
204
self.gnupgargs.append("--no-use-agent")
209
def __exit__(self, exc_type, exc_value, traceback):
217
if self.tempdir is not None:
218
# Delete contents of tempdir
219
for root, dirs, files in os.walk(self.tempdir,
221
for filename in files:
222
os.remove(os.path.join(root, filename))
224
os.rmdir(os.path.join(root, dirname))
226
os.rmdir(self.tempdir)
229
def password_encode(self, password):
230
# Passphrase can not be empty and can not contain newlines or
231
# NUL bytes. So we prefix it and hex encode it.
232
encoded = b"mandos" + binascii.hexlify(password)
233
if len(encoded) > 2048:
234
# GnuPG can't handle long passwords, so encode differently
235
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
236
.replace(b"\n", b"\\n")
237
.replace(b"\0", b"\\x00"))
240
def encrypt(self, data, password):
241
passphrase = self.password_encode(password)
242
with tempfile.NamedTemporaryFile(
243
dir=self.tempdir) as passfile:
244
passfile.write(passphrase)
246
proc = subprocess.Popen([self.gpg, '--symmetric',
250
stdin=subprocess.PIPE,
251
stdout=subprocess.PIPE,
252
stderr=subprocess.PIPE)
253
ciphertext, err = proc.communicate(input=data)
254
if proc.returncode != 0:
258
def decrypt(self, data, password):
259
passphrase = self.password_encode(password)
260
with tempfile.NamedTemporaryFile(
261
dir=self.tempdir) as passfile:
262
passfile.write(passphrase)
264
proc = subprocess.Popen([self.gpg, '--decrypt',
268
stdin=subprocess.PIPE,
269
stdout=subprocess.PIPE,
270
stderr=subprocess.PIPE)
271
decrypted_plaintext, err = proc.communicate(input=data)
272
if proc.returncode != 0:
274
return decrypted_plaintext
277
# Pretend that we have an Avahi module
279
"""This isn't so much a class as it is a module-like namespace.
280
It is instantiated once, and simulates having an Avahi module."""
281
IF_UNSPEC = -1 # avahi-common/address.h
282
PROTO_UNSPEC = -1 # avahi-common/address.h
283
PROTO_INET = 0 # avahi-common/address.h
284
PROTO_INET6 = 1 # avahi-common/address.h
285
DBUS_NAME = "org.freedesktop.Avahi"
286
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
287
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
288
DBUS_PATH_SERVER = "/"
290
def string_array_to_txt_array(self, t):
291
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
292
for s in t), signature="ay")
293
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
294
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
295
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
296
SERVER_INVALID = 0 # avahi-common/defs.h
297
SERVER_REGISTERING = 1 # avahi-common/defs.h
298
SERVER_RUNNING = 2 # avahi-common/defs.h
299
SERVER_COLLISION = 3 # avahi-common/defs.h
300
SERVER_FAILURE = 4 # avahi-common/defs.h
113
304
class AvahiError(Exception):
114
305
def __init__(self, value, *args, **kwargs):
115
306
self.value = value
116
super(AvahiError, self).__init__(value, *args, **kwargs)
117
def __unicode__(self):
118
return unicode(repr(self.value))
307
return super(AvahiError, self).__init__(value, *args,
120
311
class AvahiServiceError(AvahiError):
123
315
class AvahiGroupError(AvahiError):
127
319
class AvahiService(object):
128
320
"""An Avahi (Zeroconf) service.
131
323
interface: integer; avahi.IF_UNSPEC or an interface index.
132
324
Used to optionally bind to the specified interface.
133
325
name: string; Example: 'Mandos'
134
326
type: string; Example: '_mandos._tcp'.
135
See <http://www.dns-sd.org/ServiceTypes.html>
327
See <https://www.iana.org/assignments/service-names-port-numbers>
136
328
port: integer; what port to announce
137
329
TXT: list of strings; TXT record for the service
138
330
domain: string; Domain to publish on, default to .local if empty.
267
489
follow_name_owner_changes=True),
268
490
avahi.DBUS_INTERFACE_SERVER)
269
491
self.server.connect_to_signal("StateChanged",
270
self.server_state_changed)
492
self.server_state_changed)
271
493
self.server_state_changed(self.server.GetState())
273
496
class AvahiServiceToSyslog(AvahiService):
497
def rename(self, *args, **kwargs):
275
498
"""Add the new name to the syslog messages"""
276
ret = AvahiService.rename(self)
277
syslogger.setFormatter(logging.Formatter
278
('Mandos (%s) [%%(process)d]:'
279
' %%(levelname)s: %%(message)s'
499
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
500
syslogger.setFormatter(logging.Formatter(
501
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
283
def _timedelta_to_milliseconds(td):
284
"Convert a datetime.timedelta() to milliseconds"
285
return ((td.days * 24 * 60 * 60 * 1000)
286
+ (td.seconds * 1000)
287
+ (td.microseconds // 1000))
506
# Pretend that we have a GnuTLS module
507
class GnuTLS(object):
508
"""This isn't so much a class as it is a module-like namespace.
509
It is instantiated once, and simulates having a GnuTLS module."""
511
library = ctypes.util.find_library("gnutls")
513
library = ctypes.util.find_library("gnutls-deb0")
514
_library = ctypes.cdll.LoadLibrary(library)
516
_need_version = b"3.3.0"
517
_tls_rawpk_version = b"3.6.6"
520
# Need to use "self" here, since this method is called before
521
# the assignment to the "gnutls" global variable happens.
522
if self.check_version(self._need_version) is None:
523
raise self.Error("Needs GnuTLS {} or later"
524
.format(self._need_version))
526
# Unless otherwise indicated, the constants and types below are
527
# all from the gnutls/gnutls.h C header file.
538
E_NO_CERTIFICATE_FOUND = -49
543
KEYID_USE_SHA256 = 1 # gnutls/x509.h
544
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
547
class session_int(ctypes.Structure):
549
session_t = ctypes.POINTER(session_int)
551
class certificate_credentials_st(ctypes.Structure):
553
certificate_credentials_t = ctypes.POINTER(
554
certificate_credentials_st)
555
certificate_type_t = ctypes.c_int
557
class datum_t(ctypes.Structure):
558
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
559
('size', ctypes.c_uint)]
561
class openpgp_crt_int(ctypes.Structure):
563
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
564
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
565
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
566
credentials_type_t = ctypes.c_int
567
transport_ptr_t = ctypes.c_void_p
568
close_request_t = ctypes.c_int
571
class Error(Exception):
572
# We need to use the class name "GnuTLS" here, since this
573
# exception might be raised from within GnuTLS.__init__,
574
# which is called before the assignment to the "gnutls"
575
# global variable has happened.
576
def __init__(self, message=None, code=None, args=()):
577
# Default usage is by a message string, but if a return
578
# code is passed, convert it to a string with
581
if message is None and code is not None:
582
message = GnuTLS.strerror(code)
583
return super(GnuTLS.Error, self).__init__(
586
class CertificateSecurityError(Error):
590
class Credentials(object):
592
self._c_object = gnutls.certificate_credentials_t()
593
gnutls.certificate_allocate_credentials(
594
ctypes.byref(self._c_object))
595
self.type = gnutls.CRD_CERTIFICATE
598
gnutls.certificate_free_credentials(self._c_object)
600
class ClientSession(object):
601
def __init__(self, socket, credentials=None):
602
self._c_object = gnutls.session_t()
603
gnutls_flags = gnutls.CLIENT
604
if gnutls.check_version("3.5.6"):
605
gnutls_flags |= gnutls.NO_TICKETS
607
gnutls_flags |= gnutls.ENABLE_RAWPK
608
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
610
gnutls.set_default_priority(self._c_object)
611
gnutls.transport_set_ptr(self._c_object, socket.fileno())
612
gnutls.handshake_set_private_extensions(self._c_object,
615
if credentials is None:
616
credentials = gnutls.Credentials()
617
gnutls.credentials_set(self._c_object, credentials.type,
618
ctypes.cast(credentials._c_object,
620
self.credentials = credentials
623
gnutls.deinit(self._c_object)
626
return gnutls.handshake(self._c_object)
628
def send(self, data):
632
data_len -= gnutls.record_send(self._c_object,
637
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
639
# Error handling functions
640
def _error_code(result):
641
"""A function to raise exceptions on errors, suitable
642
for the 'restype' attribute on ctypes functions"""
645
if result == gnutls.E_NO_CERTIFICATE_FOUND:
646
raise gnutls.CertificateSecurityError(code=result)
647
raise gnutls.Error(code=result)
649
def _retry_on_error(result, func, arguments):
650
"""A function to retry on some errors, suitable
651
for the 'errcheck' attribute on ctypes functions"""
653
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
654
return _error_code(result)
655
result = func(*arguments)
658
# Unless otherwise indicated, the function declarations below are
659
# all from the gnutls/gnutls.h C header file.
662
priority_set_direct = _library.gnutls_priority_set_direct
663
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
664
ctypes.POINTER(ctypes.c_char_p)]
665
priority_set_direct.restype = _error_code
667
init = _library.gnutls_init
668
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
669
init.restype = _error_code
671
set_default_priority = _library.gnutls_set_default_priority
672
set_default_priority.argtypes = [session_t]
673
set_default_priority.restype = _error_code
675
record_send = _library.gnutls_record_send
676
record_send.argtypes = [session_t, ctypes.c_void_p,
678
record_send.restype = ctypes.c_ssize_t
679
record_send.errcheck = _retry_on_error
681
certificate_allocate_credentials = (
682
_library.gnutls_certificate_allocate_credentials)
683
certificate_allocate_credentials.argtypes = [
684
ctypes.POINTER(certificate_credentials_t)]
685
certificate_allocate_credentials.restype = _error_code
687
certificate_free_credentials = (
688
_library.gnutls_certificate_free_credentials)
689
certificate_free_credentials.argtypes = [
690
certificate_credentials_t]
691
certificate_free_credentials.restype = None
693
handshake_set_private_extensions = (
694
_library.gnutls_handshake_set_private_extensions)
695
handshake_set_private_extensions.argtypes = [session_t,
697
handshake_set_private_extensions.restype = None
699
credentials_set = _library.gnutls_credentials_set
700
credentials_set.argtypes = [session_t, credentials_type_t,
702
credentials_set.restype = _error_code
704
strerror = _library.gnutls_strerror
705
strerror.argtypes = [ctypes.c_int]
706
strerror.restype = ctypes.c_char_p
708
certificate_type_get = _library.gnutls_certificate_type_get
709
certificate_type_get.argtypes = [session_t]
710
certificate_type_get.restype = _error_code
712
certificate_get_peers = _library.gnutls_certificate_get_peers
713
certificate_get_peers.argtypes = [session_t,
714
ctypes.POINTER(ctypes.c_uint)]
715
certificate_get_peers.restype = ctypes.POINTER(datum_t)
717
global_set_log_level = _library.gnutls_global_set_log_level
718
global_set_log_level.argtypes = [ctypes.c_int]
719
global_set_log_level.restype = None
721
global_set_log_function = _library.gnutls_global_set_log_function
722
global_set_log_function.argtypes = [log_func]
723
global_set_log_function.restype = None
725
deinit = _library.gnutls_deinit
726
deinit.argtypes = [session_t]
727
deinit.restype = None
729
handshake = _library.gnutls_handshake
730
handshake.argtypes = [session_t]
731
handshake.restype = _error_code
732
handshake.errcheck = _retry_on_error
734
transport_set_ptr = _library.gnutls_transport_set_ptr
735
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
736
transport_set_ptr.restype = None
738
bye = _library.gnutls_bye
739
bye.argtypes = [session_t, close_request_t]
740
bye.restype = _error_code
741
bye.errcheck = _retry_on_error
743
check_version = _library.gnutls_check_version
744
check_version.argtypes = [ctypes.c_char_p]
745
check_version.restype = ctypes.c_char_p
747
has_rawpk = bool(check_version(_tls_rawpk_version))
751
class pubkey_st(ctypes.Structure):
753
pubkey_t = ctypes.POINTER(pubkey_st)
755
x509_crt_fmt_t = ctypes.c_int
757
# All the function declarations below are from gnutls/abstract.h
758
pubkey_init = _library.gnutls_pubkey_init
759
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
760
pubkey_init.restype = _error_code
762
pubkey_import = _library.gnutls_pubkey_import
763
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
765
pubkey_import.restype = _error_code
767
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
768
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
769
ctypes.POINTER(ctypes.c_ubyte),
770
ctypes.POINTER(ctypes.c_size_t)]
771
pubkey_get_key_id.restype = _error_code
773
pubkey_deinit = _library.gnutls_pubkey_deinit
774
pubkey_deinit.argtypes = [pubkey_t]
775
pubkey_deinit.restype = None
777
# All the function declarations below are from gnutls/openpgp.h
779
openpgp_crt_init = _library.gnutls_openpgp_crt_init
780
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
781
openpgp_crt_init.restype = _error_code
783
openpgp_crt_import = _library.gnutls_openpgp_crt_import
784
openpgp_crt_import.argtypes = [openpgp_crt_t,
785
ctypes.POINTER(datum_t),
787
openpgp_crt_import.restype = _error_code
789
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
790
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
791
ctypes.POINTER(ctypes.c_uint)]
792
openpgp_crt_verify_self.restype = _error_code
794
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
795
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
796
openpgp_crt_deinit.restype = None
798
openpgp_crt_get_fingerprint = (
799
_library.gnutls_openpgp_crt_get_fingerprint)
800
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
804
openpgp_crt_get_fingerprint.restype = _error_code
806
if check_version("3.6.4"):
807
certificate_type_get2 = _library.gnutls_certificate_type_get2
808
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
809
certificate_type_get2.restype = _error_code
811
# Remove non-public functions
812
del _error_code, _retry_on_error
813
# Create the global "gnutls" object, simulating a module
817
def call_pipe(connection, # : multiprocessing.Connection
818
func, *args, **kwargs):
819
"""This function is meant to be called by multiprocessing.Process
821
This function runs func(*args, **kwargs), and writes the resulting
822
return value on the provided multiprocessing.Connection.
824
connection.send(func(*args, **kwargs))
289
828
class Client(object):
290
829
"""A representation of a client host served by this server.
293
_approved: bool(); 'None' if not yet approved/disapproved
832
approved: bool(); 'None' if not yet approved/disapproved
294
833
approval_delay: datetime.timedelta(); Time to wait for approval
295
834
approval_duration: datetime.timedelta(); Duration of one approval
296
835
checker: subprocess.Popen(); a running checker process used
297
836
to see if the client lives.
298
837
'None' if no process is running.
299
checker_callback_tag: a gobject event source tag, or None
838
checker_callback_tag: a GLib event source tag, or None
300
839
checker_command: string; External command which is run to check
301
840
if client lives. %() expansions are done at
302
841
runtime with vars(self) as dict, so that for
303
842
instance %(name)s can be used in the command.
304
checker_initiator_tag: a gobject event source tag, or None
843
checker_initiator_tag: a GLib event source tag, or None
305
844
created: datetime.datetime(); (UTC) object creation
306
845
client_structure: Object describing what attributes a client has
307
846
and is used for storing the client at exit
308
847
current_checker_command: string; current running checker_command
309
disable_initiator_tag: a gobject event source tag, or None
848
disable_initiator_tag: a GLib event source tag, or None
311
850
fingerprint: string (40 or 32 hexadecimal digits); used to
312
uniquely identify the client
851
uniquely identify an OpenPGP client
852
key_id: string (64 hexadecimal digits); used to uniquely identify
853
a client using raw public keys
313
854
host: string; available for use by the checker command
314
855
interval: datetime.timedelta(); How often to start a new checker
315
856
last_approval_request: datetime.datetime(); (UTC) or None
316
857
last_checked_ok: datetime.datetime(); (UTC) or None
317
last_checker_status: integer between 0 and 255 reflecting exit status
318
of last checker. -1 reflect crashed checker,
320
last_enabled: datetime.datetime(); (UTC)
858
last_checker_status: integer between 0 and 255 reflecting exit
859
status of last checker. -1 reflects crashed
860
checker, -2 means no checker completed yet.
861
last_checker_signal: The signal which killed the last checker, if
862
last_checker_status is -1
863
last_enabled: datetime.datetime(); (UTC) or None
321
864
name: string; from the config file, used in log messages and
322
865
D-Bus identifiers
323
866
secret: bytestring; sent verbatim (over TLS) to client
324
867
timeout: datetime.timedelta(); How long from last_checked_ok
325
868
until this client is disabled
326
extended_timeout: extra long timeout when password has been sent
869
extended_timeout: extra long timeout when secret has been sent
327
870
runtime_expansions: Allowed attributes for runtime expansion.
328
871
expires: datetime.datetime(); time (UTC) when a client will be
329
872
disabled, or None
873
server_settings: The server_settings dict from main()
332
876
runtime_expansions = ("approval_delay", "approval_duration",
333
"created", "enabled", "fingerprint",
334
"host", "interval", "last_checked_ok",
877
"created", "enabled", "expires", "key_id",
878
"fingerprint", "host", "interval",
879
"last_approval_request", "last_checked_ok",
335
880
"last_enabled", "name", "timeout")
337
def timeout_milliseconds(self):
338
"Return the 'timeout' attribute in milliseconds"
339
return _timedelta_to_milliseconds(self.timeout)
341
def extended_timeout_milliseconds(self):
342
"Return the 'extended_timeout' attribute in milliseconds"
343
return _timedelta_to_milliseconds(self.extended_timeout)
345
def interval_milliseconds(self):
346
"Return the 'interval' attribute in milliseconds"
347
return _timedelta_to_milliseconds(self.interval)
349
def approval_delay_milliseconds(self):
350
return _timedelta_to_milliseconds(self.approval_delay)
352
def __init__(self, name = None, config=None):
353
"""Note: the 'checker' key in 'config' sets the
354
'checker_command' attribute and *not* the 'checker'
883
"extended_timeout": "PT15M",
885
"checker": "fping -q -- %%(host)s",
887
"approval_delay": "PT0S",
888
"approval_duration": "PT1S",
889
"approved_by_default": "True",
894
def config_parser(config):
895
"""Construct a new dict of client settings of this form:
896
{ client_name: {setting_name: value, ...}, ...}
897
with exceptions for any special settings as defined above.
898
NOTE: Must be a pure function. Must return the same result
899
value given the same arguments.
902
for client_name in config.sections():
903
section = dict(config.items(client_name))
904
client = settings[client_name] = {}
906
client["host"] = section["host"]
907
# Reformat values from string types to Python types
908
client["approved_by_default"] = config.getboolean(
909
client_name, "approved_by_default")
910
client["enabled"] = config.getboolean(client_name,
913
# Uppercase and remove spaces from key_id and fingerprint
914
# for later comparison purposes with return value from the
915
# key_id() and fingerprint() functions
916
client["key_id"] = (section.get("key_id", "").upper()
918
client["fingerprint"] = (section["fingerprint"].upper()
920
if "secret" in section:
921
client["secret"] = codecs.decode(section["secret"]
924
elif "secfile" in section:
925
with open(os.path.expanduser(os.path.expandvars
926
(section["secfile"])),
928
client["secret"] = secfile.read()
930
raise TypeError("No secret or secfile for section {}"
932
client["timeout"] = string_to_delta(section["timeout"])
933
client["extended_timeout"] = string_to_delta(
934
section["extended_timeout"])
935
client["interval"] = string_to_delta(section["interval"])
936
client["approval_delay"] = string_to_delta(
937
section["approval_delay"])
938
client["approval_duration"] = string_to_delta(
939
section["approval_duration"])
940
client["checker_command"] = section["checker"]
941
client["last_approval_request"] = None
942
client["last_checked_ok"] = None
943
client["last_checker_status"] = -2
947
def __init__(self, settings, name=None, server_settings=None):
949
if server_settings is None:
951
self.server_settings = server_settings
952
# adding all client settings
953
for setting, value in settings.items():
954
setattr(self, setting, value)
957
if not hasattr(self, "last_enabled"):
958
self.last_enabled = datetime.datetime.utcnow()
959
if not hasattr(self, "expires"):
960
self.expires = (datetime.datetime.utcnow()
963
self.last_enabled = None
359
966
logger.debug("Creating client %r", self.name)
360
# Uppercase and remove spaces from fingerprint for later
361
# comparison purposes with return value from the fingerprint()
363
self.fingerprint = (config["fingerprint"].upper()
967
logger.debug(" Key ID: %s", self.key_id)
365
968
logger.debug(" Fingerprint: %s", self.fingerprint)
366
if "secret" in config:
367
self.secret = config["secret"].decode("base64")
368
elif "secfile" in config:
369
with open(os.path.expanduser(os.path.expandvars
370
(config["secfile"])),
372
self.secret = secfile.read()
374
raise TypeError("No secret or secfile for client %s"
376
self.host = config.get("host", "")
377
self.created = datetime.datetime.utcnow()
379
self.last_approval_request = None
380
self.last_enabled = datetime.datetime.utcnow()
381
self.last_checked_ok = None
382
self.last_checker_status = None
383
self.timeout = string_to_delta(config["timeout"])
384
self.extended_timeout = string_to_delta(config
385
["extended_timeout"])
386
self.interval = string_to_delta(config["interval"])
969
self.created = settings.get("created",
970
datetime.datetime.utcnow())
972
# attributes specific for this server instance
387
973
self.checker = None
388
974
self.checker_initiator_tag = None
389
975
self.disable_initiator_tag = None
390
self.expires = datetime.datetime.utcnow() + self.timeout
391
976
self.checker_callback_tag = None
392
self.checker_command = config["checker"]
393
977
self.current_checker_command = None
394
self._approved = None
395
self.approved_by_default = config.get("approved_by_default",
397
979
self.approvals_pending = 0
398
self.approval_delay = string_to_delta(
399
config["approval_delay"])
400
self.approval_duration = string_to_delta(
401
config["approval_duration"])
402
self.changedstate = (multiprocessing_manager
403
.Condition(multiprocessing_manager
405
self.client_structure = [attr for attr in self.__dict__.iterkeys() if not attr.startswith("_")]
980
self.changedstate = multiprocessing_manager.Condition(
981
multiprocessing_manager.Lock())
982
self.client_structure = [attr
983
for attr in self.__dict__.keys()
984
if not attr.startswith("_")]
406
985
self.client_structure.append("client_structure")
409
for name, t in inspect.getmembers(type(self),
410
lambda obj: isinstance(obj, property)):
987
for name, t in inspect.getmembers(
988
type(self), lambda obj: isinstance(obj, property)):
411
989
if not name.startswith("_"):
412
990
self.client_structure.append(name)
414
992
# Send notice to process children that client state has changed
415
993
def send_changedstate(self):
416
994
with self.changedstate:
417
995
self.changedstate.notify_all()
419
997
def enable(self):
420
998
"""Start this client's checker and timeout hooks"""
421
999
if getattr(self, "enabled", False):
422
1000
# Already enabled
424
self.send_changedstate()
425
1002
self.expires = datetime.datetime.utcnow() + self.timeout
426
1003
self.enabled = True
427
1004
self.last_enabled = datetime.datetime.utcnow()
428
1005
self.init_checker()
1006
self.send_changedstate()
430
1008
def disable(self, quiet=True):
431
1009
"""Disable this client."""
432
1010
if not getattr(self, "enabled", False):
435
self.send_changedstate()
437
1013
logger.info("Disabling client %s", self.name)
438
if getattr(self, "disable_initiator_tag", False):
439
gobject.source_remove(self.disable_initiator_tag)
1014
if getattr(self, "disable_initiator_tag", None) is not None:
1015
GLib.source_remove(self.disable_initiator_tag)
440
1016
self.disable_initiator_tag = None
441
1017
self.expires = None
442
if getattr(self, "checker_initiator_tag", False):
443
gobject.source_remove(self.checker_initiator_tag)
1018
if getattr(self, "checker_initiator_tag", None) is not None:
1019
GLib.source_remove(self.checker_initiator_tag)
444
1020
self.checker_initiator_tag = None
445
1021
self.stop_checker()
446
1022
self.enabled = False
447
# Do not run this again if called by a gobject.timeout_add
1024
self.send_changedstate()
1025
# Do not run this again if called by a GLib.timeout_add
450
1028
def __del__(self):
453
1031
def init_checker(self):
454
1032
# Schedule a new checker to be started an 'interval' from now,
455
1033
# and every interval from then on.
456
self.checker_initiator_tag = (gobject.timeout_add
457
(self.interval_milliseconds(),
1034
if self.checker_initiator_tag is not None:
1035
GLib.source_remove(self.checker_initiator_tag)
1036
self.checker_initiator_tag = GLib.timeout_add(
1037
int(self.interval.total_seconds() * 1000),
459
1039
# Schedule a disable() when 'timeout' has passed
460
self.disable_initiator_tag = (gobject.timeout_add
461
(self.timeout_milliseconds(),
1040
if self.disable_initiator_tag is not None:
1041
GLib.source_remove(self.disable_initiator_tag)
1042
self.disable_initiator_tag = GLib.timeout_add(
1043
int(self.timeout.total_seconds() * 1000), self.disable)
463
1044
# Also start a new checker *right now*.
464
1045
self.start_checker()
467
def checker_callback(self, pid, condition, command):
1047
def checker_callback(self, source, condition, connection,
468
1049
"""The checker has completed, so take appropriate actions."""
469
1050
self.checker_callback_tag = None
470
1051
self.checker = None
471
if os.WIFEXITED(condition):
472
self.last_checker_status = os.WEXITSTATUS(condition)
1052
# Read return code from connection (see call_pipe)
1053
returncode = connection.recv()
1057
self.last_checker_status = returncode
1058
self.last_checker_signal = None
473
1059
if self.last_checker_status == 0:
474
1060
logger.info("Checker for %(name)s succeeded",
476
1062
self.checked_ok()
478
logger.info("Checker for %(name)s failed",
1064
logger.info("Checker for %(name)s failed", vars(self))
481
1066
self.last_checker_status = -1
1067
self.last_checker_signal = -returncode
482
1068
logger.warning("Checker for %(name)s crashed?",
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,
1072
def checked_ok(self):
1073
"""Assert that the client has been seen, alive and well."""
1074
self.last_checked_ok = datetime.datetime.utcnow()
1075
self.last_checker_status = 0
1076
self.last_checker_signal = None
1079
def bump_timeout(self, timeout=None):
1080
"""Bump up the timeout for this client."""
491
1081
if timeout is None:
492
1082
timeout = self.timeout
493
self.last_checked_ok = datetime.datetime.utcnow()
494
1083
if self.disable_initiator_tag is not None:
495
gobject.source_remove(self.disable_initiator_tag)
1084
GLib.source_remove(self.disable_initiator_tag)
1085
self.disable_initiator_tag = None
496
1086
if getattr(self, "enabled", False):
497
self.disable_initiator_tag = (gobject.timeout_add
498
(_timedelta_to_milliseconds
499
(timeout), self.disable))
1087
self.disable_initiator_tag = GLib.timeout_add(
1088
int(timeout.total_seconds() * 1000), self.disable)
500
1089
self.expires = datetime.datetime.utcnow() + timeout
502
1091
def need_approval(self):
503
1092
self.last_approval_request = datetime.datetime.utcnow()
505
1094
def start_checker(self):
506
1095
"""Start a new checker subprocess if one is not running.
508
1097
If a checker already exists, leave it running and do
510
1099
# The reason for not killing a running checker is that if we
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
1100
# did that, and if a checker (for some reason) started running
1101
# slowly and taking more than 'interval' time, then the client
1102
# would inevitably timeout, since no checker would get a
1103
# chance to run to completion. If we instead leave running
515
1104
# checkers alone, the checker would have to take more time
516
1105
# than 'timeout' for the client to be disabled, which is as it
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)
1108
if self.checker is not None and not self.checker.is_alive():
1109
logger.warning("Checker was not alive; joining")
532
1112
# Start a new checker if needed
533
1113
if self.checker is None:
1114
# Escape attributes for the shell
1116
attr: re.escape(str(getattr(self, attr)))
1117
for attr in self.runtime_expansions}
535
# In case checker_command has exactly one % operator
536
command = self.checker_command % self.host
538
# Escape attributes for the shell
539
escaped_attrs = dict(
541
re.escape(unicode(str(getattr(self, attr, "")),
545
self.runtime_expansions)
548
command = self.checker_command % escaped_attrs
549
except TypeError as error:
550
logger.error('Could not format string "%s":'
551
' %s', self.checker_command, error)
552
return True # Try again later
1119
command = self.checker_command % escaped_attrs
1120
except TypeError as error:
1121
logger.error('Could not format string "%s"',
1122
self.checker_command,
1124
return True # Try again later
553
1125
self.current_checker_command = command
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
1126
logger.info("Starting checker %r for %s", command,
1128
# We don't need to redirect stdout and stderr, since
1129
# in normal mode, that is already done by daemon(),
1130
# and in debug mode we don't want to. (Stdin is
1131
# always replaced by /dev/null.)
1132
# The exception is when not debugging but nevertheless
1133
# running in the foreground; use the previously
1135
popen_args = {"close_fds": True,
1138
if (not self.server_settings["debug"]
1139
and self.server_settings["foreground"]):
1140
popen_args.update({"stdout": wnull,
1142
pipe = multiprocessing.Pipe(duplex=False)
1143
self.checker = multiprocessing.Process(
1145
args=(pipe[1], subprocess.call, command),
1147
self.checker.start()
1148
self.checker_callback_tag = GLib.io_add_watch(
1149
pipe[0].fileno(), GLib.IO_IN,
1150
self.checker_callback, pipe[0], command)
1151
# Re-run this periodically if run by GLib.timeout_add
580
1154
def stop_checker(self):
581
1155
"""Force the checker process, if any, to stop."""
582
1156
if self.checker_callback_tag:
583
gobject.source_remove(self.checker_callback_tag)
1157
GLib.source_remove(self.checker_callback_tag)
584
1158
self.checker_callback_tag = None
585
1159
if getattr(self, "checker", None) is None:
587
1161
logger.debug("Stopping checker for %(name)s", vars(self))
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
1162
self.checker.terminate()
596
1163
self.checker = None
598
# Encrypts a client secret and stores it in a varible encrypted_secret
599
def encrypt_secret(self, key):
600
# Encryption-key need to be of a specific size, so we hash inputed key
601
hasheng = hashlib.sha256()
603
encryptionkey = hasheng.digest()
605
# Create validation hash so we know at decryption if it was sucessful
606
hasheng = hashlib.sha256()
607
hasheng.update(self.secret)
608
validationhash = hasheng.digest()
611
iv = os.urandom(Crypto.Cipher.AES.block_size)
612
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
613
Crypto.Cipher.AES.MODE_CFB, iv)
614
ciphertext = ciphereng.encrypt(validationhash+self.secret)
615
self.encrypted_secret = (ciphertext, iv)
617
# Decrypt a encrypted client secret
618
def decrypt_secret(self, key):
619
# Decryption-key need to be of a specific size, so we hash inputed key
620
hasheng = hashlib.sha256()
622
encryptionkey = hasheng.digest()
624
# Decrypt encrypted secret
625
ciphertext, iv = self.encrypted_secret
626
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
627
Crypto.Cipher.AES.MODE_CFB, iv)
628
plain = ciphereng.decrypt(ciphertext)
630
# Validate decrypted secret to know if it was succesful
631
hasheng = hashlib.sha256()
632
validationhash = plain[:hasheng.digest_size]
633
secret = plain[hasheng.digest_size:]
634
hasheng.update(secret)
636
# if validation fails, we use key as new secret. Otherwhise, we use
637
# the decrypted secret
638
if hasheng.digest() == validationhash:
642
del self.encrypted_secret
645
def dbus_service_property(dbus_interface, signature="v",
646
access="readwrite", byte_arrays=False):
1166
def dbus_service_property(dbus_interface,
647
1170
"""Decorators for marking methods of a DBusObjectWithProperties to
648
1171
become properties on the D-Bus.
650
1173
The decorated method will be called with no arguments by "Get"
651
1174
and with one argument by "Set".
653
1176
The parameters, where they are supported, are the same as
654
1177
dbus.service.method, except there is only "signature", since the
655
1178
type from Get() and the type sent to Set() is the same.
825
1511
except (AttributeError, xml.dom.DOMException,
826
1512
xml.parsers.expat.ExpatError) as error:
827
1513
logger.error("Failed to override Introspection method",
832
def datetime_to_dbus (dt, variant_level=0):
1519
dbus.OBJECT_MANAGER_IFACE
1520
except AttributeError:
1521
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1524
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1525
"""A D-Bus object with an ObjectManager.
1527
Classes inheriting from this exposes the standard
1528
GetManagedObjects call and the InterfacesAdded and
1529
InterfacesRemoved signals on the standard
1530
"org.freedesktop.DBus.ObjectManager" interface.
1532
Note: No signals are sent automatically; they must be sent
1535
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1536
out_signature="a{oa{sa{sv}}}")
1537
def GetManagedObjects(self):
1538
"""This function must be overridden"""
1539
raise NotImplementedError()
1541
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1542
signature="oa{sa{sv}}")
1543
def InterfacesAdded(self, object_path, interfaces_and_properties):
1546
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1547
def InterfacesRemoved(self, object_path, interfaces):
1550
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1552
path_keyword='object_path',
1553
connection_keyword='connection')
1554
def Introspect(self, object_path, connection):
1555
"""Overloading of standard D-Bus method.
1557
Override return argument name of GetManagedObjects to be
1558
"objpath_interfaces_and_properties"
1560
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1564
document = xml.dom.minidom.parseString(xmlstring)
1566
for if_tag in document.getElementsByTagName("interface"):
1567
# Fix argument name for the GetManagedObjects method
1568
if (if_tag.getAttribute("name")
1569
== dbus.OBJECT_MANAGER_IFACE):
1570
for cn in if_tag.getElementsByTagName("method"):
1571
if (cn.getAttribute("name")
1572
== "GetManagedObjects"):
1573
for arg in cn.getElementsByTagName("arg"):
1574
if (arg.getAttribute("direction")
1578
"objpath_interfaces"
1580
xmlstring = document.toxml("utf-8")
1582
except (AttributeError, xml.dom.DOMException,
1583
xml.parsers.expat.ExpatError) as error:
1584
logger.error("Failed to override Introspection method",
1589
def datetime_to_dbus(dt, variant_level=0):
833
1590
"""Convert a UTC datetime.datetime() to a D-Bus type."""
835
return dbus.String("", variant_level = variant_level)
836
return dbus.String(dt.isoformat(),
837
variant_level=variant_level)
839
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
841
"""Applied to an empty subclass of a D-Bus object, this metaclass
842
will add additional D-Bus attributes matching a certain pattern.
1592
return dbus.String("", variant_level=variant_level)
1593
return dbus.String(dt.isoformat(), variant_level=variant_level)
1596
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1597
"""A class decorator; applied to a subclass of
1598
dbus.service.Object, it will add alternate D-Bus attributes with
1599
interface names according to the "alt_interface_names" mapping.
1602
@alternate_dbus_interfaces({"org.example.Interface":
1603
"net.example.AlternateInterface"})
1604
class SampleDBusObject(dbus.service.Object):
1605
@dbus.service.method("org.example.Interface")
1606
def SampleDBusMethod():
1609
The above "SampleDBusMethod" on "SampleDBusObject" will be
1610
reachable via two interfaces: "org.example.Interface" and
1611
"net.example.AlternateInterface", the latter of which will have
1612
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1613
"true", unless "deprecate" is passed with a False value.
1615
This works for methods and signals, and also for D-Bus properties
1616
(from DBusObjectWithProperties) and interfaces (from the
1617
dbus_interface_annotations decorator).
844
def __new__(mcs, name, bases, attr):
845
# Go through all the base classes which could have D-Bus
846
# methods, signals, or properties in them
847
for base in (b for b in bases
848
if issubclass(b, dbus.service.Object)):
849
# Go though all attributes of the base class
850
for attrname, attribute in inspect.getmembers(base):
1621
for orig_interface_name, alt_interface_name in (
1622
alt_interface_names.items()):
1624
interface_names = set()
1625
# Go though all attributes of the class
1626
for attrname, attribute in inspect.getmembers(cls):
851
1627
# Ignore non-D-Bus attributes, and D-Bus attributes
852
1628
# with the wrong interface name
853
1629
if (not hasattr(attribute, "_dbus_interface")
854
or not attribute._dbus_interface
855
.startswith("se.recompile.Mandos")):
1630
or not attribute._dbus_interface.startswith(
1631
orig_interface_name)):
857
1633
# Create an alternate D-Bus interface name based on
858
1634
# the current name
859
alt_interface = (attribute._dbus_interface
860
.replace("se.recompile.Mandos",
861
"se.bsnet.fukt.Mandos"))
1635
alt_interface = attribute._dbus_interface.replace(
1636
orig_interface_name, alt_interface_name)
1637
interface_names.add(alt_interface)
862
1638
# Is this a D-Bus signal?
863
1639
if getattr(attribute, "_dbus_is_signal", False):
864
# Extract the original non-method function by
866
nonmethod_func = (dict(
1640
# Extract the original non-method undecorated
1641
# function by black magic
1642
if sys.version_info.major == 2:
1643
nonmethod_func = (dict(
867
1644
zip(attribute.func_code.co_freevars,
868
attribute.__closure__))["func"]
1645
attribute.__closure__))
1646
["func"].cell_contents)
1648
nonmethod_func = (dict(
1649
zip(attribute.__code__.co_freevars,
1650
attribute.__closure__))
1651
["func"].cell_contents)
870
1652
# Create a new, but exactly alike, function
871
1653
# object, and decorate it to be a new D-Bus signal
872
1654
# with the alternate D-Bus interface name
873
new_function = (dbus.service.signal
875
attribute._dbus_signature)
877
nonmethod_func.func_code,
878
nonmethod_func.func_globals,
879
nonmethod_func.func_name,
880
nonmethod_func.func_defaults,
881
nonmethod_func.func_closure)))
1655
new_function = copy_function(nonmethod_func)
1656
new_function = (dbus.service.signal(
1658
attribute._dbus_signature)(new_function))
1659
# Copy annotations, if any
1661
new_function._dbus_annotations = dict(
1662
attribute._dbus_annotations)
1663
except AttributeError:
882
1666
# Define a creator of a function to call both the
883
# old and new functions, so both the old and new
884
# signals gets sent when the function is called
1667
# original and alternate functions, so both the
1668
# original and alternate signals gets sent when
1669
# the function is called
885
1670
def fixscope(func1, func2):
886
1671
"""This function is a scope container to pass
887
1672
func1 and func2 to the "call_both" function
888
1673
outside of its arguments"""
1675
@functools.wraps(func2)
889
1676
def call_both(*args, **kwargs):
890
1677
"""This function will emit two D-Bus
891
1678
signals by calling func1 and func2"""
892
1679
func1(*args, **kwargs)
893
1680
func2(*args, **kwargs)
1681
# Make wrapper function look like a D-Bus
1683
for name, attr in inspect.getmembers(func2):
1684
if name.startswith("_dbus_"):
1685
setattr(call_both, name, attr)
894
1687
return call_both
895
1688
# Create the "call_both" function and add it to
897
attr[attrname] = fixscope(attribute,
1690
attr[attrname] = fixscope(attribute, new_function)
899
1691
# Is this a D-Bus method?
900
1692
elif getattr(attribute, "_dbus_is_method", False):
901
1693
# Create a new, but exactly alike, function
902
1694
# object. Decorate it to be a new D-Bus method
903
1695
# with the alternate D-Bus interface name. Add it
905
attr[attrname] = (dbus.service.method
907
attribute._dbus_in_signature,
908
attribute._dbus_out_signature)
910
(attribute.func_code,
911
attribute.func_globals,
913
attribute.func_defaults,
914
attribute.func_closure)))
1698
dbus.service.method(
1700
attribute._dbus_in_signature,
1701
attribute._dbus_out_signature)
1702
(copy_function(attribute)))
1703
# Copy annotations, if any
1705
attr[attrname]._dbus_annotations = dict(
1706
attribute._dbus_annotations)
1707
except AttributeError:
915
1709
# Is this a D-Bus property?
916
1710
elif getattr(attribute, "_dbus_is_property", False):
917
1711
# Create a new, but exactly alike, function
918
1712
# object, and decorate it to be a new D-Bus
919
1713
# property with the alternate D-Bus interface
920
1714
# name. Add it to the class.
921
attr[attrname] = (dbus_service_property
923
attribute._dbus_signature,
924
attribute._dbus_access,
926
._dbus_get_args_options
929
(attribute.func_code,
930
attribute.func_globals,
932
attribute.func_defaults,
933
attribute.func_closure)))
934
return type.__new__(mcs, name, bases, attr)
1715
attr[attrname] = (dbus_service_property(
1716
alt_interface, attribute._dbus_signature,
1717
attribute._dbus_access,
1718
attribute._dbus_get_args_options
1720
(copy_function(attribute)))
1721
# Copy annotations, if any
1723
attr[attrname]._dbus_annotations = dict(
1724
attribute._dbus_annotations)
1725
except AttributeError:
1727
# Is this a D-Bus interface?
1728
elif getattr(attribute, "_dbus_is_interface", False):
1729
# Create a new, but exactly alike, function
1730
# object. Decorate it to be a new D-Bus interface
1731
# with the alternate D-Bus interface name. Add it
1734
dbus_interface_annotations(alt_interface)
1735
(copy_function(attribute)))
1737
# Deprecate all alternate interfaces
1738
iname = "_AlternateDBusNames_interface_annotation{}"
1739
for interface_name in interface_names:
1741
@dbus_interface_annotations(interface_name)
1743
return {"org.freedesktop.DBus.Deprecated":
1745
# Find an unused name
1746
for aname in (iname.format(i)
1747
for i in itertools.count()):
1748
if aname not in attr:
1752
# Replace the class with a new subclass of it with
1753
# methods, signals, etc. as created above.
1754
if sys.version_info.major == 2:
1755
cls = type(b"{}Alternate".format(cls.__name__),
1758
cls = type("{}Alternate".format(cls.__name__),
1765
@alternate_dbus_interfaces({"se.recompile.Mandos":
1766
"se.bsnet.fukt.Mandos"})
936
1767
class ClientDBus(Client, DBusObjectWithProperties):
937
1768
"""A Client class using D-Bus
940
1771
dbus_object_path: dbus.ObjectPath
941
1772
bus: dbus.SystemBus()
944
1775
runtime_expansions = (Client.runtime_expansions
945
+ ("dbus_object_path",))
1776
+ ("dbus_object_path", ))
1778
_interface = "se.recompile.Mandos.Client"
947
1780
# dbus.service.Object doesn't use super(), so we can't either.
949
def __init__(self, bus = None, *args, **kwargs):
1782
def __init__(self, bus=None, *args, **kwargs):
951
1784
Client.__init__(self, *args, **kwargs)
953
self._approvals_pending = 0
954
1785
# Only now, when this client is initialized, can it show up on
956
client_object_name = unicode(self.name).translate(
1787
client_object_name = str(self.name).translate(
957
1788
{ord("."): ord("_"),
958
1789
ord("-"): ord("_")})
959
self.dbus_object_path = (dbus.ObjectPath
960
("/clients/" + client_object_name))
1790
self.dbus_object_path = dbus.ObjectPath(
1791
"/clients/" + client_object_name)
961
1792
DBusObjectWithProperties.__init__(self, self.bus,
962
1793
self.dbus_object_path)
964
def notifychangeproperty(transform_func,
965
dbus_name, type_func=lambda x: x,
1795
def notifychangeproperty(transform_func, dbus_name,
1796
type_func=lambda x: x,
1798
invalidate_only=False,
1799
_interface=_interface):
967
1800
""" Modify a variable so that it's a property which announces
968
1801
its changes to DBus.
1328
2196
self.start_checker()
1330
2198
self.stop_checker()
1332
2200
# ObjectPath - property
2202
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2203
"org.freedesktop.DBus.Deprecated": "true"})
1333
2204
@dbus_service_property(_interface, signature="o", access="read")
1334
2205
def ObjectPath_dbus_property(self):
1335
return self.dbus_object_path # is already a dbus.ObjectPath
2206
return self.dbus_object_path # is already a dbus.ObjectPath
1337
2208
# Secret = property
1338
@dbus_service_property(_interface, signature="ay",
1339
access="write", byte_arrays=True)
2210
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2212
@dbus_service_property(_interface,
1340
2216
def Secret_dbus_property(self, value):
1341
self.secret = str(value)
2217
self.secret = bytes(value)
1346
2222
class ProxyClient(object):
1347
def __init__(self, child_pipe, fpr, address):
2223
def __init__(self, child_pipe, key_id, fpr, address):
1348
2224
self._pipe = child_pipe
1349
self._pipe.send(('init', fpr, address))
2225
self._pipe.send(('init', key_id, fpr, address))
1350
2226
if not self._pipe.recv():
2227
raise KeyError(key_id or fpr)
1353
2229
def __getattribute__(self, name):
1354
if(name == '_pipe'):
1355
2231
return super(ProxyClient, self).__getattribute__(name)
1356
2232
self._pipe.send(('getattr', name))
1357
2233
data = self._pipe.recv()
1358
2234
if data[0] == 'data':
1360
2236
if data[0] == 'function':
1361
2238
def func(*args, **kwargs):
1362
2239
self._pipe.send(('funcall', name, args, kwargs))
1363
2240
return self._pipe.recv()[1]
1366
2244
def __setattr__(self, name, value):
1367
if(name == '_pipe'):
1368
2246
return super(ProxyClient, self).__setattr__(name, value)
1369
2247
self._pipe.send(('setattr', name, value))
1371
class ClientDBusTransitional(ClientDBus):
1372
__metaclass__ = AlternateDBusNamesMetaclass
1374
2250
class ClientHandler(socketserver.BaseRequestHandler, object):
1375
2251
"""A class to handle client connections.
1377
2253
Instantiated once for each connection to handle it.
1378
2254
Note: This will run in its own forked process."""
1380
2256
def handle(self):
1381
2257
with contextlib.closing(self.server.child_pipe) as child_pipe:
1382
2258
logger.info("TCP connection from: %s",
1383
unicode(self.client_address))
2259
str(self.client_address))
1384
2260
logger.debug("Pipe FD: %d",
1385
2261
self.server.child_pipe.fileno())
1387
session = (gnutls.connection
1388
.ClientSession(self.request,
1390
.X509Credentials()))
1392
# Note: gnutls.connection.X509Credentials is really a
1393
# generic GnuTLS certificate credentials object so long as
1394
# no X.509 keys are added to it. Therefore, we can use it
1395
# here despite using OpenPGP certificates.
1397
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1398
# "+AES-256-CBC", "+SHA1",
1399
# "+COMP-NULL", "+CTYPE-OPENPGP",
2263
session = gnutls.ClientSession(self.request)
2265
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2266
# "+AES-256-CBC", "+SHA1",
2267
# "+COMP-NULL", "+CTYPE-OPENPGP",
1401
2269
# Use a fallback default, since this MUST be set.
1402
2270
priority = self.server.gnutls_priority
1403
2271
if priority is None:
1404
2272
priority = "NORMAL"
1405
(gnutls.library.functions
1406
.gnutls_priority_set_direct(session._c_object,
2273
gnutls.priority_set_direct(session._c_object,
2274
priority.encode("utf-8"),
1409
2277
# Start communication using the Mandos protocol
1410
2278
# Get protocol number
1411
2279
line = self.request.makefile().readline()
1412
2280
logger.debug("Protocol version: %r", line)
1414
2282
if int(line.strip().split()[0]) > 1:
2283
raise RuntimeError(line)
1416
2284
except (ValueError, IndexError, RuntimeError) as error:
1417
2285
logger.error("Unknown protocol version: %s", error)
1420
2288
# Start GnuTLS connection
1422
2290
session.handshake()
1423
except gnutls.errors.GNUTLSError as error:
2291
except gnutls.Error as error:
1424
2292
logger.warning("Handshake failed: %s", error)
1425
2293
# Do not run session.bye() here: the session is not
1426
2294
# established. Just abandon the request.
1428
2296
logger.debug("Handshake succeeded")
1430
2298
approval_required = False
1433
fpr = self.fingerprint(self.peer_certificate
1436
gnutls.errors.GNUTLSError) as error:
1437
logger.warning("Bad certificate: %s", error)
1439
logger.debug("Fingerprint: %s", fpr)
1440
if self.server.use_dbus:
1442
client.NewRequest(str(self.client_address))
1445
client = ProxyClient(child_pipe, fpr,
2300
if gnutls.has_rawpk:
2303
key_id = self.key_id(
2304
self.peer_certificate(session))
2305
except (TypeError, gnutls.Error) as error:
2306
logger.warning("Bad certificate: %s", error)
2308
logger.debug("Key ID: %s", key_id)
2313
fpr = self.fingerprint(
2314
self.peer_certificate(session))
2315
except (TypeError, gnutls.Error) as error:
2316
logger.warning("Bad certificate: %s", error)
2318
logger.debug("Fingerprint: %s", fpr)
2321
client = ProxyClient(child_pipe, key_id, fpr,
1446
2322
self.client_address)
1447
2323
except KeyError:
1450
2326
if client.approval_delay:
1451
2327
delay = client.approval_delay
1452
2328
client.approvals_pending += 1
1453
2329
approval_required = True
1456
2332
if not client.enabled:
1457
2333
logger.info("Client %s is disabled",
1459
2335
if self.server.use_dbus:
1460
2336
# Emit D-Bus signal
1461
2337
client.Rejected("Disabled")
1464
if client._approved or not client.approval_delay:
1465
#We are approved or approval is disabled
2340
if client.approved or not client.approval_delay:
2341
# We are approved or approval is disabled
1467
elif client._approved is None:
2343
elif client.approved is None:
1468
2344
logger.info("Client %s needs approval",
1470
2346
if self.server.use_dbus:
1471
2347
# Emit D-Bus signal
1472
2348
client.NeedApproval(
1473
client.approval_delay_milliseconds(),
1474
client.approved_by_default)
2349
client.approval_delay.total_seconds()
2350
* 1000, client.approved_by_default)
1476
2352
logger.warning("Client %s was not approved",
1503
2377
delay -= time2 - time
1506
while sent_size < len(client.secret):
1508
sent = session.send(client.secret[sent_size:])
1509
except gnutls.errors.GNUTLSError as error:
1510
logger.warning("gnutls send failed")
1512
logger.debug("Sent: %d, remaining: %d",
1513
sent, len(client.secret)
1514
- (sent_size + sent))
2380
session.send(client.secret)
2381
except gnutls.Error as error:
2382
logger.warning("gnutls send failed",
1517
2386
logger.info("Sending secret to %s", client.name)
1518
2387
# bump the timeout using extended_timeout
1519
client.checked_ok(client.extended_timeout)
2388
client.bump_timeout(client.extended_timeout)
1520
2389
if self.server.use_dbus:
1521
2390
# Emit D-Bus signal
1522
2391
client.GotSecret()
1525
2394
if approval_required:
1526
2395
client.approvals_pending -= 1
1529
except gnutls.errors.GNUTLSError as error:
1530
logger.warning("GnuTLS bye failed")
2398
except gnutls.Error as error:
2399
logger.warning("GnuTLS bye failed",
1533
2403
def peer_certificate(session):
1534
"Return the peer's OpenPGP certificate as a bytestring"
1535
# If not an OpenPGP certificate...
1536
if (gnutls.library.functions
1537
.gnutls_certificate_type_get(session._c_object)
1538
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1539
# ...do the normal thing
1540
return session.peer_certificate
2404
"Return the peer's certificate as a bytestring"
2406
cert_type = gnutls.certificate_type_get2(session._c_object,
2408
except AttributeError:
2409
cert_type = gnutls.certificate_type_get(session._c_object)
2410
if gnutls.has_rawpk:
2411
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2413
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2414
# If not a valid certificate type...
2415
if cert_type not in valid_cert_types:
2416
logger.info("Cert type %r not in %r", cert_type,
2418
# ...return invalid data
1541
2420
list_size = ctypes.c_uint(1)
1542
cert_list = (gnutls.library.functions
1543
.gnutls_certificate_get_peers
2421
cert_list = (gnutls.certificate_get_peers
1544
2422
(session._c_object, ctypes.byref(list_size)))
1545
2423
if not bool(cert_list) and list_size.value != 0:
1546
raise gnutls.errors.GNUTLSError("error getting peer"
2424
raise gnutls.Error("error getting peer certificate")
1548
2425
if list_size.value == 0:
1550
2427
cert = cert_list[0]
1551
2428
return ctypes.string_at(cert.data, cert.size)
2431
def key_id(certificate):
2432
"Convert a certificate bytestring to a hexdigit key ID"
2433
# New GnuTLS "datum" with the public key
2434
datum = gnutls.datum_t(
2435
ctypes.cast(ctypes.c_char_p(certificate),
2436
ctypes.POINTER(ctypes.c_ubyte)),
2437
ctypes.c_uint(len(certificate)))
2438
# XXX all these need to be created in the gnutls "module"
2439
# New empty GnuTLS certificate
2440
pubkey = gnutls.pubkey_t()
2441
gnutls.pubkey_init(ctypes.byref(pubkey))
2442
# Import the raw public key into the certificate
2443
gnutls.pubkey_import(pubkey,
2444
ctypes.byref(datum),
2445
gnutls.X509_FMT_DER)
2446
# New buffer for the key ID
2447
buf = ctypes.create_string_buffer(32)
2448
buf_len = ctypes.c_size_t(len(buf))
2449
# Get the key ID from the raw public key into the buffer
2450
gnutls.pubkey_get_key_id(pubkey,
2451
gnutls.KEYID_USE_SHA256,
2452
ctypes.cast(ctypes.byref(buf),
2453
ctypes.POINTER(ctypes.c_ubyte)),
2454
ctypes.byref(buf_len))
2455
# Deinit the certificate
2456
gnutls.pubkey_deinit(pubkey)
2458
# Convert the buffer to a Python bytestring
2459
key_id = ctypes.string_at(buf, buf_len.value)
2460
# Convert the bytestring to hexadecimal notation
2461
hex_key_id = binascii.hexlify(key_id).upper()
1554
2465
def fingerprint(openpgp):
1555
2466
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1556
2467
# New GnuTLS "datum" with the OpenPGP public key
1557
datum = (gnutls.library.types
1558
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1561
ctypes.c_uint(len(openpgp))))
2468
datum = gnutls.datum_t(
2469
ctypes.cast(ctypes.c_char_p(openpgp),
2470
ctypes.POINTER(ctypes.c_ubyte)),
2471
ctypes.c_uint(len(openpgp)))
1562
2472
# New empty GnuTLS certificate
1563
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1564
(gnutls.library.functions
1565
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2473
crt = gnutls.openpgp_crt_t()
2474
gnutls.openpgp_crt_init(ctypes.byref(crt))
1566
2475
# Import the OpenPGP public key into the certificate
1567
(gnutls.library.functions
1568
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1569
gnutls.library.constants
1570
.GNUTLS_OPENPGP_FMT_RAW))
2476
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2477
gnutls.OPENPGP_FMT_RAW)
1571
2478
# Verify the self signature in the key
1572
2479
crtverify = ctypes.c_uint()
1573
(gnutls.library.functions
1574
.gnutls_openpgp_crt_verify_self(crt, 0,
1575
ctypes.byref(crtverify)))
2480
gnutls.openpgp_crt_verify_self(crt, 0,
2481
ctypes.byref(crtverify))
1576
2482
if crtverify.value != 0:
1577
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1578
raise (gnutls.errors.CertificateSecurityError
2483
gnutls.openpgp_crt_deinit(crt)
2484
raise gnutls.CertificateSecurityError(code
1580
2486
# New buffer for the fingerprint
1581
2487
buf = ctypes.create_string_buffer(20)
1582
2488
buf_len = ctypes.c_size_t()
1583
2489
# Get the fingerprint from the certificate into the buffer
1584
(gnutls.library.functions
1585
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1586
ctypes.byref(buf_len)))
2490
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2491
ctypes.byref(buf_len))
1587
2492
# Deinit the certificate
1588
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2493
gnutls.openpgp_crt_deinit(crt)
1589
2494
# Convert the buffer to a Python bytestring
1590
2495
fpr = ctypes.string_at(buf, buf_len.value)
1591
2496
# Convert the bytestring to hexadecimal notation
1592
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2497
hex_fpr = binascii.hexlify(fpr).upper()
1596
2501
class MultiprocessingMixIn(object):
1597
2502
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1598
2504
def sub_process_main(self, request, address):
1600
2506
self.finish_request(request, address)
1602
2508
self.handle_error(request, address)
1603
2509
self.close_request(request)
1605
2511
def process_request(self, request, address):
1606
2512
"""Start a new process to process the request."""
1607
proc = multiprocessing.Process(target = self.sub_process_main,
2513
proc = multiprocessing.Process(target=self.sub_process_main,
2514
args=(request, address))
1614
2519
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1615
2520
""" adds a pipe to the MixIn """
1616
2522
def process_request(self, request, client_address):
1617
2523
"""Overrides and wraps the original process_request().
1619
2525
This function creates a new pipe in self.pipe
1621
2527
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1623
2529
proc = MultiprocessingMixIn.process_request(self, request,
1624
2530
client_address)
1625
2531
self.child_pipe.close()
1626
2532
self.add_pipe(parent_pipe, proc)
1628
2534
def add_pipe(self, parent_pipe, proc):
1629
2535
"""Dummy function; override as necessary"""
1630
raise NotImplementedError
2536
raise NotImplementedError()
1633
2539
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1634
2540
socketserver.TCPServer, object):
1635
2541
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1638
2544
enabled: Boolean; whether this server is activated yet
1639
2545
interface: None or a network interface name (string)
1640
2546
use_ipv6: Boolean; to use IPv6 or not
1642
2549
def __init__(self, server_address, RequestHandlerClass,
1643
interface=None, use_ipv6=True):
2553
"""If socketfd is set, use that file descriptor instead of
2554
creating a new one with socket.socket().
1644
2556
self.interface = interface
1646
2558
self.address_family = socket.AF_INET6
2559
if socketfd is not None:
2560
# Save the file descriptor
2561
self.socketfd = socketfd
2562
# Save the original socket.socket() function
2563
self.socket_socket = socket.socket
2565
# To implement --socket, we monkey patch socket.socket.
2567
# (When socketserver.TCPServer is a new-style class, we
2568
# could make self.socket into a property instead of monkey
2569
# patching socket.socket.)
2571
# Create a one-time-only replacement for socket.socket()
2572
@functools.wraps(socket.socket)
2573
def socket_wrapper(*args, **kwargs):
2574
# Restore original function so subsequent calls are
2576
socket.socket = self.socket_socket
2577
del self.socket_socket
2578
# This time only, return a new socket object from the
2579
# saved file descriptor.
2580
return socket.fromfd(self.socketfd, *args, **kwargs)
2581
# Replace socket.socket() function with wrapper
2582
socket.socket = socket_wrapper
2583
# The socketserver.TCPServer.__init__ will call
2584
# socket.socket(), which might be our replacement,
2585
# socket_wrapper(), if socketfd was set.
1647
2586
socketserver.TCPServer.__init__(self, server_address,
1648
2587
RequestHandlerClass)
1649
2589
def server_bind(self):
1650
2590
"""This overrides the normal server_bind() function
1651
2591
to bind to an interface if one was specified, and also NOT to
1652
2592
bind to an address or port if they were not specified."""
2593
global SO_BINDTODEVICE
1653
2594
if self.interface is not None:
1654
2595
if SO_BINDTODEVICE is None:
1655
logger.error("SO_BINDTODEVICE does not exist;"
1656
" cannot bind to interface %s",
1660
self.socket.setsockopt(socket.SOL_SOCKET,
1664
except socket.error as error:
1665
if error[0] == errno.EPERM:
1666
logger.error("No permission to"
1667
" bind to interface %s",
1669
elif error[0] == errno.ENOPROTOOPT:
1670
logger.error("SO_BINDTODEVICE not available;"
1671
" cannot bind to interface %s",
2596
# Fall back to a hard-coded value which seems to be
2598
logger.warning("SO_BINDTODEVICE not found, trying 25")
2599
SO_BINDTODEVICE = 25
2601
self.socket.setsockopt(
2602
socket.SOL_SOCKET, SO_BINDTODEVICE,
2603
(self.interface + "\0").encode("utf-8"))
2604
except socket.error as error:
2605
if error.errno == errno.EPERM:
2606
logger.error("No permission to bind to"
2607
" interface %s", self.interface)
2608
elif error.errno == errno.ENOPROTOOPT:
2609
logger.error("SO_BINDTODEVICE not available;"
2610
" cannot bind to interface %s",
2612
elif error.errno == errno.ENODEV:
2613
logger.error("Interface %s does not exist,"
2614
" cannot bind", self.interface)
1675
2617
# Only bind(2) the socket if we really need to.
1676
2618
if self.server_address[0] or self.server_address[1]:
1677
2619
if not self.server_address[0]:
1678
2620
if self.address_family == socket.AF_INET6:
1679
any_address = "::" # in6addr_any
2621
any_address = "::" # in6addr_any
1681
any_address = socket.INADDR_ANY
2623
any_address = "0.0.0.0" # INADDR_ANY
1682
2624
self.server_address = (any_address,
1683
2625
self.server_address[1])
1684
2626
elif not self.server_address[1]:
1685
self.server_address = (self.server_address[0],
2627
self.server_address = (self.server_address[0], 0)
1687
2628
# if self.interface:
1688
2629
# self.server_address = (self.server_address[0],
1934
2957
parser.add_argument("--no-dbus", action="store_false",
1935
2958
dest="use_dbus", help="Do not provide D-Bus"
1936
" system bus interface")
2959
" system bus interface", default=None)
1937
2960
parser.add_argument("--no-ipv6", action="store_false",
1938
dest="use_ipv6", help="Do not use IPv6")
2961
dest="use_ipv6", help="Do not use IPv6",
1939
2963
parser.add_argument("--no-restore", action="store_false",
1940
dest="restore", help="Do not restore stored state",
2964
dest="restore", help="Do not restore stored"
2965
" state", default=None)
2966
parser.add_argument("--socket", type=int,
2967
help="Specify a file descriptor to a network"
2968
" socket to use instead of creating one")
2969
parser.add_argument("--statedir", metavar="DIR",
2970
help="Directory to save/restore state in")
2971
parser.add_argument("--foreground", action="store_true",
2972
help="Run in foreground", default=None)
2973
parser.add_argument("--no-zeroconf", action="store_false",
2974
dest="zeroconf", help="Do not use Zeroconf",
1943
2977
options = parser.parse_args()
1945
2979
if options.check:
2981
fail_count, test_count = doctest.testmod()
2982
sys.exit(os.EX_OK if fail_count == 0 else 1)
1950
2984
# Default values for config file for server-global settings
1951
server_defaults = { "interface": "",
1956
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1957
"servicename": "Mandos",
2985
if gnutls.has_rawpk:
2986
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2987
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2989
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2990
":+SIGN-DSA-SHA256")
2991
server_defaults = {"interface": "",
2995
"priority": priority,
2996
"servicename": "Mandos",
3002
"statedir": "/var/lib/mandos",
3003
"foreground": "False",
1963
3008
# Parse config file for server-global settings
1964
3009
server_config = configparser.SafeConfigParser(server_defaults)
1965
3010
del server_defaults
1966
server_config.read(os.path.join(options.configdir,
3011
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1968
3012
# Convert the SafeConfigParser object to a dict
1969
3013
server_settings = server_config.defaults()
1970
3014
# Use the appropriate methods on the non-string config options
1971
for option in ("debug", "use_dbus", "use_ipv6"):
3015
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3016
"foreground", "zeroconf"):
1972
3017
server_settings[option] = server_config.getboolean("DEFAULT",
1974
3019
if server_settings["port"]:
1975
3020
server_settings["port"] = server_config.getint("DEFAULT",
3022
if server_settings["socket"]:
3023
server_settings["socket"] = server_config.getint("DEFAULT",
3025
# Later, stdin will, and stdout and stderr might, be dup'ed
3026
# over with an opened os.devnull. But we don't want this to
3027
# happen with a supplied network socket.
3028
if 0 <= server_settings["socket"] <= 2:
3029
server_settings["socket"] = os.dup(server_settings
1977
3031
del server_config
1979
3033
# Override the settings from the config file with command line
1980
3034
# options, if set.
1981
3035
for option in ("interface", "address", "port", "debug",
1982
"priority", "servicename", "configdir",
1983
"use_dbus", "use_ipv6", "debuglevel", "restore"):
3036
"priority", "servicename", "configdir", "use_dbus",
3037
"use_ipv6", "debuglevel", "restore", "statedir",
3038
"socket", "foreground", "zeroconf"):
1984
3039
value = getattr(options, option)
1985
3040
if value is not None:
1986
3041
server_settings[option] = value
1988
3043
# Force all strings to be unicode
1989
3044
for option in server_settings.keys():
1990
if type(server_settings[option]) is str:
1991
server_settings[option] = unicode(server_settings[option])
3045
if isinstance(server_settings[option], bytes):
3046
server_settings[option] = (server_settings[option]
3048
# Force all boolean options to be boolean
3049
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3050
"foreground", "zeroconf"):
3051
server_settings[option] = bool(server_settings[option])
3052
# Debug implies foreground
3053
if server_settings["debug"]:
3054
server_settings["foreground"] = True
1992
3055
# Now we have our good server settings in "server_settings"
1994
3057
##################################################################
3059
if (not server_settings["zeroconf"]
3060
and not (server_settings["port"]
3061
or server_settings["socket"] != "")):
3062
parser.error("Needs port or socket to work without Zeroconf")
1996
3064
# For convenience
1997
3065
debug = server_settings["debug"]
1998
3066
debuglevel = server_settings["debuglevel"]
1999
3067
use_dbus = server_settings["use_dbus"]
2000
3068
use_ipv6 = server_settings["use_ipv6"]
3069
stored_state_path = os.path.join(server_settings["statedir"],
3071
foreground = server_settings["foreground"]
3072
zeroconf = server_settings["zeroconf"]
2003
initlogger(logging.DEBUG)
3075
initlogger(debug, logging.DEBUG)
2005
3077
if not debuglevel:
2008
3080
level = getattr(logging, debuglevel.upper())
3081
initlogger(debug, level)
2011
3083
if server_settings["servicename"] != "Mandos":
2012
syslogger.setFormatter(logging.Formatter
2013
('Mandos (%s) [%%(process)d]:'
2014
' %%(levelname)s: %%(message)s'
2015
% server_settings["servicename"]))
3084
syslogger.setFormatter(
3085
logging.Formatter('Mandos ({}) [%(process)d]:'
3086
' %(levelname)s: %(message)s'.format(
3087
server_settings["servicename"])))
2017
3089
# Parse config file with clients
2018
client_defaults = { "timeout": "5m",
2019
"extended_timeout": "15m",
2021
"checker": "fping -q -- %%(host)s",
2023
"approval_delay": "0s",
2024
"approval_duration": "1s",
2026
client_config = configparser.SafeConfigParser(client_defaults)
3090
client_config = configparser.SafeConfigParser(Client
2027
3092
client_config.read(os.path.join(server_settings["configdir"],
2028
3093
"clients.conf"))
2030
3095
global mandos_dbus_service
2031
3096
mandos_dbus_service = None
2033
tcp_server = MandosServer((server_settings["address"],
2034
server_settings["port"]),
2036
interface=(server_settings["interface"]
2040
server_settings["priority"],
2043
pidfilename = "/var/run/mandos.pid"
2045
pidfile = open(pidfilename, "w")
2047
logger.error("Could not open file %r", pidfilename)
2050
uid = pwd.getpwnam("_mandos").pw_uid
2051
gid = pwd.getpwnam("_mandos").pw_gid
2054
uid = pwd.getpwnam("mandos").pw_uid
2055
gid = pwd.getpwnam("mandos").pw_gid
3099
if server_settings["socket"] != "":
3100
socketfd = server_settings["socket"]
3101
tcp_server = MandosServer(
3102
(server_settings["address"], server_settings["port"]),
3104
interface=(server_settings["interface"] or None),
3106
gnutls_priority=server_settings["priority"],
3110
pidfilename = "/run/mandos.pid"
3111
if not os.path.isdir("/run/."):
3112
pidfilename = "/var/run/mandos.pid"
3115
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3116
except IOError as e:
3117
logger.error("Could not open file %r", pidfilename,
3120
for name, group in (("_mandos", "_mandos"),
3121
("mandos", "mandos"),
3122
("nobody", "nogroup")):
3124
uid = pwd.getpwnam(name).pw_uid
3125
gid = pwd.getpwnam(group).pw_gid
2056
3127
except KeyError:
2058
uid = pwd.getpwnam("nobody").pw_uid
2059
gid = pwd.getpwnam("nobody").pw_gid
3136
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2066
3138
except OSError as error:
2067
if error[0] != errno.EPERM:
3139
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3140
.format(uid, gid, os.strerror(error.errno)))
3141
if error.errno != errno.EPERM:
2071
3145
# Enable all possible GnuTLS debugging
2073
3147
# "Use a log level over 10 to enable all debugging options."
2074
3148
# - GnuTLS manual
2075
gnutls.library.functions.gnutls_global_set_log_level(11)
2077
@gnutls.library.types.gnutls_log_func
3149
gnutls.global_set_log_level(11)
2078
3152
def debug_gnutls(level, string):
2079
3153
logger.debug("GnuTLS: %s", string[:-1])
2081
(gnutls.library.functions
2082
.gnutls_global_set_log_function(debug_gnutls))
3155
gnutls.global_set_log_function(debug_gnutls)
2084
3157
# Redirect stdin so all checkers get /dev/null
2085
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3158
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2086
3159
os.dup2(null, sys.stdin.fileno())
2090
# No console logging
2091
logger.removeHandler(console)
2093
3163
# Need to fork before connecting to D-Bus
2095
3165
# Close all input and output, do double fork, etc.
3168
# multiprocessing will use threads, so before we use GLib we need
3169
# to inform GLib that threads will be used.
2098
3172
global main_loop
2099
3173
# From the Avahi example code
2100
DBusGMainLoop(set_as_default=True )
2101
main_loop = gobject.MainLoop()
3174
DBusGMainLoop(set_as_default=True)
3175
main_loop = GLib.MainLoop()
2102
3176
bus = dbus.SystemBus()
2103
3177
# End of Avahi example code
2106
3180
bus_name = dbus.service.BusName("se.recompile.Mandos",
2107
bus, do_not_queue=True)
2108
old_bus_name = (dbus.service.BusName
2109
("se.bsnet.fukt.Mandos", bus,
2111
except dbus.exceptions.NameExistsException as e:
2112
logger.error(unicode(e) + ", disabling D-Bus")
3183
old_bus_name = dbus.service.BusName(
3184
"se.bsnet.fukt.Mandos", bus,
3186
except dbus.exceptions.DBusException as e:
3187
logger.error("Disabling D-Bus:", exc_info=e)
2113
3188
use_dbus = False
2114
3189
server_settings["use_dbus"] = False
2115
3190
tcp_server.use_dbus = False
2116
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2117
service = AvahiServiceToSyslog(name =
2118
server_settings["servicename"],
2119
servicetype = "_mandos._tcp",
2120
protocol = protocol, bus = bus)
2121
if server_settings["interface"]:
2122
service.interface = (if_nametoindex
2123
(str(server_settings["interface"])))
3192
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3193
service = AvahiServiceToSyslog(
3194
name=server_settings["servicename"],
3195
servicetype="_mandos._tcp",
3198
if server_settings["interface"]:
3199
service.interface = if_nametoindex(
3200
server_settings["interface"].encode("utf-8"))
2125
3202
global multiprocessing_manager
2126
3203
multiprocessing_manager = multiprocessing.Manager()
2128
3205
client_class = Client
2130
client_class = functools.partial(ClientDBusTransitional,
2133
special_settings = {
2134
# Some settings need to be accessd by special methods;
2135
# booleans need .getboolean(), etc. Here is a list of them:
2136
"approved_by_default":
2138
client_config.getboolean(section, "approved_by_default"),
2140
# Construct a new dict of client settings of this form:
2141
# { client_name: {setting_name: value, ...}, ...}
2142
# with exceptions for any special settings as defined above
2143
client_settings = dict((clientname,
2145
(value if setting not in special_settings
2146
else special_settings[setting](clientname)))
2147
for setting, value in client_config.items(clientname)))
2148
for clientname in client_config.sections())
3207
client_class = functools.partial(ClientDBus, bus=bus)
3209
client_settings = Client.config_parser(client_config)
2150
3210
old_client_settings = {}
2153
# Get client data and settings from last running state.
3213
# This is used to redirect stdout and stderr for checker processes
3215
wnull = open(os.devnull, "w") # A writable /dev/null
3216
# Only used if server is running in foreground but not in debug
3218
if debug or not foreground:
3221
# Get client data and settings from last running state.
2154
3222
if server_settings["restore"]:
2156
3224
with open(stored_state_path, "rb") as stored_state:
2157
clients_data, old_client_settings = pickle.load(stored_state)
3225
if sys.version_info.major == 2:
3226
clients_data, old_client_settings = pickle.load(
3229
bytes_clients_data, bytes_old_client_settings = (
3230
pickle.load(stored_state, encoding="bytes"))
3231
# Fix bytes to strings
3234
clients_data = {(key.decode("utf-8")
3235
if isinstance(key, bytes)
3238
bytes_clients_data.items()}
3239
del bytes_clients_data
3240
for key in clients_data:
3241
value = {(k.decode("utf-8")
3242
if isinstance(k, bytes) else k): v
3244
clients_data[key].items()}
3245
clients_data[key] = value
3247
value["client_structure"] = [
3249
if isinstance(s, bytes)
3251
value["client_structure"]]
3253
for k in ("name", "host"):
3254
if isinstance(value[k], bytes):
3255
value[k] = value[k].decode("utf-8")
3256
if not value.has_key("key_id"):
3257
value["key_id"] = ""
3258
elif not value.has_key("fingerprint"):
3259
value["fingerprint"] = ""
3260
# old_client_settings
3262
old_client_settings = {
3263
(key.decode("utf-8")
3264
if isinstance(key, bytes)
3267
bytes_old_client_settings.items()}
3268
del bytes_old_client_settings
3270
for value in old_client_settings.values():
3271
if isinstance(value["host"], bytes):
3272
value["host"] = (value["host"]
2158
3274
os.remove(stored_state_path)
2159
3275
except IOError as e:
2160
logger.warning("Could not load persistant state: {0}".format(e))
2161
if e.errno != errno.ENOENT:
3276
if e.errno == errno.ENOENT:
3277
logger.warning("Could not load persistent state:"
3278
" {}".format(os.strerror(e.errno)))
3280
logger.critical("Could not load persistent state:",
2164
for client in clients_data:
2165
client_name = client["name"]
2167
# Decide which value to use after restoring saved state.
2168
# We have three different values: Old config file,
2169
# new config file, and saved state.
2170
# New config value takes precedence if it differs from old
2171
# config value, otherwise use saved state.
2172
for name, value in client_settings[client_name].items():
3283
except EOFError as e:
3284
logger.warning("Could not load persistent state: "
3288
with PGPEngine() as pgp:
3289
for client_name, client in clients_data.items():
3290
# Skip removed clients
3291
if client_name not in client_settings:
3294
# Decide which value to use after restoring saved state.
3295
# We have three different values: Old config file,
3296
# new config file, and saved state.
3297
# New config value takes precedence if it differs from old
3298
# config value, otherwise use saved state.
3299
for name, value in client_settings[client_name].items():
3301
# For each value in new config, check if it
3302
# differs from the old config value (Except for
3303
# the "secret" attribute)
3304
if (name != "secret"
3306
old_client_settings[client_name][name])):
3307
client[name] = value
3311
# Clients who has passed its expire date can still be
3312
# enabled if its last checker was successful. A Client
3313
# whose checker succeeded before we stored its state is
3314
# assumed to have successfully run all checkers during
3316
if client["enabled"]:
3317
if datetime.datetime.utcnow() >= client["expires"]:
3318
if not client["last_checked_ok"]:
3320
"disabling client {} - Client never "
3321
"performed a successful checker".format(
3323
client["enabled"] = False
3324
elif client["last_checker_status"] != 0:
3326
"disabling client {} - Client last"
3327
" checker failed with error code"
3330
client["last_checker_status"]))
3331
client["enabled"] = False
3333
client["expires"] = (
3334
datetime.datetime.utcnow()
3335
+ client["timeout"])
3336
logger.debug("Last checker succeeded,"
3337
" keeping {} enabled".format(
2174
# For each value in new config, check if it differs
2175
# from the old config value (Except for the "secret"
2177
if name != "secret" and value != old_client_settings[client_name][name]:
2178
setattr(client, name, value)
2182
# Clients who has passed its expire date, can still be enabled if its
2183
# last checker was sucessful. Clients who checkers failed before we
2184
# stored it state is asumed to had failed checker during downtime.
2185
if client["enabled"] and client["last_checked_ok"]:
2186
if ((datetime.datetime.utcnow() - client["last_checked_ok"])
2187
> client["interval"]):
2188
if client["last_checker_status"] != 0:
2189
client["enabled"] = False
2191
client["expires"] = datetime.datetime.utcnow() + client["timeout"]
2193
client["changedstate"] = (multiprocessing_manager
2194
.Condition(multiprocessing_manager
2197
new_client = ClientDBusTransitional.__new__(ClientDBusTransitional)
2198
tcp_server.clients[client_name] = new_client
2199
new_client.bus = bus
2200
for name, value in client.iteritems():
2201
setattr(new_client, name, value)
2202
client_object_name = unicode(client_name).translate(
2203
{ord("."): ord("_"),
2204
ord("-"): ord("_")})
2205
new_client.dbus_object_path = (dbus.ObjectPath
2206
("/clients/" + client_object_name))
2207
DBusObjectWithProperties.__init__(new_client,
2209
new_client.dbus_object_path)
2211
tcp_server.clients[client_name] = Client.__new__(Client)
2212
for name, value in client.iteritems():
2213
setattr(tcp_server.clients[client_name], name, value)
2215
tcp_server.clients[client_name].decrypt_secret(
2216
client_settings[client_name]["secret"])
2218
# Create/remove clients based on new changes made to config
2219
for clientname in set(old_client_settings) - set(client_settings):
2220
del tcp_server.clients[clientname]
2221
for clientname in set(client_settings) - set(old_client_settings):
2222
tcp_server.clients[clientname] = (client_class(name = clientname,
3340
client["secret"] = pgp.decrypt(
3341
client["encrypted_secret"],
3342
client_settings[client_name]["secret"])
3344
# If decryption fails, we use secret from new settings
3345
logger.debug("Failed to decrypt {} old secret".format(
3347
client["secret"] = (client_settings[client_name]
3350
# Add/remove clients based on new changes made to config
3351
for client_name in (set(old_client_settings)
3352
- set(client_settings)):
3353
del clients_data[client_name]
3354
for client_name in (set(client_settings)
3355
- set(old_client_settings)):
3356
clients_data[client_name] = client_settings[client_name]
3358
# Create all client objects
3359
for client_name, client in clients_data.items():
3360
tcp_server.clients[client_name] = client_class(
3363
server_settings=server_settings)
2228
3365
if not tcp_server.clients:
2229
3366
logger.warning("No clients defined")
2235
pidfile.write(str(pid) + "\n".encode("utf-8"))
2238
logger.error("Could not write to file %r with PID %d",
2241
# "pidfile" was never created
3369
if pidfile is not None:
3373
print(pid, file=pidfile)
3375
logger.error("Could not write to file %r with PID %d",
2243
3378
del pidfilename
2245
signal.signal(signal.SIGINT, signal.SIG_IGN)
2247
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2248
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3380
for termsig in (signal.SIGHUP, signal.SIGTERM):
3381
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3382
lambda: main_loop.quit() and False)
2251
class MandosDBusService(dbus.service.Object):
3386
@alternate_dbus_interfaces(
3387
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3388
class MandosDBusService(DBusObjectWithObjectManager):
2252
3389
"""A D-Bus proxy object"""
2253
3391
def __init__(self):
2254
3392
dbus.service.Object.__init__(self, bus, "/")
2255
3394
_interface = "se.recompile.Mandos"
2257
3396
@dbus.service.signal(_interface, signature="o")
2258
3397
def ClientAdded(self, objpath):
2262
3401
@dbus.service.signal(_interface, signature="ss")
2263
def ClientNotFound(self, fingerprint, address):
3402
def ClientNotFound(self, key_id, address):
3406
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2267
3408
@dbus.service.signal(_interface, signature="os")
2268
3409
def ClientRemoved(self, objpath, name):
3413
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2272
3415
@dbus.service.method(_interface, out_signature="ao")
2273
3416
def GetAllClients(self):
2275
return dbus.Array(c.dbus_object_path
2277
tcp_server.clients.itervalues())
3418
return dbus.Array(c.dbus_object_path for c in
3419
tcp_server.clients.values())
3421
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2279
3423
@dbus.service.method(_interface,
2280
3424
out_signature="a{oa{sv}}")
2281
3425
def GetAllClientsWithProperties(self):
2283
3427
return dbus.Dictionary(
2284
((c.dbus_object_path, c.GetAll(""))
2285
for c in tcp_server.clients.itervalues()),
3428
{c.dbus_object_path: c.GetAll(
3429
"se.recompile.Mandos.Client")
3430
for c in tcp_server.clients.values()},
2286
3431
signature="oa{sv}")
2288
3433
@dbus.service.method(_interface, in_signature="o")
2289
3434
def RemoveClient(self, object_path):
2291
for c in tcp_server.clients.itervalues():
3436
for c in tcp_server.clients.values():
2292
3437
if c.dbus_object_path == object_path:
2293
3438
del tcp_server.clients[c.name]
2294
3439
c.remove_from_connection()
2295
# Don't signal anything except ClientRemoved
3440
# Don't signal the disabling
2296
3441
c.disable(quiet=True)
2298
self.ClientRemoved(object_path, c.name)
3442
# Emit D-Bus signal for removal
3443
self.client_removed_signal(c)
2300
3445
raise KeyError(object_path)
2304
class MandosDBusServiceTransitional(MandosDBusService):
2305
__metaclass__ = AlternateDBusNamesMetaclass
2306
mandos_dbus_service = MandosDBusServiceTransitional()
3449
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3450
out_signature="a{oa{sa{sv}}}")
3451
def GetManagedObjects(self):
3453
return dbus.Dictionary(
3454
{client.dbus_object_path:
3456
{interface: client.GetAll(interface)
3458
client._get_all_interface_names()})
3459
for client in tcp_server.clients.values()})
3461
def client_added_signal(self, client):
3462
"""Send the new standard signal and the old signal"""
3464
# New standard signal
3465
self.InterfacesAdded(
3466
client.dbus_object_path,
3468
{interface: client.GetAll(interface)
3470
client._get_all_interface_names()}))
3472
self.ClientAdded(client.dbus_object_path)
3474
def client_removed_signal(self, client):
3475
"""Send the new standard signal and the old signal"""
3477
# New standard signal
3478
self.InterfacesRemoved(
3479
client.dbus_object_path,
3480
client._get_all_interface_names())
3482
self.ClientRemoved(client.dbus_object_path,
3485
mandos_dbus_service = MandosDBusService()
3487
# Save modules to variables to exempt the modules from being
3488
# unloaded before the function registered with atexit() is run.
3489
mp = multiprocessing
2309
3493
"Cleanup function; run on exit"
2312
multiprocessing.active_children()
3497
mp.active_children()
2313
3499
if not (tcp_server.clients or client_settings):
2316
# Store client before exiting. Secrets are encrypted with key based
2317
# on what config file has. If config file is removed/edited, old
2318
# secret will thus be unrecovable.
2320
for client in tcp_server.clients.itervalues():
2321
client.encrypt_secret(client_settings[client.name]["secret"])
2325
# A list of attributes that will not be stored when shuting down.
2326
exclude = set(("bus", "changedstate", "secret"))
2327
for name, typ in inspect.getmembers(dbus.service.Object):
2330
client_dict["encrypted_secret"] = client.encrypted_secret
2331
for attr in client.client_structure:
2332
if attr not in exclude:
2333
client_dict[attr] = getattr(client, attr)
2335
clients.append(client_dict)
2336
del client_settings[client.name]["secret"]
3502
# Store client before exiting. Secrets are encrypted with key
3503
# based on what config file has. If config file is
3504
# removed/edited, old secret will thus be unrecovable.
3506
with PGPEngine() as pgp:
3507
for client in tcp_server.clients.values():
3508
key = client_settings[client.name]["secret"]
3509
client.encrypted_secret = pgp.encrypt(client.secret,
3513
# A list of attributes that can not be pickled
3515
exclude = {"bus", "changedstate", "secret",
3516
"checker", "server_settings"}
3517
for name, typ in inspect.getmembers(dbus.service
3521
client_dict["encrypted_secret"] = (client
3523
for attr in client.client_structure:
3524
if attr not in exclude:
3525
client_dict[attr] = getattr(client, attr)
3527
clients[client.name] = client_dict
3528
del client_settings[client.name]["secret"]
2339
with os.fdopen(os.open(stored_state_path, os.O_CREAT|os.O_WRONLY|os.O_TRUNC, 0600), "wb") as stored_state:
2340
pickle.dump((clients, client_settings), stored_state)
2341
except IOError as e:
2342
logger.warning("Could not save persistant state: {0}".format(e))
2343
if e.errno != errno.ENOENT:
3531
with tempfile.NamedTemporaryFile(
3535
dir=os.path.dirname(stored_state_path),
3536
delete=False) as stored_state:
3537
pickle.dump((clients, client_settings), stored_state,
3539
tempname = stored_state.name
3540
os.rename(tempname, stored_state_path)
3541
except (IOError, OSError) as e:
3547
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3548
logger.warning("Could not save persistent state: {}"
3549
.format(os.strerror(e.errno)))
3551
logger.warning("Could not save persistent state:",
2346
3555
# Delete all clients, and settings from config