70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
83
69
import dbus.service
85
from gi.repository import GLib
86
72
from dbus.mainloop.glib import DBusGMainLoop
89
75
import xml.dom.minidom
92
if sys.version_info.major == 2:
95
# Show warnings by default
96
if not sys.warnoptions:
98
warnings.simplefilter("default")
100
# Try to find the value of SO_BINDTODEVICE:
77
import Crypto.Cipher.AES
102
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
103
# newer, and it is also the most natural place for it:
104
80
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
105
81
except AttributeError:
107
# This is where SO_BINDTODEVICE was up to and including Python
109
83
from IN import SO_BINDTODEVICE
110
84
except ImportError:
111
# In Python 2.7 it seems to have been removed entirely.
112
# Try running the C preprocessor:
114
cc = subprocess.Popen(["cc", "--language=c", "-E",
116
stdin=subprocess.PIPE,
117
stdout=subprocess.PIPE)
118
stdout = cc.communicate(
119
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
120
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
121
except (OSError, ValueError, IndexError):
123
SO_BINDTODEVICE = None
125
if sys.version_info.major == 2:
128
if sys.version_info < (3, 2):
129
configparser.Configparser = configparser.SafeConfigParser
132
stored_state_file = "clients.pickle"
85
SO_BINDTODEVICE = None
89
stored_state_path = "/var/lib/mandos/clients.pickle"
134
91
logger = logging.getLogger()
135
logging.captureWarnings(True) # Show warnings via the logging system
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
139
if_nametoindex = ctypes.cdll.LoadLibrary(
140
ctypes.util.find_library("c")).if_nametoindex
97
if_nametoindex = (ctypes.cdll.LoadLibrary
98
(ctypes.util.find_library("c"))
141
100
except (OSError, AttributeError):
143
101
def if_nametoindex(interface):
144
102
"Get an interface index the hard way, i.e. using fcntl()"
145
103
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
146
104
with contextlib.closing(socket.socket()) as s:
147
105
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
148
struct.pack(b"16s16x", interface))
149
interface_index = struct.unpack("I", ifreq[16:20])[0]
106
struct.pack(str("16s16x"),
108
interface_index = struct.unpack(str("I"),
150
110
return interface_index
153
def copy_function(func):
154
"""Make a copy of a function"""
155
if sys.version_info.major == 2:
156
return types.FunctionType(func.func_code,
162
return types.FunctionType(func.__code__,
169
def initlogger(debug, level=logging.WARNING):
113
def initlogger(level=logging.WARNING):
170
114
"""init logger and add loglevel"""
173
syslogger = (logging.handlers.SysLogHandler(
174
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
176
116
syslogger.setFormatter(logging.Formatter
177
117
('Mandos [%(process)d]: %(levelname)s:'
179
119
logger.addHandler(syslogger)
182
console = logging.StreamHandler()
183
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
187
logger.addHandler(console)
121
console = logging.StreamHandler()
122
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
126
logger.addHandler(console)
188
127
logger.setLevel(level)
191
class PGPError(Exception):
192
"""Exception if encryption/decryption fails"""
197
"""A simple class for OpenPGP symmetric encryption & decryption"""
200
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
203
output = subprocess.check_output(["gpgconf"])
204
for line in output.splitlines():
205
name, text, path = line.split(b":")
210
if e.errno != errno.ENOENT:
212
self.gnupgargs = ['--batch',
213
'--homedir', self.tempdir,
216
# Only GPG version 1 has the --no-use-agent option.
217
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
218
self.gnupgargs.append("--no-use-agent")
223
def __exit__(self, exc_type, exc_value, traceback):
231
if self.tempdir is not None:
232
# Delete contents of tempdir
233
for root, dirs, files in os.walk(self.tempdir,
235
for filename in files:
236
os.remove(os.path.join(root, filename))
238
os.rmdir(os.path.join(root, dirname))
240
os.rmdir(self.tempdir)
243
def password_encode(self, password):
244
# Passphrase can not be empty and can not contain newlines or
245
# NUL bytes. So we prefix it and hex encode it.
246
encoded = b"mandos" + binascii.hexlify(password)
247
if len(encoded) > 2048:
248
# GnuPG can't handle long passwords, so encode differently
249
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
250
.replace(b"\n", b"\\n")
251
.replace(b"\0", b"\\x00"))
254
def encrypt(self, data, password):
255
passphrase = self.password_encode(password)
256
with tempfile.NamedTemporaryFile(
257
dir=self.tempdir) as passfile:
258
passfile.write(passphrase)
260
proc = subprocess.Popen([self.gpg, '--symmetric',
264
stdin=subprocess.PIPE,
265
stdout=subprocess.PIPE,
266
stderr=subprocess.PIPE)
267
ciphertext, err = proc.communicate(input=data)
268
if proc.returncode != 0:
272
def decrypt(self, data, password):
273
passphrase = self.password_encode(password)
274
with tempfile.NamedTemporaryFile(
275
dir=self.tempdir) as passfile:
276
passfile.write(passphrase)
278
proc = subprocess.Popen([self.gpg, '--decrypt',
282
stdin=subprocess.PIPE,
283
stdout=subprocess.PIPE,
284
stderr=subprocess.PIPE)
285
decrypted_plaintext, err = proc.communicate(input=data)
286
if proc.returncode != 0:
288
return decrypted_plaintext
291
# Pretend that we have an Avahi module
293
"""This isn't so much a class as it is a module-like namespace."""
294
IF_UNSPEC = -1 # avahi-common/address.h
295
PROTO_UNSPEC = -1 # avahi-common/address.h
296
PROTO_INET = 0 # avahi-common/address.h
297
PROTO_INET6 = 1 # avahi-common/address.h
298
DBUS_NAME = "org.freedesktop.Avahi"
299
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
300
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
301
DBUS_PATH_SERVER = "/"
304
def string_array_to_txt_array(t):
305
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
306
for s in t), signature="ay")
307
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
308
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
309
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
310
SERVER_INVALID = 0 # avahi-common/defs.h
311
SERVER_REGISTERING = 1 # avahi-common/defs.h
312
SERVER_RUNNING = 2 # avahi-common/defs.h
313
SERVER_COLLISION = 3 # avahi-common/defs.h
314
SERVER_FAILURE = 4 # avahi-common/defs.h
317
130
class AvahiError(Exception):
318
131
def __init__(self, value, *args, **kwargs):
319
132
self.value = value
320
return super(AvahiError, self).__init__(value, *args,
133
super(AvahiError, self).__init__(value, *args, **kwargs)
134
def __unicode__(self):
135
return unicode(repr(self.value))
324
137
class AvahiServiceError(AvahiError):
328
140
class AvahiGroupError(AvahiError):
144
class AvahiService(object):
333
145
"""An Avahi (Zeroconf) service.
336
148
interface: integer; avahi.IF_UNSPEC or an interface index.
337
149
Used to optionally bind to the specified interface.
338
150
name: string; Example: 'Mandos'
339
151
type: string; Example: '_mandos._tcp'.
340
See <https://www.iana.org/assignments/service-names-port-numbers>
152
See <http://www.dns-sd.org/ServiceTypes.html>
341
153
port: integer; what port to announce
342
154
TXT: list of strings; TXT record for the service
343
155
domain: string; Domain to publish on, default to .local if empty.
502
284
follow_name_owner_changes=True),
503
285
avahi.DBUS_INTERFACE_SERVER)
504
286
self.server.connect_to_signal("StateChanged",
505
self.server_state_changed)
287
self.server_state_changed)
506
288
self.server_state_changed(self.server.GetState())
509
290
class AvahiServiceToSyslog(AvahiService):
510
def rename(self, *args, **kwargs):
511
292
"""Add the new name to the syslog messages"""
512
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
513
syslogger.setFormatter(logging.Formatter(
514
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
293
ret = AvahiService.rename(self)
294
syslogger.setFormatter(logging.Formatter
295
('Mandos (%s) [%%(process)d]:'
296
' %%(levelname)s: %%(message)s'
519
# Pretend that we have a GnuTLS module
521
"""This isn't so much a class as it is a module-like namespace."""
523
library = ctypes.util.find_library("gnutls")
525
library = ctypes.util.find_library("gnutls-deb0")
526
_library = ctypes.cdll.LoadLibrary(library)
529
# Unless otherwise indicated, the constants and types below are
530
# all from the gnutls/gnutls.h C header file.
541
E_NO_CERTIFICATE_FOUND = -49
546
KEYID_USE_SHA256 = 1 # gnutls/x509.h
547
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
550
class session_int(ctypes.Structure):
552
session_t = ctypes.POINTER(session_int)
554
class certificate_credentials_st(ctypes.Structure):
556
certificate_credentials_t = ctypes.POINTER(
557
certificate_credentials_st)
558
certificate_type_t = ctypes.c_int
560
class datum_t(ctypes.Structure):
561
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
562
('size', ctypes.c_uint)]
564
class openpgp_crt_int(ctypes.Structure):
566
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
567
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
568
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
569
credentials_type_t = ctypes.c_int
570
transport_ptr_t = ctypes.c_void_p
571
close_request_t = ctypes.c_int
574
class Error(Exception):
575
def __init__(self, message=None, code=None, args=()):
576
# Default usage is by a message string, but if a return
577
# code is passed, convert it to a string with
580
if message is None and code is not None:
581
message = gnutls.strerror(code)
582
return super(gnutls.Error, self).__init__(
585
class CertificateSecurityError(Error):
591
self._c_object = gnutls.certificate_credentials_t()
592
gnutls.certificate_allocate_credentials(
593
ctypes.byref(self._c_object))
594
self.type = gnutls.CRD_CERTIFICATE
597
gnutls.certificate_free_credentials(self._c_object)
600
def __init__(self, socket, credentials=None):
601
self._c_object = gnutls.session_t()
602
gnutls_flags = gnutls.CLIENT
603
if gnutls.check_version(b"3.5.6"):
604
gnutls_flags |= gnutls.NO_TICKETS
606
gnutls_flags |= gnutls.ENABLE_RAWPK
607
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
609
gnutls.set_default_priority(self._c_object)
610
gnutls.transport_set_ptr(self._c_object, socket.fileno())
611
gnutls.handshake_set_private_extensions(self._c_object,
614
if credentials is None:
615
credentials = gnutls.Credentials()
616
gnutls.credentials_set(self._c_object, credentials.type,
617
ctypes.cast(credentials._c_object,
619
self.credentials = credentials
622
gnutls.deinit(self._c_object)
625
return gnutls.handshake(self._c_object)
627
def send(self, data):
631
data_len -= gnutls.record_send(self._c_object,
636
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
638
# Error handling functions
639
def _error_code(result):
640
"""A function to raise exceptions on errors, suitable
641
for the 'restype' attribute on ctypes functions"""
644
if result == gnutls.E_NO_CERTIFICATE_FOUND:
645
raise gnutls.CertificateSecurityError(code=result)
646
raise gnutls.Error(code=result)
648
def _retry_on_error(result, func, arguments):
649
"""A function to retry on some errors, suitable
650
for the 'errcheck' attribute on ctypes functions"""
652
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
653
return _error_code(result)
654
result = func(*arguments)
657
# Unless otherwise indicated, the function declarations below are
658
# all from the gnutls/gnutls.h C header file.
661
priority_set_direct = _library.gnutls_priority_set_direct
662
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
663
ctypes.POINTER(ctypes.c_char_p)]
664
priority_set_direct.restype = _error_code
666
init = _library.gnutls_init
667
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
668
init.restype = _error_code
670
set_default_priority = _library.gnutls_set_default_priority
671
set_default_priority.argtypes = [session_t]
672
set_default_priority.restype = _error_code
674
record_send = _library.gnutls_record_send
675
record_send.argtypes = [session_t, ctypes.c_void_p,
677
record_send.restype = ctypes.c_ssize_t
678
record_send.errcheck = _retry_on_error
680
certificate_allocate_credentials = (
681
_library.gnutls_certificate_allocate_credentials)
682
certificate_allocate_credentials.argtypes = [
683
ctypes.POINTER(certificate_credentials_t)]
684
certificate_allocate_credentials.restype = _error_code
686
certificate_free_credentials = (
687
_library.gnutls_certificate_free_credentials)
688
certificate_free_credentials.argtypes = [
689
certificate_credentials_t]
690
certificate_free_credentials.restype = None
692
handshake_set_private_extensions = (
693
_library.gnutls_handshake_set_private_extensions)
694
handshake_set_private_extensions.argtypes = [session_t,
696
handshake_set_private_extensions.restype = None
698
credentials_set = _library.gnutls_credentials_set
699
credentials_set.argtypes = [session_t, credentials_type_t,
701
credentials_set.restype = _error_code
703
strerror = _library.gnutls_strerror
704
strerror.argtypes = [ctypes.c_int]
705
strerror.restype = ctypes.c_char_p
707
certificate_type_get = _library.gnutls_certificate_type_get
708
certificate_type_get.argtypes = [session_t]
709
certificate_type_get.restype = _error_code
711
certificate_get_peers = _library.gnutls_certificate_get_peers
712
certificate_get_peers.argtypes = [session_t,
713
ctypes.POINTER(ctypes.c_uint)]
714
certificate_get_peers.restype = ctypes.POINTER(datum_t)
716
global_set_log_level = _library.gnutls_global_set_log_level
717
global_set_log_level.argtypes = [ctypes.c_int]
718
global_set_log_level.restype = None
720
global_set_log_function = _library.gnutls_global_set_log_function
721
global_set_log_function.argtypes = [log_func]
722
global_set_log_function.restype = None
724
deinit = _library.gnutls_deinit
725
deinit.argtypes = [session_t]
726
deinit.restype = None
728
handshake = _library.gnutls_handshake
729
handshake.argtypes = [session_t]
730
handshake.restype = _error_code
731
handshake.errcheck = _retry_on_error
733
transport_set_ptr = _library.gnutls_transport_set_ptr
734
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
735
transport_set_ptr.restype = None
737
bye = _library.gnutls_bye
738
bye.argtypes = [session_t, close_request_t]
739
bye.restype = _error_code
740
bye.errcheck = _retry_on_error
742
check_version = _library.gnutls_check_version
743
check_version.argtypes = [ctypes.c_char_p]
744
check_version.restype = ctypes.c_char_p
746
_need_version = b"3.3.0"
747
if check_version(_need_version) is None:
748
raise self.Error("Needs GnuTLS {} or later"
749
.format(_need_version))
751
_tls_rawpk_version = b"3.6.6"
752
has_rawpk = bool(check_version(_tls_rawpk_version))
756
class pubkey_st(ctypes.Structure):
758
pubkey_t = ctypes.POINTER(pubkey_st)
760
x509_crt_fmt_t = ctypes.c_int
762
# All the function declarations below are from gnutls/abstract.h
763
pubkey_init = _library.gnutls_pubkey_init
764
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
765
pubkey_init.restype = _error_code
767
pubkey_import = _library.gnutls_pubkey_import
768
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
770
pubkey_import.restype = _error_code
772
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
773
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
774
ctypes.POINTER(ctypes.c_ubyte),
775
ctypes.POINTER(ctypes.c_size_t)]
776
pubkey_get_key_id.restype = _error_code
778
pubkey_deinit = _library.gnutls_pubkey_deinit
779
pubkey_deinit.argtypes = [pubkey_t]
780
pubkey_deinit.restype = None
782
# All the function declarations below are from gnutls/openpgp.h
784
openpgp_crt_init = _library.gnutls_openpgp_crt_init
785
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
786
openpgp_crt_init.restype = _error_code
788
openpgp_crt_import = _library.gnutls_openpgp_crt_import
789
openpgp_crt_import.argtypes = [openpgp_crt_t,
790
ctypes.POINTER(datum_t),
792
openpgp_crt_import.restype = _error_code
794
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
795
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
796
ctypes.POINTER(ctypes.c_uint)]
797
openpgp_crt_verify_self.restype = _error_code
799
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
800
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
801
openpgp_crt_deinit.restype = None
803
openpgp_crt_get_fingerprint = (
804
_library.gnutls_openpgp_crt_get_fingerprint)
805
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
809
openpgp_crt_get_fingerprint.restype = _error_code
811
if check_version(b"3.6.4"):
812
certificate_type_get2 = _library.gnutls_certificate_type_get2
813
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
814
certificate_type_get2.restype = _error_code
816
# Remove non-public functions
817
del _error_code, _retry_on_error
820
def call_pipe(connection, # : multiprocessing.Connection
821
func, *args, **kwargs):
822
"""This function is meant to be called by multiprocessing.Process
824
This function runs func(*args, **kwargs), and writes the resulting
825
return value on the provided multiprocessing.Connection.
827
connection.send(func(*args, **kwargs))
300
def _timedelta_to_milliseconds(td):
301
"Convert a datetime.timedelta() to milliseconds"
302
return ((td.days * 24 * 60 * 60 * 1000)
303
+ (td.seconds * 1000)
304
+ (td.microseconds // 1000))
306
class Client(object):
832
307
"""A representation of a client host served by this server.
835
approved: bool(); 'None' if not yet approved/disapproved
310
_approved: bool(); 'None' if not yet approved/disapproved
836
311
approval_delay: datetime.timedelta(); Time to wait for approval
837
312
approval_duration: datetime.timedelta(); Duration of one approval
838
checker: multiprocessing.Process(); a running checker process used
839
to see if the client lives. 'None' if no process is
841
checker_callback_tag: a GLib event source tag, or None
313
checker: subprocess.Popen(); a running checker process used
314
to see if the client lives.
315
'None' if no process is running.
316
checker_callback_tag: a gobject event source tag, or None
842
317
checker_command: string; External command which is run to check
843
318
if client lives. %() expansions are done at
844
319
runtime with vars(self) as dict, so that for
845
320
instance %(name)s can be used in the command.
846
checker_initiator_tag: a GLib event source tag, or None
321
checker_initiator_tag: a gobject event source tag, or None
847
322
created: datetime.datetime(); (UTC) object creation
848
323
client_structure: Object describing what attributes a client has
849
324
and is used for storing the client at exit
850
325
current_checker_command: string; current running checker_command
851
disable_initiator_tag: a GLib event source tag, or None
326
disable_initiator_tag: a gobject event source tag, or None
853
328
fingerprint: string (40 or 32 hexadecimal digits); used to
854
uniquely identify an OpenPGP client
855
key_id: string (64 hexadecimal digits); used to uniquely identify
856
a client using raw public keys
329
uniquely identify the client
857
330
host: string; available for use by the checker command
858
331
interval: datetime.timedelta(); How often to start a new checker
859
332
last_approval_request: datetime.datetime(); (UTC) or None
860
333
last_checked_ok: datetime.datetime(); (UTC) or None
861
last_checker_status: integer between 0 and 255 reflecting exit
862
status of last checker. -1 reflects crashed
863
checker, -2 means no checker completed yet.
864
last_checker_signal: The signal which killed the last checker, if
865
last_checker_status is -1
866
last_enabled: datetime.datetime(); (UTC) or None
334
last_checker_status: integer between 0 and 255 reflecting exit status
335
of last checker. -1 reflect crashed checker,
337
last_enabled: datetime.datetime(); (UTC)
867
338
name: string; from the config file, used in log messages and
868
339
D-Bus identifiers
869
340
secret: bytestring; sent verbatim (over TLS) to client
870
341
timeout: datetime.timedelta(); How long from last_checked_ok
871
342
until this client is disabled
872
extended_timeout: extra long timeout when secret has been sent
343
extended_timeout: extra long timeout when password has been sent
873
344
runtime_expansions: Allowed attributes for runtime expansion.
874
345
expires: datetime.datetime(); time (UTC) when a client will be
875
346
disabled, or None
876
server_settings: The server_settings dict from main()
879
349
runtime_expansions = ("approval_delay", "approval_duration",
880
"created", "enabled", "expires", "key_id",
881
"fingerprint", "host", "interval",
882
"last_approval_request", "last_checked_ok",
350
"created", "enabled", "fingerprint",
351
"host", "interval", "last_checked_ok",
883
352
"last_enabled", "name", "timeout")
886
"extended_timeout": "PT15M",
888
"checker": "fping -q -- %%(host)s",
890
"approval_delay": "PT0S",
891
"approval_duration": "PT1S",
892
"approved_by_default": "True",
897
def config_parser(config):
898
"""Construct a new dict of client settings of this form:
899
{ client_name: {setting_name: value, ...}, ...}
900
with exceptions for any special settings as defined above.
901
NOTE: Must be a pure function. Must return the same result
902
value given the same arguments.
905
for client_name in config.sections():
906
section = dict(config.items(client_name))
907
client = settings[client_name] = {}
909
client["host"] = section["host"]
910
# Reformat values from string types to Python types
911
client["approved_by_default"] = config.getboolean(
912
client_name, "approved_by_default")
913
client["enabled"] = config.getboolean(client_name,
916
# Uppercase and remove spaces from key_id and fingerprint
917
# for later comparison purposes with return value from the
918
# key_id() and fingerprint() functions
919
client["key_id"] = (section.get("key_id", "").upper()
921
client["fingerprint"] = (section["fingerprint"].upper()
923
if "secret" in section:
924
client["secret"] = codecs.decode(section["secret"]
927
elif "secfile" in section:
928
with open(os.path.expanduser(os.path.expandvars
929
(section["secfile"])),
931
client["secret"] = secfile.read()
933
raise TypeError("No secret or secfile for section {}"
935
client["timeout"] = string_to_delta(section["timeout"])
936
client["extended_timeout"] = string_to_delta(
937
section["extended_timeout"])
938
client["interval"] = string_to_delta(section["interval"])
939
client["approval_delay"] = string_to_delta(
940
section["approval_delay"])
941
client["approval_duration"] = string_to_delta(
942
section["approval_duration"])
943
client["checker_command"] = section["checker"]
944
client["last_approval_request"] = None
945
client["last_checked_ok"] = None
946
client["last_checker_status"] = -2
950
def __init__(self, settings, name=None, server_settings=None):
354
def timeout_milliseconds(self):
355
"Return the 'timeout' attribute in milliseconds"
356
return _timedelta_to_milliseconds(self.timeout)
358
def extended_timeout_milliseconds(self):
359
"Return the 'extended_timeout' attribute in milliseconds"
360
return _timedelta_to_milliseconds(self.extended_timeout)
362
def interval_milliseconds(self):
363
"Return the 'interval' attribute in milliseconds"
364
return _timedelta_to_milliseconds(self.interval)
366
def approval_delay_milliseconds(self):
367
return _timedelta_to_milliseconds(self.approval_delay)
369
def __init__(self, name = None, config=None):
370
"""Note: the 'checker' key in 'config' sets the
371
'checker_command' attribute and *not* the 'checker'
952
if server_settings is None:
954
self.server_settings = server_settings
955
# adding all client settings
956
for setting, value in settings.items():
957
setattr(self, setting, value)
960
if not hasattr(self, "last_enabled"):
961
self.last_enabled = datetime.datetime.utcnow()
962
if not hasattr(self, "expires"):
963
self.expires = (datetime.datetime.utcnow()
966
self.last_enabled = None
969
376
logger.debug("Creating client %r", self.name)
970
logger.debug(" Key ID: %s", self.key_id)
377
# Uppercase and remove spaces from fingerprint for later
378
# comparison purposes with return value from the fingerprint()
380
self.fingerprint = (config["fingerprint"].upper()
971
382
logger.debug(" Fingerprint: %s", self.fingerprint)
972
self.created = settings.get("created",
973
datetime.datetime.utcnow())
975
# attributes specific for this server instance
383
if "secret" in config:
384
self.secret = config["secret"].decode("base64")
385
elif "secfile" in config:
386
with open(os.path.expanduser(os.path.expandvars
387
(config["secfile"])),
389
self.secret = secfile.read()
391
raise TypeError("No secret or secfile for client %s"
393
self.host = config.get("host", "")
394
self.created = datetime.datetime.utcnow()
396
self.last_approval_request = None
397
self.last_enabled = datetime.datetime.utcnow()
398
self.last_checked_ok = None
399
self.last_checker_status = None
400
self.timeout = string_to_delta(config["timeout"])
401
self.extended_timeout = string_to_delta(config
402
["extended_timeout"])
403
self.interval = string_to_delta(config["interval"])
976
404
self.checker = None
977
405
self.checker_initiator_tag = None
978
406
self.disable_initiator_tag = None
407
self.expires = datetime.datetime.utcnow() + self.timeout
979
408
self.checker_callback_tag = None
409
self.checker_command = config["checker"]
980
410
self.current_checker_command = None
411
self._approved = None
412
self.approved_by_default = config.get("approved_by_default",
982
414
self.approvals_pending = 0
983
self.changedstate = multiprocessing_manager.Condition(
984
multiprocessing_manager.Lock())
985
self.client_structure = [attr
986
for attr in self.__dict__.keys()
987
if not attr.startswith("_")]
415
self.approval_delay = string_to_delta(
416
config["approval_delay"])
417
self.approval_duration = string_to_delta(
418
config["approval_duration"])
419
self.changedstate = (multiprocessing_manager
420
.Condition(multiprocessing_manager
422
self.client_structure = [attr for attr in self.__dict__.iterkeys() if not attr.startswith("_")]
988
423
self.client_structure.append("client_structure")
990
for name, t in inspect.getmembers(
991
type(self), lambda obj: isinstance(obj, property)):
426
for name, t in inspect.getmembers(type(self),
427
lambda obj: isinstance(obj, property)):
992
428
if not name.startswith("_"):
993
429
self.client_structure.append(name)
995
431
# Send notice to process children that client state has changed
996
432
def send_changedstate(self):
997
433
with self.changedstate:
998
434
self.changedstate.notify_all()
1000
436
def enable(self):
1001
437
"""Start this client's checker and timeout hooks"""
1002
438
if getattr(self, "enabled", False):
1003
439
# Already enabled
441
self.send_changedstate()
1005
442
self.expires = datetime.datetime.utcnow() + self.timeout
1006
443
self.enabled = True
1007
444
self.last_enabled = datetime.datetime.utcnow()
1008
445
self.init_checker()
1009
self.send_changedstate()
1011
447
def disable(self, quiet=True):
1012
448
"""Disable this client."""
1013
449
if not getattr(self, "enabled", False):
452
self.send_changedstate()
1016
454
logger.info("Disabling client %s", self.name)
1017
if getattr(self, "disable_initiator_tag", None) is not None:
1018
GLib.source_remove(self.disable_initiator_tag)
455
if getattr(self, "disable_initiator_tag", False):
456
gobject.source_remove(self.disable_initiator_tag)
1019
457
self.disable_initiator_tag = None
1020
458
self.expires = None
1021
if getattr(self, "checker_initiator_tag", None) is not None:
1022
GLib.source_remove(self.checker_initiator_tag)
459
if getattr(self, "checker_initiator_tag", False):
460
gobject.source_remove(self.checker_initiator_tag)
1023
461
self.checker_initiator_tag = None
1024
462
self.stop_checker()
1025
463
self.enabled = False
1027
self.send_changedstate()
1028
# Do not run this again if called by a GLib.timeout_add
464
# Do not run this again if called by a gobject.timeout_add
1031
467
def __del__(self):
1034
470
def init_checker(self):
1035
471
# Schedule a new checker to be started an 'interval' from now,
1036
472
# and every interval from then on.
1037
if self.checker_initiator_tag is not None:
1038
GLib.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = GLib.timeout_add(
1040
int(self.interval.total_seconds() * 1000),
473
self.checker_initiator_tag = (gobject.timeout_add
474
(self.interval_milliseconds(),
1042
476
# Schedule a disable() when 'timeout' has passed
1043
if self.disable_initiator_tag is not None:
1044
GLib.source_remove(self.disable_initiator_tag)
1045
self.disable_initiator_tag = GLib.timeout_add(
1046
int(self.timeout.total_seconds() * 1000), self.disable)
477
self.disable_initiator_tag = (gobject.timeout_add
478
(self.timeout_milliseconds(),
1047
480
# Also start a new checker *right now*.
1048
481
self.start_checker()
1050
def checker_callback(self, source, condition, connection,
484
def checker_callback(self, pid, condition, command):
1052
485
"""The checker has completed, so take appropriate actions."""
1053
# Read return code from connection (see call_pipe)
1054
returncode = connection.recv()
1057
486
self.checker_callback_tag = None
1058
487
self.checker = None
1061
self.last_checker_status = returncode
1062
self.last_checker_signal = None
488
if os.WIFEXITED(condition):
489
self.last_checker_status = os.WEXITSTATUS(condition)
1063
490
if self.last_checker_status == 0:
1064
491
logger.info("Checker for %(name)s succeeded",
1066
493
self.checked_ok()
1068
logger.info("Checker for %(name)s failed", vars(self))
495
logger.info("Checker for %(name)s failed",
1070
498
self.last_checker_status = -1
1071
self.last_checker_signal = -returncode
1072
499
logger.warning("Checker for %(name)s crashed?",
1076
def checked_ok(self):
1077
"""Assert that the client has been seen, alive and well."""
1078
self.last_checked_ok = datetime.datetime.utcnow()
1079
self.last_checker_status = 0
1080
self.last_checker_signal = None
1083
def bump_timeout(self, timeout=None):
1084
"""Bump up the timeout for this client."""
502
def checked_ok(self, timeout=None):
503
"""Bump up the timeout for this client.
505
This should only be called when the client has been seen,
1085
508
if timeout is None:
1086
509
timeout = self.timeout
510
self.last_checked_ok = datetime.datetime.utcnow()
1087
511
if self.disable_initiator_tag is not None:
1088
GLib.source_remove(self.disable_initiator_tag)
1089
self.disable_initiator_tag = None
512
gobject.source_remove(self.disable_initiator_tag)
1090
513
if getattr(self, "enabled", False):
1091
self.disable_initiator_tag = GLib.timeout_add(
1092
int(timeout.total_seconds() * 1000), self.disable)
514
self.disable_initiator_tag = (gobject.timeout_add
515
(_timedelta_to_milliseconds
516
(timeout), self.disable))
1093
517
self.expires = datetime.datetime.utcnow() + timeout
1095
519
def need_approval(self):
1096
520
self.last_approval_request = datetime.datetime.utcnow()
1098
522
def start_checker(self):
1099
523
"""Start a new checker subprocess if one is not running.
1101
525
If a checker already exists, leave it running and do
1103
527
# The reason for not killing a running checker is that if we
1104
# did that, and if a checker (for some reason) started running
1105
# slowly and taking more than 'interval' time, then the client
1106
# would inevitably timeout, since no checker would get a
1107
# chance to run to completion. If we instead leave running
528
# did that, then if a checker (for some reason) started
529
# running slowly and taking more than 'interval' time, the
530
# client would inevitably timeout, since no checker would get
531
# a chance to run to completion. If we instead leave running
1108
532
# checkers alone, the checker would have to take more time
1109
533
# than 'timeout' for the client to be disabled, which is as it
1112
if self.checker is not None and not self.checker.is_alive():
1113
logger.warning("Checker was not alive; joining")
536
# If a checker exists, make sure it is not a zombie
538
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
539
except (AttributeError, OSError) as error:
540
if (isinstance(error, OSError)
541
and error.errno != errno.ECHILD):
545
logger.warning("Checker was a zombie")
546
gobject.source_remove(self.checker_callback_tag)
547
self.checker_callback(pid, status,
548
self.current_checker_command)
1116
549
# Start a new checker if needed
1117
550
if self.checker is None:
1118
# Escape attributes for the shell
1120
attr: re.escape(str(getattr(self, attr)))
1121
for attr in self.runtime_expansions}
1123
command = self.checker_command % escaped_attrs
1124
except TypeError as error:
1125
logger.error('Could not format string "%s"',
1126
self.checker_command,
1128
return True # Try again later
552
# In case checker_command has exactly one % operator
553
command = self.checker_command % self.host
555
# Escape attributes for the shell
556
escaped_attrs = dict(
558
re.escape(unicode(str(getattr(self, attr, "")),
562
self.runtime_expansions)
565
command = self.checker_command % escaped_attrs
566
except TypeError as error:
567
logger.error('Could not format string "%s":'
568
' %s', self.checker_command, error)
569
return True # Try again later
1129
570
self.current_checker_command = command
1130
logger.info("Starting checker %r for %s", command,
1132
# We don't need to redirect stdout and stderr, since
1133
# in normal mode, that is already done by daemon(),
1134
# and in debug mode we don't want to. (Stdin is
1135
# always replaced by /dev/null.)
1136
# The exception is when not debugging but nevertheless
1137
# running in the foreground; use the previously
1139
popen_args = {"close_fds": True,
1142
if (not self.server_settings["debug"]
1143
and self.server_settings["foreground"]):
1144
popen_args.update({"stdout": wnull,
1146
pipe = multiprocessing.Pipe(duplex=False)
1147
self.checker = multiprocessing.Process(
1149
args=(pipe[1], subprocess.call, command),
1151
self.checker.start()
1152
self.checker_callback_tag = GLib.io_add_watch(
1153
pipe[0].fileno(), GLib.IO_IN,
1154
self.checker_callback, pipe[0], command)
1155
# Re-run this periodically if run by GLib.timeout_add
572
logger.info("Starting checker %r for %s",
574
# We don't need to redirect stdout and stderr, since
575
# in normal mode, that is already done by daemon(),
576
# and in debug mode we don't want to. (Stdin is
577
# always replaced by /dev/null.)
578
self.checker = subprocess.Popen(command,
581
self.checker_callback_tag = (gobject.child_watch_add
583
self.checker_callback,
585
# The checker may have completed before the gobject
586
# watch was added. Check for this.
587
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
589
gobject.source_remove(self.checker_callback_tag)
590
self.checker_callback(pid, status, command)
591
except OSError as error:
592
logger.error("Failed to start subprocess: %s",
594
# Re-run this periodically if run by gobject.timeout_add
1158
597
def stop_checker(self):
1159
598
"""Force the checker process, if any, to stop."""
1160
599
if self.checker_callback_tag:
1161
GLib.source_remove(self.checker_callback_tag)
600
gobject.source_remove(self.checker_callback_tag)
1162
601
self.checker_callback_tag = None
1163
602
if getattr(self, "checker", None) is None:
1165
604
logger.debug("Stopping checker for %(name)s", vars(self))
1166
self.checker.terminate()
606
os.kill(self.checker.pid, signal.SIGTERM)
608
#if self.checker.poll() is None:
609
# os.kill(self.checker.pid, signal.SIGKILL)
610
except OSError as error:
611
if error.errno != errno.ESRCH: # No such process
1167
613
self.checker = None
1170
def dbus_service_property(dbus_interface,
615
# Encrypts a client secret and stores it in a varible encrypted_secret
616
def encrypt_secret(self, key):
617
# Encryption-key need to be of a specific size, so we hash inputed key
618
hasheng = hashlib.sha256()
620
encryptionkey = hasheng.digest()
622
# Create validation hash so we know at decryption if it was sucessful
623
hasheng = hashlib.sha256()
624
hasheng.update(self.secret)
625
validationhash = hasheng.digest()
628
iv = os.urandom(Crypto.Cipher.AES.block_size)
629
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
630
Crypto.Cipher.AES.MODE_CFB, iv)
631
ciphertext = ciphereng.encrypt(validationhash+self.secret)
632
self.encrypted_secret = (ciphertext, iv)
634
# Decrypt a encrypted client secret
635
def decrypt_secret(self, key):
636
# Decryption-key need to be of a specific size, so we hash inputed key
637
hasheng = hashlib.sha256()
639
encryptionkey = hasheng.digest()
641
# Decrypt encrypted secret
642
ciphertext, iv = self.encrypted_secret
643
ciphereng = Crypto.Cipher.AES.new(encryptionkey,
644
Crypto.Cipher.AES.MODE_CFB, iv)
645
plain = ciphereng.decrypt(ciphertext)
647
# Validate decrypted secret to know if it was succesful
648
hasheng = hashlib.sha256()
649
validationhash = plain[:hasheng.digest_size]
650
secret = plain[hasheng.digest_size:]
651
hasheng.update(secret)
653
# if validation fails, we use key as new secret. Otherwhise, we use
654
# the decrypted secret
655
if hasheng.digest() == validationhash:
659
del self.encrypted_secret
662
def dbus_service_property(dbus_interface, signature="v",
663
access="readwrite", byte_arrays=False):
1174
664
"""Decorators for marking methods of a DBusObjectWithProperties to
1175
665
become properties on the D-Bus.
1177
667
The decorated method will be called with no arguments by "Get"
1178
668
and with one argument by "Set".
1180
670
The parameters, where they are supported, are the same as
1181
671
dbus.service.method, except there is only "signature", since the
1182
672
type from Get() and the type sent to Set() is the same.
1515
842
except (AttributeError, xml.dom.DOMException,
1516
843
xml.parsers.expat.ExpatError) as error:
1517
844
logger.error("Failed to override Introspection method",
1523
dbus.OBJECT_MANAGER_IFACE
1524
except AttributeError:
1525
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1528
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1529
"""A D-Bus object with an ObjectManager.
1531
Classes inheriting from this exposes the standard
1532
GetManagedObjects call and the InterfacesAdded and
1533
InterfacesRemoved signals on the standard
1534
"org.freedesktop.DBus.ObjectManager" interface.
1536
Note: No signals are sent automatically; they must be sent
1539
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1540
out_signature="a{oa{sa{sv}}}")
1541
def GetManagedObjects(self):
1542
"""This function must be overridden"""
1543
raise NotImplementedError()
1545
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1546
signature="oa{sa{sv}}")
1547
def InterfacesAdded(self, object_path, interfaces_and_properties):
1550
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1551
def InterfacesRemoved(self, object_path, interfaces):
1554
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1556
path_keyword='object_path',
1557
connection_keyword='connection')
1558
def Introspect(self, object_path, connection):
1559
"""Overloading of standard D-Bus method.
1561
Override return argument name of GetManagedObjects to be
1562
"objpath_interfaces_and_properties"
1564
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1568
document = xml.dom.minidom.parseString(xmlstring)
1570
for if_tag in document.getElementsByTagName("interface"):
1571
# Fix argument name for the GetManagedObjects method
1572
if (if_tag.getAttribute("name")
1573
== dbus.OBJECT_MANAGER_IFACE):
1574
for cn in if_tag.getElementsByTagName("method"):
1575
if (cn.getAttribute("name")
1576
== "GetManagedObjects"):
1577
for arg in cn.getElementsByTagName("arg"):
1578
if (arg.getAttribute("direction")
1582
"objpath_interfaces"
1584
xmlstring = document.toxml("utf-8")
1586
except (AttributeError, xml.dom.DOMException,
1587
xml.parsers.expat.ExpatError) as error:
1588
logger.error("Failed to override Introspection method",
1593
def datetime_to_dbus(dt, variant_level=0):
849
def datetime_to_dbus (dt, variant_level=0):
1594
850
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1596
return dbus.String("", variant_level=variant_level)
1597
return dbus.String(dt.isoformat(), variant_level=variant_level)
1600
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1601
"""A class decorator; applied to a subclass of
1602
dbus.service.Object, it will add alternate D-Bus attributes with
1603
interface names according to the "alt_interface_names" mapping.
1606
@alternate_dbus_interfaces({"org.example.Interface":
1607
"net.example.AlternateInterface"})
1608
class SampleDBusObject(dbus.service.Object):
1609
@dbus.service.method("org.example.Interface")
1610
def SampleDBusMethod():
1613
The above "SampleDBusMethod" on "SampleDBusObject" will be
1614
reachable via two interfaces: "org.example.Interface" and
1615
"net.example.AlternateInterface", the latter of which will have
1616
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1617
"true", unless "deprecate" is passed with a False value.
1619
This works for methods and signals, and also for D-Bus properties
1620
(from DBusObjectWithProperties) and interfaces (from the
1621
dbus_interface_annotations decorator).
852
return dbus.String("", variant_level = variant_level)
853
return dbus.String(dt.isoformat(),
854
variant_level=variant_level)
856
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
858
"""Applied to an empty subclass of a D-Bus object, this metaclass
859
will add additional D-Bus attributes matching a certain pattern.
1625
for orig_interface_name, alt_interface_name in (
1626
alt_interface_names.items()):
1628
interface_names = set()
1629
# Go though all attributes of the class
1630
for attrname, attribute in inspect.getmembers(cls):
861
def __new__(mcs, name, bases, attr):
862
# Go through all the base classes which could have D-Bus
863
# methods, signals, or properties in them
864
for base in (b for b in bases
865
if issubclass(b, dbus.service.Object)):
866
# Go though all attributes of the base class
867
for attrname, attribute in inspect.getmembers(base):
1631
868
# Ignore non-D-Bus attributes, and D-Bus attributes
1632
869
# with the wrong interface name
1633
870
if (not hasattr(attribute, "_dbus_interface")
1634
or not attribute._dbus_interface.startswith(
1635
orig_interface_name)):
871
or not attribute._dbus_interface
872
.startswith("se.recompile.Mandos")):
1637
874
# Create an alternate D-Bus interface name based on
1638
875
# the current name
1639
alt_interface = attribute._dbus_interface.replace(
1640
orig_interface_name, alt_interface_name)
1641
interface_names.add(alt_interface)
876
alt_interface = (attribute._dbus_interface
877
.replace("se.recompile.Mandos",
878
"se.bsnet.fukt.Mandos"))
1642
879
# Is this a D-Bus signal?
1643
880
if getattr(attribute, "_dbus_is_signal", False):
1644
# Extract the original non-method undecorated
1645
# function by black magic
1646
if sys.version_info.major == 2:
1647
nonmethod_func = (dict(
881
# Extract the original non-method function by
883
nonmethod_func = (dict(
1648
884
zip(attribute.func_code.co_freevars,
1649
attribute.__closure__))
1650
["func"].cell_contents)
1652
nonmethod_func = (dict(
1653
zip(attribute.__code__.co_freevars,
1654
attribute.__closure__))
1655
["func"].cell_contents)
885
attribute.__closure__))["func"]
1656
887
# Create a new, but exactly alike, function
1657
888
# object, and decorate it to be a new D-Bus signal
1658
889
# with the alternate D-Bus interface name
1659
new_function = copy_function(nonmethod_func)
1660
new_function = (dbus.service.signal(
1662
attribute._dbus_signature)(new_function))
1663
# Copy annotations, if any
1665
new_function._dbus_annotations = dict(
1666
attribute._dbus_annotations)
1667
except AttributeError:
890
new_function = (dbus.service.signal
892
attribute._dbus_signature)
894
nonmethod_func.func_code,
895
nonmethod_func.func_globals,
896
nonmethod_func.func_name,
897
nonmethod_func.func_defaults,
898
nonmethod_func.func_closure)))
1670
899
# Define a creator of a function to call both the
1671
# original and alternate functions, so both the
1672
# original and alternate signals gets sent when
1673
# the function is called
900
# old and new functions, so both the old and new
901
# signals gets sent when the function is called
1674
902
def fixscope(func1, func2):
1675
903
"""This function is a scope container to pass
1676
904
func1 and func2 to the "call_both" function
1677
905
outside of its arguments"""
1679
@functools.wraps(func2)
1680
906
def call_both(*args, **kwargs):
1681
907
"""This function will emit two D-Bus
1682
908
signals by calling func1 and func2"""
1683
909
func1(*args, **kwargs)
1684
910
func2(*args, **kwargs)
1685
# Make wrapper function look like a D-Bus
1687
for name, attr in inspect.getmembers(func2):
1688
if name.startswith("_dbus_"):
1689
setattr(call_both, name, attr)
1691
911
return call_both
1692
912
# Create the "call_both" function and add it to
1694
attr[attrname] = fixscope(attribute, new_function)
914
attr[attrname] = fixscope(attribute,
1695
916
# Is this a D-Bus method?
1696
917
elif getattr(attribute, "_dbus_is_method", False):
1697
918
# Create a new, but exactly alike, function
1698
919
# object. Decorate it to be a new D-Bus method
1699
920
# with the alternate D-Bus interface name. Add it
1702
dbus.service.method(
1704
attribute._dbus_in_signature,
1705
attribute._dbus_out_signature)
1706
(copy_function(attribute)))
1707
# Copy annotations, if any
1709
attr[attrname]._dbus_annotations = dict(
1710
attribute._dbus_annotations)
1711
except AttributeError:
922
attr[attrname] = (dbus.service.method
924
attribute._dbus_in_signature,
925
attribute._dbus_out_signature)
927
(attribute.func_code,
928
attribute.func_globals,
930
attribute.func_defaults,
931
attribute.func_closure)))
1713
932
# Is this a D-Bus property?
1714
933
elif getattr(attribute, "_dbus_is_property", False):
1715
934
# Create a new, but exactly alike, function
1716
935
# object, and decorate it to be a new D-Bus
1717
936
# property with the alternate D-Bus interface
1718
937
# name. Add it to the class.
1719
attr[attrname] = (dbus_service_property(
1720
alt_interface, attribute._dbus_signature,
1721
attribute._dbus_access,
1722
attribute._dbus_get_args_options
1724
(copy_function(attribute)))
1725
# Copy annotations, if any
1727
attr[attrname]._dbus_annotations = dict(
1728
attribute._dbus_annotations)
1729
except AttributeError:
1731
# Is this a D-Bus interface?
1732
elif getattr(attribute, "_dbus_is_interface", False):
1733
# Create a new, but exactly alike, function
1734
# object. Decorate it to be a new D-Bus interface
1735
# with the alternate D-Bus interface name. Add it
1738
dbus_interface_annotations(alt_interface)
1739
(copy_function(attribute)))
1741
# Deprecate all alternate interfaces
1742
iname = "_AlternateDBusNames_interface_annotation{}"
1743
for interface_name in interface_names:
1745
@dbus_interface_annotations(interface_name)
1747
return {"org.freedesktop.DBus.Deprecated":
1749
# Find an unused name
1750
for aname in (iname.format(i)
1751
for i in itertools.count()):
1752
if aname not in attr:
1756
# Replace the class with a new subclass of it with
1757
# methods, signals, etc. as created above.
1758
if sys.version_info.major == 2:
1759
cls = type(b"{}Alternate".format(cls.__name__),
1762
cls = type("{}Alternate".format(cls.__name__),
1769
@alternate_dbus_interfaces({"se.recompile.Mandos":
1770
"se.bsnet.fukt.Mandos"})
938
attr[attrname] = (dbus_service_property
940
attribute._dbus_signature,
941
attribute._dbus_access,
943
._dbus_get_args_options
946
(attribute.func_code,
947
attribute.func_globals,
949
attribute.func_defaults,
950
attribute.func_closure)))
951
return type.__new__(mcs, name, bases, attr)
1771
953
class ClientDBus(Client, DBusObjectWithProperties):
1772
954
"""A Client class using D-Bus
1775
957
dbus_object_path: dbus.ObjectPath
1776
958
bus: dbus.SystemBus()
1779
961
runtime_expansions = (Client.runtime_expansions
1780
+ ("dbus_object_path", ))
1782
_interface = "se.recompile.Mandos.Client"
962
+ ("dbus_object_path",))
1784
964
# dbus.service.Object doesn't use super(), so we can't either.
1786
def __init__(self, bus=None, *args, **kwargs):
966
def __init__(self, bus = None, *args, **kwargs):
1788
968
Client.__init__(self, *args, **kwargs)
970
self._approvals_pending = 0
1789
971
# Only now, when this client is initialized, can it show up on
1791
client_object_name = str(self.name).translate(
973
client_object_name = unicode(self.name).translate(
1792
974
{ord("."): ord("_"),
1793
975
ord("-"): ord("_")})
1794
self.dbus_object_path = dbus.ObjectPath(
1795
"/clients/" + client_object_name)
976
self.dbus_object_path = (dbus.ObjectPath
977
("/clients/" + client_object_name))
1796
978
DBusObjectWithProperties.__init__(self, self.bus,
1797
979
self.dbus_object_path)
1799
def notifychangeproperty(transform_func, dbus_name,
1800
type_func=lambda x: x,
1802
invalidate_only=False,
1803
_interface=_interface):
981
def notifychangeproperty(transform_func,
982
dbus_name, type_func=lambda x: x,
1804
984
""" Modify a variable so that it's a property which announces
1805
985
its changes to DBus.
2200
1345
self.start_checker()
2202
1347
self.stop_checker()
2204
1349
# ObjectPath - property
2206
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2207
"org.freedesktop.DBus.Deprecated": "true"})
2208
1350
@dbus_service_property(_interface, signature="o", access="read")
2209
1351
def ObjectPath_dbus_property(self):
2210
return self.dbus_object_path # is already a dbus.ObjectPath
1352
return self.dbus_object_path # is already a dbus.ObjectPath
2212
1354
# Secret = property
2214
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2216
@dbus_service_property(_interface,
1355
@dbus_service_property(_interface, signature="ay",
1356
access="write", byte_arrays=True)
2220
1357
def Secret_dbus_property(self, value):
2221
self.secret = bytes(value)
1358
self.secret = str(value)
2227
def __init__(self, child_pipe, key_id, fpr, address):
1363
class ProxyClient(object):
1364
def __init__(self, child_pipe, fpr, address):
2228
1365
self._pipe = child_pipe
2229
self._pipe.send(('init', key_id, fpr, address))
1366
self._pipe.send(('init', fpr, address))
2230
1367
if not self._pipe.recv():
2231
raise KeyError(key_id or fpr)
2233
1370
def __getattribute__(self, name):
1371
if(name == '_pipe'):
2235
1372
return super(ProxyClient, self).__getattribute__(name)
2236
1373
self._pipe.send(('getattr', name))
2237
1374
data = self._pipe.recv()
2238
1375
if data[0] == 'data':
2240
1377
if data[0] == 'function':
2242
1378
def func(*args, **kwargs):
2243
1379
self._pipe.send(('funcall', name, args, kwargs))
2244
1380
return self._pipe.recv()[1]
2248
1383
def __setattr__(self, name, value):
1384
if(name == '_pipe'):
2250
1385
return super(ProxyClient, self).__setattr__(name, value)
2251
1386
self._pipe.send(('setattr', name, value))
1388
class ClientDBusTransitional(ClientDBus):
1389
__metaclass__ = AlternateDBusNamesMetaclass
2254
1391
class ClientHandler(socketserver.BaseRequestHandler, object):
2255
1392
"""A class to handle client connections.
2257
1394
Instantiated once for each connection to handle it.
2258
1395
Note: This will run in its own forked process."""
2260
1397
def handle(self):
2261
1398
with contextlib.closing(self.server.child_pipe) as child_pipe:
2262
1399
logger.info("TCP connection from: %s",
2263
str(self.client_address))
1400
unicode(self.client_address))
2264
1401
logger.debug("Pipe FD: %d",
2265
1402
self.server.child_pipe.fileno())
2267
session = gnutls.ClientSession(self.request)
2269
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2270
# "+AES-256-CBC", "+SHA1",
2271
# "+COMP-NULL", "+CTYPE-OPENPGP",
1404
session = (gnutls.connection
1405
.ClientSession(self.request,
1407
.X509Credentials()))
1409
# Note: gnutls.connection.X509Credentials is really a
1410
# generic GnuTLS certificate credentials object so long as
1411
# no X.509 keys are added to it. Therefore, we can use it
1412
# here despite using OpenPGP certificates.
1414
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1415
# "+AES-256-CBC", "+SHA1",
1416
# "+COMP-NULL", "+CTYPE-OPENPGP",
2273
1418
# Use a fallback default, since this MUST be set.
2274
1419
priority = self.server.gnutls_priority
2275
1420
if priority is None:
2276
1421
priority = "NORMAL"
2277
gnutls.priority_set_direct(session._c_object,
2278
priority.encode("utf-8"),
1422
(gnutls.library.functions
1423
.gnutls_priority_set_direct(session._c_object,
2281
1426
# Start communication using the Mandos protocol
2282
1427
# Get protocol number
2283
1428
line = self.request.makefile().readline()
2284
1429
logger.debug("Protocol version: %r", line)
2286
1431
if int(line.strip().split()[0]) > 1:
2287
raise RuntimeError(line)
2288
1433
except (ValueError, IndexError, RuntimeError) as error:
2289
1434
logger.error("Unknown protocol version: %s", error)
2292
1437
# Start GnuTLS connection
2294
1439
session.handshake()
2295
except gnutls.Error as error:
1440
except gnutls.errors.GNUTLSError as error:
2296
1441
logger.warning("Handshake failed: %s", error)
2297
1442
# Do not run session.bye() here: the session is not
2298
1443
# established. Just abandon the request.
2300
1445
logger.debug("Handshake succeeded")
2302
1447
approval_required = False
2304
if gnutls.has_rawpk:
2307
key_id = self.key_id(
2308
self.peer_certificate(session))
2309
except (TypeError, gnutls.Error) as error:
2310
logger.warning("Bad certificate: %s", error)
2312
logger.debug("Key ID: %s", key_id)
2317
fpr = self.fingerprint(
2318
self.peer_certificate(session))
2319
except (TypeError, gnutls.Error) as error:
2320
logger.warning("Bad certificate: %s", error)
2322
logger.debug("Fingerprint: %s", fpr)
2325
client = ProxyClient(child_pipe, key_id, fpr,
1450
fpr = self.fingerprint(self.peer_certificate
1453
gnutls.errors.GNUTLSError) as error:
1454
logger.warning("Bad certificate: %s", error)
1456
logger.debug("Fingerprint: %s", fpr)
1457
if self.server.use_dbus:
1459
client.NewRequest(str(self.client_address))
1462
client = ProxyClient(child_pipe, fpr,
2326
1463
self.client_address)
2327
1464
except KeyError:
2330
1467
if client.approval_delay:
2331
1468
delay = client.approval_delay
2332
1469
client.approvals_pending += 1
2333
1470
approval_required = True
2336
1473
if not client.enabled:
2337
1474
logger.info("Client %s is disabled",
2339
1476
if self.server.use_dbus:
2340
1477
# Emit D-Bus signal
2341
1478
client.Rejected("Disabled")
2344
if client.approved or not client.approval_delay:
2345
# We are approved or approval is disabled
1481
if client._approved or not client.approval_delay:
1482
#We are approved or approval is disabled
2347
elif client.approved is None:
1484
elif client._approved is None:
2348
1485
logger.info("Client %s needs approval",
2350
1487
if self.server.use_dbus:
2351
1488
# Emit D-Bus signal
2352
1489
client.NeedApproval(
2353
client.approval_delay.total_seconds()
2354
* 1000, client.approved_by_default)
1490
client.approval_delay_milliseconds(),
1491
client.approved_by_default)
2356
1493
logger.warning("Client %s was not approved",
2381
1520
delay -= time2 - time
2384
session.send(client.secret)
2385
except gnutls.Error as error:
2386
logger.warning("gnutls send failed",
1523
while sent_size < len(client.secret):
1525
sent = session.send(client.secret[sent_size:])
1526
except gnutls.errors.GNUTLSError as error:
1527
logger.warning("gnutls send failed")
1529
logger.debug("Sent: %d, remaining: %d",
1530
sent, len(client.secret)
1531
- (sent_size + sent))
2390
1534
logger.info("Sending secret to %s", client.name)
2391
1535
# bump the timeout using extended_timeout
2392
client.bump_timeout(client.extended_timeout)
1536
client.checked_ok(client.extended_timeout)
2393
1537
if self.server.use_dbus:
2394
1538
# Emit D-Bus signal
2395
1539
client.GotSecret()
2398
1542
if approval_required:
2399
1543
client.approvals_pending -= 1
2402
except gnutls.Error as error:
2403
logger.warning("GnuTLS bye failed",
1546
except gnutls.errors.GNUTLSError as error:
1547
logger.warning("GnuTLS bye failed")
2407
1550
def peer_certificate(session):
2408
"Return the peer's certificate as a bytestring"
2410
cert_type = gnutls.certificate_type_get2(session._c_object,
2412
except AttributeError:
2413
cert_type = gnutls.certificate_type_get(session._c_object)
2414
if gnutls.has_rawpk:
2415
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2417
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2418
# If not a valid certificate type...
2419
if cert_type not in valid_cert_types:
2420
logger.info("Cert type %r not in %r", cert_type,
2422
# ...return invalid data
1551
"Return the peer's OpenPGP certificate as a bytestring"
1552
# If not an OpenPGP certificate...
1553
if (gnutls.library.functions
1554
.gnutls_certificate_type_get(session._c_object)
1555
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1556
# ...do the normal thing
1557
return session.peer_certificate
2424
1558
list_size = ctypes.c_uint(1)
2425
cert_list = (gnutls.certificate_get_peers
1559
cert_list = (gnutls.library.functions
1560
.gnutls_certificate_get_peers
2426
1561
(session._c_object, ctypes.byref(list_size)))
2427
1562
if not bool(cert_list) and list_size.value != 0:
2428
raise gnutls.Error("error getting peer certificate")
1563
raise gnutls.errors.GNUTLSError("error getting peer"
2429
1565
if list_size.value == 0:
2431
1567
cert = cert_list[0]
2432
1568
return ctypes.string_at(cert.data, cert.size)
2435
def key_id(certificate):
2436
"Convert a certificate bytestring to a hexdigit key ID"
2437
# New GnuTLS "datum" with the public key
2438
datum = gnutls.datum_t(
2439
ctypes.cast(ctypes.c_char_p(certificate),
2440
ctypes.POINTER(ctypes.c_ubyte)),
2441
ctypes.c_uint(len(certificate)))
2442
# XXX all these need to be created in the gnutls "module"
2443
# New empty GnuTLS certificate
2444
pubkey = gnutls.pubkey_t()
2445
gnutls.pubkey_init(ctypes.byref(pubkey))
2446
# Import the raw public key into the certificate
2447
gnutls.pubkey_import(pubkey,
2448
ctypes.byref(datum),
2449
gnutls.X509_FMT_DER)
2450
# New buffer for the key ID
2451
buf = ctypes.create_string_buffer(32)
2452
buf_len = ctypes.c_size_t(len(buf))
2453
# Get the key ID from the raw public key into the buffer
2454
gnutls.pubkey_get_key_id(pubkey,
2455
gnutls.KEYID_USE_SHA256,
2456
ctypes.cast(ctypes.byref(buf),
2457
ctypes.POINTER(ctypes.c_ubyte)),
2458
ctypes.byref(buf_len))
2459
# Deinit the certificate
2460
gnutls.pubkey_deinit(pubkey)
2462
# Convert the buffer to a Python bytestring
2463
key_id = ctypes.string_at(buf, buf_len.value)
2464
# Convert the bytestring to hexadecimal notation
2465
hex_key_id = binascii.hexlify(key_id).upper()
2469
1571
def fingerprint(openpgp):
2470
1572
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2471
1573
# New GnuTLS "datum" with the OpenPGP public key
2472
datum = gnutls.datum_t(
2473
ctypes.cast(ctypes.c_char_p(openpgp),
2474
ctypes.POINTER(ctypes.c_ubyte)),
2475
ctypes.c_uint(len(openpgp)))
1574
datum = (gnutls.library.types
1575
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1578
ctypes.c_uint(len(openpgp))))
2476
1579
# New empty GnuTLS certificate
2477
crt = gnutls.openpgp_crt_t()
2478
gnutls.openpgp_crt_init(ctypes.byref(crt))
1580
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1581
(gnutls.library.functions
1582
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2479
1583
# Import the OpenPGP public key into the certificate
2480
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2481
gnutls.OPENPGP_FMT_RAW)
1584
(gnutls.library.functions
1585
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1586
gnutls.library.constants
1587
.GNUTLS_OPENPGP_FMT_RAW))
2482
1588
# Verify the self signature in the key
2483
1589
crtverify = ctypes.c_uint()
2484
gnutls.openpgp_crt_verify_self(crt, 0,
2485
ctypes.byref(crtverify))
1590
(gnutls.library.functions
1591
.gnutls_openpgp_crt_verify_self(crt, 0,
1592
ctypes.byref(crtverify)))
2486
1593
if crtverify.value != 0:
2487
gnutls.openpgp_crt_deinit(crt)
2488
raise gnutls.CertificateSecurityError(code
1594
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1595
raise (gnutls.errors.CertificateSecurityError
2490
1597
# New buffer for the fingerprint
2491
1598
buf = ctypes.create_string_buffer(20)
2492
1599
buf_len = ctypes.c_size_t()
2493
1600
# Get the fingerprint from the certificate into the buffer
2494
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2495
ctypes.byref(buf_len))
1601
(gnutls.library.functions
1602
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1603
ctypes.byref(buf_len)))
2496
1604
# Deinit the certificate
2497
gnutls.openpgp_crt_deinit(crt)
1605
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2498
1606
# Convert the buffer to a Python bytestring
2499
1607
fpr = ctypes.string_at(buf, buf_len.value)
2500
1608
# Convert the bytestring to hexadecimal notation
2501
hex_fpr = binascii.hexlify(fpr).upper()
1609
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2505
class MultiprocessingMixIn:
1613
class MultiprocessingMixIn(object):
2506
1614
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2508
1615
def sub_process_main(self, request, address):
2510
1617
self.finish_request(request, address)
2512
1619
self.handle_error(request, address)
2513
1620
self.close_request(request)
2515
1622
def process_request(self, request, address):
2516
1623
"""Start a new process to process the request."""
2517
proc = multiprocessing.Process(target=self.sub_process_main,
2518
args=(request, address))
1624
proc = multiprocessing.Process(target = self.sub_process_main,
2523
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1631
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2524
1632
""" adds a pipe to the MixIn """
2526
1633
def process_request(self, request, client_address):
2527
1634
"""Overrides and wraps the original process_request().
2529
1636
This function creates a new pipe in self.pipe
2531
1638
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2533
1640
proc = MultiprocessingMixIn.process_request(self, request,
2534
1641
client_address)
2535
1642
self.child_pipe.close()
2536
1643
self.add_pipe(parent_pipe, proc)
2538
1645
def add_pipe(self, parent_pipe, proc):
2539
1646
"""Dummy function; override as necessary"""
2540
raise NotImplementedError()
1647
raise NotImplementedError
2543
1650
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2544
socketserver.TCPServer):
1651
socketserver.TCPServer, object):
2545
1652
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2548
1655
enabled: Boolean; whether this server is activated yet
2549
1656
interface: None or a network interface name (string)
2550
1657
use_ipv6: Boolean; to use IPv6 or not
2553
1659
def __init__(self, server_address, RequestHandlerClass,
2557
"""If socketfd is set, use that file descriptor instead of
2558
creating a new one with socket.socket().
1660
interface=None, use_ipv6=True):
2560
1661
self.interface = interface
2562
1663
self.address_family = socket.AF_INET6
2563
if socketfd is not None:
2564
# Save the file descriptor
2565
self.socketfd = socketfd
2566
# Save the original socket.socket() function
2567
self.socket_socket = socket.socket
2569
# To implement --socket, we monkey patch socket.socket.
2571
# (When socketserver.TCPServer is a new-style class, we
2572
# could make self.socket into a property instead of monkey
2573
# patching socket.socket.)
2575
# Create a one-time-only replacement for socket.socket()
2576
@functools.wraps(socket.socket)
2577
def socket_wrapper(*args, **kwargs):
2578
# Restore original function so subsequent calls are
2580
socket.socket = self.socket_socket
2581
del self.socket_socket
2582
# This time only, return a new socket object from the
2583
# saved file descriptor.
2584
return socket.fromfd(self.socketfd, *args, **kwargs)
2585
# Replace socket.socket() function with wrapper
2586
socket.socket = socket_wrapper
2587
# The socketserver.TCPServer.__init__ will call
2588
# socket.socket(), which might be our replacement,
2589
# socket_wrapper(), if socketfd was set.
2590
1664
socketserver.TCPServer.__init__(self, server_address,
2591
1665
RequestHandlerClass)
2593
1666
def server_bind(self):
2594
1667
"""This overrides the normal server_bind() function
2595
1668
to bind to an interface if one was specified, and also NOT to
2596
1669
bind to an address or port if they were not specified."""
2597
global SO_BINDTODEVICE
2598
1670
if self.interface is not None:
2599
1671
if SO_BINDTODEVICE is None:
2600
# Fall back to a hard-coded value which seems to be
2602
logger.warning("SO_BINDTODEVICE not found, trying 25")
2603
SO_BINDTODEVICE = 25
2605
self.socket.setsockopt(
2606
socket.SOL_SOCKET, SO_BINDTODEVICE,
2607
(self.interface + "\0").encode("utf-8"))
2608
except socket.error as error:
2609
if error.errno == errno.EPERM:
2610
logger.error("No permission to bind to"
2611
" interface %s", self.interface)
2612
elif error.errno == errno.ENOPROTOOPT:
2613
logger.error("SO_BINDTODEVICE not available;"
2614
" cannot bind to interface %s",
2616
elif error.errno == errno.ENODEV:
2617
logger.error("Interface %s does not exist,"
2618
" cannot bind", self.interface)
1672
logger.error("SO_BINDTODEVICE does not exist;"
1673
" cannot bind to interface %s",
1677
self.socket.setsockopt(socket.SOL_SOCKET,
1681
except socket.error as error:
1682
if error[0] == errno.EPERM:
1683
logger.error("No permission to"
1684
" bind to interface %s",
1686
elif error[0] == errno.ENOPROTOOPT:
1687
logger.error("SO_BINDTODEVICE not available;"
1688
" cannot bind to interface %s",
2621
1692
# Only bind(2) the socket if we really need to.
2622
1693
if self.server_address[0] or self.server_address[1]:
2623
if self.server_address[1]:
2624
self.allow_reuse_address = True
2625
1694
if not self.server_address[0]:
2626
1695
if self.address_family == socket.AF_INET6:
2627
any_address = "::" # in6addr_any
1696
any_address = "::" # in6addr_any
2629
any_address = "0.0.0.0" # INADDR_ANY
1698
any_address = socket.INADDR_ANY
2630
1699
self.server_address = (any_address,
2631
1700
self.server_address[1])
2632
1701
elif not self.server_address[1]:
2633
self.server_address = (self.server_address[0], 0)
1702
self.server_address = (self.server_address[0],
2634
1704
# if self.interface:
2635
1705
# self.server_address = (self.server_address[0],
2963
1927
parser.add_argument("--no-dbus", action="store_false",
2964
1928
dest="use_dbus", help="Do not provide D-Bus"
2965
" system bus interface", default=None)
1929
" system bus interface")
2966
1930
parser.add_argument("--no-ipv6", action="store_false",
2967
dest="use_ipv6", help="Do not use IPv6",
1931
dest="use_ipv6", help="Do not use IPv6")
2969
1932
parser.add_argument("--no-restore", action="store_false",
2970
dest="restore", help="Do not restore stored"
2971
" state", default=None)
2972
parser.add_argument("--socket", type=int,
2973
help="Specify a file descriptor to a network"
2974
" socket to use instead of creating one")
2975
parser.add_argument("--statedir", metavar="DIR",
2976
help="Directory to save/restore state in")
2977
parser.add_argument("--foreground", action="store_true",
2978
help="Run in foreground", default=None)
2979
parser.add_argument("--no-zeroconf", action="store_false",
2980
dest="zeroconf", help="Do not use Zeroconf",
1933
dest="restore", help="Do not restore stored state",
2983
1936
options = parser.parse_args()
2985
1943
# Default values for config file for server-global settings
2986
if gnutls.has_rawpk:
2987
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2988
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2990
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2991
":+SIGN-DSA-SHA256")
2992
server_defaults = {"interface": "",
2996
"priority": priority,
2997
"servicename": "Mandos",
3003
"statedir": "/var/lib/mandos",
3004
"foreground": "False",
1944
server_defaults = { "interface": "",
1949
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1950
"servicename": "Mandos",
3009
1956
# Parse config file for server-global settings
3010
server_config = configparser.ConfigParser(server_defaults)
1957
server_config = configparser.SafeConfigParser(server_defaults)
3011
1958
del server_defaults
3012
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3013
# Convert the ConfigParser object to a dict
1959
server_config.read(os.path.join(options.configdir,
1961
# Convert the SafeConfigParser object to a dict
3014
1962
server_settings = server_config.defaults()
3015
1963
# Use the appropriate methods on the non-string config options
3016
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3017
"foreground", "zeroconf"):
1964
for option in ("debug", "use_dbus", "use_ipv6"):
3018
1965
server_settings[option] = server_config.getboolean("DEFAULT",
3020
1967
if server_settings["port"]:
3021
1968
server_settings["port"] = server_config.getint("DEFAULT",
3023
if server_settings["socket"]:
3024
server_settings["socket"] = server_config.getint("DEFAULT",
3026
# Later, stdin will, and stdout and stderr might, be dup'ed
3027
# over with an opened os.devnull. But we don't want this to
3028
# happen with a supplied network socket.
3029
if 0 <= server_settings["socket"] <= 2:
3030
server_settings["socket"] = os.dup(server_settings
3032
1970
del server_config
3034
1972
# Override the settings from the config file with command line
3035
1973
# options, if set.
3036
1974
for option in ("interface", "address", "port", "debug",
3037
"priority", "servicename", "configdir", "use_dbus",
3038
"use_ipv6", "debuglevel", "restore", "statedir",
3039
"socket", "foreground", "zeroconf"):
1975
"priority", "servicename", "configdir",
1976
"use_dbus", "use_ipv6", "debuglevel", "restore"):
3040
1977
value = getattr(options, option)
3041
1978
if value is not None:
3042
1979
server_settings[option] = value
3044
1981
# Force all strings to be unicode
3045
1982
for option in server_settings.keys():
3046
if isinstance(server_settings[option], bytes):
3047
server_settings[option] = (server_settings[option]
3049
# Force all boolean options to be boolean
3050
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3051
"foreground", "zeroconf"):
3052
server_settings[option] = bool(server_settings[option])
3053
# Debug implies foreground
3054
if server_settings["debug"]:
3055
server_settings["foreground"] = True
1983
if type(server_settings[option]) is str:
1984
server_settings[option] = unicode(server_settings[option])
3056
1985
# Now we have our good server settings in "server_settings"
3058
1987
##################################################################
3060
if (not server_settings["zeroconf"]
3061
and not (server_settings["port"]
3062
or server_settings["socket"] != "")):
3063
parser.error("Needs port or socket to work without Zeroconf")
3065
1989
# For convenience
3066
1990
debug = server_settings["debug"]
3067
1991
debuglevel = server_settings["debuglevel"]
3068
1992
use_dbus = server_settings["use_dbus"]
3069
1993
use_ipv6 = server_settings["use_ipv6"]
3070
stored_state_path = os.path.join(server_settings["statedir"],
3072
foreground = server_settings["foreground"]
3073
zeroconf = server_settings["zeroconf"]
3076
initlogger(debug, logging.DEBUG)
1996
initlogger(logging.DEBUG)
3078
1998
if not debuglevel:
3081
2001
level = getattr(logging, debuglevel.upper())
3082
initlogger(debug, level)
3084
2004
if server_settings["servicename"] != "Mandos":
3085
syslogger.setFormatter(
3086
logging.Formatter('Mandos ({}) [%(process)d]:'
3087
' %(levelname)s: %(message)s'.format(
3088
server_settings["servicename"])))
2005
syslogger.setFormatter(logging.Formatter
2006
('Mandos (%s) [%%(process)d]:'
2007
' %%(levelname)s: %%(message)s'
2008
% server_settings["servicename"]))
3090
2010
# Parse config file with clients
3091
client_config = configparser.ConfigParser(Client.client_defaults)
2011
client_defaults = { "timeout": "5m",
2012
"extended_timeout": "15m",
2014
"checker": "fping -q -- %%(host)s",
2016
"approval_delay": "0s",
2017
"approval_duration": "1s",
2019
client_config = configparser.SafeConfigParser(client_defaults)
3092
2020
client_config.read(os.path.join(server_settings["configdir"],
3093
2021
"clients.conf"))
3095
2023
global mandos_dbus_service
3096
2024
mandos_dbus_service = None
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
2026
tcp_server = MandosServer((server_settings["address"],
2027
server_settings["port"]),
2029
interface=(server_settings["interface"]
2033
server_settings["priority"],
2036
pidfilename = "/var/run/mandos.pid"
2038
pidfile = open(pidfilename, "w")
2040
logger.error("Could not open file %r", pidfilename)
2043
uid = pwd.getpwnam("_mandos").pw_uid
2044
gid = pwd.getpwnam("_mandos").pw_gid
2047
uid = pwd.getpwnam("mandos").pw_uid
2048
gid = pwd.getpwnam("mandos").pw_gid
3127
2049
except KeyError:
2051
uid = pwd.getpwnam("nobody").pw_uid
2052
gid = pwd.getpwnam("nobody").pw_gid
3136
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3138
2059
except OSError as error:
3139
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3140
.format(uid, gid, os.strerror(error.errno)))
3141
if error.errno != errno.EPERM:
2060
if error[0] != errno.EPERM:
3145
2064
# Enable all possible GnuTLS debugging
3147
2066
# "Use a log level over 10 to enable all debugging options."
3148
2067
# - GnuTLS manual
3149
gnutls.global_set_log_level(11)
2068
gnutls.library.functions.gnutls_global_set_log_level(11)
2070
@gnutls.library.types.gnutls_log_func
3152
2071
def debug_gnutls(level, string):
3153
2072
logger.debug("GnuTLS: %s", string[:-1])
3155
gnutls.global_set_log_function(debug_gnutls)
2074
(gnutls.library.functions
2075
.gnutls_global_set_log_function(debug_gnutls))
3157
2077
# Redirect stdin so all checkers get /dev/null
3158
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2078
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3159
2079
os.dup2(null, sys.stdin.fileno())
2083
# No console logging
2084
logger.removeHandler(console)
3163
2086
# Need to fork before connecting to D-Bus
3165
2088
# Close all input and output, do double fork, etc.
3168
if gi.version_info < (3, 10, 2):
3169
# multiprocessing will use threads, so before we use GLib we
3170
# need to inform GLib that threads will be used.
3173
2091
global main_loop
3174
2092
# From the Avahi example code
3175
DBusGMainLoop(set_as_default=True)
3176
main_loop = GLib.MainLoop()
2093
DBusGMainLoop(set_as_default=True )
2094
main_loop = gobject.MainLoop()
3177
2095
bus = dbus.SystemBus()
3178
2096
# End of Avahi example code
3181
2099
bus_name = dbus.service.BusName("se.recompile.Mandos",
3184
old_bus_name = dbus.service.BusName(
3185
"se.bsnet.fukt.Mandos", bus,
3187
except dbus.exceptions.DBusException as e:
3188
logger.error("Disabling D-Bus:", exc_info=e)
2100
bus, do_not_queue=True)
2101
old_bus_name = (dbus.service.BusName
2102
("se.bsnet.fukt.Mandos", bus,
2104
except dbus.exceptions.NameExistsException as e:
2105
logger.error(unicode(e) + ", disabling D-Bus")
3189
2106
use_dbus = False
3190
2107
server_settings["use_dbus"] = False
3191
2108
tcp_server.use_dbus = False
3193
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3194
service = AvahiServiceToSyslog(
3195
name=server_settings["servicename"],
3196
servicetype="_mandos._tcp",
3199
if server_settings["interface"]:
3200
service.interface = if_nametoindex(
3201
server_settings["interface"].encode("utf-8"))
2109
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2110
service = AvahiServiceToSyslog(name =
2111
server_settings["servicename"],
2112
servicetype = "_mandos._tcp",
2113
protocol = protocol, bus = bus)
2114
if server_settings["interface"]:
2115
service.interface = (if_nametoindex
2116
(str(server_settings["interface"])))
3203
2118
global multiprocessing_manager
3204
2119
multiprocessing_manager = multiprocessing.Manager()
3206
2121
client_class = Client
3208
client_class = functools.partial(ClientDBus, bus=bus)
3210
client_settings = Client.config_parser(client_config)
2123
client_class = functools.partial(ClientDBusTransitional,
2126
special_settings = {
2127
# Some settings need to be accessd by special methods;
2128
# booleans need .getboolean(), etc. Here is a list of them:
2129
"approved_by_default":
2131
client_config.getboolean(section, "approved_by_default"),
2133
# Construct a new dict of client settings of this form:
2134
# { client_name: {setting_name: value, ...}, ...}
2135
# with exceptions for any special settings as defined above
2136
client_settings = dict((clientname,
2138
(value if setting not in special_settings
2139
else special_settings[setting](clientname)))
2140
for setting, value in client_config.items(clientname)))
2141
for clientname in client_config.sections())
3211
2143
old_client_settings = {}
3214
# This is used to redirect stdout and stderr for checker processes
3216
wnull = open(os.devnull, "w") # A writable /dev/null
3217
# Only used if server is running in foreground but not in debug
3219
if debug or not foreground:
3222
# Get client data and settings from last running state.
2146
# Get client data and settings from last running state.
3223
2147
if server_settings["restore"]:
3225
2149
with open(stored_state_path, "rb") as stored_state:
3226
if sys.version_info.major == 2:
3227
clients_data, old_client_settings = pickle.load(
3230
bytes_clients_data, bytes_old_client_settings = (
3231
pickle.load(stored_state, encoding="bytes"))
3232
# Fix bytes to strings
3235
clients_data = {(key.decode("utf-8")
3236
if isinstance(key, bytes)
3239
bytes_clients_data.items()}
3240
del bytes_clients_data
3241
for key in clients_data:
3242
value = {(k.decode("utf-8")
3243
if isinstance(k, bytes) else k): v
3245
clients_data[key].items()}
3246
clients_data[key] = value
3248
value["client_structure"] = [
3250
if isinstance(s, bytes)
3252
value["client_structure"]]
3254
for k in ("name", "host"):
3255
if isinstance(value[k], bytes):
3256
value[k] = value[k].decode("utf-8")
3257
if "key_id" not in value:
3258
value["key_id"] = ""
3259
elif "fingerprint" not in value:
3260
value["fingerprint"] = ""
3261
# old_client_settings
3263
old_client_settings = {
3264
(key.decode("utf-8")
3265
if isinstance(key, bytes)
3268
bytes_old_client_settings.items()}
3269
del bytes_old_client_settings
3271
for value in old_client_settings.values():
3272
if isinstance(value["host"], bytes):
3273
value["host"] = (value["host"]
2150
clients_data, old_client_settings = pickle.load(stored_state)
3275
2151
os.remove(stored_state_path)
3276
2152
except IOError as e:
3277
if e.errno == errno.ENOENT:
3278
logger.warning("Could not load persistent state:"
3279
" {}".format(os.strerror(e.errno)))
3281
logger.critical("Could not load persistent state:",
2153
logger.warning("Could not load persistant state: {0}".format(e))
2154
if e.errno != errno.ENOENT:
3284
except EOFError as e:
3285
logger.warning("Could not load persistent state: "
3289
with PGPEngine() as pgp:
3290
for client_name, client in clients_data.items():
3291
# Skip removed clients
3292
if client_name not in client_settings:
3295
# Decide which value to use after restoring saved state.
3296
# We have three different values: Old config file,
3297
# new config file, and saved state.
3298
# New config value takes precedence if it differs from old
3299
# config value, otherwise use saved state.
3300
for name, value in client_settings[client_name].items():
3302
# For each value in new config, check if it
3303
# differs from the old config value (Except for
3304
# the "secret" attribute)
3305
if (name != "secret"
3307
old_client_settings[client_name][name])):
3308
client[name] = value
3312
# Clients who has passed its expire date can still be
3313
# enabled if its last checker was successful. A Client
3314
# whose checker succeeded before we stored its state is
3315
# assumed to have successfully run all checkers during
3317
if client["enabled"]:
3318
if datetime.datetime.utcnow() >= client["expires"]:
3319
if not client["last_checked_ok"]:
3321
"disabling client {} - Client never "
3322
"performed a successful checker".format(
3324
client["enabled"] = False
3325
elif client["last_checker_status"] != 0:
3327
"disabling client {} - Client last"
3328
" checker failed with error code"
3331
client["last_checker_status"]))
3332
client["enabled"] = False
3334
client["expires"] = (
3335
datetime.datetime.utcnow()
3336
+ client["timeout"])
3337
logger.debug("Last checker succeeded,"
3338
" keeping {} enabled".format(
2157
for client in clients_data:
2158
client_name = client["name"]
2160
# Decide which value to use after restoring saved state.
2161
# We have three different values: Old config file,
2162
# new config file, and saved state.
2163
# New config value takes precedence if it differs from old
2164
# config value, otherwise use saved state.
2165
for name, value in client_settings[client_name].items():
3341
client["secret"] = pgp.decrypt(
3342
client["encrypted_secret"],
3343
client_settings[client_name]["secret"])
3345
# If decryption fails, we use secret from new settings
3346
logger.debug("Failed to decrypt {} old secret".format(
3348
client["secret"] = (client_settings[client_name]
3351
# Add/remove clients based on new changes made to config
3352
for client_name in (set(old_client_settings)
3353
- set(client_settings)):
3354
del clients_data[client_name]
3355
for client_name in (set(client_settings)
3356
- set(old_client_settings)):
3357
clients_data[client_name] = client_settings[client_name]
3359
# Create all client objects
3360
for client_name, client in clients_data.items():
3361
tcp_server.clients[client_name] = client_class(
3364
server_settings=server_settings)
2167
# For each value in new config, check if it differs
2168
# from the old config value (Except for the "secret"
2170
if name != "secret" and value != old_client_settings[client_name][name]:
2171
setattr(client, name, value)
2175
# Clients who has passed its expire date, can still be enabled if its
2176
# last checker was sucessful. Clients who checkers failed before we
2177
# stored it state is asumed to had failed checker during downtime.
2178
if client["enabled"] and client["last_checked_ok"]:
2179
if ((datetime.datetime.utcnow() - client["last_checked_ok"])
2180
> client["interval"]):
2181
if client["last_checker_status"] != 0:
2182
client["enabled"] = False
2184
client["expires"] = datetime.datetime.utcnow() + client["timeout"]
2186
client["changedstate"] = (multiprocessing_manager
2187
.Condition(multiprocessing_manager
2190
new_client = ClientDBusTransitional.__new__(ClientDBusTransitional)
2191
tcp_server.clients[client_name] = new_client
2192
new_client.bus = bus
2193
for name, value in client.iteritems():
2194
setattr(new_client, name, value)
2195
client_object_name = unicode(client_name).translate(
2196
{ord("."): ord("_"),
2197
ord("-"): ord("_")})
2198
new_client.dbus_object_path = (dbus.ObjectPath
2199
("/clients/" + client_object_name))
2200
DBusObjectWithProperties.__init__(new_client,
2202
new_client.dbus_object_path)
2204
tcp_server.clients[client_name] = Client.__new__(Client)
2205
for name, value in client.iteritems():
2206
setattr(tcp_server.clients[client_name], name, value)
2208
tcp_server.clients[client_name].decrypt_secret(
2209
client_settings[client_name]["secret"])
2211
# Create/remove clients based on new changes made to config
2212
for clientname in set(old_client_settings) - set(client_settings):
2213
del tcp_server.clients[clientname]
2214
for clientname in set(client_settings) - set(old_client_settings):
2215
tcp_server.clients[clientname] = (client_class(name = clientname,
3366
2221
if not tcp_server.clients:
3367
2222
logger.warning("No clients defined")
3370
if pidfile is not None:
3374
print(pid, file=pidfile)
3376
logger.error("Could not write to file %r with PID %d",
2228
pidfile.write(str(pid) + "\n".encode("utf-8"))
2231
logger.error("Could not write to file %r with PID %d",
2234
# "pidfile" was never created
3379
2236
del pidfilename
3381
for termsig in (signal.SIGHUP, signal.SIGTERM):
3382
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3383
lambda: main_loop.quit() and False)
2238
signal.signal(signal.SIGINT, signal.SIG_IGN)
2240
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2241
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3387
@alternate_dbus_interfaces(
3388
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3389
class MandosDBusService(DBusObjectWithObjectManager):
2244
class MandosDBusService(dbus.service.Object):
3390
2245
"""A D-Bus proxy object"""
3392
2246
def __init__(self):
3393
2247
dbus.service.Object.__init__(self, bus, "/")
3395
2248
_interface = "se.recompile.Mandos"
3397
2250
@dbus.service.signal(_interface, signature="o")
3398
2251
def ClientAdded(self, objpath):
3402
2255
@dbus.service.signal(_interface, signature="ss")
3403
def ClientNotFound(self, key_id, address):
2256
def ClientNotFound(self, fingerprint, address):
3407
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3409
2260
@dbus.service.signal(_interface, signature="os")
3410
2261
def ClientRemoved(self, objpath, name):
3414
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3416
2265
@dbus.service.method(_interface, out_signature="ao")
3417
2266
def GetAllClients(self):
3419
return dbus.Array(c.dbus_object_path for c in
3420
tcp_server.clients.values())
3422
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2268
return dbus.Array(c.dbus_object_path
2270
tcp_server.clients.itervalues())
3424
2272
@dbus.service.method(_interface,
3425
2273
out_signature="a{oa{sv}}")
3426
2274
def GetAllClientsWithProperties(self):
3428
2276
return dbus.Dictionary(
3429
{c.dbus_object_path: c.GetAll(
3430
"se.recompile.Mandos.Client")
3431
for c in tcp_server.clients.values()},
2277
((c.dbus_object_path, c.GetAll(""))
2278
for c in tcp_server.clients.itervalues()),
3432
2279
signature="oa{sv}")
3434
2281
@dbus.service.method(_interface, in_signature="o")
3435
2282
def RemoveClient(self, object_path):
3437
for c in tcp_server.clients.values():
2284
for c in tcp_server.clients.itervalues():
3438
2285
if c.dbus_object_path == object_path:
3439
2286
del tcp_server.clients[c.name]
3440
2287
c.remove_from_connection()
3441
# Don't signal the disabling
2288
# Don't signal anything except ClientRemoved
3442
2289
c.disable(quiet=True)
3443
# Emit D-Bus signal for removal
3444
self.client_removed_signal(c)
2291
self.ClientRemoved(object_path, c.name)
3446
2293
raise KeyError(object_path)
3450
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3451
out_signature="a{oa{sa{sv}}}")
3452
def GetManagedObjects(self):
3454
return dbus.Dictionary(
3455
{client.dbus_object_path:
3457
{interface: client.GetAll(interface)
3459
client._get_all_interface_names()})
3460
for client in tcp_server.clients.values()})
3462
def client_added_signal(self, client):
3463
"""Send the new standard signal and the old signal"""
3465
# New standard signal
3466
self.InterfacesAdded(
3467
client.dbus_object_path,
3469
{interface: client.GetAll(interface)
3471
client._get_all_interface_names()}))
3473
self.ClientAdded(client.dbus_object_path)
3475
def client_removed_signal(self, client):
3476
"""Send the new standard signal and the old signal"""
3478
# New standard signal
3479
self.InterfacesRemoved(
3480
client.dbus_object_path,
3481
client._get_all_interface_names())
3483
self.ClientRemoved(client.dbus_object_path,
3486
mandos_dbus_service = MandosDBusService()
3488
# Save modules to variables to exempt the modules from being
3489
# unloaded before the function registered with atexit() is run.
3490
mp = multiprocessing
2297
class MandosDBusServiceTransitional(MandosDBusService):
2298
__metaclass__ = AlternateDBusNamesMetaclass
2299
mandos_dbus_service = MandosDBusServiceTransitional()
3494
2302
"Cleanup function; run on exit"
3498
mp.active_children()
2305
multiprocessing.active_children()
3500
2306
if not (tcp_server.clients or client_settings):
3503
# Store client before exiting. Secrets are encrypted with key
3504
# based on what config file has. If config file is
3505
# removed/edited, old secret will thus be unrecovable.
3507
with PGPEngine() as pgp:
3508
for client in tcp_server.clients.values():
3509
key = client_settings[client.name]["secret"]
3510
client.encrypted_secret = pgp.encrypt(client.secret,
3514
# A list of attributes that can not be pickled
3516
exclude = {"bus", "changedstate", "secret",
3517
"checker", "server_settings"}
3518
for name, typ in inspect.getmembers(dbus.service
3522
client_dict["encrypted_secret"] = (client
3524
for attr in client.client_structure:
3525
if attr not in exclude:
3526
client_dict[attr] = getattr(client, attr)
3528
clients[client.name] = client_dict
3529
del client_settings[client.name]["secret"]
2309
# Store client before exiting. Secrets are encrypted with key based
2310
# on what config file has. If config file is removed/edited, old
2311
# secret will thus be unrecovable.
2313
for client in tcp_server.clients.itervalues():
2314
client.encrypt_secret(client_settings[client.name]["secret"])
2318
# A list of attributes that will not be stored when shuting down.
2319
exclude = set(("bus", "changedstate", "secret"))
2320
for name, typ in inspect.getmembers(dbus.service.Object):
2323
client_dict["encrypted_secret"] = client.encrypted_secret
2324
for attr in client.client_structure:
2325
if attr not in exclude:
2326
client_dict[attr] = getattr(client, attr)
2328
clients.append(client_dict)
2329
del client_settings[client.name]["secret"]
3532
with tempfile.NamedTemporaryFile(
3536
dir=os.path.dirname(stored_state_path),
3537
delete=False) as stored_state:
3538
pickle.dump((clients, client_settings), stored_state,
3540
tempname = stored_state.name
3541
os.rename(tempname, stored_state_path)
3542
except (IOError, OSError) as e:
3548
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3549
logger.warning("Could not save persistent state: {}"
3550
.format(os.strerror(e.errno)))
3552
logger.warning("Could not save persistent state:",
2332
with os.fdopen(os.open(stored_state_path, os.O_CREAT|os.O_WRONLY|os.O_TRUNC, 0600), "wb") as stored_state:
2333
pickle.dump((clients, client_settings), stored_state)
2334
except IOError as e:
2335
logger.warning("Could not save persistant state: {0}".format(e))
2336
if e.errno != errno.ENOENT:
3556
2339
# Delete all clients, and settings from config