70
import cPickle as pickle
62
import cPickle as pickle
73
63
import multiprocessing
82
66
import dbus.service
83
from gi.repository import GLib
84
69
from dbus.mainloop.glib import DBusGMainLoop
87
72
import xml.dom.minidom
90
# Try to find the value of SO_BINDTODEVICE:
92
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
93
# newer, and it is also the most natural place for it:
94
76
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
95
77
except AttributeError:
97
# This is where SO_BINDTODEVICE was up to and including Python
99
79
from IN import SO_BINDTODEVICE
100
80
except ImportError:
101
# In Python 2.7 it seems to have been removed entirely.
102
# Try running the C preprocessor:
104
cc = subprocess.Popen(["cc", "--language=c", "-E",
106
stdin=subprocess.PIPE,
107
stdout=subprocess.PIPE)
108
stdout = cc.communicate(
109
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
110
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
111
except (OSError, ValueError, IndexError):
113
SO_BINDTODEVICE = None
115
if sys.version_info.major == 2:
119
stored_state_file = "clients.pickle"
121
logger = logging.getLogger()
125
if_nametoindex = ctypes.cdll.LoadLibrary(
126
ctypes.util.find_library("c")).if_nametoindex
127
except (OSError, AttributeError):
129
def if_nametoindex(interface):
130
"Get an interface index the hard way, i.e. using fcntl()"
131
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
132
with contextlib.closing(socket.socket()) as s:
133
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
134
struct.pack(b"16s16x", interface))
135
interface_index = struct.unpack("I", ifreq[16:20])[0]
136
return interface_index
139
def copy_function(func):
140
"""Make a copy of a function"""
141
if sys.version_info.major == 2:
142
return types.FunctionType(func.func_code,
148
return types.FunctionType(func.__code__,
155
def initlogger(debug, level=logging.WARNING):
156
"""init logger and add loglevel"""
159
syslogger = (logging.handlers.SysLogHandler(
160
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
162
syslogger.setFormatter(logging.Formatter
163
('Mandos [%(process)d]: %(levelname)s:'
165
logger.addHandler(syslogger)
168
console = logging.StreamHandler()
169
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
173
logger.addHandler(console)
174
logger.setLevel(level)
177
class PGPError(Exception):
178
"""Exception if encryption/decryption fails"""
182
class PGPEngine(object):
183
"""A simple class for OpenPGP symmetric encryption & decryption"""
186
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
189
output = subprocess.check_output(["gpgconf"])
190
for line in output.splitlines():
191
name, text, path = line.split(b":")
196
if e.errno != errno.ENOENT:
198
self.gnupgargs = ['--batch',
199
'--homedir', self.tempdir,
202
# Only GPG version 1 has the --no-use-agent option.
203
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
204
self.gnupgargs.append("--no-use-agent")
209
def __exit__(self, exc_type, exc_value, traceback):
217
if self.tempdir is not None:
218
# Delete contents of tempdir
219
for root, dirs, files in os.walk(self.tempdir,
221
for filename in files:
222
os.remove(os.path.join(root, filename))
224
os.rmdir(os.path.join(root, dirname))
226
os.rmdir(self.tempdir)
229
def password_encode(self, password):
230
# Passphrase can not be empty and can not contain newlines or
231
# NUL bytes. So we prefix it and hex encode it.
232
encoded = b"mandos" + binascii.hexlify(password)
233
if len(encoded) > 2048:
234
# GnuPG can't handle long passwords, so encode differently
235
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
236
.replace(b"\n", b"\\n")
237
.replace(b"\0", b"\\x00"))
240
def encrypt(self, data, password):
241
passphrase = self.password_encode(password)
242
with tempfile.NamedTemporaryFile(
243
dir=self.tempdir) as passfile:
244
passfile.write(passphrase)
246
proc = subprocess.Popen([self.gpg, '--symmetric',
250
stdin=subprocess.PIPE,
251
stdout=subprocess.PIPE,
252
stderr=subprocess.PIPE)
253
ciphertext, err = proc.communicate(input=data)
254
if proc.returncode != 0:
258
def decrypt(self, data, password):
259
passphrase = self.password_encode(password)
260
with tempfile.NamedTemporaryFile(
261
dir=self.tempdir) as passfile:
262
passfile.write(passphrase)
264
proc = subprocess.Popen([self.gpg, '--decrypt',
268
stdin=subprocess.PIPE,
269
stdout=subprocess.PIPE,
270
stderr=subprocess.PIPE)
271
decrypted_plaintext, err = proc.communicate(input=data)
272
if proc.returncode != 0:
274
return decrypted_plaintext
277
# Pretend that we have an Avahi module
279
"""This isn't so much a class as it is a module-like namespace.
280
It is instantiated once, and simulates having an Avahi module."""
281
IF_UNSPEC = -1 # avahi-common/address.h
282
PROTO_UNSPEC = -1 # avahi-common/address.h
283
PROTO_INET = 0 # avahi-common/address.h
284
PROTO_INET6 = 1 # avahi-common/address.h
285
DBUS_NAME = "org.freedesktop.Avahi"
286
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
287
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
288
DBUS_PATH_SERVER = "/"
290
def string_array_to_txt_array(self, t):
291
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
292
for s in t), signature="ay")
293
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
294
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
295
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
296
SERVER_INVALID = 0 # avahi-common/defs.h
297
SERVER_REGISTERING = 1 # avahi-common/defs.h
298
SERVER_RUNNING = 2 # avahi-common/defs.h
299
SERVER_COLLISION = 3 # avahi-common/defs.h
300
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)
304
102
class AvahiError(Exception):
305
103
def __init__(self, value, *args, **kwargs):
306
104
self.value = value
307
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))
311
109
class AvahiServiceError(AvahiError):
315
112
class AvahiGroupError(AvahiError):
319
116
class AvahiService(object):
320
117
"""An Avahi (Zeroconf) service.
323
120
interface: integer; avahi.IF_UNSPEC or an interface index.
324
121
Used to optionally bind to the specified interface.
325
name: string; Example: 'Mandos'
326
type: string; Example: '_mandos._tcp'.
327
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>
328
125
port: integer; what port to announce
329
126
TXT: list of strings; TXT record for the service
330
127
domain: string; Domain to publish on, default to .local if empty.
419
197
dbus.UInt16(self.port),
420
198
avahi.string_array_to_txt_array(self.TXT))
421
199
self.group.Commit()
423
200
def entry_group_state_changed(self, state, error):
424
201
"""Derived from the Avahi example code"""
425
logger.debug("Avahi entry group state change: %i", state)
202
logger.debug(u"Avahi entry group state change: %i", state)
427
204
if state == avahi.ENTRY_GROUP_ESTABLISHED:
428
logger.debug("Zeroconf service established.")
205
logger.debug(u"Zeroconf service established.")
429
206
elif state == avahi.ENTRY_GROUP_COLLISION:
430
logger.info("Zeroconf service name collision.")
207
logger.warning(u"Zeroconf service name collision.")
432
209
elif state == avahi.ENTRY_GROUP_FAILURE:
433
logger.critical("Avahi: Error in group state changed %s",
435
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"
437
214
def cleanup(self):
438
215
"""Derived from the Avahi example code"""
439
216
if self.group is not None:
442
except (dbus.exceptions.UnknownMethodException,
443
dbus.exceptions.DBusException):
445
218
self.group = None
448
def server_state_changed(self, state, error=None):
219
def server_state_changed(self, state):
449
220
"""Derived from the Avahi example code"""
450
logger.debug("Avahi server state change: %i", state)
452
avahi.SERVER_INVALID: "Zeroconf server invalid",
453
avahi.SERVER_REGISTERING: None,
454
avahi.SERVER_COLLISION: "Zeroconf server name collision",
455
avahi.SERVER_FAILURE: "Zeroconf server failure",
457
if state in bad_states:
458
if bad_states[state] is not None:
460
logger.error(bad_states[state])
462
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")
464
225
elif state == avahi.SERVER_RUNNING:
467
except dbus.exceptions.DBusException as error:
468
if (error.get_dbus_name()
469
== "org.freedesktop.Avahi.CollisionError"):
470
logger.info("Local Zeroconf service name"
472
return self.rename(remove=False)
474
logger.critical("D-Bus Exception", exc_info=error)
479
logger.debug("Unknown state: %r", state)
481
logger.debug("Unknown state: %r: %r", state, error)
483
227
def activate(self):
484
228
"""Derived from the Avahi example code"""
485
229
if self.server is None:
486
230
self.server = dbus.Interface(
487
231
self.bus.get_object(avahi.DBUS_NAME,
488
avahi.DBUS_PATH_SERVER,
489
follow_name_owner_changes=True),
232
avahi.DBUS_PATH_SERVER),
490
233
avahi.DBUS_INTERFACE_SERVER)
491
self.server.connect_to_signal("StateChanged",
492
self.server_state_changed)
234
self.server.connect_to_signal(u"StateChanged",
235
self.server_state_changed)
493
236
self.server_state_changed(self.server.GetState())
496
class AvahiServiceToSyslog(AvahiService):
497
def rename(self, *args, **kwargs):
498
"""Add the new name to the syslog messages"""
499
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
500
syslogger.setFormatter(logging.Formatter(
501
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
506
# Pretend that we have a GnuTLS module
507
class GnuTLS(object):
508
"""This isn't so much a class as it is a module-like namespace.
509
It is instantiated once, and simulates having a GnuTLS module."""
511
library = ctypes.util.find_library("gnutls")
513
library = ctypes.util.find_library("gnutls-deb0")
514
_library = ctypes.cdll.LoadLibrary(library)
516
_need_version = b"3.3.0"
517
_tls_rawpk_version = b"3.6.6"
520
# Need to use "self" here, since this method is called before
521
# the assignment to the "gnutls" global variable happens.
522
if self.check_version(self._need_version) is None:
523
raise self.Error("Needs GnuTLS {} or later"
524
.format(self._need_version))
526
# Unless otherwise indicated, the constants and types below are
527
# all from the gnutls/gnutls.h C header file.
538
E_NO_CERTIFICATE_FOUND = -49
543
KEYID_USE_SHA256 = 1 # gnutls/x509.h
544
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
547
class session_int(ctypes.Structure):
549
session_t = ctypes.POINTER(session_int)
551
class certificate_credentials_st(ctypes.Structure):
553
certificate_credentials_t = ctypes.POINTER(
554
certificate_credentials_st)
555
certificate_type_t = ctypes.c_int
557
class datum_t(ctypes.Structure):
558
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
559
('size', ctypes.c_uint)]
561
class openpgp_crt_int(ctypes.Structure):
563
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
564
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
565
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
566
credentials_type_t = ctypes.c_int
567
transport_ptr_t = ctypes.c_void_p
568
close_request_t = ctypes.c_int
571
class Error(Exception):
572
# We need to use the class name "GnuTLS" here, since this
573
# exception might be raised from within GnuTLS.__init__,
574
# which is called before the assignment to the "gnutls"
575
# global variable has happened.
576
def __init__(self, message=None, code=None, args=()):
577
# Default usage is by a message string, but if a return
578
# code is passed, convert it to a string with
581
if message is None and code is not None:
582
message = GnuTLS.strerror(code)
583
return super(GnuTLS.Error, self).__init__(
586
class CertificateSecurityError(Error):
590
class Credentials(object):
592
self._c_object = gnutls.certificate_credentials_t()
593
gnutls.certificate_allocate_credentials(
594
ctypes.byref(self._c_object))
595
self.type = gnutls.CRD_CERTIFICATE
598
gnutls.certificate_free_credentials(self._c_object)
600
class ClientSession(object):
601
def __init__(self, socket, credentials=None):
602
self._c_object = gnutls.session_t()
603
gnutls_flags = gnutls.CLIENT
604
if gnutls.check_version("3.5.6"):
605
gnutls_flags |= gnutls.NO_TICKETS
607
gnutls_flags |= gnutls.ENABLE_RAWPK
608
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
610
gnutls.set_default_priority(self._c_object)
611
gnutls.transport_set_ptr(self._c_object, socket.fileno())
612
gnutls.handshake_set_private_extensions(self._c_object,
615
if credentials is None:
616
credentials = gnutls.Credentials()
617
gnutls.credentials_set(self._c_object, credentials.type,
618
ctypes.cast(credentials._c_object,
620
self.credentials = credentials
623
gnutls.deinit(self._c_object)
626
return gnutls.handshake(self._c_object)
628
def send(self, data):
632
data_len -= gnutls.record_send(self._c_object,
637
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
639
# Error handling functions
640
def _error_code(result):
641
"""A function to raise exceptions on errors, suitable
642
for the 'restype' attribute on ctypes functions"""
645
if result == gnutls.E_NO_CERTIFICATE_FOUND:
646
raise gnutls.CertificateSecurityError(code=result)
647
raise gnutls.Error(code=result)
649
def _retry_on_error(result, func, arguments):
650
"""A function to retry on some errors, suitable
651
for the 'errcheck' attribute on ctypes functions"""
653
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
654
return _error_code(result)
655
result = func(*arguments)
658
# Unless otherwise indicated, the function declarations below are
659
# all from the gnutls/gnutls.h C header file.
662
priority_set_direct = _library.gnutls_priority_set_direct
663
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
664
ctypes.POINTER(ctypes.c_char_p)]
665
priority_set_direct.restype = _error_code
667
init = _library.gnutls_init
668
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
669
init.restype = _error_code
671
set_default_priority = _library.gnutls_set_default_priority
672
set_default_priority.argtypes = [session_t]
673
set_default_priority.restype = _error_code
675
record_send = _library.gnutls_record_send
676
record_send.argtypes = [session_t, ctypes.c_void_p,
678
record_send.restype = ctypes.c_ssize_t
679
record_send.errcheck = _retry_on_error
681
certificate_allocate_credentials = (
682
_library.gnutls_certificate_allocate_credentials)
683
certificate_allocate_credentials.argtypes = [
684
ctypes.POINTER(certificate_credentials_t)]
685
certificate_allocate_credentials.restype = _error_code
687
certificate_free_credentials = (
688
_library.gnutls_certificate_free_credentials)
689
certificate_free_credentials.argtypes = [
690
certificate_credentials_t]
691
certificate_free_credentials.restype = None
693
handshake_set_private_extensions = (
694
_library.gnutls_handshake_set_private_extensions)
695
handshake_set_private_extensions.argtypes = [session_t,
697
handshake_set_private_extensions.restype = None
699
credentials_set = _library.gnutls_credentials_set
700
credentials_set.argtypes = [session_t, credentials_type_t,
702
credentials_set.restype = _error_code
704
strerror = _library.gnutls_strerror
705
strerror.argtypes = [ctypes.c_int]
706
strerror.restype = ctypes.c_char_p
708
certificate_type_get = _library.gnutls_certificate_type_get
709
certificate_type_get.argtypes = [session_t]
710
certificate_type_get.restype = _error_code
712
certificate_get_peers = _library.gnutls_certificate_get_peers
713
certificate_get_peers.argtypes = [session_t,
714
ctypes.POINTER(ctypes.c_uint)]
715
certificate_get_peers.restype = ctypes.POINTER(datum_t)
717
global_set_log_level = _library.gnutls_global_set_log_level
718
global_set_log_level.argtypes = [ctypes.c_int]
719
global_set_log_level.restype = None
721
global_set_log_function = _library.gnutls_global_set_log_function
722
global_set_log_function.argtypes = [log_func]
723
global_set_log_function.restype = None
725
deinit = _library.gnutls_deinit
726
deinit.argtypes = [session_t]
727
deinit.restype = None
729
handshake = _library.gnutls_handshake
730
handshake.argtypes = [session_t]
731
handshake.restype = _error_code
732
handshake.errcheck = _retry_on_error
734
transport_set_ptr = _library.gnutls_transport_set_ptr
735
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
736
transport_set_ptr.restype = None
738
bye = _library.gnutls_bye
739
bye.argtypes = [session_t, close_request_t]
740
bye.restype = _error_code
741
bye.errcheck = _retry_on_error
743
check_version = _library.gnutls_check_version
744
check_version.argtypes = [ctypes.c_char_p]
745
check_version.restype = ctypes.c_char_p
747
has_rawpk = bool(check_version(_tls_rawpk_version))
751
class pubkey_st(ctypes.Structure):
753
pubkey_t = ctypes.POINTER(pubkey_st)
755
x509_crt_fmt_t = ctypes.c_int
757
# All the function declarations below are from gnutls/abstract.h
758
pubkey_init = _library.gnutls_pubkey_init
759
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
760
pubkey_init.restype = _error_code
762
pubkey_import = _library.gnutls_pubkey_import
763
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
765
pubkey_import.restype = _error_code
767
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
768
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
769
ctypes.POINTER(ctypes.c_ubyte),
770
ctypes.POINTER(ctypes.c_size_t)]
771
pubkey_get_key_id.restype = _error_code
773
pubkey_deinit = _library.gnutls_pubkey_deinit
774
pubkey_deinit.argtypes = [pubkey_t]
775
pubkey_deinit.restype = None
777
# All the function declarations below are from gnutls/openpgp.h
779
openpgp_crt_init = _library.gnutls_openpgp_crt_init
780
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
781
openpgp_crt_init.restype = _error_code
783
openpgp_crt_import = _library.gnutls_openpgp_crt_import
784
openpgp_crt_import.argtypes = [openpgp_crt_t,
785
ctypes.POINTER(datum_t),
787
openpgp_crt_import.restype = _error_code
789
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
790
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
791
ctypes.POINTER(ctypes.c_uint)]
792
openpgp_crt_verify_self.restype = _error_code
794
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
795
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
796
openpgp_crt_deinit.restype = None
798
openpgp_crt_get_fingerprint = (
799
_library.gnutls_openpgp_crt_get_fingerprint)
800
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
804
openpgp_crt_get_fingerprint.restype = _error_code
806
if check_version("3.6.4"):
807
certificate_type_get2 = _library.gnutls_certificate_type_get2
808
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
809
certificate_type_get2.restype = _error_code
811
# Remove non-public functions
812
del _error_code, _retry_on_error
813
# Create the global "gnutls" object, simulating a module
817
def call_pipe(connection, # : multiprocessing.Connection
818
func, *args, **kwargs):
819
"""This function is meant to be called by multiprocessing.Process
821
This function runs func(*args, **kwargs), and writes the resulting
822
return value on the provided multiprocessing.Connection.
824
connection.send(func(*args, **kwargs))
828
239
class Client(object):
829
240
"""A representation of a client host served by this server.
832
approved: bool(); 'None' if not yet approved/disapproved
833
approval_delay: datetime.timedelta(); Time to wait for approval
834
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)
835
257
checker: subprocess.Popen(); a running checker process used
836
258
to see if the client lives.
837
259
'None' if no process is running.
838
checker_callback_tag: a GLib event source tag, or None
839
checker_command: string; External command which is run to check
840
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
841
265
runtime with vars(self) as dict, so that for
842
266
instance %(name)s can be used in the command.
843
checker_initiator_tag: a GLib event source tag, or None
844
created: datetime.datetime(); (UTC) object creation
845
client_structure: Object describing what attributes a client has
846
and is used for storing the client at exit
847
267
current_checker_command: string; current running checker_command
848
disable_initiator_tag: a GLib event source tag, or None
850
fingerprint: string (40 or 32 hexadecimal digits); used to
851
uniquely identify an OpenPGP client
852
key_id: string (64 hexadecimal digits); used to uniquely identify
853
a client using raw public keys
854
host: string; available for use by the checker command
855
interval: datetime.timedelta(); How often to start a new checker
856
last_approval_request: datetime.datetime(); (UTC) or None
857
last_checked_ok: datetime.datetime(); (UTC) or None
858
last_checker_status: integer between 0 and 255 reflecting exit
859
status of last checker. -1 reflects crashed
860
checker, -2 means no checker completed yet.
861
last_checker_signal: The signal which killed the last checker, if
862
last_checker_status is -1
863
last_enabled: datetime.datetime(); (UTC) or None
864
name: string; from the config file, used in log messages and
866
secret: bytestring; sent verbatim (over TLS) to client
867
timeout: datetime.timedelta(); How long from last_checked_ok
868
until this client is disabled
869
extended_timeout: extra long timeout when secret has been sent
870
runtime_expansions: Allowed attributes for runtime expansion.
871
expires: datetime.datetime(); time (UTC) when a client will be
873
server_settings: The server_settings dict from main()
268
approved_delay: datetime.timedelta(); Time to wait for approval
269
_approved: bool(); 'None' if not yet approved/disapproved
270
approved_duration: datetime.timedelta(); Duration of one approval
876
runtime_expansions = ("approval_delay", "approval_duration",
877
"created", "enabled", "expires", "key_id",
878
"fingerprint", "host", "interval",
879
"last_approval_request", "last_checked_ok",
880
"last_enabled", "name", "timeout")
883
"extended_timeout": "PT15M",
885
"checker": "fping -q -- %%(host)s",
887
"approval_delay": "PT0S",
888
"approval_duration": "PT1S",
889
"approved_by_default": "True",
894
def config_parser(config):
895
"""Construct a new dict of client settings of this form:
896
{ client_name: {setting_name: value, ...}, ...}
897
with exceptions for any special settings as defined above.
898
NOTE: Must be a pure function. Must return the same result
899
value given the same arguments.
902
for client_name in config.sections():
903
section = dict(config.items(client_name))
904
client = settings[client_name] = {}
906
client["host"] = section["host"]
907
# Reformat values from string types to Python types
908
client["approved_by_default"] = config.getboolean(
909
client_name, "approved_by_default")
910
client["enabled"] = config.getboolean(client_name,
913
# Uppercase and remove spaces from key_id and fingerprint
914
# for later comparison purposes with return value from the
915
# key_id() and fingerprint() functions
916
client["key_id"] = (section.get("key_id", "").upper()
918
client["fingerprint"] = (section["fingerprint"].upper()
920
if "secret" in section:
921
client["secret"] = codecs.decode(section["secret"]
924
elif "secfile" in section:
925
with open(os.path.expanduser(os.path.expandvars
926
(section["secfile"])),
928
client["secret"] = secfile.read()
930
raise TypeError("No secret or secfile for section {}"
932
client["timeout"] = string_to_delta(section["timeout"])
933
client["extended_timeout"] = string_to_delta(
934
section["extended_timeout"])
935
client["interval"] = string_to_delta(section["interval"])
936
client["approval_delay"] = string_to_delta(
937
section["approval_delay"])
938
client["approval_duration"] = string_to_delta(
939
section["approval_duration"])
940
client["checker_command"] = section["checker"]
941
client["last_approval_request"] = None
942
client["last_checked_ok"] = None
943
client["last_checker_status"] = -2
947
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 approved_delay_milliseconds(self):
289
return self._timedelta_to_milliseconds(self.approved_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'
949
if server_settings is None:
951
self.server_settings = server_settings
952
# adding all client settings
953
for setting, value in settings.items():
954
setattr(self, setting, value)
957
if not hasattr(self, "last_enabled"):
958
self.last_enabled = datetime.datetime.utcnow()
959
if not hasattr(self, "expires"):
960
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()
963
self.last_enabled = None
966
logger.debug("Creating client %r", self.name)
967
logger.debug(" Key ID: %s", self.key_id)
968
logger.debug(" Fingerprint: %s", self.fingerprint)
969
self.created = settings.get("created",
970
datetime.datetime.utcnow())
972
# 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
973
323
self.checker = None
974
324
self.checker_initiator_tag = None
975
325
self.disable_initiator_tag = None
976
326
self.checker_callback_tag = None
327
self.checker_command = config[u"checker"]
977
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",
979
333
self.approvals_pending = 0
980
self.changedstate = multiprocessing_manager.Condition(
981
multiprocessing_manager.Lock())
982
self.client_structure = [attr
983
for attr in self.__dict__.keys()
984
if not attr.startswith("_")]
985
self.client_structure.append("client_structure")
987
for name, t in inspect.getmembers(
988
type(self), lambda obj: isinstance(obj, property)):
989
if not name.startswith("_"):
990
self.client_structure.append(name)
992
# Send notice to process children that client state has changed
334
self.approved_delay = string_to_delta(
335
config[u"approved_delay"])
336
self.approved_duration = string_to_delta(
337
config[u"approved_duration"])
338
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
993
340
def send_changedstate(self):
994
with self.changedstate:
995
self.changedstate.notify_all()
341
self.changedstate.acquire()
342
self.changedstate.notify_all()
343
self.changedstate.release()
997
345
def enable(self):
998
346
"""Start this client's checker and timeout hooks"""
999
if getattr(self, "enabled", False):
347
if getattr(self, u"enabled", False):
1000
348
# Already enabled
1002
self.expires = datetime.datetime.utcnow() + self.timeout
350
self.send_changedstate()
1004
351
self.last_enabled = datetime.datetime.utcnow()
1006
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*.
1008
365
def disable(self, quiet=True):
1009
366
"""Disable this client."""
1010
367
if not getattr(self, "enabled", False):
1013
logger.info("Disabling client %s", self.name)
1014
if getattr(self, "disable_initiator_tag", None) is not None:
1015
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)
1016
375
self.disable_initiator_tag = None
1018
if getattr(self, "checker_initiator_tag", None) is not None:
1019
GLib.source_remove(self.checker_initiator_tag)
376
if getattr(self, u"checker_initiator_tag", False):
377
gobject.source_remove(self.checker_initiator_tag)
1020
378
self.checker_initiator_tag = None
1021
379
self.stop_checker()
380
if self.disable_hook:
381
self.disable_hook(self)
1022
382
self.enabled = False
1024
self.send_changedstate()
1025
# 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
1028
386
def __del__(self):
387
self.disable_hook = None
1031
def init_checker(self):
1032
# Schedule a new checker to be started an 'interval' from now,
1033
# and every interval from then on.
1034
if self.checker_initiator_tag is not None:
1035
GLib.source_remove(self.checker_initiator_tag)
1036
self.checker_initiator_tag = GLib.timeout_add(
1037
int(self.interval.total_seconds() * 1000),
1039
# Schedule a disable() when 'timeout' has passed
1040
if self.disable_initiator_tag is not None:
1041
GLib.source_remove(self.disable_initiator_tag)
1042
self.disable_initiator_tag = GLib.timeout_add(
1043
int(self.timeout.total_seconds() * 1000), self.disable)
1044
# Also start a new checker *right now*.
1045
self.start_checker()
1047
def checker_callback(self, source, condition, connection,
390
def checker_callback(self, pid, condition, command):
1049
391
"""The checker has completed, so take appropriate actions."""
1050
392
self.checker_callback_tag = None
1051
393
self.checker = None
1052
# Read return code from connection (see call_pipe)
1053
returncode = connection.recv()
1057
self.last_checker_status = returncode
1058
self.last_checker_signal = None
1059
if self.last_checker_status == 0:
1060
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",
1062
399
self.checked_ok()
1064
logger.info("Checker for %(name)s failed", vars(self))
401
logger.info(u"Checker for %(name)s failed",
1066
self.last_checker_status = -1
1067
self.last_checker_signal = -returncode
1068
logger.warning("Checker for %(name)s crashed?",
404
logger.warning(u"Checker for %(name)s crashed?",
1072
407
def checked_ok(self):
1073
"""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,
1074
413
self.last_checked_ok = datetime.datetime.utcnow()
1075
self.last_checker_status = 0
1076
self.last_checker_signal = None
1079
def bump_timeout(self, timeout=None):
1080
"""Bump up the timeout for this client."""
1082
timeout = self.timeout
1083
if self.disable_initiator_tag is not None:
1084
GLib.source_remove(self.disable_initiator_tag)
1085
self.disable_initiator_tag = None
1086
if getattr(self, "enabled", False):
1087
self.disable_initiator_tag = GLib.timeout_add(
1088
int(timeout.total_seconds() * 1000), self.disable)
1089
self.expires = datetime.datetime.utcnow() + timeout
1091
def need_approval(self):
1092
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(),
1094
419
def start_checker(self):
1095
420
"""Start a new checker subprocess if one is not running.
1097
422
If a checker already exists, leave it running and do
1099
424
# The reason for not killing a running checker is that if we
1100
# did that, and if a checker (for some reason) started running
1101
# slowly and taking more than 'interval' time, then the client
1102
# would inevitably timeout, since no checker would get a
1103
# 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
1104
429
# checkers alone, the checker would have to take more time
1105
430
# than 'timeout' for the client to be disabled, which is as it
1108
if self.checker is not None and not self.checker.is_alive():
1109
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)
1112
446
# Start a new checker if needed
1113
447
if self.checker is None:
1114
# Escape attributes for the shell
1116
attr: re.escape(str(getattr(self, attr)))
1117
for attr in self.runtime_expansions}
1119
command = self.checker_command % escaped_attrs
1120
except TypeError as error:
1121
logger.error('Could not format string "%s"',
1122
self.checker_command,
1124
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
1125
465
self.current_checker_command = command
1126
logger.info("Starting checker %r for %s", command,
1128
# We don't need to redirect stdout and stderr, since
1129
# in normal mode, that is already done by daemon(),
1130
# and in debug mode we don't want to. (Stdin is
1131
# always replaced by /dev/null.)
1132
# The exception is when not debugging but nevertheless
1133
# running in the foreground; use the previously
1135
popen_args = {"close_fds": True,
1138
if (not self.server_settings["debug"]
1139
and self.server_settings["foreground"]):
1140
popen_args.update({"stdout": wnull,
1142
pipe = multiprocessing.Pipe(duplex=False)
1143
self.checker = multiprocessing.Process(
1145
args=(pipe[1], subprocess.call, command),
1147
self.checker.start()
1148
self.checker_callback_tag = GLib.io_add_watch(
1149
pipe[0].fileno(), GLib.IO_IN,
1150
self.checker_callback, pipe[0], command)
1151
# 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
1154
492
def stop_checker(self):
1155
493
"""Force the checker process, if any, to stop."""
1156
494
if self.checker_callback_tag:
1157
GLib.source_remove(self.checker_callback_tag)
495
gobject.source_remove(self.checker_callback_tag)
1158
496
self.checker_callback_tag = None
1159
if getattr(self, "checker", None) is None:
497
if getattr(self, u"checker", None) is None:
1161
logger.debug("Stopping checker for %(name)s", vars(self))
1162
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
1163
508
self.checker = None
1166
def dbus_service_property(dbus_interface,
510
def dbus_service_property(dbus_interface, signature=u"v",
511
access=u"readwrite", byte_arrays=False):
1170
512
"""Decorators for marking methods of a DBusObjectWithProperties to
1171
513
become properties on the D-Bus.
1173
515
The decorated method will be called with no arguments by "Get"
1174
516
and with one argument by "Set".
1176
518
The parameters, where they are supported, are the same as
1177
519
dbus.service.method, except there is only "signature", since the
1178
520
type from Get() and the type sent to Set() is the same.
1180
522
# Encoding deeply encoded byte arrays is not supported yet by the
1181
523
# "Set" method, so we fail early here:
1182
if byte_arrays and signature != "ay":
1183
raise ValueError("Byte arrays not supported for non-'ay'"
1184
" 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)
1186
527
def decorator(func):
1187
528
func._dbus_is_property = True
1188
529
func._dbus_interface = dbus_interface
1189
530
func._dbus_signature = signature
1190
531
func._dbus_access = access
1191
532
func._dbus_name = func.__name__
1192
if func._dbus_name.endswith("_dbus_property"):
533
if func._dbus_name.endswith(u"_dbus_property"):
1193
534
func._dbus_name = func._dbus_name[:-14]
1194
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1200
def dbus_interface_annotations(dbus_interface):
1201
"""Decorator for marking functions returning interface annotations
1205
@dbus_interface_annotations("org.example.Interface")
1206
def _foo(self): # Function name does not matter
1207
return {"org.freedesktop.DBus.Deprecated": "true",
1208
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1212
def decorator(func):
1213
func._dbus_is_interface = True
1214
func._dbus_interface = dbus_interface
1215
func._dbus_name = dbus_interface
1221
def dbus_annotations(annotations):
1222
"""Decorator to annotate D-Bus methods, signals or properties
1225
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1226
"org.freedesktop.DBus.Property."
1227
"EmitsChangedSignal": "false"})
1228
@dbus_service_property("org.example.Interface", signature="b",
1230
def Property_dbus_property(self):
1231
return dbus.Boolean(False)
1233
See also the DBusObjectWithAnnotations class.
1236
def decorator(func):
1237
func._dbus_annotations = annotations
535
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1240
537
return decorator
1243
540
class DBusPropertyException(dbus.exceptions.DBusException):
1244
541
"""A base class for D-Bus property-related exceptions
543
def __unicode__(self):
544
return unicode(str(self))
1249
547
class DBusPropertyAccessException(DBusPropertyException):
1261
class DBusObjectWithAnnotations(dbus.service.Object):
1262
"""A D-Bus object with annotations.
1264
Classes inheriting from this can use the dbus_annotations
1265
decorator to add annotations to methods or signals.
1269
def _is_dbus_thing(thing):
1270
"""Returns a function testing if an attribute is a D-Bus thing
1272
If called like _is_dbus_thing("method") it returns a function
1273
suitable for use as predicate to inspect.getmembers().
1275
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1278
def _get_all_dbus_things(self, thing):
1279
"""Returns a generator of (name, attribute) pairs
1281
return ((getattr(athing.__get__(self), "_dbus_name", name),
1282
athing.__get__(self))
1283
for cls in self.__class__.__mro__
1285
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1287
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1289
path_keyword='object_path',
1290
connection_keyword='connection')
1291
def Introspect(self, object_path, connection):
1292
"""Overloading of standard D-Bus method.
1294
Inserts annotation tags on methods and signals.
1296
xmlstring = dbus.service.Object.Introspect(self, object_path,
1299
document = xml.dom.minidom.parseString(xmlstring)
1301
for if_tag in document.getElementsByTagName("interface"):
1302
# Add annotation tags
1303
for typ in ("method", "signal"):
1304
for tag in if_tag.getElementsByTagName(typ):
1306
for name, prop in (self.
1307
_get_all_dbus_things(typ)):
1308
if (name == tag.getAttribute("name")
1309
and prop._dbus_interface
1310
== if_tag.getAttribute("name")):
1311
annots.update(getattr(
1312
prop, "_dbus_annotations", {}))
1313
for name, value in annots.items():
1314
ann_tag = document.createElement(
1316
ann_tag.setAttribute("name", name)
1317
ann_tag.setAttribute("value", value)
1318
tag.appendChild(ann_tag)
1319
# Add interface annotation tags
1320
for annotation, value in dict(
1321
itertools.chain.from_iterable(
1322
annotations().items()
1323
for name, annotations
1324
in self._get_all_dbus_things("interface")
1325
if name == if_tag.getAttribute("name")
1327
ann_tag = document.createElement("annotation")
1328
ann_tag.setAttribute("name", annotation)
1329
ann_tag.setAttribute("value", value)
1330
if_tag.appendChild(ann_tag)
1331
# Fix argument name for the Introspect method itself
1332
if (if_tag.getAttribute("name")
1333
== dbus.INTROSPECTABLE_IFACE):
1334
for cn in if_tag.getElementsByTagName("method"):
1335
if cn.getAttribute("name") == "Introspect":
1336
for arg in cn.getElementsByTagName("arg"):
1337
if (arg.getAttribute("direction")
1339
arg.setAttribute("name",
1341
xmlstring = document.toxml("utf-8")
1343
except (AttributeError, xml.dom.DOMException,
1344
xml.parsers.expat.ExpatError) as error:
1345
logger.error("Failed to override Introspection method",
1350
class DBusObjectWithProperties(DBusObjectWithAnnotations):
559
class DBusObjectWithProperties(dbus.service.Object):
1351
560
"""A D-Bus object with properties.
1353
562
Classes inheriting from this can use the dbus_service_property
1354
563
decorator to expose methods as D-Bus properties. It exposes the
1355
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))
1358
578
def _get_dbus_property(self, interface_name, property_name):
1359
579
"""Returns a bound method if one exists which is a D-Bus
1360
580
property with the specified name and interface.
1362
for cls in self.__class__.__mro__:
1363
for name, value in inspect.getmembers(
1364
cls, self._is_dbus_thing("property")):
1365
if (value._dbus_name == property_name
1366
and value._dbus_interface == interface_name):
1367
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)):
1369
592
# No such property
1370
raise DBusPropertyNotFound("{}:{}.{}".format(
1371
self.dbus_object_path, interface_name, property_name))
1374
def _get_all_interface_names(cls):
1375
"""Get a sequence of all interfaces supported by an object"""
1376
return (name for name in set(getattr(getattr(x, attr),
1377
"_dbus_interface", None)
1378
for x in (inspect.getmro(cls))
1380
if name is not None)
1382
@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",
1385
599
def Get(self, interface_name, property_name):
1386
600
"""Standard D-Bus property Get() method, see D-Bus standard.
1388
602
prop = self._get_dbus_property(interface_name, property_name)
1389
if prop._dbus_access == "write":
603
if prop._dbus_access == u"write":
1390
604
raise DBusPropertyAccessException(property_name)
1392
if not hasattr(value, "variant_level"):
606
if not hasattr(value, u"variant_level"):
1394
608
return type(value)(value, variant_level=value.variant_level+1)
1396
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1397
611
def Set(self, interface_name, property_name, value):
1398
612
"""Standard D-Bus property Set() method, see D-Bus standard.
1400
614
prop = self._get_dbus_property(interface_name, property_name)
1401
if prop._dbus_access == "read":
615
if prop._dbus_access == u"read":
1402
616
raise DBusPropertyAccessException(property_name)
1403
if prop._dbus_get_args_options["byte_arrays"]:
617
if prop._dbus_get_args_options[u"byte_arrays"]:
1404
618
# The byte_arrays option is not supported yet on
1405
619
# signatures other than "ay".
1406
if prop._dbus_signature != "ay":
1407
raise ValueError("Byte arrays not supported for non-"
1408
"'ay' signature {!r}"
1409
.format(prop._dbus_signature))
1410
value = dbus.ByteArray(b''.join(chr(byte)
620
if prop._dbus_signature != u"ay":
622
value = dbus.ByteArray(''.join(unichr(byte)
1414
@dbus.service.method(dbus.PROPERTIES_IFACE,
1416
out_signature="a{sv}")
626
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
627
out_signature=u"a{sv}")
1417
628
def GetAll(self, interface_name):
1418
629
"""Standard D-Bus property GetAll() method, see D-Bus
1421
632
Note: Will not include properties with access="write".
1424
for name, prop in self._get_all_dbus_things("property"):
635
for name, prop in self._get_all_dbus_properties():
1425
636
if (interface_name
1426
637
and interface_name != prop._dbus_interface):
1427
638
# Interface non-empty but did not match
1429
640
# Ignore write-only properties
1430
if prop._dbus_access == "write":
641
if prop._dbus_access == u"write":
1433
if not hasattr(value, "variant_level"):
1434
properties[name] = value
644
if not hasattr(value, u"variant_level"):
1436
properties[name] = type(value)(
1437
value, variant_level=value.variant_level + 1)
1438
return dbus.Dictionary(properties, signature="sv")
1440
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1441
def PropertiesChanged(self, interface_name, changed_properties,
1442
invalidated_properties):
1443
"""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")
1448
651
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1450
653
path_keyword='object_path',
1451
654
connection_keyword='connection')
1452
655
def Introspect(self, object_path, connection):
1453
"""Overloading of standard D-Bus method.
1455
Inserts property tags and interface annotation tags.
656
"""Standard D-Bus method, overloaded to insert property tags.
1457
xmlstring = DBusObjectWithAnnotations.Introspect(self,
658
xmlstring = dbus.service.Object.Introspect(self, object_path,
1461
661
document = xml.dom.minidom.parseString(xmlstring)
1463
662
def make_tag(document, name, prop):
1464
e = document.createElement("property")
1465
e.setAttribute("name", name)
1466
e.setAttribute("type", prop._dbus_signature)
1467
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)
1470
for if_tag in document.getElementsByTagName("interface"):
668
for if_tag in document.getElementsByTagName(u"interface"):
1472
669
for tag in (make_tag(document, name, prop)
1474
in self._get_all_dbus_things("property")
671
in self._get_all_dbus_properties()
1475
672
if prop._dbus_interface
1476
== if_tag.getAttribute("name")):
673
== if_tag.getAttribute(u"name")):
1477
674
if_tag.appendChild(tag)
1478
# Add annotation tags for properties
1479
for tag in if_tag.getElementsByTagName("property"):
1481
for name, prop in self._get_all_dbus_things(
1483
if (name == tag.getAttribute("name")
1484
and prop._dbus_interface
1485
== if_tag.getAttribute("name")):
1486
annots.update(getattr(
1487
prop, "_dbus_annotations", {}))
1488
for name, value in annots.items():
1489
ann_tag = document.createElement(
1491
ann_tag.setAttribute("name", name)
1492
ann_tag.setAttribute("value", value)
1493
tag.appendChild(ann_tag)
1494
675
# Add the names to the return values for the
1495
676
# "org.freedesktop.DBus.Properties" methods
1496
if (if_tag.getAttribute("name")
1497
== "org.freedesktop.DBus.Properties"):
1498
for cn in if_tag.getElementsByTagName("method"):
1499
if cn.getAttribute("name") == "Get":
1500
for arg in cn.getElementsByTagName("arg"):
1501
if (arg.getAttribute("direction")
1503
arg.setAttribute("name", "value")
1504
elif cn.getAttribute("name") == "GetAll":
1505
for arg in cn.getElementsByTagName("arg"):
1506
if (arg.getAttribute("direction")
1508
arg.setAttribute("name", "props")
1509
xmlstring = document.toxml("utf-8")
1511
except (AttributeError, xml.dom.DOMException,
1512
xml.parsers.expat.ExpatError) as error:
1513
logger.error("Failed to override Introspection method",
1519
dbus.OBJECT_MANAGER_IFACE
1520
except AttributeError:
1521
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1524
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1525
"""A D-Bus object with an ObjectManager.
1527
Classes inheriting from this exposes the standard
1528
GetManagedObjects call and the InterfacesAdded and
1529
InterfacesRemoved signals on the standard
1530
"org.freedesktop.DBus.ObjectManager" interface.
1532
Note: No signals are sent automatically; they must be sent
1535
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1536
out_signature="a{oa{sa{sv}}}")
1537
def GetManagedObjects(self):
1538
"""This function must be overridden"""
1539
raise NotImplementedError()
1541
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1542
signature="oa{sa{sv}}")
1543
def InterfacesAdded(self, object_path, interfaces_and_properties):
1546
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1547
def InterfacesRemoved(self, object_path, interfaces):
1550
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1552
path_keyword='object_path',
1553
connection_keyword='connection')
1554
def Introspect(self, object_path, connection):
1555
"""Overloading of standard D-Bus method.
1557
Override return argument name of GetManagedObjects to be
1558
"objpath_interfaces_and_properties"
1560
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1564
document = xml.dom.minidom.parseString(xmlstring)
1566
for if_tag in document.getElementsByTagName("interface"):
1567
# Fix argument name for the GetManagedObjects method
1568
if (if_tag.getAttribute("name")
1569
== dbus.OBJECT_MANAGER_IFACE):
1570
for cn in if_tag.getElementsByTagName("method"):
1571
if (cn.getAttribute("name")
1572
== "GetManagedObjects"):
1573
for arg in cn.getElementsByTagName("arg"):
1574
if (arg.getAttribute("direction")
1578
"objpath_interfaces"
1580
xmlstring = document.toxml("utf-8")
1582
except (AttributeError, xml.dom.DOMException,
1583
xml.parsers.expat.ExpatError) as error:
1584
logger.error("Failed to override Introspection method",
1589
def datetime_to_dbus(dt, variant_level=0):
1590
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1592
return dbus.String("", variant_level=variant_level)
1593
return dbus.String(dt.isoformat(), variant_level=variant_level)
1596
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1597
"""A class decorator; applied to a subclass of
1598
dbus.service.Object, it will add alternate D-Bus attributes with
1599
interface names according to the "alt_interface_names" mapping.
1602
@alternate_dbus_interfaces({"org.example.Interface":
1603
"net.example.AlternateInterface"})
1604
class SampleDBusObject(dbus.service.Object):
1605
@dbus.service.method("org.example.Interface")
1606
def SampleDBusMethod():
1609
The above "SampleDBusMethod" on "SampleDBusObject" will be
1610
reachable via two interfaces: "org.example.Interface" and
1611
"net.example.AlternateInterface", the latter of which will have
1612
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1613
"true", unless "deprecate" is passed with a False value.
1615
This works for methods and signals, and also for D-Bus properties
1616
(from DBusObjectWithProperties) and interfaces (from the
1617
dbus_interface_annotations decorator).
1621
for orig_interface_name, alt_interface_name in (
1622
alt_interface_names.items()):
1624
interface_names = set()
1625
# Go though all attributes of the class
1626
for attrname, attribute in inspect.getmembers(cls):
1627
# Ignore non-D-Bus attributes, and D-Bus attributes
1628
# with the wrong interface name
1629
if (not hasattr(attribute, "_dbus_interface")
1630
or not attribute._dbus_interface.startswith(
1631
orig_interface_name)):
1633
# Create an alternate D-Bus interface name based on
1635
alt_interface = attribute._dbus_interface.replace(
1636
orig_interface_name, alt_interface_name)
1637
interface_names.add(alt_interface)
1638
# Is this a D-Bus signal?
1639
if getattr(attribute, "_dbus_is_signal", False):
1640
# Extract the original non-method undecorated
1641
# function by black magic
1642
if sys.version_info.major == 2:
1643
nonmethod_func = (dict(
1644
zip(attribute.func_code.co_freevars,
1645
attribute.__closure__))
1646
["func"].cell_contents)
1648
nonmethod_func = (dict(
1649
zip(attribute.__code__.co_freevars,
1650
attribute.__closure__))
1651
["func"].cell_contents)
1652
# Create a new, but exactly alike, function
1653
# object, and decorate it to be a new D-Bus signal
1654
# with the alternate D-Bus interface name
1655
new_function = copy_function(nonmethod_func)
1656
new_function = (dbus.service.signal(
1658
attribute._dbus_signature)(new_function))
1659
# Copy annotations, if any
1661
new_function._dbus_annotations = dict(
1662
attribute._dbus_annotations)
1663
except AttributeError:
1666
# Define a creator of a function to call both the
1667
# original and alternate functions, so both the
1668
# original and alternate signals gets sent when
1669
# the function is called
1670
def fixscope(func1, func2):
1671
"""This function is a scope container to pass
1672
func1 and func2 to the "call_both" function
1673
outside of its arguments"""
1675
@functools.wraps(func2)
1676
def call_both(*args, **kwargs):
1677
"""This function will emit two D-Bus
1678
signals by calling func1 and func2"""
1679
func1(*args, **kwargs)
1680
func2(*args, **kwargs)
1681
# Make wrapper function look like a D-Bus
1683
for name, attr in inspect.getmembers(func2):
1684
if name.startswith("_dbus_"):
1685
setattr(call_both, name, attr)
1688
# Create the "call_both" function and add it to
1690
attr[attrname] = fixscope(attribute, new_function)
1691
# Is this a D-Bus method?
1692
elif getattr(attribute, "_dbus_is_method", False):
1693
# Create a new, but exactly alike, function
1694
# object. Decorate it to be a new D-Bus method
1695
# with the alternate D-Bus interface name. Add it
1698
dbus.service.method(
1700
attribute._dbus_in_signature,
1701
attribute._dbus_out_signature)
1702
(copy_function(attribute)))
1703
# Copy annotations, if any
1705
attr[attrname]._dbus_annotations = dict(
1706
attribute._dbus_annotations)
1707
except AttributeError:
1709
# Is this a D-Bus property?
1710
elif getattr(attribute, "_dbus_is_property", False):
1711
# Create a new, but exactly alike, function
1712
# object, and decorate it to be a new D-Bus
1713
# property with the alternate D-Bus interface
1714
# name. Add it to the class.
1715
attr[attrname] = (dbus_service_property(
1716
alt_interface, attribute._dbus_signature,
1717
attribute._dbus_access,
1718
attribute._dbus_get_args_options
1720
(copy_function(attribute)))
1721
# Copy annotations, if any
1723
attr[attrname]._dbus_annotations = dict(
1724
attribute._dbus_annotations)
1725
except AttributeError:
1727
# Is this a D-Bus interface?
1728
elif getattr(attribute, "_dbus_is_interface", False):
1729
# Create a new, but exactly alike, function
1730
# object. Decorate it to be a new D-Bus interface
1731
# with the alternate D-Bus interface name. Add it
1734
dbus_interface_annotations(alt_interface)
1735
(copy_function(attribute)))
1737
# Deprecate all alternate interfaces
1738
iname = "_AlternateDBusNames_interface_annotation{}"
1739
for interface_name in interface_names:
1741
@dbus_interface_annotations(interface_name)
1743
return {"org.freedesktop.DBus.Deprecated":
1745
# Find an unused name
1746
for aname in (iname.format(i)
1747
for i in itertools.count()):
1748
if aname not in attr:
1752
# Replace the class with a new subclass of it with
1753
# methods, signals, etc. as created above.
1754
if sys.version_info.major == 2:
1755
cls = type(b"{}Alternate".format(cls.__name__),
1758
cls = type("{}Alternate".format(cls.__name__),
1765
@alternate_dbus_interfaces({"se.recompile.Mandos":
1766
"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",
1767
699
class ClientDBus(Client, DBusObjectWithProperties):
1768
700
"""A Client class using D-Bus
1771
703
dbus_object_path: dbus.ObjectPath
1772
704
bus: dbus.SystemBus()
1775
runtime_expansions = (Client.runtime_expansions
1776
+ ("dbus_object_path", ))
1778
_interface = "se.recompile.Mandos.Client"
1780
706
# dbus.service.Object doesn't use super(), so we can't either.
1782
def __init__(self, bus=None, *args, **kwargs):
708
def __init__(self, bus = None, *args, **kwargs):
709
self._approvals_pending = 0
1784
711
Client.__init__(self, *args, **kwargs)
1785
712
# Only now, when this client is initialized, can it show up on
1787
client_object_name = str(self.name).translate(
1788
{ord("."): ord("_"),
1789
ord("-"): ord("_")})
1790
self.dbus_object_path = dbus.ObjectPath(
1791
"/clients/" + client_object_name)
714
self.dbus_object_path = (dbus.ObjectPath
716
+ self.name.replace(u".", u"_")))
1792
717
DBusObjectWithProperties.__init__(self, self.bus,
1793
718
self.dbus_object_path)
1795
def notifychangeproperty(transform_func, dbus_name,
1796
type_func=lambda x: x,
1798
invalidate_only=False,
1799
_interface=_interface):
1800
""" Modify a variable so that it's a property which announces
1801
its changes to DBus.
1803
transform_fun: Function that takes a value and a variant_level
1804
and transforms it to a D-Bus type.
1805
dbus_name: D-Bus name of the variable
1806
type_func: Function that transform the value before sending it
1807
to the D-Bus. Default: no transform
1808
variant_level: D-Bus variant level. Default: 1
1810
attrname = "_{}".format(dbus_name)
1812
def setter(self, value):
1813
if hasattr(self, "dbus_object_path"):
1814
if (not hasattr(self, attrname) or
1815
type_func(getattr(self, attrname, None))
1816
!= type_func(value)):
1818
self.PropertiesChanged(
1819
_interface, dbus.Dictionary(),
1820
dbus.Array((dbus_name, )))
1822
dbus_value = transform_func(
1824
variant_level=variant_level)
1825
self.PropertyChanged(dbus.String(dbus_name),
1827
self.PropertiesChanged(
1829
dbus.Dictionary({dbus.String(dbus_name):
1832
setattr(self, attrname, value)
1834
return property(lambda self: getattr(self, attrname), setter)
1836
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1837
approvals_pending = notifychangeproperty(dbus.Boolean,
1840
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1841
last_enabled = notifychangeproperty(datetime_to_dbus,
1843
checker = notifychangeproperty(
1844
dbus.Boolean, "CheckerRunning",
1845
type_func=lambda checker: checker is not None)
1846
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1848
last_checker_status = notifychangeproperty(dbus.Int16,
1849
"LastCheckerStatus")
1850
last_approval_request = notifychangeproperty(
1851
datetime_to_dbus, "LastApprovalRequest")
1852
approved_by_default = notifychangeproperty(dbus.Boolean,
1853
"ApprovedByDefault")
1854
approval_delay = notifychangeproperty(
1855
dbus.UInt64, "ApprovalDelay",
1856
type_func=lambda td: td.total_seconds() * 1000)
1857
approval_duration = notifychangeproperty(
1858
dbus.UInt64, "ApprovalDuration",
1859
type_func=lambda td: td.total_seconds() * 1000)
1860
host = notifychangeproperty(dbus.String, "Host")
1861
timeout = notifychangeproperty(
1862
dbus.UInt64, "Timeout",
1863
type_func=lambda td: td.total_seconds() * 1000)
1864
extended_timeout = notifychangeproperty(
1865
dbus.UInt64, "ExtendedTimeout",
1866
type_func=lambda td: td.total_seconds() * 1000)
1867
interval = notifychangeproperty(
1868
dbus.UInt64, "Interval",
1869
type_func=lambda td: td.total_seconds() * 1000)
1870
checker_command = notifychangeproperty(dbus.String, "Checker")
1871
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1872
invalidate_only=True)
1874
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"approved_pending"),
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"last_enabled"),
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))
1876
764
def __del__(self, *args, **kwargs):
1878
766
self.remove_from_connection()
1879
767
except LookupError:
1881
if hasattr(DBusObjectWithProperties, "__del__"):
769
if hasattr(DBusObjectWithProperties, u"__del__"):
1882
770
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1883
771
Client.__del__(self, *args, **kwargs)
1885
def checker_callback(self, source, condition,
1886
connection, command, *args, **kwargs):
1887
ret = Client.checker_callback(self, source, condition,
1888
connection, command, *args,
1890
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"checker_running"),
779
dbus.Boolean(False, variant_level=1))
780
if os.WIFEXITED(condition):
781
exitstatus = os.WEXITSTATUS(condition)
1892
782
# Emit D-Bus signal
1893
783
self.CheckerCompleted(dbus.Int16(exitstatus),
1894
# This is specific to GNU libC
1895
dbus.Int64(exitstatus << 8),
784
dbus.Int64(condition),
1896
785
dbus.String(command))
1898
787
# Emit D-Bus signal
1899
788
self.CheckerCompleted(dbus.Int16(-1),
1901
# This is specific to GNU libC
1903
| self.last_checker_signal),
789
dbus.Int64(condition),
1904
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"last_checked_ok"),
800
(self._datetime_to_dbus(self.last_checked_ok,
1907
804
def start_checker(self, *args, **kwargs):
1908
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
1909
810
r = Client.start_checker(self, *args, **kwargs)
1910
811
# Only if new checker process was started
1911
812
if (self.checker is not None
1912
813
and old_checker_pid != self.checker.pid):
1913
814
# Emit D-Bus signal
1914
815
self.CheckerStarted(self.current_checker_command)
816
self.PropertyChanged(
817
dbus.String(u"checker_running"),
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"checker_running"),
827
dbus.Boolean(False, variant_level=1))
1917
830
def _reset_approved(self):
1918
self.approved = None
831
self._approved = None
1921
834
def approve(self, value=True):
1922
self.approved = value
1923
GLib.timeout_add(int(self.approval_duration.total_seconds()
1924
* 1000), self._reset_approved)
1925
835
self.send_changedstate()
1927
# D-Bus methods, signals & properties
836
self._approved = value
837
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration),
838
self._reset_approved)
841
## D-Bus methods, signals & properties
842
_interface = u"se.bsnet.fukt.Mandos.Client"
1933
846
# CheckerCompleted - signal
1934
@dbus.service.signal(_interface, signature="nxs")
847
@dbus.service.signal(_interface, signature=u"nxs")
1935
848
def CheckerCompleted(self, exitcode, waitstatus, command):
1939
852
# CheckerStarted - signal
1940
@dbus.service.signal(_interface, signature="s")
853
@dbus.service.signal(_interface, signature=u"s")
1941
854
def CheckerStarted(self, command):
1945
858
# PropertyChanged - signal
1946
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1947
@dbus.service.signal(_interface, signature="sv")
859
@dbus.service.signal(_interface, signature=u"sv")
1948
860
def PropertyChanged(self, property, value):
1952
864
# GotSecret - signal
1953
865
@dbus.service.signal(_interface)
1954
866
def GotSecret(self):
1957
869
server to mandos-client
1961
873
# Rejected - signal
1962
@dbus.service.signal(_interface, signature="s")
874
@dbus.service.signal(_interface, signature=u"s")
1963
875
def Rejected(self, reason):
1967
879
# NeedApproval - signal
1968
@dbus.service.signal(_interface, signature="tb")
880
@dbus.service.signal(_interface, signature=u"db")
1969
881
def NeedApproval(self, timeout, default):
1971
return self.need_approval()
1975
887
# Approve - method
1976
@dbus.service.method(_interface, in_signature="b")
888
@dbus.service.method(_interface, in_signature=u"b")
1977
889
def Approve(self, value):
1978
890
self.approve(value)
1980
892
# CheckedOK - method
1981
893
@dbus.service.method(_interface)
1982
894
def CheckedOK(self):
895
return self.checked_ok()
1985
897
# Enable - method
1986
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1987
898
@dbus.service.method(_interface)
1988
899
def Enable(self):
1992
903
# StartChecker - method
1993
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1994
904
@dbus.service.method(_interface)
1995
905
def StartChecker(self):
1997
907
self.start_checker()
1999
909
# Disable - method
2000
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2001
910
@dbus.service.method(_interface)
2002
911
def Disable(self):
2006
915
# StopChecker - method
2007
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2008
916
@dbus.service.method(_interface)
2009
917
def StopChecker(self):
2010
918
self.stop_checker()
2014
# ApprovalPending - property
2015
@dbus_service_property(_interface, signature="b", access="read")
2016
def ApprovalPending_dbus_property(self):
922
# approved_pending - property
923
@dbus_service_property(_interface, signature=u"b", access=u"read")
924
def approved_pending_dbus_property(self):
2017
925
return dbus.Boolean(bool(self.approvals_pending))
2019
# ApprovedByDefault - property
2020
@dbus_service_property(_interface,
2023
def ApprovedByDefault_dbus_property(self, value=None):
2024
if value is None: # get
2025
return dbus.Boolean(self.approved_by_default)
2026
self.approved_by_default = bool(value)
2028
# ApprovalDelay - property
2029
@dbus_service_property(_interface,
2032
def ApprovalDelay_dbus_property(self, value=None):
2033
if value is None: # get
2034
return dbus.UInt64(self.approval_delay.total_seconds()
2036
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2038
# ApprovalDuration - property
2039
@dbus_service_property(_interface,
2042
def ApprovalDuration_dbus_property(self, value=None):
2043
if value is None: # get
2044
return dbus.UInt64(self.approval_duration.total_seconds()
2046
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2050
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2051
@dbus_service_property(_interface, signature="s", access="read")
2052
def Name_dbus_property(self):
927
# approved_by_default - property
928
@dbus_service_property(_interface, signature=u"b",
930
def approved_by_default_dbus_property(self):
931
return dbus.Boolean(self.approved_by_default)
933
# approved_delay - property
934
@dbus_service_property(_interface, signature=u"t",
936
def approved_delay_dbus_property(self):
937
return dbus.UInt64(self.approved_delay_milliseconds())
939
# approved_duration - property
940
@dbus_service_property(_interface, signature=u"t",
942
def approved_duration_dbus_property(self):
943
return dbus.UInt64(self._timedelta_to_milliseconds(
944
self.approved_duration))
947
@dbus_service_property(_interface, signature=u"s", access=u"read")
948
def name_dbus_property(self):
2053
949
return dbus.String(self.name)
2057
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2058
@dbus_service_property(_interface, signature="s", access="read")
2059
def KeyID_dbus_property(self):
2060
return dbus.String(self.key_id)
2062
# Fingerprint - property
2064
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2065
@dbus_service_property(_interface, signature="s", access="read")
2066
def Fingerprint_dbus_property(self):
951
# fingerprint - property
952
@dbus_service_property(_interface, signature=u"s", access=u"read")
953
def fingerprint_dbus_property(self):
2067
954
return dbus.String(self.fingerprint)
2070
@dbus_service_property(_interface,
2073
def Host_dbus_property(self, value=None):
957
@dbus_service_property(_interface, signature=u"s",
959
def host_dbus_property(self, value=None):
2074
960
if value is None: # get
2075
961
return dbus.String(self.host)
2076
self.host = str(value)
2078
# Created - property
2080
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2081
@dbus_service_property(_interface, signature="s", access="read")
2082
def Created_dbus_property(self):
2083
return datetime_to_dbus(self.created)
2085
# LastEnabled - property
2086
@dbus_service_property(_interface, signature="s", access="read")
2087
def LastEnabled_dbus_property(self):
2088
return datetime_to_dbus(self.last_enabled)
2090
# Enabled - property
2091
@dbus_service_property(_interface,
2094
def Enabled_dbus_property(self, value=None):
964
self.PropertyChanged(dbus.String(u"host"),
965
dbus.String(value, variant_level=1))
968
@dbus_service_property(_interface, signature=u"s", access=u"read")
969
def created_dbus_property(self):
970
return dbus.String(self._datetime_to_dbus(self.created))
972
# last_enabled - property
973
@dbus_service_property(_interface, signature=u"s", access=u"read")
974
def last_enabled_dbus_property(self):
975
if self.last_enabled is None:
976
return dbus.String(u"")
977
return dbus.String(self._datetime_to_dbus(self.last_enabled))
980
@dbus_service_property(_interface, signature=u"b",
982
def enabled_dbus_property(self, value=None):
2095
983
if value is None: # get
2096
984
return dbus.Boolean(self.enabled)
2102
# LastCheckedOK - property
2103
@dbus_service_property(_interface,
2106
def LastCheckedOK_dbus_property(self, value=None):
990
# last_checked_ok - property
991
@dbus_service_property(_interface, signature=u"s",
993
def last_checked_ok_dbus_property(self, value=None):
2107
994
if value is not None:
2108
995
self.checked_ok()
2110
return datetime_to_dbus(self.last_checked_ok)
2112
# LastCheckerStatus - property
2113
@dbus_service_property(_interface, signature="n", access="read")
2114
def LastCheckerStatus_dbus_property(self):
2115
return dbus.Int16(self.last_checker_status)
2117
# Expires - property
2118
@dbus_service_property(_interface, signature="s", access="read")
2119
def Expires_dbus_property(self):
2120
return datetime_to_dbus(self.expires)
2122
# LastApprovalRequest - property
2123
@dbus_service_property(_interface, signature="s", access="read")
2124
def LastApprovalRequest_dbus_property(self):
2125
return datetime_to_dbus(self.last_approval_request)
2127
# Timeout - property
2128
@dbus_service_property(_interface,
2131
def Timeout_dbus_property(self, value=None):
997
if self.last_checked_ok is None:
998
return dbus.String(u"")
999
return dbus.String(self._datetime_to_dbus(self
1002
# timeout - property
1003
@dbus_service_property(_interface, signature=u"t",
1004
access=u"readwrite")
1005
def timeout_dbus_property(self, value=None):
2132
1006
if value is None: # get
2133
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2134
old_timeout = self.timeout
1007
return dbus.UInt64(self.timeout_milliseconds())
2135
1008
self.timeout = datetime.timedelta(0, 0, 0, value)
2136
# Reschedule disabling
2138
now = datetime.datetime.utcnow()
2139
self.expires += self.timeout - old_timeout
2140
if self.expires <= now:
2141
# The timeout has passed
2144
if (getattr(self, "disable_initiator_tag", None)
2147
GLib.source_remove(self.disable_initiator_tag)
2148
self.disable_initiator_tag = GLib.timeout_add(
2149
int((self.expires - now).total_seconds() * 1000),
2152
# ExtendedTimeout - property
2153
@dbus_service_property(_interface,
2156
def ExtendedTimeout_dbus_property(self, value=None):
2157
if value is None: # get
2158
return dbus.UInt64(self.extended_timeout.total_seconds()
2160
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2162
# Interval - property
2163
@dbus_service_property(_interface,
2166
def Interval_dbus_property(self, value=None):
2167
if value is None: # get
2168
return dbus.UInt64(self.interval.total_seconds() * 1000)
1010
self.PropertyChanged(dbus.String(u"timeout"),
1011
dbus.UInt64(value, variant_level=1))
1012
if getattr(self, u"disable_initiator_tag", None) is None:
1014
# Reschedule timeout
1015
gobject.source_remove(self.disable_initiator_tag)
1016
self.disable_initiator_tag = None
1017
time_to_die = (self.
1018
_timedelta_to_milliseconds((self
1023
if time_to_die <= 0:
1024
# The timeout has passed
1027
self.disable_initiator_tag = (gobject.timeout_add
1028
(time_to_die, self.disable))
1030
# interval - property
1031
@dbus_service_property(_interface, signature=u"t",
1032
access=u"readwrite")
1033
def interval_dbus_property(self, value=None):
1034
if value is None: # get
1035
return dbus.UInt64(self.interval_milliseconds())
2169
1036
self.interval = datetime.timedelta(0, 0, 0, value)
2170
if getattr(self, "checker_initiator_tag", None) is None:
1038
self.PropertyChanged(dbus.String(u"interval"),
1039
dbus.UInt64(value, variant_level=1))
1040
if getattr(self, u"checker_initiator_tag", None) is None:
2173
# Reschedule checker run
2174
GLib.source_remove(self.checker_initiator_tag)
2175
self.checker_initiator_tag = GLib.timeout_add(
2176
value, self.start_checker)
2177
self.start_checker() # Start one now, too
1042
# Reschedule checker run
1043
gobject.source_remove(self.checker_initiator_tag)
1044
self.checker_initiator_tag = (gobject.timeout_add
1045
(value, self.start_checker))
1046
self.start_checker() # Start one now, too
2179
# Checker - property
2180
@dbus_service_property(_interface,
2183
def Checker_dbus_property(self, value=None):
1048
# checker - property
1049
@dbus_service_property(_interface, signature=u"s",
1050
access=u"readwrite")
1051
def checker_dbus_property(self, value=None):
2184
1052
if value is None: # get
2185
1053
return dbus.String(self.checker_command)
2186
self.checker_command = str(value)
2188
# CheckerRunning - property
2189
@dbus_service_property(_interface,
2192
def CheckerRunning_dbus_property(self, value=None):
1054
self.checker_command = value
1056
self.PropertyChanged(dbus.String(u"checker"),
1057
dbus.String(self.checker_command,
1060
# checker_running - property
1061
@dbus_service_property(_interface, signature=u"b",
1062
access=u"readwrite")
1063
def checker_running_dbus_property(self, value=None):
2193
1064
if value is None: # get
2194
1065
return dbus.Boolean(self.checker is not None)
2196
1067
self.start_checker()
2198
1069
self.stop_checker()
2200
# ObjectPath - property
2202
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2203
"org.freedesktop.DBus.Deprecated": "true"})
2204
@dbus_service_property(_interface, signature="o", access="read")
2205
def ObjectPath_dbus_property(self):
2206
return self.dbus_object_path # is already a dbus.ObjectPath
2210
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2212
@dbus_service_property(_interface,
2216
def Secret_dbus_property(self, value):
2217
self.secret = bytes(value)
1071
# object_path - property
1072
@dbus_service_property(_interface, signature=u"o", access=u"read")
1073
def object_path_dbus_property(self):
1074
return self.dbus_object_path # is already a dbus.ObjectPath
1077
@dbus_service_property(_interface, signature=u"ay",
1078
access=u"write", byte_arrays=True)
1079
def secret_dbus_property(self, value):
1080
self.secret = str(value)
2222
1085
class ProxyClient(object):
2223
def __init__(self, child_pipe, key_id, fpr, address):
1086
def __init__(self, child_pipe, fpr, address):
2224
1087
self._pipe = child_pipe
2225
self._pipe.send(('init', key_id, fpr, address))
1088
self._pipe.send(('init', fpr, address))
2226
1089
if not self._pipe.recv():
2227
raise KeyError(key_id or fpr)
2229
1092
def __getattribute__(self, name):
1093
if(name == '_pipe'):
2231
1094
return super(ProxyClient, self).__getattribute__(name)
2232
1095
self._pipe.send(('getattr', name))
2233
1096
data = self._pipe.recv()
2234
1097
if data[0] == 'data':
2236
1099
if data[0] == 'function':
2238
1100
def func(*args, **kwargs):
2239
1101
self._pipe.send(('funcall', name, args, kwargs))
2240
1102
return self._pipe.recv()[1]
2244
1105
def __setattr__(self, name, value):
1106
if(name == '_pipe'):
2246
1107
return super(ProxyClient, self).__setattr__(name, value)
2247
1108
self._pipe.send(('setattr', name, value))
2250
1111
class ClientHandler(socketserver.BaseRequestHandler, object):
2251
1112
"""A class to handle client connections.
2253
1114
Instantiated once for each connection to handle it.
2254
1115
Note: This will run in its own forked process."""
2256
1117
def handle(self):
2257
1118
with contextlib.closing(self.server.child_pipe) as child_pipe:
2258
logger.info("TCP connection from: %s",
2259
str(self.client_address))
2260
logger.debug("Pipe FD: %d",
1119
logger.info(u"TCP connection from: %s",
1120
unicode(self.client_address))
1121
logger.debug(u"Pipe FD: %d",
2261
1122
self.server.child_pipe.fileno())
2263
session = gnutls.ClientSession(self.request)
2265
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2266
# "+AES-256-CBC", "+SHA1",
2267
# "+COMP-NULL", "+CTYPE-OPENPGP",
1124
session = (gnutls.connection
1125
.ClientSession(self.request,
1127
.X509Credentials()))
1129
# Note: gnutls.connection.X509Credentials is really a
1130
# generic GnuTLS certificate credentials object so long as
1131
# no X.509 keys are added to it. Therefore, we can use it
1132
# here despite using OpenPGP certificates.
1134
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1135
# u"+AES-256-CBC", u"+SHA1",
1136
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2269
1138
# Use a fallback default, since this MUST be set.
2270
1139
priority = self.server.gnutls_priority
2271
1140
if priority is None:
2273
gnutls.priority_set_direct(session._c_object,
2274
priority.encode("utf-8"),
1141
priority = u"NORMAL"
1142
(gnutls.library.functions
1143
.gnutls_priority_set_direct(session._c_object,
2277
1146
# Start communication using the Mandos protocol
2278
1147
# Get protocol number
2279
1148
line = self.request.makefile().readline()
2280
logger.debug("Protocol version: %r", line)
1149
logger.debug(u"Protocol version: %r", line)
2282
1151
if int(line.strip().split()[0]) > 1:
2283
raise RuntimeError(line)
2284
except (ValueError, IndexError, RuntimeError) as error:
2285
logger.error("Unknown protocol version: %s", error)
1153
except (ValueError, IndexError, RuntimeError), error:
1154
logger.error(u"Unknown protocol version: %s", error)
2288
1157
# Start GnuTLS connection
2290
1159
session.handshake()
2291
except gnutls.Error as error:
2292
logger.warning("Handshake failed: %s", error)
1160
except gnutls.errors.GNUTLSError, error:
1161
logger.warning(u"Handshake failed: %s", error)
2293
1162
# Do not run session.bye() here: the session is not
2294
1163
# established. Just abandon the request.
2296
logger.debug("Handshake succeeded")
1165
logger.debug(u"Handshake succeeded")
2298
1167
approval_required = False
2300
if gnutls.has_rawpk:
2303
key_id = self.key_id(
2304
self.peer_certificate(session))
2305
except (TypeError, gnutls.Error) as error:
2306
logger.warning("Bad certificate: %s", error)
2308
logger.debug("Key ID: %s", key_id)
2313
fpr = self.fingerprint(
2314
self.peer_certificate(session))
2315
except (TypeError, gnutls.Error) as error:
2316
logger.warning("Bad certificate: %s", error)
2318
logger.debug("Fingerprint: %s", fpr)
2321
client = ProxyClient(child_pipe, key_id, fpr,
1170
fpr = self.fingerprint(self.peer_certificate
1172
except (TypeError, gnutls.errors.GNUTLSError), error:
1173
logger.warning(u"Bad certificate: %s", error)
1175
logger.debug(u"Fingerprint: %s", fpr)
1178
client = ProxyClient(child_pipe, fpr,
2322
1179
self.client_address)
2323
1180
except KeyError:
2326
if client.approval_delay:
2327
delay = client.approval_delay
1183
if client.approved_delay:
1184
delay = client.approved_delay
2328
1185
client.approvals_pending += 1
2329
1186
approval_required = True
2332
1189
if not client.enabled:
2333
logger.info("Client %s is disabled",
1190
logger.warning(u"Client %s is disabled",
2335
1192
if self.server.use_dbus:
2336
1193
# Emit D-Bus signal
2337
client.Rejected("Disabled")
1194
client.Rejected("Disabled")
2340
if client.approved or not client.approval_delay:
2341
# We are approved or approval is disabled
1197
if client._approved or not client.approved_delay:
1198
#We are approved or approval is disabled
2343
elif client.approved is None:
2344
logger.info("Client %s needs approval",
1200
elif client._approved is None:
1201
logger.info(u"Client %s need approval",
2346
1203
if self.server.use_dbus:
2347
1204
# Emit D-Bus signal
2348
1205
client.NeedApproval(
2349
client.approval_delay.total_seconds()
2350
* 1000, client.approved_by_default)
1206
client.approved_delay_milliseconds(),
1207
client.approved_by_default)
2352
logger.warning("Client %s was not approved",
1209
logger.warning(u"Client %s was not approved",
2354
1211
if self.server.use_dbus:
2355
1212
# Emit D-Bus signal
2356
client.Rejected("Denied")
1213
client.Rejected("Disapproved")
2359
# wait until timeout or approved
1216
#wait until timeout or approved
1217
#x = float(client._timedelta_to_milliseconds(delay))
2360
1218
time = datetime.datetime.now()
2361
1219
client.changedstate.acquire()
2362
client.changedstate.wait(delay.total_seconds())
1220
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2363
1221
client.changedstate.release()
2364
1222
time2 = datetime.datetime.now()
2365
1223
if (time2 - time) >= delay:
2377
1235
delay -= time2 - time
2380
session.send(client.secret)
2381
except gnutls.Error as error:
2382
logger.warning("gnutls send failed",
2386
logger.info("Sending secret to %s", client.name)
2387
# bump the timeout using extended_timeout
2388
client.bump_timeout(client.extended_timeout)
1238
while sent_size < len(client.secret):
1240
sent = session.send(client.secret[sent_size:])
1241
except (gnutls.errors.GNUTLSError), error:
1242
logger.warning("gnutls send failed")
1244
logger.debug(u"Sent: %d, remaining: %d",
1245
sent, len(client.secret)
1246
- (sent_size + sent))
1249
logger.info(u"Sending secret to %s", client.name)
1250
# bump the timeout as if seen
2389
1252
if self.server.use_dbus:
2390
1253
# Emit D-Bus signal
2391
1254
client.GotSecret()
2394
1257
if approval_required:
2395
1258
client.approvals_pending -= 1
2398
except gnutls.Error as error:
2399
logger.warning("GnuTLS bye failed",
1261
except (gnutls.errors.GNUTLSError), error:
1262
logger.warning("gnutls bye failed")
2403
1265
def peer_certificate(session):
2404
"Return the peer's certificate as a bytestring"
2406
cert_type = gnutls.certificate_type_get2(session._c_object,
2408
except AttributeError:
2409
cert_type = gnutls.certificate_type_get(session._c_object)
2410
if gnutls.has_rawpk:
2411
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2413
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2414
# If not a valid certificate type...
2415
if cert_type not in valid_cert_types:
2416
logger.info("Cert type %r not in %r", cert_type,
2418
# ...return invalid data
1266
"Return the peer's OpenPGP certificate as a bytestring"
1267
# If not an OpenPGP certificate...
1268
if (gnutls.library.functions
1269
.gnutls_certificate_type_get(session._c_object)
1270
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1271
# ...do the normal thing
1272
return session.peer_certificate
2420
1273
list_size = ctypes.c_uint(1)
2421
cert_list = (gnutls.certificate_get_peers
1274
cert_list = (gnutls.library.functions
1275
.gnutls_certificate_get_peers
2422
1276
(session._c_object, ctypes.byref(list_size)))
2423
1277
if not bool(cert_list) and list_size.value != 0:
2424
raise gnutls.Error("error getting peer certificate")
1278
raise gnutls.errors.GNUTLSError(u"error getting peer"
2425
1280
if list_size.value == 0:
2427
1282
cert = cert_list[0]
2428
1283
return ctypes.string_at(cert.data, cert.size)
2431
def key_id(certificate):
2432
"Convert a certificate bytestring to a hexdigit key ID"
2433
# New GnuTLS "datum" with the public key
2434
datum = gnutls.datum_t(
2435
ctypes.cast(ctypes.c_char_p(certificate),
2436
ctypes.POINTER(ctypes.c_ubyte)),
2437
ctypes.c_uint(len(certificate)))
2438
# XXX all these need to be created in the gnutls "module"
2439
# New empty GnuTLS certificate
2440
pubkey = gnutls.pubkey_t()
2441
gnutls.pubkey_init(ctypes.byref(pubkey))
2442
# Import the raw public key into the certificate
2443
gnutls.pubkey_import(pubkey,
2444
ctypes.byref(datum),
2445
gnutls.X509_FMT_DER)
2446
# New buffer for the key ID
2447
buf = ctypes.create_string_buffer(32)
2448
buf_len = ctypes.c_size_t(len(buf))
2449
# Get the key ID from the raw public key into the buffer
2450
gnutls.pubkey_get_key_id(pubkey,
2451
gnutls.KEYID_USE_SHA256,
2452
ctypes.cast(ctypes.byref(buf),
2453
ctypes.POINTER(ctypes.c_ubyte)),
2454
ctypes.byref(buf_len))
2455
# Deinit the certificate
2456
gnutls.pubkey_deinit(pubkey)
2458
# Convert the buffer to a Python bytestring
2459
key_id = ctypes.string_at(buf, buf_len.value)
2460
# Convert the bytestring to hexadecimal notation
2461
hex_key_id = binascii.hexlify(key_id).upper()
2465
1286
def fingerprint(openpgp):
2466
1287
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2467
1288
# New GnuTLS "datum" with the OpenPGP public key
2468
datum = gnutls.datum_t(
2469
ctypes.cast(ctypes.c_char_p(openpgp),
2470
ctypes.POINTER(ctypes.c_ubyte)),
2471
ctypes.c_uint(len(openpgp)))
1289
datum = (gnutls.library.types
1290
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1293
ctypes.c_uint(len(openpgp))))
2472
1294
# New empty GnuTLS certificate
2473
crt = gnutls.openpgp_crt_t()
2474
gnutls.openpgp_crt_init(ctypes.byref(crt))
1295
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1296
(gnutls.library.functions
1297
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2475
1298
# Import the OpenPGP public key into the certificate
2476
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2477
gnutls.OPENPGP_FMT_RAW)
1299
(gnutls.library.functions
1300
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1301
gnutls.library.constants
1302
.GNUTLS_OPENPGP_FMT_RAW))
2478
1303
# Verify the self signature in the key
2479
1304
crtverify = ctypes.c_uint()
2480
gnutls.openpgp_crt_verify_self(crt, 0,
2481
ctypes.byref(crtverify))
1305
(gnutls.library.functions
1306
.gnutls_openpgp_crt_verify_self(crt, 0,
1307
ctypes.byref(crtverify)))
2482
1308
if crtverify.value != 0:
2483
gnutls.openpgp_crt_deinit(crt)
2484
raise gnutls.CertificateSecurityError(code
1309
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1310
raise (gnutls.errors.CertificateSecurityError
2486
1312
# New buffer for the fingerprint
2487
1313
buf = ctypes.create_string_buffer(20)
2488
1314
buf_len = ctypes.c_size_t()
2489
1315
# Get the fingerprint from the certificate into the buffer
2490
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2491
ctypes.byref(buf_len))
1316
(gnutls.library.functions
1317
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1318
ctypes.byref(buf_len)))
2492
1319
# Deinit the certificate
2493
gnutls.openpgp_crt_deinit(crt)
1320
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2494
1321
# Convert the buffer to a Python bytestring
2495
1322
fpr = ctypes.string_at(buf, buf_len.value)
2496
1323
# Convert the bytestring to hexadecimal notation
2497
hex_fpr = binascii.hexlify(fpr).upper()
1324
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2501
1328
class MultiprocessingMixIn(object):
2502
1329
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2504
1330
def sub_process_main(self, request, address):
2506
1332
self.finish_request(request, address)
2508
1334
self.handle_error(request, address)
2509
1335
self.close_request(request)
2511
1337
def process_request(self, request, address):
2512
1338
"""Start a new process to process the request."""
2513
proc = multiprocessing.Process(target=self.sub_process_main,
2514
args=(request, address))
1339
multiprocessing.Process(target = self.sub_process_main,
1340
args = (request, address)).start()
2519
1342
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2520
1343
""" adds a pipe to the MixIn """
2522
1344
def process_request(self, request, client_address):
2523
1345
"""Overrides and wraps the original process_request().
2525
1347
This function creates a new pipe in self.pipe
2527
1349
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2529
proc = MultiprocessingMixIn.process_request(self, request,
1351
super(MultiprocessingMixInWithPipe,
1352
self).process_request(request, client_address)
2531
1353
self.child_pipe.close()
2532
self.add_pipe(parent_pipe, proc)
1354
self.add_pipe(parent_pipe)
2534
def add_pipe(self, parent_pipe, proc):
1356
def add_pipe(self, parent_pipe):
2535
1357
"""Dummy function; override as necessary"""
2536
raise NotImplementedError()
2539
1360
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2540
1361
socketserver.TCPServer, object):
2541
1362
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2544
1365
enabled: Boolean; whether this server is activated yet
2545
1366
interface: None or a network interface name (string)
2546
1367
use_ipv6: Boolean; to use IPv6 or not
2549
1369
def __init__(self, server_address, RequestHandlerClass,
2553
"""If socketfd is set, use that file descriptor instead of
2554
creating a new one with socket.socket().
1370
interface=None, use_ipv6=True):
2556
1371
self.interface = interface
2558
1373
self.address_family = socket.AF_INET6
2559
if socketfd is not None:
2560
# Save the file descriptor
2561
self.socketfd = socketfd
2562
# Save the original socket.socket() function
2563
self.socket_socket = socket.socket
2565
# To implement --socket, we monkey patch socket.socket.
2567
# (When socketserver.TCPServer is a new-style class, we
2568
# could make self.socket into a property instead of monkey
2569
# patching socket.socket.)
2571
# Create a one-time-only replacement for socket.socket()
2572
@functools.wraps(socket.socket)
2573
def socket_wrapper(*args, **kwargs):
2574
# Restore original function so subsequent calls are
2576
socket.socket = self.socket_socket
2577
del self.socket_socket
2578
# This time only, return a new socket object from the
2579
# saved file descriptor.
2580
return socket.fromfd(self.socketfd, *args, **kwargs)
2581
# Replace socket.socket() function with wrapper
2582
socket.socket = socket_wrapper
2583
# The socketserver.TCPServer.__init__ will call
2584
# socket.socket(), which might be our replacement,
2585
# socket_wrapper(), if socketfd was set.
2586
1374
socketserver.TCPServer.__init__(self, server_address,
2587
1375
RequestHandlerClass)
2589
1376
def server_bind(self):
2590
1377
"""This overrides the normal server_bind() function
2591
1378
to bind to an interface if one was specified, and also NOT to
2592
1379
bind to an address or port if they were not specified."""
2593
global SO_BINDTODEVICE
2594
1380
if self.interface is not None:
2595
1381
if SO_BINDTODEVICE is None:
2596
# Fall back to a hard-coded value which seems to be
2598
logger.warning("SO_BINDTODEVICE not found, trying 25")
2599
SO_BINDTODEVICE = 25
2601
self.socket.setsockopt(
2602
socket.SOL_SOCKET, SO_BINDTODEVICE,
2603
(self.interface + "\0").encode("utf-8"))
2604
except socket.error as error:
2605
if error.errno == errno.EPERM:
2606
logger.error("No permission to bind to"
2607
" interface %s", self.interface)
2608
elif error.errno == errno.ENOPROTOOPT:
2609
logger.error("SO_BINDTODEVICE not available;"
2610
" cannot bind to interface %s",
2612
elif error.errno == errno.ENODEV:
2613
logger.error("Interface %s does not exist,"
2614
" cannot bind", self.interface)
1382
logger.error(u"SO_BINDTODEVICE does not exist;"
1383
u" cannot bind to interface %s",
1387
self.socket.setsockopt(socket.SOL_SOCKET,
1391
except socket.error, error:
1392
if error[0] == errno.EPERM:
1393
logger.error(u"No permission to"
1394
u" bind to interface %s",
1396
elif error[0] == errno.ENOPROTOOPT:
1397
logger.error(u"SO_BINDTODEVICE not available;"
1398
u" cannot bind to interface %s",
2617
1402
# Only bind(2) the socket if we really need to.
2618
1403
if self.server_address[0] or self.server_address[1]:
2619
1404
if not self.server_address[0]:
2620
1405
if self.address_family == socket.AF_INET6:
2621
any_address = "::" # in6addr_any
1406
any_address = u"::" # in6addr_any
2623
any_address = "0.0.0.0" # INADDR_ANY
1408
any_address = socket.INADDR_ANY
2624
1409
self.server_address = (any_address,
2625
1410
self.server_address[1])
2626
1411
elif not self.server_address[1]:
2627
self.server_address = (self.server_address[0], 0)
1412
self.server_address = (self.server_address[0],
2628
1414
# if self.interface:
2629
1415
# self.server_address = (self.server_address[0],
2758
def rfc3339_duration_to_delta(duration):
2759
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2761
>>> rfc3339_duration_to_delta("P7D")
2762
datetime.timedelta(7)
2763
>>> rfc3339_duration_to_delta("PT60S")
2764
datetime.timedelta(0, 60)
2765
>>> rfc3339_duration_to_delta("PT60M")
2766
datetime.timedelta(0, 3600)
2767
>>> rfc3339_duration_to_delta("PT24H")
2768
datetime.timedelta(1)
2769
>>> rfc3339_duration_to_delta("P1W")
2770
datetime.timedelta(7)
2771
>>> rfc3339_duration_to_delta("PT5M30S")
2772
datetime.timedelta(0, 330)
2773
>>> rfc3339_duration_to_delta("P1DT3M20S")
2774
datetime.timedelta(1, 200)
2777
# Parsing an RFC 3339 duration with regular expressions is not
2778
# possible - there would have to be multiple places for the same
2779
# values, like seconds. The current code, while more esoteric, is
2780
# cleaner without depending on a parsing library. If Python had a
2781
# built-in library for parsing we would use it, but we'd like to
2782
# avoid excessive use of external libraries.
2784
# New type for defining tokens, syntax, and semantics all-in-one
2785
Token = collections.namedtuple("Token", (
2786
"regexp", # To match token; if "value" is not None, must have
2787
# a "group" containing digits
2788
"value", # datetime.timedelta or None
2789
"followers")) # Tokens valid after this token
2790
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2791
# the "duration" ABNF definition in RFC 3339, Appendix A.
2792
token_end = Token(re.compile(r"$"), None, frozenset())
2793
token_second = Token(re.compile(r"(\d+)S"),
2794
datetime.timedelta(seconds=1),
2795
frozenset((token_end, )))
2796
token_minute = Token(re.compile(r"(\d+)M"),
2797
datetime.timedelta(minutes=1),
2798
frozenset((token_second, token_end)))
2799
token_hour = Token(re.compile(r"(\d+)H"),
2800
datetime.timedelta(hours=1),
2801
frozenset((token_minute, token_end)))
2802
token_time = Token(re.compile(r"T"),
2804
frozenset((token_hour, token_minute,
2806
token_day = Token(re.compile(r"(\d+)D"),
2807
datetime.timedelta(days=1),
2808
frozenset((token_time, token_end)))
2809
token_month = Token(re.compile(r"(\d+)M"),
2810
datetime.timedelta(weeks=4),
2811
frozenset((token_day, token_end)))
2812
token_year = Token(re.compile(r"(\d+)Y"),
2813
datetime.timedelta(weeks=52),
2814
frozenset((token_month, token_end)))
2815
token_week = Token(re.compile(r"(\d+)W"),
2816
datetime.timedelta(weeks=1),
2817
frozenset((token_end, )))
2818
token_duration = Token(re.compile(r"P"), None,
2819
frozenset((token_year, token_month,
2820
token_day, token_time,
2822
# Define starting values:
2824
value = datetime.timedelta()
2826
# Following valid tokens
2827
followers = frozenset((token_duration, ))
2828
# String left to parse
2830
# Loop until end token is found
2831
while found_token is not token_end:
2832
# Search for any currently valid tokens
2833
for token in followers:
2834
match = token.regexp.match(s)
2835
if match is not None:
2837
if token.value is not None:
2838
# Value found, parse digits
2839
factor = int(match.group(1), 10)
2840
# Add to value so far
2841
value += factor * token.value
2842
# Strip token from string
2843
s = token.regexp.sub("", s, 1)
2846
# Set valid next tokens
2847
followers = found_token.followers
2850
# No currently valid tokens were found
2851
raise ValueError("Invalid RFC 3339 duration: {!r}"
2857
1529
def string_to_delta(interval):
2858
1530
"""Parse a string and return a datetime.timedelta
2860
>>> string_to_delta('7d')
1532
>>> string_to_delta(u'7d')
2861
1533
datetime.timedelta(7)
2862
>>> string_to_delta('60s')
1534
>>> string_to_delta(u'60s')
2863
1535
datetime.timedelta(0, 60)
2864
>>> string_to_delta('60m')
1536
>>> string_to_delta(u'60m')
2865
1537
datetime.timedelta(0, 3600)
2866
>>> string_to_delta('24h')
1538
>>> string_to_delta(u'24h')
2867
1539
datetime.timedelta(1)
2868
>>> string_to_delta('1w')
1540
>>> string_to_delta(u'1w')
2869
1541
datetime.timedelta(7)
2870
>>> string_to_delta('5m 30s')
1542
>>> string_to_delta(u'5m 30s')
2871
1543
datetime.timedelta(0, 330)
2875
return rfc3339_duration_to_delta(interval)
2879
1545
timevalue = datetime.timedelta(0)
2880
1546
for s in interval.split():
1548
suffix = unicode(s[-1])
2883
1549
value = int(s[:-1])
2885
1551
delta = datetime.timedelta(value)
1552
elif suffix == u"s":
2887
1553
delta = datetime.timedelta(0, value)
1554
elif suffix == u"m":
2889
1555
delta = datetime.timedelta(0, 0, 0, 0, value)
1556
elif suffix == u"h":
2891
1557
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1558
elif suffix == u"w":
2893
1559
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2895
raise ValueError("Unknown suffix {!r}".format(suffix))
2896
except IndexError as e:
2897
raise ValueError(*(e.args))
1561
raise ValueError(u"Unknown suffix %r" % suffix)
1562
except (ValueError, IndexError), e:
1563
raise ValueError(e.message)
2898
1564
timevalue += delta
2899
1565
return timevalue
2902
def daemon(nochdir=False, noclose=False):
1568
def if_nametoindex(interface):
1569
"""Call the C function if_nametoindex(), or equivalent
1571
Note: This function cannot accept a unicode string."""
1572
global if_nametoindex
1574
if_nametoindex = (ctypes.cdll.LoadLibrary
1575
(ctypes.util.find_library(u"c"))
1577
except (OSError, AttributeError):
1578
logger.warning(u"Doing if_nametoindex the hard way")
1579
def if_nametoindex(interface):
1580
"Get an interface index the hard way, i.e. using fcntl()"
1581
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1582
with contextlib.closing(socket.socket()) as s:
1583
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1584
struct.pack(str(u"16s16x"),
1586
interface_index = struct.unpack(str(u"I"),
1588
return interface_index
1589
return if_nametoindex(interface)
1592
def daemon(nochdir = False, noclose = False):
2903
1593
"""See daemon(3). Standard BSD Unix function.
2905
1595
This should really exist as os.daemon, but it doesn't (yet)."""
2909
1599
if not nochdir:
2913
1603
if not noclose:
2914
1604
# Close all standard open file descriptors
2915
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1605
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2916
1606
if not stat.S_ISCHR(os.fstat(null).st_mode):
2917
1607
raise OSError(errno.ENODEV,
2918
"{} not a character device"
2919
.format(os.devnull))
1608
u"%s not a character device"
2920
1610
os.dup2(null, sys.stdin.fileno())
2921
1611
os.dup2(null, sys.stdout.fileno())
2922
1612
os.dup2(null, sys.stderr.fileno())
2929
1619
##################################################################
2930
1620
# Parsing of options, both command line and config file
2932
parser = argparse.ArgumentParser()
2933
parser.add_argument("-v", "--version", action="version",
2934
version="%(prog)s {}".format(version),
2935
help="show version number and exit")
2936
parser.add_argument("-i", "--interface", metavar="IF",
2937
help="Bind to interface IF")
2938
parser.add_argument("-a", "--address",
2939
help="Address to listen for requests on")
2940
parser.add_argument("-p", "--port", type=int,
2941
help="Port number to receive requests on")
2942
parser.add_argument("--check", action="store_true",
2943
help="Run self-test")
2944
parser.add_argument("--debug", action="store_true",
2945
help="Debug mode; run in foreground and log"
2946
" to terminal", default=None)
2947
parser.add_argument("--debuglevel", metavar="LEVEL",
2948
help="Debug level for stdout output")
2949
parser.add_argument("--priority", help="GnuTLS"
2950
" priority string (see GnuTLS documentation)")
2951
parser.add_argument("--servicename",
2952
metavar="NAME", help="Zeroconf service name")
2953
parser.add_argument("--configdir",
2954
default="/etc/mandos", metavar="DIR",
2955
help="Directory to search for configuration"
2957
parser.add_argument("--no-dbus", action="store_false",
2958
dest="use_dbus", help="Do not provide D-Bus"
2959
" system bus interface", default=None)
2960
parser.add_argument("--no-ipv6", action="store_false",
2961
dest="use_ipv6", help="Do not use IPv6",
2963
parser.add_argument("--no-restore", action="store_false",
2964
dest="restore", help="Do not restore stored"
2965
" state", default=None)
2966
parser.add_argument("--socket", type=int,
2967
help="Specify a file descriptor to a network"
2968
" socket to use instead of creating one")
2969
parser.add_argument("--statedir", metavar="DIR",
2970
help="Directory to save/restore state in")
2971
parser.add_argument("--foreground", action="store_true",
2972
help="Run in foreground", default=None)
2973
parser.add_argument("--no-zeroconf", action="store_false",
2974
dest="zeroconf", help="Do not use Zeroconf",
2977
options = parser.parse_args()
1622
parser = optparse.OptionParser(version = "%%prog %s" % version)
1623
parser.add_option("-i", u"--interface", type=u"string",
1624
metavar="IF", help=u"Bind to interface IF")
1625
parser.add_option("-a", u"--address", type=u"string",
1626
help=u"Address to listen for requests on")
1627
parser.add_option("-p", u"--port", type=u"int",
1628
help=u"Port number to receive requests on")
1629
parser.add_option("--check", action=u"store_true",
1630
help=u"Run self-test")
1631
parser.add_option("--debug", action=u"store_true",
1632
help=u"Debug mode; run in foreground and log to"
1634
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1635
help=u"Debug level for stdout output")
1636
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1637
u" priority string (see GnuTLS documentation)")
1638
parser.add_option("--servicename", type=u"string",
1639
metavar=u"NAME", help=u"Zeroconf service name")
1640
parser.add_option("--configdir", type=u"string",
1641
default=u"/etc/mandos", metavar=u"DIR",
1642
help=u"Directory to search for configuration"
1644
parser.add_option("--no-dbus", action=u"store_false",
1645
dest=u"use_dbus", help=u"Do not provide D-Bus"
1646
u" system bus interface")
1647
parser.add_option("--no-ipv6", action=u"store_false",
1648
dest=u"use_ipv6", help=u"Do not use IPv6")
1649
options = parser.parse_args()[0]
2979
1651
if options.check:
2981
fail_count, test_count = doctest.testmod()
2982
sys.exit(os.EX_OK if fail_count == 0 else 1)
2984
1656
# Default values for config file for server-global settings
2985
if gnutls.has_rawpk:
2986
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2987
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2989
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2990
":+SIGN-DSA-SHA256")
2991
server_defaults = {"interface": "",
2995
"priority": priority,
2996
"servicename": "Mandos",
3002
"statedir": "/var/lib/mandos",
3003
"foreground": "False",
1657
server_defaults = { u"interface": u"",
1662
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1663
u"servicename": u"Mandos",
1664
u"use_dbus": u"True",
1665
u"use_ipv6": u"True",
3008
1669
# Parse config file for server-global settings
3009
1670
server_config = configparser.SafeConfigParser(server_defaults)
3010
1671
del server_defaults
3011
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1672
server_config.read(os.path.join(options.configdir,
3012
1674
# Convert the SafeConfigParser object to a dict
3013
1675
server_settings = server_config.defaults()
3014
1676
# Use the appropriate methods on the non-string config options
3015
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3016
"foreground", "zeroconf"):
3017
server_settings[option] = server_config.getboolean("DEFAULT",
1677
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1678
server_settings[option] = server_config.getboolean(u"DEFAULT",
3019
1680
if server_settings["port"]:
3020
server_settings["port"] = server_config.getint("DEFAULT",
3022
if server_settings["socket"]:
3023
server_settings["socket"] = server_config.getint("DEFAULT",
3025
# Later, stdin will, and stdout and stderr might, be dup'ed
3026
# over with an opened os.devnull. But we don't want this to
3027
# happen with a supplied network socket.
3028
if 0 <= server_settings["socket"] <= 2:
3029
server_settings["socket"] = os.dup(server_settings
1681
server_settings["port"] = server_config.getint(u"DEFAULT",
3031
1683
del server_config
3033
1685
# Override the settings from the config file with command line
3034
1686
# options, if set.
3035
for option in ("interface", "address", "port", "debug",
3036
"priority", "servicename", "configdir", "use_dbus",
3037
"use_ipv6", "debuglevel", "restore", "statedir",
3038
"socket", "foreground", "zeroconf"):
1687
for option in (u"interface", u"address", u"port", u"debug",
1688
u"priority", u"servicename", u"configdir",
1689
u"use_dbus", u"use_ipv6", u"debuglevel"):
3039
1690
value = getattr(options, option)
3040
1691
if value is not None:
3041
1692
server_settings[option] = value
3043
1694
# Force all strings to be unicode
3044
1695
for option in server_settings.keys():
3045
if isinstance(server_settings[option], bytes):
3046
server_settings[option] = (server_settings[option]
3048
# Force all boolean options to be boolean
3049
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3050
"foreground", "zeroconf"):
3051
server_settings[option] = bool(server_settings[option])
3052
# Debug implies foreground
3053
if server_settings["debug"]:
3054
server_settings["foreground"] = True
1696
if type(server_settings[option]) is str:
1697
server_settings[option] = unicode(server_settings[option])
3055
1698
# Now we have our good server settings in "server_settings"
3057
1700
##################################################################
3059
if (not server_settings["zeroconf"]
3060
and not (server_settings["port"]
3061
or server_settings["socket"] != "")):
3062
parser.error("Needs port or socket to work without Zeroconf")
3064
1702
# For convenience
3065
debug = server_settings["debug"]
3066
debuglevel = server_settings["debuglevel"]
3067
use_dbus = server_settings["use_dbus"]
3068
use_ipv6 = server_settings["use_ipv6"]
3069
stored_state_path = os.path.join(server_settings["statedir"],
3071
foreground = server_settings["foreground"]
3072
zeroconf = server_settings["zeroconf"]
3075
initlogger(debug, logging.DEBUG)
3080
level = getattr(logging, debuglevel.upper())
3081
initlogger(debug, level)
3083
if server_settings["servicename"] != "Mandos":
3084
syslogger.setFormatter(
3085
logging.Formatter('Mandos ({}) [%(process)d]:'
3086
' %(levelname)s: %(message)s'.format(
3087
server_settings["servicename"])))
1703
debug = server_settings[u"debug"]
1704
debuglevel = server_settings[u"debuglevel"]
1705
use_dbus = server_settings[u"use_dbus"]
1706
use_ipv6 = server_settings[u"use_ipv6"]
1708
if server_settings[u"servicename"] != u"Mandos":
1709
syslogger.setFormatter(logging.Formatter
1710
(u'Mandos (%s) [%%(process)d]:'
1711
u' %%(levelname)s: %%(message)s'
1712
% server_settings[u"servicename"]))
3089
1714
# Parse config file with clients
3090
client_config = configparser.SafeConfigParser(Client
3092
client_config.read(os.path.join(server_settings["configdir"],
1715
client_defaults = { u"timeout": u"1h",
1717
u"checker": u"fping -q -- %%(host)s",
1719
u"approved_delay": u"0s",
1720
u"approved_duration": u"1s",
1722
client_config = configparser.SafeConfigParser(client_defaults)
1723
client_config.read(os.path.join(server_settings[u"configdir"],
3095
1726
global mandos_dbus_service
3096
1727
mandos_dbus_service = None
3099
if server_settings["socket"] != "":
3100
socketfd = server_settings["socket"]
3101
tcp_server = MandosServer(
3102
(server_settings["address"], server_settings["port"]),
3104
interface=(server_settings["interface"] or None),
3106
gnutls_priority=server_settings["priority"],
3110
pidfilename = "/run/mandos.pid"
3111
if not os.path.isdir("/run/."):
3112
pidfilename = "/var/run/mandos.pid"
3115
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3116
except IOError as e:
3117
logger.error("Could not open file %r", pidfilename,
3120
for name, group in (("_mandos", "_mandos"),
3121
("mandos", "mandos"),
3122
("nobody", "nogroup")):
3124
uid = pwd.getpwnam(name).pw_uid
3125
gid = pwd.getpwnam(group).pw_gid
1729
tcp_server = MandosServer((server_settings[u"address"],
1730
server_settings[u"port"]),
1732
interface=(server_settings[u"interface"]
1736
server_settings[u"priority"],
1738
pidfilename = u"/var/run/mandos.pid"
1740
pidfile = open(pidfilename, u"w")
1742
logger.error(u"Could not open file %r", pidfilename)
1745
uid = pwd.getpwnam(u"_mandos").pw_uid
1746
gid = pwd.getpwnam(u"_mandos").pw_gid
1749
uid = pwd.getpwnam(u"mandos").pw_uid
1750
gid = pwd.getpwnam(u"mandos").pw_gid
3127
1751
except KeyError:
1753
uid = pwd.getpwnam(u"nobody").pw_uid
1754
gid = pwd.getpwnam(u"nobody").pw_gid
3136
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3138
except OSError as error:
3139
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3140
.format(uid, gid, os.strerror(error.errno)))
3141
if error.errno != errno.EPERM:
1761
except OSError, error:
1762
if error[0] != errno.EPERM:
1765
# Enable all possible GnuTLS debugging
1768
if not debug and not debuglevel:
1769
syslogger.setLevel(logging.WARNING)
1770
console.setLevel(logging.WARNING)
1772
level = getattr(logging, debuglevel.upper())
1773
syslogger.setLevel(level)
1774
console.setLevel(level)
3145
# Enable all possible GnuTLS debugging
3147
1777
# "Use a log level over 10 to enable all debugging options."
3148
1778
# - GnuTLS manual
3149
gnutls.global_set_log_level(11)
1779
gnutls.library.functions.gnutls_global_set_log_level(11)
1781
@gnutls.library.types.gnutls_log_func
3152
1782
def debug_gnutls(level, string):
3153
logger.debug("GnuTLS: %s", string[:-1])
3155
gnutls.global_set_log_function(debug_gnutls)
1783
logger.debug(u"GnuTLS: %s", string[:-1])
1785
(gnutls.library.functions
1786
.gnutls_global_set_log_function(debug_gnutls))
3157
1788
# Redirect stdin so all checkers get /dev/null
3158
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1789
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3159
1790
os.dup2(null, sys.stdin.fileno())
3163
# Need to fork before connecting to D-Bus
3165
# Close all input and output, do double fork, etc.
3168
# multiprocessing will use threads, so before we use GLib we need
3169
# to inform GLib that threads will be used.
1794
# No console logging
1795
logger.removeHandler(console)
3172
1798
global main_loop
3173
1799
# From the Avahi example code
3174
DBusGMainLoop(set_as_default=True)
3175
main_loop = GLib.MainLoop()
1800
DBusGMainLoop(set_as_default=True )
1801
main_loop = gobject.MainLoop()
3176
1802
bus = dbus.SystemBus()
3177
1803
# End of Avahi example code
3180
bus_name = dbus.service.BusName("se.recompile.Mandos",
3183
old_bus_name = dbus.service.BusName(
3184
"se.bsnet.fukt.Mandos", bus,
3186
except dbus.exceptions.DBusException as e:
3187
logger.error("Disabling D-Bus:", exc_info=e)
1806
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1807
bus, do_not_queue=True)
1808
except dbus.exceptions.NameExistsException, e:
1809
logger.error(unicode(e) + u", disabling D-Bus")
3188
1810
use_dbus = False
3189
server_settings["use_dbus"] = False
1811
server_settings[u"use_dbus"] = False
3190
1812
tcp_server.use_dbus = False
3192
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3193
service = AvahiServiceToSyslog(
3194
name=server_settings["servicename"],
3195
servicetype="_mandos._tcp",
3198
if server_settings["interface"]:
3199
service.interface = if_nametoindex(
3200
server_settings["interface"].encode("utf-8"))
1813
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1814
service = AvahiService(name = server_settings[u"servicename"],
1815
servicetype = u"_mandos._tcp",
1816
protocol = protocol, bus = bus)
1817
if server_settings["interface"]:
1818
service.interface = (if_nametoindex
1819
(str(server_settings[u"interface"])))
1822
# Close all input and output, do double fork, etc.
3202
1825
global multiprocessing_manager
3203
1826
multiprocessing_manager = multiprocessing.Manager()
3205
1828
client_class = Client
3207
client_class = functools.partial(ClientDBus, bus=bus)
3209
client_settings = Client.config_parser(client_config)
3210
old_client_settings = {}
3213
# This is used to redirect stdout and stderr for checker processes
3215
wnull = open(os.devnull, "w") # A writable /dev/null
3216
# Only used if server is running in foreground but not in debug
3218
if debug or not foreground:
3221
# Get client data and settings from last running state.
3222
if server_settings["restore"]:
3224
with open(stored_state_path, "rb") as stored_state:
3225
if sys.version_info.major == 2:
3226
clients_data, old_client_settings = pickle.load(
3229
bytes_clients_data, bytes_old_client_settings = (
3230
pickle.load(stored_state, encoding="bytes"))
3231
# Fix bytes to strings
3234
clients_data = {(key.decode("utf-8")
3235
if isinstance(key, bytes)
3238
bytes_clients_data.items()}
3239
del bytes_clients_data
3240
for key in clients_data:
3241
value = {(k.decode("utf-8")
3242
if isinstance(k, bytes) else k): v
3244
clients_data[key].items()}
3245
clients_data[key] = value
3247
value["client_structure"] = [
3249
if isinstance(s, bytes)
3251
value["client_structure"]]
3253
for k in ("name", "host"):
3254
if isinstance(value[k], bytes):
3255
value[k] = value[k].decode("utf-8")
3256
if not value.has_key("key_id"):
3257
value["key_id"] = ""
3258
elif not value.has_key("fingerprint"):
3259
value["fingerprint"] = ""
3260
# old_client_settings
3262
old_client_settings = {
3263
(key.decode("utf-8")
3264
if isinstance(key, bytes)
3267
bytes_old_client_settings.items()}
3268
del bytes_old_client_settings
3270
for value in old_client_settings.values():
3271
if isinstance(value["host"], bytes):
3272
value["host"] = (value["host"]
3274
os.remove(stored_state_path)
3275
except IOError as e:
3276
if e.errno == errno.ENOENT:
3277
logger.warning("Could not load persistent state:"
3278
" {}".format(os.strerror(e.errno)))
3280
logger.critical("Could not load persistent state:",
3283
except EOFError as e:
3284
logger.warning("Could not load persistent state: "
3288
with PGPEngine() as pgp:
3289
for client_name, client in clients_data.items():
3290
# Skip removed clients
3291
if client_name not in client_settings:
3294
# Decide which value to use after restoring saved state.
3295
# We have three different values: Old config file,
3296
# new config file, and saved state.
3297
# New config value takes precedence if it differs from old
3298
# config value, otherwise use saved state.
3299
for name, value in client_settings[client_name].items():
3301
# For each value in new config, check if it
3302
# differs from the old config value (Except for
3303
# the "secret" attribute)
3304
if (name != "secret"
3306
old_client_settings[client_name][name])):
3307
client[name] = value
3311
# Clients who has passed its expire date can still be
3312
# enabled if its last checker was successful. A Client
3313
# whose checker succeeded before we stored its state is
3314
# assumed to have successfully run all checkers during
3316
if client["enabled"]:
3317
if datetime.datetime.utcnow() >= client["expires"]:
3318
if not client["last_checked_ok"]:
3320
"disabling client {} - Client never "
3321
"performed a successful checker".format(
3323
client["enabled"] = False
3324
elif client["last_checker_status"] != 0:
3326
"disabling client {} - Client last"
3327
" checker failed with error code"
3330
client["last_checker_status"]))
3331
client["enabled"] = False
3333
client["expires"] = (
3334
datetime.datetime.utcnow()
3335
+ client["timeout"])
3336
logger.debug("Last checker succeeded,"
3337
" keeping {} enabled".format(
1830
client_class = functools.partial(ClientDBus, bus = bus)
1831
def client_config_items(config, section):
1832
special_settings = {
1833
"approved_by_default":
1834
lambda: config.getboolean(section,
1835
"approved_by_default"),
1837
for name, value in config.items(section):
3340
client["secret"] = pgp.decrypt(
3341
client["encrypted_secret"],
3342
client_settings[client_name]["secret"])
3344
# If decryption fails, we use secret from new settings
3345
logger.debug("Failed to decrypt {} old secret".format(
3347
client["secret"] = (client_settings[client_name]
3350
# Add/remove clients based on new changes made to config
3351
for client_name in (set(old_client_settings)
3352
- set(client_settings)):
3353
del clients_data[client_name]
3354
for client_name in (set(client_settings)
3355
- set(old_client_settings)):
3356
clients_data[client_name] = client_settings[client_name]
3358
# Create all client objects
3359
for client_name, client in clients_data.items():
3360
tcp_server.clients[client_name] = client_class(
3363
server_settings=server_settings)
1839
yield (name, special_settings[name]())
1843
tcp_server.clients.update(set(
1844
client_class(name = section,
1845
config= dict(client_config_items(
1846
client_config, section)))
1847
for section in client_config.sections()))
3365
1848
if not tcp_server.clients:
3366
logger.warning("No clients defined")
3369
if pidfile is not None:
1849
logger.warning(u"No clients defined")
3370
1853
pid = os.getpid()
3373
print(pid, file=pidfile)
3375
logger.error("Could not write to file %r with PID %d",
1854
pidfile.write(str(pid) + "\n")
3380
for termsig in (signal.SIGHUP, signal.SIGTERM):
3381
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3382
lambda: main_loop.quit() and False)
1857
logger.error(u"Could not write to file %r with PID %d",
1860
# "pidfile" was never created
1865
signal.signal(signal.SIGINT, signal.SIG_IGN)
1866
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1867
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3386
@alternate_dbus_interfaces(
3387
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3388
class MandosDBusService(DBusObjectWithObjectManager):
1870
class MandosDBusService(dbus.service.Object):
3389
1871
"""A D-Bus proxy object"""
3391
1872
def __init__(self):
3392
dbus.service.Object.__init__(self, bus, "/")
3394
_interface = "se.recompile.Mandos"
3396
@dbus.service.signal(_interface, signature="o")
1873
dbus.service.Object.__init__(self, bus, u"/")
1874
_interface = u"se.bsnet.fukt.Mandos"
1876
@dbus.service.signal(_interface, signature=u"o")
3397
1877
def ClientAdded(self, objpath):
3401
@dbus.service.signal(_interface, signature="ss")
3402
def ClientNotFound(self, key_id, address):
1881
@dbus.service.signal(_interface, signature=u"ss")
1882
def ClientNotFound(self, fingerprint, address):
3406
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3408
@dbus.service.signal(_interface, signature="os")
1886
@dbus.service.signal(_interface, signature=u"os")
3409
1887
def ClientRemoved(self, objpath, name):
3413
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3415
@dbus.service.method(_interface, out_signature="ao")
1891
@dbus.service.method(_interface, out_signature=u"ao")
3416
1892
def GetAllClients(self):
3418
return dbus.Array(c.dbus_object_path for c in
3419
tcp_server.clients.values())
3421
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1894
return dbus.Array(c.dbus_object_path
1895
for c in tcp_server.clients)
3423
1897
@dbus.service.method(_interface,
3424
out_signature="a{oa{sv}}")
1898
out_signature=u"a{oa{sv}}")
3425
1899
def GetAllClientsWithProperties(self):
3427
1901
return dbus.Dictionary(
3428
{c.dbus_object_path: c.GetAll(
3429
"se.recompile.Mandos.Client")
3430
for c in tcp_server.clients.values()},
3433
@dbus.service.method(_interface, in_signature="o")
1902
((c.dbus_object_path, c.GetAll(u""))
1903
for c in tcp_server.clients),
1904
signature=u"oa{sv}")
1906
@dbus.service.method(_interface, in_signature=u"o")
3434
1907
def RemoveClient(self, object_path):
3436
for c in tcp_server.clients.values():
1909
for c in tcp_server.clients:
3437
1910
if c.dbus_object_path == object_path:
3438
del tcp_server.clients[c.name]
1911
tcp_server.clients.remove(c)
3439
1912
c.remove_from_connection()
3440
# Don't signal the disabling
1913
# Don't signal anything except ClientRemoved
3441
1914
c.disable(quiet=True)
3442
# Emit D-Bus signal for removal
3443
self.client_removed_signal(c)
1916
self.ClientRemoved(object_path, c.name)
3445
1918
raise KeyError(object_path)
3449
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3450
out_signature="a{oa{sa{sv}}}")
3451
def GetManagedObjects(self):
3453
return dbus.Dictionary(
3454
{client.dbus_object_path:
3456
{interface: client.GetAll(interface)
3458
client._get_all_interface_names()})
3459
for client in tcp_server.clients.values()})
3461
def client_added_signal(self, client):
3462
"""Send the new standard signal and the old signal"""
3464
# New standard signal
3465
self.InterfacesAdded(
3466
client.dbus_object_path,
3468
{interface: client.GetAll(interface)
3470
client._get_all_interface_names()}))
3472
self.ClientAdded(client.dbus_object_path)
3474
def client_removed_signal(self, client):
3475
"""Send the new standard signal and the old signal"""
3477
# New standard signal
3478
self.InterfacesRemoved(
3479
client.dbus_object_path,
3480
client._get_all_interface_names())
3482
self.ClientRemoved(client.dbus_object_path,
3485
1922
mandos_dbus_service = MandosDBusService()
3487
# Save modules to variables to exempt the modules from being
3488
# unloaded before the function registered with atexit() is run.
3489
mp = multiprocessing
3493
1925
"Cleanup function; run on exit"
3497
mp.active_children()
3499
if not (tcp_server.clients or client_settings):
3502
# Store client before exiting. Secrets are encrypted with key
3503
# based on what config file has. If config file is
3504
# removed/edited, old secret will thus be unrecovable.
3506
with PGPEngine() as pgp:
3507
for client in tcp_server.clients.values():
3508
key = client_settings[client.name]["secret"]
3509
client.encrypted_secret = pgp.encrypt(client.secret,
3513
# A list of attributes that can not be pickled
3515
exclude = {"bus", "changedstate", "secret",
3516
"checker", "server_settings"}
3517
for name, typ in inspect.getmembers(dbus.service
3521
client_dict["encrypted_secret"] = (client
3523
for attr in client.client_structure:
3524
if attr not in exclude:
3525
client_dict[attr] = getattr(client, attr)
3527
clients[client.name] = client_dict
3528
del client_settings[client.name]["secret"]
3531
with tempfile.NamedTemporaryFile(
3535
dir=os.path.dirname(stored_state_path),
3536
delete=False) as stored_state:
3537
pickle.dump((clients, client_settings), stored_state,
3539
tempname = stored_state.name
3540
os.rename(tempname, stored_state_path)
3541
except (IOError, OSError) as e:
3547
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3548
logger.warning("Could not save persistent state: {}"
3549
.format(os.strerror(e.errno)))
3551
logger.warning("Could not save persistent state:",
3555
# Delete all clients, and settings from config
3556
1928
while tcp_server.clients:
3557
name, client = tcp_server.clients.popitem()
1929
client = tcp_server.clients.pop()
3559
1931
client.remove_from_connection()
3560
# Don't signal the disabling
1932
client.disable_hook = None
1933
# Don't signal anything except ClientRemoved
3561
1934
client.disable(quiet=True)
3562
# Emit D-Bus signal for removal
3564
mandos_dbus_service.client_removed_signal(client)
3565
client_settings.clear()
1937
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3567
1940
atexit.register(cleanup)
3569
for client in tcp_server.clients.values():
1942
for client in tcp_server.clients:
3571
# Emit D-Bus signal for adding
3572
mandos_dbus_service.client_added_signal(client)
3573
# Need to initiate checking of clients
3575
client.init_checker()
1945
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3577
1948
tcp_server.enable()
3578
1949
tcp_server.server_activate()
3580
1951
# Find out what port we got
3582
service.port = tcp_server.socket.getsockname()[1]
1952
service.port = tcp_server.socket.getsockname()[1]
3584
logger.info("Now listening on address %r, port %d,"
3585
" flowinfo %d, scope_id %d",
3586
*tcp_server.socket.getsockname())
1954
logger.info(u"Now listening on address %r, port %d,"
1955
" flowinfo %d, scope_id %d"
1956
% tcp_server.socket.getsockname())
3588
logger.info("Now listening on address %r, port %d",
3589
*tcp_server.socket.getsockname())
3591
# service.interface = tcp_server.socket.getsockname()[3]
1958
logger.info(u"Now listening on address %r, port %d"
1959
% tcp_server.socket.getsockname())
1961
#service.interface = tcp_server.socket.getsockname()[3]
3595
# From the Avahi example code
3598
except dbus.exceptions.DBusException as error:
3599
logger.critical("D-Bus Exception", exc_info=error)
3602
# End of Avahi example code
3604
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3605
lambda *args, **kwargs:
3606
(tcp_server.handle_request
3607
(*args[2:], **kwargs) or True))
3609
logger.debug("Starting main loop")
1964
# From the Avahi example code
1967
except dbus.exceptions.DBusException, error:
1968
logger.critical(u"DBusException: %s", error)
1971
# End of Avahi example code
1973
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1974
lambda *args, **kwargs:
1975
(tcp_server.handle_request
1976
(*args[2:], **kwargs) or True))
1978
logger.debug(u"Starting main loop")
3610
1979
main_loop.run()
3611
except AvahiError as error:
3612
logger.critical("Avahi Error", exc_info=error)
1980
except AvahiError, error:
1981
logger.critical(u"AvahiError: %s", error)
3615
1984
except KeyboardInterrupt:
3617
print("", file=sys.stderr)
3618
logger.debug("Server received KeyboardInterrupt")
3619
logger.debug("Server exiting")
1987
logger.debug(u"Server received KeyboardInterrupt")
1988
logger.debug(u"Server exiting")
3620
1989
# Must run before the D-Bus bus name gets deregistered
3624
1992
if __name__ == '__main__':