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