70
import cPickle as pickle
63
import cPickle as pickle
73
64
import multiprocessing
85
70
import dbus.service
87
from gi.repository import GLib
88
73
from dbus.mainloop.glib import DBusGMainLoop
91
76
import xml.dom.minidom
94
if sys.version_info.major == 2:
98
# Add collections.abc.Callable if it does not exist
100
collections.abc.Callable
101
except AttributeError:
103
Callable = collections.Callable
104
collections.abc = abc
107
# Add shlex.quote if it does not exist
110
except AttributeError:
111
shlex.quote = re.escape
113
# Show warnings by default
114
if not sys.warnoptions:
116
warnings.simplefilter("default")
118
# Try to find the value of SO_BINDTODEVICE:
120
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
121
# newer, and it is also the most natural place for it:
122
81
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
123
82
except AttributeError:
125
# This is where SO_BINDTODEVICE was up to and including Python
127
84
from IN import SO_BINDTODEVICE
128
85
except ImportError:
129
# In Python 2.7 it seems to have been removed entirely.
130
# Try running the C preprocessor:
132
cc = subprocess.Popen(["cc", "--language=c", "-E",
134
stdin=subprocess.PIPE,
135
stdout=subprocess.PIPE)
136
stdout = cc.communicate(
137
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
138
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
139
except (OSError, ValueError, IndexError):
141
SO_BINDTODEVICE = None
143
if sys.version_info < (3, 2):
144
configparser.Configparser = configparser.SafeConfigParser
86
SO_BINDTODEVICE = None
147
89
stored_state_file = "clients.pickle"
149
91
logger = logging.getLogger()
150
logging.captureWarnings(True) # Show warnings via the logging system
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
154
if_nametoindex = ctypes.cdll.LoadLibrary(
155
ctypes.util.find_library("c")).if_nametoindex
97
if_nametoindex = (ctypes.cdll.LoadLibrary
98
(ctypes.util.find_library("c"))
156
100
except (OSError, AttributeError):
158
101
def if_nametoindex(interface):
159
102
"Get an interface index the hard way, i.e. using fcntl()"
160
103
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
161
104
with contextlib.closing(socket.socket()) as s:
162
105
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
163
struct.pack(b"16s16x", interface))
164
interface_index = struct.unpack("I", ifreq[16:20])[0]
106
struct.pack(str("16s16x"),
108
interface_index = struct.unpack(str("I"),
165
110
return interface_index
168
def copy_function(func):
169
"""Make a copy of a function"""
170
if sys.version_info.major == 2:
171
return types.FunctionType(func.func_code,
177
return types.FunctionType(func.__code__,
184
113
def initlogger(debug, level=logging.WARNING):
185
114
"""init logger and add loglevel"""
188
syslogger = (logging.handlers.SysLogHandler(
189
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
191
116
syslogger.setFormatter(logging.Formatter
192
117
('Mandos [%(process)d]: %(levelname)s:'
194
119
logger.addHandler(syslogger)
197
122
console = logging.StreamHandler()
198
123
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
255
168
os.rmdir(self.tempdir)
256
169
self.tempdir = None
258
171
def password_encode(self, password):
259
172
# Passphrase can not be empty and can not contain newlines or
260
173
# NUL bytes. So we prefix it and hex encode it.
261
encoded = b"mandos" + binascii.hexlify(password)
262
if len(encoded) > 2048:
263
# GnuPG can't handle long passwords, so encode differently
264
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
265
.replace(b"\n", b"\\n")
266
.replace(b"\0", b"\\x00"))
174
return b"mandos" + binascii.hexlify(password)
269
176
def encrypt(self, data, password):
270
passphrase = self.password_encode(password)
271
with tempfile.NamedTemporaryFile(
272
dir=self.tempdir) as passfile:
273
passfile.write(passphrase)
275
proc = subprocess.Popen([self.gpg, '--symmetric',
279
stdin=subprocess.PIPE,
280
stdout=subprocess.PIPE,
281
stderr=subprocess.PIPE)
282
ciphertext, err = proc.communicate(input=data)
283
if proc.returncode != 0:
177
self.gnupg.passphrase = self.password_encode(password)
178
with open(os.devnull) as devnull:
180
proc = self.gnupg.run(['--symmetric'],
181
create_fhs=['stdin', 'stdout'],
182
attach_fhs={'stderr': devnull})
183
with contextlib.closing(proc.handles['stdin']) as f:
185
with contextlib.closing(proc.handles['stdout']) as f:
186
ciphertext = f.read()
190
self.gnupg.passphrase = None
285
191
return ciphertext
287
193
def decrypt(self, data, password):
288
passphrase = self.password_encode(password)
289
with tempfile.NamedTemporaryFile(
290
dir=self.tempdir) as passfile:
291
passfile.write(passphrase)
293
proc = subprocess.Popen([self.gpg, '--decrypt',
297
stdin=subprocess.PIPE,
298
stdout=subprocess.PIPE,
299
stderr=subprocess.PIPE)
300
decrypted_plaintext, err = proc.communicate(input=data)
301
if proc.returncode != 0:
194
self.gnupg.passphrase = self.password_encode(password)
195
with open(os.devnull) as devnull:
197
proc = self.gnupg.run(['--decrypt'],
198
create_fhs=['stdin', 'stdout'],
199
attach_fhs={'stderr': devnull})
200
with contextlib.closing(proc.handles['stdin'] ) as f:
202
with contextlib.closing(proc.handles['stdout']) as f:
203
decrypted_plaintext = f.read()
207
self.gnupg.passphrase = None
303
208
return decrypted_plaintext
306
# Pretend that we have an Avahi module
308
"""This isn't so much a class as it is a module-like namespace."""
309
IF_UNSPEC = -1 # avahi-common/address.h
310
PROTO_UNSPEC = -1 # avahi-common/address.h
311
PROTO_INET = 0 # avahi-common/address.h
312
PROTO_INET6 = 1 # avahi-common/address.h
313
DBUS_NAME = "org.freedesktop.Avahi"
314
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
315
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
316
DBUS_PATH_SERVER = "/"
319
def string_array_to_txt_array(t):
320
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
321
for s in t), signature="ay")
322
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
323
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
324
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
325
SERVER_INVALID = 0 # avahi-common/defs.h
326
SERVER_REGISTERING = 1 # avahi-common/defs.h
327
SERVER_RUNNING = 2 # avahi-common/defs.h
328
SERVER_COLLISION = 3 # avahi-common/defs.h
329
SERVER_FAILURE = 4 # avahi-common/defs.h
332
212
class AvahiError(Exception):
333
213
def __init__(self, value, *args, **kwargs):
334
214
self.value = value
335
return super(AvahiError, self).__init__(value, *args,
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
339
219
class AvahiServiceError(AvahiError):
343
222
class AvahiGroupError(AvahiError):
226
class AvahiService(object):
348
227
"""An Avahi (Zeroconf) service.
351
230
interface: integer; avahi.IF_UNSPEC or an interface index.
352
231
Used to optionally bind to the specified interface.
353
232
name: string; Example: 'Mandos'
354
233
type: string; Example: '_mandos._tcp'.
355
See <https://www.iana.org/assignments/service-names-port-numbers>
234
See <http://www.dns-sd.org/ServiceTypes.html>
356
235
port: integer; what port to announce
357
236
TXT: list of strings; TXT record for the service
358
237
domain: string; Domain to publish on, default to .local if empty.
517
366
follow_name_owner_changes=True),
518
367
avahi.DBUS_INTERFACE_SERVER)
519
368
self.server.connect_to_signal("StateChanged",
520
self.server_state_changed)
369
self.server_state_changed)
521
370
self.server_state_changed(self.server.GetState())
524
372
class AvahiServiceToSyslog(AvahiService):
525
def rename(self, *args, **kwargs):
526
374
"""Add the new name to the syslog messages"""
527
ret = super(AvahiServiceToSyslog, self).rename(*args,
529
syslogger.setFormatter(logging.Formatter(
530
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
375
ret = AvahiService.rename(self)
376
syslogger.setFormatter(logging.Formatter
377
('Mandos (%s) [%%(process)d]:'
378
' %%(levelname)s: %%(message)s'
535
# Pretend that we have a GnuTLS module
537
"""This isn't so much a class as it is a module-like namespace."""
539
library = ctypes.util.find_library("gnutls")
541
library = ctypes.util.find_library("gnutls-deb0")
542
_library = ctypes.cdll.LoadLibrary(library)
545
# Unless otherwise indicated, the constants and types below are
546
# all from the gnutls/gnutls.h C header file.
557
E_NO_CERTIFICATE_FOUND = -49
562
KEYID_USE_SHA256 = 1 # gnutls/x509.h
563
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
566
class session_int(ctypes.Structure):
568
session_t = ctypes.POINTER(session_int)
570
class certificate_credentials_st(ctypes.Structure):
572
certificate_credentials_t = ctypes.POINTER(
573
certificate_credentials_st)
574
certificate_type_t = ctypes.c_int
576
class datum_t(ctypes.Structure):
577
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
578
('size', ctypes.c_uint)]
580
class openpgp_crt_int(ctypes.Structure):
582
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
583
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
584
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
585
credentials_type_t = ctypes.c_int
586
transport_ptr_t = ctypes.c_void_p
587
close_request_t = ctypes.c_int
590
class Error(Exception):
591
def __init__(self, message=None, code=None, args=()):
592
# Default usage is by a message string, but if a return
593
# code is passed, convert it to a string with
596
if message is None and code is not None:
597
message = gnutls.strerror(code)
598
return super(gnutls.Error, self).__init__(
601
class CertificateSecurityError(Error):
607
self._c_object = gnutls.certificate_credentials_t()
608
gnutls.certificate_allocate_credentials(
609
ctypes.byref(self._c_object))
610
self.type = gnutls.CRD_CERTIFICATE
613
gnutls.certificate_free_credentials(self._c_object)
616
def __init__(self, socket, credentials=None):
617
self._c_object = gnutls.session_t()
618
gnutls_flags = gnutls.CLIENT
619
if gnutls.check_version(b"3.5.6"):
620
gnutls_flags |= gnutls.NO_TICKETS
622
gnutls_flags |= gnutls.ENABLE_RAWPK
623
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
625
gnutls.set_default_priority(self._c_object)
626
gnutls.transport_set_ptr(self._c_object, socket.fileno())
627
gnutls.handshake_set_private_extensions(self._c_object,
630
if credentials is None:
631
credentials = gnutls.Credentials()
632
gnutls.credentials_set(self._c_object, credentials.type,
633
ctypes.cast(credentials._c_object,
635
self.credentials = credentials
638
gnutls.deinit(self._c_object)
641
return gnutls.handshake(self._c_object)
643
def send(self, data):
647
data_len -= gnutls.record_send(self._c_object,
652
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
654
# Error handling functions
655
def _error_code(result):
656
"""A function to raise exceptions on errors, suitable
657
for the 'restype' attribute on ctypes functions"""
660
if result == gnutls.E_NO_CERTIFICATE_FOUND:
661
raise gnutls.CertificateSecurityError(code=result)
662
raise gnutls.Error(code=result)
664
def _retry_on_error(result, func, arguments):
665
"""A function to retry on some errors, suitable
666
for the 'errcheck' attribute on ctypes functions"""
668
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
669
return _error_code(result)
670
result = func(*arguments)
673
# Unless otherwise indicated, the function declarations below are
674
# all from the gnutls/gnutls.h C header file.
677
priority_set_direct = _library.gnutls_priority_set_direct
678
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
679
ctypes.POINTER(ctypes.c_char_p)]
680
priority_set_direct.restype = _error_code
682
init = _library.gnutls_init
683
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
684
init.restype = _error_code
686
set_default_priority = _library.gnutls_set_default_priority
687
set_default_priority.argtypes = [session_t]
688
set_default_priority.restype = _error_code
690
record_send = _library.gnutls_record_send
691
record_send.argtypes = [session_t, ctypes.c_void_p,
693
record_send.restype = ctypes.c_ssize_t
694
record_send.errcheck = _retry_on_error
696
certificate_allocate_credentials = (
697
_library.gnutls_certificate_allocate_credentials)
698
certificate_allocate_credentials.argtypes = [
699
ctypes.POINTER(certificate_credentials_t)]
700
certificate_allocate_credentials.restype = _error_code
702
certificate_free_credentials = (
703
_library.gnutls_certificate_free_credentials)
704
certificate_free_credentials.argtypes = [
705
certificate_credentials_t]
706
certificate_free_credentials.restype = None
708
handshake_set_private_extensions = (
709
_library.gnutls_handshake_set_private_extensions)
710
handshake_set_private_extensions.argtypes = [session_t,
712
handshake_set_private_extensions.restype = None
714
credentials_set = _library.gnutls_credentials_set
715
credentials_set.argtypes = [session_t, credentials_type_t,
717
credentials_set.restype = _error_code
719
strerror = _library.gnutls_strerror
720
strerror.argtypes = [ctypes.c_int]
721
strerror.restype = ctypes.c_char_p
723
certificate_type_get = _library.gnutls_certificate_type_get
724
certificate_type_get.argtypes = [session_t]
725
certificate_type_get.restype = _error_code
727
certificate_get_peers = _library.gnutls_certificate_get_peers
728
certificate_get_peers.argtypes = [session_t,
729
ctypes.POINTER(ctypes.c_uint)]
730
certificate_get_peers.restype = ctypes.POINTER(datum_t)
732
global_set_log_level = _library.gnutls_global_set_log_level
733
global_set_log_level.argtypes = [ctypes.c_int]
734
global_set_log_level.restype = None
736
global_set_log_function = _library.gnutls_global_set_log_function
737
global_set_log_function.argtypes = [log_func]
738
global_set_log_function.restype = None
740
deinit = _library.gnutls_deinit
741
deinit.argtypes = [session_t]
742
deinit.restype = None
744
handshake = _library.gnutls_handshake
745
handshake.argtypes = [session_t]
746
handshake.restype = _error_code
747
handshake.errcheck = _retry_on_error
749
transport_set_ptr = _library.gnutls_transport_set_ptr
750
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
751
transport_set_ptr.restype = None
753
bye = _library.gnutls_bye
754
bye.argtypes = [session_t, close_request_t]
755
bye.restype = _error_code
756
bye.errcheck = _retry_on_error
758
check_version = _library.gnutls_check_version
759
check_version.argtypes = [ctypes.c_char_p]
760
check_version.restype = ctypes.c_char_p
762
_need_version = b"3.3.0"
763
if check_version(_need_version) is None:
764
raise self.Error("Needs GnuTLS {} or later"
765
.format(_need_version))
767
_tls_rawpk_version = b"3.6.6"
768
has_rawpk = bool(check_version(_tls_rawpk_version))
772
class pubkey_st(ctypes.Structure):
774
pubkey_t = ctypes.POINTER(pubkey_st)
776
x509_crt_fmt_t = ctypes.c_int
778
# All the function declarations below are from
780
pubkey_init = _library.gnutls_pubkey_init
781
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
782
pubkey_init.restype = _error_code
784
pubkey_import = _library.gnutls_pubkey_import
785
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
787
pubkey_import.restype = _error_code
789
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
790
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
791
ctypes.POINTER(ctypes.c_ubyte),
792
ctypes.POINTER(ctypes.c_size_t)]
793
pubkey_get_key_id.restype = _error_code
795
pubkey_deinit = _library.gnutls_pubkey_deinit
796
pubkey_deinit.argtypes = [pubkey_t]
797
pubkey_deinit.restype = None
799
# All the function declarations below are from
802
openpgp_crt_init = _library.gnutls_openpgp_crt_init
803
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
804
openpgp_crt_init.restype = _error_code
806
openpgp_crt_import = _library.gnutls_openpgp_crt_import
807
openpgp_crt_import.argtypes = [openpgp_crt_t,
808
ctypes.POINTER(datum_t),
810
openpgp_crt_import.restype = _error_code
812
openpgp_crt_verify_self = \
813
_library.gnutls_openpgp_crt_verify_self
814
openpgp_crt_verify_self.argtypes = [
817
ctypes.POINTER(ctypes.c_uint),
819
openpgp_crt_verify_self.restype = _error_code
821
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
822
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
823
openpgp_crt_deinit.restype = None
825
openpgp_crt_get_fingerprint = (
826
_library.gnutls_openpgp_crt_get_fingerprint)
827
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
831
openpgp_crt_get_fingerprint.restype = _error_code
833
if check_version(b"3.6.4"):
834
certificate_type_get2 = _library.gnutls_certificate_type_get2
835
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
836
certificate_type_get2.restype = _error_code
838
# Remove non-public functions
839
del _error_code, _retry_on_error
842
def call_pipe(connection, # : multiprocessing.Connection
843
func, *args, **kwargs):
844
"""This function is meant to be called by multiprocessing.Process
846
This function runs func(*args, **kwargs), and writes the resulting
847
return value on the provided multiprocessing.Connection.
849
connection.send(func(*args, **kwargs))
382
def timedelta_to_milliseconds(td):
383
"Convert a datetime.timedelta() to milliseconds"
384
return ((td.days * 24 * 60 * 60 * 1000)
385
+ (td.seconds * 1000)
386
+ (td.microseconds // 1000))
388
class Client(object):
854
389
"""A representation of a client host served by this server.
857
392
approved: bool(); 'None' if not yet approved/disapproved
858
393
approval_delay: datetime.timedelta(); Time to wait for approval
859
394
approval_duration: datetime.timedelta(); Duration of one approval
860
checker: multiprocessing.Process(); a running checker process used
861
to see if the client lives. 'None' if no process is
863
checker_callback_tag: a GLib event source tag, or None
395
checker: subprocess.Popen(); a running checker process used
396
to see if the client lives.
397
'None' if no process is running.
398
checker_callback_tag: a gobject event source tag, or None
864
399
checker_command: string; External command which is run to check
865
400
if client lives. %() expansions are done at
866
401
runtime with vars(self) as dict, so that for
867
402
instance %(name)s can be used in the command.
868
checker_initiator_tag: a GLib event source tag, or None
403
checker_initiator_tag: a gobject event source tag, or None
869
404
created: datetime.datetime(); (UTC) object creation
870
405
client_structure: Object describing what attributes a client has
871
406
and is used for storing the client at exit
872
407
current_checker_command: string; current running checker_command
873
disable_initiator_tag: a GLib event source tag, or None
408
disable_initiator_tag: a gobject event source tag, or None
875
410
fingerprint: string (40 or 32 hexadecimal digits); used to
876
uniquely identify an OpenPGP client
877
key_id: string (64 hexadecimal digits); used to uniquely identify
878
a client using raw public keys
411
uniquely identify the client
879
412
host: string; available for use by the checker command
880
413
interval: datetime.timedelta(); How often to start a new checker
881
414
last_approval_request: datetime.datetime(); (UTC) or None
882
415
last_checked_ok: datetime.datetime(); (UTC) or None
883
416
last_checker_status: integer between 0 and 255 reflecting exit
884
417
status of last checker. -1 reflects crashed
885
checker, -2 means no checker completed yet.
886
last_checker_signal: The signal which killed the last checker, if
887
last_checker_status is -1
888
419
last_enabled: datetime.datetime(); (UTC) or None
889
420
name: string; from the config file, used in log messages and
890
421
D-Bus identifiers
891
422
secret: bytestring; sent verbatim (over TLS) to client
892
423
timeout: datetime.timedelta(); How long from last_checked_ok
893
424
until this client is disabled
894
extended_timeout: extra long timeout when secret has been sent
425
extended_timeout: extra long timeout when password has been sent
895
426
runtime_expansions: Allowed attributes for runtime expansion.
896
427
expires: datetime.datetime(); time (UTC) when a client will be
897
428
disabled, or None
898
server_settings: The server_settings dict from main()
901
431
runtime_expansions = ("approval_delay", "approval_duration",
902
"created", "enabled", "expires", "key_id",
903
"fingerprint", "host", "interval",
904
"last_approval_request", "last_checked_ok",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
905
434
"last_enabled", "name", "timeout")
908
"extended_timeout": "PT15M",
910
"checker": "fping -q -- %%(host)s",
912
"approval_delay": "PT0S",
913
"approval_duration": "PT1S",
914
"approved_by_default": "True",
435
client_defaults = { "timeout": "5m",
436
"extended_timeout": "15m",
438
"checker": "fping -q -- %%(host)s",
440
"approval_delay": "0s",
441
"approval_duration": "1s",
442
"approved_by_default": "True",
446
def timeout_milliseconds(self):
447
"Return the 'timeout' attribute in milliseconds"
448
return timedelta_to_milliseconds(self.timeout)
450
def extended_timeout_milliseconds(self):
451
"Return the 'extended_timeout' attribute in milliseconds"
452
return timedelta_to_milliseconds(self.extended_timeout)
454
def interval_milliseconds(self):
455
"Return the 'interval' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.interval)
458
def approval_delay_milliseconds(self):
459
return timedelta_to_milliseconds(self.approval_delay)
919
462
def config_parser(config):
1002
541
self.current_checker_command = None
1003
542
self.approved = None
1004
543
self.approvals_pending = 0
1005
self.changedstate = multiprocessing_manager.Condition(
1006
multiprocessing_manager.Lock())
1007
self.client_structure = [attr
1008
for attr in self.__dict__.keys()
544
self.changedstate = (multiprocessing_manager
545
.Condition(multiprocessing_manager
547
self.client_structure = [attr for attr in
548
self.__dict__.iterkeys()
1009
549
if not attr.startswith("_")]
1010
550
self.client_structure.append("client_structure")
1012
for name, t in inspect.getmembers(
1013
type(self), lambda obj: isinstance(obj, property)):
552
for name, t in inspect.getmembers(type(self),
1014
556
if not name.startswith("_"):
1015
557
self.client_structure.append(name)
1017
559
# Send notice to process children that client state has changed
1018
560
def send_changedstate(self):
1019
561
with self.changedstate:
1020
562
self.changedstate.notify_all()
1022
564
def enable(self):
1023
565
"""Start this client's checker and timeout hooks"""
1024
566
if getattr(self, "enabled", False):
1025
567
# Already enabled
569
self.send_changedstate()
1027
570
self.expires = datetime.datetime.utcnow() + self.timeout
1028
571
self.enabled = True
1029
572
self.last_enabled = datetime.datetime.utcnow()
1030
573
self.init_checker()
1031
self.send_changedstate()
1033
575
def disable(self, quiet=True):
1034
576
"""Disable this client."""
1035
577
if not getattr(self, "enabled", False):
580
self.send_changedstate()
1038
582
logger.info("Disabling client %s", self.name)
1039
if getattr(self, "disable_initiator_tag", None) is not None:
1040
GLib.source_remove(self.disable_initiator_tag)
583
if getattr(self, "disable_initiator_tag", False):
584
gobject.source_remove(self.disable_initiator_tag)
1041
585
self.disable_initiator_tag = None
1042
586
self.expires = None
1043
if getattr(self, "checker_initiator_tag", None) is not None:
1044
GLib.source_remove(self.checker_initiator_tag)
587
if getattr(self, "checker_initiator_tag", False):
588
gobject.source_remove(self.checker_initiator_tag)
1045
589
self.checker_initiator_tag = None
1046
590
self.stop_checker()
1047
591
self.enabled = False
1049
self.send_changedstate()
1050
# Do not run this again if called by a GLib.timeout_add
592
# Do not run this again if called by a gobject.timeout_add
1053
595
def __del__(self):
1056
598
def init_checker(self):
1057
599
# Schedule a new checker to be started an 'interval' from now,
1058
600
# and every interval from then on.
1059
if self.checker_initiator_tag is not None:
1060
GLib.source_remove(self.checker_initiator_tag)
1061
self.checker_initiator_tag = GLib.timeout_add(
1062
random.randrange(int(self.interval.total_seconds() * 1000
601
self.checker_initiator_tag = (gobject.timeout_add
602
(self.interval_milliseconds(),
1065
604
# Schedule a disable() when 'timeout' has passed
1066
if self.disable_initiator_tag is not None:
1067
GLib.source_remove(self.disable_initiator_tag)
1068
self.disable_initiator_tag = GLib.timeout_add(
1069
int(self.timeout.total_seconds() * 1000), self.disable)
605
self.disable_initiator_tag = (gobject.timeout_add
606
(self.timeout_milliseconds(),
1070
608
# Also start a new checker *right now*.
1071
609
self.start_checker()
1073
def checker_callback(self, source, condition, connection,
611
def checker_callback(self, pid, condition, command):
1075
612
"""The checker has completed, so take appropriate actions."""
1076
# Read return code from connection (see call_pipe)
1077
returncode = connection.recv()
1079
if self.checker is not None:
1081
613
self.checker_callback_tag = None
1082
614
self.checker = None
1085
self.last_checker_status = returncode
1086
self.last_checker_signal = None
615
if os.WIFEXITED(condition):
616
self.last_checker_status = os.WEXITSTATUS(condition)
1087
617
if self.last_checker_status == 0:
1088
618
logger.info("Checker for %(name)s succeeded",
1090
620
self.checked_ok()
1092
logger.info("Checker for %(name)s failed", vars(self))
622
logger.info("Checker for %(name)s failed",
1094
625
self.last_checker_status = -1
1095
self.last_checker_signal = -returncode
1096
626
logger.warning("Checker for %(name)s crashed?",
1100
def checked_ok(self):
1101
"""Assert that the client has been seen, alive and well."""
1102
self.last_checked_ok = datetime.datetime.utcnow()
1103
self.last_checker_status = 0
1104
self.last_checker_signal = None
1107
def bump_timeout(self, timeout=None):
1108
"""Bump up the timeout for this client."""
629
def checked_ok(self, timeout=None):
630
"""Bump up the timeout for this client.
632
This should only be called when the client has been seen,
1109
635
if timeout is None:
1110
636
timeout = self.timeout
637
self.last_checked_ok = datetime.datetime.utcnow()
1111
638
if self.disable_initiator_tag is not None:
1112
GLib.source_remove(self.disable_initiator_tag)
1113
self.disable_initiator_tag = None
639
gobject.source_remove(self.disable_initiator_tag)
1114
640
if getattr(self, "enabled", False):
1115
self.disable_initiator_tag = GLib.timeout_add(
1116
int(timeout.total_seconds() * 1000), self.disable)
641
self.disable_initiator_tag = (gobject.timeout_add
642
(timedelta_to_milliseconds
643
(timeout), self.disable))
1117
644
self.expires = datetime.datetime.utcnow() + timeout
1119
646
def need_approval(self):
1120
647
self.last_approval_request = datetime.datetime.utcnow()
1122
649
def start_checker(self):
1123
650
"""Start a new checker subprocess if one is not running.
1125
652
If a checker already exists, leave it running and do
1127
654
# The reason for not killing a running checker is that if we
1128
# did that, and if a checker (for some reason) started running
1129
# slowly and taking more than 'interval' time, then the client
1130
# would inevitably timeout, since no checker would get a
1131
# chance to run to completion. If we instead leave running
655
# did that, then if a checker (for some reason) started
656
# running slowly and taking more than 'interval' time, the
657
# client would inevitably timeout, since no checker would get
658
# a chance to run to completion. If we instead leave running
1132
659
# checkers alone, the checker would have to take more time
1133
660
# than 'timeout' for the client to be disabled, which is as it
1136
if self.checker is not None and not self.checker.is_alive():
1137
logger.warning("Checker was not alive; joining")
663
# If a checker exists, make sure it is not a zombie
665
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
666
except (AttributeError, OSError) as error:
667
if (isinstance(error, OSError)
668
and error.errno != errno.ECHILD):
672
logger.warning("Checker was a zombie")
673
gobject.source_remove(self.checker_callback_tag)
674
self.checker_callback(pid, status,
675
self.current_checker_command)
1140
676
# Start a new checker if needed
1141
677
if self.checker is None:
1142
# Escape attributes for the shell
1144
attr: shlex.quote(str(getattr(self, attr)))
1145
for attr in self.runtime_expansions}
1147
command = self.checker_command % escaped_attrs
1148
except TypeError as error:
1149
logger.error('Could not format string "%s"',
1150
self.checker_command,
1152
return True # Try again later
679
# In case checker_command has exactly one % operator
680
command = self.checker_command % self.host
682
# Escape attributes for the shell
683
escaped_attrs = dict(
685
re.escape(unicode(str(getattr(self, attr, "")),
689
self.runtime_expansions)
692
command = self.checker_command % escaped_attrs
693
except TypeError as error:
694
logger.error('Could not format string "%s":'
695
' %s', self.checker_command, error)
696
return True # Try again later
1153
697
self.current_checker_command = command
1154
logger.info("Starting checker %r for %s", command,
1156
# We don't need to redirect stdout and stderr, since
1157
# in normal mode, that is already done by daemon(),
1158
# and in debug mode we don't want to. (Stdin is
1159
# always replaced by /dev/null.)
1160
# The exception is when not debugging but nevertheless
1161
# running in the foreground; use the previously
1163
popen_args = {"close_fds": True,
1166
if (not self.server_settings["debug"]
1167
and self.server_settings["foreground"]):
1168
popen_args.update({"stdout": wnull,
1170
pipe = multiprocessing.Pipe(duplex=False)
1171
self.checker = multiprocessing.Process(
1173
args=(pipe[1], subprocess.call, command),
1175
self.checker.start()
1176
self.checker_callback_tag = GLib.io_add_watch(
1177
GLib.IOChannel.unix_new(pipe[0].fileno()),
1178
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1179
self.checker_callback, pipe[0], command)
1180
# Re-run this periodically if run by GLib.timeout_add
699
logger.info("Starting checker %r for %s",
701
# We don't need to redirect stdout and stderr, since
702
# in normal mode, that is already done by daemon(),
703
# and in debug mode we don't want to. (Stdin is
704
# always replaced by /dev/null.)
705
self.checker = subprocess.Popen(command,
708
self.checker_callback_tag = (gobject.child_watch_add
710
self.checker_callback,
712
# The checker may have completed before the gobject
713
# watch was added. Check for this.
714
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
716
gobject.source_remove(self.checker_callback_tag)
717
self.checker_callback(pid, status, command)
718
except OSError as error:
719
logger.error("Failed to start subprocess: %s",
721
# Re-run this periodically if run by gobject.timeout_add
1183
724
def stop_checker(self):
1184
725
"""Force the checker process, if any, to stop."""
1185
726
if self.checker_callback_tag:
1186
GLib.source_remove(self.checker_callback_tag)
727
gobject.source_remove(self.checker_callback_tag)
1187
728
self.checker_callback_tag = None
1188
729
if getattr(self, "checker", None) is None:
1190
731
logger.debug("Stopping checker for %(name)s", vars(self))
1191
self.checker.terminate()
733
os.kill(self.checker.pid, signal.SIGTERM)
735
#if self.checker.poll() is None:
736
# os.kill(self.checker.pid, signal.SIGKILL)
737
except OSError as error:
738
if error.errno != errno.ESRCH: # No such process
1192
740
self.checker = None
1195
def dbus_service_property(dbus_interface,
743
def dbus_service_property(dbus_interface, signature="v",
744
access="readwrite", byte_arrays=False):
1199
745
"""Decorators for marking methods of a DBusObjectWithProperties to
1200
746
become properties on the D-Bus.
1202
748
The decorated method will be called with no arguments by "Get"
1203
749
and with one argument by "Set".
1205
751
The parameters, where they are supported, are the same as
1206
752
dbus.service.method, except there is only "signature", since the
1207
753
type from Get() and the type sent to Set() is the same.
1290
class DBusObjectWithAnnotations(dbus.service.Object):
1291
"""A D-Bus object with annotations.
1293
Classes inheriting from this can use the dbus_annotations
1294
decorator to add annotations to methods or signals.
1298
def _is_dbus_thing(thing):
1299
"""Returns a function testing if an attribute is a D-Bus thing
1301
If called like _is_dbus_thing("method") it returns a function
1302
suitable for use as predicate to inspect.getmembers().
1304
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1307
def _get_all_dbus_things(self, thing):
1308
"""Returns a generator of (name, attribute) pairs
1310
return ((getattr(athing.__get__(self), "_dbus_name", name),
1311
athing.__get__(self))
1312
for cls in self.__class__.__mro__
1314
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1316
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1318
path_keyword='object_path',
1319
connection_keyword='connection')
1320
def Introspect(self, object_path, connection):
1321
"""Overloading of standard D-Bus method.
1323
Inserts annotation tags on methods and signals.
1325
xmlstring = dbus.service.Object.Introspect(self, object_path,
1328
document = xml.dom.minidom.parseString(xmlstring)
1330
for if_tag in document.getElementsByTagName("interface"):
1331
# Add annotation tags
1332
for typ in ("method", "signal"):
1333
for tag in if_tag.getElementsByTagName(typ):
1335
for name, prop in (self.
1336
_get_all_dbus_things(typ)):
1337
if (name == tag.getAttribute("name")
1338
and prop._dbus_interface
1339
== if_tag.getAttribute("name")):
1340
annots.update(getattr(
1341
prop, "_dbus_annotations", {}))
1342
for name, value in annots.items():
1343
ann_tag = document.createElement(
1345
ann_tag.setAttribute("name", name)
1346
ann_tag.setAttribute("value", value)
1347
tag.appendChild(ann_tag)
1348
# Add interface annotation tags
1349
for annotation, value in dict(
1350
itertools.chain.from_iterable(
1351
annotations().items()
1352
for name, annotations
1353
in self._get_all_dbus_things("interface")
1354
if name == if_tag.getAttribute("name")
1356
ann_tag = document.createElement("annotation")
1357
ann_tag.setAttribute("name", annotation)
1358
ann_tag.setAttribute("value", value)
1359
if_tag.appendChild(ann_tag)
1360
# Fix argument name for the Introspect method itself
1361
if (if_tag.getAttribute("name")
1362
== dbus.INTROSPECTABLE_IFACE):
1363
for cn in if_tag.getElementsByTagName("method"):
1364
if cn.getAttribute("name") == "Introspect":
1365
for arg in cn.getElementsByTagName("arg"):
1366
if (arg.getAttribute("direction")
1368
arg.setAttribute("name",
1370
xmlstring = document.toxml("utf-8")
1372
except (AttributeError, xml.dom.DOMException,
1373
xml.parsers.expat.ExpatError) as error:
1374
logger.error("Failed to override Introspection method",
1379
class DBusObjectWithProperties(DBusObjectWithAnnotations):
792
class DBusObjectWithProperties(dbus.service.Object):
1380
793
"""A D-Bus object with properties.
1382
795
Classes inheriting from this can use the dbus_service_property
1383
796
decorator to expose methods as D-Bus properties. It exposes the
1384
797
standard Get(), Set(), and GetAll() methods on the D-Bus.
801
def _is_dbus_property(obj):
802
return getattr(obj, "_dbus_is_property", False)
804
def _get_all_dbus_properties(self):
805
"""Returns a generator of (name, attribute) pairs
807
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
808
for cls in self.__class__.__mro__
810
inspect.getmembers(cls, self._is_dbus_property))
1387
812
def _get_dbus_property(self, interface_name, property_name):
1388
813
"""Returns a bound method if one exists which is a D-Bus
1389
814
property with the specified name and interface.
1391
for cls in self.__class__.__mro__:
1392
for name, value in inspect.getmembers(
1393
cls, self._is_dbus_thing("property")):
816
for cls in self.__class__.__mro__:
817
for name, value in (inspect.getmembers
818
(cls, self._is_dbus_property)):
1394
819
if (value._dbus_name == property_name
1395
820
and value._dbus_interface == interface_name):
1396
821
return value.__get__(self)
1398
823
# No such property
1399
raise DBusPropertyNotFound("{}:{}.{}".format(
1400
self.dbus_object_path, interface_name, property_name))
1403
def _get_all_interface_names(cls):
1404
"""Get a sequence of all interfaces supported by an object"""
1405
return (name for name in set(getattr(getattr(x, attr),
1406
"_dbus_interface", None)
1407
for x in (inspect.getmro(cls))
1409
if name is not None)
1411
@dbus.service.method(dbus.PROPERTIES_IFACE,
824
raise DBusPropertyNotFound(self.dbus_object_path + ":"
825
+ interface_name + "."
828
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1413
829
out_signature="v")
1414
830
def Get(self, interface_name, property_name):
1415
831
"""Standard D-Bus property Get() method, see D-Bus standard.
1539
923
except (AttributeError, xml.dom.DOMException,
1540
924
xml.parsers.expat.ExpatError) as error:
1541
925
logger.error("Failed to override Introspection method",
1547
dbus.OBJECT_MANAGER_IFACE
1548
except AttributeError:
1549
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1552
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1553
"""A D-Bus object with an ObjectManager.
1555
Classes inheriting from this exposes the standard
1556
GetManagedObjects call and the InterfacesAdded and
1557
InterfacesRemoved signals on the standard
1558
"org.freedesktop.DBus.ObjectManager" interface.
1560
Note: No signals are sent automatically; they must be sent
1563
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1564
out_signature="a{oa{sa{sv}}}")
1565
def GetManagedObjects(self):
1566
"""This function must be overridden"""
1567
raise NotImplementedError()
1569
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1570
signature="oa{sa{sv}}")
1571
def InterfacesAdded(self, object_path, interfaces_and_properties):
1574
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1575
def InterfacesRemoved(self, object_path, interfaces):
1578
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1580
path_keyword='object_path',
1581
connection_keyword='connection')
1582
def Introspect(self, object_path, connection):
1583
"""Overloading of standard D-Bus method.
1585
Override return argument name of GetManagedObjects to be
1586
"objpath_interfaces_and_properties"
1588
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1592
document = xml.dom.minidom.parseString(xmlstring)
1594
for if_tag in document.getElementsByTagName("interface"):
1595
# Fix argument name for the GetManagedObjects method
1596
if (if_tag.getAttribute("name")
1597
== dbus.OBJECT_MANAGER_IFACE):
1598
for cn in if_tag.getElementsByTagName("method"):
1599
if (cn.getAttribute("name")
1600
== "GetManagedObjects"):
1601
for arg in cn.getElementsByTagName("arg"):
1602
if (arg.getAttribute("direction")
1606
"objpath_interfaces"
1608
xmlstring = document.toxml("utf-8")
1610
except (AttributeError, xml.dom.DOMException,
1611
xml.parsers.expat.ExpatError) as error:
1612
logger.error("Failed to override Introspection method",
1617
def datetime_to_dbus(dt, variant_level=0):
930
def datetime_to_dbus (dt, variant_level=0):
1618
931
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1620
return dbus.String("", variant_level=variant_level)
1621
return dbus.String(dt.isoformat(), variant_level=variant_level)
1624
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1625
"""A class decorator; applied to a subclass of
1626
dbus.service.Object, it will add alternate D-Bus attributes with
1627
interface names according to the "alt_interface_names" mapping.
1630
@alternate_dbus_interfaces({"org.example.Interface":
1631
"net.example.AlternateInterface"})
1632
class SampleDBusObject(dbus.service.Object):
1633
@dbus.service.method("org.example.Interface")
1634
def SampleDBusMethod():
1637
The above "SampleDBusMethod" on "SampleDBusObject" will be
1638
reachable via two interfaces: "org.example.Interface" and
1639
"net.example.AlternateInterface", the latter of which will have
1640
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1641
"true", unless "deprecate" is passed with a False value.
1643
This works for methods and signals, and also for D-Bus properties
1644
(from DBusObjectWithProperties) and interfaces (from the
1645
dbus_interface_annotations decorator).
933
return dbus.String("", variant_level = variant_level)
934
return dbus.String(dt.isoformat(),
935
variant_level=variant_level)
938
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
940
"""Applied to an empty subclass of a D-Bus object, this metaclass
941
will add additional D-Bus attributes matching a certain pattern.
1649
for orig_interface_name, alt_interface_name in (
1650
alt_interface_names.items()):
1652
interface_names = set()
1653
# Go though all attributes of the class
1654
for attrname, attribute in inspect.getmembers(cls):
943
def __new__(mcs, name, bases, attr):
944
# Go through all the base classes which could have D-Bus
945
# methods, signals, or properties in them
946
for base in (b for b in bases
947
if issubclass(b, dbus.service.Object)):
948
# Go though all attributes of the base class
949
for attrname, attribute in inspect.getmembers(base):
1655
950
# Ignore non-D-Bus attributes, and D-Bus attributes
1656
951
# with the wrong interface name
1657
952
if (not hasattr(attribute, "_dbus_interface")
1658
or not attribute._dbus_interface.startswith(
1659
orig_interface_name)):
953
or not attribute._dbus_interface
954
.startswith("se.recompile.Mandos")):
1661
956
# Create an alternate D-Bus interface name based on
1662
957
# the current name
1663
alt_interface = attribute._dbus_interface.replace(
1664
orig_interface_name, alt_interface_name)
1665
interface_names.add(alt_interface)
958
alt_interface = (attribute._dbus_interface
959
.replace("se.recompile.Mandos",
960
"se.bsnet.fukt.Mandos"))
1666
961
# Is this a D-Bus signal?
1667
962
if getattr(attribute, "_dbus_is_signal", False):
1668
# Extract the original non-method undecorated
1669
# function by black magic
1670
if sys.version_info.major == 2:
1671
nonmethod_func = (dict(
963
# Extract the original non-method function by
965
nonmethod_func = (dict(
1672
966
zip(attribute.func_code.co_freevars,
1673
attribute.__closure__))
1674
["func"].cell_contents)
1676
nonmethod_func = (dict(
1677
zip(attribute.__code__.co_freevars,
1678
attribute.__closure__))
1679
["func"].cell_contents)
967
attribute.__closure__))["func"]
1680
969
# Create a new, but exactly alike, function
1681
970
# object, and decorate it to be a new D-Bus signal
1682
971
# with the alternate D-Bus interface name
1683
new_function = copy_function(nonmethod_func)
1684
new_function = (dbus.service.signal(
1686
attribute._dbus_signature)(new_function))
1687
# Copy annotations, if any
1689
new_function._dbus_annotations = dict(
1690
attribute._dbus_annotations)
1691
except AttributeError:
972
new_function = (dbus.service.signal
974
attribute._dbus_signature)
976
nonmethod_func.func_code,
977
nonmethod_func.func_globals,
978
nonmethod_func.func_name,
979
nonmethod_func.func_defaults,
980
nonmethod_func.func_closure)))
1694
981
# Define a creator of a function to call both the
1695
# original and alternate functions, so both the
1696
# original and alternate signals gets sent when
1697
# the function is called
982
# old and new functions, so both the old and new
983
# signals gets sent when the function is called
1698
984
def fixscope(func1, func2):
1699
985
"""This function is a scope container to pass
1700
986
func1 and func2 to the "call_both" function
1701
987
outside of its arguments"""
1703
@functools.wraps(func2)
1704
988
def call_both(*args, **kwargs):
1705
989
"""This function will emit two D-Bus
1706
990
signals by calling func1 and func2"""
1707
991
func1(*args, **kwargs)
1708
992
func2(*args, **kwargs)
1709
# Make wrapper function look like a D-Bus
1711
for name, attr in inspect.getmembers(func2):
1712
if name.startswith("_dbus_"):
1713
setattr(call_both, name, attr)
1715
993
return call_both
1716
994
# Create the "call_both" function and add it to
1718
attr[attrname] = fixscope(attribute, new_function)
996
attr[attrname] = fixscope(attribute,
1719
998
# Is this a D-Bus method?
1720
999
elif getattr(attribute, "_dbus_is_method", False):
1721
1000
# Create a new, but exactly alike, function
1722
1001
# object. Decorate it to be a new D-Bus method
1723
1002
# with the alternate D-Bus interface name. Add it
1724
1003
# to the class.
1726
dbus.service.method(
1728
attribute._dbus_in_signature,
1729
attribute._dbus_out_signature)
1730
(copy_function(attribute)))
1731
# Copy annotations, if any
1733
attr[attrname]._dbus_annotations = dict(
1734
attribute._dbus_annotations)
1735
except AttributeError:
1004
attr[attrname] = (dbus.service.method
1006
attribute._dbus_in_signature,
1007
attribute._dbus_out_signature)
1009
(attribute.func_code,
1010
attribute.func_globals,
1011
attribute.func_name,
1012
attribute.func_defaults,
1013
attribute.func_closure)))
1737
1014
# Is this a D-Bus property?
1738
1015
elif getattr(attribute, "_dbus_is_property", False):
1739
1016
# Create a new, but exactly alike, function
1740
1017
# object, and decorate it to be a new D-Bus
1741
1018
# property with the alternate D-Bus interface
1742
1019
# name. Add it to the class.
1743
attr[attrname] = (dbus_service_property(
1744
alt_interface, attribute._dbus_signature,
1745
attribute._dbus_access,
1746
attribute._dbus_get_args_options
1748
(copy_function(attribute)))
1749
# Copy annotations, if any
1751
attr[attrname]._dbus_annotations = dict(
1752
attribute._dbus_annotations)
1753
except AttributeError:
1755
# Is this a D-Bus interface?
1756
elif getattr(attribute, "_dbus_is_interface", False):
1757
# Create a new, but exactly alike, function
1758
# object. Decorate it to be a new D-Bus interface
1759
# with the alternate D-Bus interface name. Add it
1762
dbus_interface_annotations(alt_interface)
1763
(copy_function(attribute)))
1765
# Deprecate all alternate interfaces
1766
iname = "_AlternateDBusNames_interface_annotation{}"
1767
for interface_name in interface_names:
1769
@dbus_interface_annotations(interface_name)
1771
return {"org.freedesktop.DBus.Deprecated":
1773
# Find an unused name
1774
for aname in (iname.format(i)
1775
for i in itertools.count()):
1776
if aname not in attr:
1780
# Replace the class with a new subclass of it with
1781
# methods, signals, etc. as created above.
1782
if sys.version_info.major == 2:
1783
cls = type(b"{}Alternate".format(cls.__name__),
1786
cls = type("{}Alternate".format(cls.__name__),
1793
@alternate_dbus_interfaces({"se.recompile.Mandos":
1794
"se.bsnet.fukt.Mandos"})
1020
attr[attrname] = (dbus_service_property
1022
attribute._dbus_signature,
1023
attribute._dbus_access,
1025
._dbus_get_args_options
1028
(attribute.func_code,
1029
attribute.func_globals,
1030
attribute.func_name,
1031
attribute.func_defaults,
1032
attribute.func_closure)))
1033
return type.__new__(mcs, name, bases, attr)
1795
1036
class ClientDBus(Client, DBusObjectWithProperties):
1796
1037
"""A Client class using D-Bus
1799
1040
dbus_object_path: dbus.ObjectPath
1800
1041
bus: dbus.SystemBus()
1803
1044
runtime_expansions = (Client.runtime_expansions
1804
+ ("dbus_object_path", ))
1806
_interface = "se.recompile.Mandos.Client"
1045
+ ("dbus_object_path",))
1808
1047
# dbus.service.Object doesn't use super(), so we can't either.
1810
def __init__(self, bus=None, *args, **kwargs):
1049
def __init__(self, bus = None, *args, **kwargs):
1812
1051
Client.__init__(self, *args, **kwargs)
1052
self._approvals_pending = 0
1054
self._approvals_pending = 0
1813
1055
# Only now, when this client is initialized, can it show up on
1815
client_object_name = str(self.name).translate(
1057
client_object_name = unicode(self.name).translate(
1816
1058
{ord("."): ord("_"),
1817
1059
ord("-"): ord("_")})
1818
self.dbus_object_path = dbus.ObjectPath(
1819
"/clients/" + client_object_name)
1060
self.dbus_object_path = (dbus.ObjectPath
1061
("/clients/" + client_object_name))
1820
1062
DBusObjectWithProperties.__init__(self, self.bus,
1821
1063
self.dbus_object_path)
1823
def notifychangeproperty(transform_func, dbus_name,
1824
type_func=lambda x: x,
1826
invalidate_only=False,
1827
_interface=_interface):
1065
def notifychangeproperty(transform_func,
1066
dbus_name, type_func=lambda x: x,
1828
1068
""" Modify a variable so that it's a property which announces
1829
1069
its changes to DBus.
1831
1071
transform_fun: Function that takes a value and a variant_level
1832
1072
and transforms it to a D-Bus type.
1833
1073
dbus_name: D-Bus name of the variable
1835
1075
to the D-Bus. Default: no transform
1836
1076
variant_level: D-Bus variant level. Default: 1
1838
attrname = "_{}".format(dbus_name)
1078
attrname = "_{0}".format(dbus_name)
1840
1079
def setter(self, value):
1841
1080
if hasattr(self, "dbus_object_path"):
1842
1081
if (not hasattr(self, attrname) or
1843
1082
type_func(getattr(self, attrname, None))
1844
1083
!= type_func(value)):
1846
self.PropertiesChanged(
1847
_interface, dbus.Dictionary(),
1848
dbus.Array((dbus_name, )))
1850
dbus_value = transform_func(
1852
variant_level=variant_level)
1853
self.PropertyChanged(dbus.String(dbus_name),
1855
self.PropertiesChanged(
1857
dbus.Dictionary({dbus.String(dbus_name):
1084
dbus_value = transform_func(type_func(value),
1087
self.PropertyChanged(dbus.String(dbus_name),
1860
1089
setattr(self, attrname, value)
1862
1091
return property(lambda self: getattr(self, attrname), setter)
1864
1094
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1865
1095
approvals_pending = notifychangeproperty(dbus.Boolean,
1866
1096
"ApprovalPending",
1868
1098
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1869
1099
last_enabled = notifychangeproperty(datetime_to_dbus,
1871
checker = notifychangeproperty(
1872
dbus.Boolean, "CheckerRunning",
1873
type_func=lambda checker: checker is not None)
1101
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1102
type_func = lambda checker:
1103
checker is not None)
1874
1104
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1875
1105
"LastCheckedOK")
1876
last_checker_status = notifychangeproperty(dbus.Int16,
1877
"LastCheckerStatus")
1878
1106
last_approval_request = notifychangeproperty(
1879
1107
datetime_to_dbus, "LastApprovalRequest")
1880
1108
approved_by_default = notifychangeproperty(dbus.Boolean,
1881
1109
"ApprovedByDefault")
1882
approval_delay = notifychangeproperty(
1883
dbus.UInt64, "ApprovalDelay",
1884
type_func=lambda td: td.total_seconds() * 1000)
1110
approval_delay = notifychangeproperty(dbus.UInt64,
1113
timedelta_to_milliseconds)
1885
1114
approval_duration = notifychangeproperty(
1886
1115
dbus.UInt64, "ApprovalDuration",
1887
type_func=lambda td: td.total_seconds() * 1000)
1116
type_func = timedelta_to_milliseconds)
1888
1117
host = notifychangeproperty(dbus.String, "Host")
1889
timeout = notifychangeproperty(
1890
dbus.UInt64, "Timeout",
1891
type_func=lambda td: td.total_seconds() * 1000)
1118
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1120
timedelta_to_milliseconds)
1892
1121
extended_timeout = notifychangeproperty(
1893
1122
dbus.UInt64, "ExtendedTimeout",
1894
type_func=lambda td: td.total_seconds() * 1000)
1895
interval = notifychangeproperty(
1896
dbus.UInt64, "Interval",
1897
type_func=lambda td: td.total_seconds() * 1000)
1123
type_func = timedelta_to_milliseconds)
1124
interval = notifychangeproperty(dbus.UInt64,
1127
timedelta_to_milliseconds)
1898
1128
checker_command = notifychangeproperty(dbus.String, "Checker")
1899
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1900
invalidate_only=True)
1902
1130
del notifychangeproperty
1904
1132
def __del__(self, *args, **kwargs):
1906
1134
self.remove_from_connection()
1985
1214
server to mandos-client
1989
1218
# Rejected - signal
1990
1219
@dbus.service.signal(_interface, signature="s")
1991
1220
def Rejected(self, reason):
1995
1224
# NeedApproval - signal
1996
1225
@dbus.service.signal(_interface, signature="tb")
1997
1226
def NeedApproval(self, timeout, default):
1999
1228
return self.need_approval()
1230
# NeRwequest - signal
1231
@dbus.service.signal(_interface, signature="s")
1232
def NewRequest(self, ip):
1234
Is sent after a client request a password.
2003
1240
# Approve - method
2004
1241
@dbus.service.method(_interface, in_signature="b")
2005
1242
def Approve(self, value):
2006
1243
self.approve(value)
2008
1245
# CheckedOK - method
2009
1246
@dbus.service.method(_interface)
2010
1247
def CheckedOK(self):
2011
1248
self.checked_ok()
2013
1250
# Enable - method
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2015
1251
@dbus.service.method(_interface)
2016
1252
def Enable(self):
2020
1256
# StartChecker - method
2021
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2022
1257
@dbus.service.method(_interface)
2023
1258
def StartChecker(self):
2025
1260
self.start_checker()
2027
1262
# Disable - method
2028
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2029
1263
@dbus.service.method(_interface)
2030
1264
def Disable(self):
2034
1268
# StopChecker - method
2035
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2036
1269
@dbus.service.method(_interface)
2037
1270
def StopChecker(self):
2038
1271
self.stop_checker()
2042
1275
# ApprovalPending - property
2043
1276
@dbus_service_property(_interface, signature="b", access="read")
2044
1277
def ApprovalPending_dbus_property(self):
2045
1278
return dbus.Boolean(bool(self.approvals_pending))
2047
1280
# ApprovedByDefault - property
2048
@dbus_service_property(_interface,
1281
@dbus_service_property(_interface, signature="b",
2050
1282
access="readwrite")
2051
1283
def ApprovedByDefault_dbus_property(self, value=None):
2052
1284
if value is None: # get
2053
1285
return dbus.Boolean(self.approved_by_default)
2054
1286
self.approved_by_default = bool(value)
2056
1288
# ApprovalDelay - property
2057
@dbus_service_property(_interface,
1289
@dbus_service_property(_interface, signature="t",
2059
1290
access="readwrite")
2060
1291
def ApprovalDelay_dbus_property(self, value=None):
2061
1292
if value is None: # get
2062
return dbus.UInt64(self.approval_delay.total_seconds()
1293
return dbus.UInt64(self.approval_delay_milliseconds())
2064
1294
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2066
1296
# ApprovalDuration - property
2067
@dbus_service_property(_interface,
1297
@dbus_service_property(_interface, signature="t",
2069
1298
access="readwrite")
2070
1299
def ApprovalDuration_dbus_property(self, value=None):
2071
1300
if value is None: # get
2072
return dbus.UInt64(self.approval_duration.total_seconds()
1301
return dbus.UInt64(timedelta_to_milliseconds(
1302
self.approval_duration))
2074
1303
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2076
1305
# Name - property
2078
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2079
1306
@dbus_service_property(_interface, signature="s", access="read")
2080
1307
def Name_dbus_property(self):
2081
1308
return dbus.String(self.name)
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
@dbus_service_property(_interface, signature="s", access="read")
2087
def KeyID_dbus_property(self):
2088
return dbus.String(self.key_id)
2090
1310
# Fingerprint - property
2092
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2093
1311
@dbus_service_property(_interface, signature="s", access="read")
2094
1312
def Fingerprint_dbus_property(self):
2095
1313
return dbus.String(self.fingerprint)
2097
1315
# Host - property
2098
@dbus_service_property(_interface,
1316
@dbus_service_property(_interface, signature="s",
2100
1317
access="readwrite")
2101
1318
def Host_dbus_property(self, value=None):
2102
1319
if value is None: # get
2103
1320
return dbus.String(self.host)
2104
self.host = str(value)
1321
self.host = unicode(value)
2106
1323
# Created - property
2108
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2109
1324
@dbus_service_property(_interface, signature="s", access="read")
2110
1325
def Created_dbus_property(self):
2111
1326
return datetime_to_dbus(self.created)
2113
1328
# LastEnabled - property
2114
1329
@dbus_service_property(_interface, signature="s", access="read")
2115
1330
def LastEnabled_dbus_property(self):
2116
1331
return datetime_to_dbus(self.last_enabled)
2118
1333
# Enabled - property
2119
@dbus_service_property(_interface,
1334
@dbus_service_property(_interface, signature="b",
2121
1335
access="readwrite")
2122
1336
def Enabled_dbus_property(self, value=None):
2123
1337
if value is None: # get
2130
1344
# LastCheckedOK - property
2131
@dbus_service_property(_interface,
1345
@dbus_service_property(_interface, signature="s",
2133
1346
access="readwrite")
2134
1347
def LastCheckedOK_dbus_property(self, value=None):
2135
1348
if value is not None:
2136
1349
self.checked_ok()
2138
1351
return datetime_to_dbus(self.last_checked_ok)
2140
# LastCheckerStatus - property
2141
@dbus_service_property(_interface, signature="n", access="read")
2142
def LastCheckerStatus_dbus_property(self):
2143
return dbus.Int16(self.last_checker_status)
2145
1353
# Expires - property
2146
1354
@dbus_service_property(_interface, signature="s", access="read")
2147
1355
def Expires_dbus_property(self):
2148
1356
return datetime_to_dbus(self.expires)
2150
1358
# LastApprovalRequest - property
2151
1359
@dbus_service_property(_interface, signature="s", access="read")
2152
1360
def LastApprovalRequest_dbus_property(self):
2153
1361
return datetime_to_dbus(self.last_approval_request)
2155
1363
# Timeout - property
2156
@dbus_service_property(_interface,
1364
@dbus_service_property(_interface, signature="t",
2158
1365
access="readwrite")
2159
1366
def Timeout_dbus_property(self, value=None):
2160
1367
if value is None: # get
2161
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2162
old_timeout = self.timeout
1368
return dbus.UInt64(self.timeout_milliseconds())
2163
1369
self.timeout = datetime.timedelta(0, 0, 0, value)
2164
# Reschedule disabling
1370
# Reschedule timeout
2165
1371
if self.enabled:
2166
1372
now = datetime.datetime.utcnow()
2167
self.expires += self.timeout - old_timeout
2168
if self.expires <= now:
1373
time_to_die = timedelta_to_milliseconds(
1374
(self.last_checked_ok + self.timeout) - now)
1375
if time_to_die <= 0:
2169
1376
# The timeout has passed
1379
self.expires = (now +
1380
datetime.timedelta(milliseconds =
2172
1382
if (getattr(self, "disable_initiator_tag", None)
2175
GLib.source_remove(self.disable_initiator_tag)
2176
self.disable_initiator_tag = GLib.timeout_add(
2177
int((self.expires - now).total_seconds() * 1000),
1385
gobject.source_remove(self.disable_initiator_tag)
1386
self.disable_initiator_tag = (gobject.timeout_add
2180
1390
# ExtendedTimeout - property
2181
@dbus_service_property(_interface,
1391
@dbus_service_property(_interface, signature="t",
2183
1392
access="readwrite")
2184
1393
def ExtendedTimeout_dbus_property(self, value=None):
2185
1394
if value is None: # get
2186
return dbus.UInt64(self.extended_timeout.total_seconds()
1395
return dbus.UInt64(self.extended_timeout_milliseconds())
2188
1396
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2190
1398
# Interval - property
2191
@dbus_service_property(_interface,
1399
@dbus_service_property(_interface, signature="t",
2193
1400
access="readwrite")
2194
1401
def Interval_dbus_property(self, value=None):
2195
1402
if value is None: # get
2196
return dbus.UInt64(self.interval.total_seconds() * 1000)
1403
return dbus.UInt64(self.interval_milliseconds())
2197
1404
self.interval = datetime.timedelta(0, 0, 0, value)
2198
1405
if getattr(self, "checker_initiator_tag", None) is None:
2200
1407
if self.enabled:
2201
1408
# Reschedule checker run
2202
GLib.source_remove(self.checker_initiator_tag)
2203
self.checker_initiator_tag = GLib.timeout_add(
2204
value, self.start_checker)
2205
self.start_checker() # Start one now, too
1409
gobject.source_remove(self.checker_initiator_tag)
1410
self.checker_initiator_tag = (gobject.timeout_add
1411
(value, self.start_checker))
1412
self.start_checker() # Start one now, too
2207
1414
# Checker - property
2208
@dbus_service_property(_interface,
1415
@dbus_service_property(_interface, signature="s",
2210
1416
access="readwrite")
2211
1417
def Checker_dbus_property(self, value=None):
2212
1418
if value is None: # get
2213
1419
return dbus.String(self.checker_command)
2214
self.checker_command = str(value)
1420
self.checker_command = unicode(value)
2216
1422
# CheckerRunning - property
2217
@dbus_service_property(_interface,
1423
@dbus_service_property(_interface, signature="b",
2219
1424
access="readwrite")
2220
1425
def CheckerRunning_dbus_property(self, value=None):
2221
1426
if value is None: # get
2262
1459
if data[0] == 'data':
2264
1461
if data[0] == 'function':
2266
1462
def func(*args, **kwargs):
2267
1463
self._pipe.send(('funcall', name, args, kwargs))
2268
1464
return self._pipe.recv()[1]
2272
1467
def __setattr__(self, name, value):
2273
1468
if name == '_pipe':
2274
1469
return super(ProxyClient, self).__setattr__(name, value)
2275
1470
self._pipe.send(('setattr', name, value))
1473
class ClientDBusTransitional(ClientDBus):
1474
__metaclass__ = AlternateDBusNamesMetaclass
2278
1477
class ClientHandler(socketserver.BaseRequestHandler, object):
2279
1478
"""A class to handle client connections.
2281
1480
Instantiated once for each connection to handle it.
2282
1481
Note: This will run in its own forked process."""
2284
1483
def handle(self):
2285
1484
with contextlib.closing(self.server.child_pipe) as child_pipe:
2286
1485
logger.info("TCP connection from: %s",
2287
str(self.client_address))
1486
unicode(self.client_address))
2288
1487
logger.debug("Pipe FD: %d",
2289
1488
self.server.child_pipe.fileno())
2291
session = gnutls.ClientSession(self.request)
2293
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2294
# "+AES-256-CBC", "+SHA1",
2295
# "+COMP-NULL", "+CTYPE-OPENPGP",
1490
session = (gnutls.connection
1491
.ClientSession(self.request,
1493
.X509Credentials()))
1495
# Note: gnutls.connection.X509Credentials is really a
1496
# generic GnuTLS certificate credentials object so long as
1497
# no X.509 keys are added to it. Therefore, we can use it
1498
# here despite using OpenPGP certificates.
1500
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1501
# "+AES-256-CBC", "+SHA1",
1502
# "+COMP-NULL", "+CTYPE-OPENPGP",
2297
1504
# Use a fallback default, since this MUST be set.
2298
1505
priority = self.server.gnutls_priority
2299
1506
if priority is None:
2300
1507
priority = "NORMAL"
2301
gnutls.priority_set_direct(session._c_object,
2302
priority.encode("utf-8"),
1508
(gnutls.library.functions
1509
.gnutls_priority_set_direct(session._c_object,
2305
1512
# Start communication using the Mandos protocol
2306
1513
# Get protocol number
2307
1514
line = self.request.makefile().readline()
2308
1515
logger.debug("Protocol version: %r", line)
2310
1517
if int(line.strip().split()[0]) > 1:
2311
raise RuntimeError(line)
2312
1519
except (ValueError, IndexError, RuntimeError) as error:
2313
1520
logger.error("Unknown protocol version: %s", error)
2316
1523
# Start GnuTLS connection
2318
1525
session.handshake()
2319
except gnutls.Error as error:
1526
except gnutls.errors.GNUTLSError as error:
2320
1527
logger.warning("Handshake failed: %s", error)
2321
1528
# Do not run session.bye() here: the session is not
2322
1529
# established. Just abandon the request.
2324
1531
logger.debug("Handshake succeeded")
2326
1533
approval_required = False
2328
if gnutls.has_rawpk:
2331
key_id = self.key_id(
2332
self.peer_certificate(session))
2333
except (TypeError, gnutls.Error) as error:
2334
logger.warning("Bad certificate: %s", error)
2336
logger.debug("Key ID: %s", key_id)
2341
fpr = self.fingerprint(
2342
self.peer_certificate(session))
2343
except (TypeError, gnutls.Error) as error:
2344
logger.warning("Bad certificate: %s", error)
2346
logger.debug("Fingerprint: %s", fpr)
2349
client = ProxyClient(child_pipe, key_id, fpr,
1536
fpr = self.fingerprint(self.peer_certificate
1539
gnutls.errors.GNUTLSError) as error:
1540
logger.warning("Bad certificate: %s", error)
1542
logger.debug("Fingerprint: %s", fpr)
1545
client = ProxyClient(child_pipe, fpr,
2350
1546
self.client_address)
2351
1547
except KeyError:
1550
if self.server.use_dbus:
1552
client.NewRequest(str(self.client_address))
2354
1554
if client.approval_delay:
2355
1555
delay = client.approval_delay
2356
1556
client.approvals_pending += 1
2357
1557
approval_required = True
2360
1560
if not client.enabled:
2361
1561
logger.info("Client %s is disabled",
2363
1563
if self.server.use_dbus:
2364
1564
# Emit D-Bus signal
2365
1565
client.Rejected("Disabled")
2368
1568
if client.approved or not client.approval_delay:
2369
# We are approved or approval is disabled
1569
#We are approved or approval is disabled
2371
1571
elif client.approved is None:
2372
1572
logger.info("Client %s needs approval",
2405
1607
delay -= time2 - time
2408
session.send(client.secret)
2409
except gnutls.Error as error:
2410
logger.warning("gnutls send failed",
1610
while sent_size < len(client.secret):
1612
sent = session.send(client.secret[sent_size:])
1613
except gnutls.errors.GNUTLSError as error:
1614
logger.warning("gnutls send failed")
1616
logger.debug("Sent: %d, remaining: %d",
1617
sent, len(client.secret)
1618
- (sent_size + sent))
2414
1621
logger.info("Sending secret to %s", client.name)
2415
1622
# bump the timeout using extended_timeout
2416
client.bump_timeout(client.extended_timeout)
1623
client.checked_ok(client.extended_timeout)
2417
1624
if self.server.use_dbus:
2418
1625
# Emit D-Bus signal
2419
1626
client.GotSecret()
2422
1629
if approval_required:
2423
1630
client.approvals_pending -= 1
2426
except gnutls.Error as error:
2427
logger.warning("GnuTLS bye failed",
1633
except gnutls.errors.GNUTLSError as error:
1634
logger.warning("GnuTLS bye failed")
2431
1637
def peer_certificate(session):
2432
"Return the peer's certificate as a bytestring"
2434
cert_type = gnutls.certificate_type_get2(session._c_object,
2436
except AttributeError:
2437
cert_type = gnutls.certificate_type_get(session._c_object)
2438
if gnutls.has_rawpk:
2439
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2441
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2442
# If not a valid certificate type...
2443
if cert_type not in valid_cert_types:
2444
logger.info("Cert type %r not in %r", cert_type,
2446
# ...return invalid data
1638
"Return the peer's OpenPGP certificate as a bytestring"
1639
# If not an OpenPGP certificate...
1640
if (gnutls.library.functions
1641
.gnutls_certificate_type_get(session._c_object)
1642
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1643
# ...do the normal thing
1644
return session.peer_certificate
2448
1645
list_size = ctypes.c_uint(1)
2449
cert_list = (gnutls.certificate_get_peers
1646
cert_list = (gnutls.library.functions
1647
.gnutls_certificate_get_peers
2450
1648
(session._c_object, ctypes.byref(list_size)))
2451
1649
if not bool(cert_list) and list_size.value != 0:
2452
raise gnutls.Error("error getting peer certificate")
1650
raise gnutls.errors.GNUTLSError("error getting peer"
2453
1652
if list_size.value == 0:
2455
1654
cert = cert_list[0]
2456
1655
return ctypes.string_at(cert.data, cert.size)
2459
def key_id(certificate):
2460
"Convert a certificate bytestring to a hexdigit key ID"
2461
# New GnuTLS "datum" with the public key
2462
datum = gnutls.datum_t(
2463
ctypes.cast(ctypes.c_char_p(certificate),
2464
ctypes.POINTER(ctypes.c_ubyte)),
2465
ctypes.c_uint(len(certificate)))
2466
# XXX all these need to be created in the gnutls "module"
2467
# New empty GnuTLS certificate
2468
pubkey = gnutls.pubkey_t()
2469
gnutls.pubkey_init(ctypes.byref(pubkey))
2470
# Import the raw public key into the certificate
2471
gnutls.pubkey_import(pubkey,
2472
ctypes.byref(datum),
2473
gnutls.X509_FMT_DER)
2474
# New buffer for the key ID
2475
buf = ctypes.create_string_buffer(32)
2476
buf_len = ctypes.c_size_t(len(buf))
2477
# Get the key ID from the raw public key into the buffer
2478
gnutls.pubkey_get_key_id(
2480
gnutls.KEYID_USE_SHA256,
2481
ctypes.cast(ctypes.byref(buf),
2482
ctypes.POINTER(ctypes.c_ubyte)),
2483
ctypes.byref(buf_len))
2484
# Deinit the certificate
2485
gnutls.pubkey_deinit(pubkey)
2487
# Convert the buffer to a Python bytestring
2488
key_id = ctypes.string_at(buf, buf_len.value)
2489
# Convert the bytestring to hexadecimal notation
2490
hex_key_id = binascii.hexlify(key_id).upper()
2494
1658
def fingerprint(openpgp):
2495
1659
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2496
1660
# New GnuTLS "datum" with the OpenPGP public key
2497
datum = gnutls.datum_t(
2498
ctypes.cast(ctypes.c_char_p(openpgp),
2499
ctypes.POINTER(ctypes.c_ubyte)),
2500
ctypes.c_uint(len(openpgp)))
1661
datum = (gnutls.library.types
1662
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1665
ctypes.c_uint(len(openpgp))))
2501
1666
# New empty GnuTLS certificate
2502
crt = gnutls.openpgp_crt_t()
2503
gnutls.openpgp_crt_init(ctypes.byref(crt))
1667
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1668
(gnutls.library.functions
1669
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2504
1670
# Import the OpenPGP public key into the certificate
2505
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2506
gnutls.OPENPGP_FMT_RAW)
1671
(gnutls.library.functions
1672
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1673
gnutls.library.constants
1674
.GNUTLS_OPENPGP_FMT_RAW))
2507
1675
# Verify the self signature in the key
2508
1676
crtverify = ctypes.c_uint()
2509
gnutls.openpgp_crt_verify_self(crt, 0,
2510
ctypes.byref(crtverify))
1677
(gnutls.library.functions
1678
.gnutls_openpgp_crt_verify_self(crt, 0,
1679
ctypes.byref(crtverify)))
2511
1680
if crtverify.value != 0:
2512
gnutls.openpgp_crt_deinit(crt)
2513
raise gnutls.CertificateSecurityError(code
1681
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1682
raise (gnutls.errors.CertificateSecurityError
2515
1684
# New buffer for the fingerprint
2516
1685
buf = ctypes.create_string_buffer(20)
2517
1686
buf_len = ctypes.c_size_t()
2518
1687
# Get the fingerprint from the certificate into the buffer
2519
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2520
ctypes.byref(buf_len))
1688
(gnutls.library.functions
1689
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1690
ctypes.byref(buf_len)))
2521
1691
# Deinit the certificate
2522
gnutls.openpgp_crt_deinit(crt)
1692
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2523
1693
# Convert the buffer to a Python bytestring
2524
1694
fpr = ctypes.string_at(buf, buf_len.value)
2525
1695
# Convert the bytestring to hexadecimal notation
2530
class MultiprocessingMixIn:
1700
class MultiprocessingMixIn(object):
2531
1701
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2533
1702
def sub_process_main(self, request, address):
2535
1704
self.finish_request(request, address)
2536
1705
except Exception:
2537
1706
self.handle_error(request, address)
2538
1707
self.close_request(request)
2540
1709
def process_request(self, request, address):
2541
1710
"""Start a new process to process the request."""
2542
proc = multiprocessing.Process(target=self.sub_process_main,
2543
args=(request, address))
1711
proc = multiprocessing.Process(target = self.sub_process_main,
2548
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1718
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2549
1719
""" adds a pipe to the MixIn """
2551
1720
def process_request(self, request, client_address):
2552
1721
"""Overrides and wraps the original process_request().
2554
1723
This function creates a new pipe in self.pipe
2556
1725
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2558
1727
proc = MultiprocessingMixIn.process_request(self, request,
2559
1728
client_address)
2560
1729
self.child_pipe.close()
2561
1730
self.add_pipe(parent_pipe, proc)
2563
1732
def add_pipe(self, parent_pipe, proc):
2564
1733
"""Dummy function; override as necessary"""
2565
raise NotImplementedError()
1734
raise NotImplementedError
2568
1737
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2569
socketserver.TCPServer):
1738
socketserver.TCPServer, object):
2570
1739
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2573
1742
enabled: Boolean; whether this server is activated yet
2574
1743
interface: None or a network interface name (string)
2575
1744
use_ipv6: Boolean; to use IPv6 or not
2578
1746
def __init__(self, server_address, RequestHandlerClass,
2582
"""If socketfd is set, use that file descriptor instead of
2583
creating a new one with socket.socket().
1747
interface=None, use_ipv6=True):
2585
1748
self.interface = interface
2587
1750
self.address_family = socket.AF_INET6
2588
if socketfd is not None:
2589
# Save the file descriptor
2590
self.socketfd = socketfd
2591
# Save the original socket.socket() function
2592
self.socket_socket = socket.socket
2594
# To implement --socket, we monkey patch socket.socket.
2596
# (When socketserver.TCPServer is a new-style class, we
2597
# could make self.socket into a property instead of monkey
2598
# patching socket.socket.)
2600
# Create a one-time-only replacement for socket.socket()
2601
@functools.wraps(socket.socket)
2602
def socket_wrapper(*args, **kwargs):
2603
# Restore original function so subsequent calls are
2605
socket.socket = self.socket_socket
2606
del self.socket_socket
2607
# This time only, return a new socket object from the
2608
# saved file descriptor.
2609
return socket.fromfd(self.socketfd, *args, **kwargs)
2610
# Replace socket.socket() function with wrapper
2611
socket.socket = socket_wrapper
2612
# The socketserver.TCPServer.__init__ will call
2613
# socket.socket(), which might be our replacement,
2614
# socket_wrapper(), if socketfd was set.
2615
1751
socketserver.TCPServer.__init__(self, server_address,
2616
1752
RequestHandlerClass)
2618
1753
def server_bind(self):
2619
1754
"""This overrides the normal server_bind() function
2620
1755
to bind to an interface if one was specified, and also NOT to
2621
1756
bind to an address or port if they were not specified."""
2622
global SO_BINDTODEVICE
2623
1757
if self.interface is not None:
2624
1758
if SO_BINDTODEVICE is None:
2625
# Fall back to a hard-coded value which seems to be
2627
logger.warning("SO_BINDTODEVICE not found, trying 25")
2628
SO_BINDTODEVICE = 25
2630
self.socket.setsockopt(
2631
socket.SOL_SOCKET, SO_BINDTODEVICE,
2632
(self.interface + "\0").encode("utf-8"))
2633
except socket.error as error:
2634
if error.errno == errno.EPERM:
2635
logger.error("No permission to bind to"
2636
" interface %s", self.interface)
2637
elif error.errno == errno.ENOPROTOOPT:
2638
logger.error("SO_BINDTODEVICE not available;"
2639
" cannot bind to interface %s",
2641
elif error.errno == errno.ENODEV:
2642
logger.error("Interface %s does not exist,"
2643
" cannot bind", self.interface)
1759
logger.error("SO_BINDTODEVICE does not exist;"
1760
" cannot bind to interface %s",
1764
self.socket.setsockopt(socket.SOL_SOCKET,
1768
except socket.error as error:
1769
if error[0] == errno.EPERM:
1770
logger.error("No permission to"
1771
" bind to interface %s",
1773
elif error[0] == errno.ENOPROTOOPT:
1774
logger.error("SO_BINDTODEVICE not available;"
1775
" cannot bind to interface %s",
2646
1779
# Only bind(2) the socket if we really need to.
2647
1780
if self.server_address[0] or self.server_address[1]:
2648
if self.server_address[1]:
2649
self.allow_reuse_address = True
2650
1781
if not self.server_address[0]:
2651
1782
if self.address_family == socket.AF_INET6:
2652
any_address = "::" # in6addr_any
1783
any_address = "::" # in6addr_any
2654
any_address = "0.0.0.0" # INADDR_ANY
1785
any_address = socket.INADDR_ANY
2655
1786
self.server_address = (any_address,
2656
1787
self.server_address[1])
2657
1788
elif not self.server_address[1]:
2658
self.server_address = (self.server_address[0], 0)
1789
self.server_address = (self.server_address[0],
2659
1791
# if self.interface:
2660
1792
# self.server_address = (self.server_address[0],
2691
1818
self.gnutls_priority = gnutls_priority
2692
1819
IPv6_TCPServer.__init__(self, server_address,
2693
1820
RequestHandlerClass,
2694
interface=interface,
1821
interface = interface,
1822
use_ipv6 = use_ipv6)
2698
1823
def server_activate(self):
2699
1824
if self.enabled:
2700
1825
return socketserver.TCPServer.server_activate(self)
2702
1827
def enable(self):
2703
1828
self.enabled = True
2705
1830
def add_pipe(self, parent_pipe, proc):
2706
1831
# Call "handle_ipc" for both data and EOF events
2708
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2709
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2710
functools.partial(self.handle_ipc,
2711
parent_pipe=parent_pipe,
2714
def handle_ipc(self, source, condition,
2717
client_object=None):
1832
gobject.io_add_watch(parent_pipe.fileno(),
1833
gobject.IO_IN | gobject.IO_HUP,
1834
functools.partial(self.handle_ipc,
1839
def handle_ipc(self, source, condition, parent_pipe=None,
1840
proc = None, client_object=None):
1842
gobject.IO_IN: "IN", # There is data to read.
1843
gobject.IO_OUT: "OUT", # Data can be written (without
1845
gobject.IO_PRI: "PRI", # There is urgent data to read.
1846
gobject.IO_ERR: "ERR", # Error condition.
1847
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1848
# broken, usually for pipes and
1851
conditions_string = ' | '.join(name
1853
condition_names.iteritems()
1854
if cond & condition)
2718
1855
# error, or the other end of multiprocessing.Pipe has closed
2719
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1856
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2720
1857
# Wait for other process to exit
2724
1861
# Read a request from the child
2725
1862
request = parent_pipe.recv()
2726
1863
command = request[0]
2728
1865
if command == 'init':
2729
key_id = request[1].decode("ascii")
2730
fpr = request[2].decode("ascii")
2731
address = request[3]
2733
for c in self.clients.values():
2734
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2735
"27AE41E4649B934CA495991B7852B855"):
2737
if key_id and c.key_id == key_id:
2740
if fpr and c.fingerprint == fpr:
1867
address = request[2]
1869
for c in self.clients.itervalues():
1870
if c.fingerprint == fpr:
2744
logger.info("Client not found for key ID: %s, address"
2745
": %s", key_id or fpr, address)
1874
logger.info("Client not found for fingerprint: %s, ad"
1875
"dress: %s", fpr, address)
2746
1876
if self.use_dbus:
2747
1877
# Emit D-Bus signal
2748
mandos_dbus_service.ClientNotFound(key_id or fpr,
1878
mandos_dbus_service.ClientNotFound(fpr,
2750
1880
parent_pipe.send(False)
2754
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2755
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2756
functools.partial(self.handle_ipc,
2757
parent_pipe=parent_pipe,
2759
client_object=client))
1883
gobject.io_add_watch(parent_pipe.fileno(),
1884
gobject.IO_IN | gobject.IO_HUP,
1885
functools.partial(self.handle_ipc,
2760
1891
parent_pipe.send(True)
2761
1892
# remove the old hook in favor of the new above hook on
2765
1896
funcname = request[1]
2766
1897
args = request[2]
2767
1898
kwargs = request[3]
2769
1900
parent_pipe.send(('data', getattr(client_object,
2770
1901
funcname)(*args,
2773
1904
if command == 'getattr':
2774
1905
attrname = request[1]
2775
if isinstance(client_object.__getattribute__(attrname),
2776
collections.abc.Callable):
2777
parent_pipe.send(('function', ))
1906
if callable(client_object.__getattribute__(attrname)):
1907
parent_pipe.send(('function',))
2780
'data', client_object.__getattribute__(attrname)))
1909
parent_pipe.send(('data', client_object
1910
.__getattribute__(attrname)))
2782
1912
if command == 'setattr':
2783
1913
attrname = request[1]
2784
1914
value = request[2]
2785
1915
setattr(client_object, attrname, value)
2790
def rfc3339_duration_to_delta(duration):
2791
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2793
>>> timedelta = datetime.timedelta
2794
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2796
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2798
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2800
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2802
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2804
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2806
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2811
# Parsing an RFC 3339 duration with regular expressions is not
2812
# possible - there would have to be multiple places for the same
2813
# values, like seconds. The current code, while more esoteric, is
2814
# cleaner without depending on a parsing library. If Python had a
2815
# built-in library for parsing we would use it, but we'd like to
2816
# avoid excessive use of external libraries.
2818
# New type for defining tokens, syntax, and semantics all-in-one
2819
Token = collections.namedtuple("Token", (
2820
"regexp", # To match token; if "value" is not None, must have
2821
# a "group" containing digits
2822
"value", # datetime.timedelta or None
2823
"followers")) # Tokens valid after this token
2824
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2825
# the "duration" ABNF definition in RFC 3339, Appendix A.
2826
token_end = Token(re.compile(r"$"), None, frozenset())
2827
token_second = Token(re.compile(r"(\d+)S"),
2828
datetime.timedelta(seconds=1),
2829
frozenset((token_end, )))
2830
token_minute = Token(re.compile(r"(\d+)M"),
2831
datetime.timedelta(minutes=1),
2832
frozenset((token_second, token_end)))
2833
token_hour = Token(re.compile(r"(\d+)H"),
2834
datetime.timedelta(hours=1),
2835
frozenset((token_minute, token_end)))
2836
token_time = Token(re.compile(r"T"),
2838
frozenset((token_hour, token_minute,
2840
token_day = Token(re.compile(r"(\d+)D"),
2841
datetime.timedelta(days=1),
2842
frozenset((token_time, token_end)))
2843
token_month = Token(re.compile(r"(\d+)M"),
2844
datetime.timedelta(weeks=4),
2845
frozenset((token_day, token_end)))
2846
token_year = Token(re.compile(r"(\d+)Y"),
2847
datetime.timedelta(weeks=52),
2848
frozenset((token_month, token_end)))
2849
token_week = Token(re.compile(r"(\d+)W"),
2850
datetime.timedelta(weeks=1),
2851
frozenset((token_end, )))
2852
token_duration = Token(re.compile(r"P"), None,
2853
frozenset((token_year, token_month,
2854
token_day, token_time,
2856
# Define starting values:
2858
value = datetime.timedelta()
2860
# Following valid tokens
2861
followers = frozenset((token_duration, ))
2862
# String left to parse
2864
# Loop until end token is found
2865
while found_token is not token_end:
2866
# Search for any currently valid tokens
2867
for token in followers:
2868
match = token.regexp.match(s)
2869
if match is not None:
2871
if token.value is not None:
2872
# Value found, parse digits
2873
factor = int(match.group(1), 10)
2874
# Add to value so far
2875
value += factor * token.value
2876
# Strip token from string
2877
s = token.regexp.sub("", s, 1)
2880
# Set valid next tokens
2881
followers = found_token.followers
2884
# No currently valid tokens were found
2885
raise ValueError("Invalid RFC 3339 duration: {!r}"
2891
1920
def string_to_delta(interval):
2892
1921
"""Parse a string and return a datetime.timedelta
2894
>>> string_to_delta('7d') == datetime.timedelta(7)
2896
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2898
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2900
>>> string_to_delta('24h') == datetime.timedelta(1)
2902
>>> string_to_delta('1w') == datetime.timedelta(7)
2904
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
1923
>>> string_to_delta('7d')
1924
datetime.timedelta(7)
1925
>>> string_to_delta('60s')
1926
datetime.timedelta(0, 60)
1927
>>> string_to_delta('60m')
1928
datetime.timedelta(0, 3600)
1929
>>> string_to_delta('24h')
1930
datetime.timedelta(1)
1931
>>> string_to_delta('1w')
1932
datetime.timedelta(7)
1933
>>> string_to_delta('5m 30s')
1934
datetime.timedelta(0, 330)
2909
return rfc3339_duration_to_delta(interval)
2913
1936
timevalue = datetime.timedelta(0)
2914
1937
for s in interval.split():
1939
suffix = unicode(s[-1])
2917
1940
value = int(s[:-1])
2918
1941
if suffix == "d":
2919
1942
delta = datetime.timedelta(value)
2991
2014
parser.add_argument("--no-dbus", action="store_false",
2992
2015
dest="use_dbus", help="Do not provide D-Bus"
2993
" system bus interface", default=None)
2016
" system bus interface")
2994
2017
parser.add_argument("--no-ipv6", action="store_false",
2995
dest="use_ipv6", help="Do not use IPv6",
2018
dest="use_ipv6", help="Do not use IPv6")
2997
2019
parser.add_argument("--no-restore", action="store_false",
2998
2020
dest="restore", help="Do not restore stored"
2999
" state", default=None)
3000
parser.add_argument("--socket", type=int,
3001
help="Specify a file descriptor to a network"
3002
" socket to use instead of creating one")
3003
2022
parser.add_argument("--statedir", metavar="DIR",
3004
2023
help="Directory to save/restore state in")
3005
parser.add_argument("--foreground", action="store_true",
3006
help="Run in foreground", default=None)
3007
parser.add_argument("--no-zeroconf", action="store_false",
3008
dest="zeroconf", help="Do not use Zeroconf",
3011
2025
options = parser.parse_args()
3013
2032
# Default values for config file for server-global settings
3014
if gnutls.has_rawpk:
3015
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3016
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3018
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3019
":+SIGN-DSA-SHA256")
3020
server_defaults = {"interface": "",
3024
"priority": priority,
3025
"servicename": "Mandos",
3031
"statedir": "/var/lib/mandos",
3032
"foreground": "False",
2033
server_defaults = { "interface": "",
2038
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2039
"servicename": "Mandos",
2044
"statedir": "/var/lib/mandos"
3037
2047
# Parse config file for server-global settings
3038
server_config = configparser.ConfigParser(server_defaults)
2048
server_config = configparser.SafeConfigParser(server_defaults)
3039
2049
del server_defaults
3040
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3041
# Convert the ConfigParser object to a dict
2050
server_config.read(os.path.join(options.configdir,
2052
# Convert the SafeConfigParser object to a dict
3042
2053
server_settings = server_config.defaults()
3043
2054
# Use the appropriate methods on the non-string config options
3044
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3045
"foreground", "zeroconf"):
2055
for option in ("debug", "use_dbus", "use_ipv6"):
3046
2056
server_settings[option] = server_config.getboolean("DEFAULT",
3048
2058
if server_settings["port"]:
3049
2059
server_settings["port"] = server_config.getint("DEFAULT",
3051
if server_settings["socket"]:
3052
server_settings["socket"] = server_config.getint("DEFAULT",
3054
# Later, stdin will, and stdout and stderr might, be dup'ed
3055
# over with an opened os.devnull. But we don't want this to
3056
# happen with a supplied network socket.
3057
if 0 <= server_settings["socket"] <= 2:
3058
server_settings["socket"] = os.dup(server_settings
3060
2061
del server_config
3062
2063
# Override the settings from the config file with command line
3063
2064
# options, if set.
3064
2065
for option in ("interface", "address", "port", "debug",
3065
"priority", "servicename", "configdir", "use_dbus",
3066
"use_ipv6", "debuglevel", "restore", "statedir",
3067
"socket", "foreground", "zeroconf"):
2066
"priority", "servicename", "configdir",
2067
"use_dbus", "use_ipv6", "debuglevel", "restore",
3068
2069
value = getattr(options, option)
3069
2070
if value is not None:
3070
2071
server_settings[option] = value
3072
2073
# Force all strings to be unicode
3073
2074
for option in server_settings.keys():
3074
if isinstance(server_settings[option], bytes):
3075
server_settings[option] = (server_settings[option]
3077
# Force all boolean options to be boolean
3078
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3079
"foreground", "zeroconf"):
3080
server_settings[option] = bool(server_settings[option])
3081
# Debug implies foreground
3082
if server_settings["debug"]:
3083
server_settings["foreground"] = True
2075
if type(server_settings[option]) is str:
2076
server_settings[option] = unicode(server_settings[option])
3084
2077
# Now we have our good server settings in "server_settings"
3086
2079
##################################################################
3088
if (not server_settings["zeroconf"]
3089
and not (server_settings["port"]
3090
or server_settings["socket"] != "")):
3091
parser.error("Needs port or socket to work without Zeroconf")
3093
2081
# For convenience
3094
2082
debug = server_settings["debug"]
3095
2083
debuglevel = server_settings["debuglevel"]
3109
2095
level = getattr(logging, debuglevel.upper())
3110
2096
initlogger(debug, level)
3112
2098
if server_settings["servicename"] != "Mandos":
3113
syslogger.setFormatter(
3114
logging.Formatter('Mandos ({}) [%(process)d]:'
3115
' %(levelname)s: %(message)s'.format(
3116
server_settings["servicename"])))
2099
syslogger.setFormatter(logging.Formatter
2100
('Mandos (%s) [%%(process)d]:'
2101
' %%(levelname)s: %%(message)s'
2102
% server_settings["servicename"]))
3118
2104
# Parse config file with clients
3119
client_config = configparser.ConfigParser(Client.client_defaults)
2105
client_config = configparser.SafeConfigParser(Client
3120
2107
client_config.read(os.path.join(server_settings["configdir"],
3121
2108
"clients.conf"))
3123
2110
global mandos_dbus_service
3124
2111
mandos_dbus_service = None
3127
if server_settings["socket"] != "":
3128
socketfd = server_settings["socket"]
3129
tcp_server = MandosServer(
3130
(server_settings["address"], server_settings["port"]),
3132
interface=(server_settings["interface"] or None),
3134
gnutls_priority=server_settings["priority"],
3138
pidfilename = "/run/mandos.pid"
3139
if not os.path.isdir("/run/."):
3140
pidfilename = "/var/run/mandos.pid"
3143
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3144
except IOError as e:
3145
logger.error("Could not open file %r", pidfilename,
3148
for name, group in (("_mandos", "_mandos"),
3149
("mandos", "mandos"),
3150
("nobody", "nogroup")):
3152
uid = pwd.getpwnam(name).pw_uid
3153
gid = pwd.getpwnam(group).pw_gid
2113
tcp_server = MandosServer((server_settings["address"],
2114
server_settings["port"]),
2116
interface=(server_settings["interface"]
2120
server_settings["priority"],
2123
pidfilename = "/var/run/mandos.pid"
2125
pidfile = open(pidfilename, "w")
2127
logger.error("Could not open file %r", pidfilename)
2130
uid = pwd.getpwnam("_mandos").pw_uid
2131
gid = pwd.getpwnam("_mandos").pw_gid
2134
uid = pwd.getpwnam("mandos").pw_uid
2135
gid = pwd.getpwnam("mandos").pw_gid
3155
2136
except KeyError:
2138
uid = pwd.getpwnam("nobody").pw_uid
2139
gid = pwd.getpwnam("nobody").pw_gid
3164
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3166
2146
except OSError as error:
3167
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3168
.format(uid, gid, os.strerror(error.errno)))
3169
if error.errno != errno.EPERM:
2147
if error[0] != errno.EPERM:
3173
2151
# Enable all possible GnuTLS debugging
3175
2153
# "Use a log level over 10 to enable all debugging options."
3176
2154
# - GnuTLS manual
3177
gnutls.global_set_log_level(11)
2155
gnutls.library.functions.gnutls_global_set_log_level(11)
2157
@gnutls.library.types.gnutls_log_func
3180
2158
def debug_gnutls(level, string):
3181
2159
logger.debug("GnuTLS: %s", string[:-1])
3183
gnutls.global_set_log_function(debug_gnutls)
2161
(gnutls.library.functions
2162
.gnutls_global_set_log_function(debug_gnutls))
3185
2164
# Redirect stdin so all checkers get /dev/null
3186
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2165
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3187
2166
os.dup2(null, sys.stdin.fileno())
3191
2170
# Need to fork before connecting to D-Bus
3193
2172
# Close all input and output, do double fork, etc.
3196
if gi.version_info < (3, 10, 2):
3197
# multiprocessing will use threads, so before we use GLib we
3198
# need to inform GLib that threads will be used.
2175
gobject.threads_init()
3201
2177
global main_loop
3202
2178
# From the Avahi example code
3203
DBusGMainLoop(set_as_default=True)
3204
main_loop = GLib.MainLoop()
2179
DBusGMainLoop(set_as_default=True )
2180
main_loop = gobject.MainLoop()
3205
2181
bus = dbus.SystemBus()
3206
2182
# End of Avahi example code
3209
2185
bus_name = dbus.service.BusName("se.recompile.Mandos",
3212
old_bus_name = dbus.service.BusName(
3213
"se.bsnet.fukt.Mandos", bus,
3215
except dbus.exceptions.DBusException as e:
3216
logger.error("Disabling D-Bus:", exc_info=e)
2186
bus, do_not_queue=True)
2187
old_bus_name = (dbus.service.BusName
2188
("se.bsnet.fukt.Mandos", bus,
2190
except dbus.exceptions.NameExistsException as e:
2191
logger.error(unicode(e) + ", disabling D-Bus")
3217
2192
use_dbus = False
3218
2193
server_settings["use_dbus"] = False
3219
2194
tcp_server.use_dbus = False
3221
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3222
service = AvahiServiceToSyslog(
3223
name=server_settings["servicename"],
3224
servicetype="_mandos._tcp",
3227
if server_settings["interface"]:
3228
service.interface = if_nametoindex(
3229
server_settings["interface"].encode("utf-8"))
2195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2196
service = AvahiServiceToSyslog(name =
2197
server_settings["servicename"],
2198
servicetype = "_mandos._tcp",
2199
protocol = protocol, bus = bus)
2200
if server_settings["interface"]:
2201
service.interface = (if_nametoindex
2202
(str(server_settings["interface"])))
3231
2204
global multiprocessing_manager
3232
2205
multiprocessing_manager = multiprocessing.Manager()
3234
2207
client_class = Client
3236
client_class = functools.partial(ClientDBus, bus=bus)
2209
client_class = functools.partial(ClientDBusTransitional,
3238
2212
client_settings = Client.config_parser(client_config)
3239
2213
old_client_settings = {}
3240
2214
clients_data = {}
3242
# This is used to redirect stdout and stderr for checker processes
3244
wnull = open(os.devnull, "w") # A writable /dev/null
3245
# Only used if server is running in foreground but not in debug
3247
if debug or not foreground:
3250
2216
# Get client data and settings from last running state.
3251
2217
if server_settings["restore"]:
3253
2219
with open(stored_state_path, "rb") as stored_state:
3254
if sys.version_info.major == 2:
3255
clients_data, old_client_settings = pickle.load(
3258
bytes_clients_data, bytes_old_client_settings = (
3259
pickle.load(stored_state, encoding="bytes"))
3260
# Fix bytes to strings
3263
clients_data = {(key.decode("utf-8")
3264
if isinstance(key, bytes)
3267
bytes_clients_data.items()}
3268
del bytes_clients_data
3269
for key in clients_data:
3270
value = {(k.decode("utf-8")
3271
if isinstance(k, bytes) else k): v
3273
clients_data[key].items()}
3274
clients_data[key] = value
3276
value["client_structure"] = [
3278
if isinstance(s, bytes)
3280
value["client_structure"]]
3281
# .name, .host, and .checker_command
3282
for k in ("name", "host", "checker_command"):
3283
if isinstance(value[k], bytes):
3284
value[k] = value[k].decode("utf-8")
3285
if "key_id" not in value:
3286
value["key_id"] = ""
3287
elif "fingerprint" not in value:
3288
value["fingerprint"] = ""
3289
# old_client_settings
3291
old_client_settings = {
3292
(key.decode("utf-8")
3293
if isinstance(key, bytes)
3296
bytes_old_client_settings.items()}
3297
del bytes_old_client_settings
3298
# .host and .checker_command
3299
for value in old_client_settings.values():
3300
for attribute in ("host", "checker_command"):
3301
if isinstance(value[attribute], bytes):
3302
value[attribute] = (value[attribute]
2220
clients_data, old_client_settings = (pickle.load
3304
2222
os.remove(stored_state_path)
3305
2223
except IOError as e:
3306
if e.errno == errno.ENOENT:
3307
logger.warning("Could not load persistent state:"
3308
" {}".format(os.strerror(e.errno)))
3310
logger.critical("Could not load persistent state:",
2224
logger.warning("Could not load persistent state: {0}"
2226
if e.errno != errno.ENOENT:
3313
2228
except EOFError as e:
3314
2229
logger.warning("Could not load persistent state: "
2230
"EOFError: {0}".format(e))
3318
2232
with PGPEngine() as pgp:
3319
for client_name, client in clients_data.items():
3320
# Skip removed clients
3321
if client_name not in client_settings:
2233
for client_name, client in clients_data.iteritems():
3324
2234
# Decide which value to use after restoring saved state.
3325
2235
# We have three different values: Old config file,
3326
2236
# new config file, and saved state.
3385
2295
- set(old_client_settings)):
3386
2296
clients_data[client_name] = client_settings[client_name]
3388
# Create all client objects
3389
for client_name, client in clients_data.items():
2298
# Create clients all clients
2299
for client_name, client in clients_data.iteritems():
3390
2300
tcp_server.clients[client_name] = client_class(
3393
server_settings=server_settings)
2301
name = client_name, settings = client)
3395
2303
if not tcp_server.clients:
3396
2304
logger.warning("No clients defined")
3399
if pidfile is not None:
3403
print(pid, file=pidfile)
3405
logger.error("Could not write to file %r with PID %d",
2310
pidfile.write(str(pid) + "\n".encode("utf-8"))
2313
logger.error("Could not write to file %r with PID %d",
2316
# "pidfile" was never created
3408
2318
del pidfilename
3410
for termsig in (signal.SIGHUP, signal.SIGTERM):
3411
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3412
lambda: main_loop.quit() and False)
2319
signal.signal(signal.SIGINT, signal.SIG_IGN)
2321
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2322
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3416
@alternate_dbus_interfaces(
3417
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3418
class MandosDBusService(DBusObjectWithObjectManager):
2325
class MandosDBusService(dbus.service.Object):
3419
2326
"""A D-Bus proxy object"""
3421
2327
def __init__(self):
3422
2328
dbus.service.Object.__init__(self, bus, "/")
3424
2329
_interface = "se.recompile.Mandos"
3426
2331
@dbus.service.signal(_interface, signature="o")
3427
2332
def ClientAdded(self, objpath):
3431
2336
@dbus.service.signal(_interface, signature="ss")
3432
def ClientNotFound(self, key_id, address):
2337
def ClientNotFound(self, fingerprint, address):
3436
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3438
2341
@dbus.service.signal(_interface, signature="os")
3439
2342
def ClientRemoved(self, objpath, name):
3443
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3445
2346
@dbus.service.method(_interface, out_signature="ao")
3446
2347
def GetAllClients(self):
3448
return dbus.Array(c.dbus_object_path for c in
3449
tcp_server.clients.values())
3451
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2349
return dbus.Array(c.dbus_object_path
2351
tcp_server.clients.itervalues())
3453
2353
@dbus.service.method(_interface,
3454
2354
out_signature="a{oa{sv}}")
3455
2355
def GetAllClientsWithProperties(self):
3457
2357
return dbus.Dictionary(
3458
{c.dbus_object_path: c.GetAll(
3459
"se.recompile.Mandos.Client")
3460
for c in tcp_server.clients.values()},
2358
((c.dbus_object_path, c.GetAll(""))
2359
for c in tcp_server.clients.itervalues()),
3461
2360
signature="oa{sv}")
3463
2362
@dbus.service.method(_interface, in_signature="o")
3464
2363
def RemoveClient(self, object_path):
3466
for c in tcp_server.clients.values():
2365
for c in tcp_server.clients.itervalues():
3467
2366
if c.dbus_object_path == object_path:
3468
2367
del tcp_server.clients[c.name]
3469
2368
c.remove_from_connection()
3470
# Don't signal the disabling
2369
# Don't signal anything except ClientRemoved
3471
2370
c.disable(quiet=True)
3472
# Emit D-Bus signal for removal
3473
self.client_removed_signal(c)
2372
self.ClientRemoved(object_path, c.name)
3475
2374
raise KeyError(object_path)
3479
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3480
out_signature="a{oa{sa{sv}}}")
3481
def GetManagedObjects(self):
3483
return dbus.Dictionary(
3484
{client.dbus_object_path:
3486
{interface: client.GetAll(interface)
3488
client._get_all_interface_names()})
3489
for client in tcp_server.clients.values()})
3491
def client_added_signal(self, client):
3492
"""Send the new standard signal and the old signal"""
3494
# New standard signal
3495
self.InterfacesAdded(
3496
client.dbus_object_path,
3498
{interface: client.GetAll(interface)
3500
client._get_all_interface_names()}))
3502
self.ClientAdded(client.dbus_object_path)
3504
def client_removed_signal(self, client):
3505
"""Send the new standard signal and the old signal"""
3507
# New standard signal
3508
self.InterfacesRemoved(
3509
client.dbus_object_path,
3510
client._get_all_interface_names())
3512
self.ClientRemoved(client.dbus_object_path,
3515
mandos_dbus_service = MandosDBusService()
3517
# Save modules to variables to exempt the modules from being
3518
# unloaded before the function registered with atexit() is run.
3519
mp = multiprocessing
2378
class MandosDBusServiceTransitional(MandosDBusService):
2379
__metaclass__ = AlternateDBusNamesMetaclass
2380
mandos_dbus_service = MandosDBusServiceTransitional()
3523
2383
"Cleanup function; run on exit"
3527
mp.active_children()
2386
multiprocessing.active_children()
3529
2387
if not (tcp_server.clients or client_settings):
3532
2390
# Store client before exiting. Secrets are encrypted with key
3533
2391
# based on what config file has. If config file is
3534
2392
# removed/edited, old secret will thus be unrecovable.
3536
2394
with PGPEngine() as pgp:
3537
for client in tcp_server.clients.values():
2395
for client in tcp_server.clients.itervalues():
3538
2396
key = client_settings[client.name]["secret"]
3539
2397
client.encrypted_secret = pgp.encrypt(client.secret,
3541
2399
client_dict = {}
3543
2401
# A list of attributes that can not be pickled
3545
exclude = {"bus", "changedstate", "secret",
3546
"checker", "server_settings"}
3547
for name, typ in inspect.getmembers(dbus.service
2403
exclude = set(("bus", "changedstate", "secret",
2405
for name, typ in (inspect.getmembers
2406
(dbus.service.Object)):
3549
2407
exclude.add(name)
3551
2409
client_dict["encrypted_secret"] = (client
3552
2410
.encrypted_secret)
3553
2411
for attr in client.client_structure:
3554
2412
if attr not in exclude:
3555
2413
client_dict[attr] = getattr(client, attr)
3557
2415
clients[client.name] = client_dict
3558
2416
del client_settings[client.name]["secret"]
3561
with tempfile.NamedTemporaryFile(
3565
dir=os.path.dirname(stored_state_path),
3566
delete=False) as stored_state:
3567
pickle.dump((clients, client_settings), stored_state,
3569
tempname = stored_state.name
2419
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2422
(stored_state_path))
2423
with os.fdopen(tempfd, "wb") as stored_state:
2424
pickle.dump((clients, client_settings), stored_state)
3570
2425
os.rename(tempname, stored_state_path)
3571
2426
except (IOError, OSError) as e:
2427
logger.warning("Could not save persistent state: {0}"
3574
2431
os.remove(tempname)
3575
2432
except NameError:
3577
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3578
logger.warning("Could not save persistent state: {}"
3579
.format(os.strerror(e.errno)))
3581
logger.warning("Could not save persistent state:",
2434
if e.errno not in set((errno.ENOENT, errno.EACCES,
3585
2438
# Delete all clients, and settings from config
3586
2439
while tcp_server.clients:
3587
2440
name, client = tcp_server.clients.popitem()
3589
2442
client.remove_from_connection()
3590
# Don't signal the disabling
2443
# Don't signal anything except ClientRemoved
3591
2444
client.disable(quiet=True)
3592
# Emit D-Bus signal for removal
3594
mandos_dbus_service.client_removed_signal(client)
2447
mandos_dbus_service.ClientRemoved(client
3595
2450
client_settings.clear()
3597
2452
atexit.register(cleanup)
3599
for client in tcp_server.clients.values():
2454
for client in tcp_server.clients.itervalues():
3601
# Emit D-Bus signal for adding
3602
mandos_dbus_service.client_added_signal(client)
2457
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3603
2458
# Need to initiate checking of clients
3604
2459
if client.enabled:
3605
2460
client.init_checker()
3607
2462
tcp_server.enable()
3608
2463
tcp_server.server_activate()
3610
2465
# Find out what port we got
3612
service.port = tcp_server.socket.getsockname()[1]
2466
service.port = tcp_server.socket.getsockname()[1]
3614
2468
logger.info("Now listening on address %r, port %d,"
3615
" flowinfo %d, scope_id %d",
3616
*tcp_server.socket.getsockname())
2469
" flowinfo %d, scope_id %d"
2470
% tcp_server.socket.getsockname())
3618
logger.info("Now listening on address %r, port %d",
3619
*tcp_server.socket.getsockname())
3621
# service.interface = tcp_server.socket.getsockname()[3]
2472
logger.info("Now listening on address %r, port %d"
2473
% tcp_server.socket.getsockname())
2475
#service.interface = tcp_server.socket.getsockname()[3]
3625
# From the Avahi example code
3628
except dbus.exceptions.DBusException as error:
3629
logger.critical("D-Bus Exception", exc_info=error)
3632
# End of Avahi example code
3635
GLib.IOChannel.unix_new(tcp_server.fileno()),
3636
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3637
lambda *args, **kwargs: (tcp_server.handle_request
3638
(*args[2:], **kwargs) or True))
2478
# From the Avahi example code
2481
except dbus.exceptions.DBusException as error:
2482
logger.critical("DBusException: %s", error)
2485
# End of Avahi example code
2487
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2488
lambda *args, **kwargs:
2489
(tcp_server.handle_request
2490
(*args[2:], **kwargs) or True))
3640
2492
logger.debug("Starting main loop")
3641
2493
main_loop.run()
3642
2494
except AvahiError as error:
3643
logger.critical("Avahi Error", exc_info=error)
2495
logger.critical("AvahiError: %s", error)
3646
2498
except KeyboardInterrupt: