69
import cPickle as pickle
62
import cPickle as pickle
72
63
import multiprocessing
81
66
import dbus.service
82
from gi.repository import GLib
83
69
from dbus.mainloop.glib import DBusGMainLoop
86
72
import xml.dom.minidom
89
# Try to find the value of SO_BINDTODEVICE:
91
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
92
# newer, and it is also the most natural place for it:
93
76
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
94
77
except AttributeError:
96
# This is where SO_BINDTODEVICE was up to and including Python
98
79
from IN import SO_BINDTODEVICE
99
80
except ImportError:
100
# In Python 2.7 it seems to have been removed entirely.
101
# Try running the C preprocessor:
103
cc = subprocess.Popen(["cc", "--language=c", "-E",
105
stdin=subprocess.PIPE,
106
stdout=subprocess.PIPE)
107
stdout = cc.communicate(
108
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
109
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
110
except (OSError, ValueError, IndexError):
112
SO_BINDTODEVICE = None
114
if sys.version_info.major == 2:
118
stored_state_file = "clients.pickle"
120
logger = logging.getLogger()
124
if_nametoindex = ctypes.cdll.LoadLibrary(
125
ctypes.util.find_library("c")).if_nametoindex
126
except (OSError, AttributeError):
128
def if_nametoindex(interface):
129
"Get an interface index the hard way, i.e. using fcntl()"
130
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
131
with contextlib.closing(socket.socket()) as s:
132
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
133
struct.pack(b"16s16x", interface))
134
interface_index = struct.unpack("I", ifreq[16:20])[0]
135
return interface_index
138
def copy_function(func):
139
"""Make a copy of a function"""
140
if sys.version_info.major == 2:
141
return types.FunctionType(func.func_code,
147
return types.FunctionType(func.__code__,
154
def initlogger(debug, level=logging.WARNING):
155
"""init logger and add loglevel"""
158
syslogger = (logging.handlers.SysLogHandler(
159
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
161
syslogger.setFormatter(logging.Formatter
162
('Mandos [%(process)d]: %(levelname)s:'
164
logger.addHandler(syslogger)
167
console = logging.StreamHandler()
168
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
172
logger.addHandler(console)
173
logger.setLevel(level)
176
class PGPError(Exception):
177
"""Exception if encryption/decryption fails"""
181
class PGPEngine(object):
182
"""A simple class for OpenPGP symmetric encryption & decryption"""
185
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
188
output = subprocess.check_output(["gpgconf"])
189
for line in output.splitlines():
190
name, text, path = line.split(b":")
195
if e.errno != errno.ENOENT:
197
self.gnupgargs = ['--batch',
198
'--homedir', self.tempdir,
201
# Only GPG version 1 has the --no-use-agent option.
202
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
203
self.gnupgargs.append("--no-use-agent")
208
def __exit__(self, exc_type, exc_value, traceback):
216
if self.tempdir is not None:
217
# Delete contents of tempdir
218
for root, dirs, files in os.walk(self.tempdir,
220
for filename in files:
221
os.remove(os.path.join(root, filename))
223
os.rmdir(os.path.join(root, dirname))
225
os.rmdir(self.tempdir)
228
def password_encode(self, password):
229
# Passphrase can not be empty and can not contain newlines or
230
# NUL bytes. So we prefix it and hex encode it.
231
encoded = b"mandos" + binascii.hexlify(password)
232
if len(encoded) > 2048:
233
# GnuPG can't handle long passwords, so encode differently
234
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
235
.replace(b"\n", b"\\n")
236
.replace(b"\0", b"\\x00"))
239
def encrypt(self, data, password):
240
passphrase = self.password_encode(password)
241
with tempfile.NamedTemporaryFile(
242
dir=self.tempdir) as passfile:
243
passfile.write(passphrase)
245
proc = subprocess.Popen([self.gpg, '--symmetric',
249
stdin=subprocess.PIPE,
250
stdout=subprocess.PIPE,
251
stderr=subprocess.PIPE)
252
ciphertext, err = proc.communicate(input=data)
253
if proc.returncode != 0:
257
def decrypt(self, data, password):
258
passphrase = self.password_encode(password)
259
with tempfile.NamedTemporaryFile(
260
dir=self.tempdir) as passfile:
261
passfile.write(passphrase)
263
proc = subprocess.Popen([self.gpg, '--decrypt',
267
stdin=subprocess.PIPE,
268
stdout=subprocess.PIPE,
269
stderr=subprocess.PIPE)
270
decrypted_plaintext, err = proc.communicate(input=data)
271
if proc.returncode != 0:
273
return decrypted_plaintext
276
# Pretend that we have an Avahi module
278
"""This isn't so much a class as it is a module-like namespace.
279
It is instantiated once, and simulates having an Avahi module."""
280
IF_UNSPEC = -1 # avahi-common/address.h
281
PROTO_UNSPEC = -1 # avahi-common/address.h
282
PROTO_INET = 0 # avahi-common/address.h
283
PROTO_INET6 = 1 # avahi-common/address.h
284
DBUS_NAME = "org.freedesktop.Avahi"
285
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
286
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
287
DBUS_PATH_SERVER = "/"
289
def string_array_to_txt_array(self, t):
290
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
291
for s in t), signature="ay")
292
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
293
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
294
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
295
SERVER_INVALID = 0 # avahi-common/defs.h
296
SERVER_REGISTERING = 1 # avahi-common/defs.h
297
SERVER_RUNNING = 2 # avahi-common/defs.h
298
SERVER_COLLISION = 3 # avahi-common/defs.h
299
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)
303
102
class AvahiError(Exception):
304
103
def __init__(self, value, *args, **kwargs):
305
104
self.value = value
306
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))
310
109
class AvahiServiceError(AvahiError):
314
112
class AvahiGroupError(AvahiError):
318
116
class AvahiService(object):
319
117
"""An Avahi (Zeroconf) service.
322
120
interface: integer; avahi.IF_UNSPEC or an interface index.
323
121
Used to optionally bind to the specified interface.
324
name: string; Example: 'Mandos'
325
type: string; Example: '_mandos._tcp'.
326
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>
327
125
port: integer; what port to announce
328
126
TXT: list of strings; TXT record for the service
329
127
domain: string; Domain to publish on, default to .local if empty.
418
197
dbus.UInt16(self.port),
419
198
avahi.string_array_to_txt_array(self.TXT))
420
199
self.group.Commit()
422
200
def entry_group_state_changed(self, state, error):
423
201
"""Derived from the Avahi example code"""
424
logger.debug("Avahi entry group state change: %i", state)
202
logger.debug(u"Avahi entry group state change: %i", state)
426
204
if state == avahi.ENTRY_GROUP_ESTABLISHED:
427
logger.debug("Zeroconf service established.")
205
logger.debug(u"Zeroconf service established.")
428
206
elif state == avahi.ENTRY_GROUP_COLLISION:
429
logger.info("Zeroconf service name collision.")
207
logger.warning(u"Zeroconf service name collision.")
431
209
elif state == avahi.ENTRY_GROUP_FAILURE:
432
logger.critical("Avahi: Error in group state changed %s",
434
raise AvahiGroupError("State changed: {!s}".format(error))
210
logger.critical(u"Avahi: Error in group state changed %s",
212
raise AvahiGroupError(u"State changed: %s"
436
214
def cleanup(self):
437
215
"""Derived from the Avahi example code"""
438
216
if self.group is not None:
441
except (dbus.exceptions.UnknownMethodException,
442
dbus.exceptions.DBusException):
444
218
self.group = None
447
def server_state_changed(self, state, error=None):
219
def server_state_changed(self, state):
448
220
"""Derived from the Avahi example code"""
449
logger.debug("Avahi server state change: %i", state)
451
avahi.SERVER_INVALID: "Zeroconf server invalid",
452
avahi.SERVER_REGISTERING: None,
453
avahi.SERVER_COLLISION: "Zeroconf server name collision",
454
avahi.SERVER_FAILURE: "Zeroconf server failure",
456
if state in bad_states:
457
if bad_states[state] is not None:
459
logger.error(bad_states[state])
461
logger.error(bad_states[state] + ": %r", error)
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
463
225
elif state == avahi.SERVER_RUNNING:
466
except dbus.exceptions.DBusException as error:
467
if (error.get_dbus_name()
468
== "org.freedesktop.Avahi.CollisionError"):
469
logger.info("Local Zeroconf service name"
471
return self.rename(remove=False)
473
logger.critical("D-Bus Exception", exc_info=error)
478
logger.debug("Unknown state: %r", state)
480
logger.debug("Unknown state: %r: %r", state, error)
482
227
def activate(self):
483
228
"""Derived from the Avahi example code"""
484
229
if self.server is None:
485
230
self.server = dbus.Interface(
486
231
self.bus.get_object(avahi.DBUS_NAME,
487
avahi.DBUS_PATH_SERVER,
488
follow_name_owner_changes=True),
232
avahi.DBUS_PATH_SERVER),
489
233
avahi.DBUS_INTERFACE_SERVER)
490
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
234
self.server.connect_to_signal(u"StateChanged",
235
self.server_state_changed)
492
236
self.server_state_changed(self.server.GetState())
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
"""Add the new name to the syslog messages"""
498
ret = AvahiService.rename(self, *args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
505
# Pretend that we have a GnuTLS module
506
class GnuTLS(object):
507
"""This isn't so much a class as it is a module-like namespace.
508
It is instantiated once, and simulates having a GnuTLS module."""
510
_library = ctypes.cdll.LoadLibrary(
511
ctypes.util.find_library("gnutls"))
512
_need_version = b"3.3.0"
515
# Need to use class name "GnuTLS" here, since this method is
516
# called before the assignment to the "gnutls" global variable
518
if GnuTLS.check_version(self._need_version) is None:
519
raise GnuTLS.Error("Needs GnuTLS {} or later"
520
.format(self._need_version))
522
# Unless otherwise indicated, the constants and types below are
523
# all from the gnutls/gnutls.h C header file.
533
E_NO_CERTIFICATE_FOUND = -49
534
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
537
class session_int(ctypes.Structure):
539
session_t = ctypes.POINTER(session_int)
541
class certificate_credentials_st(ctypes.Structure):
543
certificate_credentials_t = ctypes.POINTER(
544
certificate_credentials_st)
545
certificate_type_t = ctypes.c_int
547
class datum_t(ctypes.Structure):
548
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
549
('size', ctypes.c_uint)]
551
class openpgp_crt_int(ctypes.Structure):
553
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
554
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
555
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
556
credentials_type_t = ctypes.c_int
557
transport_ptr_t = ctypes.c_void_p
558
close_request_t = ctypes.c_int
561
class Error(Exception):
562
# We need to use the class name "GnuTLS" here, since this
563
# exception might be raised from within GnuTLS.__init__,
564
# which is called before the assignment to the "gnutls"
565
# global variable has happened.
566
def __init__(self, message=None, code=None, args=()):
567
# Default usage is by a message string, but if a return
568
# code is passed, convert it to a string with
571
if message is None and code is not None:
572
message = GnuTLS.strerror(code)
573
return super(GnuTLS.Error, self).__init__(
576
class CertificateSecurityError(Error):
580
class Credentials(object):
582
self._c_object = gnutls.certificate_credentials_t()
583
gnutls.certificate_allocate_credentials(
584
ctypes.byref(self._c_object))
585
self.type = gnutls.CRD_CERTIFICATE
588
gnutls.certificate_free_credentials(self._c_object)
590
class ClientSession(object):
591
def __init__(self, socket, credentials=None):
592
self._c_object = gnutls.session_t()
593
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
594
gnutls.set_default_priority(self._c_object)
595
gnutls.transport_set_ptr(self._c_object, socket.fileno())
596
gnutls.handshake_set_private_extensions(self._c_object,
599
if credentials is None:
600
credentials = gnutls.Credentials()
601
gnutls.credentials_set(self._c_object, credentials.type,
602
ctypes.cast(credentials._c_object,
604
self.credentials = credentials
607
gnutls.deinit(self._c_object)
610
return gnutls.handshake(self._c_object)
612
def send(self, data):
616
data_len -= gnutls.record_send(self._c_object,
621
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
623
# Error handling functions
624
def _error_code(result):
625
"""A function to raise exceptions on errors, suitable
626
for the 'restype' attribute on ctypes functions"""
629
if result == gnutls.E_NO_CERTIFICATE_FOUND:
630
raise gnutls.CertificateSecurityError(code=result)
631
raise gnutls.Error(code=result)
633
def _retry_on_error(result, func, arguments):
634
"""A function to retry on some errors, suitable
635
for the 'errcheck' attribute on ctypes functions"""
637
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
638
return _error_code(result)
639
result = func(*arguments)
642
# Unless otherwise indicated, the function declarations below are
643
# all from the gnutls/gnutls.h C header file.
646
priority_set_direct = _library.gnutls_priority_set_direct
647
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
648
ctypes.POINTER(ctypes.c_char_p)]
649
priority_set_direct.restype = _error_code
651
init = _library.gnutls_init
652
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
653
init.restype = _error_code
655
set_default_priority = _library.gnutls_set_default_priority
656
set_default_priority.argtypes = [session_t]
657
set_default_priority.restype = _error_code
659
record_send = _library.gnutls_record_send
660
record_send.argtypes = [session_t, ctypes.c_void_p,
662
record_send.restype = ctypes.c_ssize_t
663
record_send.errcheck = _retry_on_error
665
certificate_allocate_credentials = (
666
_library.gnutls_certificate_allocate_credentials)
667
certificate_allocate_credentials.argtypes = [
668
ctypes.POINTER(certificate_credentials_t)]
669
certificate_allocate_credentials.restype = _error_code
671
certificate_free_credentials = (
672
_library.gnutls_certificate_free_credentials)
673
certificate_free_credentials.argtypes = [
674
certificate_credentials_t]
675
certificate_free_credentials.restype = None
677
handshake_set_private_extensions = (
678
_library.gnutls_handshake_set_private_extensions)
679
handshake_set_private_extensions.argtypes = [session_t,
681
handshake_set_private_extensions.restype = None
683
credentials_set = _library.gnutls_credentials_set
684
credentials_set.argtypes = [session_t, credentials_type_t,
686
credentials_set.restype = _error_code
688
strerror = _library.gnutls_strerror
689
strerror.argtypes = [ctypes.c_int]
690
strerror.restype = ctypes.c_char_p
692
certificate_type_get = _library.gnutls_certificate_type_get
693
certificate_type_get.argtypes = [session_t]
694
certificate_type_get.restype = _error_code
696
certificate_get_peers = _library.gnutls_certificate_get_peers
697
certificate_get_peers.argtypes = [session_t,
698
ctypes.POINTER(ctypes.c_uint)]
699
certificate_get_peers.restype = ctypes.POINTER(datum_t)
701
global_set_log_level = _library.gnutls_global_set_log_level
702
global_set_log_level.argtypes = [ctypes.c_int]
703
global_set_log_level.restype = None
705
global_set_log_function = _library.gnutls_global_set_log_function
706
global_set_log_function.argtypes = [log_func]
707
global_set_log_function.restype = None
709
deinit = _library.gnutls_deinit
710
deinit.argtypes = [session_t]
711
deinit.restype = None
713
handshake = _library.gnutls_handshake
714
handshake.argtypes = [session_t]
715
handshake.restype = _error_code
716
handshake.errcheck = _retry_on_error
718
transport_set_ptr = _library.gnutls_transport_set_ptr
719
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
720
transport_set_ptr.restype = None
722
bye = _library.gnutls_bye
723
bye.argtypes = [session_t, close_request_t]
724
bye.restype = _error_code
725
bye.errcheck = _retry_on_error
727
check_version = _library.gnutls_check_version
728
check_version.argtypes = [ctypes.c_char_p]
729
check_version.restype = ctypes.c_char_p
731
# All the function declarations below are from gnutls/openpgp.h
733
openpgp_crt_init = _library.gnutls_openpgp_crt_init
734
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
735
openpgp_crt_init.restype = _error_code
737
openpgp_crt_import = _library.gnutls_openpgp_crt_import
738
openpgp_crt_import.argtypes = [openpgp_crt_t,
739
ctypes.POINTER(datum_t),
741
openpgp_crt_import.restype = _error_code
743
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
744
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
745
ctypes.POINTER(ctypes.c_uint)]
746
openpgp_crt_verify_self.restype = _error_code
748
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
749
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
750
openpgp_crt_deinit.restype = None
752
openpgp_crt_get_fingerprint = (
753
_library.gnutls_openpgp_crt_get_fingerprint)
754
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
758
openpgp_crt_get_fingerprint.restype = _error_code
760
# Remove non-public functions
761
del _error_code, _retry_on_error
762
# Create the global "gnutls" object, simulating a module
766
def call_pipe(connection, # : multiprocessing.Connection
767
func, *args, **kwargs):
768
"""This function is meant to be called by multiprocessing.Process
770
This function runs func(*args, **kwargs), and writes the resulting
771
return value on the provided multiprocessing.Connection.
773
connection.send(func(*args, **kwargs))
777
239
class Client(object):
778
240
"""A representation of a client host served by this server.
781
approved: bool(); 'None' if not yet approved/disapproved
782
approval_delay: datetime.timedelta(); Time to wait for approval
783
approval_duration: datetime.timedelta(); Duration of one approval
243
name: string; from the config file, used in log messages and
245
fingerprint: string (40 or 32 hexadecimal digits); used to
246
uniquely identify the client
247
secret: bytestring; sent verbatim (over TLS) to client
248
host: string; available for use by the checker command
249
created: datetime.datetime(); (UTC) object creation
250
last_enabled: datetime.datetime(); (UTC)
252
last_checked_ok: datetime.datetime(); (UTC) or None
253
timeout: datetime.timedelta(); How long from last_checked_ok
254
until this client is disabled
255
interval: datetime.timedelta(); How often to start a new checker
256
disable_hook: If set, called by disable() as disable_hook(self)
784
257
checker: subprocess.Popen(); a running checker process used
785
258
to see if the client lives.
786
259
'None' if no process is running.
787
checker_callback_tag: a GLib event source tag, or None
788
checker_command: string; External command which is run to check
789
if client lives. %() expansions are done at
260
checker_initiator_tag: a gobject event source tag, or None
261
disable_initiator_tag: - '' -
262
checker_callback_tag: - '' -
263
checker_command: string; External command which is run to check if
264
client lives. %() expansions are done at
790
265
runtime with vars(self) as dict, so that for
791
266
instance %(name)s can be used in the command.
792
checker_initiator_tag: a GLib event source tag, or None
793
created: datetime.datetime(); (UTC) object creation
794
client_structure: Object describing what attributes a client has
795
and is used for storing the client at exit
796
267
current_checker_command: string; current running checker_command
797
disable_initiator_tag: a GLib event source tag, or None
799
fingerprint: string (40 or 32 hexadecimal digits); used to
800
uniquely identify the client
801
host: string; available for use by the checker command
802
interval: datetime.timedelta(); How often to start a new checker
803
last_approval_request: datetime.datetime(); (UTC) or None
804
last_checked_ok: datetime.datetime(); (UTC) or None
805
last_checker_status: integer between 0 and 255 reflecting exit
806
status of last checker. -1 reflects crashed
807
checker, -2 means no checker completed yet.
808
last_checker_signal: The signal which killed the last checker, if
809
last_checker_status is -1
810
last_enabled: datetime.datetime(); (UTC) or None
811
name: string; from the config file, used in log messages and
813
secret: bytestring; sent verbatim (over TLS) to client
814
timeout: datetime.timedelta(); How long from last_checked_ok
815
until this client is disabled
816
extended_timeout: extra long timeout when secret has been sent
817
runtime_expansions: Allowed attributes for runtime expansion.
818
expires: datetime.datetime(); time (UTC) when a client will be
820
server_settings: The server_settings dict from main()
268
approval_delay: datetime.timedelta(); Time to wait for approval
269
_approved: bool(); 'None' if not yet approved/disapproved
270
approval_duration: datetime.timedelta(); Duration of one approval
823
runtime_expansions = ("approval_delay", "approval_duration",
824
"created", "enabled", "expires",
825
"fingerprint", "host", "interval",
826
"last_approval_request", "last_checked_ok",
827
"last_enabled", "name", "timeout")
830
"extended_timeout": "PT15M",
832
"checker": "fping -q -- %%(host)s",
834
"approval_delay": "PT0S",
835
"approval_duration": "PT1S",
836
"approved_by_default": "True",
841
def config_parser(config):
842
"""Construct a new dict of client settings of this form:
843
{ client_name: {setting_name: value, ...}, ...}
844
with exceptions for any special settings as defined above.
845
NOTE: Must be a pure function. Must return the same result
846
value given the same arguments.
849
for client_name in config.sections():
850
section = dict(config.items(client_name))
851
client = settings[client_name] = {}
853
client["host"] = section["host"]
854
# Reformat values from string types to Python types
855
client["approved_by_default"] = config.getboolean(
856
client_name, "approved_by_default")
857
client["enabled"] = config.getboolean(client_name,
860
# Uppercase and remove spaces from fingerprint for later
861
# comparison purposes with return value from the
862
# fingerprint() function
863
client["fingerprint"] = (section["fingerprint"].upper()
865
if "secret" in section:
866
client["secret"] = codecs.decode(section["secret"]
869
elif "secfile" in section:
870
with open(os.path.expanduser(os.path.expandvars
871
(section["secfile"])),
873
client["secret"] = secfile.read()
875
raise TypeError("No secret or secfile for section {}"
877
client["timeout"] = string_to_delta(section["timeout"])
878
client["extended_timeout"] = string_to_delta(
879
section["extended_timeout"])
880
client["interval"] = string_to_delta(section["interval"])
881
client["approval_delay"] = string_to_delta(
882
section["approval_delay"])
883
client["approval_duration"] = string_to_delta(
884
section["approval_duration"])
885
client["checker_command"] = section["checker"]
886
client["last_approval_request"] = None
887
client["last_checked_ok"] = None
888
client["last_checker_status"] = -2
892
def __init__(self, settings, name=None, server_settings=None):
274
def _timedelta_to_milliseconds(td):
275
"Convert a datetime.timedelta() to milliseconds"
276
return ((td.days * 24 * 60 * 60 * 1000)
277
+ (td.seconds * 1000)
278
+ (td.microseconds // 1000))
280
def timeout_milliseconds(self):
281
"Return the 'timeout' attribute in milliseconds"
282
return self._timedelta_to_milliseconds(self.timeout)
284
def interval_milliseconds(self):
285
"Return the 'interval' attribute in milliseconds"
286
return self._timedelta_to_milliseconds(self.interval)
288
def approval_delay_milliseconds(self):
289
return self._timedelta_to_milliseconds(self.approval_delay)
291
def __init__(self, name = None, disable_hook=None, config=None):
292
"""Note: the 'checker' key in 'config' sets the
293
'checker_command' attribute and *not* the 'checker'
894
if server_settings is None:
896
self.server_settings = server_settings
897
# adding all client settings
898
for setting, value in settings.items():
899
setattr(self, setting, value)
902
if not hasattr(self, "last_enabled"):
903
self.last_enabled = datetime.datetime.utcnow()
904
if not hasattr(self, "expires"):
905
self.expires = (datetime.datetime.utcnow()
298
logger.debug(u"Creating client %r", self.name)
299
# Uppercase and remove spaces from fingerprint for later
300
# comparison purposes with return value from the fingerprint()
302
self.fingerprint = (config[u"fingerprint"].upper()
304
logger.debug(u" Fingerprint: %s", self.fingerprint)
305
if u"secret" in config:
306
self.secret = config[u"secret"].decode(u"base64")
307
elif u"secfile" in config:
308
with open(os.path.expanduser(os.path.expandvars
309
(config[u"secfile"])),
311
self.secret = secfile.read()
908
self.last_enabled = None
911
logger.debug("Creating client %r", self.name)
912
logger.debug(" Fingerprint: %s", self.fingerprint)
913
self.created = settings.get("created",
914
datetime.datetime.utcnow())
916
# attributes specific for this server instance
313
raise TypeError(u"No secret or secfile for client %s"
315
self.host = config.get(u"host", u"")
316
self.created = datetime.datetime.utcnow()
318
self.last_enabled = None
319
self.last_checked_ok = None
320
self.timeout = string_to_delta(config[u"timeout"])
321
self.interval = string_to_delta(config[u"interval"])
322
self.disable_hook = disable_hook
917
323
self.checker = None
918
324
self.checker_initiator_tag = None
919
325
self.disable_initiator_tag = None
920
326
self.checker_callback_tag = None
327
self.checker_command = config[u"checker"]
921
328
self.current_checker_command = None
329
self.last_connect = None
330
self._approved = None
331
self.approved_by_default = config.get(u"approved_by_default",
923
333
self.approvals_pending = 0
924
self.changedstate = multiprocessing_manager.Condition(
925
multiprocessing_manager.Lock())
926
self.client_structure = [attr
927
for attr in self.__dict__.keys()
928
if not attr.startswith("_")]
929
self.client_structure.append("client_structure")
931
for name, t in inspect.getmembers(
932
type(self), lambda obj: isinstance(obj, property)):
933
if not name.startswith("_"):
934
self.client_structure.append(name)
936
# Send notice to process children that client state has changed
334
self.approval_delay = string_to_delta(
335
config[u"approval_delay"])
336
self.approval_duration = string_to_delta(
337
config[u"approval_duration"])
338
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
937
340
def send_changedstate(self):
938
with self.changedstate:
939
self.changedstate.notify_all()
341
self.changedstate.acquire()
342
self.changedstate.notify_all()
343
self.changedstate.release()
941
345
def enable(self):
942
346
"""Start this client's checker and timeout hooks"""
943
if getattr(self, "enabled", False):
347
if getattr(self, u"enabled", False):
944
348
# Already enabled
946
self.expires = datetime.datetime.utcnow() + self.timeout
350
self.send_changedstate()
948
351
self.last_enabled = datetime.datetime.utcnow()
950
self.send_changedstate()
352
# Schedule a new checker to be started an 'interval' from now,
353
# and every interval from then on.
354
self.checker_initiator_tag = (gobject.timeout_add
355
(self.interval_milliseconds(),
357
# Schedule a disable() when 'timeout' has passed
358
self.disable_initiator_tag = (gobject.timeout_add
359
(self.timeout_milliseconds(),
362
# Also start a new checker *right now*.
952
365
def disable(self, quiet=True):
953
366
"""Disable this client."""
954
367
if not getattr(self, "enabled", False):
957
logger.info("Disabling client %s", self.name)
958
if getattr(self, "disable_initiator_tag", None) is not None:
959
GLib.source_remove(self.disable_initiator_tag)
370
self.send_changedstate()
372
logger.info(u"Disabling client %s", self.name)
373
if getattr(self, u"disable_initiator_tag", False):
374
gobject.source_remove(self.disable_initiator_tag)
960
375
self.disable_initiator_tag = None
962
if getattr(self, "checker_initiator_tag", None) is not None:
963
GLib.source_remove(self.checker_initiator_tag)
376
if getattr(self, u"checker_initiator_tag", False):
377
gobject.source_remove(self.checker_initiator_tag)
964
378
self.checker_initiator_tag = None
965
379
self.stop_checker()
380
if self.disable_hook:
381
self.disable_hook(self)
966
382
self.enabled = False
968
self.send_changedstate()
969
# Do not run this again if called by a GLib.timeout_add
383
# Do not run this again if called by a gobject.timeout_add
972
386
def __del__(self):
387
self.disable_hook = None
975
def init_checker(self):
976
# Schedule a new checker to be started an 'interval' from now,
977
# and every interval from then on.
978
if self.checker_initiator_tag is not None:
979
GLib.source_remove(self.checker_initiator_tag)
980
self.checker_initiator_tag = GLib.timeout_add(
981
int(self.interval.total_seconds() * 1000),
983
# Schedule a disable() when 'timeout' has passed
984
if self.disable_initiator_tag is not None:
985
GLib.source_remove(self.disable_initiator_tag)
986
self.disable_initiator_tag = GLib.timeout_add(
987
int(self.timeout.total_seconds() * 1000), self.disable)
988
# Also start a new checker *right now*.
991
def checker_callback(self, source, condition, connection,
390
def checker_callback(self, pid, condition, command):
993
391
"""The checker has completed, so take appropriate actions."""
994
392
self.checker_callback_tag = None
995
393
self.checker = None
996
# Read return code from connection (see call_pipe)
997
returncode = connection.recv()
1001
self.last_checker_status = returncode
1002
self.last_checker_signal = None
1003
if self.last_checker_status == 0:
1004
logger.info("Checker for %(name)s succeeded",
394
if os.WIFEXITED(condition):
395
exitstatus = os.WEXITSTATUS(condition)
397
logger.info(u"Checker for %(name)s succeeded",
1006
399
self.checked_ok()
1008
logger.info("Checker for %(name)s failed", vars(self))
401
logger.info(u"Checker for %(name)s failed",
1010
self.last_checker_status = -1
1011
self.last_checker_signal = -returncode
1012
logger.warning("Checker for %(name)s crashed?",
404
logger.warning(u"Checker for %(name)s crashed?",
1016
407
def checked_ok(self):
1017
"""Assert that the client has been seen, alive and well."""
408
"""Bump up the timeout for this client.
410
This should only be called when the client has been seen,
1018
413
self.last_checked_ok = datetime.datetime.utcnow()
1019
self.last_checker_status = 0
1020
self.last_checker_signal = None
1023
def bump_timeout(self, timeout=None):
1024
"""Bump up the timeout for this client."""
1026
timeout = self.timeout
1027
if self.disable_initiator_tag is not None:
1028
GLib.source_remove(self.disable_initiator_tag)
1029
self.disable_initiator_tag = None
1030
if getattr(self, "enabled", False):
1031
self.disable_initiator_tag = GLib.timeout_add(
1032
int(timeout.total_seconds() * 1000), self.disable)
1033
self.expires = datetime.datetime.utcnow() + timeout
1035
def need_approval(self):
1036
self.last_approval_request = datetime.datetime.utcnow()
414
gobject.source_remove(self.disable_initiator_tag)
415
self.disable_initiator_tag = (gobject.timeout_add
416
(self.timeout_milliseconds(),
1038
419
def start_checker(self):
1039
420
"""Start a new checker subprocess if one is not running.
1041
422
If a checker already exists, leave it running and do
1043
424
# The reason for not killing a running checker is that if we
1044
# did that, and if a checker (for some reason) started running
1045
# slowly and taking more than 'interval' time, then the client
1046
# would inevitably timeout, since no checker would get a
1047
# chance to run to completion. If we instead leave running
425
# did that, then if a checker (for some reason) started
426
# running slowly and taking more than 'interval' time, the
427
# client would inevitably timeout, since no checker would get
428
# a chance to run to completion. If we instead leave running
1048
429
# checkers alone, the checker would have to take more time
1049
430
# than 'timeout' for the client to be disabled, which is as it
1052
if self.checker is not None and not self.checker.is_alive():
1053
logger.warning("Checker was not alive; joining")
433
# If a checker exists, make sure it is not a zombie
435
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
436
except (AttributeError, OSError), error:
437
if (isinstance(error, OSError)
438
and error.errno != errno.ECHILD):
442
logger.warning(u"Checker was a zombie")
443
gobject.source_remove(self.checker_callback_tag)
444
self.checker_callback(pid, status,
445
self.current_checker_command)
1056
446
# Start a new checker if needed
1057
447
if self.checker is None:
1058
# Escape attributes for the shell
1060
attr: re.escape(str(getattr(self, attr)))
1061
for attr in self.runtime_expansions}
1063
command = self.checker_command % escaped_attrs
1064
except TypeError as error:
1065
logger.error('Could not format string "%s"',
1066
self.checker_command,
1068
return True # Try again later
449
# In case checker_command has exactly one % operator
450
command = self.checker_command % self.host
452
# Escape attributes for the shell
453
escaped_attrs = dict((key,
454
re.escape(unicode(str(val),
458
vars(self).iteritems())
460
command = self.checker_command % escaped_attrs
461
except TypeError, error:
462
logger.error(u'Could not format string "%s":'
463
u' %s', self.checker_command, error)
464
return True # Try again later
1069
465
self.current_checker_command = command
1070
logger.info("Starting checker %r for %s", command,
1072
# We don't need to redirect stdout and stderr, since
1073
# in normal mode, that is already done by daemon(),
1074
# and in debug mode we don't want to. (Stdin is
1075
# always replaced by /dev/null.)
1076
# The exception is when not debugging but nevertheless
1077
# running in the foreground; use the previously
1079
popen_args = {"close_fds": True,
1082
if (not self.server_settings["debug"]
1083
and self.server_settings["foreground"]):
1084
popen_args.update({"stdout": wnull,
1086
pipe = multiprocessing.Pipe(duplex=False)
1087
self.checker = multiprocessing.Process(
1089
args=(pipe[1], subprocess.call, command),
1091
self.checker.start()
1092
self.checker_callback_tag = GLib.io_add_watch(
1093
pipe[0].fileno(), GLib.IO_IN,
1094
self.checker_callback, pipe[0], command)
1095
# Re-run this periodically if run by GLib.timeout_add
467
logger.info(u"Starting checker %r for %s",
469
# We don't need to redirect stdout and stderr, since
470
# in normal mode, that is already done by daemon(),
471
# and in debug mode we don't want to. (Stdin is
472
# always replaced by /dev/null.)
473
self.checker = subprocess.Popen(command,
475
shell=True, cwd=u"/")
476
self.checker_callback_tag = (gobject.child_watch_add
478
self.checker_callback,
480
# The checker may have completed before the gobject
481
# watch was added. Check for this.
482
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
484
gobject.source_remove(self.checker_callback_tag)
485
self.checker_callback(pid, status, command)
486
except OSError, error:
487
logger.error(u"Failed to start subprocess: %s",
489
# Re-run this periodically if run by gobject.timeout_add
1098
492
def stop_checker(self):
1099
493
"""Force the checker process, if any, to stop."""
1100
494
if self.checker_callback_tag:
1101
GLib.source_remove(self.checker_callback_tag)
495
gobject.source_remove(self.checker_callback_tag)
1102
496
self.checker_callback_tag = None
1103
if getattr(self, "checker", None) is None:
497
if getattr(self, u"checker", None) is None:
1105
logger.debug("Stopping checker for %(name)s", vars(self))
1106
self.checker.terminate()
499
logger.debug(u"Stopping checker for %(name)s", vars(self))
501
os.kill(self.checker.pid, signal.SIGTERM)
503
#if self.checker.poll() is None:
504
# os.kill(self.checker.pid, signal.SIGKILL)
505
except OSError, error:
506
if error.errno != errno.ESRCH: # No such process
1107
508
self.checker = None
1110
def dbus_service_property(dbus_interface,
510
def dbus_service_property(dbus_interface, signature=u"v",
511
access=u"readwrite", byte_arrays=False):
1114
512
"""Decorators for marking methods of a DBusObjectWithProperties to
1115
513
become properties on the D-Bus.
1117
515
The decorated method will be called with no arguments by "Get"
1118
516
and with one argument by "Set".
1120
518
The parameters, where they are supported, are the same as
1121
519
dbus.service.method, except there is only "signature", since the
1122
520
type from Get() and the type sent to Set() is the same.
1124
522
# Encoding deeply encoded byte arrays is not supported yet by the
1125
523
# "Set" method, so we fail early here:
1126
if byte_arrays and signature != "ay":
1127
raise ValueError("Byte arrays not supported for non-'ay'"
1128
" signature {!r}".format(signature))
524
if byte_arrays and signature != u"ay":
525
raise ValueError(u"Byte arrays not supported for non-'ay'"
526
u" signature %r" % signature)
1130
527
def decorator(func):
1131
528
func._dbus_is_property = True
1132
529
func._dbus_interface = dbus_interface
1133
530
func._dbus_signature = signature
1134
531
func._dbus_access = access
1135
532
func._dbus_name = func.__name__
1136
if func._dbus_name.endswith("_dbus_property"):
533
if func._dbus_name.endswith(u"_dbus_property"):
1137
534
func._dbus_name = func._dbus_name[:-14]
1138
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1144
def dbus_interface_annotations(dbus_interface):
1145
"""Decorator for marking functions returning interface annotations
1149
@dbus_interface_annotations("org.example.Interface")
1150
def _foo(self): # Function name does not matter
1151
return {"org.freedesktop.DBus.Deprecated": "true",
1152
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1156
def decorator(func):
1157
func._dbus_is_interface = True
1158
func._dbus_interface = dbus_interface
1159
func._dbus_name = dbus_interface
1165
def dbus_annotations(annotations):
1166
"""Decorator to annotate D-Bus methods, signals or properties
1169
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1170
"org.freedesktop.DBus.Property."
1171
"EmitsChangedSignal": "false"})
1172
@dbus_service_property("org.example.Interface", signature="b",
1174
def Property_dbus_property(self):
1175
return dbus.Boolean(False)
1177
See also the DBusObjectWithAnnotations class.
1180
def decorator(func):
1181
func._dbus_annotations = annotations
535
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1184
537
return decorator
1187
540
class DBusPropertyException(dbus.exceptions.DBusException):
1188
541
"""A base class for D-Bus property-related exceptions
543
def __unicode__(self):
544
return unicode(str(self))
1193
547
class DBusPropertyAccessException(DBusPropertyException):
1205
class DBusObjectWithAnnotations(dbus.service.Object):
1206
"""A D-Bus object with annotations.
1208
Classes inheriting from this can use the dbus_annotations
1209
decorator to add annotations to methods or signals.
1213
def _is_dbus_thing(thing):
1214
"""Returns a function testing if an attribute is a D-Bus thing
1216
If called like _is_dbus_thing("method") it returns a function
1217
suitable for use as predicate to inspect.getmembers().
1219
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1222
def _get_all_dbus_things(self, thing):
1223
"""Returns a generator of (name, attribute) pairs
1225
return ((getattr(athing.__get__(self), "_dbus_name", name),
1226
athing.__get__(self))
1227
for cls in self.__class__.__mro__
1229
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1231
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1233
path_keyword='object_path',
1234
connection_keyword='connection')
1235
def Introspect(self, object_path, connection):
1236
"""Overloading of standard D-Bus method.
1238
Inserts annotation tags on methods and signals.
1240
xmlstring = dbus.service.Object.Introspect(self, object_path,
1243
document = xml.dom.minidom.parseString(xmlstring)
1245
for if_tag in document.getElementsByTagName("interface"):
1246
# Add annotation tags
1247
for typ in ("method", "signal"):
1248
for tag in if_tag.getElementsByTagName(typ):
1250
for name, prop in (self.
1251
_get_all_dbus_things(typ)):
1252
if (name == tag.getAttribute("name")
1253
and prop._dbus_interface
1254
== if_tag.getAttribute("name")):
1255
annots.update(getattr(
1256
prop, "_dbus_annotations", {}))
1257
for name, value in annots.items():
1258
ann_tag = document.createElement(
1260
ann_tag.setAttribute("name", name)
1261
ann_tag.setAttribute("value", value)
1262
tag.appendChild(ann_tag)
1263
# Add interface annotation tags
1264
for annotation, value in dict(
1265
itertools.chain.from_iterable(
1266
annotations().items()
1267
for name, annotations
1268
in self._get_all_dbus_things("interface")
1269
if name == if_tag.getAttribute("name")
1271
ann_tag = document.createElement("annotation")
1272
ann_tag.setAttribute("name", annotation)
1273
ann_tag.setAttribute("value", value)
1274
if_tag.appendChild(ann_tag)
1275
# Fix argument name for the Introspect method itself
1276
if (if_tag.getAttribute("name")
1277
== dbus.INTROSPECTABLE_IFACE):
1278
for cn in if_tag.getElementsByTagName("method"):
1279
if cn.getAttribute("name") == "Introspect":
1280
for arg in cn.getElementsByTagName("arg"):
1281
if (arg.getAttribute("direction")
1283
arg.setAttribute("name",
1285
xmlstring = document.toxml("utf-8")
1287
except (AttributeError, xml.dom.DOMException,
1288
xml.parsers.expat.ExpatError) as error:
1289
logger.error("Failed to override Introspection method",
1294
class DBusObjectWithProperties(DBusObjectWithAnnotations):
559
class DBusObjectWithProperties(dbus.service.Object):
1295
560
"""A D-Bus object with properties.
1297
562
Classes inheriting from this can use the dbus_service_property
1298
563
decorator to expose methods as D-Bus properties. It exposes the
1299
564
standard Get(), Set(), and GetAll() methods on the D-Bus.
568
def _is_dbus_property(obj):
569
return getattr(obj, u"_dbus_is_property", False)
571
def _get_all_dbus_properties(self):
572
"""Returns a generator of (name, attribute) pairs
574
return ((prop._dbus_name, prop)
576
inspect.getmembers(self, self._is_dbus_property))
1302
578
def _get_dbus_property(self, interface_name, property_name):
1303
579
"""Returns a bound method if one exists which is a D-Bus
1304
580
property with the specified name and interface.
1306
for cls in self.__class__.__mro__:
1307
for name, value in inspect.getmembers(
1308
cls, self._is_dbus_thing("property")):
1309
if (value._dbus_name == property_name
1310
and value._dbus_interface == interface_name):
1311
return value.__get__(self)
582
for name in (property_name,
583
property_name + u"_dbus_property"):
584
prop = getattr(self, name, None)
586
or not self._is_dbus_property(prop)
587
or prop._dbus_name != property_name
588
or (interface_name and prop._dbus_interface
589
and interface_name != prop._dbus_interface)):
1313
592
# No such property
1314
raise DBusPropertyNotFound("{}:{}.{}".format(
1315
self.dbus_object_path, interface_name, property_name))
1318
def _get_all_interface_names(cls):
1319
"""Get a sequence of all interfaces supported by an object"""
1320
return (name for name in set(getattr(getattr(x, attr),
1321
"_dbus_interface", None)
1322
for x in (inspect.getmro(cls))
1324
if name is not None)
1326
@dbus.service.method(dbus.PROPERTIES_IFACE,
593
raise DBusPropertyNotFound(self.dbus_object_path + u":"
594
+ interface_name + u"."
597
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1329
599
def Get(self, interface_name, property_name):
1330
600
"""Standard D-Bus property Get() method, see D-Bus standard.
1332
602
prop = self._get_dbus_property(interface_name, property_name)
1333
if prop._dbus_access == "write":
603
if prop._dbus_access == u"write":
1334
604
raise DBusPropertyAccessException(property_name)
1336
if not hasattr(value, "variant_level"):
606
if not hasattr(value, u"variant_level"):
1338
608
return type(value)(value, variant_level=value.variant_level+1)
1340
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1341
611
def Set(self, interface_name, property_name, value):
1342
612
"""Standard D-Bus property Set() method, see D-Bus standard.
1344
614
prop = self._get_dbus_property(interface_name, property_name)
1345
if prop._dbus_access == "read":
615
if prop._dbus_access == u"read":
1346
616
raise DBusPropertyAccessException(property_name)
1347
if prop._dbus_get_args_options["byte_arrays"]:
617
if prop._dbus_get_args_options[u"byte_arrays"]:
1348
618
# The byte_arrays option is not supported yet on
1349
619
# signatures other than "ay".
1350
if prop._dbus_signature != "ay":
1351
raise ValueError("Byte arrays not supported for non-"
1352
"'ay' signature {!r}"
1353
.format(prop._dbus_signature))
1354
value = dbus.ByteArray(b''.join(chr(byte)
620
if prop._dbus_signature != u"ay":
622
value = dbus.ByteArray(''.join(unichr(byte)
1358
@dbus.service.method(dbus.PROPERTIES_IFACE,
1360
out_signature="a{sv}")
626
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
627
out_signature=u"a{sv}")
1361
628
def GetAll(self, interface_name):
1362
629
"""Standard D-Bus property GetAll() method, see D-Bus
1365
632
Note: Will not include properties with access="write".
1368
for name, prop in self._get_all_dbus_things("property"):
635
for name, prop in self._get_all_dbus_properties():
1369
636
if (interface_name
1370
637
and interface_name != prop._dbus_interface):
1371
638
# Interface non-empty but did not match
1373
640
# Ignore write-only properties
1374
if prop._dbus_access == "write":
641
if prop._dbus_access == u"write":
1377
if not hasattr(value, "variant_level"):
1378
properties[name] = value
644
if not hasattr(value, u"variant_level"):
1380
properties[name] = type(value)(
1381
value, variant_level=value.variant_level + 1)
1382
return dbus.Dictionary(properties, signature="sv")
1384
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1385
def PropertiesChanged(self, interface_name, changed_properties,
1386
invalidated_properties):
1387
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
647
all[name] = type(value)(value, variant_level=
648
value.variant_level+1)
649
return dbus.Dictionary(all, signature=u"sv")
1392
651
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1394
653
path_keyword='object_path',
1395
654
connection_keyword='connection')
1396
655
def Introspect(self, object_path, connection):
1397
"""Overloading of standard D-Bus method.
1399
Inserts property tags and interface annotation tags.
656
"""Standard D-Bus method, overloaded to insert property tags.
1401
xmlstring = DBusObjectWithAnnotations.Introspect(self,
658
xmlstring = dbus.service.Object.Introspect(self, object_path,
1405
661
document = xml.dom.minidom.parseString(xmlstring)
1407
662
def make_tag(document, name, prop):
1408
e = document.createElement("property")
1409
e.setAttribute("name", name)
1410
e.setAttribute("type", prop._dbus_signature)
1411
e.setAttribute("access", prop._dbus_access)
663
e = document.createElement(u"property")
664
e.setAttribute(u"name", name)
665
e.setAttribute(u"type", prop._dbus_signature)
666
e.setAttribute(u"access", prop._dbus_access)
1414
for if_tag in document.getElementsByTagName("interface"):
668
for if_tag in document.getElementsByTagName(u"interface"):
1416
669
for tag in (make_tag(document, name, prop)
1418
in self._get_all_dbus_things("property")
671
in self._get_all_dbus_properties()
1419
672
if prop._dbus_interface
1420
== if_tag.getAttribute("name")):
673
== if_tag.getAttribute(u"name")):
1421
674
if_tag.appendChild(tag)
1422
# Add annotation tags for properties
1423
for tag in if_tag.getElementsByTagName("property"):
1425
for name, prop in self._get_all_dbus_things(
1427
if (name == tag.getAttribute("name")
1428
and prop._dbus_interface
1429
== if_tag.getAttribute("name")):
1430
annots.update(getattr(
1431
prop, "_dbus_annotations", {}))
1432
for name, value in annots.items():
1433
ann_tag = document.createElement(
1435
ann_tag.setAttribute("name", name)
1436
ann_tag.setAttribute("value", value)
1437
tag.appendChild(ann_tag)
1438
675
# Add the names to the return values for the
1439
676
# "org.freedesktop.DBus.Properties" methods
1440
if (if_tag.getAttribute("name")
1441
== "org.freedesktop.DBus.Properties"):
1442
for cn in if_tag.getElementsByTagName("method"):
1443
if cn.getAttribute("name") == "Get":
1444
for arg in cn.getElementsByTagName("arg"):
1445
if (arg.getAttribute("direction")
1447
arg.setAttribute("name", "value")
1448
elif cn.getAttribute("name") == "GetAll":
1449
for arg in cn.getElementsByTagName("arg"):
1450
if (arg.getAttribute("direction")
1452
arg.setAttribute("name", "props")
1453
xmlstring = document.toxml("utf-8")
1455
except (AttributeError, xml.dom.DOMException,
1456
xml.parsers.expat.ExpatError) as error:
1457
logger.error("Failed to override Introspection method",
1462
dbus.OBJECT_MANAGER_IFACE
1463
except AttributeError:
1464
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1467
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1468
"""A D-Bus object with an ObjectManager.
1470
Classes inheriting from this exposes the standard
1471
GetManagedObjects call and the InterfacesAdded and
1472
InterfacesRemoved signals on the standard
1473
"org.freedesktop.DBus.ObjectManager" interface.
1475
Note: No signals are sent automatically; they must be sent
1478
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1479
out_signature="a{oa{sa{sv}}}")
1480
def GetManagedObjects(self):
1481
"""This function must be overridden"""
1482
raise NotImplementedError()
1484
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1485
signature="oa{sa{sv}}")
1486
def InterfacesAdded(self, object_path, interfaces_and_properties):
1489
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1490
def InterfacesRemoved(self, object_path, interfaces):
1493
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1495
path_keyword='object_path',
1496
connection_keyword='connection')
1497
def Introspect(self, object_path, connection):
1498
"""Overloading of standard D-Bus method.
1500
Override return argument name of GetManagedObjects to be
1501
"objpath_interfaces_and_properties"
1503
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1507
document = xml.dom.minidom.parseString(xmlstring)
1509
for if_tag in document.getElementsByTagName("interface"):
1510
# Fix argument name for the GetManagedObjects method
1511
if (if_tag.getAttribute("name")
1512
== dbus.OBJECT_MANAGER_IFACE):
1513
for cn in if_tag.getElementsByTagName("method"):
1514
if (cn.getAttribute("name")
1515
== "GetManagedObjects"):
1516
for arg in cn.getElementsByTagName("arg"):
1517
if (arg.getAttribute("direction")
1521
"objpath_interfaces"
1523
xmlstring = document.toxml("utf-8")
1525
except (AttributeError, xml.dom.DOMException,
1526
xml.parsers.expat.ExpatError) as error:
1527
logger.error("Failed to override Introspection method",
1532
def datetime_to_dbus(dt, variant_level=0):
1533
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1535
return dbus.String("", variant_level=variant_level)
1536
return dbus.String(dt.isoformat(), variant_level=variant_level)
1539
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1540
"""A class decorator; applied to a subclass of
1541
dbus.service.Object, it will add alternate D-Bus attributes with
1542
interface names according to the "alt_interface_names" mapping.
1545
@alternate_dbus_interfaces({"org.example.Interface":
1546
"net.example.AlternateInterface"})
1547
class SampleDBusObject(dbus.service.Object):
1548
@dbus.service.method("org.example.Interface")
1549
def SampleDBusMethod():
1552
The above "SampleDBusMethod" on "SampleDBusObject" will be
1553
reachable via two interfaces: "org.example.Interface" and
1554
"net.example.AlternateInterface", the latter of which will have
1555
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1556
"true", unless "deprecate" is passed with a False value.
1558
This works for methods and signals, and also for D-Bus properties
1559
(from DBusObjectWithProperties) and interfaces (from the
1560
dbus_interface_annotations decorator).
1564
for orig_interface_name, alt_interface_name in (
1565
alt_interface_names.items()):
1567
interface_names = set()
1568
# Go though all attributes of the class
1569
for attrname, attribute in inspect.getmembers(cls):
1570
# Ignore non-D-Bus attributes, and D-Bus attributes
1571
# with the wrong interface name
1572
if (not hasattr(attribute, "_dbus_interface")
1573
or not attribute._dbus_interface.startswith(
1574
orig_interface_name)):
1576
# Create an alternate D-Bus interface name based on
1578
alt_interface = attribute._dbus_interface.replace(
1579
orig_interface_name, alt_interface_name)
1580
interface_names.add(alt_interface)
1581
# Is this a D-Bus signal?
1582
if getattr(attribute, "_dbus_is_signal", False):
1583
# Extract the original non-method undecorated
1584
# function by black magic
1585
if sys.version_info.major == 2:
1586
nonmethod_func = (dict(
1587
zip(attribute.func_code.co_freevars,
1588
attribute.__closure__))
1589
["func"].cell_contents)
1591
nonmethod_func = (dict(
1592
zip(attribute.__code__.co_freevars,
1593
attribute.__closure__))
1594
["func"].cell_contents)
1595
# Create a new, but exactly alike, function
1596
# object, and decorate it to be a new D-Bus signal
1597
# with the alternate D-Bus interface name
1598
new_function = copy_function(nonmethod_func)
1599
new_function = (dbus.service.signal(
1601
attribute._dbus_signature)(new_function))
1602
# Copy annotations, if any
1604
new_function._dbus_annotations = dict(
1605
attribute._dbus_annotations)
1606
except AttributeError:
1609
# Define a creator of a function to call both the
1610
# original and alternate functions, so both the
1611
# original and alternate signals gets sent when
1612
# the function is called
1613
def fixscope(func1, func2):
1614
"""This function is a scope container to pass
1615
func1 and func2 to the "call_both" function
1616
outside of its arguments"""
1618
@functools.wraps(func2)
1619
def call_both(*args, **kwargs):
1620
"""This function will emit two D-Bus
1621
signals by calling func1 and func2"""
1622
func1(*args, **kwargs)
1623
func2(*args, **kwargs)
1624
# Make wrapper function look like a D-Bus
1626
for name, attr in inspect.getmembers(func2):
1627
if name.startswith("_dbus_"):
1628
setattr(call_both, name, attr)
1631
# Create the "call_both" function and add it to
1633
attr[attrname] = fixscope(attribute, new_function)
1634
# Is this a D-Bus method?
1635
elif getattr(attribute, "_dbus_is_method", False):
1636
# Create a new, but exactly alike, function
1637
# object. Decorate it to be a new D-Bus method
1638
# with the alternate D-Bus interface name. Add it
1641
dbus.service.method(
1643
attribute._dbus_in_signature,
1644
attribute._dbus_out_signature)
1645
(copy_function(attribute)))
1646
# Copy annotations, if any
1648
attr[attrname]._dbus_annotations = dict(
1649
attribute._dbus_annotations)
1650
except AttributeError:
1652
# Is this a D-Bus property?
1653
elif getattr(attribute, "_dbus_is_property", False):
1654
# Create a new, but exactly alike, function
1655
# object, and decorate it to be a new D-Bus
1656
# property with the alternate D-Bus interface
1657
# name. Add it to the class.
1658
attr[attrname] = (dbus_service_property(
1659
alt_interface, attribute._dbus_signature,
1660
attribute._dbus_access,
1661
attribute._dbus_get_args_options
1663
(copy_function(attribute)))
1664
# Copy annotations, if any
1666
attr[attrname]._dbus_annotations = dict(
1667
attribute._dbus_annotations)
1668
except AttributeError:
1670
# Is this a D-Bus interface?
1671
elif getattr(attribute, "_dbus_is_interface", False):
1672
# Create a new, but exactly alike, function
1673
# object. Decorate it to be a new D-Bus interface
1674
# with the alternate D-Bus interface name. Add it
1677
dbus_interface_annotations(alt_interface)
1678
(copy_function(attribute)))
1680
# Deprecate all alternate interfaces
1681
iname = "_AlternateDBusNames_interface_annotation{}"
1682
for interface_name in interface_names:
1684
@dbus_interface_annotations(interface_name)
1686
return {"org.freedesktop.DBus.Deprecated":
1688
# Find an unused name
1689
for aname in (iname.format(i)
1690
for i in itertools.count()):
1691
if aname not in attr:
1695
# Replace the class with a new subclass of it with
1696
# methods, signals, etc. as created above.
1697
if sys.version_info.major == 2:
1698
cls = type(b"{}Alternate".format(cls.__name__),
1701
cls = type("{}Alternate".format(cls.__name__),
1708
@alternate_dbus_interfaces({"se.recompile.Mandos":
1709
"se.bsnet.fukt.Mandos"})
677
if (if_tag.getAttribute(u"name")
678
== u"org.freedesktop.DBus.Properties"):
679
for cn in if_tag.getElementsByTagName(u"method"):
680
if cn.getAttribute(u"name") == u"Get":
681
for arg in cn.getElementsByTagName(u"arg"):
682
if (arg.getAttribute(u"direction")
684
arg.setAttribute(u"name", u"value")
685
elif cn.getAttribute(u"name") == u"GetAll":
686
for arg in cn.getElementsByTagName(u"arg"):
687
if (arg.getAttribute(u"direction")
689
arg.setAttribute(u"name", u"props")
690
xmlstring = document.toxml(u"utf-8")
692
except (AttributeError, xml.dom.DOMException,
693
xml.parsers.expat.ExpatError), error:
694
logger.error(u"Failed to override Introspection method",
1710
699
class ClientDBus(Client, DBusObjectWithProperties):
1711
700
"""A Client class using D-Bus
1714
703
dbus_object_path: dbus.ObjectPath
1715
704
bus: dbus.SystemBus()
1718
runtime_expansions = (Client.runtime_expansions
1719
+ ("dbus_object_path", ))
1721
_interface = "se.recompile.Mandos.Client"
1723
706
# dbus.service.Object doesn't use super(), so we can't either.
1725
def __init__(self, bus=None, *args, **kwargs):
708
def __init__(self, bus = None, *args, **kwargs):
709
self._approvals_pending = 0
1727
711
Client.__init__(self, *args, **kwargs)
1728
712
# Only now, when this client is initialized, can it show up on
1730
client_object_name = str(self.name).translate(
1731
{ord("."): ord("_"),
1732
ord("-"): ord("_")})
1733
self.dbus_object_path = dbus.ObjectPath(
1734
"/clients/" + client_object_name)
714
self.dbus_object_path = (dbus.ObjectPath
716
+ self.name.replace(u".", u"_")))
1735
717
DBusObjectWithProperties.__init__(self, self.bus,
1736
718
self.dbus_object_path)
1738
def notifychangeproperty(transform_func, dbus_name,
1739
type_func=lambda x: x,
1741
invalidate_only=False,
1742
_interface=_interface):
1743
""" Modify a variable so that it's a property which announces
1744
its changes to DBus.
1746
transform_fun: Function that takes a value and a variant_level
1747
and transforms it to a D-Bus type.
1748
dbus_name: D-Bus name of the variable
1749
type_func: Function that transform the value before sending it
1750
to the D-Bus. Default: no transform
1751
variant_level: D-Bus variant level. Default: 1
1753
attrname = "_{}".format(dbus_name)
1755
def setter(self, value):
1756
if hasattr(self, "dbus_object_path"):
1757
if (not hasattr(self, attrname) or
1758
type_func(getattr(self, attrname, None))
1759
!= type_func(value)):
1761
self.PropertiesChanged(
1762
_interface, dbus.Dictionary(),
1763
dbus.Array((dbus_name, )))
1765
dbus_value = transform_func(
1767
variant_level=variant_level)
1768
self.PropertyChanged(dbus.String(dbus_name),
1770
self.PropertiesChanged(
1772
dbus.Dictionary({dbus.String(dbus_name):
1775
setattr(self, attrname, value)
1777
return property(lambda self: getattr(self, attrname), setter)
1779
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1780
approvals_pending = notifychangeproperty(dbus.Boolean,
1783
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1784
last_enabled = notifychangeproperty(datetime_to_dbus,
1786
checker = notifychangeproperty(
1787
dbus.Boolean, "CheckerRunning",
1788
type_func=lambda checker: checker is not None)
1789
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1791
last_checker_status = notifychangeproperty(dbus.Int16,
1792
"LastCheckerStatus")
1793
last_approval_request = notifychangeproperty(
1794
datetime_to_dbus, "LastApprovalRequest")
1795
approved_by_default = notifychangeproperty(dbus.Boolean,
1796
"ApprovedByDefault")
1797
approval_delay = notifychangeproperty(
1798
dbus.UInt64, "ApprovalDelay",
1799
type_func=lambda td: td.total_seconds() * 1000)
1800
approval_duration = notifychangeproperty(
1801
dbus.UInt64, "ApprovalDuration",
1802
type_func=lambda td: td.total_seconds() * 1000)
1803
host = notifychangeproperty(dbus.String, "Host")
1804
timeout = notifychangeproperty(
1805
dbus.UInt64, "Timeout",
1806
type_func=lambda td: td.total_seconds() * 1000)
1807
extended_timeout = notifychangeproperty(
1808
dbus.UInt64, "ExtendedTimeout",
1809
type_func=lambda td: td.total_seconds() * 1000)
1810
interval = notifychangeproperty(
1811
dbus.UInt64, "Interval",
1812
type_func=lambda td: td.total_seconds() * 1000)
1813
checker_command = notifychangeproperty(dbus.String, "Checker")
1814
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1815
invalidate_only=True)
1817
del notifychangeproperty
720
def _get_approvals_pending(self):
721
return self._approvals_pending
722
def _set_approvals_pending(self, value):
723
old_value = self._approvals_pending
724
self._approvals_pending = value
726
if (hasattr(self, "dbus_object_path")
727
and bval is not bool(old_value)):
728
dbus_bool = dbus.Boolean(bval, variant_level=1)
729
self.PropertyChanged(dbus.String(u"ApprovalPending"),
732
approvals_pending = property(_get_approvals_pending,
733
_set_approvals_pending)
734
del _get_approvals_pending, _set_approvals_pending
737
def _datetime_to_dbus(dt, variant_level=0):
738
"""Convert a UTC datetime.datetime() to a D-Bus type."""
739
return dbus.String(dt.isoformat(),
740
variant_level=variant_level)
743
oldstate = getattr(self, u"enabled", False)
744
r = Client.enable(self)
745
if oldstate != self.enabled:
747
self.PropertyChanged(dbus.String(u"Enabled"),
748
dbus.Boolean(True, variant_level=1))
749
self.PropertyChanged(
750
dbus.String(u"LastEnabled"),
751
self._datetime_to_dbus(self.last_enabled,
755
def disable(self, quiet = False):
756
oldstate = getattr(self, u"enabled", False)
757
r = Client.disable(self, quiet=quiet)
758
if not quiet and oldstate != self.enabled:
760
self.PropertyChanged(dbus.String(u"Enabled"),
761
dbus.Boolean(False, variant_level=1))
1819
764
def __del__(self, *args, **kwargs):
1821
766
self.remove_from_connection()
1822
767
except LookupError:
1824
if hasattr(DBusObjectWithProperties, "__del__"):
769
if hasattr(DBusObjectWithProperties, u"__del__"):
1825
770
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1826
771
Client.__del__(self, *args, **kwargs)
1828
def checker_callback(self, source, condition,
1829
connection, command, *args, **kwargs):
1830
ret = Client.checker_callback(self, source, condition,
1831
connection, command, *args,
1833
exitstatus = self.last_checker_status
773
def checker_callback(self, pid, condition, command,
775
self.checker_callback_tag = None
778
self.PropertyChanged(dbus.String(u"CheckerRunning"),
779
dbus.Boolean(False, variant_level=1))
780
if os.WIFEXITED(condition):
781
exitstatus = os.WEXITSTATUS(condition)
1835
782
# Emit D-Bus signal
1836
783
self.CheckerCompleted(dbus.Int16(exitstatus),
1837
# This is specific to GNU libC
1838
dbus.Int64(exitstatus << 8),
784
dbus.Int64(condition),
1839
785
dbus.String(command))
1841
787
# Emit D-Bus signal
1842
788
self.CheckerCompleted(dbus.Int16(-1),
1844
# This is specific to GNU libC
1846
| self.last_checker_signal),
789
dbus.Int64(condition),
1847
790
dbus.String(command))
792
return Client.checker_callback(self, pid, condition, command,
795
def checked_ok(self, *args, **kwargs):
796
r = Client.checked_ok(self, *args, **kwargs)
798
self.PropertyChanged(
799
dbus.String(u"LastCheckedOK"),
800
(self._datetime_to_dbus(self.last_checked_ok,
1850
804
def start_checker(self, *args, **kwargs):
1851
old_checker_pid = getattr(self.checker, "pid", None)
805
old_checker = self.checker
806
if self.checker is not None:
807
old_checker_pid = self.checker.pid
809
old_checker_pid = None
1852
810
r = Client.start_checker(self, *args, **kwargs)
1853
811
# Only if new checker process was started
1854
812
if (self.checker is not None
1855
813
and old_checker_pid != self.checker.pid):
1856
814
# Emit D-Bus signal
1857
815
self.CheckerStarted(self.current_checker_command)
816
self.PropertyChanged(
817
dbus.String(u"CheckerRunning"),
818
dbus.Boolean(True, variant_level=1))
821
def stop_checker(self, *args, **kwargs):
822
old_checker = getattr(self, u"checker", None)
823
r = Client.stop_checker(self, *args, **kwargs)
824
if (old_checker is not None
825
and getattr(self, u"checker", None) is None):
826
self.PropertyChanged(dbus.String(u"CheckerRunning"),
827
dbus.Boolean(False, variant_level=1))
1860
830
def _reset_approved(self):
1861
self.approved = None
831
self._approved = None
1864
834
def approve(self, value=True):
1865
self.approved = value
1866
GLib.timeout_add(int(self.approval_duration.total_seconds()
1867
* 1000), self._reset_approved)
1868
835
self.send_changedstate()
1870
# D-Bus methods, signals & properties
836
self._approved = value
837
gobject.timeout_add(self._timedelta_to_milliseconds
838
(self.approval_duration),
839
self._reset_approved)
842
## D-Bus methods, signals & properties
843
_interface = u"se.bsnet.fukt.Mandos.Client"
1876
847
# CheckerCompleted - signal
1877
@dbus.service.signal(_interface, signature="nxs")
848
@dbus.service.signal(_interface, signature=u"nxs")
1878
849
def CheckerCompleted(self, exitcode, waitstatus, command):
1882
853
# CheckerStarted - signal
1883
@dbus.service.signal(_interface, signature="s")
854
@dbus.service.signal(_interface, signature=u"s")
1884
855
def CheckerStarted(self, command):
1888
859
# PropertyChanged - signal
1889
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1890
@dbus.service.signal(_interface, signature="sv")
860
@dbus.service.signal(_interface, signature=u"sv")
1891
861
def PropertyChanged(self, property, value):
1895
865
# GotSecret - signal
1896
866
@dbus.service.signal(_interface)
1897
867
def GotSecret(self):
2294
1244
if self.server.use_dbus:
2295
1245
# Emit D-Bus signal
2296
client.Rejected("Approval timed out")
1246
client.Rejected("Timed out")
2301
1251
delay -= time2 - time
2304
session.send(client.secret)
2305
except gnutls.Error as error:
2306
logger.warning("gnutls send failed",
2310
logger.info("Sending secret to %s", client.name)
2311
# bump the timeout using extended_timeout
2312
client.bump_timeout(client.extended_timeout)
1254
while sent_size < len(client.secret):
1256
sent = session.send(client.secret[sent_size:])
1257
except (gnutls.errors.GNUTLSError), error:
1258
logger.warning("gnutls send failed")
1260
logger.debug(u"Sent: %d, remaining: %d",
1261
sent, len(client.secret)
1262
- (sent_size + sent))
1265
logger.info(u"Sending secret to %s", client.name)
1266
# bump the timeout as if seen
2313
1268
if self.server.use_dbus:
2314
1269
# Emit D-Bus signal
2315
1270
client.GotSecret()
2318
1273
if approval_required:
2319
1274
client.approvals_pending -= 1
2322
except gnutls.Error as error:
2323
logger.warning("GnuTLS bye failed",
1277
except (gnutls.errors.GNUTLSError), error:
1278
logger.warning("GnuTLS bye failed")
2327
1281
def peer_certificate(session):
2328
1282
"Return the peer's OpenPGP certificate as a bytestring"
2329
1283
# If not an OpenPGP certificate...
2330
if (gnutls.certificate_type_get(session._c_object)
2331
!= gnutls.CRT_OPENPGP):
2332
# ...return invalid data
1284
if (gnutls.library.functions
1285
.gnutls_certificate_type_get(session._c_object)
1286
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1287
# ...do the normal thing
1288
return session.peer_certificate
2334
1289
list_size = ctypes.c_uint(1)
2335
cert_list = (gnutls.certificate_get_peers
1290
cert_list = (gnutls.library.functions
1291
.gnutls_certificate_get_peers
2336
1292
(session._c_object, ctypes.byref(list_size)))
2337
1293
if not bool(cert_list) and list_size.value != 0:
2338
raise gnutls.Error("error getting peer certificate")
1294
raise gnutls.errors.GNUTLSError(u"error getting peer"
2339
1296
if list_size.value == 0:
2341
1298
cert = cert_list[0]
2342
1299
return ctypes.string_at(cert.data, cert.size)
2345
1302
def fingerprint(openpgp):
2346
1303
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2347
1304
# New GnuTLS "datum" with the OpenPGP public key
2348
datum = gnutls.datum_t(
2349
ctypes.cast(ctypes.c_char_p(openpgp),
2350
ctypes.POINTER(ctypes.c_ubyte)),
2351
ctypes.c_uint(len(openpgp)))
1305
datum = (gnutls.library.types
1306
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1309
ctypes.c_uint(len(openpgp))))
2352
1310
# New empty GnuTLS certificate
2353
crt = gnutls.openpgp_crt_t()
2354
gnutls.openpgp_crt_init(ctypes.byref(crt))
1311
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1312
(gnutls.library.functions
1313
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2355
1314
# Import the OpenPGP public key into the certificate
2356
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2357
gnutls.OPENPGP_FMT_RAW)
1315
(gnutls.library.functions
1316
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1317
gnutls.library.constants
1318
.GNUTLS_OPENPGP_FMT_RAW))
2358
1319
# Verify the self signature in the key
2359
1320
crtverify = ctypes.c_uint()
2360
gnutls.openpgp_crt_verify_self(crt, 0,
2361
ctypes.byref(crtverify))
1321
(gnutls.library.functions
1322
.gnutls_openpgp_crt_verify_self(crt, 0,
1323
ctypes.byref(crtverify)))
2362
1324
if crtverify.value != 0:
2363
gnutls.openpgp_crt_deinit(crt)
2364
raise gnutls.CertificateSecurityError("Verify failed")
1325
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1326
raise (gnutls.errors.CertificateSecurityError
2365
1328
# New buffer for the fingerprint
2366
1329
buf = ctypes.create_string_buffer(20)
2367
1330
buf_len = ctypes.c_size_t()
2368
1331
# Get the fingerprint from the certificate into the buffer
2369
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2370
ctypes.byref(buf_len))
1332
(gnutls.library.functions
1333
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1334
ctypes.byref(buf_len)))
2371
1335
# Deinit the certificate
2372
gnutls.openpgp_crt_deinit(crt)
1336
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2373
1337
# Convert the buffer to a Python bytestring
2374
1338
fpr = ctypes.string_at(buf, buf_len.value)
2375
1339
# Convert the bytestring to hexadecimal notation
2376
hex_fpr = binascii.hexlify(fpr).upper()
1340
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2380
1344
class MultiprocessingMixIn(object):
2381
1345
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2383
1346
def sub_process_main(self, request, address):
2385
1348
self.finish_request(request, address)
2387
1350
self.handle_error(request, address)
2388
1351
self.close_request(request)
2390
1353
def process_request(self, request, address):
2391
1354
"""Start a new process to process the request."""
2392
proc = multiprocessing.Process(target=self.sub_process_main,
2393
args=(request, address))
1355
multiprocessing.Process(target = self.sub_process_main,
1356
args = (request, address)).start()
2398
1358
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2399
1359
""" adds a pipe to the MixIn """
2401
1360
def process_request(self, request, client_address):
2402
1361
"""Overrides and wraps the original process_request().
2404
1363
This function creates a new pipe in self.pipe
2406
1365
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2408
proc = MultiprocessingMixIn.process_request(self, request,
1367
super(MultiprocessingMixInWithPipe,
1368
self).process_request(request, client_address)
2410
1369
self.child_pipe.close()
2411
self.add_pipe(parent_pipe, proc)
1370
self.add_pipe(parent_pipe)
2413
def add_pipe(self, parent_pipe, proc):
1372
def add_pipe(self, parent_pipe):
2414
1373
"""Dummy function; override as necessary"""
2415
raise NotImplementedError()
2418
1376
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2419
1377
socketserver.TCPServer, object):
2420
1378
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2423
1381
enabled: Boolean; whether this server is activated yet
2424
1382
interface: None or a network interface name (string)
2425
1383
use_ipv6: Boolean; to use IPv6 or not
2428
1385
def __init__(self, server_address, RequestHandlerClass,
2432
"""If socketfd is set, use that file descriptor instead of
2433
creating a new one with socket.socket().
1386
interface=None, use_ipv6=True):
2435
1387
self.interface = interface
2437
1389
self.address_family = socket.AF_INET6
2438
if socketfd is not None:
2439
# Save the file descriptor
2440
self.socketfd = socketfd
2441
# Save the original socket.socket() function
2442
self.socket_socket = socket.socket
2444
# To implement --socket, we monkey patch socket.socket.
2446
# (When socketserver.TCPServer is a new-style class, we
2447
# could make self.socket into a property instead of monkey
2448
# patching socket.socket.)
2450
# Create a one-time-only replacement for socket.socket()
2451
@functools.wraps(socket.socket)
2452
def socket_wrapper(*args, **kwargs):
2453
# Restore original function so subsequent calls are
2455
socket.socket = self.socket_socket
2456
del self.socket_socket
2457
# This time only, return a new socket object from the
2458
# saved file descriptor.
2459
return socket.fromfd(self.socketfd, *args, **kwargs)
2460
# Replace socket.socket() function with wrapper
2461
socket.socket = socket_wrapper
2462
# The socketserver.TCPServer.__init__ will call
2463
# socket.socket(), which might be our replacement,
2464
# socket_wrapper(), if socketfd was set.
2465
1390
socketserver.TCPServer.__init__(self, server_address,
2466
1391
RequestHandlerClass)
2468
1392
def server_bind(self):
2469
1393
"""This overrides the normal server_bind() function
2470
1394
to bind to an interface if one was specified, and also NOT to
2471
1395
bind to an address or port if they were not specified."""
2472
global SO_BINDTODEVICE
2473
1396
if self.interface is not None:
2474
1397
if SO_BINDTODEVICE is None:
2475
# Fall back to a hard-coded value which seems to be
2477
logger.warning("SO_BINDTODEVICE not found, trying 25")
2478
SO_BINDTODEVICE = 25
2480
self.socket.setsockopt(
2481
socket.SOL_SOCKET, SO_BINDTODEVICE,
2482
(self.interface + "\0").encode("utf-8"))
2483
except socket.error as error:
2484
if error.errno == errno.EPERM:
2485
logger.error("No permission to bind to"
2486
" interface %s", self.interface)
2487
elif error.errno == errno.ENOPROTOOPT:
2488
logger.error("SO_BINDTODEVICE not available;"
2489
" cannot bind to interface %s",
2491
elif error.errno == errno.ENODEV:
2492
logger.error("Interface %s does not exist,"
2493
" cannot bind", self.interface)
1398
logger.error(u"SO_BINDTODEVICE does not exist;"
1399
u" cannot bind to interface %s",
1403
self.socket.setsockopt(socket.SOL_SOCKET,
1407
except socket.error, error:
1408
if error[0] == errno.EPERM:
1409
logger.error(u"No permission to"
1410
u" bind to interface %s",
1412
elif error[0] == errno.ENOPROTOOPT:
1413
logger.error(u"SO_BINDTODEVICE not available;"
1414
u" cannot bind to interface %s",
2496
1418
# Only bind(2) the socket if we really need to.
2497
1419
if self.server_address[0] or self.server_address[1]:
2498
1420
if not self.server_address[0]:
2499
1421
if self.address_family == socket.AF_INET6:
2500
any_address = "::" # in6addr_any
1422
any_address = u"::" # in6addr_any
2502
any_address = "0.0.0.0" # INADDR_ANY
1424
any_address = socket.INADDR_ANY
2503
1425
self.server_address = (any_address,
2504
1426
self.server_address[1])
2505
1427
elif not self.server_address[1]:
2506
self.server_address = (self.server_address[0], 0)
1428
self.server_address = (self.server_address[0],
2507
1430
# if self.interface:
2508
1431
# self.server_address = (self.server_address[0],
2631
def rfc3339_duration_to_delta(duration):
2632
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2634
>>> rfc3339_duration_to_delta("P7D")
2635
datetime.timedelta(7)
2636
>>> rfc3339_duration_to_delta("PT60S")
2637
datetime.timedelta(0, 60)
2638
>>> rfc3339_duration_to_delta("PT60M")
2639
datetime.timedelta(0, 3600)
2640
>>> rfc3339_duration_to_delta("PT24H")
2641
datetime.timedelta(1)
2642
>>> rfc3339_duration_to_delta("P1W")
2643
datetime.timedelta(7)
2644
>>> rfc3339_duration_to_delta("PT5M30S")
2645
datetime.timedelta(0, 330)
2646
>>> rfc3339_duration_to_delta("P1DT3M20S")
2647
datetime.timedelta(1, 200)
2650
# Parsing an RFC 3339 duration with regular expressions is not
2651
# possible - there would have to be multiple places for the same
2652
# values, like seconds. The current code, while more esoteric, is
2653
# cleaner without depending on a parsing library. If Python had a
2654
# built-in library for parsing we would use it, but we'd like to
2655
# avoid excessive use of external libraries.
2657
# New type for defining tokens, syntax, and semantics all-in-one
2658
Token = collections.namedtuple("Token", (
2659
"regexp", # To match token; if "value" is not None, must have
2660
# a "group" containing digits
2661
"value", # datetime.timedelta or None
2662
"followers")) # Tokens valid after this token
2663
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2664
# the "duration" ABNF definition in RFC 3339, Appendix A.
2665
token_end = Token(re.compile(r"$"), None, frozenset())
2666
token_second = Token(re.compile(r"(\d+)S"),
2667
datetime.timedelta(seconds=1),
2668
frozenset((token_end, )))
2669
token_minute = Token(re.compile(r"(\d+)M"),
2670
datetime.timedelta(minutes=1),
2671
frozenset((token_second, token_end)))
2672
token_hour = Token(re.compile(r"(\d+)H"),
2673
datetime.timedelta(hours=1),
2674
frozenset((token_minute, token_end)))
2675
token_time = Token(re.compile(r"T"),
2677
frozenset((token_hour, token_minute,
2679
token_day = Token(re.compile(r"(\d+)D"),
2680
datetime.timedelta(days=1),
2681
frozenset((token_time, token_end)))
2682
token_month = Token(re.compile(r"(\d+)M"),
2683
datetime.timedelta(weeks=4),
2684
frozenset((token_day, token_end)))
2685
token_year = Token(re.compile(r"(\d+)Y"),
2686
datetime.timedelta(weeks=52),
2687
frozenset((token_month, token_end)))
2688
token_week = Token(re.compile(r"(\d+)W"),
2689
datetime.timedelta(weeks=1),
2690
frozenset((token_end, )))
2691
token_duration = Token(re.compile(r"P"), None,
2692
frozenset((token_year, token_month,
2693
token_day, token_time,
2695
# Define starting values:
2697
value = datetime.timedelta()
2699
# Following valid tokens
2700
followers = frozenset((token_duration, ))
2701
# String left to parse
2703
# Loop until end token is found
2704
while found_token is not token_end:
2705
# Search for any currently valid tokens
2706
for token in followers:
2707
match = token.regexp.match(s)
2708
if match is not None:
2710
if token.value is not None:
2711
# Value found, parse digits
2712
factor = int(match.group(1), 10)
2713
# Add to value so far
2714
value += factor * token.value
2715
# Strip token from string
2716
s = token.regexp.sub("", s, 1)
2719
# Set valid next tokens
2720
followers = found_token.followers
2723
# No currently valid tokens were found
2724
raise ValueError("Invalid RFC 3339 duration: {!r}"
2730
1549
def string_to_delta(interval):
2731
1550
"""Parse a string and return a datetime.timedelta
2733
>>> string_to_delta('7d')
1552
>>> string_to_delta(u'7d')
2734
1553
datetime.timedelta(7)
2735
>>> string_to_delta('60s')
1554
>>> string_to_delta(u'60s')
2736
1555
datetime.timedelta(0, 60)
2737
>>> string_to_delta('60m')
1556
>>> string_to_delta(u'60m')
2738
1557
datetime.timedelta(0, 3600)
2739
>>> string_to_delta('24h')
1558
>>> string_to_delta(u'24h')
2740
1559
datetime.timedelta(1)
2741
>>> string_to_delta('1w')
1560
>>> string_to_delta(u'1w')
2742
1561
datetime.timedelta(7)
2743
>>> string_to_delta('5m 30s')
1562
>>> string_to_delta(u'5m 30s')
2744
1563
datetime.timedelta(0, 330)
2748
return rfc3339_duration_to_delta(interval)
2752
1565
timevalue = datetime.timedelta(0)
2753
1566
for s in interval.split():
1568
suffix = unicode(s[-1])
2756
1569
value = int(s[:-1])
2758
1571
delta = datetime.timedelta(value)
1572
elif suffix == u"s":
2760
1573
delta = datetime.timedelta(0, value)
1574
elif suffix == u"m":
2762
1575
delta = datetime.timedelta(0, 0, 0, 0, value)
1576
elif suffix == u"h":
2764
1577
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1578
elif suffix == u"w":
2766
1579
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2768
raise ValueError("Unknown suffix {!r}".format(suffix))
2769
except IndexError as e:
2770
raise ValueError(*(e.args))
1581
raise ValueError(u"Unknown suffix %r" % suffix)
1582
except (ValueError, IndexError), e:
1583
raise ValueError(e.message)
2771
1584
timevalue += delta
2772
1585
return timevalue
2775
def daemon(nochdir=False, noclose=False):
1588
def if_nametoindex(interface):
1589
"""Call the C function if_nametoindex(), or equivalent
1591
Note: This function cannot accept a unicode string."""
1592
global if_nametoindex
1594
if_nametoindex = (ctypes.cdll.LoadLibrary
1595
(ctypes.util.find_library(u"c"))
1597
except (OSError, AttributeError):
1598
logger.warning(u"Doing if_nametoindex the hard way")
1599
def if_nametoindex(interface):
1600
"Get an interface index the hard way, i.e. using fcntl()"
1601
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1602
with contextlib.closing(socket.socket()) as s:
1603
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1604
struct.pack(str(u"16s16x"),
1606
interface_index = struct.unpack(str(u"I"),
1608
return interface_index
1609
return if_nametoindex(interface)
1612
def daemon(nochdir = False, noclose = False):
2776
1613
"""See daemon(3). Standard BSD Unix function.
2778
1615
This should really exist as os.daemon, but it doesn't (yet)."""
2782
1619
if not nochdir:
2786
1623
if not noclose:
2787
1624
# Close all standard open file descriptors
2788
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1625
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2789
1626
if not stat.S_ISCHR(os.fstat(null).st_mode):
2790
1627
raise OSError(errno.ENODEV,
2791
"{} not a character device"
2792
.format(os.devnull))
1628
u"%s not a character device"
2793
1630
os.dup2(null, sys.stdin.fileno())
2794
1631
os.dup2(null, sys.stdout.fileno())
2795
1632
os.dup2(null, sys.stderr.fileno())
2802
1639
##################################################################
2803
1640
# Parsing of options, both command line and config file
2805
parser = argparse.ArgumentParser()
2806
parser.add_argument("-v", "--version", action="version",
2807
version="%(prog)s {}".format(version),
2808
help="show version number and exit")
2809
parser.add_argument("-i", "--interface", metavar="IF",
2810
help="Bind to interface IF")
2811
parser.add_argument("-a", "--address",
2812
help="Address to listen for requests on")
2813
parser.add_argument("-p", "--port", type=int,
2814
help="Port number to receive requests on")
2815
parser.add_argument("--check", action="store_true",
2816
help="Run self-test")
2817
parser.add_argument("--debug", action="store_true",
2818
help="Debug mode; run in foreground and log"
2819
" to terminal", default=None)
2820
parser.add_argument("--debuglevel", metavar="LEVEL",
2821
help="Debug level for stdout output")
2822
parser.add_argument("--priority", help="GnuTLS"
2823
" priority string (see GnuTLS documentation)")
2824
parser.add_argument("--servicename",
2825
metavar="NAME", help="Zeroconf service name")
2826
parser.add_argument("--configdir",
2827
default="/etc/mandos", metavar="DIR",
2828
help="Directory to search for configuration"
2830
parser.add_argument("--no-dbus", action="store_false",
2831
dest="use_dbus", help="Do not provide D-Bus"
2832
" system bus interface", default=None)
2833
parser.add_argument("--no-ipv6", action="store_false",
2834
dest="use_ipv6", help="Do not use IPv6",
2836
parser.add_argument("--no-restore", action="store_false",
2837
dest="restore", help="Do not restore stored"
2838
" state", default=None)
2839
parser.add_argument("--socket", type=int,
2840
help="Specify a file descriptor to a network"
2841
" socket to use instead of creating one")
2842
parser.add_argument("--statedir", metavar="DIR",
2843
help="Directory to save/restore state in")
2844
parser.add_argument("--foreground", action="store_true",
2845
help="Run in foreground", default=None)
2846
parser.add_argument("--no-zeroconf", action="store_false",
2847
dest="zeroconf", help="Do not use Zeroconf",
2850
options = parser.parse_args()
1642
parser = optparse.OptionParser(version = "%%prog %s" % version)
1643
parser.add_option("-i", u"--interface", type=u"string",
1644
metavar="IF", help=u"Bind to interface IF")
1645
parser.add_option("-a", u"--address", type=u"string",
1646
help=u"Address to listen for requests on")
1647
parser.add_option("-p", u"--port", type=u"int",
1648
help=u"Port number to receive requests on")
1649
parser.add_option("--check", action=u"store_true",
1650
help=u"Run self-test")
1651
parser.add_option("--debug", action=u"store_true",
1652
help=u"Debug mode; run in foreground and log to"
1654
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1655
help=u"Debug level for stdout output")
1656
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1657
u" priority string (see GnuTLS documentation)")
1658
parser.add_option("--servicename", type=u"string",
1659
metavar=u"NAME", help=u"Zeroconf service name")
1660
parser.add_option("--configdir", type=u"string",
1661
default=u"/etc/mandos", metavar=u"DIR",
1662
help=u"Directory to search for configuration"
1664
parser.add_option("--no-dbus", action=u"store_false",
1665
dest=u"use_dbus", help=u"Do not provide D-Bus"
1666
u" system bus interface")
1667
parser.add_option("--no-ipv6", action=u"store_false",
1668
dest=u"use_ipv6", help=u"Do not use IPv6")
1669
options = parser.parse_args()[0]
2852
1671
if options.check:
2854
fail_count, test_count = doctest.testmod()
2855
sys.exit(os.EX_OK if fail_count == 0 else 1)
2857
1676
# Default values for config file for server-global settings
2858
server_defaults = {"interface": "",
2863
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2864
":+SIGN-DSA-SHA256",
2865
"servicename": "Mandos",
2871
"statedir": "/var/lib/mandos",
2872
"foreground": "False",
1677
server_defaults = { u"interface": u"",
1682
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1683
u"servicename": u"Mandos",
1684
u"use_dbus": u"True",
1685
u"use_ipv6": u"True",
2876
1689
# Parse config file for server-global settings
2877
1690
server_config = configparser.SafeConfigParser(server_defaults)
2878
1691
del server_defaults
2879
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1692
server_config.read(os.path.join(options.configdir,
2880
1694
# Convert the SafeConfigParser object to a dict
2881
1695
server_settings = server_config.defaults()
2882
1696
# Use the appropriate methods on the non-string config options
2883
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2884
server_settings[option] = server_config.getboolean("DEFAULT",
1697
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1698
server_settings[option] = server_config.getboolean(u"DEFAULT",
2886
1700
if server_settings["port"]:
2887
server_settings["port"] = server_config.getint("DEFAULT",
2889
if server_settings["socket"]:
2890
server_settings["socket"] = server_config.getint("DEFAULT",
2892
# Later, stdin will, and stdout and stderr might, be dup'ed
2893
# over with an opened os.devnull. But we don't want this to
2894
# happen with a supplied network socket.
2895
if 0 <= server_settings["socket"] <= 2:
2896
server_settings["socket"] = os.dup(server_settings
1701
server_settings["port"] = server_config.getint(u"DEFAULT",
2898
1703
del server_config
2900
1705
# Override the settings from the config file with command line
2901
1706
# options, if set.
2902
for option in ("interface", "address", "port", "debug",
2903
"priority", "servicename", "configdir", "use_dbus",
2904
"use_ipv6", "debuglevel", "restore", "statedir",
2905
"socket", "foreground", "zeroconf"):
1707
for option in (u"interface", u"address", u"port", u"debug",
1708
u"priority", u"servicename", u"configdir",
1709
u"use_dbus", u"use_ipv6", u"debuglevel"):
2906
1710
value = getattr(options, option)
2907
1711
if value is not None:
2908
1712
server_settings[option] = value
2910
1714
# Force all strings to be unicode
2911
1715
for option in server_settings.keys():
2912
if isinstance(server_settings[option], bytes):
2913
server_settings[option] = (server_settings[option]
2915
# Force all boolean options to be boolean
2916
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2917
"foreground", "zeroconf"):
2918
server_settings[option] = bool(server_settings[option])
2919
# Debug implies foreground
2920
if server_settings["debug"]:
2921
server_settings["foreground"] = True
1716
if type(server_settings[option]) is str:
1717
server_settings[option] = unicode(server_settings[option])
2922
1718
# Now we have our good server settings in "server_settings"
2924
1720
##################################################################
2926
if (not server_settings["zeroconf"]
2927
and not (server_settings["port"]
2928
or server_settings["socket"] != "")):
2929
parser.error("Needs port or socket to work without Zeroconf")
2931
1722
# For convenience
2932
debug = server_settings["debug"]
2933
debuglevel = server_settings["debuglevel"]
2934
use_dbus = server_settings["use_dbus"]
2935
use_ipv6 = server_settings["use_ipv6"]
2936
stored_state_path = os.path.join(server_settings["statedir"],
2938
foreground = server_settings["foreground"]
2939
zeroconf = server_settings["zeroconf"]
2942
initlogger(debug, logging.DEBUG)
2947
level = getattr(logging, debuglevel.upper())
2948
initlogger(debug, level)
2950
if server_settings["servicename"] != "Mandos":
2951
syslogger.setFormatter(
2952
logging.Formatter('Mandos ({}) [%(process)d]:'
2953
' %(levelname)s: %(message)s'.format(
2954
server_settings["servicename"])))
1723
debug = server_settings[u"debug"]
1724
debuglevel = server_settings[u"debuglevel"]
1725
use_dbus = server_settings[u"use_dbus"]
1726
use_ipv6 = server_settings[u"use_ipv6"]
1728
if server_settings[u"servicename"] != u"Mandos":
1729
syslogger.setFormatter(logging.Formatter
1730
(u'Mandos (%s) [%%(process)d]:'
1731
u' %%(levelname)s: %%(message)s'
1732
% server_settings[u"servicename"]))
2956
1734
# Parse config file with clients
2957
client_config = configparser.SafeConfigParser(Client
2959
client_config.read(os.path.join(server_settings["configdir"],
1735
client_defaults = { u"timeout": u"1h",
1737
u"checker": u"fping -q -- %%(host)s",
1739
u"approval_delay": u"0s",
1740
u"approval_duration": u"1s",
1742
client_config = configparser.SafeConfigParser(client_defaults)
1743
client_config.read(os.path.join(server_settings[u"configdir"],
2962
1746
global mandos_dbus_service
2963
1747
mandos_dbus_service = None
2966
if server_settings["socket"] != "":
2967
socketfd = server_settings["socket"]
2968
tcp_server = MandosServer(
2969
(server_settings["address"], server_settings["port"]),
2971
interface=(server_settings["interface"] or None),
2973
gnutls_priority=server_settings["priority"],
2977
pidfilename = "/run/mandos.pid"
2978
if not os.path.isdir("/run/."):
2979
pidfilename = "/var/run/mandos.pid"
2982
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2983
except IOError as e:
2984
logger.error("Could not open file %r", pidfilename,
2987
for name, group in (("_mandos", "_mandos"),
2988
("mandos", "mandos"),
2989
("nobody", "nogroup")):
2991
uid = pwd.getpwnam(name).pw_uid
2992
gid = pwd.getpwnam(group).pw_gid
1749
tcp_server = MandosServer((server_settings[u"address"],
1750
server_settings[u"port"]),
1752
interface=(server_settings[u"interface"]
1756
server_settings[u"priority"],
1758
pidfilename = u"/var/run/mandos.pid"
1760
pidfile = open(pidfilename, u"w")
1762
logger.error(u"Could not open file %r", pidfilename)
1765
uid = pwd.getpwnam(u"_mandos").pw_uid
1766
gid = pwd.getpwnam(u"_mandos").pw_gid
1769
uid = pwd.getpwnam(u"mandos").pw_uid
1770
gid = pwd.getpwnam(u"mandos").pw_gid
2994
1771
except KeyError:
1773
uid = pwd.getpwnam(u"nobody").pw_uid
1774
gid = pwd.getpwnam(u"nobody").pw_gid
3003
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3005
except OSError as error:
3006
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3007
.format(uid, gid, os.strerror(error.errno)))
3008
if error.errno != errno.EPERM:
1781
except OSError, error:
1782
if error[0] != errno.EPERM:
1785
if not debug and not debuglevel:
1786
syslogger.setLevel(logging.WARNING)
1787
console.setLevel(logging.WARNING)
1789
level = getattr(logging, debuglevel.upper())
1790
syslogger.setLevel(level)
1791
console.setLevel(level)
3012
1794
# Enable all possible GnuTLS debugging
3014
1796
# "Use a log level over 10 to enable all debugging options."
3015
1797
# - GnuTLS manual
3016
gnutls.global_set_log_level(11)
1798
gnutls.library.functions.gnutls_global_set_log_level(11)
1800
@gnutls.library.types.gnutls_log_func
3019
1801
def debug_gnutls(level, string):
3020
logger.debug("GnuTLS: %s", string[:-1])
3022
gnutls.global_set_log_function(debug_gnutls)
1802
logger.debug(u"GnuTLS: %s", string[:-1])
1804
(gnutls.library.functions
1805
.gnutls_global_set_log_function(debug_gnutls))
3024
1807
# Redirect stdin so all checkers get /dev/null
3025
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1808
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3026
1809
os.dup2(null, sys.stdin.fileno())
3030
# Need to fork before connecting to D-Bus
3032
# Close all input and output, do double fork, etc.
3035
# multiprocessing will use threads, so before we use GLib we need
3036
# to inform GLib that threads will be used.
1813
# No console logging
1814
logger.removeHandler(console)
3039
1817
global main_loop
3040
1818
# From the Avahi example code
3041
DBusGMainLoop(set_as_default=True)
3042
main_loop = GLib.MainLoop()
1819
DBusGMainLoop(set_as_default=True )
1820
main_loop = gobject.MainLoop()
3043
1821
bus = dbus.SystemBus()
3044
1822
# End of Avahi example code
3047
bus_name = dbus.service.BusName("se.recompile.Mandos",
3050
old_bus_name = dbus.service.BusName(
3051
"se.bsnet.fukt.Mandos", bus,
3053
except dbus.exceptions.DBusException as e:
3054
logger.error("Disabling D-Bus:", exc_info=e)
1825
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1826
bus, do_not_queue=True)
1827
except dbus.exceptions.NameExistsException, e:
1828
logger.error(unicode(e) + u", disabling D-Bus")
3055
1829
use_dbus = False
3056
server_settings["use_dbus"] = False
1830
server_settings[u"use_dbus"] = False
3057
1831
tcp_server.use_dbus = False
3059
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3060
service = AvahiServiceToSyslog(
3061
name=server_settings["servicename"],
3062
servicetype="_mandos._tcp",
3065
if server_settings["interface"]:
3066
service.interface = if_nametoindex(
3067
server_settings["interface"].encode("utf-8"))
1832
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1833
service = AvahiService(name = server_settings[u"servicename"],
1834
servicetype = u"_mandos._tcp",
1835
protocol = protocol, bus = bus)
1836
if server_settings["interface"]:
1837
service.interface = (if_nametoindex
1838
(str(server_settings[u"interface"])))
1841
# Close all input and output, do double fork, etc.
3069
1844
global multiprocessing_manager
3070
1845
multiprocessing_manager = multiprocessing.Manager()
3072
1847
client_class = Client
3074
client_class = functools.partial(ClientDBus, bus=bus)
3076
client_settings = Client.config_parser(client_config)
3077
old_client_settings = {}
3080
# This is used to redirect stdout and stderr for checker processes
3082
wnull = open(os.devnull, "w") # A writable /dev/null
3083
# Only used if server is running in foreground but not in debug
3085
if debug or not foreground:
3088
# Get client data and settings from last running state.
3089
if server_settings["restore"]:
3091
with open(stored_state_path, "rb") as stored_state:
3092
if sys.version_info.major == 2:
3093
clients_data, old_client_settings = pickle.load(
3096
bytes_clients_data, bytes_old_client_settings = (
3097
pickle.load(stored_state, encoding="bytes"))
3098
# Fix bytes to strings
3101
clients_data = {(key.decode("utf-8")
3102
if isinstance(key, bytes)
3105
bytes_clients_data.items()}
3106
del bytes_clients_data
3107
for key in clients_data:
3108
value = {(k.decode("utf-8")
3109
if isinstance(k, bytes) else k): v
3111
clients_data[key].items()}
3112
clients_data[key] = value
3114
value["client_structure"] = [
3116
if isinstance(s, bytes)
3118
value["client_structure"]]
3120
for k in ("name", "host"):
3121
if isinstance(value[k], bytes):
3122
value[k] = value[k].decode("utf-8")
3123
# old_client_settings
3125
old_client_settings = {
3126
(key.decode("utf-8")
3127
if isinstance(key, bytes)
3130
bytes_old_client_settings.items()}
3131
del bytes_old_client_settings
3133
for value in old_client_settings.values():
3134
if isinstance(value["host"], bytes):
3135
value["host"] = (value["host"]
3137
os.remove(stored_state_path)
3138
except IOError as e:
3139
if e.errno == errno.ENOENT:
3140
logger.warning("Could not load persistent state:"
3141
" {}".format(os.strerror(e.errno)))
3143
logger.critical("Could not load persistent state:",
3146
except EOFError as e:
3147
logger.warning("Could not load persistent state: "
3151
with PGPEngine() as pgp:
3152
for client_name, client in clients_data.items():
3153
# Skip removed clients
3154
if client_name not in client_settings:
3157
# Decide which value to use after restoring saved state.
3158
# We have three different values: Old config file,
3159
# new config file, and saved state.
3160
# New config value takes precedence if it differs from old
3161
# config value, otherwise use saved state.
3162
for name, value in client_settings[client_name].items():
3164
# For each value in new config, check if it
3165
# differs from the old config value (Except for
3166
# the "secret" attribute)
3167
if (name != "secret"
3169
old_client_settings[client_name][name])):
3170
client[name] = value
3174
# Clients who has passed its expire date can still be
3175
# enabled if its last checker was successful. A Client
3176
# whose checker succeeded before we stored its state is
3177
# assumed to have successfully run all checkers during
3179
if client["enabled"]:
3180
if datetime.datetime.utcnow() >= client["expires"]:
3181
if not client["last_checked_ok"]:
3183
"disabling client {} - Client never "
3184
"performed a successful checker".format(
3186
client["enabled"] = False
3187
elif client["last_checker_status"] != 0:
3189
"disabling client {} - Client last"
3190
" checker failed with error code"
3193
client["last_checker_status"]))
3194
client["enabled"] = False
3196
client["expires"] = (
3197
datetime.datetime.utcnow()
3198
+ client["timeout"])
3199
logger.debug("Last checker succeeded,"
3200
" keeping {} enabled".format(
1849
client_class = functools.partial(ClientDBus, bus = bus)
1850
def client_config_items(config, section):
1851
special_settings = {
1852
"approved_by_default":
1853
lambda: config.getboolean(section,
1854
"approved_by_default"),
1856
for name, value in config.items(section):
3203
client["secret"] = pgp.decrypt(
3204
client["encrypted_secret"],
3205
client_settings[client_name]["secret"])
3207
# If decryption fails, we use secret from new settings
3208
logger.debug("Failed to decrypt {} old secret".format(
3210
client["secret"] = (client_settings[client_name]
3213
# Add/remove clients based on new changes made to config
3214
for client_name in (set(old_client_settings)
3215
- set(client_settings)):
3216
del clients_data[client_name]
3217
for client_name in (set(client_settings)
3218
- set(old_client_settings)):
3219
clients_data[client_name] = client_settings[client_name]
3221
# Create all client objects
3222
for client_name, client in clients_data.items():
3223
tcp_server.clients[client_name] = client_class(
3226
server_settings=server_settings)
1858
yield (name, special_settings[name]())
1862
tcp_server.clients.update(set(
1863
client_class(name = section,
1864
config= dict(client_config_items(
1865
client_config, section)))
1866
for section in client_config.sections()))
3228
1867
if not tcp_server.clients:
3229
logger.warning("No clients defined")
3232
if pidfile is not None:
1868
logger.warning(u"No clients defined")
3233
1872
pid = os.getpid()
3236
print(pid, file=pidfile)
3238
logger.error("Could not write to file %r with PID %d",
1873
pidfile.write(str(pid) + "\n")
3243
for termsig in (signal.SIGHUP, signal.SIGTERM):
3244
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3245
lambda: main_loop.quit() and False)
1876
logger.error(u"Could not write to file %r with PID %d",
1879
# "pidfile" was never created
1884
signal.signal(signal.SIGINT, signal.SIG_IGN)
1885
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1886
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3249
@alternate_dbus_interfaces(
3250
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3251
class MandosDBusService(DBusObjectWithObjectManager):
1889
class MandosDBusService(dbus.service.Object):
3252
1890
"""A D-Bus proxy object"""
3254
1891
def __init__(self):
3255
dbus.service.Object.__init__(self, bus, "/")
3257
_interface = "se.recompile.Mandos"
3259
@dbus.service.signal(_interface, signature="o")
1892
dbus.service.Object.__init__(self, bus, u"/")
1893
_interface = u"se.bsnet.fukt.Mandos"
1895
@dbus.service.signal(_interface, signature=u"o")
3260
1896
def ClientAdded(self, objpath):
3264
@dbus.service.signal(_interface, signature="ss")
1900
@dbus.service.signal(_interface, signature=u"ss")
3265
1901
def ClientNotFound(self, fingerprint, address):
3269
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3271
@dbus.service.signal(_interface, signature="os")
1905
@dbus.service.signal(_interface, signature=u"os")
3272
1906
def ClientRemoved(self, objpath, name):
3276
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3278
@dbus.service.method(_interface, out_signature="ao")
1910
@dbus.service.method(_interface, out_signature=u"ao")
3279
1911
def GetAllClients(self):
3281
return dbus.Array(c.dbus_object_path for c in
3282
tcp_server.clients.values())
3284
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1913
return dbus.Array(c.dbus_object_path
1914
for c in tcp_server.clients)
3286
1916
@dbus.service.method(_interface,
3287
out_signature="a{oa{sv}}")
1917
out_signature=u"a{oa{sv}}")
3288
1918
def GetAllClientsWithProperties(self):
3290
1920
return dbus.Dictionary(
3291
{c.dbus_object_path: c.GetAll(
3292
"se.recompile.Mandos.Client")
3293
for c in tcp_server.clients.values()},
3296
@dbus.service.method(_interface, in_signature="o")
1921
((c.dbus_object_path, c.GetAll(u""))
1922
for c in tcp_server.clients),
1923
signature=u"oa{sv}")
1925
@dbus.service.method(_interface, in_signature=u"o")
3297
1926
def RemoveClient(self, object_path):
3299
for c in tcp_server.clients.values():
1928
for c in tcp_server.clients:
3300
1929
if c.dbus_object_path == object_path:
3301
del tcp_server.clients[c.name]
1930
tcp_server.clients.remove(c)
3302
1931
c.remove_from_connection()
3303
# Don't signal the disabling
1932
# Don't signal anything except ClientRemoved
3304
1933
c.disable(quiet=True)
3305
# Emit D-Bus signal for removal
3306
self.client_removed_signal(c)
1935
self.ClientRemoved(object_path, c.name)
3308
1937
raise KeyError(object_path)
3312
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3313
out_signature="a{oa{sa{sv}}}")
3314
def GetManagedObjects(self):
3316
return dbus.Dictionary(
3317
{client.dbus_object_path:
3319
{interface: client.GetAll(interface)
3321
client._get_all_interface_names()})
3322
for client in tcp_server.clients.values()})
3324
def client_added_signal(self, client):
3325
"""Send the new standard signal and the old signal"""
3327
# New standard signal
3328
self.InterfacesAdded(
3329
client.dbus_object_path,
3331
{interface: client.GetAll(interface)
3333
client._get_all_interface_names()}))
3335
self.ClientAdded(client.dbus_object_path)
3337
def client_removed_signal(self, client):
3338
"""Send the new standard signal and the old signal"""
3340
# New standard signal
3341
self.InterfacesRemoved(
3342
client.dbus_object_path,
3343
client._get_all_interface_names())
3345
self.ClientRemoved(client.dbus_object_path,
3348
1941
mandos_dbus_service = MandosDBusService()
3350
# Save modules to variables to exempt the modules from being
3351
# unloaded before the function registered with atexit() is run.
3352
mp = multiprocessing
3356
1944
"Cleanup function; run on exit"
3360
mp.active_children()
3362
if not (tcp_server.clients or client_settings):
3365
# Store client before exiting. Secrets are encrypted with key
3366
# based on what config file has. If config file is
3367
# removed/edited, old secret will thus be unrecovable.
3369
with PGPEngine() as pgp:
3370
for client in tcp_server.clients.values():
3371
key = client_settings[client.name]["secret"]
3372
client.encrypted_secret = pgp.encrypt(client.secret,
3376
# A list of attributes that can not be pickled
3378
exclude = {"bus", "changedstate", "secret",
3379
"checker", "server_settings"}
3380
for name, typ in inspect.getmembers(dbus.service
3384
client_dict["encrypted_secret"] = (client
3386
for attr in client.client_structure:
3387
if attr not in exclude:
3388
client_dict[attr] = getattr(client, attr)
3390
clients[client.name] = client_dict
3391
del client_settings[client.name]["secret"]
3394
with tempfile.NamedTemporaryFile(
3398
dir=os.path.dirname(stored_state_path),
3399
delete=False) as stored_state:
3400
pickle.dump((clients, client_settings), stored_state,
3402
tempname = stored_state.name
3403
os.rename(tempname, stored_state_path)
3404
except (IOError, OSError) as e:
3410
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3411
logger.warning("Could not save persistent state: {}"
3412
.format(os.strerror(e.errno)))
3414
logger.warning("Could not save persistent state:",
3418
# Delete all clients, and settings from config
3419
1947
while tcp_server.clients:
3420
name, client = tcp_server.clients.popitem()
1948
client = tcp_server.clients.pop()
3422
1950
client.remove_from_connection()
3423
# Don't signal the disabling
1951
client.disable_hook = None
1952
# Don't signal anything except ClientRemoved
3424
1953
client.disable(quiet=True)
3425
# Emit D-Bus signal for removal
3427
mandos_dbus_service.client_removed_signal(client)
3428
client_settings.clear()
1956
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3430
1959
atexit.register(cleanup)
3432
for client in tcp_server.clients.values():
1961
for client in tcp_server.clients:
3434
# Emit D-Bus signal for adding
3435
mandos_dbus_service.client_added_signal(client)
3436
# Need to initiate checking of clients
3438
client.init_checker()
1964
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3440
1967
tcp_server.enable()
3441
1968
tcp_server.server_activate()
3443
1970
# Find out what port we got
3445
service.port = tcp_server.socket.getsockname()[1]
1971
service.port = tcp_server.socket.getsockname()[1]
3447
logger.info("Now listening on address %r, port %d,"
3448
" flowinfo %d, scope_id %d",
3449
*tcp_server.socket.getsockname())
1973
logger.info(u"Now listening on address %r, port %d,"
1974
" flowinfo %d, scope_id %d"
1975
% tcp_server.socket.getsockname())
3451
logger.info("Now listening on address %r, port %d",
3452
*tcp_server.socket.getsockname())
3454
# service.interface = tcp_server.socket.getsockname()[3]
1977
logger.info(u"Now listening on address %r, port %d"
1978
% tcp_server.socket.getsockname())
1980
#service.interface = tcp_server.socket.getsockname()[3]
3458
# From the Avahi example code
3461
except dbus.exceptions.DBusException as error:
3462
logger.critical("D-Bus Exception", exc_info=error)
3465
# End of Avahi example code
3467
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3468
lambda *args, **kwargs:
3469
(tcp_server.handle_request
3470
(*args[2:], **kwargs) or True))
3472
logger.debug("Starting main loop")
1983
# From the Avahi example code
1986
except dbus.exceptions.DBusException, error:
1987
logger.critical(u"DBusException: %s", error)
1990
# End of Avahi example code
1992
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1993
lambda *args, **kwargs:
1994
(tcp_server.handle_request
1995
(*args[2:], **kwargs) or True))
1997
logger.debug(u"Starting main loop")
3473
1998
main_loop.run()
3474
except AvahiError as error:
3475
logger.critical("Avahi Error", exc_info=error)
1999
except AvahiError, error:
2000
logger.critical(u"AvahiError: %s", error)
3478
2003
except KeyboardInterrupt:
3480
print("", file=sys.stderr)
3481
logger.debug("Server received KeyboardInterrupt")
3482
logger.debug("Server exiting")
2006
logger.debug(u"Server received KeyboardInterrupt")
2007
logger.debug(u"Server exiting")
3483
2008
# Must run before the D-Bus bus name gets deregistered
3487
2011
if __name__ == '__main__':