63
import cPickle as pickle
70
import cPickle as pickle
64
73
import multiprocessing
70
84
import dbus.service
86
from gi.repository import GLib
73
87
from dbus.mainloop.glib import DBusGMainLoop
76
90
import xml.dom.minidom
93
if sys.version_info.major == 2:
97
# Add collections.abc.Callable if it does not exist
99
collections.abc.Callable
100
except AttributeError:
102
Callable = collections.Callable
103
collections.abc = abc
106
# Show warnings by default
107
if not sys.warnoptions:
109
warnings.simplefilter("default")
111
# Try to find the value of SO_BINDTODEVICE:
113
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
114
# newer, and it is also the most natural place for it:
81
115
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
82
116
except AttributeError:
118
# This is where SO_BINDTODEVICE was up to and including Python
84
120
from IN import SO_BINDTODEVICE
85
121
except ImportError:
86
SO_BINDTODEVICE = None
122
# In Python 2.7 it seems to have been removed entirely.
123
# Try running the C preprocessor:
125
cc = subprocess.Popen(["cc", "--language=c", "-E",
127
stdin=subprocess.PIPE,
128
stdout=subprocess.PIPE)
129
stdout = cc.communicate(
130
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
131
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
132
except (OSError, ValueError, IndexError):
134
SO_BINDTODEVICE = None
136
if sys.version_info < (3, 2):
137
configparser.Configparser = configparser.SafeConfigParser
89
140
stored_state_file = "clients.pickle"
91
142
logger = logging.getLogger()
92
syslogger = (logging.handlers.SysLogHandler
93
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
94
address = str("/dev/log")))
143
logging.captureWarnings(True) # Show warnings via the logging system
97
if_nametoindex = (ctypes.cdll.LoadLibrary
98
(ctypes.util.find_library("c"))
147
if_nametoindex = ctypes.cdll.LoadLibrary(
148
ctypes.util.find_library("c")).if_nametoindex
100
149
except (OSError, AttributeError):
101
151
def if_nametoindex(interface):
102
152
"Get an interface index the hard way, i.e. using fcntl()"
103
153
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
104
154
with contextlib.closing(socket.socket()) as s:
105
155
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
106
struct.pack(str("16s16x"),
108
interface_index = struct.unpack(str("I"),
156
struct.pack(b"16s16x", interface))
157
interface_index = struct.unpack("I", ifreq[16:20])[0]
110
158
return interface_index
161
def copy_function(func):
162
"""Make a copy of a function"""
163
if sys.version_info.major == 2:
164
return types.FunctionType(func.func_code,
170
return types.FunctionType(func.__code__,
113
177
def initlogger(debug, level=logging.WARNING):
114
178
"""init logger and add loglevel"""
181
syslogger = (logging.handlers.SysLogHandler(
182
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
116
184
syslogger.setFormatter(logging.Formatter
117
185
('Mandos [%(process)d]: %(levelname)s:'
119
187
logger.addHandler(syslogger)
122
190
console = logging.StreamHandler()
123
191
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
168
248
os.rmdir(self.tempdir)
169
249
self.tempdir = None
171
251
def password_encode(self, password):
172
252
# Passphrase can not be empty and can not contain newlines or
173
253
# NUL bytes. So we prefix it and hex encode it.
174
return b"mandos" + binascii.hexlify(password)
254
encoded = b"mandos" + binascii.hexlify(password)
255
if len(encoded) > 2048:
256
# GnuPG can't handle long passwords, so encode differently
257
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
258
.replace(b"\n", b"\\n")
259
.replace(b"\0", b"\\x00"))
176
262
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
263
passphrase = self.password_encode(password)
264
with tempfile.NamedTemporaryFile(
265
dir=self.tempdir) as passfile:
266
passfile.write(passphrase)
268
proc = subprocess.Popen([self.gpg, '--symmetric',
272
stdin=subprocess.PIPE,
273
stdout=subprocess.PIPE,
274
stderr=subprocess.PIPE)
275
ciphertext, err = proc.communicate(input=data)
276
if proc.returncode != 0:
191
278
return ciphertext
193
280
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
281
passphrase = self.password_encode(password)
282
with tempfile.NamedTemporaryFile(
283
dir=self.tempdir) as passfile:
284
passfile.write(passphrase)
286
proc = subprocess.Popen([self.gpg, '--decrypt',
290
stdin=subprocess.PIPE,
291
stdout=subprocess.PIPE,
292
stderr=subprocess.PIPE)
293
decrypted_plaintext, err = proc.communicate(input=data)
294
if proc.returncode != 0:
208
296
return decrypted_plaintext
299
# Pretend that we have an Avahi module
301
"""This isn't so much a class as it is a module-like namespace."""
302
IF_UNSPEC = -1 # avahi-common/address.h
303
PROTO_UNSPEC = -1 # avahi-common/address.h
304
PROTO_INET = 0 # avahi-common/address.h
305
PROTO_INET6 = 1 # avahi-common/address.h
306
DBUS_NAME = "org.freedesktop.Avahi"
307
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
308
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
309
DBUS_PATH_SERVER = "/"
312
def string_array_to_txt_array(t):
313
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
314
for s in t), signature="ay")
315
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
316
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
317
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
318
SERVER_INVALID = 0 # avahi-common/defs.h
319
SERVER_REGISTERING = 1 # avahi-common/defs.h
320
SERVER_RUNNING = 2 # avahi-common/defs.h
321
SERVER_COLLISION = 3 # avahi-common/defs.h
322
SERVER_FAILURE = 4 # avahi-common/defs.h
212
325
class AvahiError(Exception):
213
326
def __init__(self, value, *args, **kwargs):
214
327
self.value = value
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
328
return super(AvahiError, self).__init__(value, *args,
219
332
class AvahiServiceError(AvahiError):
222
336
class AvahiGroupError(AvahiError):
226
class AvahiService(object):
227
341
"""An Avahi (Zeroconf) service.
230
344
interface: integer; avahi.IF_UNSPEC or an interface index.
231
345
Used to optionally bind to the specified interface.
232
346
name: string; Example: 'Mandos'
233
347
type: string; Example: '_mandos._tcp'.
234
See <http://www.dns-sd.org/ServiceTypes.html>
348
See <https://www.iana.org/assignments/service-names-port-numbers>
235
349
port: integer; what port to announce
236
350
TXT: list of strings; TXT record for the service
237
351
domain: string; Domain to publish on, default to .local if empty.
366
510
follow_name_owner_changes=True),
367
511
avahi.DBUS_INTERFACE_SERVER)
368
512
self.server.connect_to_signal("StateChanged",
369
self.server_state_changed)
513
self.server_state_changed)
370
514
self.server_state_changed(self.server.GetState())
372
517
class AvahiServiceToSyslog(AvahiService):
518
def rename(self, *args, **kwargs):
374
519
"""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'
520
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
521
syslogger.setFormatter(logging.Formatter(
522
'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):
527
# Pretend that we have a GnuTLS module
529
"""This isn't so much a class as it is a module-like namespace."""
531
library = ctypes.util.find_library("gnutls")
533
library = ctypes.util.find_library("gnutls-deb0")
534
_library = ctypes.cdll.LoadLibrary(library)
537
# Unless otherwise indicated, the constants and types below are
538
# all from the gnutls/gnutls.h C header file.
549
E_NO_CERTIFICATE_FOUND = -49
554
KEYID_USE_SHA256 = 1 # gnutls/x509.h
555
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
558
class session_int(ctypes.Structure):
560
session_t = ctypes.POINTER(session_int)
562
class certificate_credentials_st(ctypes.Structure):
564
certificate_credentials_t = ctypes.POINTER(
565
certificate_credentials_st)
566
certificate_type_t = ctypes.c_int
568
class datum_t(ctypes.Structure):
569
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
570
('size', ctypes.c_uint)]
572
class openpgp_crt_int(ctypes.Structure):
574
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
575
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
576
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
577
credentials_type_t = ctypes.c_int
578
transport_ptr_t = ctypes.c_void_p
579
close_request_t = ctypes.c_int
582
class Error(Exception):
583
def __init__(self, message=None, code=None, args=()):
584
# Default usage is by a message string, but if a return
585
# code is passed, convert it to a string with
588
if message is None and code is not None:
589
message = gnutls.strerror(code)
590
return super(gnutls.Error, self).__init__(
593
class CertificateSecurityError(Error):
599
self._c_object = gnutls.certificate_credentials_t()
600
gnutls.certificate_allocate_credentials(
601
ctypes.byref(self._c_object))
602
self.type = gnutls.CRD_CERTIFICATE
605
gnutls.certificate_free_credentials(self._c_object)
608
def __init__(self, socket, credentials=None):
609
self._c_object = gnutls.session_t()
610
gnutls_flags = gnutls.CLIENT
611
if gnutls.check_version(b"3.5.6"):
612
gnutls_flags |= gnutls.NO_TICKETS
614
gnutls_flags |= gnutls.ENABLE_RAWPK
615
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
617
gnutls.set_default_priority(self._c_object)
618
gnutls.transport_set_ptr(self._c_object, socket.fileno())
619
gnutls.handshake_set_private_extensions(self._c_object,
622
if credentials is None:
623
credentials = gnutls.Credentials()
624
gnutls.credentials_set(self._c_object, credentials.type,
625
ctypes.cast(credentials._c_object,
627
self.credentials = credentials
630
gnutls.deinit(self._c_object)
633
return gnutls.handshake(self._c_object)
635
def send(self, data):
639
data_len -= gnutls.record_send(self._c_object,
644
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
646
# Error handling functions
647
def _error_code(result):
648
"""A function to raise exceptions on errors, suitable
649
for the 'restype' attribute on ctypes functions"""
652
if result == gnutls.E_NO_CERTIFICATE_FOUND:
653
raise gnutls.CertificateSecurityError(code=result)
654
raise gnutls.Error(code=result)
656
def _retry_on_error(result, func, arguments):
657
"""A function to retry on some errors, suitable
658
for the 'errcheck' attribute on ctypes functions"""
660
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
661
return _error_code(result)
662
result = func(*arguments)
665
# Unless otherwise indicated, the function declarations below are
666
# all from the gnutls/gnutls.h C header file.
669
priority_set_direct = _library.gnutls_priority_set_direct
670
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
671
ctypes.POINTER(ctypes.c_char_p)]
672
priority_set_direct.restype = _error_code
674
init = _library.gnutls_init
675
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
676
init.restype = _error_code
678
set_default_priority = _library.gnutls_set_default_priority
679
set_default_priority.argtypes = [session_t]
680
set_default_priority.restype = _error_code
682
record_send = _library.gnutls_record_send
683
record_send.argtypes = [session_t, ctypes.c_void_p,
685
record_send.restype = ctypes.c_ssize_t
686
record_send.errcheck = _retry_on_error
688
certificate_allocate_credentials = (
689
_library.gnutls_certificate_allocate_credentials)
690
certificate_allocate_credentials.argtypes = [
691
ctypes.POINTER(certificate_credentials_t)]
692
certificate_allocate_credentials.restype = _error_code
694
certificate_free_credentials = (
695
_library.gnutls_certificate_free_credentials)
696
certificate_free_credentials.argtypes = [
697
certificate_credentials_t]
698
certificate_free_credentials.restype = None
700
handshake_set_private_extensions = (
701
_library.gnutls_handshake_set_private_extensions)
702
handshake_set_private_extensions.argtypes = [session_t,
704
handshake_set_private_extensions.restype = None
706
credentials_set = _library.gnutls_credentials_set
707
credentials_set.argtypes = [session_t, credentials_type_t,
709
credentials_set.restype = _error_code
711
strerror = _library.gnutls_strerror
712
strerror.argtypes = [ctypes.c_int]
713
strerror.restype = ctypes.c_char_p
715
certificate_type_get = _library.gnutls_certificate_type_get
716
certificate_type_get.argtypes = [session_t]
717
certificate_type_get.restype = _error_code
719
certificate_get_peers = _library.gnutls_certificate_get_peers
720
certificate_get_peers.argtypes = [session_t,
721
ctypes.POINTER(ctypes.c_uint)]
722
certificate_get_peers.restype = ctypes.POINTER(datum_t)
724
global_set_log_level = _library.gnutls_global_set_log_level
725
global_set_log_level.argtypes = [ctypes.c_int]
726
global_set_log_level.restype = None
728
global_set_log_function = _library.gnutls_global_set_log_function
729
global_set_log_function.argtypes = [log_func]
730
global_set_log_function.restype = None
732
deinit = _library.gnutls_deinit
733
deinit.argtypes = [session_t]
734
deinit.restype = None
736
handshake = _library.gnutls_handshake
737
handshake.argtypes = [session_t]
738
handshake.restype = _error_code
739
handshake.errcheck = _retry_on_error
741
transport_set_ptr = _library.gnutls_transport_set_ptr
742
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
743
transport_set_ptr.restype = None
745
bye = _library.gnutls_bye
746
bye.argtypes = [session_t, close_request_t]
747
bye.restype = _error_code
748
bye.errcheck = _retry_on_error
750
check_version = _library.gnutls_check_version
751
check_version.argtypes = [ctypes.c_char_p]
752
check_version.restype = ctypes.c_char_p
754
_need_version = b"3.3.0"
755
if check_version(_need_version) is None:
756
raise self.Error("Needs GnuTLS {} or later"
757
.format(_need_version))
759
_tls_rawpk_version = b"3.6.6"
760
has_rawpk = bool(check_version(_tls_rawpk_version))
764
class pubkey_st(ctypes.Structure):
766
pubkey_t = ctypes.POINTER(pubkey_st)
768
x509_crt_fmt_t = ctypes.c_int
770
# All the function declarations below are from gnutls/abstract.h
771
pubkey_init = _library.gnutls_pubkey_init
772
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
773
pubkey_init.restype = _error_code
775
pubkey_import = _library.gnutls_pubkey_import
776
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
778
pubkey_import.restype = _error_code
780
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
781
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
782
ctypes.POINTER(ctypes.c_ubyte),
783
ctypes.POINTER(ctypes.c_size_t)]
784
pubkey_get_key_id.restype = _error_code
786
pubkey_deinit = _library.gnutls_pubkey_deinit
787
pubkey_deinit.argtypes = [pubkey_t]
788
pubkey_deinit.restype = None
790
# All the function declarations below are from gnutls/openpgp.h
792
openpgp_crt_init = _library.gnutls_openpgp_crt_init
793
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
794
openpgp_crt_init.restype = _error_code
796
openpgp_crt_import = _library.gnutls_openpgp_crt_import
797
openpgp_crt_import.argtypes = [openpgp_crt_t,
798
ctypes.POINTER(datum_t),
800
openpgp_crt_import.restype = _error_code
802
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
803
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
804
ctypes.POINTER(ctypes.c_uint)]
805
openpgp_crt_verify_self.restype = _error_code
807
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
808
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
809
openpgp_crt_deinit.restype = None
811
openpgp_crt_get_fingerprint = (
812
_library.gnutls_openpgp_crt_get_fingerprint)
813
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
817
openpgp_crt_get_fingerprint.restype = _error_code
819
if check_version(b"3.6.4"):
820
certificate_type_get2 = _library.gnutls_certificate_type_get2
821
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
822
certificate_type_get2.restype = _error_code
824
# Remove non-public functions
825
del _error_code, _retry_on_error
828
def call_pipe(connection, # : multiprocessing.Connection
829
func, *args, **kwargs):
830
"""This function is meant to be called by multiprocessing.Process
832
This function runs func(*args, **kwargs), and writes the resulting
833
return value on the provided multiprocessing.Connection.
835
connection.send(func(*args, **kwargs))
389
840
"""A representation of a client host served by this server.
392
843
approved: bool(); 'None' if not yet approved/disapproved
393
844
approval_delay: datetime.timedelta(); Time to wait for approval
394
845
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
846
checker: multiprocessing.Process(); a running checker process used
847
to see if the client lives. 'None' if no process is
849
checker_callback_tag: a GLib event source tag, or None
399
850
checker_command: string; External command which is run to check
400
851
if client lives. %() expansions are done at
401
852
runtime with vars(self) as dict, so that for
402
853
instance %(name)s can be used in the command.
403
checker_initiator_tag: a gobject event source tag, or None
854
checker_initiator_tag: a GLib event source tag, or None
404
855
created: datetime.datetime(); (UTC) object creation
405
856
client_structure: Object describing what attributes a client has
406
857
and is used for storing the client at exit
407
858
current_checker_command: string; current running checker_command
408
disable_initiator_tag: a gobject event source tag, or None
859
disable_initiator_tag: a GLib event source tag, or None
410
861
fingerprint: string (40 or 32 hexadecimal digits); used to
411
uniquely identify the client
862
uniquely identify an OpenPGP client
863
key_id: string (64 hexadecimal digits); used to uniquely identify
864
a client using raw public keys
412
865
host: string; available for use by the checker command
413
866
interval: datetime.timedelta(); How often to start a new checker
414
867
last_approval_request: datetime.datetime(); (UTC) or None
415
868
last_checked_ok: datetime.datetime(); (UTC) or None
416
869
last_checker_status: integer between 0 and 255 reflecting exit
417
870
status of last checker. -1 reflects crashed
871
checker, -2 means no checker completed yet.
872
last_checker_signal: The signal which killed the last checker, if
873
last_checker_status is -1
419
874
last_enabled: datetime.datetime(); (UTC) or None
420
875
name: string; from the config file, used in log messages and
421
876
D-Bus identifiers
422
877
secret: bytestring; sent verbatim (over TLS) to client
423
878
timeout: datetime.timedelta(); How long from last_checked_ok
424
879
until this client is disabled
425
extended_timeout: extra long timeout when password has been sent
880
extended_timeout: extra long timeout when secret has been sent
426
881
runtime_expansions: Allowed attributes for runtime expansion.
427
882
expires: datetime.datetime(); time (UTC) when a client will be
428
883
disabled, or None
884
server_settings: The server_settings dict from main()
431
887
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
888
"created", "enabled", "expires", "key_id",
889
"fingerprint", "host", "interval",
890
"last_approval_request", "last_checked_ok",
434
891
"last_enabled", "name", "timeout")
435
client_defaults = { "timeout": "5m",
436
"extended_timeout": "15m",
438
"checker": "fping -q -- %%(host)s",
440
"approval_delay": "0s",
441
"approval_duration": "1s",
442
"approved_by_default": "True",
446
def timeout_milliseconds(self):
447
"Return the 'timeout' attribute in milliseconds"
448
return timedelta_to_milliseconds(self.timeout)
450
def extended_timeout_milliseconds(self):
451
"Return the 'extended_timeout' attribute in milliseconds"
452
return timedelta_to_milliseconds(self.extended_timeout)
454
def interval_milliseconds(self):
455
"Return the 'interval' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.interval)
458
def approval_delay_milliseconds(self):
459
return timedelta_to_milliseconds(self.approval_delay)
894
"extended_timeout": "PT15M",
896
"checker": "fping -q -- %%(host)s",
898
"approval_delay": "PT0S",
899
"approval_duration": "PT1S",
900
"approved_by_default": "True",
462
905
def config_parser(config):
541
988
self.current_checker_command = None
542
989
self.approved = None
543
990
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()
991
self.changedstate = multiprocessing_manager.Condition(
992
multiprocessing_manager.Lock())
993
self.client_structure = [attr
994
for attr in self.__dict__.keys()
549
995
if not attr.startswith("_")]
550
996
self.client_structure.append("client_structure")
552
for name, t in inspect.getmembers(type(self),
998
for name, t in inspect.getmembers(
999
type(self), lambda obj: isinstance(obj, property)):
556
1000
if not name.startswith("_"):
557
1001
self.client_structure.append(name)
559
1003
# Send notice to process children that client state has changed
560
1004
def send_changedstate(self):
561
1005
with self.changedstate:
562
1006
self.changedstate.notify_all()
564
1008
def enable(self):
565
1009
"""Start this client's checker and timeout hooks"""
566
1010
if getattr(self, "enabled", False):
567
1011
# Already enabled
569
self.send_changedstate()
570
1013
self.expires = datetime.datetime.utcnow() + self.timeout
571
1014
self.enabled = True
572
1015
self.last_enabled = datetime.datetime.utcnow()
573
1016
self.init_checker()
1017
self.send_changedstate()
575
1019
def disable(self, quiet=True):
576
1020
"""Disable this client."""
577
1021
if not getattr(self, "enabled", False):
580
self.send_changedstate()
582
1024
logger.info("Disabling client %s", self.name)
583
if getattr(self, "disable_initiator_tag", False):
584
gobject.source_remove(self.disable_initiator_tag)
1025
if getattr(self, "disable_initiator_tag", None) is not None:
1026
GLib.source_remove(self.disable_initiator_tag)
585
1027
self.disable_initiator_tag = None
586
1028
self.expires = None
587
if getattr(self, "checker_initiator_tag", False):
588
gobject.source_remove(self.checker_initiator_tag)
1029
if getattr(self, "checker_initiator_tag", None) is not None:
1030
GLib.source_remove(self.checker_initiator_tag)
589
1031
self.checker_initiator_tag = None
590
1032
self.stop_checker()
591
1033
self.enabled = False
592
# Do not run this again if called by a gobject.timeout_add
1035
self.send_changedstate()
1036
# Do not run this again if called by a GLib.timeout_add
595
1039
def __del__(self):
598
1042
def init_checker(self):
599
1043
# Schedule a new checker to be started an 'interval' from now,
600
1044
# and every interval from then on.
601
self.checker_initiator_tag = (gobject.timeout_add
602
(self.interval_milliseconds(),
1045
if self.checker_initiator_tag is not None:
1046
GLib.source_remove(self.checker_initiator_tag)
1047
self.checker_initiator_tag = GLib.timeout_add(
1048
random.randrange(int(self.interval.total_seconds() * 1000
604
1051
# Schedule a disable() when 'timeout' has passed
605
self.disable_initiator_tag = (gobject.timeout_add
606
(self.timeout_milliseconds(),
1052
if self.disable_initiator_tag is not None:
1053
GLib.source_remove(self.disable_initiator_tag)
1054
self.disable_initiator_tag = GLib.timeout_add(
1055
int(self.timeout.total_seconds() * 1000), self.disable)
608
1056
# Also start a new checker *right now*.
609
1057
self.start_checker()
611
def checker_callback(self, pid, condition, command):
1059
def checker_callback(self, source, condition, connection,
612
1061
"""The checker has completed, so take appropriate actions."""
1062
# Read return code from connection (see call_pipe)
1063
returncode = connection.recv()
1065
if self.checker is not None:
613
1067
self.checker_callback_tag = None
614
1068
self.checker = None
615
if os.WIFEXITED(condition):
616
self.last_checker_status = os.WEXITSTATUS(condition)
1071
self.last_checker_status = returncode
1072
self.last_checker_signal = None
617
1073
if self.last_checker_status == 0:
618
1074
logger.info("Checker for %(name)s succeeded",
620
1076
self.checked_ok()
622
logger.info("Checker for %(name)s failed",
1078
logger.info("Checker for %(name)s failed", vars(self))
625
1080
self.last_checker_status = -1
1081
self.last_checker_signal = -returncode
626
1082
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,
1086
def checked_ok(self):
1087
"""Assert that the client has been seen, alive and well."""
1088
self.last_checked_ok = datetime.datetime.utcnow()
1089
self.last_checker_status = 0
1090
self.last_checker_signal = None
1093
def bump_timeout(self, timeout=None):
1094
"""Bump up the timeout for this client."""
635
1095
if timeout is None:
636
1096
timeout = self.timeout
637
self.last_checked_ok = datetime.datetime.utcnow()
638
1097
if self.disable_initiator_tag is not None:
639
gobject.source_remove(self.disable_initiator_tag)
1098
GLib.source_remove(self.disable_initiator_tag)
1099
self.disable_initiator_tag = None
640
1100
if getattr(self, "enabled", False):
641
self.disable_initiator_tag = (gobject.timeout_add
642
(timedelta_to_milliseconds
643
(timeout), self.disable))
1101
self.disable_initiator_tag = GLib.timeout_add(
1102
int(timeout.total_seconds() * 1000), self.disable)
644
1103
self.expires = datetime.datetime.utcnow() + timeout
646
1105
def need_approval(self):
647
1106
self.last_approval_request = datetime.datetime.utcnow()
649
1108
def start_checker(self):
650
1109
"""Start a new checker subprocess if one is not running.
652
1111
If a checker already exists, leave it running and do
654
1113
# 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
1114
# did that, and if a checker (for some reason) started running
1115
# slowly and taking more than 'interval' time, then the client
1116
# would inevitably timeout, since no checker would get a
1117
# chance to run to completion. If we instead leave running
659
1118
# checkers alone, the checker would have to take more time
660
1119
# 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)
1122
if self.checker is not None and not self.checker.is_alive():
1123
logger.warning("Checker was not alive; joining")
676
1126
# Start a new checker if needed
677
1127
if self.checker is None:
1128
# Escape attributes for the shell
1130
attr: re.escape(str(getattr(self, attr)))
1131
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
1133
command = self.checker_command % escaped_attrs
1134
except TypeError as error:
1135
logger.error('Could not format string "%s"',
1136
self.checker_command,
1138
return True # Try again later
697
1139
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
1140
logger.info("Starting checker %r for %s", command,
1142
# We don't need to redirect stdout and stderr, since
1143
# in normal mode, that is already done by daemon(),
1144
# and in debug mode we don't want to. (Stdin is
1145
# always replaced by /dev/null.)
1146
# The exception is when not debugging but nevertheless
1147
# running in the foreground; use the previously
1149
popen_args = {"close_fds": True,
1152
if (not self.server_settings["debug"]
1153
and self.server_settings["foreground"]):
1154
popen_args.update({"stdout": wnull,
1156
pipe = multiprocessing.Pipe(duplex=False)
1157
self.checker = multiprocessing.Process(
1159
args=(pipe[1], subprocess.call, command),
1161
self.checker.start()
1162
self.checker_callback_tag = GLib.io_add_watch(
1163
GLib.IOChannel.unix_new(pipe[0].fileno()),
1164
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1165
self.checker_callback, pipe[0], command)
1166
# Re-run this periodically if run by GLib.timeout_add
724
1169
def stop_checker(self):
725
1170
"""Force the checker process, if any, to stop."""
726
1171
if self.checker_callback_tag:
727
gobject.source_remove(self.checker_callback_tag)
1172
GLib.source_remove(self.checker_callback_tag)
728
1173
self.checker_callback_tag = None
729
1174
if getattr(self, "checker", None) is None:
731
1176
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
1177
self.checker.terminate()
740
1178
self.checker = None
743
def dbus_service_property(dbus_interface, signature="v",
744
access="readwrite", byte_arrays=False):
1181
def dbus_service_property(dbus_interface,
745
1185
"""Decorators for marking methods of a DBusObjectWithProperties to
746
1186
become properties on the D-Bus.
748
1188
The decorated method will be called with no arguments by "Get"
749
1189
and with one argument by "Set".
751
1191
The parameters, where they are supported, are the same as
752
1192
dbus.service.method, except there is only "signature", since the
753
1193
type from Get() and the type sent to Set() is the same.
792
class DBusObjectWithProperties(dbus.service.Object):
1276
class DBusObjectWithAnnotations(dbus.service.Object):
1277
"""A D-Bus object with annotations.
1279
Classes inheriting from this can use the dbus_annotations
1280
decorator to add annotations to methods or signals.
1284
def _is_dbus_thing(thing):
1285
"""Returns a function testing if an attribute is a D-Bus thing
1287
If called like _is_dbus_thing("method") it returns a function
1288
suitable for use as predicate to inspect.getmembers().
1290
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1293
def _get_all_dbus_things(self, thing):
1294
"""Returns a generator of (name, attribute) pairs
1296
return ((getattr(athing.__get__(self), "_dbus_name", name),
1297
athing.__get__(self))
1298
for cls in self.__class__.__mro__
1300
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1302
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1304
path_keyword='object_path',
1305
connection_keyword='connection')
1306
def Introspect(self, object_path, connection):
1307
"""Overloading of standard D-Bus method.
1309
Inserts annotation tags on methods and signals.
1311
xmlstring = dbus.service.Object.Introspect(self, object_path,
1314
document = xml.dom.minidom.parseString(xmlstring)
1316
for if_tag in document.getElementsByTagName("interface"):
1317
# Add annotation tags
1318
for typ in ("method", "signal"):
1319
for tag in if_tag.getElementsByTagName(typ):
1321
for name, prop in (self.
1322
_get_all_dbus_things(typ)):
1323
if (name == tag.getAttribute("name")
1324
and prop._dbus_interface
1325
== if_tag.getAttribute("name")):
1326
annots.update(getattr(
1327
prop, "_dbus_annotations", {}))
1328
for name, value in annots.items():
1329
ann_tag = document.createElement(
1331
ann_tag.setAttribute("name", name)
1332
ann_tag.setAttribute("value", value)
1333
tag.appendChild(ann_tag)
1334
# Add interface annotation tags
1335
for annotation, value in dict(
1336
itertools.chain.from_iterable(
1337
annotations().items()
1338
for name, annotations
1339
in self._get_all_dbus_things("interface")
1340
if name == if_tag.getAttribute("name")
1342
ann_tag = document.createElement("annotation")
1343
ann_tag.setAttribute("name", annotation)
1344
ann_tag.setAttribute("value", value)
1345
if_tag.appendChild(ann_tag)
1346
# Fix argument name for the Introspect method itself
1347
if (if_tag.getAttribute("name")
1348
== dbus.INTROSPECTABLE_IFACE):
1349
for cn in if_tag.getElementsByTagName("method"):
1350
if cn.getAttribute("name") == "Introspect":
1351
for arg in cn.getElementsByTagName("arg"):
1352
if (arg.getAttribute("direction")
1354
arg.setAttribute("name",
1356
xmlstring = document.toxml("utf-8")
1358
except (AttributeError, xml.dom.DOMException,
1359
xml.parsers.expat.ExpatError) as error:
1360
logger.error("Failed to override Introspection method",
1365
class DBusObjectWithProperties(DBusObjectWithAnnotations):
793
1366
"""A D-Bus object with properties.
795
1368
Classes inheriting from this can use the dbus_service_property
796
1369
decorator to expose methods as D-Bus properties. It exposes the
797
1370
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
1373
def _get_dbus_property(self, interface_name, property_name):
813
1374
"""Returns a bound method if one exists which is a D-Bus
814
1375
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)):
1377
for cls in self.__class__.__mro__:
1378
for name, value in inspect.getmembers(
1379
cls, self._is_dbus_thing("property")):
819
1380
if (value._dbus_name == property_name
820
1381
and value._dbus_interface == interface_name):
821
1382
return value.__get__(self)
823
1384
# No such property
824
raise DBusPropertyNotFound(self.dbus_object_path + ":"
825
+ interface_name + "."
828
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1385
raise DBusPropertyNotFound("{}:{}.{}".format(
1386
self.dbus_object_path, interface_name, property_name))
1389
def _get_all_interface_names(cls):
1390
"""Get a sequence of all interfaces supported by an object"""
1391
return (name for name in set(getattr(getattr(x, attr),
1392
"_dbus_interface", None)
1393
for x in (inspect.getmro(cls))
1395
if name is not None)
1397
@dbus.service.method(dbus.PROPERTIES_IFACE,
829
1399
out_signature="v")
830
1400
def Get(self, interface_name, property_name):
831
1401
"""Standard D-Bus property Get() method, see D-Bus standard.
923
1525
except (AttributeError, xml.dom.DOMException,
924
1526
xml.parsers.expat.ExpatError) as error:
925
1527
logger.error("Failed to override Introspection method",
930
def datetime_to_dbus (dt, variant_level=0):
1533
dbus.OBJECT_MANAGER_IFACE
1534
except AttributeError:
1535
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1538
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1539
"""A D-Bus object with an ObjectManager.
1541
Classes inheriting from this exposes the standard
1542
GetManagedObjects call and the InterfacesAdded and
1543
InterfacesRemoved signals on the standard
1544
"org.freedesktop.DBus.ObjectManager" interface.
1546
Note: No signals are sent automatically; they must be sent
1549
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1550
out_signature="a{oa{sa{sv}}}")
1551
def GetManagedObjects(self):
1552
"""This function must be overridden"""
1553
raise NotImplementedError()
1555
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1556
signature="oa{sa{sv}}")
1557
def InterfacesAdded(self, object_path, interfaces_and_properties):
1560
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1561
def InterfacesRemoved(self, object_path, interfaces):
1564
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1566
path_keyword='object_path',
1567
connection_keyword='connection')
1568
def Introspect(self, object_path, connection):
1569
"""Overloading of standard D-Bus method.
1571
Override return argument name of GetManagedObjects to be
1572
"objpath_interfaces_and_properties"
1574
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1578
document = xml.dom.minidom.parseString(xmlstring)
1580
for if_tag in document.getElementsByTagName("interface"):
1581
# Fix argument name for the GetManagedObjects method
1582
if (if_tag.getAttribute("name")
1583
== dbus.OBJECT_MANAGER_IFACE):
1584
for cn in if_tag.getElementsByTagName("method"):
1585
if (cn.getAttribute("name")
1586
== "GetManagedObjects"):
1587
for arg in cn.getElementsByTagName("arg"):
1588
if (arg.getAttribute("direction")
1592
"objpath_interfaces"
1594
xmlstring = document.toxml("utf-8")
1596
except (AttributeError, xml.dom.DOMException,
1597
xml.parsers.expat.ExpatError) as error:
1598
logger.error("Failed to override Introspection method",
1603
def datetime_to_dbus(dt, variant_level=0):
931
1604
"""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.
1606
return dbus.String("", variant_level=variant_level)
1607
return dbus.String(dt.isoformat(), variant_level=variant_level)
1610
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1611
"""A class decorator; applied to a subclass of
1612
dbus.service.Object, it will add alternate D-Bus attributes with
1613
interface names according to the "alt_interface_names" mapping.
1616
@alternate_dbus_interfaces({"org.example.Interface":
1617
"net.example.AlternateInterface"})
1618
class SampleDBusObject(dbus.service.Object):
1619
@dbus.service.method("org.example.Interface")
1620
def SampleDBusMethod():
1623
The above "SampleDBusMethod" on "SampleDBusObject" will be
1624
reachable via two interfaces: "org.example.Interface" and
1625
"net.example.AlternateInterface", the latter of which will have
1626
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1627
"true", unless "deprecate" is passed with a False value.
1629
This works for methods and signals, and also for D-Bus properties
1630
(from DBusObjectWithProperties) and interfaces (from the
1631
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):
1635
for orig_interface_name, alt_interface_name in (
1636
alt_interface_names.items()):
1638
interface_names = set()
1639
# Go though all attributes of the class
1640
for attrname, attribute in inspect.getmembers(cls):
950
1641
# Ignore non-D-Bus attributes, and D-Bus attributes
951
1642
# with the wrong interface name
952
1643
if (not hasattr(attribute, "_dbus_interface")
953
or not attribute._dbus_interface
954
.startswith("se.recompile.Mandos")):
1644
or not attribute._dbus_interface.startswith(
1645
orig_interface_name)):
956
1647
# Create an alternate D-Bus interface name based on
957
1648
# the current name
958
alt_interface = (attribute._dbus_interface
959
.replace("se.recompile.Mandos",
960
"se.bsnet.fukt.Mandos"))
1649
alt_interface = attribute._dbus_interface.replace(
1650
orig_interface_name, alt_interface_name)
1651
interface_names.add(alt_interface)
961
1652
# Is this a D-Bus signal?
962
1653
if getattr(attribute, "_dbus_is_signal", False):
963
# Extract the original non-method function by
965
nonmethod_func = (dict(
1654
# Extract the original non-method undecorated
1655
# function by black magic
1656
if sys.version_info.major == 2:
1657
nonmethod_func = (dict(
966
1658
zip(attribute.func_code.co_freevars,
967
attribute.__closure__))["func"]
1659
attribute.__closure__))
1660
["func"].cell_contents)
1662
nonmethod_func = (dict(
1663
zip(attribute.__code__.co_freevars,
1664
attribute.__closure__))
1665
["func"].cell_contents)
969
1666
# Create a new, but exactly alike, function
970
1667
# object, and decorate it to be a new D-Bus signal
971
1668
# 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)))
1669
new_function = copy_function(nonmethod_func)
1670
new_function = (dbus.service.signal(
1672
attribute._dbus_signature)(new_function))
1673
# Copy annotations, if any
1675
new_function._dbus_annotations = dict(
1676
attribute._dbus_annotations)
1677
except AttributeError:
981
1680
# 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
1681
# original and alternate functions, so both the
1682
# original and alternate signals gets sent when
1683
# the function is called
984
1684
def fixscope(func1, func2):
985
1685
"""This function is a scope container to pass
986
1686
func1 and func2 to the "call_both" function
987
1687
outside of its arguments"""
1689
@functools.wraps(func2)
988
1690
def call_both(*args, **kwargs):
989
1691
"""This function will emit two D-Bus
990
1692
signals by calling func1 and func2"""
991
1693
func1(*args, **kwargs)
992
1694
func2(*args, **kwargs)
1695
# Make wrapper function look like a D-Bus
1697
for name, attr in inspect.getmembers(func2):
1698
if name.startswith("_dbus_"):
1699
setattr(call_both, name, attr)
993
1701
return call_both
994
1702
# Create the "call_both" function and add it to
996
attr[attrname] = fixscope(attribute,
1704
attr[attrname] = fixscope(attribute, new_function)
998
1705
# Is this a D-Bus method?
999
1706
elif getattr(attribute, "_dbus_is_method", False):
1000
1707
# Create a new, but exactly alike, function
1001
1708
# object. Decorate it to be a new D-Bus method
1002
1709
# with the alternate D-Bus interface name. Add it
1003
1710
# 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)))
1712
dbus.service.method(
1714
attribute._dbus_in_signature,
1715
attribute._dbus_out_signature)
1716
(copy_function(attribute)))
1717
# Copy annotations, if any
1719
attr[attrname]._dbus_annotations = dict(
1720
attribute._dbus_annotations)
1721
except AttributeError:
1014
1723
# Is this a D-Bus property?
1015
1724
elif getattr(attribute, "_dbus_is_property", False):
1016
1725
# Create a new, but exactly alike, function
1017
1726
# object, and decorate it to be a new D-Bus
1018
1727
# property with the alternate D-Bus interface
1019
1728
# 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)
1729
attr[attrname] = (dbus_service_property(
1730
alt_interface, attribute._dbus_signature,
1731
attribute._dbus_access,
1732
attribute._dbus_get_args_options
1734
(copy_function(attribute)))
1735
# Copy annotations, if any
1737
attr[attrname]._dbus_annotations = dict(
1738
attribute._dbus_annotations)
1739
except AttributeError:
1741
# Is this a D-Bus interface?
1742
elif getattr(attribute, "_dbus_is_interface", False):
1743
# Create a new, but exactly alike, function
1744
# object. Decorate it to be a new D-Bus interface
1745
# with the alternate D-Bus interface name. Add it
1748
dbus_interface_annotations(alt_interface)
1749
(copy_function(attribute)))
1751
# Deprecate all alternate interfaces
1752
iname = "_AlternateDBusNames_interface_annotation{}"
1753
for interface_name in interface_names:
1755
@dbus_interface_annotations(interface_name)
1757
return {"org.freedesktop.DBus.Deprecated":
1759
# Find an unused name
1760
for aname in (iname.format(i)
1761
for i in itertools.count()):
1762
if aname not in attr:
1766
# Replace the class with a new subclass of it with
1767
# methods, signals, etc. as created above.
1768
if sys.version_info.major == 2:
1769
cls = type(b"{}Alternate".format(cls.__name__),
1772
cls = type("{}Alternate".format(cls.__name__),
1779
@alternate_dbus_interfaces({"se.recompile.Mandos":
1780
"se.bsnet.fukt.Mandos"})
1036
1781
class ClientDBus(Client, DBusObjectWithProperties):
1037
1782
"""A Client class using D-Bus
1040
1785
dbus_object_path: dbus.ObjectPath
1041
1786
bus: dbus.SystemBus()
1044
1789
runtime_expansions = (Client.runtime_expansions
1045
+ ("dbus_object_path",))
1790
+ ("dbus_object_path", ))
1792
_interface = "se.recompile.Mandos.Client"
1047
1794
# dbus.service.Object doesn't use super(), so we can't either.
1049
def __init__(self, bus = None, *args, **kwargs):
1796
def __init__(self, bus=None, *args, **kwargs):
1051
1798
Client.__init__(self, *args, **kwargs)
1052
self._approvals_pending = 0
1054
self._approvals_pending = 0
1055
1799
# Only now, when this client is initialized, can it show up on
1057
client_object_name = unicode(self.name).translate(
1801
client_object_name = str(self.name).translate(
1058
1802
{ord("."): ord("_"),
1059
1803
ord("-"): ord("_")})
1060
self.dbus_object_path = (dbus.ObjectPath
1061
("/clients/" + client_object_name))
1804
self.dbus_object_path = dbus.ObjectPath(
1805
"/clients/" + client_object_name)
1062
1806
DBusObjectWithProperties.__init__(self, self.bus,
1063
1807
self.dbus_object_path)
1065
def notifychangeproperty(transform_func,
1066
dbus_name, type_func=lambda x: x,
1809
def notifychangeproperty(transform_func, dbus_name,
1810
type_func=lambda x: x,
1812
invalidate_only=False,
1813
_interface=_interface):
1068
1814
""" Modify a variable so that it's a property which announces
1069
1815
its changes to DBus.
1071
1817
transform_fun: Function that takes a value and a variant_level
1072
1818
and transforms it to a D-Bus type.
1073
1819
dbus_name: D-Bus name of the variable
1075
1821
to the D-Bus. Default: no transform
1076
1822
variant_level: D-Bus variant level. Default: 1
1078
attrname = "_{0}".format(dbus_name)
1824
attrname = "_{}".format(dbus_name)
1079
1826
def setter(self, value):
1080
1827
if hasattr(self, "dbus_object_path"):
1081
1828
if (not hasattr(self, attrname) or
1082
1829
type_func(getattr(self, attrname, None))
1083
1830
!= type_func(value)):
1084
dbus_value = transform_func(type_func(value),
1087
self.PropertyChanged(dbus.String(dbus_name),
1832
self.PropertiesChanged(
1833
_interface, dbus.Dictionary(),
1834
dbus.Array((dbus_name, )))
1836
dbus_value = transform_func(
1838
variant_level=variant_level)
1839
self.PropertyChanged(dbus.String(dbus_name),
1841
self.PropertiesChanged(
1843
dbus.Dictionary({dbus.String(dbus_name):
1089
1846
setattr(self, attrname, value)
1091
1848
return property(lambda self: getattr(self, attrname), setter)
1094
1850
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1095
1851
approvals_pending = notifychangeproperty(dbus.Boolean,
1096
1852
"ApprovalPending",
1098
1854
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1099
1855
last_enabled = notifychangeproperty(datetime_to_dbus,
1101
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1102
type_func = lambda checker:
1103
checker is not None)
1857
checker = notifychangeproperty(
1858
dbus.Boolean, "CheckerRunning",
1859
type_func=lambda checker: checker is not None)
1104
1860
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1105
1861
"LastCheckedOK")
1862
last_checker_status = notifychangeproperty(dbus.Int16,
1863
"LastCheckerStatus")
1106
1864
last_approval_request = notifychangeproperty(
1107
1865
datetime_to_dbus, "LastApprovalRequest")
1108
1866
approved_by_default = notifychangeproperty(dbus.Boolean,
1109
1867
"ApprovedByDefault")
1110
approval_delay = notifychangeproperty(dbus.UInt64,
1113
timedelta_to_milliseconds)
1868
approval_delay = notifychangeproperty(
1869
dbus.UInt64, "ApprovalDelay",
1870
type_func=lambda td: td.total_seconds() * 1000)
1114
1871
approval_duration = notifychangeproperty(
1115
1872
dbus.UInt64, "ApprovalDuration",
1116
type_func = timedelta_to_milliseconds)
1873
type_func=lambda td: td.total_seconds() * 1000)
1117
1874
host = notifychangeproperty(dbus.String, "Host")
1118
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1120
timedelta_to_milliseconds)
1875
timeout = notifychangeproperty(
1876
dbus.UInt64, "Timeout",
1877
type_func=lambda td: td.total_seconds() * 1000)
1121
1878
extended_timeout = notifychangeproperty(
1122
1879
dbus.UInt64, "ExtendedTimeout",
1123
type_func = timedelta_to_milliseconds)
1124
interval = notifychangeproperty(dbus.UInt64,
1127
timedelta_to_milliseconds)
1880
type_func=lambda td: td.total_seconds() * 1000)
1881
interval = notifychangeproperty(
1882
dbus.UInt64, "Interval",
1883
type_func=lambda td: td.total_seconds() * 1000)
1128
1884
checker_command = notifychangeproperty(dbus.String, "Checker")
1885
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1886
invalidate_only=True)
1130
1888
del notifychangeproperty
1132
1890
def __del__(self, *args, **kwargs):
1134
1892
self.remove_from_connection()
1214
1971
server to mandos-client
1218
1975
# Rejected - signal
1219
1976
@dbus.service.signal(_interface, signature="s")
1220
1977
def Rejected(self, reason):
1224
1981
# NeedApproval - signal
1225
1982
@dbus.service.signal(_interface, signature="tb")
1226
1983
def NeedApproval(self, timeout, default):
1228
1985
return self.need_approval()
1230
# NeRwequest - signal
1231
@dbus.service.signal(_interface, signature="s")
1232
def NewRequest(self, ip):
1234
Is sent after a client request a password.
1240
1989
# Approve - method
1241
1990
@dbus.service.method(_interface, in_signature="b")
1242
1991
def Approve(self, value):
1243
1992
self.approve(value)
1245
1994
# CheckedOK - method
1246
1995
@dbus.service.method(_interface)
1247
1996
def CheckedOK(self):
1248
1997
self.checked_ok()
1250
1999
# Enable - method
2000
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1251
2001
@dbus.service.method(_interface)
1252
2002
def Enable(self):
1256
2006
# StartChecker - method
2007
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1257
2008
@dbus.service.method(_interface)
1258
2009
def StartChecker(self):
1260
2011
self.start_checker()
1262
2013
# Disable - method
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1263
2015
@dbus.service.method(_interface)
1264
2016
def Disable(self):
1268
2020
# StopChecker - method
2021
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1269
2022
@dbus.service.method(_interface)
1270
2023
def StopChecker(self):
1271
2024
self.stop_checker()
1275
2028
# ApprovalPending - property
1276
2029
@dbus_service_property(_interface, signature="b", access="read")
1277
2030
def ApprovalPending_dbus_property(self):
1278
2031
return dbus.Boolean(bool(self.approvals_pending))
1280
2033
# ApprovedByDefault - property
1281
@dbus_service_property(_interface, signature="b",
2034
@dbus_service_property(_interface,
1282
2036
access="readwrite")
1283
2037
def ApprovedByDefault_dbus_property(self, value=None):
1284
2038
if value is None: # get
1285
2039
return dbus.Boolean(self.approved_by_default)
1286
2040
self.approved_by_default = bool(value)
1288
2042
# ApprovalDelay - property
1289
@dbus_service_property(_interface, signature="t",
2043
@dbus_service_property(_interface,
1290
2045
access="readwrite")
1291
2046
def ApprovalDelay_dbus_property(self, value=None):
1292
2047
if value is None: # get
1293
return dbus.UInt64(self.approval_delay_milliseconds())
2048
return dbus.UInt64(self.approval_delay.total_seconds()
1294
2050
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1296
2052
# ApprovalDuration - property
1297
@dbus_service_property(_interface, signature="t",
2053
@dbus_service_property(_interface,
1298
2055
access="readwrite")
1299
2056
def ApprovalDuration_dbus_property(self, value=None):
1300
2057
if value is None: # get
1301
return dbus.UInt64(timedelta_to_milliseconds(
1302
self.approval_duration))
2058
return dbus.UInt64(self.approval_duration.total_seconds()
1303
2060
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1305
2062
# Name - property
2064
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1306
2065
@dbus_service_property(_interface, signature="s", access="read")
1307
2066
def Name_dbus_property(self):
1308
2067
return dbus.String(self.name)
2071
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2072
@dbus_service_property(_interface, signature="s", access="read")
2073
def KeyID_dbus_property(self):
2074
return dbus.String(self.key_id)
1310
2076
# Fingerprint - property
2078
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1311
2079
@dbus_service_property(_interface, signature="s", access="read")
1312
2080
def Fingerprint_dbus_property(self):
1313
2081
return dbus.String(self.fingerprint)
1315
2083
# Host - property
1316
@dbus_service_property(_interface, signature="s",
2084
@dbus_service_property(_interface,
1317
2086
access="readwrite")
1318
2087
def Host_dbus_property(self, value=None):
1319
2088
if value is None: # get
1320
2089
return dbus.String(self.host)
1321
self.host = unicode(value)
2090
self.host = str(value)
1323
2092
# Created - property
2094
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1324
2095
@dbus_service_property(_interface, signature="s", access="read")
1325
2096
def Created_dbus_property(self):
1326
2097
return datetime_to_dbus(self.created)
1328
2099
# LastEnabled - property
1329
2100
@dbus_service_property(_interface, signature="s", access="read")
1330
2101
def LastEnabled_dbus_property(self):
1331
2102
return datetime_to_dbus(self.last_enabled)
1333
2104
# Enabled - property
1334
@dbus_service_property(_interface, signature="b",
2105
@dbus_service_property(_interface,
1335
2107
access="readwrite")
1336
2108
def Enabled_dbus_property(self, value=None):
1337
2109
if value is None: # get
1344
2116
# LastCheckedOK - property
1345
@dbus_service_property(_interface, signature="s",
2117
@dbus_service_property(_interface,
1346
2119
access="readwrite")
1347
2120
def LastCheckedOK_dbus_property(self, value=None):
1348
2121
if value is not None:
1349
2122
self.checked_ok()
1351
2124
return datetime_to_dbus(self.last_checked_ok)
2126
# LastCheckerStatus - property
2127
@dbus_service_property(_interface, signature="n", access="read")
2128
def LastCheckerStatus_dbus_property(self):
2129
return dbus.Int16(self.last_checker_status)
1353
2131
# Expires - property
1354
2132
@dbus_service_property(_interface, signature="s", access="read")
1355
2133
def Expires_dbus_property(self):
1356
2134
return datetime_to_dbus(self.expires)
1358
2136
# LastApprovalRequest - property
1359
2137
@dbus_service_property(_interface, signature="s", access="read")
1360
2138
def LastApprovalRequest_dbus_property(self):
1361
2139
return datetime_to_dbus(self.last_approval_request)
1363
2141
# Timeout - property
1364
@dbus_service_property(_interface, signature="t",
2142
@dbus_service_property(_interface,
1365
2144
access="readwrite")
1366
2145
def Timeout_dbus_property(self, value=None):
1367
2146
if value is None: # get
1368
return dbus.UInt64(self.timeout_milliseconds())
2147
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2148
old_timeout = self.timeout
1369
2149
self.timeout = datetime.timedelta(0, 0, 0, value)
1370
# Reschedule timeout
2150
# Reschedule disabling
1371
2151
if self.enabled:
1372
2152
now = datetime.datetime.utcnow()
1373
time_to_die = timedelta_to_milliseconds(
1374
(self.last_checked_ok + self.timeout) - now)
1375
if time_to_die <= 0:
2153
self.expires += self.timeout - old_timeout
2154
if self.expires <= now:
1376
2155
# The timeout has passed
1379
self.expires = (now +
1380
datetime.timedelta(milliseconds =
1382
2158
if (getattr(self, "disable_initiator_tag", None)
1385
gobject.source_remove(self.disable_initiator_tag)
1386
self.disable_initiator_tag = (gobject.timeout_add
2161
GLib.source_remove(self.disable_initiator_tag)
2162
self.disable_initiator_tag = GLib.timeout_add(
2163
int((self.expires - now).total_seconds() * 1000),
1390
2166
# ExtendedTimeout - property
1391
@dbus_service_property(_interface, signature="t",
2167
@dbus_service_property(_interface,
1392
2169
access="readwrite")
1393
2170
def ExtendedTimeout_dbus_property(self, value=None):
1394
2171
if value is None: # get
1395
return dbus.UInt64(self.extended_timeout_milliseconds())
2172
return dbus.UInt64(self.extended_timeout.total_seconds()
1396
2174
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1398
2176
# Interval - property
1399
@dbus_service_property(_interface, signature="t",
2177
@dbus_service_property(_interface,
1400
2179
access="readwrite")
1401
2180
def Interval_dbus_property(self, value=None):
1402
2181
if value is None: # get
1403
return dbus.UInt64(self.interval_milliseconds())
2182
return dbus.UInt64(self.interval.total_seconds() * 1000)
1404
2183
self.interval = datetime.timedelta(0, 0, 0, value)
1405
2184
if getattr(self, "checker_initiator_tag", None) is None:
1407
2186
if self.enabled:
1408
2187
# Reschedule checker run
1409
gobject.source_remove(self.checker_initiator_tag)
1410
self.checker_initiator_tag = (gobject.timeout_add
1411
(value, self.start_checker))
1412
self.start_checker() # Start one now, too
2188
GLib.source_remove(self.checker_initiator_tag)
2189
self.checker_initiator_tag = GLib.timeout_add(
2190
value, self.start_checker)
2191
self.start_checker() # Start one now, too
1414
2193
# Checker - property
1415
@dbus_service_property(_interface, signature="s",
2194
@dbus_service_property(_interface,
1416
2196
access="readwrite")
1417
2197
def Checker_dbus_property(self, value=None):
1418
2198
if value is None: # get
1419
2199
return dbus.String(self.checker_command)
1420
self.checker_command = unicode(value)
2200
self.checker_command = str(value)
1422
2202
# CheckerRunning - property
1423
@dbus_service_property(_interface, signature="b",
2203
@dbus_service_property(_interface,
1424
2205
access="readwrite")
1425
2206
def CheckerRunning_dbus_property(self, value=None):
1426
2207
if value is None: # get
1459
2248
if data[0] == 'data':
1461
2250
if data[0] == 'function':
1462
2252
def func(*args, **kwargs):
1463
2253
self._pipe.send(('funcall', name, args, kwargs))
1464
2254
return self._pipe.recv()[1]
1467
2258
def __setattr__(self, name, value):
1468
2259
if name == '_pipe':
1469
2260
return super(ProxyClient, self).__setattr__(name, value)
1470
2261
self._pipe.send(('setattr', name, value))
1473
class ClientDBusTransitional(ClientDBus):
1474
__metaclass__ = AlternateDBusNamesMetaclass
1477
2264
class ClientHandler(socketserver.BaseRequestHandler, object):
1478
2265
"""A class to handle client connections.
1480
2267
Instantiated once for each connection to handle it.
1481
2268
Note: This will run in its own forked process."""
1483
2270
def handle(self):
1484
2271
with contextlib.closing(self.server.child_pipe) as child_pipe:
1485
2272
logger.info("TCP connection from: %s",
1486
unicode(self.client_address))
2273
str(self.client_address))
1487
2274
logger.debug("Pipe FD: %d",
1488
2275
self.server.child_pipe.fileno())
1490
session = (gnutls.connection
1491
.ClientSession(self.request,
1493
.X509Credentials()))
1495
# Note: gnutls.connection.X509Credentials is really a
1496
# generic GnuTLS certificate credentials object so long as
1497
# no X.509 keys are added to it. Therefore, we can use it
1498
# here despite using OpenPGP certificates.
1500
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1501
# "+AES-256-CBC", "+SHA1",
1502
# "+COMP-NULL", "+CTYPE-OPENPGP",
2277
session = gnutls.ClientSession(self.request)
2279
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2280
# "+AES-256-CBC", "+SHA1",
2281
# "+COMP-NULL", "+CTYPE-OPENPGP",
1504
2283
# Use a fallback default, since this MUST be set.
1505
2284
priority = self.server.gnutls_priority
1506
2285
if priority is None:
1507
2286
priority = "NORMAL"
1508
(gnutls.library.functions
1509
.gnutls_priority_set_direct(session._c_object,
2287
gnutls.priority_set_direct(session._c_object,
2288
priority.encode("utf-8"),
1512
2291
# Start communication using the Mandos protocol
1513
2292
# Get protocol number
1514
2293
line = self.request.makefile().readline()
1515
2294
logger.debug("Protocol version: %r", line)
1517
2296
if int(line.strip().split()[0]) > 1:
2297
raise RuntimeError(line)
1519
2298
except (ValueError, IndexError, RuntimeError) as error:
1520
2299
logger.error("Unknown protocol version: %s", error)
1523
2302
# Start GnuTLS connection
1525
2304
session.handshake()
1526
except gnutls.errors.GNUTLSError as error:
2305
except gnutls.Error as error:
1527
2306
logger.warning("Handshake failed: %s", error)
1528
2307
# Do not run session.bye() here: the session is not
1529
2308
# established. Just abandon the request.
1531
2310
logger.debug("Handshake succeeded")
1533
2312
approval_required = False
1536
fpr = self.fingerprint(self.peer_certificate
1539
gnutls.errors.GNUTLSError) as error:
1540
logger.warning("Bad certificate: %s", error)
1542
logger.debug("Fingerprint: %s", fpr)
1545
client = ProxyClient(child_pipe, fpr,
2314
if gnutls.has_rawpk:
2317
key_id = self.key_id(
2318
self.peer_certificate(session))
2319
except (TypeError, gnutls.Error) as error:
2320
logger.warning("Bad certificate: %s", error)
2322
logger.debug("Key ID: %s", key_id)
2327
fpr = self.fingerprint(
2328
self.peer_certificate(session))
2329
except (TypeError, gnutls.Error) as error:
2330
logger.warning("Bad certificate: %s", error)
2332
logger.debug("Fingerprint: %s", fpr)
2335
client = ProxyClient(child_pipe, key_id, fpr,
1546
2336
self.client_address)
1547
2337
except KeyError:
1550
if self.server.use_dbus:
1552
client.NewRequest(str(self.client_address))
1554
2340
if client.approval_delay:
1555
2341
delay = client.approval_delay
1556
2342
client.approvals_pending += 1
1557
2343
approval_required = True
1560
2346
if not client.enabled:
1561
2347
logger.info("Client %s is disabled",
1563
2349
if self.server.use_dbus:
1564
2350
# Emit D-Bus signal
1565
2351
client.Rejected("Disabled")
1568
2354
if client.approved or not client.approval_delay:
1569
#We are approved or approval is disabled
2355
# We are approved or approval is disabled
1571
2357
elif client.approved is None:
1572
2358
logger.info("Client %s needs approval",
1607
2391
delay -= time2 - time
1610
while sent_size < len(client.secret):
1612
sent = session.send(client.secret[sent_size:])
1613
except gnutls.errors.GNUTLSError as error:
1614
logger.warning("gnutls send failed")
1616
logger.debug("Sent: %d, remaining: %d",
1617
sent, len(client.secret)
1618
- (sent_size + sent))
2394
session.send(client.secret)
2395
except gnutls.Error as error:
2396
logger.warning("gnutls send failed",
1621
2400
logger.info("Sending secret to %s", client.name)
1622
2401
# bump the timeout using extended_timeout
1623
client.checked_ok(client.extended_timeout)
2402
client.bump_timeout(client.extended_timeout)
1624
2403
if self.server.use_dbus:
1625
2404
# Emit D-Bus signal
1626
2405
client.GotSecret()
1629
2408
if approval_required:
1630
2409
client.approvals_pending -= 1
1633
except gnutls.errors.GNUTLSError as error:
1634
logger.warning("GnuTLS bye failed")
2412
except gnutls.Error as error:
2413
logger.warning("GnuTLS bye failed",
1637
2417
def peer_certificate(session):
1638
"Return the peer's OpenPGP certificate as a bytestring"
1639
# If not an OpenPGP certificate...
1640
if (gnutls.library.functions
1641
.gnutls_certificate_type_get(session._c_object)
1642
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1643
# ...do the normal thing
1644
return session.peer_certificate
2418
"Return the peer's certificate as a bytestring"
2420
cert_type = gnutls.certificate_type_get2(session._c_object,
2422
except AttributeError:
2423
cert_type = gnutls.certificate_type_get(session._c_object)
2424
if gnutls.has_rawpk:
2425
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2427
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2428
# If not a valid certificate type...
2429
if cert_type not in valid_cert_types:
2430
logger.info("Cert type %r not in %r", cert_type,
2432
# ...return invalid data
1645
2434
list_size = ctypes.c_uint(1)
1646
cert_list = (gnutls.library.functions
1647
.gnutls_certificate_get_peers
2435
cert_list = (gnutls.certificate_get_peers
1648
2436
(session._c_object, ctypes.byref(list_size)))
1649
2437
if not bool(cert_list) and list_size.value != 0:
1650
raise gnutls.errors.GNUTLSError("error getting peer"
2438
raise gnutls.Error("error getting peer certificate")
1652
2439
if list_size.value == 0:
1654
2441
cert = cert_list[0]
1655
2442
return ctypes.string_at(cert.data, cert.size)
2445
def key_id(certificate):
2446
"Convert a certificate bytestring to a hexdigit key ID"
2447
# New GnuTLS "datum" with the public key
2448
datum = gnutls.datum_t(
2449
ctypes.cast(ctypes.c_char_p(certificate),
2450
ctypes.POINTER(ctypes.c_ubyte)),
2451
ctypes.c_uint(len(certificate)))
2452
# XXX all these need to be created in the gnutls "module"
2453
# New empty GnuTLS certificate
2454
pubkey = gnutls.pubkey_t()
2455
gnutls.pubkey_init(ctypes.byref(pubkey))
2456
# Import the raw public key into the certificate
2457
gnutls.pubkey_import(pubkey,
2458
ctypes.byref(datum),
2459
gnutls.X509_FMT_DER)
2460
# New buffer for the key ID
2461
buf = ctypes.create_string_buffer(32)
2462
buf_len = ctypes.c_size_t(len(buf))
2463
# Get the key ID from the raw public key into the buffer
2464
gnutls.pubkey_get_key_id(pubkey,
2465
gnutls.KEYID_USE_SHA256,
2466
ctypes.cast(ctypes.byref(buf),
2467
ctypes.POINTER(ctypes.c_ubyte)),
2468
ctypes.byref(buf_len))
2469
# Deinit the certificate
2470
gnutls.pubkey_deinit(pubkey)
2472
# Convert the buffer to a Python bytestring
2473
key_id = ctypes.string_at(buf, buf_len.value)
2474
# Convert the bytestring to hexadecimal notation
2475
hex_key_id = binascii.hexlify(key_id).upper()
1658
2479
def fingerprint(openpgp):
1659
2480
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1660
2481
# New GnuTLS "datum" with the OpenPGP public key
1661
datum = (gnutls.library.types
1662
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1665
ctypes.c_uint(len(openpgp))))
2482
datum = gnutls.datum_t(
2483
ctypes.cast(ctypes.c_char_p(openpgp),
2484
ctypes.POINTER(ctypes.c_ubyte)),
2485
ctypes.c_uint(len(openpgp)))
1666
2486
# New empty GnuTLS certificate
1667
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1668
(gnutls.library.functions
1669
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2487
crt = gnutls.openpgp_crt_t()
2488
gnutls.openpgp_crt_init(ctypes.byref(crt))
1670
2489
# Import the OpenPGP public key into the certificate
1671
(gnutls.library.functions
1672
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1673
gnutls.library.constants
1674
.GNUTLS_OPENPGP_FMT_RAW))
2490
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2491
gnutls.OPENPGP_FMT_RAW)
1675
2492
# Verify the self signature in the key
1676
2493
crtverify = ctypes.c_uint()
1677
(gnutls.library.functions
1678
.gnutls_openpgp_crt_verify_self(crt, 0,
1679
ctypes.byref(crtverify)))
2494
gnutls.openpgp_crt_verify_self(crt, 0,
2495
ctypes.byref(crtverify))
1680
2496
if crtverify.value != 0:
1681
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1682
raise (gnutls.errors.CertificateSecurityError
2497
gnutls.openpgp_crt_deinit(crt)
2498
raise gnutls.CertificateSecurityError(code
1684
2500
# New buffer for the fingerprint
1685
2501
buf = ctypes.create_string_buffer(20)
1686
2502
buf_len = ctypes.c_size_t()
1687
2503
# Get the fingerprint from the certificate into the buffer
1688
(gnutls.library.functions
1689
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1690
ctypes.byref(buf_len)))
2504
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2505
ctypes.byref(buf_len))
1691
2506
# Deinit the certificate
1692
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2507
gnutls.openpgp_crt_deinit(crt)
1693
2508
# Convert the buffer to a Python bytestring
1694
2509
fpr = ctypes.string_at(buf, buf_len.value)
1695
2510
# Convert the bytestring to hexadecimal notation
1700
class MultiprocessingMixIn(object):
2515
class MultiprocessingMixIn:
1701
2516
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1702
2518
def sub_process_main(self, request, address):
1704
2520
self.finish_request(request, address)
1705
2521
except Exception:
1706
2522
self.handle_error(request, address)
1707
2523
self.close_request(request)
1709
2525
def process_request(self, request, address):
1710
2526
"""Start a new process to process the request."""
1711
proc = multiprocessing.Process(target = self.sub_process_main,
2527
proc = multiprocessing.Process(target=self.sub_process_main,
2528
args=(request, address))
1718
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2533
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1719
2534
""" adds a pipe to the MixIn """
1720
2536
def process_request(self, request, client_address):
1721
2537
"""Overrides and wraps the original process_request().
1723
2539
This function creates a new pipe in self.pipe
1725
2541
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1727
2543
proc = MultiprocessingMixIn.process_request(self, request,
1728
2544
client_address)
1729
2545
self.child_pipe.close()
1730
2546
self.add_pipe(parent_pipe, proc)
1732
2548
def add_pipe(self, parent_pipe, proc):
1733
2549
"""Dummy function; override as necessary"""
1734
raise NotImplementedError
2550
raise NotImplementedError()
1737
2553
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1738
socketserver.TCPServer, object):
2554
socketserver.TCPServer):
1739
2555
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1742
2558
enabled: Boolean; whether this server is activated yet
1743
2559
interface: None or a network interface name (string)
1744
2560
use_ipv6: Boolean; to use IPv6 or not
1746
2563
def __init__(self, server_address, RequestHandlerClass,
1747
interface=None, use_ipv6=True):
2567
"""If socketfd is set, use that file descriptor instead of
2568
creating a new one with socket.socket().
1748
2570
self.interface = interface
1750
2572
self.address_family = socket.AF_INET6
2573
if socketfd is not None:
2574
# Save the file descriptor
2575
self.socketfd = socketfd
2576
# Save the original socket.socket() function
2577
self.socket_socket = socket.socket
2579
# To implement --socket, we monkey patch socket.socket.
2581
# (When socketserver.TCPServer is a new-style class, we
2582
# could make self.socket into a property instead of monkey
2583
# patching socket.socket.)
2585
# Create a one-time-only replacement for socket.socket()
2586
@functools.wraps(socket.socket)
2587
def socket_wrapper(*args, **kwargs):
2588
# Restore original function so subsequent calls are
2590
socket.socket = self.socket_socket
2591
del self.socket_socket
2592
# This time only, return a new socket object from the
2593
# saved file descriptor.
2594
return socket.fromfd(self.socketfd, *args, **kwargs)
2595
# Replace socket.socket() function with wrapper
2596
socket.socket = socket_wrapper
2597
# The socketserver.TCPServer.__init__ will call
2598
# socket.socket(), which might be our replacement,
2599
# socket_wrapper(), if socketfd was set.
1751
2600
socketserver.TCPServer.__init__(self, server_address,
1752
2601
RequestHandlerClass)
1753
2603
def server_bind(self):
1754
2604
"""This overrides the normal server_bind() function
1755
2605
to bind to an interface if one was specified, and also NOT to
1756
2606
bind to an address or port if they were not specified."""
2607
global SO_BINDTODEVICE
1757
2608
if self.interface is not None:
1758
2609
if SO_BINDTODEVICE is None:
1759
logger.error("SO_BINDTODEVICE does not exist;"
1760
" cannot bind to interface %s",
1764
self.socket.setsockopt(socket.SOL_SOCKET,
1768
except socket.error as error:
1769
if error[0] == errno.EPERM:
1770
logger.error("No permission to"
1771
" bind to interface %s",
1773
elif error[0] == errno.ENOPROTOOPT:
1774
logger.error("SO_BINDTODEVICE not available;"
1775
" cannot bind to interface %s",
2610
# Fall back to a hard-coded value which seems to be
2612
logger.warning("SO_BINDTODEVICE not found, trying 25")
2613
SO_BINDTODEVICE = 25
2615
self.socket.setsockopt(
2616
socket.SOL_SOCKET, SO_BINDTODEVICE,
2617
(self.interface + "\0").encode("utf-8"))
2618
except socket.error as error:
2619
if error.errno == errno.EPERM:
2620
logger.error("No permission to bind to"
2621
" interface %s", self.interface)
2622
elif error.errno == errno.ENOPROTOOPT:
2623
logger.error("SO_BINDTODEVICE not available;"
2624
" cannot bind to interface %s",
2626
elif error.errno == errno.ENODEV:
2627
logger.error("Interface %s does not exist,"
2628
" cannot bind", self.interface)
1779
2631
# Only bind(2) the socket if we really need to.
1780
2632
if self.server_address[0] or self.server_address[1]:
2633
if self.server_address[1]:
2634
self.allow_reuse_address = True
1781
2635
if not self.server_address[0]:
1782
2636
if self.address_family == socket.AF_INET6:
1783
any_address = "::" # in6addr_any
2637
any_address = "::" # in6addr_any
1785
any_address = socket.INADDR_ANY
2639
any_address = "0.0.0.0" # INADDR_ANY
1786
2640
self.server_address = (any_address,
1787
2641
self.server_address[1])
1788
2642
elif not self.server_address[1]:
1789
self.server_address = (self.server_address[0],
2643
self.server_address = (self.server_address[0], 0)
1791
2644
# if self.interface:
1792
2645
# self.server_address = (self.server_address[0],
1818
2676
self.gnutls_priority = gnutls_priority
1819
2677
IPv6_TCPServer.__init__(self, server_address,
1820
2678
RequestHandlerClass,
1821
interface = interface,
1822
use_ipv6 = use_ipv6)
2679
interface=interface,
1823
2683
def server_activate(self):
1824
2684
if self.enabled:
1825
2685
return socketserver.TCPServer.server_activate(self)
1827
2687
def enable(self):
1828
2688
self.enabled = True
1830
2690
def add_pipe(self, parent_pipe, proc):
1831
2691
# Call "handle_ipc" for both data and EOF events
1832
gobject.io_add_watch(parent_pipe.fileno(),
1833
gobject.IO_IN | gobject.IO_HUP,
1834
functools.partial(self.handle_ipc,
1839
def handle_ipc(self, source, condition, parent_pipe=None,
1840
proc = None, client_object=None):
1842
gobject.IO_IN: "IN", # There is data to read.
1843
gobject.IO_OUT: "OUT", # Data can be written (without
1845
gobject.IO_PRI: "PRI", # There is urgent data to read.
1846
gobject.IO_ERR: "ERR", # Error condition.
1847
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1848
# broken, usually for pipes and
1851
conditions_string = ' | '.join(name
1853
condition_names.iteritems()
1854
if cond & condition)
2693
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2694
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2695
functools.partial(self.handle_ipc,
2696
parent_pipe=parent_pipe,
2699
def handle_ipc(self, source, condition,
2702
client_object=None):
1855
2703
# error, or the other end of multiprocessing.Pipe has closed
1856
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2704
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1857
2705
# Wait for other process to exit
1861
2709
# Read a request from the child
1862
2710
request = parent_pipe.recv()
1863
2711
command = request[0]
1865
2713
if command == 'init':
1867
address = request[2]
1869
for c in self.clients.itervalues():
1870
if c.fingerprint == fpr:
2714
key_id = request[1].decode("ascii")
2715
fpr = request[2].decode("ascii")
2716
address = request[3]
2718
for c in self.clients.values():
2719
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2721
if key_id and c.key_id == key_id:
2724
if fpr and c.fingerprint == fpr:
1874
logger.info("Client not found for fingerprint: %s, ad"
1875
"dress: %s", fpr, address)
2728
logger.info("Client not found for key ID: %s, address"
2729
": %s", key_id or fpr, address)
1876
2730
if self.use_dbus:
1877
2731
# Emit D-Bus signal
1878
mandos_dbus_service.ClientNotFound(fpr,
2732
mandos_dbus_service.ClientNotFound(key_id or fpr,
1880
2734
parent_pipe.send(False)
1883
gobject.io_add_watch(parent_pipe.fileno(),
1884
gobject.IO_IN | gobject.IO_HUP,
1885
functools.partial(self.handle_ipc,
2738
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2739
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2740
functools.partial(self.handle_ipc,
2741
parent_pipe=parent_pipe,
2743
client_object=client))
1891
2744
parent_pipe.send(True)
1892
2745
# remove the old hook in favor of the new above hook on
1896
2749
funcname = request[1]
1897
2750
args = request[2]
1898
2751
kwargs = request[3]
1900
2753
parent_pipe.send(('data', getattr(client_object,
1901
2754
funcname)(*args,
1904
2757
if command == 'getattr':
1905
2758
attrname = request[1]
1906
if callable(client_object.__getattribute__(attrname)):
1907
parent_pipe.send(('function',))
2759
if isinstance(client_object.__getattribute__(attrname),
2760
collections.abc.Callable):
2761
parent_pipe.send(('function', ))
1909
parent_pipe.send(('data', client_object
1910
.__getattribute__(attrname)))
2764
'data', client_object.__getattribute__(attrname)))
1912
2766
if command == 'setattr':
1913
2767
attrname = request[1]
1914
2768
value = request[2]
1915
2769
setattr(client_object, attrname, value)
2774
def rfc3339_duration_to_delta(duration):
2775
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2777
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2779
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2781
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2783
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2785
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2787
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2789
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2793
# Parsing an RFC 3339 duration with regular expressions is not
2794
# possible - there would have to be multiple places for the same
2795
# values, like seconds. The current code, while more esoteric, is
2796
# cleaner without depending on a parsing library. If Python had a
2797
# built-in library for parsing we would use it, but we'd like to
2798
# avoid excessive use of external libraries.
2800
# New type for defining tokens, syntax, and semantics all-in-one
2801
Token = collections.namedtuple("Token", (
2802
"regexp", # To match token; if "value" is not None, must have
2803
# a "group" containing digits
2804
"value", # datetime.timedelta or None
2805
"followers")) # Tokens valid after this token
2806
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2807
# the "duration" ABNF definition in RFC 3339, Appendix A.
2808
token_end = Token(re.compile(r"$"), None, frozenset())
2809
token_second = Token(re.compile(r"(\d+)S"),
2810
datetime.timedelta(seconds=1),
2811
frozenset((token_end, )))
2812
token_minute = Token(re.compile(r"(\d+)M"),
2813
datetime.timedelta(minutes=1),
2814
frozenset((token_second, token_end)))
2815
token_hour = Token(re.compile(r"(\d+)H"),
2816
datetime.timedelta(hours=1),
2817
frozenset((token_minute, token_end)))
2818
token_time = Token(re.compile(r"T"),
2820
frozenset((token_hour, token_minute,
2822
token_day = Token(re.compile(r"(\d+)D"),
2823
datetime.timedelta(days=1),
2824
frozenset((token_time, token_end)))
2825
token_month = Token(re.compile(r"(\d+)M"),
2826
datetime.timedelta(weeks=4),
2827
frozenset((token_day, token_end)))
2828
token_year = Token(re.compile(r"(\d+)Y"),
2829
datetime.timedelta(weeks=52),
2830
frozenset((token_month, token_end)))
2831
token_week = Token(re.compile(r"(\d+)W"),
2832
datetime.timedelta(weeks=1),
2833
frozenset((token_end, )))
2834
token_duration = Token(re.compile(r"P"), None,
2835
frozenset((token_year, token_month,
2836
token_day, token_time,
2838
# Define starting values:
2840
value = datetime.timedelta()
2842
# Following valid tokens
2843
followers = frozenset((token_duration, ))
2844
# String left to parse
2846
# Loop until end token is found
2847
while found_token is not token_end:
2848
# Search for any currently valid tokens
2849
for token in followers:
2850
match = token.regexp.match(s)
2851
if match is not None:
2853
if token.value is not None:
2854
# Value found, parse digits
2855
factor = int(match.group(1), 10)
2856
# Add to value so far
2857
value += factor * token.value
2858
# Strip token from string
2859
s = token.regexp.sub("", s, 1)
2862
# Set valid next tokens
2863
followers = found_token.followers
2866
# No currently valid tokens were found
2867
raise ValueError("Invalid RFC 3339 duration: {!r}"
1920
2873
def string_to_delta(interval):
1921
2874
"""Parse a string and return a datetime.timedelta
1923
>>> string_to_delta('7d')
1924
datetime.timedelta(7)
1925
>>> string_to_delta('60s')
1926
datetime.timedelta(0, 60)
1927
>>> string_to_delta('60m')
1928
datetime.timedelta(0, 3600)
1929
>>> string_to_delta('24h')
1930
datetime.timedelta(1)
1931
>>> string_to_delta('1w')
1932
datetime.timedelta(7)
1933
>>> string_to_delta('5m 30s')
1934
datetime.timedelta(0, 330)
2876
>>> string_to_delta('7d') == datetime.timedelta(7)
2878
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2880
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2882
>>> string_to_delta('24h') == datetime.timedelta(1)
2884
>>> string_to_delta('1w') == datetime.timedelta(7)
2886
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2891
return rfc3339_duration_to_delta(interval)
1936
2895
timevalue = datetime.timedelta(0)
1937
2896
for s in interval.split():
1939
suffix = unicode(s[-1])
1940
2899
value = int(s[:-1])
1941
2900
if suffix == "d":
1942
2901
delta = datetime.timedelta(value)
2014
2973
parser.add_argument("--no-dbus", action="store_false",
2015
2974
dest="use_dbus", help="Do not provide D-Bus"
2016
" system bus interface")
2975
" system bus interface", default=None)
2017
2976
parser.add_argument("--no-ipv6", action="store_false",
2018
dest="use_ipv6", help="Do not use IPv6")
2977
dest="use_ipv6", help="Do not use IPv6",
2019
2979
parser.add_argument("--no-restore", action="store_false",
2020
2980
dest="restore", help="Do not restore stored"
2981
" state", default=None)
2982
parser.add_argument("--socket", type=int,
2983
help="Specify a file descriptor to a network"
2984
" socket to use instead of creating one")
2022
2985
parser.add_argument("--statedir", metavar="DIR",
2023
2986
help="Directory to save/restore state in")
2987
parser.add_argument("--foreground", action="store_true",
2988
help="Run in foreground", default=None)
2989
parser.add_argument("--no-zeroconf", action="store_false",
2990
dest="zeroconf", help="Do not use Zeroconf",
2025
2993
options = parser.parse_args()
2032
2995
# Default values for config file for server-global settings
2033
server_defaults = { "interface": "",
2038
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2039
"servicename": "Mandos",
2044
"statedir": "/var/lib/mandos"
2996
if gnutls.has_rawpk:
2997
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2998
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3000
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3001
":+SIGN-DSA-SHA256")
3002
server_defaults = {"interface": "",
3006
"priority": priority,
3007
"servicename": "Mandos",
3013
"statedir": "/var/lib/mandos",
3014
"foreground": "False",
2047
3019
# Parse config file for server-global settings
2048
server_config = configparser.SafeConfigParser(server_defaults)
3020
server_config = configparser.ConfigParser(server_defaults)
2049
3021
del server_defaults
2050
server_config.read(os.path.join(options.configdir,
2052
# Convert the SafeConfigParser object to a dict
3022
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3023
# Convert the ConfigParser object to a dict
2053
3024
server_settings = server_config.defaults()
2054
3025
# Use the appropriate methods on the non-string config options
2055
for option in ("debug", "use_dbus", "use_ipv6"):
3026
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3027
"foreground", "zeroconf"):
2056
3028
server_settings[option] = server_config.getboolean("DEFAULT",
2058
3030
if server_settings["port"]:
2059
3031
server_settings["port"] = server_config.getint("DEFAULT",
3033
if server_settings["socket"]:
3034
server_settings["socket"] = server_config.getint("DEFAULT",
3036
# Later, stdin will, and stdout and stderr might, be dup'ed
3037
# over with an opened os.devnull. But we don't want this to
3038
# happen with a supplied network socket.
3039
if 0 <= server_settings["socket"] <= 2:
3040
server_settings["socket"] = os.dup(server_settings
2061
3042
del server_config
2063
3044
# Override the settings from the config file with command line
2064
3045
# options, if set.
2065
3046
for option in ("interface", "address", "port", "debug",
2066
"priority", "servicename", "configdir",
2067
"use_dbus", "use_ipv6", "debuglevel", "restore",
3047
"priority", "servicename", "configdir", "use_dbus",
3048
"use_ipv6", "debuglevel", "restore", "statedir",
3049
"socket", "foreground", "zeroconf"):
2069
3050
value = getattr(options, option)
2070
3051
if value is not None:
2071
3052
server_settings[option] = value
2073
3054
# Force all strings to be unicode
2074
3055
for option in server_settings.keys():
2075
if type(server_settings[option]) is str:
2076
server_settings[option] = unicode(server_settings[option])
3056
if isinstance(server_settings[option], bytes):
3057
server_settings[option] = (server_settings[option]
3059
# Force all boolean options to be boolean
3060
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3061
"foreground", "zeroconf"):
3062
server_settings[option] = bool(server_settings[option])
3063
# Debug implies foreground
3064
if server_settings["debug"]:
3065
server_settings["foreground"] = True
2077
3066
# Now we have our good server settings in "server_settings"
2079
3068
##################################################################
3070
if (not server_settings["zeroconf"]
3071
and not (server_settings["port"]
3072
or server_settings["socket"] != "")):
3073
parser.error("Needs port or socket to work without Zeroconf")
2081
3075
# For convenience
2082
3076
debug = server_settings["debug"]
2083
3077
debuglevel = server_settings["debuglevel"]
2095
3091
level = getattr(logging, debuglevel.upper())
2096
3092
initlogger(debug, level)
2098
3094
if server_settings["servicename"] != "Mandos":
2099
syslogger.setFormatter(logging.Formatter
2100
('Mandos (%s) [%%(process)d]:'
2101
' %%(levelname)s: %%(message)s'
2102
% server_settings["servicename"]))
3095
syslogger.setFormatter(
3096
logging.Formatter('Mandos ({}) [%(process)d]:'
3097
' %(levelname)s: %(message)s'.format(
3098
server_settings["servicename"])))
2104
3100
# Parse config file with clients
2105
client_config = configparser.SafeConfigParser(Client
3101
client_config = configparser.ConfigParser(Client.client_defaults)
2107
3102
client_config.read(os.path.join(server_settings["configdir"],
2108
3103
"clients.conf"))
2110
3105
global mandos_dbus_service
2111
3106
mandos_dbus_service = None
2113
tcp_server = MandosServer((server_settings["address"],
2114
server_settings["port"]),
2116
interface=(server_settings["interface"]
2120
server_settings["priority"],
2123
pidfilename = "/var/run/mandos.pid"
2125
pidfile = open(pidfilename, "w")
2127
logger.error("Could not open file %r", pidfilename)
2130
uid = pwd.getpwnam("_mandos").pw_uid
2131
gid = pwd.getpwnam("_mandos").pw_gid
2134
uid = pwd.getpwnam("mandos").pw_uid
2135
gid = pwd.getpwnam("mandos").pw_gid
3109
if server_settings["socket"] != "":
3110
socketfd = server_settings["socket"]
3111
tcp_server = MandosServer(
3112
(server_settings["address"], server_settings["port"]),
3114
interface=(server_settings["interface"] or None),
3116
gnutls_priority=server_settings["priority"],
3120
pidfilename = "/run/mandos.pid"
3121
if not os.path.isdir("/run/."):
3122
pidfilename = "/var/run/mandos.pid"
3125
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3126
except IOError as e:
3127
logger.error("Could not open file %r", pidfilename,
3130
for name, group in (("_mandos", "_mandos"),
3131
("mandos", "mandos"),
3132
("nobody", "nogroup")):
3134
uid = pwd.getpwnam(name).pw_uid
3135
gid = pwd.getpwnam(group).pw_gid
2136
3137
except KeyError:
2138
uid = pwd.getpwnam("nobody").pw_uid
2139
gid = pwd.getpwnam("nobody").pw_gid
3146
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2146
3148
except OSError as error:
2147
if error[0] != errno.EPERM:
3149
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3150
.format(uid, gid, os.strerror(error.errno)))
3151
if error.errno != errno.EPERM:
2151
3155
# Enable all possible GnuTLS debugging
2153
3157
# "Use a log level over 10 to enable all debugging options."
2154
3158
# - GnuTLS manual
2155
gnutls.library.functions.gnutls_global_set_log_level(11)
2157
@gnutls.library.types.gnutls_log_func
3159
gnutls.global_set_log_level(11)
2158
3162
def debug_gnutls(level, string):
2159
3163
logger.debug("GnuTLS: %s", string[:-1])
2161
(gnutls.library.functions
2162
.gnutls_global_set_log_function(debug_gnutls))
3165
gnutls.global_set_log_function(debug_gnutls)
2164
3167
# Redirect stdin so all checkers get /dev/null
2165
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3168
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2166
3169
os.dup2(null, sys.stdin.fileno())
2170
3173
# Need to fork before connecting to D-Bus
2172
3175
# Close all input and output, do double fork, etc.
2175
gobject.threads_init()
3178
if gi.version_info < (3, 10, 2):
3179
# multiprocessing will use threads, so before we use GLib we
3180
# need to inform GLib that threads will be used.
2177
3183
global main_loop
2178
3184
# From the Avahi example code
2179
DBusGMainLoop(set_as_default=True )
2180
main_loop = gobject.MainLoop()
3185
DBusGMainLoop(set_as_default=True)
3186
main_loop = GLib.MainLoop()
2181
3187
bus = dbus.SystemBus()
2182
3188
# End of Avahi example code
2185
3191
bus_name = dbus.service.BusName("se.recompile.Mandos",
2186
bus, do_not_queue=True)
2187
old_bus_name = (dbus.service.BusName
2188
("se.bsnet.fukt.Mandos", bus,
2190
except dbus.exceptions.NameExistsException as e:
2191
logger.error(unicode(e) + ", disabling D-Bus")
3194
old_bus_name = dbus.service.BusName(
3195
"se.bsnet.fukt.Mandos", bus,
3197
except dbus.exceptions.DBusException as e:
3198
logger.error("Disabling D-Bus:", exc_info=e)
2192
3199
use_dbus = False
2193
3200
server_settings["use_dbus"] = False
2194
3201
tcp_server.use_dbus = False
2195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2196
service = AvahiServiceToSyslog(name =
2197
server_settings["servicename"],
2198
servicetype = "_mandos._tcp",
2199
protocol = protocol, bus = bus)
2200
if server_settings["interface"]:
2201
service.interface = (if_nametoindex
2202
(str(server_settings["interface"])))
3203
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3204
service = AvahiServiceToSyslog(
3205
name=server_settings["servicename"],
3206
servicetype="_mandos._tcp",
3209
if server_settings["interface"]:
3210
service.interface = if_nametoindex(
3211
server_settings["interface"].encode("utf-8"))
2204
3213
global multiprocessing_manager
2205
3214
multiprocessing_manager = multiprocessing.Manager()
2207
3216
client_class = Client
2209
client_class = functools.partial(ClientDBusTransitional,
3218
client_class = functools.partial(ClientDBus, bus=bus)
2212
3220
client_settings = Client.config_parser(client_config)
2213
3221
old_client_settings = {}
2214
3222
clients_data = {}
3224
# This is used to redirect stdout and stderr for checker processes
3226
wnull = open(os.devnull, "w") # A writable /dev/null
3227
# Only used if server is running in foreground but not in debug
3229
if debug or not foreground:
2216
3232
# Get client data and settings from last running state.
2217
3233
if server_settings["restore"]:
2219
3235
with open(stored_state_path, "rb") as stored_state:
2220
clients_data, old_client_settings = (pickle.load
3236
if sys.version_info.major == 2:
3237
clients_data, old_client_settings = pickle.load(
3240
bytes_clients_data, bytes_old_client_settings = (
3241
pickle.load(stored_state, encoding="bytes"))
3242
# Fix bytes to strings
3245
clients_data = {(key.decode("utf-8")
3246
if isinstance(key, bytes)
3249
bytes_clients_data.items()}
3250
del bytes_clients_data
3251
for key in clients_data:
3252
value = {(k.decode("utf-8")
3253
if isinstance(k, bytes) else k): v
3255
clients_data[key].items()}
3256
clients_data[key] = value
3258
value["client_structure"] = [
3260
if isinstance(s, bytes)
3262
value["client_structure"]]
3263
# .name, .host, and .checker_command
3264
for k in ("name", "host", "checker_command"):
3265
if isinstance(value[k], bytes):
3266
value[k] = value[k].decode("utf-8")
3267
if "key_id" not in value:
3268
value["key_id"] = ""
3269
elif "fingerprint" not in value:
3270
value["fingerprint"] = ""
3271
# old_client_settings
3273
old_client_settings = {
3274
(key.decode("utf-8")
3275
if isinstance(key, bytes)
3278
bytes_old_client_settings.items()}
3279
del bytes_old_client_settings
3280
# .host and .checker_command
3281
for value in old_client_settings.values():
3282
for attribute in ("host", "checker_command"):
3283
if isinstance(value[attribute], bytes):
3284
value[attribute] = (value[attribute]
2222
3286
os.remove(stored_state_path)
2223
3287
except IOError as e:
2224
logger.warning("Could not load persistent state: {0}"
2226
if e.errno != errno.ENOENT:
3288
if e.errno == errno.ENOENT:
3289
logger.warning("Could not load persistent state:"
3290
" {}".format(os.strerror(e.errno)))
3292
logger.critical("Could not load persistent state:",
2228
3295
except EOFError as e:
2229
3296
logger.warning("Could not load persistent state: "
2230
"EOFError: {0}".format(e))
2232
3300
with PGPEngine() as pgp:
2233
for client_name, client in clients_data.iteritems():
3301
for client_name, client in clients_data.items():
3302
# Skip removed clients
3303
if client_name not in client_settings:
2234
3306
# Decide which value to use after restoring saved state.
2235
3307
# We have three different values: Old config file,
2236
3308
# new config file, and saved state.
2295
3367
- set(old_client_settings)):
2296
3368
clients_data[client_name] = client_settings[client_name]
2298
# Create clients all clients
2299
for client_name, client in clients_data.iteritems():
3370
# Create all client objects
3371
for client_name, client in clients_data.items():
2300
3372
tcp_server.clients[client_name] = client_class(
2301
name = client_name, settings = client)
3375
server_settings=server_settings)
2303
3377
if not tcp_server.clients:
2304
3378
logger.warning("No clients defined")
2310
pidfile.write(str(pid) + "\n".encode("utf-8"))
2313
logger.error("Could not write to file %r with PID %d",
2316
# "pidfile" was never created
3381
if pidfile is not None:
3385
print(pid, file=pidfile)
3387
logger.error("Could not write to file %r with PID %d",
2318
3390
del pidfilename
2319
signal.signal(signal.SIGINT, signal.SIG_IGN)
2321
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2322
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3392
for termsig in (signal.SIGHUP, signal.SIGTERM):
3393
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3394
lambda: main_loop.quit() and False)
2325
class MandosDBusService(dbus.service.Object):
3398
@alternate_dbus_interfaces(
3399
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3400
class MandosDBusService(DBusObjectWithObjectManager):
2326
3401
"""A D-Bus proxy object"""
2327
3403
def __init__(self):
2328
3404
dbus.service.Object.__init__(self, bus, "/")
2329
3406
_interface = "se.recompile.Mandos"
2331
3408
@dbus.service.signal(_interface, signature="o")
2332
3409
def ClientAdded(self, objpath):
2336
3413
@dbus.service.signal(_interface, signature="ss")
2337
def ClientNotFound(self, fingerprint, address):
3414
def ClientNotFound(self, key_id, address):
3418
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2341
3420
@dbus.service.signal(_interface, signature="os")
2342
3421
def ClientRemoved(self, objpath, name):
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2346
3427
@dbus.service.method(_interface, out_signature="ao")
2347
3428
def GetAllClients(self):
2349
return dbus.Array(c.dbus_object_path
2351
tcp_server.clients.itervalues())
3430
return dbus.Array(c.dbus_object_path for c in
3431
tcp_server.clients.values())
3433
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2353
3435
@dbus.service.method(_interface,
2354
3436
out_signature="a{oa{sv}}")
2355
3437
def GetAllClientsWithProperties(self):
2357
3439
return dbus.Dictionary(
2358
((c.dbus_object_path, c.GetAll(""))
2359
for c in tcp_server.clients.itervalues()),
3440
{c.dbus_object_path: c.GetAll(
3441
"se.recompile.Mandos.Client")
3442
for c in tcp_server.clients.values()},
2360
3443
signature="oa{sv}")
2362
3445
@dbus.service.method(_interface, in_signature="o")
2363
3446
def RemoveClient(self, object_path):
2365
for c in tcp_server.clients.itervalues():
3448
for c in tcp_server.clients.values():
2366
3449
if c.dbus_object_path == object_path:
2367
3450
del tcp_server.clients[c.name]
2368
3451
c.remove_from_connection()
2369
# Don't signal anything except ClientRemoved
3452
# Don't signal the disabling
2370
3453
c.disable(quiet=True)
2372
self.ClientRemoved(object_path, c.name)
3454
# Emit D-Bus signal for removal
3455
self.client_removed_signal(c)
2374
3457
raise KeyError(object_path)
2378
class MandosDBusServiceTransitional(MandosDBusService):
2379
__metaclass__ = AlternateDBusNamesMetaclass
2380
mandos_dbus_service = MandosDBusServiceTransitional()
3461
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3462
out_signature="a{oa{sa{sv}}}")
3463
def GetManagedObjects(self):
3465
return dbus.Dictionary(
3466
{client.dbus_object_path:
3468
{interface: client.GetAll(interface)
3470
client._get_all_interface_names()})
3471
for client in tcp_server.clients.values()})
3473
def client_added_signal(self, client):
3474
"""Send the new standard signal and the old signal"""
3476
# New standard signal
3477
self.InterfacesAdded(
3478
client.dbus_object_path,
3480
{interface: client.GetAll(interface)
3482
client._get_all_interface_names()}))
3484
self.ClientAdded(client.dbus_object_path)
3486
def client_removed_signal(self, client):
3487
"""Send the new standard signal and the old signal"""
3489
# New standard signal
3490
self.InterfacesRemoved(
3491
client.dbus_object_path,
3492
client._get_all_interface_names())
3494
self.ClientRemoved(client.dbus_object_path,
3497
mandos_dbus_service = MandosDBusService()
3499
# Save modules to variables to exempt the modules from being
3500
# unloaded before the function registered with atexit() is run.
3501
mp = multiprocessing
2383
3505
"Cleanup function; run on exit"
2386
multiprocessing.active_children()
3509
mp.active_children()
2387
3511
if not (tcp_server.clients or client_settings):
2390
3514
# Store client before exiting. Secrets are encrypted with key
2391
3515
# based on what config file has. If config file is
2392
3516
# removed/edited, old secret will thus be unrecovable.
2394
3518
with PGPEngine() as pgp:
2395
for client in tcp_server.clients.itervalues():
3519
for client in tcp_server.clients.values():
2396
3520
key = client_settings[client.name]["secret"]
2397
3521
client.encrypted_secret = pgp.encrypt(client.secret,
2399
3523
client_dict = {}
2401
3525
# A list of attributes that can not be pickled
2403
exclude = set(("bus", "changedstate", "secret",
2405
for name, typ in (inspect.getmembers
2406
(dbus.service.Object)):
3527
exclude = {"bus", "changedstate", "secret",
3528
"checker", "server_settings"}
3529
for name, typ in inspect.getmembers(dbus.service
2407
3531
exclude.add(name)
2409
3533
client_dict["encrypted_secret"] = (client
2410
3534
.encrypted_secret)
2411
3535
for attr in client.client_structure:
2412
3536
if attr not in exclude:
2413
3537
client_dict[attr] = getattr(client, attr)
2415
3539
clients[client.name] = client_dict
2416
3540
del client_settings[client.name]["secret"]
2419
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2422
(stored_state_path))
2423
with os.fdopen(tempfd, "wb") as stored_state:
2424
pickle.dump((clients, client_settings), stored_state)
3543
with tempfile.NamedTemporaryFile(
3547
dir=os.path.dirname(stored_state_path),
3548
delete=False) as stored_state:
3549
pickle.dump((clients, client_settings), stored_state,
3551
tempname = stored_state.name
2425
3552
os.rename(tempname, stored_state_path)
2426
3553
except (IOError, OSError) as e:
2427
logger.warning("Could not save persistent state: {0}"
2431
3556
os.remove(tempname)
2432
3557
except NameError:
2434
if e.errno not in set((errno.ENOENT, errno.EACCES,
3559
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3560
logger.warning("Could not save persistent state: {}"
3561
.format(os.strerror(e.errno)))
3563
logger.warning("Could not save persistent state:",
2438
3567
# Delete all clients, and settings from config
2439
3568
while tcp_server.clients:
2440
3569
name, client = tcp_server.clients.popitem()
2442
3571
client.remove_from_connection()
2443
# Don't signal anything except ClientRemoved
3572
# Don't signal the disabling
2444
3573
client.disable(quiet=True)
3574
# Emit D-Bus signal for removal
2447
mandos_dbus_service.ClientRemoved(client
3576
mandos_dbus_service.client_removed_signal(client)
2450
3577
client_settings.clear()
2452
3579
atexit.register(cleanup)
2454
for client in tcp_server.clients.itervalues():
3581
for client in tcp_server.clients.values():
2457
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3583
# Emit D-Bus signal for adding
3584
mandos_dbus_service.client_added_signal(client)
2458
3585
# Need to initiate checking of clients
2459
3586
if client.enabled:
2460
3587
client.init_checker()
2462
3589
tcp_server.enable()
2463
3590
tcp_server.server_activate()
2465
3592
# Find out what port we got
2466
service.port = tcp_server.socket.getsockname()[1]
3594
service.port = tcp_server.socket.getsockname()[1]
2468
3596
logger.info("Now listening on address %r, port %d,"
2469
" flowinfo %d, scope_id %d"
2470
% tcp_server.socket.getsockname())
3597
" flowinfo %d, scope_id %d",
3598
*tcp_server.socket.getsockname())
2472
logger.info("Now listening on address %r, port %d"
2473
% tcp_server.socket.getsockname())
2475
#service.interface = tcp_server.socket.getsockname()[3]
3600
logger.info("Now listening on address %r, port %d",
3601
*tcp_server.socket.getsockname())
3603
# service.interface = tcp_server.socket.getsockname()[3]
2478
# From the Avahi example code
2481
except dbus.exceptions.DBusException as error:
2482
logger.critical("DBusException: %s", error)
2485
# End of Avahi example code
2487
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2488
lambda *args, **kwargs:
2489
(tcp_server.handle_request
2490
(*args[2:], **kwargs) or True))
3607
# From the Avahi example code
3610
except dbus.exceptions.DBusException as error:
3611
logger.critical("D-Bus Exception", exc_info=error)
3614
# End of Avahi example code
3617
GLib.IOChannel.unix_new(tcp_server.fileno()),
3618
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3619
lambda *args, **kwargs: (tcp_server.handle_request
3620
(*args[2:], **kwargs) or True))
2492
3622
logger.debug("Starting main loop")
2493
3623
main_loop.run()
2494
3624
except AvahiError as error:
2495
logger.critical("AvahiError: %s", error)
3625
logger.critical("Avahi Error", exc_info=error)
2498
3628
except KeyboardInterrupt: