To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 815
- compare with another revision
- download diff
- download tarball
- view history from revision 815
- Committer: Teddy Hogeborn
- Date: 2016-03-02 16:45:38 UTC
- Revision ID: teddy@recompile.se-20160302164538-n9ocll4izthzw1ov
Ignore any error from initramfs-tools' "configure_networking".
* initramfs-tools-script: Wrap call to "configure_networking" with
"set +e" and "set -e", since configure_networking was not designed
to run in a "set -e" environment.
Closes: 816513
Thanks: Carlos Alberto Lopez Perez <clopez@igalia.com>
Thanks: Ben Hutchings <ben@decadent.org.uk>
* initramfs-tools-script: Wrap call to "configure_networking" with
"set +e" and "set -e", since configure_networking was not designed
to run in a "set -e" environment.
Closes: 816513
Thanks: Carlos Alberto Lopez Perez <clopez@igalia.com>
Thanks: Ben Hutchings <ben@decadent.org.uk>
- files added:
- debian/upstream
- plugin-helpers
- files modified:
- DBUS-API
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 Björn Påhlsson
14
# Copyright © 2008-2016 Teddy Hogeborn
15
# Copyright © 2008-2016 Björn Påhlsson
16
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
36
36
37
37
from future_builtins import *
38
38
39
import SocketServer as socketserver
39
try:
40
import SocketServer as socketserver
41
except ImportError:
42
import socketserver
40
43
import socket
41
44
import argparse
42
45
import datetime
43
46
import errno
44
import gnutls.crypto
45
import gnutls.connection
46
import gnutls.errors
47
import gnutls.library.functions
48
import gnutls.library.constants
49
import gnutls.library.types
50
import ConfigParser as configparser
47
try:
48
import ConfigParser as configparser
49
except ImportError:
50
import configparser
51
51
import sys
52
52
import re
53
53
import os
62
62
import struct
63
63
import fcntl
64
64
import functools
65
import cPickle as pickle
65
try:
66
import cPickle as pickle
67
except ImportError:
68
import pickle
66
69
import multiprocessing
67
70
import types
68
71
import binascii
69
72
import tempfile
70
73
import itertools
71
74
import collections
75
import codecs
72
76
73
77
import dbus
74
78
import dbus.service
75
import gobject
79
try:
80
import gobject
81
except ImportError:
82
from gi.repository import GObject as gobject
76
83
import avahi
77
84
from dbus.mainloop.glib import DBusGMainLoop
78
85
import ctypes
88
95
except ImportError:
89
96
SO_BINDTODEVICE = None
90
97
91
version = "1.6.0"
98
if sys.version_info.major == 2:
99
str = unicode
100
101
version = "1.7.3"
92
102
stored_state_file = "clients.pickle"
93
103
94
104
logger = logging.getLogger()
95
syslogger = (logging.handlers.SysLogHandler
96
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
address = str("/dev/log")))
105
syslogger = None
98
106
99
107
try:
100
if_nametoindex = (ctypes.cdll.LoadLibrary
101
(ctypes.util.find_library("c"))
102
.if_nametoindex)
108
if_nametoindex = ctypes.cdll.LoadLibrary(
109
ctypes.util.find_library("c")).if_nametoindex
103
110
except (OSError, AttributeError):
111
104
112
def if_nametoindex(interface):
105
113
"Get an interface index the hard way, i.e. using fcntl()"
106
114
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
107
115
with contextlib.closing(socket.socket()) as s:
108
116
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
109
struct.pack(str("16s16x"),
110
interface))
111
interface_index = struct.unpack(str("I"),
112
ifreq[16:20])[0]
117
struct.pack(b"16s16x", interface))
118
interface_index = struct.unpack("I", ifreq[16:20])[0]
113
119
return interface_index
114
120
115
121
116
122
def initlogger(debug, level=logging.WARNING):
117
123
"""init logger and add loglevel"""
118
124
125
global syslogger
126
syslogger = (logging.handlers.SysLogHandler(
127
facility = logging.handlers.SysLogHandler.LOG_DAEMON,
128
address = "/dev/log"))
119
129
syslogger.setFormatter(logging.Formatter
120
130
('Mandos [%(process)d]: %(levelname)s:'
121
131
' %(message)s'))
138
148
139
149
class PGPEngine(object):
140
150
"""A simple class for OpenPGP symmetric encryption & decryption"""
151
141
152
def __init__(self):
142
153
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
154
self.gpg = "gpg"
155
try:
156
output = subprocess.check_output(["gpgconf"])
157
for line in output.splitlines():
158
name, text, path = line.split(":")
159
if name == "gpg":
160
self.gpg = path
161
break
162
except OSError as e:
163
if e.errno != errno.ENOENT:
164
raise
143
165
self.gnupgargs = ['--batch',
144
'--home', self.tempdir,
166
'--homedir', self.tempdir,
145
167
'--force-mdc',
146
168
'--quiet',
147
169
'--no-use-agent']
172
194
def password_encode(self, password):
173
195
# Passphrase can not be empty and can not contain newlines or
174
196
# NUL bytes. So we prefix it and hex encode it.
175
return b"mandos" + binascii.hexlify(password)
197
encoded = b"mandos" + binascii.hexlify(password)
198
if len(encoded) > 2048:
199
# GnuPG can't handle long passwords, so encode differently
200
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
201
.replace(b"\n", b"\\n")
202
.replace(b"\0", b"\\x00"))
203
return encoded
176
204
177
205
def encrypt(self, data, password):
178
206
passphrase = self.password_encode(password)
179
with tempfile.NamedTemporaryFile(dir=self.tempdir
180
) as passfile:
207
with tempfile.NamedTemporaryFile(
208
dir=self.tempdir) as passfile:
181
209
passfile.write(passphrase)
182
210
passfile.flush()
183
proc = subprocess.Popen(['gpg', '--symmetric',
211
proc = subprocess.Popen([self.gpg, '--symmetric',
184
212
'--passphrase-file',
185
213
passfile.name]
186
214
+ self.gnupgargs,
194
222
195
223
def decrypt(self, data, password):
196
224
passphrase = self.password_encode(password)
197
with tempfile.NamedTemporaryFile(dir = self.tempdir
198
) as passfile:
225
with tempfile.NamedTemporaryFile(
226
dir = self.tempdir) as passfile:
199
227
passfile.write(passphrase)
200
228
passfile.flush()
201
proc = subprocess.Popen(['gpg', '--decrypt',
229
proc = subprocess.Popen([self.gpg, '--decrypt',
202
230
'--passphrase-file',
203
231
passfile.name]
204
232
+ self.gnupgargs,
205
233
stdin = subprocess.PIPE,
206
234
stdout = subprocess.PIPE,
207
235
stderr = subprocess.PIPE)
208
decrypted_plaintext, err = proc.communicate(input
209
= data)
236
decrypted_plaintext, err = proc.communicate(input = data)
210
237
if proc.returncode != 0:
211
238
raise PGPError(err)
212
239
return decrypted_plaintext
215
242
class AvahiError(Exception):
216
243
def __init__(self, value, *args, **kwargs):
217
244
self.value = value
218
super(AvahiError, self).__init__(value, *args, **kwargs)
219
def __unicode__(self):
220
return unicode(repr(self.value))
245
return super(AvahiError, self).__init__(value, *args,
246
**kwargs)
247
221
248
222
249
class AvahiServiceError(AvahiError):
223
250
pass
224
251
252
225
253
class AvahiGroupError(AvahiError):
226
254
pass
227
255
247
275
bus: dbus.SystemBus()
248
276
"""
249
277
250
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
251
servicetype = None, port = None, TXT = None,
252
domain = "", host = "", max_renames = 32768,
253
protocol = avahi.PROTO_UNSPEC, bus = None):
278
def __init__(self,
279
interface = avahi.IF_UNSPEC,
280
name = None,
281
servicetype = None,
282
port = None,
283
TXT = None,
284
domain = "",
285
host = "",
286
max_renames = 32768,
287
protocol = avahi.PROTO_UNSPEC,
288
bus = None):
254
289
self.interface = interface
255
290
self.name = name
256
291
self.type = servicetype
266
301
self.bus = bus
267
302
self.entry_group_state_changed_match = None
268
303
269
def rename(self):
304
def rename(self, remove=True):
270
305
"""Derived from the Avahi example code"""
271
306
if self.rename_count >= self.max_renames:
272
307
logger.critical("No suitable Zeroconf service name found"
273
308
" after %i retries, exiting.",
274
309
self.rename_count)
275
310
raise AvahiServiceError("Too many renames")
276
self.name = unicode(self.server
277
.GetAlternativeServiceName(self.name))
311
self.name = str(
312
self.server.GetAlternativeServiceName(self.name))
313
self.rename_count += 1
278
314
logger.info("Changing Zeroconf service name to %r ...",
279
315
self.name)
280
self.remove()
316
if remove:
317
self.remove()
281
318
try:
282
319
self.add()
283
320
except dbus.exceptions.DBusException as error:
284
logger.critical("D-Bus Exception", exc_info=error)
285
self.cleanup()
286
os._exit(1)
287
self.rename_count += 1
321
if (error.get_dbus_name()
322
== "org.freedesktop.Avahi.CollisionError"):
323
logger.info("Local Zeroconf service name collision.")
324
return self.rename(remove=False)
325
else:
326
logger.critical("D-Bus Exception", exc_info=error)
327
self.cleanup()
328
os._exit(1)
288
329
289
330
def remove(self):
290
331
"""Derived from the Avahi example code"""
328
369
self.rename()
329
370
elif state == avahi.ENTRY_GROUP_FAILURE:
330
371
logger.critical("Avahi: Error in group state changed %s",
331
unicode(error))
332
raise AvahiGroupError("State changed: {0!s}"
333
.format(error))
372
str(error))
373
raise AvahiGroupError("State changed: {!s}".format(error))
334
374
335
375
def cleanup(self):
336
376
"""Derived from the Avahi example code"""
346
386
def server_state_changed(self, state, error=None):
347
387
"""Derived from the Avahi example code"""
348
388
logger.debug("Avahi server state change: %i", state)
349
bad_states = { avahi.SERVER_INVALID:
350
"Zeroconf server invalid",
351
avahi.SERVER_REGISTERING: None,
352
avahi.SERVER_COLLISION:
353
"Zeroconf server name collision",
354
avahi.SERVER_FAILURE:
355
"Zeroconf server failure" }
389
bad_states = {
390
avahi.SERVER_INVALID: "Zeroconf server invalid",
391
avahi.SERVER_REGISTERING: None,
392
avahi.SERVER_COLLISION: "Zeroconf server name collision",
393
avahi.SERVER_FAILURE: "Zeroconf server failure",
394
}
356
395
if state in bad_states:
357
396
if bad_states[state] is not None:
358
397
if error is None:
361
400
logger.error(bad_states[state] + ": %r", error)
362
401
self.cleanup()
363
402
elif state == avahi.SERVER_RUNNING:
364
self.add()
403
try:
404
self.add()
405
except dbus.exceptions.DBusException as error:
406
if (error.get_dbus_name()
407
== "org.freedesktop.Avahi.CollisionError"):
408
logger.info("Local Zeroconf service name"
409
" collision.")
410
return self.rename(remove=False)
411
else:
412
logger.critical("D-Bus Exception", exc_info=error)
413
self.cleanup()
414
os._exit(1)
365
415
else:
366
416
if error is None:
367
417
logger.debug("Unknown state: %r", state)
377
427
follow_name_owner_changes=True),
378
428
avahi.DBUS_INTERFACE_SERVER)
379
429
self.server.connect_to_signal("StateChanged",
380
self.server_state_changed)
430
self.server_state_changed)
381
431
self.server_state_changed(self.server.GetState())
382
432
383
433
384
434
class AvahiServiceToSyslog(AvahiService):
385
def rename(self):
435
def rename(self, *args, **kwargs):
386
436
"""Add the new name to the syslog messages"""
387
ret = AvahiService.rename(self)
388
syslogger.setFormatter(logging.Formatter
389
('Mandos ({0}) [%(process)d]:'
390
' %(levelname)s: %(message)s'
391
.format(self.name)))
437
ret = AvahiService.rename(self, *args, **kwargs)
438
syslogger.setFormatter(logging.Formatter(
439
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
440
.format(self.name)))
392
441
return ret
393
442
394
395
def timedelta_to_milliseconds(td):
396
"Convert a datetime.timedelta() to milliseconds"
397
return ((td.days * 24 * 60 * 60 * 1000)
398
+ (td.seconds * 1000)
399
+ (td.microseconds // 1000))
400
443
# Pretend that we have a GnuTLS module
444
class GnuTLS(object):
445
"""This isn't so much a class as it is a module-like namespace.
446
It is instantiated once, and simulates having a GnuTLS module."""
447
448
_library = ctypes.cdll.LoadLibrary(
449
ctypes.util.find_library("gnutls"))
450
_need_version = "3.3.0"
451
def __init__(self):
452
# Need to use class name "GnuTLS" here, since this method is
453
# called before the assignment to the "gnutls" global variable
454
# happens.
455
if GnuTLS.check_version(self._need_version) is None:
456
raise GnuTLS.Error("Needs GnuTLS {} or later"
457
.format(self._need_version))
458
459
# Unless otherwise indicated, the constants and types below are
460
# all from the gnutls/gnutls.h C header file.
461
462
# Constants
463
E_SUCCESS = 0
464
E_INTERRUPTED = -52
465
E_AGAIN = -28
466
CRT_OPENPGP = 2
467
CLIENT = 2
468
SHUT_RDWR = 0
469
CRD_CERTIFICATE = 1
470
E_NO_CERTIFICATE_FOUND = -49
471
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
472
473
# Types
474
class session_int(ctypes.Structure):
475
_fields_ = []
476
session_t = ctypes.POINTER(session_int)
477
class certificate_credentials_st(ctypes.Structure):
478
_fields_ = []
479
certificate_credentials_t = ctypes.POINTER(
480
certificate_credentials_st)
481
certificate_type_t = ctypes.c_int
482
class datum_t(ctypes.Structure):
483
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
484
('size', ctypes.c_uint)]
485
class openpgp_crt_int(ctypes.Structure):
486
_fields_ = []
487
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
488
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
489
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
490
credentials_type_t = ctypes.c_int #
491
transport_ptr_t = ctypes.c_void_p
492
close_request_t = ctypes.c_int
493
494
# Exceptions
495
class Error(Exception):
496
# We need to use the class name "GnuTLS" here, since this
497
# exception might be raised from within GnuTLS.__init__,
498
# which is called before the assignment to the "gnutls"
499
# global variable has happened.
500
def __init__(self, message = None, code = None, args=()):
501
# Default usage is by a message string, but if a return
502
# code is passed, convert it to a string with
503
# gnutls.strerror()
504
self.code = code
505
if message is None and code is not None:
506
message = GnuTLS.strerror(code)
507
return super(GnuTLS.Error, self).__init__(
508
message, *args)
509
510
class CertificateSecurityError(Error):
511
pass
512
513
# Classes
514
class Credentials(object):
515
def __init__(self):
516
self._c_object = gnutls.certificate_credentials_t()
517
gnutls.certificate_allocate_credentials(
518
ctypes.byref(self._c_object))
519
self.type = gnutls.CRD_CERTIFICATE
520
521
def __del__(self):
522
gnutls.certificate_free_credentials(self._c_object)
523
524
class ClientSession(object):
525
def __init__(self, socket, credentials = None):
526
self._c_object = gnutls.session_t()
527
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
528
gnutls.set_default_priority(self._c_object)
529
gnutls.transport_set_ptr(self._c_object, socket.fileno())
530
gnutls.handshake_set_private_extensions(self._c_object,
531
True)
532
self.socket = socket
533
if credentials is None:
534
credentials = gnutls.Credentials()
535
gnutls.credentials_set(self._c_object, credentials.type,
536
ctypes.cast(credentials._c_object,
537
ctypes.c_void_p))
538
self.credentials = credentials
539
540
def __del__(self):
541
gnutls.deinit(self._c_object)
542
543
def handshake(self):
544
return gnutls.handshake(self._c_object)
545
546
def send(self, data):
547
data = bytes(data)
548
data_len = len(data)
549
while data_len > 0:
550
data_len -= gnutls.record_send(self._c_object,
551
data[-data_len:],
552
data_len)
553
554
def bye(self):
555
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
556
557
# Error handling functions
558
def _error_code(result):
559
"""A function to raise exceptions on errors, suitable
560
for the 'restype' attribute on ctypes functions"""
561
if result >= 0:
562
return result
563
if result == gnutls.E_NO_CERTIFICATE_FOUND:
564
raise gnutls.CertificateSecurityError(code = result)
565
raise gnutls.Error(code = result)
566
567
def _retry_on_error(result, func, arguments):
568
"""A function to retry on some errors, suitable
569
for the 'errcheck' attribute on ctypes functions"""
570
while result < 0:
571
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
572
return _error_code(result)
573
result = func(*arguments)
574
return result
575
576
# Unless otherwise indicated, the function declarations below are
577
# all from the gnutls/gnutls.h C header file.
578
579
# Functions
580
priority_set_direct = _library.gnutls_priority_set_direct
581
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
582
ctypes.POINTER(ctypes.c_char_p)]
583
priority_set_direct.restype = _error_code
584
585
init = _library.gnutls_init
586
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
587
init.restype = _error_code
588
589
set_default_priority = _library.gnutls_set_default_priority
590
set_default_priority.argtypes = [session_t]
591
set_default_priority.restype = _error_code
592
593
record_send = _library.gnutls_record_send
594
record_send.argtypes = [session_t, ctypes.c_void_p,
595
ctypes.c_size_t]
596
record_send.restype = ctypes.c_ssize_t
597
record_send.errcheck = _retry_on_error
598
599
certificate_allocate_credentials = (
600
_library.gnutls_certificate_allocate_credentials)
601
certificate_allocate_credentials.argtypes = [
602
ctypes.POINTER(certificate_credentials_t)]
603
certificate_allocate_credentials.restype = _error_code
604
605
certificate_free_credentials = (
606
_library.gnutls_certificate_free_credentials)
607
certificate_free_credentials.argtypes = [certificate_credentials_t]
608
certificate_free_credentials.restype = None
609
610
handshake_set_private_extensions = (
611
_library.gnutls_handshake_set_private_extensions)
612
handshake_set_private_extensions.argtypes = [session_t,
613
ctypes.c_int]
614
handshake_set_private_extensions.restype = None
615
616
credentials_set = _library.gnutls_credentials_set
617
credentials_set.argtypes = [session_t, credentials_type_t,
618
ctypes.c_void_p]
619
credentials_set.restype = _error_code
620
621
strerror = _library.gnutls_strerror
622
strerror.argtypes = [ctypes.c_int]
623
strerror.restype = ctypes.c_char_p
624
625
certificate_type_get = _library.gnutls_certificate_type_get
626
certificate_type_get.argtypes = [session_t]
627
certificate_type_get.restype = _error_code
628
629
certificate_get_peers = _library.gnutls_certificate_get_peers
630
certificate_get_peers.argtypes = [session_t,
631
ctypes.POINTER(ctypes.c_uint)]
632
certificate_get_peers.restype = ctypes.POINTER(datum_t)
633
634
global_set_log_level = _library.gnutls_global_set_log_level
635
global_set_log_level.argtypes = [ctypes.c_int]
636
global_set_log_level.restype = None
637
638
global_set_log_function = _library.gnutls_global_set_log_function
639
global_set_log_function.argtypes = [log_func]
640
global_set_log_function.restype = None
641
642
deinit = _library.gnutls_deinit
643
deinit.argtypes = [session_t]
644
deinit.restype = None
645
646
handshake = _library.gnutls_handshake
647
handshake.argtypes = [session_t]
648
handshake.restype = _error_code
649
handshake.errcheck = _retry_on_error
650
651
transport_set_ptr = _library.gnutls_transport_set_ptr
652
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
653
transport_set_ptr.restype = None
654
655
bye = _library.gnutls_bye
656
bye.argtypes = [session_t, close_request_t]
657
bye.restype = _error_code
658
bye.errcheck = _retry_on_error
659
660
check_version = _library.gnutls_check_version
661
check_version.argtypes = [ctypes.c_char_p]
662
check_version.restype = ctypes.c_char_p
663
664
# All the function declarations below are from gnutls/openpgp.h
665
666
openpgp_crt_init = _library.gnutls_openpgp_crt_init
667
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
668
openpgp_crt_init.restype = _error_code
669
670
openpgp_crt_import = _library.gnutls_openpgp_crt_import
671
openpgp_crt_import.argtypes = [openpgp_crt_t,
672
ctypes.POINTER(datum_t),
673
openpgp_crt_fmt_t]
674
openpgp_crt_import.restype = _error_code
675
676
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
677
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
678
ctypes.POINTER(ctypes.c_uint)]
679
openpgp_crt_verify_self.restype = _error_code
680
681
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
682
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
683
openpgp_crt_deinit.restype = None
684
685
openpgp_crt_get_fingerprint = (
686
_library.gnutls_openpgp_crt_get_fingerprint)
687
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
688
ctypes.c_void_p,
689
ctypes.POINTER(
690
ctypes.c_size_t)]
691
openpgp_crt_get_fingerprint.restype = _error_code
692
693
# Remove non-public functions
694
del _error_code, _retry_on_error
695
# Create the global "gnutls" object, simulating a module
696
gnutls = GnuTLS()
697
698
def call_pipe(connection, # : multiprocessing.Connection
699
func, *args, **kwargs):
700
"""This function is meant to be called by multiprocessing.Process
701
702
This function runs func(*args, **kwargs), and writes the resulting
703
return value on the provided multiprocessing.Connection.
704
"""
705
connection.send(func(*args, **kwargs))
706
connection.close()
401
707
402
708
class Client(object):
403
709
"""A representation of a client host served by this server.
430
736
last_checker_status: integer between 0 and 255 reflecting exit
431
737
status of last checker. -1 reflects crashed
432
738
checker, -2 means no checker completed yet.
739
last_checker_signal: The signal which killed the last checker, if
740
last_checker_status is -1
433
741
last_enabled: datetime.datetime(); (UTC) or None
434
742
name: string; from the config file, used in log messages and
435
743
D-Bus identifiers
448
756
"fingerprint", "host", "interval",
449
757
"last_approval_request", "last_checked_ok",
450
758
"last_enabled", "name", "timeout")
451
client_defaults = { "timeout": "PT5M",
452
"extended_timeout": "PT15M",
453
"interval": "PT2M",
454
"checker": "fping -q -- %%(host)s",
455
"host": "",
456
"approval_delay": "PT0S",
457
"approval_duration": "PT1S",
458
"approved_by_default": "True",
459
"enabled": "True",
460
}
461
462
def timeout_milliseconds(self):
463
"Return the 'timeout' attribute in milliseconds"
464
return timedelta_to_milliseconds(self.timeout)
465
466
def extended_timeout_milliseconds(self):
467
"Return the 'extended_timeout' attribute in milliseconds"
468
return timedelta_to_milliseconds(self.extended_timeout)
469
470
def interval_milliseconds(self):
471
"Return the 'interval' attribute in milliseconds"
472
return timedelta_to_milliseconds(self.interval)
473
474
def approval_delay_milliseconds(self):
475
return timedelta_to_milliseconds(self.approval_delay)
759
client_defaults = {
760
"timeout": "PT5M",
761
"extended_timeout": "PT15M",
762
"interval": "PT2M",
763
"checker": "fping -q -- %%(host)s",
764
"host": "",
765
"approval_delay": "PT0S",
766
"approval_duration": "PT1S",
767
"approved_by_default": "True",
768
"enabled": "True",
769
}
476
770
477
771
@staticmethod
478
772
def config_parser(config):
494
788
client["enabled"] = config.getboolean(client_name,
495
789
"enabled")
496
790
791
# Uppercase and remove spaces from fingerprint for later
792
# comparison purposes with return value from the
793
# fingerprint() function
497
794
client["fingerprint"] = (section["fingerprint"].upper()
498
795
.replace(" ", ""))
499
796
if "secret" in section:
504
801
"rb") as secfile:
505
802
client["secret"] = secfile.read()
506
803
else:
507
raise TypeError("No secret or secfile for section {0}"
804
raise TypeError("No secret or secfile for section {}"
508
805
.format(section))
509
806
client["timeout"] = string_to_delta(section["timeout"])
510
807
client["extended_timeout"] = string_to_delta(
527
824
server_settings = {}
528
825
self.server_settings = server_settings
529
826
# adding all client settings
530
for setting, value in settings.iteritems():
827
for setting, value in settings.items():
531
828
setattr(self, setting, value)
532
829
533
830
if self.enabled:
541
838
self.expires = None
542
839
543
840
logger.debug("Creating client %r", self.name)
544
# Uppercase and remove spaces from fingerprint for later
545
# comparison purposes with return value from the fingerprint()
546
# function
547
841
logger.debug(" Fingerprint: %s", self.fingerprint)
548
842
self.created = settings.get("created",
549
843
datetime.datetime.utcnow())
556
850
self.current_checker_command = None
557
851
self.approved = None
558
852
self.approvals_pending = 0
559
self.changedstate = (multiprocessing_manager
560
.Condition(multiprocessing_manager
561
.Lock()))
562
self.client_structure = [attr for attr in
563
self.__dict__.iterkeys()
853
self.changedstate = multiprocessing_manager.Condition(
854
multiprocessing_manager.Lock())
855
self.client_structure = [attr
856
for attr in self.__dict__.iterkeys()
564
857
if not attr.startswith("_")]
565
858
self.client_structure.append("client_structure")
566
859
567
for name, t in inspect.getmembers(type(self),
568
lambda obj:
569
isinstance(obj,
570
property)):
860
for name, t in inspect.getmembers(
861
type(self), lambda obj: isinstance(obj, property)):
571
862
if not name.startswith("_"):
572
863
self.client_structure.append(name)
573
864
615
906
# and every interval from then on.
616
907
if self.checker_initiator_tag is not None:
617
908
gobject.source_remove(self.checker_initiator_tag)
618
self.checker_initiator_tag = (gobject.timeout_add
619
(self.interval_milliseconds(),
620
self.start_checker))
909
self.checker_initiator_tag = gobject.timeout_add(
910
int(self.interval.total_seconds() * 1000),
911
self.start_checker)
621
912
# Schedule a disable() when 'timeout' has passed
622
913
if self.disable_initiator_tag is not None:
623
914
gobject.source_remove(self.disable_initiator_tag)
624
self.disable_initiator_tag = (gobject.timeout_add
625
(self.timeout_milliseconds(),
626
self.disable))
915
self.disable_initiator_tag = gobject.timeout_add(
916
int(self.timeout.total_seconds() * 1000), self.disable)
627
917
# Also start a new checker *right now*.
628
918
self.start_checker()
629
919
630
def checker_callback(self, pid, condition, command):
920
def checker_callback(self, source, condition, connection,
921
command):
631
922
"""The checker has completed, so take appropriate actions."""
632
923
self.checker_callback_tag = None
633
924
self.checker = None
634
if os.WIFEXITED(condition):
635
self.last_checker_status = os.WEXITSTATUS(condition)
925
# Read return code from connection (see call_pipe)
926
returncode = connection.recv()
927
connection.close()
928
929
if returncode >= 0:
930
self.last_checker_status = returncode
931
self.last_checker_signal = None
636
932
if self.last_checker_status == 0:
637
933
logger.info("Checker for %(name)s succeeded",
638
934
vars(self))
639
935
self.checked_ok()
640
936
else:
641
logger.info("Checker for %(name)s failed",
642
vars(self))
937
logger.info("Checker for %(name)s failed", vars(self))
643
938
else:
644
939
self.last_checker_status = -1
940
self.last_checker_signal = -returncode
645
941
logger.warning("Checker for %(name)s crashed?",
646
942
vars(self))
943
return False
647
944
648
945
def checked_ok(self):
649
946
"""Assert that the client has been seen, alive and well."""
650
947
self.last_checked_ok = datetime.datetime.utcnow()
651
948
self.last_checker_status = 0
949
self.last_checker_signal = None
652
950
self.bump_timeout()
653
951
654
952
def bump_timeout(self, timeout=None):
659
957
gobject.source_remove(self.disable_initiator_tag)
660
958
self.disable_initiator_tag = None
661
959
if getattr(self, "enabled", False):
662
self.disable_initiator_tag = (gobject.timeout_add
663
(timedelta_to_milliseconds
664
(timeout), self.disable))
960
self.disable_initiator_tag = gobject.timeout_add(
961
int(timeout.total_seconds() * 1000), self.disable)
665
962
self.expires = datetime.datetime.utcnow() + timeout
666
963
667
964
def need_approval(self):
681
978
# than 'timeout' for the client to be disabled, which is as it
682
979
# should be.
683
980
684
# If a checker exists, make sure it is not a zombie
685
try:
686
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
687
except (AttributeError, OSError) as error:
688
if (isinstance(error, OSError)
689
and error.errno != errno.ECHILD):
690
raise error
691
else:
692
if pid:
693
logger.warning("Checker was a zombie")
694
gobject.source_remove(self.checker_callback_tag)
695
self.checker_callback(pid, status,
696
self.current_checker_command)
981
if self.checker is not None and not self.checker.is_alive():
982
logger.warning("Checker was not alive; joining")
983
self.checker.join()
984
self.checker = None
697
985
# Start a new checker if needed
698
986
if self.checker is None:
699
987
# Escape attributes for the shell
700
escaped_attrs = dict(
701
(attr, re.escape(unicode(getattr(self, attr))))
702
for attr in
703
self.runtime_expansions)
988
escaped_attrs = {
989
attr: re.escape(str(getattr(self, attr)))
990
for attr in self.runtime_expansions }
704
991
try:
705
992
command = self.checker_command % escaped_attrs
706
993
except TypeError as error:
707
994
logger.error('Could not format string "%s"',
708
self.checker_command, exc_info=error)
709
return True # Try again later
995
self.checker_command,
996
exc_info=error)
997
return True # Try again later
710
998
self.current_checker_command = command
711
try:
712
logger.info("Starting checker %r for %s",
713
command, self.name)
714
# We don't need to redirect stdout and stderr, since
715
# in normal mode, that is already done by daemon(),
716
# and in debug mode we don't want to. (Stdin is
717
# always replaced by /dev/null.)
718
# The exception is when not debugging but nevertheless
719
# running in the foreground; use the previously
720
# created wnull.
721
popen_args = {}
722
if (not self.server_settings["debug"]
723
and self.server_settings["foreground"]):
724
popen_args.update({"stdout": wnull,
725
"stderr": wnull })
726
self.checker = subprocess.Popen(command,
727
close_fds=True,
728
shell=True, cwd="/",
729
**popen_args)
730
except OSError as error:
731
logger.error("Failed to start subprocess",
732
exc_info=error)
733
return True
734
self.checker_callback_tag = (gobject.child_watch_add
735
(self.checker.pid,
736
self.checker_callback,
737
data=command))
738
# The checker may have completed before the gobject
739
# watch was added. Check for this.
740
try:
741
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
742
except OSError as error:
743
if error.errno == errno.ECHILD:
744
# This should never happen
745
logger.error("Child process vanished",
746
exc_info=error)
747
return True
748
raise
749
if pid:
750
gobject.source_remove(self.checker_callback_tag)
751
self.checker_callback(pid, status, command)
999
logger.info("Starting checker %r for %s", command,
1000
self.name)
1001
# We don't need to redirect stdout and stderr, since
1002
# in normal mode, that is already done by daemon(),
1003
# and in debug mode we don't want to. (Stdin is
1004
# always replaced by /dev/null.)
1005
# The exception is when not debugging but nevertheless
1006
# running in the foreground; use the previously
1007
# created wnull.
1008
popen_args = { "close_fds": True,
1009
"shell": True,
1010
"cwd": "/" }
1011
if (not self.server_settings["debug"]
1012
and self.server_settings["foreground"]):
1013
popen_args.update({"stdout": wnull,
1014
"stderr": wnull })
1015
pipe = multiprocessing.Pipe(duplex = False)
1016
self.checker = multiprocessing.Process(
1017
target = call_pipe,
1018
args = (pipe[1], subprocess.call, command),
1019
kwargs = popen_args)
1020
self.checker.start()
1021
self.checker_callback_tag = gobject.io_add_watch(
1022
pipe[0].fileno(), gobject.IO_IN,
1023
self.checker_callback, pipe[0], command)
752
1024
# Re-run this periodically if run by gobject.timeout_add
753
1025
return True
754
1026
760
1032
if getattr(self, "checker", None) is None:
761
1033
return
762
1034
logger.debug("Stopping checker for %(name)s", vars(self))
763
try:
764
self.checker.terminate()
765
#time.sleep(0.5)
766
#if self.checker.poll() is None:
767
# self.checker.kill()
768
except OSError as error:
769
if error.errno != errno.ESRCH: # No such process
770
raise
1035
self.checker.terminate()
771
1036
self.checker = None
772
1037
773
1038
774
def dbus_service_property(dbus_interface, signature="v",
775
access="readwrite", byte_arrays=False):
1039
def dbus_service_property(dbus_interface,
1040
signature="v",
1041
access="readwrite",
1042
byte_arrays=False):
776
1043
"""Decorators for marking methods of a DBusObjectWithProperties to
777
1044
become properties on the D-Bus.
778
1045
787
1054
# "Set" method, so we fail early here:
788
1055
if byte_arrays and signature != "ay":
789
1056
raise ValueError("Byte arrays not supported for non-'ay'"
790
" signature {0!r}".format(signature))
1057
" signature {!r}".format(signature))
1058
791
1059
def decorator(func):
792
1060
func._dbus_is_property = True
793
1061
func._dbus_interface = dbus_interface
798
1066
func._dbus_name = func._dbus_name[:-14]
799
1067
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
800
1068
return func
1069
801
1070
return decorator
802
1071
803
1072
812
1081
"org.freedesktop.DBus.Property.EmitsChangedSignal":
813
1082
"false"}
814
1083
"""
1084
815
1085
def decorator(func):
816
1086
func._dbus_is_interface = True
817
1087
func._dbus_interface = dbus_interface
818
1088
func._dbus_name = dbus_interface
819
1089
return func
1090
820
1091
return decorator
821
1092
822
1093
824
1095
"""Decorator to annotate D-Bus methods, signals or properties
825
1096
Usage:
826
1097
1098
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1099
"org.freedesktop.DBus.Property."
1100
"EmitsChangedSignal": "false"})
827
1101
@dbus_service_property("org.example.Interface", signature="b",
828
1102
access="r")
829
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
830
"org.freedesktop.DBus.Property."
831
"EmitsChangedSignal": "false"})
832
1103
def Property_dbus_property(self):
833
1104
return dbus.Boolean(False)
1105
1106
See also the DBusObjectWithAnnotations class.
834
1107
"""
1108
835
1109
def decorator(func):
836
1110
func._dbus_annotations = annotations
837
1111
return func
1112
838
1113
return decorator
839
1114
840
1115
841
1116
class DBusPropertyException(dbus.exceptions.DBusException):
842
1117
"""A base class for D-Bus property-related exceptions
843
1118
"""
844
def __unicode__(self):
845
return unicode(str(self))
1119
pass
846
1120
847
1121
848
1122
class DBusPropertyAccessException(DBusPropertyException):
857
1131
pass
858
1132
859
1133
860
class DBusObjectWithProperties(dbus.service.Object):
861
"""A D-Bus object with properties.
1134
class DBusObjectWithAnnotations(dbus.service.Object):
1135
"""A D-Bus object with annotations.
862
1136
863
Classes inheriting from this can use the dbus_service_property
864
decorator to expose methods as D-Bus properties. It exposes the
865
standard Get(), Set(), and GetAll() methods on the D-Bus.
1137
Classes inheriting from this can use the dbus_annotations
1138
decorator to add annotations to methods or signals.
866
1139
"""
867
1140
868
1141
@staticmethod
872
1145
If called like _is_dbus_thing("method") it returns a function
873
1146
suitable for use as predicate to inspect.getmembers().
874
1147
"""
875
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1148
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
876
1149
False)
877
1150
878
1151
def _get_all_dbus_things(self, thing):
879
1152
"""Returns a generator of (name, attribute) pairs
880
1153
"""
881
return ((getattr(athing.__get__(self), "_dbus_name",
882
name),
1154
return ((getattr(athing.__get__(self), "_dbus_name", name),
883
1155
athing.__get__(self))
884
1156
for cls in self.__class__.__mro__
885
1157
for name, athing in
886
inspect.getmembers(cls,
887
self._is_dbus_thing(thing)))
1158
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1159
1160
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1161
out_signature = "s",
1162
path_keyword = 'object_path',
1163
connection_keyword = 'connection')
1164
def Introspect(self, object_path, connection):
1165
"""Overloading of standard D-Bus method.
1166
1167
Inserts annotation tags on methods and signals.
1168
"""
1169
xmlstring = dbus.service.Object.Introspect(self, object_path,
1170
connection)
1171
try:
1172
document = xml.dom.minidom.parseString(xmlstring)
1173
1174
for if_tag in document.getElementsByTagName("interface"):
1175
# Add annotation tags
1176
for typ in ("method", "signal"):
1177
for tag in if_tag.getElementsByTagName(typ):
1178
annots = dict()
1179
for name, prop in (self.
1180
_get_all_dbus_things(typ)):
1181
if (name == tag.getAttribute("name")
1182
and prop._dbus_interface
1183
== if_tag.getAttribute("name")):
1184
annots.update(getattr(
1185
prop, "_dbus_annotations", {}))
1186
for name, value in annots.items():
1187
ann_tag = document.createElement(
1188
"annotation")
1189
ann_tag.setAttribute("name", name)
1190
ann_tag.setAttribute("value", value)
1191
tag.appendChild(ann_tag)
1192
# Add interface annotation tags
1193
for annotation, value in dict(
1194
itertools.chain.from_iterable(
1195
annotations().items()
1196
for name, annotations
1197
in self._get_all_dbus_things("interface")
1198
if name == if_tag.getAttribute("name")
1199
)).items():
1200
ann_tag = document.createElement("annotation")
1201
ann_tag.setAttribute("name", annotation)
1202
ann_tag.setAttribute("value", value)
1203
if_tag.appendChild(ann_tag)
1204
# Fix argument name for the Introspect method itself
1205
if (if_tag.getAttribute("name")
1206
== dbus.INTROSPECTABLE_IFACE):
1207
for cn in if_tag.getElementsByTagName("method"):
1208
if cn.getAttribute("name") == "Introspect":
1209
for arg in cn.getElementsByTagName("arg"):
1210
if (arg.getAttribute("direction")
1211
== "out"):
1212
arg.setAttribute("name",
1213
"xml_data")
1214
xmlstring = document.toxml("utf-8")
1215
document.unlink()
1216
except (AttributeError, xml.dom.DOMException,
1217
xml.parsers.expat.ExpatError) as error:
1218
logger.error("Failed to override Introspection method",
1219
exc_info=error)
1220
return xmlstring
1221
1222
1223
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1224
"""A D-Bus object with properties.
1225
1226
Classes inheriting from this can use the dbus_service_property
1227
decorator to expose methods as D-Bus properties. It exposes the
1228
standard Get(), Set(), and GetAll() methods on the D-Bus.
1229
"""
888
1230
889
1231
def _get_dbus_property(self, interface_name, property_name):
890
1232
"""Returns a bound method if one exists which is a D-Bus
891
1233
property with the specified name and interface.
892
1234
"""
893
for cls in self.__class__.__mro__:
894
for name, value in (inspect.getmembers
895
(cls,
896
self._is_dbus_thing("property"))):
1235
for cls in self.__class__.__mro__:
1236
for name, value in inspect.getmembers(
1237
cls, self._is_dbus_thing("property")):
897
1238
if (value._dbus_name == property_name
898
1239
and value._dbus_interface == interface_name):
899
1240
return value.__get__(self)
900
1241
901
1242
# No such property
902
raise DBusPropertyNotFound(self.dbus_object_path + ":"
903
+ interface_name + "."
904
+ property_name)
905
906
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1243
raise DBusPropertyNotFound("{}:{}.{}".format(
1244
self.dbus_object_path, interface_name, property_name))
1245
1246
@classmethod
1247
def _get_all_interface_names(cls):
1248
"""Get a sequence of all interfaces supported by an object"""
1249
return (name for name in set(getattr(getattr(x, attr),
1250
"_dbus_interface", None)
1251
for x in (inspect.getmro(cls))
1252
for attr in dir(x))
1253
if name is not None)
1254
1255
@dbus.service.method(dbus.PROPERTIES_IFACE,
1256
in_signature="ss",
907
1257
out_signature="v")
908
1258
def Get(self, interface_name, property_name):
909
1259
"""Standard D-Bus property Get() method, see D-Bus standard.
927
1277
# The byte_arrays option is not supported yet on
928
1278
# signatures other than "ay".
929
1279
if prop._dbus_signature != "ay":
930
raise ValueError
1280
raise ValueError("Byte arrays not supported for non-"
1281
"'ay' signature {!r}"
1282
.format(prop._dbus_signature))
931
1283
value = dbus.ByteArray(b''.join(chr(byte)
932
1284
for byte in value))
933
1285
prop(value)
934
1286
935
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1287
@dbus.service.method(dbus.PROPERTIES_IFACE,
1288
in_signature="s",
936
1289
out_signature="a{sv}")
937
1290
def GetAll(self, interface_name):
938
1291
"""Standard D-Bus property GetAll() method, see D-Bus
953
1306
if not hasattr(value, "variant_level"):
954
1307
properties[name] = value
955
1308
continue
956
properties[name] = type(value)(value, variant_level=
957
value.variant_level+1)
1309
properties[name] = type(value)(
1310
value, variant_level = value.variant_level + 1)
958
1311
return dbus.Dictionary(properties, signature="sv")
959
1312
1313
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1314
def PropertiesChanged(self, interface_name, changed_properties,
1315
invalidated_properties):
1316
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1317
standard.
1318
"""
1319
pass
1320
960
1321
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
961
1322
out_signature="s",
962
1323
path_keyword='object_path',
966
1327
967
1328
Inserts property tags and interface annotation tags.
968
1329
"""
969
xmlstring = dbus.service.Object.Introspect(self, object_path,
970
connection)
1330
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1331
object_path,
1332
connection)
971
1333
try:
972
1334
document = xml.dom.minidom.parseString(xmlstring)
1335
973
1336
def make_tag(document, name, prop):
974
1337
e = document.createElement("property")
975
1338
e.setAttribute("name", name)
976
1339
e.setAttribute("type", prop._dbus_signature)
977
1340
e.setAttribute("access", prop._dbus_access)
978
1341
return e
1342
979
1343
for if_tag in document.getElementsByTagName("interface"):
980
1344
# Add property tags
981
1345
for tag in (make_tag(document, name, prop)
984
1348
if prop._dbus_interface
985
1349
== if_tag.getAttribute("name")):
986
1350
if_tag.appendChild(tag)
987
# Add annotation tags
988
for typ in ("method", "signal", "property"):
989
for tag in if_tag.getElementsByTagName(typ):
990
annots = dict()
991
for name, prop in (self.
992
_get_all_dbus_things(typ)):
993
if (name == tag.getAttribute("name")
994
and prop._dbus_interface
995
== if_tag.getAttribute("name")):
996
annots.update(getattr
997
(prop,
998
"_dbus_annotations",
999
{}))
1000
for name, value in annots.iteritems():
1001
ann_tag = document.createElement(
1002
"annotation")
1003
ann_tag.setAttribute("name", name)
1004
ann_tag.setAttribute("value", value)
1005
tag.appendChild(ann_tag)
1006
# Add interface annotation tags
1007
for annotation, value in dict(
1008
itertools.chain.from_iterable(
1009
annotations().iteritems()
1010
for name, annotations in
1011
self._get_all_dbus_things("interface")
1012
if name == if_tag.getAttribute("name")
1013
)).iteritems():
1014
ann_tag = document.createElement("annotation")
1015
ann_tag.setAttribute("name", annotation)
1016
ann_tag.setAttribute("value", value)
1017
if_tag.appendChild(ann_tag)
1351
# Add annotation tags for properties
1352
for tag in if_tag.getElementsByTagName("property"):
1353
annots = dict()
1354
for name, prop in self._get_all_dbus_things(
1355
"property"):
1356
if (name == tag.getAttribute("name")
1357
and prop._dbus_interface
1358
== if_tag.getAttribute("name")):
1359
annots.update(getattr(
1360
prop, "_dbus_annotations", {}))
1361
for name, value in annots.items():
1362
ann_tag = document.createElement(
1363
"annotation")
1364
ann_tag.setAttribute("name", name)
1365
ann_tag.setAttribute("value", value)
1366
tag.appendChild(ann_tag)
1018
1367
# Add the names to the return values for the
1019
1368
# "org.freedesktop.DBus.Properties" methods
1020
1369
if (if_tag.getAttribute("name")
1038
1387
exc_info=error)
1039
1388
return xmlstring
1040
1389
1390
try:
1391
dbus.OBJECT_MANAGER_IFACE
1392
except AttributeError:
1393
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1394
1395
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1396
"""A D-Bus object with an ObjectManager.
1397
1398
Classes inheriting from this exposes the standard
1399
GetManagedObjects call and the InterfacesAdded and
1400
InterfacesRemoved signals on the standard
1401
"org.freedesktop.DBus.ObjectManager" interface.
1402
1403
Note: No signals are sent automatically; they must be sent
1404
manually.
1405
"""
1406
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1407
out_signature = "a{oa{sa{sv}}}")
1408
def GetManagedObjects(self):
1409
"""This function must be overridden"""
1410
raise NotImplementedError()
1411
1412
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1413
signature = "oa{sa{sv}}")
1414
def InterfacesAdded(self, object_path, interfaces_and_properties):
1415
pass
1416
1417
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1418
def InterfacesRemoved(self, object_path, interfaces):
1419
pass
1420
1421
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1422
out_signature = "s",
1423
path_keyword = 'object_path',
1424
connection_keyword = 'connection')
1425
def Introspect(self, object_path, connection):
1426
"""Overloading of standard D-Bus method.
1427
1428
Override return argument name of GetManagedObjects to be
1429
"objpath_interfaces_and_properties"
1430
"""
1431
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1432
object_path,
1433
connection)
1434
try:
1435
document = xml.dom.minidom.parseString(xmlstring)
1436
1437
for if_tag in document.getElementsByTagName("interface"):
1438
# Fix argument name for the GetManagedObjects method
1439
if (if_tag.getAttribute("name")
1440
== dbus.OBJECT_MANAGER_IFACE):
1441
for cn in if_tag.getElementsByTagName("method"):
1442
if (cn.getAttribute("name")
1443
== "GetManagedObjects"):
1444
for arg in cn.getElementsByTagName("arg"):
1445
if (arg.getAttribute("direction")
1446
== "out"):
1447
arg.setAttribute(
1448
"name",
1449
"objpath_interfaces"
1450
"_and_properties")
1451
xmlstring = document.toxml("utf-8")
1452
document.unlink()
1453
except (AttributeError, xml.dom.DOMException,
1454
xml.parsers.expat.ExpatError) as error:
1455
logger.error("Failed to override Introspection method",
1456
exc_info = error)
1457
return xmlstring
1041
1458
1042
1459
def datetime_to_dbus(dt, variant_level=0):
1043
1460
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1044
1461
if dt is None:
1045
1462
return dbus.String("", variant_level = variant_level)
1046
return dbus.String(dt.isoformat(),
1047
variant_level=variant_level)
1463
return dbus.String(dt.isoformat(), variant_level=variant_level)
1048
1464
1049
1465
1050
1466
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1070
1486
(from DBusObjectWithProperties) and interfaces (from the
1071
1487
dbus_interface_annotations decorator).
1072
1488
"""
1489
1073
1490
def wrapper(cls):
1074
1491
for orig_interface_name, alt_interface_name in (
1075
alt_interface_names.iteritems()):
1492
alt_interface_names.items()):
1076
1493
attr = {}
1077
1494
interface_names = set()
1078
1495
# Go though all attributes of the class
1080
1497
# Ignore non-D-Bus attributes, and D-Bus attributes
1081
1498
# with the wrong interface name
1082
1499
if (not hasattr(attribute, "_dbus_interface")
1083
or not attribute._dbus_interface
1084
.startswith(orig_interface_name)):
1500
or not attribute._dbus_interface.startswith(
1501
orig_interface_name)):
1085
1502
continue
1086
1503
# Create an alternate D-Bus interface name based on
1087
1504
# the current name
1088
alt_interface = (attribute._dbus_interface
1089
.replace(orig_interface_name,
1090
alt_interface_name))
1505
alt_interface = attribute._dbus_interface.replace(
1506
orig_interface_name, alt_interface_name)
1091
1507
interface_names.add(alt_interface)
1092
1508
# Is this a D-Bus signal?
1093
1509
if getattr(attribute, "_dbus_is_signal", False):
1094
# Extract the original non-method undecorated
1095
# function by black magic
1096
nonmethod_func = (dict(
1510
if sys.version_info.major == 2:
1511
# Extract the original non-method undecorated
1512
# function by black magic
1513
nonmethod_func = (dict(
1097
1514
zip(attribute.func_code.co_freevars,
1098
attribute.__closure__))["func"]
1099
.cell_contents)
1515
attribute.__closure__))
1516
["func"].cell_contents)
1517
else:
1518
nonmethod_func = attribute
1100
1519
# Create a new, but exactly alike, function
1101
1520
# object, and decorate it to be a new D-Bus signal
1102
1521
# with the alternate D-Bus interface name
1103
new_function = (dbus.service.signal
1104
(alt_interface,
1105
attribute._dbus_signature)
1106
(types.FunctionType(
1107
nonmethod_func.func_code,
1108
nonmethod_func.func_globals,
1109
nonmethod_func.func_name,
1110
nonmethod_func.func_defaults,
1111
nonmethod_func.func_closure)))
1522
if sys.version_info.major == 2:
1523
new_function = types.FunctionType(
1524
nonmethod_func.func_code,
1525
nonmethod_func.func_globals,
1526
nonmethod_func.func_name,
1527
nonmethod_func.func_defaults,
1528
nonmethod_func.func_closure)
1529
else:
1530
new_function = types.FunctionType(
1531
nonmethod_func.__code__,
1532
nonmethod_func.__globals__,
1533
nonmethod_func.__name__,
1534
nonmethod_func.__defaults__,
1535
nonmethod_func.__closure__)
1536
new_function = (dbus.service.signal(
1537
alt_interface,
1538
attribute._dbus_signature)(new_function))
1112
1539
# Copy annotations, if any
1113
1540
try:
1114
new_function._dbus_annotations = (
1115
dict(attribute._dbus_annotations))
1541
new_function._dbus_annotations = dict(
1542
attribute._dbus_annotations)
1116
1543
except AttributeError:
1117
1544
pass
1118
1545
# Define a creator of a function to call both the
1123
1550
"""This function is a scope container to pass
1124
1551
func1 and func2 to the "call_both" function
1125
1552
outside of its arguments"""
1553
1554
@functools.wraps(func2)
1126
1555
def call_both(*args, **kwargs):
1127
1556
"""This function will emit two D-Bus
1128
1557
signals by calling func1 and func2"""
1129
1558
func1(*args, **kwargs)
1130
1559
func2(*args, **kwargs)
1560
# Make wrapper function look like a D-Bus signal
1561
for name, attr in inspect.getmembers(func2):
1562
if name.startswith("_dbus_"):
1563
setattr(call_both, name, attr)
1564
1131
1565
return call_both
1132
1566
# Create the "call_both" function and add it to
1133
1567
# the class
1138
1572
# object. Decorate it to be a new D-Bus method
1139
1573
# with the alternate D-Bus interface name. Add it
1140
1574
# to the class.
1141
attr[attrname] = (dbus.service.method
1142
(alt_interface,
1143
attribute._dbus_in_signature,
1144
attribute._dbus_out_signature)
1145
(types.FunctionType
1146
(attribute.func_code,
1147
attribute.func_globals,
1148
attribute.func_name,
1149
attribute.func_defaults,
1150
attribute.func_closure)))
1575
attr[attrname] = (
1576
dbus.service.method(
1577
alt_interface,
1578
attribute._dbus_in_signature,
1579
attribute._dbus_out_signature)
1580
(types.FunctionType(attribute.func_code,
1581
attribute.func_globals,
1582
attribute.func_name,
1583
attribute.func_defaults,
1584
attribute.func_closure)))
1151
1585
# Copy annotations, if any
1152
1586
try:
1153
attr[attrname]._dbus_annotations = (
1154
dict(attribute._dbus_annotations))
1587
attr[attrname]._dbus_annotations = dict(
1588
attribute._dbus_annotations)
1155
1589
except AttributeError:
1156
1590
pass
1157
1591
# Is this a D-Bus property?
1160
1594
# object, and decorate it to be a new D-Bus
1161
1595
# property with the alternate D-Bus interface
1162
1596
# name. Add it to the class.
1163
attr[attrname] = (dbus_service_property
1164
(alt_interface,
1165
attribute._dbus_signature,
1166
attribute._dbus_access,
1167
attribute
1168
._dbus_get_args_options
1169
["byte_arrays"])
1170
(types.FunctionType
1171
(attribute.func_code,
1172
attribute.func_globals,
1173
attribute.func_name,
1174
attribute.func_defaults,
1175
attribute.func_closure)))
1597
attr[attrname] = (dbus_service_property(
1598
alt_interface, attribute._dbus_signature,
1599
attribute._dbus_access,
1600
attribute._dbus_get_args_options
1601
["byte_arrays"])
1602
(types.FunctionType(
1603
attribute.func_code,
1604
attribute.func_globals,
1605
attribute.func_name,
1606
attribute.func_defaults,
1607
attribute.func_closure)))
1176
1608
# Copy annotations, if any
1177
1609
try:
1178
attr[attrname]._dbus_annotations = (
1179
dict(attribute._dbus_annotations))
1610
attr[attrname]._dbus_annotations = dict(
1611
attribute._dbus_annotations)
1180
1612
except AttributeError:
1181
1613
pass
1182
1614
# Is this a D-Bus interface?
1185
1617
# object. Decorate it to be a new D-Bus interface
1186
1618
# with the alternate D-Bus interface name. Add it
1187
1619
# to the class.
1188
attr[attrname] = (dbus_interface_annotations
1189
(alt_interface)
1190
(types.FunctionType
1191
(attribute.func_code,
1192
attribute.func_globals,
1193
attribute.func_name,
1194
attribute.func_defaults,
1195
attribute.func_closure)))
1620
attr[attrname] = (
1621
dbus_interface_annotations(alt_interface)
1622
(types.FunctionType(attribute.func_code,
1623
attribute.func_globals,
1624
attribute.func_name,
1625
attribute.func_defaults,
1626
attribute.func_closure)))
1196
1627
if deprecate:
1197
1628
# Deprecate all alternate interfaces
1198
iname="_AlternateDBusNames_interface_annotation{0}"
1629
iname="_AlternateDBusNames_interface_annotation{}"
1199
1630
for interface_name in interface_names:
1631
1200
1632
@dbus_interface_annotations(interface_name)
1201
1633
def func(self):
1202
1634
return { "org.freedesktop.DBus.Deprecated":
1203
"true" }
1635
"true" }
1204
1636
# Find an unused name
1205
1637
for aname in (iname.format(i)
1206
1638
for i in itertools.count()):
1210
1642
if interface_names:
1211
1643
# Replace the class with a new subclass of it with
1212
1644
# methods, signals, etc. as created above.
1213
cls = type(b"{0}Alternate".format(cls.__name__),
1214
(cls,), attr)
1645
cls = type(b"{}Alternate".format(cls.__name__),
1646
(cls, ), attr)
1215
1647
return cls
1648
1216
1649
return wrapper
1217
1650
1218
1651
1219
1652
@alternate_dbus_interfaces({"se.recompile.Mandos":
1220
"se.bsnet.fukt.Mandos"})
1653
"se.bsnet.fukt.Mandos"})
1221
1654
class ClientDBus(Client, DBusObjectWithProperties):
1222
1655
"""A Client class using D-Bus
1223
1656
1227
1660
"""
1228
1661
1229
1662
runtime_expansions = (Client.runtime_expansions
1230
+ ("dbus_object_path",))
1663
+ ("dbus_object_path", ))
1664
1665
_interface = "se.recompile.Mandos.Client"
1231
1666
1232
1667
# dbus.service.Object doesn't use super(), so we can't either.
1233
1668
1236
1671
Client.__init__(self, *args, **kwargs)
1237
1672
# Only now, when this client is initialized, can it show up on
1238
1673
# the D-Bus
1239
client_object_name = unicode(self.name).translate(
1674
client_object_name = str(self.name).translate(
1240
1675
{ord("."): ord("_"),
1241
1676
ord("-"): ord("_")})
1242
self.dbus_object_path = (dbus.ObjectPath
1243
("/clients/" + client_object_name))
1677
self.dbus_object_path = dbus.ObjectPath(
1678
"/clients/" + client_object_name)
1244
1679
DBusObjectWithProperties.__init__(self, self.bus,
1245
1680
self.dbus_object_path)
1246
1681
1247
def notifychangeproperty(transform_func,
1248
dbus_name, type_func=lambda x: x,
1249
variant_level=1):
1682
def notifychangeproperty(transform_func, dbus_name,
1683
type_func=lambda x: x,
1684
variant_level=1,
1685
invalidate_only=False,
1686
_interface=_interface):
1250
1687
""" Modify a variable so that it's a property which announces
1251
1688
its changes to DBus.
1252
1689
1257
1694
to the D-Bus. Default: no transform
1258
1695
variant_level: D-Bus variant level. Default: 1
1259
1696
"""
1260
attrname = "_{0}".format(dbus_name)
1697
attrname = "_{}".format(dbus_name)
1698
1261
1699
def setter(self, value):
1262
1700
if hasattr(self, "dbus_object_path"):
1263
1701
if (not hasattr(self, attrname) or
1264
1702
type_func(getattr(self, attrname, None))
1265
1703
!= type_func(value)):
1266
dbus_value = transform_func(type_func(value),
1267
variant_level
1268
=variant_level)
1269
self.PropertyChanged(dbus.String(dbus_name),
1270
dbus_value)
1704
if invalidate_only:
1705
self.PropertiesChanged(
1706
_interface, dbus.Dictionary(),
1707
dbus.Array((dbus_name, )))
1708
else:
1709
dbus_value = transform_func(
1710
type_func(value),
1711
variant_level = variant_level)
1712
self.PropertyChanged(dbus.String(dbus_name),
1713
dbus_value)
1714
self.PropertiesChanged(
1715
_interface,
1716
dbus.Dictionary({ dbus.String(dbus_name):
1717
dbus_value }),
1718
dbus.Array())
1271
1719
setattr(self, attrname, value)
1272
1720
1273
1721
return property(lambda self: getattr(self, attrname), setter)
1279
1727
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1280
1728
last_enabled = notifychangeproperty(datetime_to_dbus,
1281
1729
"LastEnabled")
1282
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1283
type_func = lambda checker:
1284
checker is not None)
1730
checker = notifychangeproperty(
1731
dbus.Boolean, "CheckerRunning",
1732
type_func = lambda checker: checker is not None)
1285
1733
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1286
1734
"LastCheckedOK")
1287
1735
last_checker_status = notifychangeproperty(dbus.Int16,
1290
1738
datetime_to_dbus, "LastApprovalRequest")
1291
1739
approved_by_default = notifychangeproperty(dbus.Boolean,
1292
1740
"ApprovedByDefault")
1293
approval_delay = notifychangeproperty(dbus.UInt64,
1294
"ApprovalDelay",
1295
type_func =
1296
timedelta_to_milliseconds)
1741
approval_delay = notifychangeproperty(
1742
dbus.UInt64, "ApprovalDelay",
1743
type_func = lambda td: td.total_seconds() * 1000)
1297
1744
approval_duration = notifychangeproperty(
1298
1745
dbus.UInt64, "ApprovalDuration",
1299
type_func = timedelta_to_milliseconds)
1746
type_func = lambda td: td.total_seconds() * 1000)
1300
1747
host = notifychangeproperty(dbus.String, "Host")
1301
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1302
type_func =
1303
timedelta_to_milliseconds)
1748
timeout = notifychangeproperty(
1749
dbus.UInt64, "Timeout",
1750
type_func = lambda td: td.total_seconds() * 1000)
1304
1751
extended_timeout = notifychangeproperty(
1305
1752
dbus.UInt64, "ExtendedTimeout",
1306
type_func = timedelta_to_milliseconds)
1307
interval = notifychangeproperty(dbus.UInt64,
1308
"Interval",
1309
type_func =
1310
timedelta_to_milliseconds)
1753
type_func = lambda td: td.total_seconds() * 1000)
1754
interval = notifychangeproperty(
1755
dbus.UInt64, "Interval",
1756
type_func = lambda td: td.total_seconds() * 1000)
1311
1757
checker_command = notifychangeproperty(dbus.String, "Checker")
1758
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1759
invalidate_only=True)
1312
1760
1313
1761
del notifychangeproperty
1314
1762
1321
1769
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1322
1770
Client.__del__(self, *args, **kwargs)
1323
1771
1324
def checker_callback(self, pid, condition, command,
1325
*args, **kwargs):
1326
self.checker_callback_tag = None
1327
self.checker = None
1328
if os.WIFEXITED(condition):
1329
exitstatus = os.WEXITSTATUS(condition)
1772
def checker_callback(self, source, condition,
1773
connection, command, *args, **kwargs):
1774
ret = Client.checker_callback(self, source, condition,
1775
connection, command, *args,
1776
**kwargs)
1777
exitstatus = self.last_checker_status
1778
if exitstatus >= 0:
1330
1779
# Emit D-Bus signal
1331
1780
self.CheckerCompleted(dbus.Int16(exitstatus),
1332
dbus.Int64(condition),
1781
# This is specific to GNU libC
1782
dbus.Int64(exitstatus << 8),
1333
1783
dbus.String(command))
1334
1784
else:
1335
1785
# Emit D-Bus signal
1336
1786
self.CheckerCompleted(dbus.Int16(-1),
1337
dbus.Int64(condition),
1787
dbus.Int64(
1788
# This is specific to GNU libC
1789
(exitstatus << 8)
1790
| self.last_checker_signal),
1338
1791
dbus.String(command))
1339
1340
return Client.checker_callback(self, pid, condition, command,
1341
*args, **kwargs)
1792
return ret
1342
1793
1343
1794
def start_checker(self, *args, **kwargs):
1344
old_checker = self.checker
1345
if self.checker is not None:
1346
old_checker_pid = self.checker.pid
1347
else:
1348
old_checker_pid = None
1795
old_checker_pid = getattr(self.checker, "pid", None)
1349
1796
r = Client.start_checker(self, *args, **kwargs)
1350
1797
# Only if new checker process was started
1351
1798
if (self.checker is not None
1360
1807
1361
1808
def approve(self, value=True):
1362
1809
self.approved = value
1363
gobject.timeout_add(timedelta_to_milliseconds
1364
(self.approval_duration),
1365
self._reset_approved)
1810
gobject.timeout_add(int(self.approval_duration.total_seconds()
1811
* 1000), self._reset_approved)
1366
1812
self.send_changedstate()
1367
1813
1368
1814
## D-Bus methods, signals & properties
1369
_interface = "se.recompile.Mandos.Client"
1370
1815
1371
1816
## Interfaces
1372
1817
1373
@dbus_interface_annotations(_interface)
1374
def _foo(self):
1375
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1376
"false"}
1377
1378
1818
## Signals
1379
1819
1380
1820
# CheckerCompleted - signal
1390
1830
pass
1391
1831
1392
1832
# PropertyChanged - signal
1833
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1393
1834
@dbus.service.signal(_interface, signature="sv")
1394
1835
def PropertyChanged(self, property, value):
1395
1836
"D-Bus signal"
1429
1870
self.checked_ok()
1430
1871
1431
1872
# Enable - method
1873
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1432
1874
@dbus.service.method(_interface)
1433
1875
def Enable(self):
1434
1876
"D-Bus method"
1435
1877
self.enable()
1436
1878
1437
1879
# StartChecker - method
1880
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1438
1881
@dbus.service.method(_interface)
1439
1882
def StartChecker(self):
1440
1883
"D-Bus method"
1441
1884
self.start_checker()
1442
1885
1443
1886
# Disable - method
1887
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1444
1888
@dbus.service.method(_interface)
1445
1889
def Disable(self):
1446
1890
"D-Bus method"
1447
1891
self.disable()
1448
1892
1449
1893
# StopChecker - method
1894
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1450
1895
@dbus.service.method(_interface)
1451
1896
def StopChecker(self):
1452
1897
self.stop_checker()
1459
1904
return dbus.Boolean(bool(self.approvals_pending))
1460
1905
1461
1906
# ApprovedByDefault - property
1462
@dbus_service_property(_interface, signature="b",
1907
@dbus_service_property(_interface,
1908
signature="b",
1463
1909
access="readwrite")
1464
1910
def ApprovedByDefault_dbus_property(self, value=None):
1465
1911
if value is None: # get
1467
1913
self.approved_by_default = bool(value)
1468
1914
1469
1915
# ApprovalDelay - property
1470
@dbus_service_property(_interface, signature="t",
1916
@dbus_service_property(_interface,
1917
signature="t",
1471
1918
access="readwrite")
1472
1919
def ApprovalDelay_dbus_property(self, value=None):
1473
1920
if value is None: # get
1474
return dbus.UInt64(self.approval_delay_milliseconds())
1921
return dbus.UInt64(self.approval_delay.total_seconds()
1922
* 1000)
1475
1923
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1476
1924
1477
1925
# ApprovalDuration - property
1478
@dbus_service_property(_interface, signature="t",
1926
@dbus_service_property(_interface,
1927
signature="t",
1479
1928
access="readwrite")
1480
1929
def ApprovalDuration_dbus_property(self, value=None):
1481
1930
if value is None: # get
1482
return dbus.UInt64(timedelta_to_milliseconds(
1483
self.approval_duration))
1931
return dbus.UInt64(self.approval_duration.total_seconds()
1932
* 1000)
1484
1933
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1485
1934
1486
1935
# Name - property
1936
@dbus_annotations(
1937
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1487
1938
@dbus_service_property(_interface, signature="s", access="read")
1488
1939
def Name_dbus_property(self):
1489
1940
return dbus.String(self.name)
1490
1941
1491
1942
# Fingerprint - property
1943
@dbus_annotations(
1944
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1492
1945
@dbus_service_property(_interface, signature="s", access="read")
1493
1946
def Fingerprint_dbus_property(self):
1494
1947
return dbus.String(self.fingerprint)
1495
1948
1496
1949
# Host - property
1497
@dbus_service_property(_interface, signature="s",
1950
@dbus_service_property(_interface,
1951
signature="s",
1498
1952
access="readwrite")
1499
1953
def Host_dbus_property(self, value=None):
1500
1954
if value is None: # get
1501
1955
return dbus.String(self.host)
1502
self.host = unicode(value)
1956
self.host = str(value)
1503
1957
1504
1958
# Created - property
1959
@dbus_annotations(
1960
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1505
1961
@dbus_service_property(_interface, signature="s", access="read")
1506
1962
def Created_dbus_property(self):
1507
1963
return datetime_to_dbus(self.created)
1512
1968
return datetime_to_dbus(self.last_enabled)
1513
1969
1514
1970
# Enabled - property
1515
@dbus_service_property(_interface, signature="b",
1971
@dbus_service_property(_interface,
1972
signature="b",
1516
1973
access="readwrite")
1517
1974
def Enabled_dbus_property(self, value=None):
1518
1975
if value is None: # get
1523
1980
self.disable()
1524
1981
1525
1982
# LastCheckedOK - property
1526
@dbus_service_property(_interface, signature="s",
1983
@dbus_service_property(_interface,
1984
signature="s",
1527
1985
access="readwrite")
1528
1986
def LastCheckedOK_dbus_property(self, value=None):
1529
1987
if value is not None:
1532
1990
return datetime_to_dbus(self.last_checked_ok)
1533
1991
1534
1992
# LastCheckerStatus - property
1535
@dbus_service_property(_interface, signature="n",
1536
access="read")
1993
@dbus_service_property(_interface, signature="n", access="read")
1537
1994
def LastCheckerStatus_dbus_property(self):
1538
1995
return dbus.Int16(self.last_checker_status)
1539
1996
1548
2005
return datetime_to_dbus(self.last_approval_request)
1549
2006
1550
2007
# Timeout - property
1551
@dbus_service_property(_interface, signature="t",
2008
@dbus_service_property(_interface,
2009
signature="t",
1552
2010
access="readwrite")
1553
2011
def Timeout_dbus_property(self, value=None):
1554
2012
if value is None: # get
1555
return dbus.UInt64(self.timeout_milliseconds())
2013
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1556
2014
old_timeout = self.timeout
1557
2015
self.timeout = datetime.timedelta(0, 0, 0, value)
1558
2016
# Reschedule disabling
1567
2025
is None):
1568
2026
return
1569
2027
gobject.source_remove(self.disable_initiator_tag)
1570
self.disable_initiator_tag = (
1571
gobject.timeout_add(
1572
timedelta_to_milliseconds(self.expires - now),
1573
self.disable))
2028
self.disable_initiator_tag = gobject.timeout_add(
2029
int((self.expires - now).total_seconds() * 1000),
2030
self.disable)
1574
2031
1575
2032
# ExtendedTimeout - property
1576
@dbus_service_property(_interface, signature="t",
2033
@dbus_service_property(_interface,
2034
signature="t",
1577
2035
access="readwrite")
1578
2036
def ExtendedTimeout_dbus_property(self, value=None):
1579
2037
if value is None: # get
1580
return dbus.UInt64(self.extended_timeout_milliseconds())
2038
return dbus.UInt64(self.extended_timeout.total_seconds()
2039
* 1000)
1581
2040
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1582
2041
1583
2042
# Interval - property
1584
@dbus_service_property(_interface, signature="t",
2043
@dbus_service_property(_interface,
2044
signature="t",
1585
2045
access="readwrite")
1586
2046
def Interval_dbus_property(self, value=None):
1587
2047
if value is None: # get
1588
return dbus.UInt64(self.interval_milliseconds())
2048
return dbus.UInt64(self.interval.total_seconds() * 1000)
1589
2049
self.interval = datetime.timedelta(0, 0, 0, value)
1590
2050
if getattr(self, "checker_initiator_tag", None) is None:
1591
2051
return
1592
2052
if self.enabled:
1593
2053
# Reschedule checker run
1594
2054
gobject.source_remove(self.checker_initiator_tag)
1595
self.checker_initiator_tag = (gobject.timeout_add
1596
(value, self.start_checker))
1597
self.start_checker() # Start one now, too
2055
self.checker_initiator_tag = gobject.timeout_add(
2056
value, self.start_checker)
2057
self.start_checker() # Start one now, too
1598
2058
1599
2059
# Checker - property
1600
@dbus_service_property(_interface, signature="s",
2060
@dbus_service_property(_interface,
2061
signature="s",
1601
2062
access="readwrite")
1602
2063
def Checker_dbus_property(self, value=None):
1603
2064
if value is None: # get
1604
2065
return dbus.String(self.checker_command)
1605
self.checker_command = unicode(value)
2066
self.checker_command = str(value)
1606
2067
1607
2068
# CheckerRunning - property
1608
@dbus_service_property(_interface, signature="b",
2069
@dbus_service_property(_interface,
2070
signature="b",
1609
2071
access="readwrite")
1610
2072
def CheckerRunning_dbus_property(self, value=None):
1611
2073
if value is None: # get
1616
2078
self.stop_checker()
1617
2079
1618
2080
# ObjectPath - property
2081
@dbus_annotations(
2082
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2083
"org.freedesktop.DBus.Deprecated": "true"})
1619
2084
@dbus_service_property(_interface, signature="o", access="read")
1620
2085
def ObjectPath_dbus_property(self):
1621
2086
return self.dbus_object_path # is already a dbus.ObjectPath
1622
2087
1623
2088
# Secret = property
1624
@dbus_service_property(_interface, signature="ay",
1625
access="write", byte_arrays=True)
2089
@dbus_annotations(
2090
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2091
"invalidates"})
2092
@dbus_service_property(_interface,
2093
signature="ay",
2094
access="write",
2095
byte_arrays=True)
1626
2096
def Secret_dbus_property(self, value):
1627
self.secret = str(value)
2097
self.secret = bytes(value)
1628
2098
1629
2099
del _interface
1630
2100
1634
2104
self._pipe = child_pipe
1635
2105
self._pipe.send(('init', fpr, address))
1636
2106
if not self._pipe.recv():
1637
raise KeyError()
2107
raise KeyError(fpr)
1638
2108
1639
2109
def __getattribute__(self, name):
1640
2110
if name == '_pipe':
1644
2114
if data[0] == 'data':
1645
2115
return data[1]
1646
2116
if data[0] == 'function':
2117
1647
2118
def func(*args, **kwargs):
1648
2119
self._pipe.send(('funcall', name, args, kwargs))
1649
2120
return self._pipe.recv()[1]
2121
1650
2122
return func
1651
2123
1652
2124
def __setattr__(self, name, value):
1664
2136
def handle(self):
1665
2137
with contextlib.closing(self.server.child_pipe) as child_pipe:
1666
2138
logger.info("TCP connection from: %s",
1667
unicode(self.client_address))
2139
str(self.client_address))
1668
2140
logger.debug("Pipe FD: %d",
1669
2141
self.server.child_pipe.fileno())
1670
2142
1671
session = (gnutls.connection
1672
.ClientSession(self.request,
1673
gnutls.connection
1674
.X509Credentials()))
1675
1676
# Note: gnutls.connection.X509Credentials is really a
1677
# generic GnuTLS certificate credentials object so long as
1678
# no X.509 keys are added to it. Therefore, we can use it
1679
# here despite using OpenPGP certificates.
2143
session = gnutls.ClientSession(self.request)
1680
2144
1681
2145
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1682
2146
# "+AES-256-CBC", "+SHA1",
1686
2150
priority = self.server.gnutls_priority
1687
2151
if priority is None:
1688
2152
priority = "NORMAL"
1689
(gnutls.library.functions
1690
.gnutls_priority_set_direct(session._c_object,
1691
priority, None))
2153
gnutls.priority_set_direct(session._c_object, priority,
2154
None)
1692
2155
1693
2156
# Start communication using the Mandos protocol
1694
2157
# Get protocol number
1696
2159
logger.debug("Protocol version: %r", line)
1697
2160
try:
1698
2161
if int(line.strip().split()[0]) > 1:
1699
raise RuntimeError
2162
raise RuntimeError(line)
1700
2163
except (ValueError, IndexError, RuntimeError) as error:
1701
2164
logger.error("Unknown protocol version: %s", error)
1702
2165
return
1704
2167
# Start GnuTLS connection
1705
2168
try:
1706
2169
session.handshake()
1707
except gnutls.errors.GNUTLSError as error:
2170
except gnutls.Error as error:
1708
2171
logger.warning("Handshake failed: %s", error)
1709
2172
# Do not run session.bye() here: the session is not
1710
2173
# established. Just abandon the request.
1714
2177
approval_required = False
1715
2178
try:
1716
2179
try:
1717
fpr = self.fingerprint(self.peer_certificate
1718
(session))
1719
except (TypeError,
1720
gnutls.errors.GNUTLSError) as error:
2180
fpr = self.fingerprint(
2181
self.peer_certificate(session))
2182
except (TypeError, gnutls.Error) as error:
1721
2183
logger.warning("Bad certificate: %s", error)
1722
2184
return
1723
2185
logger.debug("Fingerprint: %s", fpr)
1736
2198
while True:
1737
2199
if not client.enabled:
1738
2200
logger.info("Client %s is disabled",
1739
client.name)
2201
client.name)
1740
2202
if self.server.use_dbus:
1741
2203
# Emit D-Bus signal
1742
2204
client.Rejected("Disabled")
1751
2213
if self.server.use_dbus:
1752
2214
# Emit D-Bus signal
1753
2215
client.NeedApproval(
1754
client.approval_delay_milliseconds(),
1755
client.approved_by_default)
2216
client.approval_delay.total_seconds()
2217
* 1000, client.approved_by_default)
1756
2218
else:
1757
2219
logger.warning("Client %s was not approved",
1758
2220
client.name)
1764
2226
#wait until timeout or approved
1765
2227
time = datetime.datetime.now()
1766
2228
client.changedstate.acquire()
1767
client.changedstate.wait(
1768
float(timedelta_to_milliseconds(delay)
1769
/ 1000))
2229
client.changedstate.wait(delay.total_seconds())
1770
2230
client.changedstate.release()
1771
2231
time2 = datetime.datetime.now()
1772
2232
if (time2 - time) >= delay:
1783
2243
else:
1784
2244
delay -= time2 - time
1785
2245
1786
sent_size = 0
1787
while sent_size < len(client.secret):
1788
try:
1789
sent = session.send(client.secret[sent_size:])
1790
except gnutls.errors.GNUTLSError as error:
1791
logger.warning("gnutls send failed",
1792
exc_info=error)
1793
return
1794
logger.debug("Sent: %d, remaining: %d",
1795
sent, len(client.secret)
1796
- (sent_size + sent))
1797
sent_size += sent
2246
try:
2247
session.send(client.secret)
2248
except gnutls.Error as error:
2249
logger.warning("gnutls send failed",
2250
exc_info = error)
2251
return
1798
2252
1799
2253
logger.info("Sending secret to %s", client.name)
1800
2254
# bump the timeout using extended_timeout
1808
2262
client.approvals_pending -= 1
1809
2263
try:
1810
2264
session.bye()
1811
except gnutls.errors.GNUTLSError as error:
2265
except gnutls.Error as error:
1812
2266
logger.warning("GnuTLS bye failed",
1813
2267
exc_info=error)
1814
2268
1816
2270
def peer_certificate(session):
1817
2271
"Return the peer's OpenPGP certificate as a bytestring"
1818
2272
# If not an OpenPGP certificate...
1819
if (gnutls.library.functions
1820
.gnutls_certificate_type_get(session._c_object)
1821
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1822
# ...do the normal thing
1823
return session.peer_certificate
2273
if (gnutls.certificate_type_get(session._c_object)
2274
!= gnutls.CRT_OPENPGP):
2275
# ...return invalid data
2276
return b""
1824
2277
list_size = ctypes.c_uint(1)
1825
cert_list = (gnutls.library.functions
1826
.gnutls_certificate_get_peers
2278
cert_list = (gnutls.certificate_get_peers
1827
2279
(session._c_object, ctypes.byref(list_size)))
1828
2280
if not bool(cert_list) and list_size.value != 0:
1829
raise gnutls.errors.GNUTLSError("error getting peer"
1830
" certificate")
2281
raise gnutls.Error("error getting peer certificate")
1831
2282
if list_size.value == 0:
1832
2283
return None
1833
2284
cert = cert_list[0]
1837
2288
def fingerprint(openpgp):
1838
2289
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1839
2290
# New GnuTLS "datum" with the OpenPGP public key
1840
datum = (gnutls.library.types
1841
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1842
ctypes.POINTER
1843
(ctypes.c_ubyte)),
1844
ctypes.c_uint(len(openpgp))))
2291
datum = gnutls.datum_t(
2292
ctypes.cast(ctypes.c_char_p(openpgp),
2293
ctypes.POINTER(ctypes.c_ubyte)),
2294
ctypes.c_uint(len(openpgp)))
1845
2295
# New empty GnuTLS certificate
1846
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1847
(gnutls.library.functions
1848
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2296
crt = gnutls.openpgp_crt_t()
2297
gnutls.openpgp_crt_init(ctypes.byref(crt))
1849
2298
# Import the OpenPGP public key into the certificate
1850
(gnutls.library.functions
1851
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1852
gnutls.library.constants
1853
.GNUTLS_OPENPGP_FMT_RAW))
2299
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2300
gnutls.OPENPGP_FMT_RAW)
1854
2301
# Verify the self signature in the key
1855
2302
crtverify = ctypes.c_uint()
1856
(gnutls.library.functions
1857
.gnutls_openpgp_crt_verify_self(crt, 0,
1858
ctypes.byref(crtverify)))
2303
gnutls.openpgp_crt_verify_self(crt, 0,
2304
ctypes.byref(crtverify))
1859
2305
if crtverify.value != 0:
1860
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1861
raise (gnutls.errors.CertificateSecurityError
1862
("Verify failed"))
2306
gnutls.openpgp_crt_deinit(crt)
2307
raise gnutls.CertificateSecurityError("Verify failed")
1863
2308
# New buffer for the fingerprint
1864
2309
buf = ctypes.create_string_buffer(20)
1865
2310
buf_len = ctypes.c_size_t()
1866
2311
# Get the fingerprint from the certificate into the buffer
1867
(gnutls.library.functions
1868
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1869
ctypes.byref(buf_len)))
2312
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2313
ctypes.byref(buf_len))
1870
2314
# Deinit the certificate
1871
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2315
gnutls.openpgp_crt_deinit(crt)
1872
2316
# Convert the buffer to a Python bytestring
1873
2317
fpr = ctypes.string_at(buf, buf_len.value)
1874
2318
# Convert the bytestring to hexadecimal notation
1878
2322
1879
2323
class MultiprocessingMixIn(object):
1880
2324
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2325
1881
2326
def sub_process_main(self, request, address):
1882
2327
try:
1883
2328
self.finish_request(request, address)
1895
2340
1896
2341
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1897
2342
""" adds a pipe to the MixIn """
2343
1898
2344
def process_request(self, request, client_address):
1899
2345
"""Overrides and wraps the original process_request().
1900
2346
1909
2355
1910
2356
def add_pipe(self, parent_pipe, proc):
1911
2357
"""Dummy function; override as necessary"""
1912
raise NotImplementedError
2358
raise NotImplementedError()
1913
2359
1914
2360
1915
2361
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1921
2367
interface: None or a network interface name (string)
1922
2368
use_ipv6: Boolean; to use IPv6 or not
1923
2369
"""
2370
1924
2371
def __init__(self, server_address, RequestHandlerClass,
1925
interface=None, use_ipv6=True, socketfd=None):
2372
interface=None,
2373
use_ipv6=True,
2374
socketfd=None):
1926
2375
"""If socketfd is set, use that file descriptor instead of
1927
2376
creating a new one with socket.socket().
1928
2377
"""
1969
2418
self.interface)
1970
2419
else:
1971
2420
try:
1972
self.socket.setsockopt(socket.SOL_SOCKET,
1973
SO_BINDTODEVICE,
1974
str(self.interface + '\0'))
2421
self.socket.setsockopt(
2422
socket.SOL_SOCKET, SO_BINDTODEVICE,
2423
(self.interface + "\0").encode("utf-8"))
1975
2424
except socket.error as error:
1976
2425
if error.errno == errno.EPERM:
1977
2426
logger.error("No permission to bind to"
1995
2444
self.server_address = (any_address,
1996
2445
self.server_address[1])
1997
2446
elif not self.server_address[1]:
1998
self.server_address = (self.server_address[0],
1999
0)
2447
self.server_address = (self.server_address[0], 0)
2000
2448
# if self.interface:
2001
2449
# self.server_address = (self.server_address[0],
2002
2450
# 0, # port
2016
2464
2017
2465
Assumes a gobject.MainLoop event loop.
2018
2466
"""
2467
2019
2468
def __init__(self, server_address, RequestHandlerClass,
2020
interface=None, use_ipv6=True, clients=None,
2021
gnutls_priority=None, use_dbus=True, socketfd=None):
2469
interface=None,
2470
use_ipv6=True,
2471
clients=None,
2472
gnutls_priority=None,
2473
use_dbus=True,
2474
socketfd=None):
2022
2475
self.enabled = False
2023
2476
self.clients = clients
2024
2477
if self.clients is None:
2030
2483
interface = interface,
2031
2484
use_ipv6 = use_ipv6,
2032
2485
socketfd = socketfd)
2486
2033
2487
def server_activate(self):
2034
2488
if self.enabled:
2035
2489
return socketserver.TCPServer.server_activate(self)
2039
2493
2040
2494
def add_pipe(self, parent_pipe, proc):
2041
2495
# Call "handle_ipc" for both data and EOF events
2042
gobject.io_add_watch(parent_pipe.fileno(),
2043
gobject.IO_IN | gobject.IO_HUP,
2044
functools.partial(self.handle_ipc,
2045
parent_pipe =
2046
parent_pipe,
2047
proc = proc))
2496
gobject.io_add_watch(
2497
parent_pipe.fileno(),
2498
gobject.IO_IN | gobject.IO_HUP,
2499
functools.partial(self.handle_ipc,
2500
parent_pipe = parent_pipe,
2501
proc = proc))
2048
2502
2049
def handle_ipc(self, source, condition, parent_pipe=None,
2050
proc = None, client_object=None):
2503
def handle_ipc(self, source, condition,
2504
parent_pipe=None,
2505
proc = None,
2506
client_object=None):
2051
2507
# error, or the other end of multiprocessing.Pipe has closed
2052
2508
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2053
2509
# Wait for other process to exit
2076
2532
parent_pipe.send(False)
2077
2533
return False
2078
2534
2079
gobject.io_add_watch(parent_pipe.fileno(),
2080
gobject.IO_IN | gobject.IO_HUP,
2081
functools.partial(self.handle_ipc,
2082
parent_pipe =
2083
parent_pipe,
2084
proc = proc,
2085
client_object =
2086
client))
2535
gobject.io_add_watch(
2536
parent_pipe.fileno(),
2537
gobject.IO_IN | gobject.IO_HUP,
2538
functools.partial(self.handle_ipc,
2539
parent_pipe = parent_pipe,
2540
proc = proc,
2541
client_object = client))
2087
2542
parent_pipe.send(True)
2088
2543
# remove the old hook in favor of the new above hook on
2089
2544
# same fileno
2095
2550
2096
2551
parent_pipe.send(('data', getattr(client_object,
2097
2552
funcname)(*args,
2098
**kwargs)))
2553
**kwargs)))
2099
2554
2100
2555
if command == 'getattr':
2101
2556
attrname = request[1]
2102
if callable(client_object.__getattribute__(attrname)):
2103
parent_pipe.send(('function',))
2557
if isinstance(client_object.__getattribute__(attrname),
2558
collections.Callable):
2559
parent_pipe.send(('function', ))
2104
2560
else:
2105
parent_pipe.send(('data', client_object
2106
.__getattribute__(attrname)))
2561
parent_pipe.send((
2562
'data', client_object.__getattribute__(attrname)))
2107
2563
2108
2564
if command == 'setattr':
2109
2565
attrname = request[1]
2140
2596
# avoid excessive use of external libraries.
2141
2597
2142
2598
# New type for defining tokens, syntax, and semantics all-in-one
2143
Token = collections.namedtuple("Token",
2144
("regexp", # To match token; if
2145
# "value" is not None,
2146
# must have a "group"
2147
# containing digits
2148
"value", # datetime.timedelta or
2149
# None
2150
"followers")) # Tokens valid after
2151
# this token
2599
Token = collections.namedtuple("Token", (
2600
"regexp", # To match token; if "value" is not None, must have
2601
# a "group" containing digits
2602
"value", # datetime.timedelta or None
2603
"followers")) # Tokens valid after this token
2152
2604
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2153
2605
# the "duration" ABNF definition in RFC 3339, Appendix A.
2154
2606
token_end = Token(re.compile(r"$"), None, frozenset())
2155
2607
token_second = Token(re.compile(r"(\d+)S"),
2156
2608
datetime.timedelta(seconds=1),
2157
frozenset((token_end,)))
2609
frozenset((token_end, )))
2158
2610
token_minute = Token(re.compile(r"(\d+)M"),
2159
2611
datetime.timedelta(minutes=1),
2160
2612
frozenset((token_second, token_end)))
2176
2628
frozenset((token_month, token_end)))
2177
2629
token_week = Token(re.compile(r"(\d+)W"),
2178
2630
datetime.timedelta(weeks=1),
2179
frozenset((token_end,)))
2631
frozenset((token_end, )))
2180
2632
token_duration = Token(re.compile(r"P"), None,
2181
2633
frozenset((token_year, token_month,
2182
2634
token_day, token_time,
2183
token_week))),
2635
token_week)))
2184
2636
# Define starting values
2185
2637
value = datetime.timedelta() # Value so far
2186
2638
found_token = None
2187
followers = frozenset(token_duration,) # Following valid tokens
2639
followers = frozenset((token_duration, )) # Following valid tokens
2188
2640
s = duration # String left to parse
2189
2641
# Loop until end token is found
2190
2642
while found_token is not token_end:
2207
2659
break
2208
2660
else:
2209
2661
# No currently valid tokens were found
2210
raise ValueError("Invalid RFC 3339 duration")
2662
raise ValueError("Invalid RFC 3339 duration: {!r}"
2663
.format(duration))
2211
2664
# End token found
2212
2665
return value
2213
2666
2237
2690
timevalue = datetime.timedelta(0)
2238
2691
for s in interval.split():
2239
2692
try:
2240
suffix = unicode(s[-1])
2693
suffix = s[-1]
2241
2694
value = int(s[:-1])
2242
2695
if suffix == "d":
2243
2696
delta = datetime.timedelta(value)
2250
2703
elif suffix == "w":
2251
2704
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2252
2705
else:
2253
raise ValueError("Unknown suffix {0!r}"
2254
.format(suffix))
2255
except (ValueError, IndexError) as e:
2706
raise ValueError("Unknown suffix {!r}".format(suffix))
2707
except IndexError as e:
2256
2708
raise ValueError(*(e.args))
2257
2709
timevalue += delta
2258
2710
return timevalue
2274
2726
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2275
2727
if not stat.S_ISCHR(os.fstat(null).st_mode):
2276
2728
raise OSError(errno.ENODEV,
2277
"{0} not a character device"
2729
"{} not a character device"
2278
2730
.format(os.devnull))
2279
2731
os.dup2(null, sys.stdin.fileno())
2280
2732
os.dup2(null, sys.stdout.fileno())
2290
2742
2291
2743
parser = argparse.ArgumentParser()
2292
2744
parser.add_argument("-v", "--version", action="version",
2293
version = "%(prog)s {0}".format(version),
2745
version = "%(prog)s {}".format(version),
2294
2746
help="show version number and exit")
2295
2747
parser.add_argument("-i", "--interface", metavar="IF",
2296
2748
help="Bind to interface IF")
2329
2781
help="Directory to save/restore state in")
2330
2782
parser.add_argument("--foreground", action="store_true",
2331
2783
help="Run in foreground", default=None)
2784
parser.add_argument("--no-zeroconf", action="store_false",
2785
dest="zeroconf", help="Do not use Zeroconf",
2786
default=None)
2332
2787
2333
2788
options = parser.parse_args()
2334
2789
2335
2790
if options.check:
2336
2791
import doctest
2337
doctest.testmod()
2338
sys.exit()
2792
fail_count, test_count = doctest.testmod()
2793
sys.exit(os.EX_OK if fail_count == 0 else 1)
2339
2794
2340
2795
# Default values for config file for server-global settings
2341
2796
server_defaults = { "interface": "",
2343
2798
"port": "",
2344
2799
"debug": "False",
2345
2800
"priority":
2346
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224",
2801
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2802
":+SIGN-DSA-SHA256",
2347
2803
"servicename": "Mandos",
2348
2804
"use_dbus": "True",
2349
2805
"use_ipv6": "True",
2352
2808
"socket": "",
2353
2809
"statedir": "/var/lib/mandos",
2354
2810
"foreground": "False",
2355
}
2811
"zeroconf": "True",
2812
}
2356
2813
2357
2814
# Parse config file for server-global settings
2358
2815
server_config = configparser.SafeConfigParser(server_defaults)
2359
2816
del server_defaults
2360
server_config.read(os.path.join(options.configdir,
2361
"mandos.conf"))
2817
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2362
2818
# Convert the SafeConfigParser object to a dict
2363
2819
server_settings = server_config.defaults()
2364
2820
# Use the appropriate methods on the non-string config options
2382
2838
# Override the settings from the config file with command line
2383
2839
# options, if set.
2384
2840
for option in ("interface", "address", "port", "debug",
2385
"priority", "servicename", "configdir",
2386
"use_dbus", "use_ipv6", "debuglevel", "restore",
2387
"statedir", "socket", "foreground"):
2841
"priority", "servicename", "configdir", "use_dbus",
2842
"use_ipv6", "debuglevel", "restore", "statedir",
2843
"socket", "foreground", "zeroconf"):
2388
2844
value = getattr(options, option)
2389
2845
if value is not None:
2390
2846
server_settings[option] = value
2391
2847
del options
2392
2848
# Force all strings to be unicode
2393
2849
for option in server_settings.keys():
2394
if type(server_settings[option]) is str:
2395
server_settings[option] = unicode(server_settings[option])
2850
if isinstance(server_settings[option], bytes):
2851
server_settings[option] = (server_settings[option]
2852
.decode("utf-8"))
2396
2853
# Force all boolean options to be boolean
2397
2854
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2398
"foreground"):
2855
"foreground", "zeroconf"):
2399
2856
server_settings[option] = bool(server_settings[option])
2400
2857
# Debug implies foreground
2401
2858
if server_settings["debug"]:
2404
2861
2405
2862
##################################################################
2406
2863
2864
if (not server_settings["zeroconf"]
2865
and not (server_settings["port"]
2866
or server_settings["socket"] != "")):
2867
parser.error("Needs port or socket to work without Zeroconf")
2868
2407
2869
# For convenience
2408
2870
debug = server_settings["debug"]
2409
2871
debuglevel = server_settings["debuglevel"]
2412
2874
stored_state_path = os.path.join(server_settings["statedir"],
2413
2875
stored_state_file)
2414
2876
foreground = server_settings["foreground"]
2877
zeroconf = server_settings["zeroconf"]
2415
2878
2416
2879
if debug:
2417
2880
initlogger(debug, logging.DEBUG)
2423
2886
initlogger(debug, level)
2424
2887
2425
2888
if server_settings["servicename"] != "Mandos":
2426
syslogger.setFormatter(logging.Formatter
2427
('Mandos ({0}) [%(process)d]:'
2428
' %(levelname)s: %(message)s'
2429
.format(server_settings
2430
["servicename"])))
2889
syslogger.setFormatter(
2890
logging.Formatter('Mandos ({}) [%(process)d]:'
2891
' %(levelname)s: %(message)s'.format(
2892
server_settings["servicename"])))
2431
2893
2432
2894
# Parse config file with clients
2433
2895
client_config = configparser.SafeConfigParser(Client
2438
2900
global mandos_dbus_service
2439
2901
mandos_dbus_service = None
2440
2902
2441
tcp_server = MandosServer((server_settings["address"],
2442
server_settings["port"]),
2443
ClientHandler,
2444
interface=(server_settings["interface"]
2445
or None),
2446
use_ipv6=use_ipv6,
2447
gnutls_priority=
2448
server_settings["priority"],
2449
use_dbus=use_dbus,
2450
socketfd=(server_settings["socket"]
2451
or None))
2903
socketfd = None
2904
if server_settings["socket"] != "":
2905
socketfd = server_settings["socket"]
2906
tcp_server = MandosServer(
2907
(server_settings["address"], server_settings["port"]),
2908
ClientHandler,
2909
interface=(server_settings["interface"] or None),
2910
use_ipv6=use_ipv6,
2911
gnutls_priority=server_settings["priority"],
2912
use_dbus=use_dbus,
2913
socketfd=socketfd)
2452
2914
if not foreground:
2453
pidfilename = "/var/run/mandos.pid"
2915
pidfilename = "/run/mandos.pid"
2916
if not os.path.isdir("/run/."):
2917
pidfilename = "/var/run/mandos.pid"
2454
2918
pidfile = None
2455
2919
try:
2456
pidfile = open(pidfilename, "w")
2920
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2457
2921
except IOError as e:
2458
2922
logger.error("Could not open file %r", pidfilename,
2459
2923
exc_info=e)
2473
2937
os.setuid(uid)
2474
2938
except OSError as error:
2475
2939
if error.errno != errno.EPERM:
2476
raise error
2940
raise
2477
2941
2478
2942
if debug:
2479
2943
# Enable all possible GnuTLS debugging
2480
2944
2481
2945
# "Use a log level over 10 to enable all debugging options."
2482
2946
# - GnuTLS manual
2483
gnutls.library.functions.gnutls_global_set_log_level(11)
2947
gnutls.global_set_log_level(11)
2484
2948
2485
@gnutls.library.types.gnutls_log_func
2949
@gnutls.log_func
2486
2950
def debug_gnutls(level, string):
2487
2951
logger.debug("GnuTLS: %s", string[:-1])
2488
2952
2489
(gnutls.library.functions
2490
.gnutls_global_set_log_function(debug_gnutls))
2953
gnutls.global_set_log_function(debug_gnutls)
2491
2954
2492
2955
# Redirect stdin so all checkers get /dev/null
2493
2956
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2513
2976
if use_dbus:
2514
2977
try:
2515
2978
bus_name = dbus.service.BusName("se.recompile.Mandos",
2516
bus, do_not_queue=True)
2517
old_bus_name = (dbus.service.BusName
2518
("se.bsnet.fukt.Mandos", bus,
2519
do_not_queue=True))
2520
except dbus.exceptions.NameExistsException as e:
2979
bus,
2980
do_not_queue=True)
2981
old_bus_name = dbus.service.BusName(
2982
"se.bsnet.fukt.Mandos", bus,
2983
do_not_queue=True)
2984
except dbus.exceptions.DBusException as e:
2521
2985
logger.error("Disabling D-Bus:", exc_info=e)
2522
2986
use_dbus = False
2523
2987
server_settings["use_dbus"] = False
2524
2988
tcp_server.use_dbus = False
2525
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2526
service = AvahiServiceToSyslog(name =
2527
server_settings["servicename"],
2528
servicetype = "_mandos._tcp",
2529
protocol = protocol, bus = bus)
2530
if server_settings["interface"]:
2531
service.interface = (if_nametoindex
2532
(str(server_settings["interface"])))
2989
if zeroconf:
2990
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2991
service = AvahiServiceToSyslog(
2992
name = server_settings["servicename"],
2993
servicetype = "_mandos._tcp",
2994
protocol = protocol,
2995
bus = bus)
2996
if server_settings["interface"]:
2997
service.interface = if_nametoindex(
2998
server_settings["interface"].encode("utf-8"))
2533
2999
2534
3000
global multiprocessing_manager
2535
3001
multiprocessing_manager = multiprocessing.Manager()
2554
3020
if server_settings["restore"]:
2555
3021
try:
2556
3022
with open(stored_state_path, "rb") as stored_state:
2557
clients_data, old_client_settings = (pickle.load
2558
(stored_state))
3023
clients_data, old_client_settings = pickle.load(
3024
stored_state)
2559
3025
os.remove(stored_state_path)
2560
3026
except IOError as e:
2561
3027
if e.errno == errno.ENOENT:
2562
logger.warning("Could not load persistent state: {0}"
2563
.format(os.strerror(e.errno)))
3028
logger.warning("Could not load persistent state:"
3029
" {}".format(os.strerror(e.errno)))
2564
3030
else:
2565
3031
logger.critical("Could not load persistent state:",
2566
3032
exc_info=e)
2567
3033
raise
2568
3034
except EOFError as e:
2569
3035
logger.warning("Could not load persistent state: "
2570
"EOFError:", exc_info=e)
3036
"EOFError:",
3037
exc_info=e)
2571
3038
2572
3039
with PGPEngine() as pgp:
2573
for client_name, client in clients_data.iteritems():
3040
for client_name, client in clients_data.items():
2574
3041
# Skip removed clients
2575
3042
if client_name not in client_settings:
2576
3043
continue
2585
3052
# For each value in new config, check if it
2586
3053
# differs from the old config value (Except for
2587
3054
# the "secret" attribute)
2588
if (name != "secret" and
2589
value != old_client_settings[client_name]
2590
[name]):
3055
if (name != "secret"
3056
and (value !=
3057
old_client_settings[client_name][name])):
2591
3058
client[name] = value
2592
3059
except KeyError:
2593
3060
pass
2594
3061
2595
3062
# Clients who has passed its expire date can still be
2596
# enabled if its last checker was successful. Clients
3063
# enabled if its last checker was successful. A Client
2597
3064
# whose checker succeeded before we stored its state is
2598
3065
# assumed to have successfully run all checkers during
2599
3066
# downtime.
2601
3068
if datetime.datetime.utcnow() >= client["expires"]:
2602
3069
if not client["last_checked_ok"]:
2603
3070
logger.warning(
2604
"disabling client {0} - Client never "
2605
"performed a successful checker"
2606
.format(client_name))
3071
"disabling client {} - Client never "
3072
"performed a successful checker".format(
3073
client_name))
2607
3074
client["enabled"] = False
2608
3075
elif client["last_checker_status"] != 0:
2609
3076
logger.warning(
2610
"disabling client {0} - Client "
2611
"last checker failed with error code {1}"
2612
.format(client_name,
2613
client["last_checker_status"]))
3077
"disabling client {} - Client last"
3078
" checker failed with error code"
3079
" {}".format(
3080
client_name,
3081
client["last_checker_status"]))
2614
3082
client["enabled"] = False
2615
3083
else:
2616
client["expires"] = (datetime.datetime
2617
.utcnow()
2618
+ client["timeout"])
3084
client["expires"] = (
3085
datetime.datetime.utcnow()
3086
+ client["timeout"])
2619
3087
logger.debug("Last checker succeeded,"
2620
" keeping {0} enabled"
2621
.format(client_name))
3088
" keeping {} enabled".format(
3089
client_name))
2622
3090
try:
2623
client["secret"] = (
2624
pgp.decrypt(client["encrypted_secret"],
2625
client_settings[client_name]
2626
["secret"]))
3091
client["secret"] = pgp.decrypt(
3092
client["encrypted_secret"],
3093
client_settings[client_name]["secret"])
2627
3094
except PGPError:
2628
3095
# If decryption fails, we use secret from new settings
2629
logger.debug("Failed to decrypt {0} old secret"
2630
.format(client_name))
2631
client["secret"] = (
2632
client_settings[client_name]["secret"])
3096
logger.debug("Failed to decrypt {} old secret".format(
3097
client_name))
3098
client["secret"] = (client_settings[client_name]
3099
["secret"])
2633
3100
2634
3101
# Add/remove clients based on new changes made to config
2635
3102
for client_name in (set(old_client_settings)
2640
3107
clients_data[client_name] = client_settings[client_name]
2641
3108
2642
3109
# Create all client objects
2643
for client_name, client in clients_data.iteritems():
3110
for client_name, client in clients_data.items():
2644
3111
tcp_server.clients[client_name] = client_class(
2645
name = client_name, settings = client,
3112
name = client_name,
3113
settings = client,
2646
3114
server_settings = server_settings)
2647
3115
2648
3116
if not tcp_server.clients:
2650
3118
2651
3119
if not foreground:
2652
3120
if pidfile is not None:
3121
pid = os.getpid()
2653
3122
try:
2654
3123
with pidfile:
2655
pid = os.getpid()
2656
pidfile.write(str(pid) + "\n".encode("utf-8"))
3124
print(pid, file=pidfile)
2657
3125
except IOError:
2658
3126
logger.error("Could not write to file %r with PID %d",
2659
3127
pidfilename, pid)
2664
3132
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2665
3133
2666
3134
if use_dbus:
2667
@alternate_dbus_interfaces({"se.recompile.Mandos":
2668
"se.bsnet.fukt.Mandos"})
2669
class MandosDBusService(DBusObjectWithProperties):
3135
3136
@alternate_dbus_interfaces(
3137
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3138
class MandosDBusService(DBusObjectWithObjectManager):
2670
3139
"""A D-Bus proxy object"""
3140
2671
3141
def __init__(self):
2672
3142
dbus.service.Object.__init__(self, bus, "/")
3143
2673
3144
_interface = "se.recompile.Mandos"
2674
3145
2675
@dbus_interface_annotations(_interface)
2676
def _foo(self):
2677
return { "org.freedesktop.DBus.Property"
2678
".EmitsChangedSignal":
2679
"false"}
2680
2681
3146
@dbus.service.signal(_interface, signature="o")
2682
3147
def ClientAdded(self, objpath):
2683
3148
"D-Bus signal"
2688
3153
"D-Bus signal"
2689
3154
pass
2690
3155
3156
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3157
"true"})
2691
3158
@dbus.service.signal(_interface, signature="os")
2692
3159
def ClientRemoved(self, objpath, name):
2693
3160
"D-Bus signal"
2694
3161
pass
2695
3162
3163
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3164
"true"})
2696
3165
@dbus.service.method(_interface, out_signature="ao")
2697
3166
def GetAllClients(self):
2698
3167
"D-Bus method"
2699
return dbus.Array(c.dbus_object_path
2700
for c in
3168
return dbus.Array(c.dbus_object_path for c in
2701
3169
tcp_server.clients.itervalues())
2702
3170
3171
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3172
"true"})
2703
3173
@dbus.service.method(_interface,
2704
3174
out_signature="a{oa{sv}}")
2705
3175
def GetAllClientsWithProperties(self):
2706
3176
"D-Bus method"
2707
3177
return dbus.Dictionary(
2708
((c.dbus_object_path, c.GetAll(""))
2709
for c in tcp_server.clients.itervalues()),
3178
{ c.dbus_object_path: c.GetAll(
3179
"se.recompile.Mandos.Client")
3180
for c in tcp_server.clients.itervalues() },
2710
3181
signature="oa{sv}")
2711
3182
2712
3183
@dbus.service.method(_interface, in_signature="o")
2716
3187
if c.dbus_object_path == object_path:
2717
3188
del tcp_server.clients[c.name]
2718
3189
c.remove_from_connection()
2719
# Don't signal anything except ClientRemoved
3190
# Don't signal the disabling
2720
3191
c.disable(quiet=True)
2721
# Emit D-Bus signal
2722
self.ClientRemoved(object_path, c.name)
3192
# Emit D-Bus signal for removal
3193
self.client_removed_signal(c)
2723
3194
return
2724
3195
raise KeyError(object_path)
2725
3196
2726
3197
del _interface
3198
3199
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3200
out_signature = "a{oa{sa{sv}}}")
3201
def GetManagedObjects(self):
3202
"""D-Bus method"""
3203
return dbus.Dictionary(
3204
{ client.dbus_object_path:
3205
dbus.Dictionary(
3206
{ interface: client.GetAll(interface)
3207
for interface in
3208
client._get_all_interface_names()})
3209
for client in tcp_server.clients.values()})
3210
3211
def client_added_signal(self, client):
3212
"""Send the new standard signal and the old signal"""
3213
if use_dbus:
3214
# New standard signal
3215
self.InterfacesAdded(
3216
client.dbus_object_path,
3217
dbus.Dictionary(
3218
{ interface: client.GetAll(interface)
3219
for interface in
3220
client._get_all_interface_names()}))
3221
# Old signal
3222
self.ClientAdded(client.dbus_object_path)
3223
3224
def client_removed_signal(self, client):
3225
"""Send the new standard signal and the old signal"""
3226
if use_dbus:
3227
# New standard signal
3228
self.InterfacesRemoved(
3229
client.dbus_object_path,
3230
client._get_all_interface_names())
3231
# Old signal
3232
self.ClientRemoved(client.dbus_object_path,
3233
client.name)
2727
3234
2728
3235
mandos_dbus_service = MandosDBusService()
2729
3236
2730
3237
def cleanup():
2731
3238
"Cleanup function; run on exit"
2732
service.cleanup()
3239
if zeroconf:
3240
service.cleanup()
2733
3241
2734
3242
multiprocessing.active_children()
2735
3243
wnull.close()
2749
3257
2750
3258
# A list of attributes that can not be pickled
2751
3259
# + secret.
2752
exclude = set(("bus", "changedstate", "secret",
2753
"checker", "server_settings"))
2754
for name, typ in (inspect.getmembers
2755
(dbus.service.Object)):
3260
exclude = { "bus", "changedstate", "secret",
3261
"checker", "server_settings" }
3262
for name, typ in inspect.getmembers(dbus.service
3263
.Object):
2756
3264
exclude.add(name)
2757
3265
2758
3266
client_dict["encrypted_secret"] = (client
2765
3273
del client_settings[client.name]["secret"]
2766
3274
2767
3275
try:
2768
with (tempfile.NamedTemporaryFile
2769
(mode='wb', suffix=".pickle", prefix='clients-',
2770
dir=os.path.dirname(stored_state_path),
2771
delete=False)) as stored_state:
3276
with tempfile.NamedTemporaryFile(
3277
mode='wb',
3278
suffix=".pickle",
3279
prefix='clients-',
3280
dir=os.path.dirname(stored_state_path),
3281
delete=False) as stored_state:
2772
3282
pickle.dump((clients, client_settings), stored_state)
2773
tempname=stored_state.name
3283
tempname = stored_state.name
2774
3284
os.rename(tempname, stored_state_path)
2775
3285
except (IOError, OSError) as e:
2776
3286
if not debug:
2779
3289
except NameError:
2780
3290
pass
2781
3291
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2782
logger.warning("Could not save persistent state: {0}"
3292
logger.warning("Could not save persistent state: {}"
2783
3293
.format(os.strerror(e.errno)))
2784
3294
else:
2785
3295
logger.warning("Could not save persistent state:",
2786
3296
exc_info=e)
2787
raise e
3297
raise
2788
3298
2789
3299
# Delete all clients, and settings from config
2790
3300
while tcp_server.clients:
2791
3301
name, client = tcp_server.clients.popitem()
2792
3302
if use_dbus:
2793
3303
client.remove_from_connection()
2794
# Don't signal anything except ClientRemoved
3304
# Don't signal the disabling
2795
3305
client.disable(quiet=True)
3306
# Emit D-Bus signal for removal
2796
3307
if use_dbus:
2797
# Emit D-Bus signal
2798
mandos_dbus_service.ClientRemoved(client
2799
.dbus_object_path,
2800
client.name)
3308
mandos_dbus_service.client_removed_signal(client)
2801
3309
client_settings.clear()
2802
3310
2803
3311
atexit.register(cleanup)
2804
3312
2805
3313
for client in tcp_server.clients.itervalues():
2806
3314
if use_dbus:
2807
# Emit D-Bus signal
2808
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3315
# Emit D-Bus signal for adding
3316
mandos_dbus_service.client_added_signal(client)
2809
3317
# Need to initiate checking of clients
2810
3318
if client.enabled:
2811
3319
client.init_checker()
2814
3322
tcp_server.server_activate()
2815
3323
2816
3324
# Find out what port we got
2817
service.port = tcp_server.socket.getsockname()[1]
3325
if zeroconf:
3326
service.port = tcp_server.socket.getsockname()[1]
2818
3327
if use_ipv6:
2819
3328
logger.info("Now listening on address %r, port %d,"
2820
3329
" flowinfo %d, scope_id %d",
2826
3335
#service.interface = tcp_server.socket.getsockname()[3]
2827
3336
2828
3337
try:
2829
# From the Avahi example code
2830
try:
2831
service.activate()
2832
except dbus.exceptions.DBusException as error:
2833
logger.critical("D-Bus Exception", exc_info=error)
2834
cleanup()
2835
sys.exit(1)
2836
# End of Avahi example code
3338
if zeroconf:
3339
# From the Avahi example code
3340
try:
3341
service.activate()
3342
except dbus.exceptions.DBusException as error:
3343
logger.critical("D-Bus Exception", exc_info=error)
3344
cleanup()
3345
sys.exit(1)
3346
# End of Avahi example code
2837
3347
2838
3348
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2839
3349
lambda *args, **kwargs:
2854
3364
# Must run before the D-Bus bus name gets deregistered
2855
3365
cleanup()
2856
3366
3367
2857
3368
if __name__ == '__main__':
2858
3369
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0