70
import cPickle as pickle
62
import cPickle as pickle
73
63
import multiprocessing
82
66
import dbus.service
84
from gi.repository import GLib
85
69
from dbus.mainloop.glib import DBusGMainLoop
88
72
import xml.dom.minidom
91
if sys.version_info.major == 2:
94
# Try to find the value of SO_BINDTODEVICE:
96
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
97
# newer, and it is also the most natural place for it:
98
76
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
99
77
except AttributeError:
101
# This is where SO_BINDTODEVICE was up to and including Python
103
79
from IN import SO_BINDTODEVICE
104
80
except ImportError:
105
# In Python 2.7 it seems to have been removed entirely.
106
# Try running the C preprocessor:
108
cc = subprocess.Popen(["cc", "--language=c", "-E",
110
stdin=subprocess.PIPE,
111
stdout=subprocess.PIPE)
112
stdout = cc.communicate(
113
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
114
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
115
except (OSError, ValueError, IndexError):
117
SO_BINDTODEVICE = None
119
if sys.version_info.major == 2:
122
if sys.version_info < (3, 2):
123
configparser.Configparser = configparser.SafeConfigParser
126
stored_state_file = "clients.pickle"
128
logger = logging.getLogger()
132
if_nametoindex = ctypes.cdll.LoadLibrary(
133
ctypes.util.find_library("c")).if_nametoindex
134
except (OSError, AttributeError):
136
def if_nametoindex(interface):
137
"Get an interface index the hard way, i.e. using fcntl()"
138
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
139
with contextlib.closing(socket.socket()) as s:
140
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
141
struct.pack(b"16s16x", interface))
142
interface_index = struct.unpack("I", ifreq[16:20])[0]
143
return interface_index
146
def copy_function(func):
147
"""Make a copy of a function"""
148
if sys.version_info.major == 2:
149
return types.FunctionType(func.func_code,
155
return types.FunctionType(func.__code__,
162
def initlogger(debug, level=logging.WARNING):
163
"""init logger and add loglevel"""
166
syslogger = (logging.handlers.SysLogHandler(
167
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
169
syslogger.setFormatter(logging.Formatter
170
('Mandos [%(process)d]: %(levelname)s:'
172
logger.addHandler(syslogger)
175
console = logging.StreamHandler()
176
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
180
logger.addHandler(console)
181
logger.setLevel(level)
184
class PGPError(Exception):
185
"""Exception if encryption/decryption fails"""
190
"""A simple class for OpenPGP symmetric encryption & decryption"""
193
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
196
output = subprocess.check_output(["gpgconf"])
197
for line in output.splitlines():
198
name, text, path = line.split(b":")
203
if e.errno != errno.ENOENT:
205
self.gnupgargs = ['--batch',
206
'--homedir', self.tempdir,
209
# Only GPG version 1 has the --no-use-agent option.
210
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
211
self.gnupgargs.append("--no-use-agent")
216
def __exit__(self, exc_type, exc_value, traceback):
224
if self.tempdir is not None:
225
# Delete contents of tempdir
226
for root, dirs, files in os.walk(self.tempdir,
228
for filename in files:
229
os.remove(os.path.join(root, filename))
231
os.rmdir(os.path.join(root, dirname))
233
os.rmdir(self.tempdir)
236
def password_encode(self, password):
237
# Passphrase can not be empty and can not contain newlines or
238
# NUL bytes. So we prefix it and hex encode it.
239
encoded = b"mandos" + binascii.hexlify(password)
240
if len(encoded) > 2048:
241
# GnuPG can't handle long passwords, so encode differently
242
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
243
.replace(b"\n", b"\\n")
244
.replace(b"\0", b"\\x00"))
247
def encrypt(self, data, password):
248
passphrase = self.password_encode(password)
249
with tempfile.NamedTemporaryFile(
250
dir=self.tempdir) as passfile:
251
passfile.write(passphrase)
253
proc = subprocess.Popen([self.gpg, '--symmetric',
257
stdin=subprocess.PIPE,
258
stdout=subprocess.PIPE,
259
stderr=subprocess.PIPE)
260
ciphertext, err = proc.communicate(input=data)
261
if proc.returncode != 0:
265
def decrypt(self, data, password):
266
passphrase = self.password_encode(password)
267
with tempfile.NamedTemporaryFile(
268
dir=self.tempdir) as passfile:
269
passfile.write(passphrase)
271
proc = subprocess.Popen([self.gpg, '--decrypt',
275
stdin=subprocess.PIPE,
276
stdout=subprocess.PIPE,
277
stderr=subprocess.PIPE)
278
decrypted_plaintext, err = proc.communicate(input=data)
279
if proc.returncode != 0:
281
return decrypted_plaintext
284
# Pretend that we have an Avahi module
286
"""This isn't so much a class as it is a module-like namespace."""
287
IF_UNSPEC = -1 # avahi-common/address.h
288
PROTO_UNSPEC = -1 # avahi-common/address.h
289
PROTO_INET = 0 # avahi-common/address.h
290
PROTO_INET6 = 1 # avahi-common/address.h
291
DBUS_NAME = "org.freedesktop.Avahi"
292
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
293
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
294
DBUS_PATH_SERVER = "/"
297
def string_array_to_txt_array(t):
298
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
299
for s in t), signature="ay")
300
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
301
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
302
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
303
SERVER_INVALID = 0 # avahi-common/defs.h
304
SERVER_REGISTERING = 1 # avahi-common/defs.h
305
SERVER_RUNNING = 2 # avahi-common/defs.h
306
SERVER_COLLISION = 3 # avahi-common/defs.h
307
SERVER_FAILURE = 4 # avahi-common/defs.h
81
SO_BINDTODEVICE = None
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
88
syslogger = (logging.handlers.SysLogHandler
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
94
logger.addHandler(syslogger)
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
100
logger.addHandler(console)
310
102
class AvahiError(Exception):
311
103
def __init__(self, value, *args, **kwargs):
312
104
self.value = value
313
return super(AvahiError, self).__init__(value, *args,
105
super(AvahiError, self).__init__(value, *args, **kwargs)
106
def __unicode__(self):
107
return unicode(repr(self.value))
317
109
class AvahiServiceError(AvahiError):
321
112
class AvahiGroupError(AvahiError):
116
class AvahiService(object):
326
117
"""An Avahi (Zeroconf) service.
329
120
interface: integer; avahi.IF_UNSPEC or an interface index.
330
121
Used to optionally bind to the specified interface.
331
name: string; Example: 'Mandos'
332
type: string; Example: '_mandos._tcp'.
333
See <https://www.iana.org/assignments/service-names-port-numbers>
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
334
125
port: integer; what port to announce
335
126
TXT: list of strings; TXT record for the service
336
127
domain: string; Domain to publish on, default to .local if empty.
425
192
dbus.UInt16(self.port),
426
193
avahi.string_array_to_txt_array(self.TXT))
427
194
self.group.Commit()
429
195
def entry_group_state_changed(self, state, error):
430
196
"""Derived from the Avahi example code"""
431
logger.debug("Avahi entry group state change: %i", state)
197
logger.debug(u"Avahi entry group state change: %i", state)
433
199
if state == avahi.ENTRY_GROUP_ESTABLISHED:
434
logger.debug("Zeroconf service established.")
200
logger.debug(u"Zeroconf service established.")
435
201
elif state == avahi.ENTRY_GROUP_COLLISION:
436
logger.info("Zeroconf service name collision.")
202
logger.warning(u"Zeroconf service name collision.")
438
204
elif state == avahi.ENTRY_GROUP_FAILURE:
439
logger.critical("Avahi: Error in group state changed %s",
441
raise AvahiGroupError("State changed: {!s}".format(error))
205
logger.critical(u"Avahi: Error in group state changed %s",
207
raise AvahiGroupError(u"State changed: %s"
443
209
def cleanup(self):
444
210
"""Derived from the Avahi example code"""
445
211
if self.group is not None:
448
except (dbus.exceptions.UnknownMethodException,
449
dbus.exceptions.DBusException):
451
213
self.group = None
454
def server_state_changed(self, state, error=None):
214
def server_state_changed(self, state):
455
215
"""Derived from the Avahi example code"""
456
logger.debug("Avahi server state change: %i", state)
458
avahi.SERVER_INVALID: "Zeroconf server invalid",
459
avahi.SERVER_REGISTERING: None,
460
avahi.SERVER_COLLISION: "Zeroconf server name collision",
461
avahi.SERVER_FAILURE: "Zeroconf server failure",
463
if state in bad_states:
464
if bad_states[state] is not None:
466
logger.error(bad_states[state])
468
logger.error(bad_states[state] + ": %r", error)
216
logger.debug(u"Avahi server state change: %i", state)
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
470
220
elif state == avahi.SERVER_RUNNING:
473
except dbus.exceptions.DBusException as error:
474
if (error.get_dbus_name()
475
== "org.freedesktop.Avahi.CollisionError"):
476
logger.info("Local Zeroconf service name"
478
return self.rename(remove=False)
480
logger.critical("D-Bus Exception", exc_info=error)
485
logger.debug("Unknown state: %r", state)
487
logger.debug("Unknown state: %r: %r", state, error)
489
222
def activate(self):
490
223
"""Derived from the Avahi example code"""
491
224
if self.server is None:
492
225
self.server = dbus.Interface(
493
226
self.bus.get_object(avahi.DBUS_NAME,
494
avahi.DBUS_PATH_SERVER,
495
follow_name_owner_changes=True),
227
avahi.DBUS_PATH_SERVER),
496
228
avahi.DBUS_INTERFACE_SERVER)
497
self.server.connect_to_signal("StateChanged",
498
self.server_state_changed)
229
self.server.connect_to_signal(u"StateChanged",
230
self.server_state_changed)
499
231
self.server_state_changed(self.server.GetState())
502
class AvahiServiceToSyslog(AvahiService):
503
def rename(self, *args, **kwargs):
504
"""Add the new name to the syslog messages"""
505
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
506
syslogger.setFormatter(logging.Formatter(
507
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
512
# Pretend that we have a GnuTLS module
514
"""This isn't so much a class as it is a module-like namespace."""
516
library = ctypes.util.find_library("gnutls")
518
library = ctypes.util.find_library("gnutls-deb0")
519
_library = ctypes.cdll.LoadLibrary(library)
522
# Unless otherwise indicated, the constants and types below are
523
# all from the gnutls/gnutls.h C header file.
534
E_NO_CERTIFICATE_FOUND = -49
539
KEYID_USE_SHA256 = 1 # gnutls/x509.h
540
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
543
class session_int(ctypes.Structure):
545
session_t = ctypes.POINTER(session_int)
547
class certificate_credentials_st(ctypes.Structure):
549
certificate_credentials_t = ctypes.POINTER(
550
certificate_credentials_st)
551
certificate_type_t = ctypes.c_int
553
class datum_t(ctypes.Structure):
554
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
555
('size', ctypes.c_uint)]
557
class openpgp_crt_int(ctypes.Structure):
559
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
560
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
561
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
562
credentials_type_t = ctypes.c_int
563
transport_ptr_t = ctypes.c_void_p
564
close_request_t = ctypes.c_int
567
class Error(Exception):
568
def __init__(self, message=None, code=None, args=()):
569
# Default usage is by a message string, but if a return
570
# code is passed, convert it to a string with
573
if message is None and code is not None:
574
message = gnutls.strerror(code)
575
return super(gnutls.Error, self).__init__(
578
class CertificateSecurityError(Error):
584
self._c_object = gnutls.certificate_credentials_t()
585
gnutls.certificate_allocate_credentials(
586
ctypes.byref(self._c_object))
587
self.type = gnutls.CRD_CERTIFICATE
590
gnutls.certificate_free_credentials(self._c_object)
593
def __init__(self, socket, credentials=None):
594
self._c_object = gnutls.session_t()
595
gnutls_flags = gnutls.CLIENT
596
if gnutls.check_version(b"3.5.6"):
597
gnutls_flags |= gnutls.NO_TICKETS
599
gnutls_flags |= gnutls.ENABLE_RAWPK
600
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
602
gnutls.set_default_priority(self._c_object)
603
gnutls.transport_set_ptr(self._c_object, socket.fileno())
604
gnutls.handshake_set_private_extensions(self._c_object,
607
if credentials is None:
608
credentials = gnutls.Credentials()
609
gnutls.credentials_set(self._c_object, credentials.type,
610
ctypes.cast(credentials._c_object,
612
self.credentials = credentials
615
gnutls.deinit(self._c_object)
618
return gnutls.handshake(self._c_object)
620
def send(self, data):
624
data_len -= gnutls.record_send(self._c_object,
629
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
631
# Error handling functions
632
def _error_code(result):
633
"""A function to raise exceptions on errors, suitable
634
for the 'restype' attribute on ctypes functions"""
637
if result == gnutls.E_NO_CERTIFICATE_FOUND:
638
raise gnutls.CertificateSecurityError(code=result)
639
raise gnutls.Error(code=result)
641
def _retry_on_error(result, func, arguments):
642
"""A function to retry on some errors, suitable
643
for the 'errcheck' attribute on ctypes functions"""
645
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
646
return _error_code(result)
647
result = func(*arguments)
650
# Unless otherwise indicated, the function declarations below are
651
# all from the gnutls/gnutls.h C header file.
654
priority_set_direct = _library.gnutls_priority_set_direct
655
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
656
ctypes.POINTER(ctypes.c_char_p)]
657
priority_set_direct.restype = _error_code
659
init = _library.gnutls_init
660
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
661
init.restype = _error_code
663
set_default_priority = _library.gnutls_set_default_priority
664
set_default_priority.argtypes = [session_t]
665
set_default_priority.restype = _error_code
667
record_send = _library.gnutls_record_send
668
record_send.argtypes = [session_t, ctypes.c_void_p,
670
record_send.restype = ctypes.c_ssize_t
671
record_send.errcheck = _retry_on_error
673
certificate_allocate_credentials = (
674
_library.gnutls_certificate_allocate_credentials)
675
certificate_allocate_credentials.argtypes = [
676
ctypes.POINTER(certificate_credentials_t)]
677
certificate_allocate_credentials.restype = _error_code
679
certificate_free_credentials = (
680
_library.gnutls_certificate_free_credentials)
681
certificate_free_credentials.argtypes = [
682
certificate_credentials_t]
683
certificate_free_credentials.restype = None
685
handshake_set_private_extensions = (
686
_library.gnutls_handshake_set_private_extensions)
687
handshake_set_private_extensions.argtypes = [session_t,
689
handshake_set_private_extensions.restype = None
691
credentials_set = _library.gnutls_credentials_set
692
credentials_set.argtypes = [session_t, credentials_type_t,
694
credentials_set.restype = _error_code
696
strerror = _library.gnutls_strerror
697
strerror.argtypes = [ctypes.c_int]
698
strerror.restype = ctypes.c_char_p
700
certificate_type_get = _library.gnutls_certificate_type_get
701
certificate_type_get.argtypes = [session_t]
702
certificate_type_get.restype = _error_code
704
certificate_get_peers = _library.gnutls_certificate_get_peers
705
certificate_get_peers.argtypes = [session_t,
706
ctypes.POINTER(ctypes.c_uint)]
707
certificate_get_peers.restype = ctypes.POINTER(datum_t)
709
global_set_log_level = _library.gnutls_global_set_log_level
710
global_set_log_level.argtypes = [ctypes.c_int]
711
global_set_log_level.restype = None
713
global_set_log_function = _library.gnutls_global_set_log_function
714
global_set_log_function.argtypes = [log_func]
715
global_set_log_function.restype = None
717
deinit = _library.gnutls_deinit
718
deinit.argtypes = [session_t]
719
deinit.restype = None
721
handshake = _library.gnutls_handshake
722
handshake.argtypes = [session_t]
723
handshake.restype = _error_code
724
handshake.errcheck = _retry_on_error
726
transport_set_ptr = _library.gnutls_transport_set_ptr
727
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
728
transport_set_ptr.restype = None
730
bye = _library.gnutls_bye
731
bye.argtypes = [session_t, close_request_t]
732
bye.restype = _error_code
733
bye.errcheck = _retry_on_error
735
check_version = _library.gnutls_check_version
736
check_version.argtypes = [ctypes.c_char_p]
737
check_version.restype = ctypes.c_char_p
739
_need_version = b"3.3.0"
740
if check_version(_need_version) is None:
741
raise self.Error("Needs GnuTLS {} or later"
742
.format(_need_version))
744
_tls_rawpk_version = b"3.6.6"
745
has_rawpk = bool(check_version(_tls_rawpk_version))
749
class pubkey_st(ctypes.Structure):
751
pubkey_t = ctypes.POINTER(pubkey_st)
753
x509_crt_fmt_t = ctypes.c_int
755
# All the function declarations below are from gnutls/abstract.h
756
pubkey_init = _library.gnutls_pubkey_init
757
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
758
pubkey_init.restype = _error_code
760
pubkey_import = _library.gnutls_pubkey_import
761
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
763
pubkey_import.restype = _error_code
765
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
766
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
767
ctypes.POINTER(ctypes.c_ubyte),
768
ctypes.POINTER(ctypes.c_size_t)]
769
pubkey_get_key_id.restype = _error_code
771
pubkey_deinit = _library.gnutls_pubkey_deinit
772
pubkey_deinit.argtypes = [pubkey_t]
773
pubkey_deinit.restype = None
775
# All the function declarations below are from gnutls/openpgp.h
777
openpgp_crt_init = _library.gnutls_openpgp_crt_init
778
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
779
openpgp_crt_init.restype = _error_code
781
openpgp_crt_import = _library.gnutls_openpgp_crt_import
782
openpgp_crt_import.argtypes = [openpgp_crt_t,
783
ctypes.POINTER(datum_t),
785
openpgp_crt_import.restype = _error_code
787
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
788
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
789
ctypes.POINTER(ctypes.c_uint)]
790
openpgp_crt_verify_self.restype = _error_code
792
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
793
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
794
openpgp_crt_deinit.restype = None
796
openpgp_crt_get_fingerprint = (
797
_library.gnutls_openpgp_crt_get_fingerprint)
798
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
802
openpgp_crt_get_fingerprint.restype = _error_code
804
if check_version(b"3.6.4"):
805
certificate_type_get2 = _library.gnutls_certificate_type_get2
806
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
807
certificate_type_get2.restype = _error_code
809
# Remove non-public functions
810
del _error_code, _retry_on_error
813
def call_pipe(connection, # : multiprocessing.Connection
814
func, *args, **kwargs):
815
"""This function is meant to be called by multiprocessing.Process
817
This function runs func(*args, **kwargs), and writes the resulting
818
return value on the provided multiprocessing.Connection.
820
connection.send(func(*args, **kwargs))
234
class Client(object):
825
235
"""A representation of a client host served by this server.
828
approved: bool(); 'None' if not yet approved/disapproved
829
approval_delay: datetime.timedelta(); Time to wait for approval
830
approval_duration: datetime.timedelta(); Duration of one approval
831
checker: multiprocessing.Process(); a running checker process used
832
to see if the client lives. 'None' if no process is
834
checker_callback_tag: a GLib event source tag, or None
835
checker_command: string; External command which is run to check
836
if client lives. %() expansions are done at
837
runtime with vars(self) as dict, so that for
838
instance %(name)s can be used in the command.
839
checker_initiator_tag: a GLib event source tag, or None
238
name: string; from the config file, used in log messages and
240
fingerprint: string (40 or 32 hexadecimal digits); used to
241
uniquely identify the client
242
secret: bytestring; sent verbatim (over TLS) to client
243
host: string; available for use by the checker command
840
244
created: datetime.datetime(); (UTC) object creation
841
client_structure: Object describing what attributes a client has
842
and is used for storing the client at exit
843
current_checker_command: string; current running checker_command
844
disable_initiator_tag: a GLib event source tag, or None
245
last_enabled: datetime.datetime(); (UTC)
846
fingerprint: string (40 or 32 hexadecimal digits); used to
847
uniquely identify an OpenPGP client
848
key_id: string (64 hexadecimal digits); used to uniquely identify
849
a client using raw public keys
850
host: string; available for use by the checker command
851
interval: datetime.timedelta(); How often to start a new checker
852
last_approval_request: datetime.datetime(); (UTC) or None
853
247
last_checked_ok: datetime.datetime(); (UTC) or None
854
last_checker_status: integer between 0 and 255 reflecting exit
855
status of last checker. -1 reflects crashed
856
checker, -2 means no checker completed yet.
857
last_checker_signal: The signal which killed the last checker, if
858
last_checker_status is -1
859
last_enabled: datetime.datetime(); (UTC) or None
860
name: string; from the config file, used in log messages and
862
secret: bytestring; sent verbatim (over TLS) to client
863
248
timeout: datetime.timedelta(); How long from last_checked_ok
864
249
until this client is disabled
865
extended_timeout: extra long timeout when secret has been sent
866
runtime_expansions: Allowed attributes for runtime expansion.
867
expires: datetime.datetime(); time (UTC) when a client will be
869
server_settings: The server_settings dict from main()
250
interval: datetime.timedelta(); How often to start a new checker
251
disable_hook: If set, called by disable() as disable_hook(self)
252
checker: subprocess.Popen(); a running checker process used
253
to see if the client lives.
254
'None' if no process is running.
255
checker_initiator_tag: a gobject event source tag, or None
256
disable_initiator_tag: - '' -
257
checker_callback_tag: - '' -
258
checker_command: string; External command which is run to check if
259
client lives. %() expansions are done at
260
runtime with vars(self) as dict, so that for
261
instance %(name)s can be used in the command.
262
current_checker_command: string; current running checker_command
263
approved_delay: datetime.timedelta(); Time to wait for approval
264
_approved: bool(); 'None' if not yet approved/disapproved
265
approved_duration: datetime.timedelta(); Duration of one approval
872
runtime_expansions = ("approval_delay", "approval_duration",
873
"created", "enabled", "expires", "key_id",
874
"fingerprint", "host", "interval",
875
"last_approval_request", "last_checked_ok",
876
"last_enabled", "name", "timeout")
879
"extended_timeout": "PT15M",
881
"checker": "fping -q -- %%(host)s",
883
"approval_delay": "PT0S",
884
"approval_duration": "PT1S",
885
"approved_by_default": "True",
890
def config_parser(config):
891
"""Construct a new dict of client settings of this form:
892
{ client_name: {setting_name: value, ...}, ...}
893
with exceptions for any special settings as defined above.
894
NOTE: Must be a pure function. Must return the same result
895
value given the same arguments.
898
for client_name in config.sections():
899
section = dict(config.items(client_name))
900
client = settings[client_name] = {}
902
client["host"] = section["host"]
903
# Reformat values from string types to Python types
904
client["approved_by_default"] = config.getboolean(
905
client_name, "approved_by_default")
906
client["enabled"] = config.getboolean(client_name,
909
# Uppercase and remove spaces from key_id and fingerprint
910
# for later comparison purposes with return value from the
911
# key_id() and fingerprint() functions
912
client["key_id"] = (section.get("key_id", "").upper()
914
client["fingerprint"] = (section["fingerprint"].upper()
916
if "secret" in section:
917
client["secret"] = codecs.decode(section["secret"]
920
elif "secfile" in section:
921
with open(os.path.expanduser(os.path.expandvars
922
(section["secfile"])),
924
client["secret"] = secfile.read()
926
raise TypeError("No secret or secfile for section {}"
928
client["timeout"] = string_to_delta(section["timeout"])
929
client["extended_timeout"] = string_to_delta(
930
section["extended_timeout"])
931
client["interval"] = string_to_delta(section["interval"])
932
client["approval_delay"] = string_to_delta(
933
section["approval_delay"])
934
client["approval_duration"] = string_to_delta(
935
section["approval_duration"])
936
client["checker_command"] = section["checker"]
937
client["last_approval_request"] = None
938
client["last_checked_ok"] = None
939
client["last_checker_status"] = -2
943
def __init__(self, settings, name=None, server_settings=None):
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
275
def timeout_milliseconds(self):
276
"Return the 'timeout' attribute in milliseconds"
277
return self._timedelta_to_milliseconds(self.timeout)
279
def interval_milliseconds(self):
280
"Return the 'interval' attribute in milliseconds"
281
return self._timedelta_to_milliseconds(self.interval)
283
def approved_delay_milliseconds(self):
284
return self._timedelta_to_milliseconds(self.approved_delay)
286
def __init__(self, name = None, disable_hook=None, config=None):
287
"""Note: the 'checker' key in 'config' sets the
288
'checker_command' attribute and *not* the 'checker'
945
if server_settings is None:
947
self.server_settings = server_settings
948
# adding all client settings
949
for setting, value in settings.items():
950
setattr(self, setting, value)
953
if not hasattr(self, "last_enabled"):
954
self.last_enabled = datetime.datetime.utcnow()
955
if not hasattr(self, "expires"):
956
self.expires = (datetime.datetime.utcnow()
293
logger.debug(u"Creating client %r", self.name)
294
# Uppercase and remove spaces from fingerprint for later
295
# comparison purposes with return value from the fingerprint()
297
self.fingerprint = (config[u"fingerprint"].upper()
299
logger.debug(u" Fingerprint: %s", self.fingerprint)
300
if u"secret" in config:
301
self.secret = config[u"secret"].decode(u"base64")
302
elif u"secfile" in config:
303
with open(os.path.expanduser(os.path.expandvars
304
(config[u"secfile"])),
306
self.secret = secfile.read()
959
self.last_enabled = None
962
logger.debug("Creating client %r", self.name)
963
logger.debug(" Key ID: %s", self.key_id)
964
logger.debug(" Fingerprint: %s", self.fingerprint)
965
self.created = settings.get("created",
966
datetime.datetime.utcnow())
968
# attributes specific for this server instance
308
raise TypeError(u"No secret or secfile for client %s"
310
self.host = config.get(u"host", u"")
311
self.created = datetime.datetime.utcnow()
313
self.last_enabled = None
314
self.last_checked_ok = None
315
self.timeout = string_to_delta(config[u"timeout"])
316
self.interval = string_to_delta(config[u"interval"])
317
self.disable_hook = disable_hook
969
318
self.checker = None
970
319
self.checker_initiator_tag = None
971
320
self.disable_initiator_tag = None
972
321
self.checker_callback_tag = None
322
self.checker_command = config[u"checker"]
973
323
self.current_checker_command = None
324
self.last_connect = None
325
self._approved = None
326
self.approved_by_default = config.get(u"approved_by_default",
975
328
self.approvals_pending = 0
976
self.changedstate = multiprocessing_manager.Condition(
977
multiprocessing_manager.Lock())
978
self.client_structure = [attr
979
for attr in self.__dict__.keys()
980
if not attr.startswith("_")]
981
self.client_structure.append("client_structure")
983
for name, t in inspect.getmembers(
984
type(self), lambda obj: isinstance(obj, property)):
985
if not name.startswith("_"):
986
self.client_structure.append(name)
988
# Send notice to process children that client state has changed
329
self.approved_delay = string_to_delta(
330
config[u"approved_delay"])
331
self.approved_duration = string_to_delta(
332
config[u"approved_duration"])
333
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
989
335
def send_changedstate(self):
990
with self.changedstate:
991
self.changedstate.notify_all()
336
self.changedstate.acquire()
337
self.changedstate.notify_all()
338
self.changedstate.release()
993
340
def enable(self):
994
341
"""Start this client's checker and timeout hooks"""
995
if getattr(self, "enabled", False):
342
if getattr(self, u"enabled", False):
996
343
# Already enabled
998
self.expires = datetime.datetime.utcnow() + self.timeout
345
self.send_changedstate()
1000
346
self.last_enabled = datetime.datetime.utcnow()
1002
self.send_changedstate()
347
# Schedule a new checker to be started an 'interval' from now,
348
# and every interval from then on.
349
self.checker_initiator_tag = (gobject.timeout_add
350
(self.interval_milliseconds(),
352
# Schedule a disable() when 'timeout' has passed
353
self.disable_initiator_tag = (gobject.timeout_add
354
(self.timeout_milliseconds(),
357
# Also start a new checker *right now*.
1004
360
def disable(self, quiet=True):
1005
361
"""Disable this client."""
1006
362
if not getattr(self, "enabled", False):
1009
logger.info("Disabling client %s", self.name)
1010
if getattr(self, "disable_initiator_tag", None) is not None:
1011
GLib.source_remove(self.disable_initiator_tag)
365
self.send_changedstate()
367
logger.info(u"Disabling client %s", self.name)
368
if getattr(self, u"disable_initiator_tag", False):
369
gobject.source_remove(self.disable_initiator_tag)
1012
370
self.disable_initiator_tag = None
1014
if getattr(self, "checker_initiator_tag", None) is not None:
1015
GLib.source_remove(self.checker_initiator_tag)
371
if getattr(self, u"checker_initiator_tag", False):
372
gobject.source_remove(self.checker_initiator_tag)
1016
373
self.checker_initiator_tag = None
1017
374
self.stop_checker()
375
if self.disable_hook:
376
self.disable_hook(self)
1018
377
self.enabled = False
1020
self.send_changedstate()
1021
# Do not run this again if called by a GLib.timeout_add
378
# Do not run this again if called by a gobject.timeout_add
1024
381
def __del__(self):
382
self.disable_hook = None
1027
def init_checker(self):
1028
# Schedule a new checker to be started an 'interval' from now,
1029
# and every interval from then on.
1030
if self.checker_initiator_tag is not None:
1031
GLib.source_remove(self.checker_initiator_tag)
1032
self.checker_initiator_tag = GLib.timeout_add(
1033
int(self.interval.total_seconds() * 1000),
1035
# Schedule a disable() when 'timeout' has passed
1036
if self.disable_initiator_tag is not None:
1037
GLib.source_remove(self.disable_initiator_tag)
1038
self.disable_initiator_tag = GLib.timeout_add(
1039
int(self.timeout.total_seconds() * 1000), self.disable)
1040
# Also start a new checker *right now*.
1041
self.start_checker()
1043
def checker_callback(self, source, condition, connection,
385
def checker_callback(self, pid, condition, command):
1045
386
"""The checker has completed, so take appropriate actions."""
1046
# Read return code from connection (see call_pipe)
1047
returncode = connection.recv()
1050
387
self.checker_callback_tag = None
1051
388
self.checker = None
1054
self.last_checker_status = returncode
1055
self.last_checker_signal = None
1056
if self.last_checker_status == 0:
1057
logger.info("Checker for %(name)s succeeded",
389
if os.WIFEXITED(condition):
390
exitstatus = os.WEXITSTATUS(condition)
392
logger.info(u"Checker for %(name)s succeeded",
1059
394
self.checked_ok()
1061
logger.info("Checker for %(name)s failed", vars(self))
396
logger.info(u"Checker for %(name)s failed",
1063
self.last_checker_status = -1
1064
self.last_checker_signal = -returncode
1065
logger.warning("Checker for %(name)s crashed?",
399
logger.warning(u"Checker for %(name)s crashed?",
1069
402
def checked_ok(self):
1070
"""Assert that the client has been seen, alive and well."""
403
"""Bump up the timeout for this client.
405
This should only be called when the client has been seen,
1071
408
self.last_checked_ok = datetime.datetime.utcnow()
1072
self.last_checker_status = 0
1073
self.last_checker_signal = None
1076
def bump_timeout(self, timeout=None):
1077
"""Bump up the timeout for this client."""
1079
timeout = self.timeout
1080
if self.disable_initiator_tag is not None:
1081
GLib.source_remove(self.disable_initiator_tag)
1082
self.disable_initiator_tag = None
1083
if getattr(self, "enabled", False):
1084
self.disable_initiator_tag = GLib.timeout_add(
1085
int(timeout.total_seconds() * 1000), self.disable)
1086
self.expires = datetime.datetime.utcnow() + timeout
1088
def need_approval(self):
1089
self.last_approval_request = datetime.datetime.utcnow()
409
gobject.source_remove(self.disable_initiator_tag)
410
self.disable_initiator_tag = (gobject.timeout_add
411
(self.timeout_milliseconds(),
1091
414
def start_checker(self):
1092
415
"""Start a new checker subprocess if one is not running.
1094
417
If a checker already exists, leave it running and do
1096
419
# The reason for not killing a running checker is that if we
1097
# did that, and if a checker (for some reason) started running
1098
# slowly and taking more than 'interval' time, then the client
1099
# would inevitably timeout, since no checker would get a
1100
# chance to run to completion. If we instead leave running
420
# did that, then if a checker (for some reason) started
421
# running slowly and taking more than 'interval' time, the
422
# client would inevitably timeout, since no checker would get
423
# a chance to run to completion. If we instead leave running
1101
424
# checkers alone, the checker would have to take more time
1102
425
# than 'timeout' for the client to be disabled, which is as it
1105
if self.checker is not None and not self.checker.is_alive():
1106
logger.warning("Checker was not alive; joining")
428
# If a checker exists, make sure it is not a zombie
430
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
431
except (AttributeError, OSError), error:
432
if (isinstance(error, OSError)
433
and error.errno != errno.ECHILD):
437
logger.warning(u"Checker was a zombie")
438
gobject.source_remove(self.checker_callback_tag)
439
self.checker_callback(pid, status,
440
self.current_checker_command)
1109
441
# Start a new checker if needed
1110
442
if self.checker is None:
1111
# Escape attributes for the shell
1113
attr: re.escape(str(getattr(self, attr)))
1114
for attr in self.runtime_expansions}
1116
command = self.checker_command % escaped_attrs
1117
except TypeError as error:
1118
logger.error('Could not format string "%s"',
1119
self.checker_command,
1121
return True # Try again later
444
# In case checker_command has exactly one % operator
445
command = self.checker_command % self.host
447
# Escape attributes for the shell
448
escaped_attrs = dict((key,
449
re.escape(unicode(str(val),
453
vars(self).iteritems())
455
command = self.checker_command % escaped_attrs
456
except TypeError, error:
457
logger.error(u'Could not format string "%s":'
458
u' %s', self.checker_command, error)
459
return True # Try again later
1122
460
self.current_checker_command = command
1123
logger.info("Starting checker %r for %s", command,
1125
# We don't need to redirect stdout and stderr, since
1126
# in normal mode, that is already done by daemon(),
1127
# and in debug mode we don't want to. (Stdin is
1128
# always replaced by /dev/null.)
1129
# The exception is when not debugging but nevertheless
1130
# running in the foreground; use the previously
1132
popen_args = {"close_fds": True,
1135
if (not self.server_settings["debug"]
1136
and self.server_settings["foreground"]):
1137
popen_args.update({"stdout": wnull,
1139
pipe = multiprocessing.Pipe(duplex=False)
1140
self.checker = multiprocessing.Process(
1142
args=(pipe[1], subprocess.call, command),
1144
self.checker.start()
1145
self.checker_callback_tag = GLib.io_add_watch(
1146
pipe[0].fileno(), GLib.IO_IN,
1147
self.checker_callback, pipe[0], command)
1148
# Re-run this periodically if run by GLib.timeout_add
462
logger.info(u"Starting checker %r for %s",
464
# We don't need to redirect stdout and stderr, since
465
# in normal mode, that is already done by daemon(),
466
# and in debug mode we don't want to. (Stdin is
467
# always replaced by /dev/null.)
468
self.checker = subprocess.Popen(command,
470
shell=True, cwd=u"/")
471
self.checker_callback_tag = (gobject.child_watch_add
473
self.checker_callback,
475
# The checker may have completed before the gobject
476
# watch was added. Check for this.
477
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
479
gobject.source_remove(self.checker_callback_tag)
480
self.checker_callback(pid, status, command)
481
except OSError, error:
482
logger.error(u"Failed to start subprocess: %s",
484
# Re-run this periodically if run by gobject.timeout_add
1151
487
def stop_checker(self):
1152
488
"""Force the checker process, if any, to stop."""
1153
489
if self.checker_callback_tag:
1154
GLib.source_remove(self.checker_callback_tag)
490
gobject.source_remove(self.checker_callback_tag)
1155
491
self.checker_callback_tag = None
1156
if getattr(self, "checker", None) is None:
492
if getattr(self, u"checker", None) is None:
1158
logger.debug("Stopping checker for %(name)s", vars(self))
1159
self.checker.terminate()
494
logger.debug(u"Stopping checker for %(name)s", vars(self))
496
os.kill(self.checker.pid, signal.SIGTERM)
498
#if self.checker.poll() is None:
499
# os.kill(self.checker.pid, signal.SIGKILL)
500
except OSError, error:
501
if error.errno != errno.ESRCH: # No such process
1160
503
self.checker = None
1163
def dbus_service_property(dbus_interface,
505
def dbus_service_property(dbus_interface, signature=u"v",
506
access=u"readwrite", byte_arrays=False):
1167
507
"""Decorators for marking methods of a DBusObjectWithProperties to
1168
508
become properties on the D-Bus.
1170
510
The decorated method will be called with no arguments by "Get"
1171
511
and with one argument by "Set".
1173
513
The parameters, where they are supported, are the same as
1174
514
dbus.service.method, except there is only "signature", since the
1175
515
type from Get() and the type sent to Set() is the same.
1177
517
# Encoding deeply encoded byte arrays is not supported yet by the
1178
518
# "Set" method, so we fail early here:
1179
if byte_arrays and signature != "ay":
1180
raise ValueError("Byte arrays not supported for non-'ay'"
1181
" signature {!r}".format(signature))
519
if byte_arrays and signature != u"ay":
520
raise ValueError(u"Byte arrays not supported for non-'ay'"
521
u" signature %r" % signature)
1183
522
def decorator(func):
1184
523
func._dbus_is_property = True
1185
524
func._dbus_interface = dbus_interface
1186
525
func._dbus_signature = signature
1187
526
func._dbus_access = access
1188
527
func._dbus_name = func.__name__
1189
if func._dbus_name.endswith("_dbus_property"):
528
if func._dbus_name.endswith(u"_dbus_property"):
1190
529
func._dbus_name = func._dbus_name[:-14]
1191
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1197
def dbus_interface_annotations(dbus_interface):
1198
"""Decorator for marking functions returning interface annotations
1202
@dbus_interface_annotations("org.example.Interface")
1203
def _foo(self): # Function name does not matter
1204
return {"org.freedesktop.DBus.Deprecated": "true",
1205
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1209
def decorator(func):
1210
func._dbus_is_interface = True
1211
func._dbus_interface = dbus_interface
1212
func._dbus_name = dbus_interface
1218
def dbus_annotations(annotations):
1219
"""Decorator to annotate D-Bus methods, signals or properties
1222
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1223
"org.freedesktop.DBus.Property."
1224
"EmitsChangedSignal": "false"})
1225
@dbus_service_property("org.example.Interface", signature="b",
1227
def Property_dbus_property(self):
1228
return dbus.Boolean(False)
1230
See also the DBusObjectWithAnnotations class.
1233
def decorator(func):
1234
func._dbus_annotations = annotations
530
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1237
532
return decorator
1240
535
class DBusPropertyException(dbus.exceptions.DBusException):
1241
536
"""A base class for D-Bus property-related exceptions
538
def __unicode__(self):
539
return unicode(str(self))
1246
542
class DBusPropertyAccessException(DBusPropertyException):
1258
class DBusObjectWithAnnotations(dbus.service.Object):
1259
"""A D-Bus object with annotations.
1261
Classes inheriting from this can use the dbus_annotations
1262
decorator to add annotations to methods or signals.
1266
def _is_dbus_thing(thing):
1267
"""Returns a function testing if an attribute is a D-Bus thing
1269
If called like _is_dbus_thing("method") it returns a function
1270
suitable for use as predicate to inspect.getmembers().
1272
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1275
def _get_all_dbus_things(self, thing):
1276
"""Returns a generator of (name, attribute) pairs
1278
return ((getattr(athing.__get__(self), "_dbus_name", name),
1279
athing.__get__(self))
1280
for cls in self.__class__.__mro__
1282
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1284
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1286
path_keyword='object_path',
1287
connection_keyword='connection')
1288
def Introspect(self, object_path, connection):
1289
"""Overloading of standard D-Bus method.
1291
Inserts annotation tags on methods and signals.
1293
xmlstring = dbus.service.Object.Introspect(self, object_path,
1296
document = xml.dom.minidom.parseString(xmlstring)
1298
for if_tag in document.getElementsByTagName("interface"):
1299
# Add annotation tags
1300
for typ in ("method", "signal"):
1301
for tag in if_tag.getElementsByTagName(typ):
1303
for name, prop in (self.
1304
_get_all_dbus_things(typ)):
1305
if (name == tag.getAttribute("name")
1306
and prop._dbus_interface
1307
== if_tag.getAttribute("name")):
1308
annots.update(getattr(
1309
prop, "_dbus_annotations", {}))
1310
for name, value in annots.items():
1311
ann_tag = document.createElement(
1313
ann_tag.setAttribute("name", name)
1314
ann_tag.setAttribute("value", value)
1315
tag.appendChild(ann_tag)
1316
# Add interface annotation tags
1317
for annotation, value in dict(
1318
itertools.chain.from_iterable(
1319
annotations().items()
1320
for name, annotations
1321
in self._get_all_dbus_things("interface")
1322
if name == if_tag.getAttribute("name")
1324
ann_tag = document.createElement("annotation")
1325
ann_tag.setAttribute("name", annotation)
1326
ann_tag.setAttribute("value", value)
1327
if_tag.appendChild(ann_tag)
1328
# Fix argument name for the Introspect method itself
1329
if (if_tag.getAttribute("name")
1330
== dbus.INTROSPECTABLE_IFACE):
1331
for cn in if_tag.getElementsByTagName("method"):
1332
if cn.getAttribute("name") == "Introspect":
1333
for arg in cn.getElementsByTagName("arg"):
1334
if (arg.getAttribute("direction")
1336
arg.setAttribute("name",
1338
xmlstring = document.toxml("utf-8")
1340
except (AttributeError, xml.dom.DOMException,
1341
xml.parsers.expat.ExpatError) as error:
1342
logger.error("Failed to override Introspection method",
1347
class DBusObjectWithProperties(DBusObjectWithAnnotations):
554
class DBusObjectWithProperties(dbus.service.Object):
1348
555
"""A D-Bus object with properties.
1350
557
Classes inheriting from this can use the dbus_service_property
1351
558
decorator to expose methods as D-Bus properties. It exposes the
1352
559
standard Get(), Set(), and GetAll() methods on the D-Bus.
563
def _is_dbus_property(obj):
564
return getattr(obj, u"_dbus_is_property", False)
566
def _get_all_dbus_properties(self):
567
"""Returns a generator of (name, attribute) pairs
569
return ((prop._dbus_name, prop)
571
inspect.getmembers(self, self._is_dbus_property))
1355
573
def _get_dbus_property(self, interface_name, property_name):
1356
574
"""Returns a bound method if one exists which is a D-Bus
1357
575
property with the specified name and interface.
1359
for cls in self.__class__.__mro__:
1360
for name, value in inspect.getmembers(
1361
cls, self._is_dbus_thing("property")):
1362
if (value._dbus_name == property_name
1363
and value._dbus_interface == interface_name):
1364
return value.__get__(self)
577
for name in (property_name,
578
property_name + u"_dbus_property"):
579
prop = getattr(self, name, None)
581
or not self._is_dbus_property(prop)
582
or prop._dbus_name != property_name
583
or (interface_name and prop._dbus_interface
584
and interface_name != prop._dbus_interface)):
1366
587
# No such property
1367
raise DBusPropertyNotFound("{}:{}.{}".format(
1368
self.dbus_object_path, interface_name, property_name))
1371
def _get_all_interface_names(cls):
1372
"""Get a sequence of all interfaces supported by an object"""
1373
return (name for name in set(getattr(getattr(x, attr),
1374
"_dbus_interface", None)
1375
for x in (inspect.getmro(cls))
1377
if name is not None)
1379
@dbus.service.method(dbus.PROPERTIES_IFACE,
588
raise DBusPropertyNotFound(self.dbus_object_path + u":"
589
+ interface_name + u"."
592
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1382
594
def Get(self, interface_name, property_name):
1383
595
"""Standard D-Bus property Get() method, see D-Bus standard.
1385
597
prop = self._get_dbus_property(interface_name, property_name)
1386
if prop._dbus_access == "write":
598
if prop._dbus_access == u"write":
1387
599
raise DBusPropertyAccessException(property_name)
1389
if not hasattr(value, "variant_level"):
601
if not hasattr(value, u"variant_level"):
1391
603
return type(value)(value, variant_level=value.variant_level+1)
1393
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1394
606
def Set(self, interface_name, property_name, value):
1395
607
"""Standard D-Bus property Set() method, see D-Bus standard.
1397
609
prop = self._get_dbus_property(interface_name, property_name)
1398
if prop._dbus_access == "read":
610
if prop._dbus_access == u"read":
1399
611
raise DBusPropertyAccessException(property_name)
1400
if prop._dbus_get_args_options["byte_arrays"]:
612
if prop._dbus_get_args_options[u"byte_arrays"]:
1401
613
# The byte_arrays option is not supported yet on
1402
614
# signatures other than "ay".
1403
if prop._dbus_signature != "ay":
1404
raise ValueError("Byte arrays not supported for non-"
1405
"'ay' signature {!r}"
1406
.format(prop._dbus_signature))
1407
value = dbus.ByteArray(b''.join(chr(byte)
615
if prop._dbus_signature != u"ay":
617
value = dbus.ByteArray(''.join(unichr(byte)
1411
@dbus.service.method(dbus.PROPERTIES_IFACE,
1413
out_signature="a{sv}")
621
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
622
out_signature=u"a{sv}")
1414
623
def GetAll(self, interface_name):
1415
624
"""Standard D-Bus property GetAll() method, see D-Bus
1418
627
Note: Will not include properties with access="write".
1421
for name, prop in self._get_all_dbus_things("property"):
630
for name, prop in self._get_all_dbus_properties():
1422
631
if (interface_name
1423
632
and interface_name != prop._dbus_interface):
1424
633
# Interface non-empty but did not match
1426
635
# Ignore write-only properties
1427
if prop._dbus_access == "write":
636
if prop._dbus_access == u"write":
1430
if not hasattr(value, "variant_level"):
1431
properties[name] = value
639
if not hasattr(value, u"variant_level"):
1433
properties[name] = type(value)(
1434
value, variant_level=value.variant_level + 1)
1435
return dbus.Dictionary(properties, signature="sv")
1437
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1438
def PropertiesChanged(self, interface_name, changed_properties,
1439
invalidated_properties):
1440
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
642
all[name] = type(value)(value, variant_level=
643
value.variant_level+1)
644
return dbus.Dictionary(all, signature=u"sv")
1445
646
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1447
648
path_keyword='object_path',
1448
649
connection_keyword='connection')
1449
650
def Introspect(self, object_path, connection):
1450
"""Overloading of standard D-Bus method.
1452
Inserts property tags and interface annotation tags.
651
"""Standard D-Bus method, overloaded to insert property tags.
1454
xmlstring = DBusObjectWithAnnotations.Introspect(self,
653
xmlstring = dbus.service.Object.Introspect(self, object_path,
1458
656
document = xml.dom.minidom.parseString(xmlstring)
1460
657
def make_tag(document, name, prop):
1461
e = document.createElement("property")
1462
e.setAttribute("name", name)
1463
e.setAttribute("type", prop._dbus_signature)
1464
e.setAttribute("access", prop._dbus_access)
658
e = document.createElement(u"property")
659
e.setAttribute(u"name", name)
660
e.setAttribute(u"type", prop._dbus_signature)
661
e.setAttribute(u"access", prop._dbus_access)
1467
for if_tag in document.getElementsByTagName("interface"):
663
for if_tag in document.getElementsByTagName(u"interface"):
1469
664
for tag in (make_tag(document, name, prop)
1471
in self._get_all_dbus_things("property")
666
in self._get_all_dbus_properties()
1472
667
if prop._dbus_interface
1473
== if_tag.getAttribute("name")):
668
== if_tag.getAttribute(u"name")):
1474
669
if_tag.appendChild(tag)
1475
# Add annotation tags for properties
1476
for tag in if_tag.getElementsByTagName("property"):
1478
for name, prop in self._get_all_dbus_things(
1480
if (name == tag.getAttribute("name")
1481
and prop._dbus_interface
1482
== if_tag.getAttribute("name")):
1483
annots.update(getattr(
1484
prop, "_dbus_annotations", {}))
1485
for name, value in annots.items():
1486
ann_tag = document.createElement(
1488
ann_tag.setAttribute("name", name)
1489
ann_tag.setAttribute("value", value)
1490
tag.appendChild(ann_tag)
1491
670
# Add the names to the return values for the
1492
671
# "org.freedesktop.DBus.Properties" methods
1493
if (if_tag.getAttribute("name")
1494
== "org.freedesktop.DBus.Properties"):
1495
for cn in if_tag.getElementsByTagName("method"):
1496
if cn.getAttribute("name") == "Get":
1497
for arg in cn.getElementsByTagName("arg"):
1498
if (arg.getAttribute("direction")
1500
arg.setAttribute("name", "value")
1501
elif cn.getAttribute("name") == "GetAll":
1502
for arg in cn.getElementsByTagName("arg"):
1503
if (arg.getAttribute("direction")
1505
arg.setAttribute("name", "props")
1506
xmlstring = document.toxml("utf-8")
1508
except (AttributeError, xml.dom.DOMException,
1509
xml.parsers.expat.ExpatError) as error:
1510
logger.error("Failed to override Introspection method",
1516
dbus.OBJECT_MANAGER_IFACE
1517
except AttributeError:
1518
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1521
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1522
"""A D-Bus object with an ObjectManager.
1524
Classes inheriting from this exposes the standard
1525
GetManagedObjects call and the InterfacesAdded and
1526
InterfacesRemoved signals on the standard
1527
"org.freedesktop.DBus.ObjectManager" interface.
1529
Note: No signals are sent automatically; they must be sent
1532
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1533
out_signature="a{oa{sa{sv}}}")
1534
def GetManagedObjects(self):
1535
"""This function must be overridden"""
1536
raise NotImplementedError()
1538
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1539
signature="oa{sa{sv}}")
1540
def InterfacesAdded(self, object_path, interfaces_and_properties):
1543
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1544
def InterfacesRemoved(self, object_path, interfaces):
1547
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1549
path_keyword='object_path',
1550
connection_keyword='connection')
1551
def Introspect(self, object_path, connection):
1552
"""Overloading of standard D-Bus method.
1554
Override return argument name of GetManagedObjects to be
1555
"objpath_interfaces_and_properties"
1557
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1561
document = xml.dom.minidom.parseString(xmlstring)
1563
for if_tag in document.getElementsByTagName("interface"):
1564
# Fix argument name for the GetManagedObjects method
1565
if (if_tag.getAttribute("name")
1566
== dbus.OBJECT_MANAGER_IFACE):
1567
for cn in if_tag.getElementsByTagName("method"):
1568
if (cn.getAttribute("name")
1569
== "GetManagedObjects"):
1570
for arg in cn.getElementsByTagName("arg"):
1571
if (arg.getAttribute("direction")
1575
"objpath_interfaces"
1577
xmlstring = document.toxml("utf-8")
1579
except (AttributeError, xml.dom.DOMException,
1580
xml.parsers.expat.ExpatError) as error:
1581
logger.error("Failed to override Introspection method",
1586
def datetime_to_dbus(dt, variant_level=0):
1587
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1589
return dbus.String("", variant_level=variant_level)
1590
return dbus.String(dt.isoformat(), variant_level=variant_level)
1593
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1594
"""A class decorator; applied to a subclass of
1595
dbus.service.Object, it will add alternate D-Bus attributes with
1596
interface names according to the "alt_interface_names" mapping.
1599
@alternate_dbus_interfaces({"org.example.Interface":
1600
"net.example.AlternateInterface"})
1601
class SampleDBusObject(dbus.service.Object):
1602
@dbus.service.method("org.example.Interface")
1603
def SampleDBusMethod():
1606
The above "SampleDBusMethod" on "SampleDBusObject" will be
1607
reachable via two interfaces: "org.example.Interface" and
1608
"net.example.AlternateInterface", the latter of which will have
1609
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1610
"true", unless "deprecate" is passed with a False value.
1612
This works for methods and signals, and also for D-Bus properties
1613
(from DBusObjectWithProperties) and interfaces (from the
1614
dbus_interface_annotations decorator).
1618
for orig_interface_name, alt_interface_name in (
1619
alt_interface_names.items()):
1621
interface_names = set()
1622
# Go though all attributes of the class
1623
for attrname, attribute in inspect.getmembers(cls):
1624
# Ignore non-D-Bus attributes, and D-Bus attributes
1625
# with the wrong interface name
1626
if (not hasattr(attribute, "_dbus_interface")
1627
or not attribute._dbus_interface.startswith(
1628
orig_interface_name)):
1630
# Create an alternate D-Bus interface name based on
1632
alt_interface = attribute._dbus_interface.replace(
1633
orig_interface_name, alt_interface_name)
1634
interface_names.add(alt_interface)
1635
# Is this a D-Bus signal?
1636
if getattr(attribute, "_dbus_is_signal", False):
1637
# Extract the original non-method undecorated
1638
# function by black magic
1639
if sys.version_info.major == 2:
1640
nonmethod_func = (dict(
1641
zip(attribute.func_code.co_freevars,
1642
attribute.__closure__))
1643
["func"].cell_contents)
1645
nonmethod_func = (dict(
1646
zip(attribute.__code__.co_freevars,
1647
attribute.__closure__))
1648
["func"].cell_contents)
1649
# Create a new, but exactly alike, function
1650
# object, and decorate it to be a new D-Bus signal
1651
# with the alternate D-Bus interface name
1652
new_function = copy_function(nonmethod_func)
1653
new_function = (dbus.service.signal(
1655
attribute._dbus_signature)(new_function))
1656
# Copy annotations, if any
1658
new_function._dbus_annotations = dict(
1659
attribute._dbus_annotations)
1660
except AttributeError:
1663
# Define a creator of a function to call both the
1664
# original and alternate functions, so both the
1665
# original and alternate signals gets sent when
1666
# the function is called
1667
def fixscope(func1, func2):
1668
"""This function is a scope container to pass
1669
func1 and func2 to the "call_both" function
1670
outside of its arguments"""
1672
@functools.wraps(func2)
1673
def call_both(*args, **kwargs):
1674
"""This function will emit two D-Bus
1675
signals by calling func1 and func2"""
1676
func1(*args, **kwargs)
1677
func2(*args, **kwargs)
1678
# Make wrapper function look like a D-Bus
1680
for name, attr in inspect.getmembers(func2):
1681
if name.startswith("_dbus_"):
1682
setattr(call_both, name, attr)
1685
# Create the "call_both" function and add it to
1687
attr[attrname] = fixscope(attribute, new_function)
1688
# Is this a D-Bus method?
1689
elif getattr(attribute, "_dbus_is_method", False):
1690
# Create a new, but exactly alike, function
1691
# object. Decorate it to be a new D-Bus method
1692
# with the alternate D-Bus interface name. Add it
1695
dbus.service.method(
1697
attribute._dbus_in_signature,
1698
attribute._dbus_out_signature)
1699
(copy_function(attribute)))
1700
# Copy annotations, if any
1702
attr[attrname]._dbus_annotations = dict(
1703
attribute._dbus_annotations)
1704
except AttributeError:
1706
# Is this a D-Bus property?
1707
elif getattr(attribute, "_dbus_is_property", False):
1708
# Create a new, but exactly alike, function
1709
# object, and decorate it to be a new D-Bus
1710
# property with the alternate D-Bus interface
1711
# name. Add it to the class.
1712
attr[attrname] = (dbus_service_property(
1713
alt_interface, attribute._dbus_signature,
1714
attribute._dbus_access,
1715
attribute._dbus_get_args_options
1717
(copy_function(attribute)))
1718
# Copy annotations, if any
1720
attr[attrname]._dbus_annotations = dict(
1721
attribute._dbus_annotations)
1722
except AttributeError:
1724
# Is this a D-Bus interface?
1725
elif getattr(attribute, "_dbus_is_interface", False):
1726
# Create a new, but exactly alike, function
1727
# object. Decorate it to be a new D-Bus interface
1728
# with the alternate D-Bus interface name. Add it
1731
dbus_interface_annotations(alt_interface)
1732
(copy_function(attribute)))
1734
# Deprecate all alternate interfaces
1735
iname = "_AlternateDBusNames_interface_annotation{}"
1736
for interface_name in interface_names:
1738
@dbus_interface_annotations(interface_name)
1740
return {"org.freedesktop.DBus.Deprecated":
1742
# Find an unused name
1743
for aname in (iname.format(i)
1744
for i in itertools.count()):
1745
if aname not in attr:
1749
# Replace the class with a new subclass of it with
1750
# methods, signals, etc. as created above.
1751
if sys.version_info.major == 2:
1752
cls = type(b"{}Alternate".format(cls.__name__),
1755
cls = type("{}Alternate".format(cls.__name__),
1762
@alternate_dbus_interfaces({"se.recompile.Mandos":
1763
"se.bsnet.fukt.Mandos"})
672
if (if_tag.getAttribute(u"name")
673
== u"org.freedesktop.DBus.Properties"):
674
for cn in if_tag.getElementsByTagName(u"method"):
675
if cn.getAttribute(u"name") == u"Get":
676
for arg in cn.getElementsByTagName(u"arg"):
677
if (arg.getAttribute(u"direction")
679
arg.setAttribute(u"name", u"value")
680
elif cn.getAttribute(u"name") == u"GetAll":
681
for arg in cn.getElementsByTagName(u"arg"):
682
if (arg.getAttribute(u"direction")
684
arg.setAttribute(u"name", u"props")
685
xmlstring = document.toxml(u"utf-8")
687
except (AttributeError, xml.dom.DOMException,
688
xml.parsers.expat.ExpatError), error:
689
logger.error(u"Failed to override Introspection method",
1764
694
class ClientDBus(Client, DBusObjectWithProperties):
1765
695
"""A Client class using D-Bus
1768
698
dbus_object_path: dbus.ObjectPath
1769
699
bus: dbus.SystemBus()
1772
runtime_expansions = (Client.runtime_expansions
1773
+ ("dbus_object_path", ))
1775
_interface = "se.recompile.Mandos.Client"
1777
701
# dbus.service.Object doesn't use super(), so we can't either.
1779
def __init__(self, bus=None, *args, **kwargs):
703
def __init__(self, bus = None, *args, **kwargs):
704
self._approvals_pending = 0
1781
706
Client.__init__(self, *args, **kwargs)
1782
707
# Only now, when this client is initialized, can it show up on
1784
client_object_name = str(self.name).translate(
1785
{ord("."): ord("_"),
1786
ord("-"): ord("_")})
1787
self.dbus_object_path = dbus.ObjectPath(
1788
"/clients/" + client_object_name)
709
self.dbus_object_path = (dbus.ObjectPath
711
+ self.name.replace(u".", u"_")))
1789
712
DBusObjectWithProperties.__init__(self, self.bus,
1790
713
self.dbus_object_path)
1792
def notifychangeproperty(transform_func, dbus_name,
1793
type_func=lambda x: x,
1795
invalidate_only=False,
1796
_interface=_interface):
1797
""" Modify a variable so that it's a property which announces
1798
its changes to DBus.
1800
transform_fun: Function that takes a value and a variant_level
1801
and transforms it to a D-Bus type.
1802
dbus_name: D-Bus name of the variable
1803
type_func: Function that transform the value before sending it
1804
to the D-Bus. Default: no transform
1805
variant_level: D-Bus variant level. Default: 1
1807
attrname = "_{}".format(dbus_name)
1809
def setter(self, value):
1810
if hasattr(self, "dbus_object_path"):
1811
if (not hasattr(self, attrname) or
1812
type_func(getattr(self, attrname, None))
1813
!= type_func(value)):
1815
self.PropertiesChanged(
1816
_interface, dbus.Dictionary(),
1817
dbus.Array((dbus_name, )))
1819
dbus_value = transform_func(
1821
variant_level=variant_level)
1822
self.PropertyChanged(dbus.String(dbus_name),
1824
self.PropertiesChanged(
1826
dbus.Dictionary({dbus.String(dbus_name):
1829
setattr(self, attrname, value)
1831
return property(lambda self: getattr(self, attrname), setter)
1833
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1834
approvals_pending = notifychangeproperty(dbus.Boolean,
1837
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1838
last_enabled = notifychangeproperty(datetime_to_dbus,
1840
checker = notifychangeproperty(
1841
dbus.Boolean, "CheckerRunning",
1842
type_func=lambda checker: checker is not None)
1843
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1845
last_checker_status = notifychangeproperty(dbus.Int16,
1846
"LastCheckerStatus")
1847
last_approval_request = notifychangeproperty(
1848
datetime_to_dbus, "LastApprovalRequest")
1849
approved_by_default = notifychangeproperty(dbus.Boolean,
1850
"ApprovedByDefault")
1851
approval_delay = notifychangeproperty(
1852
dbus.UInt64, "ApprovalDelay",
1853
type_func=lambda td: td.total_seconds() * 1000)
1854
approval_duration = notifychangeproperty(
1855
dbus.UInt64, "ApprovalDuration",
1856
type_func=lambda td: td.total_seconds() * 1000)
1857
host = notifychangeproperty(dbus.String, "Host")
1858
timeout = notifychangeproperty(
1859
dbus.UInt64, "Timeout",
1860
type_func=lambda td: td.total_seconds() * 1000)
1861
extended_timeout = notifychangeproperty(
1862
dbus.UInt64, "ExtendedTimeout",
1863
type_func=lambda td: td.total_seconds() * 1000)
1864
interval = notifychangeproperty(
1865
dbus.UInt64, "Interval",
1866
type_func=lambda td: td.total_seconds() * 1000)
1867
checker_command = notifychangeproperty(dbus.String, "Checker")
1868
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1869
invalidate_only=True)
1871
del notifychangeproperty
715
def _get_approvals_pending(self):
716
return self._approvals_pending
717
def _set_approvals_pending(self, value):
718
old_value = self._approvals_pending
719
self._approvals_pending = value
721
if (hasattr(self, "dbus_object_path")
722
and bval is not bool(old_value)):
723
dbus_bool = dbus.Boolean(bval, variant_level=1)
724
self.PropertyChanged(dbus.String(u"approved_pending"),
727
approvals_pending = property(_get_approvals_pending,
728
_set_approvals_pending)
729
del _get_approvals_pending, _set_approvals_pending
732
def _datetime_to_dbus(dt, variant_level=0):
733
"""Convert a UTC datetime.datetime() to a D-Bus type."""
734
return dbus.String(dt.isoformat(),
735
variant_level=variant_level)
738
oldstate = getattr(self, u"enabled", False)
739
r = Client.enable(self)
740
if oldstate != self.enabled:
742
self.PropertyChanged(dbus.String(u"enabled"),
743
dbus.Boolean(True, variant_level=1))
744
self.PropertyChanged(
745
dbus.String(u"last_enabled"),
746
self._datetime_to_dbus(self.last_enabled,
750
def disable(self, quiet = False):
751
oldstate = getattr(self, u"enabled", False)
752
r = Client.disable(self, quiet=quiet)
753
if not quiet and oldstate != self.enabled:
755
self.PropertyChanged(dbus.String(u"enabled"),
756
dbus.Boolean(False, variant_level=1))
1873
759
def __del__(self, *args, **kwargs):
1875
761
self.remove_from_connection()
1876
762
except LookupError:
1878
if hasattr(DBusObjectWithProperties, "__del__"):
764
if hasattr(DBusObjectWithProperties, u"__del__"):
1879
765
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1880
766
Client.__del__(self, *args, **kwargs)
1882
def checker_callback(self, source, condition,
1883
connection, command, *args, **kwargs):
1884
ret = Client.checker_callback(self, source, condition,
1885
connection, command, *args,
1887
exitstatus = self.last_checker_status
768
def checker_callback(self, pid, condition, command,
770
self.checker_callback_tag = None
773
self.PropertyChanged(dbus.String(u"checker_running"),
774
dbus.Boolean(False, variant_level=1))
775
if os.WIFEXITED(condition):
776
exitstatus = os.WEXITSTATUS(condition)
1889
777
# Emit D-Bus signal
1890
778
self.CheckerCompleted(dbus.Int16(exitstatus),
1891
# This is specific to GNU libC
1892
dbus.Int64(exitstatus << 8),
779
dbus.Int64(condition),
1893
780
dbus.String(command))
1895
782
# Emit D-Bus signal
1896
783
self.CheckerCompleted(dbus.Int16(-1),
1898
# This is specific to GNU libC
1900
| self.last_checker_signal),
784
dbus.Int64(condition),
1901
785
dbus.String(command))
787
return Client.checker_callback(self, pid, condition, command,
790
def checked_ok(self, *args, **kwargs):
791
r = Client.checked_ok(self, *args, **kwargs)
793
self.PropertyChanged(
794
dbus.String(u"last_checked_ok"),
795
(self._datetime_to_dbus(self.last_checked_ok,
1904
799
def start_checker(self, *args, **kwargs):
1905
old_checker_pid = getattr(self.checker, "pid", None)
800
old_checker = self.checker
801
if self.checker is not None:
802
old_checker_pid = self.checker.pid
804
old_checker_pid = None
1906
805
r = Client.start_checker(self, *args, **kwargs)
1907
806
# Only if new checker process was started
1908
807
if (self.checker is not None
1909
808
and old_checker_pid != self.checker.pid):
1910
809
# Emit D-Bus signal
1911
810
self.CheckerStarted(self.current_checker_command)
811
self.PropertyChanged(
812
dbus.String(u"checker_running"),
813
dbus.Boolean(True, variant_level=1))
816
def stop_checker(self, *args, **kwargs):
817
old_checker = getattr(self, u"checker", None)
818
r = Client.stop_checker(self, *args, **kwargs)
819
if (old_checker is not None
820
and getattr(self, u"checker", None) is None):
821
self.PropertyChanged(dbus.String(u"checker_running"),
822
dbus.Boolean(False, variant_level=1))
1914
825
def _reset_approved(self):
1915
self.approved = None
826
self._approved = None
1918
829
def approve(self, value=True):
1919
self.approved = value
1920
GLib.timeout_add(int(self.approval_duration.total_seconds()
1921
* 1000), self._reset_approved)
1922
830
self.send_changedstate()
1924
# D-Bus methods, signals & properties
831
self._approved = value
832
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration),
833
self._reset_approved)
836
## D-Bus methods, signals & properties
837
_interface = u"se.bsnet.fukt.Mandos.Client"
1930
841
# CheckerCompleted - signal
1931
@dbus.service.signal(_interface, signature="nxs")
842
@dbus.service.signal(_interface, signature=u"nxs")
1932
843
def CheckerCompleted(self, exitcode, waitstatus, command):
1936
847
# CheckerStarted - signal
1937
@dbus.service.signal(_interface, signature="s")
848
@dbus.service.signal(_interface, signature=u"s")
1938
849
def CheckerStarted(self, command):
1942
853
# PropertyChanged - signal
1943
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1944
@dbus.service.signal(_interface, signature="sv")
854
@dbus.service.signal(_interface, signature=u"sv")
1945
855
def PropertyChanged(self, property, value):
1949
859
# GotSecret - signal
1950
860
@dbus.service.signal(_interface)
1951
861
def GotSecret(self):
1954
864
server to mandos-client
1958
868
# Rejected - signal
1959
@dbus.service.signal(_interface, signature="s")
869
@dbus.service.signal(_interface, signature=u"s")
1960
870
def Rejected(self, reason):
1964
874
# NeedApproval - signal
1965
@dbus.service.signal(_interface, signature="tb")
875
@dbus.service.signal(_interface, signature=u"db")
1966
876
def NeedApproval(self, timeout, default):
1968
return self.need_approval()
1972
882
# Approve - method
1973
@dbus.service.method(_interface, in_signature="b")
883
@dbus.service.method(_interface, in_signature=u"b")
1974
884
def Approve(self, value):
1975
885
self.approve(value)
1977
887
# CheckedOK - method
1978
888
@dbus.service.method(_interface)
1979
889
def CheckedOK(self):
890
return self.checked_ok()
1982
892
# Enable - method
1983
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1984
893
@dbus.service.method(_interface)
1985
894
def Enable(self):
1989
898
# StartChecker - method
1990
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1991
899
@dbus.service.method(_interface)
1992
900
def StartChecker(self):
1994
902
self.start_checker()
1996
904
# Disable - method
1997
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1998
905
@dbus.service.method(_interface)
1999
906
def Disable(self):
2003
910
# StopChecker - method
2004
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2005
911
@dbus.service.method(_interface)
2006
912
def StopChecker(self):
2007
913
self.stop_checker()
2011
# ApprovalPending - property
2012
@dbus_service_property(_interface, signature="b", access="read")
2013
def ApprovalPending_dbus_property(self):
917
# approved_pending - property
918
@dbus_service_property(_interface, signature=u"b", access=u"read")
919
def approved_pending_dbus_property(self):
2014
920
return dbus.Boolean(bool(self.approvals_pending))
2016
# ApprovedByDefault - property
2017
@dbus_service_property(_interface,
2020
def ApprovedByDefault_dbus_property(self, value=None):
2021
if value is None: # get
2022
return dbus.Boolean(self.approved_by_default)
2023
self.approved_by_default = bool(value)
2025
# ApprovalDelay - property
2026
@dbus_service_property(_interface,
2029
def ApprovalDelay_dbus_property(self, value=None):
2030
if value is None: # get
2031
return dbus.UInt64(self.approval_delay.total_seconds()
2033
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2035
# ApprovalDuration - property
2036
@dbus_service_property(_interface,
2039
def ApprovalDuration_dbus_property(self, value=None):
2040
if value is None: # get
2041
return dbus.UInt64(self.approval_duration.total_seconds()
2043
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2047
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2048
@dbus_service_property(_interface, signature="s", access="read")
2049
def Name_dbus_property(self):
922
# approved_by_default - property
923
@dbus_service_property(_interface, signature=u"b",
925
def approved_by_default_dbus_property(self):
926
return dbus.Boolean(self.approved_by_default)
928
# approved_delay - property
929
@dbus_service_property(_interface, signature=u"t",
931
def approved_delay_dbus_property(self):
932
return dbus.UInt64(self.approved_delay_milliseconds())
934
# approved_duration - property
935
@dbus_service_property(_interface, signature=u"t",
937
def approved_duration_dbus_property(self):
938
return dbus.UInt64(self._timedelta_to_milliseconds(
939
self.approved_duration))
942
@dbus_service_property(_interface, signature=u"s", access=u"read")
943
def name_dbus_property(self):
2050
944
return dbus.String(self.name)
2054
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2055
@dbus_service_property(_interface, signature="s", access="read")
2056
def KeyID_dbus_property(self):
2057
return dbus.String(self.key_id)
2059
# Fingerprint - property
2061
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2062
@dbus_service_property(_interface, signature="s", access="read")
2063
def Fingerprint_dbus_property(self):
946
# fingerprint - property
947
@dbus_service_property(_interface, signature=u"s", access=u"read")
948
def fingerprint_dbus_property(self):
2064
949
return dbus.String(self.fingerprint)
2067
@dbus_service_property(_interface,
2070
def Host_dbus_property(self, value=None):
952
@dbus_service_property(_interface, signature=u"s",
954
def host_dbus_property(self, value=None):
2071
955
if value is None: # get
2072
956
return dbus.String(self.host)
2073
self.host = str(value)
2075
# Created - property
2077
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2078
@dbus_service_property(_interface, signature="s", access="read")
2079
def Created_dbus_property(self):
2080
return datetime_to_dbus(self.created)
2082
# LastEnabled - property
2083
@dbus_service_property(_interface, signature="s", access="read")
2084
def LastEnabled_dbus_property(self):
2085
return datetime_to_dbus(self.last_enabled)
2087
# Enabled - property
2088
@dbus_service_property(_interface,
2091
def Enabled_dbus_property(self, value=None):
959
self.PropertyChanged(dbus.String(u"host"),
960
dbus.String(value, variant_level=1))
963
@dbus_service_property(_interface, signature=u"s", access=u"read")
964
def created_dbus_property(self):
965
return dbus.String(self._datetime_to_dbus(self.created))
967
# last_enabled - property
968
@dbus_service_property(_interface, signature=u"s", access=u"read")
969
def last_enabled_dbus_property(self):
970
if self.last_enabled is None:
971
return dbus.String(u"")
972
return dbus.String(self._datetime_to_dbus(self.last_enabled))
975
@dbus_service_property(_interface, signature=u"b",
977
def enabled_dbus_property(self, value=None):
2092
978
if value is None: # get
2093
979
return dbus.Boolean(self.enabled)
2099
# LastCheckedOK - property
2100
@dbus_service_property(_interface,
2103
def LastCheckedOK_dbus_property(self, value=None):
985
# last_checked_ok - property
986
@dbus_service_property(_interface, signature=u"s",
988
def last_checked_ok_dbus_property(self, value=None):
2104
989
if value is not None:
2105
990
self.checked_ok()
2107
return datetime_to_dbus(self.last_checked_ok)
2109
# LastCheckerStatus - property
2110
@dbus_service_property(_interface, signature="n", access="read")
2111
def LastCheckerStatus_dbus_property(self):
2112
return dbus.Int16(self.last_checker_status)
2114
# Expires - property
2115
@dbus_service_property(_interface, signature="s", access="read")
2116
def Expires_dbus_property(self):
2117
return datetime_to_dbus(self.expires)
2119
# LastApprovalRequest - property
2120
@dbus_service_property(_interface, signature="s", access="read")
2121
def LastApprovalRequest_dbus_property(self):
2122
return datetime_to_dbus(self.last_approval_request)
2124
# Timeout - property
2125
@dbus_service_property(_interface,
2128
def Timeout_dbus_property(self, value=None):
992
if self.last_checked_ok is None:
993
return dbus.String(u"")
994
return dbus.String(self._datetime_to_dbus(self
998
@dbus_service_property(_interface, signature=u"t",
1000
def timeout_dbus_property(self, value=None):
2129
1001
if value is None: # get
2130
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2131
old_timeout = self.timeout
1002
return dbus.UInt64(self.timeout_milliseconds())
2132
1003
self.timeout = datetime.timedelta(0, 0, 0, value)
2133
# Reschedule disabling
2135
now = datetime.datetime.utcnow()
2136
self.expires += self.timeout - old_timeout
2137
if self.expires <= now:
2138
# The timeout has passed
2141
if (getattr(self, "disable_initiator_tag", None)
2144
GLib.source_remove(self.disable_initiator_tag)
2145
self.disable_initiator_tag = GLib.timeout_add(
2146
int((self.expires - now).total_seconds() * 1000),
2149
# ExtendedTimeout - property
2150
@dbus_service_property(_interface,
2153
def ExtendedTimeout_dbus_property(self, value=None):
2154
if value is None: # get
2155
return dbus.UInt64(self.extended_timeout.total_seconds()
2157
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2159
# Interval - property
2160
@dbus_service_property(_interface,
2163
def Interval_dbus_property(self, value=None):
2164
if value is None: # get
2165
return dbus.UInt64(self.interval.total_seconds() * 1000)
1005
self.PropertyChanged(dbus.String(u"timeout"),
1006
dbus.UInt64(value, variant_level=1))
1007
if getattr(self, u"disable_initiator_tag", None) is None:
1009
# Reschedule timeout
1010
gobject.source_remove(self.disable_initiator_tag)
1011
self.disable_initiator_tag = None
1012
time_to_die = (self.
1013
_timedelta_to_milliseconds((self
1018
if time_to_die <= 0:
1019
# The timeout has passed
1022
self.disable_initiator_tag = (gobject.timeout_add
1023
(time_to_die, self.disable))
1025
# interval - property
1026
@dbus_service_property(_interface, signature=u"t",
1027
access=u"readwrite")
1028
def interval_dbus_property(self, value=None):
1029
if value is None: # get
1030
return dbus.UInt64(self.interval_milliseconds())
2166
1031
self.interval = datetime.timedelta(0, 0, 0, value)
2167
if getattr(self, "checker_initiator_tag", None) is None:
1033
self.PropertyChanged(dbus.String(u"interval"),
1034
dbus.UInt64(value, variant_level=1))
1035
if getattr(self, u"checker_initiator_tag", None) is None:
2170
# Reschedule checker run
2171
GLib.source_remove(self.checker_initiator_tag)
2172
self.checker_initiator_tag = GLib.timeout_add(
2173
value, self.start_checker)
2174
self.start_checker() # Start one now, too
1037
# Reschedule checker run
1038
gobject.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = (gobject.timeout_add
1040
(value, self.start_checker))
1041
self.start_checker() # Start one now, too
2176
# Checker - property
2177
@dbus_service_property(_interface,
2180
def Checker_dbus_property(self, value=None):
1043
# checker - property
1044
@dbus_service_property(_interface, signature=u"s",
1045
access=u"readwrite")
1046
def checker_dbus_property(self, value=None):
2181
1047
if value is None: # get
2182
1048
return dbus.String(self.checker_command)
2183
self.checker_command = str(value)
2185
# CheckerRunning - property
2186
@dbus_service_property(_interface,
2189
def CheckerRunning_dbus_property(self, value=None):
1049
self.checker_command = value
1051
self.PropertyChanged(dbus.String(u"checker"),
1052
dbus.String(self.checker_command,
1055
# checker_running - property
1056
@dbus_service_property(_interface, signature=u"b",
1057
access=u"readwrite")
1058
def checker_running_dbus_property(self, value=None):
2190
1059
if value is None: # get
2191
1060
return dbus.Boolean(self.checker is not None)
2193
1062
self.start_checker()
2195
1064
self.stop_checker()
2197
# ObjectPath - property
2199
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2200
"org.freedesktop.DBus.Deprecated": "true"})
2201
@dbus_service_property(_interface, signature="o", access="read")
2202
def ObjectPath_dbus_property(self):
2203
return self.dbus_object_path # is already a dbus.ObjectPath
2207
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2209
@dbus_service_property(_interface,
2213
def Secret_dbus_property(self, value):
2214
self.secret = bytes(value)
1066
# object_path - property
1067
@dbus_service_property(_interface, signature=u"o", access=u"read")
1068
def object_path_dbus_property(self):
1069
return self.dbus_object_path # is already a dbus.ObjectPath
1072
@dbus_service_property(_interface, signature=u"ay",
1073
access=u"write", byte_arrays=True)
1074
def secret_dbus_property(self, value):
1075
self.secret = str(value)
2220
def __init__(self, child_pipe, key_id, fpr, address):
1080
class ProxyClient(object):
1081
def __init__(self, child_pipe, fpr, address):
2221
1082
self._pipe = child_pipe
2222
self._pipe.send(('init', key_id, fpr, address))
1083
self._pipe.send(('init', fpr, address))
2223
1084
if not self._pipe.recv():
2224
raise KeyError(key_id or fpr)
2226
1087
def __getattribute__(self, name):
1088
if(name == '_pipe'):
2228
1089
return super(ProxyClient, self).__getattribute__(name)
2229
1090
self._pipe.send(('getattr', name))
2230
1091
data = self._pipe.recv()
2231
1092
if data[0] == 'data':
2233
1094
if data[0] == 'function':
2235
1095
def func(*args, **kwargs):
2236
1096
self._pipe.send(('funcall', name, args, kwargs))
2237
1097
return self._pipe.recv()[1]
2241
1100
def __setattr__(self, name, value):
1101
if(name == '_pipe'):
2243
1102
return super(ProxyClient, self).__setattr__(name, value)
2244
1103
self._pipe.send(('setattr', name, value))
2247
1106
class ClientHandler(socketserver.BaseRequestHandler, object):
2248
1107
"""A class to handle client connections.
2250
1109
Instantiated once for each connection to handle it.
2251
1110
Note: This will run in its own forked process."""
2253
1112
def handle(self):
2254
1113
with contextlib.closing(self.server.child_pipe) as child_pipe:
2255
logger.info("TCP connection from: %s",
2256
str(self.client_address))
2257
logger.debug("Pipe FD: %d",
1114
logger.info(u"TCP connection from: %s",
1115
unicode(self.client_address))
1116
logger.debug(u"Pipe FD: %d",
2258
1117
self.server.child_pipe.fileno())
2260
session = gnutls.ClientSession(self.request)
2262
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2263
# "+AES-256-CBC", "+SHA1",
2264
# "+COMP-NULL", "+CTYPE-OPENPGP",
1119
session = (gnutls.connection
1120
.ClientSession(self.request,
1122
.X509Credentials()))
1124
# Note: gnutls.connection.X509Credentials is really a
1125
# generic GnuTLS certificate credentials object so long as
1126
# no X.509 keys are added to it. Therefore, we can use it
1127
# here despite using OpenPGP certificates.
1129
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1130
# u"+AES-256-CBC", u"+SHA1",
1131
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2266
1133
# Use a fallback default, since this MUST be set.
2267
1134
priority = self.server.gnutls_priority
2268
1135
if priority is None:
2270
gnutls.priority_set_direct(session._c_object,
2271
priority.encode("utf-8"),
1136
priority = u"NORMAL"
1137
(gnutls.library.functions
1138
.gnutls_priority_set_direct(session._c_object,
2274
1141
# Start communication using the Mandos protocol
2275
1142
# Get protocol number
2276
1143
line = self.request.makefile().readline()
2277
logger.debug("Protocol version: %r", line)
1144
logger.debug(u"Protocol version: %r", line)
2279
1146
if int(line.strip().split()[0]) > 1:
2280
raise RuntimeError(line)
2281
except (ValueError, IndexError, RuntimeError) as error:
2282
logger.error("Unknown protocol version: %s", error)
1148
except (ValueError, IndexError, RuntimeError), error:
1149
logger.error(u"Unknown protocol version: %s", error)
2285
1152
# Start GnuTLS connection
2287
1154
session.handshake()
2288
except gnutls.Error as error:
2289
logger.warning("Handshake failed: %s", error)
1155
except gnutls.errors.GNUTLSError, error:
1156
logger.warning(u"Handshake failed: %s", error)
2290
1157
# Do not run session.bye() here: the session is not
2291
1158
# established. Just abandon the request.
2293
logger.debug("Handshake succeeded")
1160
logger.debug(u"Handshake succeeded")
2295
1162
approval_required = False
2297
if gnutls.has_rawpk:
2300
key_id = self.key_id(
2301
self.peer_certificate(session))
2302
except (TypeError, gnutls.Error) as error:
2303
logger.warning("Bad certificate: %s", error)
2305
logger.debug("Key ID: %s", key_id)
2310
fpr = self.fingerprint(
2311
self.peer_certificate(session))
2312
except (TypeError, gnutls.Error) as error:
2313
logger.warning("Bad certificate: %s", error)
2315
logger.debug("Fingerprint: %s", fpr)
2318
client = ProxyClient(child_pipe, key_id, fpr,
1165
fpr = self.fingerprint(self.peer_certificate
1167
except (TypeError, gnutls.errors.GNUTLSError), error:
1168
logger.warning(u"Bad certificate: %s", error)
1170
logger.debug(u"Fingerprint: %s", fpr)
1173
client = ProxyClient(child_pipe, fpr,
2319
1174
self.client_address)
2320
1175
except KeyError:
2323
if client.approval_delay:
2324
delay = client.approval_delay
1178
if client.approved_delay:
1179
delay = client.approved_delay
2325
1180
client.approvals_pending += 1
2326
1181
approval_required = True
2329
1184
if not client.enabled:
2330
logger.info("Client %s is disabled",
1185
logger.warning(u"Client %s is disabled",
2332
1187
if self.server.use_dbus:
2333
1188
# Emit D-Bus signal
2334
client.Rejected("Disabled")
1189
client.Rejected("Disabled")
2337
if client.approved or not client.approval_delay:
2338
# We are approved or approval is disabled
1192
if client._approved or not client.approved_delay:
1193
#We are approved or approval is disabled
2340
elif client.approved is None:
2341
logger.info("Client %s needs approval",
1195
elif client._approved is None:
1196
logger.info(u"Client %s need approval",
2343
1198
if self.server.use_dbus:
2344
1199
# Emit D-Bus signal
2345
1200
client.NeedApproval(
2346
client.approval_delay.total_seconds()
2347
* 1000, client.approved_by_default)
1201
client.approved_delay_milliseconds(),
1202
client.approved_by_default)
2349
logger.warning("Client %s was not approved",
1204
logger.warning(u"Client %s was not approved",
2351
1206
if self.server.use_dbus:
2352
1207
# Emit D-Bus signal
2353
client.Rejected("Denied")
1208
client.Rejected("Disapproved")
2356
# wait until timeout or approved
1211
#wait until timeout or approved
1212
#x = float(client._timedelta_to_milliseconds(delay))
2357
1213
time = datetime.datetime.now()
2358
1214
client.changedstate.acquire()
2359
client.changedstate.wait(delay.total_seconds())
1215
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2360
1216
client.changedstate.release()
2361
1217
time2 = datetime.datetime.now()
2362
1218
if (time2 - time) >= delay:
2367
1223
if self.server.use_dbus:
2368
1224
# Emit D-Bus signal
2369
client.Rejected("Approval timed out")
1225
client.Rejected("Time out")
2374
1230
delay -= time2 - time
2377
session.send(client.secret)
2378
except gnutls.Error as error:
2379
logger.warning("gnutls send failed",
2383
logger.info("Sending secret to %s", client.name)
2384
# bump the timeout using extended_timeout
2385
client.bump_timeout(client.extended_timeout)
1233
while sent_size < len(client.secret):
1235
sent = session.send(client.secret[sent_size:])
1236
except (gnutls.errors.GNUTLSError), error:
1237
logger.warning("gnutls send failed")
1239
logger.debug(u"Sent: %d, remaining: %d",
1240
sent, len(client.secret)
1241
- (sent_size + sent))
1244
logger.info(u"Sending secret to %s", client.name)
1245
# bump the timeout as if seen
2386
1247
if self.server.use_dbus:
2387
1248
# Emit D-Bus signal
2388
1249
client.GotSecret()
2391
1252
if approval_required:
2392
1253
client.approvals_pending -= 1
2395
except gnutls.Error as error:
2396
logger.warning("GnuTLS bye failed",
1256
except (gnutls.errors.GNUTLSError), error:
1257
logger.warning("gnutls bye failed")
2400
1260
def peer_certificate(session):
2401
"Return the peer's certificate as a bytestring"
2403
cert_type = gnutls.certificate_type_get2(session._c_object,
2405
except AttributeError:
2406
cert_type = gnutls.certificate_type_get(session._c_object)
2407
if gnutls.has_rawpk:
2408
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2410
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2411
# If not a valid certificate type...
2412
if cert_type not in valid_cert_types:
2413
logger.info("Cert type %r not in %r", cert_type,
2415
# ...return invalid data
1261
"Return the peer's OpenPGP certificate as a bytestring"
1262
# If not an OpenPGP certificate...
1263
if (gnutls.library.functions
1264
.gnutls_certificate_type_get(session._c_object)
1265
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1266
# ...do the normal thing
1267
return session.peer_certificate
2417
1268
list_size = ctypes.c_uint(1)
2418
cert_list = (gnutls.certificate_get_peers
1269
cert_list = (gnutls.library.functions
1270
.gnutls_certificate_get_peers
2419
1271
(session._c_object, ctypes.byref(list_size)))
2420
1272
if not bool(cert_list) and list_size.value != 0:
2421
raise gnutls.Error("error getting peer certificate")
1273
raise gnutls.errors.GNUTLSError(u"error getting peer"
2422
1275
if list_size.value == 0:
2424
1277
cert = cert_list[0]
2425
1278
return ctypes.string_at(cert.data, cert.size)
2428
def key_id(certificate):
2429
"Convert a certificate bytestring to a hexdigit key ID"
2430
# New GnuTLS "datum" with the public key
2431
datum = gnutls.datum_t(
2432
ctypes.cast(ctypes.c_char_p(certificate),
2433
ctypes.POINTER(ctypes.c_ubyte)),
2434
ctypes.c_uint(len(certificate)))
2435
# XXX all these need to be created in the gnutls "module"
2436
# New empty GnuTLS certificate
2437
pubkey = gnutls.pubkey_t()
2438
gnutls.pubkey_init(ctypes.byref(pubkey))
2439
# Import the raw public key into the certificate
2440
gnutls.pubkey_import(pubkey,
2441
ctypes.byref(datum),
2442
gnutls.X509_FMT_DER)
2443
# New buffer for the key ID
2444
buf = ctypes.create_string_buffer(32)
2445
buf_len = ctypes.c_size_t(len(buf))
2446
# Get the key ID from the raw public key into the buffer
2447
gnutls.pubkey_get_key_id(pubkey,
2448
gnutls.KEYID_USE_SHA256,
2449
ctypes.cast(ctypes.byref(buf),
2450
ctypes.POINTER(ctypes.c_ubyte)),
2451
ctypes.byref(buf_len))
2452
# Deinit the certificate
2453
gnutls.pubkey_deinit(pubkey)
2455
# Convert the buffer to a Python bytestring
2456
key_id = ctypes.string_at(buf, buf_len.value)
2457
# Convert the bytestring to hexadecimal notation
2458
hex_key_id = binascii.hexlify(key_id).upper()
2462
1281
def fingerprint(openpgp):
2463
1282
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2464
1283
# New GnuTLS "datum" with the OpenPGP public key
2465
datum = gnutls.datum_t(
2466
ctypes.cast(ctypes.c_char_p(openpgp),
2467
ctypes.POINTER(ctypes.c_ubyte)),
2468
ctypes.c_uint(len(openpgp)))
1284
datum = (gnutls.library.types
1285
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1288
ctypes.c_uint(len(openpgp))))
2469
1289
# New empty GnuTLS certificate
2470
crt = gnutls.openpgp_crt_t()
2471
gnutls.openpgp_crt_init(ctypes.byref(crt))
1290
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1291
(gnutls.library.functions
1292
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2472
1293
# Import the OpenPGP public key into the certificate
2473
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2474
gnutls.OPENPGP_FMT_RAW)
1294
(gnutls.library.functions
1295
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1296
gnutls.library.constants
1297
.GNUTLS_OPENPGP_FMT_RAW))
2475
1298
# Verify the self signature in the key
2476
1299
crtverify = ctypes.c_uint()
2477
gnutls.openpgp_crt_verify_self(crt, 0,
2478
ctypes.byref(crtverify))
1300
(gnutls.library.functions
1301
.gnutls_openpgp_crt_verify_self(crt, 0,
1302
ctypes.byref(crtverify)))
2479
1303
if crtverify.value != 0:
2480
gnutls.openpgp_crt_deinit(crt)
2481
raise gnutls.CertificateSecurityError(code
1304
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1305
raise (gnutls.errors.CertificateSecurityError
2483
1307
# New buffer for the fingerprint
2484
1308
buf = ctypes.create_string_buffer(20)
2485
1309
buf_len = ctypes.c_size_t()
2486
1310
# Get the fingerprint from the certificate into the buffer
2487
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2488
ctypes.byref(buf_len))
1311
(gnutls.library.functions
1312
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1313
ctypes.byref(buf_len)))
2489
1314
# Deinit the certificate
2490
gnutls.openpgp_crt_deinit(crt)
1315
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2491
1316
# Convert the buffer to a Python bytestring
2492
1317
fpr = ctypes.string_at(buf, buf_len.value)
2493
1318
# Convert the bytestring to hexadecimal notation
2494
hex_fpr = binascii.hexlify(fpr).upper()
1319
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2498
class MultiprocessingMixIn:
1323
class MultiprocessingMixIn(object):
2499
1324
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2501
1325
def sub_process_main(self, request, address):
2503
1327
self.finish_request(request, address)
2505
1329
self.handle_error(request, address)
2506
1330
self.close_request(request)
2508
1332
def process_request(self, request, address):
2509
1333
"""Start a new process to process the request."""
2510
proc = multiprocessing.Process(target=self.sub_process_main,
2511
args=(request, address))
2516
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1334
multiprocessing.Process(target = self.sub_process_main,
1335
args = (request, address)).start()
1337
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2517
1338
""" adds a pipe to the MixIn """
2519
1339
def process_request(self, request, client_address):
2520
1340
"""Overrides and wraps the original process_request().
2522
1342
This function creates a new pipe in self.pipe
2524
1344
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2526
proc = MultiprocessingMixIn.process_request(self, request,
1346
super(MultiprocessingMixInWithPipe,
1347
self).process_request(request, client_address)
2528
1348
self.child_pipe.close()
2529
self.add_pipe(parent_pipe, proc)
1349
self.add_pipe(parent_pipe)
2531
def add_pipe(self, parent_pipe, proc):
1351
def add_pipe(self, parent_pipe):
2532
1352
"""Dummy function; override as necessary"""
2533
raise NotImplementedError()
2536
1355
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2537
socketserver.TCPServer):
1356
socketserver.TCPServer, object):
2538
1357
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2541
1360
enabled: Boolean; whether this server is activated yet
2542
1361
interface: None or a network interface name (string)
2543
1362
use_ipv6: Boolean; to use IPv6 or not
2546
1364
def __init__(self, server_address, RequestHandlerClass,
2550
"""If socketfd is set, use that file descriptor instead of
2551
creating a new one with socket.socket().
1365
interface=None, use_ipv6=True):
2553
1366
self.interface = interface
2555
1368
self.address_family = socket.AF_INET6
2556
if socketfd is not None:
2557
# Save the file descriptor
2558
self.socketfd = socketfd
2559
# Save the original socket.socket() function
2560
self.socket_socket = socket.socket
2562
# To implement --socket, we monkey patch socket.socket.
2564
# (When socketserver.TCPServer is a new-style class, we
2565
# could make self.socket into a property instead of monkey
2566
# patching socket.socket.)
2568
# Create a one-time-only replacement for socket.socket()
2569
@functools.wraps(socket.socket)
2570
def socket_wrapper(*args, **kwargs):
2571
# Restore original function so subsequent calls are
2573
socket.socket = self.socket_socket
2574
del self.socket_socket
2575
# This time only, return a new socket object from the
2576
# saved file descriptor.
2577
return socket.fromfd(self.socketfd, *args, **kwargs)
2578
# Replace socket.socket() function with wrapper
2579
socket.socket = socket_wrapper
2580
# The socketserver.TCPServer.__init__ will call
2581
# socket.socket(), which might be our replacement,
2582
# socket_wrapper(), if socketfd was set.
2583
1369
socketserver.TCPServer.__init__(self, server_address,
2584
1370
RequestHandlerClass)
2586
1371
def server_bind(self):
2587
1372
"""This overrides the normal server_bind() function
2588
1373
to bind to an interface if one was specified, and also NOT to
2589
1374
bind to an address or port if they were not specified."""
2590
global SO_BINDTODEVICE
2591
1375
if self.interface is not None:
2592
1376
if SO_BINDTODEVICE is None:
2593
# Fall back to a hard-coded value which seems to be
2595
logger.warning("SO_BINDTODEVICE not found, trying 25")
2596
SO_BINDTODEVICE = 25
2598
self.socket.setsockopt(
2599
socket.SOL_SOCKET, SO_BINDTODEVICE,
2600
(self.interface + "\0").encode("utf-8"))
2601
except socket.error as error:
2602
if error.errno == errno.EPERM:
2603
logger.error("No permission to bind to"
2604
" interface %s", self.interface)
2605
elif error.errno == errno.ENOPROTOOPT:
2606
logger.error("SO_BINDTODEVICE not available;"
2607
" cannot bind to interface %s",
2609
elif error.errno == errno.ENODEV:
2610
logger.error("Interface %s does not exist,"
2611
" cannot bind", self.interface)
1377
logger.error(u"SO_BINDTODEVICE does not exist;"
1378
u" cannot bind to interface %s",
1382
self.socket.setsockopt(socket.SOL_SOCKET,
1386
except socket.error, error:
1387
if error[0] == errno.EPERM:
1388
logger.error(u"No permission to"
1389
u" bind to interface %s",
1391
elif error[0] == errno.ENOPROTOOPT:
1392
logger.error(u"SO_BINDTODEVICE not available;"
1393
u" cannot bind to interface %s",
2614
1397
# Only bind(2) the socket if we really need to.
2615
1398
if self.server_address[0] or self.server_address[1]:
2616
if self.server_address[1]:
2617
self.allow_reuse_address = True
2618
1399
if not self.server_address[0]:
2619
1400
if self.address_family == socket.AF_INET6:
2620
any_address = "::" # in6addr_any
1401
any_address = u"::" # in6addr_any
2622
any_address = "0.0.0.0" # INADDR_ANY
1403
any_address = socket.INADDR_ANY
2623
1404
self.server_address = (any_address,
2624
1405
self.server_address[1])
2625
1406
elif not self.server_address[1]:
2626
self.server_address = (self.server_address[0], 0)
1407
self.server_address = (self.server_address[0],
2627
1409
# if self.interface:
2628
1410
# self.server_address = (self.server_address[0],
2757
def rfc3339_duration_to_delta(duration):
2758
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2760
>>> rfc3339_duration_to_delta("P7D")
2761
datetime.timedelta(7)
2762
>>> rfc3339_duration_to_delta("PT60S")
2763
datetime.timedelta(0, 60)
2764
>>> rfc3339_duration_to_delta("PT60M")
2765
datetime.timedelta(0, 3600)
2766
>>> rfc3339_duration_to_delta("PT24H")
2767
datetime.timedelta(1)
2768
>>> rfc3339_duration_to_delta("P1W")
2769
datetime.timedelta(7)
2770
>>> rfc3339_duration_to_delta("PT5M30S")
2771
datetime.timedelta(0, 330)
2772
>>> rfc3339_duration_to_delta("P1DT3M20S")
2773
datetime.timedelta(1, 200)
2776
# Parsing an RFC 3339 duration with regular expressions is not
2777
# possible - there would have to be multiple places for the same
2778
# values, like seconds. The current code, while more esoteric, is
2779
# cleaner without depending on a parsing library. If Python had a
2780
# built-in library for parsing we would use it, but we'd like to
2781
# avoid excessive use of external libraries.
2783
# New type for defining tokens, syntax, and semantics all-in-one
2784
Token = collections.namedtuple("Token", (
2785
"regexp", # To match token; if "value" is not None, must have
2786
# a "group" containing digits
2787
"value", # datetime.timedelta or None
2788
"followers")) # Tokens valid after this token
2789
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2790
# the "duration" ABNF definition in RFC 3339, Appendix A.
2791
token_end = Token(re.compile(r"$"), None, frozenset())
2792
token_second = Token(re.compile(r"(\d+)S"),
2793
datetime.timedelta(seconds=1),
2794
frozenset((token_end, )))
2795
token_minute = Token(re.compile(r"(\d+)M"),
2796
datetime.timedelta(minutes=1),
2797
frozenset((token_second, token_end)))
2798
token_hour = Token(re.compile(r"(\d+)H"),
2799
datetime.timedelta(hours=1),
2800
frozenset((token_minute, token_end)))
2801
token_time = Token(re.compile(r"T"),
2803
frozenset((token_hour, token_minute,
2805
token_day = Token(re.compile(r"(\d+)D"),
2806
datetime.timedelta(days=1),
2807
frozenset((token_time, token_end)))
2808
token_month = Token(re.compile(r"(\d+)M"),
2809
datetime.timedelta(weeks=4),
2810
frozenset((token_day, token_end)))
2811
token_year = Token(re.compile(r"(\d+)Y"),
2812
datetime.timedelta(weeks=52),
2813
frozenset((token_month, token_end)))
2814
token_week = Token(re.compile(r"(\d+)W"),
2815
datetime.timedelta(weeks=1),
2816
frozenset((token_end, )))
2817
token_duration = Token(re.compile(r"P"), None,
2818
frozenset((token_year, token_month,
2819
token_day, token_time,
2821
# Define starting values:
2823
value = datetime.timedelta()
2825
# Following valid tokens
2826
followers = frozenset((token_duration, ))
2827
# String left to parse
2829
# Loop until end token is found
2830
while found_token is not token_end:
2831
# Search for any currently valid tokens
2832
for token in followers:
2833
match = token.regexp.match(s)
2834
if match is not None:
2836
if token.value is not None:
2837
# Value found, parse digits
2838
factor = int(match.group(1), 10)
2839
# Add to value so far
2840
value += factor * token.value
2841
# Strip token from string
2842
s = token.regexp.sub("", s, 1)
2845
# Set valid next tokens
2846
followers = found_token.followers
2849
# No currently valid tokens were found
2850
raise ValueError("Invalid RFC 3339 duration: {!r}"
2856
1528
def string_to_delta(interval):
2857
1529
"""Parse a string and return a datetime.timedelta
2859
>>> string_to_delta('7d')
1531
>>> string_to_delta(u'7d')
2860
1532
datetime.timedelta(7)
2861
>>> string_to_delta('60s')
1533
>>> string_to_delta(u'60s')
2862
1534
datetime.timedelta(0, 60)
2863
>>> string_to_delta('60m')
1535
>>> string_to_delta(u'60m')
2864
1536
datetime.timedelta(0, 3600)
2865
>>> string_to_delta('24h')
1537
>>> string_to_delta(u'24h')
2866
1538
datetime.timedelta(1)
2867
>>> string_to_delta('1w')
1539
>>> string_to_delta(u'1w')
2868
1540
datetime.timedelta(7)
2869
>>> string_to_delta('5m 30s')
1541
>>> string_to_delta(u'5m 30s')
2870
1542
datetime.timedelta(0, 330)
2874
return rfc3339_duration_to_delta(interval)
2878
1544
timevalue = datetime.timedelta(0)
2879
1545
for s in interval.split():
1547
suffix = unicode(s[-1])
2882
1548
value = int(s[:-1])
2884
1550
delta = datetime.timedelta(value)
1551
elif suffix == u"s":
2886
1552
delta = datetime.timedelta(0, value)
1553
elif suffix == u"m":
2888
1554
delta = datetime.timedelta(0, 0, 0, 0, value)
1555
elif suffix == u"h":
2890
1556
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1557
elif suffix == u"w":
2892
1558
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2894
raise ValueError("Unknown suffix {!r}".format(suffix))
2895
except IndexError as e:
2896
raise ValueError(*(e.args))
1560
raise ValueError(u"Unknown suffix %r" % suffix)
1561
except (ValueError, IndexError), e:
1562
raise ValueError(e.message)
2897
1563
timevalue += delta
2898
1564
return timevalue
2901
def daemon(nochdir=False, noclose=False):
1567
def if_nametoindex(interface):
1568
"""Call the C function if_nametoindex(), or equivalent
1570
Note: This function cannot accept a unicode string."""
1571
global if_nametoindex
1573
if_nametoindex = (ctypes.cdll.LoadLibrary
1574
(ctypes.util.find_library(u"c"))
1576
except (OSError, AttributeError):
1577
logger.warning(u"Doing if_nametoindex the hard way")
1578
def if_nametoindex(interface):
1579
"Get an interface index the hard way, i.e. using fcntl()"
1580
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1581
with contextlib.closing(socket.socket()) as s:
1582
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1583
struct.pack(str(u"16s16x"),
1585
interface_index = struct.unpack(str(u"I"),
1587
return interface_index
1588
return if_nametoindex(interface)
1591
def daemon(nochdir = False, noclose = False):
2902
1592
"""See daemon(3). Standard BSD Unix function.
2904
1594
This should really exist as os.daemon, but it doesn't (yet)."""
2908
1598
if not nochdir:
2912
1602
if not noclose:
2913
1603
# Close all standard open file descriptors
2914
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1604
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2915
1605
if not stat.S_ISCHR(os.fstat(null).st_mode):
2916
1606
raise OSError(errno.ENODEV,
2917
"{} not a character device"
2918
.format(os.devnull))
1607
u"%s not a character device"
2919
1609
os.dup2(null, sys.stdin.fileno())
2920
1610
os.dup2(null, sys.stdout.fileno())
2921
1611
os.dup2(null, sys.stderr.fileno())
2928
1618
##################################################################
2929
1619
# Parsing of options, both command line and config file
2931
parser = argparse.ArgumentParser()
2932
parser.add_argument("-v", "--version", action="version",
2933
version="%(prog)s {}".format(version),
2934
help="show version number and exit")
2935
parser.add_argument("-i", "--interface", metavar="IF",
2936
help="Bind to interface IF")
2937
parser.add_argument("-a", "--address",
2938
help="Address to listen for requests on")
2939
parser.add_argument("-p", "--port", type=int,
2940
help="Port number to receive requests on")
2941
parser.add_argument("--check", action="store_true",
2942
help="Run self-test")
2943
parser.add_argument("--debug", action="store_true",
2944
help="Debug mode; run in foreground and log"
2945
" to terminal", default=None)
2946
parser.add_argument("--debuglevel", metavar="LEVEL",
2947
help="Debug level for stdout output")
2948
parser.add_argument("--priority", help="GnuTLS"
2949
" priority string (see GnuTLS documentation)")
2950
parser.add_argument("--servicename",
2951
metavar="NAME", help="Zeroconf service name")
2952
parser.add_argument("--configdir",
2953
default="/etc/mandos", metavar="DIR",
2954
help="Directory to search for configuration"
2956
parser.add_argument("--no-dbus", action="store_false",
2957
dest="use_dbus", help="Do not provide D-Bus"
2958
" system bus interface", default=None)
2959
parser.add_argument("--no-ipv6", action="store_false",
2960
dest="use_ipv6", help="Do not use IPv6",
2962
parser.add_argument("--no-restore", action="store_false",
2963
dest="restore", help="Do not restore stored"
2964
" state", default=None)
2965
parser.add_argument("--socket", type=int,
2966
help="Specify a file descriptor to a network"
2967
" socket to use instead of creating one")
2968
parser.add_argument("--statedir", metavar="DIR",
2969
help="Directory to save/restore state in")
2970
parser.add_argument("--foreground", action="store_true",
2971
help="Run in foreground", default=None)
2972
parser.add_argument("--no-zeroconf", action="store_false",
2973
dest="zeroconf", help="Do not use Zeroconf",
2976
options = parser.parse_args()
1621
parser = optparse.OptionParser(version = "%%prog %s" % version)
1622
parser.add_option("-i", u"--interface", type=u"string",
1623
metavar="IF", help=u"Bind to interface IF")
1624
parser.add_option("-a", u"--address", type=u"string",
1625
help=u"Address to listen for requests on")
1626
parser.add_option("-p", u"--port", type=u"int",
1627
help=u"Port number to receive requests on")
1628
parser.add_option("--check", action=u"store_true",
1629
help=u"Run self-test")
1630
parser.add_option("--debug", action=u"store_true",
1631
help=u"Debug mode; run in foreground and log to"
1633
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1634
help=u"Debug level for stdout output")
1635
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1636
u" priority string (see GnuTLS documentation)")
1637
parser.add_option("--servicename", type=u"string",
1638
metavar=u"NAME", help=u"Zeroconf service name")
1639
parser.add_option("--configdir", type=u"string",
1640
default=u"/etc/mandos", metavar=u"DIR",
1641
help=u"Directory to search for configuration"
1643
parser.add_option("--no-dbus", action=u"store_false",
1644
dest=u"use_dbus", help=u"Do not provide D-Bus"
1645
u" system bus interface")
1646
parser.add_option("--no-ipv6", action=u"store_false",
1647
dest=u"use_ipv6", help=u"Do not use IPv6")
1648
options = parser.parse_args()[0]
2978
1650
if options.check:
2980
fail_count, test_count = doctest.testmod()
2981
sys.exit(os.EX_OK if fail_count == 0 else 1)
2983
1655
# Default values for config file for server-global settings
2984
if gnutls.has_rawpk:
2985
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2986
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2988
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2989
":+SIGN-DSA-SHA256")
2990
server_defaults = {"interface": "",
2994
"priority": priority,
2995
"servicename": "Mandos",
3001
"statedir": "/var/lib/mandos",
3002
"foreground": "False",
1656
server_defaults = { u"interface": u"",
1661
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1662
u"servicename": u"Mandos",
1663
u"use_dbus": u"True",
1664
u"use_ipv6": u"True",
3007
1668
# Parse config file for server-global settings
3008
server_config = configparser.ConfigParser(server_defaults)
1669
server_config = configparser.SafeConfigParser(server_defaults)
3009
1670
del server_defaults
3010
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3011
# Convert the ConfigParser object to a dict
1671
server_config.read(os.path.join(options.configdir,
1673
# Convert the SafeConfigParser object to a dict
3012
1674
server_settings = server_config.defaults()
3013
1675
# Use the appropriate methods on the non-string config options
3014
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3015
"foreground", "zeroconf"):
3016
server_settings[option] = server_config.getboolean("DEFAULT",
1676
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1677
server_settings[option] = server_config.getboolean(u"DEFAULT",
3018
1679
if server_settings["port"]:
3019
server_settings["port"] = server_config.getint("DEFAULT",
3021
if server_settings["socket"]:
3022
server_settings["socket"] = server_config.getint("DEFAULT",
3024
# Later, stdin will, and stdout and stderr might, be dup'ed
3025
# over with an opened os.devnull. But we don't want this to
3026
# happen with a supplied network socket.
3027
if 0 <= server_settings["socket"] <= 2:
3028
server_settings["socket"] = os.dup(server_settings
1680
server_settings["port"] = server_config.getint(u"DEFAULT",
3030
1682
del server_config
3032
1684
# Override the settings from the config file with command line
3033
1685
# options, if set.
3034
for option in ("interface", "address", "port", "debug",
3035
"priority", "servicename", "configdir", "use_dbus",
3036
"use_ipv6", "debuglevel", "restore", "statedir",
3037
"socket", "foreground", "zeroconf"):
1686
for option in (u"interface", u"address", u"port", u"debug",
1687
u"priority", u"servicename", u"configdir",
1688
u"use_dbus", u"use_ipv6", u"debuglevel"):
3038
1689
value = getattr(options, option)
3039
1690
if value is not None:
3040
1691
server_settings[option] = value
3042
1693
# Force all strings to be unicode
3043
1694
for option in server_settings.keys():
3044
if isinstance(server_settings[option], bytes):
3045
server_settings[option] = (server_settings[option]
3047
# Force all boolean options to be boolean
3048
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3049
"foreground", "zeroconf"):
3050
server_settings[option] = bool(server_settings[option])
3051
# Debug implies foreground
3052
if server_settings["debug"]:
3053
server_settings["foreground"] = True
1695
if type(server_settings[option]) is str:
1696
server_settings[option] = unicode(server_settings[option])
3054
1697
# Now we have our good server settings in "server_settings"
3056
1699
##################################################################
3058
if (not server_settings["zeroconf"]
3059
and not (server_settings["port"]
3060
or server_settings["socket"] != "")):
3061
parser.error("Needs port or socket to work without Zeroconf")
3063
1701
# For convenience
3064
debug = server_settings["debug"]
3065
debuglevel = server_settings["debuglevel"]
3066
use_dbus = server_settings["use_dbus"]
3067
use_ipv6 = server_settings["use_ipv6"]
3068
stored_state_path = os.path.join(server_settings["statedir"],
3070
foreground = server_settings["foreground"]
3071
zeroconf = server_settings["zeroconf"]
3074
initlogger(debug, logging.DEBUG)
3079
level = getattr(logging, debuglevel.upper())
3080
initlogger(debug, level)
3082
if server_settings["servicename"] != "Mandos":
3083
syslogger.setFormatter(
3084
logging.Formatter('Mandos ({}) [%(process)d]:'
3085
' %(levelname)s: %(message)s'.format(
3086
server_settings["servicename"])))
1702
debug = server_settings[u"debug"]
1703
debuglevel = server_settings[u"debuglevel"]
1704
use_dbus = server_settings[u"use_dbus"]
1705
use_ipv6 = server_settings[u"use_ipv6"]
1707
if server_settings[u"servicename"] != u"Mandos":
1708
syslogger.setFormatter(logging.Formatter
1709
(u'Mandos (%s) [%%(process)d]:'
1710
u' %%(levelname)s: %%(message)s'
1711
% server_settings[u"servicename"]))
3088
1713
# Parse config file with clients
3089
client_config = configparser.ConfigParser(Client.client_defaults)
3090
client_config.read(os.path.join(server_settings["configdir"],
1714
client_defaults = { u"timeout": u"1h",
1716
u"checker": u"fping -q -- %%(host)s",
1718
u"approved_delay": u"0s",
1719
u"approved_duration": u"1s",
1721
client_config = configparser.SafeConfigParser(client_defaults)
1722
client_config.read(os.path.join(server_settings[u"configdir"],
3093
1725
global mandos_dbus_service
3094
1726
mandos_dbus_service = None
3097
if server_settings["socket"] != "":
3098
socketfd = server_settings["socket"]
3099
tcp_server = MandosServer(
3100
(server_settings["address"], server_settings["port"]),
3102
interface=(server_settings["interface"] or None),
3104
gnutls_priority=server_settings["priority"],
3108
pidfilename = "/run/mandos.pid"
3109
if not os.path.isdir("/run/."):
3110
pidfilename = "/var/run/mandos.pid"
3113
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3114
except IOError as e:
3115
logger.error("Could not open file %r", pidfilename,
3118
for name, group in (("_mandos", "_mandos"),
3119
("mandos", "mandos"),
3120
("nobody", "nogroup")):
3122
uid = pwd.getpwnam(name).pw_uid
3123
gid = pwd.getpwnam(group).pw_gid
1728
tcp_server = MandosServer((server_settings[u"address"],
1729
server_settings[u"port"]),
1731
interface=server_settings[u"interface"],
1734
server_settings[u"priority"],
1736
pidfilename = u"/var/run/mandos.pid"
1738
pidfile = open(pidfilename, u"w")
1740
logger.error(u"Could not open file %r", pidfilename)
1743
uid = pwd.getpwnam(u"_mandos").pw_uid
1744
gid = pwd.getpwnam(u"_mandos").pw_gid
1747
uid = pwd.getpwnam(u"mandos").pw_uid
1748
gid = pwd.getpwnam(u"mandos").pw_gid
3125
1749
except KeyError:
1751
uid = pwd.getpwnam(u"nobody").pw_uid
1752
gid = pwd.getpwnam(u"nobody").pw_gid
3134
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3136
except OSError as error:
3137
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3138
.format(uid, gid, os.strerror(error.errno)))
3139
if error.errno != errno.EPERM:
1759
except OSError, error:
1760
if error[0] != errno.EPERM:
1763
# Enable all possible GnuTLS debugging
1766
if not debug and not debuglevel:
1767
syslogger.setLevel(logging.WARNING)
1768
console.setLevel(logging.WARNING)
1770
level = getattr(logging, debuglevel.upper())
1771
syslogger.setLevel(level)
1772
console.setLevel(level)
3143
# Enable all possible GnuTLS debugging
3145
1775
# "Use a log level over 10 to enable all debugging options."
3146
1776
# - GnuTLS manual
3147
gnutls.global_set_log_level(11)
1777
gnutls.library.functions.gnutls_global_set_log_level(11)
1779
@gnutls.library.types.gnutls_log_func
3150
1780
def debug_gnutls(level, string):
3151
logger.debug("GnuTLS: %s", string[:-1])
3153
gnutls.global_set_log_function(debug_gnutls)
1781
logger.debug(u"GnuTLS: %s", string[:-1])
1783
(gnutls.library.functions
1784
.gnutls_global_set_log_function(debug_gnutls))
3155
1786
# Redirect stdin so all checkers get /dev/null
3156
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1787
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3157
1788
os.dup2(null, sys.stdin.fileno())
3161
# Need to fork before connecting to D-Bus
3163
# Close all input and output, do double fork, etc.
3166
if gi.version_info < (3, 10, 2):
3167
# multiprocessing will use threads, so before we use GLib we
3168
# need to inform GLib that threads will be used.
1792
# No console logging
1793
logger.removeHandler(console)
3171
1796
global main_loop
3172
1797
# From the Avahi example code
3173
DBusGMainLoop(set_as_default=True)
3174
main_loop = GLib.MainLoop()
1798
DBusGMainLoop(set_as_default=True )
1799
main_loop = gobject.MainLoop()
3175
1800
bus = dbus.SystemBus()
3176
1801
# End of Avahi example code
3179
bus_name = dbus.service.BusName("se.recompile.Mandos",
3182
old_bus_name = dbus.service.BusName(
3183
"se.bsnet.fukt.Mandos", bus,
3185
except dbus.exceptions.DBusException as e:
3186
logger.error("Disabling D-Bus:", exc_info=e)
1804
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1805
bus, do_not_queue=True)
1806
except dbus.exceptions.NameExistsException, e:
1807
logger.error(unicode(e) + u", disabling D-Bus")
3187
1808
use_dbus = False
3188
server_settings["use_dbus"] = False
1809
server_settings[u"use_dbus"] = False
3189
1810
tcp_server.use_dbus = False
3191
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3192
service = AvahiServiceToSyslog(
3193
name=server_settings["servicename"],
3194
servicetype="_mandos._tcp",
3197
if server_settings["interface"]:
3198
service.interface = if_nametoindex(
3199
server_settings["interface"].encode("utf-8"))
1811
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1812
service = AvahiService(name = server_settings[u"servicename"],
1813
servicetype = u"_mandos._tcp",
1814
protocol = protocol, bus = bus)
1815
if server_settings["interface"]:
1816
service.interface = (if_nametoindex
1817
(str(server_settings[u"interface"])))
1820
# Close all input and output, do double fork, etc.
3201
1823
global multiprocessing_manager
3202
1824
multiprocessing_manager = multiprocessing.Manager()
3204
1826
client_class = Client
3206
client_class = functools.partial(ClientDBus, bus=bus)
3208
client_settings = Client.config_parser(client_config)
3209
old_client_settings = {}
3212
# This is used to redirect stdout and stderr for checker processes
3214
wnull = open(os.devnull, "w") # A writable /dev/null
3215
# Only used if server is running in foreground but not in debug
3217
if debug or not foreground:
3220
# Get client data and settings from last running state.
3221
if server_settings["restore"]:
3223
with open(stored_state_path, "rb") as stored_state:
3224
if sys.version_info.major == 2:
3225
clients_data, old_client_settings = pickle.load(
3228
bytes_clients_data, bytes_old_client_settings = (
3229
pickle.load(stored_state, encoding="bytes"))
3230
# Fix bytes to strings
3233
clients_data = {(key.decode("utf-8")
3234
if isinstance(key, bytes)
3237
bytes_clients_data.items()}
3238
del bytes_clients_data
3239
for key in clients_data:
3240
value = {(k.decode("utf-8")
3241
if isinstance(k, bytes) else k): v
3243
clients_data[key].items()}
3244
clients_data[key] = value
3246
value["client_structure"] = [
3248
if isinstance(s, bytes)
3250
value["client_structure"]]
3252
for k in ("name", "host"):
3253
if isinstance(value[k], bytes):
3254
value[k] = value[k].decode("utf-8")
3255
if "key_id" not in value:
3256
value["key_id"] = ""
3257
elif "fingerprint" not in value:
3258
value["fingerprint"] = ""
3259
# old_client_settings
3261
old_client_settings = {
3262
(key.decode("utf-8")
3263
if isinstance(key, bytes)
3266
bytes_old_client_settings.items()}
3267
del bytes_old_client_settings
3269
for value in old_client_settings.values():
3270
if isinstance(value["host"], bytes):
3271
value["host"] = (value["host"]
3273
os.remove(stored_state_path)
3274
except IOError as e:
3275
if e.errno == errno.ENOENT:
3276
logger.warning("Could not load persistent state:"
3277
" {}".format(os.strerror(e.errno)))
3279
logger.critical("Could not load persistent state:",
3282
except EOFError as e:
3283
logger.warning("Could not load persistent state: "
3287
with PGPEngine() as pgp:
3288
for client_name, client in clients_data.items():
3289
# Skip removed clients
3290
if client_name not in client_settings:
3293
# Decide which value to use after restoring saved state.
3294
# We have three different values: Old config file,
3295
# new config file, and saved state.
3296
# New config value takes precedence if it differs from old
3297
# config value, otherwise use saved state.
3298
for name, value in client_settings[client_name].items():
3300
# For each value in new config, check if it
3301
# differs from the old config value (Except for
3302
# the "secret" attribute)
3303
if (name != "secret"
3305
old_client_settings[client_name][name])):
3306
client[name] = value
3310
# Clients who has passed its expire date can still be
3311
# enabled if its last checker was successful. A Client
3312
# whose checker succeeded before we stored its state is
3313
# assumed to have successfully run all checkers during
3315
if client["enabled"]:
3316
if datetime.datetime.utcnow() >= client["expires"]:
3317
if not client["last_checked_ok"]:
3319
"disabling client {} - Client never "
3320
"performed a successful checker".format(
3322
client["enabled"] = False
3323
elif client["last_checker_status"] != 0:
3325
"disabling client {} - Client last"
3326
" checker failed with error code"
3329
client["last_checker_status"]))
3330
client["enabled"] = False
3332
client["expires"] = (
3333
datetime.datetime.utcnow()
3334
+ client["timeout"])
3335
logger.debug("Last checker succeeded,"
3336
" keeping {} enabled".format(
1828
client_class = functools.partial(ClientDBus, bus = bus)
1829
def client_config_items(config, section):
1830
special_settings = {
1831
"approved_by_default":
1832
lambda: config.getboolean(section,
1833
"approved_by_default"),
1835
for name, value in config.items(section):
3339
client["secret"] = pgp.decrypt(
3340
client["encrypted_secret"],
3341
client_settings[client_name]["secret"])
3343
# If decryption fails, we use secret from new settings
3344
logger.debug("Failed to decrypt {} old secret".format(
3346
client["secret"] = (client_settings[client_name]
3349
# Add/remove clients based on new changes made to config
3350
for client_name in (set(old_client_settings)
3351
- set(client_settings)):
3352
del clients_data[client_name]
3353
for client_name in (set(client_settings)
3354
- set(old_client_settings)):
3355
clients_data[client_name] = client_settings[client_name]
3357
# Create all client objects
3358
for client_name, client in clients_data.items():
3359
tcp_server.clients[client_name] = client_class(
3362
server_settings=server_settings)
1837
yield (name, special_settings[name]())
1841
tcp_server.clients.update(set(
1842
client_class(name = section,
1843
config= dict(client_config_items(
1844
client_config, section)))
1845
for section in client_config.sections()))
3364
1846
if not tcp_server.clients:
3365
logger.warning("No clients defined")
3368
if pidfile is not None:
1847
logger.warning(u"No clients defined")
3369
1851
pid = os.getpid()
3372
print(pid, file=pidfile)
3374
logger.error("Could not write to file %r with PID %d",
1852
pidfile.write(str(pid) + "\n")
3379
for termsig in (signal.SIGHUP, signal.SIGTERM):
3380
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3381
lambda: main_loop.quit() and False)
1855
logger.error(u"Could not write to file %r with PID %d",
1858
# "pidfile" was never created
1863
signal.signal(signal.SIGINT, signal.SIG_IGN)
1864
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1865
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3385
@alternate_dbus_interfaces(
3386
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3387
class MandosDBusService(DBusObjectWithObjectManager):
1868
class MandosDBusService(dbus.service.Object):
3388
1869
"""A D-Bus proxy object"""
3390
1870
def __init__(self):
3391
dbus.service.Object.__init__(self, bus, "/")
3393
_interface = "se.recompile.Mandos"
3395
@dbus.service.signal(_interface, signature="o")
1871
dbus.service.Object.__init__(self, bus, u"/")
1872
_interface = u"se.bsnet.fukt.Mandos"
1874
@dbus.service.signal(_interface, signature=u"o")
3396
1875
def ClientAdded(self, objpath):
3400
@dbus.service.signal(_interface, signature="ss")
3401
def ClientNotFound(self, key_id, address):
1879
@dbus.service.signal(_interface, signature=u"ss")
1880
def ClientNotFound(self, fingerprint, address):
3405
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3407
@dbus.service.signal(_interface, signature="os")
1884
@dbus.service.signal(_interface, signature=u"os")
3408
1885
def ClientRemoved(self, objpath, name):
3412
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3414
@dbus.service.method(_interface, out_signature="ao")
1889
@dbus.service.method(_interface, out_signature=u"ao")
3415
1890
def GetAllClients(self):
3417
return dbus.Array(c.dbus_object_path for c in
3418
tcp_server.clients.values())
3420
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1892
return dbus.Array(c.dbus_object_path
1893
for c in tcp_server.clients)
3422
1895
@dbus.service.method(_interface,
3423
out_signature="a{oa{sv}}")
1896
out_signature=u"a{oa{sv}}")
3424
1897
def GetAllClientsWithProperties(self):
3426
1899
return dbus.Dictionary(
3427
{c.dbus_object_path: c.GetAll(
3428
"se.recompile.Mandos.Client")
3429
for c in tcp_server.clients.values()},
3432
@dbus.service.method(_interface, in_signature="o")
1900
((c.dbus_object_path, c.GetAll(u""))
1901
for c in tcp_server.clients),
1902
signature=u"oa{sv}")
1904
@dbus.service.method(_interface, in_signature=u"o")
3433
1905
def RemoveClient(self, object_path):
3435
for c in tcp_server.clients.values():
1907
for c in tcp_server.clients:
3436
1908
if c.dbus_object_path == object_path:
3437
del tcp_server.clients[c.name]
1909
tcp_server.clients.remove(c)
3438
1910
c.remove_from_connection()
3439
# Don't signal the disabling
1911
# Don't signal anything except ClientRemoved
3440
1912
c.disable(quiet=True)
3441
# Emit D-Bus signal for removal
3442
self.client_removed_signal(c)
1914
self.ClientRemoved(object_path, c.name)
3444
1916
raise KeyError(object_path)
3448
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3449
out_signature="a{oa{sa{sv}}}")
3450
def GetManagedObjects(self):
3452
return dbus.Dictionary(
3453
{client.dbus_object_path:
3455
{interface: client.GetAll(interface)
3457
client._get_all_interface_names()})
3458
for client in tcp_server.clients.values()})
3460
def client_added_signal(self, client):
3461
"""Send the new standard signal and the old signal"""
3463
# New standard signal
3464
self.InterfacesAdded(
3465
client.dbus_object_path,
3467
{interface: client.GetAll(interface)
3469
client._get_all_interface_names()}))
3471
self.ClientAdded(client.dbus_object_path)
3473
def client_removed_signal(self, client):
3474
"""Send the new standard signal and the old signal"""
3476
# New standard signal
3477
self.InterfacesRemoved(
3478
client.dbus_object_path,
3479
client._get_all_interface_names())
3481
self.ClientRemoved(client.dbus_object_path,
3484
1920
mandos_dbus_service = MandosDBusService()
3486
# Save modules to variables to exempt the modules from being
3487
# unloaded before the function registered with atexit() is run.
3488
mp = multiprocessing
3492
1923
"Cleanup function; run on exit"
3496
mp.active_children()
3498
if not (tcp_server.clients or client_settings):
3501
# Store client before exiting. Secrets are encrypted with key
3502
# based on what config file has. If config file is
3503
# removed/edited, old secret will thus be unrecovable.
3505
with PGPEngine() as pgp:
3506
for client in tcp_server.clients.values():
3507
key = client_settings[client.name]["secret"]
3508
client.encrypted_secret = pgp.encrypt(client.secret,
3512
# A list of attributes that can not be pickled
3514
exclude = {"bus", "changedstate", "secret",
3515
"checker", "server_settings"}
3516
for name, typ in inspect.getmembers(dbus.service
3520
client_dict["encrypted_secret"] = (client
3522
for attr in client.client_structure:
3523
if attr not in exclude:
3524
client_dict[attr] = getattr(client, attr)
3526
clients[client.name] = client_dict
3527
del client_settings[client.name]["secret"]
3530
with tempfile.NamedTemporaryFile(
3534
dir=os.path.dirname(stored_state_path),
3535
delete=False) as stored_state:
3536
pickle.dump((clients, client_settings), stored_state,
3538
tempname = stored_state.name
3539
os.rename(tempname, stored_state_path)
3540
except (IOError, OSError) as e:
3546
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3547
logger.warning("Could not save persistent state: {}"
3548
.format(os.strerror(e.errno)))
3550
logger.warning("Could not save persistent state:",
3554
# Delete all clients, and settings from config
3555
1926
while tcp_server.clients:
3556
name, client = tcp_server.clients.popitem()
1927
client = tcp_server.clients.pop()
3558
1929
client.remove_from_connection()
3559
# Don't signal the disabling
1930
client.disable_hook = None
1931
# Don't signal anything except ClientRemoved
3560
1932
client.disable(quiet=True)
3561
# Emit D-Bus signal for removal
3563
mandos_dbus_service.client_removed_signal(client)
3564
client_settings.clear()
1935
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3566
1938
atexit.register(cleanup)
3568
for client in tcp_server.clients.values():
1940
for client in tcp_server.clients:
3570
# Emit D-Bus signal for adding
3571
mandos_dbus_service.client_added_signal(client)
3572
# Need to initiate checking of clients
3574
client.init_checker()
1943
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3576
1946
tcp_server.enable()
3577
1947
tcp_server.server_activate()
3579
1949
# Find out what port we got
3581
service.port = tcp_server.socket.getsockname()[1]
1950
service.port = tcp_server.socket.getsockname()[1]
3583
logger.info("Now listening on address %r, port %d,"
3584
" flowinfo %d, scope_id %d",
3585
*tcp_server.socket.getsockname())
1952
logger.info(u"Now listening on address %r, port %d,"
1953
" flowinfo %d, scope_id %d"
1954
% tcp_server.socket.getsockname())
3587
logger.info("Now listening on address %r, port %d",
3588
*tcp_server.socket.getsockname())
3590
# service.interface = tcp_server.socket.getsockname()[3]
1956
logger.info(u"Now listening on address %r, port %d"
1957
% tcp_server.socket.getsockname())
1959
#service.interface = tcp_server.socket.getsockname()[3]
3594
# From the Avahi example code
3597
except dbus.exceptions.DBusException as error:
3598
logger.critical("D-Bus Exception", exc_info=error)
3601
# End of Avahi example code
3603
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3604
lambda *args, **kwargs:
3605
(tcp_server.handle_request
3606
(*args[2:], **kwargs) or True))
3608
logger.debug("Starting main loop")
1962
# From the Avahi example code
1965
except dbus.exceptions.DBusException, error:
1966
logger.critical(u"DBusException: %s", error)
1969
# End of Avahi example code
1971
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1972
lambda *args, **kwargs:
1973
(tcp_server.handle_request
1974
(*args[2:], **kwargs) or True))
1976
logger.debug(u"Starting main loop")
3609
1977
main_loop.run()
3610
except AvahiError as error:
3611
logger.critical("Avahi Error", exc_info=error)
1978
except AvahiError, error:
1979
logger.critical(u"AvahiError: %s", error)
3614
1982
except KeyboardInterrupt:
3616
print("", file=sys.stderr)
3617
logger.debug("Server received KeyboardInterrupt")
3618
logger.debug("Server exiting")
1985
logger.debug(u"Server received KeyboardInterrupt")
1986
logger.debug(u"Server exiting")
3619
1987
# Must run before the D-Bus bus name gets deregistered
3623
1990
if __name__ == '__main__':