62
import cPickle as pickle
70
import cPickle as pickle
63
73
import multiprocessing
66
83
import dbus.service
85
from gi.repository import GLib
69
86
from dbus.mainloop.glib import DBusGMainLoop
72
89
import xml.dom.minidom
92
if sys.version_info.major == 2:
95
# Show warnings by default
96
if not sys.warnoptions:
98
warnings.simplefilter("default")
100
# Try to find the value of SO_BINDTODEVICE:
102
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
103
# newer, and it is also the most natural place for it:
76
104
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
77
105
except AttributeError:
107
# This is where SO_BINDTODEVICE was up to and including Python
79
109
from IN import SO_BINDTODEVICE
80
110
except ImportError:
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)
111
# In Python 2.7 it seems to have been removed entirely.
112
# Try running the C preprocessor:
114
cc = subprocess.Popen(["cc", "--language=c", "-E",
116
stdin=subprocess.PIPE,
117
stdout=subprocess.PIPE)
118
stdout = cc.communicate(
119
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
120
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
121
except (OSError, ValueError, IndexError):
123
SO_BINDTODEVICE = None
125
if sys.version_info.major == 2:
128
if sys.version_info < (3, 2):
129
configparser.Configparser = configparser.SafeConfigParser
132
stored_state_file = "clients.pickle"
134
logger = logging.getLogger()
135
logging.captureWarnings(True) # Show warnings via the logging system
139
if_nametoindex = ctypes.cdll.LoadLibrary(
140
ctypes.util.find_library("c")).if_nametoindex
141
except (OSError, AttributeError):
143
def if_nametoindex(interface):
144
"Get an interface index the hard way, i.e. using fcntl()"
145
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
146
with contextlib.closing(socket.socket()) as s:
147
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
148
struct.pack(b"16s16x", interface))
149
interface_index = struct.unpack("I", ifreq[16:20])[0]
150
return interface_index
153
def copy_function(func):
154
"""Make a copy of a function"""
155
if sys.version_info.major == 2:
156
return types.FunctionType(func.func_code,
162
return types.FunctionType(func.__code__,
169
def initlogger(debug, level=logging.WARNING):
170
"""init logger and add loglevel"""
173
syslogger = (logging.handlers.SysLogHandler(
174
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
176
syslogger.setFormatter(logging.Formatter
177
('Mandos [%(process)d]: %(levelname)s:'
179
logger.addHandler(syslogger)
182
console = logging.StreamHandler()
183
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
187
logger.addHandler(console)
188
logger.setLevel(level)
191
class PGPError(Exception):
192
"""Exception if encryption/decryption fails"""
197
"""A simple class for OpenPGP symmetric encryption & decryption"""
200
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
203
output = subprocess.check_output(["gpgconf"])
204
for line in output.splitlines():
205
name, text, path = line.split(b":")
210
if e.errno != errno.ENOENT:
212
self.gnupgargs = ['--batch',
213
'--homedir', self.tempdir,
216
# Only GPG version 1 has the --no-use-agent option.
217
if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
218
self.gnupgargs.append("--no-use-agent")
223
def __exit__(self, exc_type, exc_value, traceback):
231
if self.tempdir is not None:
232
# Delete contents of tempdir
233
for root, dirs, files in os.walk(self.tempdir,
235
for filename in files:
236
os.remove(os.path.join(root, filename))
238
os.rmdir(os.path.join(root, dirname))
240
os.rmdir(self.tempdir)
243
def password_encode(self, password):
244
# Passphrase can not be empty and can not contain newlines or
245
# NUL bytes. So we prefix it and hex encode it.
246
encoded = b"mandos" + binascii.hexlify(password)
247
if len(encoded) > 2048:
248
# GnuPG can't handle long passwords, so encode differently
249
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
250
.replace(b"\n", b"\\n")
251
.replace(b"\0", b"\\x00"))
254
def encrypt(self, data, password):
255
passphrase = self.password_encode(password)
256
with tempfile.NamedTemporaryFile(
257
dir=self.tempdir) as passfile:
258
passfile.write(passphrase)
260
proc = subprocess.Popen([self.gpg, '--symmetric',
264
stdin=subprocess.PIPE,
265
stdout=subprocess.PIPE,
266
stderr=subprocess.PIPE)
267
ciphertext, err = proc.communicate(input=data)
268
if proc.returncode != 0:
272
def decrypt(self, data, password):
273
passphrase = self.password_encode(password)
274
with tempfile.NamedTemporaryFile(
275
dir=self.tempdir) as passfile:
276
passfile.write(passphrase)
278
proc = subprocess.Popen([self.gpg, '--decrypt',
282
stdin=subprocess.PIPE,
283
stdout=subprocess.PIPE,
284
stderr=subprocess.PIPE)
285
decrypted_plaintext, err = proc.communicate(input=data)
286
if proc.returncode != 0:
288
return decrypted_plaintext
291
# Pretend that we have an Avahi module
293
"""This isn't so much a class as it is a module-like namespace."""
294
IF_UNSPEC = -1 # avahi-common/address.h
295
PROTO_UNSPEC = -1 # avahi-common/address.h
296
PROTO_INET = 0 # avahi-common/address.h
297
PROTO_INET6 = 1 # avahi-common/address.h
298
DBUS_NAME = "org.freedesktop.Avahi"
299
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
300
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
301
DBUS_PATH_SERVER = "/"
304
def string_array_to_txt_array(t):
305
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
306
for s in t), signature="ay")
307
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
308
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
309
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
310
SERVER_INVALID = 0 # avahi-common/defs.h
311
SERVER_REGISTERING = 1 # avahi-common/defs.h
312
SERVER_RUNNING = 2 # avahi-common/defs.h
313
SERVER_COLLISION = 3 # avahi-common/defs.h
314
SERVER_FAILURE = 4 # avahi-common/defs.h
102
317
class AvahiError(Exception):
103
318
def __init__(self, value, *args, **kwargs):
104
319
self.value = value
105
super(AvahiError, self).__init__(value, *args, **kwargs)
106
def __unicode__(self):
107
return unicode(repr(self.value))
320
return super(AvahiError, self).__init__(value, *args,
109
324
class AvahiServiceError(AvahiError):
112
328
class AvahiGroupError(AvahiError):
116
class AvahiService(object):
117
333
"""An Avahi (Zeroconf) service.
120
336
interface: integer; avahi.IF_UNSPEC or an interface index.
121
337
Used to optionally bind to the specified interface.
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
338
name: string; Example: 'Mandos'
339
type: string; Example: '_mandos._tcp'.
340
See <https://www.iana.org/assignments/service-names-port-numbers>
125
341
port: integer; what port to announce
126
342
TXT: list of strings; TXT record for the service
127
343
domain: string; Domain to publish on, default to .local if empty.
197
432
dbus.UInt16(self.port),
198
433
avahi.string_array_to_txt_array(self.TXT))
199
434
self.group.Commit()
200
436
def entry_group_state_changed(self, state, error):
201
437
"""Derived from the Avahi example code"""
202
logger.debug(u"Avahi entry group state change: %i", state)
438
logger.debug("Avahi entry group state change: %i", state)
204
440
if state == avahi.ENTRY_GROUP_ESTABLISHED:
205
logger.debug(u"Zeroconf service established.")
441
logger.debug("Zeroconf service established.")
206
442
elif state == avahi.ENTRY_GROUP_COLLISION:
207
logger.warning(u"Zeroconf service name collision.")
443
logger.info("Zeroconf service name collision.")
209
445
elif state == avahi.ENTRY_GROUP_FAILURE:
210
logger.critical(u"Avahi: Error in group state changed %s",
212
raise AvahiGroupError(u"State changed: %s"
446
logger.critical("Avahi: Error in group state changed %s",
448
raise AvahiGroupError("State changed: {!s}".format(error))
214
450
def cleanup(self):
215
451
"""Derived from the Avahi example code"""
216
452
if self.group is not None:
455
except (dbus.exceptions.UnknownMethodException,
456
dbus.exceptions.DBusException):
218
458
self.group = None
219
def server_state_changed(self, state):
461
def server_state_changed(self, state, error=None):
220
462
"""Derived from the Avahi example code"""
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
463
logger.debug("Avahi server state change: %i", state)
465
avahi.SERVER_INVALID: "Zeroconf server invalid",
466
avahi.SERVER_REGISTERING: None,
467
avahi.SERVER_COLLISION: "Zeroconf server name collision",
468
avahi.SERVER_FAILURE: "Zeroconf server failure",
470
if state in bad_states:
471
if bad_states[state] is not None:
473
logger.error(bad_states[state])
475
logger.error(bad_states[state] + ": %r", error)
225
477
elif state == avahi.SERVER_RUNNING:
480
except dbus.exceptions.DBusException as error:
481
if (error.get_dbus_name()
482
== "org.freedesktop.Avahi.CollisionError"):
483
logger.info("Local Zeroconf service name"
485
return self.rename(remove=False)
487
logger.critical("D-Bus Exception", exc_info=error)
492
logger.debug("Unknown state: %r", state)
494
logger.debug("Unknown state: %r: %r", state, error)
227
496
def activate(self):
228
497
"""Derived from the Avahi example code"""
229
498
if self.server is None:
230
499
self.server = dbus.Interface(
231
500
self.bus.get_object(avahi.DBUS_NAME,
232
avahi.DBUS_PATH_SERVER),
501
avahi.DBUS_PATH_SERVER,
502
follow_name_owner_changes=True),
233
503
avahi.DBUS_INTERFACE_SERVER)
234
self.server.connect_to_signal(u"StateChanged",
235
self.server_state_changed)
504
self.server.connect_to_signal("StateChanged",
505
self.server_state_changed)
236
506
self.server_state_changed(self.server.GetState())
239
class Client(object):
509
class AvahiServiceToSyslog(AvahiService):
510
def rename(self, *args, **kwargs):
511
"""Add the new name to the syslog messages"""
512
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
513
syslogger.setFormatter(logging.Formatter(
514
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
519
# Pretend that we have a GnuTLS module
521
"""This isn't so much a class as it is a module-like namespace."""
523
library = ctypes.util.find_library("gnutls")
525
library = ctypes.util.find_library("gnutls-deb0")
526
_library = ctypes.cdll.LoadLibrary(library)
529
# Unless otherwise indicated, the constants and types below are
530
# all from the gnutls/gnutls.h C header file.
541
E_NO_CERTIFICATE_FOUND = -49
546
KEYID_USE_SHA256 = 1 # gnutls/x509.h
547
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
550
class session_int(ctypes.Structure):
552
session_t = ctypes.POINTER(session_int)
554
class certificate_credentials_st(ctypes.Structure):
556
certificate_credentials_t = ctypes.POINTER(
557
certificate_credentials_st)
558
certificate_type_t = ctypes.c_int
560
class datum_t(ctypes.Structure):
561
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
562
('size', ctypes.c_uint)]
564
class openpgp_crt_int(ctypes.Structure):
566
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
567
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
568
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
569
credentials_type_t = ctypes.c_int
570
transport_ptr_t = ctypes.c_void_p
571
close_request_t = ctypes.c_int
574
class Error(Exception):
575
def __init__(self, message=None, code=None, args=()):
576
# Default usage is by a message string, but if a return
577
# code is passed, convert it to a string with
580
if message is None and code is not None:
581
message = gnutls.strerror(code)
582
return super(gnutls.Error, self).__init__(
585
class CertificateSecurityError(Error):
591
self._c_object = gnutls.certificate_credentials_t()
592
gnutls.certificate_allocate_credentials(
593
ctypes.byref(self._c_object))
594
self.type = gnutls.CRD_CERTIFICATE
597
gnutls.certificate_free_credentials(self._c_object)
600
def __init__(self, socket, credentials=None):
601
self._c_object = gnutls.session_t()
602
gnutls_flags = gnutls.CLIENT
603
if gnutls.check_version(b"3.5.6"):
604
gnutls_flags |= gnutls.NO_TICKETS
606
gnutls_flags |= gnutls.ENABLE_RAWPK
607
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
609
gnutls.set_default_priority(self._c_object)
610
gnutls.transport_set_ptr(self._c_object, socket.fileno())
611
gnutls.handshake_set_private_extensions(self._c_object,
614
if credentials is None:
615
credentials = gnutls.Credentials()
616
gnutls.credentials_set(self._c_object, credentials.type,
617
ctypes.cast(credentials._c_object,
619
self.credentials = credentials
622
gnutls.deinit(self._c_object)
625
return gnutls.handshake(self._c_object)
627
def send(self, data):
631
data_len -= gnutls.record_send(self._c_object,
636
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
638
# Error handling functions
639
def _error_code(result):
640
"""A function to raise exceptions on errors, suitable
641
for the 'restype' attribute on ctypes functions"""
644
if result == gnutls.E_NO_CERTIFICATE_FOUND:
645
raise gnutls.CertificateSecurityError(code=result)
646
raise gnutls.Error(code=result)
648
def _retry_on_error(result, func, arguments):
649
"""A function to retry on some errors, suitable
650
for the 'errcheck' attribute on ctypes functions"""
652
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
653
return _error_code(result)
654
result = func(*arguments)
657
# Unless otherwise indicated, the function declarations below are
658
# all from the gnutls/gnutls.h C header file.
661
priority_set_direct = _library.gnutls_priority_set_direct
662
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
663
ctypes.POINTER(ctypes.c_char_p)]
664
priority_set_direct.restype = _error_code
666
init = _library.gnutls_init
667
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
668
init.restype = _error_code
670
set_default_priority = _library.gnutls_set_default_priority
671
set_default_priority.argtypes = [session_t]
672
set_default_priority.restype = _error_code
674
record_send = _library.gnutls_record_send
675
record_send.argtypes = [session_t, ctypes.c_void_p,
677
record_send.restype = ctypes.c_ssize_t
678
record_send.errcheck = _retry_on_error
680
certificate_allocate_credentials = (
681
_library.gnutls_certificate_allocate_credentials)
682
certificate_allocate_credentials.argtypes = [
683
ctypes.POINTER(certificate_credentials_t)]
684
certificate_allocate_credentials.restype = _error_code
686
certificate_free_credentials = (
687
_library.gnutls_certificate_free_credentials)
688
certificate_free_credentials.argtypes = [
689
certificate_credentials_t]
690
certificate_free_credentials.restype = None
692
handshake_set_private_extensions = (
693
_library.gnutls_handshake_set_private_extensions)
694
handshake_set_private_extensions.argtypes = [session_t,
696
handshake_set_private_extensions.restype = None
698
credentials_set = _library.gnutls_credentials_set
699
credentials_set.argtypes = [session_t, credentials_type_t,
701
credentials_set.restype = _error_code
703
strerror = _library.gnutls_strerror
704
strerror.argtypes = [ctypes.c_int]
705
strerror.restype = ctypes.c_char_p
707
certificate_type_get = _library.gnutls_certificate_type_get
708
certificate_type_get.argtypes = [session_t]
709
certificate_type_get.restype = _error_code
711
certificate_get_peers = _library.gnutls_certificate_get_peers
712
certificate_get_peers.argtypes = [session_t,
713
ctypes.POINTER(ctypes.c_uint)]
714
certificate_get_peers.restype = ctypes.POINTER(datum_t)
716
global_set_log_level = _library.gnutls_global_set_log_level
717
global_set_log_level.argtypes = [ctypes.c_int]
718
global_set_log_level.restype = None
720
global_set_log_function = _library.gnutls_global_set_log_function
721
global_set_log_function.argtypes = [log_func]
722
global_set_log_function.restype = None
724
deinit = _library.gnutls_deinit
725
deinit.argtypes = [session_t]
726
deinit.restype = None
728
handshake = _library.gnutls_handshake
729
handshake.argtypes = [session_t]
730
handshake.restype = _error_code
731
handshake.errcheck = _retry_on_error
733
transport_set_ptr = _library.gnutls_transport_set_ptr
734
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
735
transport_set_ptr.restype = None
737
bye = _library.gnutls_bye
738
bye.argtypes = [session_t, close_request_t]
739
bye.restype = _error_code
740
bye.errcheck = _retry_on_error
742
check_version = _library.gnutls_check_version
743
check_version.argtypes = [ctypes.c_char_p]
744
check_version.restype = ctypes.c_char_p
746
_need_version = b"3.3.0"
747
if check_version(_need_version) is None:
748
raise self.Error("Needs GnuTLS {} or later"
749
.format(_need_version))
751
_tls_rawpk_version = b"3.6.6"
752
has_rawpk = bool(check_version(_tls_rawpk_version))
756
class pubkey_st(ctypes.Structure):
758
pubkey_t = ctypes.POINTER(pubkey_st)
760
x509_crt_fmt_t = ctypes.c_int
762
# All the function declarations below are from gnutls/abstract.h
763
pubkey_init = _library.gnutls_pubkey_init
764
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
765
pubkey_init.restype = _error_code
767
pubkey_import = _library.gnutls_pubkey_import
768
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
770
pubkey_import.restype = _error_code
772
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
773
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
774
ctypes.POINTER(ctypes.c_ubyte),
775
ctypes.POINTER(ctypes.c_size_t)]
776
pubkey_get_key_id.restype = _error_code
778
pubkey_deinit = _library.gnutls_pubkey_deinit
779
pubkey_deinit.argtypes = [pubkey_t]
780
pubkey_deinit.restype = None
782
# All the function declarations below are from gnutls/openpgp.h
784
openpgp_crt_init = _library.gnutls_openpgp_crt_init
785
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
786
openpgp_crt_init.restype = _error_code
788
openpgp_crt_import = _library.gnutls_openpgp_crt_import
789
openpgp_crt_import.argtypes = [openpgp_crt_t,
790
ctypes.POINTER(datum_t),
792
openpgp_crt_import.restype = _error_code
794
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
795
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
796
ctypes.POINTER(ctypes.c_uint)]
797
openpgp_crt_verify_self.restype = _error_code
799
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
800
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
801
openpgp_crt_deinit.restype = None
803
openpgp_crt_get_fingerprint = (
804
_library.gnutls_openpgp_crt_get_fingerprint)
805
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
809
openpgp_crt_get_fingerprint.restype = _error_code
811
if check_version(b"3.6.4"):
812
certificate_type_get2 = _library.gnutls_certificate_type_get2
813
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
814
certificate_type_get2.restype = _error_code
816
# Remove non-public functions
817
del _error_code, _retry_on_error
820
def call_pipe(connection, # : multiprocessing.Connection
821
func, *args, **kwargs):
822
"""This function is meant to be called by multiprocessing.Process
824
This function runs func(*args, **kwargs), and writes the resulting
825
return value on the provided multiprocessing.Connection.
827
connection.send(func(*args, **kwargs))
240
832
"""A representation of a client host served by this server.
835
approved: bool(); 'None' if not yet approved/disapproved
836
approval_delay: datetime.timedelta(); Time to wait for approval
837
approval_duration: datetime.timedelta(); Duration of one approval
838
checker: multiprocessing.Process(); a running checker process used
839
to see if the client lives. 'None' if no process is
841
checker_callback_tag: a GLib event source tag, or None
842
checker_command: string; External command which is run to check
843
if client lives. %() expansions are done at
844
runtime with vars(self) as dict, so that for
845
instance %(name)s can be used in the command.
846
checker_initiator_tag: a GLib event source tag, or None
847
created: datetime.datetime(); (UTC) object creation
848
client_structure: Object describing what attributes a client has
849
and is used for storing the client at exit
850
current_checker_command: string; current running checker_command
851
disable_initiator_tag: a GLib event source tag, or None
853
fingerprint: string (40 or 32 hexadecimal digits); used to
854
uniquely identify an OpenPGP client
855
key_id: string (64 hexadecimal digits); used to uniquely identify
856
a client using raw public keys
857
host: string; available for use by the checker command
858
interval: datetime.timedelta(); How often to start a new checker
859
last_approval_request: datetime.datetime(); (UTC) or None
860
last_checked_ok: datetime.datetime(); (UTC) or None
861
last_checker_status: integer between 0 and 255 reflecting exit
862
status of last checker. -1 reflects crashed
863
checker, -2 means no checker completed yet.
864
last_checker_signal: The signal which killed the last checker, if
865
last_checker_status is -1
866
last_enabled: datetime.datetime(); (UTC) or None
243
867
name: string; from the config file, used in log messages and
244
868
D-Bus identifiers
245
fingerprint: string (40 or 32 hexadecimal digits); used to
246
uniquely identify the client
247
869
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
870
timeout: datetime.timedelta(); How long from last_checked_ok
254
871
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)
257
checker: subprocess.Popen(); a running checker process used
258
to see if the client lives.
259
'None' if no process is running.
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
265
runtime with vars(self) as dict, so that for
266
instance %(name)s can be used in the command.
267
current_checker_command: string; current running checker_command
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
872
extended_timeout: extra long timeout when secret has been sent
873
runtime_expansions: Allowed attributes for runtime expansion.
874
expires: datetime.datetime(); time (UTC) when a client will be
876
server_settings: The server_settings dict from main()
879
runtime_expansions = ("approval_delay", "approval_duration",
880
"created", "enabled", "expires", "key_id",
881
"fingerprint", "host", "interval",
882
"last_approval_request", "last_checked_ok",
883
"last_enabled", "name", "timeout")
886
"extended_timeout": "PT15M",
888
"checker": "fping -q -- %%(host)s",
890
"approval_delay": "PT0S",
891
"approval_duration": "PT1S",
892
"approved_by_default": "True",
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'
897
def config_parser(config):
898
"""Construct a new dict of client settings of this form:
899
{ client_name: {setting_name: value, ...}, ...}
900
with exceptions for any special settings as defined above.
901
NOTE: Must be a pure function. Must return the same result
902
value given the same arguments.
905
for client_name in config.sections():
906
section = dict(config.items(client_name))
907
client = settings[client_name] = {}
909
client["host"] = section["host"]
910
# Reformat values from string types to Python types
911
client["approved_by_default"] = config.getboolean(
912
client_name, "approved_by_default")
913
client["enabled"] = config.getboolean(client_name,
916
# Uppercase and remove spaces from key_id and fingerprint
917
# for later comparison purposes with return value from the
918
# key_id() and fingerprint() functions
919
client["key_id"] = (section.get("key_id", "").upper()
921
client["fingerprint"] = (section["fingerprint"].upper()
923
if "secret" in section:
924
client["secret"] = codecs.decode(section["secret"]
927
elif "secfile" in section:
928
with open(os.path.expanduser(os.path.expandvars
929
(section["secfile"])),
931
client["secret"] = secfile.read()
933
raise TypeError("No secret or secfile for section {}"
935
client["timeout"] = string_to_delta(section["timeout"])
936
client["extended_timeout"] = string_to_delta(
937
section["extended_timeout"])
938
client["interval"] = string_to_delta(section["interval"])
939
client["approval_delay"] = string_to_delta(
940
section["approval_delay"])
941
client["approval_duration"] = string_to_delta(
942
section["approval_duration"])
943
client["checker_command"] = section["checker"]
944
client["last_approval_request"] = None
945
client["last_checked_ok"] = None
946
client["last_checker_status"] = -2
950
def __init__(self, settings, name=None, server_settings=None):
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()
952
if server_settings is None:
954
self.server_settings = server_settings
955
# adding all client settings
956
for setting, value in settings.items():
957
setattr(self, setting, value)
960
if not hasattr(self, "last_enabled"):
961
self.last_enabled = datetime.datetime.utcnow()
962
if not hasattr(self, "expires"):
963
self.expires = (datetime.datetime.utcnow()
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
966
self.last_enabled = None
969
logger.debug("Creating client %r", self.name)
970
logger.debug(" Key ID: %s", self.key_id)
971
logger.debug(" Fingerprint: %s", self.fingerprint)
972
self.created = settings.get("created",
973
datetime.datetime.utcnow())
975
# attributes specific for this server instance
323
976
self.checker = None
324
977
self.checker_initiator_tag = None
325
978
self.disable_initiator_tag = None
326
979
self.checker_callback_tag = None
327
self.checker_command = config[u"checker"]
328
980
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",
333
982
self.approvals_pending = 0
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())
983
self.changedstate = multiprocessing_manager.Condition(
984
multiprocessing_manager.Lock())
985
self.client_structure = [attr
986
for attr in self.__dict__.keys()
987
if not attr.startswith("_")]
988
self.client_structure.append("client_structure")
990
for name, t in inspect.getmembers(
991
type(self), lambda obj: isinstance(obj, property)):
992
if not name.startswith("_"):
993
self.client_structure.append(name)
995
# Send notice to process children that client state has changed
340
996
def send_changedstate(self):
341
self.changedstate.acquire()
342
self.changedstate.notify_all()
343
self.changedstate.release()
997
with self.changedstate:
998
self.changedstate.notify_all()
345
1000
def enable(self):
346
1001
"""Start this client's checker and timeout hooks"""
347
if getattr(self, u"enabled", False):
1002
if getattr(self, "enabled", False):
348
1003
# Already enabled
350
self.send_changedstate()
1005
self.expires = datetime.datetime.utcnow() + self.timeout
351
1007
self.last_enabled = datetime.datetime.utcnow()
1009
self.send_changedstate()
1011
def disable(self, quiet=True):
1012
"""Disable this client."""
1013
if not getattr(self, "enabled", False):
1016
logger.info("Disabling client %s", self.name)
1017
if getattr(self, "disable_initiator_tag", None) is not None:
1018
GLib.source_remove(self.disable_initiator_tag)
1019
self.disable_initiator_tag = None
1021
if getattr(self, "checker_initiator_tag", None) is not None:
1022
GLib.source_remove(self.checker_initiator_tag)
1023
self.checker_initiator_tag = None
1025
self.enabled = False
1027
self.send_changedstate()
1028
# Do not run this again if called by a GLib.timeout_add
1034
def init_checker(self):
352
1035
# Schedule a new checker to be started an 'interval' from now,
353
1036
# and every interval from then on.
354
self.checker_initiator_tag = (gobject.timeout_add
355
(self.interval_milliseconds(),
1037
if self.checker_initiator_tag is not None:
1038
GLib.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = GLib.timeout_add(
1040
int(self.interval.total_seconds() * 1000),
357
1042
# Schedule a disable() when 'timeout' has passed
358
self.disable_initiator_tag = (gobject.timeout_add
359
(self.timeout_milliseconds(),
1043
if self.disable_initiator_tag is not None:
1044
GLib.source_remove(self.disable_initiator_tag)
1045
self.disable_initiator_tag = GLib.timeout_add(
1046
int(self.timeout.total_seconds() * 1000), self.disable)
362
1047
# Also start a new checker *right now*.
363
1048
self.start_checker()
365
def disable(self, quiet=True):
366
"""Disable this client."""
367
if not getattr(self, "enabled", False):
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)
375
self.disable_initiator_tag = None
376
if getattr(self, u"checker_initiator_tag", False):
377
gobject.source_remove(self.checker_initiator_tag)
378
self.checker_initiator_tag = None
380
if self.disable_hook:
381
self.disable_hook(self)
383
# Do not run this again if called by a gobject.timeout_add
387
self.disable_hook = None
390
def checker_callback(self, pid, condition, command):
1050
def checker_callback(self, source, condition, connection,
391
1052
"""The checker has completed, so take appropriate actions."""
1053
# Read return code from connection (see call_pipe)
1054
returncode = connection.recv()
392
1057
self.checker_callback_tag = None
393
1058
self.checker = None
394
if os.WIFEXITED(condition):
395
exitstatus = os.WEXITSTATUS(condition)
397
logger.info(u"Checker for %(name)s succeeded",
1061
self.last_checker_status = returncode
1062
self.last_checker_signal = None
1063
if self.last_checker_status == 0:
1064
logger.info("Checker for %(name)s succeeded",
399
1066
self.checked_ok()
401
logger.info(u"Checker for %(name)s failed",
1068
logger.info("Checker for %(name)s failed", vars(self))
404
logger.warning(u"Checker for %(name)s crashed?",
1070
self.last_checker_status = -1
1071
self.last_checker_signal = -returncode
1072
logger.warning("Checker for %(name)s crashed?",
407
1076
def checked_ok(self):
408
"""Bump up the timeout for this client.
410
This should only be called when the client has been seen,
1077
"""Assert that the client has been seen, alive and well."""
413
1078
self.last_checked_ok = datetime.datetime.utcnow()
414
gobject.source_remove(self.disable_initiator_tag)
415
self.disable_initiator_tag = (gobject.timeout_add
416
(self.timeout_milliseconds(),
1079
self.last_checker_status = 0
1080
self.last_checker_signal = None
1083
def bump_timeout(self, timeout=None):
1084
"""Bump up the timeout for this client."""
1086
timeout = self.timeout
1087
if self.disable_initiator_tag is not None:
1088
GLib.source_remove(self.disable_initiator_tag)
1089
self.disable_initiator_tag = None
1090
if getattr(self, "enabled", False):
1091
self.disable_initiator_tag = GLib.timeout_add(
1092
int(timeout.total_seconds() * 1000), self.disable)
1093
self.expires = datetime.datetime.utcnow() + timeout
1095
def need_approval(self):
1096
self.last_approval_request = datetime.datetime.utcnow()
419
1098
def start_checker(self):
420
1099
"""Start a new checker subprocess if one is not running.
422
1101
If a checker already exists, leave it running and do
424
1103
# The reason for not killing a running checker is that if we
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
# did that, and if a checker (for some reason) started running
1105
# slowly and taking more than 'interval' time, then the client
1106
# would inevitably timeout, since no checker would get a
1107
# chance to run to completion. If we instead leave running
429
1108
# checkers alone, the checker would have to take more time
430
1109
# than 'timeout' for the client to be disabled, which is as it
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
if self.checker is not None and not self.checker.is_alive():
1113
logger.warning("Checker was not alive; joining")
446
1116
# Start a new checker if needed
447
1117
if self.checker is None:
1118
# Escape attributes for the shell
1120
attr: re.escape(str(getattr(self, attr)))
1121
for attr in self.runtime_expansions}
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
1123
command = self.checker_command % escaped_attrs
1124
except TypeError as error:
1125
logger.error('Could not format string "%s"',
1126
self.checker_command,
1128
return True # Try again later
465
1129
self.current_checker_command = command
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
1130
logger.info("Starting checker %r for %s", command,
1132
# We don't need to redirect stdout and stderr, since
1133
# in normal mode, that is already done by daemon(),
1134
# and in debug mode we don't want to. (Stdin is
1135
# always replaced by /dev/null.)
1136
# The exception is when not debugging but nevertheless
1137
# running in the foreground; use the previously
1139
popen_args = {"close_fds": True,
1142
if (not self.server_settings["debug"]
1143
and self.server_settings["foreground"]):
1144
popen_args.update({"stdout": wnull,
1146
pipe = multiprocessing.Pipe(duplex=False)
1147
self.checker = multiprocessing.Process(
1149
args=(pipe[1], subprocess.call, command),
1151
self.checker.start()
1152
self.checker_callback_tag = GLib.io_add_watch(
1153
GLib.IOChannel.unix_new(pipe[0].fileno()),
1154
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1155
self.checker_callback, pipe[0], command)
1156
# Re-run this periodically if run by GLib.timeout_add
492
1159
def stop_checker(self):
493
1160
"""Force the checker process, if any, to stop."""
494
1161
if self.checker_callback_tag:
495
gobject.source_remove(self.checker_callback_tag)
1162
GLib.source_remove(self.checker_callback_tag)
496
1163
self.checker_callback_tag = None
497
if getattr(self, u"checker", None) is None:
1164
if getattr(self, "checker", None) is None:
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
1166
logger.debug("Stopping checker for %(name)s", vars(self))
1167
self.checker.terminate()
508
1168
self.checker = None
510
def dbus_service_property(dbus_interface, signature=u"v",
511
access=u"readwrite", byte_arrays=False):
1171
def dbus_service_property(dbus_interface,
512
1175
"""Decorators for marking methods of a DBusObjectWithProperties to
513
1176
become properties on the D-Bus.
515
1178
The decorated method will be called with no arguments by "Get"
516
1179
and with one argument by "Set".
518
1181
The parameters, where they are supported, are the same as
519
1182
dbus.service.method, except there is only "signature", since the
520
1183
type from Get() and the type sent to Set() is the same.
522
1185
# Encoding deeply encoded byte arrays is not supported yet by the
523
1186
# "Set" method, so we fail early here:
524
if byte_arrays and signature != u"ay":
525
raise ValueError(u"Byte arrays not supported for non-'ay'"
526
u" signature %r" % signature)
1187
if byte_arrays and signature != "ay":
1188
raise ValueError("Byte arrays not supported for non-'ay'"
1189
" signature {!r}".format(signature))
527
1191
def decorator(func):
528
1192
func._dbus_is_property = True
529
1193
func._dbus_interface = dbus_interface
530
1194
func._dbus_signature = signature
531
1195
func._dbus_access = access
532
1196
func._dbus_name = func.__name__
533
if func._dbus_name.endswith(u"_dbus_property"):
1197
if func._dbus_name.endswith("_dbus_property"):
534
1198
func._dbus_name = func._dbus_name[:-14]
535
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1199
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1205
def dbus_interface_annotations(dbus_interface):
1206
"""Decorator for marking functions returning interface annotations
1210
@dbus_interface_annotations("org.example.Interface")
1211
def _foo(self): # Function name does not matter
1212
return {"org.freedesktop.DBus.Deprecated": "true",
1213
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1217
def decorator(func):
1218
func._dbus_is_interface = True
1219
func._dbus_interface = dbus_interface
1220
func._dbus_name = dbus_interface
1226
def dbus_annotations(annotations):
1227
"""Decorator to annotate D-Bus methods, signals or properties
1230
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1231
"org.freedesktop.DBus.Property."
1232
"EmitsChangedSignal": "false"})
1233
@dbus_service_property("org.example.Interface", signature="b",
1235
def Property_dbus_property(self):
1236
return dbus.Boolean(False)
1238
See also the DBusObjectWithAnnotations class.
1241
def decorator(func):
1242
func._dbus_annotations = annotations
537
1245
return decorator
540
1248
class DBusPropertyException(dbus.exceptions.DBusException):
541
1249
"""A base class for D-Bus property-related exceptions
543
def __unicode__(self):
544
return unicode(str(self))
547
1254
class DBusPropertyAccessException(DBusPropertyException):
559
class DBusObjectWithProperties(dbus.service.Object):
1266
class DBusObjectWithAnnotations(dbus.service.Object):
1267
"""A D-Bus object with annotations.
1269
Classes inheriting from this can use the dbus_annotations
1270
decorator to add annotations to methods or signals.
1274
def _is_dbus_thing(thing):
1275
"""Returns a function testing if an attribute is a D-Bus thing
1277
If called like _is_dbus_thing("method") it returns a function
1278
suitable for use as predicate to inspect.getmembers().
1280
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1283
def _get_all_dbus_things(self, thing):
1284
"""Returns a generator of (name, attribute) pairs
1286
return ((getattr(athing.__get__(self), "_dbus_name", name),
1287
athing.__get__(self))
1288
for cls in self.__class__.__mro__
1290
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1292
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1294
path_keyword='object_path',
1295
connection_keyword='connection')
1296
def Introspect(self, object_path, connection):
1297
"""Overloading of standard D-Bus method.
1299
Inserts annotation tags on methods and signals.
1301
xmlstring = dbus.service.Object.Introspect(self, object_path,
1304
document = xml.dom.minidom.parseString(xmlstring)
1306
for if_tag in document.getElementsByTagName("interface"):
1307
# Add annotation tags
1308
for typ in ("method", "signal"):
1309
for tag in if_tag.getElementsByTagName(typ):
1311
for name, prop in (self.
1312
_get_all_dbus_things(typ)):
1313
if (name == tag.getAttribute("name")
1314
and prop._dbus_interface
1315
== if_tag.getAttribute("name")):
1316
annots.update(getattr(
1317
prop, "_dbus_annotations", {}))
1318
for name, value in annots.items():
1319
ann_tag = document.createElement(
1321
ann_tag.setAttribute("name", name)
1322
ann_tag.setAttribute("value", value)
1323
tag.appendChild(ann_tag)
1324
# Add interface annotation tags
1325
for annotation, value in dict(
1326
itertools.chain.from_iterable(
1327
annotations().items()
1328
for name, annotations
1329
in self._get_all_dbus_things("interface")
1330
if name == if_tag.getAttribute("name")
1332
ann_tag = document.createElement("annotation")
1333
ann_tag.setAttribute("name", annotation)
1334
ann_tag.setAttribute("value", value)
1335
if_tag.appendChild(ann_tag)
1336
# Fix argument name for the Introspect method itself
1337
if (if_tag.getAttribute("name")
1338
== dbus.INTROSPECTABLE_IFACE):
1339
for cn in if_tag.getElementsByTagName("method"):
1340
if cn.getAttribute("name") == "Introspect":
1341
for arg in cn.getElementsByTagName("arg"):
1342
if (arg.getAttribute("direction")
1344
arg.setAttribute("name",
1346
xmlstring = document.toxml("utf-8")
1348
except (AttributeError, xml.dom.DOMException,
1349
xml.parsers.expat.ExpatError) as error:
1350
logger.error("Failed to override Introspection method",
1355
class DBusObjectWithProperties(DBusObjectWithAnnotations):
560
1356
"""A D-Bus object with properties.
562
1358
Classes inheriting from this can use the dbus_service_property
563
1359
decorator to expose methods as D-Bus properties. It exposes the
564
1360
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))
578
1363
def _get_dbus_property(self, interface_name, property_name):
579
1364
"""Returns a bound method if one exists which is a D-Bus
580
1365
property with the specified name and interface.
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)):
1367
for cls in self.__class__.__mro__:
1368
for name, value in inspect.getmembers(
1369
cls, self._is_dbus_thing("property")):
1370
if (value._dbus_name == property_name
1371
and value._dbus_interface == interface_name):
1372
return value.__get__(self)
592
1374
# No such property
593
raise DBusPropertyNotFound(self.dbus_object_path + u":"
594
+ interface_name + u"."
597
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1375
raise DBusPropertyNotFound("{}:{}.{}".format(
1376
self.dbus_object_path, interface_name, property_name))
1379
def _get_all_interface_names(cls):
1380
"""Get a sequence of all interfaces supported by an object"""
1381
return (name for name in set(getattr(getattr(x, attr),
1382
"_dbus_interface", None)
1383
for x in (inspect.getmro(cls))
1385
if name is not None)
1387
@dbus.service.method(dbus.PROPERTIES_IFACE,
599
1390
def Get(self, interface_name, property_name):
600
1391
"""Standard D-Bus property Get() method, see D-Bus standard.
602
1393
prop = self._get_dbus_property(interface_name, property_name)
603
if prop._dbus_access == u"write":
1394
if prop._dbus_access == "write":
604
1395
raise DBusPropertyAccessException(property_name)
606
if not hasattr(value, u"variant_level"):
1397
if not hasattr(value, "variant_level"):
608
1399
return type(value)(value, variant_level=value.variant_level+1)
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1401
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
611
1402
def Set(self, interface_name, property_name, value):
612
1403
"""Standard D-Bus property Set() method, see D-Bus standard.
614
1405
prop = self._get_dbus_property(interface_name, property_name)
615
if prop._dbus_access == u"read":
1406
if prop._dbus_access == "read":
616
1407
raise DBusPropertyAccessException(property_name)
617
if prop._dbus_get_args_options[u"byte_arrays"]:
1408
if prop._dbus_get_args_options["byte_arrays"]:
618
1409
# The byte_arrays option is not supported yet on
619
1410
# signatures other than "ay".
620
if prop._dbus_signature != u"ay":
622
value = dbus.ByteArray(''.join(unichr(byte)
1411
if prop._dbus_signature != "ay":
1412
raise ValueError("Byte arrays not supported for non-"
1413
"'ay' signature {!r}"
1414
.format(prop._dbus_signature))
1415
value = dbus.ByteArray(b''.join(chr(byte)
626
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
627
out_signature=u"a{sv}")
1419
@dbus.service.method(dbus.PROPERTIES_IFACE,
1421
out_signature="a{sv}")
628
1422
def GetAll(self, interface_name):
629
1423
"""Standard D-Bus property GetAll() method, see D-Bus
632
1426
Note: Will not include properties with access="write".
635
for name, prop in self._get_all_dbus_properties():
1429
for name, prop in self._get_all_dbus_things("property"):
636
1430
if (interface_name
637
1431
and interface_name != prop._dbus_interface):
638
1432
# Interface non-empty but did not match
640
1434
# Ignore write-only properties
641
if prop._dbus_access == u"write":
1435
if prop._dbus_access == "write":
644
if not hasattr(value, u"variant_level"):
1438
if not hasattr(value, "variant_level"):
1439
properties[name] = value
647
all[name] = type(value)(value, variant_level=
648
value.variant_level+1)
649
return dbus.Dictionary(all, signature=u"sv")
1441
properties[name] = type(value)(
1442
value, variant_level=value.variant_level + 1)
1443
return dbus.Dictionary(properties, signature="sv")
1445
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1446
def PropertiesChanged(self, interface_name, changed_properties,
1447
invalidated_properties):
1448
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
651
1453
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
653
1455
path_keyword='object_path',
654
1456
connection_keyword='connection')
655
1457
def Introspect(self, object_path, connection):
656
"""Standard D-Bus method, overloaded to insert property tags.
1458
"""Overloading of standard D-Bus method.
1460
Inserts property tags and interface annotation tags.
658
xmlstring = dbus.service.Object.Introspect(self, object_path,
1462
xmlstring = DBusObjectWithAnnotations.Introspect(self,
661
1466
document = xml.dom.minidom.parseString(xmlstring)
662
1468
def make_tag(document, name, prop):
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)
1469
e = document.createElement("property")
1470
e.setAttribute("name", name)
1471
e.setAttribute("type", prop._dbus_signature)
1472
e.setAttribute("access", prop._dbus_access)
668
for if_tag in document.getElementsByTagName(u"interface"):
1475
for if_tag in document.getElementsByTagName("interface"):
669
1477
for tag in (make_tag(document, name, prop)
671
in self._get_all_dbus_properties()
1479
in self._get_all_dbus_things("property")
672
1480
if prop._dbus_interface
673
== if_tag.getAttribute(u"name")):
1481
== if_tag.getAttribute("name")):
674
1482
if_tag.appendChild(tag)
1483
# Add annotation tags for properties
1484
for tag in if_tag.getElementsByTagName("property"):
1486
for name, prop in self._get_all_dbus_things(
1488
if (name == tag.getAttribute("name")
1489
and prop._dbus_interface
1490
== if_tag.getAttribute("name")):
1491
annots.update(getattr(
1492
prop, "_dbus_annotations", {}))
1493
for name, value in annots.items():
1494
ann_tag = document.createElement(
1496
ann_tag.setAttribute("name", name)
1497
ann_tag.setAttribute("value", value)
1498
tag.appendChild(ann_tag)
675
1499
# Add the names to the return values for the
676
1500
# "org.freedesktop.DBus.Properties" methods
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",
1501
if (if_tag.getAttribute("name")
1502
== "org.freedesktop.DBus.Properties"):
1503
for cn in if_tag.getElementsByTagName("method"):
1504
if cn.getAttribute("name") == "Get":
1505
for arg in cn.getElementsByTagName("arg"):
1506
if (arg.getAttribute("direction")
1508
arg.setAttribute("name", "value")
1509
elif cn.getAttribute("name") == "GetAll":
1510
for arg in cn.getElementsByTagName("arg"):
1511
if (arg.getAttribute("direction")
1513
arg.setAttribute("name", "props")
1514
xmlstring = document.toxml("utf-8")
1516
except (AttributeError, xml.dom.DOMException,
1517
xml.parsers.expat.ExpatError) as error:
1518
logger.error("Failed to override Introspection method",
1524
dbus.OBJECT_MANAGER_IFACE
1525
except AttributeError:
1526
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1529
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1530
"""A D-Bus object with an ObjectManager.
1532
Classes inheriting from this exposes the standard
1533
GetManagedObjects call and the InterfacesAdded and
1534
InterfacesRemoved signals on the standard
1535
"org.freedesktop.DBus.ObjectManager" interface.
1537
Note: No signals are sent automatically; they must be sent
1540
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1541
out_signature="a{oa{sa{sv}}}")
1542
def GetManagedObjects(self):
1543
"""This function must be overridden"""
1544
raise NotImplementedError()
1546
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1547
signature="oa{sa{sv}}")
1548
def InterfacesAdded(self, object_path, interfaces_and_properties):
1551
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1552
def InterfacesRemoved(self, object_path, interfaces):
1555
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1557
path_keyword='object_path',
1558
connection_keyword='connection')
1559
def Introspect(self, object_path, connection):
1560
"""Overloading of standard D-Bus method.
1562
Override return argument name of GetManagedObjects to be
1563
"objpath_interfaces_and_properties"
1565
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1569
document = xml.dom.minidom.parseString(xmlstring)
1571
for if_tag in document.getElementsByTagName("interface"):
1572
# Fix argument name for the GetManagedObjects method
1573
if (if_tag.getAttribute("name")
1574
== dbus.OBJECT_MANAGER_IFACE):
1575
for cn in if_tag.getElementsByTagName("method"):
1576
if (cn.getAttribute("name")
1577
== "GetManagedObjects"):
1578
for arg in cn.getElementsByTagName("arg"):
1579
if (arg.getAttribute("direction")
1583
"objpath_interfaces"
1585
xmlstring = document.toxml("utf-8")
1587
except (AttributeError, xml.dom.DOMException,
1588
xml.parsers.expat.ExpatError) as error:
1589
logger.error("Failed to override Introspection method",
1594
def datetime_to_dbus(dt, variant_level=0):
1595
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1597
return dbus.String("", variant_level=variant_level)
1598
return dbus.String(dt.isoformat(), variant_level=variant_level)
1601
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1602
"""A class decorator; applied to a subclass of
1603
dbus.service.Object, it will add alternate D-Bus attributes with
1604
interface names according to the "alt_interface_names" mapping.
1607
@alternate_dbus_interfaces({"org.example.Interface":
1608
"net.example.AlternateInterface"})
1609
class SampleDBusObject(dbus.service.Object):
1610
@dbus.service.method("org.example.Interface")
1611
def SampleDBusMethod():
1614
The above "SampleDBusMethod" on "SampleDBusObject" will be
1615
reachable via two interfaces: "org.example.Interface" and
1616
"net.example.AlternateInterface", the latter of which will have
1617
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1618
"true", unless "deprecate" is passed with a False value.
1620
This works for methods and signals, and also for D-Bus properties
1621
(from DBusObjectWithProperties) and interfaces (from the
1622
dbus_interface_annotations decorator).
1626
for orig_interface_name, alt_interface_name in (
1627
alt_interface_names.items()):
1629
interface_names = set()
1630
# Go though all attributes of the class
1631
for attrname, attribute in inspect.getmembers(cls):
1632
# Ignore non-D-Bus attributes, and D-Bus attributes
1633
# with the wrong interface name
1634
if (not hasattr(attribute, "_dbus_interface")
1635
or not attribute._dbus_interface.startswith(
1636
orig_interface_name)):
1638
# Create an alternate D-Bus interface name based on
1640
alt_interface = attribute._dbus_interface.replace(
1641
orig_interface_name, alt_interface_name)
1642
interface_names.add(alt_interface)
1643
# Is this a D-Bus signal?
1644
if getattr(attribute, "_dbus_is_signal", False):
1645
# Extract the original non-method undecorated
1646
# function by black magic
1647
if sys.version_info.major == 2:
1648
nonmethod_func = (dict(
1649
zip(attribute.func_code.co_freevars,
1650
attribute.__closure__))
1651
["func"].cell_contents)
1653
nonmethod_func = (dict(
1654
zip(attribute.__code__.co_freevars,
1655
attribute.__closure__))
1656
["func"].cell_contents)
1657
# Create a new, but exactly alike, function
1658
# object, and decorate it to be a new D-Bus signal
1659
# with the alternate D-Bus interface name
1660
new_function = copy_function(nonmethod_func)
1661
new_function = (dbus.service.signal(
1663
attribute._dbus_signature)(new_function))
1664
# Copy annotations, if any
1666
new_function._dbus_annotations = dict(
1667
attribute._dbus_annotations)
1668
except AttributeError:
1671
# Define a creator of a function to call both the
1672
# original and alternate functions, so both the
1673
# original and alternate signals gets sent when
1674
# the function is called
1675
def fixscope(func1, func2):
1676
"""This function is a scope container to pass
1677
func1 and func2 to the "call_both" function
1678
outside of its arguments"""
1680
@functools.wraps(func2)
1681
def call_both(*args, **kwargs):
1682
"""This function will emit two D-Bus
1683
signals by calling func1 and func2"""
1684
func1(*args, **kwargs)
1685
func2(*args, **kwargs)
1686
# Make wrapper function look like a D-Bus
1688
for name, attr in inspect.getmembers(func2):
1689
if name.startswith("_dbus_"):
1690
setattr(call_both, name, attr)
1693
# Create the "call_both" function and add it to
1695
attr[attrname] = fixscope(attribute, new_function)
1696
# Is this a D-Bus method?
1697
elif getattr(attribute, "_dbus_is_method", False):
1698
# Create a new, but exactly alike, function
1699
# object. Decorate it to be a new D-Bus method
1700
# with the alternate D-Bus interface name. Add it
1703
dbus.service.method(
1705
attribute._dbus_in_signature,
1706
attribute._dbus_out_signature)
1707
(copy_function(attribute)))
1708
# Copy annotations, if any
1710
attr[attrname]._dbus_annotations = dict(
1711
attribute._dbus_annotations)
1712
except AttributeError:
1714
# Is this a D-Bus property?
1715
elif getattr(attribute, "_dbus_is_property", False):
1716
# Create a new, but exactly alike, function
1717
# object, and decorate it to be a new D-Bus
1718
# property with the alternate D-Bus interface
1719
# name. Add it to the class.
1720
attr[attrname] = (dbus_service_property(
1721
alt_interface, attribute._dbus_signature,
1722
attribute._dbus_access,
1723
attribute._dbus_get_args_options
1725
(copy_function(attribute)))
1726
# Copy annotations, if any
1728
attr[attrname]._dbus_annotations = dict(
1729
attribute._dbus_annotations)
1730
except AttributeError:
1732
# Is this a D-Bus interface?
1733
elif getattr(attribute, "_dbus_is_interface", False):
1734
# Create a new, but exactly alike, function
1735
# object. Decorate it to be a new D-Bus interface
1736
# with the alternate D-Bus interface name. Add it
1739
dbus_interface_annotations(alt_interface)
1740
(copy_function(attribute)))
1742
# Deprecate all alternate interfaces
1743
iname = "_AlternateDBusNames_interface_annotation{}"
1744
for interface_name in interface_names:
1746
@dbus_interface_annotations(interface_name)
1748
return {"org.freedesktop.DBus.Deprecated":
1750
# Find an unused name
1751
for aname in (iname.format(i)
1752
for i in itertools.count()):
1753
if aname not in attr:
1757
# Replace the class with a new subclass of it with
1758
# methods, signals, etc. as created above.
1759
if sys.version_info.major == 2:
1760
cls = type(b"{}Alternate".format(cls.__name__),
1763
cls = type("{}Alternate".format(cls.__name__),
1770
@alternate_dbus_interfaces({"se.recompile.Mandos":
1771
"se.bsnet.fukt.Mandos"})
699
1772
class ClientDBus(Client, DBusObjectWithProperties):
700
1773
"""A Client class using D-Bus
703
1776
dbus_object_path: dbus.ObjectPath
704
1777
bus: dbus.SystemBus()
1780
runtime_expansions = (Client.runtime_expansions
1781
+ ("dbus_object_path", ))
1783
_interface = "se.recompile.Mandos.Client"
706
1785
# dbus.service.Object doesn't use super(), so we can't either.
708
def __init__(self, bus = None, *args, **kwargs):
709
self._approvals_pending = 0
1787
def __init__(self, bus=None, *args, **kwargs):
711
1789
Client.__init__(self, *args, **kwargs)
712
1790
# Only now, when this client is initialized, can it show up on
714
self.dbus_object_path = (dbus.ObjectPath
716
+ self.name.replace(u".", u"_")))
1792
client_object_name = str(self.name).translate(
1793
{ord("."): ord("_"),
1794
ord("-"): ord("_")})
1795
self.dbus_object_path = dbus.ObjectPath(
1796
"/clients/" + client_object_name)
717
1797
DBusObjectWithProperties.__init__(self, self.bus,
718
1798
self.dbus_object_path)
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))
1800
def notifychangeproperty(transform_func, dbus_name,
1801
type_func=lambda x: x,
1803
invalidate_only=False,
1804
_interface=_interface):
1805
""" Modify a variable so that it's a property which announces
1806
its changes to DBus.
1808
transform_fun: Function that takes a value and a variant_level
1809
and transforms it to a D-Bus type.
1810
dbus_name: D-Bus name of the variable
1811
type_func: Function that transform the value before sending it
1812
to the D-Bus. Default: no transform
1813
variant_level: D-Bus variant level. Default: 1
1815
attrname = "_{}".format(dbus_name)
1817
def setter(self, value):
1818
if hasattr(self, "dbus_object_path"):
1819
if (not hasattr(self, attrname) or
1820
type_func(getattr(self, attrname, None))
1821
!= type_func(value)):
1823
self.PropertiesChanged(
1824
_interface, dbus.Dictionary(),
1825
dbus.Array((dbus_name, )))
1827
dbus_value = transform_func(
1829
variant_level=variant_level)
1830
self.PropertyChanged(dbus.String(dbus_name),
1832
self.PropertiesChanged(
1834
dbus.Dictionary({dbus.String(dbus_name):
1837
setattr(self, attrname, value)
1839
return property(lambda self: getattr(self, attrname), setter)
1841
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1842
approvals_pending = notifychangeproperty(dbus.Boolean,
1845
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1846
last_enabled = notifychangeproperty(datetime_to_dbus,
1848
checker = notifychangeproperty(
1849
dbus.Boolean, "CheckerRunning",
1850
type_func=lambda checker: checker is not None)
1851
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1853
last_checker_status = notifychangeproperty(dbus.Int16,
1854
"LastCheckerStatus")
1855
last_approval_request = notifychangeproperty(
1856
datetime_to_dbus, "LastApprovalRequest")
1857
approved_by_default = notifychangeproperty(dbus.Boolean,
1858
"ApprovedByDefault")
1859
approval_delay = notifychangeproperty(
1860
dbus.UInt64, "ApprovalDelay",
1861
type_func=lambda td: td.total_seconds() * 1000)
1862
approval_duration = notifychangeproperty(
1863
dbus.UInt64, "ApprovalDuration",
1864
type_func=lambda td: td.total_seconds() * 1000)
1865
host = notifychangeproperty(dbus.String, "Host")
1866
timeout = notifychangeproperty(
1867
dbus.UInt64, "Timeout",
1868
type_func=lambda td: td.total_seconds() * 1000)
1869
extended_timeout = notifychangeproperty(
1870
dbus.UInt64, "ExtendedTimeout",
1871
type_func=lambda td: td.total_seconds() * 1000)
1872
interval = notifychangeproperty(
1873
dbus.UInt64, "Interval",
1874
type_func=lambda td: td.total_seconds() * 1000)
1875
checker_command = notifychangeproperty(dbus.String, "Checker")
1876
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1877
invalidate_only=True)
1879
del notifychangeproperty
764
1881
def __del__(self, *args, **kwargs):
766
1883
self.remove_from_connection()
767
1884
except LookupError:
769
if hasattr(DBusObjectWithProperties, u"__del__"):
1886
if hasattr(DBusObjectWithProperties, "__del__"):
770
1887
DBusObjectWithProperties.__del__(self, *args, **kwargs)
771
1888
Client.__del__(self, *args, **kwargs)
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)
1890
def checker_callback(self, source, condition,
1891
connection, command, *args, **kwargs):
1892
ret = Client.checker_callback(self, source, condition,
1893
connection, command, *args,
1895
exitstatus = self.last_checker_status
782
1897
# Emit D-Bus signal
783
1898
self.CheckerCompleted(dbus.Int16(exitstatus),
784
dbus.Int64(condition),
1899
# This is specific to GNU libC
1900
dbus.Int64(exitstatus << 8),
785
1901
dbus.String(command))
787
1903
# Emit D-Bus signal
788
1904
self.CheckerCompleted(dbus.Int16(-1),
789
dbus.Int64(condition),
1906
# This is specific to GNU libC
1908
| self.last_checker_signal),
790
1909
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,
804
1912
def start_checker(self, *args, **kwargs):
805
old_checker = self.checker
806
if self.checker is not None:
807
old_checker_pid = self.checker.pid
809
old_checker_pid = None
1913
old_checker_pid = getattr(self.checker, "pid", None)
810
1914
r = Client.start_checker(self, *args, **kwargs)
811
1915
# Only if new checker process was started
812
1916
if (self.checker is not None
813
1917
and old_checker_pid != self.checker.pid):
814
1918
# Emit D-Bus signal
815
1919
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))
830
1922
def _reset_approved(self):
831
self._approved = None
1923
self.approved = None
834
1926
def approve(self, value=True):
1927
self.approved = value
1928
GLib.timeout_add(int(self.approval_duration.total_seconds()
1929
* 1000), self._reset_approved)
835
1930
self.send_changedstate()
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"
1932
# D-Bus methods, signals & properties
846
1938
# CheckerCompleted - signal
847
@dbus.service.signal(_interface, signature=u"nxs")
1939
@dbus.service.signal(_interface, signature="nxs")
848
1940
def CheckerCompleted(self, exitcode, waitstatus, command):
852
1944
# CheckerStarted - signal
853
@dbus.service.signal(_interface, signature=u"s")
1945
@dbus.service.signal(_interface, signature="s")
854
1946
def CheckerStarted(self, command):
858
1950
# PropertyChanged - signal
859
@dbus.service.signal(_interface, signature=u"sv")
1951
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1952
@dbus.service.signal(_interface, signature="sv")
860
1953
def PropertyChanged(self, property, value):
864
1957
# GotSecret - signal
865
1958
@dbus.service.signal(_interface)
866
1959
def GotSecret(self):
869
1962
server to mandos-client
873
1966
# Rejected - signal
874
@dbus.service.signal(_interface, signature=u"s")
1967
@dbus.service.signal(_interface, signature="s")
875
1968
def Rejected(self, reason):
879
1972
# NeedApproval - signal
880
@dbus.service.signal(_interface, signature=u"db")
1973
@dbus.service.signal(_interface, signature="tb")
881
1974
def NeedApproval(self, timeout, default):
1976
return self.need_approval()
887
1980
# Approve - method
888
@dbus.service.method(_interface, in_signature=u"b")
1981
@dbus.service.method(_interface, in_signature="b")
889
1982
def Approve(self, value):
890
1983
self.approve(value)
892
1985
# CheckedOK - method
893
1986
@dbus.service.method(_interface)
894
1987
def CheckedOK(self):
895
return self.checked_ok()
897
1990
# Enable - method
1991
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
898
1992
@dbus.service.method(_interface)
899
1993
def Enable(self):
903
1997
# StartChecker - method
1998
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
904
1999
@dbus.service.method(_interface)
905
2000
def StartChecker(self):
907
2002
self.start_checker()
909
2004
# Disable - method
2005
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
910
2006
@dbus.service.method(_interface)
911
2007
def Disable(self):
915
2011
# StopChecker - method
2012
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
916
2013
@dbus.service.method(_interface)
917
2014
def StopChecker(self):
918
2015
self.stop_checker()
922
# approved_pending - property
923
@dbus_service_property(_interface, signature=u"b", access=u"read")
924
def approved_pending_dbus_property(self):
2019
# ApprovalPending - property
2020
@dbus_service_property(_interface, signature="b", access="read")
2021
def ApprovalPending_dbus_property(self):
925
2022
return dbus.Boolean(bool(self.approvals_pending))
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):
2024
# ApprovedByDefault - property
2025
@dbus_service_property(_interface,
2028
def ApprovedByDefault_dbus_property(self, value=None):
2029
if value is None: # get
2030
return dbus.Boolean(self.approved_by_default)
2031
self.approved_by_default = bool(value)
2033
# ApprovalDelay - property
2034
@dbus_service_property(_interface,
2037
def ApprovalDelay_dbus_property(self, value=None):
2038
if value is None: # get
2039
return dbus.UInt64(self.approval_delay.total_seconds()
2041
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2043
# ApprovalDuration - property
2044
@dbus_service_property(_interface,
2047
def ApprovalDuration_dbus_property(self, value=None):
2048
if value is None: # get
2049
return dbus.UInt64(self.approval_duration.total_seconds()
2051
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2055
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2056
@dbus_service_property(_interface, signature="s", access="read")
2057
def Name_dbus_property(self):
949
2058
return dbus.String(self.name)
951
# fingerprint - property
952
@dbus_service_property(_interface, signature=u"s", access=u"read")
953
def fingerprint_dbus_property(self):
2062
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2063
@dbus_service_property(_interface, signature="s", access="read")
2064
def KeyID_dbus_property(self):
2065
return dbus.String(self.key_id)
2067
# Fingerprint - property
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
@dbus_service_property(_interface, signature="s", access="read")
2071
def Fingerprint_dbus_property(self):
954
2072
return dbus.String(self.fingerprint)
957
@dbus_service_property(_interface, signature=u"s",
959
def host_dbus_property(self, value=None):
2075
@dbus_service_property(_interface,
2078
def Host_dbus_property(self, value=None):
960
2079
if value is None: # get
961
2080
return dbus.String(self.host)
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):
2081
self.host = str(value)
2083
# Created - property
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
@dbus_service_property(_interface, signature="s", access="read")
2087
def Created_dbus_property(self):
2088
return datetime_to_dbus(self.created)
2090
# LastEnabled - property
2091
@dbus_service_property(_interface, signature="s", access="read")
2092
def LastEnabled_dbus_property(self):
2093
return datetime_to_dbus(self.last_enabled)
2095
# Enabled - property
2096
@dbus_service_property(_interface,
2099
def Enabled_dbus_property(self, value=None):
983
2100
if value is None: # get
984
2101
return dbus.Boolean(self.enabled)
990
# last_checked_ok - property
991
@dbus_service_property(_interface, signature=u"s",
993
def last_checked_ok_dbus_property(self, value=None):
2107
# LastCheckedOK - property
2108
@dbus_service_property(_interface,
2111
def LastCheckedOK_dbus_property(self, value=None):
994
2112
if value is not None:
995
2113
self.checked_ok()
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):
2115
return datetime_to_dbus(self.last_checked_ok)
2117
# LastCheckerStatus - property
2118
@dbus_service_property(_interface, signature="n", access="read")
2119
def LastCheckerStatus_dbus_property(self):
2120
return dbus.Int16(self.last_checker_status)
2122
# Expires - property
2123
@dbus_service_property(_interface, signature="s", access="read")
2124
def Expires_dbus_property(self):
2125
return datetime_to_dbus(self.expires)
2127
# LastApprovalRequest - property
2128
@dbus_service_property(_interface, signature="s", access="read")
2129
def LastApprovalRequest_dbus_property(self):
2130
return datetime_to_dbus(self.last_approval_request)
2132
# Timeout - property
2133
@dbus_service_property(_interface,
2136
def Timeout_dbus_property(self, value=None):
1006
2137
if value is None: # get
1007
return dbus.UInt64(self.timeout_milliseconds())
2138
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2139
old_timeout = self.timeout
1008
2140
self.timeout = datetime.timedelta(0, 0, 0, value)
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())
2141
# Reschedule disabling
2143
now = datetime.datetime.utcnow()
2144
self.expires += self.timeout - old_timeout
2145
if self.expires <= now:
2146
# The timeout has passed
2149
if (getattr(self, "disable_initiator_tag", None)
2152
GLib.source_remove(self.disable_initiator_tag)
2153
self.disable_initiator_tag = GLib.timeout_add(
2154
int((self.expires - now).total_seconds() * 1000),
2157
# ExtendedTimeout - property
2158
@dbus_service_property(_interface,
2161
def ExtendedTimeout_dbus_property(self, value=None):
2162
if value is None: # get
2163
return dbus.UInt64(self.extended_timeout.total_seconds()
2165
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2167
# Interval - property
2168
@dbus_service_property(_interface,
2171
def Interval_dbus_property(self, value=None):
2172
if value is None: # get
2173
return dbus.UInt64(self.interval.total_seconds() * 1000)
1036
2174
self.interval = datetime.timedelta(0, 0, 0, value)
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:
2175
if getattr(self, "checker_initiator_tag", None) is None:
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
2178
# Reschedule checker run
2179
GLib.source_remove(self.checker_initiator_tag)
2180
self.checker_initiator_tag = GLib.timeout_add(
2181
value, self.start_checker)
2182
self.start_checker() # Start one now, too
1048
# checker - property
1049
@dbus_service_property(_interface, signature=u"s",
1050
access=u"readwrite")
1051
def checker_dbus_property(self, value=None):
2184
# Checker - property
2185
@dbus_service_property(_interface,
2188
def Checker_dbus_property(self, value=None):
1052
2189
if value is None: # get
1053
2190
return dbus.String(self.checker_command)
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):
2191
self.checker_command = str(value)
2193
# CheckerRunning - property
2194
@dbus_service_property(_interface,
2197
def CheckerRunning_dbus_property(self, value=None):
1064
2198
if value is None: # get
1065
2199
return dbus.Boolean(self.checker is not None)
1067
2201
self.start_checker()
1069
2203
self.stop_checker()
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)
2205
# ObjectPath - property
2207
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2208
"org.freedesktop.DBus.Deprecated": "true"})
2209
@dbus_service_property(_interface, signature="o", access="read")
2210
def ObjectPath_dbus_property(self):
2211
return self.dbus_object_path # is already a dbus.ObjectPath
2215
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2217
@dbus_service_property(_interface,
2221
def Secret_dbus_property(self, value):
2222
self.secret = bytes(value)
1085
class ProxyClient(object):
1086
def __init__(self, child_pipe, fpr, address):
2228
def __init__(self, child_pipe, key_id, fpr, address):
1087
2229
self._pipe = child_pipe
1088
self._pipe.send(('init', fpr, address))
2230
self._pipe.send(('init', key_id, fpr, address))
1089
2231
if not self._pipe.recv():
2232
raise KeyError(key_id or fpr)
1092
2234
def __getattribute__(self, name):
1093
if(name == '_pipe'):
1094
2236
return super(ProxyClient, self).__getattribute__(name)
1095
2237
self._pipe.send(('getattr', name))
1096
2238
data = self._pipe.recv()
1097
2239
if data[0] == 'data':
1099
2241
if data[0] == 'function':
1100
2243
def func(*args, **kwargs):
1101
2244
self._pipe.send(('funcall', name, args, kwargs))
1102
2245
return self._pipe.recv()[1]
1105
2249
def __setattr__(self, name, value):
1106
if(name == '_pipe'):
1107
2251
return super(ProxyClient, self).__setattr__(name, value)
1108
2252
self._pipe.send(('setattr', name, value))
1111
2255
class ClientHandler(socketserver.BaseRequestHandler, object):
1112
2256
"""A class to handle client connections.
1114
2258
Instantiated once for each connection to handle it.
1115
2259
Note: This will run in its own forked process."""
1117
2261
def handle(self):
1118
2262
with contextlib.closing(self.server.child_pipe) as child_pipe:
1119
logger.info(u"TCP connection from: %s",
1120
unicode(self.client_address))
1121
logger.debug(u"Pipe FD: %d",
2263
logger.info("TCP connection from: %s",
2264
str(self.client_address))
2265
logger.debug("Pipe FD: %d",
1122
2266
self.server.child_pipe.fileno())
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",
2268
session = gnutls.ClientSession(self.request)
2270
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2271
# "+AES-256-CBC", "+SHA1",
2272
# "+COMP-NULL", "+CTYPE-OPENPGP",
1138
2274
# Use a fallback default, since this MUST be set.
1139
2275
priority = self.server.gnutls_priority
1140
2276
if priority is None:
1141
priority = u"NORMAL"
1142
(gnutls.library.functions
1143
.gnutls_priority_set_direct(session._c_object,
2278
gnutls.priority_set_direct(session._c_object,
2279
priority.encode("utf-8"),
1146
2282
# Start communication using the Mandos protocol
1147
2283
# Get protocol number
1148
2284
line = self.request.makefile().readline()
1149
logger.debug(u"Protocol version: %r", line)
2285
logger.debug("Protocol version: %r", line)
1151
2287
if int(line.strip().split()[0]) > 1:
1153
except (ValueError, IndexError, RuntimeError), error:
1154
logger.error(u"Unknown protocol version: %s", error)
2288
raise RuntimeError(line)
2289
except (ValueError, IndexError, RuntimeError) as error:
2290
logger.error("Unknown protocol version: %s", error)
1157
2293
# Start GnuTLS connection
1159
2295
session.handshake()
1160
except gnutls.errors.GNUTLSError, error:
1161
logger.warning(u"Handshake failed: %s", error)
2296
except gnutls.Error as error:
2297
logger.warning("Handshake failed: %s", error)
1162
2298
# Do not run session.bye() here: the session is not
1163
2299
# established. Just abandon the request.
1165
logger.debug(u"Handshake succeeded")
2301
logger.debug("Handshake succeeded")
1167
2303
approval_required = False
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,
2305
if gnutls.has_rawpk:
2308
key_id = self.key_id(
2309
self.peer_certificate(session))
2310
except (TypeError, gnutls.Error) as error:
2311
logger.warning("Bad certificate: %s", error)
2313
logger.debug("Key ID: %s", key_id)
2318
fpr = self.fingerprint(
2319
self.peer_certificate(session))
2320
except (TypeError, gnutls.Error) as error:
2321
logger.warning("Bad certificate: %s", error)
2323
logger.debug("Fingerprint: %s", fpr)
2326
client = ProxyClient(child_pipe, key_id, fpr,
1179
2327
self.client_address)
1180
2328
except KeyError:
1183
if client.approved_delay:
1184
delay = client.approved_delay
2331
if client.approval_delay:
2332
delay = client.approval_delay
1185
2333
client.approvals_pending += 1
1186
2334
approval_required = True
1189
2337
if not client.enabled:
1190
logger.warning(u"Client %s is disabled",
2338
logger.info("Client %s is disabled",
1192
2340
if self.server.use_dbus:
1193
2341
# Emit D-Bus signal
1194
client.Rejected("Disabled")
2342
client.Rejected("Disabled")
1197
if client._approved or not client.approved_delay:
1198
#We are approved or approval is disabled
2345
if client.approved or not client.approval_delay:
2346
# We are approved or approval is disabled
1200
elif client._approved is None:
1201
logger.info(u"Client %s need approval",
2348
elif client.approved is None:
2349
logger.info("Client %s needs approval",
1203
2351
if self.server.use_dbus:
1204
2352
# Emit D-Bus signal
1205
2353
client.NeedApproval(
1206
client.approved_delay_milliseconds(),
1207
client.approved_by_default)
2354
client.approval_delay.total_seconds()
2355
* 1000, client.approved_by_default)
1209
logger.warning(u"Client %s was not approved",
2357
logger.warning("Client %s was not approved",
1211
2359
if self.server.use_dbus:
1212
2360
# Emit D-Bus signal
1213
client.Rejected("Disapproved")
2361
client.Rejected("Denied")
1216
#wait until timeout or approved
1217
#x = float(client._timedelta_to_milliseconds(delay))
2364
# wait until timeout or approved
1218
2365
time = datetime.datetime.now()
1219
2366
client.changedstate.acquire()
1220
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2367
client.changedstate.wait(delay.total_seconds())
1221
2368
client.changedstate.release()
1222
2369
time2 = datetime.datetime.now()
1223
2370
if (time2 - time) >= delay:
1228
2375
if self.server.use_dbus:
1229
2376
# Emit D-Bus signal
1230
client.Rejected("Time out")
2377
client.Rejected("Approval timed out")
1235
2382
delay -= time2 - time
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
2385
session.send(client.secret)
2386
except gnutls.Error as error:
2387
logger.warning("gnutls send failed",
2391
logger.info("Sending secret to %s", client.name)
2392
# bump the timeout using extended_timeout
2393
client.bump_timeout(client.extended_timeout)
1252
2394
if self.server.use_dbus:
1253
2395
# Emit D-Bus signal
1254
2396
client.GotSecret()
1257
2399
if approval_required:
1258
2400
client.approvals_pending -= 1
1261
except (gnutls.errors.GNUTLSError), error:
1262
logger.warning("gnutls bye failed")
2403
except gnutls.Error as error:
2404
logger.warning("GnuTLS bye failed",
1265
2408
def peer_certificate(session):
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
2409
"Return the peer's certificate as a bytestring"
2411
cert_type = gnutls.certificate_type_get2(session._c_object,
2413
except AttributeError:
2414
cert_type = gnutls.certificate_type_get(session._c_object)
2415
if gnutls.has_rawpk:
2416
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2418
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2419
# If not a valid certificate type...
2420
if cert_type not in valid_cert_types:
2421
logger.info("Cert type %r not in %r", cert_type,
2423
# ...return invalid data
1273
2425
list_size = ctypes.c_uint(1)
1274
cert_list = (gnutls.library.functions
1275
.gnutls_certificate_get_peers
2426
cert_list = (gnutls.certificate_get_peers
1276
2427
(session._c_object, ctypes.byref(list_size)))
1277
2428
if not bool(cert_list) and list_size.value != 0:
1278
raise gnutls.errors.GNUTLSError(u"error getting peer"
2429
raise gnutls.Error("error getting peer certificate")
1280
2430
if list_size.value == 0:
1282
2432
cert = cert_list[0]
1283
2433
return ctypes.string_at(cert.data, cert.size)
2436
def key_id(certificate):
2437
"Convert a certificate bytestring to a hexdigit key ID"
2438
# New GnuTLS "datum" with the public key
2439
datum = gnutls.datum_t(
2440
ctypes.cast(ctypes.c_char_p(certificate),
2441
ctypes.POINTER(ctypes.c_ubyte)),
2442
ctypes.c_uint(len(certificate)))
2443
# XXX all these need to be created in the gnutls "module"
2444
# New empty GnuTLS certificate
2445
pubkey = gnutls.pubkey_t()
2446
gnutls.pubkey_init(ctypes.byref(pubkey))
2447
# Import the raw public key into the certificate
2448
gnutls.pubkey_import(pubkey,
2449
ctypes.byref(datum),
2450
gnutls.X509_FMT_DER)
2451
# New buffer for the key ID
2452
buf = ctypes.create_string_buffer(32)
2453
buf_len = ctypes.c_size_t(len(buf))
2454
# Get the key ID from the raw public key into the buffer
2455
gnutls.pubkey_get_key_id(pubkey,
2456
gnutls.KEYID_USE_SHA256,
2457
ctypes.cast(ctypes.byref(buf),
2458
ctypes.POINTER(ctypes.c_ubyte)),
2459
ctypes.byref(buf_len))
2460
# Deinit the certificate
2461
gnutls.pubkey_deinit(pubkey)
2463
# Convert the buffer to a Python bytestring
2464
key_id = ctypes.string_at(buf, buf_len.value)
2465
# Convert the bytestring to hexadecimal notation
2466
hex_key_id = binascii.hexlify(key_id).upper()
1286
2470
def fingerprint(openpgp):
1287
2471
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1288
2472
# New GnuTLS "datum" with the OpenPGP public key
1289
datum = (gnutls.library.types
1290
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1293
ctypes.c_uint(len(openpgp))))
2473
datum = gnutls.datum_t(
2474
ctypes.cast(ctypes.c_char_p(openpgp),
2475
ctypes.POINTER(ctypes.c_ubyte)),
2476
ctypes.c_uint(len(openpgp)))
1294
2477
# New empty GnuTLS certificate
1295
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1296
(gnutls.library.functions
1297
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2478
crt = gnutls.openpgp_crt_t()
2479
gnutls.openpgp_crt_init(ctypes.byref(crt))
1298
2480
# Import the OpenPGP public key into the certificate
1299
(gnutls.library.functions
1300
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1301
gnutls.library.constants
1302
.GNUTLS_OPENPGP_FMT_RAW))
2481
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2482
gnutls.OPENPGP_FMT_RAW)
1303
2483
# Verify the self signature in the key
1304
2484
crtverify = ctypes.c_uint()
1305
(gnutls.library.functions
1306
.gnutls_openpgp_crt_verify_self(crt, 0,
1307
ctypes.byref(crtverify)))
2485
gnutls.openpgp_crt_verify_self(crt, 0,
2486
ctypes.byref(crtverify))
1308
2487
if crtverify.value != 0:
1309
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1310
raise (gnutls.errors.CertificateSecurityError
2488
gnutls.openpgp_crt_deinit(crt)
2489
raise gnutls.CertificateSecurityError(code
1312
2491
# New buffer for the fingerprint
1313
2492
buf = ctypes.create_string_buffer(20)
1314
2493
buf_len = ctypes.c_size_t()
1315
2494
# Get the fingerprint from the certificate into the buffer
1316
(gnutls.library.functions
1317
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1318
ctypes.byref(buf_len)))
2495
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2496
ctypes.byref(buf_len))
1319
2497
# Deinit the certificate
1320
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2498
gnutls.openpgp_crt_deinit(crt)
1321
2499
# Convert the buffer to a Python bytestring
1322
2500
fpr = ctypes.string_at(buf, buf_len.value)
1323
2501
# Convert the bytestring to hexadecimal notation
1324
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2502
hex_fpr = binascii.hexlify(fpr).upper()
1328
class MultiprocessingMixIn(object):
2506
class MultiprocessingMixIn:
1329
2507
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1330
2509
def sub_process_main(self, request, address):
1332
2511
self.finish_request(request, address)
1334
2513
self.handle_error(request, address)
1335
2514
self.close_request(request)
1337
2516
def process_request(self, request, address):
1338
2517
"""Start a new process to process the request."""
1339
multiprocessing.Process(target = self.sub_process_main,
1340
args = (request, address)).start()
1342
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2518
proc = multiprocessing.Process(target=self.sub_process_main,
2519
args=(request, address))
2524
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1343
2525
""" adds a pipe to the MixIn """
1344
2527
def process_request(self, request, client_address):
1345
2528
"""Overrides and wraps the original process_request().
1347
2530
This function creates a new pipe in self.pipe
1349
2532
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1351
super(MultiprocessingMixInWithPipe,
1352
self).process_request(request, client_address)
2534
proc = MultiprocessingMixIn.process_request(self, request,
1353
2536
self.child_pipe.close()
1354
self.add_pipe(parent_pipe)
2537
self.add_pipe(parent_pipe, proc)
1356
def add_pipe(self, parent_pipe):
2539
def add_pipe(self, parent_pipe, proc):
1357
2540
"""Dummy function; override as necessary"""
2541
raise NotImplementedError()
1360
2544
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1361
socketserver.TCPServer, object):
2545
socketserver.TCPServer):
1362
2546
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1365
2549
enabled: Boolean; whether this server is activated yet
1366
2550
interface: None or a network interface name (string)
1367
2551
use_ipv6: Boolean; to use IPv6 or not
1369
2554
def __init__(self, server_address, RequestHandlerClass,
1370
interface=None, use_ipv6=True):
2558
"""If socketfd is set, use that file descriptor instead of
2559
creating a new one with socket.socket().
1371
2561
self.interface = interface
1373
2563
self.address_family = socket.AF_INET6
2564
if socketfd is not None:
2565
# Save the file descriptor
2566
self.socketfd = socketfd
2567
# Save the original socket.socket() function
2568
self.socket_socket = socket.socket
2570
# To implement --socket, we monkey patch socket.socket.
2572
# (When socketserver.TCPServer is a new-style class, we
2573
# could make self.socket into a property instead of monkey
2574
# patching socket.socket.)
2576
# Create a one-time-only replacement for socket.socket()
2577
@functools.wraps(socket.socket)
2578
def socket_wrapper(*args, **kwargs):
2579
# Restore original function so subsequent calls are
2581
socket.socket = self.socket_socket
2582
del self.socket_socket
2583
# This time only, return a new socket object from the
2584
# saved file descriptor.
2585
return socket.fromfd(self.socketfd, *args, **kwargs)
2586
# Replace socket.socket() function with wrapper
2587
socket.socket = socket_wrapper
2588
# The socketserver.TCPServer.__init__ will call
2589
# socket.socket(), which might be our replacement,
2590
# socket_wrapper(), if socketfd was set.
1374
2591
socketserver.TCPServer.__init__(self, server_address,
1375
2592
RequestHandlerClass)
1376
2594
def server_bind(self):
1377
2595
"""This overrides the normal server_bind() function
1378
2596
to bind to an interface if one was specified, and also NOT to
1379
2597
bind to an address or port if they were not specified."""
2598
global SO_BINDTODEVICE
1380
2599
if self.interface is not None:
1381
2600
if SO_BINDTODEVICE is None:
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",
2601
# Fall back to a hard-coded value which seems to be
2603
logger.warning("SO_BINDTODEVICE not found, trying 25")
2604
SO_BINDTODEVICE = 25
2606
self.socket.setsockopt(
2607
socket.SOL_SOCKET, SO_BINDTODEVICE,
2608
(self.interface + "\0").encode("utf-8"))
2609
except socket.error as error:
2610
if error.errno == errno.EPERM:
2611
logger.error("No permission to bind to"
2612
" interface %s", self.interface)
2613
elif error.errno == errno.ENOPROTOOPT:
2614
logger.error("SO_BINDTODEVICE not available;"
2615
" cannot bind to interface %s",
2617
elif error.errno == errno.ENODEV:
2618
logger.error("Interface %s does not exist,"
2619
" cannot bind", self.interface)
1402
2622
# Only bind(2) the socket if we really need to.
1403
2623
if self.server_address[0] or self.server_address[1]:
2624
if self.server_address[1]:
2625
self.allow_reuse_address = True
1404
2626
if not self.server_address[0]:
1405
2627
if self.address_family == socket.AF_INET6:
1406
any_address = u"::" # in6addr_any
2628
any_address = "::" # in6addr_any
1408
any_address = socket.INADDR_ANY
2630
any_address = "0.0.0.0" # INADDR_ANY
1409
2631
self.server_address = (any_address,
1410
2632
self.server_address[1])
1411
2633
elif not self.server_address[1]:
1412
self.server_address = (self.server_address[0],
2634
self.server_address = (self.server_address[0], 0)
1414
2635
# if self.interface:
1415
2636
# self.server_address = (self.server_address[0],
2765
def rfc3339_duration_to_delta(duration):
2766
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2768
>>> rfc3339_duration_to_delta("P7D")
2769
datetime.timedelta(7)
2770
>>> rfc3339_duration_to_delta("PT60S")
2771
datetime.timedelta(0, 60)
2772
>>> rfc3339_duration_to_delta("PT60M")
2773
datetime.timedelta(0, 3600)
2774
>>> rfc3339_duration_to_delta("PT24H")
2775
datetime.timedelta(1)
2776
>>> rfc3339_duration_to_delta("P1W")
2777
datetime.timedelta(7)
2778
>>> rfc3339_duration_to_delta("PT5M30S")
2779
datetime.timedelta(0, 330)
2780
>>> rfc3339_duration_to_delta("P1DT3M20S")
2781
datetime.timedelta(1, 200)
2784
# Parsing an RFC 3339 duration with regular expressions is not
2785
# possible - there would have to be multiple places for the same
2786
# values, like seconds. The current code, while more esoteric, is
2787
# cleaner without depending on a parsing library. If Python had a
2788
# built-in library for parsing we would use it, but we'd like to
2789
# avoid excessive use of external libraries.
2791
# New type for defining tokens, syntax, and semantics all-in-one
2792
Token = collections.namedtuple("Token", (
2793
"regexp", # To match token; if "value" is not None, must have
2794
# a "group" containing digits
2795
"value", # datetime.timedelta or None
2796
"followers")) # Tokens valid after this token
2797
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2798
# the "duration" ABNF definition in RFC 3339, Appendix A.
2799
token_end = Token(re.compile(r"$"), None, frozenset())
2800
token_second = Token(re.compile(r"(\d+)S"),
2801
datetime.timedelta(seconds=1),
2802
frozenset((token_end, )))
2803
token_minute = Token(re.compile(r"(\d+)M"),
2804
datetime.timedelta(minutes=1),
2805
frozenset((token_second, token_end)))
2806
token_hour = Token(re.compile(r"(\d+)H"),
2807
datetime.timedelta(hours=1),
2808
frozenset((token_minute, token_end)))
2809
token_time = Token(re.compile(r"T"),
2811
frozenset((token_hour, token_minute,
2813
token_day = Token(re.compile(r"(\d+)D"),
2814
datetime.timedelta(days=1),
2815
frozenset((token_time, token_end)))
2816
token_month = Token(re.compile(r"(\d+)M"),
2817
datetime.timedelta(weeks=4),
2818
frozenset((token_day, token_end)))
2819
token_year = Token(re.compile(r"(\d+)Y"),
2820
datetime.timedelta(weeks=52),
2821
frozenset((token_month, token_end)))
2822
token_week = Token(re.compile(r"(\d+)W"),
2823
datetime.timedelta(weeks=1),
2824
frozenset((token_end, )))
2825
token_duration = Token(re.compile(r"P"), None,
2826
frozenset((token_year, token_month,
2827
token_day, token_time,
2829
# Define starting values:
2831
value = datetime.timedelta()
2833
# Following valid tokens
2834
followers = frozenset((token_duration, ))
2835
# String left to parse
2837
# Loop until end token is found
2838
while found_token is not token_end:
2839
# Search for any currently valid tokens
2840
for token in followers:
2841
match = token.regexp.match(s)
2842
if match is not None:
2844
if token.value is not None:
2845
# Value found, parse digits
2846
factor = int(match.group(1), 10)
2847
# Add to value so far
2848
value += factor * token.value
2849
# Strip token from string
2850
s = token.regexp.sub("", s, 1)
2853
# Set valid next tokens
2854
followers = found_token.followers
2857
# No currently valid tokens were found
2858
raise ValueError("Invalid RFC 3339 duration: {!r}"
1533
2864
def string_to_delta(interval):
1534
2865
"""Parse a string and return a datetime.timedelta
1536
>>> string_to_delta(u'7d')
2867
>>> string_to_delta('7d')
1537
2868
datetime.timedelta(7)
1538
>>> string_to_delta(u'60s')
2869
>>> string_to_delta('60s')
1539
2870
datetime.timedelta(0, 60)
1540
>>> string_to_delta(u'60m')
2871
>>> string_to_delta('60m')
1541
2872
datetime.timedelta(0, 3600)
1542
>>> string_to_delta(u'24h')
2873
>>> string_to_delta('24h')
1543
2874
datetime.timedelta(1)
1544
>>> string_to_delta(u'1w')
2875
>>> string_to_delta('1w')
1545
2876
datetime.timedelta(7)
1546
>>> string_to_delta(u'5m 30s')
2877
>>> string_to_delta('5m 30s')
1547
2878
datetime.timedelta(0, 330)
2882
return rfc3339_duration_to_delta(interval)
1549
2886
timevalue = datetime.timedelta(0)
1550
2887
for s in interval.split():
1552
suffix = unicode(s[-1])
1553
2890
value = int(s[:-1])
1555
2892
delta = datetime.timedelta(value)
1556
elif suffix == u"s":
1557
2894
delta = datetime.timedelta(0, value)
1558
elif suffix == u"m":
1559
2896
delta = datetime.timedelta(0, 0, 0, 0, value)
1560
elif suffix == u"h":
1561
2898
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1562
elif suffix == u"w":
1563
2900
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1565
raise ValueError(u"Unknown suffix %r" % suffix)
1566
except (ValueError, IndexError), e:
1567
raise ValueError(e.message)
2902
raise ValueError("Unknown suffix {!r}".format(suffix))
2903
except IndexError as e:
2904
raise ValueError(*(e.args))
1568
2905
timevalue += delta
1569
2906
return timevalue
1572
def if_nametoindex(interface):
1573
"""Call the C function if_nametoindex(), or equivalent
1575
Note: This function cannot accept a unicode string."""
1576
global if_nametoindex
1578
if_nametoindex = (ctypes.cdll.LoadLibrary
1579
(ctypes.util.find_library(u"c"))
1581
except (OSError, AttributeError):
1582
logger.warning(u"Doing if_nametoindex the hard way")
1583
def if_nametoindex(interface):
1584
"Get an interface index the hard way, i.e. using fcntl()"
1585
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1586
with contextlib.closing(socket.socket()) as s:
1587
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1588
struct.pack(str(u"16s16x"),
1590
interface_index = struct.unpack(str(u"I"),
1592
return interface_index
1593
return if_nametoindex(interface)
1596
def daemon(nochdir = False, noclose = False):
2909
def daemon(nochdir=False, noclose=False):
1597
2910
"""See daemon(3). Standard BSD Unix function.
1599
2912
This should really exist as os.daemon, but it doesn't (yet)."""
1603
2916
if not nochdir:
1607
2920
if not noclose:
1608
2921
# Close all standard open file descriptors
1609
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2922
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1610
2923
if not stat.S_ISCHR(os.fstat(null).st_mode):
1611
2924
raise OSError(errno.ENODEV,
1612
u"%s not a character device"
2925
"{} not a character device"
2926
.format(os.devnull))
1614
2927
os.dup2(null, sys.stdin.fileno())
1615
2928
os.dup2(null, sys.stdout.fileno())
1616
2929
os.dup2(null, sys.stderr.fileno())
1623
2936
##################################################################
1624
2937
# Parsing of options, both command line and config file
1626
parser = optparse.OptionParser(version = "%%prog %s" % version)
1627
parser.add_option("-i", u"--interface", type=u"string",
1628
metavar="IF", help=u"Bind to interface IF")
1629
parser.add_option("-a", u"--address", type=u"string",
1630
help=u"Address to listen for requests on")
1631
parser.add_option("-p", u"--port", type=u"int",
1632
help=u"Port number to receive requests on")
1633
parser.add_option("--check", action=u"store_true",
1634
help=u"Run self-test")
1635
parser.add_option("--debug", action=u"store_true",
1636
help=u"Debug mode; run in foreground and log to"
1638
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1639
help=u"Debug level for stdout output")
1640
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1641
u" priority string (see GnuTLS documentation)")
1642
parser.add_option("--servicename", type=u"string",
1643
metavar=u"NAME", help=u"Zeroconf service name")
1644
parser.add_option("--configdir", type=u"string",
1645
default=u"/etc/mandos", metavar=u"DIR",
1646
help=u"Directory to search for configuration"
1648
parser.add_option("--no-dbus", action=u"store_false",
1649
dest=u"use_dbus", help=u"Do not provide D-Bus"
1650
u" system bus interface")
1651
parser.add_option("--no-ipv6", action=u"store_false",
1652
dest=u"use_ipv6", help=u"Do not use IPv6")
1653
options = parser.parse_args()[0]
2939
parser = argparse.ArgumentParser()
2940
parser.add_argument("-v", "--version", action="version",
2941
version="%(prog)s {}".format(version),
2942
help="show version number and exit")
2943
parser.add_argument("-i", "--interface", metavar="IF",
2944
help="Bind to interface IF")
2945
parser.add_argument("-a", "--address",
2946
help="Address to listen for requests on")
2947
parser.add_argument("-p", "--port", type=int,
2948
help="Port number to receive requests on")
2949
parser.add_argument("--check", action="store_true",
2950
help="Run self-test")
2951
parser.add_argument("--debug", action="store_true",
2952
help="Debug mode; run in foreground and log"
2953
" to terminal", default=None)
2954
parser.add_argument("--debuglevel", metavar="LEVEL",
2955
help="Debug level for stdout output")
2956
parser.add_argument("--priority", help="GnuTLS"
2957
" priority string (see GnuTLS documentation)")
2958
parser.add_argument("--servicename",
2959
metavar="NAME", help="Zeroconf service name")
2960
parser.add_argument("--configdir",
2961
default="/etc/mandos", metavar="DIR",
2962
help="Directory to search for configuration"
2964
parser.add_argument("--no-dbus", action="store_false",
2965
dest="use_dbus", help="Do not provide D-Bus"
2966
" system bus interface", default=None)
2967
parser.add_argument("--no-ipv6", action="store_false",
2968
dest="use_ipv6", help="Do not use IPv6",
2970
parser.add_argument("--no-restore", action="store_false",
2971
dest="restore", help="Do not restore stored"
2972
" state", default=None)
2973
parser.add_argument("--socket", type=int,
2974
help="Specify a file descriptor to a network"
2975
" socket to use instead of creating one")
2976
parser.add_argument("--statedir", metavar="DIR",
2977
help="Directory to save/restore state in")
2978
parser.add_argument("--foreground", action="store_true",
2979
help="Run in foreground", default=None)
2980
parser.add_argument("--no-zeroconf", action="store_false",
2981
dest="zeroconf", help="Do not use Zeroconf",
2984
options = parser.parse_args()
1660
2986
# Default values for config file for server-global settings
1661
server_defaults = { u"interface": u"",
1666
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1667
u"servicename": u"Mandos",
1668
u"use_dbus": u"True",
1669
u"use_ipv6": u"True",
2987
if gnutls.has_rawpk:
2988
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2989
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2991
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2992
":+SIGN-DSA-SHA256")
2993
server_defaults = {"interface": "",
2997
"priority": priority,
2998
"servicename": "Mandos",
3004
"statedir": "/var/lib/mandos",
3005
"foreground": "False",
1673
3010
# Parse config file for server-global settings
1674
server_config = configparser.SafeConfigParser(server_defaults)
3011
server_config = configparser.ConfigParser(server_defaults)
1675
3012
del server_defaults
1676
server_config.read(os.path.join(options.configdir,
1678
# Convert the SafeConfigParser object to a dict
3013
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3014
# Convert the ConfigParser object to a dict
1679
3015
server_settings = server_config.defaults()
1680
3016
# Use the appropriate methods on the non-string config options
1681
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1682
server_settings[option] = server_config.getboolean(u"DEFAULT",
3017
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3018
"foreground", "zeroconf"):
3019
server_settings[option] = server_config.getboolean("DEFAULT",
1684
3021
if server_settings["port"]:
1685
server_settings["port"] = server_config.getint(u"DEFAULT",
3022
server_settings["port"] = server_config.getint("DEFAULT",
3024
if server_settings["socket"]:
3025
server_settings["socket"] = server_config.getint("DEFAULT",
3027
# Later, stdin will, and stdout and stderr might, be dup'ed
3028
# over with an opened os.devnull. But we don't want this to
3029
# happen with a supplied network socket.
3030
if 0 <= server_settings["socket"] <= 2:
3031
server_settings["socket"] = os.dup(server_settings
1687
3033
del server_config
1689
3035
# Override the settings from the config file with command line
1690
3036
# options, if set.
1691
for option in (u"interface", u"address", u"port", u"debug",
1692
u"priority", u"servicename", u"configdir",
1693
u"use_dbus", u"use_ipv6", u"debuglevel"):
3037
for option in ("interface", "address", "port", "debug",
3038
"priority", "servicename", "configdir", "use_dbus",
3039
"use_ipv6", "debuglevel", "restore", "statedir",
3040
"socket", "foreground", "zeroconf"):
1694
3041
value = getattr(options, option)
1695
3042
if value is not None:
1696
3043
server_settings[option] = value
1698
3045
# Force all strings to be unicode
1699
3046
for option in server_settings.keys():
1700
if type(server_settings[option]) is str:
1701
server_settings[option] = unicode(server_settings[option])
3047
if isinstance(server_settings[option], bytes):
3048
server_settings[option] = (server_settings[option]
3050
# Force all boolean options to be boolean
3051
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3052
"foreground", "zeroconf"):
3053
server_settings[option] = bool(server_settings[option])
3054
# Debug implies foreground
3055
if server_settings["debug"]:
3056
server_settings["foreground"] = True
1702
3057
# Now we have our good server settings in "server_settings"
1704
3059
##################################################################
3061
if (not server_settings["zeroconf"]
3062
and not (server_settings["port"]
3063
or server_settings["socket"] != "")):
3064
parser.error("Needs port or socket to work without Zeroconf")
1706
3066
# For convenience
1707
debug = server_settings[u"debug"]
1708
debuglevel = server_settings[u"debuglevel"]
1709
use_dbus = server_settings[u"use_dbus"]
1710
use_ipv6 = server_settings[u"use_ipv6"]
1712
if server_settings[u"servicename"] != u"Mandos":
1713
syslogger.setFormatter(logging.Formatter
1714
(u'Mandos (%s) [%%(process)d]:'
1715
u' %%(levelname)s: %%(message)s'
1716
% server_settings[u"servicename"]))
3067
debug = server_settings["debug"]
3068
debuglevel = server_settings["debuglevel"]
3069
use_dbus = server_settings["use_dbus"]
3070
use_ipv6 = server_settings["use_ipv6"]
3071
stored_state_path = os.path.join(server_settings["statedir"],
3073
foreground = server_settings["foreground"]
3074
zeroconf = server_settings["zeroconf"]
3077
initlogger(debug, logging.DEBUG)
3082
level = getattr(logging, debuglevel.upper())
3083
initlogger(debug, level)
3085
if server_settings["servicename"] != "Mandos":
3086
syslogger.setFormatter(
3087
logging.Formatter('Mandos ({}) [%(process)d]:'
3088
' %(levelname)s: %(message)s'.format(
3089
server_settings["servicename"])))
1718
3091
# Parse config file with clients
1719
client_defaults = { u"timeout": u"1h",
1721
u"checker": u"fping -q -- %%(host)s",
1723
u"approved_delay": u"0s",
1724
u"approved_duration": u"1s",
1726
client_config = configparser.SafeConfigParser(client_defaults)
1727
client_config.read(os.path.join(server_settings[u"configdir"],
3092
client_config = configparser.ConfigParser(Client.client_defaults)
3093
client_config.read(os.path.join(server_settings["configdir"],
1730
3096
global mandos_dbus_service
1731
3097
mandos_dbus_service = None
1733
tcp_server = MandosServer((server_settings[u"address"],
1734
server_settings[u"port"]),
1736
interface=(server_settings[u"interface"]
1740
server_settings[u"priority"],
1742
pidfilename = u"/var/run/mandos.pid"
1744
pidfile = open(pidfilename, u"w")
1746
logger.error(u"Could not open file %r", pidfilename)
1749
uid = pwd.getpwnam(u"_mandos").pw_uid
1750
gid = pwd.getpwnam(u"_mandos").pw_gid
1753
uid = pwd.getpwnam(u"mandos").pw_uid
1754
gid = pwd.getpwnam(u"mandos").pw_gid
3100
if server_settings["socket"] != "":
3101
socketfd = server_settings["socket"]
3102
tcp_server = MandosServer(
3103
(server_settings["address"], server_settings["port"]),
3105
interface=(server_settings["interface"] or None),
3107
gnutls_priority=server_settings["priority"],
3111
pidfilename = "/run/mandos.pid"
3112
if not os.path.isdir("/run/."):
3113
pidfilename = "/var/run/mandos.pid"
3116
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3117
except IOError as e:
3118
logger.error("Could not open file %r", pidfilename,
3121
for name, group in (("_mandos", "_mandos"),
3122
("mandos", "mandos"),
3123
("nobody", "nogroup")):
3125
uid = pwd.getpwnam(name).pw_uid
3126
gid = pwd.getpwnam(group).pw_gid
1755
3128
except KeyError:
1757
uid = pwd.getpwnam(u"nobody").pw_uid
1758
gid = pwd.getpwnam(u"nobody").pw_gid
1765
except OSError, error:
1766
if error[0] != errno.EPERM:
1769
# Enable all possible GnuTLS debugging
1772
if not debug and not debuglevel:
1773
syslogger.setLevel(logging.WARNING)
1774
console.setLevel(logging.WARNING)
1776
level = getattr(logging, debuglevel.upper())
1777
syslogger.setLevel(level)
1778
console.setLevel(level)
3137
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3139
except OSError as error:
3140
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3141
.format(uid, gid, os.strerror(error.errno)))
3142
if error.errno != errno.EPERM:
3146
# Enable all possible GnuTLS debugging
1781
3148
# "Use a log level over 10 to enable all debugging options."
1782
3149
# - GnuTLS manual
1783
gnutls.library.functions.gnutls_global_set_log_level(11)
1785
@gnutls.library.types.gnutls_log_func
3150
gnutls.global_set_log_level(11)
1786
3153
def debug_gnutls(level, string):
1787
logger.debug(u"GnuTLS: %s", string[:-1])
1789
(gnutls.library.functions
1790
.gnutls_global_set_log_function(debug_gnutls))
3154
logger.debug("GnuTLS: %s", string[:-1])
3156
gnutls.global_set_log_function(debug_gnutls)
1792
3158
# Redirect stdin so all checkers get /dev/null
1793
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3159
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1794
3160
os.dup2(null, sys.stdin.fileno())
1798
# No console logging
1799
logger.removeHandler(console)
3164
# Need to fork before connecting to D-Bus
3166
# Close all input and output, do double fork, etc.
3169
if gi.version_info < (3, 10, 2):
3170
# multiprocessing will use threads, so before we use GLib we
3171
# need to inform GLib that threads will be used.
1802
3174
global main_loop
1803
3175
# From the Avahi example code
1804
DBusGMainLoop(set_as_default=True )
1805
main_loop = gobject.MainLoop()
3176
DBusGMainLoop(set_as_default=True)
3177
main_loop = GLib.MainLoop()
1806
3178
bus = dbus.SystemBus()
1807
3179
# End of Avahi example code
1810
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1811
bus, do_not_queue=True)
1812
except dbus.exceptions.NameExistsException, e:
1813
logger.error(unicode(e) + u", disabling D-Bus")
3182
bus_name = dbus.service.BusName("se.recompile.Mandos",
3185
old_bus_name = dbus.service.BusName(
3186
"se.bsnet.fukt.Mandos", bus,
3188
except dbus.exceptions.DBusException as e:
3189
logger.error("Disabling D-Bus:", exc_info=e)
1814
3190
use_dbus = False
1815
server_settings[u"use_dbus"] = False
3191
server_settings["use_dbus"] = False
1816
3192
tcp_server.use_dbus = False
1817
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1818
service = AvahiService(name = server_settings[u"servicename"],
1819
servicetype = u"_mandos._tcp",
1820
protocol = protocol, bus = bus)
1821
if server_settings["interface"]:
1822
service.interface = (if_nametoindex
1823
(str(server_settings[u"interface"])))
3194
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3195
service = AvahiServiceToSyslog(
3196
name=server_settings["servicename"],
3197
servicetype="_mandos._tcp",
3200
if server_settings["interface"]:
3201
service.interface = if_nametoindex(
3202
server_settings["interface"].encode("utf-8"))
1826
# Close all input and output, do double fork, etc.
1829
3204
global multiprocessing_manager
1830
3205
multiprocessing_manager = multiprocessing.Manager()
1832
3207
client_class = Client
1834
client_class = functools.partial(ClientDBus, bus = bus)
1835
def client_config_items(config, section):
1836
special_settings = {
1837
"approved_by_default":
1838
lambda: config.getboolean(section,
1839
"approved_by_default"),
1841
for name, value in config.items(section):
3209
client_class = functools.partial(ClientDBus, bus=bus)
3211
client_settings = Client.config_parser(client_config)
3212
old_client_settings = {}
3215
# This is used to redirect stdout and stderr for checker processes
3217
wnull = open(os.devnull, "w") # A writable /dev/null
3218
# Only used if server is running in foreground but not in debug
3220
if debug or not foreground:
3223
# Get client data and settings from last running state.
3224
if server_settings["restore"]:
3226
with open(stored_state_path, "rb") as stored_state:
3227
if sys.version_info.major == 2:
3228
clients_data, old_client_settings = pickle.load(
3231
bytes_clients_data, bytes_old_client_settings = (
3232
pickle.load(stored_state, encoding="bytes"))
3233
# Fix bytes to strings
3236
clients_data = {(key.decode("utf-8")
3237
if isinstance(key, bytes)
3240
bytes_clients_data.items()}
3241
del bytes_clients_data
3242
for key in clients_data:
3243
value = {(k.decode("utf-8")
3244
if isinstance(k, bytes) else k): v
3246
clients_data[key].items()}
3247
clients_data[key] = value
3249
value["client_structure"] = [
3251
if isinstance(s, bytes)
3253
value["client_structure"]]
3255
for k in ("name", "host"):
3256
if isinstance(value[k], bytes):
3257
value[k] = value[k].decode("utf-8")
3258
if "key_id" not in value:
3259
value["key_id"] = ""
3260
elif "fingerprint" not in value:
3261
value["fingerprint"] = ""
3262
# old_client_settings
3264
old_client_settings = {
3265
(key.decode("utf-8")
3266
if isinstance(key, bytes)
3269
bytes_old_client_settings.items()}
3270
del bytes_old_client_settings
3272
for value in old_client_settings.values():
3273
if isinstance(value["host"], bytes):
3274
value["host"] = (value["host"]
3276
os.remove(stored_state_path)
3277
except IOError as e:
3278
if e.errno == errno.ENOENT:
3279
logger.warning("Could not load persistent state:"
3280
" {}".format(os.strerror(e.errno)))
3282
logger.critical("Could not load persistent state:",
3285
except EOFError as e:
3286
logger.warning("Could not load persistent state: "
3290
with PGPEngine() as pgp:
3291
for client_name, client in clients_data.items():
3292
# Skip removed clients
3293
if client_name not in client_settings:
3296
# Decide which value to use after restoring saved state.
3297
# We have three different values: Old config file,
3298
# new config file, and saved state.
3299
# New config value takes precedence if it differs from old
3300
# config value, otherwise use saved state.
3301
for name, value in client_settings[client_name].items():
3303
# For each value in new config, check if it
3304
# differs from the old config value (Except for
3305
# the "secret" attribute)
3306
if (name != "secret"
3308
old_client_settings[client_name][name])):
3309
client[name] = value
3313
# Clients who has passed its expire date can still be
3314
# enabled if its last checker was successful. A Client
3315
# whose checker succeeded before we stored its state is
3316
# assumed to have successfully run all checkers during
3318
if client["enabled"]:
3319
if datetime.datetime.utcnow() >= client["expires"]:
3320
if not client["last_checked_ok"]:
3322
"disabling client {} - Client never "
3323
"performed a successful checker".format(
3325
client["enabled"] = False
3326
elif client["last_checker_status"] != 0:
3328
"disabling client {} - Client last"
3329
" checker failed with error code"
3332
client["last_checker_status"]))
3333
client["enabled"] = False
3335
client["expires"] = (
3336
datetime.datetime.utcnow()
3337
+ client["timeout"])
3338
logger.debug("Last checker succeeded,"
3339
" keeping {} enabled".format(
1843
yield (name, special_settings[name]())
1847
tcp_server.clients.update(set(
1848
client_class(name = section,
1849
config= dict(client_config_items(
1850
client_config, section)))
1851
for section in client_config.sections()))
3342
client["secret"] = pgp.decrypt(
3343
client["encrypted_secret"],
3344
client_settings[client_name]["secret"])
3346
# If decryption fails, we use secret from new settings
3347
logger.debug("Failed to decrypt {} old secret".format(
3349
client["secret"] = (client_settings[client_name]
3352
# Add/remove clients based on new changes made to config
3353
for client_name in (set(old_client_settings)
3354
- set(client_settings)):
3355
del clients_data[client_name]
3356
for client_name in (set(client_settings)
3357
- set(old_client_settings)):
3358
clients_data[client_name] = client_settings[client_name]
3360
# Create all client objects
3361
for client_name, client in clients_data.items():
3362
tcp_server.clients[client_name] = client_class(
3365
server_settings=server_settings)
1852
3367
if not tcp_server.clients:
1853
logger.warning(u"No clients defined")
3368
logger.warning("No clients defined")
3371
if pidfile is not None:
1857
3372
pid = os.getpid()
1858
pidfile.write(str(pid) + "\n")
3375
print(pid, file=pidfile)
3377
logger.error("Could not write to file %r with PID %d",
1861
logger.error(u"Could not write to file %r with PID %d",
1864
# "pidfile" was never created
1869
signal.signal(signal.SIGINT, signal.SIG_IGN)
1870
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1871
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3382
for termsig in (signal.SIGHUP, signal.SIGTERM):
3383
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3384
lambda: main_loop.quit() and False)
1874
class MandosDBusService(dbus.service.Object):
3388
@alternate_dbus_interfaces(
3389
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3390
class MandosDBusService(DBusObjectWithObjectManager):
1875
3391
"""A D-Bus proxy object"""
1876
3393
def __init__(self):
1877
dbus.service.Object.__init__(self, bus, u"/")
1878
_interface = u"se.bsnet.fukt.Mandos"
1880
@dbus.service.signal(_interface, signature=u"o")
3394
dbus.service.Object.__init__(self, bus, "/")
3396
_interface = "se.recompile.Mandos"
3398
@dbus.service.signal(_interface, signature="o")
1881
3399
def ClientAdded(self, objpath):
1885
@dbus.service.signal(_interface, signature=u"ss")
1886
def ClientNotFound(self, fingerprint, address):
3403
@dbus.service.signal(_interface, signature="ss")
3404
def ClientNotFound(self, key_id, address):
1890
@dbus.service.signal(_interface, signature=u"os")
3408
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3410
@dbus.service.signal(_interface, signature="os")
1891
3411
def ClientRemoved(self, objpath, name):
1895
@dbus.service.method(_interface, out_signature=u"ao")
3415
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3417
@dbus.service.method(_interface, out_signature="ao")
1896
3418
def GetAllClients(self):
1898
return dbus.Array(c.dbus_object_path
1899
for c in tcp_server.clients)
3420
return dbus.Array(c.dbus_object_path for c in
3421
tcp_server.clients.values())
3423
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1901
3425
@dbus.service.method(_interface,
1902
out_signature=u"a{oa{sv}}")
3426
out_signature="a{oa{sv}}")
1903
3427
def GetAllClientsWithProperties(self):
1905
3429
return dbus.Dictionary(
1906
((c.dbus_object_path, c.GetAll(u""))
1907
for c in tcp_server.clients),
1908
signature=u"oa{sv}")
1910
@dbus.service.method(_interface, in_signature=u"o")
3430
{c.dbus_object_path: c.GetAll(
3431
"se.recompile.Mandos.Client")
3432
for c in tcp_server.clients.values()},
3435
@dbus.service.method(_interface, in_signature="o")
1911
3436
def RemoveClient(self, object_path):
1913
for c in tcp_server.clients:
3438
for c in tcp_server.clients.values():
1914
3439
if c.dbus_object_path == object_path:
1915
tcp_server.clients.remove(c)
3440
del tcp_server.clients[c.name]
1916
3441
c.remove_from_connection()
1917
# Don't signal anything except ClientRemoved
3442
# Don't signal the disabling
1918
3443
c.disable(quiet=True)
1920
self.ClientRemoved(object_path, c.name)
3444
# Emit D-Bus signal for removal
3445
self.client_removed_signal(c)
1922
3447
raise KeyError(object_path)
3451
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3452
out_signature="a{oa{sa{sv}}}")
3453
def GetManagedObjects(self):
3455
return dbus.Dictionary(
3456
{client.dbus_object_path:
3458
{interface: client.GetAll(interface)
3460
client._get_all_interface_names()})
3461
for client in tcp_server.clients.values()})
3463
def client_added_signal(self, client):
3464
"""Send the new standard signal and the old signal"""
3466
# New standard signal
3467
self.InterfacesAdded(
3468
client.dbus_object_path,
3470
{interface: client.GetAll(interface)
3472
client._get_all_interface_names()}))
3474
self.ClientAdded(client.dbus_object_path)
3476
def client_removed_signal(self, client):
3477
"""Send the new standard signal and the old signal"""
3479
# New standard signal
3480
self.InterfacesRemoved(
3481
client.dbus_object_path,
3482
client._get_all_interface_names())
3484
self.ClientRemoved(client.dbus_object_path,
1926
3487
mandos_dbus_service = MandosDBusService()
3489
# Save modules to variables to exempt the modules from being
3490
# unloaded before the function registered with atexit() is run.
3491
mp = multiprocessing
1929
3495
"Cleanup function; run on exit"
3499
mp.active_children()
3501
if not (tcp_server.clients or client_settings):
3504
# Store client before exiting. Secrets are encrypted with key
3505
# based on what config file has. If config file is
3506
# removed/edited, old secret will thus be unrecovable.
3508
with PGPEngine() as pgp:
3509
for client in tcp_server.clients.values():
3510
key = client_settings[client.name]["secret"]
3511
client.encrypted_secret = pgp.encrypt(client.secret,
3515
# A list of attributes that can not be pickled
3517
exclude = {"bus", "changedstate", "secret",
3518
"checker", "server_settings"}
3519
for name, typ in inspect.getmembers(dbus.service
3523
client_dict["encrypted_secret"] = (client
3525
for attr in client.client_structure:
3526
if attr not in exclude:
3527
client_dict[attr] = getattr(client, attr)
3529
clients[client.name] = client_dict
3530
del client_settings[client.name]["secret"]
3533
with tempfile.NamedTemporaryFile(
3537
dir=os.path.dirname(stored_state_path),
3538
delete=False) as stored_state:
3539
pickle.dump((clients, client_settings), stored_state,
3541
tempname = stored_state.name
3542
os.rename(tempname, stored_state_path)
3543
except (IOError, OSError) as e:
3549
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3550
logger.warning("Could not save persistent state: {}"
3551
.format(os.strerror(e.errno)))
3553
logger.warning("Could not save persistent state:",
3557
# Delete all clients, and settings from config
1932
3558
while tcp_server.clients:
1933
client = tcp_server.clients.pop()
3559
name, client = tcp_server.clients.popitem()
1935
3561
client.remove_from_connection()
1936
client.disable_hook = None
1937
# Don't signal anything except ClientRemoved
3562
# Don't signal the disabling
1938
3563
client.disable(quiet=True)
3564
# Emit D-Bus signal for removal
1941
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3566
mandos_dbus_service.client_removed_signal(client)
3567
client_settings.clear()
1944
3569
atexit.register(cleanup)
1946
for client in tcp_server.clients:
3571
for client in tcp_server.clients.values():
1949
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3573
# Emit D-Bus signal for adding
3574
mandos_dbus_service.client_added_signal(client)
3575
# Need to initiate checking of clients
3577
client.init_checker()
1952
3579
tcp_server.enable()
1953
3580
tcp_server.server_activate()
1955
3582
# Find out what port we got
1956
service.port = tcp_server.socket.getsockname()[1]
3584
service.port = tcp_server.socket.getsockname()[1]
1958
logger.info(u"Now listening on address %r, port %d,"
1959
" flowinfo %d, scope_id %d"
1960
% tcp_server.socket.getsockname())
3586
logger.info("Now listening on address %r, port %d,"
3587
" flowinfo %d, scope_id %d",
3588
*tcp_server.socket.getsockname())
1962
logger.info(u"Now listening on address %r, port %d"
1963
% tcp_server.socket.getsockname())
1965
#service.interface = tcp_server.socket.getsockname()[3]
3590
logger.info("Now listening on address %r, port %d",
3591
*tcp_server.socket.getsockname())
3593
# service.interface = tcp_server.socket.getsockname()[3]
1968
# From the Avahi example code
1971
except dbus.exceptions.DBusException, error:
1972
logger.critical(u"DBusException: %s", error)
1975
# End of Avahi example code
1977
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1978
lambda *args, **kwargs:
1979
(tcp_server.handle_request
1980
(*args[2:], **kwargs) or True))
1982
logger.debug(u"Starting main loop")
3597
# From the Avahi example code
3600
except dbus.exceptions.DBusException as error:
3601
logger.critical("D-Bus Exception", exc_info=error)
3604
# End of Avahi example code
3607
GLib.IOChannel.unix_new(tcp_server.fileno()),
3608
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3609
lambda *args, **kwargs: (tcp_server.handle_request
3610
(*args[2:], **kwargs) or True))
3612
logger.debug("Starting main loop")
1983
3613
main_loop.run()
1984
except AvahiError, error:
1985
logger.critical(u"AvahiError: %s", error)
3614
except AvahiError as error:
3615
logger.critical("Avahi Error", exc_info=error)
1988
3618
except KeyboardInterrupt:
1991
logger.debug(u"Server received KeyboardInterrupt")
1992
logger.debug(u"Server exiting")
3620
print("", file=sys.stderr)
3621
logger.debug("Server received KeyboardInterrupt")
3622
logger.debug("Server exiting")
1993
3623
# Must run before the D-Bus bus name gets deregistered
3627
def should_only_run_tests():
3628
parser = argparse.ArgumentParser(add_help=False)
3629
parser.add_argument("--check", action='store_true')
3630
args, unknown_args = parser.parse_known_args()
3631
run_tests = args.check
3633
# Remove --check argument from sys.argv
3634
sys.argv[1:] = unknown_args
3637
# Add all tests from doctest strings
3638
def load_tests(loader, tests, none):
3640
tests.addTests(doctest.DocTestSuite())
1996
3643
if __name__ == '__main__':
3645
if should_only_run_tests():
3646
# Call using ./mandos --check [--verbose]