70
import cPickle as pickle
62
import cPickle as pickle
73
63
import multiprocessing
83
66
import dbus.service
85
from gi.repository import GLib
86
69
from dbus.mainloop.glib import DBusGMainLoop
89
72
import xml.dom.minidom
92
if sys.version_info.major == 2:
96
# Show warnings by default
97
if not sys.warnoptions:
99
warnings.simplefilter("default")
101
# Try to find the value of SO_BINDTODEVICE:
103
# This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
104
# newer, and it is also the most natural place for it:
105
76
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
106
77
except AttributeError:
108
# This is where SO_BINDTODEVICE was up to and including Python
110
79
from IN import SO_BINDTODEVICE
111
80
except ImportError:
112
# In Python 2.7 it seems to have been removed entirely.
113
# Try running the C preprocessor:
115
cc = subprocess.Popen(["cc", "--language=c", "-E",
117
stdin=subprocess.PIPE,
118
stdout=subprocess.PIPE)
119
stdout = cc.communicate(
120
"#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
121
SO_BINDTODEVICE = int(stdout.splitlines()[-1])
122
except (OSError, ValueError, IndexError):
124
SO_BINDTODEVICE = None
126
if sys.version_info < (3, 2):
127
configparser.Configparser = configparser.SafeConfigParser
130
stored_state_file = "clients.pickle"
132
logger = logging.getLogger()
133
logging.captureWarnings(True) # Show warnings via the logging system
137
if_nametoindex = ctypes.cdll.LoadLibrary(
138
ctypes.util.find_library("c")).if_nametoindex
139
except (OSError, AttributeError):
141
def if_nametoindex(interface):
142
"Get an interface index the hard way, i.e. using fcntl()"
143
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
144
with contextlib.closing(socket.socket()) as s:
145
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
146
struct.pack(b"16s16x", interface))
147
interface_index = struct.unpack("I", ifreq[16:20])[0]
148
return interface_index
151
def copy_function(func):
152
"""Make a copy of a function"""
153
if sys.version_info.major == 2:
154
return types.FunctionType(func.func_code,
160
return types.FunctionType(func.__code__,
167
def initlogger(debug, level=logging.WARNING):
168
"""init logger and add loglevel"""
171
syslogger = (logging.handlers.SysLogHandler(
172
facility=logging.handlers.SysLogHandler.LOG_DAEMON,
174
syslogger.setFormatter(logging.Formatter
175
('Mandos [%(process)d]: %(levelname)s:'
177
logger.addHandler(syslogger)
180
console = logging.StreamHandler()
181
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
185
logger.addHandler(console)
186
logger.setLevel(level)
189
class PGPError(Exception):
190
"""Exception if encryption/decryption fails"""
195
"""A simple class for OpenPGP symmetric encryption & decryption"""
198
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
201
output = subprocess.check_output(["gpgconf"])
202
for line in output.splitlines():
203
name, text, path = line.split(b":")
208
if e.errno != errno.ENOENT:
210
self.gnupgargs = ['--batch',
211
'--homedir', self.tempdir,
214
# Only GPG version 1 has the --no-use-agent option.
215
if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
216
self.gnupgargs.append("--no-use-agent")
221
def __exit__(self, exc_type, exc_value, traceback):
229
if self.tempdir is not None:
230
# Delete contents of tempdir
231
for root, dirs, files in os.walk(self.tempdir,
233
for filename in files:
234
os.remove(os.path.join(root, filename))
236
os.rmdir(os.path.join(root, dirname))
238
os.rmdir(self.tempdir)
241
def password_encode(self, password):
242
# Passphrase can not be empty and can not contain newlines or
243
# NUL bytes. So we prefix it and hex encode it.
244
encoded = b"mandos" + binascii.hexlify(password)
245
if len(encoded) > 2048:
246
# GnuPG can't handle long passwords, so encode differently
247
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
248
.replace(b"\n", b"\\n")
249
.replace(b"\0", b"\\x00"))
252
def encrypt(self, data, password):
253
passphrase = self.password_encode(password)
254
with tempfile.NamedTemporaryFile(
255
dir=self.tempdir) as passfile:
256
passfile.write(passphrase)
258
proc = subprocess.Popen([self.gpg, '--symmetric',
262
stdin=subprocess.PIPE,
263
stdout=subprocess.PIPE,
264
stderr=subprocess.PIPE)
265
ciphertext, err = proc.communicate(input=data)
266
if proc.returncode != 0:
270
def decrypt(self, data, password):
271
passphrase = self.password_encode(password)
272
with tempfile.NamedTemporaryFile(
273
dir=self.tempdir) as passfile:
274
passfile.write(passphrase)
276
proc = subprocess.Popen([self.gpg, '--decrypt',
280
stdin=subprocess.PIPE,
281
stdout=subprocess.PIPE,
282
stderr=subprocess.PIPE)
283
decrypted_plaintext, err = proc.communicate(input=data)
284
if proc.returncode != 0:
286
return decrypted_plaintext
289
# Pretend that we have an Avahi module
291
"""This isn't so much a class as it is a module-like namespace."""
292
IF_UNSPEC = -1 # avahi-common/address.h
293
PROTO_UNSPEC = -1 # avahi-common/address.h
294
PROTO_INET = 0 # avahi-common/address.h
295
PROTO_INET6 = 1 # avahi-common/address.h
296
DBUS_NAME = "org.freedesktop.Avahi"
297
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
298
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
299
DBUS_PATH_SERVER = "/"
302
def string_array_to_txt_array(t):
303
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
304
for s in t), signature="ay")
305
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
306
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
307
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
308
SERVER_INVALID = 0 # avahi-common/defs.h
309
SERVER_REGISTERING = 1 # avahi-common/defs.h
310
SERVER_RUNNING = 2 # avahi-common/defs.h
311
SERVER_COLLISION = 3 # avahi-common/defs.h
312
SERVER_FAILURE = 4 # avahi-common/defs.h
81
SO_BINDTODEVICE = None
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
88
syslogger = (logging.handlers.SysLogHandler
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
94
logger.addHandler(syslogger)
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
100
logger.addHandler(console)
315
102
class AvahiError(Exception):
316
103
def __init__(self, value, *args, **kwargs):
317
104
self.value = value
318
return super(AvahiError, self).__init__(value, *args,
105
super(AvahiError, self).__init__(value, *args, **kwargs)
106
def __unicode__(self):
107
return unicode(repr(self.value))
322
109
class AvahiServiceError(AvahiError):
326
112
class AvahiGroupError(AvahiError):
116
class AvahiService(object):
331
117
"""An Avahi (Zeroconf) service.
334
120
interface: integer; avahi.IF_UNSPEC or an interface index.
335
121
Used to optionally bind to the specified interface.
336
name: string; Example: 'Mandos'
337
type: string; Example: '_mandos._tcp'.
338
See <https://www.iana.org/assignments/service-names-port-numbers>
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
339
125
port: integer; what port to announce
340
126
TXT: list of strings; TXT record for the service
341
127
domain: string; Domain to publish on, default to .local if empty.
430
197
dbus.UInt16(self.port),
431
198
avahi.string_array_to_txt_array(self.TXT))
432
199
self.group.Commit()
434
200
def entry_group_state_changed(self, state, error):
435
201
"""Derived from the Avahi example code"""
436
logger.debug("Avahi entry group state change: %i", state)
202
logger.debug(u"Avahi entry group state change: %i", state)
438
204
if state == avahi.ENTRY_GROUP_ESTABLISHED:
439
logger.debug("Zeroconf service established.")
205
logger.debug(u"Zeroconf service established.")
440
206
elif state == avahi.ENTRY_GROUP_COLLISION:
441
logger.info("Zeroconf service name collision.")
207
logger.warning(u"Zeroconf service name collision.")
443
209
elif state == avahi.ENTRY_GROUP_FAILURE:
444
logger.critical("Avahi: Error in group state changed %s",
446
raise AvahiGroupError("State changed: {!s}".format(error))
210
logger.critical(u"Avahi: Error in group state changed %s",
212
raise AvahiGroupError(u"State changed: %s"
448
214
def cleanup(self):
449
215
"""Derived from the Avahi example code"""
450
216
if self.group is not None:
453
except (dbus.exceptions.UnknownMethodException,
454
dbus.exceptions.DBusException):
456
218
self.group = None
459
def server_state_changed(self, state, error=None):
219
def server_state_changed(self, state):
460
220
"""Derived from the Avahi example code"""
461
logger.debug("Avahi server state change: %i", state)
463
avahi.SERVER_INVALID: "Zeroconf server invalid",
464
avahi.SERVER_REGISTERING: None,
465
avahi.SERVER_COLLISION: "Zeroconf server name collision",
466
avahi.SERVER_FAILURE: "Zeroconf server failure",
468
if state in bad_states:
469
if bad_states[state] is not None:
471
logger.error(bad_states[state])
473
logger.error(bad_states[state] + ": %r", error)
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
475
225
elif state == avahi.SERVER_RUNNING:
478
except dbus.exceptions.DBusException as error:
479
if (error.get_dbus_name()
480
== "org.freedesktop.Avahi.CollisionError"):
481
logger.info("Local Zeroconf service name"
483
return self.rename(remove=False)
485
logger.critical("D-Bus Exception", exc_info=error)
490
logger.debug("Unknown state: %r", state)
492
logger.debug("Unknown state: %r: %r", state, error)
494
227
def activate(self):
495
228
"""Derived from the Avahi example code"""
496
229
if self.server is None:
497
230
self.server = dbus.Interface(
498
231
self.bus.get_object(avahi.DBUS_NAME,
499
avahi.DBUS_PATH_SERVER,
500
follow_name_owner_changes=True),
232
avahi.DBUS_PATH_SERVER),
501
233
avahi.DBUS_INTERFACE_SERVER)
502
self.server.connect_to_signal("StateChanged",
503
self.server_state_changed)
234
self.server.connect_to_signal(u"StateChanged",
235
self.server_state_changed)
504
236
self.server_state_changed(self.server.GetState())
507
class AvahiServiceToSyslog(AvahiService):
508
def rename(self, *args, **kwargs):
509
"""Add the new name to the syslog messages"""
510
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
511
syslogger.setFormatter(logging.Formatter(
512
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
517
# Pretend that we have a GnuTLS module
519
"""This isn't so much a class as it is a module-like namespace."""
521
library = ctypes.util.find_library("gnutls")
523
library = ctypes.util.find_library("gnutls-deb0")
524
_library = ctypes.cdll.LoadLibrary(library)
527
# Unless otherwise indicated, the constants and types below are
528
# all from the gnutls/gnutls.h C header file.
539
E_NO_CERTIFICATE_FOUND = -49
544
KEYID_USE_SHA256 = 1 # gnutls/x509.h
545
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
548
class session_int(ctypes.Structure):
550
session_t = ctypes.POINTER(session_int)
552
class certificate_credentials_st(ctypes.Structure):
554
certificate_credentials_t = ctypes.POINTER(
555
certificate_credentials_st)
556
certificate_type_t = ctypes.c_int
558
class datum_t(ctypes.Structure):
559
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
560
('size', ctypes.c_uint)]
562
class openpgp_crt_int(ctypes.Structure):
564
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
565
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
566
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
567
credentials_type_t = ctypes.c_int
568
transport_ptr_t = ctypes.c_void_p
569
close_request_t = ctypes.c_int
572
class Error(Exception):
573
def __init__(self, message=None, code=None, args=()):
574
# Default usage is by a message string, but if a return
575
# code is passed, convert it to a string with
578
if message is None and code is not None:
579
message = gnutls.strerror(code)
580
return super(gnutls.Error, self).__init__(
583
class CertificateSecurityError(Error):
589
self._c_object = gnutls.certificate_credentials_t()
590
gnutls.certificate_allocate_credentials(
591
ctypes.byref(self._c_object))
592
self.type = gnutls.CRD_CERTIFICATE
595
gnutls.certificate_free_credentials(self._c_object)
598
def __init__(self, socket, credentials=None):
599
self._c_object = gnutls.session_t()
600
gnutls_flags = gnutls.CLIENT
601
if gnutls.check_version(b"3.5.6"):
602
gnutls_flags |= gnutls.NO_TICKETS
604
gnutls_flags |= gnutls.ENABLE_RAWPK
605
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
607
gnutls.set_default_priority(self._c_object)
608
gnutls.transport_set_ptr(self._c_object, socket.fileno())
609
gnutls.handshake_set_private_extensions(self._c_object,
612
if credentials is None:
613
credentials = gnutls.Credentials()
614
gnutls.credentials_set(self._c_object, credentials.type,
615
ctypes.cast(credentials._c_object,
617
self.credentials = credentials
620
gnutls.deinit(self._c_object)
623
return gnutls.handshake(self._c_object)
625
def send(self, data):
629
data_len -= gnutls.record_send(self._c_object,
634
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
636
# Error handling functions
637
def _error_code(result):
638
"""A function to raise exceptions on errors, suitable
639
for the 'restype' attribute on ctypes functions"""
642
if result == gnutls.E_NO_CERTIFICATE_FOUND:
643
raise gnutls.CertificateSecurityError(code=result)
644
raise gnutls.Error(code=result)
646
def _retry_on_error(result, func, arguments):
647
"""A function to retry on some errors, suitable
648
for the 'errcheck' attribute on ctypes functions"""
650
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
651
return _error_code(result)
652
result = func(*arguments)
655
# Unless otherwise indicated, the function declarations below are
656
# all from the gnutls/gnutls.h C header file.
659
priority_set_direct = _library.gnutls_priority_set_direct
660
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
661
ctypes.POINTER(ctypes.c_char_p)]
662
priority_set_direct.restype = _error_code
664
init = _library.gnutls_init
665
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
666
init.restype = _error_code
668
set_default_priority = _library.gnutls_set_default_priority
669
set_default_priority.argtypes = [session_t]
670
set_default_priority.restype = _error_code
672
record_send = _library.gnutls_record_send
673
record_send.argtypes = [session_t, ctypes.c_void_p,
675
record_send.restype = ctypes.c_ssize_t
676
record_send.errcheck = _retry_on_error
678
certificate_allocate_credentials = (
679
_library.gnutls_certificate_allocate_credentials)
680
certificate_allocate_credentials.argtypes = [
681
ctypes.POINTER(certificate_credentials_t)]
682
certificate_allocate_credentials.restype = _error_code
684
certificate_free_credentials = (
685
_library.gnutls_certificate_free_credentials)
686
certificate_free_credentials.argtypes = [
687
certificate_credentials_t]
688
certificate_free_credentials.restype = None
690
handshake_set_private_extensions = (
691
_library.gnutls_handshake_set_private_extensions)
692
handshake_set_private_extensions.argtypes = [session_t,
694
handshake_set_private_extensions.restype = None
696
credentials_set = _library.gnutls_credentials_set
697
credentials_set.argtypes = [session_t, credentials_type_t,
699
credentials_set.restype = _error_code
701
strerror = _library.gnutls_strerror
702
strerror.argtypes = [ctypes.c_int]
703
strerror.restype = ctypes.c_char_p
705
certificate_type_get = _library.gnutls_certificate_type_get
706
certificate_type_get.argtypes = [session_t]
707
certificate_type_get.restype = _error_code
709
certificate_get_peers = _library.gnutls_certificate_get_peers
710
certificate_get_peers.argtypes = [session_t,
711
ctypes.POINTER(ctypes.c_uint)]
712
certificate_get_peers.restype = ctypes.POINTER(datum_t)
714
global_set_log_level = _library.gnutls_global_set_log_level
715
global_set_log_level.argtypes = [ctypes.c_int]
716
global_set_log_level.restype = None
718
global_set_log_function = _library.gnutls_global_set_log_function
719
global_set_log_function.argtypes = [log_func]
720
global_set_log_function.restype = None
722
deinit = _library.gnutls_deinit
723
deinit.argtypes = [session_t]
724
deinit.restype = None
726
handshake = _library.gnutls_handshake
727
handshake.argtypes = [session_t]
728
handshake.restype = _error_code
729
handshake.errcheck = _retry_on_error
731
transport_set_ptr = _library.gnutls_transport_set_ptr
732
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
733
transport_set_ptr.restype = None
735
bye = _library.gnutls_bye
736
bye.argtypes = [session_t, close_request_t]
737
bye.restype = _error_code
738
bye.errcheck = _retry_on_error
740
check_version = _library.gnutls_check_version
741
check_version.argtypes = [ctypes.c_char_p]
742
check_version.restype = ctypes.c_char_p
744
_need_version = b"3.3.0"
745
if check_version(_need_version) is None:
746
raise self.Error("Needs GnuTLS {} or later"
747
.format(_need_version))
749
_tls_rawpk_version = b"3.6.6"
750
has_rawpk = bool(check_version(_tls_rawpk_version))
754
class pubkey_st(ctypes.Structure):
756
pubkey_t = ctypes.POINTER(pubkey_st)
758
x509_crt_fmt_t = ctypes.c_int
760
# All the function declarations below are from gnutls/abstract.h
761
pubkey_init = _library.gnutls_pubkey_init
762
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
763
pubkey_init.restype = _error_code
765
pubkey_import = _library.gnutls_pubkey_import
766
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
768
pubkey_import.restype = _error_code
770
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
771
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
772
ctypes.POINTER(ctypes.c_ubyte),
773
ctypes.POINTER(ctypes.c_size_t)]
774
pubkey_get_key_id.restype = _error_code
776
pubkey_deinit = _library.gnutls_pubkey_deinit
777
pubkey_deinit.argtypes = [pubkey_t]
778
pubkey_deinit.restype = None
780
# All the function declarations below are from gnutls/openpgp.h
782
openpgp_crt_init = _library.gnutls_openpgp_crt_init
783
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
784
openpgp_crt_init.restype = _error_code
786
openpgp_crt_import = _library.gnutls_openpgp_crt_import
787
openpgp_crt_import.argtypes = [openpgp_crt_t,
788
ctypes.POINTER(datum_t),
790
openpgp_crt_import.restype = _error_code
792
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
793
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
794
ctypes.POINTER(ctypes.c_uint)]
795
openpgp_crt_verify_self.restype = _error_code
797
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
798
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
799
openpgp_crt_deinit.restype = None
801
openpgp_crt_get_fingerprint = (
802
_library.gnutls_openpgp_crt_get_fingerprint)
803
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
807
openpgp_crt_get_fingerprint.restype = _error_code
809
if check_version(b"3.6.4"):
810
certificate_type_get2 = _library.gnutls_certificate_type_get2
811
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
812
certificate_type_get2.restype = _error_code
814
# Remove non-public functions
815
del _error_code, _retry_on_error
818
def call_pipe(connection, # : multiprocessing.Connection
819
func, *args, **kwargs):
820
"""This function is meant to be called by multiprocessing.Process
822
This function runs func(*args, **kwargs), and writes the resulting
823
return value on the provided multiprocessing.Connection.
825
connection.send(func(*args, **kwargs))
239
class Client(object):
830
240
"""A representation of a client host served by this server.
833
approved: bool(); 'None' if not yet approved/disapproved
243
_approved: bool(); 'None' if not yet approved/disapproved
834
244
approval_delay: datetime.timedelta(); Time to wait for approval
835
245
approval_duration: datetime.timedelta(); Duration of one approval
836
checker: multiprocessing.Process(); a running checker process used
837
to see if the client lives. 'None' if no process is
839
checker_callback_tag: a GLib event source tag, or None
246
checker: subprocess.Popen(); a running checker process used
247
to see if the client lives.
248
'None' if no process is running.
249
checker_callback_tag: - '' -
840
250
checker_command: string; External command which is run to check
841
251
if client lives. %() expansions are done at
842
252
runtime with vars(self) as dict, so that for
843
253
instance %(name)s can be used in the command.
844
checker_initiator_tag: a GLib event source tag, or None
254
checker_initiator_tag: a gobject event source tag, or None
845
255
created: datetime.datetime(); (UTC) object creation
846
client_structure: Object describing what attributes a client has
847
and is used for storing the client at exit
848
256
current_checker_command: string; current running checker_command
849
disable_initiator_tag: a GLib event source tag, or None
257
disable_hook: If set, called by disable() as disable_hook(self)
258
disable_initiator_tag: - '' -
851
260
fingerprint: string (40 or 32 hexadecimal digits); used to
852
uniquely identify an OpenPGP client
853
key_id: string (64 hexadecimal digits); used to uniquely identify
854
a client using raw public keys
261
uniquely identify the client
855
262
host: string; available for use by the checker command
856
263
interval: datetime.timedelta(); How often to start a new checker
857
last_approval_request: datetime.datetime(); (UTC) or None
858
264
last_checked_ok: datetime.datetime(); (UTC) or None
859
last_checker_status: integer between 0 and 255 reflecting exit
860
status of last checker. -1 reflects crashed
861
checker, -2 means no checker completed yet.
862
last_checker_signal: The signal which killed the last checker, if
863
last_checker_status is -1
864
last_enabled: datetime.datetime(); (UTC) or None
265
last_enabled: datetime.datetime(); (UTC)
865
266
name: string; from the config file, used in log messages and
866
267
D-Bus identifiers
867
268
secret: bytestring; sent verbatim (over TLS) to client
868
269
timeout: datetime.timedelta(); How long from last_checked_ok
869
270
until this client is disabled
870
extended_timeout: extra long timeout when secret has been sent
871
271
runtime_expansions: Allowed attributes for runtime expansion.
872
expires: datetime.datetime(); time (UTC) when a client will be
874
server_settings: The server_settings dict from main()
877
runtime_expansions = ("approval_delay", "approval_duration",
878
"created", "enabled", "expires", "key_id",
879
"fingerprint", "host", "interval",
880
"last_approval_request", "last_checked_ok",
881
"last_enabled", "name", "timeout")
884
"extended_timeout": "PT15M",
886
"checker": "fping -q -- %%(host)s",
888
"approval_delay": "PT0S",
889
"approval_duration": "PT1S",
890
"approved_by_default": "True",
274
runtime_expansions = (u"approval_delay", u"approval_duration",
275
u"created", u"enabled", u"fingerprint",
276
u"host", u"interval", u"last_checked_ok",
277
u"last_enabled", u"name", u"timeout")
895
def config_parser(config):
896
"""Construct a new dict of client settings of this form:
897
{ client_name: {setting_name: value, ...}, ...}
898
with exceptions for any special settings as defined above.
899
NOTE: Must be a pure function. Must return the same result
900
value given the same arguments.
903
for client_name in config.sections():
904
section = dict(config.items(client_name))
905
client = settings[client_name] = {}
907
client["host"] = section["host"]
908
# Reformat values from string types to Python types
909
client["approved_by_default"] = config.getboolean(
910
client_name, "approved_by_default")
911
client["enabled"] = config.getboolean(client_name,
914
# Uppercase and remove spaces from key_id and fingerprint
915
# for later comparison purposes with return value from the
916
# key_id() and fingerprint() functions
917
client["key_id"] = (section.get("key_id", "").upper()
919
client["fingerprint"] = (section["fingerprint"].upper()
921
if "secret" in section:
922
client["secret"] = codecs.decode(section["secret"]
925
elif "secfile" in section:
926
with open(os.path.expanduser(os.path.expandvars
927
(section["secfile"])),
929
client["secret"] = secfile.read()
931
raise TypeError("No secret or secfile for section {}"
933
client["timeout"] = string_to_delta(section["timeout"])
934
client["extended_timeout"] = string_to_delta(
935
section["extended_timeout"])
936
client["interval"] = string_to_delta(section["interval"])
937
client["approval_delay"] = string_to_delta(
938
section["approval_delay"])
939
client["approval_duration"] = string_to_delta(
940
section["approval_duration"])
941
client["checker_command"] = section["checker"]
942
client["last_approval_request"] = None
943
client["last_checked_ok"] = None
944
client["last_checker_status"] = -2
948
def __init__(self, settings, name=None, server_settings=None):
280
def _timedelta_to_milliseconds(td):
281
"Convert a datetime.timedelta() to milliseconds"
282
return ((td.days * 24 * 60 * 60 * 1000)
283
+ (td.seconds * 1000)
284
+ (td.microseconds // 1000))
286
def timeout_milliseconds(self):
287
"Return the 'timeout' attribute in milliseconds"
288
return self._timedelta_to_milliseconds(self.timeout)
290
def interval_milliseconds(self):
291
"Return the 'interval' attribute in milliseconds"
292
return self._timedelta_to_milliseconds(self.interval)
294
def approval_delay_milliseconds(self):
295
return self._timedelta_to_milliseconds(self.approval_delay)
297
def __init__(self, name = None, disable_hook=None, config=None):
298
"""Note: the 'checker' key in 'config' sets the
299
'checker_command' attribute and *not* the 'checker'
950
if server_settings is None:
952
self.server_settings = server_settings
953
# adding all client settings
954
for setting, value in settings.items():
955
setattr(self, setting, value)
958
if not hasattr(self, "last_enabled"):
959
self.last_enabled = datetime.datetime.utcnow()
960
if not hasattr(self, "expires"):
961
self.expires = (datetime.datetime.utcnow()
304
logger.debug(u"Creating client %r", self.name)
305
# Uppercase and remove spaces from fingerprint for later
306
# comparison purposes with return value from the fingerprint()
308
self.fingerprint = (config[u"fingerprint"].upper()
310
logger.debug(u" Fingerprint: %s", self.fingerprint)
311
if u"secret" in config:
312
self.secret = config[u"secret"].decode(u"base64")
313
elif u"secfile" in config:
314
with open(os.path.expanduser(os.path.expandvars
315
(config[u"secfile"])),
317
self.secret = secfile.read()
964
self.last_enabled = None
967
logger.debug("Creating client %r", self.name)
968
logger.debug(" Key ID: %s", self.key_id)
969
logger.debug(" Fingerprint: %s", self.fingerprint)
970
self.created = settings.get("created",
971
datetime.datetime.utcnow())
973
# attributes specific for this server instance
319
raise TypeError(u"No secret or secfile for client %s"
321
self.host = config.get(u"host", u"")
322
self.created = datetime.datetime.utcnow()
324
self.last_enabled = None
325
self.last_checked_ok = None
326
self.timeout = string_to_delta(config[u"timeout"])
327
self.interval = string_to_delta(config[u"interval"])
328
self.disable_hook = disable_hook
974
329
self.checker = None
975
330
self.checker_initiator_tag = None
976
331
self.disable_initiator_tag = None
977
332
self.checker_callback_tag = None
333
self.checker_command = config[u"checker"]
978
334
self.current_checker_command = None
335
self.last_connect = None
336
self._approved = None
337
self.approved_by_default = config.get(u"approved_by_default",
980
339
self.approvals_pending = 0
981
self.changedstate = multiprocessing_manager.Condition(
982
multiprocessing_manager.Lock())
983
self.client_structure = [attr
984
for attr in self.__dict__.keys()
985
if not attr.startswith("_")]
986
self.client_structure.append("client_structure")
988
for name, t in inspect.getmembers(
989
type(self), lambda obj: isinstance(obj, property)):
990
if not name.startswith("_"):
991
self.client_structure.append(name)
993
# Send notice to process children that client state has changed
340
self.approval_delay = string_to_delta(
341
config[u"approval_delay"])
342
self.approval_duration = string_to_delta(
343
config[u"approval_duration"])
344
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
994
346
def send_changedstate(self):
995
with self.changedstate:
996
self.changedstate.notify_all()
347
self.changedstate.acquire()
348
self.changedstate.notify_all()
349
self.changedstate.release()
998
351
def enable(self):
999
352
"""Start this client's checker and timeout hooks"""
1000
if getattr(self, "enabled", False):
353
if getattr(self, u"enabled", False):
1001
354
# Already enabled
1003
self.expires = datetime.datetime.utcnow() + self.timeout
356
self.send_changedstate()
1005
357
self.last_enabled = datetime.datetime.utcnow()
1007
self.send_changedstate()
358
# Schedule a new checker to be started an 'interval' from now,
359
# and every interval from then on.
360
self.checker_initiator_tag = (gobject.timeout_add
361
(self.interval_milliseconds(),
363
# Schedule a disable() when 'timeout' has passed
364
self.disable_initiator_tag = (gobject.timeout_add
365
(self.timeout_milliseconds(),
368
# Also start a new checker *right now*.
1009
371
def disable(self, quiet=True):
1010
372
"""Disable this client."""
1011
373
if not getattr(self, "enabled", False):
1014
logger.info("Disabling client %s", self.name)
1015
if getattr(self, "disable_initiator_tag", None) is not None:
1016
GLib.source_remove(self.disable_initiator_tag)
376
self.send_changedstate()
378
logger.info(u"Disabling client %s", self.name)
379
if getattr(self, u"disable_initiator_tag", False):
380
gobject.source_remove(self.disable_initiator_tag)
1017
381
self.disable_initiator_tag = None
1019
if getattr(self, "checker_initiator_tag", None) is not None:
1020
GLib.source_remove(self.checker_initiator_tag)
382
if getattr(self, u"checker_initiator_tag", False):
383
gobject.source_remove(self.checker_initiator_tag)
1021
384
self.checker_initiator_tag = None
1022
385
self.stop_checker()
386
if self.disable_hook:
387
self.disable_hook(self)
1023
388
self.enabled = False
1025
self.send_changedstate()
1026
# Do not run this again if called by a GLib.timeout_add
389
# Do not run this again if called by a gobject.timeout_add
1029
392
def __del__(self):
393
self.disable_hook = None
1032
def init_checker(self):
1033
# Schedule a new checker to be started an 'interval' from now,
1034
# and every interval from then on.
1035
if self.checker_initiator_tag is not None:
1036
GLib.source_remove(self.checker_initiator_tag)
1037
self.checker_initiator_tag = GLib.timeout_add(
1038
int(self.interval.total_seconds() * 1000),
1040
# Schedule a disable() when 'timeout' has passed
1041
if self.disable_initiator_tag is not None:
1042
GLib.source_remove(self.disable_initiator_tag)
1043
self.disable_initiator_tag = GLib.timeout_add(
1044
int(self.timeout.total_seconds() * 1000), self.disable)
1045
# Also start a new checker *right now*.
1046
self.start_checker()
1048
def checker_callback(self, source, condition, connection,
396
def checker_callback(self, pid, condition, command):
1050
397
"""The checker has completed, so take appropriate actions."""
1051
# Read return code from connection (see call_pipe)
1052
returncode = connection.recv()
1054
if self.checker is not None:
1056
398
self.checker_callback_tag = None
1057
399
self.checker = None
1060
self.last_checker_status = returncode
1061
self.last_checker_signal = None
1062
if self.last_checker_status == 0:
1063
logger.info("Checker for %(name)s succeeded",
400
if os.WIFEXITED(condition):
401
exitstatus = os.WEXITSTATUS(condition)
403
logger.info(u"Checker for %(name)s succeeded",
1065
405
self.checked_ok()
1067
logger.info("Checker for %(name)s failed", vars(self))
407
logger.info(u"Checker for %(name)s failed",
1069
self.last_checker_status = -1
1070
self.last_checker_signal = -returncode
1071
logger.warning("Checker for %(name)s crashed?",
410
logger.warning(u"Checker for %(name)s crashed?",
1075
413
def checked_ok(self):
1076
"""Assert that the client has been seen, alive and well."""
414
"""Bump up the timeout for this client.
416
This should only be called when the client has been seen,
1077
419
self.last_checked_ok = datetime.datetime.utcnow()
1078
self.last_checker_status = 0
1079
self.last_checker_signal = None
1082
def bump_timeout(self, timeout=None):
1083
"""Bump up the timeout for this client."""
1085
timeout = self.timeout
1086
if self.disable_initiator_tag is not None:
1087
GLib.source_remove(self.disable_initiator_tag)
1088
self.disable_initiator_tag = None
1089
if getattr(self, "enabled", False):
1090
self.disable_initiator_tag = GLib.timeout_add(
1091
int(timeout.total_seconds() * 1000), self.disable)
1092
self.expires = datetime.datetime.utcnow() + timeout
1094
def need_approval(self):
1095
self.last_approval_request = datetime.datetime.utcnow()
420
gobject.source_remove(self.disable_initiator_tag)
421
self.disable_initiator_tag = (gobject.timeout_add
422
(self.timeout_milliseconds(),
1097
425
def start_checker(self):
1098
426
"""Start a new checker subprocess if one is not running.
1100
428
If a checker already exists, leave it running and do
1102
430
# The reason for not killing a running checker is that if we
1103
# did that, and if a checker (for some reason) started running
1104
# slowly and taking more than 'interval' time, then the client
1105
# would inevitably timeout, since no checker would get a
1106
# chance to run to completion. If we instead leave running
431
# did that, then if a checker (for some reason) started
432
# running slowly and taking more than 'interval' time, the
433
# client would inevitably timeout, since no checker would get
434
# a chance to run to completion. If we instead leave running
1107
435
# checkers alone, the checker would have to take more time
1108
436
# than 'timeout' for the client to be disabled, which is as it
1111
if self.checker is not None and not self.checker.is_alive():
1112
logger.warning("Checker was not alive; joining")
439
# If a checker exists, make sure it is not a zombie
441
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
442
except (AttributeError, OSError), error:
443
if (isinstance(error, OSError)
444
and error.errno != errno.ECHILD):
448
logger.warning(u"Checker was a zombie")
449
gobject.source_remove(self.checker_callback_tag)
450
self.checker_callback(pid, status,
451
self.current_checker_command)
1115
452
# Start a new checker if needed
1116
453
if self.checker is None:
1117
# Escape attributes for the shell
1119
attr: re.escape(str(getattr(self, attr)))
1120
for attr in self.runtime_expansions}
1122
command = self.checker_command % escaped_attrs
1123
except TypeError as error:
1124
logger.error('Could not format string "%s"',
1125
self.checker_command,
1127
return True # Try again later
455
# In case checker_command has exactly one % operator
456
command = self.checker_command % self.host
458
# Escape attributes for the shell
459
escaped_attrs = dict(
461
re.escape(unicode(str(getattr(self, attr, u"")),
465
self.runtime_expansions)
468
command = self.checker_command % escaped_attrs
469
except TypeError, error:
470
logger.error(u'Could not format string "%s":'
471
u' %s', self.checker_command, error)
472
return True # Try again later
1128
473
self.current_checker_command = command
1129
logger.info("Starting checker %r for %s", command,
1131
# We don't need to redirect stdout and stderr, since
1132
# in normal mode, that is already done by daemon(),
1133
# and in debug mode we don't want to. (Stdin is
1134
# always replaced by /dev/null.)
1135
# The exception is when not debugging but nevertheless
1136
# running in the foreground; use the previously
1138
popen_args = {"close_fds": True,
1141
if (not self.server_settings["debug"]
1142
and self.server_settings["foreground"]):
1143
popen_args.update({"stdout": wnull,
1145
pipe = multiprocessing.Pipe(duplex=False)
1146
self.checker = multiprocessing.Process(
1148
args=(pipe[1], subprocess.call, command),
1150
self.checker.start()
1151
self.checker_callback_tag = GLib.io_add_watch(
1152
GLib.IOChannel.unix_new(pipe[0].fileno()),
1153
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1154
self.checker_callback, pipe[0], command)
1155
# Re-run this periodically if run by GLib.timeout_add
475
logger.info(u"Starting checker %r for %s",
477
# We don't need to redirect stdout and stderr, since
478
# in normal mode, that is already done by daemon(),
479
# and in debug mode we don't want to. (Stdin is
480
# always replaced by /dev/null.)
481
self.checker = subprocess.Popen(command,
483
shell=True, cwd=u"/")
484
self.checker_callback_tag = (gobject.child_watch_add
486
self.checker_callback,
488
# The checker may have completed before the gobject
489
# watch was added. Check for this.
490
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
492
gobject.source_remove(self.checker_callback_tag)
493
self.checker_callback(pid, status, command)
494
except OSError, error:
495
logger.error(u"Failed to start subprocess: %s",
497
# Re-run this periodically if run by gobject.timeout_add
1158
500
def stop_checker(self):
1159
501
"""Force the checker process, if any, to stop."""
1160
502
if self.checker_callback_tag:
1161
GLib.source_remove(self.checker_callback_tag)
503
gobject.source_remove(self.checker_callback_tag)
1162
504
self.checker_callback_tag = None
1163
if getattr(self, "checker", None) is None:
505
if getattr(self, u"checker", None) is None:
1165
logger.debug("Stopping checker for %(name)s", vars(self))
1166
self.checker.terminate()
507
logger.debug(u"Stopping checker for %(name)s", vars(self))
509
os.kill(self.checker.pid, signal.SIGTERM)
511
#if self.checker.poll() is None:
512
# os.kill(self.checker.pid, signal.SIGKILL)
513
except OSError, error:
514
if error.errno != errno.ESRCH: # No such process
1167
516
self.checker = None
1170
def dbus_service_property(dbus_interface,
518
def dbus_service_property(dbus_interface, signature=u"v",
519
access=u"readwrite", byte_arrays=False):
1174
520
"""Decorators for marking methods of a DBusObjectWithProperties to
1175
521
become properties on the D-Bus.
1177
523
The decorated method will be called with no arguments by "Get"
1178
524
and with one argument by "Set".
1180
526
The parameters, where they are supported, are the same as
1181
527
dbus.service.method, except there is only "signature", since the
1182
528
type from Get() and the type sent to Set() is the same.
1184
530
# Encoding deeply encoded byte arrays is not supported yet by the
1185
531
# "Set" method, so we fail early here:
1186
if byte_arrays and signature != "ay":
1187
raise ValueError("Byte arrays not supported for non-'ay'"
1188
" signature {!r}".format(signature))
532
if byte_arrays and signature != u"ay":
533
raise ValueError(u"Byte arrays not supported for non-'ay'"
534
u" signature %r" % signature)
1190
535
def decorator(func):
1191
536
func._dbus_is_property = True
1192
537
func._dbus_interface = dbus_interface
1193
538
func._dbus_signature = signature
1194
539
func._dbus_access = access
1195
540
func._dbus_name = func.__name__
1196
if func._dbus_name.endswith("_dbus_property"):
541
if func._dbus_name.endswith(u"_dbus_property"):
1197
542
func._dbus_name = func._dbus_name[:-14]
1198
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1204
def dbus_interface_annotations(dbus_interface):
1205
"""Decorator for marking functions returning interface annotations
1209
@dbus_interface_annotations("org.example.Interface")
1210
def _foo(self): # Function name does not matter
1211
return {"org.freedesktop.DBus.Deprecated": "true",
1212
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1216
def decorator(func):
1217
func._dbus_is_interface = True
1218
func._dbus_interface = dbus_interface
1219
func._dbus_name = dbus_interface
1225
def dbus_annotations(annotations):
1226
"""Decorator to annotate D-Bus methods, signals or properties
1229
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1230
"org.freedesktop.DBus.Property."
1231
"EmitsChangedSignal": "false"})
1232
@dbus_service_property("org.example.Interface", signature="b",
1234
def Property_dbus_property(self):
1235
return dbus.Boolean(False)
1237
See also the DBusObjectWithAnnotations class.
1240
def decorator(func):
1241
func._dbus_annotations = annotations
543
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1244
545
return decorator
1247
548
class DBusPropertyException(dbus.exceptions.DBusException):
1248
549
"""A base class for D-Bus property-related exceptions
551
def __unicode__(self):
552
return unicode(str(self))
1253
555
class DBusPropertyAccessException(DBusPropertyException):
1265
class DBusObjectWithAnnotations(dbus.service.Object):
1266
"""A D-Bus object with annotations.
1268
Classes inheriting from this can use the dbus_annotations
1269
decorator to add annotations to methods or signals.
1273
def _is_dbus_thing(thing):
1274
"""Returns a function testing if an attribute is a D-Bus thing
1276
If called like _is_dbus_thing("method") it returns a function
1277
suitable for use as predicate to inspect.getmembers().
1279
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1282
def _get_all_dbus_things(self, thing):
1283
"""Returns a generator of (name, attribute) pairs
1285
return ((getattr(athing.__get__(self), "_dbus_name", name),
1286
athing.__get__(self))
1287
for cls in self.__class__.__mro__
1289
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1291
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1293
path_keyword='object_path',
1294
connection_keyword='connection')
1295
def Introspect(self, object_path, connection):
1296
"""Overloading of standard D-Bus method.
1298
Inserts annotation tags on methods and signals.
1300
xmlstring = dbus.service.Object.Introspect(self, object_path,
1303
document = xml.dom.minidom.parseString(xmlstring)
1305
for if_tag in document.getElementsByTagName("interface"):
1306
# Add annotation tags
1307
for typ in ("method", "signal"):
1308
for tag in if_tag.getElementsByTagName(typ):
1310
for name, prop in (self.
1311
_get_all_dbus_things(typ)):
1312
if (name == tag.getAttribute("name")
1313
and prop._dbus_interface
1314
== if_tag.getAttribute("name")):
1315
annots.update(getattr(
1316
prop, "_dbus_annotations", {}))
1317
for name, value in annots.items():
1318
ann_tag = document.createElement(
1320
ann_tag.setAttribute("name", name)
1321
ann_tag.setAttribute("value", value)
1322
tag.appendChild(ann_tag)
1323
# Add interface annotation tags
1324
for annotation, value in dict(
1325
itertools.chain.from_iterable(
1326
annotations().items()
1327
for name, annotations
1328
in self._get_all_dbus_things("interface")
1329
if name == if_tag.getAttribute("name")
1331
ann_tag = document.createElement("annotation")
1332
ann_tag.setAttribute("name", annotation)
1333
ann_tag.setAttribute("value", value)
1334
if_tag.appendChild(ann_tag)
1335
# Fix argument name for the Introspect method itself
1336
if (if_tag.getAttribute("name")
1337
== dbus.INTROSPECTABLE_IFACE):
1338
for cn in if_tag.getElementsByTagName("method"):
1339
if cn.getAttribute("name") == "Introspect":
1340
for arg in cn.getElementsByTagName("arg"):
1341
if (arg.getAttribute("direction")
1343
arg.setAttribute("name",
1345
xmlstring = document.toxml("utf-8")
1347
except (AttributeError, xml.dom.DOMException,
1348
xml.parsers.expat.ExpatError) as error:
1349
logger.error("Failed to override Introspection method",
1354
class DBusObjectWithProperties(DBusObjectWithAnnotations):
567
class DBusObjectWithProperties(dbus.service.Object):
1355
568
"""A D-Bus object with properties.
1357
570
Classes inheriting from this can use the dbus_service_property
1358
571
decorator to expose methods as D-Bus properties. It exposes the
1359
572
standard Get(), Set(), and GetAll() methods on the D-Bus.
576
def _is_dbus_property(obj):
577
return getattr(obj, u"_dbus_is_property", False)
579
def _get_all_dbus_properties(self):
580
"""Returns a generator of (name, attribute) pairs
582
return ((prop._dbus_name, prop)
584
inspect.getmembers(self, self._is_dbus_property))
1362
586
def _get_dbus_property(self, interface_name, property_name):
1363
587
"""Returns a bound method if one exists which is a D-Bus
1364
588
property with the specified name and interface.
1366
for cls in self.__class__.__mro__:
1367
for name, value in inspect.getmembers(
1368
cls, self._is_dbus_thing("property")):
1369
if (value._dbus_name == property_name
1370
and value._dbus_interface == interface_name):
1371
return value.__get__(self)
590
for name in (property_name,
591
property_name + u"_dbus_property"):
592
prop = getattr(self, name, None)
594
or not self._is_dbus_property(prop)
595
or prop._dbus_name != property_name
596
or (interface_name and prop._dbus_interface
597
and interface_name != prop._dbus_interface)):
1373
600
# No such property
1374
raise DBusPropertyNotFound("{}:{}.{}".format(
1375
self.dbus_object_path, interface_name, property_name))
1378
def _get_all_interface_names(cls):
1379
"""Get a sequence of all interfaces supported by an object"""
1380
return (name for name in set(getattr(getattr(x, attr),
1381
"_dbus_interface", None)
1382
for x in (inspect.getmro(cls))
1384
if name is not None)
1386
@dbus.service.method(dbus.PROPERTIES_IFACE,
601
raise DBusPropertyNotFound(self.dbus_object_path + u":"
602
+ interface_name + u"."
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1389
607
def Get(self, interface_name, property_name):
1390
608
"""Standard D-Bus property Get() method, see D-Bus standard.
1392
610
prop = self._get_dbus_property(interface_name, property_name)
1393
if prop._dbus_access == "write":
611
if prop._dbus_access == u"write":
1394
612
raise DBusPropertyAccessException(property_name)
1396
if not hasattr(value, "variant_level"):
614
if not hasattr(value, u"variant_level"):
1398
616
return type(value)(value, variant_level=value.variant_level+1)
1400
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
618
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1401
619
def Set(self, interface_name, property_name, value):
1402
620
"""Standard D-Bus property Set() method, see D-Bus standard.
1404
622
prop = self._get_dbus_property(interface_name, property_name)
1405
if prop._dbus_access == "read":
623
if prop._dbus_access == u"read":
1406
624
raise DBusPropertyAccessException(property_name)
1407
if prop._dbus_get_args_options["byte_arrays"]:
625
if prop._dbus_get_args_options[u"byte_arrays"]:
1408
626
# The byte_arrays option is not supported yet on
1409
627
# signatures other than "ay".
1410
if prop._dbus_signature != "ay":
1411
raise ValueError("Byte arrays not supported for non-"
1412
"'ay' signature {!r}"
1413
.format(prop._dbus_signature))
1414
value = dbus.ByteArray(bytes(value))
628
if prop._dbus_signature != u"ay":
630
value = dbus.ByteArray(''.join(unichr(byte)
1417
@dbus.service.method(dbus.PROPERTIES_IFACE,
1419
out_signature="a{sv}")
634
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
635
out_signature=u"a{sv}")
1420
636
def GetAll(self, interface_name):
1421
637
"""Standard D-Bus property GetAll() method, see D-Bus
1424
640
Note: Will not include properties with access="write".
1427
for name, prop in self._get_all_dbus_things("property"):
643
for name, prop in self._get_all_dbus_properties():
1428
644
if (interface_name
1429
645
and interface_name != prop._dbus_interface):
1430
646
# Interface non-empty but did not match
1432
648
# Ignore write-only properties
1433
if prop._dbus_access == "write":
649
if prop._dbus_access == u"write":
1436
if not hasattr(value, "variant_level"):
1437
properties[name] = value
652
if not hasattr(value, u"variant_level"):
1439
properties[name] = type(value)(
1440
value, variant_level=value.variant_level + 1)
1441
return dbus.Dictionary(properties, signature="sv")
1443
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1444
def PropertiesChanged(self, interface_name, changed_properties,
1445
invalidated_properties):
1446
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
655
all[name] = type(value)(value, variant_level=
656
value.variant_level+1)
657
return dbus.Dictionary(all, signature=u"sv")
1451
659
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1453
661
path_keyword='object_path',
1454
662
connection_keyword='connection')
1455
663
def Introspect(self, object_path, connection):
1456
"""Overloading of standard D-Bus method.
1458
Inserts property tags and interface annotation tags.
664
"""Standard D-Bus method, overloaded to insert property tags.
1460
xmlstring = DBusObjectWithAnnotations.Introspect(self,
666
xmlstring = dbus.service.Object.Introspect(self, object_path,
1464
669
document = xml.dom.minidom.parseString(xmlstring)
1466
670
def make_tag(document, name, prop):
1467
e = document.createElement("property")
1468
e.setAttribute("name", name)
1469
e.setAttribute("type", prop._dbus_signature)
1470
e.setAttribute("access", prop._dbus_access)
671
e = document.createElement(u"property")
672
e.setAttribute(u"name", name)
673
e.setAttribute(u"type", prop._dbus_signature)
674
e.setAttribute(u"access", prop._dbus_access)
1473
for if_tag in document.getElementsByTagName("interface"):
676
for if_tag in document.getElementsByTagName(u"interface"):
1475
677
for tag in (make_tag(document, name, prop)
1477
in self._get_all_dbus_things("property")
679
in self._get_all_dbus_properties()
1478
680
if prop._dbus_interface
1479
== if_tag.getAttribute("name")):
681
== if_tag.getAttribute(u"name")):
1480
682
if_tag.appendChild(tag)
1481
# Add annotation tags for properties
1482
for tag in if_tag.getElementsByTagName("property"):
1484
for name, prop in self._get_all_dbus_things(
1486
if (name == tag.getAttribute("name")
1487
and prop._dbus_interface
1488
== if_tag.getAttribute("name")):
1489
annots.update(getattr(
1490
prop, "_dbus_annotations", {}))
1491
for name, value in annots.items():
1492
ann_tag = document.createElement(
1494
ann_tag.setAttribute("name", name)
1495
ann_tag.setAttribute("value", value)
1496
tag.appendChild(ann_tag)
1497
683
# Add the names to the return values for the
1498
684
# "org.freedesktop.DBus.Properties" methods
1499
if (if_tag.getAttribute("name")
1500
== "org.freedesktop.DBus.Properties"):
1501
for cn in if_tag.getElementsByTagName("method"):
1502
if cn.getAttribute("name") == "Get":
1503
for arg in cn.getElementsByTagName("arg"):
1504
if (arg.getAttribute("direction")
1506
arg.setAttribute("name", "value")
1507
elif cn.getAttribute("name") == "GetAll":
1508
for arg in cn.getElementsByTagName("arg"):
1509
if (arg.getAttribute("direction")
1511
arg.setAttribute("name", "props")
1512
xmlstring = document.toxml("utf-8")
1514
except (AttributeError, xml.dom.DOMException,
1515
xml.parsers.expat.ExpatError) as error:
1516
logger.error("Failed to override Introspection method",
1522
dbus.OBJECT_MANAGER_IFACE
1523
except AttributeError:
1524
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1527
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1528
"""A D-Bus object with an ObjectManager.
1530
Classes inheriting from this exposes the standard
1531
GetManagedObjects call and the InterfacesAdded and
1532
InterfacesRemoved signals on the standard
1533
"org.freedesktop.DBus.ObjectManager" interface.
1535
Note: No signals are sent automatically; they must be sent
1538
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1539
out_signature="a{oa{sa{sv}}}")
1540
def GetManagedObjects(self):
1541
"""This function must be overridden"""
1542
raise NotImplementedError()
1544
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1545
signature="oa{sa{sv}}")
1546
def InterfacesAdded(self, object_path, interfaces_and_properties):
1549
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1550
def InterfacesRemoved(self, object_path, interfaces):
1553
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1555
path_keyword='object_path',
1556
connection_keyword='connection')
1557
def Introspect(self, object_path, connection):
1558
"""Overloading of standard D-Bus method.
1560
Override return argument name of GetManagedObjects to be
1561
"objpath_interfaces_and_properties"
1563
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1567
document = xml.dom.minidom.parseString(xmlstring)
1569
for if_tag in document.getElementsByTagName("interface"):
1570
# Fix argument name for the GetManagedObjects method
1571
if (if_tag.getAttribute("name")
1572
== dbus.OBJECT_MANAGER_IFACE):
1573
for cn in if_tag.getElementsByTagName("method"):
1574
if (cn.getAttribute("name")
1575
== "GetManagedObjects"):
1576
for arg in cn.getElementsByTagName("arg"):
1577
if (arg.getAttribute("direction")
1581
"objpath_interfaces"
1583
xmlstring = document.toxml("utf-8")
1585
except (AttributeError, xml.dom.DOMException,
1586
xml.parsers.expat.ExpatError) as error:
1587
logger.error("Failed to override Introspection method",
1592
def datetime_to_dbus(dt, variant_level=0):
1593
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1595
return dbus.String("", variant_level=variant_level)
1596
return dbus.String(dt.isoformat(), variant_level=variant_level)
1599
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1600
"""A class decorator; applied to a subclass of
1601
dbus.service.Object, it will add alternate D-Bus attributes with
1602
interface names according to the "alt_interface_names" mapping.
1605
@alternate_dbus_interfaces({"org.example.Interface":
1606
"net.example.AlternateInterface"})
1607
class SampleDBusObject(dbus.service.Object):
1608
@dbus.service.method("org.example.Interface")
1609
def SampleDBusMethod():
1612
The above "SampleDBusMethod" on "SampleDBusObject" will be
1613
reachable via two interfaces: "org.example.Interface" and
1614
"net.example.AlternateInterface", the latter of which will have
1615
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1616
"true", unless "deprecate" is passed with a False value.
1618
This works for methods and signals, and also for D-Bus properties
1619
(from DBusObjectWithProperties) and interfaces (from the
1620
dbus_interface_annotations decorator).
1624
for orig_interface_name, alt_interface_name in (
1625
alt_interface_names.items()):
1627
interface_names = set()
1628
# Go though all attributes of the class
1629
for attrname, attribute in inspect.getmembers(cls):
1630
# Ignore non-D-Bus attributes, and D-Bus attributes
1631
# with the wrong interface name
1632
if (not hasattr(attribute, "_dbus_interface")
1633
or not attribute._dbus_interface.startswith(
1634
orig_interface_name)):
1636
# Create an alternate D-Bus interface name based on
1638
alt_interface = attribute._dbus_interface.replace(
1639
orig_interface_name, alt_interface_name)
1640
interface_names.add(alt_interface)
1641
# Is this a D-Bus signal?
1642
if getattr(attribute, "_dbus_is_signal", False):
1643
# Extract the original non-method undecorated
1644
# function by black magic
1645
if sys.version_info.major == 2:
1646
nonmethod_func = (dict(
1647
zip(attribute.func_code.co_freevars,
1648
attribute.__closure__))
1649
["func"].cell_contents)
1651
nonmethod_func = (dict(
1652
zip(attribute.__code__.co_freevars,
1653
attribute.__closure__))
1654
["func"].cell_contents)
1655
# Create a new, but exactly alike, function
1656
# object, and decorate it to be a new D-Bus signal
1657
# with the alternate D-Bus interface name
1658
new_function = copy_function(nonmethod_func)
1659
new_function = (dbus.service.signal(
1661
attribute._dbus_signature)(new_function))
1662
# Copy annotations, if any
1664
new_function._dbus_annotations = dict(
1665
attribute._dbus_annotations)
1666
except AttributeError:
1669
# Define a creator of a function to call both the
1670
# original and alternate functions, so both the
1671
# original and alternate signals gets sent when
1672
# the function is called
1673
def fixscope(func1, func2):
1674
"""This function is a scope container to pass
1675
func1 and func2 to the "call_both" function
1676
outside of its arguments"""
1678
@functools.wraps(func2)
1679
def call_both(*args, **kwargs):
1680
"""This function will emit two D-Bus
1681
signals by calling func1 and func2"""
1682
func1(*args, **kwargs)
1683
func2(*args, **kwargs)
1684
# Make wrapper function look like a D-Bus
1686
for name, attr in inspect.getmembers(func2):
1687
if name.startswith("_dbus_"):
1688
setattr(call_both, name, attr)
1691
# Create the "call_both" function and add it to
1693
attr[attrname] = fixscope(attribute, new_function)
1694
# Is this a D-Bus method?
1695
elif getattr(attribute, "_dbus_is_method", False):
1696
# Create a new, but exactly alike, function
1697
# object. Decorate it to be a new D-Bus method
1698
# with the alternate D-Bus interface name. Add it
1701
dbus.service.method(
1703
attribute._dbus_in_signature,
1704
attribute._dbus_out_signature)
1705
(copy_function(attribute)))
1706
# Copy annotations, if any
1708
attr[attrname]._dbus_annotations = dict(
1709
attribute._dbus_annotations)
1710
except AttributeError:
1712
# Is this a D-Bus property?
1713
elif getattr(attribute, "_dbus_is_property", False):
1714
# Create a new, but exactly alike, function
1715
# object, and decorate it to be a new D-Bus
1716
# property with the alternate D-Bus interface
1717
# name. Add it to the class.
1718
attr[attrname] = (dbus_service_property(
1719
alt_interface, attribute._dbus_signature,
1720
attribute._dbus_access,
1721
attribute._dbus_get_args_options
1723
(copy_function(attribute)))
1724
# Copy annotations, if any
1726
attr[attrname]._dbus_annotations = dict(
1727
attribute._dbus_annotations)
1728
except AttributeError:
1730
# Is this a D-Bus interface?
1731
elif getattr(attribute, "_dbus_is_interface", False):
1732
# Create a new, but exactly alike, function
1733
# object. Decorate it to be a new D-Bus interface
1734
# with the alternate D-Bus interface name. Add it
1737
dbus_interface_annotations(alt_interface)
1738
(copy_function(attribute)))
1740
# Deprecate all alternate interfaces
1741
iname = "_AlternateDBusNames_interface_annotation{}"
1742
for interface_name in interface_names:
1744
@dbus_interface_annotations(interface_name)
1746
return {"org.freedesktop.DBus.Deprecated":
1748
# Find an unused name
1749
for aname in (iname.format(i)
1750
for i in itertools.count()):
1751
if aname not in attr:
1755
# Replace the class with a new subclass of it with
1756
# methods, signals, etc. as created above.
1757
if sys.version_info.major == 2:
1758
cls = type(b"{}Alternate".format(cls.__name__),
1761
cls = type("{}Alternate".format(cls.__name__),
1768
@alternate_dbus_interfaces({"se.recompile.Mandos":
1769
"se.bsnet.fukt.Mandos"})
685
if (if_tag.getAttribute(u"name")
686
== u"org.freedesktop.DBus.Properties"):
687
for cn in if_tag.getElementsByTagName(u"method"):
688
if cn.getAttribute(u"name") == u"Get":
689
for arg in cn.getElementsByTagName(u"arg"):
690
if (arg.getAttribute(u"direction")
692
arg.setAttribute(u"name", u"value")
693
elif cn.getAttribute(u"name") == u"GetAll":
694
for arg in cn.getElementsByTagName(u"arg"):
695
if (arg.getAttribute(u"direction")
697
arg.setAttribute(u"name", u"props")
698
xmlstring = document.toxml(u"utf-8")
700
except (AttributeError, xml.dom.DOMException,
701
xml.parsers.expat.ExpatError), error:
702
logger.error(u"Failed to override Introspection method",
1770
707
class ClientDBus(Client, DBusObjectWithProperties):
1771
708
"""A Client class using D-Bus
1774
711
dbus_object_path: dbus.ObjectPath
1775
712
bus: dbus.SystemBus()
1778
715
runtime_expansions = (Client.runtime_expansions
1779
+ ("dbus_object_path", ))
1781
_interface = "se.recompile.Mandos.Client"
716
+ (u"dbus_object_path",))
1783
718
# dbus.service.Object doesn't use super(), so we can't either.
1785
def __init__(self, bus=None, *args, **kwargs):
720
def __init__(self, bus = None, *args, **kwargs):
721
self._approvals_pending = 0
1787
723
Client.__init__(self, *args, **kwargs)
1788
724
# Only now, when this client is initialized, can it show up on
1790
client_object_name = str(self.name).translate(
1791
{ord("."): ord("_"),
1792
ord("-"): ord("_")})
1793
self.dbus_object_path = dbus.ObjectPath(
1794
"/clients/" + client_object_name)
726
client_object_name = unicode(self.name).translate(
727
{ord(u"."): ord(u"_"),
728
ord(u"-"): ord(u"_")})
729
self.dbus_object_path = (dbus.ObjectPath
730
(u"/clients/" + client_object_name))
1795
731
DBusObjectWithProperties.__init__(self, self.bus,
1796
732
self.dbus_object_path)
1798
def notifychangeproperty(transform_func, dbus_name,
1799
type_func=lambda x: x,
1801
invalidate_only=False,
1802
_interface=_interface):
1803
""" Modify a variable so that it's a property which announces
1804
its changes to DBus.
1806
transform_fun: Function that takes a value and a variant_level
1807
and transforms it to a D-Bus type.
1808
dbus_name: D-Bus name of the variable
1809
type_func: Function that transform the value before sending it
1810
to the D-Bus. Default: no transform
1811
variant_level: D-Bus variant level. Default: 1
1813
attrname = "_{}".format(dbus_name)
1815
def setter(self, value):
1816
if hasattr(self, "dbus_object_path"):
1817
if (not hasattr(self, attrname) or
1818
type_func(getattr(self, attrname, None))
1819
!= type_func(value)):
1821
self.PropertiesChanged(
1822
_interface, dbus.Dictionary(),
1823
dbus.Array((dbus_name, )))
1825
dbus_value = transform_func(
1827
variant_level=variant_level)
1828
self.PropertyChanged(dbus.String(dbus_name),
1830
self.PropertiesChanged(
1832
dbus.Dictionary({dbus.String(dbus_name):
1835
setattr(self, attrname, value)
1837
return property(lambda self: getattr(self, attrname), setter)
1839
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1840
approvals_pending = notifychangeproperty(dbus.Boolean,
1843
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1844
last_enabled = notifychangeproperty(datetime_to_dbus,
1846
checker = notifychangeproperty(
1847
dbus.Boolean, "CheckerRunning",
1848
type_func=lambda checker: checker is not None)
1849
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1851
last_checker_status = notifychangeproperty(dbus.Int16,
1852
"LastCheckerStatus")
1853
last_approval_request = notifychangeproperty(
1854
datetime_to_dbus, "LastApprovalRequest")
1855
approved_by_default = notifychangeproperty(dbus.Boolean,
1856
"ApprovedByDefault")
1857
approval_delay = notifychangeproperty(
1858
dbus.UInt64, "ApprovalDelay",
1859
type_func=lambda td: td.total_seconds() * 1000)
1860
approval_duration = notifychangeproperty(
1861
dbus.UInt64, "ApprovalDuration",
1862
type_func=lambda td: td.total_seconds() * 1000)
1863
host = notifychangeproperty(dbus.String, "Host")
1864
timeout = notifychangeproperty(
1865
dbus.UInt64, "Timeout",
1866
type_func=lambda td: td.total_seconds() * 1000)
1867
extended_timeout = notifychangeproperty(
1868
dbus.UInt64, "ExtendedTimeout",
1869
type_func=lambda td: td.total_seconds() * 1000)
1870
interval = notifychangeproperty(
1871
dbus.UInt64, "Interval",
1872
type_func=lambda td: td.total_seconds() * 1000)
1873
checker_command = notifychangeproperty(dbus.String, "Checker")
1874
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1875
invalidate_only=True)
1877
del notifychangeproperty
734
def _get_approvals_pending(self):
735
return self._approvals_pending
736
def _set_approvals_pending(self, value):
737
old_value = self._approvals_pending
738
self._approvals_pending = value
740
if (hasattr(self, "dbus_object_path")
741
and bval is not bool(old_value)):
742
dbus_bool = dbus.Boolean(bval, variant_level=1)
743
self.PropertyChanged(dbus.String(u"ApprovalPending"),
746
approvals_pending = property(_get_approvals_pending,
747
_set_approvals_pending)
748
del _get_approvals_pending, _set_approvals_pending
751
def _datetime_to_dbus(dt, variant_level=0):
752
"""Convert a UTC datetime.datetime() to a D-Bus type."""
753
return dbus.String(dt.isoformat(),
754
variant_level=variant_level)
757
oldstate = getattr(self, u"enabled", False)
758
r = Client.enable(self)
759
if oldstate != self.enabled:
761
self.PropertyChanged(dbus.String(u"Enabled"),
762
dbus.Boolean(True, variant_level=1))
763
self.PropertyChanged(
764
dbus.String(u"LastEnabled"),
765
self._datetime_to_dbus(self.last_enabled,
769
def disable(self, quiet = False):
770
oldstate = getattr(self, u"enabled", False)
771
r = Client.disable(self, quiet=quiet)
772
if not quiet and oldstate != self.enabled:
774
self.PropertyChanged(dbus.String(u"Enabled"),
775
dbus.Boolean(False, variant_level=1))
1879
778
def __del__(self, *args, **kwargs):
1881
780
self.remove_from_connection()
1882
781
except LookupError:
1884
if hasattr(DBusObjectWithProperties, "__del__"):
783
if hasattr(DBusObjectWithProperties, u"__del__"):
1885
784
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1886
785
Client.__del__(self, *args, **kwargs)
1888
def checker_callback(self, source, condition,
1889
connection, command, *args, **kwargs):
1890
ret = Client.checker_callback(self, source, condition,
1891
connection, command, *args,
1893
exitstatus = self.last_checker_status
787
def checker_callback(self, pid, condition, command,
789
self.checker_callback_tag = None
792
self.PropertyChanged(dbus.String(u"CheckerRunning"),
793
dbus.Boolean(False, variant_level=1))
794
if os.WIFEXITED(condition):
795
exitstatus = os.WEXITSTATUS(condition)
1895
796
# Emit D-Bus signal
1896
797
self.CheckerCompleted(dbus.Int16(exitstatus),
1897
# This is specific to GNU libC
1898
dbus.Int64(exitstatus << 8),
798
dbus.Int64(condition),
1899
799
dbus.String(command))
1901
801
# Emit D-Bus signal
1902
802
self.CheckerCompleted(dbus.Int16(-1),
1904
# This is specific to GNU libC
1906
| self.last_checker_signal),
803
dbus.Int64(condition),
1907
804
dbus.String(command))
806
return Client.checker_callback(self, pid, condition, command,
809
def checked_ok(self, *args, **kwargs):
810
r = Client.checked_ok(self, *args, **kwargs)
812
self.PropertyChanged(
813
dbus.String(u"LastCheckedOK"),
814
(self._datetime_to_dbus(self.last_checked_ok,
1910
818
def start_checker(self, *args, **kwargs):
1911
old_checker_pid = getattr(self.checker, "pid", None)
819
old_checker = self.checker
820
if self.checker is not None:
821
old_checker_pid = self.checker.pid
823
old_checker_pid = None
1912
824
r = Client.start_checker(self, *args, **kwargs)
1913
825
# Only if new checker process was started
1914
826
if (self.checker is not None
1915
827
and old_checker_pid != self.checker.pid):
1916
828
# Emit D-Bus signal
1917
829
self.CheckerStarted(self.current_checker_command)
830
self.PropertyChanged(
831
dbus.String(u"CheckerRunning"),
832
dbus.Boolean(True, variant_level=1))
835
def stop_checker(self, *args, **kwargs):
836
old_checker = getattr(self, u"checker", None)
837
r = Client.stop_checker(self, *args, **kwargs)
838
if (old_checker is not None
839
and getattr(self, u"checker", None) is None):
840
self.PropertyChanged(dbus.String(u"CheckerRunning"),
841
dbus.Boolean(False, variant_level=1))
1920
844
def _reset_approved(self):
1921
self.approved = None
845
self._approved = None
1924
848
def approve(self, value=True):
1925
self.approved = value
1926
GLib.timeout_add(int(self.approval_duration.total_seconds()
1927
* 1000), self._reset_approved)
1928
849
self.send_changedstate()
1930
# D-Bus methods, signals & properties
850
self._approved = value
851
gobject.timeout_add(self._timedelta_to_milliseconds
852
(self.approval_duration),
853
self._reset_approved)
856
## D-Bus methods, signals & properties
857
_interface = u"se.bsnet.fukt.Mandos.Client"
1936
861
# CheckerCompleted - signal
1937
@dbus.service.signal(_interface, signature="nxs")
862
@dbus.service.signal(_interface, signature=u"nxs")
1938
863
def CheckerCompleted(self, exitcode, waitstatus, command):
1942
867
# CheckerStarted - signal
1943
@dbus.service.signal(_interface, signature="s")
868
@dbus.service.signal(_interface, signature=u"s")
1944
869
def CheckerStarted(self, command):
1948
873
# PropertyChanged - signal
1949
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1950
@dbus.service.signal(_interface, signature="sv")
874
@dbus.service.signal(_interface, signature=u"sv")
1951
875
def PropertyChanged(self, property, value):
1955
879
# GotSecret - signal
1956
880
@dbus.service.signal(_interface)
1957
881
def GotSecret(self):
2199
1097
self.start_checker()
2201
1099
self.stop_checker()
2203
1101
# ObjectPath - property
2205
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2206
"org.freedesktop.DBus.Deprecated": "true"})
2207
@dbus_service_property(_interface, signature="o", access="read")
1102
@dbus_service_property(_interface, signature=u"o", access=u"read")
2208
1103
def ObjectPath_dbus_property(self):
2209
return self.dbus_object_path # is already a dbus.ObjectPath
1104
return self.dbus_object_path # is already a dbus.ObjectPath
2211
1106
# Secret = property
2213
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2215
@dbus_service_property(_interface,
1107
@dbus_service_property(_interface, signature=u"ay",
1108
access=u"write", byte_arrays=True)
2219
1109
def Secret_dbus_property(self, value):
2220
self.secret = bytes(value)
1110
self.secret = str(value)
2226
def __init__(self, child_pipe, key_id, fpr, address):
1115
class ProxyClient(object):
1116
def __init__(self, child_pipe, fpr, address):
2227
1117
self._pipe = child_pipe
2228
self._pipe.send(('init', key_id, fpr, address))
1118
self._pipe.send(('init', fpr, address))
2229
1119
if not self._pipe.recv():
2230
raise KeyError(key_id or fpr)
2232
1122
def __getattribute__(self, name):
1123
if(name == '_pipe'):
2234
1124
return super(ProxyClient, self).__getattribute__(name)
2235
1125
self._pipe.send(('getattr', name))
2236
1126
data = self._pipe.recv()
2237
1127
if data[0] == 'data':
2239
1129
if data[0] == 'function':
2241
1130
def func(*args, **kwargs):
2242
1131
self._pipe.send(('funcall', name, args, kwargs))
2243
1132
return self._pipe.recv()[1]
2247
1135
def __setattr__(self, name, value):
1136
if(name == '_pipe'):
2249
1137
return super(ProxyClient, self).__setattr__(name, value)
2250
1138
self._pipe.send(('setattr', name, value))
2253
1141
class ClientHandler(socketserver.BaseRequestHandler, object):
2254
1142
"""A class to handle client connections.
2256
1144
Instantiated once for each connection to handle it.
2257
1145
Note: This will run in its own forked process."""
2259
1147
def handle(self):
2260
1148
with contextlib.closing(self.server.child_pipe) as child_pipe:
2261
logger.info("TCP connection from: %s",
2262
str(self.client_address))
2263
logger.debug("Pipe FD: %d",
1149
logger.info(u"TCP connection from: %s",
1150
unicode(self.client_address))
1151
logger.debug(u"Pipe FD: %d",
2264
1152
self.server.child_pipe.fileno())
2266
session = gnutls.ClientSession(self.request)
2268
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2269
# "+AES-256-CBC", "+SHA1",
2270
# "+COMP-NULL", "+CTYPE-OPENPGP",
1154
session = (gnutls.connection
1155
.ClientSession(self.request,
1157
.X509Credentials()))
1159
# Note: gnutls.connection.X509Credentials is really a
1160
# generic GnuTLS certificate credentials object so long as
1161
# no X.509 keys are added to it. Therefore, we can use it
1162
# here despite using OpenPGP certificates.
1164
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1165
# u"+AES-256-CBC", u"+SHA1",
1166
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2272
1168
# Use a fallback default, since this MUST be set.
2273
1169
priority = self.server.gnutls_priority
2274
1170
if priority is None:
2276
gnutls.priority_set_direct(session._c_object,
2277
priority.encode("utf-8"),
1171
priority = u"NORMAL"
1172
(gnutls.library.functions
1173
.gnutls_priority_set_direct(session._c_object,
2280
1176
# Start communication using the Mandos protocol
2281
1177
# Get protocol number
2282
1178
line = self.request.makefile().readline()
2283
logger.debug("Protocol version: %r", line)
1179
logger.debug(u"Protocol version: %r", line)
2285
1181
if int(line.strip().split()[0]) > 1:
2286
raise RuntimeError(line)
2287
except (ValueError, IndexError, RuntimeError) as error:
2288
logger.error("Unknown protocol version: %s", error)
1183
except (ValueError, IndexError, RuntimeError), error:
1184
logger.error(u"Unknown protocol version: %s", error)
2291
1187
# Start GnuTLS connection
2293
1189
session.handshake()
2294
except gnutls.Error as error:
2295
logger.warning("Handshake failed: %s", error)
1190
except gnutls.errors.GNUTLSError, error:
1191
logger.warning(u"Handshake failed: %s", error)
2296
1192
# Do not run session.bye() here: the session is not
2297
1193
# established. Just abandon the request.
2299
logger.debug("Handshake succeeded")
1195
logger.debug(u"Handshake succeeded")
2301
1197
approval_required = False
2303
if gnutls.has_rawpk:
2306
key_id = self.key_id(
2307
self.peer_certificate(session))
2308
except (TypeError, gnutls.Error) as error:
2309
logger.warning("Bad certificate: %s", error)
2311
logger.debug("Key ID: %s", key_id)
2316
fpr = self.fingerprint(
2317
self.peer_certificate(session))
2318
except (TypeError, gnutls.Error) as error:
2319
logger.warning("Bad certificate: %s", error)
2321
logger.debug("Fingerprint: %s", fpr)
2324
client = ProxyClient(child_pipe, key_id, fpr,
1200
fpr = self.fingerprint(self.peer_certificate
1202
except (TypeError, gnutls.errors.GNUTLSError), error:
1203
logger.warning(u"Bad certificate: %s", error)
1205
logger.debug(u"Fingerprint: %s", fpr)
1208
client = ProxyClient(child_pipe, fpr,
2325
1209
self.client_address)
2326
1210
except KeyError:
2329
1213
if client.approval_delay:
2330
1214
delay = client.approval_delay
2331
1215
client.approvals_pending += 1
2332
1216
approval_required = True
2335
1219
if not client.enabled:
2336
logger.info("Client %s is disabled",
1220
logger.warning(u"Client %s is disabled",
2338
1222
if self.server.use_dbus:
2339
1223
# Emit D-Bus signal
2340
client.Rejected("Disabled")
1224
client.Rejected("Disabled")
2343
if client.approved or not client.approval_delay:
2344
# We are approved or approval is disabled
1227
if client._approved or not client.approval_delay:
1228
#We are approved or approval is disabled
2346
elif client.approved is None:
2347
logger.info("Client %s needs approval",
1230
elif client._approved is None:
1231
logger.info(u"Client %s needs approval",
2349
1233
if self.server.use_dbus:
2350
1234
# Emit D-Bus signal
2351
1235
client.NeedApproval(
2352
client.approval_delay.total_seconds()
2353
* 1000, client.approved_by_default)
1236
client.approval_delay_milliseconds(),
1237
client.approved_by_default)
2355
logger.warning("Client %s was not approved",
1239
logger.warning(u"Client %s was not approved",
2357
1241
if self.server.use_dbus:
2358
1242
# Emit D-Bus signal
2359
1243
client.Rejected("Denied")
2362
# wait until timeout or approved
1246
#wait until timeout or approved
1247
#x = float(client._timedelta_to_milliseconds(delay))
2363
1248
time = datetime.datetime.now()
2364
1249
client.changedstate.acquire()
2365
client.changedstate.wait(delay.total_seconds())
1250
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2366
1251
client.changedstate.release()
2367
1252
time2 = datetime.datetime.now()
2368
1253
if (time2 - time) >= delay:
2380
1265
delay -= time2 - time
2383
session.send(client.secret)
2384
except gnutls.Error as error:
2385
logger.warning("gnutls send failed",
2389
logger.info("Sending secret to %s", client.name)
2390
# bump the timeout using extended_timeout
2391
client.bump_timeout(client.extended_timeout)
1268
while sent_size < len(client.secret):
1270
sent = session.send(client.secret[sent_size:])
1271
except (gnutls.errors.GNUTLSError), error:
1272
logger.warning("gnutls send failed")
1274
logger.debug(u"Sent: %d, remaining: %d",
1275
sent, len(client.secret)
1276
- (sent_size + sent))
1279
logger.info(u"Sending secret to %s", client.name)
1280
# bump the timeout as if seen
2392
1282
if self.server.use_dbus:
2393
1283
# Emit D-Bus signal
2394
1284
client.GotSecret()
2397
1287
if approval_required:
2398
1288
client.approvals_pending -= 1
2401
except gnutls.Error as error:
2402
logger.warning("GnuTLS bye failed",
1291
except (gnutls.errors.GNUTLSError), error:
1292
logger.warning("GnuTLS bye failed")
2406
1295
def peer_certificate(session):
2407
"Return the peer's certificate as a bytestring"
2409
cert_type = gnutls.certificate_type_get2(session._c_object,
2411
except AttributeError:
2412
cert_type = gnutls.certificate_type_get(session._c_object)
2413
if gnutls.has_rawpk:
2414
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2416
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2417
# If not a valid certificate type...
2418
if cert_type not in valid_cert_types:
2419
logger.info("Cert type %r not in %r", cert_type,
2421
# ...return invalid data
1296
"Return the peer's OpenPGP certificate as a bytestring"
1297
# If not an OpenPGP certificate...
1298
if (gnutls.library.functions
1299
.gnutls_certificate_type_get(session._c_object)
1300
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1301
# ...do the normal thing
1302
return session.peer_certificate
2423
1303
list_size = ctypes.c_uint(1)
2424
cert_list = (gnutls.certificate_get_peers
1304
cert_list = (gnutls.library.functions
1305
.gnutls_certificate_get_peers
2425
1306
(session._c_object, ctypes.byref(list_size)))
2426
1307
if not bool(cert_list) and list_size.value != 0:
2427
raise gnutls.Error("error getting peer certificate")
1308
raise gnutls.errors.GNUTLSError(u"error getting peer"
2428
1310
if list_size.value == 0:
2430
1312
cert = cert_list[0]
2431
1313
return ctypes.string_at(cert.data, cert.size)
2434
def key_id(certificate):
2435
"Convert a certificate bytestring to a hexdigit key ID"
2436
# New GnuTLS "datum" with the public key
2437
datum = gnutls.datum_t(
2438
ctypes.cast(ctypes.c_char_p(certificate),
2439
ctypes.POINTER(ctypes.c_ubyte)),
2440
ctypes.c_uint(len(certificate)))
2441
# XXX all these need to be created in the gnutls "module"
2442
# New empty GnuTLS certificate
2443
pubkey = gnutls.pubkey_t()
2444
gnutls.pubkey_init(ctypes.byref(pubkey))
2445
# Import the raw public key into the certificate
2446
gnutls.pubkey_import(pubkey,
2447
ctypes.byref(datum),
2448
gnutls.X509_FMT_DER)
2449
# New buffer for the key ID
2450
buf = ctypes.create_string_buffer(32)
2451
buf_len = ctypes.c_size_t(len(buf))
2452
# Get the key ID from the raw public key into the buffer
2453
gnutls.pubkey_get_key_id(pubkey,
2454
gnutls.KEYID_USE_SHA256,
2455
ctypes.cast(ctypes.byref(buf),
2456
ctypes.POINTER(ctypes.c_ubyte)),
2457
ctypes.byref(buf_len))
2458
# Deinit the certificate
2459
gnutls.pubkey_deinit(pubkey)
2461
# Convert the buffer to a Python bytestring
2462
key_id = ctypes.string_at(buf, buf_len.value)
2463
# Convert the bytestring to hexadecimal notation
2464
hex_key_id = binascii.hexlify(key_id).upper()
2468
1316
def fingerprint(openpgp):
2469
1317
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2470
1318
# New GnuTLS "datum" with the OpenPGP public key
2471
datum = gnutls.datum_t(
2472
ctypes.cast(ctypes.c_char_p(openpgp),
2473
ctypes.POINTER(ctypes.c_ubyte)),
2474
ctypes.c_uint(len(openpgp)))
1319
datum = (gnutls.library.types
1320
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1323
ctypes.c_uint(len(openpgp))))
2475
1324
# New empty GnuTLS certificate
2476
crt = gnutls.openpgp_crt_t()
2477
gnutls.openpgp_crt_init(ctypes.byref(crt))
1325
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1326
(gnutls.library.functions
1327
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2478
1328
# Import the OpenPGP public key into the certificate
2479
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2480
gnutls.OPENPGP_FMT_RAW)
1329
(gnutls.library.functions
1330
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1331
gnutls.library.constants
1332
.GNUTLS_OPENPGP_FMT_RAW))
2481
1333
# Verify the self signature in the key
2482
1334
crtverify = ctypes.c_uint()
2483
gnutls.openpgp_crt_verify_self(crt, 0,
2484
ctypes.byref(crtverify))
1335
(gnutls.library.functions
1336
.gnutls_openpgp_crt_verify_self(crt, 0,
1337
ctypes.byref(crtverify)))
2485
1338
if crtverify.value != 0:
2486
gnutls.openpgp_crt_deinit(crt)
2487
raise gnutls.CertificateSecurityError(code
1339
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1340
raise (gnutls.errors.CertificateSecurityError
2489
1342
# New buffer for the fingerprint
2490
1343
buf = ctypes.create_string_buffer(20)
2491
1344
buf_len = ctypes.c_size_t()
2492
1345
# Get the fingerprint from the certificate into the buffer
2493
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2494
ctypes.byref(buf_len))
1346
(gnutls.library.functions
1347
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1348
ctypes.byref(buf_len)))
2495
1349
# Deinit the certificate
2496
gnutls.openpgp_crt_deinit(crt)
1350
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2497
1351
# Convert the buffer to a Python bytestring
2498
1352
fpr = ctypes.string_at(buf, buf_len.value)
2499
1353
# Convert the bytestring to hexadecimal notation
2500
hex_fpr = binascii.hexlify(fpr).upper()
1354
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2504
class MultiprocessingMixIn:
1358
class MultiprocessingMixIn(object):
2505
1359
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2507
1360
def sub_process_main(self, request, address):
2509
1362
self.finish_request(request, address)
2511
1364
self.handle_error(request, address)
2512
1365
self.close_request(request)
2514
1367
def process_request(self, request, address):
2515
1368
"""Start a new process to process the request."""
2516
proc = multiprocessing.Process(target=self.sub_process_main,
2517
args=(request, address))
2522
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
1369
multiprocessing.Process(target = self.sub_process_main,
1370
args = (request, address)).start()
1372
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2523
1373
""" adds a pipe to the MixIn """
2525
1374
def process_request(self, request, client_address):
2526
1375
"""Overrides and wraps the original process_request().
2528
1377
This function creates a new pipe in self.pipe
2530
1379
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2532
proc = MultiprocessingMixIn.process_request(self, request,
1381
super(MultiprocessingMixInWithPipe,
1382
self).process_request(request, client_address)
2534
1383
self.child_pipe.close()
2535
self.add_pipe(parent_pipe, proc)
1384
self.add_pipe(parent_pipe)
2537
def add_pipe(self, parent_pipe, proc):
1386
def add_pipe(self, parent_pipe):
2538
1387
"""Dummy function; override as necessary"""
2539
raise NotImplementedError()
2542
1390
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2543
socketserver.TCPServer):
1391
socketserver.TCPServer, object):
2544
1392
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2547
1395
enabled: Boolean; whether this server is activated yet
2548
1396
interface: None or a network interface name (string)
2549
1397
use_ipv6: Boolean; to use IPv6 or not
2552
1399
def __init__(self, server_address, RequestHandlerClass,
2556
"""If socketfd is set, use that file descriptor instead of
2557
creating a new one with socket.socket().
1400
interface=None, use_ipv6=True):
2559
1401
self.interface = interface
2561
1403
self.address_family = socket.AF_INET6
2562
if socketfd is not None:
2563
# Save the file descriptor
2564
self.socketfd = socketfd
2565
# Save the original socket.socket() function
2566
self.socket_socket = socket.socket
2568
# To implement --socket, we monkey patch socket.socket.
2570
# (When socketserver.TCPServer is a new-style class, we
2571
# could make self.socket into a property instead of monkey
2572
# patching socket.socket.)
2574
# Create a one-time-only replacement for socket.socket()
2575
@functools.wraps(socket.socket)
2576
def socket_wrapper(*args, **kwargs):
2577
# Restore original function so subsequent calls are
2579
socket.socket = self.socket_socket
2580
del self.socket_socket
2581
# This time only, return a new socket object from the
2582
# saved file descriptor.
2583
return socket.fromfd(self.socketfd, *args, **kwargs)
2584
# Replace socket.socket() function with wrapper
2585
socket.socket = socket_wrapper
2586
# The socketserver.TCPServer.__init__ will call
2587
# socket.socket(), which might be our replacement,
2588
# socket_wrapper(), if socketfd was set.
2589
1404
socketserver.TCPServer.__init__(self, server_address,
2590
1405
RequestHandlerClass)
2592
1406
def server_bind(self):
2593
1407
"""This overrides the normal server_bind() function
2594
1408
to bind to an interface if one was specified, and also NOT to
2595
1409
bind to an address or port if they were not specified."""
2596
global SO_BINDTODEVICE
2597
1410
if self.interface is not None:
2598
1411
if SO_BINDTODEVICE is None:
2599
# Fall back to a hard-coded value which seems to be
2601
logger.warning("SO_BINDTODEVICE not found, trying 25")
2602
SO_BINDTODEVICE = 25
2604
self.socket.setsockopt(
2605
socket.SOL_SOCKET, SO_BINDTODEVICE,
2606
(self.interface + "\0").encode("utf-8"))
2607
except socket.error as error:
2608
if error.errno == errno.EPERM:
2609
logger.error("No permission to bind to"
2610
" interface %s", self.interface)
2611
elif error.errno == errno.ENOPROTOOPT:
2612
logger.error("SO_BINDTODEVICE not available;"
2613
" cannot bind to interface %s",
2615
elif error.errno == errno.ENODEV:
2616
logger.error("Interface %s does not exist,"
2617
" cannot bind", self.interface)
1412
logger.error(u"SO_BINDTODEVICE does not exist;"
1413
u" cannot bind to interface %s",
1417
self.socket.setsockopt(socket.SOL_SOCKET,
1421
except socket.error, error:
1422
if error[0] == errno.EPERM:
1423
logger.error(u"No permission to"
1424
u" bind to interface %s",
1426
elif error[0] == errno.ENOPROTOOPT:
1427
logger.error(u"SO_BINDTODEVICE not available;"
1428
u" cannot bind to interface %s",
2620
1432
# Only bind(2) the socket if we really need to.
2621
1433
if self.server_address[0] or self.server_address[1]:
2622
if self.server_address[1]:
2623
self.allow_reuse_address = True
2624
1434
if not self.server_address[0]:
2625
1435
if self.address_family == socket.AF_INET6:
2626
any_address = "::" # in6addr_any
1436
any_address = u"::" # in6addr_any
2628
any_address = "0.0.0.0" # INADDR_ANY
1438
any_address = socket.INADDR_ANY
2629
1439
self.server_address = (any_address,
2630
1440
self.server_address[1])
2631
1441
elif not self.server_address[1]:
2632
self.server_address = (self.server_address[0], 0)
1442
self.server_address = (self.server_address[0],
2633
1444
# if self.interface:
2634
1445
# self.server_address = (self.server_address[0],
2763
def rfc3339_duration_to_delta(duration):
2764
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2766
>>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2768
>>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2770
>>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2772
>>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2774
>>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2776
>>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2778
>>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2782
# Parsing an RFC 3339 duration with regular expressions is not
2783
# possible - there would have to be multiple places for the same
2784
# values, like seconds. The current code, while more esoteric, is
2785
# cleaner without depending on a parsing library. If Python had a
2786
# built-in library for parsing we would use it, but we'd like to
2787
# avoid excessive use of external libraries.
2789
# New type for defining tokens, syntax, and semantics all-in-one
2790
Token = collections.namedtuple("Token", (
2791
"regexp", # To match token; if "value" is not None, must have
2792
# a "group" containing digits
2793
"value", # datetime.timedelta or None
2794
"followers")) # Tokens valid after this token
2795
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2796
# the "duration" ABNF definition in RFC 3339, Appendix A.
2797
token_end = Token(re.compile(r"$"), None, frozenset())
2798
token_second = Token(re.compile(r"(\d+)S"),
2799
datetime.timedelta(seconds=1),
2800
frozenset((token_end, )))
2801
token_minute = Token(re.compile(r"(\d+)M"),
2802
datetime.timedelta(minutes=1),
2803
frozenset((token_second, token_end)))
2804
token_hour = Token(re.compile(r"(\d+)H"),
2805
datetime.timedelta(hours=1),
2806
frozenset((token_minute, token_end)))
2807
token_time = Token(re.compile(r"T"),
2809
frozenset((token_hour, token_minute,
2811
token_day = Token(re.compile(r"(\d+)D"),
2812
datetime.timedelta(days=1),
2813
frozenset((token_time, token_end)))
2814
token_month = Token(re.compile(r"(\d+)M"),
2815
datetime.timedelta(weeks=4),
2816
frozenset((token_day, token_end)))
2817
token_year = Token(re.compile(r"(\d+)Y"),
2818
datetime.timedelta(weeks=52),
2819
frozenset((token_month, token_end)))
2820
token_week = Token(re.compile(r"(\d+)W"),
2821
datetime.timedelta(weeks=1),
2822
frozenset((token_end, )))
2823
token_duration = Token(re.compile(r"P"), None,
2824
frozenset((token_year, token_month,
2825
token_day, token_time,
2827
# Define starting values:
2829
value = datetime.timedelta()
2831
# Following valid tokens
2832
followers = frozenset((token_duration, ))
2833
# String left to parse
2835
# Loop until end token is found
2836
while found_token is not token_end:
2837
# Search for any currently valid tokens
2838
for token in followers:
2839
match = token.regexp.match(s)
2840
if match is not None:
2842
if token.value is not None:
2843
# Value found, parse digits
2844
factor = int(match.group(1), 10)
2845
# Add to value so far
2846
value += factor * token.value
2847
# Strip token from string
2848
s = token.regexp.sub("", s, 1)
2851
# Set valid next tokens
2852
followers = found_token.followers
2855
# No currently valid tokens were found
2856
raise ValueError("Invalid RFC 3339 duration: {!r}"
2862
1559
def string_to_delta(interval):
2863
1560
"""Parse a string and return a datetime.timedelta
2865
>>> string_to_delta('7d') == datetime.timedelta(7)
2867
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2869
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2871
>>> string_to_delta('24h') == datetime.timedelta(1)
2873
>>> string_to_delta('1w') == datetime.timedelta(7)
2875
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
1562
>>> string_to_delta(u'7d')
1563
datetime.timedelta(7)
1564
>>> string_to_delta(u'60s')
1565
datetime.timedelta(0, 60)
1566
>>> string_to_delta(u'60m')
1567
datetime.timedelta(0, 3600)
1568
>>> string_to_delta(u'24h')
1569
datetime.timedelta(1)
1570
>>> string_to_delta(u'1w')
1571
datetime.timedelta(7)
1572
>>> string_to_delta(u'5m 30s')
1573
datetime.timedelta(0, 330)
2880
return rfc3339_duration_to_delta(interval)
2884
1575
timevalue = datetime.timedelta(0)
2885
1576
for s in interval.split():
1578
suffix = unicode(s[-1])
2888
1579
value = int(s[:-1])
2890
1581
delta = datetime.timedelta(value)
1582
elif suffix == u"s":
2892
1583
delta = datetime.timedelta(0, value)
1584
elif suffix == u"m":
2894
1585
delta = datetime.timedelta(0, 0, 0, 0, value)
1586
elif suffix == u"h":
2896
1587
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1588
elif suffix == u"w":
2898
1589
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2900
raise ValueError("Unknown suffix {!r}".format(suffix))
2901
except IndexError as e:
2902
raise ValueError(*(e.args))
1591
raise ValueError(u"Unknown suffix %r" % suffix)
1592
except (ValueError, IndexError), e:
1593
raise ValueError(e.message)
2903
1594
timevalue += delta
2904
1595
return timevalue
2907
def daemon(nochdir=False, noclose=False):
1598
def if_nametoindex(interface):
1599
"""Call the C function if_nametoindex(), or equivalent
1601
Note: This function cannot accept a unicode string."""
1602
global if_nametoindex
1604
if_nametoindex = (ctypes.cdll.LoadLibrary
1605
(ctypes.util.find_library(u"c"))
1607
except (OSError, AttributeError):
1608
logger.warning(u"Doing if_nametoindex the hard way")
1609
def if_nametoindex(interface):
1610
"Get an interface index the hard way, i.e. using fcntl()"
1611
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1612
with contextlib.closing(socket.socket()) as s:
1613
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1614
struct.pack(str(u"16s16x"),
1616
interface_index = struct.unpack(str(u"I"),
1618
return interface_index
1619
return if_nametoindex(interface)
1622
def daemon(nochdir = False, noclose = False):
2908
1623
"""See daemon(3). Standard BSD Unix function.
2910
1625
This should really exist as os.daemon, but it doesn't (yet)."""
2914
1629
if not nochdir:
2918
1633
if not noclose:
2919
1634
# Close all standard open file descriptors
2920
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1635
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2921
1636
if not stat.S_ISCHR(os.fstat(null).st_mode):
2922
1637
raise OSError(errno.ENODEV,
2923
"{} not a character device"
2924
.format(os.devnull))
1638
u"%s not a character device"
2925
1640
os.dup2(null, sys.stdin.fileno())
2926
1641
os.dup2(null, sys.stdout.fileno())
2927
1642
os.dup2(null, sys.stderr.fileno())
2934
1649
##################################################################
2935
1650
# Parsing of options, both command line and config file
2937
parser = argparse.ArgumentParser()
2938
parser.add_argument("-v", "--version", action="version",
2939
version="%(prog)s {}".format(version),
2940
help="show version number and exit")
2941
parser.add_argument("-i", "--interface", metavar="IF",
2942
help="Bind to interface IF")
2943
parser.add_argument("-a", "--address",
2944
help="Address to listen for requests on")
2945
parser.add_argument("-p", "--port", type=int,
2946
help="Port number to receive requests on")
2947
parser.add_argument("--check", action="store_true",
2948
help="Run self-test")
2949
parser.add_argument("--debug", action="store_true",
2950
help="Debug mode; run in foreground and log"
2951
" to terminal", default=None)
2952
parser.add_argument("--debuglevel", metavar="LEVEL",
2953
help="Debug level for stdout output")
2954
parser.add_argument("--priority", help="GnuTLS"
2955
" priority string (see GnuTLS documentation)")
2956
parser.add_argument("--servicename",
2957
metavar="NAME", help="Zeroconf service name")
2958
parser.add_argument("--configdir",
2959
default="/etc/mandos", metavar="DIR",
2960
help="Directory to search for configuration"
2962
parser.add_argument("--no-dbus", action="store_false",
2963
dest="use_dbus", help="Do not provide D-Bus"
2964
" system bus interface", default=None)
2965
parser.add_argument("--no-ipv6", action="store_false",
2966
dest="use_ipv6", help="Do not use IPv6",
2968
parser.add_argument("--no-restore", action="store_false",
2969
dest="restore", help="Do not restore stored"
2970
" state", default=None)
2971
parser.add_argument("--socket", type=int,
2972
help="Specify a file descriptor to a network"
2973
" socket to use instead of creating one")
2974
parser.add_argument("--statedir", metavar="DIR",
2975
help="Directory to save/restore state in")
2976
parser.add_argument("--foreground", action="store_true",
2977
help="Run in foreground", default=None)
2978
parser.add_argument("--no-zeroconf", action="store_false",
2979
dest="zeroconf", help="Do not use Zeroconf",
2982
options = parser.parse_args()
1652
parser = optparse.OptionParser(version = "%%prog %s" % version)
1653
parser.add_option("-i", u"--interface", type=u"string",
1654
metavar="IF", help=u"Bind to interface IF")
1655
parser.add_option("-a", u"--address", type=u"string",
1656
help=u"Address to listen for requests on")
1657
parser.add_option("-p", u"--port", type=u"int",
1658
help=u"Port number to receive requests on")
1659
parser.add_option("--check", action=u"store_true",
1660
help=u"Run self-test")
1661
parser.add_option("--debug", action=u"store_true",
1662
help=u"Debug mode; run in foreground and log to"
1664
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1665
help=u"Debug level for stdout output")
1666
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1667
u" priority string (see GnuTLS documentation)")
1668
parser.add_option("--servicename", type=u"string",
1669
metavar=u"NAME", help=u"Zeroconf service name")
1670
parser.add_option("--configdir", type=u"string",
1671
default=u"/etc/mandos", metavar=u"DIR",
1672
help=u"Directory to search for configuration"
1674
parser.add_option("--no-dbus", action=u"store_false",
1675
dest=u"use_dbus", help=u"Do not provide D-Bus"
1676
u" system bus interface")
1677
parser.add_option("--no-ipv6", action=u"store_false",
1678
dest=u"use_ipv6", help=u"Do not use IPv6")
1679
options = parser.parse_args()[0]
2984
1686
# Default values for config file for server-global settings
2985
if gnutls.has_rawpk:
2986
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2987
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2989
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2990
":+SIGN-DSA-SHA256")
2991
server_defaults = {"interface": "",
2995
"priority": priority,
2996
"servicename": "Mandos",
3002
"statedir": "/var/lib/mandos",
3003
"foreground": "False",
1687
server_defaults = { u"interface": u"",
1692
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1693
u"servicename": u"Mandos",
1694
u"use_dbus": u"True",
1695
u"use_ipv6": u"True",
3008
1699
# Parse config file for server-global settings
3009
server_config = configparser.ConfigParser(server_defaults)
1700
server_config = configparser.SafeConfigParser(server_defaults)
3010
1701
del server_defaults
3011
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3012
# Convert the ConfigParser object to a dict
1702
server_config.read(os.path.join(options.configdir,
1704
# Convert the SafeConfigParser object to a dict
3013
1705
server_settings = server_config.defaults()
3014
1706
# Use the appropriate methods on the non-string config options
3015
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3016
"foreground", "zeroconf"):
3017
server_settings[option] = server_config.getboolean("DEFAULT",
1707
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1708
server_settings[option] = server_config.getboolean(u"DEFAULT",
3019
1710
if server_settings["port"]:
3020
server_settings["port"] = server_config.getint("DEFAULT",
3022
if server_settings["socket"]:
3023
server_settings["socket"] = server_config.getint("DEFAULT",
3025
# Later, stdin will, and stdout and stderr might, be dup'ed
3026
# over with an opened os.devnull. But we don't want this to
3027
# happen with a supplied network socket.
3028
if 0 <= server_settings["socket"] <= 2:
3029
server_settings["socket"] = os.dup(server_settings
1711
server_settings["port"] = server_config.getint(u"DEFAULT",
3031
1713
del server_config
3033
1715
# Override the settings from the config file with command line
3034
1716
# options, if set.
3035
for option in ("interface", "address", "port", "debug",
3036
"priority", "servicename", "configdir", "use_dbus",
3037
"use_ipv6", "debuglevel", "restore", "statedir",
3038
"socket", "foreground", "zeroconf"):
1717
for option in (u"interface", u"address", u"port", u"debug",
1718
u"priority", u"servicename", u"configdir",
1719
u"use_dbus", u"use_ipv6", u"debuglevel"):
3039
1720
value = getattr(options, option)
3040
1721
if value is not None:
3041
1722
server_settings[option] = value
3043
1724
# Force all strings to be unicode
3044
1725
for option in server_settings.keys():
3045
if isinstance(server_settings[option], bytes):
3046
server_settings[option] = (server_settings[option]
3048
# Force all boolean options to be boolean
3049
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3050
"foreground", "zeroconf"):
3051
server_settings[option] = bool(server_settings[option])
3052
# Debug implies foreground
3053
if server_settings["debug"]:
3054
server_settings["foreground"] = True
1726
if type(server_settings[option]) is str:
1727
server_settings[option] = unicode(server_settings[option])
3055
1728
# Now we have our good server settings in "server_settings"
3057
1730
##################################################################
3059
if (not server_settings["zeroconf"]
3060
and not (server_settings["port"]
3061
or server_settings["socket"] != "")):
3062
parser.error("Needs port or socket to work without Zeroconf")
3064
1732
# For convenience
3065
debug = server_settings["debug"]
3066
debuglevel = server_settings["debuglevel"]
3067
use_dbus = server_settings["use_dbus"]
3068
use_ipv6 = server_settings["use_ipv6"]
3069
stored_state_path = os.path.join(server_settings["statedir"],
3071
foreground = server_settings["foreground"]
3072
zeroconf = server_settings["zeroconf"]
3075
initlogger(debug, logging.DEBUG)
3080
level = getattr(logging, debuglevel.upper())
3081
initlogger(debug, level)
3083
if server_settings["servicename"] != "Mandos":
3084
syslogger.setFormatter(
3085
logging.Formatter('Mandos ({}) [%(process)d]:'
3086
' %(levelname)s: %(message)s'.format(
3087
server_settings["servicename"])))
1733
debug = server_settings[u"debug"]
1734
debuglevel = server_settings[u"debuglevel"]
1735
use_dbus = server_settings[u"use_dbus"]
1736
use_ipv6 = server_settings[u"use_ipv6"]
1738
if server_settings[u"servicename"] != u"Mandos":
1739
syslogger.setFormatter(logging.Formatter
1740
(u'Mandos (%s) [%%(process)d]:'
1741
u' %%(levelname)s: %%(message)s'
1742
% server_settings[u"servicename"]))
3089
1744
# Parse config file with clients
3090
client_config = configparser.ConfigParser(Client.client_defaults)
3091
client_config.read(os.path.join(server_settings["configdir"],
1745
client_defaults = { u"timeout": u"1h",
1747
u"checker": u"fping -q -- %%(host)s",
1749
u"approval_delay": u"0s",
1750
u"approval_duration": u"1s",
1752
client_config = configparser.SafeConfigParser(client_defaults)
1753
client_config.read(os.path.join(server_settings[u"configdir"],
3094
1756
global mandos_dbus_service
3095
1757
mandos_dbus_service = None
3098
if server_settings["socket"] != "":
3099
socketfd = server_settings["socket"]
3100
tcp_server = MandosServer(
3101
(server_settings["address"], server_settings["port"]),
3103
interface=(server_settings["interface"] or None),
3105
gnutls_priority=server_settings["priority"],
3109
pidfilename = "/run/mandos.pid"
3110
if not os.path.isdir("/run/."):
3111
pidfilename = "/var/run/mandos.pid"
3114
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3115
except IOError as e:
3116
logger.error("Could not open file %r", pidfilename,
3119
for name, group in (("_mandos", "_mandos"),
3120
("mandos", "mandos"),
3121
("nobody", "nogroup")):
3123
uid = pwd.getpwnam(name).pw_uid
3124
gid = pwd.getpwnam(group).pw_gid
1759
tcp_server = MandosServer((server_settings[u"address"],
1760
server_settings[u"port"]),
1762
interface=(server_settings[u"interface"]
1766
server_settings[u"priority"],
1769
pidfilename = u"/var/run/mandos.pid"
1771
pidfile = open(pidfilename, u"w")
1773
logger.error(u"Could not open file %r", pidfilename)
1776
uid = pwd.getpwnam(u"_mandos").pw_uid
1777
gid = pwd.getpwnam(u"_mandos").pw_gid
1780
uid = pwd.getpwnam(u"mandos").pw_uid
1781
gid = pwd.getpwnam(u"mandos").pw_gid
3126
1782
except KeyError:
1784
uid = pwd.getpwnam(u"nobody").pw_uid
1785
gid = pwd.getpwnam(u"nobody").pw_gid
3135
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3137
except OSError as error:
3138
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3139
.format(uid, gid, os.strerror(error.errno)))
3140
if error.errno != errno.EPERM:
1792
except OSError, error:
1793
if error[0] != errno.EPERM:
1796
if not debug and not debuglevel:
1797
syslogger.setLevel(logging.WARNING)
1798
console.setLevel(logging.WARNING)
1800
level = getattr(logging, debuglevel.upper())
1801
syslogger.setLevel(level)
1802
console.setLevel(level)
3144
1805
# Enable all possible GnuTLS debugging
3146
1807
# "Use a log level over 10 to enable all debugging options."
3147
1808
# - GnuTLS manual
3148
gnutls.global_set_log_level(11)
1809
gnutls.library.functions.gnutls_global_set_log_level(11)
1811
@gnutls.library.types.gnutls_log_func
3151
1812
def debug_gnutls(level, string):
3152
logger.debug("GnuTLS: %s", string[:-1])
3154
gnutls.global_set_log_function(debug_gnutls)
1813
logger.debug(u"GnuTLS: %s", string[:-1])
1815
(gnutls.library.functions
1816
.gnutls_global_set_log_function(debug_gnutls))
3156
1818
# Redirect stdin so all checkers get /dev/null
3157
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1819
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3158
1820
os.dup2(null, sys.stdin.fileno())
3162
# Need to fork before connecting to D-Bus
3164
# Close all input and output, do double fork, etc.
3167
if gi.version_info < (3, 10, 2):
3168
# multiprocessing will use threads, so before we use GLib we
3169
# need to inform GLib that threads will be used.
1824
# No console logging
1825
logger.removeHandler(console)
3172
1828
global main_loop
3173
1829
# From the Avahi example code
3174
DBusGMainLoop(set_as_default=True)
3175
main_loop = GLib.MainLoop()
1830
DBusGMainLoop(set_as_default=True )
1831
main_loop = gobject.MainLoop()
3176
1832
bus = dbus.SystemBus()
3177
1833
# End of Avahi example code
3180
bus_name = dbus.service.BusName("se.recompile.Mandos",
3183
old_bus_name = dbus.service.BusName(
3184
"se.bsnet.fukt.Mandos", bus,
3186
except dbus.exceptions.DBusException as e:
3187
logger.error("Disabling D-Bus:", exc_info=e)
1836
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1837
bus, do_not_queue=True)
1838
except dbus.exceptions.NameExistsException, e:
1839
logger.error(unicode(e) + u", disabling D-Bus")
3188
1840
use_dbus = False
3189
server_settings["use_dbus"] = False
1841
server_settings[u"use_dbus"] = False
3190
1842
tcp_server.use_dbus = False
3192
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3193
service = AvahiServiceToSyslog(
3194
name=server_settings["servicename"],
3195
servicetype="_mandos._tcp",
3198
if server_settings["interface"]:
3199
service.interface = if_nametoindex(
3200
server_settings["interface"].encode("utf-8"))
1843
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1844
service = AvahiService(name = server_settings[u"servicename"],
1845
servicetype = u"_mandos._tcp",
1846
protocol = protocol, bus = bus)
1847
if server_settings["interface"]:
1848
service.interface = (if_nametoindex
1849
(str(server_settings[u"interface"])))
1852
# Close all input and output, do double fork, etc.
3202
1855
global multiprocessing_manager
3203
1856
multiprocessing_manager = multiprocessing.Manager()
3205
1858
client_class = Client
3207
client_class = functools.partial(ClientDBus, bus=bus)
3209
client_settings = Client.config_parser(client_config)
3210
old_client_settings = {}
3213
# This is used to redirect stdout and stderr for checker processes
3215
wnull = open(os.devnull, "w") # A writable /dev/null
3216
# Only used if server is running in foreground but not in debug
3218
if debug or not foreground:
3221
# Get client data and settings from last running state.
3222
if server_settings["restore"]:
3224
with open(stored_state_path, "rb") as stored_state:
3225
if sys.version_info.major == 2:
3226
clients_data, old_client_settings = pickle.load(
3229
bytes_clients_data, bytes_old_client_settings = (
3230
pickle.load(stored_state, encoding="bytes"))
3231
# Fix bytes to strings
3234
clients_data = {(key.decode("utf-8")
3235
if isinstance(key, bytes)
3238
bytes_clients_data.items()}
3239
del bytes_clients_data
3240
for key in clients_data:
3241
value = {(k.decode("utf-8")
3242
if isinstance(k, bytes) else k): v
3244
clients_data[key].items()}
3245
clients_data[key] = value
3247
value["client_structure"] = [
3249
if isinstance(s, bytes)
3251
value["client_structure"]]
3252
# .name, .host, and .checker_command
3253
for k in ("name", "host", "checker_command"):
3254
if isinstance(value[k], bytes):
3255
value[k] = value[k].decode("utf-8")
3256
if "key_id" not in value:
3257
value["key_id"] = ""
3258
elif "fingerprint" not in value:
3259
value["fingerprint"] = ""
3260
# old_client_settings
3262
old_client_settings = {
3263
(key.decode("utf-8")
3264
if isinstance(key, bytes)
3267
bytes_old_client_settings.items()}
3268
del bytes_old_client_settings
3269
# .host and .checker_command
3270
for value in old_client_settings.values():
3271
for attribute in ("host", "checker_command"):
3272
if isinstance(value[attribute], bytes):
3273
value[attribute] = (value[attribute]
3275
os.remove(stored_state_path)
3276
except IOError as e:
3277
if e.errno == errno.ENOENT:
3278
logger.warning("Could not load persistent state:"
3279
" {}".format(os.strerror(e.errno)))
3281
logger.critical("Could not load persistent state:",
3284
except EOFError as e:
3285
logger.warning("Could not load persistent state: "
3289
with PGPEngine() as pgp:
3290
for client_name, client in clients_data.items():
3291
# Skip removed clients
3292
if client_name not in client_settings:
3295
# Decide which value to use after restoring saved state.
3296
# We have three different values: Old config file,
3297
# new config file, and saved state.
3298
# New config value takes precedence if it differs from old
3299
# config value, otherwise use saved state.
3300
for name, value in client_settings[client_name].items():
3302
# For each value in new config, check if it
3303
# differs from the old config value (Except for
3304
# the "secret" attribute)
3305
if (name != "secret"
3307
old_client_settings[client_name][name])):
3308
client[name] = value
3312
# Clients who has passed its expire date can still be
3313
# enabled if its last checker was successful. A Client
3314
# whose checker succeeded before we stored its state is
3315
# assumed to have successfully run all checkers during
3317
if client["enabled"]:
3318
if datetime.datetime.utcnow() >= client["expires"]:
3319
if not client["last_checked_ok"]:
3321
"disabling client {} - Client never "
3322
"performed a successful checker".format(
3324
client["enabled"] = False
3325
elif client["last_checker_status"] != 0:
3327
"disabling client {} - Client last"
3328
" checker failed with error code"
3331
client["last_checker_status"]))
3332
client["enabled"] = False
3334
client["expires"] = (
3335
datetime.datetime.utcnow()
3336
+ client["timeout"])
3337
logger.debug("Last checker succeeded,"
3338
" keeping {} enabled".format(
1860
client_class = functools.partial(ClientDBus, bus = bus)
1861
def client_config_items(config, section):
1862
special_settings = {
1863
"approved_by_default":
1864
lambda: config.getboolean(section,
1865
"approved_by_default"),
1867
for name, value in config.items(section):
3341
client["secret"] = pgp.decrypt(
3342
client["encrypted_secret"],
3343
client_settings[client_name]["secret"])
3345
# If decryption fails, we use secret from new settings
3346
logger.debug("Failed to decrypt {} old secret".format(
3348
client["secret"] = (client_settings[client_name]
3351
# Add/remove clients based on new changes made to config
3352
for client_name in (set(old_client_settings)
3353
- set(client_settings)):
3354
del clients_data[client_name]
3355
for client_name in (set(client_settings)
3356
- set(old_client_settings)):
3357
clients_data[client_name] = client_settings[client_name]
3359
# Create all client objects
3360
for client_name, client in clients_data.items():
3361
tcp_server.clients[client_name] = client_class(
3364
server_settings=server_settings)
1869
yield (name, special_settings[name]())
1873
tcp_server.clients.update(set(
1874
client_class(name = section,
1875
config= dict(client_config_items(
1876
client_config, section)))
1877
for section in client_config.sections()))
3366
1878
if not tcp_server.clients:
3367
logger.warning("No clients defined")
3370
if pidfile is not None:
3374
print(pid, file=pidfile)
3376
logger.error("Could not write to file %r with PID %d",
1879
logger.warning(u"No clients defined")
1885
pidfile.write(str(pid) + "\n")
1888
logger.error(u"Could not write to file %r with PID %d",
1891
# "pidfile" was never created
3379
1893
del pidfilename
3381
for termsig in (signal.SIGHUP, signal.SIGTERM):
3382
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3383
lambda: main_loop.quit() and False)
1895
signal.signal(signal.SIGINT, signal.SIG_IGN)
1897
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1898
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3387
@alternate_dbus_interfaces(
3388
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3389
class MandosDBusService(DBusObjectWithObjectManager):
1901
class MandosDBusService(dbus.service.Object):
3390
1902
"""A D-Bus proxy object"""
3392
1903
def __init__(self):
3393
dbus.service.Object.__init__(self, bus, "/")
3395
_interface = "se.recompile.Mandos"
3397
@dbus.service.signal(_interface, signature="o")
1904
dbus.service.Object.__init__(self, bus, u"/")
1905
_interface = u"se.bsnet.fukt.Mandos"
1907
@dbus.service.signal(_interface, signature=u"o")
3398
1908
def ClientAdded(self, objpath):
3402
@dbus.service.signal(_interface, signature="ss")
3403
def ClientNotFound(self, key_id, address):
1912
@dbus.service.signal(_interface, signature=u"ss")
1913
def ClientNotFound(self, fingerprint, address):
3407
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3409
@dbus.service.signal(_interface, signature="os")
1917
@dbus.service.signal(_interface, signature=u"os")
3410
1918
def ClientRemoved(self, objpath, name):
3414
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3416
@dbus.service.method(_interface, out_signature="ao")
1922
@dbus.service.method(_interface, out_signature=u"ao")
3417
1923
def GetAllClients(self):
3419
return dbus.Array(c.dbus_object_path for c in
3420
tcp_server.clients.values())
3422
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1925
return dbus.Array(c.dbus_object_path
1926
for c in tcp_server.clients)
3424
1928
@dbus.service.method(_interface,
3425
out_signature="a{oa{sv}}")
1929
out_signature=u"a{oa{sv}}")
3426
1930
def GetAllClientsWithProperties(self):
3428
1932
return dbus.Dictionary(
3429
{c.dbus_object_path: c.GetAll(
3430
"se.recompile.Mandos.Client")
3431
for c in tcp_server.clients.values()},
3434
@dbus.service.method(_interface, in_signature="o")
1933
((c.dbus_object_path, c.GetAll(u""))
1934
for c in tcp_server.clients),
1935
signature=u"oa{sv}")
1937
@dbus.service.method(_interface, in_signature=u"o")
3435
1938
def RemoveClient(self, object_path):
3437
for c in tcp_server.clients.values():
1940
for c in tcp_server.clients:
3438
1941
if c.dbus_object_path == object_path:
3439
del tcp_server.clients[c.name]
1942
tcp_server.clients.remove(c)
3440
1943
c.remove_from_connection()
3441
# Don't signal the disabling
1944
# Don't signal anything except ClientRemoved
3442
1945
c.disable(quiet=True)
3443
# Emit D-Bus signal for removal
3444
self.client_removed_signal(c)
1947
self.ClientRemoved(object_path, c.name)
3446
1949
raise KeyError(object_path)
3450
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3451
out_signature="a{oa{sa{sv}}}")
3452
def GetManagedObjects(self):
3454
return dbus.Dictionary(
3455
{client.dbus_object_path:
3457
{interface: client.GetAll(interface)
3459
client._get_all_interface_names()})
3460
for client in tcp_server.clients.values()})
3462
def client_added_signal(self, client):
3463
"""Send the new standard signal and the old signal"""
3465
# New standard signal
3466
self.InterfacesAdded(
3467
client.dbus_object_path,
3469
{interface: client.GetAll(interface)
3471
client._get_all_interface_names()}))
3473
self.ClientAdded(client.dbus_object_path)
3475
def client_removed_signal(self, client):
3476
"""Send the new standard signal and the old signal"""
3478
# New standard signal
3479
self.InterfacesRemoved(
3480
client.dbus_object_path,
3481
client._get_all_interface_names())
3483
self.ClientRemoved(client.dbus_object_path,
3486
1953
mandos_dbus_service = MandosDBusService()
3488
# Save modules to variables to exempt the modules from being
3489
# unloaded before the function registered with atexit() is run.
3490
mp = multiprocessing
3494
1956
"Cleanup function; run on exit"
3498
mp.active_children()
3500
if not (tcp_server.clients or client_settings):
3503
# Store client before exiting. Secrets are encrypted with key
3504
# based on what config file has. If config file is
3505
# removed/edited, old secret will thus be unrecovable.
3507
with PGPEngine() as pgp:
3508
for client in tcp_server.clients.values():
3509
key = client_settings[client.name]["secret"]
3510
client.encrypted_secret = pgp.encrypt(client.secret,
3514
# A list of attributes that can not be pickled
3516
exclude = {"bus", "changedstate", "secret",
3517
"checker", "server_settings"}
3518
for name, typ in inspect.getmembers(dbus.service
3522
client_dict["encrypted_secret"] = (client
3524
for attr in client.client_structure:
3525
if attr not in exclude:
3526
client_dict[attr] = getattr(client, attr)
3528
clients[client.name] = client_dict
3529
del client_settings[client.name]["secret"]
3532
with tempfile.NamedTemporaryFile(
3536
dir=os.path.dirname(stored_state_path),
3537
delete=False) as stored_state:
3538
pickle.dump((clients, client_settings), stored_state,
3540
tempname = stored_state.name
3541
os.rename(tempname, stored_state_path)
3542
except (IOError, OSError) as e:
3548
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3549
logger.warning("Could not save persistent state: {}"
3550
.format(os.strerror(e.errno)))
3552
logger.warning("Could not save persistent state:",
3556
# Delete all clients, and settings from config
3557
1959
while tcp_server.clients:
3558
name, client = tcp_server.clients.popitem()
1960
client = tcp_server.clients.pop()
3560
1962
client.remove_from_connection()
3561
# Don't signal the disabling
1963
client.disable_hook = None
1964
# Don't signal anything except ClientRemoved
3562
1965
client.disable(quiet=True)
3563
# Emit D-Bus signal for removal
3565
mandos_dbus_service.client_removed_signal(client)
3566
client_settings.clear()
1968
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3568
1971
atexit.register(cleanup)
3570
for client in tcp_server.clients.values():
1973
for client in tcp_server.clients:
3572
# Emit D-Bus signal for adding
3573
mandos_dbus_service.client_added_signal(client)
3574
# Need to initiate checking of clients
3576
client.init_checker()
1976
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3578
1979
tcp_server.enable()
3579
1980
tcp_server.server_activate()
3581
1982
# Find out what port we got
3583
service.port = tcp_server.socket.getsockname()[1]
1983
service.port = tcp_server.socket.getsockname()[1]
3585
logger.info("Now listening on address %r, port %d,"
3586
" flowinfo %d, scope_id %d",
3587
*tcp_server.socket.getsockname())
1985
logger.info(u"Now listening on address %r, port %d,"
1986
" flowinfo %d, scope_id %d"
1987
% tcp_server.socket.getsockname())
3589
logger.info("Now listening on address %r, port %d",
3590
*tcp_server.socket.getsockname())
3592
# service.interface = tcp_server.socket.getsockname()[3]
1989
logger.info(u"Now listening on address %r, port %d"
1990
% tcp_server.socket.getsockname())
1992
#service.interface = tcp_server.socket.getsockname()[3]
3596
# From the Avahi example code
3599
except dbus.exceptions.DBusException as error:
3600
logger.critical("D-Bus Exception", exc_info=error)
3603
# End of Avahi example code
3606
GLib.IOChannel.unix_new(tcp_server.fileno()),
3607
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3608
lambda *args, **kwargs: (tcp_server.handle_request
3609
(*args[2:], **kwargs) or True))
3611
logger.debug("Starting main loop")
1995
# From the Avahi example code
1998
except dbus.exceptions.DBusException, error:
1999
logger.critical(u"DBusException: %s", error)
2002
# End of Avahi example code
2004
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2005
lambda *args, **kwargs:
2006
(tcp_server.handle_request
2007
(*args[2:], **kwargs) or True))
2009
logger.debug(u"Starting main loop")
3612
2010
main_loop.run()
3613
except AvahiError as error:
3614
logger.critical("Avahi Error", exc_info=error)
2011
except AvahiError, error:
2012
logger.critical(u"AvahiError: %s", error)
3617
2015
except KeyboardInterrupt:
3619
print("", file=sys.stderr)
3620
logger.debug("Server received KeyboardInterrupt")
3621
logger.debug("Server exiting")
2018
logger.debug(u"Server received KeyboardInterrupt")
2019
logger.debug(u"Server exiting")
3622
2020
# Must run before the D-Bus bus name gets deregistered
3626
def should_only_run_tests():
3627
parser = argparse.ArgumentParser(add_help=False)
3628
parser.add_argument("--check", action='store_true')
3629
args, unknown_args = parser.parse_known_args()
3630
run_tests = args.check
3632
# Remove --check argument from sys.argv
3633
sys.argv[1:] = unknown_args
3636
# Add all tests from doctest strings
3637
def load_tests(loader, tests, none):
3639
tests.addTests(doctest.DocTestSuite())
3642
2023
if __name__ == '__main__':
3644
if should_only_run_tests():
3645
# Call using ./mandos --check [--verbose]