70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
82
70
import dbus.service
83
from gi.repository import GLib
84
73
from dbus.mainloop.glib import DBusGMainLoop
87
76
import xml.dom.minidom
90
# Try to find the value of SO_BINDTODEVICE:
92
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
93
# newer, and it is also the most natural place for it:
94
81
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
95
82
except AttributeError:
97
# This is where SO_BINDTODEVICE was up to and including Python
99
84
from IN import SO_BINDTODEVICE
100
85
except ImportError:
101
# In Python 2.7 it seems to have been removed entirely.
102
# Try running the C preprocessor:
104
cc = subprocess.Popen(["cc", "--language=c", "-E",
106
stdin=subprocess.PIPE,
107
stdout=subprocess.PIPE)
108
stdout = cc.communicate(
109
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
110
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
111
except (OSError, ValueError, IndexError):
113
SO_BINDTODEVICE = None
115
if sys.version_info.major == 2:
119
stored_state_file = "clients.pickle"
86
SO_BINDTODEVICE = None
90
stored_state_path = "/var/lib/mandos/clients.pickle"
121
92
logger = logging.getLogger()
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
125
if_nametoindex = ctypes.cdll.LoadLibrary(
126
ctypes.util.find_library("c")).if_nametoindex
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
127
101
except (OSError, AttributeError):
129
102
def if_nametoindex(interface):
130
103
"Get an interface index the hard way, i.e. using fcntl()"
131
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
132
105
with contextlib.closing(socket.socket()) as s:
133
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
134
struct.pack(b"16s16x", interface))
135
interface_index = struct.unpack("I", ifreq[16:20])[0]
107
struct.pack(str("16s16x"),
109
interface_index = struct.unpack(str("I"),
136
111
return interface_index
139
def copy_function(func):
140
"""Make a copy of a function"""
141
if sys.version_info.major == 2:
142
return types.FunctionType(func.func_code,
148
return types.FunctionType(func.__code__,
155
def initlogger(debug, level=logging.WARNING):
114
def initlogger(level=logging.WARNING):
156
115
"""init logger and add loglevel"""
159
syslogger = (logging.handlers.SysLogHandler(
160
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
162
117
syslogger.setFormatter(logging.Formatter
163
118
('Mandos [%(process)d]: %(levelname)s:'
165
120
logger.addHandler(syslogger)
168
console = logging.StreamHandler()
169
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
173
logger.addHandler(console)
122
console = logging.StreamHandler()
123
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
127
logger.addHandler(console)
174
128
logger.setLevel(level)
177
class PGPError(Exception):
178
"""Exception if encryption/decryption fails"""
131
class CryptoError(Exception):
182
class PGPEngine(object):
135
class Crypto(object):
183
136
"""A simple class for OpenPGP symmetric encryption & decryption"""
185
137
def __init__(self):
138
self.gnupg = GnuPGInterface.GnuPG()
186
139
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
189
output = subprocess.check_output(["gpgconf"])
190
for line in output.splitlines():
191
name, text, path = line.split(b":")
196
if e.errno != errno.ENOENT:
198
self.gnupgargs = ['--batch',
199
'--homedir', self.tempdir,
202
# Only GPG version 1 has the --no-use-agent option.
203
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
204
self.gnupgargs.append("--no-use-agent")
140
self.gnupg = GnuPGInterface.GnuPG()
141
self.gnupg.options.meta_interactive = False
142
self.gnupg.options.homedir = self.tempdir
143
self.gnupg.options.extra_args.extend(['--force-mdc',
206
146
def __enter__(self):
209
def __exit__(self, exc_type, exc_value, traceback):
149
def __exit__ (self, exc_type, exc_value, traceback):
213
153
def __del__(self):
216
156
def _cleanup(self):
217
157
if self.tempdir is not None:
218
158
# Delete contents of tempdir
219
159
for root, dirs, files in os.walk(self.tempdir,
221
161
for filename in files:
222
162
os.remove(os.path.join(root, filename))
223
163
for dirname in dirs:
226
166
os.rmdir(self.tempdir)
227
167
self.tempdir = None
229
169
def password_encode(self, password):
230
170
# Passphrase can not be empty and can not contain newlines or
231
171
# NUL bytes. So we prefix it and hex encode it.
232
encoded = b"mandos" + binascii.hexlify(password)
233
if len(encoded) > 2048:
234
# GnuPG can't handle long passwords, so encode differently
235
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
236
.replace(b"\n", b"\\n")
237
.replace(b"\0", b"\\x00"))
172
return b"mandos" + binascii.hexlify(password)
240
174
def encrypt(self, data, password):
241
passphrase = self.password_encode(password)
242
with tempfile.NamedTemporaryFile(
243
dir=self.tempdir) as passfile:
244
passfile.write(passphrase)
246
proc = subprocess.Popen([self.gpg, '--symmetric',
250
stdin=subprocess.PIPE,
251
stdout=subprocess.PIPE,
252
stderr=subprocess.PIPE)
253
ciphertext, err = proc.communicate(input=data)
254
if proc.returncode != 0:
175
self.gnupg.passphrase = self.password_encode(password)
176
with open(os.devnull) as devnull:
178
proc = self.gnupg.run(['--symmetric'],
179
create_fhs=['stdin', 'stdout'],
180
attach_fhs={'stderr': devnull})
181
with contextlib.closing(proc.handles['stdin']) as f:
183
with contextlib.closing(proc.handles['stdout']) as f:
184
ciphertext = f.read()
188
self.gnupg.passphrase = None
256
189
return ciphertext
258
191
def decrypt(self, data, password):
259
passphrase = self.password_encode(password)
260
with tempfile.NamedTemporaryFile(
261
dir=self.tempdir) as passfile:
262
passfile.write(passphrase)
264
proc = subprocess.Popen([self.gpg, '--decrypt',
268
stdin=subprocess.PIPE,
269
stdout=subprocess.PIPE,
270
stderr=subprocess.PIPE)
271
decrypted_plaintext, err = proc.communicate(input=data)
272
if proc.returncode != 0:
192
self.gnupg.passphrase = self.password_encode(password)
193
with open(os.devnull) as devnull:
195
proc = self.gnupg.run(['--decrypt'],
196
create_fhs=['stdin', 'stdout'],
197
attach_fhs={'stderr': devnull})
198
with contextlib.closing(proc.handles['stdin'] ) as f:
200
with contextlib.closing(proc.handles['stdout']) as f:
201
decrypted_plaintext = f.read()
205
self.gnupg.passphrase = None
274
206
return decrypted_plaintext
277
# Pretend that we have an Avahi module
279
"""This isn't so much a class as it is a module-like namespace.
280
It is instantiated once, and simulates having an Avahi module."""
281
IF_UNSPEC = -1 # avahi-common/address.h
282
PROTO_UNSPEC = -1 # avahi-common/address.h
283
PROTO_INET = 0 # avahi-common/address.h
284
PROTO_INET6 = 1 # avahi-common/address.h
285
DBUS_NAME = "org.freedesktop.Avahi"
286
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
287
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
288
DBUS_PATH_SERVER = "/"
290
def string_array_to_txt_array(self, t):
291
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
292
for s in t), signature="ay")
293
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
294
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
295
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
296
SERVER_INVALID = 0 # avahi-common/defs.h
297
SERVER_REGISTERING = 1 # avahi-common/defs.h
298
SERVER_RUNNING = 2 # avahi-common/defs.h
299
SERVER_COLLISION = 3 # avahi-common/defs.h
300
SERVER_FAILURE = 4 # avahi-common/defs.h
304
210
class AvahiError(Exception):
305
211
def __init__(self, value, *args, **kwargs):
306
212
self.value = value
307
return super(AvahiError, self).__init__(value, *args,
213
super(AvahiError, self).__init__(value, *args, **kwargs)
214
def __unicode__(self):
215
return unicode(repr(self.value))
311
217
class AvahiServiceError(AvahiError):
315
220
class AvahiGroupError(AvahiError):
319
224
class AvahiService(object):
320
225
"""An Avahi (Zeroconf) service.
323
228
interface: integer; avahi.IF_UNSPEC or an interface index.
324
229
Used to optionally bind to the specified interface.
325
230
name: string; Example: 'Mandos'
326
231
type: string; Example: '_mandos._tcp'.
327
See <https://www.iana.org/assignments/service-names-port-numbers>
232
See <http://www.dns-sd.org/ServiceTypes.html>
328
233
port: integer; what port to announce
329
234
TXT: list of strings; TXT record for the service
330
235
domain: string; Domain to publish on, default to .local if empty.
489
364
follow_name_owner_changes=True),
490
365
avahi.DBUS_INTERFACE_SERVER)
491
366
self.server.connect_to_signal("StateChanged",
492
self.server_state_changed)
367
self.server_state_changed)
493
368
self.server_state_changed(self.server.GetState())
496
370
class AvahiServiceToSyslog(AvahiService):
497
def rename(self, *args, **kwargs):
498
372
"""Add the new name to the syslog messages"""
499
ret = AvahiService.rename(self, *args, **kwargs)
500
syslogger.setFormatter(logging.Formatter(
501
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
373
ret = AvahiService.rename(self)
374
syslogger.setFormatter(logging.Formatter
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
506
# Pretend that we have a GnuTLS module
507
class GnuTLS(object):
508
"""This isn't so much a class as it is a module-like namespace.
509
It is instantiated once, and simulates having a GnuTLS module."""
511
library = ctypes.util.find_library("gnutls")
513
library = ctypes.util.find_library("gnutls-deb0")
514
_library = ctypes.cdll.LoadLibrary(library)
516
_need_version = b"3.3.0"
519
# Need to use "self" here, since this method is called before
520
# the assignment to the "gnutls" global variable happens.
521
if self.check_version(self._need_version) is None:
522
raise self.Error("Needs GnuTLS {} or later"
523
.format(self._need_version))
525
# Unless otherwise indicated, the constants and types below are
526
# all from the gnutls/gnutls.h C header file.
536
E_NO_CERTIFICATE_FOUND = -49
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
540
class session_int(ctypes.Structure):
542
session_t = ctypes.POINTER(session_int)
544
class certificate_credentials_st(ctypes.Structure):
546
certificate_credentials_t = ctypes.POINTER(
547
certificate_credentials_st)
548
certificate_type_t = ctypes.c_int
550
class datum_t(ctypes.Structure):
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
('size', ctypes.c_uint)]
554
class openpgp_crt_int(ctypes.Structure):
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
credentials_type_t = ctypes.c_int
560
transport_ptr_t = ctypes.c_void_p
561
close_request_t = ctypes.c_int
564
class Error(Exception):
565
# We need to use the class name "GnuTLS" here, since this
566
# exception might be raised from within GnuTLS.__init__,
567
# which is called before the assignment to the "gnutls"
568
# global variable has happened.
569
def __init__(self, message=None, code=None, args=()):
570
# Default usage is by a message string, but if a return
571
# code is passed, convert it to a string with
574
if message is None and code is not None:
575
message = GnuTLS.strerror(code)
576
return super(GnuTLS.Error, self).__init__(
579
class CertificateSecurityError(Error):
583
class Credentials(object):
585
self._c_object = gnutls.certificate_credentials_t()
586
gnutls.certificate_allocate_credentials(
587
ctypes.byref(self._c_object))
588
self.type = gnutls.CRD_CERTIFICATE
591
gnutls.certificate_free_credentials(self._c_object)
593
class ClientSession(object):
594
def __init__(self, socket, credentials=None):
595
self._c_object = gnutls.session_t()
596
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
597
gnutls.set_default_priority(self._c_object)
598
gnutls.transport_set_ptr(self._c_object, socket.fileno())
599
gnutls.handshake_set_private_extensions(self._c_object,
602
if credentials is None:
603
credentials = gnutls.Credentials()
604
gnutls.credentials_set(self._c_object, credentials.type,
605
ctypes.cast(credentials._c_object,
607
self.credentials = credentials
610
gnutls.deinit(self._c_object)
613
return gnutls.handshake(self._c_object)
615
def send(self, data):
619
data_len -= gnutls.record_send(self._c_object,
624
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
626
# Error handling functions
627
def _error_code(result):
628
"""A function to raise exceptions on errors, suitable
629
for the 'restype' attribute on ctypes functions"""
632
if result == gnutls.E_NO_CERTIFICATE_FOUND:
633
raise gnutls.CertificateSecurityError(code=result)
634
raise gnutls.Error(code=result)
636
def _retry_on_error(result, func, arguments):
637
"""A function to retry on some errors, suitable
638
for the 'errcheck' attribute on ctypes functions"""
640
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
641
return _error_code(result)
642
result = func(*arguments)
645
# Unless otherwise indicated, the function declarations below are
646
# all from the gnutls/gnutls.h C header file.
649
priority_set_direct = _library.gnutls_priority_set_direct
650
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
651
ctypes.POINTER(ctypes.c_char_p)]
652
priority_set_direct.restype = _error_code
654
init = _library.gnutls_init
655
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
656
init.restype = _error_code
658
set_default_priority = _library.gnutls_set_default_priority
659
set_default_priority.argtypes = [session_t]
660
set_default_priority.restype = _error_code
662
record_send = _library.gnutls_record_send
663
record_send.argtypes = [session_t, ctypes.c_void_p,
665
record_send.restype = ctypes.c_ssize_t
666
record_send.errcheck = _retry_on_error
668
certificate_allocate_credentials = (
669
_library.gnutls_certificate_allocate_credentials)
670
certificate_allocate_credentials.argtypes = [
671
ctypes.POINTER(certificate_credentials_t)]
672
certificate_allocate_credentials.restype = _error_code
674
certificate_free_credentials = (
675
_library.gnutls_certificate_free_credentials)
676
certificate_free_credentials.argtypes = [
677
certificate_credentials_t]
678
certificate_free_credentials.restype = None
680
handshake_set_private_extensions = (
681
_library.gnutls_handshake_set_private_extensions)
682
handshake_set_private_extensions.argtypes = [session_t,
684
handshake_set_private_extensions.restype = None
686
credentials_set = _library.gnutls_credentials_set
687
credentials_set.argtypes = [session_t, credentials_type_t,
689
credentials_set.restype = _error_code
691
strerror = _library.gnutls_strerror
692
strerror.argtypes = [ctypes.c_int]
693
strerror.restype = ctypes.c_char_p
695
certificate_type_get = _library.gnutls_certificate_type_get
696
certificate_type_get.argtypes = [session_t]
697
certificate_type_get.restype = _error_code
699
certificate_get_peers = _library.gnutls_certificate_get_peers
700
certificate_get_peers.argtypes = [session_t,
701
ctypes.POINTER(ctypes.c_uint)]
702
certificate_get_peers.restype = ctypes.POINTER(datum_t)
704
global_set_log_level = _library.gnutls_global_set_log_level
705
global_set_log_level.argtypes = [ctypes.c_int]
706
global_set_log_level.restype = None
708
global_set_log_function = _library.gnutls_global_set_log_function
709
global_set_log_function.argtypes = [log_func]
710
global_set_log_function.restype = None
712
deinit = _library.gnutls_deinit
713
deinit.argtypes = [session_t]
714
deinit.restype = None
716
handshake = _library.gnutls_handshake
717
handshake.argtypes = [session_t]
718
handshake.restype = _error_code
719
handshake.errcheck = _retry_on_error
721
transport_set_ptr = _library.gnutls_transport_set_ptr
722
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
723
transport_set_ptr.restype = None
725
bye = _library.gnutls_bye
726
bye.argtypes = [session_t, close_request_t]
727
bye.restype = _error_code
728
bye.errcheck = _retry_on_error
730
check_version = _library.gnutls_check_version
731
check_version.argtypes = [ctypes.c_char_p]
732
check_version.restype = ctypes.c_char_p
734
# All the function declarations below are from gnutls/openpgp.h
736
openpgp_crt_init = _library.gnutls_openpgp_crt_init
737
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
738
openpgp_crt_init.restype = _error_code
740
openpgp_crt_import = _library.gnutls_openpgp_crt_import
741
openpgp_crt_import.argtypes = [openpgp_crt_t,
742
ctypes.POINTER(datum_t),
744
openpgp_crt_import.restype = _error_code
746
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
747
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
748
ctypes.POINTER(ctypes.c_uint)]
749
openpgp_crt_verify_self.restype = _error_code
751
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
752
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
753
openpgp_crt_deinit.restype = None
755
openpgp_crt_get_fingerprint = (
756
_library.gnutls_openpgp_crt_get_fingerprint)
757
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
761
openpgp_crt_get_fingerprint.restype = _error_code
763
# Remove non-public functions
764
del _error_code, _retry_on_error
765
# Create the global "gnutls" object, simulating a module
769
def call_pipe(connection, # : multiprocessing.Connection
770
func, *args, **kwargs):
771
"""This function is meant to be called by multiprocessing.Process
773
This function runs func(*args, **kwargs), and writes the resulting
774
return value on the provided multiprocessing.Connection.
776
connection.send(func(*args, **kwargs))
380
def _timedelta_to_milliseconds(td):
381
"Convert a datetime.timedelta() to milliseconds"
382
return ((td.days * 24 * 60 * 60 * 1000)
383
+ (td.seconds * 1000)
384
+ (td.microseconds // 1000))
780
386
class Client(object):
781
387
"""A representation of a client host served by this server.
784
approved: bool(); 'None' if not yet approved/disapproved
390
_approved: bool(); 'None' if not yet approved/disapproved
785
391
approval_delay: datetime.timedelta(); Time to wait for approval
786
392
approval_duration: datetime.timedelta(); Duration of one approval
787
393
checker: subprocess.Popen(); a running checker process used
788
394
to see if the client lives.
789
395
'None' if no process is running.
790
checker_callback_tag: a GLib event source tag, or None
396
checker_callback_tag: a gobject event source tag, or None
791
397
checker_command: string; External command which is run to check
792
398
if client lives. %() expansions are done at
793
399
runtime with vars(self) as dict, so that for
794
400
instance %(name)s can be used in the command.
795
checker_initiator_tag: a GLib event source tag, or None
401
checker_initiator_tag: a gobject event source tag, or None
796
402
created: datetime.datetime(); (UTC) object creation
797
403
client_structure: Object describing what attributes a client has
798
404
and is used for storing the client at exit
799
405
current_checker_command: string; current running checker_command
800
disable_initiator_tag: a GLib event source tag, or None
406
disable_initiator_tag: a gobject event source tag, or None
802
408
fingerprint: string (40 or 32 hexadecimal digits); used to
803
409
uniquely identify the client
805
411
interval: datetime.timedelta(); How often to start a new checker
806
412
last_approval_request: datetime.datetime(); (UTC) or None
807
413
last_checked_ok: datetime.datetime(); (UTC) or None
808
415
last_checker_status: integer between 0 and 255 reflecting exit
809
416
status of last checker. -1 reflects crashed
810
checker, -2 means no checker completed yet.
811
last_checker_signal: The signal which killed the last checker, if
812
last_checker_status is -1
813
last_enabled: datetime.datetime(); (UTC) or None
418
last_enabled: datetime.datetime(); (UTC)
814
419
name: string; from the config file, used in log messages and
815
420
D-Bus identifiers
816
421
secret: bytestring; sent verbatim (over TLS) to client
817
422
timeout: datetime.timedelta(); How long from last_checked_ok
818
423
until this client is disabled
819
extended_timeout: extra long timeout when secret has been sent
424
extended_timeout: extra long timeout when password has been sent
820
425
runtime_expansions: Allowed attributes for runtime expansion.
821
426
expires: datetime.datetime(); time (UTC) when a client will be
822
427
disabled, or None
823
server_settings: The server_settings dict from main()
826
430
runtime_expansions = ("approval_delay", "approval_duration",
827
"created", "enabled", "expires",
828
"fingerprint", "host", "interval",
829
"last_approval_request", "last_checked_ok",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
830
433
"last_enabled", "name", "timeout")
833
"extended_timeout": "PT15M",
835
"checker": "fping -q -- %%(host)s",
837
"approval_delay": "PT0S",
838
"approval_duration": "PT1S",
839
"approved_by_default": "True",
844
def config_parser(config):
845
"""Construct a new dict of client settings of this form:
846
{ client_name: {setting_name: value, ...}, ...}
847
with exceptions for any special settings as defined above.
848
NOTE: Must be a pure function. Must return the same result
849
value given the same arguments.
852
for client_name in config.sections():
853
section = dict(config.items(client_name))
854
client = settings[client_name] = {}
856
client["host"] = section["host"]
857
# Reformat values from string types to Python types
858
client["approved_by_default"] = config.getboolean(
859
client_name, "approved_by_default")
860
client["enabled"] = config.getboolean(client_name,
863
# Uppercase and remove spaces from fingerprint for later
864
# comparison purposes with return value from the
865
# fingerprint() function
866
client["fingerprint"] = (section["fingerprint"].upper()
868
if "secret" in section:
869
client["secret"] = codecs.decode(section["secret"]
872
elif "secfile" in section:
873
with open(os.path.expanduser(os.path.expandvars
874
(section["secfile"])),
876
client["secret"] = secfile.read()
878
raise TypeError("No secret or secfile for section {}"
880
client["timeout"] = string_to_delta(section["timeout"])
881
client["extended_timeout"] = string_to_delta(
882
section["extended_timeout"])
883
client["interval"] = string_to_delta(section["interval"])
884
client["approval_delay"] = string_to_delta(
885
section["approval_delay"])
886
client["approval_duration"] = string_to_delta(
887
section["approval_duration"])
888
client["checker_command"] = section["checker"]
889
client["last_approval_request"] = None
890
client["last_checked_ok"] = None
891
client["last_checker_status"] = -2
895
def __init__(self, settings, name=None, server_settings=None):
435
def timeout_milliseconds(self):
436
"Return the 'timeout' attribute in milliseconds"
437
return _timedelta_to_milliseconds(self.timeout)
439
def extended_timeout_milliseconds(self):
440
"Return the 'extended_timeout' attribute in milliseconds"
441
return _timedelta_to_milliseconds(self.extended_timeout)
443
def interval_milliseconds(self):
444
"Return the 'interval' attribute in milliseconds"
445
return _timedelta_to_milliseconds(self.interval)
447
def approval_delay_milliseconds(self):
448
return _timedelta_to_milliseconds(self.approval_delay)
450
def __init__(self, name = None, config=None):
451
"""Note: the 'checker' key in 'config' sets the
452
'checker_command' attribute and *not* the 'checker'
897
if server_settings is None:
899
self.server_settings = server_settings
900
# adding all client settings
901
for setting, value in settings.items():
902
setattr(self, setting, value)
905
if not hasattr(self, "last_enabled"):
906
self.last_enabled = datetime.datetime.utcnow()
907
if not hasattr(self, "expires"):
908
self.expires = (datetime.datetime.utcnow()
911
self.last_enabled = None
914
457
logger.debug("Creating client %r", self.name)
458
# Uppercase and remove spaces from fingerprint for later
459
# comparison purposes with return value from the fingerprint()
461
self.fingerprint = (config["fingerprint"].upper()
915
463
logger.debug(" Fingerprint: %s", self.fingerprint)
916
self.created = settings.get("created",
917
datetime.datetime.utcnow())
919
# attributes specific for this server instance
464
if "secret" in config:
465
self.secret = config["secret"].decode("base64")
466
elif "secfile" in config:
467
with open(os.path.expanduser(os.path.expandvars
468
(config["secfile"])),
470
self.secret = secfile.read()
472
raise TypeError("No secret or secfile for client %s"
474
self.host = config.get("host", "")
475
self.created = datetime.datetime.utcnow()
477
self.last_approval_request = None
478
self.last_enabled = datetime.datetime.utcnow()
479
self.last_checked_ok = None
480
self.last_checker_status = None
481
self.timeout = string_to_delta(config["timeout"])
482
self.extended_timeout = string_to_delta(config
483
["extended_timeout"])
484
self.interval = string_to_delta(config["interval"])
920
485
self.checker = None
921
486
self.checker_initiator_tag = None
922
487
self.disable_initiator_tag = None
488
self.expires = datetime.datetime.utcnow() + self.timeout
923
489
self.checker_callback_tag = None
490
self.checker_command = config["checker"]
924
491
self.current_checker_command = None
492
self._approved = None
493
self.approved_by_default = config.get("approved_by_default",
926
495
self.approvals_pending = 0
927
self.changedstate = multiprocessing_manager.Condition(
928
multiprocessing_manager.Lock())
929
self.client_structure = [attr
930
for attr in self.__dict__.keys()
496
self.approval_delay = string_to_delta(
497
config["approval_delay"])
498
self.approval_duration = string_to_delta(
499
config["approval_duration"])
500
self.changedstate = (multiprocessing_manager
501
.Condition(multiprocessing_manager
503
self.client_structure = [attr for attr in
504
self.__dict__.iterkeys()
931
505
if not attr.startswith("_")]
932
506
self.client_structure.append("client_structure")
934
for name, t in inspect.getmembers(
935
type(self), lambda obj: isinstance(obj, property)):
508
for name, t in inspect.getmembers(type(self),
936
512
if not name.startswith("_"):
937
513
self.client_structure.append(name)
939
515
# Send notice to process children that client state has changed
940
516
def send_changedstate(self):
941
517
with self.changedstate:
942
518
self.changedstate.notify_all()
944
520
def enable(self):
945
521
"""Start this client's checker and timeout hooks"""
946
522
if getattr(self, "enabled", False):
947
523
# Already enabled
525
self.send_changedstate()
949
526
self.expires = datetime.datetime.utcnow() + self.timeout
950
527
self.enabled = True
951
528
self.last_enabled = datetime.datetime.utcnow()
952
529
self.init_checker()
953
self.send_changedstate()
955
531
def disable(self, quiet=True):
956
532
"""Disable this client."""
957
533
if not getattr(self, "enabled", False):
536
self.send_changedstate()
960
538
logger.info("Disabling client %s", self.name)
961
if getattr(self, "disable_initiator_tag", None) is not None:
962
GLib.source_remove(self.disable_initiator_tag)
539
if getattr(self, "disable_initiator_tag", False):
540
gobject.source_remove(self.disable_initiator_tag)
963
541
self.disable_initiator_tag = None
964
542
self.expires = None
965
if getattr(self, "checker_initiator_tag", None) is not None:
966
GLib.source_remove(self.checker_initiator_tag)
543
if getattr(self, "checker_initiator_tag", False):
544
gobject.source_remove(self.checker_initiator_tag)
967
545
self.checker_initiator_tag = None
968
546
self.stop_checker()
969
547
self.enabled = False
971
self.send_changedstate()
972
# Do not run this again if called by a GLib.timeout_add
548
# Do not run this again if called by a gobject.timeout_add
975
551
def __del__(self):
978
554
def init_checker(self):
979
555
# Schedule a new checker to be started an 'interval' from now,
980
556
# and every interval from then on.
981
if self.checker_initiator_tag is not None:
982
GLib.source_remove(self.checker_initiator_tag)
983
self.checker_initiator_tag = GLib.timeout_add(
984
int(self.interval.total_seconds() * 1000),
557
self.checker_initiator_tag = (gobject.timeout_add
558
(self.interval_milliseconds(),
986
560
# Schedule a disable() when 'timeout' has passed
987
if self.disable_initiator_tag is not None:
988
GLib.source_remove(self.disable_initiator_tag)
989
self.disable_initiator_tag = GLib.timeout_add(
990
int(self.timeout.total_seconds() * 1000), self.disable)
561
self.disable_initiator_tag = (gobject.timeout_add
562
(self.timeout_milliseconds(),
991
564
# Also start a new checker *right now*.
992
565
self.start_checker()
994
def checker_callback(self, source, condition, connection,
567
def checker_callback(self, pid, condition, command):
996
568
"""The checker has completed, so take appropriate actions."""
997
569
self.checker_callback_tag = None
998
570
self.checker = None
999
# Read return code from connection (see call_pipe)
1000
returncode = connection.recv()
1004
self.last_checker_status = returncode
1005
self.last_checker_signal = None
571
if os.WIFEXITED(condition):
572
self.last_checker_status = os.WEXITSTATUS(condition)
1006
573
if self.last_checker_status == 0:
1007
574
logger.info("Checker for %(name)s succeeded",
1009
576
self.checked_ok()
1011
logger.info("Checker for %(name)s failed", vars(self))
578
logger.info("Checker for %(name)s failed",
1013
581
self.last_checker_status = -1
1014
self.last_checker_signal = -returncode
1015
582
logger.warning("Checker for %(name)s crashed?",
1019
def checked_ok(self):
1020
"""Assert that the client has been seen, alive and well."""
1021
self.last_checked_ok = datetime.datetime.utcnow()
1022
self.last_checker_status = 0
1023
self.last_checker_signal = None
1026
def bump_timeout(self, timeout=None):
1027
"""Bump up the timeout for this client."""
585
def checked_ok(self, timeout=None):
586
"""Bump up the timeout for this client.
588
This should only be called when the client has been seen,
1028
591
if timeout is None:
1029
592
timeout = self.timeout
593
self.last_checked_ok = datetime.datetime.utcnow()
1030
594
if self.disable_initiator_tag is not None:
1031
GLib.source_remove(self.disable_initiator_tag)
1032
self.disable_initiator_tag = None
595
gobject.source_remove(self.disable_initiator_tag)
1033
596
if getattr(self, "enabled", False):
1034
self.disable_initiator_tag = GLib.timeout_add(
1035
int(timeout.total_seconds() * 1000), self.disable)
597
self.disable_initiator_tag = (gobject.timeout_add
598
(_timedelta_to_milliseconds
599
(timeout), self.disable))
1036
600
self.expires = datetime.datetime.utcnow() + timeout
1038
602
def need_approval(self):
1039
603
self.last_approval_request = datetime.datetime.utcnow()
1041
605
def start_checker(self):
1042
606
"""Start a new checker subprocess if one is not running.
1044
608
If a checker already exists, leave it running and do
1046
610
# The reason for not killing a running checker is that if we
1047
# did that, and if a checker (for some reason) started running
1048
# slowly and taking more than 'interval' time, then the client
1049
# would inevitably timeout, since no checker would get a
1050
# chance to run to completion. If we instead leave running
611
# did that, then if a checker (for some reason) started
612
# running slowly and taking more than 'interval' time, the
613
# client would inevitably timeout, since no checker would get
614
# a chance to run to completion. If we instead leave running
1051
615
# checkers alone, the checker would have to take more time
1052
616
# than 'timeout' for the client to be disabled, which is as it
1055
if self.checker is not None and not self.checker.is_alive():
1056
logger.warning("Checker was not alive; joining")
619
# If a checker exists, make sure it is not a zombie
621
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
622
except (AttributeError, OSError) as error:
623
if (isinstance(error, OSError)
624
and error.errno != errno.ECHILD):
628
logger.warning("Checker was a zombie")
629
gobject.source_remove(self.checker_callback_tag)
630
self.checker_callback(pid, status,
631
self.current_checker_command)
1059
632
# Start a new checker if needed
1060
633
if self.checker is None:
1061
# Escape attributes for the shell
1063
attr: re.escape(str(getattr(self, attr)))
1064
for attr in self.runtime_expansions}
1066
command = self.checker_command % escaped_attrs
1067
except TypeError as error:
1068
logger.error('Could not format string "%s"',
1069
self.checker_command,
1071
return True # Try again later
635
# In case checker_command has exactly one % operator
636
command = self.checker_command % self.host
638
# Escape attributes for the shell
639
escaped_attrs = dict(
641
re.escape(unicode(str(getattr(self, attr, "")),
645
self.runtime_expansions)
648
command = self.checker_command % escaped_attrs
649
except TypeError as error:
650
logger.error('Could not format string "%s":'
651
' %s', self.checker_command, error)
652
return True # Try again later
1072
653
self.current_checker_command = command
1073
logger.info("Starting checker %r for %s", command,
1075
# We don't need to redirect stdout and stderr, since
1076
# in normal mode, that is already done by daemon(),
1077
# and in debug mode we don't want to. (Stdin is
1078
# always replaced by /dev/null.)
1079
# The exception is when not debugging but nevertheless
1080
# running in the foreground; use the previously
1082
popen_args = {"close_fds": True,
1085
if (not self.server_settings["debug"]
1086
and self.server_settings["foreground"]):
1087
popen_args.update({"stdout": wnull,
1089
pipe = multiprocessing.Pipe(duplex=False)
1090
self.checker = multiprocessing.Process(
1092
args=(pipe[1], subprocess.call, command),
1094
self.checker.start()
1095
self.checker_callback_tag = GLib.io_add_watch(
1096
pipe[0].fileno(), GLib.IO_IN,
1097
self.checker_callback, pipe[0], command)
1098
# Re-run this periodically if run by GLib.timeout_add
655
logger.info("Starting checker %r for %s",
657
# We don't need to redirect stdout and stderr, since
658
# in normal mode, that is already done by daemon(),
659
# and in debug mode we don't want to. (Stdin is
660
# always replaced by /dev/null.)
661
self.checker = subprocess.Popen(command,
664
self.checker_callback_tag = (gobject.child_watch_add
666
self.checker_callback,
668
# The checker may have completed before the gobject
669
# watch was added. Check for this.
670
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
672
gobject.source_remove(self.checker_callback_tag)
673
self.checker_callback(pid, status, command)
674
except OSError as error:
675
logger.error("Failed to start subprocess: %s",
677
# Re-run this periodically if run by gobject.timeout_add
1101
680
def stop_checker(self):
1102
681
"""Force the checker process, if any, to stop."""
1103
682
if self.checker_callback_tag:
1104
GLib.source_remove(self.checker_callback_tag)
683
gobject.source_remove(self.checker_callback_tag)
1105
684
self.checker_callback_tag = None
1106
685
if getattr(self, "checker", None) is None:
1108
687
logger.debug("Stopping checker for %(name)s", vars(self))
1109
self.checker.terminate()
689
os.kill(self.checker.pid, signal.SIGTERM)
691
#if self.checker.poll() is None:
692
# os.kill(self.checker.pid, signal.SIGKILL)
693
except OSError as error:
694
if error.errno != errno.ESRCH: # No such process
1110
696
self.checker = None
1113
def dbus_service_property(dbus_interface,
699
def dbus_service_property(dbus_interface, signature="v",
700
access="readwrite", byte_arrays=False):
1117
701
"""Decorators for marking methods of a DBusObjectWithProperties to
1118
702
become properties on the D-Bus.
1120
704
The decorated method will be called with no arguments by "Get"
1121
705
and with one argument by "Set".
1123
707
The parameters, where they are supported, are the same as
1124
708
dbus.service.method, except there is only "signature", since the
1125
709
type from Get() and the type sent to Set() is the same.
1208
class DBusObjectWithAnnotations(dbus.service.Object):
1209
"""A D-Bus object with annotations.
1211
Classes inheriting from this can use the dbus_annotations
1212
decorator to add annotations to methods or signals.
1216
def _is_dbus_thing(thing):
1217
"""Returns a function testing if an attribute is a D-Bus thing
1219
If called like _is_dbus_thing("method") it returns a function
1220
suitable for use as predicate to inspect.getmembers().
1222
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1225
def _get_all_dbus_things(self, thing):
1226
"""Returns a generator of (name, attribute) pairs
1228
return ((getattr(athing.__get__(self), "_dbus_name", name),
1229
athing.__get__(self))
1230
for cls in self.__class__.__mro__
1232
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1234
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1236
path_keyword='object_path',
1237
connection_keyword='connection')
1238
def Introspect(self, object_path, connection):
1239
"""Overloading of standard D-Bus method.
1241
Inserts annotation tags on methods and signals.
1243
xmlstring = dbus.service.Object.Introspect(self, object_path,
1246
document = xml.dom.minidom.parseString(xmlstring)
1248
for if_tag in document.getElementsByTagName("interface"):
1249
# Add annotation tags
1250
for typ in ("method", "signal"):
1251
for tag in if_tag.getElementsByTagName(typ):
1253
for name, prop in (self.
1254
_get_all_dbus_things(typ)):
1255
if (name == tag.getAttribute("name")
1256
and prop._dbus_interface
1257
== if_tag.getAttribute("name")):
1258
annots.update(getattr(
1259
prop, "_dbus_annotations", {}))
1260
for name, value in annots.items():
1261
ann_tag = document.createElement(
1263
ann_tag.setAttribute("name", name)
1264
ann_tag.setAttribute("value", value)
1265
tag.appendChild(ann_tag)
1266
# Add interface annotation tags
1267
for annotation, value in dict(
1268
itertools.chain.from_iterable(
1269
annotations().items()
1270
for name, annotations
1271
in self._get_all_dbus_things("interface")
1272
if name == if_tag.getAttribute("name")
1274
ann_tag = document.createElement("annotation")
1275
ann_tag.setAttribute("name", annotation)
1276
ann_tag.setAttribute("value", value)
1277
if_tag.appendChild(ann_tag)
1278
# Fix argument name for the Introspect method itself
1279
if (if_tag.getAttribute("name")
1280
== dbus.INTROSPECTABLE_IFACE):
1281
for cn in if_tag.getElementsByTagName("method"):
1282
if cn.getAttribute("name") == "Introspect":
1283
for arg in cn.getElementsByTagName("arg"):
1284
if (arg.getAttribute("direction")
1286
arg.setAttribute("name",
1288
xmlstring = document.toxml("utf-8")
1290
except (AttributeError, xml.dom.DOMException,
1291
xml.parsers.expat.ExpatError) as error:
1292
logger.error("Failed to override Introspection method",
1297
class DBusObjectWithProperties(DBusObjectWithAnnotations):
748
class DBusObjectWithProperties(dbus.service.Object):
1298
749
"""A D-Bus object with properties.
1300
751
Classes inheriting from this can use the dbus_service_property
1301
752
decorator to expose methods as D-Bus properties. It exposes the
1302
753
standard Get(), Set(), and GetAll() methods on the D-Bus.
757
def _is_dbus_property(obj):
758
return getattr(obj, "_dbus_is_property", False)
760
def _get_all_dbus_properties(self):
761
"""Returns a generator of (name, attribute) pairs
763
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
764
for cls in self.__class__.__mro__
766
inspect.getmembers(cls, self._is_dbus_property))
1305
768
def _get_dbus_property(self, interface_name, property_name):
1306
769
"""Returns a bound method if one exists which is a D-Bus
1307
770
property with the specified name and interface.
1309
for cls in self.__class__.__mro__:
1310
for name, value in inspect.getmembers(
1311
cls, self._is_dbus_thing("property")):
772
for cls in self.__class__.__mro__:
773
for name, value in (inspect.getmembers
774
(cls, self._is_dbus_property)):
1312
775
if (value._dbus_name == property_name
1313
776
and value._dbus_interface == interface_name):
1314
777
return value.__get__(self)
1316
779
# No such property
1317
raise DBusPropertyNotFound("{}:{}.{}".format(
1318
self.dbus_object_path, interface_name, property_name))
1321
def _get_all_interface_names(cls):
1322
"""Get a sequence of all interfaces supported by an object"""
1323
return (name for name in set(getattr(getattr(x, attr),
1324
"_dbus_interface", None)
1325
for x in (inspect.getmro(cls))
1327
if name is not None)
1329
@dbus.service.method(dbus.PROPERTIES_IFACE,
780
raise DBusPropertyNotFound(self.dbus_object_path + ":"
781
+ interface_name + "."
784
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1331
785
out_signature="v")
1332
786
def Get(self, interface_name, property_name):
1333
787
"""Standard D-Bus property Get() method, see D-Bus standard.
1458
879
except (AttributeError, xml.dom.DOMException,
1459
880
xml.parsers.expat.ExpatError) as error:
1460
881
logger.error("Failed to override Introspection method",
1466
dbus.OBJECT_MANAGER_IFACE
1467
except AttributeError:
1468
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1471
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1472
"""A D-Bus object with an ObjectManager.
1474
Classes inheriting from this exposes the standard
1475
GetManagedObjects call and the InterfacesAdded and
1476
InterfacesRemoved signals on the standard
1477
"org.freedesktop.DBus.ObjectManager" interface.
1479
Note: No signals are sent automatically; they must be sent
1482
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1483
out_signature="a{oa{sa{sv}}}")
1484
def GetManagedObjects(self):
1485
"""This function must be overridden"""
1486
raise NotImplementedError()
1488
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1489
signature="oa{sa{sv}}")
1490
def InterfacesAdded(self, object_path, interfaces_and_properties):
1493
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1494
def InterfacesRemoved(self, object_path, interfaces):
1497
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1499
path_keyword='object_path',
1500
connection_keyword='connection')
1501
def Introspect(self, object_path, connection):
1502
"""Overloading of standard D-Bus method.
1504
Override return argument name of GetManagedObjects to be
1505
"objpath_interfaces_and_properties"
1507
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1511
document = xml.dom.minidom.parseString(xmlstring)
1513
for if_tag in document.getElementsByTagName("interface"):
1514
# Fix argument name for the GetManagedObjects method
1515
if (if_tag.getAttribute("name")
1516
== dbus.OBJECT_MANAGER_IFACE):
1517
for cn in if_tag.getElementsByTagName("method"):
1518
if (cn.getAttribute("name")
1519
== "GetManagedObjects"):
1520
for arg in cn.getElementsByTagName("arg"):
1521
if (arg.getAttribute("direction")
1525
"objpath_interfaces"
1527
xmlstring = document.toxml("utf-8")
1529
except (AttributeError, xml.dom.DOMException,
1530
xml.parsers.expat.ExpatError) as error:
1531
logger.error("Failed to override Introspection method",
1536
def datetime_to_dbus(dt, variant_level=0):
886
def datetime_to_dbus (dt, variant_level=0):
1537
887
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1539
return dbus.String("", variant_level=variant_level)
1540
return dbus.String(dt.isoformat(), variant_level=variant_level)
1543
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1544
"""A class decorator; applied to a subclass of
1545
dbus.service.Object, it will add alternate D-Bus attributes with
1546
interface names according to the "alt_interface_names" mapping.
1549
@alternate_dbus_interfaces({"org.example.Interface":
1550
"net.example.AlternateInterface"})
1551
class SampleDBusObject(dbus.service.Object):
1552
@dbus.service.method("org.example.Interface")
1553
def SampleDBusMethod():
1556
The above "SampleDBusMethod" on "SampleDBusObject" will be
1557
reachable via two interfaces: "org.example.Interface" and
1558
"net.example.AlternateInterface", the latter of which will have
1559
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1560
"true", unless "deprecate" is passed with a False value.
1562
This works for methods and signals, and also for D-Bus properties
1563
(from DBusObjectWithProperties) and interfaces (from the
1564
dbus_interface_annotations decorator).
889
return dbus.String("", variant_level = variant_level)
890
return dbus.String(dt.isoformat(),
891
variant_level=variant_level)
894
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
896
"""Applied to an empty subclass of a D-Bus object, this metaclass
897
will add additional D-Bus attributes matching a certain pattern.
1568
for orig_interface_name, alt_interface_name in (
1569
alt_interface_names.items()):
1571
interface_names = set()
1572
# Go though all attributes of the class
1573
for attrname, attribute in inspect.getmembers(cls):
899
def __new__(mcs, name, bases, attr):
900
# Go through all the base classes which could have D-Bus
901
# methods, signals, or properties in them
902
for base in (b for b in bases
903
if issubclass(b, dbus.service.Object)):
904
# Go though all attributes of the base class
905
for attrname, attribute in inspect.getmembers(base):
1574
906
# Ignore non-D-Bus attributes, and D-Bus attributes
1575
907
# with the wrong interface name
1576
908
if (not hasattr(attribute, "_dbus_interface")
1577
or not attribute._dbus_interface.startswith(
1578
orig_interface_name)):
909
or not attribute._dbus_interface
910
.startswith("se.recompile.Mandos")):
1580
912
# Create an alternate D-Bus interface name based on
1581
913
# the current name
1582
alt_interface = attribute._dbus_interface.replace(
1583
orig_interface_name, alt_interface_name)
1584
interface_names.add(alt_interface)
914
alt_interface = (attribute._dbus_interface
915
.replace("se.recompile.Mandos",
916
"se.bsnet.fukt.Mandos"))
1585
917
# Is this a D-Bus signal?
1586
918
if getattr(attribute, "_dbus_is_signal", False):
1587
# Extract the original non-method undecorated
1588
# function by black magic
1589
if sys.version_info.major == 2:
1590
nonmethod_func = (dict(
919
# Extract the original non-method function by
921
nonmethod_func = (dict(
1591
922
zip(attribute.func_code.co_freevars,
1592
attribute.__closure__))
1593
["func"].cell_contents)
1595
nonmethod_func = (dict(
1596
zip(attribute.__code__.co_freevars,
1597
attribute.__closure__))
1598
["func"].cell_contents)
923
attribute.__closure__))["func"]
1599
925
# Create a new, but exactly alike, function
1600
926
# object, and decorate it to be a new D-Bus signal
1601
927
# with the alternate D-Bus interface name
1602
new_function = copy_function(nonmethod_func)
1603
new_function = (dbus.service.signal(
1605
attribute._dbus_signature)(new_function))
1606
# Copy annotations, if any
1608
new_function._dbus_annotations = dict(
1609
attribute._dbus_annotations)
1610
except AttributeError:
928
new_function = (dbus.service.signal
930
attribute._dbus_signature)
932
nonmethod_func.func_code,
933
nonmethod_func.func_globals,
934
nonmethod_func.func_name,
935
nonmethod_func.func_defaults,
936
nonmethod_func.func_closure)))
1613
937
# Define a creator of a function to call both the
1614
# original and alternate functions, so both the
1615
# original and alternate signals gets sent when
1616
# the function is called
938
# old and new functions, so both the old and new
939
# signals gets sent when the function is called
1617
940
def fixscope(func1, func2):
1618
941
"""This function is a scope container to pass
1619
942
func1 and func2 to the "call_both" function
1620
943
outside of its arguments"""
1622
@functools.wraps(func2)
1623
944
def call_both(*args, **kwargs):
1624
945
"""This function will emit two D-Bus
1625
946
signals by calling func1 and func2"""
1626
947
func1(*args, **kwargs)
1627
948
func2(*args, **kwargs)
1628
# Make wrapper function look like a D-Bus
1630
for name, attr in inspect.getmembers(func2):
1631
if name.startswith("_dbus_"):
1632
setattr(call_both, name, attr)
1634
949
return call_both
1635
950
# Create the "call_both" function and add it to
1637
attr[attrname] = fixscope(attribute, new_function)
952
attr[attrname] = fixscope(attribute,
1638
954
# Is this a D-Bus method?
1639
955
elif getattr(attribute, "_dbus_is_method", False):
1640
956
# Create a new, but exactly alike, function
1641
957
# object. Decorate it to be a new D-Bus method
1642
958
# with the alternate D-Bus interface name. Add it
1645
dbus.service.method(
1647
attribute._dbus_in_signature,
1648
attribute._dbus_out_signature)
1649
(copy_function(attribute)))
1650
# Copy annotations, if any
1652
attr[attrname]._dbus_annotations = dict(
1653
attribute._dbus_annotations)
1654
except AttributeError:
960
attr[attrname] = (dbus.service.method
962
attribute._dbus_in_signature,
963
attribute._dbus_out_signature)
965
(attribute.func_code,
966
attribute.func_globals,
968
attribute.func_defaults,
969
attribute.func_closure)))
1656
970
# Is this a D-Bus property?
1657
971
elif getattr(attribute, "_dbus_is_property", False):
1658
972
# Create a new, but exactly alike, function
1659
973
# object, and decorate it to be a new D-Bus
1660
974
# property with the alternate D-Bus interface
1661
975
# name. Add it to the class.
1662
attr[attrname] = (dbus_service_property(
1663
alt_interface, attribute._dbus_signature,
1664
attribute._dbus_access,
1665
attribute._dbus_get_args_options
1667
(copy_function(attribute)))
1668
# Copy annotations, if any
1670
attr[attrname]._dbus_annotations = dict(
1671
attribute._dbus_annotations)
1672
except AttributeError:
1674
# Is this a D-Bus interface?
1675
elif getattr(attribute, "_dbus_is_interface", False):
1676
# Create a new, but exactly alike, function
1677
# object. Decorate it to be a new D-Bus interface
1678
# with the alternate D-Bus interface name. Add it
1681
dbus_interface_annotations(alt_interface)
1682
(copy_function(attribute)))
1684
# Deprecate all alternate interfaces
1685
iname = "_AlternateDBusNames_interface_annotation{}"
1686
for interface_name in interface_names:
1688
@dbus_interface_annotations(interface_name)
1690
return {"org.freedesktop.DBus.Deprecated":
1692
# Find an unused name
1693
for aname in (iname.format(i)
1694
for i in itertools.count()):
1695
if aname not in attr:
1699
# Replace the class with a new subclass of it with
1700
# methods, signals, etc. as created above.
1701
if sys.version_info.major == 2:
1702
cls = type(b"{}Alternate".format(cls.__name__),
1705
cls = type("{}Alternate".format(cls.__name__),
1712
@alternate_dbus_interfaces({"se.recompile.Mandos":
1713
"se.bsnet.fukt.Mandos"})
976
attr[attrname] = (dbus_service_property
978
attribute._dbus_signature,
979
attribute._dbus_access,
981
._dbus_get_args_options
984
(attribute.func_code,
985
attribute.func_globals,
987
attribute.func_defaults,
988
attribute.func_closure)))
989
return type.__new__(mcs, name, bases, attr)
1714
992
class ClientDBus(Client, DBusObjectWithProperties):
1715
993
"""A Client class using D-Bus
1718
996
dbus_object_path: dbus.ObjectPath
1719
997
bus: dbus.SystemBus()
1722
1000
runtime_expansions = (Client.runtime_expansions
1723
+ ("dbus_object_path", ))
1725
_interface = "se.recompile.Mandos.Client"
1001
+ ("dbus_object_path",))
1727
1003
# dbus.service.Object doesn't use super(), so we can't either.
1729
def __init__(self, bus=None, *args, **kwargs):
1005
def __init__(self, bus = None, *args, **kwargs):
1731
1007
Client.__init__(self, *args, **kwargs)
1009
self._approvals_pending = 0
1732
1010
# Only now, when this client is initialized, can it show up on
1734
client_object_name = str(self.name).translate(
1012
client_object_name = unicode(self.name).translate(
1735
1013
{ord("."): ord("_"),
1736
1014
ord("-"): ord("_")})
1737
self.dbus_object_path = dbus.ObjectPath(
1738
"/clients/" + client_object_name)
1015
self.dbus_object_path = (dbus.ObjectPath
1016
("/clients/" + client_object_name))
1739
1017
DBusObjectWithProperties.__init__(self, self.bus,
1740
1018
self.dbus_object_path)
1742
def notifychangeproperty(transform_func, dbus_name,
1743
type_func=lambda x: x,
1745
invalidate_only=False,
1746
_interface=_interface):
1020
def notifychangeproperty(transform_func,
1021
dbus_name, type_func=lambda x: x,
1747
1023
""" Modify a variable so that it's a property which announces
1748
1024
its changes to DBus.
1750
1026
transform_fun: Function that takes a value and a variant_level
1751
1027
and transforms it to a D-Bus type.
1752
1028
dbus_name: D-Bus name of the variable
1754
1030
to the D-Bus. Default: no transform
1755
1031
variant_level: D-Bus variant level. Default: 1
1757
attrname = "_{}".format(dbus_name)
1033
attrname = "_{0}".format(dbus_name)
1759
1034
def setter(self, value):
1760
1035
if hasattr(self, "dbus_object_path"):
1761
1036
if (not hasattr(self, attrname) or
1762
1037
type_func(getattr(self, attrname, None))
1763
1038
!= type_func(value)):
1765
self.PropertiesChanged(
1766
_interface, dbus.Dictionary(),
1767
dbus.Array((dbus_name, )))
1769
dbus_value = transform_func(
1771
variant_level=variant_level)
1772
self.PropertyChanged(dbus.String(dbus_name),
1774
self.PropertiesChanged(
1776
dbus.Dictionary({dbus.String(dbus_name):
1039
dbus_value = transform_func(type_func(value),
1042
self.PropertyChanged(dbus.String(dbus_name),
1779
1044
setattr(self, attrname, value)
1781
1046
return property(lambda self: getattr(self, attrname), setter)
1783
1049
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1784
1050
approvals_pending = notifychangeproperty(dbus.Boolean,
1785
1051
"ApprovalPending",
1787
1053
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1788
1054
last_enabled = notifychangeproperty(datetime_to_dbus,
1790
checker = notifychangeproperty(
1791
dbus.Boolean, "CheckerRunning",
1792
type_func=lambda checker: checker is not None)
1056
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1057
type_func = lambda checker:
1058
checker is not None)
1793
1059
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1794
1060
"LastCheckedOK")
1795
last_checker_status = notifychangeproperty(dbus.Int16,
1796
"LastCheckerStatus")
1797
1061
last_approval_request = notifychangeproperty(
1798
1062
datetime_to_dbus, "LastApprovalRequest")
1799
1063
approved_by_default = notifychangeproperty(dbus.Boolean,
1800
1064
"ApprovedByDefault")
1801
approval_delay = notifychangeproperty(
1802
dbus.UInt64, "ApprovalDelay",
1803
type_func=lambda td: td.total_seconds() * 1000)
1065
approval_delay = notifychangeproperty(dbus.UInt16,
1068
_timedelta_to_milliseconds)
1804
1069
approval_duration = notifychangeproperty(
1805
dbus.UInt64, "ApprovalDuration",
1806
type_func=lambda td: td.total_seconds() * 1000)
1070
dbus.UInt16, "ApprovalDuration",
1071
type_func = _timedelta_to_milliseconds)
1807
1072
host = notifychangeproperty(dbus.String, "Host")
1808
timeout = notifychangeproperty(
1809
dbus.UInt64, "Timeout",
1810
type_func=lambda td: td.total_seconds() * 1000)
1073
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1075
_timedelta_to_milliseconds)
1811
1076
extended_timeout = notifychangeproperty(
1812
dbus.UInt64, "ExtendedTimeout",
1813
type_func=lambda td: td.total_seconds() * 1000)
1814
interval = notifychangeproperty(
1815
dbus.UInt64, "Interval",
1816
type_func=lambda td: td.total_seconds() * 1000)
1077
dbus.UInt16, "ExtendedTimeout",
1078
type_func = _timedelta_to_milliseconds)
1079
interval = notifychangeproperty(dbus.UInt16,
1082
_timedelta_to_milliseconds)
1817
1083
checker_command = notifychangeproperty(dbus.String, "Checker")
1818
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1819
invalidate_only=True)
1821
1085
del notifychangeproperty
1823
1087
def __del__(self, *args, **kwargs):
1825
1089
self.remove_from_connection()
1904
1169
server to mandos-client
1908
1173
# Rejected - signal
1909
1174
@dbus.service.signal(_interface, signature="s")
1910
1175
def Rejected(self, reason):
1914
1179
# NeedApproval - signal
1915
1180
@dbus.service.signal(_interface, signature="tb")
1916
1181
def NeedApproval(self, timeout, default):
1918
1183
return self.need_approval()
1185
# NeRwequest - signal
1186
@dbus.service.signal(_interface, signature="s")
1187
def NewRequest(self, ip):
1189
Is sent after a client request a password.
1922
1195
# Approve - method
1923
1196
@dbus.service.method(_interface, in_signature="b")
1924
1197
def Approve(self, value):
1925
1198
self.approve(value)
1927
1200
# CheckedOK - method
1928
1201
@dbus.service.method(_interface)
1929
1202
def CheckedOK(self):
1930
1203
self.checked_ok()
1932
1205
# Enable - method
1933
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1934
1206
@dbus.service.method(_interface)
1935
1207
def Enable(self):
1939
1211
# StartChecker - method
1940
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1941
1212
@dbus.service.method(_interface)
1942
1213
def StartChecker(self):
1944
1215
self.start_checker()
1946
1217
# Disable - method
1947
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1948
1218
@dbus.service.method(_interface)
1949
1219
def Disable(self):
1953
1223
# StopChecker - method
1954
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1955
1224
@dbus.service.method(_interface)
1956
1225
def StopChecker(self):
1957
1226
self.stop_checker()
1961
1230
# ApprovalPending - property
1962
1231
@dbus_service_property(_interface, signature="b", access="read")
1963
1232
def ApprovalPending_dbus_property(self):
1964
1233
return dbus.Boolean(bool(self.approvals_pending))
1966
1235
# ApprovedByDefault - property
1967
@dbus_service_property(_interface,
1236
@dbus_service_property(_interface, signature="b",
1969
1237
access="readwrite")
1970
1238
def ApprovedByDefault_dbus_property(self, value=None):
1971
1239
if value is None: # get
1972
1240
return dbus.Boolean(self.approved_by_default)
1973
1241
self.approved_by_default = bool(value)
1975
1243
# ApprovalDelay - property
1976
@dbus_service_property(_interface,
1244
@dbus_service_property(_interface, signature="t",
1978
1245
access="readwrite")
1979
1246
def ApprovalDelay_dbus_property(self, value=None):
1980
1247
if value is None: # get
1981
return dbus.UInt64(self.approval_delay.total_seconds()
1248
return dbus.UInt64(self.approval_delay_milliseconds())
1983
1249
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1985
1251
# ApprovalDuration - property
1986
@dbus_service_property(_interface,
1252
@dbus_service_property(_interface, signature="t",
1988
1253
access="readwrite")
1989
1254
def ApprovalDuration_dbus_property(self, value=None):
1990
1255
if value is None: # get
1991
return dbus.UInt64(self.approval_duration.total_seconds()
1256
return dbus.UInt64(_timedelta_to_milliseconds(
1257
self.approval_duration))
1993
1258
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1995
1260
# Name - property
1997
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1998
1261
@dbus_service_property(_interface, signature="s", access="read")
1999
1262
def Name_dbus_property(self):
2000
1263
return dbus.String(self.name)
2002
1265
# Fingerprint - property
2004
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2005
1266
@dbus_service_property(_interface, signature="s", access="read")
2006
1267
def Fingerprint_dbus_property(self):
2007
1268
return dbus.String(self.fingerprint)
2009
1270
# Host - property
2010
@dbus_service_property(_interface,
1271
@dbus_service_property(_interface, signature="s",
2012
1272
access="readwrite")
2013
1273
def Host_dbus_property(self, value=None):
2014
1274
if value is None: # get
2015
1275
return dbus.String(self.host)
2016
self.host = str(value)
2018
1278
# Created - property
2020
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2021
1279
@dbus_service_property(_interface, signature="s", access="read")
2022
1280
def Created_dbus_property(self):
2023
return datetime_to_dbus(self.created)
1281
return dbus.String(datetime_to_dbus(self.created))
2025
1283
# LastEnabled - property
2026
1284
@dbus_service_property(_interface, signature="s", access="read")
2027
1285
def LastEnabled_dbus_property(self):
2028
1286
return datetime_to_dbus(self.last_enabled)
2030
1288
# Enabled - property
2031
@dbus_service_property(_interface,
1289
@dbus_service_property(_interface, signature="b",
2033
1290
access="readwrite")
2034
1291
def Enabled_dbus_property(self, value=None):
2035
1292
if value is None: # get
2042
1299
# LastCheckedOK - property
2043
@dbus_service_property(_interface,
1300
@dbus_service_property(_interface, signature="s",
2045
1301
access="readwrite")
2046
1302
def LastCheckedOK_dbus_property(self, value=None):
2047
1303
if value is not None:
2048
1304
self.checked_ok()
2050
1306
return datetime_to_dbus(self.last_checked_ok)
2052
# LastCheckerStatus - property
2053
@dbus_service_property(_interface, signature="n", access="read")
2054
def LastCheckerStatus_dbus_property(self):
2055
return dbus.Int16(self.last_checker_status)
2057
1308
# Expires - property
2058
1309
@dbus_service_property(_interface, signature="s", access="read")
2059
1310
def Expires_dbus_property(self):
2060
1311
return datetime_to_dbus(self.expires)
2062
1313
# LastApprovalRequest - property
2063
1314
@dbus_service_property(_interface, signature="s", access="read")
2064
1315
def LastApprovalRequest_dbus_property(self):
2065
1316
return datetime_to_dbus(self.last_approval_request)
2067
1318
# Timeout - property
2068
@dbus_service_property(_interface,
1319
@dbus_service_property(_interface, signature="t",
2070
1320
access="readwrite")
2071
1321
def Timeout_dbus_property(self, value=None):
2072
1322
if value is None: # get
2073
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2074
old_timeout = self.timeout
1323
return dbus.UInt64(self.timeout_milliseconds())
2075
1324
self.timeout = datetime.timedelta(0, 0, 0, value)
2076
# Reschedule disabling
2078
now = datetime.datetime.utcnow()
2079
self.expires += self.timeout - old_timeout
2080
if self.expires <= now:
2081
# The timeout has passed
2084
if (getattr(self, "disable_initiator_tag", None)
2087
GLib.source_remove(self.disable_initiator_tag)
2088
self.disable_initiator_tag = GLib.timeout_add(
2089
int((self.expires - now).total_seconds() * 1000),
1325
if getattr(self, "disable_initiator_tag", None) is None:
1327
# Reschedule timeout
1328
gobject.source_remove(self.disable_initiator_tag)
1329
self.disable_initiator_tag = None
1331
time_to_die = _timedelta_to_milliseconds((self
1336
if time_to_die <= 0:
1337
# The timeout has passed
1340
self.expires = (datetime.datetime.utcnow()
1341
+ datetime.timedelta(milliseconds =
1343
self.disable_initiator_tag = (gobject.timeout_add
1344
(time_to_die, self.disable))
2092
1346
# ExtendedTimeout - property
2093
@dbus_service_property(_interface,
1347
@dbus_service_property(_interface, signature="t",
2095
1348
access="readwrite")
2096
1349
def ExtendedTimeout_dbus_property(self, value=None):
2097
1350
if value is None: # get
2098
return dbus.UInt64(self.extended_timeout.total_seconds()
1351
return dbus.UInt64(self.extended_timeout_milliseconds())
2100
1352
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2102
1354
# Interval - property
2103
@dbus_service_property(_interface,
1355
@dbus_service_property(_interface, signature="t",
2105
1356
access="readwrite")
2106
1357
def Interval_dbus_property(self, value=None):
2107
1358
if value is None: # get
2108
return dbus.UInt64(self.interval.total_seconds() * 1000)
1359
return dbus.UInt64(self.interval_milliseconds())
2109
1360
self.interval = datetime.timedelta(0, 0, 0, value)
2110
1361
if getattr(self, "checker_initiator_tag", None) is None:
2113
# Reschedule checker run
2114
GLib.source_remove(self.checker_initiator_tag)
2115
self.checker_initiator_tag = GLib.timeout_add(
2116
value, self.start_checker)
2117
self.start_checker() # Start one now, too
1363
# Reschedule checker run
1364
gobject.source_remove(self.checker_initiator_tag)
1365
self.checker_initiator_tag = (gobject.timeout_add
1366
(value, self.start_checker))
1367
self.start_checker() # Start one now, too
2119
1369
# Checker - property
2120
@dbus_service_property(_interface,
1370
@dbus_service_property(_interface, signature="s",
2122
1371
access="readwrite")
2123
1372
def Checker_dbus_property(self, value=None):
2124
1373
if value is None: # get
2125
1374
return dbus.String(self.checker_command)
2126
self.checker_command = str(value)
1375
self.checker_command = value
2128
1377
# CheckerRunning - property
2129
@dbus_service_property(_interface,
1378
@dbus_service_property(_interface, signature="b",
2131
1379
access="readwrite")
2132
1380
def CheckerRunning_dbus_property(self, value=None):
2133
1381
if value is None: # get
2164
1404
self._pipe = child_pipe
2165
1405
self._pipe.send(('init', fpr, address))
2166
1406
if not self._pipe.recv():
2169
1409
def __getattribute__(self, name):
1410
if(name == '_pipe'):
2171
1411
return super(ProxyClient, self).__getattribute__(name)
2172
1412
self._pipe.send(('getattr', name))
2173
1413
data = self._pipe.recv()
2174
1414
if data[0] == 'data':
2176
1416
if data[0] == 'function':
2178
1417
def func(*args, **kwargs):
2179
1418
self._pipe.send(('funcall', name, args, kwargs))
2180
1419
return self._pipe.recv()[1]
2184
1422
def __setattr__(self, name, value):
1423
if(name == '_pipe'):
2186
1424
return super(ProxyClient, self).__setattr__(name, value)
2187
1425
self._pipe.send(('setattr', name, value))
1428
class ClientDBusTransitional(ClientDBus):
1429
__metaclass__ = AlternateDBusNamesMetaclass
2190
1432
class ClientHandler(socketserver.BaseRequestHandler, object):
2191
1433
"""A class to handle client connections.
2193
1435
Instantiated once for each connection to handle it.
2194
1436
Note: This will run in its own forked process."""
2196
1438
def handle(self):
2197
1439
with contextlib.closing(self.server.child_pipe) as child_pipe:
2198
1440
logger.info("TCP connection from: %s",
2199
str(self.client_address))
1441
unicode(self.client_address))
2200
1442
logger.debug("Pipe FD: %d",
2201
1443
self.server.child_pipe.fileno())
2203
session = gnutls.ClientSession(self.request)
2205
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2206
# "+AES-256-CBC", "+SHA1",
2207
# "+COMP-NULL", "+CTYPE-OPENPGP",
1445
session = (gnutls.connection
1446
.ClientSession(self.request,
1448
.X509Credentials()))
1450
# Note: gnutls.connection.X509Credentials is really a
1451
# generic GnuTLS certificate credentials object so long as
1452
# no X.509 keys are added to it. Therefore, we can use it
1453
# here despite using OpenPGP certificates.
1455
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1456
# "+AES-256-CBC", "+SHA1",
1457
# "+COMP-NULL", "+CTYPE-OPENPGP",
2209
1459
# Use a fallback default, since this MUST be set.
2210
1460
priority = self.server.gnutls_priority
2211
1461
if priority is None:
2212
1462
priority = "NORMAL"
2213
gnutls.priority_set_direct(session._c_object,
2214
priority.encode("utf-8"),
1463
(gnutls.library.functions
1464
.gnutls_priority_set_direct(session._c_object,
2217
1467
# Start communication using the Mandos protocol
2218
1468
# Get protocol number
2219
1469
line = self.request.makefile().readline()
2220
1470
logger.debug("Protocol version: %r", line)
2222
1472
if int(line.strip().split()[0]) > 1:
2223
raise RuntimeError(line)
2224
1474
except (ValueError, IndexError, RuntimeError) as error:
2225
1475
logger.error("Unknown protocol version: %s", error)
2228
1478
# Start GnuTLS connection
2230
1480
session.handshake()
2231
except gnutls.Error as error:
1481
except gnutls.errors.GNUTLSError as error:
2232
1482
logger.warning("Handshake failed: %s", error)
2233
1483
# Do not run session.bye() here: the session is not
2234
1484
# established. Just abandon the request.
2236
1486
logger.debug("Handshake succeeded")
2238
1488
approval_required = False
2241
fpr = self.fingerprint(
2242
self.peer_certificate(session))
2243
except (TypeError, gnutls.Error) as error:
1491
fpr = self.fingerprint(self.peer_certificate
1494
gnutls.errors.GNUTLSError) as error:
2244
1495
logger.warning("Bad certificate: %s", error)
2246
1497
logger.debug("Fingerprint: %s", fpr)
1498
if self.server.use_dbus:
1500
client.NewRequest(str(self.client_address))
2249
1503
client = ProxyClient(child_pipe, fpr,
2250
1504
self.client_address)
2251
1505
except KeyError:
2254
1508
if client.approval_delay:
2255
1509
delay = client.approval_delay
2256
1510
client.approvals_pending += 1
2257
1511
approval_required = True
2260
1514
if not client.enabled:
2261
1515
logger.info("Client %s is disabled",
2263
1517
if self.server.use_dbus:
2264
1518
# Emit D-Bus signal
2265
1519
client.Rejected("Disabled")
2268
if client.approved or not client.approval_delay:
2269
# We are approved or approval is disabled
1522
if client._approved or not client.approval_delay:
1523
#We are approved or approval is disabled
2271
elif client.approved is None:
1525
elif client._approved is None:
2272
1526
logger.info("Client %s needs approval",
2274
1528
if self.server.use_dbus:
2275
1529
# Emit D-Bus signal
2276
1530
client.NeedApproval(
2277
client.approval_delay.total_seconds()
2278
* 1000, client.approved_by_default)
1531
client.approval_delay_milliseconds(),
1532
client.approved_by_default)
2280
1534
logger.warning("Client %s was not approved",
2305
1561
delay -= time2 - time
2308
session.send(client.secret)
2309
except gnutls.Error as error:
2310
logger.warning("gnutls send failed",
1564
while sent_size < len(client.secret):
1566
sent = session.send(client.secret[sent_size:])
1567
except gnutls.errors.GNUTLSError as error:
1568
logger.warning("gnutls send failed")
1570
logger.debug("Sent: %d, remaining: %d",
1571
sent, len(client.secret)
1572
- (sent_size + sent))
2314
1575
logger.info("Sending secret to %s", client.name)
2315
1576
# bump the timeout using extended_timeout
2316
client.bump_timeout(client.extended_timeout)
1577
client.checked_ok(client.extended_timeout)
2317
1578
if self.server.use_dbus:
2318
1579
# Emit D-Bus signal
2319
1580
client.GotSecret()
2322
1583
if approval_required:
2323
1584
client.approvals_pending -= 1
2326
except gnutls.Error as error:
2327
logger.warning("GnuTLS bye failed",
1587
except gnutls.errors.GNUTLSError as error:
1588
logger.warning("GnuTLS bye failed")
2331
1591
def peer_certificate(session):
2332
1592
"Return the peer's OpenPGP certificate as a bytestring"
2333
1593
# If not an OpenPGP certificate...
2334
if (gnutls.certificate_type_get(session._c_object)
2335
!= gnutls.CRT_OPENPGP):
2336
# ...return invalid data
1594
if (gnutls.library.functions
1595
.gnutls_certificate_type_get(session._c_object)
1596
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1597
# ...do the normal thing
1598
return session.peer_certificate
2338
1599
list_size = ctypes.c_uint(1)
2339
cert_list = (gnutls.certificate_get_peers
1600
cert_list = (gnutls.library.functions
1601
.gnutls_certificate_get_peers
2340
1602
(session._c_object, ctypes.byref(list_size)))
2341
1603
if not bool(cert_list) and list_size.value != 0:
2342
raise gnutls.Error("error getting peer certificate")
1604
raise gnutls.errors.GNUTLSError("error getting peer"
2343
1606
if list_size.value == 0:
2345
1608
cert = cert_list[0]
2346
1609
return ctypes.string_at(cert.data, cert.size)
2349
1612
def fingerprint(openpgp):
2350
1613
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2351
1614
# New GnuTLS "datum" with the OpenPGP public key
2352
datum = gnutls.datum_t(
2353
ctypes.cast(ctypes.c_char_p(openpgp),
2354
ctypes.POINTER(ctypes.c_ubyte)),
2355
ctypes.c_uint(len(openpgp)))
1615
datum = (gnutls.library.types
1616
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1619
ctypes.c_uint(len(openpgp))))
2356
1620
# New empty GnuTLS certificate
2357
crt = gnutls.openpgp_crt_t()
2358
gnutls.openpgp_crt_init(ctypes.byref(crt))
1621
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1622
(gnutls.library.functions
1623
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2359
1624
# Import the OpenPGP public key into the certificate
2360
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2361
gnutls.OPENPGP_FMT_RAW)
1625
(gnutls.library.functions
1626
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1627
gnutls.library.constants
1628
.GNUTLS_OPENPGP_FMT_RAW))
2362
1629
# Verify the self signature in the key
2363
1630
crtverify = ctypes.c_uint()
2364
gnutls.openpgp_crt_verify_self(crt, 0,
2365
ctypes.byref(crtverify))
1631
(gnutls.library.functions
1632
.gnutls_openpgp_crt_verify_self(crt, 0,
1633
ctypes.byref(crtverify)))
2366
1634
if crtverify.value != 0:
2367
gnutls.openpgp_crt_deinit(crt)
2368
raise gnutls.CertificateSecurityError("Verify failed")
1635
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1636
raise (gnutls.errors.CertificateSecurityError
2369
1638
# New buffer for the fingerprint
2370
1639
buf = ctypes.create_string_buffer(20)
2371
1640
buf_len = ctypes.c_size_t()
2372
1641
# Get the fingerprint from the certificate into the buffer
2373
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2374
ctypes.byref(buf_len))
1642
(gnutls.library.functions
1643
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1644
ctypes.byref(buf_len)))
2375
1645
# Deinit the certificate
2376
gnutls.openpgp_crt_deinit(crt)
1646
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2377
1647
# Convert the buffer to a Python bytestring
2378
1648
fpr = ctypes.string_at(buf, buf_len.value)
2379
1649
# Convert the bytestring to hexadecimal notation
2384
1654
class MultiprocessingMixIn(object):
2385
1655
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2387
1656
def sub_process_main(self, request, address):
2389
1658
self.finish_request(request, address)
2391
1660
self.handle_error(request, address)
2392
1661
self.close_request(request)
2394
1663
def process_request(self, request, address):
2395
1664
"""Start a new process to process the request."""
2396
proc = multiprocessing.Process(target=self.sub_process_main,
2397
args=(request, address))
1665
proc = multiprocessing.Process(target = self.sub_process_main,
2402
1672
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2403
1673
""" adds a pipe to the MixIn """
2405
1674
def process_request(self, request, client_address):
2406
1675
"""Overrides and wraps the original process_request().
2408
1677
This function creates a new pipe in self.pipe
2410
1679
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2412
1681
proc = MultiprocessingMixIn.process_request(self, request,
2413
1682
client_address)
2414
1683
self.child_pipe.close()
2415
1684
self.add_pipe(parent_pipe, proc)
2417
1686
def add_pipe(self, parent_pipe, proc):
2418
1687
"""Dummy function; override as necessary"""
2419
raise NotImplementedError()
1688
raise NotImplementedError
2422
1691
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2423
1692
socketserver.TCPServer, object):
2424
1693
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2427
1696
enabled: Boolean; whether this server is activated yet
2428
1697
interface: None or a network interface name (string)
2429
1698
use_ipv6: Boolean; to use IPv6 or not
2432
1700
def __init__(self, server_address, RequestHandlerClass,
2436
"""If socketfd is set, use that file descriptor instead of
2437
creating a new one with socket.socket().
1701
interface=None, use_ipv6=True):
2439
1702
self.interface = interface
2441
1704
self.address_family = socket.AF_INET6
2442
if socketfd is not None:
2443
# Save the file descriptor
2444
self.socketfd = socketfd
2445
# Save the original socket.socket() function
2446
self.socket_socket = socket.socket
2448
# To implement --socket, we monkey patch socket.socket.
2450
# (When socketserver.TCPServer is a new-style class, we
2451
# could make self.socket into a property instead of monkey
2452
# patching socket.socket.)
2454
# Create a one-time-only replacement for socket.socket()
2455
@functools.wraps(socket.socket)
2456
def socket_wrapper(*args, **kwargs):
2457
# Restore original function so subsequent calls are
2459
socket.socket = self.socket_socket
2460
del self.socket_socket
2461
# This time only, return a new socket object from the
2462
# saved file descriptor.
2463
return socket.fromfd(self.socketfd, *args, **kwargs)
2464
# Replace socket.socket() function with wrapper
2465
socket.socket = socket_wrapper
2466
# The socketserver.TCPServer.__init__ will call
2467
# socket.socket(), which might be our replacement,
2468
# socket_wrapper(), if socketfd was set.
2469
1705
socketserver.TCPServer.__init__(self, server_address,
2470
1706
RequestHandlerClass)
2472
1707
def server_bind(self):
2473
1708
"""This overrides the normal server_bind() function
2474
1709
to bind to an interface if one was specified, and also NOT to
2475
1710
bind to an address or port if they were not specified."""
2476
global SO_BINDTODEVICE
2477
1711
if self.interface is not None:
2478
1712
if SO_BINDTODEVICE is None:
2479
# Fall back to a hard-coded value which seems to be
2481
logger.warning("SO_BINDTODEVICE not found, trying 25")
2482
SO_BINDTODEVICE = 25
2484
self.socket.setsockopt(
2485
socket.SOL_SOCKET, SO_BINDTODEVICE,
2486
(self.interface + "\0").encode("utf-8"))
2487
except socket.error as error:
2488
if error.errno == errno.EPERM:
2489
logger.error("No permission to bind to"
2490
" interface %s", self.interface)
2491
elif error.errno == errno.ENOPROTOOPT:
2492
logger.error("SO_BINDTODEVICE not available;"
2493
" cannot bind to interface %s",
2495
elif error.errno == errno.ENODEV:
2496
logger.error("Interface %s does not exist,"
2497
" cannot bind", self.interface)
1713
logger.error("SO_BINDTODEVICE does not exist;"
1714
" cannot bind to interface %s",
1718
self.socket.setsockopt(socket.SOL_SOCKET,
1722
except socket.error as error:
1723
if error[0] == errno.EPERM:
1724
logger.error("No permission to"
1725
" bind to interface %s",
1727
elif error[0] == errno.ENOPROTOOPT:
1728
logger.error("SO_BINDTODEVICE not available;"
1729
" cannot bind to interface %s",
2500
1733
# Only bind(2) the socket if we really need to.
2501
1734
if self.server_address[0] or self.server_address[1]:
2502
1735
if not self.server_address[0]:
2503
1736
if self.address_family == socket.AF_INET6:
2504
any_address = "::" # in6addr_any
1737
any_address = "::" # in6addr_any
2506
any_address = "0.0.0.0" # INADDR_ANY
1739
any_address = socket.INADDR_ANY
2507
1740
self.server_address = (any_address,
2508
1741
self.server_address[1])
2509
1742
elif not self.server_address[1]:
2510
self.server_address = (self.server_address[0], 0)
1743
self.server_address = (self.server_address[0],
2511
1745
# if self.interface:
2512
1746
# self.server_address = (self.server_address[0],
2610
1850
funcname = request[1]
2611
1851
args = request[2]
2612
1852
kwargs = request[3]
2614
1854
parent_pipe.send(('data', getattr(client_object,
2615
1855
funcname)(*args,
2618
1858
if command == 'getattr':
2619
1859
attrname = request[1]
2620
if isinstance(client_object.__getattribute__(attrname),
2621
collections.Callable):
2622
parent_pipe.send(('function', ))
1860
if callable(client_object.__getattribute__(attrname)):
1861
parent_pipe.send(('function',))
2625
'data', client_object.__getattribute__(attrname)))
1863
parent_pipe.send(('data', client_object
1864
.__getattribute__(attrname)))
2627
1866
if command == 'setattr':
2628
1867
attrname = request[1]
2629
1868
value = request[2]
2630
1869
setattr(client_object, attrname, value)
2635
def rfc3339_duration_to_delta(duration):
2636
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2638
>>> rfc3339_duration_to_delta("P7D")
2639
datetime.timedelta(7)
2640
>>> rfc3339_duration_to_delta("PT60S")
2641
datetime.timedelta(0, 60)
2642
>>> rfc3339_duration_to_delta("PT60M")
2643
datetime.timedelta(0, 3600)
2644
>>> rfc3339_duration_to_delta("PT24H")
2645
datetime.timedelta(1)
2646
>>> rfc3339_duration_to_delta("P1W")
2647
datetime.timedelta(7)
2648
>>> rfc3339_duration_to_delta("PT5M30S")
2649
datetime.timedelta(0, 330)
2650
>>> rfc3339_duration_to_delta("P1DT3M20S")
2651
datetime.timedelta(1, 200)
2654
# Parsing an RFC 3339 duration with regular expressions is not
2655
# possible - there would have to be multiple places for the same
2656
# values, like seconds. The current code, while more esoteric, is
2657
# cleaner without depending on a parsing library. If Python had a
2658
# built-in library for parsing we would use it, but we'd like to
2659
# avoid excessive use of external libraries.
2661
# New type for defining tokens, syntax, and semantics all-in-one
2662
Token = collections.namedtuple("Token", (
2663
"regexp", # To match token; if "value" is not None, must have
2664
# a "group" containing digits
2665
"value", # datetime.timedelta or None
2666
"followers")) # Tokens valid after this token
2667
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2668
# the "duration" ABNF definition in RFC 3339, Appendix A.
2669
token_end = Token(re.compile(r"$"), None, frozenset())
2670
token_second = Token(re.compile(r"(\d+)S"),
2671
datetime.timedelta(seconds=1),
2672
frozenset((token_end, )))
2673
token_minute = Token(re.compile(r"(\d+)M"),
2674
datetime.timedelta(minutes=1),
2675
frozenset((token_second, token_end)))
2676
token_hour = Token(re.compile(r"(\d+)H"),
2677
datetime.timedelta(hours=1),
2678
frozenset((token_minute, token_end)))
2679
token_time = Token(re.compile(r"T"),
2681
frozenset((token_hour, token_minute,
2683
token_day = Token(re.compile(r"(\d+)D"),
2684
datetime.timedelta(days=1),
2685
frozenset((token_time, token_end)))
2686
token_month = Token(re.compile(r"(\d+)M"),
2687
datetime.timedelta(weeks=4),
2688
frozenset((token_day, token_end)))
2689
token_year = Token(re.compile(r"(\d+)Y"),
2690
datetime.timedelta(weeks=52),
2691
frozenset((token_month, token_end)))
2692
token_week = Token(re.compile(r"(\d+)W"),
2693
datetime.timedelta(weeks=1),
2694
frozenset((token_end, )))
2695
token_duration = Token(re.compile(r"P"), None,
2696
frozenset((token_year, token_month,
2697
token_day, token_time,
2699
# Define starting values:
2701
value = datetime.timedelta()
2703
# Following valid tokens
2704
followers = frozenset((token_duration, ))
2705
# String left to parse
2707
# Loop until end token is found
2708
while found_token is not token_end:
2709
# Search for any currently valid tokens
2710
for token in followers:
2711
match = token.regexp.match(s)
2712
if match is not None:
2714
if token.value is not None:
2715
# Value found, parse digits
2716
factor = int(match.group(1), 10)
2717
# Add to value so far
2718
value += factor * token.value
2719
# Strip token from string
2720
s = token.regexp.sub("", s, 1)
2723
# Set valid next tokens
2724
followers = found_token.followers
2727
# No currently valid tokens were found
2728
raise ValueError("Invalid RFC 3339 duration: {!r}"
2734
1874
def string_to_delta(interval):
2735
1875
"""Parse a string and return a datetime.timedelta
2737
1877
>>> string_to_delta('7d')
2738
1878
datetime.timedelta(7)
2739
1879
>>> string_to_delta('60s')
2834
1968
parser.add_argument("--no-dbus", action="store_false",
2835
1969
dest="use_dbus", help="Do not provide D-Bus"
2836
" system bus interface", default=None)
1970
" system bus interface")
2837
1971
parser.add_argument("--no-ipv6", action="store_false",
2838
dest="use_ipv6", help="Do not use IPv6",
1972
dest="use_ipv6", help="Do not use IPv6")
2840
1973
parser.add_argument("--no-restore", action="store_false",
2841
1974
dest="restore", help="Do not restore stored"
2842
" state", default=None)
2843
parser.add_argument("--socket", type=int,
2844
help="Specify a file descriptor to a network"
2845
" socket to use instead of creating one")
2846
parser.add_argument("--statedir", metavar="DIR",
2847
help="Directory to save/restore state in")
2848
parser.add_argument("--foreground", action="store_true",
2849
help="Run in foreground", default=None)
2850
parser.add_argument("--no-zeroconf", action="store_false",
2851
dest="zeroconf", help="Do not use Zeroconf",
1975
" state", default=True)
2854
1977
options = parser.parse_args()
2856
1979
if options.check:
2858
fail_count, test_count = doctest.testmod()
2859
sys.exit(os.EX_OK if fail_count == 0 else 1)
2861
1984
# Default values for config file for server-global settings
2862
server_defaults = {"interface": "",
2867
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2868
":+SIGN-DSA-SHA256",
2869
"servicename": "Mandos",
2875
"statedir": "/var/lib/mandos",
2876
"foreground": "False",
1985
server_defaults = { "interface": "",
1990
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1991
"servicename": "Mandos",
2880
1997
# Parse config file for server-global settings
2881
1998
server_config = configparser.SafeConfigParser(server_defaults)
2882
1999
del server_defaults
2883
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2000
server_config.read(os.path.join(options.configdir,
2884
2002
# Convert the SafeConfigParser object to a dict
2885
2003
server_settings = server_config.defaults()
2886
2004
# Use the appropriate methods on the non-string config options
2887
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2888
"foreground", "zeroconf"):
2005
for option in ("debug", "use_dbus", "use_ipv6"):
2889
2006
server_settings[option] = server_config.getboolean("DEFAULT",
2891
2008
if server_settings["port"]:
2892
2009
server_settings["port"] = server_config.getint("DEFAULT",
2894
if server_settings["socket"]:
2895
server_settings["socket"] = server_config.getint("DEFAULT",
2897
# Later, stdin will, and stdout and stderr might, be dup'ed
2898
# over with an opened os.devnull. But we don't want this to
2899
# happen with a supplied network socket.
2900
if 0 <= server_settings["socket"] <= 2:
2901
server_settings["socket"] = os.dup(server_settings
2903
2011
del server_config
2905
2013
# Override the settings from the config file with command line
2906
2014
# options, if set.
2907
2015
for option in ("interface", "address", "port", "debug",
2908
"priority", "servicename", "configdir", "use_dbus",
2909
"use_ipv6", "debuglevel", "restore", "statedir",
2910
"socket", "foreground", "zeroconf"):
2016
"priority", "servicename", "configdir",
2017
"use_dbus", "use_ipv6", "debuglevel", "restore"):
2911
2018
value = getattr(options, option)
2912
2019
if value is not None:
2913
2020
server_settings[option] = value
2915
2022
# Force all strings to be unicode
2916
2023
for option in server_settings.keys():
2917
if isinstance(server_settings[option], bytes):
2918
server_settings[option] = (server_settings[option]
2920
# Force all boolean options to be boolean
2921
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2922
"foreground", "zeroconf"):
2923
server_settings[option] = bool(server_settings[option])
2924
# Debug implies foreground
2925
if server_settings["debug"]:
2926
server_settings["foreground"] = True
2024
if type(server_settings[option]) is str:
2025
server_settings[option] = unicode(server_settings[option])
2927
2026
# Now we have our good server settings in "server_settings"
2929
2028
##################################################################
2931
if (not server_settings["zeroconf"]
2932
and not (server_settings["port"]
2933
or server_settings["socket"] != "")):
2934
parser.error("Needs port or socket to work without Zeroconf")
2936
2030
# For convenience
2937
2031
debug = server_settings["debug"]
2938
2032
debuglevel = server_settings["debuglevel"]
2939
2033
use_dbus = server_settings["use_dbus"]
2940
2034
use_ipv6 = server_settings["use_ipv6"]
2941
stored_state_path = os.path.join(server_settings["statedir"],
2943
foreground = server_settings["foreground"]
2944
zeroconf = server_settings["zeroconf"]
2947
initlogger(debug, logging.DEBUG)
2037
initlogger(logging.DEBUG)
2949
2039
if not debuglevel:
2952
2042
level = getattr(logging, debuglevel.upper())
2953
initlogger(debug, level)
2955
2045
if server_settings["servicename"] != "Mandos":
2956
syslogger.setFormatter(
2957
logging.Formatter('Mandos ({}) [%(process)d]:'
2958
' %(levelname)s: %(message)s'.format(
2959
server_settings["servicename"])))
2046
syslogger.setFormatter(logging.Formatter
2047
('Mandos (%s) [%%(process)d]:'
2048
' %%(levelname)s: %%(message)s'
2049
% server_settings["servicename"]))
2961
2051
# Parse config file with clients
2962
client_config = configparser.SafeConfigParser(Client
2052
client_defaults = { "timeout": "5m",
2053
"extended_timeout": "15m",
2055
"checker": "fping -q -- %%(host)s",
2057
"approval_delay": "0s",
2058
"approval_duration": "1s",
2060
client_config = configparser.SafeConfigParser(client_defaults)
2964
2061
client_config.read(os.path.join(server_settings["configdir"],
2965
2062
"clients.conf"))
2967
2064
global mandos_dbus_service
2968
2065
mandos_dbus_service = None
2971
if server_settings["socket"] != "":
2972
socketfd = server_settings["socket"]
2973
tcp_server = MandosServer(
2974
(server_settings["address"], server_settings["port"]),
2976
interface=(server_settings["interface"] or None),
2978
gnutls_priority=server_settings["priority"],
2982
pidfilename = "/run/mandos.pid"
2983
if not os.path.isdir("/run/."):
2984
pidfilename = "/var/run/mandos.pid"
2987
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2988
except IOError as e:
2989
logger.error("Could not open file %r", pidfilename,
2992
for name, group in (("_mandos", "_mandos"),
2993
("mandos", "mandos"),
2994
("nobody", "nogroup")):
2996
uid = pwd.getpwnam(name).pw_uid
2997
gid = pwd.getpwnam(group).pw_gid
2067
tcp_server = MandosServer((server_settings["address"],
2068
server_settings["port"]),
2070
interface=(server_settings["interface"]
2074
server_settings["priority"],
2077
pidfilename = "/var/run/mandos.pid"
2079
pidfile = open(pidfilename, "w")
2081
logger.error("Could not open file %r", pidfilename)
2084
uid = pwd.getpwnam("_mandos").pw_uid
2085
gid = pwd.getpwnam("_mandos").pw_gid
2088
uid = pwd.getpwnam("mandos").pw_uid
2089
gid = pwd.getpwnam("mandos").pw_gid
2999
2090
except KeyError:
2092
uid = pwd.getpwnam("nobody").pw_uid
2093
gid = pwd.getpwnam("nobody").pw_gid
3008
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3010
2100
except OSError as error:
3011
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3012
.format(uid, gid, os.strerror(error.errno)))
3013
if error.errno != errno.EPERM:
2101
if error[0] != errno.EPERM:
3017
2105
# Enable all possible GnuTLS debugging
3019
2107
# "Use a log level over 10 to enable all debugging options."
3020
2108
# - GnuTLS manual
3021
gnutls.global_set_log_level(11)
2109
gnutls.library.functions.gnutls_global_set_log_level(11)
2111
@gnutls.library.types.gnutls_log_func
3024
2112
def debug_gnutls(level, string):
3025
2113
logger.debug("GnuTLS: %s", string[:-1])
3027
gnutls.global_set_log_function(debug_gnutls)
2115
(gnutls.library.functions
2116
.gnutls_global_set_log_function(debug_gnutls))
3029
2118
# Redirect stdin so all checkers get /dev/null
3030
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2119
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3031
2120
os.dup2(null, sys.stdin.fileno())
2124
# No console logging
2125
logger.removeHandler(console)
3035
2127
# Need to fork before connecting to D-Bus
3037
2129
# Close all input and output, do double fork, etc.
3040
# multiprocessing will use threads, so before we use GLib we need
3041
# to inform GLib that threads will be used.
3044
2132
global main_loop
3045
2133
# From the Avahi example code
3046
DBusGMainLoop(set_as_default=True)
3047
main_loop = GLib.MainLoop()
2134
DBusGMainLoop(set_as_default=True )
2135
main_loop = gobject.MainLoop()
3048
2136
bus = dbus.SystemBus()
3049
2137
# End of Avahi example code
3052
2140
bus_name = dbus.service.BusName("se.recompile.Mandos",
3055
old_bus_name = dbus.service.BusName(
3056
"se.bsnet.fukt.Mandos", bus,
3058
except dbus.exceptions.DBusException as e:
3059
logger.error("Disabling D-Bus:", exc_info=e)
2141
bus, do_not_queue=True)
2142
old_bus_name = (dbus.service.BusName
2143
("se.bsnet.fukt.Mandos", bus,
2145
except dbus.exceptions.NameExistsException as e:
2146
logger.error(unicode(e) + ", disabling D-Bus")
3060
2147
use_dbus = False
3061
2148
server_settings["use_dbus"] = False
3062
2149
tcp_server.use_dbus = False
3064
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3065
service = AvahiServiceToSyslog(
3066
name=server_settings["servicename"],
3067
servicetype="_mandos._tcp",
3070
if server_settings["interface"]:
3071
service.interface = if_nametoindex(
3072
server_settings["interface"].encode("utf-8"))
2150
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2151
service = AvahiServiceToSyslog(name =
2152
server_settings["servicename"],
2153
servicetype = "_mandos._tcp",
2154
protocol = protocol, bus = bus)
2155
if server_settings["interface"]:
2156
service.interface = (if_nametoindex
2157
(str(server_settings["interface"])))
3074
2159
global multiprocessing_manager
3075
2160
multiprocessing_manager = multiprocessing.Manager()
3077
2162
client_class = Client
3079
client_class = functools.partial(ClientDBus, bus=bus)
3081
client_settings = Client.config_parser(client_config)
2164
client_class = functools.partial(ClientDBusTransitional,
2167
special_settings = {
2168
# Some settings need to be accessd by special methods;
2169
# booleans need .getboolean(), etc. Here is a list of them:
2170
"approved_by_default":
2172
client_config.getboolean(section, "approved_by_default"),
2174
# Construct a new dict of client settings of this form:
2175
# { client_name: {setting_name: value, ...}, ...}
2176
# with exceptions for any special settings as defined above
2177
client_settings = dict((clientname,
2180
if setting not in special_settings
2181
else special_settings[setting]
2183
for setting, value in
2184
client_config.items(clientname)))
2185
for clientname in client_config.sections())
3082
2187
old_client_settings = {}
3085
# This is used to redirect stdout and stderr for checker processes
3087
wnull = open(os.devnull, "w") # A writable /dev/null
3088
# Only used if server is running in foreground but not in debug
3090
if debug or not foreground:
3093
2190
# Get client data and settings from last running state.
3094
2191
if server_settings["restore"]:
3096
2193
with open(stored_state_path, "rb") as stored_state:
3097
if sys.version_info.major == 2:
3098
clients_data, old_client_settings = pickle.load(
3101
bytes_clients_data, bytes_old_client_settings = (
3102
pickle.load(stored_state, encoding="bytes"))
3103
# Fix bytes to strings
3106
clients_data = {(key.decode("utf-8")
3107
if isinstance(key, bytes)
3110
bytes_clients_data.items()}
3111
del bytes_clients_data
3112
for key in clients_data:
3113
value = {(k.decode("utf-8")
3114
if isinstance(k, bytes) else k): v
3116
clients_data[key].items()}
3117
clients_data[key] = value
3119
value["client_structure"] = [
3121
if isinstance(s, bytes)
3123
value["client_structure"]]
3125
for k in ("name", "host"):
3126
if isinstance(value[k], bytes):
3127
value[k] = value[k].decode("utf-8")
3128
# old_client_settings
3130
old_client_settings = {
3131
(key.decode("utf-8")
3132
if isinstance(key, bytes)
3135
bytes_old_client_settings.items()}
3136
del bytes_old_client_settings
3138
for value in old_client_settings.values():
3139
if isinstance(value["host"], bytes):
3140
value["host"] = (value["host"]
2194
clients_data, old_client_settings = (pickle.load
3142
2196
os.remove(stored_state_path)
3143
2197
except IOError as e:
3144
if e.errno == errno.ENOENT:
3145
logger.warning("Could not load persistent state:"
3146
" {}".format(os.strerror(e.errno)))
3148
logger.critical("Could not load persistent state:",
2198
logger.warning("Could not load persistent state: {0}"
2200
if e.errno != errno.ENOENT:
3151
except EOFError as e:
3152
logger.warning("Could not load persistent state: "
3156
with PGPEngine() as pgp:
3157
for client_name, client in clients_data.items():
3158
# Skip removed clients
3159
if client_name not in client_settings:
2203
with Crypto() as crypt:
2204
for client in clients_data:
2205
client_name = client["name"]
3162
2207
# Decide which value to use after restoring saved state.
3163
2208
# We have three different values: Old config file,
3164
2209
# new config file, and saved state.
3169
2214
# For each value in new config, check if it
3170
2215
# differs from the old config value (Except for
3171
2216
# the "secret" attribute)
3172
if (name != "secret"
3174
old_client_settings[client_name][name])):
3175
client[name] = value
2217
if (name != "secret" and
2218
value != old_client_settings[client_name]
2220
setattr(client, name, value)
3176
2221
except KeyError:
3179
2224
# Clients who has passed its expire date can still be
3180
# enabled if its last checker was successful. A Client
3181
# whose checker succeeded before we stored its state is
3182
# assumed to have successfully run all checkers during
3184
if client["enabled"]:
3185
if datetime.datetime.utcnow() >= client["expires"]:
3186
if not client["last_checked_ok"]:
3188
"disabling client {} - Client never "
3189
"performed a successful checker".format(
3191
client["enabled"] = False
3192
elif client["last_checker_status"] != 0:
3194
"disabling client {} - Client last"
3195
" checker failed with error code"
3198
client["last_checker_status"]))
2225
# enabled if its last checker was sucessful. Clients
2226
# whose checker failed before we stored its state is
2227
# assumed to have failed all checkers during downtime.
2228
if client["enabled"] and client["last_checked_ok"]:
2229
if ((datetime.datetime.utcnow()
2230
- client["last_checked_ok"])
2231
> client["interval"]):
2232
if client["last_checker_status"] != 0:
3199
2233
client["enabled"] = False
3201
client["expires"] = (
3202
datetime.datetime.utcnow()
3203
+ client["timeout"])
3204
logger.debug("Last checker succeeded,"
3205
" keeping {} enabled".format(
2235
client["expires"] = (datetime.datetime
2237
+ client["timeout"])
2239
client["changedstate"] = (multiprocessing_manager
2241
(multiprocessing_manager
2244
new_client = (ClientDBusTransitional.__new__
2245
(ClientDBusTransitional))
2246
tcp_server.clients[client_name] = new_client
2247
new_client.bus = bus
2248
for name, value in client.iteritems():
2249
setattr(new_client, name, value)
2250
client_object_name = unicode(client_name).translate(
2251
{ord("."): ord("_"),
2252
ord("-"): ord("_")})
2253
new_client.dbus_object_path = (dbus.ObjectPath
2255
+ client_object_name))
2256
DBusObjectWithProperties.__init__(new_client,
2261
tcp_server.clients[client_name] = (Client.__new__
2263
for name, value in client.iteritems():
2264
setattr(tcp_server.clients[client_name],
3208
client["secret"] = pgp.decrypt(
3209
client["encrypted_secret"],
2268
tcp_server.clients[client_name].secret = (
2269
crypt.decrypt(tcp_server.clients[client_name]
2271
client_settings[client_name]
2274
# If decryption fails, we use secret from new settings
2275
tcp_server.clients[client_name].secret = (
3210
2276
client_settings[client_name]["secret"])
3212
# If decryption fails, we use secret from new settings
3213
logger.debug("Failed to decrypt {} old secret".format(
3215
client["secret"] = (client_settings[client_name]
3218
# Add/remove clients based on new changes made to config
3219
for client_name in (set(old_client_settings)
3220
- set(client_settings)):
3221
del clients_data[client_name]
3222
for client_name in (set(client_settings)
3223
- set(old_client_settings)):
3224
clients_data[client_name] = client_settings[client_name]
3226
# Create all client objects
3227
for client_name, client in clients_data.items():
3228
tcp_server.clients[client_name] = client_class(
3231
server_settings=server_settings)
2278
# Create/remove clients based on new changes made to config
2279
for clientname in set(old_client_settings) - set(client_settings):
2280
del tcp_server.clients[clientname]
2281
for clientname in set(client_settings) - set(old_client_settings):
2282
tcp_server.clients[clientname] = (client_class(name
3233
2288
if not tcp_server.clients:
3234
2289
logger.warning("No clients defined")
3237
if pidfile is not None:
3241
print(pid, file=pidfile)
3243
logger.error("Could not write to file %r with PID %d",
2295
pidfile.write(str(pid) + "\n".encode("utf-8"))
2298
logger.error("Could not write to file %r with PID %d",
2301
# "pidfile" was never created
3246
2303
del pidfilename
3248
for termsig in (signal.SIGHUP, signal.SIGTERM):
3249
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3250
lambda: main_loop.quit() and False)
2305
signal.signal(signal.SIGINT, signal.SIG_IGN)
2307
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2308
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3254
@alternate_dbus_interfaces(
3255
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3256
class MandosDBusService(DBusObjectWithObjectManager):
2311
class MandosDBusService(dbus.service.Object):
3257
2312
"""A D-Bus proxy object"""
3259
2313
def __init__(self):
3260
2314
dbus.service.Object.__init__(self, bus, "/")
3262
2315
_interface = "se.recompile.Mandos"
3264
2317
@dbus.service.signal(_interface, signature="o")
3265
2318
def ClientAdded(self, objpath):
3269
2322
@dbus.service.signal(_interface, signature="ss")
3270
2323
def ClientNotFound(self, fingerprint, address):
3274
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3276
2327
@dbus.service.signal(_interface, signature="os")
3277
2328
def ClientRemoved(self, objpath, name):
3281
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3283
2332
@dbus.service.method(_interface, out_signature="ao")
3284
2333
def GetAllClients(self):
3286
return dbus.Array(c.dbus_object_path for c in
3287
tcp_server.clients.values())
3289
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2335
return dbus.Array(c.dbus_object_path
2337
tcp_server.clients.itervalues())
3291
2339
@dbus.service.method(_interface,
3292
2340
out_signature="a{oa{sv}}")
3293
2341
def GetAllClientsWithProperties(self):
3295
2343
return dbus.Dictionary(
3296
{c.dbus_object_path: c.GetAll(
3297
"se.recompile.Mandos.Client")
3298
for c in tcp_server.clients.values()},
2344
((c.dbus_object_path, c.GetAll(""))
2345
for c in tcp_server.clients.itervalues()),
3299
2346
signature="oa{sv}")
3301
2348
@dbus.service.method(_interface, in_signature="o")
3302
2349
def RemoveClient(self, object_path):
3304
for c in tcp_server.clients.values():
2351
for c in tcp_server.clients.itervalues():
3305
2352
if c.dbus_object_path == object_path:
3306
2353
del tcp_server.clients[c.name]
3307
2354
c.remove_from_connection()
3308
# Don't signal the disabling
2355
# Don't signal anything except ClientRemoved
3309
2356
c.disable(quiet=True)
3310
# Emit D-Bus signal for removal
3311
self.client_removed_signal(c)
2358
self.ClientRemoved(object_path, c.name)
3313
2360
raise KeyError(object_path)
3317
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3318
out_signature="a{oa{sa{sv}}}")
3319
def GetManagedObjects(self):
3321
return dbus.Dictionary(
3322
{client.dbus_object_path:
3324
{interface: client.GetAll(interface)
3326
client._get_all_interface_names()})
3327
for client in tcp_server.clients.values()})
3329
def client_added_signal(self, client):
3330
"""Send the new standard signal and the old signal"""
3332
# New standard signal
3333
self.InterfacesAdded(
3334
client.dbus_object_path,
3336
{interface: client.GetAll(interface)
3338
client._get_all_interface_names()}))
3340
self.ClientAdded(client.dbus_object_path)
3342
def client_removed_signal(self, client):
3343
"""Send the new standard signal and the old signal"""
3345
# New standard signal
3346
self.InterfacesRemoved(
3347
client.dbus_object_path,
3348
client._get_all_interface_names())
3350
self.ClientRemoved(client.dbus_object_path,
3353
mandos_dbus_service = MandosDBusService()
3355
# Save modules to variables to exempt the modules from being
3356
# unloaded before the function registered with atexit() is run.
3357
mp = multiprocessing
2364
class MandosDBusServiceTransitional(MandosDBusService):
2365
__metaclass__ = AlternateDBusNamesMetaclass
2366
mandos_dbus_service = MandosDBusServiceTransitional()
3361
2369
"Cleanup function; run on exit"
3365
mp.active_children()
2372
multiprocessing.active_children()
3367
2373
if not (tcp_server.clients or client_settings):
3370
2376
# Store client before exiting. Secrets are encrypted with key
3371
2377
# based on what config file has. If config file is
3372
2378
# removed/edited, old secret will thus be unrecovable.
3374
with PGPEngine() as pgp:
3375
for client in tcp_server.clients.values():
2380
with Crypto() as crypt:
2381
for client in tcp_server.clients.itervalues():
3376
2382
key = client_settings[client.name]["secret"]
3377
client.encrypted_secret = pgp.encrypt(client.secret,
2383
client.encrypted_secret = crypt.encrypt(client.secret,
3379
2385
client_dict = {}
3381
# A list of attributes that can not be pickled
3383
exclude = {"bus", "changedstate", "secret",
3384
"checker", "server_settings"}
3385
for name, typ in inspect.getmembers(dbus.service
2387
# A list of attributes that will not be stored when
2389
exclude = set(("bus", "changedstate", "secret"))
2390
for name, typ in (inspect.getmembers
2391
(dbus.service.Object)):
3387
2392
exclude.add(name)
3389
2394
client_dict["encrypted_secret"] = (client
3390
2395
.encrypted_secret)
3391
2396
for attr in client.client_structure:
3392
2397
if attr not in exclude:
3393
2398
client_dict[attr] = getattr(client, attr)
3395
clients[client.name] = client_dict
2400
clients.append(client_dict)
3396
2401
del client_settings[client.name]["secret"]
3399
with tempfile.NamedTemporaryFile(
3403
dir=os.path.dirname(stored_state_path),
3404
delete=False) as stored_state:
3405
pickle.dump((clients, client_settings), stored_state,
3407
tempname = stored_state.name
3408
os.rename(tempname, stored_state_path)
2404
with os.fdopen(os.open(stored_state_path,
2405
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2406
0600), "wb") as stored_state:
2407
pickle.dump((clients, client_settings), stored_state)
3409
2408
except (IOError, OSError) as e:
3415
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3416
logger.warning("Could not save persistent state: {}"
3417
.format(os.strerror(e.errno)))
3419
logger.warning("Could not save persistent state:",
2409
logger.warning("Could not save persistent state: {0}"
2411
if e.errno not in (errno.ENOENT, errno.EACCES):
3423
2414
# Delete all clients, and settings from config
3424
2415
while tcp_server.clients:
3425
2416
name, client = tcp_server.clients.popitem()
3427
2418
client.remove_from_connection()
3428
# Don't signal the disabling
2419
# Don't signal anything except ClientRemoved
3429
2420
client.disable(quiet=True)
3430
# Emit D-Bus signal for removal
3432
mandos_dbus_service.client_removed_signal(client)
2423
mandos_dbus_service.ClientRemoved(client
3433
2426
client_settings.clear()
3435
2428
atexit.register(cleanup)
3437
for client in tcp_server.clients.values():
2430
for client in tcp_server.clients.itervalues():
3439
# Emit D-Bus signal for adding
3440
mandos_dbus_service.client_added_signal(client)
2433
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3441
2434
# Need to initiate checking of clients
3442
2435
if client.enabled:
3443
2436
client.init_checker()
3445
2438
tcp_server.enable()
3446
2439
tcp_server.server_activate()
3448
2441
# Find out what port we got
3450
service.port = tcp_server.socket.getsockname()[1]
2442
service.port = tcp_server.socket.getsockname()[1]
3452
2444
logger.info("Now listening on address %r, port %d,"
3453
" flowinfo %d, scope_id %d",
3454
*tcp_server.socket.getsockname())
2445
" flowinfo %d, scope_id %d"
2446
% tcp_server.socket.getsockname())
3456
logger.info("Now listening on address %r, port %d",
3457
*tcp_server.socket.getsockname())
3459
# service.interface = tcp_server.socket.getsockname()[3]
2448
logger.info("Now listening on address %r, port %d"
2449
% tcp_server.socket.getsockname())
2451
#service.interface = tcp_server.socket.getsockname()[3]
3463
# From the Avahi example code
3466
except dbus.exceptions.DBusException as error:
3467
logger.critical("D-Bus Exception", exc_info=error)
3470
# End of Avahi example code
3472
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3473
lambda *args, **kwargs:
3474
(tcp_server.handle_request
3475
(*args[2:], **kwargs) or True))
2454
# From the Avahi example code
2457
except dbus.exceptions.DBusException as error:
2458
logger.critical("DBusException: %s", error)
2461
# End of Avahi example code
2463
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2464
lambda *args, **kwargs:
2465
(tcp_server.handle_request
2466
(*args[2:], **kwargs) or True))
3477
2468
logger.debug("Starting main loop")
3478
2469
main_loop.run()
3479
2470
except AvahiError as error:
3480
logger.critical("Avahi Error", exc_info=error)
2471
logger.critical("AvahiError: %s", error)
3483
2474
except KeyboardInterrupt: