70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
83
68
import dbus.service
85
from gi.repository import GLib
86
71
from dbus.mainloop.glib import DBusGMainLoop
89
74
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:
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
78
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
105
79
except AttributeError:
107
# This is where SO_BINDTODEVICE was up to and including Python
109
81
from IN import SO_BINDTODEVICE
110
82
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"
134
logger = logging.getLogger()
135
logging.captureWarnings(True) # Show warnings via the logging system
139
if_nametoindex = ctypes.cdll.LoadLibrary(
140
ctypes.util.find_library("c")).if_nametoindex
141
except (OSError, AttributeError):
143
def if_nametoindex(interface):
144
"Get an interface index the hard way, i.e. using fcntl()"
145
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
146
with contextlib.closing(socket.socket()) as s:
147
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
148
struct.pack(b"16s16x", interface))
149
interface_index = struct.unpack("I", ifreq[16:20])[0]
150
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):
170
"""init logger and add loglevel"""
173
syslogger = (logging.handlers.SysLogHandler(
174
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
176
syslogger.setFormatter(logging.Formatter
177
('Mandos [%(process)d]: %(levelname)s:'
179
logger.addHandler(syslogger)
182
console = logging.StreamHandler()
183
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
187
logger.addHandler(console)
188
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 == b"gpg" or self.gpg.endswith(b"/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
83
SO_BINDTODEVICE = None
88
#logger = logging.getLogger('mandos')
89
logger = logging.Logger('mandos')
90
syslogger = (logging.handlers.SysLogHandler
91
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
address = str("/dev/log")))
93
syslogger.setFormatter(logging.Formatter
94
('Mandos [%(process)d]: %(levelname)s:'
96
logger.addHandler(syslogger)
98
console = logging.StreamHandler()
99
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
102
logger.addHandler(console)
317
104
class AvahiError(Exception):
318
105
def __init__(self, value, *args, **kwargs):
319
106
self.value = value
320
return super(AvahiError, self).__init__(value, *args,
107
super(AvahiError, self).__init__(value, *args, **kwargs)
108
def __unicode__(self):
109
return unicode(repr(self.value))
324
111
class AvahiServiceError(AvahiError):
328
114
class AvahiGroupError(AvahiError):
118
class AvahiService(object):
333
119
"""An Avahi (Zeroconf) service.
336
122
interface: integer; avahi.IF_UNSPEC or an interface index.
337
123
Used to optionally bind to the specified interface.
338
124
name: string; Example: 'Mandos'
339
125
type: string; Example: '_mandos._tcp'.
340
See <https://www.iana.org/assignments/service-names-port-numbers>
126
See <http://www.dns-sd.org/ServiceTypes.html>
341
127
port: integer; what port to announce
342
128
TXT: list of strings; TXT record for the service
343
129
domain: string; Domain to publish on, default to .local if empty.
502
262
follow_name_owner_changes=True),
503
263
avahi.DBUS_INTERFACE_SERVER)
504
264
self.server.connect_to_signal("StateChanged",
505
self.server_state_changed)
265
self.server_state_changed)
506
266
self.server_state_changed(self.server.GetState())
509
class AvahiServiceToSyslog(AvahiService):
510
def rename(self, *args, **kwargs):
511
"""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'
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))
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
275
class Client(object):
832
276
"""A representation of a client host served by this server.
835
approved: bool(); 'None' if not yet approved/disapproved
279
_approved: bool(); 'None' if not yet approved/disapproved
836
280
approval_delay: datetime.timedelta(); Time to wait for approval
837
281
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
282
checker: subprocess.Popen(); a running checker process used
283
to see if the client lives.
284
'None' if no process is running.
285
checker_callback_tag: a gobject event source tag, or None
842
286
checker_command: string; External command which is run to check
843
287
if client lives. %() expansions are done at
844
288
runtime with vars(self) as dict, so that for
845
289
instance %(name)s can be used in the command.
846
checker_initiator_tag: a GLib event source tag, or None
290
checker_initiator_tag: a gobject event source tag, or None
847
291
created: datetime.datetime(); (UTC) object creation
848
client_structure: Object describing what attributes a client has
849
and is used for storing the client at exit
850
292
current_checker_command: string; current running checker_command
851
disable_initiator_tag: a GLib event source tag, or None
293
disable_hook: If set, called by disable() as disable_hook(self)
294
disable_initiator_tag: a gobject event source tag, or None
853
296
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
297
uniquely identify the client
857
298
host: string; available for use by the checker command
858
299
interval: datetime.timedelta(); How often to start a new checker
859
300
last_approval_request: datetime.datetime(); (UTC) or None
860
301
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
302
last_enabled: datetime.datetime(); (UTC)
867
303
name: string; from the config file, used in log messages and
868
304
D-Bus identifiers
869
305
secret: bytestring; sent verbatim (over TLS) to client
870
306
timeout: datetime.timedelta(); How long from last_checked_ok
871
307
until this client is disabled
872
extended_timeout: extra long timeout when secret has been sent
308
extended_timeout: extra long timeout when password has been sent
873
309
runtime_expansions: Allowed attributes for runtime expansion.
874
310
expires: datetime.datetime(); time (UTC) when a client will be
875
311
disabled, or None
876
server_settings: The server_settings dict from main()
879
314
runtime_expansions = ("approval_delay", "approval_duration",
880
"created", "enabled", "expires", "key_id",
881
"fingerprint", "host", "interval",
882
"last_approval_request", "last_checked_ok",
315
"created", "enabled", "fingerprint",
316
"host", "interval", "last_checked_ok",
883
317
"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):
319
def timeout_milliseconds(self):
320
"Return the 'timeout' attribute in milliseconds"
321
return _timedelta_to_milliseconds(self.timeout)
323
def extended_timeout_milliseconds(self):
324
"Return the 'extended_timeout' attribute in milliseconds"
325
return _timedelta_to_milliseconds(self.extended_timeout)
327
def interval_milliseconds(self):
328
"Return the 'interval' attribute in milliseconds"
329
return _timedelta_to_milliseconds(self.interval)
331
def approval_delay_milliseconds(self):
332
return _timedelta_to_milliseconds(self.approval_delay)
334
def __init__(self, name = None, disable_hook=None, config=None):
335
"""Note: the 'checker' key in 'config' sets the
336
'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
341
logger.debug("Creating client %r", self.name)
970
logger.debug(" Key ID: %s", self.key_id)
342
# Uppercase and remove spaces from fingerprint for later
343
# comparison purposes with return value from the fingerprint()
345
self.fingerprint = (config["fingerprint"].upper()
971
347
logger.debug(" Fingerprint: %s", self.fingerprint)
972
self.created = settings.get("created",
973
datetime.datetime.utcnow())
975
# attributes specific for this server instance
348
if "secret" in config:
349
self.secret = config["secret"].decode("base64")
350
elif "secfile" in config:
351
with open(os.path.expanduser(os.path.expandvars
352
(config["secfile"])),
354
self.secret = secfile.read()
356
raise TypeError("No secret or secfile for client %s"
358
self.host = config.get("host", "")
359
self.created = datetime.datetime.utcnow()
361
self.last_approval_request = None
362
self.last_enabled = None
363
self.last_checked_ok = None
364
self.timeout = string_to_delta(config["timeout"])
365
self.extended_timeout = string_to_delta(config
366
["extended_timeout"])
367
self.interval = string_to_delta(config["interval"])
368
self.disable_hook = disable_hook
976
369
self.checker = None
977
370
self.checker_initiator_tag = None
978
371
self.disable_initiator_tag = None
979
373
self.checker_callback_tag = None
374
self.checker_command = config["checker"]
980
375
self.current_checker_command = None
376
self.last_connect = None
377
self._approved = None
378
self.approved_by_default = config.get("approved_by_default",
982
380
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("_")]
988
self.client_structure.append("client_structure")
990
for name, t in inspect.getmembers(
991
type(self), lambda obj: isinstance(obj, property)):
992
if not name.startswith("_"):
993
self.client_structure.append(name)
995
# Send notice to process children that client state has changed
381
self.approval_delay = string_to_delta(
382
config["approval_delay"])
383
self.approval_duration = string_to_delta(
384
config["approval_duration"])
385
self.changedstate = (multiprocessing_manager
386
.Condition(multiprocessing_manager
996
389
def send_changedstate(self):
997
with self.changedstate:
998
self.changedstate.notify_all()
390
self.changedstate.acquire()
391
self.changedstate.notify_all()
392
self.changedstate.release()
1000
394
def enable(self):
1001
395
"""Start this client's checker and timeout hooks"""
1002
396
if getattr(self, "enabled", False):
1003
397
# Already enabled
399
self.send_changedstate()
400
# Schedule a new checker to be started an 'interval' from now,
401
# and every interval from then on.
402
self.checker_initiator_tag = (gobject.timeout_add
403
(self.interval_milliseconds(),
405
# Schedule a disable() when 'timeout' has passed
1005
406
self.expires = datetime.datetime.utcnow() + self.timeout
407
self.disable_initiator_tag = (gobject.timeout_add
408
(self.timeout_milliseconds(),
1006
410
self.enabled = True
1007
411
self.last_enabled = datetime.datetime.utcnow()
1009
self.send_changedstate()
412
# Also start a new checker *right now*.
1011
415
def disable(self, quiet=True):
1012
416
"""Disable this client."""
1013
417
if not getattr(self, "enabled", False):
420
self.send_changedstate()
1016
422
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)
423
if getattr(self, "disable_initiator_tag", False):
424
gobject.source_remove(self.disable_initiator_tag)
1019
425
self.disable_initiator_tag = None
1020
426
self.expires = None
1021
if getattr(self, "checker_initiator_tag", None) is not None:
1022
GLib.source_remove(self.checker_initiator_tag)
427
if getattr(self, "checker_initiator_tag", False):
428
gobject.source_remove(self.checker_initiator_tag)
1023
429
self.checker_initiator_tag = None
1024
430
self.stop_checker()
431
if self.disable_hook:
432
self.disable_hook(self)
1025
433
self.enabled = False
1027
self.send_changedstate()
1028
# Do not run this again if called by a GLib.timeout_add
434
# Do not run this again if called by a gobject.timeout_add
1031
437
def __del__(self):
438
self.disable_hook = None
1034
def init_checker(self):
1035
# Schedule a new checker to be started an 'interval' from now,
1036
# 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),
1042
# 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)
1047
# Also start a new checker *right now*.
1048
self.start_checker()
1050
def checker_callback(self, source, condition, connection,
441
def checker_callback(self, pid, condition, command):
1052
442
"""The checker has completed, so take appropriate actions."""
1053
# Read return code from connection (see call_pipe)
1054
returncode = connection.recv()
1056
if self.checker is not None:
1058
443
self.checker_callback_tag = None
1059
444
self.checker = None
1062
self.last_checker_status = returncode
1063
self.last_checker_signal = None
1064
if self.last_checker_status == 0:
445
if os.WIFEXITED(condition):
446
exitstatus = os.WEXITSTATUS(condition)
1065
448
logger.info("Checker for %(name)s succeeded",
1067
450
self.checked_ok()
1069
logger.info("Checker for %(name)s failed", vars(self))
452
logger.info("Checker for %(name)s failed",
1071
self.last_checker_status = -1
1072
self.last_checker_signal = -returncode
1073
455
logger.warning("Checker for %(name)s crashed?",
1077
def checked_ok(self):
1078
"""Assert that the client has been seen, alive and well."""
1079
self.last_checked_ok = datetime.datetime.utcnow()
1080
self.last_checker_status = 0
1081
self.last_checker_signal = None
1084
def bump_timeout(self, timeout=None):
1085
"""Bump up the timeout for this client."""
458
def checked_ok(self, timeout=None):
459
"""Bump up the timeout for this client.
461
This should only be called when the client has been seen,
1086
464
if timeout is None:
1087
465
timeout = self.timeout
1088
if self.disable_initiator_tag is not None:
1089
GLib.source_remove(self.disable_initiator_tag)
1090
self.disable_initiator_tag = None
1091
if getattr(self, "enabled", False):
1092
self.disable_initiator_tag = GLib.timeout_add(
1093
int(timeout.total_seconds() * 1000), self.disable)
1094
self.expires = datetime.datetime.utcnow() + timeout
466
self.last_checked_ok = datetime.datetime.utcnow()
467
gobject.source_remove(self.disable_initiator_tag)
468
self.disable_initiator_tag = (gobject.timeout_add
469
(_timedelta_to_milliseconds
470
(timeout), self.disable))
471
self.expires = datetime.datetime.utcnow() + timeout
1096
473
def need_approval(self):
1097
474
self.last_approval_request = datetime.datetime.utcnow()
1099
476
def start_checker(self):
1100
477
"""Start a new checker subprocess if one is not running.
1102
479
If a checker already exists, leave it running and do
1104
481
# The reason for not killing a running checker is that if we
1105
# did that, and if a checker (for some reason) started running
1106
# slowly and taking more than 'interval' time, then the client
1107
# would inevitably timeout, since no checker would get a
1108
# chance to run to completion. If we instead leave running
482
# did that, then if a checker (for some reason) started
483
# running slowly and taking more than 'interval' time, the
484
# client would inevitably timeout, since no checker would get
485
# a chance to run to completion. If we instead leave running
1109
486
# checkers alone, the checker would have to take more time
1110
487
# than 'timeout' for the client to be disabled, which is as it
1113
if self.checker is not None and not self.checker.is_alive():
1114
logger.warning("Checker was not alive; joining")
490
# If a checker exists, make sure it is not a zombie
492
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
493
except (AttributeError, OSError) as error:
494
if (isinstance(error, OSError)
495
and error.errno != errno.ECHILD):
499
logger.warning("Checker was a zombie")
500
gobject.source_remove(self.checker_callback_tag)
501
self.checker_callback(pid, status,
502
self.current_checker_command)
1117
503
# Start a new checker if needed
1118
504
if self.checker is None:
1119
# Escape attributes for the shell
1121
attr: re.escape(str(getattr(self, attr)))
1122
for attr in self.runtime_expansions}
1124
command = self.checker_command % escaped_attrs
1125
except TypeError as error:
1126
logger.error('Could not format string "%s"',
1127
self.checker_command,
1129
return True # Try again later
506
# In case checker_command has exactly one % operator
507
command = self.checker_command % self.host
509
# Escape attributes for the shell
510
escaped_attrs = dict(
512
re.escape(unicode(str(getattr(self, attr, "")),
516
self.runtime_expansions)
519
command = self.checker_command % escaped_attrs
520
except TypeError as error:
521
logger.error('Could not format string "%s":'
522
' %s', self.checker_command, error)
523
return True # Try again later
1130
524
self.current_checker_command = command
1131
logger.info("Starting checker %r for %s", command,
1133
# We don't need to redirect stdout and stderr, since
1134
# in normal mode, that is already done by daemon(),
1135
# and in debug mode we don't want to. (Stdin is
1136
# always replaced by /dev/null.)
1137
# The exception is when not debugging but nevertheless
1138
# running in the foreground; use the previously
1140
popen_args = {"close_fds": True,
1143
if (not self.server_settings["debug"]
1144
and self.server_settings["foreground"]):
1145
popen_args.update({"stdout": wnull,
1147
pipe = multiprocessing.Pipe(duplex=False)
1148
self.checker = multiprocessing.Process(
1150
args=(pipe[1], subprocess.call, command),
1152
self.checker.start()
1153
self.checker_callback_tag = GLib.io_add_watch(
1154
GLib.IOChannel.unix_new(pipe[0].fileno()),
1155
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1156
self.checker_callback, pipe[0], command)
1157
# Re-run this periodically if run by GLib.timeout_add
526
logger.info("Starting checker %r for %s",
528
# We don't need to redirect stdout and stderr, since
529
# in normal mode, that is already done by daemon(),
530
# and in debug mode we don't want to. (Stdin is
531
# always replaced by /dev/null.)
532
self.checker = subprocess.Popen(command,
535
self.checker_callback_tag = (gobject.child_watch_add
537
self.checker_callback,
539
# The checker may have completed before the gobject
540
# watch was added. Check for this.
541
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
543
gobject.source_remove(self.checker_callback_tag)
544
self.checker_callback(pid, status, command)
545
except OSError as error:
546
logger.error("Failed to start subprocess: %s",
548
# Re-run this periodically if run by gobject.timeout_add
1160
551
def stop_checker(self):
1161
552
"""Force the checker process, if any, to stop."""
1162
553
if self.checker_callback_tag:
1163
GLib.source_remove(self.checker_callback_tag)
554
gobject.source_remove(self.checker_callback_tag)
1164
555
self.checker_callback_tag = None
1165
556
if getattr(self, "checker", None) is None:
1167
558
logger.debug("Stopping checker for %(name)s", vars(self))
1168
self.checker.terminate()
560
os.kill(self.checker.pid, signal.SIGTERM)
562
#if self.checker.poll() is None:
563
# os.kill(self.checker.pid, signal.SIGKILL)
564
except OSError as error:
565
if error.errno != errno.ESRCH: # No such process
1169
567
self.checker = None
1172
def dbus_service_property(dbus_interface,
570
def dbus_service_property(dbus_interface, signature="v",
571
access="readwrite", byte_arrays=False):
1176
572
"""Decorators for marking methods of a DBusObjectWithProperties to
1177
573
become properties on the D-Bus.
1179
575
The decorated method will be called with no arguments by "Get"
1180
576
and with one argument by "Set".
1182
578
The parameters, where they are supported, are the same as
1183
579
dbus.service.method, except there is only "signature", since the
1184
580
type from Get() and the type sent to Set() is the same.
1517
750
except (AttributeError, xml.dom.DOMException,
1518
751
xml.parsers.expat.ExpatError) as error:
1519
752
logger.error("Failed to override Introspection method",
1525
dbus.OBJECT_MANAGER_IFACE
1526
except AttributeError:
1527
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1530
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1531
"""A D-Bus object with an ObjectManager.
1533
Classes inheriting from this exposes the standard
1534
GetManagedObjects call and the InterfacesAdded and
1535
InterfacesRemoved signals on the standard
1536
"org.freedesktop.DBus.ObjectManager" interface.
1538
Note: No signals are sent automatically; they must be sent
1541
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1542
out_signature="a{oa{sa{sv}}}")
1543
def GetManagedObjects(self):
1544
"""This function must be overridden"""
1545
raise NotImplementedError()
1547
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1548
signature="oa{sa{sv}}")
1549
def InterfacesAdded(self, object_path, interfaces_and_properties):
1552
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1553
def InterfacesRemoved(self, object_path, interfaces):
1556
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1558
path_keyword='object_path',
1559
connection_keyword='connection')
1560
def Introspect(self, object_path, connection):
1561
"""Overloading of standard D-Bus method.
1563
Override return argument name of GetManagedObjects to be
1564
"objpath_interfaces_and_properties"
1566
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1570
document = xml.dom.minidom.parseString(xmlstring)
1572
for if_tag in document.getElementsByTagName("interface"):
1573
# Fix argument name for the GetManagedObjects method
1574
if (if_tag.getAttribute("name")
1575
== dbus.OBJECT_MANAGER_IFACE):
1576
for cn in if_tag.getElementsByTagName("method"):
1577
if (cn.getAttribute("name")
1578
== "GetManagedObjects"):
1579
for arg in cn.getElementsByTagName("arg"):
1580
if (arg.getAttribute("direction")
1584
"objpath_interfaces"
1586
xmlstring = document.toxml("utf-8")
1588
except (AttributeError, xml.dom.DOMException,
1589
xml.parsers.expat.ExpatError) as error:
1590
logger.error("Failed to override Introspection method",
1595
def datetime_to_dbus(dt, variant_level=0):
757
def datetime_to_dbus (dt, variant_level=0):
1596
758
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1598
return dbus.String("", variant_level=variant_level)
1599
return dbus.String(dt.isoformat(), variant_level=variant_level)
1602
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1603
"""A class decorator; applied to a subclass of
1604
dbus.service.Object, it will add alternate D-Bus attributes with
1605
interface names according to the "alt_interface_names" mapping.
1608
@alternate_dbus_interfaces({"org.example.Interface":
1609
"net.example.AlternateInterface"})
1610
class SampleDBusObject(dbus.service.Object):
1611
@dbus.service.method("org.example.Interface")
1612
def SampleDBusMethod():
1615
The above "SampleDBusMethod" on "SampleDBusObject" will be
1616
reachable via two interfaces: "org.example.Interface" and
1617
"net.example.AlternateInterface", the latter of which will have
1618
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1619
"true", unless "deprecate" is passed with a False value.
1621
This works for methods and signals, and also for D-Bus properties
1622
(from DBusObjectWithProperties) and interfaces (from the
1623
dbus_interface_annotations decorator).
760
return dbus.String("", variant_level = variant_level)
761
return dbus.String(dt.isoformat(),
762
variant_level=variant_level)
764
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
766
"""Applied to an empty subclass of a D-Bus object, this metaclass
767
will add additional D-Bus attributes matching a certain pattern.
1627
for orig_interface_name, alt_interface_name in (
1628
alt_interface_names.items()):
1630
interface_names = set()
1631
# Go though all attributes of the class
1632
for attrname, attribute in inspect.getmembers(cls):
769
def __new__(mcs, name, bases, attr):
770
# Go through all the base classes which could have D-Bus
771
# methods, signals, or properties in them
772
for base in (b for b in bases
773
if issubclass(b, dbus.service.Object)):
774
# Go though all attributes of the base class
775
for attrname, attribute in inspect.getmembers(base):
1633
776
# Ignore non-D-Bus attributes, and D-Bus attributes
1634
777
# with the wrong interface name
1635
778
if (not hasattr(attribute, "_dbus_interface")
1636
or not attribute._dbus_interface.startswith(
1637
orig_interface_name)):
779
or not attribute._dbus_interface
780
.startswith("se.recompile.Mandos")):
1639
782
# Create an alternate D-Bus interface name based on
1640
783
# the current name
1641
alt_interface = attribute._dbus_interface.replace(
1642
orig_interface_name, alt_interface_name)
1643
interface_names.add(alt_interface)
784
alt_interface = (attribute._dbus_interface
785
.replace("se.recompile.Mandos",
786
"se.bsnet.fukt.Mandos"))
1644
787
# Is this a D-Bus signal?
1645
788
if getattr(attribute, "_dbus_is_signal", False):
1646
# Extract the original non-method undecorated
1647
# function by black magic
1648
if sys.version_info.major == 2:
1649
nonmethod_func = (dict(
789
# Extract the original non-method function by
791
nonmethod_func = (dict(
1650
792
zip(attribute.func_code.co_freevars,
1651
attribute.__closure__))
1652
["func"].cell_contents)
1654
nonmethod_func = (dict(
1655
zip(attribute.__code__.co_freevars,
1656
attribute.__closure__))
1657
["func"].cell_contents)
793
attribute.__closure__))["func"]
1658
795
# Create a new, but exactly alike, function
1659
796
# object, and decorate it to be a new D-Bus signal
1660
797
# with the alternate D-Bus interface name
1661
new_function = copy_function(nonmethod_func)
1662
new_function = (dbus.service.signal(
1664
attribute._dbus_signature)(new_function))
1665
# Copy annotations, if any
1667
new_function._dbus_annotations = dict(
1668
attribute._dbus_annotations)
1669
except AttributeError:
798
new_function = (dbus.service.signal
800
attribute._dbus_signature)
802
nonmethod_func.func_code,
803
nonmethod_func.func_globals,
804
nonmethod_func.func_name,
805
nonmethod_func.func_defaults,
806
nonmethod_func.func_closure)))
1672
807
# Define a creator of a function to call both the
1673
# original and alternate functions, so both the
1674
# original and alternate signals gets sent when
1675
# the function is called
808
# old and new functions, so both the old and new
809
# signals gets sent when the function is called
1676
810
def fixscope(func1, func2):
1677
811
"""This function is a scope container to pass
1678
812
func1 and func2 to the "call_both" function
1679
813
outside of its arguments"""
1681
@functools.wraps(func2)
1682
814
def call_both(*args, **kwargs):
1683
815
"""This function will emit two D-Bus
1684
816
signals by calling func1 and func2"""
1685
817
func1(*args, **kwargs)
1686
818
func2(*args, **kwargs)
1687
# Make wrapper function look like a D-Bus
1689
for name, attr in inspect.getmembers(func2):
1690
if name.startswith("_dbus_"):
1691
setattr(call_both, name, attr)
1693
819
return call_both
1694
820
# Create the "call_both" function and add it to
1696
attr[attrname] = fixscope(attribute, new_function)
822
attr[attrname] = fixscope(attribute,
1697
824
# Is this a D-Bus method?
1698
825
elif getattr(attribute, "_dbus_is_method", False):
1699
826
# Create a new, but exactly alike, function
1700
827
# object. Decorate it to be a new D-Bus method
1701
828
# with the alternate D-Bus interface name. Add it
1704
dbus.service.method(
1706
attribute._dbus_in_signature,
1707
attribute._dbus_out_signature)
1708
(copy_function(attribute)))
1709
# Copy annotations, if any
1711
attr[attrname]._dbus_annotations = dict(
1712
attribute._dbus_annotations)
1713
except AttributeError:
830
attr[attrname] = (dbus.service.method
832
attribute._dbus_in_signature,
833
attribute._dbus_out_signature)
835
(attribute.func_code,
836
attribute.func_globals,
838
attribute.func_defaults,
839
attribute.func_closure)))
1715
840
# Is this a D-Bus property?
1716
841
elif getattr(attribute, "_dbus_is_property", False):
1717
842
# Create a new, but exactly alike, function
1718
843
# object, and decorate it to be a new D-Bus
1719
844
# property with the alternate D-Bus interface
1720
845
# name. Add it to the class.
1721
attr[attrname] = (dbus_service_property(
1722
alt_interface, attribute._dbus_signature,
1723
attribute._dbus_access,
1724
attribute._dbus_get_args_options
1726
(copy_function(attribute)))
1727
# Copy annotations, if any
1729
attr[attrname]._dbus_annotations = dict(
1730
attribute._dbus_annotations)
1731
except AttributeError:
1733
# Is this a D-Bus interface?
1734
elif getattr(attribute, "_dbus_is_interface", False):
1735
# Create a new, but exactly alike, function
1736
# object. Decorate it to be a new D-Bus interface
1737
# with the alternate D-Bus interface name. Add it
1740
dbus_interface_annotations(alt_interface)
1741
(copy_function(attribute)))
1743
# Deprecate all alternate interfaces
1744
iname = "_AlternateDBusNames_interface_annotation{}"
1745
for interface_name in interface_names:
1747
@dbus_interface_annotations(interface_name)
1749
return {"org.freedesktop.DBus.Deprecated":
1751
# Find an unused name
1752
for aname in (iname.format(i)
1753
for i in itertools.count()):
1754
if aname not in attr:
1758
# Replace the class with a new subclass of it with
1759
# methods, signals, etc. as created above.
1760
if sys.version_info.major == 2:
1761
cls = type(b"{}Alternate".format(cls.__name__),
1764
cls = type("{}Alternate".format(cls.__name__),
1771
@alternate_dbus_interfaces({"se.recompile.Mandos":
1772
"se.bsnet.fukt.Mandos"})
846
attr[attrname] = (dbus_service_property
848
attribute._dbus_signature,
849
attribute._dbus_access,
851
._dbus_get_args_options
854
(attribute.func_code,
855
attribute.func_globals,
857
attribute.func_defaults,
858
attribute.func_closure)))
859
return type.__new__(mcs, name, bases, attr)
1773
861
class ClientDBus(Client, DBusObjectWithProperties):
1774
862
"""A Client class using D-Bus
1777
865
dbus_object_path: dbus.ObjectPath
1778
866
bus: dbus.SystemBus()
1781
869
runtime_expansions = (Client.runtime_expansions
1782
+ ("dbus_object_path", ))
1784
_interface = "se.recompile.Mandos.Client"
870
+ ("dbus_object_path",))
1786
872
# dbus.service.Object doesn't use super(), so we can't either.
1788
def __init__(self, bus=None, *args, **kwargs):
874
def __init__(self, bus = None, *args, **kwargs):
875
self._approvals_pending = 0
1790
877
Client.__init__(self, *args, **kwargs)
1791
878
# Only now, when this client is initialized, can it show up on
1793
client_object_name = str(self.name).translate(
880
client_object_name = unicode(self.name).translate(
1794
881
{ord("."): ord("_"),
1795
882
ord("-"): ord("_")})
1796
self.dbus_object_path = dbus.ObjectPath(
1797
"/clients/" + client_object_name)
883
self.dbus_object_path = (dbus.ObjectPath
884
("/clients/" + client_object_name))
1798
885
DBusObjectWithProperties.__init__(self, self.bus,
1799
886
self.dbus_object_path)
1801
def notifychangeproperty(transform_func, dbus_name,
1802
type_func=lambda x: x,
1804
invalidate_only=False,
1805
_interface=_interface):
888
def notifychangeproperty(transform_func,
889
dbus_name, type_func=lambda x: x,
1806
891
""" Modify a variable so that it's a property which announces
1807
892
its changes to DBus.
2202
1244
self.start_checker()
2204
1246
self.stop_checker()
2206
1248
# ObjectPath - property
2208
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2209
"org.freedesktop.DBus.Deprecated": "true"})
2210
1249
@dbus_service_property(_interface, signature="o", access="read")
2211
1250
def ObjectPath_dbus_property(self):
2212
return self.dbus_object_path # is already a dbus.ObjectPath
1251
return self.dbus_object_path # is already a dbus.ObjectPath
2214
1253
# Secret = property
2216
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2218
@dbus_service_property(_interface,
1254
@dbus_service_property(_interface, signature="ay",
1255
access="write", byte_arrays=True)
2222
1256
def Secret_dbus_property(self, value):
2223
self.secret = bytes(value)
1257
self.secret = str(value)
2229
def __init__(self, child_pipe, key_id, fpr, address):
1262
class ProxyClient(object):
1263
def __init__(self, child_pipe, fpr, address):
2230
1264
self._pipe = child_pipe
2231
self._pipe.send(('init', key_id, fpr, address))
1265
self._pipe.send(('init', fpr, address))
2232
1266
if not self._pipe.recv():
2233
raise KeyError(key_id or fpr)
2235
1269
def __getattribute__(self, name):
1270
if(name == '_pipe'):
2237
1271
return super(ProxyClient, self).__getattribute__(name)
2238
1272
self._pipe.send(('getattr', name))
2239
1273
data = self._pipe.recv()
2240
1274
if data[0] == 'data':
2242
1276
if data[0] == 'function':
2244
1277
def func(*args, **kwargs):
2245
1278
self._pipe.send(('funcall', name, args, kwargs))
2246
1279
return self._pipe.recv()[1]
2250
1282
def __setattr__(self, name, value):
1283
if(name == '_pipe'):
2252
1284
return super(ProxyClient, self).__setattr__(name, value)
2253
1285
self._pipe.send(('setattr', name, value))
1287
class ClientDBusTransitional(ClientDBus):
1288
__metaclass__ = AlternateDBusNamesMetaclass
2256
1290
class ClientHandler(socketserver.BaseRequestHandler, object):
2257
1291
"""A class to handle client connections.
2259
1293
Instantiated once for each connection to handle it.
2260
1294
Note: This will run in its own forked process."""
2262
1296
def handle(self):
2263
1297
with contextlib.closing(self.server.child_pipe) as child_pipe:
2264
1298
logger.info("TCP connection from: %s",
2265
str(self.client_address))
1299
unicode(self.client_address))
2266
1300
logger.debug("Pipe FD: %d",
2267
1301
self.server.child_pipe.fileno())
2269
session = gnutls.ClientSession(self.request)
2271
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2272
# "+AES-256-CBC", "+SHA1",
2273
# "+COMP-NULL", "+CTYPE-OPENPGP",
1303
session = (gnutls.connection
1304
.ClientSession(self.request,
1306
.X509Credentials()))
1308
# Note: gnutls.connection.X509Credentials is really a
1309
# generic GnuTLS certificate credentials object so long as
1310
# no X.509 keys are added to it. Therefore, we can use it
1311
# here despite using OpenPGP certificates.
1313
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1314
# "+AES-256-CBC", "+SHA1",
1315
# "+COMP-NULL", "+CTYPE-OPENPGP",
2275
1317
# Use a fallback default, since this MUST be set.
2276
1318
priority = self.server.gnutls_priority
2277
1319
if priority is None:
2278
1320
priority = "NORMAL"
2279
gnutls.priority_set_direct(session._c_object,
2280
priority.encode("utf-8"),
1321
(gnutls.library.functions
1322
.gnutls_priority_set_direct(session._c_object,
2283
1325
# Start communication using the Mandos protocol
2284
1326
# Get protocol number
2285
1327
line = self.request.makefile().readline()
2286
1328
logger.debug("Protocol version: %r", line)
2288
1330
if int(line.strip().split()[0]) > 1:
2289
raise RuntimeError(line)
2290
1332
except (ValueError, IndexError, RuntimeError) as error:
2291
1333
logger.error("Unknown protocol version: %s", error)
2294
1336
# Start GnuTLS connection
2296
1338
session.handshake()
2297
except gnutls.Error as error:
1339
except gnutls.errors.GNUTLSError as error:
2298
1340
logger.warning("Handshake failed: %s", error)
2299
1341
# Do not run session.bye() here: the session is not
2300
1342
# established. Just abandon the request.
2302
1344
logger.debug("Handshake succeeded")
2304
1346
approval_required = False
2306
if gnutls.has_rawpk:
2309
key_id = self.key_id(
2310
self.peer_certificate(session))
2311
except (TypeError, gnutls.Error) as error:
2312
logger.warning("Bad certificate: %s", error)
2314
logger.debug("Key ID: %s", key_id)
2319
fpr = self.fingerprint(
2320
self.peer_certificate(session))
2321
except (TypeError, gnutls.Error) as error:
2322
logger.warning("Bad certificate: %s", error)
2324
logger.debug("Fingerprint: %s", fpr)
2327
client = ProxyClient(child_pipe, key_id, fpr,
1349
fpr = self.fingerprint(self.peer_certificate
1352
gnutls.errors.GNUTLSError) as error:
1353
logger.warning("Bad certificate: %s", error)
1355
logger.debug("Fingerprint: %s", fpr)
1358
client = ProxyClient(child_pipe, fpr,
2328
1359
self.client_address)
2329
1360
except KeyError:
2332
1363
if client.approval_delay:
2333
1364
delay = client.approval_delay
2334
1365
client.approvals_pending += 1
2335
1366
approval_required = True
2338
1369
if not client.enabled:
2339
1370
logger.info("Client %s is disabled",
2341
1372
if self.server.use_dbus:
2342
1373
# Emit D-Bus signal
2343
1374
client.Rejected("Disabled")
2346
if client.approved or not client.approval_delay:
2347
# We are approved or approval is disabled
1377
if client._approved or not client.approval_delay:
1378
#We are approved or approval is disabled
2349
elif client.approved is None:
1380
elif client._approved is None:
2350
1381
logger.info("Client %s needs approval",
2352
1383
if self.server.use_dbus:
2353
1384
# Emit D-Bus signal
2354
1385
client.NeedApproval(
2355
client.approval_delay.total_seconds()
2356
* 1000, client.approved_by_default)
1386
client.approval_delay_milliseconds(),
1387
client.approved_by_default)
2358
1389
logger.warning("Client %s was not approved",
2383
1416
delay -= time2 - time
2386
session.send(client.secret)
2387
except gnutls.Error as error:
2388
logger.warning("gnutls send failed",
1419
while sent_size < len(client.secret):
1421
sent = session.send(client.secret[sent_size:])
1422
except gnutls.errors.GNUTLSError as error:
1423
logger.warning("gnutls send failed")
1425
logger.debug("Sent: %d, remaining: %d",
1426
sent, len(client.secret)
1427
- (sent_size + sent))
2392
1430
logger.info("Sending secret to %s", client.name)
2393
1431
# bump the timeout using extended_timeout
2394
client.bump_timeout(client.extended_timeout)
1432
client.checked_ok(client.extended_timeout)
2395
1433
if self.server.use_dbus:
2396
1434
# Emit D-Bus signal
2397
1435
client.GotSecret()
2400
1438
if approval_required:
2401
1439
client.approvals_pending -= 1
2404
except gnutls.Error as error:
2405
logger.warning("GnuTLS bye failed",
1442
except gnutls.errors.GNUTLSError as error:
1443
logger.warning("GnuTLS bye failed")
2409
1446
def peer_certificate(session):
2410
"Return the peer's certificate as a bytestring"
2412
cert_type = gnutls.certificate_type_get2(session._c_object,
2414
except AttributeError:
2415
cert_type = gnutls.certificate_type_get(session._c_object)
2416
if gnutls.has_rawpk:
2417
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2419
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2420
# If not a valid certificate type...
2421
if cert_type not in valid_cert_types:
2422
logger.info("Cert type %r not in %r", cert_type,
2424
# ...return invalid data
1447
"Return the peer's OpenPGP certificate as a bytestring"
1448
# If not an OpenPGP certificate...
1449
if (gnutls.library.functions
1450
.gnutls_certificate_type_get(session._c_object)
1451
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1452
# ...do the normal thing
1453
return session.peer_certificate
2426
1454
list_size = ctypes.c_uint(1)
2427
cert_list = (gnutls.certificate_get_peers
1455
cert_list = (gnutls.library.functions
1456
.gnutls_certificate_get_peers
2428
1457
(session._c_object, ctypes.byref(list_size)))
2429
1458
if not bool(cert_list) and list_size.value != 0:
2430
raise gnutls.Error("error getting peer certificate")
1459
raise gnutls.errors.GNUTLSError("error getting peer"
2431
1461
if list_size.value == 0:
2433
1463
cert = cert_list[0]
2434
1464
return ctypes.string_at(cert.data, cert.size)
2437
def key_id(certificate):
2438
"Convert a certificate bytestring to a hexdigit key ID"
2439
# New GnuTLS "datum" with the public key
2440
datum = gnutls.datum_t(
2441
ctypes.cast(ctypes.c_char_p(certificate),
2442
ctypes.POINTER(ctypes.c_ubyte)),
2443
ctypes.c_uint(len(certificate)))
2444
# XXX all these need to be created in the gnutls "module"
2445
# New empty GnuTLS certificate
2446
pubkey = gnutls.pubkey_t()
2447
gnutls.pubkey_init(ctypes.byref(pubkey))
2448
# Import the raw public key into the certificate
2449
gnutls.pubkey_import(pubkey,
2450
ctypes.byref(datum),
2451
gnutls.X509_FMT_DER)
2452
# New buffer for the key ID
2453
buf = ctypes.create_string_buffer(32)
2454
buf_len = ctypes.c_size_t(len(buf))
2455
# Get the key ID from the raw public key into the buffer
2456
gnutls.pubkey_get_key_id(pubkey,
2457
gnutls.KEYID_USE_SHA256,
2458
ctypes.cast(ctypes.byref(buf),
2459
ctypes.POINTER(ctypes.c_ubyte)),
2460
ctypes.byref(buf_len))
2461
# Deinit the certificate
2462
gnutls.pubkey_deinit(pubkey)
2464
# Convert the buffer to a Python bytestring
2465
key_id = ctypes.string_at(buf, buf_len.value)
2466
# Convert the bytestring to hexadecimal notation
2467
hex_key_id = binascii.hexlify(key_id).upper()
2471
1467
def fingerprint(openpgp):
2472
1468
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2473
1469
# New GnuTLS "datum" with the OpenPGP public key
2474
datum = gnutls.datum_t(
2475
ctypes.cast(ctypes.c_char_p(openpgp),
2476
ctypes.POINTER(ctypes.c_ubyte)),
2477
ctypes.c_uint(len(openpgp)))
1470
datum = (gnutls.library.types
1471
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1474
ctypes.c_uint(len(openpgp))))
2478
1475
# New empty GnuTLS certificate
2479
crt = gnutls.openpgp_crt_t()
2480
gnutls.openpgp_crt_init(ctypes.byref(crt))
1476
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1477
(gnutls.library.functions
1478
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2481
1479
# Import the OpenPGP public key into the certificate
2482
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2483
gnutls.OPENPGP_FMT_RAW)
1480
(gnutls.library.functions
1481
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1482
gnutls.library.constants
1483
.GNUTLS_OPENPGP_FMT_RAW))
2484
1484
# Verify the self signature in the key
2485
1485
crtverify = ctypes.c_uint()
2486
gnutls.openpgp_crt_verify_self(crt, 0,
2487
ctypes.byref(crtverify))
1486
(gnutls.library.functions
1487
.gnutls_openpgp_crt_verify_self(crt, 0,
1488
ctypes.byref(crtverify)))
2488
1489
if crtverify.value != 0:
2489
gnutls.openpgp_crt_deinit(crt)
2490
raise gnutls.CertificateSecurityError(code
1490
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1491
raise (gnutls.errors.CertificateSecurityError
2492
1493
# New buffer for the fingerprint
2493
1494
buf = ctypes.create_string_buffer(20)
2494
1495
buf_len = ctypes.c_size_t()
2495
1496
# Get the fingerprint from the certificate into the buffer
2496
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2497
ctypes.byref(buf_len))
1497
(gnutls.library.functions
1498
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1499
ctypes.byref(buf_len)))
2498
1500
# Deinit the certificate
2499
gnutls.openpgp_crt_deinit(crt)
1501
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2500
1502
# Convert the buffer to a Python bytestring
2501
1503
fpr = ctypes.string_at(buf, buf_len.value)
2502
1504
# Convert the bytestring to hexadecimal notation
2503
hex_fpr = binascii.hexlify(fpr).upper()
1505
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2507
class MultiprocessingMixIn:
1509
class MultiprocessingMixIn(object):
2508
1510
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2510
1511
def sub_process_main(self, request, address):
2512
1513
self.finish_request(request, address)
2514
1515
self.handle_error(request, address)
2515
1516
self.close_request(request)
2517
1518
def process_request(self, request, address):
2518
1519
"""Start a new process to process the request."""
2519
proc = multiprocessing.Process(target=self.sub_process_main,
2520
args=(request, address))
1520
proc = multiprocessing.Process(target = self.sub_process_main,
2525
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1527
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2526
1528
""" adds a pipe to the MixIn """
2528
1529
def process_request(self, request, client_address):
2529
1530
"""Overrides and wraps the original process_request().
2531
1532
This function creates a new pipe in self.pipe
2533
1534
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2535
1536
proc = MultiprocessingMixIn.process_request(self, request,
2536
1537
client_address)
2537
1538
self.child_pipe.close()
2538
1539
self.add_pipe(parent_pipe, proc)
2540
1541
def add_pipe(self, parent_pipe, proc):
2541
1542
"""Dummy function; override as necessary"""
2542
raise NotImplementedError()
1543
raise NotImplementedError
2545
1546
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2546
socketserver.TCPServer):
1547
socketserver.TCPServer, object):
2547
1548
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2550
1551
enabled: Boolean; whether this server is activated yet
2551
1552
interface: None or a network interface name (string)
2552
1553
use_ipv6: Boolean; to use IPv6 or not
2555
1555
def __init__(self, server_address, RequestHandlerClass,
2559
"""If socketfd is set, use that file descriptor instead of
2560
creating a new one with socket.socket().
1556
interface=None, use_ipv6=True):
2562
1557
self.interface = interface
2564
1559
self.address_family = socket.AF_INET6
2565
if socketfd is not None:
2566
# Save the file descriptor
2567
self.socketfd = socketfd
2568
# Save the original socket.socket() function
2569
self.socket_socket = socket.socket
2571
# To implement --socket, we monkey patch socket.socket.
2573
# (When socketserver.TCPServer is a new-style class, we
2574
# could make self.socket into a property instead of monkey
2575
# patching socket.socket.)
2577
# Create a one-time-only replacement for socket.socket()
2578
@functools.wraps(socket.socket)
2579
def socket_wrapper(*args, **kwargs):
2580
# Restore original function so subsequent calls are
2582
socket.socket = self.socket_socket
2583
del self.socket_socket
2584
# This time only, return a new socket object from the
2585
# saved file descriptor.
2586
return socket.fromfd(self.socketfd, *args, **kwargs)
2587
# Replace socket.socket() function with wrapper
2588
socket.socket = socket_wrapper
2589
# The socketserver.TCPServer.__init__ will call
2590
# socket.socket(), which might be our replacement,
2591
# socket_wrapper(), if socketfd was set.
2592
1560
socketserver.TCPServer.__init__(self, server_address,
2593
1561
RequestHandlerClass)
2595
1562
def server_bind(self):
2596
1563
"""This overrides the normal server_bind() function
2597
1564
to bind to an interface if one was specified, and also NOT to
2598
1565
bind to an address or port if they were not specified."""
2599
global SO_BINDTODEVICE
2600
1566
if self.interface is not None:
2601
1567
if SO_BINDTODEVICE is None:
2602
# Fall back to a hard-coded value which seems to be
2604
logger.warning("SO_BINDTODEVICE not found, trying 25")
2605
SO_BINDTODEVICE = 25
2607
self.socket.setsockopt(
2608
socket.SOL_SOCKET, SO_BINDTODEVICE,
2609
(self.interface + "\0").encode("utf-8"))
2610
except socket.error as error:
2611
if error.errno == errno.EPERM:
2612
logger.error("No permission to bind to"
2613
" interface %s", self.interface)
2614
elif error.errno == errno.ENOPROTOOPT:
2615
logger.error("SO_BINDTODEVICE not available;"
2616
" cannot bind to interface %s",
2618
elif error.errno == errno.ENODEV:
2619
logger.error("Interface %s does not exist,"
2620
" cannot bind", self.interface)
1568
logger.error("SO_BINDTODEVICE does not exist;"
1569
" cannot bind to interface %s",
1573
self.socket.setsockopt(socket.SOL_SOCKET,
1577
except socket.error as error:
1578
if error[0] == errno.EPERM:
1579
logger.error("No permission to"
1580
" bind to interface %s",
1582
elif error[0] == errno.ENOPROTOOPT:
1583
logger.error("SO_BINDTODEVICE not available;"
1584
" cannot bind to interface %s",
2623
1588
# Only bind(2) the socket if we really need to.
2624
1589
if self.server_address[0] or self.server_address[1]:
2625
if self.server_address[1]:
2626
self.allow_reuse_address = True
2627
1590
if not self.server_address[0]:
2628
1591
if self.address_family == socket.AF_INET6:
2629
any_address = "::" # in6addr_any
1592
any_address = "::" # in6addr_any
2631
any_address = "0.0.0.0" # INADDR_ANY
1594
any_address = socket.INADDR_ANY
2632
1595
self.server_address = (any_address,
2633
1596
self.server_address[1])
2634
1597
elif not self.server_address[1]:
2635
self.server_address = (self.server_address[0], 0)
1598
self.server_address = (self.server_address[0],
2636
1600
# if self.interface:
2637
1601
# self.server_address = (self.server_address[0],
2965
1847
parser.add_argument("--no-dbus", action="store_false",
2966
1848
dest="use_dbus", help="Do not provide D-Bus"
2967
" system bus interface", default=None)
1849
" system bus interface")
2968
1850
parser.add_argument("--no-ipv6", action="store_false",
2969
dest="use_ipv6", help="Do not use IPv6",
2971
parser.add_argument("--no-restore", action="store_false",
2972
dest="restore", help="Do not restore stored"
2973
" state", default=None)
2974
parser.add_argument("--socket", type=int,
2975
help="Specify a file descriptor to a network"
2976
" socket to use instead of creating one")
2977
parser.add_argument("--statedir", metavar="DIR",
2978
help="Directory to save/restore state in")
2979
parser.add_argument("--foreground", action="store_true",
2980
help="Run in foreground", default=None)
2981
parser.add_argument("--no-zeroconf", action="store_false",
2982
dest="zeroconf", help="Do not use Zeroconf",
1851
dest="use_ipv6", help="Do not use IPv6")
2985
1852
options = parser.parse_args()
2987
1859
# Default values for config file for server-global settings
2988
if gnutls.has_rawpk:
2989
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2990
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2992
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2993
":+SIGN-DSA-SHA256")
2994
server_defaults = {"interface": "",
2998
"priority": priority,
2999
"servicename": "Mandos",
3005
"statedir": "/var/lib/mandos",
3006
"foreground": "False",
1860
server_defaults = { "interface": "",
1865
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1866
"servicename": "Mandos",
3011
1872
# Parse config file for server-global settings
3012
server_config = configparser.ConfigParser(server_defaults)
1873
server_config = configparser.SafeConfigParser(server_defaults)
3013
1874
del server_defaults
3014
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3015
# Convert the ConfigParser object to a dict
1875
server_config.read(os.path.join(options.configdir,
1877
# Convert the SafeConfigParser object to a dict
3016
1878
server_settings = server_config.defaults()
3017
1879
# Use the appropriate methods on the non-string config options
3018
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3019
"foreground", "zeroconf"):
1880
for option in ("debug", "use_dbus", "use_ipv6"):
3020
1881
server_settings[option] = server_config.getboolean("DEFAULT",
3022
1883
if server_settings["port"]:
3023
1884
server_settings["port"] = server_config.getint("DEFAULT",
3025
if server_settings["socket"]:
3026
server_settings["socket"] = server_config.getint("DEFAULT",
3028
# Later, stdin will, and stdout and stderr might, be dup'ed
3029
# over with an opened os.devnull. But we don't want this to
3030
# happen with a supplied network socket.
3031
if 0 <= server_settings["socket"] <= 2:
3032
server_settings["socket"] = os.dup(server_settings
3034
1886
del server_config
3036
1888
# Override the settings from the config file with command line
3037
1889
# options, if set.
3038
1890
for option in ("interface", "address", "port", "debug",
3039
"priority", "servicename", "configdir", "use_dbus",
3040
"use_ipv6", "debuglevel", "restore", "statedir",
3041
"socket", "foreground", "zeroconf"):
1891
"priority", "servicename", "configdir",
1892
"use_dbus", "use_ipv6", "debuglevel"):
3042
1893
value = getattr(options, option)
3043
1894
if value is not None:
3044
1895
server_settings[option] = value
3046
1897
# Force all strings to be unicode
3047
1898
for option in server_settings.keys():
3048
if isinstance(server_settings[option], bytes):
3049
server_settings[option] = (server_settings[option]
3051
# Force all boolean options to be boolean
3052
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3053
"foreground", "zeroconf"):
3054
server_settings[option] = bool(server_settings[option])
3055
# Debug implies foreground
3056
if server_settings["debug"]:
3057
server_settings["foreground"] = True
1899
if type(server_settings[option]) is str:
1900
server_settings[option] = unicode(server_settings[option])
3058
1901
# Now we have our good server settings in "server_settings"
3060
1903
##################################################################
3062
if (not server_settings["zeroconf"]
3063
and not (server_settings["port"]
3064
or server_settings["socket"] != "")):
3065
parser.error("Needs port or socket to work without Zeroconf")
3067
1905
# For convenience
3068
1906
debug = server_settings["debug"]
3069
1907
debuglevel = server_settings["debuglevel"]
3070
1908
use_dbus = server_settings["use_dbus"]
3071
1909
use_ipv6 = server_settings["use_ipv6"]
3072
stored_state_path = os.path.join(server_settings["statedir"],
3074
foreground = server_settings["foreground"]
3075
zeroconf = server_settings["zeroconf"]
3078
initlogger(debug, logging.DEBUG)
3083
level = getattr(logging, debuglevel.upper())
3084
initlogger(debug, level)
3086
1911
if server_settings["servicename"] != "Mandos":
3087
syslogger.setFormatter(
3088
logging.Formatter('Mandos ({}) [%(process)d]:'
3089
' %(levelname)s: %(message)s'.format(
3090
server_settings["servicename"])))
1912
syslogger.setFormatter(logging.Formatter
1913
('Mandos (%s) [%%(process)d]:'
1914
' %%(levelname)s: %%(message)s'
1915
% server_settings["servicename"]))
3092
1917
# Parse config file with clients
3093
client_config = configparser.ConfigParser(Client.client_defaults)
1918
client_defaults = { "timeout": "5m",
1919
"extended_timeout": "15m",
1921
"checker": "fping -q -- %%(host)s",
1923
"approval_delay": "0s",
1924
"approval_duration": "1s",
1926
client_config = configparser.SafeConfigParser(client_defaults)
3094
1927
client_config.read(os.path.join(server_settings["configdir"],
3095
1928
"clients.conf"))
3097
1930
global mandos_dbus_service
3098
1931
mandos_dbus_service = None
3101
if server_settings["socket"] != "":
3102
socketfd = server_settings["socket"]
3103
tcp_server = MandosServer(
3104
(server_settings["address"], server_settings["port"]),
3106
interface=(server_settings["interface"] or None),
3108
gnutls_priority=server_settings["priority"],
3112
pidfilename = "/run/mandos.pid"
3113
if not os.path.isdir("/run/."):
3114
pidfilename = "/var/run/mandos.pid"
3117
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3118
except IOError as e:
3119
logger.error("Could not open file %r", pidfilename,
3122
for name, group in (("_mandos", "_mandos"),
3123
("mandos", "mandos"),
3124
("nobody", "nogroup")):
3126
uid = pwd.getpwnam(name).pw_uid
3127
gid = pwd.getpwnam(group).pw_gid
1933
tcp_server = MandosServer((server_settings["address"],
1934
server_settings["port"]),
1936
interface=(server_settings["interface"]
1940
server_settings["priority"],
1943
pidfilename = "/var/run/mandos.pid"
1945
pidfile = open(pidfilename, "w")
1947
logger.error("Could not open file %r", pidfilename)
1950
uid = pwd.getpwnam("_mandos").pw_uid
1951
gid = pwd.getpwnam("_mandos").pw_gid
1954
uid = pwd.getpwnam("mandos").pw_uid
1955
gid = pwd.getpwnam("mandos").pw_gid
3129
1956
except KeyError:
1958
uid = pwd.getpwnam("nobody").pw_uid
1959
gid = pwd.getpwnam("nobody").pw_gid
3138
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3140
1966
except OSError as error:
3141
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3142
.format(uid, gid, os.strerror(error.errno)))
3143
if error.errno != errno.EPERM:
1967
if error[0] != errno.EPERM:
1970
if not debug and not debuglevel:
1971
syslogger.setLevel(logging.WARNING)
1972
console.setLevel(logging.WARNING)
1974
level = getattr(logging, debuglevel.upper())
1975
syslogger.setLevel(level)
1976
console.setLevel(level)
3147
1979
# Enable all possible GnuTLS debugging
3149
1981
# "Use a log level over 10 to enable all debugging options."
3150
1982
# - GnuTLS manual
3151
gnutls.global_set_log_level(11)
1983
gnutls.library.functions.gnutls_global_set_log_level(11)
1985
@gnutls.library.types.gnutls_log_func
3154
1986
def debug_gnutls(level, string):
3155
1987
logger.debug("GnuTLS: %s", string[:-1])
3157
gnutls.global_set_log_function(debug_gnutls)
1989
(gnutls.library.functions
1990
.gnutls_global_set_log_function(debug_gnutls))
3159
1992
# Redirect stdin so all checkers get /dev/null
3160
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1993
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3161
1994
os.dup2(null, sys.stdin.fileno())
1998
# No console logging
1999
logger.removeHandler(console)
3165
2001
# Need to fork before connecting to D-Bus
3167
2003
# Close all input and output, do double fork, etc.
3170
if gi.version_info < (3, 10, 2):
3171
# multiprocessing will use threads, so before we use GLib we
3172
# need to inform GLib that threads will be used.
3175
2006
global main_loop
3176
2007
# From the Avahi example code
3177
DBusGMainLoop(set_as_default=True)
3178
main_loop = GLib.MainLoop()
2008
DBusGMainLoop(set_as_default=True )
2009
main_loop = gobject.MainLoop()
3179
2010
bus = dbus.SystemBus()
3180
2011
# End of Avahi example code
3183
2014
bus_name = dbus.service.BusName("se.recompile.Mandos",
3186
old_bus_name = dbus.service.BusName(
3187
"se.bsnet.fukt.Mandos", bus,
3189
except dbus.exceptions.DBusException as e:
3190
logger.error("Disabling D-Bus:", exc_info=e)
2015
bus, do_not_queue=True)
2016
old_bus_name = (dbus.service.BusName
2017
("se.bsnet.fukt.Mandos", bus,
2019
except dbus.exceptions.NameExistsException as e:
2020
logger.error(unicode(e) + ", disabling D-Bus")
3191
2021
use_dbus = False
3192
2022
server_settings["use_dbus"] = False
3193
2023
tcp_server.use_dbus = False
3195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3196
service = AvahiServiceToSyslog(
3197
name=server_settings["servicename"],
3198
servicetype="_mandos._tcp",
3201
if server_settings["interface"]:
3202
service.interface = if_nametoindex(
3203
server_settings["interface"].encode("utf-8"))
2024
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2025
service = AvahiService(name = server_settings["servicename"],
2026
servicetype = "_mandos._tcp",
2027
protocol = protocol, bus = bus)
2028
if server_settings["interface"]:
2029
service.interface = (if_nametoindex
2030
(str(server_settings["interface"])))
3205
2032
global multiprocessing_manager
3206
2033
multiprocessing_manager = multiprocessing.Manager()
3208
2035
client_class = Client
3210
client_class = functools.partial(ClientDBus, bus=bus)
3212
client_settings = Client.config_parser(client_config)
3213
old_client_settings = {}
3216
# This is used to redirect stdout and stderr for checker processes
3218
wnull = open(os.devnull, "w") # A writable /dev/null
3219
# Only used if server is running in foreground but not in debug
3221
if debug or not foreground:
3224
# Get client data and settings from last running state.
3225
if server_settings["restore"]:
3227
with open(stored_state_path, "rb") as stored_state:
3228
if sys.version_info.major == 2:
3229
clients_data, old_client_settings = pickle.load(
3232
bytes_clients_data, bytes_old_client_settings = (
3233
pickle.load(stored_state, encoding="bytes"))
3234
# Fix bytes to strings
3237
clients_data = {(key.decode("utf-8")
3238
if isinstance(key, bytes)
3241
bytes_clients_data.items()}
3242
del bytes_clients_data
3243
for key in clients_data:
3244
value = {(k.decode("utf-8")
3245
if isinstance(k, bytes) else k): v
3247
clients_data[key].items()}
3248
clients_data[key] = value
3250
value["client_structure"] = [
3252
if isinstance(s, bytes)
3254
value["client_structure"]]
3255
# .name, .host, and .checker_command
3256
for k in ("name", "host", "checker_command"):
3257
if isinstance(value[k], bytes):
3258
value[k] = value[k].decode("utf-8")
3259
if "key_id" not in value:
3260
value["key_id"] = ""
3261
elif "fingerprint" not in value:
3262
value["fingerprint"] = ""
3263
# old_client_settings
3265
old_client_settings = {
3266
(key.decode("utf-8")
3267
if isinstance(key, bytes)
3270
bytes_old_client_settings.items()}
3271
del bytes_old_client_settings
3272
# .host and .checker_command
3273
for value in old_client_settings.values():
3274
for attribute in ("host", "checker_command"):
3275
if isinstance(value[attribute], bytes):
3276
value[attribute] = (value[attribute]
3278
os.remove(stored_state_path)
3279
except IOError as e:
3280
if e.errno == errno.ENOENT:
3281
logger.warning("Could not load persistent state:"
3282
" {}".format(os.strerror(e.errno)))
3284
logger.critical("Could not load persistent state:",
3287
except EOFError as e:
3288
logger.warning("Could not load persistent state: "
3292
with PGPEngine() as pgp:
3293
for client_name, client in clients_data.items():
3294
# Skip removed clients
3295
if client_name not in client_settings:
3298
# Decide which value to use after restoring saved state.
3299
# We have three different values: Old config file,
3300
# new config file, and saved state.
3301
# New config value takes precedence if it differs from old
3302
# config value, otherwise use saved state.
3303
for name, value in client_settings[client_name].items():
3305
# For each value in new config, check if it
3306
# differs from the old config value (Except for
3307
# the "secret" attribute)
3308
if (name != "secret"
3310
old_client_settings[client_name][name])):
3311
client[name] = value
3315
# Clients who has passed its expire date can still be
3316
# enabled if its last checker was successful. A Client
3317
# whose checker succeeded before we stored its state is
3318
# assumed to have successfully run all checkers during
3320
if client["enabled"]:
3321
if datetime.datetime.utcnow() >= client["expires"]:
3322
if not client["last_checked_ok"]:
3324
"disabling client {} - Client never "
3325
"performed a successful checker".format(
3327
client["enabled"] = False
3328
elif client["last_checker_status"] != 0:
3330
"disabling client {} - Client last"
3331
" checker failed with error code"
3334
client["last_checker_status"]))
3335
client["enabled"] = False
3337
client["expires"] = (
3338
datetime.datetime.utcnow()
3339
+ client["timeout"])
3340
logger.debug("Last checker succeeded,"
3341
" keeping {} enabled".format(
2037
client_class = functools.partial(ClientDBusTransitional,
2039
def client_config_items(config, section):
2040
special_settings = {
2041
"approved_by_default":
2042
lambda: config.getboolean(section,
2043
"approved_by_default"),
2045
for name, value in config.items(section):
3344
client["secret"] = pgp.decrypt(
3345
client["encrypted_secret"],
3346
client_settings[client_name]["secret"])
3348
# If decryption fails, we use secret from new settings
3349
logger.debug("Failed to decrypt {} old secret".format(
3351
client["secret"] = (client_settings[client_name]
3354
# Add/remove clients based on new changes made to config
3355
for client_name in (set(old_client_settings)
3356
- set(client_settings)):
3357
del clients_data[client_name]
3358
for client_name in (set(client_settings)
3359
- set(old_client_settings)):
3360
clients_data[client_name] = client_settings[client_name]
3362
# Create all client objects
3363
for client_name, client in clients_data.items():
3364
tcp_server.clients[client_name] = client_class(
3367
server_settings=server_settings)
2047
yield (name, special_settings[name]())
2051
tcp_server.clients.update(set(
2052
client_class(name = section,
2053
config= dict(client_config_items(
2054
client_config, section)))
2055
for section in client_config.sections()))
3369
2056
if not tcp_server.clients:
3370
2057
logger.warning("No clients defined")
3373
if pidfile is not None:
3377
print(pid, file=pidfile)
3379
logger.error("Could not write to file %r with PID %d",
2063
pidfile.write(str(pid) + "\n".encode("utf-8"))
2066
logger.error("Could not write to file %r with PID %d",
2069
# "pidfile" was never created
3382
2071
del pidfilename
3384
for termsig in (signal.SIGHUP, signal.SIGTERM):
3385
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3386
lambda: main_loop.quit() and False)
2073
signal.signal(signal.SIGINT, signal.SIG_IGN)
2075
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2076
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3390
@alternate_dbus_interfaces(
3391
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3392
class MandosDBusService(DBusObjectWithObjectManager):
2079
class MandosDBusService(dbus.service.Object):
3393
2080
"""A D-Bus proxy object"""
3395
2081
def __init__(self):
3396
2082
dbus.service.Object.__init__(self, bus, "/")
3398
2083
_interface = "se.recompile.Mandos"
3400
2085
@dbus.service.signal(_interface, signature="o")
3401
2086
def ClientAdded(self, objpath):
3405
2090
@dbus.service.signal(_interface, signature="ss")
3406
def ClientNotFound(self, key_id, address):
2091
def ClientNotFound(self, fingerprint, address):
3410
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3412
2095
@dbus.service.signal(_interface, signature="os")
3413
2096
def ClientRemoved(self, objpath, name):
3417
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3419
2100
@dbus.service.method(_interface, out_signature="ao")
3420
2101
def GetAllClients(self):
3422
return dbus.Array(c.dbus_object_path for c in
3423
tcp_server.clients.values())
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2103
return dbus.Array(c.dbus_object_path
2104
for c in tcp_server.clients)
3427
2106
@dbus.service.method(_interface,
3428
2107
out_signature="a{oa{sv}}")
3429
2108
def GetAllClientsWithProperties(self):
3431
2110
return dbus.Dictionary(
3432
{c.dbus_object_path: c.GetAll(
3433
"se.recompile.Mandos.Client")
3434
for c in tcp_server.clients.values()},
2111
((c.dbus_object_path, c.GetAll(""))
2112
for c in tcp_server.clients),
3435
2113
signature="oa{sv}")
3437
2115
@dbus.service.method(_interface, in_signature="o")
3438
2116
def RemoveClient(self, object_path):
3440
for c in tcp_server.clients.values():
2118
for c in tcp_server.clients:
3441
2119
if c.dbus_object_path == object_path:
3442
del tcp_server.clients[c.name]
2120
tcp_server.clients.remove(c)
3443
2121
c.remove_from_connection()
3444
# Don't signal the disabling
2122
# Don't signal anything except ClientRemoved
3445
2123
c.disable(quiet=True)
3446
# Emit D-Bus signal for removal
3447
self.client_removed_signal(c)
2125
self.ClientRemoved(object_path, c.name)
3449
2127
raise KeyError(object_path)
3453
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3454
out_signature="a{oa{sa{sv}}}")
3455
def GetManagedObjects(self):
3457
return dbus.Dictionary(
3458
{client.dbus_object_path:
3460
{interface: client.GetAll(interface)
3462
client._get_all_interface_names()})
3463
for client in tcp_server.clients.values()})
3465
def client_added_signal(self, client):
3466
"""Send the new standard signal and the old signal"""
3468
# New standard signal
3469
self.InterfacesAdded(
3470
client.dbus_object_path,
3472
{interface: client.GetAll(interface)
3474
client._get_all_interface_names()}))
3476
self.ClientAdded(client.dbus_object_path)
3478
def client_removed_signal(self, client):
3479
"""Send the new standard signal and the old signal"""
3481
# New standard signal
3482
self.InterfacesRemoved(
3483
client.dbus_object_path,
3484
client._get_all_interface_names())
3486
self.ClientRemoved(client.dbus_object_path,
3489
mandos_dbus_service = MandosDBusService()
3491
# Save modules to variables to exempt the modules from being
3492
# unloaded before the function registered with atexit() is run.
3493
mp = multiprocessing
2131
class MandosDBusServiceTransitional(MandosDBusService):
2132
__metaclass__ = AlternateDBusNamesMetaclass
2133
mandos_dbus_service = MandosDBusServiceTransitional()
3497
2136
"Cleanup function; run on exit"
3501
mp.active_children()
3503
if not (tcp_server.clients or client_settings):
3506
# Store client before exiting. Secrets are encrypted with key
3507
# based on what config file has. If config file is
3508
# removed/edited, old secret will thus be unrecovable.
3510
with PGPEngine() as pgp:
3511
for client in tcp_server.clients.values():
3512
key = client_settings[client.name]["secret"]
3513
client.encrypted_secret = pgp.encrypt(client.secret,
3517
# A list of attributes that can not be pickled
3519
exclude = {"bus", "changedstate", "secret",
3520
"checker", "server_settings"}
3521
for name, typ in inspect.getmembers(dbus.service
3525
client_dict["encrypted_secret"] = (client
3527
for attr in client.client_structure:
3528
if attr not in exclude:
3529
client_dict[attr] = getattr(client, attr)
3531
clients[client.name] = client_dict
3532
del client_settings[client.name]["secret"]
3535
with tempfile.NamedTemporaryFile(
3539
dir=os.path.dirname(stored_state_path),
3540
delete=False) as stored_state:
3541
pickle.dump((clients, client_settings), stored_state,
3543
tempname = stored_state.name
3544
os.rename(tempname, stored_state_path)
3545
except (IOError, OSError) as e:
3551
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3552
logger.warning("Could not save persistent state: {}"
3553
.format(os.strerror(e.errno)))
3555
logger.warning("Could not save persistent state:",
3559
# Delete all clients, and settings from config
2139
multiprocessing.active_children()
3560
2140
while tcp_server.clients:
3561
name, client = tcp_server.clients.popitem()
2141
client = tcp_server.clients.pop()
3563
2143
client.remove_from_connection()
3564
# Don't signal the disabling
2144
client.disable_hook = None
2145
# Don't signal anything except ClientRemoved
3565
2146
client.disable(quiet=True)
3566
# Emit D-Bus signal for removal
3568
mandos_dbus_service.client_removed_signal(client)
3569
client_settings.clear()
2149
mandos_dbus_service.ClientRemoved(client
3571
2153
atexit.register(cleanup)
3573
for client in tcp_server.clients.values():
2155
for client in tcp_server.clients:
3575
# Emit D-Bus signal for adding
3576
mandos_dbus_service.client_added_signal(client)
3577
# Need to initiate checking of clients
3579
client.init_checker()
2158
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3581
2161
tcp_server.enable()
3582
2162
tcp_server.server_activate()
3584
2164
# Find out what port we got
3586
service.port = tcp_server.socket.getsockname()[1]
2165
service.port = tcp_server.socket.getsockname()[1]
3588
2167
logger.info("Now listening on address %r, port %d,"
3589
" flowinfo %d, scope_id %d",
3590
*tcp_server.socket.getsockname())
2168
" flowinfo %d, scope_id %d"
2169
% tcp_server.socket.getsockname())
3592
logger.info("Now listening on address %r, port %d",
3593
*tcp_server.socket.getsockname())
3595
# service.interface = tcp_server.socket.getsockname()[3]
2171
logger.info("Now listening on address %r, port %d"
2172
% tcp_server.socket.getsockname())
2174
#service.interface = tcp_server.socket.getsockname()[3]
3599
# From the Avahi example code
3602
except dbus.exceptions.DBusException as error:
3603
logger.critical("D-Bus Exception", exc_info=error)
3606
# End of Avahi example code
3609
GLib.IOChannel.unix_new(tcp_server.fileno()),
3610
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3611
lambda *args, **kwargs: (tcp_server.handle_request
3612
(*args[2:], **kwargs) or True))
2177
# From the Avahi example code
2180
except dbus.exceptions.DBusException as error:
2181
logger.critical("DBusException: %s", error)
2184
# End of Avahi example code
2186
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2187
lambda *args, **kwargs:
2188
(tcp_server.handle_request
2189
(*args[2:], **kwargs) or True))
3614
2191
logger.debug("Starting main loop")
3615
2192
main_loop.run()
3616
2193
except AvahiError as error:
3617
logger.critical("Avahi Error", exc_info=error)
2194
logger.critical("AvahiError: %s", error)
3620
2197
except KeyboardInterrupt: