70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
85
67
import dbus.service
87
from gi.repository import GLib
88
70
from dbus.mainloop.glib import DBusGMainLoop
91
73
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
77
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
123
78
except AttributeError:
125
# This is where SO_BINDTODEVICE was up to and including Python
127
80
from IN import SO_BINDTODEVICE
128
81
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
82
SO_BINDTODEVICE = None
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
89
syslogger = (logging.handlers.SysLogHandler
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
address = str("/dev/log")))
92
syslogger.setFormatter(logging.Formatter
93
('Mandos [%(process)d]: %(levelname)s:'
95
logger.addHandler(syslogger)
97
console = logging.StreamHandler()
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
101
logger.addHandler(console)
332
103
class AvahiError(Exception):
333
104
def __init__(self, value, *args, **kwargs):
334
105
self.value = value
335
return super(AvahiError, self).__init__(value, *args,
106
super(AvahiError, self).__init__(value, *args, **kwargs)
107
def __unicode__(self):
108
return unicode(repr(self.value))
339
110
class AvahiServiceError(AvahiError):
343
113
class AvahiGroupError(AvahiError):
117
class AvahiService(object):
348
118
"""An Avahi (Zeroconf) service.
351
121
interface: integer; avahi.IF_UNSPEC or an interface index.
352
122
Used to optionally bind to the specified interface.
353
123
name: string; Example: 'Mandos'
354
124
type: string; Example: '_mandos._tcp'.
355
See <https://www.iana.org/assignments/service-names-port-numbers>
125
See <http://www.dns-sd.org/ServiceTypes.html>
356
126
port: integer; what port to announce
357
127
TXT: list of strings; TXT record for the service
358
128
domain: string; Domain to publish on, default to .local if empty.
460
210
elif state == avahi.ENTRY_GROUP_FAILURE:
461
211
logger.critical("Avahi: Error in group state changed %s",
463
raise AvahiGroupError("State changed: {!s}".format(error))
213
raise AvahiGroupError("State changed: %s"
465
215
def cleanup(self):
466
216
"""Derived from the Avahi example code"""
467
217
if self.group is not None:
470
except (dbus.exceptions.UnknownMethodException,
471
dbus.exceptions.DBusException):
473
219
self.group = None
476
def server_state_changed(self, state, error=None):
220
def server_state_changed(self, state):
477
221
"""Derived from the Avahi example code"""
478
222
logger.debug("Avahi server state change: %i", state)
480
avahi.SERVER_INVALID: "Zeroconf server invalid",
481
avahi.SERVER_REGISTERING: None,
482
avahi.SERVER_COLLISION: "Zeroconf server name collision",
483
avahi.SERVER_FAILURE: "Zeroconf server failure",
485
if state in bad_states:
486
if bad_states[state] is not None:
488
logger.error(bad_states[state])
490
logger.error(bad_states[state] + ": %r", error)
223
if state == avahi.SERVER_COLLISION:
224
logger.error("Zeroconf server name collision")
492
226
elif state == avahi.SERVER_RUNNING:
495
except dbus.exceptions.DBusException as error:
496
if (error.get_dbus_name()
497
== "org.freedesktop.Avahi.CollisionError"):
498
logger.info("Local Zeroconf service name"
500
return self.rename(remove=False)
502
logger.critical("D-Bus Exception", exc_info=error)
507
logger.debug("Unknown state: %r", state)
509
logger.debug("Unknown state: %r: %r", state, error)
511
228
def activate(self):
512
229
"""Derived from the Avahi example code"""
513
230
if self.server is None:
514
231
self.server = dbus.Interface(
515
232
self.bus.get_object(avahi.DBUS_NAME,
516
avahi.DBUS_PATH_SERVER,
517
follow_name_owner_changes=True),
233
avahi.DBUS_PATH_SERVER),
518
234
avahi.DBUS_INTERFACE_SERVER)
519
235
self.server.connect_to_signal("StateChanged",
520
self.server_state_changed)
236
self.server_state_changed)
521
237
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))
240
class Client(object):
855
241
"""A representation of a client host served by this server.
858
approved: bool(); 'None' if not yet approved/disapproved
244
_approved: bool(); 'None' if not yet approved/disapproved
859
245
approval_delay: datetime.timedelta(); Time to wait for approval
860
246
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
247
checker: subprocess.Popen(); a running checker process used
248
to see if the client lives.
249
'None' if no process is running.
250
checker_callback_tag: a gobject event source tag, or None
865
251
checker_command: string; External command which is run to check
866
252
if client lives. %() expansions are done at
867
253
runtime with vars(self) as dict, so that for
868
254
instance %(name)s can be used in the command.
869
checker_initiator_tag: a GLib event source tag, or None
255
checker_initiator_tag: a gobject event source tag, or None
870
256
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
257
current_checker_command: string; current running checker_command
874
disable_initiator_tag: a GLib event source tag, or None
258
disable_hook: If set, called by disable() as disable_hook(self)
259
disable_initiator_tag: a gobject event source tag, or None
876
261
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
262
uniquely identify the client
880
263
host: string; available for use by the checker command
881
264
interval: datetime.timedelta(); How often to start a new checker
882
265
last_approval_request: datetime.datetime(); (UTC) or None
883
266
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
267
last_enabled: datetime.datetime(); (UTC)
890
268
name: string; from the config file, used in log messages and
891
269
D-Bus identifiers
892
270
secret: bytestring; sent verbatim (over TLS) to client
893
271
timeout: datetime.timedelta(); How long from last_checked_ok
894
272
until this client is disabled
895
extended_timeout: extra long timeout when secret has been sent
896
273
runtime_expansions: Allowed attributes for runtime expansion.
897
expires: datetime.datetime(); time (UTC) when a client will be
899
server_settings: The server_settings dict from main()
902
276
runtime_expansions = ("approval_delay", "approval_duration",
903
"created", "enabled", "expires", "key_id",
904
"fingerprint", "host", "interval",
905
"last_approval_request", "last_checked_ok",
277
"created", "enabled", "fingerprint",
278
"host", "interval", "last_checked_ok",
906
279
"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):
282
def _timedelta_to_milliseconds(td):
283
"Convert a datetime.timedelta() to milliseconds"
284
return ((td.days * 24 * 60 * 60 * 1000)
285
+ (td.seconds * 1000)
286
+ (td.microseconds // 1000))
288
def timeout_milliseconds(self):
289
"Return the 'timeout' attribute in milliseconds"
290
return self._timedelta_to_milliseconds(self.timeout)
292
def interval_milliseconds(self):
293
"Return the 'interval' attribute in milliseconds"
294
return self._timedelta_to_milliseconds(self.interval)
296
def approval_delay_milliseconds(self):
297
return self._timedelta_to_milliseconds(self.approval_delay)
299
def __init__(self, name = None, disable_hook=None, config=None):
300
"""Note: the 'checker' key in 'config' sets the
301
'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
306
logger.debug("Creating client %r", self.name)
993
logger.debug(" Key ID: %s", self.key_id)
307
# Uppercase and remove spaces from fingerprint for later
308
# comparison purposes with return value from the fingerprint()
310
self.fingerprint = (config["fingerprint"].upper()
994
312
logger.debug(" Fingerprint: %s", self.fingerprint)
995
self.created = settings.get("created",
996
datetime.datetime.utcnow())
998
# attributes specific for this server instance
313
if "secret" in config:
314
self.secret = config["secret"].decode("base64")
315
elif "secfile" in config:
316
with open(os.path.expanduser(os.path.expandvars
317
(config["secfile"])),
319
self.secret = secfile.read()
321
raise TypeError("No secret or secfile for client %s"
323
self.host = config.get("host", "")
324
self.created = datetime.datetime.utcnow()
326
self.last_approval_request = None
327
self.last_enabled = None
328
self.last_checked_ok = None
329
self.timeout = string_to_delta(config["timeout"])
330
self.interval = string_to_delta(config["interval"])
331
self.disable_hook = disable_hook
999
332
self.checker = None
1000
333
self.checker_initiator_tag = None
1001
334
self.disable_initiator_tag = None
1002
335
self.checker_callback_tag = None
336
self.checker_command = config["checker"]
1003
337
self.current_checker_command = None
1004
self.approved = None
338
self.last_connect = None
339
self._approved = None
340
self.approved_by_default = config.get("approved_by_default",
1005
342
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
343
self.approval_delay = string_to_delta(
344
config["approval_delay"])
345
self.approval_duration = string_to_delta(
346
config["approval_duration"])
347
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
1019
349
def send_changedstate(self):
1020
with self.changedstate:
1021
self.changedstate.notify_all()
350
self.changedstate.acquire()
351
self.changedstate.notify_all()
352
self.changedstate.release()
1023
354
def enable(self):
1024
355
"""Start this client's checker and timeout hooks"""
1025
356
if getattr(self, "enabled", False):
1026
357
# Already enabled
1028
self.expires = datetime.datetime.utcnow() + self.timeout
359
self.send_changedstate()
1030
360
self.last_enabled = datetime.datetime.utcnow()
1032
self.send_changedstate()
361
# Schedule a new checker to be started an 'interval' from now,
362
# and every interval from then on.
363
self.checker_initiator_tag = (gobject.timeout_add
364
(self.interval_milliseconds(),
366
# Schedule a disable() when 'timeout' has passed
367
self.disable_initiator_tag = (gobject.timeout_add
368
(self.timeout_milliseconds(),
371
# Also start a new checker *right now*.
1034
374
def disable(self, quiet=True):
1035
375
"""Disable this client."""
1036
376
if not getattr(self, "enabled", False):
379
self.send_changedstate()
1039
381
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)
382
if getattr(self, "disable_initiator_tag", False):
383
gobject.source_remove(self.disable_initiator_tag)
1042
384
self.disable_initiator_tag = None
1044
if getattr(self, "checker_initiator_tag", None) is not None:
1045
GLib.source_remove(self.checker_initiator_tag)
385
if getattr(self, "checker_initiator_tag", False):
386
gobject.source_remove(self.checker_initiator_tag)
1046
387
self.checker_initiator_tag = None
1047
388
self.stop_checker()
389
if self.disable_hook:
390
self.disable_hook(self)
1048
391
self.enabled = False
1050
self.send_changedstate()
1051
# Do not run this again if called by a GLib.timeout_add
392
# Do not run this again if called by a gobject.timeout_add
1054
395
def __del__(self):
396
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,
399
def checker_callback(self, pid, condition, command):
1076
400
"""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
401
self.checker_callback_tag = None
1083
402
self.checker = None
1086
self.last_checker_status = returncode
1087
self.last_checker_signal = None
1088
if self.last_checker_status == 0:
403
if os.WIFEXITED(condition):
404
exitstatus = os.WEXITSTATUS(condition)
1089
406
logger.info("Checker for %(name)s succeeded",
1091
408
self.checked_ok()
1093
logger.info("Checker for %(name)s failed", vars(self))
410
logger.info("Checker for %(name)s failed",
1095
self.last_checker_status = -1
1096
self.last_checker_signal = -returncode
1097
413
logger.warning("Checker for %(name)s crashed?",
1101
416
def checked_ok(self):
1102
"""Assert that the client has been seen, alive and well."""
417
"""Bump up the timeout for this client.
419
This should only be called when the client has been seen,
1103
422
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."""
1111
timeout = self.timeout
1112
if self.disable_initiator_tag is not None:
1113
GLib.source_remove(self.disable_initiator_tag)
1114
self.disable_initiator_tag = None
1115
if getattr(self, "enabled", False):
1116
self.disable_initiator_tag = GLib.timeout_add(
1117
int(timeout.total_seconds() * 1000), self.disable)
1118
self.expires = datetime.datetime.utcnow() + timeout
423
gobject.source_remove(self.disable_initiator_tag)
424
self.disable_initiator_tag = (gobject.timeout_add
425
(self.timeout_milliseconds(),
1120
428
def need_approval(self):
1121
429
self.last_approval_request = datetime.datetime.utcnow()
1123
431
def start_checker(self):
1124
432
"""Start a new checker subprocess if one is not running.
1126
434
If a checker already exists, leave it running and do
1128
436
# 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
437
# did that, then if a checker (for some reason) started
438
# running slowly and taking more than 'interval' time, the
439
# client would inevitably timeout, since no checker would get
440
# a chance to run to completion. If we instead leave running
1133
441
# checkers alone, the checker would have to take more time
1134
442
# 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")
445
# If a checker exists, make sure it is not a zombie
447
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
448
except (AttributeError, OSError), error:
449
if (isinstance(error, OSError)
450
and error.errno != errno.ECHILD):
454
logger.warning("Checker was a zombie")
455
gobject.source_remove(self.checker_callback_tag)
456
self.checker_callback(pid, status,
457
self.current_checker_command)
1141
458
# Start a new checker if needed
1142
459
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
461
# In case checker_command has exactly one % operator
462
command = self.checker_command % self.host
464
# Escape attributes for the shell
465
escaped_attrs = dict(
467
re.escape(unicode(str(getattr(self, attr, "")),
471
self.runtime_expansions)
474
command = self.checker_command % escaped_attrs
475
except TypeError, error:
476
logger.error('Could not format string "%s":'
477
' %s', self.checker_command, error)
478
return True # Try again later
1154
479
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
481
logger.info("Starting checker %r for %s",
483
# We don't need to redirect stdout and stderr, since
484
# in normal mode, that is already done by daemon(),
485
# and in debug mode we don't want to. (Stdin is
486
# always replaced by /dev/null.)
487
self.checker = subprocess.Popen(command,
490
self.checker_callback_tag = (gobject.child_watch_add
492
self.checker_callback,
494
# The checker may have completed before the gobject
495
# watch was added. Check for this.
496
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
498
gobject.source_remove(self.checker_callback_tag)
499
self.checker_callback(pid, status, command)
500
except OSError, error:
501
logger.error("Failed to start subprocess: %s",
503
# Re-run this periodically if run by gobject.timeout_add
1184
506
def stop_checker(self):
1185
507
"""Force the checker process, if any, to stop."""
1186
508
if self.checker_callback_tag:
1187
GLib.source_remove(self.checker_callback_tag)
509
gobject.source_remove(self.checker_callback_tag)
1188
510
self.checker_callback_tag = None
1189
511
if getattr(self, "checker", None) is None:
1191
513
logger.debug("Stopping checker for %(name)s", vars(self))
1192
self.checker.terminate()
515
os.kill(self.checker.pid, signal.SIGTERM)
517
#if self.checker.poll() is None:
518
# os.kill(self.checker.pid, signal.SIGKILL)
519
except OSError, error:
520
if error.errno != errno.ESRCH: # No such process
1193
522
self.checker = None
1196
def dbus_service_property(dbus_interface,
524
def dbus_service_property(dbus_interface, signature="v",
525
access="readwrite", byte_arrays=False):
1200
526
"""Decorators for marking methods of a DBusObjectWithProperties to
1201
527
become properties on the D-Bus.
1203
529
The decorated method will be called with no arguments by "Get"
1204
530
and with one argument by "Set".
1206
532
The parameters, where they are supported, are the same as
1207
533
dbus.service.method, except there is only "signature", since the
1208
534
type from Get() and the type sent to Set() is the same.
1538
704
xmlstring = document.toxml("utf-8")
1539
705
document.unlink()
1540
706
except (AttributeError, xml.dom.DOMException,
1541
xml.parsers.expat.ExpatError) as error:
1542
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):
1619
"""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).
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):
1656
# Ignore non-D-Bus attributes, and D-Bus attributes
1657
# with the wrong interface name
1658
if (not hasattr(attribute, "_dbus_interface")
1659
or not attribute._dbus_interface.startswith(
1660
orig_interface_name)):
1662
# Create an alternate D-Bus interface name based on
1664
alt_interface = attribute._dbus_interface.replace(
1665
orig_interface_name, alt_interface_name)
1666
interface_names.add(alt_interface)
1667
# Is this a D-Bus signal?
1668
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(
1673
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)
1681
# Create a new, but exactly alike, function
1682
# object, and decorate it to be a new D-Bus signal
1683
# 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:
1695
# 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
1699
def fixscope(func1, func2):
1700
"""This function is a scope container to pass
1701
func1 and func2 to the "call_both" function
1702
outside of its arguments"""
1704
@functools.wraps(func2)
1705
def call_both(*args, **kwargs):
1706
"""This function will emit two D-Bus
1707
signals by calling func1 and func2"""
1708
func1(*args, **kwargs)
1709
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)
1717
# Create the "call_both" function and add it to
1719
attr[attrname] = fixscope(attribute, new_function)
1720
# Is this a D-Bus method?
1721
elif getattr(attribute, "_dbus_is_method", False):
1722
# Create a new, but exactly alike, function
1723
# object. Decorate it to be a new D-Bus method
1724
# 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:
1738
# Is this a D-Bus property?
1739
elif getattr(attribute, "_dbus_is_property", False):
1740
# Create a new, but exactly alike, function
1741
# object, and decorate it to be a new D-Bus
1742
# property with the alternate D-Bus interface
1743
# 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"})
707
xml.parsers.expat.ExpatError), error:
708
logger.error("Failed to override Introspection method",
1796
713
class ClientDBus(Client, DBusObjectWithProperties):
1797
714
"""A Client class using D-Bus
1800
717
dbus_object_path: dbus.ObjectPath
1801
718
bus: dbus.SystemBus()
1804
721
runtime_expansions = (Client.runtime_expansions
1805
+ ("dbus_object_path", ))
1807
_interface = "se.recompile.Mandos.Client"
722
+ ("dbus_object_path",))
1809
724
# dbus.service.Object doesn't use super(), so we can't either.
1811
def __init__(self, bus=None, *args, **kwargs):
726
def __init__(self, bus = None, *args, **kwargs):
727
self._approvals_pending = 0
1813
729
Client.__init__(self, *args, **kwargs)
1814
730
# Only now, when this client is initialized, can it show up on
1816
client_object_name = str(self.name).translate(
732
client_object_name = unicode(self.name).translate(
1817
733
{ord("."): ord("_"),
1818
734
ord("-"): ord("_")})
1819
self.dbus_object_path = dbus.ObjectPath(
1820
"/clients/" + client_object_name)
735
self.dbus_object_path = (dbus.ObjectPath
736
("/clients/" + client_object_name))
1821
737
DBusObjectWithProperties.__init__(self, self.bus,
1822
738
self.dbus_object_path)
1824
def notifychangeproperty(transform_func, dbus_name,
1825
type_func=lambda x: x,
1827
invalidate_only=False,
1828
_interface=_interface):
1829
""" Modify a variable so that it's a property which announces
1830
its changes to DBus.
1832
transform_fun: Function that takes a value and a variant_level
1833
and transforms it to a D-Bus type.
1834
dbus_name: D-Bus name of the variable
1835
type_func: Function that transform the value before sending it
1836
to the D-Bus. Default: no transform
1837
variant_level: D-Bus variant level. Default: 1
1839
attrname = "_{}".format(dbus_name)
1841
def setter(self, value):
1842
if hasattr(self, "dbus_object_path"):
1843
if (not hasattr(self, attrname) or
1844
type_func(getattr(self, attrname, None))
1845
!= type_func(value)):
1847
self.PropertiesChanged(
1848
_interface, dbus.Dictionary(),
1849
dbus.Array((dbus_name, )))
1851
dbus_value = transform_func(
1853
variant_level=variant_level)
1854
self.PropertyChanged(dbus.String(dbus_name),
1856
self.PropertiesChanged(
1858
dbus.Dictionary({dbus.String(dbus_name):
1861
setattr(self, attrname, value)
1863
return property(lambda self: getattr(self, attrname), setter)
1865
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1866
approvals_pending = notifychangeproperty(dbus.Boolean,
1869
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1870
last_enabled = notifychangeproperty(datetime_to_dbus,
1872
checker = notifychangeproperty(
1873
dbus.Boolean, "CheckerRunning",
1874
type_func=lambda checker: checker is not None)
1875
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1877
last_checker_status = notifychangeproperty(dbus.Int16,
1878
"LastCheckerStatus")
1879
last_approval_request = notifychangeproperty(
1880
datetime_to_dbus, "LastApprovalRequest")
1881
approved_by_default = notifychangeproperty(dbus.Boolean,
1882
"ApprovedByDefault")
1883
approval_delay = notifychangeproperty(
1884
dbus.UInt64, "ApprovalDelay",
1885
type_func=lambda td: td.total_seconds() * 1000)
1886
approval_duration = notifychangeproperty(
1887
dbus.UInt64, "ApprovalDuration",
1888
type_func=lambda td: td.total_seconds() * 1000)
1889
host = notifychangeproperty(dbus.String, "Host")
1890
timeout = notifychangeproperty(
1891
dbus.UInt64, "Timeout",
1892
type_func=lambda td: td.total_seconds() * 1000)
1893
extended_timeout = notifychangeproperty(
1894
dbus.UInt64, "ExtendedTimeout",
1895
type_func=lambda td: td.total_seconds() * 1000)
1896
interval = notifychangeproperty(
1897
dbus.UInt64, "Interval",
1898
type_func=lambda td: td.total_seconds() * 1000)
1899
checker_command = notifychangeproperty(dbus.String, "Checker")
1900
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1901
invalidate_only=True)
1903
del notifychangeproperty
740
def _get_approvals_pending(self):
741
return self._approvals_pending
742
def _set_approvals_pending(self, value):
743
old_value = self._approvals_pending
744
self._approvals_pending = value
746
if (hasattr(self, "dbus_object_path")
747
and bval is not bool(old_value)):
748
dbus_bool = dbus.Boolean(bval, variant_level=1)
749
self.PropertyChanged(dbus.String("ApprovalPending"),
752
approvals_pending = property(_get_approvals_pending,
753
_set_approvals_pending)
754
del _get_approvals_pending, _set_approvals_pending
757
def _datetime_to_dbus(dt, variant_level=0):
758
"""Convert a UTC datetime.datetime() to a D-Bus type."""
759
return dbus.String(dt.isoformat(),
760
variant_level=variant_level)
763
oldstate = getattr(self, "enabled", False)
764
r = Client.enable(self)
765
if oldstate != self.enabled:
767
self.PropertyChanged(dbus.String("Enabled"),
768
dbus.Boolean(True, variant_level=1))
769
self.PropertyChanged(
770
dbus.String("LastEnabled"),
771
self._datetime_to_dbus(self.last_enabled,
775
def disable(self, quiet = False):
776
oldstate = getattr(self, "enabled", False)
777
r = Client.disable(self, quiet=quiet)
778
if not quiet and oldstate != self.enabled:
780
self.PropertyChanged(dbus.String("Enabled"),
781
dbus.Boolean(False, variant_level=1))
1905
784
def __del__(self, *args, **kwargs):
1907
786
self.remove_from_connection()
2406
1289
delay -= time2 - time
2409
session.send(client.secret)
2410
except gnutls.Error as error:
2411
logger.warning("gnutls send failed",
1292
while sent_size < len(client.secret):
1294
sent = session.send(client.secret[sent_size:])
1295
except (gnutls.errors.GNUTLSError), error:
1296
logger.warning("gnutls send failed")
1298
logger.debug("Sent: %d, remaining: %d",
1299
sent, len(client.secret)
1300
- (sent_size + sent))
2415
1303
logger.info("Sending secret to %s", client.name)
2416
# bump the timeout using extended_timeout
2417
client.bump_timeout(client.extended_timeout)
1304
# bump the timeout as if seen
2418
1306
if self.server.use_dbus:
2419
1307
# Emit D-Bus signal
2420
1308
client.GotSecret()
2423
1311
if approval_required:
2424
1312
client.approvals_pending -= 1
2427
except gnutls.Error as error:
2428
logger.warning("GnuTLS bye failed",
1315
except (gnutls.errors.GNUTLSError), error:
1316
logger.warning("GnuTLS bye failed")
2432
1319
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
1320
"Return the peer's OpenPGP certificate as a bytestring"
1321
# If not an OpenPGP certificate...
1322
if (gnutls.library.functions
1323
.gnutls_certificate_type_get(session._c_object)
1324
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1325
# ...do the normal thing
1326
return session.peer_certificate
2449
1327
list_size = ctypes.c_uint(1)
2450
cert_list = (gnutls.certificate_get_peers
1328
cert_list = (gnutls.library.functions
1329
.gnutls_certificate_get_peers
2451
1330
(session._c_object, ctypes.byref(list_size)))
2452
1331
if not bool(cert_list) and list_size.value != 0:
2453
raise gnutls.Error("error getting peer certificate")
1332
raise gnutls.errors.GNUTLSError("error getting peer"
2454
1334
if list_size.value == 0:
2456
1336
cert = cert_list[0]
2457
1337
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
1340
def fingerprint(openpgp):
2496
1341
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2497
1342
# 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)))
1343
datum = (gnutls.library.types
1344
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1347
ctypes.c_uint(len(openpgp))))
2502
1348
# New empty GnuTLS certificate
2503
crt = gnutls.openpgp_crt_t()
2504
gnutls.openpgp_crt_init(ctypes.byref(crt))
1349
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1350
(gnutls.library.functions
1351
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2505
1352
# Import the OpenPGP public key into the certificate
2506
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2507
gnutls.OPENPGP_FMT_RAW)
1353
(gnutls.library.functions
1354
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1355
gnutls.library.constants
1356
.GNUTLS_OPENPGP_FMT_RAW))
2508
1357
# Verify the self signature in the key
2509
1358
crtverify = ctypes.c_uint()
2510
gnutls.openpgp_crt_verify_self(crt, 0,
2511
ctypes.byref(crtverify))
1359
(gnutls.library.functions
1360
.gnutls_openpgp_crt_verify_self(crt, 0,
1361
ctypes.byref(crtverify)))
2512
1362
if crtverify.value != 0:
2513
gnutls.openpgp_crt_deinit(crt)
2514
raise gnutls.CertificateSecurityError(code
1363
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1364
raise (gnutls.errors.CertificateSecurityError
2516
1366
# New buffer for the fingerprint
2517
1367
buf = ctypes.create_string_buffer(20)
2518
1368
buf_len = ctypes.c_size_t()
2519
1369
# Get the fingerprint from the certificate into the buffer
2520
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2521
ctypes.byref(buf_len))
1370
(gnutls.library.functions
1371
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1372
ctypes.byref(buf_len)))
2522
1373
# Deinit the certificate
2523
gnutls.openpgp_crt_deinit(crt)
1374
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2524
1375
# Convert the buffer to a Python bytestring
2525
1376
fpr = ctypes.string_at(buf, buf_len.value)
2526
1377
# Convert the bytestring to hexadecimal notation
2527
hex_fpr = binascii.hexlify(fpr).upper()
1378
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
2531
class MultiprocessingMixIn:
1382
class MultiprocessingMixIn(object):
2532
1383
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2534
1384
def sub_process_main(self, request, address):
2536
1386
self.finish_request(request, address)
2538
1388
self.handle_error(request, address)
2539
1389
self.close_request(request)
2541
1391
def process_request(self, request, address):
2542
1392
"""Start a new process to process the request."""
2543
proc = multiprocessing.Process(target=self.sub_process_main,
2544
args=(request, address))
2549
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1393
multiprocessing.Process(target = self.sub_process_main,
1394
args = (request, address)).start()
1396
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2550
1397
""" adds a pipe to the MixIn """
2552
1398
def process_request(self, request, client_address):
2553
1399
"""Overrides and wraps the original process_request().
2555
1401
This function creates a new pipe in self.pipe
2557
1403
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2559
proc = MultiprocessingMixIn.process_request(self, request,
1405
super(MultiprocessingMixInWithPipe,
1406
self).process_request(request, client_address)
2561
1407
self.child_pipe.close()
2562
self.add_pipe(parent_pipe, proc)
1408
self.add_pipe(parent_pipe)
2564
def add_pipe(self, parent_pipe, proc):
1410
def add_pipe(self, parent_pipe):
2565
1411
"""Dummy function; override as necessary"""
2566
raise NotImplementedError()
1412
raise NotImplementedError
2569
1414
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2570
socketserver.TCPServer):
1415
socketserver.TCPServer, object):
2571
1416
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2574
1419
enabled: Boolean; whether this server is activated yet
2575
1420
interface: None or a network interface name (string)
2576
1421
use_ipv6: Boolean; to use IPv6 or not
2579
1423
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().
1424
interface=None, use_ipv6=True):
2586
1425
self.interface = interface
2588
1427
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
1428
socketserver.TCPServer.__init__(self, server_address,
2617
1429
RequestHandlerClass)
2619
1430
def server_bind(self):
2620
1431
"""This overrides the normal server_bind() function
2621
1432
to bind to an interface if one was specified, and also NOT to
2622
1433
bind to an address or port if they were not specified."""
2623
global SO_BINDTODEVICE
2624
1434
if self.interface is not None:
2625
1435
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)
1436
logger.error("SO_BINDTODEVICE does not exist;"
1437
" cannot bind to interface %s",
1441
self.socket.setsockopt(socket.SOL_SOCKET,
1445
except socket.error, error:
1446
if error[0] == errno.EPERM:
1447
logger.error("No permission to"
1448
" bind to interface %s",
1450
elif error[0] == errno.ENOPROTOOPT:
1451
logger.error("SO_BINDTODEVICE not available;"
1452
" cannot bind to interface %s",
2647
1456
# Only bind(2) the socket if we really need to.
2648
1457
if self.server_address[0] or self.server_address[1]:
2649
if self.server_address[1]:
2650
self.allow_reuse_address = True
2651
1458
if not self.server_address[0]:
2652
1459
if self.address_family == socket.AF_INET6:
2653
any_address = "::" # in6addr_any
1460
any_address = "::" # in6addr_any
2655
any_address = "0.0.0.0" # INADDR_ANY
1462
any_address = socket.INADDR_ANY
2656
1463
self.server_address = (any_address,
2657
1464
self.server_address[1])
2658
1465
elif not self.server_address[1]:
2659
self.server_address = (self.server_address[0], 0)
1466
self.server_address = (self.server_address[0],
2660
1468
# if self.interface:
2661
1469
# self.server_address = (self.server_address[0],
2964
1673
##################################################################
2965
1674
# Parsing of options, both command line and config file
2967
parser = argparse.ArgumentParser()
2968
parser.add_argument("-v", "--version", action="version",
2969
version="%(prog)s {}".format(version),
2970
help="show version number and exit")
2971
parser.add_argument("-i", "--interface", metavar="IF",
2972
help="Bind to interface IF")
2973
parser.add_argument("-a", "--address",
2974
help="Address to listen for requests on")
2975
parser.add_argument("-p", "--port", type=int,
2976
help="Port number to receive requests on")
2977
parser.add_argument("--check", action="store_true",
2978
help="Run self-test")
2979
parser.add_argument("--debug", action="store_true",
2980
help="Debug mode; run in foreground and log"
2981
" to terminal", default=None)
2982
parser.add_argument("--debuglevel", metavar="LEVEL",
2983
help="Debug level for stdout output")
2984
parser.add_argument("--priority", help="GnuTLS"
2985
" priority string (see GnuTLS documentation)")
2986
parser.add_argument("--servicename",
2987
metavar="NAME", help="Zeroconf service name")
2988
parser.add_argument("--configdir",
2989
default="/etc/mandos", metavar="DIR",
2990
help="Directory to search for configuration"
2992
parser.add_argument("--no-dbus", action="store_false",
2993
dest="use_dbus", help="Do not provide D-Bus"
2994
" system bus interface", default=None)
2995
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",
3012
options = parser.parse_args()
1676
parser = optparse.OptionParser(version = "%%prog %s" % version)
1677
parser.add_option("-i", "--interface", type="string",
1678
metavar="IF", help="Bind to interface IF")
1679
parser.add_option("-a", "--address", type="string",
1680
help="Address to listen for requests on")
1681
parser.add_option("-p", "--port", type="int",
1682
help="Port number to receive requests on")
1683
parser.add_option("--check", action="store_true",
1684
help="Run self-test")
1685
parser.add_option("--debug", action="store_true",
1686
help="Debug mode; run in foreground and log to"
1688
parser.add_option("--debuglevel", type="string", metavar="LEVEL",
1689
help="Debug level for stdout output")
1690
parser.add_option("--priority", type="string", help="GnuTLS"
1691
" priority string (see GnuTLS documentation)")
1692
parser.add_option("--servicename", type="string",
1693
metavar="NAME", help="Zeroconf service name")
1694
parser.add_option("--configdir", type="string",
1695
default="/etc/mandos", metavar="DIR",
1696
help="Directory to search for configuration"
1698
parser.add_option("--no-dbus", action="store_false",
1699
dest="use_dbus", help="Do not provide D-Bus"
1700
" system bus interface")
1701
parser.add_option("--no-ipv6", action="store_false",
1702
dest="use_ipv6", help="Do not use IPv6")
1703
options = parser.parse_args()[0]
3014
1710
# 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",
1711
server_defaults = { "interface": "",
1716
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1717
"servicename": "Mandos",
3038
1723
# Parse config file for server-global settings
3039
server_config = configparser.ConfigParser(server_defaults)
1724
server_config = configparser.SafeConfigParser(server_defaults)
3040
1725
del server_defaults
3041
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3042
# Convert the ConfigParser object to a dict
1726
server_config.read(os.path.join(options.configdir,
1728
# Convert the SafeConfigParser object to a dict
3043
1729
server_settings = server_config.defaults()
3044
1730
# Use the appropriate methods on the non-string config options
3045
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3046
"foreground", "zeroconf"):
1731
for option in ("debug", "use_dbus", "use_ipv6"):
3047
1732
server_settings[option] = server_config.getboolean("DEFAULT",
3049
1734
if server_settings["port"]:
3050
1735
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
1737
del server_config
3063
1739
# Override the settings from the config file with command line
3064
1740
# options, if set.
3065
1741
for option in ("interface", "address", "port", "debug",
3066
"priority", "servicename", "configdir", "use_dbus",
3067
"use_ipv6", "debuglevel", "restore", "statedir",
3068
"socket", "foreground", "zeroconf"):
1742
"priority", "servicename", "configdir",
1743
"use_dbus", "use_ipv6", "debuglevel"):
3069
1744
value = getattr(options, option)
3070
1745
if value is not None:
3071
1746
server_settings[option] = value
3073
1748
# Force all strings to be unicode
3074
1749
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
1750
if type(server_settings[option]) is str:
1751
server_settings[option] = unicode(server_settings[option])
3085
1752
# Now we have our good server settings in "server_settings"
3087
1754
##################################################################
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
1756
# For convenience
3095
1757
debug = server_settings["debug"]
3096
1758
debuglevel = server_settings["debuglevel"]
3097
1759
use_dbus = server_settings["use_dbus"]
3098
1760
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
1762
if server_settings["servicename"] != "Mandos":
3114
syslogger.setFormatter(
3115
logging.Formatter('Mandos ({}) [%(process)d]:'
3116
' %(levelname)s: %(message)s'.format(
3117
server_settings["servicename"])))
1763
syslogger.setFormatter(logging.Formatter
1764
('Mandos (%s) [%%(process)d]:'
1765
' %%(levelname)s: %%(message)s'
1766
% server_settings["servicename"]))
3119
1768
# Parse config file with clients
3120
client_config = configparser.ConfigParser(Client.client_defaults)
1769
client_defaults = { "timeout": "1h",
1771
"checker": "fping -q -- %%(host)s",
1773
"approval_delay": "0s",
1774
"approval_duration": "1s",
1776
client_config = configparser.SafeConfigParser(client_defaults)
3121
1777
client_config.read(os.path.join(server_settings["configdir"],
3122
1778
"clients.conf"))
3124
1780
global mandos_dbus_service
3125
1781
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
1783
tcp_server = MandosServer((server_settings["address"],
1784
server_settings["port"]),
1786
interface=(server_settings["interface"]
1790
server_settings["priority"],
1793
pidfilename = "/var/run/mandos.pid"
1795
pidfile = open(pidfilename, "w")
1797
logger.error("Could not open file %r", pidfilename)
1800
uid = pwd.getpwnam("_mandos").pw_uid
1801
gid = pwd.getpwnam("_mandos").pw_gid
1804
uid = pwd.getpwnam("mandos").pw_uid
1805
gid = pwd.getpwnam("mandos").pw_gid
3156
1806
except KeyError:
1808
uid = pwd.getpwnam("nobody").pw_uid
1809
gid = pwd.getpwnam("nobody").pw_gid
3165
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3167
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:
1816
except OSError, error:
1817
if error[0] != errno.EPERM:
1820
if not debug and not debuglevel:
1821
syslogger.setLevel(logging.WARNING)
1822
console.setLevel(logging.WARNING)
1824
level = getattr(logging, debuglevel.upper())
1825
syslogger.setLevel(level)
1826
console.setLevel(level)
3174
1829
# Enable all possible GnuTLS debugging
3176
1831
# "Use a log level over 10 to enable all debugging options."
3177
1832
# - GnuTLS manual
3178
gnutls.global_set_log_level(11)
1833
gnutls.library.functions.gnutls_global_set_log_level(11)
1835
@gnutls.library.types.gnutls_log_func
3181
1836
def debug_gnutls(level, string):
3182
1837
logger.debug("GnuTLS: %s", string[:-1])
3184
gnutls.global_set_log_function(debug_gnutls)
1839
(gnutls.library.functions
1840
.gnutls_global_set_log_function(debug_gnutls))
3186
1842
# Redirect stdin so all checkers get /dev/null
3187
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1843
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3188
1844
os.dup2(null, sys.stdin.fileno())
1848
# No console logging
1849
logger.removeHandler(console)
3192
1851
# Need to fork before connecting to D-Bus
3194
1853
# 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
1856
global main_loop
3203
1857
# From the Avahi example code
3204
DBusGMainLoop(set_as_default=True)
3205
main_loop = GLib.MainLoop()
1858
DBusGMainLoop(set_as_default=True )
1859
main_loop = gobject.MainLoop()
3206
1860
bus = dbus.SystemBus()
3207
1861
# End of Avahi example code
3210
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)
1864
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1865
bus, do_not_queue=True)
1866
except dbus.exceptions.NameExistsException, e:
1867
logger.error(unicode(e) + ", disabling D-Bus")
3218
1868
use_dbus = False
3219
1869
server_settings["use_dbus"] = False
3220
1870
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"))
1871
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1872
service = AvahiService(name = server_settings["servicename"],
1873
servicetype = "_mandos._tcp",
1874
protocol = protocol, bus = bus)
1875
if server_settings["interface"]:
1876
service.interface = (if_nametoindex
1877
(str(server_settings["interface"])))
3232
1879
global multiprocessing_manager
3233
1880
multiprocessing_manager = multiprocessing.Manager()
3235
1882
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(
1884
client_class = functools.partial(ClientDBus, bus = bus)
1885
def client_config_items(config, section):
1886
special_settings = {
1887
"approved_by_default":
1888
lambda: config.getboolean(section,
1889
"approved_by_default"),
1891
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)
1893
yield (name, special_settings[name]())
1897
tcp_server.clients.update(set(
1898
client_class(name = section,
1899
config= dict(client_config_items(
1900
client_config, section)))
1901
for section in client_config.sections()))
3396
1902
if not tcp_server.clients:
3397
1903
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",
1909
pidfile.write(str(pid) + "\n".encode("utf-8"))
1912
logger.error("Could not write to file %r with PID %d",
1915
# "pidfile" was never created
3409
1917
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)
1919
signal.signal(signal.SIGINT, signal.SIG_IGN)
1921
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1922
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):
1925
class MandosDBusService(dbus.service.Object):
3420
1926
"""A D-Bus proxy object"""
3422
1927
def __init__(self):
3423
1928
dbus.service.Object.__init__(self, bus, "/")
3425
_interface = "se.recompile.Mandos"
1929
_interface = "se.bsnet.fukt.Mandos"
3427
1931
@dbus.service.signal(_interface, signature="o")
3428
1932
def ClientAdded(self, objpath):
3432
1936
@dbus.service.signal(_interface, signature="ss")
3433
def ClientNotFound(self, key_id, address):
1937
def ClientNotFound(self, fingerprint, address):
3437
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3439
1941
@dbus.service.signal(_interface, signature="os")
3440
1942
def ClientRemoved(self, objpath, name):
3444
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3446
1946
@dbus.service.method(_interface, out_signature="ao")
3447
1947
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":
1949
return dbus.Array(c.dbus_object_path
1950
for c in tcp_server.clients)
3454
1952
@dbus.service.method(_interface,
3455
1953
out_signature="a{oa{sv}}")
3456
1954
def GetAllClientsWithProperties(self):
3458
1956
return dbus.Dictionary(
3459
{c.dbus_object_path: c.GetAll(
3460
"se.recompile.Mandos.Client")
3461
for c in tcp_server.clients.values()},
1957
((c.dbus_object_path, c.GetAll(""))
1958
for c in tcp_server.clients),
3462
1959
signature="oa{sv}")
3464
1961
@dbus.service.method(_interface, in_signature="o")
3465
1962
def RemoveClient(self, object_path):
3467
for c in tcp_server.clients.values():
1964
for c in tcp_server.clients:
3468
1965
if c.dbus_object_path == object_path:
3469
del tcp_server.clients[c.name]
1966
tcp_server.clients.remove(c)
3470
1967
c.remove_from_connection()
3471
# Don't signal the disabling
1968
# Don't signal anything except ClientRemoved
3472
1969
c.disable(quiet=True)
3473
# Emit D-Bus signal for removal
3474
self.client_removed_signal(c)
1971
self.ClientRemoved(object_path, c.name)
3476
1973
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
1977
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
3524
1980
"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
3587
1983
while tcp_server.clients:
3588
name, client = tcp_server.clients.popitem()
1984
client = tcp_server.clients.pop()
3590
1986
client.remove_from_connection()
3591
# Don't signal the disabling
1987
client.disable_hook = None
1988
# Don't signal anything except ClientRemoved
3592
1989
client.disable(quiet=True)
3593
# Emit D-Bus signal for removal
3595
mandos_dbus_service.client_removed_signal(client)
3596
client_settings.clear()
1992
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3598
1995
atexit.register(cleanup)
3600
for client in tcp_server.clients.values():
1997
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()
2000
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3608
2003
tcp_server.enable()
3609
2004
tcp_server.server_activate()
3611
2006
# Find out what port we got
3613
service.port = tcp_server.socket.getsockname()[1]
2007
service.port = tcp_server.socket.getsockname()[1]
3615
2009
logger.info("Now listening on address %r, port %d,"
3616
" flowinfo %d, scope_id %d",
3617
*tcp_server.socket.getsockname())
2010
" flowinfo %d, scope_id %d"
2011
% 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]
2013
logger.info("Now listening on address %r, port %d"
2014
% tcp_server.socket.getsockname())
2016
#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))
2019
# From the Avahi example code
2022
except dbus.exceptions.DBusException, error:
2023
logger.critical("DBusException: %s", error)
2026
# End of Avahi example code
2028
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2029
lambda *args, **kwargs:
2030
(tcp_server.handle_request
2031
(*args[2:], **kwargs) or True))
3641
2033
logger.debug("Starting main loop")
3642
2034
main_loop.run()
3643
except AvahiError as error:
3644
logger.critical("Avahi Error", exc_info=error)
2035
except AvahiError, error:
2036
logger.critical("AvahiError: %s", error)
3647
2039
except KeyboardInterrupt: