63
import cPickle as pickle
70
import cPickle as pickle
64
73
import multiprocessing
70
85
import dbus.service
87
from gi.repository import GLib
73
88
from dbus.mainloop.glib import DBusGMainLoop
76
91
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:
81
122
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
82
123
except AttributeError:
125
# This is where SO_BINDTODEVICE was up to and including Python
84
127
from IN import SO_BINDTODEVICE
85
128
except ImportError:
86
SO_BINDTODEVICE = None
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
89
147
stored_state_file = "clients.pickle"
91
149
logger = logging.getLogger()
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
150
logging.captureWarnings(True) # Show warnings via the logging system
97
if_nametoindex = (ctypes.cdll.LoadLibrary
98
(ctypes.util.find_library("c"))
154
if_nametoindex = ctypes.cdll.LoadLibrary(
155
ctypes.util.find_library("c")).if_nametoindex
100
156
except (OSError, AttributeError):
101
158
def if_nametoindex(interface):
102
159
"Get an interface index the hard way, i.e. using fcntl()"
103
160
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
104
161
with contextlib.closing(socket.socket()) as s:
105
162
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
106
struct.pack(str("16s16x"),
108
interface_index = struct.unpack(str("I"),
163
struct.pack(b"16s16x", interface))
164
interface_index = struct.unpack("I", ifreq[16:20])[0]
110
165
return interface_index
168
def copy_function(func):
169
"""Make a copy of a function"""
170
if sys.version_info.major == 2:
171
return types.FunctionType(func.func_code,
177
return types.FunctionType(func.__code__,
113
184
def initlogger(debug, level=logging.WARNING):
114
185
"""init logger and add loglevel"""
188
syslogger = (logging.handlers.SysLogHandler(
189
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
116
191
syslogger.setFormatter(logging.Formatter
117
192
('Mandos [%(process)d]: %(levelname)s:'
119
194
logger.addHandler(syslogger)
122
197
console = logging.StreamHandler()
123
198
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
168
255
os.rmdir(self.tempdir)
169
256
self.tempdir = None
171
258
def password_encode(self, password):
172
259
# Passphrase can not be empty and can not contain newlines or
173
260
# NUL bytes. So we prefix it and hex encode it.
174
return b"mandos" + binascii.hexlify(password)
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"))
176
269
def encrypt(self, data, password):
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
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:
191
285
return ciphertext
193
287
def decrypt(self, data, password):
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
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:
208
303
return decrypted_plaintext
306
# Pretend that we have an Avahi module
308
"""This isn't so much a class as it is a module-like namespace."""
309
IF_UNSPEC = -1 # avahi-common/address.h
310
PROTO_UNSPEC = -1 # avahi-common/address.h
311
PROTO_INET = 0 # avahi-common/address.h
312
PROTO_INET6 = 1 # avahi-common/address.h
313
DBUS_NAME = "org.freedesktop.Avahi"
314
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
315
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
316
DBUS_PATH_SERVER = "/"
319
def string_array_to_txt_array(t):
320
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
321
for s in t), signature="ay")
322
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
323
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
324
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
325
SERVER_INVALID = 0 # avahi-common/defs.h
326
SERVER_REGISTERING = 1 # avahi-common/defs.h
327
SERVER_RUNNING = 2 # avahi-common/defs.h
328
SERVER_COLLISION = 3 # avahi-common/defs.h
329
SERVER_FAILURE = 4 # avahi-common/defs.h
212
332
class AvahiError(Exception):
213
333
def __init__(self, value, *args, **kwargs):
214
334
self.value = value
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
335
return super(AvahiError, self).__init__(value, *args,
219
339
class AvahiServiceError(AvahiError):
222
343
class AvahiGroupError(AvahiError):
226
class AvahiService(object):
227
348
"""An Avahi (Zeroconf) service.
230
351
interface: integer; avahi.IF_UNSPEC or an interface index.
231
352
Used to optionally bind to the specified interface.
232
353
name: string; Example: 'Mandos'
233
354
type: string; Example: '_mandos._tcp'.
234
See <http://www.dns-sd.org/ServiceTypes.html>
355
See <https://www.iana.org/assignments/service-names-port-numbers>
235
356
port: integer; what port to announce
236
357
TXT: list of strings; TXT record for the service
237
358
domain: string; Domain to publish on, default to .local if empty.
366
517
follow_name_owner_changes=True),
367
518
avahi.DBUS_INTERFACE_SERVER)
368
519
self.server.connect_to_signal("StateChanged",
369
self.server_state_changed)
520
self.server_state_changed)
370
521
self.server_state_changed(self.server.GetState())
372
524
class AvahiServiceToSyslog(AvahiService):
525
def rename(self, *args, **kwargs):
374
526
"""Add the new name to the syslog messages"""
375
ret = AvahiService.rename(self)
376
syslogger.setFormatter(logging.Formatter
377
('Mandos (%s) [%%(process)d]:'
378
' %%(levelname)s: %%(message)s'
527
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
528
syslogger.setFormatter(logging.Formatter(
529
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
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):
534
# Pretend that we have a GnuTLS module
536
"""This isn't so much a class as it is a module-like namespace."""
538
library = ctypes.util.find_library("gnutls")
540
library = ctypes.util.find_library("gnutls-deb0")
541
_library = ctypes.cdll.LoadLibrary(library)
544
# Unless otherwise indicated, the constants and types below are
545
# all from the gnutls/gnutls.h C header file.
556
E_NO_CERTIFICATE_FOUND = -49
561
KEYID_USE_SHA256 = 1 # gnutls/x509.h
562
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
565
class session_int(ctypes.Structure):
567
session_t = ctypes.POINTER(session_int)
569
class certificate_credentials_st(ctypes.Structure):
571
certificate_credentials_t = ctypes.POINTER(
572
certificate_credentials_st)
573
certificate_type_t = ctypes.c_int
575
class datum_t(ctypes.Structure):
576
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
577
('size', ctypes.c_uint)]
579
class openpgp_crt_int(ctypes.Structure):
581
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
583
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
credentials_type_t = ctypes.c_int
585
transport_ptr_t = ctypes.c_void_p
586
close_request_t = ctypes.c_int
589
class Error(Exception):
590
def __init__(self, message=None, code=None, args=()):
591
# Default usage is by a message string, but if a return
592
# code is passed, convert it to a string with
595
if message is None and code is not None:
596
message = gnutls.strerror(code)
597
return super(gnutls.Error, self).__init__(
600
class CertificateSecurityError(Error):
606
self._c_object = gnutls.certificate_credentials_t()
607
gnutls.certificate_allocate_credentials(
608
ctypes.byref(self._c_object))
609
self.type = gnutls.CRD_CERTIFICATE
612
gnutls.certificate_free_credentials(self._c_object)
615
def __init__(self, socket, credentials=None):
616
self._c_object = gnutls.session_t()
617
gnutls_flags = gnutls.CLIENT
618
if gnutls.check_version(b"3.5.6"):
619
gnutls_flags |= gnutls.NO_TICKETS
621
gnutls_flags |= gnutls.ENABLE_RAWPK
622
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
624
gnutls.set_default_priority(self._c_object)
625
gnutls.transport_set_ptr(self._c_object, socket.fileno())
626
gnutls.handshake_set_private_extensions(self._c_object,
629
if credentials is None:
630
credentials = gnutls.Credentials()
631
gnutls.credentials_set(self._c_object, credentials.type,
632
ctypes.cast(credentials._c_object,
634
self.credentials = credentials
637
gnutls.deinit(self._c_object)
640
return gnutls.handshake(self._c_object)
642
def send(self, data):
646
data_len -= gnutls.record_send(self._c_object,
651
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
653
# Error handling functions
654
def _error_code(result):
655
"""A function to raise exceptions on errors, suitable
656
for the 'restype' attribute on ctypes functions"""
659
if result == gnutls.E_NO_CERTIFICATE_FOUND:
660
raise gnutls.CertificateSecurityError(code=result)
661
raise gnutls.Error(code=result)
663
def _retry_on_error(result, func, arguments):
664
"""A function to retry on some errors, suitable
665
for the 'errcheck' attribute on ctypes functions"""
667
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
668
return _error_code(result)
669
result = func(*arguments)
672
# Unless otherwise indicated, the function declarations below are
673
# all from the gnutls/gnutls.h C header file.
676
priority_set_direct = _library.gnutls_priority_set_direct
677
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
678
ctypes.POINTER(ctypes.c_char_p)]
679
priority_set_direct.restype = _error_code
681
init = _library.gnutls_init
682
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
683
init.restype = _error_code
685
set_default_priority = _library.gnutls_set_default_priority
686
set_default_priority.argtypes = [session_t]
687
set_default_priority.restype = _error_code
689
record_send = _library.gnutls_record_send
690
record_send.argtypes = [session_t, ctypes.c_void_p,
692
record_send.restype = ctypes.c_ssize_t
693
record_send.errcheck = _retry_on_error
695
certificate_allocate_credentials = (
696
_library.gnutls_certificate_allocate_credentials)
697
certificate_allocate_credentials.argtypes = [
698
ctypes.POINTER(certificate_credentials_t)]
699
certificate_allocate_credentials.restype = _error_code
701
certificate_free_credentials = (
702
_library.gnutls_certificate_free_credentials)
703
certificate_free_credentials.argtypes = [
704
certificate_credentials_t]
705
certificate_free_credentials.restype = None
707
handshake_set_private_extensions = (
708
_library.gnutls_handshake_set_private_extensions)
709
handshake_set_private_extensions.argtypes = [session_t,
711
handshake_set_private_extensions.restype = None
713
credentials_set = _library.gnutls_credentials_set
714
credentials_set.argtypes = [session_t, credentials_type_t,
716
credentials_set.restype = _error_code
718
strerror = _library.gnutls_strerror
719
strerror.argtypes = [ctypes.c_int]
720
strerror.restype = ctypes.c_char_p
722
certificate_type_get = _library.gnutls_certificate_type_get
723
certificate_type_get.argtypes = [session_t]
724
certificate_type_get.restype = _error_code
726
certificate_get_peers = _library.gnutls_certificate_get_peers
727
certificate_get_peers.argtypes = [session_t,
728
ctypes.POINTER(ctypes.c_uint)]
729
certificate_get_peers.restype = ctypes.POINTER(datum_t)
731
global_set_log_level = _library.gnutls_global_set_log_level
732
global_set_log_level.argtypes = [ctypes.c_int]
733
global_set_log_level.restype = None
735
global_set_log_function = _library.gnutls_global_set_log_function
736
global_set_log_function.argtypes = [log_func]
737
global_set_log_function.restype = None
739
deinit = _library.gnutls_deinit
740
deinit.argtypes = [session_t]
741
deinit.restype = None
743
handshake = _library.gnutls_handshake
744
handshake.argtypes = [session_t]
745
handshake.restype = _error_code
746
handshake.errcheck = _retry_on_error
748
transport_set_ptr = _library.gnutls_transport_set_ptr
749
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
750
transport_set_ptr.restype = None
752
bye = _library.gnutls_bye
753
bye.argtypes = [session_t, close_request_t]
754
bye.restype = _error_code
755
bye.errcheck = _retry_on_error
757
check_version = _library.gnutls_check_version
758
check_version.argtypes = [ctypes.c_char_p]
759
check_version.restype = ctypes.c_char_p
761
_need_version = b"3.3.0"
762
if check_version(_need_version) is None:
763
raise self.Error("Needs GnuTLS {} or later"
764
.format(_need_version))
766
_tls_rawpk_version = b"3.6.6"
767
has_rawpk = bool(check_version(_tls_rawpk_version))
771
class pubkey_st(ctypes.Structure):
773
pubkey_t = ctypes.POINTER(pubkey_st)
775
x509_crt_fmt_t = ctypes.c_int
777
# All the function declarations below are from gnutls/abstract.h
778
pubkey_init = _library.gnutls_pubkey_init
779
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
780
pubkey_init.restype = _error_code
782
pubkey_import = _library.gnutls_pubkey_import
783
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
785
pubkey_import.restype = _error_code
787
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
788
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
789
ctypes.POINTER(ctypes.c_ubyte),
790
ctypes.POINTER(ctypes.c_size_t)]
791
pubkey_get_key_id.restype = _error_code
793
pubkey_deinit = _library.gnutls_pubkey_deinit
794
pubkey_deinit.argtypes = [pubkey_t]
795
pubkey_deinit.restype = None
797
# All the function declarations below are from gnutls/openpgp.h
799
openpgp_crt_init = _library.gnutls_openpgp_crt_init
800
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
801
openpgp_crt_init.restype = _error_code
803
openpgp_crt_import = _library.gnutls_openpgp_crt_import
804
openpgp_crt_import.argtypes = [openpgp_crt_t,
805
ctypes.POINTER(datum_t),
807
openpgp_crt_import.restype = _error_code
809
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
810
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
811
ctypes.POINTER(ctypes.c_uint)]
812
openpgp_crt_verify_self.restype = _error_code
814
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
815
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
816
openpgp_crt_deinit.restype = None
818
openpgp_crt_get_fingerprint = (
819
_library.gnutls_openpgp_crt_get_fingerprint)
820
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
824
openpgp_crt_get_fingerprint.restype = _error_code
826
if check_version(b"3.6.4"):
827
certificate_type_get2 = _library.gnutls_certificate_type_get2
828
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
829
certificate_type_get2.restype = _error_code
831
# Remove non-public functions
832
del _error_code, _retry_on_error
835
def call_pipe(connection, # : multiprocessing.Connection
836
func, *args, **kwargs):
837
"""This function is meant to be called by multiprocessing.Process
839
This function runs func(*args, **kwargs), and writes the resulting
840
return value on the provided multiprocessing.Connection.
842
connection.send(func(*args, **kwargs))
389
847
"""A representation of a client host served by this server.
392
850
approved: bool(); 'None' if not yet approved/disapproved
393
851
approval_delay: datetime.timedelta(); Time to wait for approval
394
852
approval_duration: datetime.timedelta(); Duration of one approval
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
853
checker: multiprocessing.Process(); a running checker process used
854
to see if the client lives. 'None' if no process is
856
checker_callback_tag: a GLib event source tag, or None
399
857
checker_command: string; External command which is run to check
400
858
if client lives. %() expansions are done at
401
859
runtime with vars(self) as dict, so that for
402
860
instance %(name)s can be used in the command.
403
checker_initiator_tag: a gobject event source tag, or None
861
checker_initiator_tag: a GLib event source tag, or None
404
862
created: datetime.datetime(); (UTC) object creation
405
863
client_structure: Object describing what attributes a client has
406
864
and is used for storing the client at exit
407
865
current_checker_command: string; current running checker_command
408
disable_initiator_tag: a gobject event source tag, or None
866
disable_initiator_tag: a GLib event source tag, or None
410
868
fingerprint: string (40 or 32 hexadecimal digits); used to
411
uniquely identify the client
869
uniquely identify an OpenPGP client
870
key_id: string (64 hexadecimal digits); used to uniquely identify
871
a client using raw public keys
412
872
host: string; available for use by the checker command
413
873
interval: datetime.timedelta(); How often to start a new checker
414
874
last_approval_request: datetime.datetime(); (UTC) or None
415
875
last_checked_ok: datetime.datetime(); (UTC) or None
416
876
last_checker_status: integer between 0 and 255 reflecting exit
417
877
status of last checker. -1 reflects crashed
878
checker, -2 means no checker completed yet.
879
last_checker_signal: The signal which killed the last checker, if
880
last_checker_status is -1
419
881
last_enabled: datetime.datetime(); (UTC) or None
420
882
name: string; from the config file, used in log messages and
421
883
D-Bus identifiers
541
995
self.current_checker_command = None
542
996
self.approved = None
543
997
self.approvals_pending = 0
544
self.changedstate = (multiprocessing_manager
545
.Condition(multiprocessing_manager
547
self.client_structure = [attr for attr in
548
self.__dict__.iterkeys()
998
self.changedstate = multiprocessing_manager.Condition(
999
multiprocessing_manager.Lock())
1000
self.client_structure = [attr
1001
for attr in self.__dict__.keys()
549
1002
if not attr.startswith("_")]
550
1003
self.client_structure.append("client_structure")
552
for name, t in inspect.getmembers(type(self),
1005
for name, t in inspect.getmembers(
1006
type(self), lambda obj: isinstance(obj, property)):
556
1007
if not name.startswith("_"):
557
1008
self.client_structure.append(name)
559
1010
# Send notice to process children that client state has changed
560
1011
def send_changedstate(self):
561
1012
with self.changedstate:
562
1013
self.changedstate.notify_all()
564
1015
def enable(self):
565
1016
"""Start this client's checker and timeout hooks"""
566
1017
if getattr(self, "enabled", False):
567
1018
# Already enabled
569
self.send_changedstate()
570
1020
self.expires = datetime.datetime.utcnow() + self.timeout
571
1021
self.enabled = True
572
1022
self.last_enabled = datetime.datetime.utcnow()
573
1023
self.init_checker()
1024
self.send_changedstate()
575
1026
def disable(self, quiet=True):
576
1027
"""Disable this client."""
577
1028
if not getattr(self, "enabled", False):
580
self.send_changedstate()
582
1031
logger.info("Disabling client %s", self.name)
583
if getattr(self, "disable_initiator_tag", False):
584
gobject.source_remove(self.disable_initiator_tag)
1032
if getattr(self, "disable_initiator_tag", None) is not None:
1033
GLib.source_remove(self.disable_initiator_tag)
585
1034
self.disable_initiator_tag = None
586
1035
self.expires = None
587
if getattr(self, "checker_initiator_tag", False):
588
gobject.source_remove(self.checker_initiator_tag)
1036
if getattr(self, "checker_initiator_tag", None) is not None:
1037
GLib.source_remove(self.checker_initiator_tag)
589
1038
self.checker_initiator_tag = None
590
1039
self.stop_checker()
591
1040
self.enabled = False
592
# Do not run this again if called by a gobject.timeout_add
1042
self.send_changedstate()
1043
# Do not run this again if called by a GLib.timeout_add
595
1046
def __del__(self):
598
1049
def init_checker(self):
599
1050
# Schedule a new checker to be started an 'interval' from now,
600
1051
# and every interval from then on.
601
self.checker_initiator_tag = (gobject.timeout_add
602
(self.interval_milliseconds(),
1052
if self.checker_initiator_tag is not None:
1053
GLib.source_remove(self.checker_initiator_tag)
1054
self.checker_initiator_tag = GLib.timeout_add(
1055
random.randrange(int(self.interval.total_seconds() * 1000
604
1058
# Schedule a disable() when 'timeout' has passed
605
self.disable_initiator_tag = (gobject.timeout_add
606
(self.timeout_milliseconds(),
1059
if self.disable_initiator_tag is not None:
1060
GLib.source_remove(self.disable_initiator_tag)
1061
self.disable_initiator_tag = GLib.timeout_add(
1062
int(self.timeout.total_seconds() * 1000), self.disable)
608
1063
# Also start a new checker *right now*.
609
1064
self.start_checker()
611
def checker_callback(self, pid, condition, command):
1066
def checker_callback(self, source, condition, connection,
612
1068
"""The checker has completed, so take appropriate actions."""
1069
# Read return code from connection (see call_pipe)
1070
returncode = connection.recv()
1072
if self.checker is not None:
613
1074
self.checker_callback_tag = None
614
1075
self.checker = None
615
if os.WIFEXITED(condition):
616
self.last_checker_status = os.WEXITSTATUS(condition)
1078
self.last_checker_status = returncode
1079
self.last_checker_signal = None
617
1080
if self.last_checker_status == 0:
618
1081
logger.info("Checker for %(name)s succeeded",
620
1083
self.checked_ok()
622
logger.info("Checker for %(name)s failed",
1085
logger.info("Checker for %(name)s failed", vars(self))
625
1087
self.last_checker_status = -1
1088
self.last_checker_signal = -returncode
626
1089
logger.warning("Checker for %(name)s crashed?",
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,
1093
def checked_ok(self):
1094
"""Assert that the client has been seen, alive and well."""
1095
self.last_checked_ok = datetime.datetime.utcnow()
1096
self.last_checker_status = 0
1097
self.last_checker_signal = None
1100
def bump_timeout(self, timeout=None):
1101
"""Bump up the timeout for this client."""
635
1102
if timeout is None:
636
1103
timeout = self.timeout
637
self.last_checked_ok = datetime.datetime.utcnow()
638
1104
if self.disable_initiator_tag is not None:
639
gobject.source_remove(self.disable_initiator_tag)
1105
GLib.source_remove(self.disable_initiator_tag)
1106
self.disable_initiator_tag = None
640
1107
if getattr(self, "enabled", False):
641
self.disable_initiator_tag = (gobject.timeout_add
642
(timedelta_to_milliseconds
643
(timeout), self.disable))
1108
self.disable_initiator_tag = GLib.timeout_add(
1109
int(timeout.total_seconds() * 1000), self.disable)
644
1110
self.expires = datetime.datetime.utcnow() + timeout
646
1112
def need_approval(self):
647
1113
self.last_approval_request = datetime.datetime.utcnow()
649
1115
def start_checker(self):
650
1116
"""Start a new checker subprocess if one is not running.
652
1118
If a checker already exists, leave it running and do
654
1120
# The reason for not killing a running checker is that if we
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
1121
# did that, and if a checker (for some reason) started running
1122
# slowly and taking more than 'interval' time, then the client
1123
# would inevitably timeout, since no checker would get a
1124
# chance to run to completion. If we instead leave running
659
1125
# checkers alone, the checker would have to take more time
660
1126
# than 'timeout' for the client to be disabled, which is as it
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)
1129
if self.checker is not None and not self.checker.is_alive():
1130
logger.warning("Checker was not alive; joining")
676
1133
# Start a new checker if needed
677
1134
if self.checker is None:
1135
# Escape attributes for the shell
1137
attr: shlex.quote(str(getattr(self, attr)))
1138
for attr in self.runtime_expansions}
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
1140
command = self.checker_command % escaped_attrs
1141
except TypeError as error:
1142
logger.error('Could not format string "%s"',
1143
self.checker_command,
1145
return True # Try again later
697
1146
self.current_checker_command = command
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
1147
logger.info("Starting checker %r for %s", command,
1149
# We don't need to redirect stdout and stderr, since
1150
# in normal mode, that is already done by daemon(),
1151
# and in debug mode we don't want to. (Stdin is
1152
# always replaced by /dev/null.)
1153
# The exception is when not debugging but nevertheless
1154
# running in the foreground; use the previously
1156
popen_args = {"close_fds": True,
1159
if (not self.server_settings["debug"]
1160
and self.server_settings["foreground"]):
1161
popen_args.update({"stdout": wnull,
1163
pipe = multiprocessing.Pipe(duplex=False)
1164
self.checker = multiprocessing.Process(
1166
args=(pipe[1], subprocess.call, command),
1168
self.checker.start()
1169
self.checker_callback_tag = GLib.io_add_watch(
1170
GLib.IOChannel.unix_new(pipe[0].fileno()),
1171
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1172
self.checker_callback, pipe[0], command)
1173
# Re-run this periodically if run by GLib.timeout_add
724
1176
def stop_checker(self):
725
1177
"""Force the checker process, if any, to stop."""
726
1178
if self.checker_callback_tag:
727
gobject.source_remove(self.checker_callback_tag)
1179
GLib.source_remove(self.checker_callback_tag)
728
1180
self.checker_callback_tag = None
729
1181
if getattr(self, "checker", None) is None:
731
1183
logger.debug("Stopping checker for %(name)s", vars(self))
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
1184
self.checker.terminate()
740
1185
self.checker = None
743
def dbus_service_property(dbus_interface, signature="v",
744
access="readwrite", byte_arrays=False):
1188
def dbus_service_property(dbus_interface,
745
1192
"""Decorators for marking methods of a DBusObjectWithProperties to
746
1193
become properties on the D-Bus.
748
1195
The decorated method will be called with no arguments by "Get"
749
1196
and with one argument by "Set".
751
1198
The parameters, where they are supported, are the same as
752
1199
dbus.service.method, except there is only "signature", since the
753
1200
type from Get() and the type sent to Set() is the same.
792
class DBusObjectWithProperties(dbus.service.Object):
1283
class DBusObjectWithAnnotations(dbus.service.Object):
1284
"""A D-Bus object with annotations.
1286
Classes inheriting from this can use the dbus_annotations
1287
decorator to add annotations to methods or signals.
1291
def _is_dbus_thing(thing):
1292
"""Returns a function testing if an attribute is a D-Bus thing
1294
If called like _is_dbus_thing("method") it returns a function
1295
suitable for use as predicate to inspect.getmembers().
1297
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1300
def _get_all_dbus_things(self, thing):
1301
"""Returns a generator of (name, attribute) pairs
1303
return ((getattr(athing.__get__(self), "_dbus_name", name),
1304
athing.__get__(self))
1305
for cls in self.__class__.__mro__
1307
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1309
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1311
path_keyword='object_path',
1312
connection_keyword='connection')
1313
def Introspect(self, object_path, connection):
1314
"""Overloading of standard D-Bus method.
1316
Inserts annotation tags on methods and signals.
1318
xmlstring = dbus.service.Object.Introspect(self, object_path,
1321
document = xml.dom.minidom.parseString(xmlstring)
1323
for if_tag in document.getElementsByTagName("interface"):
1324
# Add annotation tags
1325
for typ in ("method", "signal"):
1326
for tag in if_tag.getElementsByTagName(typ):
1328
for name, prop in (self.
1329
_get_all_dbus_things(typ)):
1330
if (name == tag.getAttribute("name")
1331
and prop._dbus_interface
1332
== if_tag.getAttribute("name")):
1333
annots.update(getattr(
1334
prop, "_dbus_annotations", {}))
1335
for name, value in annots.items():
1336
ann_tag = document.createElement(
1338
ann_tag.setAttribute("name", name)
1339
ann_tag.setAttribute("value", value)
1340
tag.appendChild(ann_tag)
1341
# Add interface annotation tags
1342
for annotation, value in dict(
1343
itertools.chain.from_iterable(
1344
annotations().items()
1345
for name, annotations
1346
in self._get_all_dbus_things("interface")
1347
if name == if_tag.getAttribute("name")
1349
ann_tag = document.createElement("annotation")
1350
ann_tag.setAttribute("name", annotation)
1351
ann_tag.setAttribute("value", value)
1352
if_tag.appendChild(ann_tag)
1353
# Fix argument name for the Introspect method itself
1354
if (if_tag.getAttribute("name")
1355
== dbus.INTROSPECTABLE_IFACE):
1356
for cn in if_tag.getElementsByTagName("method"):
1357
if cn.getAttribute("name") == "Introspect":
1358
for arg in cn.getElementsByTagName("arg"):
1359
if (arg.getAttribute("direction")
1361
arg.setAttribute("name",
1363
xmlstring = document.toxml("utf-8")
1365
except (AttributeError, xml.dom.DOMException,
1366
xml.parsers.expat.ExpatError) as error:
1367
logger.error("Failed to override Introspection method",
1372
class DBusObjectWithProperties(DBusObjectWithAnnotations):
793
1373
"""A D-Bus object with properties.
795
1375
Classes inheriting from this can use the dbus_service_property
796
1376
decorator to expose methods as D-Bus properties. It exposes the
797
1377
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))
812
1380
def _get_dbus_property(self, interface_name, property_name):
813
1381
"""Returns a bound method if one exists which is a D-Bus
814
1382
property with the specified name and interface.
816
for cls in self.__class__.__mro__:
817
for name, value in (inspect.getmembers
818
(cls, self._is_dbus_property)):
1384
for cls in self.__class__.__mro__:
1385
for name, value in inspect.getmembers(
1386
cls, self._is_dbus_thing("property")):
819
1387
if (value._dbus_name == property_name
820
1388
and value._dbus_interface == interface_name):
821
1389
return value.__get__(self)
823
1391
# No such property
824
raise DBusPropertyNotFound(self.dbus_object_path + ":"
825
+ interface_name + "."
828
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1392
raise DBusPropertyNotFound("{}:{}.{}".format(
1393
self.dbus_object_path, interface_name, property_name))
1396
def _get_all_interface_names(cls):
1397
"""Get a sequence of all interfaces supported by an object"""
1398
return (name for name in set(getattr(getattr(x, attr),
1399
"_dbus_interface", None)
1400
for x in (inspect.getmro(cls))
1402
if name is not None)
1404
@dbus.service.method(dbus.PROPERTIES_IFACE,
829
1406
out_signature="v")
830
1407
def Get(self, interface_name, property_name):
831
1408
"""Standard D-Bus property Get() method, see D-Bus standard.
875
1454
if not hasattr(value, "variant_level"):
876
1455
properties[name] = value
878
properties[name] = type(value)(value, variant_level=
879
value.variant_level+1)
1457
properties[name] = type(value)(
1458
value, variant_level=value.variant_level + 1)
880
1459
return dbus.Dictionary(properties, signature="sv")
1461
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1462
def PropertiesChanged(self, interface_name, changed_properties,
1463
invalidated_properties):
1464
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
882
1469
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
883
1470
out_signature="s",
884
1471
path_keyword='object_path',
885
1472
connection_keyword='connection')
886
1473
def Introspect(self, object_path, connection):
887
"""Standard D-Bus method, overloaded to insert property tags.
1474
"""Overloading of standard D-Bus method.
1476
Inserts property tags and interface annotation tags.
889
xmlstring = dbus.service.Object.Introspect(self, object_path,
1478
xmlstring = DBusObjectWithAnnotations.Introspect(self,
892
1482
document = xml.dom.minidom.parseString(xmlstring)
893
1484
def make_tag(document, name, prop):
894
1485
e = document.createElement("property")
895
1486
e.setAttribute("name", name)
896
1487
e.setAttribute("type", prop._dbus_signature)
897
1488
e.setAttribute("access", prop._dbus_access)
899
1491
for if_tag in document.getElementsByTagName("interface"):
900
1493
for tag in (make_tag(document, name, prop)
902
in self._get_all_dbus_properties()
1495
in self._get_all_dbus_things("property")
903
1496
if prop._dbus_interface
904
1497
== if_tag.getAttribute("name")):
905
1498
if_tag.appendChild(tag)
1499
# Add annotation tags for properties
1500
for tag in if_tag.getElementsByTagName("property"):
1502
for name, prop in self._get_all_dbus_things(
1504
if (name == tag.getAttribute("name")
1505
and prop._dbus_interface
1506
== if_tag.getAttribute("name")):
1507
annots.update(getattr(
1508
prop, "_dbus_annotations", {}))
1509
for name, value in annots.items():
1510
ann_tag = document.createElement(
1512
ann_tag.setAttribute("name", name)
1513
ann_tag.setAttribute("value", value)
1514
tag.appendChild(ann_tag)
906
1515
# Add the names to the return values for the
907
1516
# "org.freedesktop.DBus.Properties" methods
908
1517
if (if_tag.getAttribute("name")
923
1532
except (AttributeError, xml.dom.DOMException,
924
1533
xml.parsers.expat.ExpatError) as error:
925
1534
logger.error("Failed to override Introspection method",
930
def datetime_to_dbus (dt, variant_level=0):
1540
dbus.OBJECT_MANAGER_IFACE
1541
except AttributeError:
1542
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1545
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1546
"""A D-Bus object with an ObjectManager.
1548
Classes inheriting from this exposes the standard
1549
GetManagedObjects call and the InterfacesAdded and
1550
InterfacesRemoved signals on the standard
1551
"org.freedesktop.DBus.ObjectManager" interface.
1553
Note: No signals are sent automatically; they must be sent
1556
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1557
out_signature="a{oa{sa{sv}}}")
1558
def GetManagedObjects(self):
1559
"""This function must be overridden"""
1560
raise NotImplementedError()
1562
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1563
signature="oa{sa{sv}}")
1564
def InterfacesAdded(self, object_path, interfaces_and_properties):
1567
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1568
def InterfacesRemoved(self, object_path, interfaces):
1571
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1573
path_keyword='object_path',
1574
connection_keyword='connection')
1575
def Introspect(self, object_path, connection):
1576
"""Overloading of standard D-Bus method.
1578
Override return argument name of GetManagedObjects to be
1579
"objpath_interfaces_and_properties"
1581
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1585
document = xml.dom.minidom.parseString(xmlstring)
1587
for if_tag in document.getElementsByTagName("interface"):
1588
# Fix argument name for the GetManagedObjects method
1589
if (if_tag.getAttribute("name")
1590
== dbus.OBJECT_MANAGER_IFACE):
1591
for cn in if_tag.getElementsByTagName("method"):
1592
if (cn.getAttribute("name")
1593
== "GetManagedObjects"):
1594
for arg in cn.getElementsByTagName("arg"):
1595
if (arg.getAttribute("direction")
1599
"objpath_interfaces"
1601
xmlstring = document.toxml("utf-8")
1603
except (AttributeError, xml.dom.DOMException,
1604
xml.parsers.expat.ExpatError) as error:
1605
logger.error("Failed to override Introspection method",
1610
def datetime_to_dbus(dt, variant_level=0):
931
1611
"""Convert a UTC datetime.datetime() to a D-Bus type."""
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.
1613
return dbus.String("", variant_level=variant_level)
1614
return dbus.String(dt.isoformat(), variant_level=variant_level)
1617
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1618
"""A class decorator; applied to a subclass of
1619
dbus.service.Object, it will add alternate D-Bus attributes with
1620
interface names according to the "alt_interface_names" mapping.
1623
@alternate_dbus_interfaces({"org.example.Interface":
1624
"net.example.AlternateInterface"})
1625
class SampleDBusObject(dbus.service.Object):
1626
@dbus.service.method("org.example.Interface")
1627
def SampleDBusMethod():
1630
The above "SampleDBusMethod" on "SampleDBusObject" will be
1631
reachable via two interfaces: "org.example.Interface" and
1632
"net.example.AlternateInterface", the latter of which will have
1633
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1634
"true", unless "deprecate" is passed with a False value.
1636
This works for methods and signals, and also for D-Bus properties
1637
(from DBusObjectWithProperties) and interfaces (from the
1638
dbus_interface_annotations decorator).
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):
1642
for orig_interface_name, alt_interface_name in (
1643
alt_interface_names.items()):
1645
interface_names = set()
1646
# Go though all attributes of the class
1647
for attrname, attribute in inspect.getmembers(cls):
950
1648
# Ignore non-D-Bus attributes, and D-Bus attributes
951
1649
# with the wrong interface name
952
1650
if (not hasattr(attribute, "_dbus_interface")
953
or not attribute._dbus_interface
954
.startswith("se.recompile.Mandos")):
1651
or not attribute._dbus_interface.startswith(
1652
orig_interface_name)):
956
1654
# Create an alternate D-Bus interface name based on
957
1655
# the current name
958
alt_interface = (attribute._dbus_interface
959
.replace("se.recompile.Mandos",
960
"se.bsnet.fukt.Mandos"))
1656
alt_interface = attribute._dbus_interface.replace(
1657
orig_interface_name, alt_interface_name)
1658
interface_names.add(alt_interface)
961
1659
# Is this a D-Bus signal?
962
1660
if getattr(attribute, "_dbus_is_signal", False):
963
# Extract the original non-method function by
965
nonmethod_func = (dict(
1661
# Extract the original non-method undecorated
1662
# function by black magic
1663
if sys.version_info.major == 2:
1664
nonmethod_func = (dict(
966
1665
zip(attribute.func_code.co_freevars,
967
attribute.__closure__))["func"]
1666
attribute.__closure__))
1667
["func"].cell_contents)
1669
nonmethod_func = (dict(
1670
zip(attribute.__code__.co_freevars,
1671
attribute.__closure__))
1672
["func"].cell_contents)
969
1673
# Create a new, but exactly alike, function
970
1674
# object, and decorate it to be a new D-Bus signal
971
1675
# with the alternate D-Bus interface name
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)))
1676
new_function = copy_function(nonmethod_func)
1677
new_function = (dbus.service.signal(
1679
attribute._dbus_signature)(new_function))
1680
# Copy annotations, if any
1682
new_function._dbus_annotations = dict(
1683
attribute._dbus_annotations)
1684
except AttributeError:
981
1687
# Define a creator of a function to call both the
982
# old and new functions, so both the old and new
983
# signals gets sent when the function is called
1688
# original and alternate functions, so both the
1689
# original and alternate signals gets sent when
1690
# the function is called
984
1691
def fixscope(func1, func2):
985
1692
"""This function is a scope container to pass
986
1693
func1 and func2 to the "call_both" function
987
1694
outside of its arguments"""
1696
@functools.wraps(func2)
988
1697
def call_both(*args, **kwargs):
989
1698
"""This function will emit two D-Bus
990
1699
signals by calling func1 and func2"""
991
1700
func1(*args, **kwargs)
992
1701
func2(*args, **kwargs)
1702
# Make wrapper function look like a D-Bus
1704
for name, attr in inspect.getmembers(func2):
1705
if name.startswith("_dbus_"):
1706
setattr(call_both, name, attr)
993
1708
return call_both
994
1709
# Create the "call_both" function and add it to
996
attr[attrname] = fixscope(attribute,
1711
attr[attrname] = fixscope(attribute, new_function)
998
1712
# Is this a D-Bus method?
999
1713
elif getattr(attribute, "_dbus_is_method", False):
1000
1714
# Create a new, but exactly alike, function
1001
1715
# object. Decorate it to be a new D-Bus method
1002
1716
# with the alternate D-Bus interface name. Add it
1003
1717
# to the class.
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)))
1719
dbus.service.method(
1721
attribute._dbus_in_signature,
1722
attribute._dbus_out_signature)
1723
(copy_function(attribute)))
1724
# Copy annotations, if any
1726
attr[attrname]._dbus_annotations = dict(
1727
attribute._dbus_annotations)
1728
except AttributeError:
1014
1730
# Is this a D-Bus property?
1015
1731
elif getattr(attribute, "_dbus_is_property", False):
1016
1732
# Create a new, but exactly alike, function
1017
1733
# object, and decorate it to be a new D-Bus
1018
1734
# property with the alternate D-Bus interface
1019
1735
# name. Add it to the class.
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)
1736
attr[attrname] = (dbus_service_property(
1737
alt_interface, attribute._dbus_signature,
1738
attribute._dbus_access,
1739
attribute._dbus_get_args_options
1741
(copy_function(attribute)))
1742
# Copy annotations, if any
1744
attr[attrname]._dbus_annotations = dict(
1745
attribute._dbus_annotations)
1746
except AttributeError:
1748
# Is this a D-Bus interface?
1749
elif getattr(attribute, "_dbus_is_interface", False):
1750
# Create a new, but exactly alike, function
1751
# object. Decorate it to be a new D-Bus interface
1752
# with the alternate D-Bus interface name. Add it
1755
dbus_interface_annotations(alt_interface)
1756
(copy_function(attribute)))
1758
# Deprecate all alternate interfaces
1759
iname = "_AlternateDBusNames_interface_annotation{}"
1760
for interface_name in interface_names:
1762
@dbus_interface_annotations(interface_name)
1764
return {"org.freedesktop.DBus.Deprecated":
1766
# Find an unused name
1767
for aname in (iname.format(i)
1768
for i in itertools.count()):
1769
if aname not in attr:
1773
# Replace the class with a new subclass of it with
1774
# methods, signals, etc. as created above.
1775
if sys.version_info.major == 2:
1776
cls = type(b"{}Alternate".format(cls.__name__),
1779
cls = type("{}Alternate".format(cls.__name__),
1786
@alternate_dbus_interfaces({"se.recompile.Mandos":
1787
"se.bsnet.fukt.Mandos"})
1036
1788
class ClientDBus(Client, DBusObjectWithProperties):
1037
1789
"""A Client class using D-Bus
1040
1792
dbus_object_path: dbus.ObjectPath
1041
1793
bus: dbus.SystemBus()
1044
1796
runtime_expansions = (Client.runtime_expansions
1045
+ ("dbus_object_path",))
1797
+ ("dbus_object_path", ))
1799
_interface = "se.recompile.Mandos.Client"
1047
1801
# dbus.service.Object doesn't use super(), so we can't either.
1049
def __init__(self, bus = None, *args, **kwargs):
1803
def __init__(self, bus=None, *args, **kwargs):
1051
1805
Client.__init__(self, *args, **kwargs)
1052
1806
# Only now, when this client is initialized, can it show up on
1054
client_object_name = unicode(self.name).translate(
1808
client_object_name = str(self.name).translate(
1055
1809
{ord("."): ord("_"),
1056
1810
ord("-"): ord("_")})
1057
self.dbus_object_path = (dbus.ObjectPath
1058
("/clients/" + client_object_name))
1811
self.dbus_object_path = dbus.ObjectPath(
1812
"/clients/" + client_object_name)
1059
1813
DBusObjectWithProperties.__init__(self, self.bus,
1060
1814
self.dbus_object_path)
1062
def notifychangeproperty(transform_func,
1063
dbus_name, type_func=lambda x: x,
1816
def notifychangeproperty(transform_func, dbus_name,
1817
type_func=lambda x: x,
1819
invalidate_only=False,
1820
_interface=_interface):
1065
1821
""" Modify a variable so that it's a property which announces
1066
1822
its changes to DBus.
1068
1824
transform_fun: Function that takes a value and a variant_level
1069
1825
and transforms it to a D-Bus type.
1070
1826
dbus_name: D-Bus name of the variable
1072
1828
to the D-Bus. Default: no transform
1073
1829
variant_level: D-Bus variant level. Default: 1
1075
attrname = "_{0}".format(dbus_name)
1831
attrname = "_{}".format(dbus_name)
1076
1833
def setter(self, value):
1077
1834
if hasattr(self, "dbus_object_path"):
1078
1835
if (not hasattr(self, attrname) or
1079
1836
type_func(getattr(self, attrname, None))
1080
1837
!= type_func(value)):
1081
dbus_value = transform_func(type_func(value),
1084
self.PropertyChanged(dbus.String(dbus_name),
1839
self.PropertiesChanged(
1840
_interface, dbus.Dictionary(),
1841
dbus.Array((dbus_name, )))
1843
dbus_value = transform_func(
1845
variant_level=variant_level)
1846
self.PropertyChanged(dbus.String(dbus_name),
1848
self.PropertiesChanged(
1850
dbus.Dictionary({dbus.String(dbus_name):
1086
1853
setattr(self, attrname, value)
1088
1855
return property(lambda self: getattr(self, attrname), setter)
1091
1857
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1092
1858
approvals_pending = notifychangeproperty(dbus.Boolean,
1093
1859
"ApprovalPending",
1095
1861
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1096
1862
last_enabled = notifychangeproperty(datetime_to_dbus,
1098
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1099
type_func = lambda checker:
1100
checker is not None)
1864
checker = notifychangeproperty(
1865
dbus.Boolean, "CheckerRunning",
1866
type_func=lambda checker: checker is not None)
1101
1867
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1102
1868
"LastCheckedOK")
1869
last_checker_status = notifychangeproperty(dbus.Int16,
1870
"LastCheckerStatus")
1103
1871
last_approval_request = notifychangeproperty(
1104
1872
datetime_to_dbus, "LastApprovalRequest")
1105
1873
approved_by_default = notifychangeproperty(dbus.Boolean,
1106
1874
"ApprovedByDefault")
1107
approval_delay = notifychangeproperty(dbus.UInt64,
1110
timedelta_to_milliseconds)
1875
approval_delay = notifychangeproperty(
1876
dbus.UInt64, "ApprovalDelay",
1877
type_func=lambda td: td.total_seconds() * 1000)
1111
1878
approval_duration = notifychangeproperty(
1112
1879
dbus.UInt64, "ApprovalDuration",
1113
type_func = timedelta_to_milliseconds)
1880
type_func=lambda td: td.total_seconds() * 1000)
1114
1881
host = notifychangeproperty(dbus.String, "Host")
1115
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1117
timedelta_to_milliseconds)
1882
timeout = notifychangeproperty(
1883
dbus.UInt64, "Timeout",
1884
type_func=lambda td: td.total_seconds() * 1000)
1118
1885
extended_timeout = notifychangeproperty(
1119
1886
dbus.UInt64, "ExtendedTimeout",
1120
type_func = timedelta_to_milliseconds)
1121
interval = notifychangeproperty(dbus.UInt64,
1124
timedelta_to_milliseconds)
1887
type_func=lambda td: td.total_seconds() * 1000)
1888
interval = notifychangeproperty(
1889
dbus.UInt64, "Interval",
1890
type_func=lambda td: td.total_seconds() * 1000)
1125
1891
checker_command = notifychangeproperty(dbus.String, "Checker")
1892
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1893
invalidate_only=True)
1127
1895
del notifychangeproperty
1129
1897
def __del__(self, *args, **kwargs):
1131
1899
self.remove_from_connection()
1211
1978
server to mandos-client
1215
1982
# Rejected - signal
1216
1983
@dbus.service.signal(_interface, signature="s")
1217
1984
def Rejected(self, reason):
1221
1988
# NeedApproval - signal
1222
1989
@dbus.service.signal(_interface, signature="tb")
1223
1990
def NeedApproval(self, timeout, default):
1225
1992
return self.need_approval()
1227
# NewRequest - signal
1228
@dbus.service.signal(_interface, signature="s")
1229
def NewRequest(self, ip):
1231
Is sent after a client request a secret.
1237
1996
# Approve - method
1238
1997
@dbus.service.method(_interface, in_signature="b")
1239
1998
def Approve(self, value):
1240
1999
self.approve(value)
1242
2001
# CheckedOK - method
1243
2002
@dbus.service.method(_interface)
1244
2003
def CheckedOK(self):
1245
2004
self.checked_ok()
1247
2006
# Enable - method
2007
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1248
2008
@dbus.service.method(_interface)
1249
2009
def Enable(self):
1253
2013
# StartChecker - method
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1254
2015
@dbus.service.method(_interface)
1255
2016
def StartChecker(self):
1257
2018
self.start_checker()
1259
2020
# Disable - method
2021
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1260
2022
@dbus.service.method(_interface)
1261
2023
def Disable(self):
1265
2027
# StopChecker - method
2028
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1266
2029
@dbus.service.method(_interface)
1267
2030
def StopChecker(self):
1268
2031
self.stop_checker()
1272
2035
# ApprovalPending - property
1273
2036
@dbus_service_property(_interface, signature="b", access="read")
1274
2037
def ApprovalPending_dbus_property(self):
1275
2038
return dbus.Boolean(bool(self.approvals_pending))
1277
2040
# ApprovedByDefault - property
1278
@dbus_service_property(_interface, signature="b",
2041
@dbus_service_property(_interface,
1279
2043
access="readwrite")
1280
2044
def ApprovedByDefault_dbus_property(self, value=None):
1281
2045
if value is None: # get
1282
2046
return dbus.Boolean(self.approved_by_default)
1283
2047
self.approved_by_default = bool(value)
1285
2049
# ApprovalDelay - property
1286
@dbus_service_property(_interface, signature="t",
2050
@dbus_service_property(_interface,
1287
2052
access="readwrite")
1288
2053
def ApprovalDelay_dbus_property(self, value=None):
1289
2054
if value is None: # get
1290
return dbus.UInt64(self.approval_delay_milliseconds())
2055
return dbus.UInt64(self.approval_delay.total_seconds()
1291
2057
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1293
2059
# ApprovalDuration - property
1294
@dbus_service_property(_interface, signature="t",
2060
@dbus_service_property(_interface,
1295
2062
access="readwrite")
1296
2063
def ApprovalDuration_dbus_property(self, value=None):
1297
2064
if value is None: # get
1298
return dbus.UInt64(timedelta_to_milliseconds(
1299
self.approval_duration))
2065
return dbus.UInt64(self.approval_duration.total_seconds()
1300
2067
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1302
2069
# Name - property
2071
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1303
2072
@dbus_service_property(_interface, signature="s", access="read")
1304
2073
def Name_dbus_property(self):
1305
2074
return dbus.String(self.name)
2078
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2079
@dbus_service_property(_interface, signature="s", access="read")
2080
def KeyID_dbus_property(self):
2081
return dbus.String(self.key_id)
1307
2083
# Fingerprint - property
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1308
2086
@dbus_service_property(_interface, signature="s", access="read")
1309
2087
def Fingerprint_dbus_property(self):
1310
2088
return dbus.String(self.fingerprint)
1312
2090
# Host - property
1313
@dbus_service_property(_interface, signature="s",
2091
@dbus_service_property(_interface,
1314
2093
access="readwrite")
1315
2094
def Host_dbus_property(self, value=None):
1316
2095
if value is None: # get
1317
2096
return dbus.String(self.host)
1318
self.host = unicode(value)
2097
self.host = str(value)
1320
2099
# Created - property
2101
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1321
2102
@dbus_service_property(_interface, signature="s", access="read")
1322
2103
def Created_dbus_property(self):
1323
2104
return datetime_to_dbus(self.created)
1325
2106
# LastEnabled - property
1326
2107
@dbus_service_property(_interface, signature="s", access="read")
1327
2108
def LastEnabled_dbus_property(self):
1328
2109
return datetime_to_dbus(self.last_enabled)
1330
2111
# Enabled - property
1331
@dbus_service_property(_interface, signature="b",
2112
@dbus_service_property(_interface,
1332
2114
access="readwrite")
1333
2115
def Enabled_dbus_property(self, value=None):
1334
2116
if value is None: # get
1341
2123
# LastCheckedOK - property
1342
@dbus_service_property(_interface, signature="s",
2124
@dbus_service_property(_interface,
1343
2126
access="readwrite")
1344
2127
def LastCheckedOK_dbus_property(self, value=None):
1345
2128
if value is not None:
1346
2129
self.checked_ok()
1348
2131
return datetime_to_dbus(self.last_checked_ok)
2133
# LastCheckerStatus - property
2134
@dbus_service_property(_interface, signature="n", access="read")
2135
def LastCheckerStatus_dbus_property(self):
2136
return dbus.Int16(self.last_checker_status)
1350
2138
# Expires - property
1351
2139
@dbus_service_property(_interface, signature="s", access="read")
1352
2140
def Expires_dbus_property(self):
1353
2141
return datetime_to_dbus(self.expires)
1355
2143
# LastApprovalRequest - property
1356
2144
@dbus_service_property(_interface, signature="s", access="read")
1357
2145
def LastApprovalRequest_dbus_property(self):
1358
2146
return datetime_to_dbus(self.last_approval_request)
1360
2148
# Timeout - property
1361
@dbus_service_property(_interface, signature="t",
2149
@dbus_service_property(_interface,
1362
2151
access="readwrite")
1363
2152
def Timeout_dbus_property(self, value=None):
1364
2153
if value is None: # get
1365
return dbus.UInt64(self.timeout_milliseconds())
2154
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2155
old_timeout = self.timeout
1366
2156
self.timeout = datetime.timedelta(0, 0, 0, value)
1367
# Reschedule timeout
2157
# Reschedule disabling
1368
2158
if self.enabled:
1369
2159
now = datetime.datetime.utcnow()
1370
time_to_die = timedelta_to_milliseconds(
1371
(self.last_checked_ok + self.timeout) - now)
1372
if time_to_die <= 0:
2160
self.expires += self.timeout - old_timeout
2161
if self.expires <= now:
1373
2162
# The timeout has passed
1376
self.expires = (now +
1377
datetime.timedelta(milliseconds =
1379
2165
if (getattr(self, "disable_initiator_tag", None)
1382
gobject.source_remove(self.disable_initiator_tag)
1383
self.disable_initiator_tag = (gobject.timeout_add
2168
GLib.source_remove(self.disable_initiator_tag)
2169
self.disable_initiator_tag = GLib.timeout_add(
2170
int((self.expires - now).total_seconds() * 1000),
1387
2173
# ExtendedTimeout - property
1388
@dbus_service_property(_interface, signature="t",
2174
@dbus_service_property(_interface,
1389
2176
access="readwrite")
1390
2177
def ExtendedTimeout_dbus_property(self, value=None):
1391
2178
if value is None: # get
1392
return dbus.UInt64(self.extended_timeout_milliseconds())
2179
return dbus.UInt64(self.extended_timeout.total_seconds()
1393
2181
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1395
2183
# Interval - property
1396
@dbus_service_property(_interface, signature="t",
2184
@dbus_service_property(_interface,
1397
2186
access="readwrite")
1398
2187
def Interval_dbus_property(self, value=None):
1399
2188
if value is None: # get
1400
return dbus.UInt64(self.interval_milliseconds())
2189
return dbus.UInt64(self.interval.total_seconds() * 1000)
1401
2190
self.interval = datetime.timedelta(0, 0, 0, value)
1402
2191
if getattr(self, "checker_initiator_tag", None) is None:
1404
2193
if self.enabled:
1405
2194
# Reschedule checker run
1406
gobject.source_remove(self.checker_initiator_tag)
1407
self.checker_initiator_tag = (gobject.timeout_add
1408
(value, self.start_checker))
1409
self.start_checker() # Start one now, too
2195
GLib.source_remove(self.checker_initiator_tag)
2196
self.checker_initiator_tag = GLib.timeout_add(
2197
value, self.start_checker)
2198
self.start_checker() # Start one now, too
1411
2200
# Checker - property
1412
@dbus_service_property(_interface, signature="s",
2201
@dbus_service_property(_interface,
1413
2203
access="readwrite")
1414
2204
def Checker_dbus_property(self, value=None):
1415
2205
if value is None: # get
1416
2206
return dbus.String(self.checker_command)
1417
self.checker_command = unicode(value)
2207
self.checker_command = str(value)
1419
2209
# CheckerRunning - property
1420
@dbus_service_property(_interface, signature="b",
2210
@dbus_service_property(_interface,
1421
2212
access="readwrite")
1422
2213
def CheckerRunning_dbus_property(self, value=None):
1423
2214
if value is None: # get
1456
2255
if data[0] == 'data':
1458
2257
if data[0] == 'function':
1459
2259
def func(*args, **kwargs):
1460
2260
self._pipe.send(('funcall', name, args, kwargs))
1461
2261
return self._pipe.recv()[1]
1464
2265
def __setattr__(self, name, value):
1465
2266
if name == '_pipe':
1466
2267
return super(ProxyClient, self).__setattr__(name, value)
1467
2268
self._pipe.send(('setattr', name, value))
1470
class ClientDBusTransitional(ClientDBus):
1471
__metaclass__ = AlternateDBusNamesMetaclass
1474
2271
class ClientHandler(socketserver.BaseRequestHandler, object):
1475
2272
"""A class to handle client connections.
1477
2274
Instantiated once for each connection to handle it.
1478
2275
Note: This will run in its own forked process."""
1480
2277
def handle(self):
1481
2278
with contextlib.closing(self.server.child_pipe) as child_pipe:
1482
2279
logger.info("TCP connection from: %s",
1483
unicode(self.client_address))
2280
str(self.client_address))
1484
2281
logger.debug("Pipe FD: %d",
1485
2282
self.server.child_pipe.fileno())
1487
session = (gnutls.connection
1488
.ClientSession(self.request,
1490
.X509Credentials()))
1492
# Note: gnutls.connection.X509Credentials is really a
1493
# generic GnuTLS certificate credentials object so long as
1494
# no X.509 keys are added to it. Therefore, we can use it
1495
# here despite using OpenPGP certificates.
1497
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1498
# "+AES-256-CBC", "+SHA1",
1499
# "+COMP-NULL", "+CTYPE-OPENPGP",
2284
session = gnutls.ClientSession(self.request)
2286
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2287
# "+AES-256-CBC", "+SHA1",
2288
# "+COMP-NULL", "+CTYPE-OPENPGP",
1501
2290
# Use a fallback default, since this MUST be set.
1502
2291
priority = self.server.gnutls_priority
1503
2292
if priority is None:
1504
2293
priority = "NORMAL"
1505
(gnutls.library.functions
1506
.gnutls_priority_set_direct(session._c_object,
2294
gnutls.priority_set_direct(session._c_object,
2295
priority.encode("utf-8"),
1509
2298
# Start communication using the Mandos protocol
1510
2299
# Get protocol number
1511
2300
line = self.request.makefile().readline()
1512
2301
logger.debug("Protocol version: %r", line)
1514
2303
if int(line.strip().split()[0]) > 1:
2304
raise RuntimeError(line)
1516
2305
except (ValueError, IndexError, RuntimeError) as error:
1517
2306
logger.error("Unknown protocol version: %s", error)
1520
2309
# Start GnuTLS connection
1522
2311
session.handshake()
1523
except gnutls.errors.GNUTLSError as error:
2312
except gnutls.Error as error:
1524
2313
logger.warning("Handshake failed: %s", error)
1525
2314
# Do not run session.bye() here: the session is not
1526
2315
# established. Just abandon the request.
1528
2317
logger.debug("Handshake succeeded")
1530
2319
approval_required = False
1533
fpr = self.fingerprint(self.peer_certificate
1536
gnutls.errors.GNUTLSError) as error:
1537
logger.warning("Bad certificate: %s", error)
1539
logger.debug("Fingerprint: %s", fpr)
1542
client = ProxyClient(child_pipe, fpr,
2321
if gnutls.has_rawpk:
2324
key_id = self.key_id(
2325
self.peer_certificate(session))
2326
except (TypeError, gnutls.Error) as error:
2327
logger.warning("Bad certificate: %s", error)
2329
logger.debug("Key ID: %s", key_id)
2334
fpr = self.fingerprint(
2335
self.peer_certificate(session))
2336
except (TypeError, gnutls.Error) as error:
2337
logger.warning("Bad certificate: %s", error)
2339
logger.debug("Fingerprint: %s", fpr)
2342
client = ProxyClient(child_pipe, key_id, fpr,
1543
2343
self.client_address)
1544
2344
except KeyError:
1547
if self.server.use_dbus:
1549
client.NewRequest(unicode(self.client_address)[0])
1551
2347
if client.approval_delay:
1552
2348
delay = client.approval_delay
1553
2349
client.approvals_pending += 1
1554
2350
approval_required = True
1557
2353
if not client.enabled:
1558
2354
logger.info("Client %s is disabled",
1560
2356
if self.server.use_dbus:
1561
2357
# Emit D-Bus signal
1562
2358
client.Rejected("Disabled")
1565
2361
if client.approved or not client.approval_delay:
1566
#We are approved or approval is disabled
2362
# We are approved or approval is disabled
1568
2364
elif client.approved is None:
1569
2365
logger.info("Client %s needs approval",
1604
2398
delay -= time2 - time
1607
while sent_size < len(client.secret):
1609
sent = session.send(client.secret[sent_size:])
1610
except gnutls.errors.GNUTLSError as error:
1611
logger.warning("gnutls send failed")
1613
logger.debug("Sent: %d, remaining: %d",
1614
sent, len(client.secret)
1615
- (sent_size + sent))
2401
session.send(client.secret)
2402
except gnutls.Error as error:
2403
logger.warning("gnutls send failed",
1618
2407
logger.info("Sending secret to %s", client.name)
1619
2408
# bump the timeout using extended_timeout
1620
client.checked_ok(client.extended_timeout)
2409
client.bump_timeout(client.extended_timeout)
1621
2410
if self.server.use_dbus:
1622
2411
# Emit D-Bus signal
1623
2412
client.GotSecret()
1626
2415
if approval_required:
1627
2416
client.approvals_pending -= 1
1630
except gnutls.errors.GNUTLSError as error:
1631
logger.warning("GnuTLS bye failed")
2419
except gnutls.Error as error:
2420
logger.warning("GnuTLS bye failed",
1634
2424
def peer_certificate(session):
1635
"Return the peer's OpenPGP certificate as a bytestring"
1636
# If not an OpenPGP certificate...
1637
if (gnutls.library.functions
1638
.gnutls_certificate_type_get(session._c_object)
1639
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1640
# ...do the normal thing
1641
return session.peer_certificate
2425
"Return the peer's certificate as a bytestring"
2427
cert_type = gnutls.certificate_type_get2(session._c_object,
2429
except AttributeError:
2430
cert_type = gnutls.certificate_type_get(session._c_object)
2431
if gnutls.has_rawpk:
2432
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2434
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2435
# If not a valid certificate type...
2436
if cert_type not in valid_cert_types:
2437
logger.info("Cert type %r not in %r", cert_type,
2439
# ...return invalid data
1642
2441
list_size = ctypes.c_uint(1)
1643
cert_list = (gnutls.library.functions
1644
.gnutls_certificate_get_peers
2442
cert_list = (gnutls.certificate_get_peers
1645
2443
(session._c_object, ctypes.byref(list_size)))
1646
2444
if not bool(cert_list) and list_size.value != 0:
1647
raise gnutls.errors.GNUTLSError("error getting peer"
2445
raise gnutls.Error("error getting peer certificate")
1649
2446
if list_size.value == 0:
1651
2448
cert = cert_list[0]
1652
2449
return ctypes.string_at(cert.data, cert.size)
2452
def key_id(certificate):
2453
"Convert a certificate bytestring to a hexdigit key ID"
2454
# New GnuTLS "datum" with the public key
2455
datum = gnutls.datum_t(
2456
ctypes.cast(ctypes.c_char_p(certificate),
2457
ctypes.POINTER(ctypes.c_ubyte)),
2458
ctypes.c_uint(len(certificate)))
2459
# XXX all these need to be created in the gnutls "module"
2460
# New empty GnuTLS certificate
2461
pubkey = gnutls.pubkey_t()
2462
gnutls.pubkey_init(ctypes.byref(pubkey))
2463
# Import the raw public key into the certificate
2464
gnutls.pubkey_import(pubkey,
2465
ctypes.byref(datum),
2466
gnutls.X509_FMT_DER)
2467
# New buffer for the key ID
2468
buf = ctypes.create_string_buffer(32)
2469
buf_len = ctypes.c_size_t(len(buf))
2470
# Get the key ID from the raw public key into the buffer
2471
gnutls.pubkey_get_key_id(pubkey,
2472
gnutls.KEYID_USE_SHA256,
2473
ctypes.cast(ctypes.byref(buf),
2474
ctypes.POINTER(ctypes.c_ubyte)),
2475
ctypes.byref(buf_len))
2476
# Deinit the certificate
2477
gnutls.pubkey_deinit(pubkey)
2479
# Convert the buffer to a Python bytestring
2480
key_id = ctypes.string_at(buf, buf_len.value)
2481
# Convert the bytestring to hexadecimal notation
2482
hex_key_id = binascii.hexlify(key_id).upper()
1655
2486
def fingerprint(openpgp):
1656
2487
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1657
2488
# New GnuTLS "datum" with the OpenPGP public key
1658
datum = (gnutls.library.types
1659
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1662
ctypes.c_uint(len(openpgp))))
2489
datum = gnutls.datum_t(
2490
ctypes.cast(ctypes.c_char_p(openpgp),
2491
ctypes.POINTER(ctypes.c_ubyte)),
2492
ctypes.c_uint(len(openpgp)))
1663
2493
# New empty GnuTLS certificate
1664
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1665
(gnutls.library.functions
1666
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2494
crt = gnutls.openpgp_crt_t()
2495
gnutls.openpgp_crt_init(ctypes.byref(crt))
1667
2496
# Import the OpenPGP public key into the certificate
1668
(gnutls.library.functions
1669
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1670
gnutls.library.constants
1671
.GNUTLS_OPENPGP_FMT_RAW))
2497
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2498
gnutls.OPENPGP_FMT_RAW)
1672
2499
# Verify the self signature in the key
1673
2500
crtverify = ctypes.c_uint()
1674
(gnutls.library.functions
1675
.gnutls_openpgp_crt_verify_self(crt, 0,
1676
ctypes.byref(crtverify)))
2501
gnutls.openpgp_crt_verify_self(crt, 0,
2502
ctypes.byref(crtverify))
1677
2503
if crtverify.value != 0:
1678
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1679
raise (gnutls.errors.CertificateSecurityError
2504
gnutls.openpgp_crt_deinit(crt)
2505
raise gnutls.CertificateSecurityError(code
1681
2507
# New buffer for the fingerprint
1682
2508
buf = ctypes.create_string_buffer(20)
1683
2509
buf_len = ctypes.c_size_t()
1684
2510
# Get the fingerprint from the certificate into the buffer
1685
(gnutls.library.functions
1686
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1687
ctypes.byref(buf_len)))
2511
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2512
ctypes.byref(buf_len))
1688
2513
# Deinit the certificate
1689
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2514
gnutls.openpgp_crt_deinit(crt)
1690
2515
# Convert the buffer to a Python bytestring
1691
2516
fpr = ctypes.string_at(buf, buf_len.value)
1692
2517
# Convert the bytestring to hexadecimal notation
1697
class MultiprocessingMixIn(object):
2522
class MultiprocessingMixIn:
1698
2523
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1699
2525
def sub_process_main(self, request, address):
1701
2527
self.finish_request(request, address)
1702
2528
except Exception:
1703
2529
self.handle_error(request, address)
1704
2530
self.close_request(request)
1706
2532
def process_request(self, request, address):
1707
2533
"""Start a new process to process the request."""
1708
proc = multiprocessing.Process(target = self.sub_process_main,
2534
proc = multiprocessing.Process(target=self.sub_process_main,
2535
args=(request, address))
1715
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2540
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1716
2541
""" adds a pipe to the MixIn """
1717
2543
def process_request(self, request, client_address):
1718
2544
"""Overrides and wraps the original process_request().
1720
2546
This function creates a new pipe in self.pipe
1722
2548
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1724
2550
proc = MultiprocessingMixIn.process_request(self, request,
1725
2551
client_address)
1726
2552
self.child_pipe.close()
1727
2553
self.add_pipe(parent_pipe, proc)
1729
2555
def add_pipe(self, parent_pipe, proc):
1730
2556
"""Dummy function; override as necessary"""
1731
raise NotImplementedError
2557
raise NotImplementedError()
1734
2560
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1735
socketserver.TCPServer, object):
2561
socketserver.TCPServer):
1736
2562
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1739
2565
enabled: Boolean; whether this server is activated yet
1740
2566
interface: None or a network interface name (string)
1741
2567
use_ipv6: Boolean; to use IPv6 or not
1743
2570
def __init__(self, server_address, RequestHandlerClass,
1744
interface=None, use_ipv6=True):
2574
"""If socketfd is set, use that file descriptor instead of
2575
creating a new one with socket.socket().
1745
2577
self.interface = interface
1747
2579
self.address_family = socket.AF_INET6
2580
if socketfd is not None:
2581
# Save the file descriptor
2582
self.socketfd = socketfd
2583
# Save the original socket.socket() function
2584
self.socket_socket = socket.socket
2586
# To implement --socket, we monkey patch socket.socket.
2588
# (When socketserver.TCPServer is a new-style class, we
2589
# could make self.socket into a property instead of monkey
2590
# patching socket.socket.)
2592
# Create a one-time-only replacement for socket.socket()
2593
@functools.wraps(socket.socket)
2594
def socket_wrapper(*args, **kwargs):
2595
# Restore original function so subsequent calls are
2597
socket.socket = self.socket_socket
2598
del self.socket_socket
2599
# This time only, return a new socket object from the
2600
# saved file descriptor.
2601
return socket.fromfd(self.socketfd, *args, **kwargs)
2602
# Replace socket.socket() function with wrapper
2603
socket.socket = socket_wrapper
2604
# The socketserver.TCPServer.__init__ will call
2605
# socket.socket(), which might be our replacement,
2606
# socket_wrapper(), if socketfd was set.
1748
2607
socketserver.TCPServer.__init__(self, server_address,
1749
2608
RequestHandlerClass)
1750
2610
def server_bind(self):
1751
2611
"""This overrides the normal server_bind() function
1752
2612
to bind to an interface if one was specified, and also NOT to
1753
2613
bind to an address or port if they were not specified."""
2614
global SO_BINDTODEVICE
1754
2615
if self.interface is not None:
1755
2616
if SO_BINDTODEVICE is None:
1756
logger.error("SO_BINDTODEVICE does not exist;"
1757
" cannot bind to interface %s",
1761
self.socket.setsockopt(socket.SOL_SOCKET,
1765
except socket.error as error:
1766
if error[0] == errno.EPERM:
1767
logger.error("No permission to"
1768
" bind to interface %s",
1770
elif error[0] == errno.ENOPROTOOPT:
1771
logger.error("SO_BINDTODEVICE not available;"
1772
" cannot bind to interface %s",
2617
# Fall back to a hard-coded value which seems to be
2619
logger.warning("SO_BINDTODEVICE not found, trying 25")
2620
SO_BINDTODEVICE = 25
2622
self.socket.setsockopt(
2623
socket.SOL_SOCKET, SO_BINDTODEVICE,
2624
(self.interface + "\0").encode("utf-8"))
2625
except socket.error as error:
2626
if error.errno == errno.EPERM:
2627
logger.error("No permission to bind to"
2628
" interface %s", self.interface)
2629
elif error.errno == errno.ENOPROTOOPT:
2630
logger.error("SO_BINDTODEVICE not available;"
2631
" cannot bind to interface %s",
2633
elif error.errno == errno.ENODEV:
2634
logger.error("Interface %s does not exist,"
2635
" cannot bind", self.interface)
1776
2638
# Only bind(2) the socket if we really need to.
1777
2639
if self.server_address[0] or self.server_address[1]:
2640
if self.server_address[1]:
2641
self.allow_reuse_address = True
1778
2642
if not self.server_address[0]:
1779
2643
if self.address_family == socket.AF_INET6:
1780
any_address = "::" # in6addr_any
2644
any_address = "::" # in6addr_any
1782
any_address = socket.INADDR_ANY
2646
any_address = "0.0.0.0" # INADDR_ANY
1783
2647
self.server_address = (any_address,
1784
2648
self.server_address[1])
1785
2649
elif not self.server_address[1]:
1786
self.server_address = (self.server_address[0],
2650
self.server_address = (self.server_address[0], 0)
1788
2651
# if self.interface:
1789
2652
# self.server_address = (self.server_address[0],
1815
2683
self.gnutls_priority = gnutls_priority
1816
2684
IPv6_TCPServer.__init__(self, server_address,
1817
2685
RequestHandlerClass,
1818
interface = interface,
1819
use_ipv6 = use_ipv6)
2686
interface=interface,
1820
2690
def server_activate(self):
1821
2691
if self.enabled:
1822
2692
return socketserver.TCPServer.server_activate(self)
1824
2694
def enable(self):
1825
2695
self.enabled = True
1827
2697
def add_pipe(self, parent_pipe, proc):
1828
2698
# Call "handle_ipc" for both data and EOF events
1829
gobject.io_add_watch(parent_pipe.fileno(),
1830
gobject.IO_IN | gobject.IO_HUP,
1831
functools.partial(self.handle_ipc,
1836
def handle_ipc(self, source, condition, parent_pipe=None,
1837
proc = None, client_object=None):
1839
gobject.IO_IN: "IN", # There is data to read.
1840
gobject.IO_OUT: "OUT", # Data can be written (without
1842
gobject.IO_PRI: "PRI", # There is urgent data to read.
1843
gobject.IO_ERR: "ERR", # Error condition.
1844
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1845
# broken, usually for pipes and
1848
conditions_string = ' | '.join(name
1850
condition_names.iteritems()
1851
if cond & condition)
2700
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2701
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2702
functools.partial(self.handle_ipc,
2703
parent_pipe=parent_pipe,
2706
def handle_ipc(self, source, condition,
2709
client_object=None):
1852
2710
# error, or the other end of multiprocessing.Pipe has closed
1853
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2711
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1854
2712
# Wait for other process to exit
1858
2716
# Read a request from the child
1859
2717
request = parent_pipe.recv()
1860
2718
command = request[0]
1862
2720
if command == 'init':
1864
address = request[2]
1866
for c in self.clients.itervalues():
1867
if c.fingerprint == fpr:
2721
key_id = request[1].decode("ascii")
2722
fpr = request[2].decode("ascii")
2723
address = request[3]
2725
for c in self.clients.values():
2726
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2728
if key_id and c.key_id == key_id:
2731
if fpr and c.fingerprint == fpr:
1871
logger.info("Client not found for fingerprint: %s, ad"
1872
"dress: %s", fpr, address)
2735
logger.info("Client not found for key ID: %s, address"
2736
": %s", key_id or fpr, address)
1873
2737
if self.use_dbus:
1874
2738
# Emit D-Bus signal
1875
mandos_dbus_service.ClientNotFound(fpr,
2739
mandos_dbus_service.ClientNotFound(key_id or fpr,
1877
2741
parent_pipe.send(False)
1880
gobject.io_add_watch(parent_pipe.fileno(),
1881
gobject.IO_IN | gobject.IO_HUP,
1882
functools.partial(self.handle_ipc,
2745
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2746
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2747
functools.partial(self.handle_ipc,
2748
parent_pipe=parent_pipe,
2750
client_object=client))
1888
2751
parent_pipe.send(True)
1889
2752
# remove the old hook in favor of the new above hook on
1893
2756
funcname = request[1]
1894
2757
args = request[2]
1895
2758
kwargs = request[3]
1897
2760
parent_pipe.send(('data', getattr(client_object,
1898
2761
funcname)(*args,
1901
2764
if command == 'getattr':
1902
2765
attrname = request[1]
1903
if callable(client_object.__getattribute__(attrname)):
1904
parent_pipe.send(('function',))
2766
if isinstance(client_object.__getattribute__(attrname),
2767
collections.abc.Callable):
2768
parent_pipe.send(('function', ))
1906
parent_pipe.send(('data', client_object
1907
.__getattribute__(attrname)))
2771
'data', client_object.__getattribute__(attrname)))
1909
2773
if command == 'setattr':
1910
2774
attrname = request[1]
1911
2775
value = request[2]
1912
2776
setattr(client_object, attrname, value)
2781
def rfc3339_duration_to_delta(duration):
2782
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2784
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2786
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2788
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2790
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2792
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2794
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2796
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2800
# Parsing an RFC 3339 duration with regular expressions is not
2801
# possible - there would have to be multiple places for the same
2802
# values, like seconds. The current code, while more esoteric, is
2803
# cleaner without depending on a parsing library. If Python had a
2804
# built-in library for parsing we would use it, but we'd like to
2805
# avoid excessive use of external libraries.
2807
# New type for defining tokens, syntax, and semantics all-in-one
2808
Token = collections.namedtuple("Token", (
2809
"regexp", # To match token; if "value" is not None, must have
2810
# a "group" containing digits
2811
"value", # datetime.timedelta or None
2812
"followers")) # Tokens valid after this token
2813
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2814
# the "duration" ABNF definition in RFC 3339, Appendix A.
2815
token_end = Token(re.compile(r"$"), None, frozenset())
2816
token_second = Token(re.compile(r"(\d+)S"),
2817
datetime.timedelta(seconds=1),
2818
frozenset((token_end, )))
2819
token_minute = Token(re.compile(r"(\d+)M"),
2820
datetime.timedelta(minutes=1),
2821
frozenset((token_second, token_end)))
2822
token_hour = Token(re.compile(r"(\d+)H"),
2823
datetime.timedelta(hours=1),
2824
frozenset((token_minute, token_end)))
2825
token_time = Token(re.compile(r"T"),
2827
frozenset((token_hour, token_minute,
2829
token_day = Token(re.compile(r"(\d+)D"),
2830
datetime.timedelta(days=1),
2831
frozenset((token_time, token_end)))
2832
token_month = Token(re.compile(r"(\d+)M"),
2833
datetime.timedelta(weeks=4),
2834
frozenset((token_day, token_end)))
2835
token_year = Token(re.compile(r"(\d+)Y"),
2836
datetime.timedelta(weeks=52),
2837
frozenset((token_month, token_end)))
2838
token_week = Token(re.compile(r"(\d+)W"),
2839
datetime.timedelta(weeks=1),
2840
frozenset((token_end, )))
2841
token_duration = Token(re.compile(r"P"), None,
2842
frozenset((token_year, token_month,
2843
token_day, token_time,
2845
# Define starting values:
2847
value = datetime.timedelta()
2849
# Following valid tokens
2850
followers = frozenset((token_duration, ))
2851
# String left to parse
2853
# Loop until end token is found
2854
while found_token is not token_end:
2855
# Search for any currently valid tokens
2856
for token in followers:
2857
match = token.regexp.match(s)
2858
if match is not None:
2860
if token.value is not None:
2861
# Value found, parse digits
2862
factor = int(match.group(1), 10)
2863
# Add to value so far
2864
value += factor * token.value
2865
# Strip token from string
2866
s = token.regexp.sub("", s, 1)
2869
# Set valid next tokens
2870
followers = found_token.followers
2873
# No currently valid tokens were found
2874
raise ValueError("Invalid RFC 3339 duration: {!r}"
1917
2880
def string_to_delta(interval):
1918
2881
"""Parse a string and return a datetime.timedelta
1920
>>> string_to_delta('7d')
1921
datetime.timedelta(7)
1922
>>> string_to_delta('60s')
1923
datetime.timedelta(0, 60)
1924
>>> string_to_delta('60m')
1925
datetime.timedelta(0, 3600)
1926
>>> string_to_delta('24h')
1927
datetime.timedelta(1)
1928
>>> string_to_delta('1w')
1929
datetime.timedelta(7)
1930
>>> string_to_delta('5m 30s')
1931
datetime.timedelta(0, 330)
2883
>>> string_to_delta('7d') == datetime.timedelta(7)
2885
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2887
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2889
>>> string_to_delta('24h') == datetime.timedelta(1)
2891
>>> string_to_delta('1w') == datetime.timedelta(7)
2893
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2898
return rfc3339_duration_to_delta(interval)
1933
2902
timevalue = datetime.timedelta(0)
1934
2903
for s in interval.split():
1936
suffix = unicode(s[-1])
1937
2906
value = int(s[:-1])
1938
2907
if suffix == "d":
1939
2908
delta = datetime.timedelta(value)
2011
2980
parser.add_argument("--no-dbus", action="store_false",
2012
2981
dest="use_dbus", help="Do not provide D-Bus"
2013
" system bus interface")
2982
" system bus interface", default=None)
2014
2983
parser.add_argument("--no-ipv6", action="store_false",
2015
dest="use_ipv6", help="Do not use IPv6")
2984
dest="use_ipv6", help="Do not use IPv6",
2016
2986
parser.add_argument("--no-restore", action="store_false",
2017
2987
dest="restore", help="Do not restore stored"
2988
" state", default=None)
2989
parser.add_argument("--socket", type=int,
2990
help="Specify a file descriptor to a network"
2991
" socket to use instead of creating one")
2019
2992
parser.add_argument("--statedir", metavar="DIR",
2020
2993
help="Directory to save/restore state in")
2994
parser.add_argument("--foreground", action="store_true",
2995
help="Run in foreground", default=None)
2996
parser.add_argument("--no-zeroconf", action="store_false",
2997
dest="zeroconf", help="Do not use Zeroconf",
2022
3000
options = parser.parse_args()
2029
3002
# Default values for config file for server-global settings
2030
server_defaults = { "interface": "",
2035
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2036
"servicename": "Mandos",
2041
"statedir": "/var/lib/mandos"
3003
if gnutls.has_rawpk:
3004
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3005
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3007
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3008
":+SIGN-DSA-SHA256")
3009
server_defaults = {"interface": "",
3013
"priority": priority,
3014
"servicename": "Mandos",
3020
"statedir": "/var/lib/mandos",
3021
"foreground": "False",
2044
3026
# Parse config file for server-global settings
2045
server_config = configparser.SafeConfigParser(server_defaults)
3027
server_config = configparser.ConfigParser(server_defaults)
2046
3028
del server_defaults
2047
server_config.read(os.path.join(options.configdir,
2049
# Convert the SafeConfigParser object to a dict
3029
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3030
# Convert the ConfigParser object to a dict
2050
3031
server_settings = server_config.defaults()
2051
3032
# Use the appropriate methods on the non-string config options
2052
for option in ("debug", "use_dbus", "use_ipv6"):
3033
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3034
"foreground", "zeroconf"):
2053
3035
server_settings[option] = server_config.getboolean("DEFAULT",
2055
3037
if server_settings["port"]:
2056
3038
server_settings["port"] = server_config.getint("DEFAULT",
3040
if server_settings["socket"]:
3041
server_settings["socket"] = server_config.getint("DEFAULT",
3043
# Later, stdin will, and stdout and stderr might, be dup'ed
3044
# over with an opened os.devnull. But we don't want this to
3045
# happen with a supplied network socket.
3046
if 0 <= server_settings["socket"] <= 2:
3047
server_settings["socket"] = os.dup(server_settings
2058
3049
del server_config
2060
3051
# Override the settings from the config file with command line
2061
3052
# options, if set.
2062
3053
for option in ("interface", "address", "port", "debug",
2063
"priority", "servicename", "configdir",
2064
"use_dbus", "use_ipv6", "debuglevel", "restore",
3054
"priority", "servicename", "configdir", "use_dbus",
3055
"use_ipv6", "debuglevel", "restore", "statedir",
3056
"socket", "foreground", "zeroconf"):
2066
3057
value = getattr(options, option)
2067
3058
if value is not None:
2068
3059
server_settings[option] = value
2070
3061
# Force all strings to be unicode
2071
3062
for option in server_settings.keys():
2072
if type(server_settings[option]) is str:
2073
server_settings[option] = unicode(server_settings[option])
3063
if isinstance(server_settings[option], bytes):
3064
server_settings[option] = (server_settings[option]
3066
# Force all boolean options to be boolean
3067
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3068
"foreground", "zeroconf"):
3069
server_settings[option] = bool(server_settings[option])
3070
# Debug implies foreground
3071
if server_settings["debug"]:
3072
server_settings["foreground"] = True
2074
3073
# Now we have our good server settings in "server_settings"
2076
3075
##################################################################
3077
if (not server_settings["zeroconf"]
3078
and not (server_settings["port"]
3079
or server_settings["socket"] != "")):
3080
parser.error("Needs port or socket to work without Zeroconf")
2078
3082
# For convenience
2079
3083
debug = server_settings["debug"]
2080
3084
debuglevel = server_settings["debuglevel"]
2092
3098
level = getattr(logging, debuglevel.upper())
2093
3099
initlogger(debug, level)
2095
3101
if server_settings["servicename"] != "Mandos":
2096
syslogger.setFormatter(logging.Formatter
2097
('Mandos (%s) [%%(process)d]:'
2098
' %%(levelname)s: %%(message)s'
2099
% server_settings["servicename"]))
3102
syslogger.setFormatter(
3103
logging.Formatter('Mandos ({}) [%(process)d]:'
3104
' %(levelname)s: %(message)s'.format(
3105
server_settings["servicename"])))
2101
3107
# Parse config file with clients
2102
client_config = configparser.SafeConfigParser(Client
3108
client_config = configparser.ConfigParser(Client.client_defaults)
2104
3109
client_config.read(os.path.join(server_settings["configdir"],
2105
3110
"clients.conf"))
2107
3112
global mandos_dbus_service
2108
3113
mandos_dbus_service = None
2110
tcp_server = MandosServer((server_settings["address"],
2111
server_settings["port"]),
2113
interface=(server_settings["interface"]
2117
server_settings["priority"],
2120
pidfilename = "/var/run/mandos.pid"
2122
pidfile = open(pidfilename, "w")
2124
logger.error("Could not open file %r", pidfilename)
2127
uid = pwd.getpwnam("_mandos").pw_uid
2128
gid = pwd.getpwnam("_mandos").pw_gid
2131
uid = pwd.getpwnam("mandos").pw_uid
2132
gid = pwd.getpwnam("mandos").pw_gid
3116
if server_settings["socket"] != "":
3117
socketfd = server_settings["socket"]
3118
tcp_server = MandosServer(
3119
(server_settings["address"], server_settings["port"]),
3121
interface=(server_settings["interface"] or None),
3123
gnutls_priority=server_settings["priority"],
3127
pidfilename = "/run/mandos.pid"
3128
if not os.path.isdir("/run/."):
3129
pidfilename = "/var/run/mandos.pid"
3132
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3133
except IOError as e:
3134
logger.error("Could not open file %r", pidfilename,
3137
for name, group in (("_mandos", "_mandos"),
3138
("mandos", "mandos"),
3139
("nobody", "nogroup")):
3141
uid = pwd.getpwnam(name).pw_uid
3142
gid = pwd.getpwnam(group).pw_gid
2133
3144
except KeyError:
2135
uid = pwd.getpwnam("nobody").pw_uid
2136
gid = pwd.getpwnam("nobody").pw_gid
3153
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2143
3155
except OSError as error:
2144
if error[0] != errno.EPERM:
3156
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3157
.format(uid, gid, os.strerror(error.errno)))
3158
if error.errno != errno.EPERM:
2148
3162
# Enable all possible GnuTLS debugging
2150
3164
# "Use a log level over 10 to enable all debugging options."
2151
3165
# - GnuTLS manual
2152
gnutls.library.functions.gnutls_global_set_log_level(11)
2154
@gnutls.library.types.gnutls_log_func
3166
gnutls.global_set_log_level(11)
2155
3169
def debug_gnutls(level, string):
2156
3170
logger.debug("GnuTLS: %s", string[:-1])
2158
(gnutls.library.functions
2159
.gnutls_global_set_log_function(debug_gnutls))
3172
gnutls.global_set_log_function(debug_gnutls)
2161
3174
# Redirect stdin so all checkers get /dev/null
2162
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3175
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2163
3176
os.dup2(null, sys.stdin.fileno())
2167
3180
# Need to fork before connecting to D-Bus
2169
3182
# Close all input and output, do double fork, etc.
2172
gobject.threads_init()
3185
if gi.version_info < (3, 10, 2):
3186
# multiprocessing will use threads, so before we use GLib we
3187
# need to inform GLib that threads will be used.
2174
3190
global main_loop
2175
3191
# From the Avahi example code
2176
DBusGMainLoop(set_as_default=True )
2177
main_loop = gobject.MainLoop()
3192
DBusGMainLoop(set_as_default=True)
3193
main_loop = GLib.MainLoop()
2178
3194
bus = dbus.SystemBus()
2179
3195
# End of Avahi example code
2182
3198
bus_name = dbus.service.BusName("se.recompile.Mandos",
2183
bus, do_not_queue=True)
2184
old_bus_name = (dbus.service.BusName
2185
("se.bsnet.fukt.Mandos", bus,
2187
except dbus.exceptions.NameExistsException as e:
2188
logger.error(unicode(e) + ", disabling D-Bus")
3201
old_bus_name = dbus.service.BusName(
3202
"se.bsnet.fukt.Mandos", bus,
3204
except dbus.exceptions.DBusException as e:
3205
logger.error("Disabling D-Bus:", exc_info=e)
2189
3206
use_dbus = False
2190
3207
server_settings["use_dbus"] = False
2191
3208
tcp_server.use_dbus = False
2192
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2193
service = AvahiServiceToSyslog(name =
2194
server_settings["servicename"],
2195
servicetype = "_mandos._tcp",
2196
protocol = protocol, bus = bus)
2197
if server_settings["interface"]:
2198
service.interface = (if_nametoindex
2199
(str(server_settings["interface"])))
3210
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3211
service = AvahiServiceToSyslog(
3212
name=server_settings["servicename"],
3213
servicetype="_mandos._tcp",
3216
if server_settings["interface"]:
3217
service.interface = if_nametoindex(
3218
server_settings["interface"].encode("utf-8"))
2201
3220
global multiprocessing_manager
2202
3221
multiprocessing_manager = multiprocessing.Manager()
2204
3223
client_class = Client
2206
client_class = functools.partial(ClientDBusTransitional,
3225
client_class = functools.partial(ClientDBus, bus=bus)
2209
3227
client_settings = Client.config_parser(client_config)
2210
3228
old_client_settings = {}
2211
3229
clients_data = {}
3231
# This is used to redirect stdout and stderr for checker processes
3233
wnull = open(os.devnull, "w") # A writable /dev/null
3234
# Only used if server is running in foreground but not in debug
3236
if debug or not foreground:
2213
3239
# Get client data and settings from last running state.
2214
3240
if server_settings["restore"]:
2216
3242
with open(stored_state_path, "rb") as stored_state:
2217
clients_data, old_client_settings = (pickle.load
3243
if sys.version_info.major == 2:
3244
clients_data, old_client_settings = pickle.load(
3247
bytes_clients_data, bytes_old_client_settings = (
3248
pickle.load(stored_state, encoding="bytes"))
3249
# Fix bytes to strings
3252
clients_data = {(key.decode("utf-8")
3253
if isinstance(key, bytes)
3256
bytes_clients_data.items()}
3257
del bytes_clients_data
3258
for key in clients_data:
3259
value = {(k.decode("utf-8")
3260
if isinstance(k, bytes) else k): v
3262
clients_data[key].items()}
3263
clients_data[key] = value
3265
value["client_structure"] = [
3267
if isinstance(s, bytes)
3269
value["client_structure"]]
3270
# .name, .host, and .checker_command
3271
for k in ("name", "host", "checker_command"):
3272
if isinstance(value[k], bytes):
3273
value[k] = value[k].decode("utf-8")
3274
if "key_id" not in value:
3275
value["key_id"] = ""
3276
elif "fingerprint" not in value:
3277
value["fingerprint"] = ""
3278
# old_client_settings
3280
old_client_settings = {
3281
(key.decode("utf-8")
3282
if isinstance(key, bytes)
3285
bytes_old_client_settings.items()}
3286
del bytes_old_client_settings
3287
# .host and .checker_command
3288
for value in old_client_settings.values():
3289
for attribute in ("host", "checker_command"):
3290
if isinstance(value[attribute], bytes):
3291
value[attribute] = (value[attribute]
2219
3293
os.remove(stored_state_path)
2220
3294
except IOError as e:
2221
logger.warning("Could not load persistent state: {0}"
2223
if e.errno != errno.ENOENT:
3295
if e.errno == errno.ENOENT:
3296
logger.warning("Could not load persistent state:"
3297
" {}".format(os.strerror(e.errno)))
3299
logger.critical("Could not load persistent state:",
2225
3302
except EOFError as e:
2226
3303
logger.warning("Could not load persistent state: "
2227
"EOFError: {0}".format(e))
2229
3307
with PGPEngine() as pgp:
2230
for client_name, client in clients_data.iteritems():
3308
for client_name, client in clients_data.items():
3309
# Skip removed clients
3310
if client_name not in client_settings:
2231
3313
# Decide which value to use after restoring saved state.
2232
3314
# We have three different values: Old config file,
2233
3315
# new config file, and saved state.
2294
3375
clients_data[client_name] = client_settings[client_name]
2296
3377
# Create all client objects
2297
for client_name, client in clients_data.iteritems():
3378
for client_name, client in clients_data.items():
2298
3379
tcp_server.clients[client_name] = client_class(
2299
name = client_name, settings = client)
3382
server_settings=server_settings)
2301
3384
if not tcp_server.clients:
2302
3385
logger.warning("No clients defined")
2308
pidfile.write(str(pid) + "\n".encode("utf-8"))
2311
logger.error("Could not write to file %r with PID %d",
2314
# "pidfile" was never created
3388
if pidfile is not None:
3392
print(pid, file=pidfile)
3394
logger.error("Could not write to file %r with PID %d",
2316
3397
del pidfilename
2317
signal.signal(signal.SIGINT, signal.SIG_IGN)
2319
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2320
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3399
for termsig in (signal.SIGHUP, signal.SIGTERM):
3400
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3401
lambda: main_loop.quit() and False)
2323
class MandosDBusService(dbus.service.Object):
3405
@alternate_dbus_interfaces(
3406
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3407
class MandosDBusService(DBusObjectWithObjectManager):
2324
3408
"""A D-Bus proxy object"""
2325
3410
def __init__(self):
2326
3411
dbus.service.Object.__init__(self, bus, "/")
2327
3413
_interface = "se.recompile.Mandos"
2329
3415
@dbus.service.signal(_interface, signature="o")
2330
3416
def ClientAdded(self, objpath):
2334
3420
@dbus.service.signal(_interface, signature="ss")
2335
def ClientNotFound(self, fingerprint, address):
3421
def ClientNotFound(self, key_id, address):
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2339
3427
@dbus.service.signal(_interface, signature="os")
2340
3428
def ClientRemoved(self, objpath, name):
3432
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2344
3434
@dbus.service.method(_interface, out_signature="ao")
2345
3435
def GetAllClients(self):
2347
return dbus.Array(c.dbus_object_path
2349
tcp_server.clients.itervalues())
3437
return dbus.Array(c.dbus_object_path for c in
3438
tcp_server.clients.values())
3440
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2351
3442
@dbus.service.method(_interface,
2352
3443
out_signature="a{oa{sv}}")
2353
3444
def GetAllClientsWithProperties(self):
2355
3446
return dbus.Dictionary(
2356
((c.dbus_object_path, c.GetAll(""))
2357
for c in tcp_server.clients.itervalues()),
3447
{c.dbus_object_path: c.GetAll(
3448
"se.recompile.Mandos.Client")
3449
for c in tcp_server.clients.values()},
2358
3450
signature="oa{sv}")
2360
3452
@dbus.service.method(_interface, in_signature="o")
2361
3453
def RemoveClient(self, object_path):
2363
for c in tcp_server.clients.itervalues():
3455
for c in tcp_server.clients.values():
2364
3456
if c.dbus_object_path == object_path:
2365
3457
del tcp_server.clients[c.name]
2366
3458
c.remove_from_connection()
2367
# Don't signal anything except ClientRemoved
3459
# Don't signal the disabling
2368
3460
c.disable(quiet=True)
2370
self.ClientRemoved(object_path, c.name)
3461
# Emit D-Bus signal for removal
3462
self.client_removed_signal(c)
2372
3464
raise KeyError(object_path)
2376
class MandosDBusServiceTransitional(MandosDBusService):
2377
__metaclass__ = AlternateDBusNamesMetaclass
2378
mandos_dbus_service = MandosDBusServiceTransitional()
3468
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3469
out_signature="a{oa{sa{sv}}}")
3470
def GetManagedObjects(self):
3472
return dbus.Dictionary(
3473
{client.dbus_object_path:
3475
{interface: client.GetAll(interface)
3477
client._get_all_interface_names()})
3478
for client in tcp_server.clients.values()})
3480
def client_added_signal(self, client):
3481
"""Send the new standard signal and the old signal"""
3483
# New standard signal
3484
self.InterfacesAdded(
3485
client.dbus_object_path,
3487
{interface: client.GetAll(interface)
3489
client._get_all_interface_names()}))
3491
self.ClientAdded(client.dbus_object_path)
3493
def client_removed_signal(self, client):
3494
"""Send the new standard signal and the old signal"""
3496
# New standard signal
3497
self.InterfacesRemoved(
3498
client.dbus_object_path,
3499
client._get_all_interface_names())
3501
self.ClientRemoved(client.dbus_object_path,
3504
mandos_dbus_service = MandosDBusService()
3506
# Save modules to variables to exempt the modules from being
3507
# unloaded before the function registered with atexit() is run.
3508
mp = multiprocessing
2381
3512
"Cleanup function; run on exit"
2384
multiprocessing.active_children()
3516
mp.active_children()
2385
3518
if not (tcp_server.clients or client_settings):
2388
3521
# Store client before exiting. Secrets are encrypted with key
2389
3522
# based on what config file has. If config file is
2390
3523
# removed/edited, old secret will thus be unrecovable.
2392
3525
with PGPEngine() as pgp:
2393
for client in tcp_server.clients.itervalues():
3526
for client in tcp_server.clients.values():
2394
3527
key = client_settings[client.name]["secret"]
2395
3528
client.encrypted_secret = pgp.encrypt(client.secret,
2397
3530
client_dict = {}
2399
3532
# A list of attributes that can not be pickled
2401
exclude = set(("bus", "changedstate", "secret",
2403
for name, typ in (inspect.getmembers
2404
(dbus.service.Object)):
3534
exclude = {"bus", "changedstate", "secret",
3535
"checker", "server_settings"}
3536
for name, typ in inspect.getmembers(dbus.service
2405
3538
exclude.add(name)
2407
3540
client_dict["encrypted_secret"] = (client
2408
3541
.encrypted_secret)
2409
3542
for attr in client.client_structure:
2410
3543
if attr not in exclude:
2411
3544
client_dict[attr] = getattr(client, attr)
2413
3546
clients[client.name] = client_dict
2414
3547
del client_settings[client.name]["secret"]
2417
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2420
(stored_state_path))
2421
with os.fdopen(tempfd, "wb") as stored_state:
2422
pickle.dump((clients, client_settings), stored_state)
3550
with tempfile.NamedTemporaryFile(
3554
dir=os.path.dirname(stored_state_path),
3555
delete=False) as stored_state:
3556
pickle.dump((clients, client_settings), stored_state,
3558
tempname = stored_state.name
2423
3559
os.rename(tempname, stored_state_path)
2424
3560
except (IOError, OSError) as e:
2425
logger.warning("Could not save persistent state: {0}"
2429
3563
os.remove(tempname)
2430
3564
except NameError:
2432
if e.errno not in set((errno.ENOENT, errno.EACCES,
3566
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3567
logger.warning("Could not save persistent state: {}"
3568
.format(os.strerror(e.errno)))
3570
logger.warning("Could not save persistent state:",
2436
3574
# Delete all clients, and settings from config
2437
3575
while tcp_server.clients:
2438
3576
name, client = tcp_server.clients.popitem()
2440
3578
client.remove_from_connection()
2441
# Don't signal anything except ClientRemoved
3579
# Don't signal the disabling
2442
3580
client.disable(quiet=True)
3581
# Emit D-Bus signal for removal
2445
mandos_dbus_service.ClientRemoved(client
3583
mandos_dbus_service.client_removed_signal(client)
2448
3584
client_settings.clear()
2450
3586
atexit.register(cleanup)
2452
for client in tcp_server.clients.itervalues():
3588
for client in tcp_server.clients.values():
2455
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3590
# Emit D-Bus signal for adding
3591
mandos_dbus_service.client_added_signal(client)
2456
3592
# Need to initiate checking of clients
2457
3593
if client.enabled:
2458
3594
client.init_checker()
2460
3596
tcp_server.enable()
2461
3597
tcp_server.server_activate()
2463
3599
# Find out what port we got
2464
service.port = tcp_server.socket.getsockname()[1]
3601
service.port = tcp_server.socket.getsockname()[1]
2466
3603
logger.info("Now listening on address %r, port %d,"
2467
" flowinfo %d, scope_id %d"
2468
% tcp_server.socket.getsockname())
3604
" flowinfo %d, scope_id %d",
3605
*tcp_server.socket.getsockname())
2470
logger.info("Now listening on address %r, port %d"
2471
% tcp_server.socket.getsockname())
2473
#service.interface = tcp_server.socket.getsockname()[3]
3607
logger.info("Now listening on address %r, port %d",
3608
*tcp_server.socket.getsockname())
3610
# service.interface = tcp_server.socket.getsockname()[3]
2476
# From the Avahi example code
2479
except dbus.exceptions.DBusException as error:
2480
logger.critical("DBusException: %s", error)
2483
# End of Avahi example code
2485
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2486
lambda *args, **kwargs:
2487
(tcp_server.handle_request
2488
(*args[2:], **kwargs) or True))
3614
# From the Avahi example code
3617
except dbus.exceptions.DBusException as error:
3618
logger.critical("D-Bus Exception", exc_info=error)
3621
# End of Avahi example code
3624
GLib.IOChannel.unix_new(tcp_server.fileno()),
3625
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3626
lambda *args, **kwargs: (tcp_server.handle_request
3627
(*args[2:], **kwargs) or True))
2490
3629
logger.debug("Starting main loop")
2491
3630
main_loop.run()
2492
3631
except AvahiError as error:
2493
logger.critical("AvahiError: %s", error)
3632
logger.critical("Avahi Error", exc_info=error)
2496
3635
except KeyboardInterrupt: