70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
85
68
import dbus.service
87
from gi.repository import GLib
88
71
from dbus.mainloop.glib import DBusGMainLoop
91
74
import xml.dom.minidom
94
if sys.version_info.major == 2:
98
# Add collections.abc.Callable if it does not exist
100
collections.abc.Callable
101
except AttributeError:
103
Callable = collections.Callable
104
collections.abc = abc
107
# Add shlex.quote if it does not exist
110
except AttributeError:
111
shlex.quote = re.escape
113
# Show warnings by default
114
if not sys.warnoptions:
116
warnings.simplefilter("default")
118
# Try to find the value of SO_BINDTODEVICE:
120
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
121
# newer, and it is also the most natural place for it:
122
78
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
123
79
except AttributeError:
125
# This is where SO_BINDTODEVICE was up to and including Python
127
81
from IN import SO_BINDTODEVICE
128
82
except ImportError:
129
# In Python 2.7 it seems to have been removed entirely.
130
# Try running the C preprocessor:
132
cc = subprocess.Popen(["cc", "--language=c", "-E",
134
stdin=subprocess.PIPE,
135
stdout=subprocess.PIPE)
136
stdout = cc.communicate(
137
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
138
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
139
except (OSError, ValueError, IndexError):
141
SO_BINDTODEVICE = None
143
if sys.version_info < (3, 2):
144
configparser.Configparser = configparser.SafeConfigParser
147
stored_state_file = "clients.pickle"
149
logger = logging.getLogger()
150
logging.captureWarnings(True) # Show warnings via the logging system
154
if_nametoindex = ctypes.cdll.LoadLibrary(
155
ctypes.util.find_library("c")).if_nametoindex
156
except (OSError, AttributeError):
158
def if_nametoindex(interface):
159
"Get an interface index the hard way, i.e. using fcntl()"
160
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
161
with contextlib.closing(socket.socket()) as s:
162
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
163
struct.pack(b"16s16x", interface))
164
interface_index = struct.unpack("I", ifreq[16:20])[0]
165
return interface_index
168
def copy_function(func):
169
"""Make a copy of a function"""
170
if sys.version_info.major == 2:
171
return types.FunctionType(func.func_code,
177
return types.FunctionType(func.__code__,
184
def initlogger(debug, level=logging.WARNING):
185
"""init logger and add loglevel"""
188
syslogger = (logging.handlers.SysLogHandler(
189
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
191
syslogger.setFormatter(logging.Formatter
192
('Mandos [%(process)d]: %(levelname)s:'
194
logger.addHandler(syslogger)
197
console = logging.StreamHandler()
198
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
202
logger.addHandler(console)
203
logger.setLevel(level)
206
class PGPError(Exception):
207
"""Exception if encryption/decryption fails"""
212
"""A simple class for OpenPGP symmetric encryption & decryption"""
215
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
218
output = subprocess.check_output(["gpgconf"])
219
for line in output.splitlines():
220
name, text, path = line.split(b":")
225
if e.errno != errno.ENOENT:
227
self.gnupgargs = ['--batch',
228
'--homedir', self.tempdir,
231
# Only GPG version 1 has the --no-use-agent option.
232
if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
233
self.gnupgargs.append("--no-use-agent")
238
def __exit__(self, exc_type, exc_value, traceback):
246
if self.tempdir is not None:
247
# Delete contents of tempdir
248
for root, dirs, files in os.walk(self.tempdir,
250
for filename in files:
251
os.remove(os.path.join(root, filename))
253
os.rmdir(os.path.join(root, dirname))
255
os.rmdir(self.tempdir)
258
def password_encode(self, password):
259
# Passphrase can not be empty and can not contain newlines or
260
# NUL bytes. So we prefix it and hex encode it.
261
encoded = b"mandos" + binascii.hexlify(password)
262
if len(encoded) > 2048:
263
# GnuPG can't handle long passwords, so encode differently
264
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
265
.replace(b"\n", b"\\n")
266
.replace(b"\0", b"\\x00"))
269
def encrypt(self, data, password):
270
passphrase = self.password_encode(password)
271
with tempfile.NamedTemporaryFile(
272
dir=self.tempdir) as passfile:
273
passfile.write(passphrase)
275
proc = subprocess.Popen([self.gpg, '--symmetric',
279
stdin=subprocess.PIPE,
280
stdout=subprocess.PIPE,
281
stderr=subprocess.PIPE)
282
ciphertext, err = proc.communicate(input=data)
283
if proc.returncode != 0:
287
def decrypt(self, data, password):
288
passphrase = self.password_encode(password)
289
with tempfile.NamedTemporaryFile(
290
dir=self.tempdir) as passfile:
291
passfile.write(passphrase)
293
proc = subprocess.Popen([self.gpg, '--decrypt',
297
stdin=subprocess.PIPE,
298
stdout=subprocess.PIPE,
299
stderr=subprocess.PIPE)
300
decrypted_plaintext, err = proc.communicate(input=data)
301
if proc.returncode != 0:
303
return decrypted_plaintext
306
# Pretend that we have an Avahi module
308
"""This isn't so much a class as it is a module-like namespace."""
309
IF_UNSPEC = -1 # avahi-common/address.h
310
PROTO_UNSPEC = -1 # avahi-common/address.h
311
PROTO_INET = 0 # avahi-common/address.h
312
PROTO_INET6 = 1 # avahi-common/address.h
313
DBUS_NAME = "org.freedesktop.Avahi"
314
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
315
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
316
DBUS_PATH_SERVER = "/"
319
def string_array_to_txt_array(t):
320
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
321
for s in t), signature="ay")
322
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
323
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
324
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
325
SERVER_INVALID = 0 # avahi-common/defs.h
326
SERVER_REGISTERING = 1 # avahi-common/defs.h
327
SERVER_RUNNING = 2 # avahi-common/defs.h
328
SERVER_COLLISION = 3 # avahi-common/defs.h
329
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)
332
104
class AvahiError(Exception):
333
105
def __init__(self, value, *args, **kwargs):
334
106
self.value = value
335
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))
339
111
class AvahiServiceError(AvahiError):
343
114
class AvahiGroupError(AvahiError):
118
class AvahiService(object):
348
119
"""An Avahi (Zeroconf) service.
351
122
interface: integer; avahi.IF_UNSPEC or an interface index.
352
123
Used to optionally bind to the specified interface.
353
124
name: string; Example: 'Mandos'
354
125
type: string; Example: '_mandos._tcp'.
355
See <https://www.iana.org/assignments/service-names-port-numbers>
126
See <http://www.dns-sd.org/ServiceTypes.html>
356
127
port: integer; what port to announce
357
128
TXT: list of strings; TXT record for the service
358
129
domain: string; Domain to publish on, default to .local if empty.
517
262
follow_name_owner_changes=True),
518
263
avahi.DBUS_INTERFACE_SERVER)
519
264
self.server.connect_to_signal("StateChanged",
520
self.server_state_changed)
265
self.server_state_changed)
521
266
self.server_state_changed(self.server.GetState())
524
class AvahiServiceToSyslog(AvahiService):
525
def rename(self, *args, **kwargs):
526
"""Add the new name to the syslog messages"""
527
ret = super(AvahiServiceToSyslog, self).rename(*args,
529
syslogger.setFormatter(logging.Formatter(
530
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
535
# Pretend that we have a GnuTLS module
537
"""This isn't so much a class as it is a module-like namespace."""
539
library = ctypes.util.find_library("gnutls")
541
library = ctypes.util.find_library("gnutls-deb0")
542
_library = ctypes.cdll.LoadLibrary(library)
545
# Unless otherwise indicated, the constants and types below are
546
# all from the gnutls/gnutls.h C header file.
557
E_NO_CERTIFICATE_FOUND = -49
562
KEYID_USE_SHA256 = 1 # gnutls/x509.h
563
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
566
class session_int(ctypes.Structure):
568
session_t = ctypes.POINTER(session_int)
570
class certificate_credentials_st(ctypes.Structure):
572
certificate_credentials_t = ctypes.POINTER(
573
certificate_credentials_st)
574
certificate_type_t = ctypes.c_int
576
class datum_t(ctypes.Structure):
577
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
578
('size', ctypes.c_uint)]
580
class openpgp_crt_int(ctypes.Structure):
582
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
583
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
584
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
585
credentials_type_t = ctypes.c_int
586
transport_ptr_t = ctypes.c_void_p
587
close_request_t = ctypes.c_int
590
class Error(Exception):
591
def __init__(self, message=None, code=None, args=()):
592
# Default usage is by a message string, but if a return
593
# code is passed, convert it to a string with
596
if message is None and code is not None:
597
message = gnutls.strerror(code)
598
return super(gnutls.Error, self).__init__(
601
class CertificateSecurityError(Error):
607
self._c_object = gnutls.certificate_credentials_t()
608
gnutls.certificate_allocate_credentials(
609
ctypes.byref(self._c_object))
610
self.type = gnutls.CRD_CERTIFICATE
613
gnutls.certificate_free_credentials(self._c_object)
616
def __init__(self, socket, credentials=None):
617
self._c_object = gnutls.session_t()
618
gnutls_flags = gnutls.CLIENT
619
if gnutls.check_version(b"3.5.6"):
620
gnutls_flags |= gnutls.NO_TICKETS
622
gnutls_flags |= gnutls.ENABLE_RAWPK
623
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
625
gnutls.set_default_priority(self._c_object)
626
gnutls.transport_set_ptr(self._c_object, socket.fileno())
627
gnutls.handshake_set_private_extensions(self._c_object,
630
if credentials is None:
631
credentials = gnutls.Credentials()
632
gnutls.credentials_set(self._c_object, credentials.type,
633
ctypes.cast(credentials._c_object,
635
self.credentials = credentials
638
gnutls.deinit(self._c_object)
641
return gnutls.handshake(self._c_object)
643
def send(self, data):
647
data_len -= gnutls.record_send(self._c_object,
652
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
654
# Error handling functions
655
def _error_code(result):
656
"""A function to raise exceptions on errors, suitable
657
for the 'restype' attribute on ctypes functions"""
660
if result == gnutls.E_NO_CERTIFICATE_FOUND:
661
raise gnutls.CertificateSecurityError(code=result)
662
raise gnutls.Error(code=result)
664
def _retry_on_error(result, func, arguments,
665
_error_code=_error_code):
666
"""A function to retry on some errors, suitable
667
for the 'errcheck' attribute on ctypes functions"""
669
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
670
return _error_code(result)
671
result = func(*arguments)
674
# Unless otherwise indicated, the function declarations below are
675
# all from the gnutls/gnutls.h C header file.
678
priority_set_direct = _library.gnutls_priority_set_direct
679
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
680
ctypes.POINTER(ctypes.c_char_p)]
681
priority_set_direct.restype = _error_code
683
init = _library.gnutls_init
684
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
685
init.restype = _error_code
687
set_default_priority = _library.gnutls_set_default_priority
688
set_default_priority.argtypes = [session_t]
689
set_default_priority.restype = _error_code
691
record_send = _library.gnutls_record_send
692
record_send.argtypes = [session_t, ctypes.c_void_p,
694
record_send.restype = ctypes.c_ssize_t
695
record_send.errcheck = _retry_on_error
697
certificate_allocate_credentials = (
698
_library.gnutls_certificate_allocate_credentials)
699
certificate_allocate_credentials.argtypes = [
700
ctypes.POINTER(certificate_credentials_t)]
701
certificate_allocate_credentials.restype = _error_code
703
certificate_free_credentials = (
704
_library.gnutls_certificate_free_credentials)
705
certificate_free_credentials.argtypes = [
706
certificate_credentials_t]
707
certificate_free_credentials.restype = None
709
handshake_set_private_extensions = (
710
_library.gnutls_handshake_set_private_extensions)
711
handshake_set_private_extensions.argtypes = [session_t,
713
handshake_set_private_extensions.restype = None
715
credentials_set = _library.gnutls_credentials_set
716
credentials_set.argtypes = [session_t, credentials_type_t,
718
credentials_set.restype = _error_code
720
strerror = _library.gnutls_strerror
721
strerror.argtypes = [ctypes.c_int]
722
strerror.restype = ctypes.c_char_p
724
certificate_type_get = _library.gnutls_certificate_type_get
725
certificate_type_get.argtypes = [session_t]
726
certificate_type_get.restype = _error_code
728
certificate_get_peers = _library.gnutls_certificate_get_peers
729
certificate_get_peers.argtypes = [session_t,
730
ctypes.POINTER(ctypes.c_uint)]
731
certificate_get_peers.restype = ctypes.POINTER(datum_t)
733
global_set_log_level = _library.gnutls_global_set_log_level
734
global_set_log_level.argtypes = [ctypes.c_int]
735
global_set_log_level.restype = None
737
global_set_log_function = _library.gnutls_global_set_log_function
738
global_set_log_function.argtypes = [log_func]
739
global_set_log_function.restype = None
741
deinit = _library.gnutls_deinit
742
deinit.argtypes = [session_t]
743
deinit.restype = None
745
handshake = _library.gnutls_handshake
746
handshake.argtypes = [session_t]
747
handshake.restype = _error_code
748
handshake.errcheck = _retry_on_error
750
transport_set_ptr = _library.gnutls_transport_set_ptr
751
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
752
transport_set_ptr.restype = None
754
bye = _library.gnutls_bye
755
bye.argtypes = [session_t, close_request_t]
756
bye.restype = _error_code
757
bye.errcheck = _retry_on_error
759
check_version = _library.gnutls_check_version
760
check_version.argtypes = [ctypes.c_char_p]
761
check_version.restype = ctypes.c_char_p
763
_need_version = b"3.3.0"
764
if check_version(_need_version) is None:
765
raise self.Error("Needs GnuTLS {} or later"
766
.format(_need_version))
768
_tls_rawpk_version = b"3.6.6"
769
has_rawpk = bool(check_version(_tls_rawpk_version))
773
class pubkey_st(ctypes.Structure):
775
pubkey_t = ctypes.POINTER(pubkey_st)
777
x509_crt_fmt_t = ctypes.c_int
779
# All the function declarations below are from
781
pubkey_init = _library.gnutls_pubkey_init
782
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
783
pubkey_init.restype = _error_code
785
pubkey_import = _library.gnutls_pubkey_import
786
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
788
pubkey_import.restype = _error_code
790
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
791
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
792
ctypes.POINTER(ctypes.c_ubyte),
793
ctypes.POINTER(ctypes.c_size_t)]
794
pubkey_get_key_id.restype = _error_code
796
pubkey_deinit = _library.gnutls_pubkey_deinit
797
pubkey_deinit.argtypes = [pubkey_t]
798
pubkey_deinit.restype = None
800
# All the function declarations below are from
803
openpgp_crt_init = _library.gnutls_openpgp_crt_init
804
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
805
openpgp_crt_init.restype = _error_code
807
openpgp_crt_import = _library.gnutls_openpgp_crt_import
808
openpgp_crt_import.argtypes = [openpgp_crt_t,
809
ctypes.POINTER(datum_t),
811
openpgp_crt_import.restype = _error_code
813
openpgp_crt_verify_self = \
814
_library.gnutls_openpgp_crt_verify_self
815
openpgp_crt_verify_self.argtypes = [
818
ctypes.POINTER(ctypes.c_uint),
820
openpgp_crt_verify_self.restype = _error_code
822
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
823
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
824
openpgp_crt_deinit.restype = None
826
openpgp_crt_get_fingerprint = (
827
_library.gnutls_openpgp_crt_get_fingerprint)
828
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
832
openpgp_crt_get_fingerprint.restype = _error_code
834
if check_version(b"3.6.4"):
835
certificate_type_get2 = _library.gnutls_certificate_type_get2
836
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
837
certificate_type_get2.restype = _error_code
839
# Remove non-public functions
840
del _error_code, _retry_on_error
843
def call_pipe(connection, # : multiprocessing.Connection
844
func, *args, **kwargs):
845
"""This function is meant to be called by multiprocessing.Process
847
This function runs func(*args, **kwargs), and writes the resulting
848
return value on the provided multiprocessing.Connection.
850
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):
855
276
"""A representation of a client host served by this server.
858
approved: bool(); 'None' if not yet approved/disapproved
279
_approved: bool(); 'None' if not yet approved/disapproved
859
280
approval_delay: datetime.timedelta(); Time to wait for approval
860
281
approval_duration: datetime.timedelta(); Duration of one approval
861
checker: multiprocessing.Process(); a running checker process used
862
to see if the client lives. 'None' if no process is
864
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
865
286
checker_command: string; External command which is run to check
866
287
if client lives. %() expansions are done at
867
288
runtime with vars(self) as dict, so that for
868
289
instance %(name)s can be used in the command.
869
checker_initiator_tag: a GLib event source tag, or None
290
checker_initiator_tag: a gobject event source tag, or None
870
291
created: datetime.datetime(); (UTC) object creation
871
client_structure: Object describing what attributes a client has
872
and is used for storing the client at exit
873
292
current_checker_command: string; current running checker_command
874
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
876
296
fingerprint: string (40 or 32 hexadecimal digits); used to
877
uniquely identify an OpenPGP client
878
key_id: string (64 hexadecimal digits); used to uniquely identify
879
a client using raw public keys
297
uniquely identify the client
880
298
host: string; available for use by the checker command
881
299
interval: datetime.timedelta(); How often to start a new checker
882
300
last_approval_request: datetime.datetime(); (UTC) or None
883
301
last_checked_ok: datetime.datetime(); (UTC) or None
884
last_checker_status: integer between 0 and 255 reflecting exit
885
status of last checker. -1 reflects crashed
886
checker, -2 means no checker completed yet.
887
last_checker_signal: The signal which killed the last checker, if
888
last_checker_status is -1
889
last_enabled: datetime.datetime(); (UTC) or None
302
last_enabled: datetime.datetime(); (UTC)
890
303
name: string; from the config file, used in log messages and
891
304
D-Bus identifiers
892
305
secret: bytestring; sent verbatim (over TLS) to client
893
306
timeout: datetime.timedelta(); How long from last_checked_ok
894
307
until this client is disabled
895
extended_timeout: extra long timeout when secret has been sent
308
extended_timeout: extra long timeout when password has been sent
896
309
runtime_expansions: Allowed attributes for runtime expansion.
897
310
expires: datetime.datetime(); time (UTC) when a client will be
898
311
disabled, or None
899
server_settings: The server_settings dict from main()
902
314
runtime_expansions = ("approval_delay", "approval_duration",
903
"created", "enabled", "expires", "key_id",
904
"fingerprint", "host", "interval",
905
"last_approval_request", "last_checked_ok",
315
"created", "enabled", "fingerprint",
316
"host", "interval", "last_checked_ok",
906
317
"last_enabled", "name", "timeout")
909
"extended_timeout": "PT15M",
911
"checker": "fping -q -- %%(host)s",
913
"approval_delay": "PT0S",
914
"approval_duration": "PT1S",
915
"approved_by_default": "True",
920
def config_parser(config):
921
"""Construct a new dict of client settings of this form:
922
{ client_name: {setting_name: value, ...}, ...}
923
with exceptions for any special settings as defined above.
924
NOTE: Must be a pure function. Must return the same result
925
value given the same arguments.
928
for client_name in config.sections():
929
section = dict(config.items(client_name))
930
client = settings[client_name] = {}
932
client["host"] = section["host"]
933
# Reformat values from string types to Python types
934
client["approved_by_default"] = config.getboolean(
935
client_name, "approved_by_default")
936
client["enabled"] = config.getboolean(client_name,
939
# Uppercase and remove spaces from key_id and fingerprint
940
# for later comparison purposes with return value from the
941
# key_id() and fingerprint() functions
942
client["key_id"] = (section.get("key_id", "").upper()
944
client["fingerprint"] = (section["fingerprint"].upper()
946
if "secret" in section:
947
client["secret"] = codecs.decode(section["secret"]
950
elif "secfile" in section:
951
with open(os.path.expanduser(os.path.expandvars
952
(section["secfile"])),
954
client["secret"] = secfile.read()
956
raise TypeError("No secret or secfile for section {}"
958
client["timeout"] = string_to_delta(section["timeout"])
959
client["extended_timeout"] = string_to_delta(
960
section["extended_timeout"])
961
client["interval"] = string_to_delta(section["interval"])
962
client["approval_delay"] = string_to_delta(
963
section["approval_delay"])
964
client["approval_duration"] = string_to_delta(
965
section["approval_duration"])
966
client["checker_command"] = section["checker"]
967
client["last_approval_request"] = None
968
client["last_checked_ok"] = None
969
client["last_checker_status"] = -2
973
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'
975
if server_settings is None:
977
self.server_settings = server_settings
978
# adding all client settings
979
for setting, value in settings.items():
980
setattr(self, setting, value)
983
if not hasattr(self, "last_enabled"):
984
self.last_enabled = datetime.datetime.utcnow()
985
if not hasattr(self, "expires"):
986
self.expires = (datetime.datetime.utcnow()
989
self.last_enabled = None
992
341
logger.debug("Creating client %r", self.name)
993
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()
994
347
logger.debug(" Fingerprint: %s", self.fingerprint)
995
self.created = settings.get("created",
996
datetime.datetime.utcnow())
998
# 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
999
369
self.checker = None
1000
370
self.checker_initiator_tag = None
1001
371
self.disable_initiator_tag = None
1002
373
self.checker_callback_tag = None
374
self.checker_command = config["checker"]
1003
375
self.current_checker_command = None
1004
self.approved = None
376
self.last_connect = None
377
self._approved = None
378
self.approved_by_default = config.get("approved_by_default",
1005
380
self.approvals_pending = 0
1006
self.changedstate = multiprocessing_manager.Condition(
1007
multiprocessing_manager.Lock())
1008
self.client_structure = [attr
1009
for attr in self.__dict__.keys()
1010
if not attr.startswith("_")]
1011
self.client_structure.append("client_structure")
1013
for name, t in inspect.getmembers(
1014
type(self), lambda obj: isinstance(obj, property)):
1015
if not name.startswith("_"):
1016
self.client_structure.append(name)
1018
# 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
1019
389
def send_changedstate(self):
1020
with self.changedstate:
1021
self.changedstate.notify_all()
390
self.changedstate.acquire()
391
self.changedstate.notify_all()
392
self.changedstate.release()
1023
394
def enable(self):
1024
395
"""Start this client's checker and timeout hooks"""
1025
396
if getattr(self, "enabled", False):
1026
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
1028
406
self.expires = datetime.datetime.utcnow() + self.timeout
407
self.disable_initiator_tag = (gobject.timeout_add
408
(self.timeout_milliseconds(),
1029
410
self.enabled = True
1030
411
self.last_enabled = datetime.datetime.utcnow()
1032
self.send_changedstate()
412
# Also start a new checker *right now*.
1034
415
def disable(self, quiet=True):
1035
416
"""Disable this client."""
1036
417
if not getattr(self, "enabled", False):
420
self.send_changedstate()
1039
422
logger.info("Disabling client %s", self.name)
1040
if getattr(self, "disable_initiator_tag", None) is not None:
1041
GLib.source_remove(self.disable_initiator_tag)
423
if getattr(self, "disable_initiator_tag", False):
424
gobject.source_remove(self.disable_initiator_tag)
1042
425
self.disable_initiator_tag = None
1043
426
self.expires = None
1044
if getattr(self, "checker_initiator_tag", None) is not None:
1045
GLib.source_remove(self.checker_initiator_tag)
427
if getattr(self, "checker_initiator_tag", False):
428
gobject.source_remove(self.checker_initiator_tag)
1046
429
self.checker_initiator_tag = None
1047
430
self.stop_checker()
431
if self.disable_hook:
432
self.disable_hook(self)
1048
433
self.enabled = False
1050
self.send_changedstate()
1051
# 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
1054
437
def __del__(self):
438
self.disable_hook = None
1057
def init_checker(self):
1058
# Schedule a new checker to be started an 'interval' from now,
1059
# and every interval from then on.
1060
if self.checker_initiator_tag is not None:
1061
GLib.source_remove(self.checker_initiator_tag)
1062
self.checker_initiator_tag = GLib.timeout_add(
1063
random.randrange(int(self.interval.total_seconds() * 1000
1066
# Schedule a disable() when 'timeout' has passed
1067
if self.disable_initiator_tag is not None:
1068
GLib.source_remove(self.disable_initiator_tag)
1069
self.disable_initiator_tag = GLib.timeout_add(
1070
int(self.timeout.total_seconds() * 1000), self.disable)
1071
# Also start a new checker *right now*.
1072
self.start_checker()
1074
def checker_callback(self, source, condition, connection,
441
def checker_callback(self, pid, condition, command):
1076
442
"""The checker has completed, so take appropriate actions."""
1077
# Read return code from connection (see call_pipe)
1078
returncode = connection.recv()
1080
if self.checker is not None:
1082
443
self.checker_callback_tag = None
1083
444
self.checker = None
1086
self.last_checker_status = returncode
1087
self.last_checker_signal = None
1088
if self.last_checker_status == 0:
445
if os.WIFEXITED(condition):
446
exitstatus = os.WEXITSTATUS(condition)
1089
448
logger.info("Checker for %(name)s succeeded",
1091
450
self.checked_ok()
1093
logger.info("Checker for %(name)s failed", vars(self))
452
logger.info("Checker for %(name)s failed",
1095
self.last_checker_status = -1
1096
self.last_checker_signal = -returncode
1097
455
logger.warning("Checker for %(name)s crashed?",
1101
def checked_ok(self):
1102
"""Assert that the client has been seen, alive and well."""
1103
self.last_checked_ok = datetime.datetime.utcnow()
1104
self.last_checker_status = 0
1105
self.last_checker_signal = None
1108
def bump_timeout(self, timeout=None):
1109
"""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,
1110
464
if timeout is None:
1111
465
timeout = self.timeout
466
self.last_checked_ok = datetime.datetime.utcnow()
1112
467
if self.disable_initiator_tag is not None:
1113
GLib.source_remove(self.disable_initiator_tag)
1114
self.disable_initiator_tag = None
468
gobject.source_remove(self.disable_initiator_tag)
1115
469
if getattr(self, "enabled", False):
1116
self.disable_initiator_tag = GLib.timeout_add(
1117
int(timeout.total_seconds() * 1000), self.disable)
470
self.disable_initiator_tag = (gobject.timeout_add
471
(_timedelta_to_milliseconds
472
(timeout), self.disable))
1118
473
self.expires = datetime.datetime.utcnow() + timeout
1120
475
def need_approval(self):
1121
476
self.last_approval_request = datetime.datetime.utcnow()
1123
478
def start_checker(self):
1124
479
"""Start a new checker subprocess if one is not running.
1126
481
If a checker already exists, leave it running and do
1128
483
# The reason for not killing a running checker is that if we
1129
# did that, and if a checker (for some reason) started running
1130
# slowly and taking more than 'interval' time, then the client
1131
# would inevitably timeout, since no checker would get a
1132
# chance to run to completion. If we instead leave running
484
# did that, then if a checker (for some reason) started
485
# running slowly and taking more than 'interval' time, the
486
# client would inevitably timeout, since no checker would get
487
# a chance to run to completion. If we instead leave running
1133
488
# checkers alone, the checker would have to take more time
1134
489
# than 'timeout' for the client to be disabled, which is as it
1137
if self.checker is not None and not self.checker.is_alive():
1138
logger.warning("Checker was not alive; joining")
492
# If a checker exists, make sure it is not a zombie
494
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
495
except (AttributeError, OSError) as error:
496
if (isinstance(error, OSError)
497
and error.errno != errno.ECHILD):
501
logger.warning("Checker was a zombie")
502
gobject.source_remove(self.checker_callback_tag)
503
self.checker_callback(pid, status,
504
self.current_checker_command)
1141
505
# Start a new checker if needed
1142
506
if self.checker is None:
1143
# Escape attributes for the shell
1145
attr: shlex.quote(str(getattr(self, attr)))
1146
for attr in self.runtime_expansions}
1148
command = self.checker_command % escaped_attrs
1149
except TypeError as error:
1150
logger.error('Could not format string "%s"',
1151
self.checker_command,
1153
return True # Try again later
508
# In case checker_command has exactly one % operator
509
command = self.checker_command % self.host
511
# Escape attributes for the shell
512
escaped_attrs = dict(
514
re.escape(unicode(str(getattr(self, attr, "")),
518
self.runtime_expansions)
521
command = self.checker_command % escaped_attrs
522
except TypeError as error:
523
logger.error('Could not format string "%s":'
524
' %s', self.checker_command, error)
525
return True # Try again later
1154
526
self.current_checker_command = command
1155
logger.info("Starting checker %r for %s", command,
1157
# We don't need to redirect stdout and stderr, since
1158
# in normal mode, that is already done by daemon(),
1159
# and in debug mode we don't want to. (Stdin is
1160
# always replaced by /dev/null.)
1161
# The exception is when not debugging but nevertheless
1162
# running in the foreground; use the previously
1164
popen_args = {"close_fds": True,
1167
if (not self.server_settings["debug"]
1168
and self.server_settings["foreground"]):
1169
popen_args.update({"stdout": wnull,
1171
pipe = multiprocessing.Pipe(duplex=False)
1172
self.checker = multiprocessing.Process(
1174
args=(pipe[1], subprocess.call, command),
1176
self.checker.start()
1177
self.checker_callback_tag = GLib.io_add_watch(
1178
GLib.IOChannel.unix_new(pipe[0].fileno()),
1179
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1180
self.checker_callback, pipe[0], command)
1181
# Re-run this periodically if run by GLib.timeout_add
528
logger.info("Starting checker %r for %s",
530
# We don't need to redirect stdout and stderr, since
531
# in normal mode, that is already done by daemon(),
532
# and in debug mode we don't want to. (Stdin is
533
# always replaced by /dev/null.)
534
self.checker = subprocess.Popen(command,
537
self.checker_callback_tag = (gobject.child_watch_add
539
self.checker_callback,
541
# The checker may have completed before the gobject
542
# watch was added. Check for this.
543
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
545
gobject.source_remove(self.checker_callback_tag)
546
self.checker_callback(pid, status, command)
547
except OSError as error:
548
logger.error("Failed to start subprocess: %s",
550
# Re-run this periodically if run by gobject.timeout_add
1184
553
def stop_checker(self):
1185
554
"""Force the checker process, if any, to stop."""
1186
555
if self.checker_callback_tag:
1187
GLib.source_remove(self.checker_callback_tag)
556
gobject.source_remove(self.checker_callback_tag)
1188
557
self.checker_callback_tag = None
1189
558
if getattr(self, "checker", None) is None:
1191
560
logger.debug("Stopping checker for %(name)s", vars(self))
1192
self.checker.terminate()
562
os.kill(self.checker.pid, signal.SIGTERM)
564
#if self.checker.poll() is None:
565
# os.kill(self.checker.pid, signal.SIGKILL)
566
except OSError as error:
567
if error.errno != errno.ESRCH: # No such process
1193
569
self.checker = None
1196
def dbus_service_property(dbus_interface,
572
def dbus_service_property(dbus_interface, signature="v",
573
access="readwrite", byte_arrays=False):
1200
574
"""Decorators for marking methods of a DBusObjectWithProperties to
1201
575
become properties on the D-Bus.
1203
577
The decorated method will be called with no arguments by "Get"
1204
578
and with one argument by "Set".
1206
580
The parameters, where they are supported, are the same as
1207
581
dbus.service.method, except there is only "signature", since the
1208
582
type from Get() and the type sent to Set() is the same.
1540
752
except (AttributeError, xml.dom.DOMException,
1541
753
xml.parsers.expat.ExpatError) as error:
1542
754
logger.error("Failed to override Introspection method",
1548
dbus.OBJECT_MANAGER_IFACE
1549
except AttributeError:
1550
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1553
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1554
"""A D-Bus object with an ObjectManager.
1556
Classes inheriting from this exposes the standard
1557
GetManagedObjects call and the InterfacesAdded and
1558
InterfacesRemoved signals on the standard
1559
"org.freedesktop.DBus.ObjectManager" interface.
1561
Note: No signals are sent automatically; they must be sent
1564
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1565
out_signature="a{oa{sa{sv}}}")
1566
def GetManagedObjects(self):
1567
"""This function must be overridden"""
1568
raise NotImplementedError()
1570
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1571
signature="oa{sa{sv}}")
1572
def InterfacesAdded(self, object_path, interfaces_and_properties):
1575
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1576
def InterfacesRemoved(self, object_path, interfaces):
1579
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1581
path_keyword='object_path',
1582
connection_keyword='connection')
1583
def Introspect(self, object_path, connection):
1584
"""Overloading of standard D-Bus method.
1586
Override return argument name of GetManagedObjects to be
1587
"objpath_interfaces_and_properties"
1589
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1593
document = xml.dom.minidom.parseString(xmlstring)
1595
for if_tag in document.getElementsByTagName("interface"):
1596
# Fix argument name for the GetManagedObjects method
1597
if (if_tag.getAttribute("name")
1598
== dbus.OBJECT_MANAGER_IFACE):
1599
for cn in if_tag.getElementsByTagName("method"):
1600
if (cn.getAttribute("name")
1601
== "GetManagedObjects"):
1602
for arg in cn.getElementsByTagName("arg"):
1603
if (arg.getAttribute("direction")
1607
"objpath_interfaces"
1609
xmlstring = document.toxml("utf-8")
1611
except (AttributeError, xml.dom.DOMException,
1612
xml.parsers.expat.ExpatError) as error:
1613
logger.error("Failed to override Introspection method",
1618
def datetime_to_dbus(dt, variant_level=0):
759
def datetime_to_dbus (dt, variant_level=0):
1619
760
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1621
return dbus.String("", variant_level=variant_level)
1622
return dbus.String(dt.isoformat(), variant_level=variant_level)
1625
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1626
"""A class decorator; applied to a subclass of
1627
dbus.service.Object, it will add alternate D-Bus attributes with
1628
interface names according to the "alt_interface_names" mapping.
1631
@alternate_dbus_interfaces({"org.example.Interface":
1632
"net.example.AlternateInterface"})
1633
class SampleDBusObject(dbus.service.Object):
1634
@dbus.service.method("org.example.Interface")
1635
def SampleDBusMethod():
1638
The above "SampleDBusMethod" on "SampleDBusObject" will be
1639
reachable via two interfaces: "org.example.Interface" and
1640
"net.example.AlternateInterface", the latter of which will have
1641
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1642
"true", unless "deprecate" is passed with a False value.
1644
This works for methods and signals, and also for D-Bus properties
1645
(from DBusObjectWithProperties) and interfaces (from the
1646
dbus_interface_annotations decorator).
762
return dbus.String("", variant_level = variant_level)
763
return dbus.String(dt.isoformat(),
764
variant_level=variant_level)
766
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
768
"""Applied to an empty subclass of a D-Bus object, this metaclass
769
will add additional D-Bus attributes matching a certain pattern.
1650
for orig_interface_name, alt_interface_name in (
1651
alt_interface_names.items()):
1653
interface_names = set()
1654
# Go though all attributes of the class
1655
for attrname, attribute in inspect.getmembers(cls):
771
def __new__(mcs, name, bases, attr):
772
# Go through all the base classes which could have D-Bus
773
# methods, signals, or properties in them
774
for base in (b for b in bases
775
if issubclass(b, dbus.service.Object)):
776
# Go though all attributes of the base class
777
for attrname, attribute in inspect.getmembers(base):
1656
778
# Ignore non-D-Bus attributes, and D-Bus attributes
1657
779
# with the wrong interface name
1658
780
if (not hasattr(attribute, "_dbus_interface")
1659
or not attribute._dbus_interface.startswith(
1660
orig_interface_name)):
781
or not attribute._dbus_interface
782
.startswith("se.recompile.Mandos")):
1662
784
# Create an alternate D-Bus interface name based on
1663
785
# the current name
1664
alt_interface = attribute._dbus_interface.replace(
1665
orig_interface_name, alt_interface_name)
1666
interface_names.add(alt_interface)
786
alt_interface = (attribute._dbus_interface
787
.replace("se.recompile.Mandos",
788
"se.bsnet.fukt.Mandos"))
1667
789
# Is this a D-Bus signal?
1668
790
if getattr(attribute, "_dbus_is_signal", False):
1669
# Extract the original non-method undecorated
1670
# function by black magic
1671
if sys.version_info.major == 2:
1672
nonmethod_func = (dict(
791
# Extract the original non-method function by
793
nonmethod_func = (dict(
1673
794
zip(attribute.func_code.co_freevars,
1674
attribute.__closure__))
1675
["func"].cell_contents)
1677
nonmethod_func = (dict(
1678
zip(attribute.__code__.co_freevars,
1679
attribute.__closure__))
1680
["func"].cell_contents)
795
attribute.__closure__))["func"]
1681
797
# Create a new, but exactly alike, function
1682
798
# object, and decorate it to be a new D-Bus signal
1683
799
# with the alternate D-Bus interface name
1684
new_function = copy_function(nonmethod_func)
1685
new_function = (dbus.service.signal(
1687
attribute._dbus_signature)(new_function))
1688
# Copy annotations, if any
1690
new_function._dbus_annotations = dict(
1691
attribute._dbus_annotations)
1692
except AttributeError:
800
new_function = (dbus.service.signal
802
attribute._dbus_signature)
804
nonmethod_func.func_code,
805
nonmethod_func.func_globals,
806
nonmethod_func.func_name,
807
nonmethod_func.func_defaults,
808
nonmethod_func.func_closure)))
1695
809
# Define a creator of a function to call both the
1696
# original and alternate functions, so both the
1697
# original and alternate signals gets sent when
1698
# the function is called
810
# old and new functions, so both the old and new
811
# signals gets sent when the function is called
1699
812
def fixscope(func1, func2):
1700
813
"""This function is a scope container to pass
1701
814
func1 and func2 to the "call_both" function
1702
815
outside of its arguments"""
1704
@functools.wraps(func2)
1705
816
def call_both(*args, **kwargs):
1706
817
"""This function will emit two D-Bus
1707
818
signals by calling func1 and func2"""
1708
819
func1(*args, **kwargs)
1709
820
func2(*args, **kwargs)
1710
# Make wrapper function look like a D-Bus
1712
for name, attr in inspect.getmembers(func2):
1713
if name.startswith("_dbus_"):
1714
setattr(call_both, name, attr)
1716
821
return call_both
1717
822
# Create the "call_both" function and add it to
1719
attr[attrname] = fixscope(attribute, new_function)
824
attr[attrname] = fixscope(attribute,
1720
826
# Is this a D-Bus method?
1721
827
elif getattr(attribute, "_dbus_is_method", False):
1722
828
# Create a new, but exactly alike, function
1723
829
# object. Decorate it to be a new D-Bus method
1724
830
# with the alternate D-Bus interface name. Add it
1727
dbus.service.method(
1729
attribute._dbus_in_signature,
1730
attribute._dbus_out_signature)
1731
(copy_function(attribute)))
1732
# Copy annotations, if any
1734
attr[attrname]._dbus_annotations = dict(
1735
attribute._dbus_annotations)
1736
except AttributeError:
832
attr[attrname] = (dbus.service.method
834
attribute._dbus_in_signature,
835
attribute._dbus_out_signature)
837
(attribute.func_code,
838
attribute.func_globals,
840
attribute.func_defaults,
841
attribute.func_closure)))
1738
842
# Is this a D-Bus property?
1739
843
elif getattr(attribute, "_dbus_is_property", False):
1740
844
# Create a new, but exactly alike, function
1741
845
# object, and decorate it to be a new D-Bus
1742
846
# property with the alternate D-Bus interface
1743
847
# name. Add it to the class.
1744
attr[attrname] = (dbus_service_property(
1745
alt_interface, attribute._dbus_signature,
1746
attribute._dbus_access,
1747
attribute._dbus_get_args_options
1749
(copy_function(attribute)))
1750
# Copy annotations, if any
1752
attr[attrname]._dbus_annotations = dict(
1753
attribute._dbus_annotations)
1754
except AttributeError:
1756
# Is this a D-Bus interface?
1757
elif getattr(attribute, "_dbus_is_interface", False):
1758
# Create a new, but exactly alike, function
1759
# object. Decorate it to be a new D-Bus interface
1760
# with the alternate D-Bus interface name. Add it
1763
dbus_interface_annotations(alt_interface)
1764
(copy_function(attribute)))
1766
# Deprecate all alternate interfaces
1767
iname = "_AlternateDBusNames_interface_annotation{}"
1768
for interface_name in interface_names:
1770
@dbus_interface_annotations(interface_name)
1772
return {"org.freedesktop.DBus.Deprecated":
1774
# Find an unused name
1775
for aname in (iname.format(i)
1776
for i in itertools.count()):
1777
if aname not in attr:
1781
# Replace the class with a new subclass of it with
1782
# methods, signals, etc. as created above.
1783
if sys.version_info.major == 2:
1784
cls = type(b"{}Alternate".format(cls.__name__),
1787
cls = type("{}Alternate".format(cls.__name__),
1794
@alternate_dbus_interfaces({"se.recompile.Mandos":
1795
"se.bsnet.fukt.Mandos"})
848
attr[attrname] = (dbus_service_property
850
attribute._dbus_signature,
851
attribute._dbus_access,
853
._dbus_get_args_options
856
(attribute.func_code,
857
attribute.func_globals,
859
attribute.func_defaults,
860
attribute.func_closure)))
861
return type.__new__(mcs, name, bases, attr)
1796
863
class ClientDBus(Client, DBusObjectWithProperties):
1797
864
"""A Client class using D-Bus
1800
867
dbus_object_path: dbus.ObjectPath
1801
868
bus: dbus.SystemBus()
1804
871
runtime_expansions = (Client.runtime_expansions
1805
+ ("dbus_object_path", ))
1807
_interface = "se.recompile.Mandos.Client"
872
+ ("dbus_object_path",))
1809
874
# dbus.service.Object doesn't use super(), so we can't either.
1811
def __init__(self, bus=None, *args, **kwargs):
876
def __init__(self, bus = None, *args, **kwargs):
877
self._approvals_pending = 0
1813
879
Client.__init__(self, *args, **kwargs)
1814
880
# Only now, when this client is initialized, can it show up on
1816
client_object_name = str(self.name).translate(
882
client_object_name = unicode(self.name).translate(
1817
883
{ord("."): ord("_"),
1818
884
ord("-"): ord("_")})
1819
self.dbus_object_path = dbus.ObjectPath(
1820
"/clients/" + client_object_name)
885
self.dbus_object_path = (dbus.ObjectPath
886
("/clients/" + client_object_name))
1821
887
DBusObjectWithProperties.__init__(self, self.bus,
1822
888
self.dbus_object_path)
1824
def notifychangeproperty(transform_func, dbus_name,
1825
type_func=lambda x: x,
1827
invalidate_only=False,
1828
_interface=_interface):
890
def notifychangeproperty(transform_func,
891
dbus_name, type_func=lambda x: x,
1829
893
""" Modify a variable so that it's a property which announces
1830
894
its changes to DBus.
2225
1246
self.start_checker()
2227
1248
self.stop_checker()
2229
1250
# ObjectPath - property
2231
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2232
"org.freedesktop.DBus.Deprecated": "true"})
2233
1251
@dbus_service_property(_interface, signature="o", access="read")
2234
1252
def ObjectPath_dbus_property(self):
2235
return self.dbus_object_path # is already a dbus.ObjectPath
1253
return self.dbus_object_path # is already a dbus.ObjectPath
2237
1255
# Secret = property
2239
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2241
@dbus_service_property(_interface,
1256
@dbus_service_property(_interface, signature="ay",
1257
access="write", byte_arrays=True)
2245
1258
def Secret_dbus_property(self, value):
2246
self.secret = bytes(value)
1259
self.secret = str(value)
2252
def __init__(self, child_pipe, key_id, fpr, address):
1264
class ProxyClient(object):
1265
def __init__(self, child_pipe, fpr, address):
2253
1266
self._pipe = child_pipe
2254
self._pipe.send(('init', key_id, fpr, address))
1267
self._pipe.send(('init', fpr, address))
2255
1268
if not self._pipe.recv():
2256
raise KeyError(key_id or fpr)
2258
1271
def __getattribute__(self, name):
1272
if(name == '_pipe'):
2260
1273
return super(ProxyClient, self).__getattribute__(name)
2261
1274
self._pipe.send(('getattr', name))
2262
1275
data = self._pipe.recv()
2263
1276
if data[0] == 'data':
2265
1278
if data[0] == 'function':
2267
1279
def func(*args, **kwargs):
2268
1280
self._pipe.send(('funcall', name, args, kwargs))
2269
1281
return self._pipe.recv()[1]
2273
1284
def __setattr__(self, name, value):
1285
if(name == '_pipe'):
2275
1286
return super(ProxyClient, self).__setattr__(name, value)
2276
1287
self._pipe.send(('setattr', name, value))
1289
class ClientDBusTransitional(ClientDBus):
1290
__metaclass__ = AlternateDBusNamesMetaclass
2279
1292
class ClientHandler(socketserver.BaseRequestHandler, object):
2280
1293
"""A class to handle client connections.
2282
1295
Instantiated once for each connection to handle it.
2283
1296
Note: This will run in its own forked process."""
2285
1298
def handle(self):
2286
1299
with contextlib.closing(self.server.child_pipe) as child_pipe:
2287
1300
logger.info("TCP connection from: %s",
2288
str(self.client_address))
1301
unicode(self.client_address))
2289
1302
logger.debug("Pipe FD: %d",
2290
1303
self.server.child_pipe.fileno())
2292
session = gnutls.ClientSession(self.request)
2294
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2295
# "+AES-256-CBC", "+SHA1",
2296
# "+COMP-NULL", "+CTYPE-OPENPGP",
1305
session = (gnutls.connection
1306
.ClientSession(self.request,
1308
.X509Credentials()))
1310
# Note: gnutls.connection.X509Credentials is really a
1311
# generic GnuTLS certificate credentials object so long as
1312
# no X.509 keys are added to it. Therefore, we can use it
1313
# here despite using OpenPGP certificates.
1315
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1316
# "+AES-256-CBC", "+SHA1",
1317
# "+COMP-NULL", "+CTYPE-OPENPGP",
2298
1319
# Use a fallback default, since this MUST be set.
2299
1320
priority = self.server.gnutls_priority
2300
1321
if priority is None:
2301
1322
priority = "NORMAL"
2302
gnutls.priority_set_direct(session._c_object,
2303
priority.encode("utf-8"),
1323
(gnutls.library.functions
1324
.gnutls_priority_set_direct(session._c_object,
2306
1327
# Start communication using the Mandos protocol
2307
1328
# Get protocol number
2308
1329
line = self.request.makefile().readline()
2309
1330
logger.debug("Protocol version: %r", line)
2311
1332
if int(line.strip().split()[0]) > 1:
2312
raise RuntimeError(line)
2313
1334
except (ValueError, IndexError, RuntimeError) as error:
2314
1335
logger.error("Unknown protocol version: %s", error)
2317
1338
# Start GnuTLS connection
2319
1340
session.handshake()
2320
except gnutls.Error as error:
1341
except gnutls.errors.GNUTLSError as error:
2321
1342
logger.warning("Handshake failed: %s", error)
2322
1343
# Do not run session.bye() here: the session is not
2323
1344
# established. Just abandon the request.
2325
1346
logger.debug("Handshake succeeded")
2327
1348
approval_required = False
2329
if gnutls.has_rawpk:
2332
key_id = self.key_id(
2333
self.peer_certificate(session))
2334
except (TypeError, gnutls.Error) as error:
2335
logger.warning("Bad certificate: %s", error)
2337
logger.debug("Key ID: %s", key_id)
2342
fpr = self.fingerprint(
2343
self.peer_certificate(session))
2344
except (TypeError, gnutls.Error) as error:
2345
logger.warning("Bad certificate: %s", error)
2347
logger.debug("Fingerprint: %s", fpr)
2350
client = ProxyClient(child_pipe, key_id, fpr,
1351
fpr = self.fingerprint(self.peer_certificate
1354
gnutls.errors.GNUTLSError) as error:
1355
logger.warning("Bad certificate: %s", error)
1357
logger.debug("Fingerprint: %s", fpr)
1360
client = ProxyClient(child_pipe, fpr,
2351
1361
self.client_address)
2352
1362
except KeyError:
2355
1365
if client.approval_delay:
2356
1366
delay = client.approval_delay
2357
1367
client.approvals_pending += 1
2358
1368
approval_required = True
2361
1371
if not client.enabled:
2362
1372
logger.info("Client %s is disabled",
2364
1374
if self.server.use_dbus:
2365
1375
# Emit D-Bus signal
2366
1376
client.Rejected("Disabled")
2369
if client.approved or not client.approval_delay:
2370
# We are approved or approval is disabled
1379
if client._approved or not client.approval_delay:
1380
#We are approved or approval is disabled
2372
elif client.approved is None:
1382
elif client._approved is None:
2373
1383
logger.info("Client %s needs approval",
2375
1385
if self.server.use_dbus:
2376
1386
# Emit D-Bus signal
2377
1387
client.NeedApproval(
2378
client.approval_delay.total_seconds()
2379
* 1000, client.approved_by_default)
1388
client.approval_delay_milliseconds(),
1389
client.approved_by_default)
2381
1391
logger.warning("Client %s was not approved",
2406
1418
delay -= time2 - time
2409
session.send(client.secret)
2410
except gnutls.Error as error:
2411
logger.warning("gnutls send failed",
1421
while sent_size < len(client.secret):
1423
sent = session.send(client.secret[sent_size:])
1424
except gnutls.errors.GNUTLSError as error:
1425
logger.warning("gnutls send failed")
1427
logger.debug("Sent: %d, remaining: %d",
1428
sent, len(client.secret)
1429
- (sent_size + sent))
2415
1432
logger.info("Sending secret to %s", client.name)
2416
1433
# bump the timeout using extended_timeout
2417
client.bump_timeout(client.extended_timeout)
1434
client.checked_ok(client.extended_timeout)
2418
1435
if self.server.use_dbus:
2419
1436
# Emit D-Bus signal
2420
1437
client.GotSecret()
2423
1440
if approval_required:
2424
1441
client.approvals_pending -= 1
2427
except gnutls.Error as error:
2428
logger.warning("GnuTLS bye failed",
1444
except gnutls.errors.GNUTLSError as error:
1445
logger.warning("GnuTLS bye failed")
2432
1448
def peer_certificate(session):
2433
"Return the peer's certificate as a bytestring"
2435
cert_type = gnutls.certificate_type_get2(session._c_object,
2437
except AttributeError:
2438
cert_type = gnutls.certificate_type_get(session._c_object)
2439
if gnutls.has_rawpk:
2440
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2442
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2443
# If not a valid certificate type...
2444
if cert_type not in valid_cert_types:
2445
logger.info("Cert type %r not in %r", cert_type,
2447
# ...return invalid data
1449
"Return the peer's OpenPGP certificate as a bytestring"
1450
# If not an OpenPGP certificate...
1451
if (gnutls.library.functions
1452
.gnutls_certificate_type_get(session._c_object)
1453
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1454
# ...do the normal thing
1455
return session.peer_certificate
2449
1456
list_size = ctypes.c_uint(1)
2450
cert_list = (gnutls.certificate_get_peers
1457
cert_list = (gnutls.library.functions
1458
.gnutls_certificate_get_peers
2451
1459
(session._c_object, ctypes.byref(list_size)))
2452
1460
if not bool(cert_list) and list_size.value != 0:
2453
raise gnutls.Error("error getting peer certificate")
1461
raise gnutls.errors.GNUTLSError("error getting peer"
2454
1463
if list_size.value == 0:
2456
1465
cert = cert_list[0]
2457
1466
return ctypes.string_at(cert.data, cert.size)
2460
def key_id(certificate):
2461
"Convert a certificate bytestring to a hexdigit key ID"
2462
# New GnuTLS "datum" with the public key
2463
datum = gnutls.datum_t(
2464
ctypes.cast(ctypes.c_char_p(certificate),
2465
ctypes.POINTER(ctypes.c_ubyte)),
2466
ctypes.c_uint(len(certificate)))
2467
# XXX all these need to be created in the gnutls "module"
2468
# New empty GnuTLS certificate
2469
pubkey = gnutls.pubkey_t()
2470
gnutls.pubkey_init(ctypes.byref(pubkey))
2471
# Import the raw public key into the certificate
2472
gnutls.pubkey_import(pubkey,
2473
ctypes.byref(datum),
2474
gnutls.X509_FMT_DER)
2475
# New buffer for the key ID
2476
buf = ctypes.create_string_buffer(32)
2477
buf_len = ctypes.c_size_t(len(buf))
2478
# Get the key ID from the raw public key into the buffer
2479
gnutls.pubkey_get_key_id(
2481
gnutls.KEYID_USE_SHA256,
2482
ctypes.cast(ctypes.byref(buf),
2483
ctypes.POINTER(ctypes.c_ubyte)),
2484
ctypes.byref(buf_len))
2485
# Deinit the certificate
2486
gnutls.pubkey_deinit(pubkey)
2488
# Convert the buffer to a Python bytestring
2489
key_id = ctypes.string_at(buf, buf_len.value)
2490
# Convert the bytestring to hexadecimal notation
2491
hex_key_id = binascii.hexlify(key_id).upper()
2495
1469
def fingerprint(openpgp):
2496
1470
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2497
1471
# New GnuTLS "datum" with the OpenPGP public key
2498
datum = gnutls.datum_t(
2499
ctypes.cast(ctypes.c_char_p(openpgp),
2500
ctypes.POINTER(ctypes.c_ubyte)),
2501
ctypes.c_uint(len(openpgp)))
1472
datum = (gnutls.library.types
1473
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1476
ctypes.c_uint(len(openpgp))))
2502
1477
# New empty GnuTLS certificate
2503
crt = gnutls.openpgp_crt_t()
2504
gnutls.openpgp_crt_init(ctypes.byref(crt))
1478
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1479
(gnutls.library.functions
1480
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2505
1481
# Import the OpenPGP public key into the certificate
2506
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2507
gnutls.OPENPGP_FMT_RAW)
1482
(gnutls.library.functions
1483
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1484
gnutls.library.constants
1485
.GNUTLS_OPENPGP_FMT_RAW))
2508
1486
# Verify the self signature in the key
2509
1487
crtverify = ctypes.c_uint()
2510
gnutls.openpgp_crt_verify_self(crt, 0,
2511
ctypes.byref(crtverify))
1488
(gnutls.library.functions
1489
.gnutls_openpgp_crt_verify_self(crt, 0,
1490
ctypes.byref(crtverify)))
2512
1491
if crtverify.value != 0:
2513
gnutls.openpgp_crt_deinit(crt)
2514
raise gnutls.CertificateSecurityError(code
1492
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1493
raise (gnutls.errors.CertificateSecurityError
2516
1495
# New buffer for the fingerprint
2517
1496
buf = ctypes.create_string_buffer(20)
2518
1497
buf_len = ctypes.c_size_t()
2519
1498
# Get the fingerprint from the certificate into the buffer
2520
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2521
ctypes.byref(buf_len))
1499
(gnutls.library.functions
1500
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1501
ctypes.byref(buf_len)))
2522
1502
# Deinit the certificate
2523
gnutls.openpgp_crt_deinit(crt)
1503
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2524
1504
# Convert the buffer to a Python bytestring
2525
1505
fpr = ctypes.string_at(buf, buf_len.value)
2526
1506
# Convert the bytestring to hexadecimal notation
2527
hex_fpr = binascii.hexlify(fpr).upper()
1507
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2531
class MultiprocessingMixIn:
1511
class MultiprocessingMixIn(object):
2532
1512
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2534
1513
def sub_process_main(self, request, address):
2536
1515
self.finish_request(request, address)
2538
1517
self.handle_error(request, address)
2539
1518
self.close_request(request)
2541
1520
def process_request(self, request, address):
2542
1521
"""Start a new process to process the request."""
2543
proc = multiprocessing.Process(target=self.sub_process_main,
2544
args=(request, address))
1522
proc = multiprocessing.Process(target = self.sub_process_main,
2549
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1529
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2550
1530
""" adds a pipe to the MixIn """
2552
1531
def process_request(self, request, client_address):
2553
1532
"""Overrides and wraps the original process_request().
2555
1534
This function creates a new pipe in self.pipe
2557
1536
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2559
1538
proc = MultiprocessingMixIn.process_request(self, request,
2560
1539
client_address)
2561
1540
self.child_pipe.close()
2562
1541
self.add_pipe(parent_pipe, proc)
2564
1543
def add_pipe(self, parent_pipe, proc):
2565
1544
"""Dummy function; override as necessary"""
2566
raise NotImplementedError()
1545
raise NotImplementedError
2569
1548
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2570
socketserver.TCPServer):
1549
socketserver.TCPServer, object):
2571
1550
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2574
1553
enabled: Boolean; whether this server is activated yet
2575
1554
interface: None or a network interface name (string)
2576
1555
use_ipv6: Boolean; to use IPv6 or not
2579
1557
def __init__(self, server_address, RequestHandlerClass,
2583
"""If socketfd is set, use that file descriptor instead of
2584
creating a new one with socket.socket().
1558
interface=None, use_ipv6=True):
2586
1559
self.interface = interface
2588
1561
self.address_family = socket.AF_INET6
2589
if socketfd is not None:
2590
# Save the file descriptor
2591
self.socketfd = socketfd
2592
# Save the original socket.socket() function
2593
self.socket_socket = socket.socket
2595
# To implement --socket, we monkey patch socket.socket.
2597
# (When socketserver.TCPServer is a new-style class, we
2598
# could make self.socket into a property instead of monkey
2599
# patching socket.socket.)
2601
# Create a one-time-only replacement for socket.socket()
2602
@functools.wraps(socket.socket)
2603
def socket_wrapper(*args, **kwargs):
2604
# Restore original function so subsequent calls are
2606
socket.socket = self.socket_socket
2607
del self.socket_socket
2608
# This time only, return a new socket object from the
2609
# saved file descriptor.
2610
return socket.fromfd(self.socketfd, *args, **kwargs)
2611
# Replace socket.socket() function with wrapper
2612
socket.socket = socket_wrapper
2613
# The socketserver.TCPServer.__init__ will call
2614
# socket.socket(), which might be our replacement,
2615
# socket_wrapper(), if socketfd was set.
2616
1562
socketserver.TCPServer.__init__(self, server_address,
2617
1563
RequestHandlerClass)
2619
1564
def server_bind(self):
2620
1565
"""This overrides the normal server_bind() function
2621
1566
to bind to an interface if one was specified, and also NOT to
2622
1567
bind to an address or port if they were not specified."""
2623
global SO_BINDTODEVICE
2624
1568
if self.interface is not None:
2625
1569
if SO_BINDTODEVICE is None:
2626
# Fall back to a hard-coded value which seems to be
2628
logger.warning("SO_BINDTODEVICE not found, trying 25")
2629
SO_BINDTODEVICE = 25
2631
self.socket.setsockopt(
2632
socket.SOL_SOCKET, SO_BINDTODEVICE,
2633
(self.interface + "\0").encode("utf-8"))
2634
except socket.error as error:
2635
if error.errno == errno.EPERM:
2636
logger.error("No permission to bind to"
2637
" interface %s", self.interface)
2638
elif error.errno == errno.ENOPROTOOPT:
2639
logger.error("SO_BINDTODEVICE not available;"
2640
" cannot bind to interface %s",
2642
elif error.errno == errno.ENODEV:
2643
logger.error("Interface %s does not exist,"
2644
" cannot bind", self.interface)
1570
logger.error("SO_BINDTODEVICE does not exist;"
1571
" cannot bind to interface %s",
1575
self.socket.setsockopt(socket.SOL_SOCKET,
1579
except socket.error as error:
1580
if error[0] == errno.EPERM:
1581
logger.error("No permission to"
1582
" bind to interface %s",
1584
elif error[0] == errno.ENOPROTOOPT:
1585
logger.error("SO_BINDTODEVICE not available;"
1586
" cannot bind to interface %s",
2647
1590
# Only bind(2) the socket if we really need to.
2648
1591
if self.server_address[0] or self.server_address[1]:
2649
if self.server_address[1]:
2650
self.allow_reuse_address = True
2651
1592
if not self.server_address[0]:
2652
1593
if self.address_family == socket.AF_INET6:
2653
any_address = "::" # in6addr_any
1594
any_address = "::" # in6addr_any
2655
any_address = "0.0.0.0" # INADDR_ANY
1596
any_address = socket.INADDR_ANY
2656
1597
self.server_address = (any_address,
2657
1598
self.server_address[1])
2658
1599
elif not self.server_address[1]:
2659
self.server_address = (self.server_address[0], 0)
1600
self.server_address = (self.server_address[0],
2660
1602
# if self.interface:
2661
1603
# self.server_address = (self.server_address[0],
2992
1849
parser.add_argument("--no-dbus", action="store_false",
2993
1850
dest="use_dbus", help="Do not provide D-Bus"
2994
" system bus interface", default=None)
1851
" system bus interface")
2995
1852
parser.add_argument("--no-ipv6", action="store_false",
2996
dest="use_ipv6", help="Do not use IPv6",
2998
parser.add_argument("--no-restore", action="store_false",
2999
dest="restore", help="Do not restore stored"
3000
" state", default=None)
3001
parser.add_argument("--socket", type=int,
3002
help="Specify a file descriptor to a network"
3003
" socket to use instead of creating one")
3004
parser.add_argument("--statedir", metavar="DIR",
3005
help="Directory to save/restore state in")
3006
parser.add_argument("--foreground", action="store_true",
3007
help="Run in foreground", default=None)
3008
parser.add_argument("--no-zeroconf", action="store_false",
3009
dest="zeroconf", help="Do not use Zeroconf",
1853
dest="use_ipv6", help="Do not use IPv6")
3012
1854
options = parser.parse_args()
3014
1861
# Default values for config file for server-global settings
3015
if gnutls.has_rawpk:
3016
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3017
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3019
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3020
":+SIGN-DSA-SHA256")
3021
server_defaults = {"interface": "",
3025
"priority": priority,
3026
"servicename": "Mandos",
3032
"statedir": "/var/lib/mandos",
3033
"foreground": "False",
1862
server_defaults = { "interface": "",
1867
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1868
"servicename": "Mandos",
3038
1874
# Parse config file for server-global settings
3039
server_config = configparser.ConfigParser(server_defaults)
1875
server_config = configparser.SafeConfigParser(server_defaults)
3040
1876
del server_defaults
3041
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3042
# Convert the ConfigParser object to a dict
1877
server_config.read(os.path.join(options.configdir,
1879
# Convert the SafeConfigParser object to a dict
3043
1880
server_settings = server_config.defaults()
3044
1881
# Use the appropriate methods on the non-string config options
3045
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3046
"foreground", "zeroconf"):
1882
for option in ("debug", "use_dbus", "use_ipv6"):
3047
1883
server_settings[option] = server_config.getboolean("DEFAULT",
3049
1885
if server_settings["port"]:
3050
1886
server_settings["port"] = server_config.getint("DEFAULT",
3052
if server_settings["socket"]:
3053
server_settings["socket"] = server_config.getint("DEFAULT",
3055
# Later, stdin will, and stdout and stderr might, be dup'ed
3056
# over with an opened os.devnull. But we don't want this to
3057
# happen with a supplied network socket.
3058
if 0 <= server_settings["socket"] <= 2:
3059
server_settings["socket"] = os.dup(server_settings
3061
1888
del server_config
3063
1890
# Override the settings from the config file with command line
3064
1891
# options, if set.
3065
1892
for option in ("interface", "address", "port", "debug",
3066
"priority", "servicename", "configdir", "use_dbus",
3067
"use_ipv6", "debuglevel", "restore", "statedir",
3068
"socket", "foreground", "zeroconf"):
1893
"priority", "servicename", "configdir",
1894
"use_dbus", "use_ipv6", "debuglevel"):
3069
1895
value = getattr(options, option)
3070
1896
if value is not None:
3071
1897
server_settings[option] = value
3073
1899
# Force all strings to be unicode
3074
1900
for option in server_settings.keys():
3075
if isinstance(server_settings[option], bytes):
3076
server_settings[option] = (server_settings[option]
3078
# Force all boolean options to be boolean
3079
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3080
"foreground", "zeroconf"):
3081
server_settings[option] = bool(server_settings[option])
3082
# Debug implies foreground
3083
if server_settings["debug"]:
3084
server_settings["foreground"] = True
1901
if type(server_settings[option]) is str:
1902
server_settings[option] = unicode(server_settings[option])
3085
1903
# Now we have our good server settings in "server_settings"
3087
1905
##################################################################
3089
if (not server_settings["zeroconf"]
3090
and not (server_settings["port"]
3091
or server_settings["socket"] != "")):
3092
parser.error("Needs port or socket to work without Zeroconf")
3094
1907
# For convenience
3095
1908
debug = server_settings["debug"]
3096
1909
debuglevel = server_settings["debuglevel"]
3097
1910
use_dbus = server_settings["use_dbus"]
3098
1911
use_ipv6 = server_settings["use_ipv6"]
3099
stored_state_path = os.path.join(server_settings["statedir"],
3101
foreground = server_settings["foreground"]
3102
zeroconf = server_settings["zeroconf"]
3105
initlogger(debug, logging.DEBUG)
3110
level = getattr(logging, debuglevel.upper())
3111
initlogger(debug, level)
3113
1913
if server_settings["servicename"] != "Mandos":
3114
syslogger.setFormatter(
3115
logging.Formatter('Mandos ({}) [%(process)d]:'
3116
' %(levelname)s: %(message)s'.format(
3117
server_settings["servicename"])))
1914
syslogger.setFormatter(logging.Formatter
1915
('Mandos (%s) [%%(process)d]:'
1916
' %%(levelname)s: %%(message)s'
1917
% server_settings["servicename"]))
3119
1919
# Parse config file with clients
3120
client_config = configparser.ConfigParser(Client.client_defaults)
1920
client_defaults = { "timeout": "5m",
1921
"extended_timeout": "15m",
1923
"checker": "fping -q -- %%(host)s",
1925
"approval_delay": "0s",
1926
"approval_duration": "1s",
1928
client_config = configparser.SafeConfigParser(client_defaults)
3121
1929
client_config.read(os.path.join(server_settings["configdir"],
3122
1930
"clients.conf"))
3124
1932
global mandos_dbus_service
3125
1933
mandos_dbus_service = None
3128
if server_settings["socket"] != "":
3129
socketfd = server_settings["socket"]
3130
tcp_server = MandosServer(
3131
(server_settings["address"], server_settings["port"]),
3133
interface=(server_settings["interface"] or None),
3135
gnutls_priority=server_settings["priority"],
3139
pidfilename = "/run/mandos.pid"
3140
if not os.path.isdir("/run/."):
3141
pidfilename = "/var/run/mandos.pid"
3144
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3145
except IOError as e:
3146
logger.error("Could not open file %r", pidfilename,
3149
for name, group in (("_mandos", "_mandos"),
3150
("mandos", "mandos"),
3151
("nobody", "nogroup")):
3153
uid = pwd.getpwnam(name).pw_uid
3154
gid = pwd.getpwnam(group).pw_gid
1935
tcp_server = MandosServer((server_settings["address"],
1936
server_settings["port"]),
1938
interface=(server_settings["interface"]
1942
server_settings["priority"],
1945
pidfilename = "/var/run/mandos.pid"
1947
pidfile = open(pidfilename, "w")
1949
logger.error("Could not open file %r", pidfilename)
1952
uid = pwd.getpwnam("_mandos").pw_uid
1953
gid = pwd.getpwnam("_mandos").pw_gid
1956
uid = pwd.getpwnam("mandos").pw_uid
1957
gid = pwd.getpwnam("mandos").pw_gid
3156
1958
except KeyError:
1960
uid = pwd.getpwnam("nobody").pw_uid
1961
gid = pwd.getpwnam("nobody").pw_gid
3165
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3167
1968
except OSError as error:
3168
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3169
.format(uid, gid, os.strerror(error.errno)))
3170
if error.errno != errno.EPERM:
1969
if error[0] != errno.EPERM:
1972
if not debug and not debuglevel:
1973
syslogger.setLevel(logging.WARNING)
1974
console.setLevel(logging.WARNING)
1976
level = getattr(logging, debuglevel.upper())
1977
syslogger.setLevel(level)
1978
console.setLevel(level)
3174
1981
# Enable all possible GnuTLS debugging
3176
1983
# "Use a log level over 10 to enable all debugging options."
3177
1984
# - GnuTLS manual
3178
gnutls.global_set_log_level(11)
1985
gnutls.library.functions.gnutls_global_set_log_level(11)
1987
@gnutls.library.types.gnutls_log_func
3181
1988
def debug_gnutls(level, string):
3182
1989
logger.debug("GnuTLS: %s", string[:-1])
3184
gnutls.global_set_log_function(debug_gnutls)
1991
(gnutls.library.functions
1992
.gnutls_global_set_log_function(debug_gnutls))
3186
1994
# Redirect stdin so all checkers get /dev/null
3187
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1995
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3188
1996
os.dup2(null, sys.stdin.fileno())
2000
# No console logging
2001
logger.removeHandler(console)
3192
2003
# Need to fork before connecting to D-Bus
3194
2005
# Close all input and output, do double fork, etc.
3197
if gi.version_info < (3, 10, 2):
3198
# multiprocessing will use threads, so before we use GLib we
3199
# need to inform GLib that threads will be used.
3202
2008
global main_loop
3203
2009
# From the Avahi example code
3204
DBusGMainLoop(set_as_default=True)
3205
main_loop = GLib.MainLoop()
2010
DBusGMainLoop(set_as_default=True )
2011
main_loop = gobject.MainLoop()
3206
2012
bus = dbus.SystemBus()
3207
2013
# End of Avahi example code
3210
2016
bus_name = dbus.service.BusName("se.recompile.Mandos",
3213
old_bus_name = dbus.service.BusName(
3214
"se.bsnet.fukt.Mandos", bus,
3216
except dbus.exceptions.DBusException as e:
3217
logger.error("Disabling D-Bus:", exc_info=e)
2017
bus, do_not_queue=True)
2018
old_bus_name = (dbus.service.BusName
2019
("se.bsnet.fukt.Mandos", bus,
2021
except dbus.exceptions.NameExistsException as e:
2022
logger.error(unicode(e) + ", disabling D-Bus")
3218
2023
use_dbus = False
3219
2024
server_settings["use_dbus"] = False
3220
2025
tcp_server.use_dbus = False
3222
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3223
service = AvahiServiceToSyslog(
3224
name=server_settings["servicename"],
3225
servicetype="_mandos._tcp",
3228
if server_settings["interface"]:
3229
service.interface = if_nametoindex(
3230
server_settings["interface"].encode("utf-8"))
2026
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2027
service = AvahiService(name = server_settings["servicename"],
2028
servicetype = "_mandos._tcp",
2029
protocol = protocol, bus = bus)
2030
if server_settings["interface"]:
2031
service.interface = (if_nametoindex
2032
(str(server_settings["interface"])))
3232
2034
global multiprocessing_manager
3233
2035
multiprocessing_manager = multiprocessing.Manager()
3235
2037
client_class = Client
3237
client_class = functools.partial(ClientDBus, bus=bus)
3239
client_settings = Client.config_parser(client_config)
3240
old_client_settings = {}
3243
# This is used to redirect stdout and stderr for checker processes
3245
wnull = open(os.devnull, "w") # A writable /dev/null
3246
# Only used if server is running in foreground but not in debug
3248
if debug or not foreground:
3251
# Get client data and settings from last running state.
3252
if server_settings["restore"]:
3254
with open(stored_state_path, "rb") as stored_state:
3255
if sys.version_info.major == 2:
3256
clients_data, old_client_settings = pickle.load(
3259
bytes_clients_data, bytes_old_client_settings = (
3260
pickle.load(stored_state, encoding="bytes"))
3261
# Fix bytes to strings
3264
clients_data = {(key.decode("utf-8")
3265
if isinstance(key, bytes)
3268
bytes_clients_data.items()}
3269
del bytes_clients_data
3270
for key in clients_data:
3271
value = {(k.decode("utf-8")
3272
if isinstance(k, bytes) else k): v
3274
clients_data[key].items()}
3275
clients_data[key] = value
3277
value["client_structure"] = [
3279
if isinstance(s, bytes)
3281
value["client_structure"]]
3282
# .name, .host, and .checker_command
3283
for k in ("name", "host", "checker_command"):
3284
if isinstance(value[k], bytes):
3285
value[k] = value[k].decode("utf-8")
3286
if "key_id" not in value:
3287
value["key_id"] = ""
3288
elif "fingerprint" not in value:
3289
value["fingerprint"] = ""
3290
# old_client_settings
3292
old_client_settings = {
3293
(key.decode("utf-8")
3294
if isinstance(key, bytes)
3297
bytes_old_client_settings.items()}
3298
del bytes_old_client_settings
3299
# .host and .checker_command
3300
for value in old_client_settings.values():
3301
for attribute in ("host", "checker_command"):
3302
if isinstance(value[attribute], bytes):
3303
value[attribute] = (value[attribute]
3305
os.remove(stored_state_path)
3306
except IOError as e:
3307
if e.errno == errno.ENOENT:
3308
logger.warning("Could not load persistent state:"
3309
" {}".format(os.strerror(e.errno)))
3311
logger.critical("Could not load persistent state:",
3314
except EOFError as e:
3315
logger.warning("Could not load persistent state: "
3319
with PGPEngine() as pgp:
3320
for client_name, client in clients_data.items():
3321
# Skip removed clients
3322
if client_name not in client_settings:
3325
# Decide which value to use after restoring saved state.
3326
# We have three different values: Old config file,
3327
# new config file, and saved state.
3328
# New config value takes precedence if it differs from old
3329
# config value, otherwise use saved state.
3330
for name, value in client_settings[client_name].items():
3332
# For each value in new config, check if it
3333
# differs from the old config value (Except for
3334
# the "secret" attribute)
3335
if (name != "secret"
3337
old_client_settings[client_name][name])):
3338
client[name] = value
3342
# Clients who has passed its expire date can still be
3343
# enabled if its last checker was successful. A Client
3344
# whose checker succeeded before we stored its state is
3345
# assumed to have successfully run all checkers during
3347
if client["enabled"]:
3348
if datetime.datetime.utcnow() >= client["expires"]:
3349
if not client["last_checked_ok"]:
3351
"disabling client {} - Client never "
3352
"performed a successful checker".format(
3354
client["enabled"] = False
3355
elif client["last_checker_status"] != 0:
3357
"disabling client {} - Client last"
3358
" checker failed with error code"
3361
client["last_checker_status"]))
3362
client["enabled"] = False
3364
client["expires"] = (
3365
datetime.datetime.utcnow()
3366
+ client["timeout"])
3367
logger.debug("Last checker succeeded,"
3368
" keeping {} enabled".format(
2039
client_class = functools.partial(ClientDBusTransitional,
2041
def client_config_items(config, section):
2042
special_settings = {
2043
"approved_by_default":
2044
lambda: config.getboolean(section,
2045
"approved_by_default"),
2047
for name, value in config.items(section):
3371
client["secret"] = pgp.decrypt(
3372
client["encrypted_secret"],
3373
client_settings[client_name]["secret"])
3375
# If decryption fails, we use secret from new settings
3376
logger.debug("Failed to decrypt {} old secret".format(
3378
client["secret"] = (client_settings[client_name]
3381
# Add/remove clients based on new changes made to config
3382
for client_name in (set(old_client_settings)
3383
- set(client_settings)):
3384
del clients_data[client_name]
3385
for client_name in (set(client_settings)
3386
- set(old_client_settings)):
3387
clients_data[client_name] = client_settings[client_name]
3389
# Create all client objects
3390
for client_name, client in clients_data.items():
3391
tcp_server.clients[client_name] = client_class(
3394
server_settings=server_settings)
2049
yield (name, special_settings[name]())
2053
tcp_server.clients.update(set(
2054
client_class(name = section,
2055
config= dict(client_config_items(
2056
client_config, section)))
2057
for section in client_config.sections()))
3396
2058
if not tcp_server.clients:
3397
2059
logger.warning("No clients defined")
3400
if pidfile is not None:
3404
print(pid, file=pidfile)
3406
logger.error("Could not write to file %r with PID %d",
2065
pidfile.write(str(pid) + "\n".encode("utf-8"))
2068
logger.error("Could not write to file %r with PID %d",
2071
# "pidfile" was never created
3409
2073
del pidfilename
3411
for termsig in (signal.SIGHUP, signal.SIGTERM):
3412
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3413
lambda: main_loop.quit() and False)
2075
signal.signal(signal.SIGINT, signal.SIG_IGN)
2077
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2078
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3417
@alternate_dbus_interfaces(
3418
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3419
class MandosDBusService(DBusObjectWithObjectManager):
2081
class MandosDBusService(dbus.service.Object):
3420
2082
"""A D-Bus proxy object"""
3422
2083
def __init__(self):
3423
2084
dbus.service.Object.__init__(self, bus, "/")
3425
2085
_interface = "se.recompile.Mandos"
3427
2087
@dbus.service.signal(_interface, signature="o")
3428
2088
def ClientAdded(self, objpath):
3432
2092
@dbus.service.signal(_interface, signature="ss")
3433
def ClientNotFound(self, key_id, address):
2093
def ClientNotFound(self, fingerprint, address):
3437
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3439
2097
@dbus.service.signal(_interface, signature="os")
3440
2098
def ClientRemoved(self, objpath, name):
3444
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3446
2102
@dbus.service.method(_interface, out_signature="ao")
3447
2103
def GetAllClients(self):
3449
return dbus.Array(c.dbus_object_path for c in
3450
tcp_server.clients.values())
3452
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2105
return dbus.Array(c.dbus_object_path
2106
for c in tcp_server.clients)
3454
2108
@dbus.service.method(_interface,
3455
2109
out_signature="a{oa{sv}}")
3456
2110
def GetAllClientsWithProperties(self):
3458
2112
return dbus.Dictionary(
3459
{c.dbus_object_path: c.GetAll(
3460
"se.recompile.Mandos.Client")
3461
for c in tcp_server.clients.values()},
2113
((c.dbus_object_path, c.GetAll(""))
2114
for c in tcp_server.clients),
3462
2115
signature="oa{sv}")
3464
2117
@dbus.service.method(_interface, in_signature="o")
3465
2118
def RemoveClient(self, object_path):
3467
for c in tcp_server.clients.values():
2120
for c in tcp_server.clients:
3468
2121
if c.dbus_object_path == object_path:
3469
del tcp_server.clients[c.name]
2122
tcp_server.clients.remove(c)
3470
2123
c.remove_from_connection()
3471
# Don't signal the disabling
2124
# Don't signal anything except ClientRemoved
3472
2125
c.disable(quiet=True)
3473
# Emit D-Bus signal for removal
3474
self.client_removed_signal(c)
2127
self.ClientRemoved(object_path, c.name)
3476
2129
raise KeyError(object_path)
3480
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3481
out_signature="a{oa{sa{sv}}}")
3482
def GetManagedObjects(self):
3484
return dbus.Dictionary(
3485
{client.dbus_object_path:
3487
{interface: client.GetAll(interface)
3489
client._get_all_interface_names()})
3490
for client in tcp_server.clients.values()})
3492
def client_added_signal(self, client):
3493
"""Send the new standard signal and the old signal"""
3495
# New standard signal
3496
self.InterfacesAdded(
3497
client.dbus_object_path,
3499
{interface: client.GetAll(interface)
3501
client._get_all_interface_names()}))
3503
self.ClientAdded(client.dbus_object_path)
3505
def client_removed_signal(self, client):
3506
"""Send the new standard signal and the old signal"""
3508
# New standard signal
3509
self.InterfacesRemoved(
3510
client.dbus_object_path,
3511
client._get_all_interface_names())
3513
self.ClientRemoved(client.dbus_object_path,
3516
mandos_dbus_service = MandosDBusService()
3518
# Save modules to variables to exempt the modules from being
3519
# unloaded before the function registered with atexit() is run.
3520
mp = multiprocessing
2133
class MandosDBusServiceTransitional(MandosDBusService):
2134
__metaclass__ = AlternateDBusNamesMetaclass
2135
mandos_dbus_service = MandosDBusServiceTransitional()
3524
2138
"Cleanup function; run on exit"
3528
mp.active_children()
3530
if not (tcp_server.clients or client_settings):
3533
# Store client before exiting. Secrets are encrypted with key
3534
# based on what config file has. If config file is
3535
# removed/edited, old secret will thus be unrecovable.
3537
with PGPEngine() as pgp:
3538
for client in tcp_server.clients.values():
3539
key = client_settings[client.name]["secret"]
3540
client.encrypted_secret = pgp.encrypt(client.secret,
3544
# A list of attributes that can not be pickled
3546
exclude = {"bus", "changedstate", "secret",
3547
"checker", "server_settings"}
3548
for name, typ in inspect.getmembers(dbus.service
3552
client_dict["encrypted_secret"] = (client
3554
for attr in client.client_structure:
3555
if attr not in exclude:
3556
client_dict[attr] = getattr(client, attr)
3558
clients[client.name] = client_dict
3559
del client_settings[client.name]["secret"]
3562
with tempfile.NamedTemporaryFile(
3566
dir=os.path.dirname(stored_state_path),
3567
delete=False) as stored_state:
3568
pickle.dump((clients, client_settings), stored_state,
3570
tempname = stored_state.name
3571
os.rename(tempname, stored_state_path)
3572
except (IOError, OSError) as e:
3578
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3579
logger.warning("Could not save persistent state: {}"
3580
.format(os.strerror(e.errno)))
3582
logger.warning("Could not save persistent state:",
3586
# Delete all clients, and settings from config
2141
multiprocessing.active_children()
3587
2142
while tcp_server.clients:
3588
name, client = tcp_server.clients.popitem()
2143
client = tcp_server.clients.pop()
3590
2145
client.remove_from_connection()
3591
# Don't signal the disabling
2146
client.disable_hook = None
2147
# Don't signal anything except ClientRemoved
3592
2148
client.disable(quiet=True)
3593
# Emit D-Bus signal for removal
3595
mandos_dbus_service.client_removed_signal(client)
3596
client_settings.clear()
2151
mandos_dbus_service.ClientRemoved(client
3598
2155
atexit.register(cleanup)
3600
for client in tcp_server.clients.values():
2157
for client in tcp_server.clients:
3602
# Emit D-Bus signal for adding
3603
mandos_dbus_service.client_added_signal(client)
3604
# Need to initiate checking of clients
3606
client.init_checker()
2160
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3608
2163
tcp_server.enable()
3609
2164
tcp_server.server_activate()
3611
2166
# Find out what port we got
3613
service.port = tcp_server.socket.getsockname()[1]
2167
service.port = tcp_server.socket.getsockname()[1]
3615
2169
logger.info("Now listening on address %r, port %d,"
3616
" flowinfo %d, scope_id %d",
3617
*tcp_server.socket.getsockname())
2170
" flowinfo %d, scope_id %d"
2171
% tcp_server.socket.getsockname())
3619
logger.info("Now listening on address %r, port %d",
3620
*tcp_server.socket.getsockname())
3622
# service.interface = tcp_server.socket.getsockname()[3]
2173
logger.info("Now listening on address %r, port %d"
2174
% tcp_server.socket.getsockname())
2176
#service.interface = tcp_server.socket.getsockname()[3]
3626
# From the Avahi example code
3629
except dbus.exceptions.DBusException as error:
3630
logger.critical("D-Bus Exception", exc_info=error)
3633
# End of Avahi example code
3636
GLib.IOChannel.unix_new(tcp_server.fileno()),
3637
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3638
lambda *args, **kwargs: (tcp_server.handle_request
3639
(*args[2:], **kwargs) or True))
2179
# From the Avahi example code
2182
except dbus.exceptions.DBusException as error:
2183
logger.critical("DBusException: %s", error)
2186
# End of Avahi example code
2188
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2189
lambda *args, **kwargs:
2190
(tcp_server.handle_request
2191
(*args[2:], **kwargs) or True))
3641
2193
logger.debug("Starting main loop")
3642
2194
main_loop.run()
3643
2195
except AvahiError as error:
3644
logger.critical("Avahi Error", exc_info=error)
2196
logger.critical("AvahiError: %s", error)
3647
2199
except KeyboardInterrupt: