63
import cPickle as pickle
70
import cPickle as pickle
64
73
import multiprocessing
71
82
import dbus.service
84
from gi.repository import GLib
74
85
from dbus.mainloop.glib import DBusGMainLoop
77
88
import xml.dom.minidom
91
# Try to find the value of SO_BINDTODEVICE:
93
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
94
# newer, and it is also the most natural place for it:
82
95
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
83
96
except AttributeError:
98
# This is where SO_BINDTODEVICE was up to and including Python
85
100
from IN import SO_BINDTODEVICE
86
101
except ImportError:
87
SO_BINDTODEVICE = None
102
# In Python 2.7 it seems to have been removed entirely.
103
# Try running the C preprocessor:
105
cc = subprocess.Popen(["cc", "--language=c", "-E",
107
stdin=subprocess.PIPE,
108
stdout=subprocess.PIPE)
109
stdout = cc.communicate(
110
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
111
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
112
except (OSError, ValueError, IndexError):
114
SO_BINDTODEVICE = None
116
if sys.version_info.major == 2:
119
if sys.version_info < (3, 2):
120
configparser.Configparser = configparser.SafeConfigParser
90
123
stored_state_file = "clients.pickle"
92
125
logger = logging.getLogger()
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
129
if_nametoindex = ctypes.cdll.LoadLibrary(
130
ctypes.util.find_library("c")).if_nametoindex
101
131
except (OSError, AttributeError):
102
133
def if_nametoindex(interface):
103
134
"Get an interface index the hard way, i.e. using fcntl()"
104
135
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
136
with contextlib.closing(socket.socket()) as s:
106
137
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
109
interface_index = struct.unpack(str("I"),
138
struct.pack(b"16s16x", interface))
139
interface_index = struct.unpack("I", ifreq[16:20])[0]
111
140
return interface_index
143
def copy_function(func):
144
"""Make a copy of a function"""
145
if sys.version_info.major == 2:
146
return types.FunctionType(func.func_code,
152
return types.FunctionType(func.__code__,
114
159
def initlogger(debug, level=logging.WARNING):
115
160
"""init logger and add loglevel"""
163
syslogger = (logging.handlers.SysLogHandler(
164
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
117
166
syslogger.setFormatter(logging.Formatter
118
167
('Mandos [%(process)d]: %(levelname)s:'
120
169
logger.addHandler(syslogger)
123
172
console = logging.StreamHandler()
124
173
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
169
230
os.rmdir(self.tempdir)
170
231
self.tempdir = None
172
233
def password_encode(self, password):
173
234
# Passphrase can not be empty and can not contain newlines or
174
235
# NUL bytes. So we prefix it and hex encode it.
175
return b"mandos" + binascii.hexlify(password)
236
encoded = b"mandos" + binascii.hexlify(password)
237
if len(encoded) > 2048:
238
# GnuPG can't handle long passwords, so encode differently
239
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
240
.replace(b"\n", b"\\n")
241
.replace(b"\0", b"\\x00"))
177
244
def encrypt(self, data, password):
178
self.gnupg.passphrase = self.password_encode(password)
179
with open(os.devnull, "w") as devnull:
181
proc = self.gnupg.run(['--symmetric'],
182
create_fhs=['stdin', 'stdout'],
183
attach_fhs={'stderr': devnull})
184
with contextlib.closing(proc.handles['stdin']) as f:
186
with contextlib.closing(proc.handles['stdout']) as f:
187
ciphertext = f.read()
191
self.gnupg.passphrase = None
245
passphrase = self.password_encode(password)
246
with tempfile.NamedTemporaryFile(
247
dir=self.tempdir) as passfile:
248
passfile.write(passphrase)
250
proc = subprocess.Popen([self.gpg, '--symmetric',
254
stdin=subprocess.PIPE,
255
stdout=subprocess.PIPE,
256
stderr=subprocess.PIPE)
257
ciphertext, err = proc.communicate(input=data)
258
if proc.returncode != 0:
192
260
return ciphertext
194
262
def decrypt(self, data, password):
195
self.gnupg.passphrase = self.password_encode(password)
196
with open(os.devnull, "w") as devnull:
198
proc = self.gnupg.run(['--decrypt'],
199
create_fhs=['stdin', 'stdout'],
200
attach_fhs={'stderr': devnull})
201
with contextlib.closing(proc.handles['stdin']) as f:
203
with contextlib.closing(proc.handles['stdout']) as f:
204
decrypted_plaintext = f.read()
208
self.gnupg.passphrase = None
263
passphrase = self.password_encode(password)
264
with tempfile.NamedTemporaryFile(
265
dir=self.tempdir) as passfile:
266
passfile.write(passphrase)
268
proc = subprocess.Popen([self.gpg, '--decrypt',
272
stdin=subprocess.PIPE,
273
stdout=subprocess.PIPE,
274
stderr=subprocess.PIPE)
275
decrypted_plaintext, err = proc.communicate(input=data)
276
if proc.returncode != 0:
209
278
return decrypted_plaintext
281
# Pretend that we have an Avahi module
283
"""This isn't so much a class as it is a module-like namespace."""
284
IF_UNSPEC = -1 # avahi-common/address.h
285
PROTO_UNSPEC = -1 # avahi-common/address.h
286
PROTO_INET = 0 # avahi-common/address.h
287
PROTO_INET6 = 1 # avahi-common/address.h
288
DBUS_NAME = "org.freedesktop.Avahi"
289
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
290
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
291
DBUS_PATH_SERVER = "/"
294
def string_array_to_txt_array(t):
295
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
296
for s in t), signature="ay")
297
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
298
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
299
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
300
SERVER_INVALID = 0 # avahi-common/defs.h
301
SERVER_REGISTERING = 1 # avahi-common/defs.h
302
SERVER_RUNNING = 2 # avahi-common/defs.h
303
SERVER_COLLISION = 3 # avahi-common/defs.h
304
SERVER_FAILURE = 4 # avahi-common/defs.h
212
307
class AvahiError(Exception):
213
308
def __init__(self, value, *args, **kwargs):
214
309
self.value = value
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
310
return super(AvahiError, self).__init__(value, *args,
219
314
class AvahiServiceError(AvahiError):
222
318
class AvahiGroupError(AvahiError):
226
322
class AvahiService(object):
227
323
"""An Avahi (Zeroconf) service.
230
326
interface: integer; avahi.IF_UNSPEC or an interface index.
231
327
Used to optionally bind to the specified interface.
232
328
name: string; Example: 'Mandos'
233
329
type: string; Example: '_mandos._tcp'.
234
See <http://www.dns-sd.org/ServiceTypes.html>
330
See <https://www.iana.org/assignments/service-names-port-numbers>
235
331
port: integer; what port to announce
236
332
TXT: list of strings; TXT record for the service
237
333
domain: string; Domain to publish on, default to .local if empty.
374
492
follow_name_owner_changes=True),
375
493
avahi.DBUS_INTERFACE_SERVER)
376
494
self.server.connect_to_signal("StateChanged",
377
self.server_state_changed)
495
self.server_state_changed)
378
496
self.server_state_changed(self.server.GetState())
380
499
class AvahiServiceToSyslog(AvahiService):
500
def rename(self, *args, **kwargs):
382
501
"""Add the new name to the syslog messages"""
383
ret = AvahiService.rename(self)
384
syslogger.setFormatter(logging.Formatter
385
('Mandos ({0}) [%(process)d]:'
386
' %(levelname)s: %(message)s'
502
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
503
syslogger.setFormatter(logging.Formatter(
504
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
390
def timedelta_to_milliseconds(td):
391
"Convert a datetime.timedelta() to milliseconds"
392
return ((td.days * 24 * 60 * 60 * 1000)
393
+ (td.seconds * 1000)
394
+ (td.microseconds // 1000))
509
# Pretend that we have a GnuTLS module
510
class gnutls(object):
511
"""This isn't so much a class as it is a module-like namespace."""
513
library = ctypes.util.find_library("gnutls")
515
library = ctypes.util.find_library("gnutls-deb0")
516
_library = ctypes.cdll.LoadLibrary(library)
519
# Unless otherwise indicated, the constants and types below are
520
# all from the gnutls/gnutls.h C header file.
531
E_NO_CERTIFICATE_FOUND = -49
536
KEYID_USE_SHA256 = 1 # gnutls/x509.h
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
540
class session_int(ctypes.Structure):
542
session_t = ctypes.POINTER(session_int)
544
class certificate_credentials_st(ctypes.Structure):
546
certificate_credentials_t = ctypes.POINTER(
547
certificate_credentials_st)
548
certificate_type_t = ctypes.c_int
550
class datum_t(ctypes.Structure):
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
('size', ctypes.c_uint)]
554
class openpgp_crt_int(ctypes.Structure):
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
credentials_type_t = ctypes.c_int
560
transport_ptr_t = ctypes.c_void_p
561
close_request_t = ctypes.c_int
564
class Error(Exception):
565
def __init__(self, message=None, code=None, args=()):
566
# Default usage is by a message string, but if a return
567
# code is passed, convert it to a string with
570
if message is None and code is not None:
571
message = gnutls.strerror(code)
572
return super(gnutls.Error, self).__init__(
575
class CertificateSecurityError(Error):
579
class Credentials(object):
581
self._c_object = gnutls.certificate_credentials_t()
582
gnutls.certificate_allocate_credentials(
583
ctypes.byref(self._c_object))
584
self.type = gnutls.CRD_CERTIFICATE
587
gnutls.certificate_free_credentials(self._c_object)
589
class ClientSession(object):
590
def __init__(self, socket, credentials=None):
591
self._c_object = gnutls.session_t()
592
gnutls_flags = gnutls.CLIENT
593
if gnutls.check_version(b"3.5.6"):
594
gnutls_flags |= gnutls.NO_TICKETS
596
gnutls_flags |= gnutls.ENABLE_RAWPK
597
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
599
gnutls.set_default_priority(self._c_object)
600
gnutls.transport_set_ptr(self._c_object, socket.fileno())
601
gnutls.handshake_set_private_extensions(self._c_object,
604
if credentials is None:
605
credentials = gnutls.Credentials()
606
gnutls.credentials_set(self._c_object, credentials.type,
607
ctypes.cast(credentials._c_object,
609
self.credentials = credentials
612
gnutls.deinit(self._c_object)
615
return gnutls.handshake(self._c_object)
617
def send(self, data):
621
data_len -= gnutls.record_send(self._c_object,
626
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
628
# Error handling functions
629
def _error_code(result):
630
"""A function to raise exceptions on errors, suitable
631
for the 'restype' attribute on ctypes functions"""
634
if result == gnutls.E_NO_CERTIFICATE_FOUND:
635
raise gnutls.CertificateSecurityError(code=result)
636
raise gnutls.Error(code=result)
638
def _retry_on_error(result, func, arguments):
639
"""A function to retry on some errors, suitable
640
for the 'errcheck' attribute on ctypes functions"""
642
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
643
return _error_code(result)
644
result = func(*arguments)
647
# Unless otherwise indicated, the function declarations below are
648
# all from the gnutls/gnutls.h C header file.
651
priority_set_direct = _library.gnutls_priority_set_direct
652
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
653
ctypes.POINTER(ctypes.c_char_p)]
654
priority_set_direct.restype = _error_code
656
init = _library.gnutls_init
657
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
658
init.restype = _error_code
660
set_default_priority = _library.gnutls_set_default_priority
661
set_default_priority.argtypes = [session_t]
662
set_default_priority.restype = _error_code
664
record_send = _library.gnutls_record_send
665
record_send.argtypes = [session_t, ctypes.c_void_p,
667
record_send.restype = ctypes.c_ssize_t
668
record_send.errcheck = _retry_on_error
670
certificate_allocate_credentials = (
671
_library.gnutls_certificate_allocate_credentials)
672
certificate_allocate_credentials.argtypes = [
673
ctypes.POINTER(certificate_credentials_t)]
674
certificate_allocate_credentials.restype = _error_code
676
certificate_free_credentials = (
677
_library.gnutls_certificate_free_credentials)
678
certificate_free_credentials.argtypes = [
679
certificate_credentials_t]
680
certificate_free_credentials.restype = None
682
handshake_set_private_extensions = (
683
_library.gnutls_handshake_set_private_extensions)
684
handshake_set_private_extensions.argtypes = [session_t,
686
handshake_set_private_extensions.restype = None
688
credentials_set = _library.gnutls_credentials_set
689
credentials_set.argtypes = [session_t, credentials_type_t,
691
credentials_set.restype = _error_code
693
strerror = _library.gnutls_strerror
694
strerror.argtypes = [ctypes.c_int]
695
strerror.restype = ctypes.c_char_p
697
certificate_type_get = _library.gnutls_certificate_type_get
698
certificate_type_get.argtypes = [session_t]
699
certificate_type_get.restype = _error_code
701
certificate_get_peers = _library.gnutls_certificate_get_peers
702
certificate_get_peers.argtypes = [session_t,
703
ctypes.POINTER(ctypes.c_uint)]
704
certificate_get_peers.restype = ctypes.POINTER(datum_t)
706
global_set_log_level = _library.gnutls_global_set_log_level
707
global_set_log_level.argtypes = [ctypes.c_int]
708
global_set_log_level.restype = None
710
global_set_log_function = _library.gnutls_global_set_log_function
711
global_set_log_function.argtypes = [log_func]
712
global_set_log_function.restype = None
714
deinit = _library.gnutls_deinit
715
deinit.argtypes = [session_t]
716
deinit.restype = None
718
handshake = _library.gnutls_handshake
719
handshake.argtypes = [session_t]
720
handshake.restype = _error_code
721
handshake.errcheck = _retry_on_error
723
transport_set_ptr = _library.gnutls_transport_set_ptr
724
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
725
transport_set_ptr.restype = None
727
bye = _library.gnutls_bye
728
bye.argtypes = [session_t, close_request_t]
729
bye.restype = _error_code
730
bye.errcheck = _retry_on_error
732
check_version = _library.gnutls_check_version
733
check_version.argtypes = [ctypes.c_char_p]
734
check_version.restype = ctypes.c_char_p
736
_need_version = b"3.3.0"
737
if check_version(_need_version) is None:
738
raise self.Error("Needs GnuTLS {} or later"
739
.format(_need_version))
741
_tls_rawpk_version = b"3.6.6"
742
has_rawpk = bool(check_version(_tls_rawpk_version))
746
class pubkey_st(ctypes.Structure):
748
pubkey_t = ctypes.POINTER(pubkey_st)
750
x509_crt_fmt_t = ctypes.c_int
752
# All the function declarations below are from gnutls/abstract.h
753
pubkey_init = _library.gnutls_pubkey_init
754
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
755
pubkey_init.restype = _error_code
757
pubkey_import = _library.gnutls_pubkey_import
758
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
760
pubkey_import.restype = _error_code
762
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
763
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
764
ctypes.POINTER(ctypes.c_ubyte),
765
ctypes.POINTER(ctypes.c_size_t)]
766
pubkey_get_key_id.restype = _error_code
768
pubkey_deinit = _library.gnutls_pubkey_deinit
769
pubkey_deinit.argtypes = [pubkey_t]
770
pubkey_deinit.restype = None
772
# All the function declarations below are from gnutls/openpgp.h
774
openpgp_crt_init = _library.gnutls_openpgp_crt_init
775
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
776
openpgp_crt_init.restype = _error_code
778
openpgp_crt_import = _library.gnutls_openpgp_crt_import
779
openpgp_crt_import.argtypes = [openpgp_crt_t,
780
ctypes.POINTER(datum_t),
782
openpgp_crt_import.restype = _error_code
784
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
785
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
786
ctypes.POINTER(ctypes.c_uint)]
787
openpgp_crt_verify_self.restype = _error_code
789
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
790
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
791
openpgp_crt_deinit.restype = None
793
openpgp_crt_get_fingerprint = (
794
_library.gnutls_openpgp_crt_get_fingerprint)
795
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
799
openpgp_crt_get_fingerprint.restype = _error_code
801
if check_version(b"3.6.4"):
802
certificate_type_get2 = _library.gnutls_certificate_type_get2
803
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
804
certificate_type_get2.restype = _error_code
806
# Remove non-public functions
807
del _error_code, _retry_on_error
810
def call_pipe(connection, # : multiprocessing.Connection
811
func, *args, **kwargs):
812
"""This function is meant to be called by multiprocessing.Process
814
This function runs func(*args, **kwargs), and writes the resulting
815
return value on the provided multiprocessing.Connection.
817
connection.send(func(*args, **kwargs))
396
821
class Client(object):
397
822
"""A representation of a client host served by this server.
400
825
approved: bool(); 'None' if not yet approved/disapproved
401
826
approval_delay: datetime.timedelta(); Time to wait for approval
402
827
approval_duration: datetime.timedelta(); Duration of one approval
403
checker: subprocess.Popen(); a running checker process used
404
to see if the client lives.
405
'None' if no process is running.
406
checker_callback_tag: a gobject event source tag, or None
828
checker: multiprocessing.Process(); a running checker process used
829
to see if the client lives. 'None' if no process is
831
checker_callback_tag: a GLib event source tag, or None
407
832
checker_command: string; External command which is run to check
408
833
if client lives. %() expansions are done at
409
834
runtime with vars(self) as dict, so that for
410
835
instance %(name)s can be used in the command.
411
checker_initiator_tag: a gobject event source tag, or None
836
checker_initiator_tag: a GLib event source tag, or None
412
837
created: datetime.datetime(); (UTC) object creation
413
838
client_structure: Object describing what attributes a client has
414
839
and is used for storing the client at exit
415
840
current_checker_command: string; current running checker_command
416
disable_initiator_tag: a gobject event source tag, or None
841
disable_initiator_tag: a GLib event source tag, or None
418
843
fingerprint: string (40 or 32 hexadecimal digits); used to
419
uniquely identify the client
844
uniquely identify an OpenPGP client
845
key_id: string (64 hexadecimal digits); used to uniquely identify
846
a client using raw public keys
420
847
host: string; available for use by the checker command
421
848
interval: datetime.timedelta(); How often to start a new checker
422
849
last_approval_request: datetime.datetime(); (UTC) or None
545
970
self.current_checker_command = None
546
971
self.approved = None
547
972
self.approvals_pending = 0
548
self.changedstate = (multiprocessing_manager
549
.Condition(multiprocessing_manager
551
self.client_structure = [attr for attr in
552
self.__dict__.iterkeys()
973
self.changedstate = multiprocessing_manager.Condition(
974
multiprocessing_manager.Lock())
975
self.client_structure = [attr
976
for attr in self.__dict__.keys()
553
977
if not attr.startswith("_")]
554
978
self.client_structure.append("client_structure")
556
for name, t in inspect.getmembers(type(self),
980
for name, t in inspect.getmembers(
981
type(self), lambda obj: isinstance(obj, property)):
560
982
if not name.startswith("_"):
561
983
self.client_structure.append(name)
563
985
# Send notice to process children that client state has changed
564
986
def send_changedstate(self):
565
987
with self.changedstate:
566
988
self.changedstate.notify_all()
568
990
def enable(self):
569
991
"""Start this client's checker and timeout hooks"""
570
992
if getattr(self, "enabled", False):
571
993
# Already enabled
573
self.send_changedstate()
574
995
self.expires = datetime.datetime.utcnow() + self.timeout
575
996
self.enabled = True
576
997
self.last_enabled = datetime.datetime.utcnow()
577
998
self.init_checker()
999
self.send_changedstate()
579
1001
def disable(self, quiet=True):
580
1002
"""Disable this client."""
581
1003
if not getattr(self, "enabled", False):
584
self.send_changedstate()
586
1006
logger.info("Disabling client %s", self.name)
587
if getattr(self, "disable_initiator_tag", False):
588
gobject.source_remove(self.disable_initiator_tag)
1007
if getattr(self, "disable_initiator_tag", None) is not None:
1008
GLib.source_remove(self.disable_initiator_tag)
589
1009
self.disable_initiator_tag = None
590
1010
self.expires = None
591
if getattr(self, "checker_initiator_tag", False):
592
gobject.source_remove(self.checker_initiator_tag)
1011
if getattr(self, "checker_initiator_tag", None) is not None:
1012
GLib.source_remove(self.checker_initiator_tag)
593
1013
self.checker_initiator_tag = None
594
1014
self.stop_checker()
595
1015
self.enabled = False
596
# Do not run this again if called by a gobject.timeout_add
1017
self.send_changedstate()
1018
# Do not run this again if called by a GLib.timeout_add
599
1021
def __del__(self):
602
1024
def init_checker(self):
603
1025
# Schedule a new checker to be started an 'interval' from now,
604
1026
# and every interval from then on.
605
self.checker_initiator_tag = (gobject.timeout_add
606
(self.interval_milliseconds(),
1027
if self.checker_initiator_tag is not None:
1028
GLib.source_remove(self.checker_initiator_tag)
1029
self.checker_initiator_tag = GLib.timeout_add(
1030
int(self.interval.total_seconds() * 1000),
608
1032
# Schedule a disable() when 'timeout' has passed
609
self.disable_initiator_tag = (gobject.timeout_add
610
(self.timeout_milliseconds(),
1033
if self.disable_initiator_tag is not None:
1034
GLib.source_remove(self.disable_initiator_tag)
1035
self.disable_initiator_tag = GLib.timeout_add(
1036
int(self.timeout.total_seconds() * 1000), self.disable)
612
1037
# Also start a new checker *right now*.
613
1038
self.start_checker()
615
def checker_callback(self, pid, condition, command):
1040
def checker_callback(self, source, condition, connection,
616
1042
"""The checker has completed, so take appropriate actions."""
1043
# Read return code from connection (see call_pipe)
1044
returncode = connection.recv()
617
1047
self.checker_callback_tag = None
618
1048
self.checker = None
619
if os.WIFEXITED(condition):
620
self.last_checker_status = os.WEXITSTATUS(condition)
1051
self.last_checker_status = returncode
1052
self.last_checker_signal = None
621
1053
if self.last_checker_status == 0:
622
1054
logger.info("Checker for %(name)s succeeded",
624
1056
self.checked_ok()
626
logger.info("Checker for %(name)s failed",
1058
logger.info("Checker for %(name)s failed", vars(self))
629
1060
self.last_checker_status = -1
1061
self.last_checker_signal = -returncode
630
1062
logger.warning("Checker for %(name)s crashed?",
633
1066
def checked_ok(self):
634
1067
"""Assert that the client has been seen, alive and well."""
635
1068
self.last_checked_ok = datetime.datetime.utcnow()
636
1069
self.last_checker_status = 0
1070
self.last_checker_signal = None
637
1071
self.bump_timeout()
639
1073
def bump_timeout(self, timeout=None):
640
1074
"""Bump up the timeout for this client."""
641
1075
if timeout is None:
642
1076
timeout = self.timeout
643
1077
if self.disable_initiator_tag is not None:
644
gobject.source_remove(self.disable_initiator_tag)
1078
GLib.source_remove(self.disable_initiator_tag)
1079
self.disable_initiator_tag = None
645
1080
if getattr(self, "enabled", False):
646
self.disable_initiator_tag = (gobject.timeout_add
647
(timedelta_to_milliseconds
648
(timeout), self.disable))
1081
self.disable_initiator_tag = GLib.timeout_add(
1082
int(timeout.total_seconds() * 1000), self.disable)
649
1083
self.expires = datetime.datetime.utcnow() + timeout
651
1085
def need_approval(self):
652
1086
self.last_approval_request = datetime.datetime.utcnow()
654
1088
def start_checker(self):
655
1089
"""Start a new checker subprocess if one is not running.
657
1091
If a checker already exists, leave it running and do
659
1093
# The reason for not killing a running checker is that if we
664
1098
# checkers alone, the checker would have to take more time
665
1099
# than 'timeout' for the client to be disabled, which is as it
668
# If a checker exists, make sure it is not a zombie
670
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
671
except (AttributeError, OSError) as error:
672
if (isinstance(error, OSError)
673
and error.errno != errno.ECHILD):
677
logger.warning("Checker was a zombie")
678
gobject.source_remove(self.checker_callback_tag)
679
self.checker_callback(pid, status,
680
self.current_checker_command)
1102
if self.checker is not None and not self.checker.is_alive():
1103
logger.warning("Checker was not alive; joining")
681
1106
# Start a new checker if needed
682
1107
if self.checker is None:
1108
# Escape attributes for the shell
1110
attr: re.escape(str(getattr(self, attr)))
1111
for attr in self.runtime_expansions}
684
# In case checker_command has exactly one % operator
685
command = self.checker_command % self.host
687
# Escape attributes for the shell
688
escaped_attrs = dict(
690
re.escape(unicode(str(getattr(self, attr, "")),
694
self.runtime_expansions)
697
command = self.checker_command % escaped_attrs
698
except TypeError as error:
699
logger.error('Could not format string "%s"',
700
self.checker_command, exc_info=error)
701
return True # Try again later
1113
command = self.checker_command % escaped_attrs
1114
except TypeError as error:
1115
logger.error('Could not format string "%s"',
1116
self.checker_command,
1118
return True # Try again later
702
1119
self.current_checker_command = command
704
logger.info("Starting checker %r for %s",
706
# We don't need to redirect stdout and stderr, since
707
# in normal mode, that is already done by daemon(),
708
# and in debug mode we don't want to. (Stdin is
709
# always replaced by /dev/null.)
710
self.checker = subprocess.Popen(command,
713
self.checker_callback_tag = (gobject.child_watch_add
715
self.checker_callback,
717
# The checker may have completed before the gobject
718
# watch was added. Check for this.
719
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
721
gobject.source_remove(self.checker_callback_tag)
722
self.checker_callback(pid, status, command)
723
except OSError as error:
724
logger.error("Failed to start subprocess",
726
# Re-run this periodically if run by gobject.timeout_add
1120
logger.info("Starting checker %r for %s", command,
1122
# We don't need to redirect stdout and stderr, since
1123
# in normal mode, that is already done by daemon(),
1124
# and in debug mode we don't want to. (Stdin is
1125
# always replaced by /dev/null.)
1126
# The exception is when not debugging but nevertheless
1127
# running in the foreground; use the previously
1129
popen_args = {"close_fds": True,
1132
if (not self.server_settings["debug"]
1133
and self.server_settings["foreground"]):
1134
popen_args.update({"stdout": wnull,
1136
pipe = multiprocessing.Pipe(duplex=False)
1137
self.checker = multiprocessing.Process(
1139
args=(pipe[1], subprocess.call, command),
1141
self.checker.start()
1142
self.checker_callback_tag = GLib.io_add_watch(
1143
pipe[0].fileno(), GLib.IO_IN,
1144
self.checker_callback, pipe[0], command)
1145
# Re-run this periodically if run by GLib.timeout_add
729
1148
def stop_checker(self):
730
1149
"""Force the checker process, if any, to stop."""
731
1150
if self.checker_callback_tag:
732
gobject.source_remove(self.checker_callback_tag)
1151
GLib.source_remove(self.checker_callback_tag)
733
1152
self.checker_callback_tag = None
734
1153
if getattr(self, "checker", None) is None:
736
1155
logger.debug("Stopping checker for %(name)s", vars(self))
738
self.checker.terminate()
740
#if self.checker.poll() is None:
741
# self.checker.kill()
742
except OSError as error:
743
if error.errno != errno.ESRCH: # No such process
1156
self.checker.terminate()
745
1157
self.checker = None
748
def dbus_service_property(dbus_interface, signature="v",
749
access="readwrite", byte_arrays=False):
1160
def dbus_service_property(dbus_interface,
750
1164
"""Decorators for marking methods of a DBusObjectWithProperties to
751
1165
become properties on the D-Bus.
753
1167
The decorated method will be called with no arguments by "Get"
754
1168
and with one argument by "Set".
756
1170
The parameters, where they are supported, are the same as
757
1171
dbus.service.method, except there is only "signature", since the
758
1172
type from Get() and the type sent to Set() is the same.
834
class DBusObjectWithProperties(dbus.service.Object):
835
"""A D-Bus object with properties.
837
Classes inheriting from this can use the dbus_service_property
838
decorator to expose methods as D-Bus properties. It exposes the
839
standard Get(), Set(), and GetAll() methods on the D-Bus.
1255
class DBusObjectWithAnnotations(dbus.service.Object):
1256
"""A D-Bus object with annotations.
1258
Classes inheriting from this can use the dbus_annotations
1259
decorator to add annotations to methods or signals.
843
1263
def _is_dbus_thing(thing):
844
1264
"""Returns a function testing if an attribute is a D-Bus thing
846
1266
If called like _is_dbus_thing("method") it returns a function
847
1267
suitable for use as predicate to inspect.getmembers().
849
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1269
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
852
1272
def _get_all_dbus_things(self, thing):
853
1273
"""Returns a generator of (name, attribute) pairs
855
return ((getattr(athing.__get__(self), "_dbus_name",
1275
return ((getattr(athing.__get__(self), "_dbus_name", name),
857
1276
athing.__get__(self))
858
1277
for cls in self.__class__.__mro__
859
1278
for name, athing in
860
inspect.getmembers(cls,
861
self._is_dbus_thing(thing)))
1279
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1281
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1283
path_keyword='object_path',
1284
connection_keyword='connection')
1285
def Introspect(self, object_path, connection):
1286
"""Overloading of standard D-Bus method.
1288
Inserts annotation tags on methods and signals.
1290
xmlstring = dbus.service.Object.Introspect(self, object_path,
1293
document = xml.dom.minidom.parseString(xmlstring)
1295
for if_tag in document.getElementsByTagName("interface"):
1296
# Add annotation tags
1297
for typ in ("method", "signal"):
1298
for tag in if_tag.getElementsByTagName(typ):
1300
for name, prop in (self.
1301
_get_all_dbus_things(typ)):
1302
if (name == tag.getAttribute("name")
1303
and prop._dbus_interface
1304
== if_tag.getAttribute("name")):
1305
annots.update(getattr(
1306
prop, "_dbus_annotations", {}))
1307
for name, value in annots.items():
1308
ann_tag = document.createElement(
1310
ann_tag.setAttribute("name", name)
1311
ann_tag.setAttribute("value", value)
1312
tag.appendChild(ann_tag)
1313
# Add interface annotation tags
1314
for annotation, value in dict(
1315
itertools.chain.from_iterable(
1316
annotations().items()
1317
for name, annotations
1318
in self._get_all_dbus_things("interface")
1319
if name == if_tag.getAttribute("name")
1321
ann_tag = document.createElement("annotation")
1322
ann_tag.setAttribute("name", annotation)
1323
ann_tag.setAttribute("value", value)
1324
if_tag.appendChild(ann_tag)
1325
# Fix argument name for the Introspect method itself
1326
if (if_tag.getAttribute("name")
1327
== dbus.INTROSPECTABLE_IFACE):
1328
for cn in if_tag.getElementsByTagName("method"):
1329
if cn.getAttribute("name") == "Introspect":
1330
for arg in cn.getElementsByTagName("arg"):
1331
if (arg.getAttribute("direction")
1333
arg.setAttribute("name",
1335
xmlstring = document.toxml("utf-8")
1337
except (AttributeError, xml.dom.DOMException,
1338
xml.parsers.expat.ExpatError) as error:
1339
logger.error("Failed to override Introspection method",
1344
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1345
"""A D-Bus object with properties.
1347
Classes inheriting from this can use the dbus_service_property
1348
decorator to expose methods as D-Bus properties. It exposes the
1349
standard Get(), Set(), and GetAll() methods on the D-Bus.
863
1352
def _get_dbus_property(self, interface_name, property_name):
864
1353
"""Returns a bound method if one exists which is a D-Bus
865
1354
property with the specified name and interface.
867
for cls in self.__class__.__mro__:
868
for name, value in (inspect.getmembers
870
self._is_dbus_thing("property"))):
1356
for cls in self.__class__.__mro__:
1357
for name, value in inspect.getmembers(
1358
cls, self._is_dbus_thing("property")):
871
1359
if (value._dbus_name == property_name
872
1360
and value._dbus_interface == interface_name):
873
1361
return value.__get__(self)
875
1363
# No such property
876
raise DBusPropertyNotFound(self.dbus_object_path + ":"
877
+ interface_name + "."
880
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1364
raise DBusPropertyNotFound("{}:{}.{}".format(
1365
self.dbus_object_path, interface_name, property_name))
1368
def _get_all_interface_names(cls):
1369
"""Get a sequence of all interfaces supported by an object"""
1370
return (name for name in set(getattr(getattr(x, attr),
1371
"_dbus_interface", None)
1372
for x in (inspect.getmro(cls))
1374
if name is not None)
1376
@dbus.service.method(dbus.PROPERTIES_IFACE,
881
1378
out_signature="v")
882
1379
def Get(self, interface_name, property_name):
883
1380
"""Standard D-Bus property Get() method, see D-Bus standard.
1013
1509
return xmlstring
1016
def datetime_to_dbus (dt, variant_level=0):
1513
dbus.OBJECT_MANAGER_IFACE
1514
except AttributeError:
1515
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1518
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1519
"""A D-Bus object with an ObjectManager.
1521
Classes inheriting from this exposes the standard
1522
GetManagedObjects call and the InterfacesAdded and
1523
InterfacesRemoved signals on the standard
1524
"org.freedesktop.DBus.ObjectManager" interface.
1526
Note: No signals are sent automatically; they must be sent
1529
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1530
out_signature="a{oa{sa{sv}}}")
1531
def GetManagedObjects(self):
1532
"""This function must be overridden"""
1533
raise NotImplementedError()
1535
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1536
signature="oa{sa{sv}}")
1537
def InterfacesAdded(self, object_path, interfaces_and_properties):
1540
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1541
def InterfacesRemoved(self, object_path, interfaces):
1544
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1546
path_keyword='object_path',
1547
connection_keyword='connection')
1548
def Introspect(self, object_path, connection):
1549
"""Overloading of standard D-Bus method.
1551
Override return argument name of GetManagedObjects to be
1552
"objpath_interfaces_and_properties"
1554
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1558
document = xml.dom.minidom.parseString(xmlstring)
1560
for if_tag in document.getElementsByTagName("interface"):
1561
# Fix argument name for the GetManagedObjects method
1562
if (if_tag.getAttribute("name")
1563
== dbus.OBJECT_MANAGER_IFACE):
1564
for cn in if_tag.getElementsByTagName("method"):
1565
if (cn.getAttribute("name")
1566
== "GetManagedObjects"):
1567
for arg in cn.getElementsByTagName("arg"):
1568
if (arg.getAttribute("direction")
1572
"objpath_interfaces"
1574
xmlstring = document.toxml("utf-8")
1576
except (AttributeError, xml.dom.DOMException,
1577
xml.parsers.expat.ExpatError) as error:
1578
logger.error("Failed to override Introspection method",
1583
def datetime_to_dbus(dt, variant_level=0):
1017
1584
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1019
return dbus.String("", variant_level = variant_level)
1020
return dbus.String(dt.isoformat(),
1021
variant_level=variant_level)
1586
return dbus.String("", variant_level=variant_level)
1587
return dbus.String(dt.isoformat(), variant_level=variant_level)
1024
1590
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1377
1951
server to mandos-client
1381
1955
# Rejected - signal
1382
1956
@dbus.service.signal(_interface, signature="s")
1383
1957
def Rejected(self, reason):
1387
1961
# NeedApproval - signal
1388
1962
@dbus.service.signal(_interface, signature="tb")
1389
1963
def NeedApproval(self, timeout, default):
1391
1965
return self.need_approval()
1395
1969
# Approve - method
1396
1970
@dbus.service.method(_interface, in_signature="b")
1397
1971
def Approve(self, value):
1398
1972
self.approve(value)
1400
1974
# CheckedOK - method
1401
1975
@dbus.service.method(_interface)
1402
1976
def CheckedOK(self):
1403
1977
self.checked_ok()
1405
1979
# Enable - method
1980
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1406
1981
@dbus.service.method(_interface)
1407
1982
def Enable(self):
1411
1986
# StartChecker - method
1987
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1412
1988
@dbus.service.method(_interface)
1413
1989
def StartChecker(self):
1415
1991
self.start_checker()
1417
1993
# Disable - method
1994
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1418
1995
@dbus.service.method(_interface)
1419
1996
def Disable(self):
1423
2000
# StopChecker - method
2001
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1424
2002
@dbus.service.method(_interface)
1425
2003
def StopChecker(self):
1426
2004
self.stop_checker()
1430
2008
# ApprovalPending - property
1431
2009
@dbus_service_property(_interface, signature="b", access="read")
1432
2010
def ApprovalPending_dbus_property(self):
1433
2011
return dbus.Boolean(bool(self.approvals_pending))
1435
2013
# ApprovedByDefault - property
1436
@dbus_service_property(_interface, signature="b",
2014
@dbus_service_property(_interface,
1437
2016
access="readwrite")
1438
2017
def ApprovedByDefault_dbus_property(self, value=None):
1439
2018
if value is None: # get
1440
2019
return dbus.Boolean(self.approved_by_default)
1441
2020
self.approved_by_default = bool(value)
1443
2022
# ApprovalDelay - property
1444
@dbus_service_property(_interface, signature="t",
2023
@dbus_service_property(_interface,
1445
2025
access="readwrite")
1446
2026
def ApprovalDelay_dbus_property(self, value=None):
1447
2027
if value is None: # get
1448
return dbus.UInt64(self.approval_delay_milliseconds())
2028
return dbus.UInt64(self.approval_delay.total_seconds()
1449
2030
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1451
2032
# ApprovalDuration - property
1452
@dbus_service_property(_interface, signature="t",
2033
@dbus_service_property(_interface,
1453
2035
access="readwrite")
1454
2036
def ApprovalDuration_dbus_property(self, value=None):
1455
2037
if value is None: # get
1456
return dbus.UInt64(timedelta_to_milliseconds(
1457
self.approval_duration))
2038
return dbus.UInt64(self.approval_duration.total_seconds()
1458
2040
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1460
2042
# Name - property
2044
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1461
2045
@dbus_service_property(_interface, signature="s", access="read")
1462
2046
def Name_dbus_property(self):
1463
2047
return dbus.String(self.name)
2051
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2052
@dbus_service_property(_interface, signature="s", access="read")
2053
def KeyID_dbus_property(self):
2054
return dbus.String(self.key_id)
1465
2056
# Fingerprint - property
2058
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1466
2059
@dbus_service_property(_interface, signature="s", access="read")
1467
2060
def Fingerprint_dbus_property(self):
1468
2061
return dbus.String(self.fingerprint)
1470
2063
# Host - property
1471
@dbus_service_property(_interface, signature="s",
2064
@dbus_service_property(_interface,
1472
2066
access="readwrite")
1473
2067
def Host_dbus_property(self, value=None):
1474
2068
if value is None: # get
1475
2069
return dbus.String(self.host)
1476
self.host = unicode(value)
2070
self.host = str(value)
1478
2072
# Created - property
2074
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1479
2075
@dbus_service_property(_interface, signature="s", access="read")
1480
2076
def Created_dbus_property(self):
1481
2077
return datetime_to_dbus(self.created)
1483
2079
# LastEnabled - property
1484
2080
@dbus_service_property(_interface, signature="s", access="read")
1485
2081
def LastEnabled_dbus_property(self):
1486
2082
return datetime_to_dbus(self.last_enabled)
1488
2084
# Enabled - property
1489
@dbus_service_property(_interface, signature="b",
2085
@dbus_service_property(_interface,
1490
2087
access="readwrite")
1491
2088
def Enabled_dbus_property(self, value=None):
1492
2089
if value is None: # get
1499
2096
# LastCheckedOK - property
1500
@dbus_service_property(_interface, signature="s",
2097
@dbus_service_property(_interface,
1501
2099
access="readwrite")
1502
2100
def LastCheckedOK_dbus_property(self, value=None):
1503
2101
if value is not None:
1504
2102
self.checked_ok()
1506
2104
return datetime_to_dbus(self.last_checked_ok)
1508
2106
# LastCheckerStatus - property
1509
@dbus_service_property(_interface, signature="n",
2107
@dbus_service_property(_interface, signature="n", access="read")
1511
2108
def LastCheckerStatus_dbus_property(self):
1512
2109
return dbus.Int16(self.last_checker_status)
1514
2111
# Expires - property
1515
2112
@dbus_service_property(_interface, signature="s", access="read")
1516
2113
def Expires_dbus_property(self):
1517
2114
return datetime_to_dbus(self.expires)
1519
2116
# LastApprovalRequest - property
1520
2117
@dbus_service_property(_interface, signature="s", access="read")
1521
2118
def LastApprovalRequest_dbus_property(self):
1522
2119
return datetime_to_dbus(self.last_approval_request)
1524
2121
# Timeout - property
1525
@dbus_service_property(_interface, signature="t",
2122
@dbus_service_property(_interface,
1526
2124
access="readwrite")
1527
2125
def Timeout_dbus_property(self, value=None):
1528
2126
if value is None: # get
1529
return dbus.UInt64(self.timeout_milliseconds())
2127
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2128
old_timeout = self.timeout
1530
2129
self.timeout = datetime.timedelta(0, 0, 0, value)
1531
# Reschedule timeout
2130
# Reschedule disabling
1532
2131
if self.enabled:
1533
2132
now = datetime.datetime.utcnow()
1534
time_to_die = timedelta_to_milliseconds(
1535
(self.last_checked_ok + self.timeout) - now)
1536
if time_to_die <= 0:
2133
self.expires += self.timeout - old_timeout
2134
if self.expires <= now:
1537
2135
# The timeout has passed
1540
self.expires = (now +
1541
datetime.timedelta(milliseconds =
1543
2138
if (getattr(self, "disable_initiator_tag", None)
1546
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (gobject.timeout_add
2141
GLib.source_remove(self.disable_initiator_tag)
2142
self.disable_initiator_tag = GLib.timeout_add(
2143
int((self.expires - now).total_seconds() * 1000),
1551
2146
# ExtendedTimeout - property
1552
@dbus_service_property(_interface, signature="t",
2147
@dbus_service_property(_interface,
1553
2149
access="readwrite")
1554
2150
def ExtendedTimeout_dbus_property(self, value=None):
1555
2151
if value is None: # get
1556
return dbus.UInt64(self.extended_timeout_milliseconds())
2152
return dbus.UInt64(self.extended_timeout.total_seconds()
1557
2154
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1559
2156
# Interval - property
1560
@dbus_service_property(_interface, signature="t",
2157
@dbus_service_property(_interface,
1561
2159
access="readwrite")
1562
2160
def Interval_dbus_property(self, value=None):
1563
2161
if value is None: # get
1564
return dbus.UInt64(self.interval_milliseconds())
2162
return dbus.UInt64(self.interval.total_seconds() * 1000)
1565
2163
self.interval = datetime.timedelta(0, 0, 0, value)
1566
2164
if getattr(self, "checker_initiator_tag", None) is None:
1568
2166
if self.enabled:
1569
2167
# Reschedule checker run
1570
gobject.source_remove(self.checker_initiator_tag)
1571
self.checker_initiator_tag = (gobject.timeout_add
1572
(value, self.start_checker))
1573
self.start_checker() # Start one now, too
2168
GLib.source_remove(self.checker_initiator_tag)
2169
self.checker_initiator_tag = GLib.timeout_add(
2170
value, self.start_checker)
2171
self.start_checker() # Start one now, too
1575
2173
# Checker - property
1576
@dbus_service_property(_interface, signature="s",
2174
@dbus_service_property(_interface,
1577
2176
access="readwrite")
1578
2177
def Checker_dbus_property(self, value=None):
1579
2178
if value is None: # get
1580
2179
return dbus.String(self.checker_command)
1581
self.checker_command = unicode(value)
2180
self.checker_command = str(value)
1583
2182
# CheckerRunning - property
1584
@dbus_service_property(_interface, signature="b",
2183
@dbus_service_property(_interface,
1585
2185
access="readwrite")
1586
2186
def CheckerRunning_dbus_property(self, value=None):
1587
2187
if value is None: # get
1634
2244
class ClientHandler(socketserver.BaseRequestHandler, object):
1635
2245
"""A class to handle client connections.
1637
2247
Instantiated once for each connection to handle it.
1638
2248
Note: This will run in its own forked process."""
1640
2250
def handle(self):
1641
2251
with contextlib.closing(self.server.child_pipe) as child_pipe:
1642
2252
logger.info("TCP connection from: %s",
1643
unicode(self.client_address))
2253
str(self.client_address))
1644
2254
logger.debug("Pipe FD: %d",
1645
2255
self.server.child_pipe.fileno())
1647
session = (gnutls.connection
1648
.ClientSession(self.request,
1650
.X509Credentials()))
1652
# Note: gnutls.connection.X509Credentials is really a
1653
# generic GnuTLS certificate credentials object so long as
1654
# no X.509 keys are added to it. Therefore, we can use it
1655
# here despite using OpenPGP certificates.
1657
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1658
# "+AES-256-CBC", "+SHA1",
1659
# "+COMP-NULL", "+CTYPE-OPENPGP",
2257
session = gnutls.ClientSession(self.request)
2259
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2260
# "+AES-256-CBC", "+SHA1",
2261
# "+COMP-NULL", "+CTYPE-OPENPGP",
1661
2263
# Use a fallback default, since this MUST be set.
1662
2264
priority = self.server.gnutls_priority
1663
2265
if priority is None:
1664
2266
priority = "NORMAL"
1665
(gnutls.library.functions
1666
.gnutls_priority_set_direct(session._c_object,
2267
gnutls.priority_set_direct(session._c_object,
2268
priority.encode("utf-8"),
1669
2271
# Start communication using the Mandos protocol
1670
2272
# Get protocol number
1671
2273
line = self.request.makefile().readline()
1672
2274
logger.debug("Protocol version: %r", line)
1674
2276
if int(line.strip().split()[0]) > 1:
2277
raise RuntimeError(line)
1676
2278
except (ValueError, IndexError, RuntimeError) as error:
1677
2279
logger.error("Unknown protocol version: %s", error)
1680
2282
# Start GnuTLS connection
1682
2284
session.handshake()
1683
except gnutls.errors.GNUTLSError as error:
2285
except gnutls.Error as error:
1684
2286
logger.warning("Handshake failed: %s", error)
1685
2287
# Do not run session.bye() here: the session is not
1686
2288
# established. Just abandon the request.
1688
2290
logger.debug("Handshake succeeded")
1690
2292
approval_required = False
1693
fpr = self.fingerprint(self.peer_certificate
1696
gnutls.errors.GNUTLSError) as error:
1697
logger.warning("Bad certificate: %s", error)
1699
logger.debug("Fingerprint: %s", fpr)
1702
client = ProxyClient(child_pipe, fpr,
2294
if gnutls.has_rawpk:
2297
key_id = self.key_id(
2298
self.peer_certificate(session))
2299
except (TypeError, gnutls.Error) as error:
2300
logger.warning("Bad certificate: %s", error)
2302
logger.debug("Key ID: %s", key_id)
2307
fpr = self.fingerprint(
2308
self.peer_certificate(session))
2309
except (TypeError, gnutls.Error) as error:
2310
logger.warning("Bad certificate: %s", error)
2312
logger.debug("Fingerprint: %s", fpr)
2315
client = ProxyClient(child_pipe, key_id, fpr,
1703
2316
self.client_address)
1704
2317
except KeyError:
1707
2320
if client.approval_delay:
1708
2321
delay = client.approval_delay
1709
2322
client.approvals_pending += 1
1710
2323
approval_required = True
1713
2326
if not client.enabled:
1714
2327
logger.info("Client %s is disabled",
1716
2329
if self.server.use_dbus:
1717
2330
# Emit D-Bus signal
1718
2331
client.Rejected("Disabled")
1721
2334
if client.approved or not client.approval_delay:
1722
#We are approved or approval is disabled
2335
# We are approved or approval is disabled
1724
2337
elif client.approved is None:
1725
2338
logger.info("Client %s needs approval",
1760
2371
delay -= time2 - time
1763
while sent_size < len(client.secret):
1765
sent = session.send(client.secret[sent_size:])
1766
except gnutls.errors.GNUTLSError as error:
1767
logger.warning("gnutls send failed",
1770
logger.debug("Sent: %d, remaining: %d",
1771
sent, len(client.secret)
1772
- (sent_size + sent))
2374
session.send(client.secret)
2375
except gnutls.Error as error:
2376
logger.warning("gnutls send failed",
1775
2380
logger.info("Sending secret to %s", client.name)
1776
2381
# bump the timeout using extended_timeout
1777
2382
client.bump_timeout(client.extended_timeout)
1778
2383
if self.server.use_dbus:
1779
2384
# Emit D-Bus signal
1780
2385
client.GotSecret()
1783
2388
if approval_required:
1784
2389
client.approvals_pending -= 1
1787
except gnutls.errors.GNUTLSError as error:
2392
except gnutls.Error as error:
1788
2393
logger.warning("GnuTLS bye failed",
1789
2394
exc_info=error)
1792
2397
def peer_certificate(session):
1793
"Return the peer's OpenPGP certificate as a bytestring"
1794
# If not an OpenPGP certificate...
1795
if (gnutls.library.functions
1796
.gnutls_certificate_type_get(session._c_object)
1797
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1798
# ...do the normal thing
1799
return session.peer_certificate
2398
"Return the peer's certificate as a bytestring"
2400
cert_type = gnutls.certificate_type_get2(session._c_object,
2402
except AttributeError:
2403
cert_type = gnutls.certificate_type_get(session._c_object)
2404
if gnutls.has_rawpk:
2405
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2407
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2408
# If not a valid certificate type...
2409
if cert_type not in valid_cert_types:
2410
logger.info("Cert type %r not in %r", cert_type,
2412
# ...return invalid data
1800
2414
list_size = ctypes.c_uint(1)
1801
cert_list = (gnutls.library.functions
1802
.gnutls_certificate_get_peers
2415
cert_list = (gnutls.certificate_get_peers
1803
2416
(session._c_object, ctypes.byref(list_size)))
1804
2417
if not bool(cert_list) and list_size.value != 0:
1805
raise gnutls.errors.GNUTLSError("error getting peer"
2418
raise gnutls.Error("error getting peer certificate")
1807
2419
if list_size.value == 0:
1809
2421
cert = cert_list[0]
1810
2422
return ctypes.string_at(cert.data, cert.size)
2425
def key_id(certificate):
2426
"Convert a certificate bytestring to a hexdigit key ID"
2427
# New GnuTLS "datum" with the public key
2428
datum = gnutls.datum_t(
2429
ctypes.cast(ctypes.c_char_p(certificate),
2430
ctypes.POINTER(ctypes.c_ubyte)),
2431
ctypes.c_uint(len(certificate)))
2432
# XXX all these need to be created in the gnutls "module"
2433
# New empty GnuTLS certificate
2434
pubkey = gnutls.pubkey_t()
2435
gnutls.pubkey_init(ctypes.byref(pubkey))
2436
# Import the raw public key into the certificate
2437
gnutls.pubkey_import(pubkey,
2438
ctypes.byref(datum),
2439
gnutls.X509_FMT_DER)
2440
# New buffer for the key ID
2441
buf = ctypes.create_string_buffer(32)
2442
buf_len = ctypes.c_size_t(len(buf))
2443
# Get the key ID from the raw public key into the buffer
2444
gnutls.pubkey_get_key_id(pubkey,
2445
gnutls.KEYID_USE_SHA256,
2446
ctypes.cast(ctypes.byref(buf),
2447
ctypes.POINTER(ctypes.c_ubyte)),
2448
ctypes.byref(buf_len))
2449
# Deinit the certificate
2450
gnutls.pubkey_deinit(pubkey)
2452
# Convert the buffer to a Python bytestring
2453
key_id = ctypes.string_at(buf, buf_len.value)
2454
# Convert the bytestring to hexadecimal notation
2455
hex_key_id = binascii.hexlify(key_id).upper()
1813
2459
def fingerprint(openpgp):
1814
2460
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1815
2461
# New GnuTLS "datum" with the OpenPGP public key
1816
datum = (gnutls.library.types
1817
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1820
ctypes.c_uint(len(openpgp))))
2462
datum = gnutls.datum_t(
2463
ctypes.cast(ctypes.c_char_p(openpgp),
2464
ctypes.POINTER(ctypes.c_ubyte)),
2465
ctypes.c_uint(len(openpgp)))
1821
2466
# New empty GnuTLS certificate
1822
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1823
(gnutls.library.functions
1824
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2467
crt = gnutls.openpgp_crt_t()
2468
gnutls.openpgp_crt_init(ctypes.byref(crt))
1825
2469
# Import the OpenPGP public key into the certificate
1826
(gnutls.library.functions
1827
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1828
gnutls.library.constants
1829
.GNUTLS_OPENPGP_FMT_RAW))
2470
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2471
gnutls.OPENPGP_FMT_RAW)
1830
2472
# Verify the self signature in the key
1831
2473
crtverify = ctypes.c_uint()
1832
(gnutls.library.functions
1833
.gnutls_openpgp_crt_verify_self(crt, 0,
1834
ctypes.byref(crtverify)))
2474
gnutls.openpgp_crt_verify_self(crt, 0,
2475
ctypes.byref(crtverify))
1835
2476
if crtverify.value != 0:
1836
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1837
raise (gnutls.errors.CertificateSecurityError
2477
gnutls.openpgp_crt_deinit(crt)
2478
raise gnutls.CertificateSecurityError(code
1839
2480
# New buffer for the fingerprint
1840
2481
buf = ctypes.create_string_buffer(20)
1841
2482
buf_len = ctypes.c_size_t()
1842
2483
# Get the fingerprint from the certificate into the buffer
1843
(gnutls.library.functions
1844
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1845
ctypes.byref(buf_len)))
2484
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2485
ctypes.byref(buf_len))
1846
2486
# Deinit the certificate
1847
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2487
gnutls.openpgp_crt_deinit(crt)
1848
2488
# Convert the buffer to a Python bytestring
1849
2489
fpr = ctypes.string_at(buf, buf_len.value)
1850
2490
# Convert the bytestring to hexadecimal notation
1855
2495
class MultiprocessingMixIn(object):
1856
2496
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1857
2498
def sub_process_main(self, request, address):
1859
2500
self.finish_request(request, address)
1860
2501
except Exception:
1861
2502
self.handle_error(request, address)
1862
2503
self.close_request(request)
1864
2505
def process_request(self, request, address):
1865
2506
"""Start a new process to process the request."""
1866
proc = multiprocessing.Process(target = self.sub_process_main,
2507
proc = multiprocessing.Process(target=self.sub_process_main,
2508
args=(request, address))
1873
2513
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1874
2514
""" adds a pipe to the MixIn """
1875
2516
def process_request(self, request, client_address):
1876
2517
"""Overrides and wraps the original process_request().
1878
2519
This function creates a new pipe in self.pipe
1880
2521
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1882
2523
proc = MultiprocessingMixIn.process_request(self, request,
1883
2524
client_address)
1884
2525
self.child_pipe.close()
1885
2526
self.add_pipe(parent_pipe, proc)
1887
2528
def add_pipe(self, parent_pipe, proc):
1888
2529
"""Dummy function; override as necessary"""
1889
raise NotImplementedError
2530
raise NotImplementedError()
1892
2533
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1893
2534
socketserver.TCPServer, object):
1894
2535
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1897
2538
enabled: Boolean; whether this server is activated yet
1898
2539
interface: None or a network interface name (string)
1899
2540
use_ipv6: Boolean; to use IPv6 or not
1901
2543
def __init__(self, server_address, RequestHandlerClass,
1902
interface=None, use_ipv6=True):
2547
"""If socketfd is set, use that file descriptor instead of
2548
creating a new one with socket.socket().
1903
2550
self.interface = interface
1905
2552
self.address_family = socket.AF_INET6
2553
if socketfd is not None:
2554
# Save the file descriptor
2555
self.socketfd = socketfd
2556
# Save the original socket.socket() function
2557
self.socket_socket = socket.socket
2559
# To implement --socket, we monkey patch socket.socket.
2561
# (When socketserver.TCPServer is a new-style class, we
2562
# could make self.socket into a property instead of monkey
2563
# patching socket.socket.)
2565
# Create a one-time-only replacement for socket.socket()
2566
@functools.wraps(socket.socket)
2567
def socket_wrapper(*args, **kwargs):
2568
# Restore original function so subsequent calls are
2570
socket.socket = self.socket_socket
2571
del self.socket_socket
2572
# This time only, return a new socket object from the
2573
# saved file descriptor.
2574
return socket.fromfd(self.socketfd, *args, **kwargs)
2575
# Replace socket.socket() function with wrapper
2576
socket.socket = socket_wrapper
2577
# The socketserver.TCPServer.__init__ will call
2578
# socket.socket(), which might be our replacement,
2579
# socket_wrapper(), if socketfd was set.
1906
2580
socketserver.TCPServer.__init__(self, server_address,
1907
2581
RequestHandlerClass)
1908
2583
def server_bind(self):
1909
2584
"""This overrides the normal server_bind() function
1910
2585
to bind to an interface if one was specified, and also NOT to
1911
2586
bind to an address or port if they were not specified."""
2587
global SO_BINDTODEVICE
1912
2588
if self.interface is not None:
1913
2589
if SO_BINDTODEVICE is None:
1914
logger.error("SO_BINDTODEVICE does not exist;"
1915
" cannot bind to interface %s",
1919
self.socket.setsockopt(socket.SOL_SOCKET,
1923
except socket.error as error:
1924
if error[0] == errno.EPERM:
1925
logger.error("No permission to"
1926
" bind to interface %s",
1928
elif error[0] == errno.ENOPROTOOPT:
1929
logger.error("SO_BINDTODEVICE not available;"
1930
" cannot bind to interface %s",
2590
# Fall back to a hard-coded value which seems to be
2592
logger.warning("SO_BINDTODEVICE not found, trying 25")
2593
SO_BINDTODEVICE = 25
2595
self.socket.setsockopt(
2596
socket.SOL_SOCKET, SO_BINDTODEVICE,
2597
(self.interface + "\0").encode("utf-8"))
2598
except socket.error as error:
2599
if error.errno == errno.EPERM:
2600
logger.error("No permission to bind to"
2601
" interface %s", self.interface)
2602
elif error.errno == errno.ENOPROTOOPT:
2603
logger.error("SO_BINDTODEVICE not available;"
2604
" cannot bind to interface %s",
2606
elif error.errno == errno.ENODEV:
2607
logger.error("Interface %s does not exist,"
2608
" cannot bind", self.interface)
1934
2611
# Only bind(2) the socket if we really need to.
1935
2612
if self.server_address[0] or self.server_address[1]:
2613
if self.server_address[1]:
2614
self.allow_reuse_address = True
1936
2615
if not self.server_address[0]:
1937
2616
if self.address_family == socket.AF_INET6:
1938
any_address = "::" # in6addr_any
2617
any_address = "::" # in6addr_any
1940
any_address = socket.INADDR_ANY
2619
any_address = "0.0.0.0" # INADDR_ANY
1941
2620
self.server_address = (any_address,
1942
2621
self.server_address[1])
1943
2622
elif not self.server_address[1]:
1944
self.server_address = (self.server_address[0],
2623
self.server_address = (self.server_address[0], 0)
1946
2624
# if self.interface:
1947
2625
# self.server_address = (self.server_address[0],
1973
2656
self.gnutls_priority = gnutls_priority
1974
2657
IPv6_TCPServer.__init__(self, server_address,
1975
2658
RequestHandlerClass,
1976
interface = interface,
1977
use_ipv6 = use_ipv6)
2659
interface=interface,
1978
2663
def server_activate(self):
1979
2664
if self.enabled:
1980
2665
return socketserver.TCPServer.server_activate(self)
1982
2667
def enable(self):
1983
2668
self.enabled = True
1985
2670
def add_pipe(self, parent_pipe, proc):
1986
2671
# Call "handle_ipc" for both data and EOF events
1987
gobject.io_add_watch(parent_pipe.fileno(),
1988
gobject.IO_IN | gobject.IO_HUP,
1989
functools.partial(self.handle_ipc,
1994
def handle_ipc(self, source, condition, parent_pipe=None,
1995
proc = None, client_object=None):
2673
parent_pipe.fileno(),
2674
GLib.IO_IN | GLib.IO_HUP,
2675
functools.partial(self.handle_ipc,
2676
parent_pipe=parent_pipe,
2679
def handle_ipc(self, source, condition,
2682
client_object=None):
1996
2683
# error, or the other end of multiprocessing.Pipe has closed
1997
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2684
if condition & (GLib.IO_ERR | GLib.IO_HUP):
1998
2685
# Wait for other process to exit
2002
2689
# Read a request from the child
2003
2690
request = parent_pipe.recv()
2004
2691
command = request[0]
2006
2693
if command == 'init':
2008
address = request[2]
2010
for c in self.clients.itervalues():
2011
if c.fingerprint == fpr:
2694
key_id = request[1].decode("ascii")
2695
fpr = request[2].decode("ascii")
2696
address = request[3]
2698
for c in self.clients.values():
2699
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2701
if key_id and c.key_id == key_id:
2704
if fpr and c.fingerprint == fpr:
2015
logger.info("Client not found for fingerprint: %s, ad"
2016
"dress: %s", fpr, address)
2708
logger.info("Client not found for key ID: %s, address"
2709
": %s", key_id or fpr, address)
2017
2710
if self.use_dbus:
2018
2711
# Emit D-Bus signal
2019
mandos_dbus_service.ClientNotFound(fpr,
2712
mandos_dbus_service.ClientNotFound(key_id or fpr,
2021
2714
parent_pipe.send(False)
2024
gobject.io_add_watch(parent_pipe.fileno(),
2025
gobject.IO_IN | gobject.IO_HUP,
2026
functools.partial(self.handle_ipc,
2718
parent_pipe.fileno(),
2719
GLib.IO_IN | GLib.IO_HUP,
2720
functools.partial(self.handle_ipc,
2721
parent_pipe=parent_pipe,
2723
client_object=client))
2032
2724
parent_pipe.send(True)
2033
2725
# remove the old hook in favor of the new above hook on
2037
2729
funcname = request[1]
2038
2730
args = request[2]
2039
2731
kwargs = request[3]
2041
2733
parent_pipe.send(('data', getattr(client_object,
2042
2734
funcname)(*args,
2045
2737
if command == 'getattr':
2046
2738
attrname = request[1]
2047
if callable(client_object.__getattribute__(attrname)):
2048
parent_pipe.send(('function',))
2739
if isinstance(client_object.__getattribute__(attrname),
2740
collections.Callable):
2741
parent_pipe.send(('function', ))
2050
parent_pipe.send(('data', client_object
2051
.__getattribute__(attrname)))
2744
'data', client_object.__getattribute__(attrname)))
2053
2746
if command == 'setattr':
2054
2747
attrname = request[1]
2055
2748
value = request[2]
2056
2749
setattr(client_object, attrname, value)
2754
def rfc3339_duration_to_delta(duration):
2755
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2757
>>> rfc3339_duration_to_delta("P7D")
2758
datetime.timedelta(7)
2759
>>> rfc3339_duration_to_delta("PT60S")
2760
datetime.timedelta(0, 60)
2761
>>> rfc3339_duration_to_delta("PT60M")
2762
datetime.timedelta(0, 3600)
2763
>>> rfc3339_duration_to_delta("PT24H")
2764
datetime.timedelta(1)
2765
>>> rfc3339_duration_to_delta("P1W")
2766
datetime.timedelta(7)
2767
>>> rfc3339_duration_to_delta("PT5M30S")
2768
datetime.timedelta(0, 330)
2769
>>> rfc3339_duration_to_delta("P1DT3M20S")
2770
datetime.timedelta(1, 200)
2773
# Parsing an RFC 3339 duration with regular expressions is not
2774
# possible - there would have to be multiple places for the same
2775
# values, like seconds. The current code, while more esoteric, is
2776
# cleaner without depending on a parsing library. If Python had a
2777
# built-in library for parsing we would use it, but we'd like to
2778
# avoid excessive use of external libraries.
2780
# New type for defining tokens, syntax, and semantics all-in-one
2781
Token = collections.namedtuple("Token", (
2782
"regexp", # To match token; if "value" is not None, must have
2783
# a "group" containing digits
2784
"value", # datetime.timedelta or None
2785
"followers")) # Tokens valid after this token
2786
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2787
# the "duration" ABNF definition in RFC 3339, Appendix A.
2788
token_end = Token(re.compile(r"$"), None, frozenset())
2789
token_second = Token(re.compile(r"(\d+)S"),
2790
datetime.timedelta(seconds=1),
2791
frozenset((token_end, )))
2792
token_minute = Token(re.compile(r"(\d+)M"),
2793
datetime.timedelta(minutes=1),
2794
frozenset((token_second, token_end)))
2795
token_hour = Token(re.compile(r"(\d+)H"),
2796
datetime.timedelta(hours=1),
2797
frozenset((token_minute, token_end)))
2798
token_time = Token(re.compile(r"T"),
2800
frozenset((token_hour, token_minute,
2802
token_day = Token(re.compile(r"(\d+)D"),
2803
datetime.timedelta(days=1),
2804
frozenset((token_time, token_end)))
2805
token_month = Token(re.compile(r"(\d+)M"),
2806
datetime.timedelta(weeks=4),
2807
frozenset((token_day, token_end)))
2808
token_year = Token(re.compile(r"(\d+)Y"),
2809
datetime.timedelta(weeks=52),
2810
frozenset((token_month, token_end)))
2811
token_week = Token(re.compile(r"(\d+)W"),
2812
datetime.timedelta(weeks=1),
2813
frozenset((token_end, )))
2814
token_duration = Token(re.compile(r"P"), None,
2815
frozenset((token_year, token_month,
2816
token_day, token_time,
2818
# Define starting values:
2820
value = datetime.timedelta()
2822
# Following valid tokens
2823
followers = frozenset((token_duration, ))
2824
# String left to parse
2826
# Loop until end token is found
2827
while found_token is not token_end:
2828
# Search for any currently valid tokens
2829
for token in followers:
2830
match = token.regexp.match(s)
2831
if match is not None:
2833
if token.value is not None:
2834
# Value found, parse digits
2835
factor = int(match.group(1), 10)
2836
# Add to value so far
2837
value += factor * token.value
2838
# Strip token from string
2839
s = token.regexp.sub("", s, 1)
2842
# Set valid next tokens
2843
followers = found_token.followers
2846
# No currently valid tokens were found
2847
raise ValueError("Invalid RFC 3339 duration: {!r}"
2061
2853
def string_to_delta(interval):
2062
2854
"""Parse a string and return a datetime.timedelta
2064
2856
>>> string_to_delta('7d')
2065
2857
datetime.timedelta(7)
2066
2858
>>> string_to_delta('60s')
2156
2953
parser.add_argument("--no-dbus", action="store_false",
2157
2954
dest="use_dbus", help="Do not provide D-Bus"
2158
" system bus interface")
2955
" system bus interface", default=None)
2159
2956
parser.add_argument("--no-ipv6", action="store_false",
2160
dest="use_ipv6", help="Do not use IPv6")
2957
dest="use_ipv6", help="Do not use IPv6",
2161
2959
parser.add_argument("--no-restore", action="store_false",
2162
2960
dest="restore", help="Do not restore stored"
2961
" state", default=None)
2962
parser.add_argument("--socket", type=int,
2963
help="Specify a file descriptor to a network"
2964
" socket to use instead of creating one")
2164
2965
parser.add_argument("--statedir", metavar="DIR",
2165
2966
help="Directory to save/restore state in")
2967
parser.add_argument("--foreground", action="store_true",
2968
help="Run in foreground", default=None)
2969
parser.add_argument("--no-zeroconf", action="store_false",
2970
dest="zeroconf", help="Do not use Zeroconf",
2167
2973
options = parser.parse_args()
2169
2975
if options.check:
2977
fail_count, test_count = doctest.testmod()
2978
sys.exit(os.EX_OK if fail_count == 0 else 1)
2174
2980
# Default values for config file for server-global settings
2175
server_defaults = { "interface": "",
2180
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2181
"servicename": "Mandos",
2186
"statedir": "/var/lib/mandos"
2981
if gnutls.has_rawpk:
2982
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2983
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2985
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2986
":+SIGN-DSA-SHA256")
2987
server_defaults = {"interface": "",
2991
"priority": priority,
2992
"servicename": "Mandos",
2998
"statedir": "/var/lib/mandos",
2999
"foreground": "False",
2189
3004
# Parse config file for server-global settings
2190
server_config = configparser.SafeConfigParser(server_defaults)
3005
server_config = configparser.ConfigParser(server_defaults)
2191
3006
del server_defaults
2192
server_config.read(os.path.join(options.configdir,
2194
# Convert the SafeConfigParser object to a dict
3007
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3008
# Convert the ConfigParser object to a dict
2195
3009
server_settings = server_config.defaults()
2196
3010
# Use the appropriate methods on the non-string config options
2197
for option in ("debug", "use_dbus", "use_ipv6"):
3011
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3012
"foreground", "zeroconf"):
2198
3013
server_settings[option] = server_config.getboolean("DEFAULT",
2200
3015
if server_settings["port"]:
2201
3016
server_settings["port"] = server_config.getint("DEFAULT",
3018
if server_settings["socket"]:
3019
server_settings["socket"] = server_config.getint("DEFAULT",
3021
# Later, stdin will, and stdout and stderr might, be dup'ed
3022
# over with an opened os.devnull. But we don't want this to
3023
# happen with a supplied network socket.
3024
if 0 <= server_settings["socket"] <= 2:
3025
server_settings["socket"] = os.dup(server_settings
2203
3027
del server_config
2205
3029
# Override the settings from the config file with command line
2206
3030
# options, if set.
2207
3031
for option in ("interface", "address", "port", "debug",
2208
"priority", "servicename", "configdir",
2209
"use_dbus", "use_ipv6", "debuglevel", "restore",
3032
"priority", "servicename", "configdir", "use_dbus",
3033
"use_ipv6", "debuglevel", "restore", "statedir",
3034
"socket", "foreground", "zeroconf"):
2211
3035
value = getattr(options, option)
2212
3036
if value is not None:
2213
3037
server_settings[option] = value
2215
3039
# Force all strings to be unicode
2216
3040
for option in server_settings.keys():
2217
if type(server_settings[option]) is str:
2218
server_settings[option] = unicode(server_settings[option])
3041
if isinstance(server_settings[option], bytes):
3042
server_settings[option] = (server_settings[option]
3044
# Force all boolean options to be boolean
3045
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3046
"foreground", "zeroconf"):
3047
server_settings[option] = bool(server_settings[option])
3048
# Debug implies foreground
3049
if server_settings["debug"]:
3050
server_settings["foreground"] = True
2219
3051
# Now we have our good server settings in "server_settings"
2221
3053
##################################################################
3055
if (not server_settings["zeroconf"]
3056
and not (server_settings["port"]
3057
or server_settings["socket"] != "")):
3058
parser.error("Needs port or socket to work without Zeroconf")
2223
3060
# For convenience
2224
3061
debug = server_settings["debug"]
2225
3062
debuglevel = server_settings["debuglevel"]
3131
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2286
3133
except OSError as error:
2287
if error[0] != errno.EPERM:
3134
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3135
.format(uid, gid, os.strerror(error.errno)))
3136
if error.errno != errno.EPERM:
2291
3140
# Enable all possible GnuTLS debugging
2293
3142
# "Use a log level over 10 to enable all debugging options."
2294
3143
# - GnuTLS manual
2295
gnutls.library.functions.gnutls_global_set_log_level(11)
2297
@gnutls.library.types.gnutls_log_func
3144
gnutls.global_set_log_level(11)
2298
3147
def debug_gnutls(level, string):
2299
3148
logger.debug("GnuTLS: %s", string[:-1])
2301
(gnutls.library.functions
2302
.gnutls_global_set_log_function(debug_gnutls))
3150
gnutls.global_set_log_function(debug_gnutls)
2304
3152
# Redirect stdin so all checkers get /dev/null
2305
3153
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2306
3154
os.dup2(null, sys.stdin.fileno())
2310
3158
# Need to fork before connecting to D-Bus
2312
3160
# Close all input and output, do double fork, etc.
2315
gobject.threads_init()
3163
if gi.version_info < (3, 10, 2):
3164
# multiprocessing will use threads, so before we use GLib we
3165
# need to inform GLib that threads will be used.
2317
3168
global main_loop
2318
3169
# From the Avahi example code
2319
3170
DBusGMainLoop(set_as_default=True)
2320
main_loop = gobject.MainLoop()
3171
main_loop = GLib.MainLoop()
2321
3172
bus = dbus.SystemBus()
2322
3173
# End of Avahi example code
2325
3176
bus_name = dbus.service.BusName("se.recompile.Mandos",
2326
bus, do_not_queue=True)
2327
old_bus_name = (dbus.service.BusName
2328
("se.bsnet.fukt.Mandos", bus,
2330
except dbus.exceptions.NameExistsException as e:
3179
old_bus_name = dbus.service.BusName(
3180
"se.bsnet.fukt.Mandos", bus,
3182
except dbus.exceptions.DBusException as e:
2331
3183
logger.error("Disabling D-Bus:", exc_info=e)
2332
3184
use_dbus = False
2333
3185
server_settings["use_dbus"] = False
2334
3186
tcp_server.use_dbus = False
2335
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2336
service = AvahiServiceToSyslog(name =
2337
server_settings["servicename"],
2338
servicetype = "_mandos._tcp",
2339
protocol = protocol, bus = bus)
2340
if server_settings["interface"]:
2341
service.interface = (if_nametoindex
2342
(str(server_settings["interface"])))
3188
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3189
service = AvahiServiceToSyslog(
3190
name=server_settings["servicename"],
3191
servicetype="_mandos._tcp",
3194
if server_settings["interface"]:
3195
service.interface = if_nametoindex(
3196
server_settings["interface"].encode("utf-8"))
2344
3198
global multiprocessing_manager
2345
3199
multiprocessing_manager = multiprocessing.Manager()
2347
3201
client_class = Client
2349
client_class = functools.partial(ClientDBus, bus = bus)
3203
client_class = functools.partial(ClientDBus, bus=bus)
2351
3205
client_settings = Client.config_parser(client_config)
2352
3206
old_client_settings = {}
2353
3207
clients_data = {}
3209
# This is used to redirect stdout and stderr for checker processes
3211
wnull = open(os.devnull, "w") # A writable /dev/null
3212
# Only used if server is running in foreground but not in debug
3214
if debug or not foreground:
2355
3217
# Get client data and settings from last running state.
2356
3218
if server_settings["restore"]:
2358
3220
with open(stored_state_path, "rb") as stored_state:
2359
clients_data, old_client_settings = (pickle.load
3221
if sys.version_info.major == 2:
3222
clients_data, old_client_settings = pickle.load(
3225
bytes_clients_data, bytes_old_client_settings = (
3226
pickle.load(stored_state, encoding="bytes"))
3227
# Fix bytes to strings
3230
clients_data = {(key.decode("utf-8")
3231
if isinstance(key, bytes)
3234
bytes_clients_data.items()}
3235
del bytes_clients_data
3236
for key in clients_data:
3237
value = {(k.decode("utf-8")
3238
if isinstance(k, bytes) else k): v
3240
clients_data[key].items()}
3241
clients_data[key] = value
3243
value["client_structure"] = [
3245
if isinstance(s, bytes)
3247
value["client_structure"]]
3249
for k in ("name", "host"):
3250
if isinstance(value[k], bytes):
3251
value[k] = value[k].decode("utf-8")
3252
if "key_id" not in value:
3253
value["key_id"] = ""
3254
elif "fingerprint" not in value:
3255
value["fingerprint"] = ""
3256
# old_client_settings
3258
old_client_settings = {
3259
(key.decode("utf-8")
3260
if isinstance(key, bytes)
3263
bytes_old_client_settings.items()}
3264
del bytes_old_client_settings
3266
for value in old_client_settings.values():
3267
if isinstance(value["host"], bytes):
3268
value["host"] = (value["host"]
2361
3270
os.remove(stored_state_path)
2362
3271
except IOError as e:
2363
3272
if e.errno == errno.ENOENT:
2364
logger.warning("Could not load persistent state: {0}"
2365
.format(os.strerror(e.errno)))
3273
logger.warning("Could not load persistent state:"
3274
" {}".format(os.strerror(e.errno)))
2367
3276
logger.critical("Could not load persistent state:",
2370
3279
except EOFError as e:
2371
3280
logger.warning("Could not load persistent state: "
2372
"EOFError:", exc_info=e)
2374
3284
with PGPEngine() as pgp:
2375
for client_name, client in clients_data.iteritems():
3285
for client_name, client in clients_data.items():
3286
# Skip removed clients
3287
if client_name not in client_settings:
2376
3290
# Decide which value to use after restoring saved state.
2377
3291
# We have three different values: Old config file,
2378
3292
# new config file, and saved state.
2436
3350
for client_name in (set(client_settings)
2437
3351
- set(old_client_settings)):
2438
3352
clients_data[client_name] = client_settings[client_name]
2440
3354
# Create all client objects
2441
for client_name, client in clients_data.iteritems():
3355
for client_name, client in clients_data.items():
2442
3356
tcp_server.clients[client_name] = client_class(
2443
name = client_name, settings = client)
3359
server_settings=server_settings)
2445
3361
if not tcp_server.clients:
2446
3362
logger.warning("No clients defined")
2452
pidfile.write(str(pid) + "\n".encode("utf-8"))
2455
logger.error("Could not write to file %r with PID %d",
2458
# "pidfile" was never created
3365
if pidfile is not None:
3369
print(pid, file=pidfile)
3371
logger.error("Could not write to file %r with PID %d",
2460
3374
del pidfilename
2461
signal.signal(signal.SIGINT, signal.SIG_IGN)
2463
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2464
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3376
for termsig in (signal.SIGHUP, signal.SIGTERM):
3377
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3378
lambda: main_loop.quit() and False)
2467
@alternate_dbus_interfaces({"se.recompile.Mandos":
2468
"se.bsnet.fukt.Mandos"})
2469
class MandosDBusService(DBusObjectWithProperties):
3382
@alternate_dbus_interfaces(
3383
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3384
class MandosDBusService(DBusObjectWithObjectManager):
2470
3385
"""A D-Bus proxy object"""
2471
3387
def __init__(self):
2472
3388
dbus.service.Object.__init__(self, bus, "/")
2473
3390
_interface = "se.recompile.Mandos"
2475
@dbus_interface_annotations(_interface)
2477
return { "org.freedesktop.DBus.Property"
2478
".EmitsChangedSignal":
2481
3392
@dbus.service.signal(_interface, signature="o")
2482
3393
def ClientAdded(self, objpath):
2486
3397
@dbus.service.signal(_interface, signature="ss")
2487
def ClientNotFound(self, fingerprint, address):
3398
def ClientNotFound(self, key_id, address):
3402
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2491
3404
@dbus.service.signal(_interface, signature="os")
2492
3405
def ClientRemoved(self, objpath, name):
3409
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2496
3411
@dbus.service.method(_interface, out_signature="ao")
2497
3412
def GetAllClients(self):
2499
return dbus.Array(c.dbus_object_path
2501
tcp_server.clients.itervalues())
3414
return dbus.Array(c.dbus_object_path for c in
3415
tcp_server.clients.values())
3417
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2503
3419
@dbus.service.method(_interface,
2504
3420
out_signature="a{oa{sv}}")
2505
3421
def GetAllClientsWithProperties(self):
2507
3423
return dbus.Dictionary(
2508
((c.dbus_object_path, c.GetAll(""))
2509
for c in tcp_server.clients.itervalues()),
3424
{c.dbus_object_path: c.GetAll(
3425
"se.recompile.Mandos.Client")
3426
for c in tcp_server.clients.values()},
2510
3427
signature="oa{sv}")
2512
3429
@dbus.service.method(_interface, in_signature="o")
2513
3430
def RemoveClient(self, object_path):
2515
for c in tcp_server.clients.itervalues():
3432
for c in tcp_server.clients.values():
2516
3433
if c.dbus_object_path == object_path:
2517
3434
del tcp_server.clients[c.name]
2518
3435
c.remove_from_connection()
2519
# Don't signal anything except ClientRemoved
3436
# Don't signal the disabling
2520
3437
c.disable(quiet=True)
2522
self.ClientRemoved(object_path, c.name)
3438
# Emit D-Bus signal for removal
3439
self.client_removed_signal(c)
2524
3441
raise KeyError(object_path)
3445
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3446
out_signature="a{oa{sa{sv}}}")
3447
def GetManagedObjects(self):
3449
return dbus.Dictionary(
3450
{client.dbus_object_path:
3452
{interface: client.GetAll(interface)
3454
client._get_all_interface_names()})
3455
for client in tcp_server.clients.values()})
3457
def client_added_signal(self, client):
3458
"""Send the new standard signal and the old signal"""
3460
# New standard signal
3461
self.InterfacesAdded(
3462
client.dbus_object_path,
3464
{interface: client.GetAll(interface)
3466
client._get_all_interface_names()}))
3468
self.ClientAdded(client.dbus_object_path)
3470
def client_removed_signal(self, client):
3471
"""Send the new standard signal and the old signal"""
3473
# New standard signal
3474
self.InterfacesRemoved(
3475
client.dbus_object_path,
3476
client._get_all_interface_names())
3478
self.ClientRemoved(client.dbus_object_path,
2528
3481
mandos_dbus_service = MandosDBusService()
3483
# Save modules to variables to exempt the modules from being
3484
# unloaded before the function registered with atexit() is run.
3485
mp = multiprocessing
2531
3489
"Cleanup function; run on exit"
2534
multiprocessing.active_children()
3493
mp.active_children()
2535
3495
if not (tcp_server.clients or client_settings):
2538
3498
# Store client before exiting. Secrets are encrypted with key
2539
3499
# based on what config file has. If config file is
2540
3500
# removed/edited, old secret will thus be unrecovable.
2542
3502
with PGPEngine() as pgp:
2543
for client in tcp_server.clients.itervalues():
3503
for client in tcp_server.clients.values():
2544
3504
key = client_settings[client.name]["secret"]
2545
3505
client.encrypted_secret = pgp.encrypt(client.secret,
2547
3507
client_dict = {}
2549
3509
# A list of attributes that can not be pickled
2551
exclude = set(("bus", "changedstate", "secret",
2553
for name, typ in (inspect.getmembers
2554
(dbus.service.Object)):
3511
exclude = {"bus", "changedstate", "secret",
3512
"checker", "server_settings"}
3513
for name, typ in inspect.getmembers(dbus.service
2555
3515
exclude.add(name)
2557
3517
client_dict["encrypted_secret"] = (client
2558
3518
.encrypted_secret)
2559
3519
for attr in client.client_structure:
2560
3520
if attr not in exclude:
2561
3521
client_dict[attr] = getattr(client, attr)
2563
3523
clients[client.name] = client_dict
2564
3524
del client_settings[client.name]["secret"]
2567
with (tempfile.NamedTemporaryFile
2568
(mode='wb', suffix=".pickle", prefix='clients-',
2569
dir=os.path.dirname(stored_state_path),
2570
delete=False)) as stored_state:
2571
pickle.dump((clients, client_settings), stored_state)
2572
tempname=stored_state.name
3527
with tempfile.NamedTemporaryFile(
3531
dir=os.path.dirname(stored_state_path),
3532
delete=False) as stored_state:
3533
pickle.dump((clients, client_settings), stored_state,
3535
tempname = stored_state.name
2573
3536
os.rename(tempname, stored_state_path)
2574
3537
except (IOError, OSError) as e: