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 237.4.65
- compare with another revision
- download diff
- download tarball
- view history from revision 237.4.65
- Committer: Teddy Hogeborn
- Date: 2016-02-29 21:28:39 UTC
- mto: This revision was merged to the branch mainline in revision 814.
- Revision ID: teddy@recompile.se-20160229212839-hoz3rw1us3uds68n
Tags: version-1.7.3-1
* Makefile (version): Changed to "1.7.3".
* NEWS (Version 1.7.3): New entry.
* debian/changelog (1.7.3-1): - '' -
* NEWS (Version 1.7.3): New entry.
* debian/changelog (1.7.3-1): - '' -
- 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
440
748
runtime_expansions: Allowed attributes for runtime expansion.
441
749
expires: datetime.datetime(); time (UTC) when a client will be
442
750
disabled, or None
751
server_settings: The server_settings dict from main()
443
752
"""
444
753
445
754
runtime_expansions = ("approval_delay", "approval_duration",
447
756
"fingerprint", "host", "interval",
448
757
"last_approval_request", "last_checked_ok",
449
758
"last_enabled", "name", "timeout")
450
client_defaults = { "timeout": "PT5M",
451
"extended_timeout": "PT15M",
452
"interval": "PT2M",
453
"checker": "fping -q -- %%(host)s",
454
"host": "",
455
"approval_delay": "PT0S",
456
"approval_duration": "PT1S",
457
"approved_by_default": "True",
458
"enabled": "True",
459
}
460
461
def timeout_milliseconds(self):
462
"Return the 'timeout' attribute in milliseconds"
463
return timedelta_to_milliseconds(self.timeout)
464
465
def extended_timeout_milliseconds(self):
466
"Return the 'extended_timeout' attribute in milliseconds"
467
return timedelta_to_milliseconds(self.extended_timeout)
468
469
def interval_milliseconds(self):
470
"Return the 'interval' attribute in milliseconds"
471
return timedelta_to_milliseconds(self.interval)
472
473
def approval_delay_milliseconds(self):
474
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
}
475
770
476
771
@staticmethod
477
772
def config_parser(config):
493
788
client["enabled"] = config.getboolean(client_name,
494
789
"enabled")
495
790
791
# Uppercase and remove spaces from fingerprint for later
792
# comparison purposes with return value from the
793
# fingerprint() function
496
794
client["fingerprint"] = (section["fingerprint"].upper()
497
795
.replace(" ", ""))
498
796
if "secret" in section:
503
801
"rb") as secfile:
504
802
client["secret"] = secfile.read()
505
803
else:
506
raise TypeError("No secret or secfile for section {0}"
804
raise TypeError("No secret or secfile for section {}"
507
805
.format(section))
508
806
client["timeout"] = string_to_delta(section["timeout"])
509
807
client["extended_timeout"] = string_to_delta(
520
818
521
819
return settings
522
820
523
def __init__(self, settings, name = None):
821
def __init__(self, settings, name = None, server_settings=None):
524
822
self.name = name
823
if server_settings is None:
824
server_settings = {}
825
self.server_settings = server_settings
525
826
# adding all client settings
526
for setting, value in settings.iteritems():
827
for setting, value in settings.items():
527
828
setattr(self, setting, value)
528
829
529
830
if self.enabled:
537
838
self.expires = None
538
839
539
840
logger.debug("Creating client %r", self.name)
540
# Uppercase and remove spaces from fingerprint for later
541
# comparison purposes with return value from the fingerprint()
542
# function
543
841
logger.debug(" Fingerprint: %s", self.fingerprint)
544
842
self.created = settings.get("created",
545
843
datetime.datetime.utcnow())
552
850
self.current_checker_command = None
553
851
self.approved = None
554
852
self.approvals_pending = 0
555
self.changedstate = (multiprocessing_manager
556
.Condition(multiprocessing_manager
557
.Lock()))
558
self.client_structure = [attr for attr in
559
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()
560
857
if not attr.startswith("_")]
561
858
self.client_structure.append("client_structure")
562
859
563
for name, t in inspect.getmembers(type(self),
564
lambda obj:
565
isinstance(obj,
566
property)):
860
for name, t in inspect.getmembers(
861
type(self), lambda obj: isinstance(obj, property)):
567
862
if not name.startswith("_"):
568
863
self.client_structure.append(name)
569
864
611
906
# and every interval from then on.
612
907
if self.checker_initiator_tag is not None:
613
908
gobject.source_remove(self.checker_initiator_tag)
614
self.checker_initiator_tag = (gobject.timeout_add
615
(self.interval_milliseconds(),
616
self.start_checker))
909
self.checker_initiator_tag = gobject.timeout_add(
910
int(self.interval.total_seconds() * 1000),
911
self.start_checker)
617
912
# Schedule a disable() when 'timeout' has passed
618
913
if self.disable_initiator_tag is not None:
619
914
gobject.source_remove(self.disable_initiator_tag)
620
self.disable_initiator_tag = (gobject.timeout_add
621
(self.timeout_milliseconds(),
622
self.disable))
915
self.disable_initiator_tag = gobject.timeout_add(
916
int(self.timeout.total_seconds() * 1000), self.disable)
623
917
# Also start a new checker *right now*.
624
918
self.start_checker()
625
919
626
def checker_callback(self, pid, condition, command):
920
def checker_callback(self, source, condition, connection,
921
command):
627
922
"""The checker has completed, so take appropriate actions."""
628
923
self.checker_callback_tag = None
629
924
self.checker = None
630
if os.WIFEXITED(condition):
631
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
632
932
if self.last_checker_status == 0:
633
933
logger.info("Checker for %(name)s succeeded",
634
934
vars(self))
635
935
self.checked_ok()
636
936
else:
637
logger.info("Checker for %(name)s failed",
638
vars(self))
937
logger.info("Checker for %(name)s failed", vars(self))
639
938
else:
640
939
self.last_checker_status = -1
940
self.last_checker_signal = -returncode
641
941
logger.warning("Checker for %(name)s crashed?",
642
942
vars(self))
943
return False
643
944
644
945
def checked_ok(self):
645
946
"""Assert that the client has been seen, alive and well."""
646
947
self.last_checked_ok = datetime.datetime.utcnow()
647
948
self.last_checker_status = 0
949
self.last_checker_signal = None
648
950
self.bump_timeout()
649
951
650
952
def bump_timeout(self, timeout=None):
655
957
gobject.source_remove(self.disable_initiator_tag)
656
958
self.disable_initiator_tag = None
657
959
if getattr(self, "enabled", False):
658
self.disable_initiator_tag = (gobject.timeout_add
659
(timedelta_to_milliseconds
660
(timeout), self.disable))
960
self.disable_initiator_tag = gobject.timeout_add(
961
int(timeout.total_seconds() * 1000), self.disable)
661
962
self.expires = datetime.datetime.utcnow() + timeout
662
963
663
964
def need_approval(self):
677
978
# than 'timeout' for the client to be disabled, which is as it
678
979
# should be.
679
980
680
# If a checker exists, make sure it is not a zombie
681
try:
682
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
683
except (AttributeError, OSError) as error:
684
if (isinstance(error, OSError)
685
and error.errno != errno.ECHILD):
686
raise error
687
else:
688
if pid:
689
logger.warning("Checker was a zombie")
690
gobject.source_remove(self.checker_callback_tag)
691
self.checker_callback(pid, status,
692
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
693
985
# Start a new checker if needed
694
986
if self.checker is None:
695
987
# Escape attributes for the shell
696
escaped_attrs = dict(
697
(attr, re.escape(unicode(getattr(self, attr))))
698
for attr in
699
self.runtime_expansions)
988
escaped_attrs = {
989
attr: re.escape(str(getattr(self, attr)))
990
for attr in self.runtime_expansions }
700
991
try:
701
992
command = self.checker_command % escaped_attrs
702
993
except TypeError as error:
703
994
logger.error('Could not format string "%s"',
704
self.checker_command, exc_info=error)
705
return True # Try again later
995
self.checker_command,
996
exc_info=error)
997
return True # Try again later
706
998
self.current_checker_command = command
707
try:
708
logger.info("Starting checker %r for %s",
709
command, self.name)
710
# We don't need to redirect stdout and stderr, since
711
# in normal mode, that is already done by daemon(),
712
# and in debug mode we don't want to. (Stdin is
713
# always replaced by /dev/null.)
714
self.checker = subprocess.Popen(command,
715
close_fds=True,
716
shell=True, cwd="/")
717
except OSError as error:
718
logger.error("Failed to start subprocess",
719
exc_info=error)
720
return True
721
self.checker_callback_tag = (gobject.child_watch_add
722
(self.checker.pid,
723
self.checker_callback,
724
data=command))
725
# The checker may have completed before the gobject
726
# watch was added. Check for this.
727
try:
728
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
729
except OSError as error:
730
if error.errno == errno.ECHILD:
731
# This should never happen
732
logger.error("Child process vanished",
733
exc_info=error)
734
return True
735
raise
736
if pid:
737
gobject.source_remove(self.checker_callback_tag)
738
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)
739
1024
# Re-run this periodically if run by gobject.timeout_add
740
1025
return True
741
1026
747
1032
if getattr(self, "checker", None) is None:
748
1033
return
749
1034
logger.debug("Stopping checker for %(name)s", vars(self))
750
try:
751
self.checker.terminate()
752
#time.sleep(0.5)
753
#if self.checker.poll() is None:
754
# self.checker.kill()
755
except OSError as error:
756
if error.errno != errno.ESRCH: # No such process
757
raise
1035
self.checker.terminate()
758
1036
self.checker = None
759
1037
760
1038
761
def dbus_service_property(dbus_interface, signature="v",
762
access="readwrite", byte_arrays=False):
1039
def dbus_service_property(dbus_interface,
1040
signature="v",
1041
access="readwrite",
1042
byte_arrays=False):
763
1043
"""Decorators for marking methods of a DBusObjectWithProperties to
764
1044
become properties on the D-Bus.
765
1045
774
1054
# "Set" method, so we fail early here:
775
1055
if byte_arrays and signature != "ay":
776
1056
raise ValueError("Byte arrays not supported for non-'ay'"
777
" signature {0!r}".format(signature))
1057
" signature {!r}".format(signature))
1058
778
1059
def decorator(func):
779
1060
func._dbus_is_property = True
780
1061
func._dbus_interface = dbus_interface
785
1066
func._dbus_name = func._dbus_name[:-14]
786
1067
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
787
1068
return func
1069
788
1070
return decorator
789
1071
790
1072
799
1081
"org.freedesktop.DBus.Property.EmitsChangedSignal":
800
1082
"false"}
801
1083
"""
1084
802
1085
def decorator(func):
803
1086
func._dbus_is_interface = True
804
1087
func._dbus_interface = dbus_interface
805
1088
func._dbus_name = dbus_interface
806
1089
return func
1090
807
1091
return decorator
808
1092
809
1093
811
1095
"""Decorator to annotate D-Bus methods, signals or properties
812
1096
Usage:
813
1097
1098
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1099
"org.freedesktop.DBus.Property."
1100
"EmitsChangedSignal": "false"})
814
1101
@dbus_service_property("org.example.Interface", signature="b",
815
1102
access="r")
816
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
817
"org.freedesktop.DBus.Property."
818
"EmitsChangedSignal": "false"})
819
1103
def Property_dbus_property(self):
820
1104
return dbus.Boolean(False)
1105
1106
See also the DBusObjectWithAnnotations class.
821
1107
"""
1108
822
1109
def decorator(func):
823
1110
func._dbus_annotations = annotations
824
1111
return func
1112
825
1113
return decorator
826
1114
827
1115
828
1116
class DBusPropertyException(dbus.exceptions.DBusException):
829
1117
"""A base class for D-Bus property-related exceptions
830
1118
"""
831
def __unicode__(self):
832
return unicode(str(self))
1119
pass
833
1120
834
1121
835
1122
class DBusPropertyAccessException(DBusPropertyException):
844
1131
pass
845
1132
846
1133
847
class DBusObjectWithProperties(dbus.service.Object):
848
"""A D-Bus object with properties.
1134
class DBusObjectWithAnnotations(dbus.service.Object):
1135
"""A D-Bus object with annotations.
849
1136
850
Classes inheriting from this can use the dbus_service_property
851
decorator to expose methods as D-Bus properties. It exposes the
852
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.
853
1139
"""
854
1140
855
1141
@staticmethod
859
1145
If called like _is_dbus_thing("method") it returns a function
860
1146
suitable for use as predicate to inspect.getmembers().
861
1147
"""
862
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1148
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
863
1149
False)
864
1150
865
1151
def _get_all_dbus_things(self, thing):
866
1152
"""Returns a generator of (name, attribute) pairs
867
1153
"""
868
return ((getattr(athing.__get__(self), "_dbus_name",
869
name),
1154
return ((getattr(athing.__get__(self), "_dbus_name", name),
870
1155
athing.__get__(self))
871
1156
for cls in self.__class__.__mro__
872
1157
for name, athing in
873
inspect.getmembers(cls,
874
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
"""
875
1230
876
1231
def _get_dbus_property(self, interface_name, property_name):
877
1232
"""Returns a bound method if one exists which is a D-Bus
878
1233
property with the specified name and interface.
879
1234
"""
880
for cls in self.__class__.__mro__:
881
for name, value in (inspect.getmembers
882
(cls,
883
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")):
884
1238
if (value._dbus_name == property_name
885
1239
and value._dbus_interface == interface_name):
886
1240
return value.__get__(self)
887
1241
888
1242
# No such property
889
raise DBusPropertyNotFound(self.dbus_object_path + ":"
890
+ interface_name + "."
891
+ property_name)
892
893
@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",
894
1257
out_signature="v")
895
1258
def Get(self, interface_name, property_name):
896
1259
"""Standard D-Bus property Get() method, see D-Bus standard.
914
1277
# The byte_arrays option is not supported yet on
915
1278
# signatures other than "ay".
916
1279
if prop._dbus_signature != "ay":
917
raise ValueError
1280
raise ValueError("Byte arrays not supported for non-"
1281
"'ay' signature {!r}"
1282
.format(prop._dbus_signature))
918
1283
value = dbus.ByteArray(b''.join(chr(byte)
919
1284
for byte in value))
920
1285
prop(value)
921
1286
922
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1287
@dbus.service.method(dbus.PROPERTIES_IFACE,
1288
in_signature="s",
923
1289
out_signature="a{sv}")
924
1290
def GetAll(self, interface_name):
925
1291
"""Standard D-Bus property GetAll() method, see D-Bus
940
1306
if not hasattr(value, "variant_level"):
941
1307
properties[name] = value
942
1308
continue
943
properties[name] = type(value)(value, variant_level=
944
value.variant_level+1)
1309
properties[name] = type(value)(
1310
value, variant_level = value.variant_level + 1)
945
1311
return dbus.Dictionary(properties, signature="sv")
946
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
947
1321
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
948
1322
out_signature="s",
949
1323
path_keyword='object_path',
953
1327
954
1328
Inserts property tags and interface annotation tags.
955
1329
"""
956
xmlstring = dbus.service.Object.Introspect(self, object_path,
957
connection)
1330
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1331
object_path,
1332
connection)
958
1333
try:
959
1334
document = xml.dom.minidom.parseString(xmlstring)
1335
960
1336
def make_tag(document, name, prop):
961
1337
e = document.createElement("property")
962
1338
e.setAttribute("name", name)
963
1339
e.setAttribute("type", prop._dbus_signature)
964
1340
e.setAttribute("access", prop._dbus_access)
965
1341
return e
1342
966
1343
for if_tag in document.getElementsByTagName("interface"):
967
1344
# Add property tags
968
1345
for tag in (make_tag(document, name, prop)
971
1348
if prop._dbus_interface
972
1349
== if_tag.getAttribute("name")):
973
1350
if_tag.appendChild(tag)
974
# Add annotation tags
975
for typ in ("method", "signal", "property"):
976
for tag in if_tag.getElementsByTagName(typ):
977
annots = dict()
978
for name, prop in (self.
979
_get_all_dbus_things(typ)):
980
if (name == tag.getAttribute("name")
981
and prop._dbus_interface
982
== if_tag.getAttribute("name")):
983
annots.update(getattr
984
(prop,
985
"_dbus_annotations",
986
{}))
987
for name, value in annots.iteritems():
988
ann_tag = document.createElement(
989
"annotation")
990
ann_tag.setAttribute("name", name)
991
ann_tag.setAttribute("value", value)
992
tag.appendChild(ann_tag)
993
# Add interface annotation tags
994
for annotation, value in dict(
995
itertools.chain.from_iterable(
996
annotations().iteritems()
997
for name, annotations in
998
self._get_all_dbus_things("interface")
999
if name == if_tag.getAttribute("name")
1000
)).iteritems():
1001
ann_tag = document.createElement("annotation")
1002
ann_tag.setAttribute("name", annotation)
1003
ann_tag.setAttribute("value", value)
1004
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)
1005
1367
# Add the names to the return values for the
1006
1368
# "org.freedesktop.DBus.Properties" methods
1007
1369
if (if_tag.getAttribute("name")
1025
1387
exc_info=error)
1026
1388
return xmlstring
1027
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
1028
1458
1029
1459
def datetime_to_dbus(dt, variant_level=0):
1030
1460
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1031
1461
if dt is None:
1032
1462
return dbus.String("", variant_level = variant_level)
1033
return dbus.String(dt.isoformat(),
1034
variant_level=variant_level)
1463
return dbus.String(dt.isoformat(), variant_level=variant_level)
1035
1464
1036
1465
1037
1466
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1057
1486
(from DBusObjectWithProperties) and interfaces (from the
1058
1487
dbus_interface_annotations decorator).
1059
1488
"""
1489
1060
1490
def wrapper(cls):
1061
1491
for orig_interface_name, alt_interface_name in (
1062
alt_interface_names.iteritems()):
1492
alt_interface_names.items()):
1063
1493
attr = {}
1064
1494
interface_names = set()
1065
1495
# Go though all attributes of the class
1067
1497
# Ignore non-D-Bus attributes, and D-Bus attributes
1068
1498
# with the wrong interface name
1069
1499
if (not hasattr(attribute, "_dbus_interface")
1070
or not attribute._dbus_interface
1071
.startswith(orig_interface_name)):
1500
or not attribute._dbus_interface.startswith(
1501
orig_interface_name)):
1072
1502
continue
1073
1503
# Create an alternate D-Bus interface name based on
1074
1504
# the current name
1075
alt_interface = (attribute._dbus_interface
1076
.replace(orig_interface_name,
1077
alt_interface_name))
1505
alt_interface = attribute._dbus_interface.replace(
1506
orig_interface_name, alt_interface_name)
1078
1507
interface_names.add(alt_interface)
1079
1508
# Is this a D-Bus signal?
1080
1509
if getattr(attribute, "_dbus_is_signal", False):
1081
# Extract the original non-method undecorated
1082
# function by black magic
1083
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(
1084
1514
zip(attribute.func_code.co_freevars,
1085
attribute.__closure__))["func"]
1086
.cell_contents)
1515
attribute.__closure__))
1516
["func"].cell_contents)
1517
else:
1518
nonmethod_func = attribute
1087
1519
# Create a new, but exactly alike, function
1088
1520
# object, and decorate it to be a new D-Bus signal
1089
1521
# with the alternate D-Bus interface name
1090
new_function = (dbus.service.signal
1091
(alt_interface,
1092
attribute._dbus_signature)
1093
(types.FunctionType(
1094
nonmethod_func.func_code,
1095
nonmethod_func.func_globals,
1096
nonmethod_func.func_name,
1097
nonmethod_func.func_defaults,
1098
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))
1099
1539
# Copy annotations, if any
1100
1540
try:
1101
new_function._dbus_annotations = (
1102
dict(attribute._dbus_annotations))
1541
new_function._dbus_annotations = dict(
1542
attribute._dbus_annotations)
1103
1543
except AttributeError:
1104
1544
pass
1105
1545
# Define a creator of a function to call both the
1110
1550
"""This function is a scope container to pass
1111
1551
func1 and func2 to the "call_both" function
1112
1552
outside of its arguments"""
1553
1554
@functools.wraps(func2)
1113
1555
def call_both(*args, **kwargs):
1114
1556
"""This function will emit two D-Bus
1115
1557
signals by calling func1 and func2"""
1116
1558
func1(*args, **kwargs)
1117
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
1118
1565
return call_both
1119
1566
# Create the "call_both" function and add it to
1120
1567
# the class
1125
1572
# object. Decorate it to be a new D-Bus method
1126
1573
# with the alternate D-Bus interface name. Add it
1127
1574
# to the class.
1128
attr[attrname] = (dbus.service.method
1129
(alt_interface,
1130
attribute._dbus_in_signature,
1131
attribute._dbus_out_signature)
1132
(types.FunctionType
1133
(attribute.func_code,
1134
attribute.func_globals,
1135
attribute.func_name,
1136
attribute.func_defaults,
1137
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)))
1138
1585
# Copy annotations, if any
1139
1586
try:
1140
attr[attrname]._dbus_annotations = (
1141
dict(attribute._dbus_annotations))
1587
attr[attrname]._dbus_annotations = dict(
1588
attribute._dbus_annotations)
1142
1589
except AttributeError:
1143
1590
pass
1144
1591
# Is this a D-Bus property?
1147
1594
# object, and decorate it to be a new D-Bus
1148
1595
# property with the alternate D-Bus interface
1149
1596
# name. Add it to the class.
1150
attr[attrname] = (dbus_service_property
1151
(alt_interface,
1152
attribute._dbus_signature,
1153
attribute._dbus_access,
1154
attribute
1155
._dbus_get_args_options
1156
["byte_arrays"])
1157
(types.FunctionType
1158
(attribute.func_code,
1159
attribute.func_globals,
1160
attribute.func_name,
1161
attribute.func_defaults,
1162
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)))
1163
1608
# Copy annotations, if any
1164
1609
try:
1165
attr[attrname]._dbus_annotations = (
1166
dict(attribute._dbus_annotations))
1610
attr[attrname]._dbus_annotations = dict(
1611
attribute._dbus_annotations)
1167
1612
except AttributeError:
1168
1613
pass
1169
1614
# Is this a D-Bus interface?
1172
1617
# object. Decorate it to be a new D-Bus interface
1173
1618
# with the alternate D-Bus interface name. Add it
1174
1619
# to the class.
1175
attr[attrname] = (dbus_interface_annotations
1176
(alt_interface)
1177
(types.FunctionType
1178
(attribute.func_code,
1179
attribute.func_globals,
1180
attribute.func_name,
1181
attribute.func_defaults,
1182
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)))
1183
1627
if deprecate:
1184
1628
# Deprecate all alternate interfaces
1185
iname="_AlternateDBusNames_interface_annotation{0}"
1629
iname="_AlternateDBusNames_interface_annotation{}"
1186
1630
for interface_name in interface_names:
1631
1187
1632
@dbus_interface_annotations(interface_name)
1188
1633
def func(self):
1189
1634
return { "org.freedesktop.DBus.Deprecated":
1190
"true" }
1635
"true" }
1191
1636
# Find an unused name
1192
1637
for aname in (iname.format(i)
1193
1638
for i in itertools.count()):
1197
1642
if interface_names:
1198
1643
# Replace the class with a new subclass of it with
1199
1644
# methods, signals, etc. as created above.
1200
cls = type(b"{0}Alternate".format(cls.__name__),
1201
(cls,), attr)
1645
cls = type(b"{}Alternate".format(cls.__name__),
1646
(cls, ), attr)
1202
1647
return cls
1648
1203
1649
return wrapper
1204
1650
1205
1651
1206
1652
@alternate_dbus_interfaces({"se.recompile.Mandos":
1207
"se.bsnet.fukt.Mandos"})
1653
"se.bsnet.fukt.Mandos"})
1208
1654
class ClientDBus(Client, DBusObjectWithProperties):
1209
1655
"""A Client class using D-Bus
1210
1656
1214
1660
"""
1215
1661
1216
1662
runtime_expansions = (Client.runtime_expansions
1217
+ ("dbus_object_path",))
1663
+ ("dbus_object_path", ))
1664
1665
_interface = "se.recompile.Mandos.Client"
1218
1666
1219
1667
# dbus.service.Object doesn't use super(), so we can't either.
1220
1668
1223
1671
Client.__init__(self, *args, **kwargs)
1224
1672
# Only now, when this client is initialized, can it show up on
1225
1673
# the D-Bus
1226
client_object_name = unicode(self.name).translate(
1674
client_object_name = str(self.name).translate(
1227
1675
{ord("."): ord("_"),
1228
1676
ord("-"): ord("_")})
1229
self.dbus_object_path = (dbus.ObjectPath
1230
("/clients/" + client_object_name))
1677
self.dbus_object_path = dbus.ObjectPath(
1678
"/clients/" + client_object_name)
1231
1679
DBusObjectWithProperties.__init__(self, self.bus,
1232
1680
self.dbus_object_path)
1233
1681
1234
def notifychangeproperty(transform_func,
1235
dbus_name, type_func=lambda x: x,
1236
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):
1237
1687
""" Modify a variable so that it's a property which announces
1238
1688
its changes to DBus.
1239
1689
1244
1694
to the D-Bus. Default: no transform
1245
1695
variant_level: D-Bus variant level. Default: 1
1246
1696
"""
1247
attrname = "_{0}".format(dbus_name)
1697
attrname = "_{}".format(dbus_name)
1698
1248
1699
def setter(self, value):
1249
1700
if hasattr(self, "dbus_object_path"):
1250
1701
if (not hasattr(self, attrname) or
1251
1702
type_func(getattr(self, attrname, None))
1252
1703
!= type_func(value)):
1253
dbus_value = transform_func(type_func(value),
1254
variant_level
1255
=variant_level)
1256
self.PropertyChanged(dbus.String(dbus_name),
1257
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())
1258
1719
setattr(self, attrname, value)
1259
1720
1260
1721
return property(lambda self: getattr(self, attrname), setter)
1266
1727
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1267
1728
last_enabled = notifychangeproperty(datetime_to_dbus,
1268
1729
"LastEnabled")
1269
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1270
type_func = lambda checker:
1271
checker is not None)
1730
checker = notifychangeproperty(
1731
dbus.Boolean, "CheckerRunning",
1732
type_func = lambda checker: checker is not None)
1272
1733
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1273
1734
"LastCheckedOK")
1274
1735
last_checker_status = notifychangeproperty(dbus.Int16,
1277
1738
datetime_to_dbus, "LastApprovalRequest")
1278
1739
approved_by_default = notifychangeproperty(dbus.Boolean,
1279
1740
"ApprovedByDefault")
1280
approval_delay = notifychangeproperty(dbus.UInt64,
1281
"ApprovalDelay",
1282
type_func =
1283
timedelta_to_milliseconds)
1741
approval_delay = notifychangeproperty(
1742
dbus.UInt64, "ApprovalDelay",
1743
type_func = lambda td: td.total_seconds() * 1000)
1284
1744
approval_duration = notifychangeproperty(
1285
1745
dbus.UInt64, "ApprovalDuration",
1286
type_func = timedelta_to_milliseconds)
1746
type_func = lambda td: td.total_seconds() * 1000)
1287
1747
host = notifychangeproperty(dbus.String, "Host")
1288
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1289
type_func =
1290
timedelta_to_milliseconds)
1748
timeout = notifychangeproperty(
1749
dbus.UInt64, "Timeout",
1750
type_func = lambda td: td.total_seconds() * 1000)
1291
1751
extended_timeout = notifychangeproperty(
1292
1752
dbus.UInt64, "ExtendedTimeout",
1293
type_func = timedelta_to_milliseconds)
1294
interval = notifychangeproperty(dbus.UInt64,
1295
"Interval",
1296
type_func =
1297
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)
1298
1757
checker_command = notifychangeproperty(dbus.String, "Checker")
1758
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1759
invalidate_only=True)
1299
1760
1300
1761
del notifychangeproperty
1301
1762
1308
1769
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1309
1770
Client.__del__(self, *args, **kwargs)
1310
1771
1311
def checker_callback(self, pid, condition, command,
1312
*args, **kwargs):
1313
self.checker_callback_tag = None
1314
self.checker = None
1315
if os.WIFEXITED(condition):
1316
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:
1317
1779
# Emit D-Bus signal
1318
1780
self.CheckerCompleted(dbus.Int16(exitstatus),
1319
dbus.Int64(condition),
1781
# This is specific to GNU libC
1782
dbus.Int64(exitstatus << 8),
1320
1783
dbus.String(command))
1321
1784
else:
1322
1785
# Emit D-Bus signal
1323
1786
self.CheckerCompleted(dbus.Int16(-1),
1324
dbus.Int64(condition),
1787
dbus.Int64(
1788
# This is specific to GNU libC
1789
(exitstatus << 8)
1790
| self.last_checker_signal),
1325
1791
dbus.String(command))
1326
1327
return Client.checker_callback(self, pid, condition, command,
1328
*args, **kwargs)
1792
return ret
1329
1793
1330
1794
def start_checker(self, *args, **kwargs):
1331
old_checker = self.checker
1332
if self.checker is not None:
1333
old_checker_pid = self.checker.pid
1334
else:
1335
old_checker_pid = None
1795
old_checker_pid = getattr(self.checker, "pid", None)
1336
1796
r = Client.start_checker(self, *args, **kwargs)
1337
1797
# Only if new checker process was started
1338
1798
if (self.checker is not None
1347
1807
1348
1808
def approve(self, value=True):
1349
1809
self.approved = value
1350
gobject.timeout_add(timedelta_to_milliseconds
1351
(self.approval_duration),
1352
self._reset_approved)
1810
gobject.timeout_add(int(self.approval_duration.total_seconds()
1811
* 1000), self._reset_approved)
1353
1812
self.send_changedstate()
1354
1813
1355
1814
## D-Bus methods, signals & properties
1356
_interface = "se.recompile.Mandos.Client"
1357
1815
1358
1816
## Interfaces
1359
1817
1360
@dbus_interface_annotations(_interface)
1361
def _foo(self):
1362
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1363
"false"}
1364
1365
1818
## Signals
1366
1819
1367
1820
# CheckerCompleted - signal
1377
1830
pass
1378
1831
1379
1832
# PropertyChanged - signal
1833
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1380
1834
@dbus.service.signal(_interface, signature="sv")
1381
1835
def PropertyChanged(self, property, value):
1382
1836
"D-Bus signal"
1416
1870
self.checked_ok()
1417
1871
1418
1872
# Enable - method
1873
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1419
1874
@dbus.service.method(_interface)
1420
1875
def Enable(self):
1421
1876
"D-Bus method"
1422
1877
self.enable()
1423
1878
1424
1879
# StartChecker - method
1880
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1425
1881
@dbus.service.method(_interface)
1426
1882
def StartChecker(self):
1427
1883
"D-Bus method"
1428
1884
self.start_checker()
1429
1885
1430
1886
# Disable - method
1887
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1431
1888
@dbus.service.method(_interface)
1432
1889
def Disable(self):
1433
1890
"D-Bus method"
1434
1891
self.disable()
1435
1892
1436
1893
# StopChecker - method
1894
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1437
1895
@dbus.service.method(_interface)
1438
1896
def StopChecker(self):
1439
1897
self.stop_checker()
1446
1904
return dbus.Boolean(bool(self.approvals_pending))
1447
1905
1448
1906
# ApprovedByDefault - property
1449
@dbus_service_property(_interface, signature="b",
1907
@dbus_service_property(_interface,
1908
signature="b",
1450
1909
access="readwrite")
1451
1910
def ApprovedByDefault_dbus_property(self, value=None):
1452
1911
if value is None: # get
1454
1913
self.approved_by_default = bool(value)
1455
1914
1456
1915
# ApprovalDelay - property
1457
@dbus_service_property(_interface, signature="t",
1916
@dbus_service_property(_interface,
1917
signature="t",
1458
1918
access="readwrite")
1459
1919
def ApprovalDelay_dbus_property(self, value=None):
1460
1920
if value is None: # get
1461
return dbus.UInt64(self.approval_delay_milliseconds())
1921
return dbus.UInt64(self.approval_delay.total_seconds()
1922
* 1000)
1462
1923
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1463
1924
1464
1925
# ApprovalDuration - property
1465
@dbus_service_property(_interface, signature="t",
1926
@dbus_service_property(_interface,
1927
signature="t",
1466
1928
access="readwrite")
1467
1929
def ApprovalDuration_dbus_property(self, value=None):
1468
1930
if value is None: # get
1469
return dbus.UInt64(timedelta_to_milliseconds(
1470
self.approval_duration))
1931
return dbus.UInt64(self.approval_duration.total_seconds()
1932
* 1000)
1471
1933
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1472
1934
1473
1935
# Name - property
1936
@dbus_annotations(
1937
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1474
1938
@dbus_service_property(_interface, signature="s", access="read")
1475
1939
def Name_dbus_property(self):
1476
1940
return dbus.String(self.name)
1477
1941
1478
1942
# Fingerprint - property
1943
@dbus_annotations(
1944
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1479
1945
@dbus_service_property(_interface, signature="s", access="read")
1480
1946
def Fingerprint_dbus_property(self):
1481
1947
return dbus.String(self.fingerprint)
1482
1948
1483
1949
# Host - property
1484
@dbus_service_property(_interface, signature="s",
1950
@dbus_service_property(_interface,
1951
signature="s",
1485
1952
access="readwrite")
1486
1953
def Host_dbus_property(self, value=None):
1487
1954
if value is None: # get
1488
1955
return dbus.String(self.host)
1489
self.host = unicode(value)
1956
self.host = str(value)
1490
1957
1491
1958
# Created - property
1959
@dbus_annotations(
1960
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1492
1961
@dbus_service_property(_interface, signature="s", access="read")
1493
1962
def Created_dbus_property(self):
1494
1963
return datetime_to_dbus(self.created)
1499
1968
return datetime_to_dbus(self.last_enabled)
1500
1969
1501
1970
# Enabled - property
1502
@dbus_service_property(_interface, signature="b",
1971
@dbus_service_property(_interface,
1972
signature="b",
1503
1973
access="readwrite")
1504
1974
def Enabled_dbus_property(self, value=None):
1505
1975
if value is None: # get
1510
1980
self.disable()
1511
1981
1512
1982
# LastCheckedOK - property
1513
@dbus_service_property(_interface, signature="s",
1983
@dbus_service_property(_interface,
1984
signature="s",
1514
1985
access="readwrite")
1515
1986
def LastCheckedOK_dbus_property(self, value=None):
1516
1987
if value is not None:
1519
1990
return datetime_to_dbus(self.last_checked_ok)
1520
1991
1521
1992
# LastCheckerStatus - property
1522
@dbus_service_property(_interface, signature="n",
1523
access="read")
1993
@dbus_service_property(_interface, signature="n", access="read")
1524
1994
def LastCheckerStatus_dbus_property(self):
1525
1995
return dbus.Int16(self.last_checker_status)
1526
1996
1535
2005
return datetime_to_dbus(self.last_approval_request)
1536
2006
1537
2007
# Timeout - property
1538
@dbus_service_property(_interface, signature="t",
2008
@dbus_service_property(_interface,
2009
signature="t",
1539
2010
access="readwrite")
1540
2011
def Timeout_dbus_property(self, value=None):
1541
2012
if value is None: # get
1542
return dbus.UInt64(self.timeout_milliseconds())
2013
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1543
2014
old_timeout = self.timeout
1544
2015
self.timeout = datetime.timedelta(0, 0, 0, value)
1545
2016
# Reschedule disabling
1554
2025
is None):
1555
2026
return
1556
2027
gobject.source_remove(self.disable_initiator_tag)
1557
self.disable_initiator_tag = (
1558
gobject.timeout_add(
1559
timedelta_to_milliseconds(self.expires - now),
1560
self.disable))
2028
self.disable_initiator_tag = gobject.timeout_add(
2029
int((self.expires - now).total_seconds() * 1000),
2030
self.disable)
1561
2031
1562
2032
# ExtendedTimeout - property
1563
@dbus_service_property(_interface, signature="t",
2033
@dbus_service_property(_interface,
2034
signature="t",
1564
2035
access="readwrite")
1565
2036
def ExtendedTimeout_dbus_property(self, value=None):
1566
2037
if value is None: # get
1567
return dbus.UInt64(self.extended_timeout_milliseconds())
2038
return dbus.UInt64(self.extended_timeout.total_seconds()
2039
* 1000)
1568
2040
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1569
2041
1570
2042
# Interval - property
1571
@dbus_service_property(_interface, signature="t",
2043
@dbus_service_property(_interface,
2044
signature="t",
1572
2045
access="readwrite")
1573
2046
def Interval_dbus_property(self, value=None):
1574
2047
if value is None: # get
1575
return dbus.UInt64(self.interval_milliseconds())
2048
return dbus.UInt64(self.interval.total_seconds() * 1000)
1576
2049
self.interval = datetime.timedelta(0, 0, 0, value)
1577
2050
if getattr(self, "checker_initiator_tag", None) is None:
1578
2051
return
1579
2052
if self.enabled:
1580
2053
# Reschedule checker run
1581
2054
gobject.source_remove(self.checker_initiator_tag)
1582
self.checker_initiator_tag = (gobject.timeout_add
1583
(value, self.start_checker))
1584
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
1585
2058
1586
2059
# Checker - property
1587
@dbus_service_property(_interface, signature="s",
2060
@dbus_service_property(_interface,
2061
signature="s",
1588
2062
access="readwrite")
1589
2063
def Checker_dbus_property(self, value=None):
1590
2064
if value is None: # get
1591
2065
return dbus.String(self.checker_command)
1592
self.checker_command = unicode(value)
2066
self.checker_command = str(value)
1593
2067
1594
2068
# CheckerRunning - property
1595
@dbus_service_property(_interface, signature="b",
2069
@dbus_service_property(_interface,
2070
signature="b",
1596
2071
access="readwrite")
1597
2072
def CheckerRunning_dbus_property(self, value=None):
1598
2073
if value is None: # get
1603
2078
self.stop_checker()
1604
2079
1605
2080
# ObjectPath - property
2081
@dbus_annotations(
2082
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2083
"org.freedesktop.DBus.Deprecated": "true"})
1606
2084
@dbus_service_property(_interface, signature="o", access="read")
1607
2085
def ObjectPath_dbus_property(self):
1608
2086
return self.dbus_object_path # is already a dbus.ObjectPath
1609
2087
1610
2088
# Secret = property
1611
@dbus_service_property(_interface, signature="ay",
1612
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)
1613
2096
def Secret_dbus_property(self, value):
1614
self.secret = str(value)
2097
self.secret = bytes(value)
1615
2098
1616
2099
del _interface
1617
2100
1621
2104
self._pipe = child_pipe
1622
2105
self._pipe.send(('init', fpr, address))
1623
2106
if not self._pipe.recv():
1624
raise KeyError()
2107
raise KeyError(fpr)
1625
2108
1626
2109
def __getattribute__(self, name):
1627
2110
if name == '_pipe':
1631
2114
if data[0] == 'data':
1632
2115
return data[1]
1633
2116
if data[0] == 'function':
2117
1634
2118
def func(*args, **kwargs):
1635
2119
self._pipe.send(('funcall', name, args, kwargs))
1636
2120
return self._pipe.recv()[1]
2121
1637
2122
return func
1638
2123
1639
2124
def __setattr__(self, name, value):
1651
2136
def handle(self):
1652
2137
with contextlib.closing(self.server.child_pipe) as child_pipe:
1653
2138
logger.info("TCP connection from: %s",
1654
unicode(self.client_address))
2139
str(self.client_address))
1655
2140
logger.debug("Pipe FD: %d",
1656
2141
self.server.child_pipe.fileno())
1657
2142
1658
session = (gnutls.connection
1659
.ClientSession(self.request,
1660
gnutls.connection
1661
.X509Credentials()))
1662
1663
# Note: gnutls.connection.X509Credentials is really a
1664
# generic GnuTLS certificate credentials object so long as
1665
# no X.509 keys are added to it. Therefore, we can use it
1666
# here despite using OpenPGP certificates.
2143
session = gnutls.ClientSession(self.request)
1667
2144
1668
2145
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1669
2146
# "+AES-256-CBC", "+SHA1",
1673
2150
priority = self.server.gnutls_priority
1674
2151
if priority is None:
1675
2152
priority = "NORMAL"
1676
(gnutls.library.functions
1677
.gnutls_priority_set_direct(session._c_object,
1678
priority, None))
2153
gnutls.priority_set_direct(session._c_object, priority,
2154
None)
1679
2155
1680
2156
# Start communication using the Mandos protocol
1681
2157
# Get protocol number
1683
2159
logger.debug("Protocol version: %r", line)
1684
2160
try:
1685
2161
if int(line.strip().split()[0]) > 1:
1686
raise RuntimeError
2162
raise RuntimeError(line)
1687
2163
except (ValueError, IndexError, RuntimeError) as error:
1688
2164
logger.error("Unknown protocol version: %s", error)
1689
2165
return
1691
2167
# Start GnuTLS connection
1692
2168
try:
1693
2169
session.handshake()
1694
except gnutls.errors.GNUTLSError as error:
2170
except gnutls.Error as error:
1695
2171
logger.warning("Handshake failed: %s", error)
1696
2172
# Do not run session.bye() here: the session is not
1697
2173
# established. Just abandon the request.
1701
2177
approval_required = False
1702
2178
try:
1703
2179
try:
1704
fpr = self.fingerprint(self.peer_certificate
1705
(session))
1706
except (TypeError,
1707
gnutls.errors.GNUTLSError) as error:
2180
fpr = self.fingerprint(
2181
self.peer_certificate(session))
2182
except (TypeError, gnutls.Error) as error:
1708
2183
logger.warning("Bad certificate: %s", error)
1709
2184
return
1710
2185
logger.debug("Fingerprint: %s", fpr)
1723
2198
while True:
1724
2199
if not client.enabled:
1725
2200
logger.info("Client %s is disabled",
1726
client.name)
2201
client.name)
1727
2202
if self.server.use_dbus:
1728
2203
# Emit D-Bus signal
1729
2204
client.Rejected("Disabled")
1738
2213
if self.server.use_dbus:
1739
2214
# Emit D-Bus signal
1740
2215
client.NeedApproval(
1741
client.approval_delay_milliseconds(),
1742
client.approved_by_default)
2216
client.approval_delay.total_seconds()
2217
* 1000, client.approved_by_default)
1743
2218
else:
1744
2219
logger.warning("Client %s was not approved",
1745
2220
client.name)
1751
2226
#wait until timeout or approved
1752
2227
time = datetime.datetime.now()
1753
2228
client.changedstate.acquire()
1754
client.changedstate.wait(
1755
float(timedelta_to_milliseconds(delay)
1756
/ 1000))
2229
client.changedstate.wait(delay.total_seconds())
1757
2230
client.changedstate.release()
1758
2231
time2 = datetime.datetime.now()
1759
2232
if (time2 - time) >= delay:
1770
2243
else:
1771
2244
delay -= time2 - time
1772
2245
1773
sent_size = 0
1774
while sent_size < len(client.secret):
1775
try:
1776
sent = session.send(client.secret[sent_size:])
1777
except gnutls.errors.GNUTLSError as error:
1778
logger.warning("gnutls send failed",
1779
exc_info=error)
1780
return
1781
logger.debug("Sent: %d, remaining: %d",
1782
sent, len(client.secret)
1783
- (sent_size + sent))
1784
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
1785
2252
1786
2253
logger.info("Sending secret to %s", client.name)
1787
2254
# bump the timeout using extended_timeout
1795
2262
client.approvals_pending -= 1
1796
2263
try:
1797
2264
session.bye()
1798
except gnutls.errors.GNUTLSError as error:
2265
except gnutls.Error as error:
1799
2266
logger.warning("GnuTLS bye failed",
1800
2267
exc_info=error)
1801
2268
1803
2270
def peer_certificate(session):
1804
2271
"Return the peer's OpenPGP certificate as a bytestring"
1805
2272
# If not an OpenPGP certificate...
1806
if (gnutls.library.functions
1807
.gnutls_certificate_type_get(session._c_object)
1808
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1809
# ...do the normal thing
1810
return session.peer_certificate
2273
if (gnutls.certificate_type_get(session._c_object)
2274
!= gnutls.CRT_OPENPGP):
2275
# ...return invalid data
2276
return b""
1811
2277
list_size = ctypes.c_uint(1)
1812
cert_list = (gnutls.library.functions
1813
.gnutls_certificate_get_peers
2278
cert_list = (gnutls.certificate_get_peers
1814
2279
(session._c_object, ctypes.byref(list_size)))
1815
2280
if not bool(cert_list) and list_size.value != 0:
1816
raise gnutls.errors.GNUTLSError("error getting peer"
1817
" certificate")
2281
raise gnutls.Error("error getting peer certificate")
1818
2282
if list_size.value == 0:
1819
2283
return None
1820
2284
cert = cert_list[0]
1824
2288
def fingerprint(openpgp):
1825
2289
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1826
2290
# New GnuTLS "datum" with the OpenPGP public key
1827
datum = (gnutls.library.types
1828
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1829
ctypes.POINTER
1830
(ctypes.c_ubyte)),
1831
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)))
1832
2295
# New empty GnuTLS certificate
1833
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1834
(gnutls.library.functions
1835
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2296
crt = gnutls.openpgp_crt_t()
2297
gnutls.openpgp_crt_init(ctypes.byref(crt))
1836
2298
# Import the OpenPGP public key into the certificate
1837
(gnutls.library.functions
1838
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1839
gnutls.library.constants
1840
.GNUTLS_OPENPGP_FMT_RAW))
2299
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2300
gnutls.OPENPGP_FMT_RAW)
1841
2301
# Verify the self signature in the key
1842
2302
crtverify = ctypes.c_uint()
1843
(gnutls.library.functions
1844
.gnutls_openpgp_crt_verify_self(crt, 0,
1845
ctypes.byref(crtverify)))
2303
gnutls.openpgp_crt_verify_self(crt, 0,
2304
ctypes.byref(crtverify))
1846
2305
if crtverify.value != 0:
1847
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1848
raise (gnutls.errors.CertificateSecurityError
1849
("Verify failed"))
2306
gnutls.openpgp_crt_deinit(crt)
2307
raise gnutls.CertificateSecurityError("Verify failed")
1850
2308
# New buffer for the fingerprint
1851
2309
buf = ctypes.create_string_buffer(20)
1852
2310
buf_len = ctypes.c_size_t()
1853
2311
# Get the fingerprint from the certificate into the buffer
1854
(gnutls.library.functions
1855
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1856
ctypes.byref(buf_len)))
2312
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2313
ctypes.byref(buf_len))
1857
2314
# Deinit the certificate
1858
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2315
gnutls.openpgp_crt_deinit(crt)
1859
2316
# Convert the buffer to a Python bytestring
1860
2317
fpr = ctypes.string_at(buf, buf_len.value)
1861
2318
# Convert the bytestring to hexadecimal notation
1865
2322
1866
2323
class MultiprocessingMixIn(object):
1867
2324
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2325
1868
2326
def sub_process_main(self, request, address):
1869
2327
try:
1870
2328
self.finish_request(request, address)
1882
2340
1883
2341
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1884
2342
""" adds a pipe to the MixIn """
2343
1885
2344
def process_request(self, request, client_address):
1886
2345
"""Overrides and wraps the original process_request().
1887
2346
1896
2355
1897
2356
def add_pipe(self, parent_pipe, proc):
1898
2357
"""Dummy function; override as necessary"""
1899
raise NotImplementedError
2358
raise NotImplementedError()
1900
2359
1901
2360
1902
2361
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1908
2367
interface: None or a network interface name (string)
1909
2368
use_ipv6: Boolean; to use IPv6 or not
1910
2369
"""
2370
1911
2371
def __init__(self, server_address, RequestHandlerClass,
1912
interface=None, use_ipv6=True, socketfd=None):
2372
interface=None,
2373
use_ipv6=True,
2374
socketfd=None):
1913
2375
"""If socketfd is set, use that file descriptor instead of
1914
2376
creating a new one with socket.socket().
1915
2377
"""
1956
2418
self.interface)
1957
2419
else:
1958
2420
try:
1959
self.socket.setsockopt(socket.SOL_SOCKET,
1960
SO_BINDTODEVICE,
1961
str(self.interface + '\0'))
2421
self.socket.setsockopt(
2422
socket.SOL_SOCKET, SO_BINDTODEVICE,
2423
(self.interface + "\0").encode("utf-8"))
1962
2424
except socket.error as error:
1963
2425
if error.errno == errno.EPERM:
1964
2426
logger.error("No permission to bind to"
1978
2440
if self.address_family == socket.AF_INET6:
1979
2441
any_address = "::" # in6addr_any
1980
2442
else:
1981
any_address = socket.INADDR_ANY
2443
any_address = "0.0.0.0" # INADDR_ANY
1982
2444
self.server_address = (any_address,
1983
2445
self.server_address[1])
1984
2446
elif not self.server_address[1]:
1985
self.server_address = (self.server_address[0],
1986
0)
2447
self.server_address = (self.server_address[0], 0)
1987
2448
# if self.interface:
1988
2449
# self.server_address = (self.server_address[0],
1989
2450
# 0, # port
2003
2464
2004
2465
Assumes a gobject.MainLoop event loop.
2005
2466
"""
2467
2006
2468
def __init__(self, server_address, RequestHandlerClass,
2007
interface=None, use_ipv6=True, clients=None,
2008
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):
2009
2475
self.enabled = False
2010
2476
self.clients = clients
2011
2477
if self.clients is None:
2017
2483
interface = interface,
2018
2484
use_ipv6 = use_ipv6,
2019
2485
socketfd = socketfd)
2486
2020
2487
def server_activate(self):
2021
2488
if self.enabled:
2022
2489
return socketserver.TCPServer.server_activate(self)
2026
2493
2027
2494
def add_pipe(self, parent_pipe, proc):
2028
2495
# Call "handle_ipc" for both data and EOF events
2029
gobject.io_add_watch(parent_pipe.fileno(),
2030
gobject.IO_IN | gobject.IO_HUP,
2031
functools.partial(self.handle_ipc,
2032
parent_pipe =
2033
parent_pipe,
2034
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))
2035
2502
2036
def handle_ipc(self, source, condition, parent_pipe=None,
2037
proc = None, client_object=None):
2503
def handle_ipc(self, source, condition,
2504
parent_pipe=None,
2505
proc = None,
2506
client_object=None):
2038
2507
# error, or the other end of multiprocessing.Pipe has closed
2039
2508
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2040
2509
# Wait for other process to exit
2063
2532
parent_pipe.send(False)
2064
2533
return False
2065
2534
2066
gobject.io_add_watch(parent_pipe.fileno(),
2067
gobject.IO_IN | gobject.IO_HUP,
2068
functools.partial(self.handle_ipc,
2069
parent_pipe =
2070
parent_pipe,
2071
proc = proc,
2072
client_object =
2073
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))
2074
2542
parent_pipe.send(True)
2075
2543
# remove the old hook in favor of the new above hook on
2076
2544
# same fileno
2082
2550
2083
2551
parent_pipe.send(('data', getattr(client_object,
2084
2552
funcname)(*args,
2085
**kwargs)))
2553
**kwargs)))
2086
2554
2087
2555
if command == 'getattr':
2088
2556
attrname = request[1]
2089
if callable(client_object.__getattribute__(attrname)):
2090
parent_pipe.send(('function',))
2557
if isinstance(client_object.__getattribute__(attrname),
2558
collections.Callable):
2559
parent_pipe.send(('function', ))
2091
2560
else:
2092
parent_pipe.send(('data', client_object
2093
.__getattribute__(attrname)))
2561
parent_pipe.send((
2562
'data', client_object.__getattribute__(attrname)))
2094
2563
2095
2564
if command == 'setattr':
2096
2565
attrname = request[1]
2127
2596
# avoid excessive use of external libraries.
2128
2597
2129
2598
# New type for defining tokens, syntax, and semantics all-in-one
2130
Token = collections.namedtuple("Token",
2131
("regexp", # To match token; if
2132
# "value" is not None,
2133
# must have a "group"
2134
# containing digits
2135
"value", # datetime.timedelta or
2136
# None
2137
"followers")) # Tokens valid after
2138
# 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
2139
2604
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2140
2605
# the "duration" ABNF definition in RFC 3339, Appendix A.
2141
2606
token_end = Token(re.compile(r"$"), None, frozenset())
2142
2607
token_second = Token(re.compile(r"(\d+)S"),
2143
2608
datetime.timedelta(seconds=1),
2144
frozenset((token_end,)))
2609
frozenset((token_end, )))
2145
2610
token_minute = Token(re.compile(r"(\d+)M"),
2146
2611
datetime.timedelta(minutes=1),
2147
2612
frozenset((token_second, token_end)))
2163
2628
frozenset((token_month, token_end)))
2164
2629
token_week = Token(re.compile(r"(\d+)W"),
2165
2630
datetime.timedelta(weeks=1),
2166
frozenset((token_end,)))
2631
frozenset((token_end, )))
2167
2632
token_duration = Token(re.compile(r"P"), None,
2168
2633
frozenset((token_year, token_month,
2169
2634
token_day, token_time,
2170
token_week))),
2635
token_week)))
2171
2636
# Define starting values
2172
2637
value = datetime.timedelta() # Value so far
2173
2638
found_token = None
2174
followers = frozenset(token_duration,) # Following valid tokens
2639
followers = frozenset((token_duration, )) # Following valid tokens
2175
2640
s = duration # String left to parse
2176
2641
# Loop until end token is found
2177
2642
while found_token is not token_end:
2194
2659
break
2195
2660
else:
2196
2661
# No currently valid tokens were found
2197
raise ValueError("Invalid RFC 3339 duration")
2662
raise ValueError("Invalid RFC 3339 duration: {!r}"
2663
.format(duration))
2198
2664
# End token found
2199
2665
return value
2200
2666
2224
2690
timevalue = datetime.timedelta(0)
2225
2691
for s in interval.split():
2226
2692
try:
2227
suffix = unicode(s[-1])
2693
suffix = s[-1]
2228
2694
value = int(s[:-1])
2229
2695
if suffix == "d":
2230
2696
delta = datetime.timedelta(value)
2237
2703
elif suffix == "w":
2238
2704
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2239
2705
else:
2240
raise ValueError("Unknown suffix {0!r}"
2241
.format(suffix))
2242
except (ValueError, IndexError) as e:
2706
raise ValueError("Unknown suffix {!r}".format(suffix))
2707
except IndexError as e:
2243
2708
raise ValueError(*(e.args))
2244
2709
timevalue += delta
2245
2710
return timevalue
2261
2726
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2262
2727
if not stat.S_ISCHR(os.fstat(null).st_mode):
2263
2728
raise OSError(errno.ENODEV,
2264
"{0} not a character device"
2729
"{} not a character device"
2265
2730
.format(os.devnull))
2266
2731
os.dup2(null, sys.stdin.fileno())
2267
2732
os.dup2(null, sys.stdout.fileno())
2277
2742
2278
2743
parser = argparse.ArgumentParser()
2279
2744
parser.add_argument("-v", "--version", action="version",
2280
version = "%(prog)s {0}".format(version),
2745
version = "%(prog)s {}".format(version),
2281
2746
help="show version number and exit")
2282
2747
parser.add_argument("-i", "--interface", metavar="IF",
2283
2748
help="Bind to interface IF")
2289
2754
help="Run self-test")
2290
2755
parser.add_argument("--debug", action="store_true",
2291
2756
help="Debug mode; run in foreground and log"
2292
" to terminal")
2757
" to terminal", default=None)
2293
2758
parser.add_argument("--debuglevel", metavar="LEVEL",
2294
2759
help="Debug level for stdout output")
2295
2760
parser.add_argument("--priority", help="GnuTLS"
2302
2767
" files")
2303
2768
parser.add_argument("--no-dbus", action="store_false",
2304
2769
dest="use_dbus", help="Do not provide D-Bus"
2305
" system bus interface")
2770
" system bus interface", default=None)
2306
2771
parser.add_argument("--no-ipv6", action="store_false",
2307
dest="use_ipv6", help="Do not use IPv6")
2772
dest="use_ipv6", help="Do not use IPv6",
2773
default=None)
2308
2774
parser.add_argument("--no-restore", action="store_false",
2309
2775
dest="restore", help="Do not restore stored"
2310
" state")
2776
" state", default=None)
2311
2777
parser.add_argument("--socket", type=int,
2312
2778
help="Specify a file descriptor to a network"
2313
2779
" socket to use instead of creating one")
2314
2780
parser.add_argument("--statedir", metavar="DIR",
2315
2781
help="Directory to save/restore state in")
2316
2782
parser.add_argument("--foreground", action="store_true",
2317
help="Run in foreground")
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)
2318
2787
2319
2788
options = parser.parse_args()
2320
2789
2321
2790
if options.check:
2322
2791
import doctest
2323
doctest.testmod()
2324
sys.exit()
2792
fail_count, test_count = doctest.testmod()
2793
sys.exit(os.EX_OK if fail_count == 0 else 1)
2325
2794
2326
2795
# Default values for config file for server-global settings
2327
2796
server_defaults = { "interface": "",
2329
2798
"port": "",
2330
2799
"debug": "False",
2331
2800
"priority":
2332
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2801
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2802
":+SIGN-DSA-SHA256",
2333
2803
"servicename": "Mandos",
2334
2804
"use_dbus": "True",
2335
2805
"use_ipv6": "True",
2338
2808
"socket": "",
2339
2809
"statedir": "/var/lib/mandos",
2340
2810
"foreground": "False",
2341
}
2811
"zeroconf": "True",
2812
}
2342
2813
2343
2814
# Parse config file for server-global settings
2344
2815
server_config = configparser.SafeConfigParser(server_defaults)
2345
2816
del server_defaults
2346
server_config.read(os.path.join(options.configdir,
2347
"mandos.conf"))
2817
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2348
2818
# Convert the SafeConfigParser object to a dict
2349
2819
server_settings = server_config.defaults()
2350
2820
# Use the appropriate methods on the non-string config options
2368
2838
# Override the settings from the config file with command line
2369
2839
# options, if set.
2370
2840
for option in ("interface", "address", "port", "debug",
2371
"priority", "servicename", "configdir",
2372
"use_dbus", "use_ipv6", "debuglevel", "restore",
2373
"statedir", "socket", "foreground"):
2841
"priority", "servicename", "configdir", "use_dbus",
2842
"use_ipv6", "debuglevel", "restore", "statedir",
2843
"socket", "foreground", "zeroconf"):
2374
2844
value = getattr(options, option)
2375
2845
if value is not None:
2376
2846
server_settings[option] = value
2377
2847
del options
2378
2848
# Force all strings to be unicode
2379
2849
for option in server_settings.keys():
2380
if type(server_settings[option]) is str:
2381
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"))
2853
# Force all boolean options to be boolean
2854
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2855
"foreground", "zeroconf"):
2856
server_settings[option] = bool(server_settings[option])
2382
2857
# Debug implies foreground
2383
2858
if server_settings["debug"]:
2384
2859
server_settings["foreground"] = True
2386
2861
2387
2862
##################################################################
2388
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
2389
2869
# For convenience
2390
2870
debug = server_settings["debug"]
2391
2871
debuglevel = server_settings["debuglevel"]
2394
2874
stored_state_path = os.path.join(server_settings["statedir"],
2395
2875
stored_state_file)
2396
2876
foreground = server_settings["foreground"]
2877
zeroconf = server_settings["zeroconf"]
2397
2878
2398
2879
if debug:
2399
2880
initlogger(debug, logging.DEBUG)
2405
2886
initlogger(debug, level)
2406
2887
2407
2888
if server_settings["servicename"] != "Mandos":
2408
syslogger.setFormatter(logging.Formatter
2409
('Mandos ({0}) [%(process)d]:'
2410
' %(levelname)s: %(message)s'
2411
.format(server_settings
2412
["servicename"])))
2889
syslogger.setFormatter(
2890
logging.Formatter('Mandos ({}) [%(process)d]:'
2891
' %(levelname)s: %(message)s'.format(
2892
server_settings["servicename"])))
2413
2893
2414
2894
# Parse config file with clients
2415
2895
client_config = configparser.SafeConfigParser(Client
2420
2900
global mandos_dbus_service
2421
2901
mandos_dbus_service = None
2422
2902
2423
tcp_server = MandosServer((server_settings["address"],
2424
server_settings["port"]),
2425
ClientHandler,
2426
interface=(server_settings["interface"]
2427
or None),
2428
use_ipv6=use_ipv6,
2429
gnutls_priority=
2430
server_settings["priority"],
2431
use_dbus=use_dbus,
2432
socketfd=(server_settings["socket"]
2433
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)
2434
2914
if not foreground:
2435
pidfilename = "/var/run/mandos.pid"
2915
pidfilename = "/run/mandos.pid"
2916
if not os.path.isdir("/run/."):
2917
pidfilename = "/var/run/mandos.pid"
2436
2918
pidfile = None
2437
2919
try:
2438
pidfile = open(pidfilename, "w")
2920
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2439
2921
except IOError as e:
2440
2922
logger.error("Could not open file %r", pidfilename,
2441
2923
exc_info=e)
2455
2937
os.setuid(uid)
2456
2938
except OSError as error:
2457
2939
if error.errno != errno.EPERM:
2458
raise error
2940
raise
2459
2941
2460
2942
if debug:
2461
2943
# Enable all possible GnuTLS debugging
2462
2944
2463
2945
# "Use a log level over 10 to enable all debugging options."
2464
2946
# - GnuTLS manual
2465
gnutls.library.functions.gnutls_global_set_log_level(11)
2947
gnutls.global_set_log_level(11)
2466
2948
2467
@gnutls.library.types.gnutls_log_func
2949
@gnutls.log_func
2468
2950
def debug_gnutls(level, string):
2469
2951
logger.debug("GnuTLS: %s", string[:-1])
2470
2952
2471
(gnutls.library.functions
2472
.gnutls_global_set_log_function(debug_gnutls))
2953
gnutls.global_set_log_function(debug_gnutls)
2473
2954
2474
2955
# Redirect stdin so all checkers get /dev/null
2475
2956
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2495
2976
if use_dbus:
2496
2977
try:
2497
2978
bus_name = dbus.service.BusName("se.recompile.Mandos",
2498
bus, do_not_queue=True)
2499
old_bus_name = (dbus.service.BusName
2500
("se.bsnet.fukt.Mandos", bus,
2501
do_not_queue=True))
2502
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:
2503
2985
logger.error("Disabling D-Bus:", exc_info=e)
2504
2986
use_dbus = False
2505
2987
server_settings["use_dbus"] = False
2506
2988
tcp_server.use_dbus = False
2507
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2508
service = AvahiServiceToSyslog(name =
2509
server_settings["servicename"],
2510
servicetype = "_mandos._tcp",
2511
protocol = protocol, bus = bus)
2512
if server_settings["interface"]:
2513
service.interface = (if_nametoindex
2514
(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"))
2515
2999
2516
3000
global multiprocessing_manager
2517
3001
multiprocessing_manager = multiprocessing.Manager()
2524
3008
old_client_settings = {}
2525
3009
clients_data = {}
2526
3010
3011
# This is used to redirect stdout and stderr for checker processes
3012
global wnull
3013
wnull = open(os.devnull, "w") # A writable /dev/null
3014
# Only used if server is running in foreground but not in debug
3015
# mode
3016
if debug or not foreground:
3017
wnull.close()
3018
2527
3019
# Get client data and settings from last running state.
2528
3020
if server_settings["restore"]:
2529
3021
try:
2530
3022
with open(stored_state_path, "rb") as stored_state:
2531
clients_data, old_client_settings = (pickle.load
2532
(stored_state))
3023
clients_data, old_client_settings = pickle.load(
3024
stored_state)
2533
3025
os.remove(stored_state_path)
2534
3026
except IOError as e:
2535
3027
if e.errno == errno.ENOENT:
2536
logger.warning("Could not load persistent state: {0}"
2537
.format(os.strerror(e.errno)))
3028
logger.warning("Could not load persistent state:"
3029
" {}".format(os.strerror(e.errno)))
2538
3030
else:
2539
3031
logger.critical("Could not load persistent state:",
2540
3032
exc_info=e)
2541
3033
raise
2542
3034
except EOFError as e:
2543
3035
logger.warning("Could not load persistent state: "
2544
"EOFError:", exc_info=e)
3036
"EOFError:",
3037
exc_info=e)
2545
3038
2546
3039
with PGPEngine() as pgp:
2547
for client_name, client in clients_data.iteritems():
3040
for client_name, client in clients_data.items():
3041
# Skip removed clients
3042
if client_name not in client_settings:
3043
continue
3044
2548
3045
# Decide which value to use after restoring saved state.
2549
3046
# We have three different values: Old config file,
2550
3047
# new config file, and saved state.
2555
3052
# For each value in new config, check if it
2556
3053
# differs from the old config value (Except for
2557
3054
# the "secret" attribute)
2558
if (name != "secret" and
2559
value != old_client_settings[client_name]
2560
[name]):
3055
if (name != "secret"
3056
and (value !=
3057
old_client_settings[client_name][name])):
2561
3058
client[name] = value
2562
3059
except KeyError:
2563
3060
pass
2564
3061
2565
3062
# Clients who has passed its expire date can still be
2566
# enabled if its last checker was successful. Clients
3063
# enabled if its last checker was successful. A Client
2567
3064
# whose checker succeeded before we stored its state is
2568
3065
# assumed to have successfully run all checkers during
2569
3066
# downtime.
2571
3068
if datetime.datetime.utcnow() >= client["expires"]:
2572
3069
if not client["last_checked_ok"]:
2573
3070
logger.warning(
2574
"disabling client {0} - Client never "
2575
"performed a successful checker"
2576
.format(client_name))
3071
"disabling client {} - Client never "
3072
"performed a successful checker".format(
3073
client_name))
2577
3074
client["enabled"] = False
2578
3075
elif client["last_checker_status"] != 0:
2579
3076
logger.warning(
2580
"disabling client {0} - Client "
2581
"last checker failed with error code {1}"
2582
.format(client_name,
2583
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"]))
2584
3082
client["enabled"] = False
2585
3083
else:
2586
client["expires"] = (datetime.datetime
2587
.utcnow()
2588
+ client["timeout"])
3084
client["expires"] = (
3085
datetime.datetime.utcnow()
3086
+ client["timeout"])
2589
3087
logger.debug("Last checker succeeded,"
2590
" keeping {0} enabled"
2591
.format(client_name))
3088
" keeping {} enabled".format(
3089
client_name))
2592
3090
try:
2593
client["secret"] = (
2594
pgp.decrypt(client["encrypted_secret"],
2595
client_settings[client_name]
2596
["secret"]))
3091
client["secret"] = pgp.decrypt(
3092
client["encrypted_secret"],
3093
client_settings[client_name]["secret"])
2597
3094
except PGPError:
2598
3095
# If decryption fails, we use secret from new settings
2599
logger.debug("Failed to decrypt {0} old secret"
2600
.format(client_name))
2601
client["secret"] = (
2602
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"])
2603
3100
2604
3101
# Add/remove clients based on new changes made to config
2605
3102
for client_name in (set(old_client_settings)
2610
3107
clients_data[client_name] = client_settings[client_name]
2611
3108
2612
3109
# Create all client objects
2613
for client_name, client in clients_data.iteritems():
3110
for client_name, client in clients_data.items():
2614
3111
tcp_server.clients[client_name] = client_class(
2615
name = client_name, settings = client)
3112
name = client_name,
3113
settings = client,
3114
server_settings = server_settings)
2616
3115
2617
3116
if not tcp_server.clients:
2618
3117
logger.warning("No clients defined")
2619
3118
2620
3119
if not foreground:
2621
3120
if pidfile is not None:
3121
pid = os.getpid()
2622
3122
try:
2623
3123
with pidfile:
2624
pid = os.getpid()
2625
pidfile.write(str(pid) + "\n".encode("utf-8"))
3124
print(pid, file=pidfile)
2626
3125
except IOError:
2627
3126
logger.error("Could not write to file %r with PID %d",
2628
3127
pidfilename, pid)
2633
3132
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2634
3133
2635
3134
if use_dbus:
2636
@alternate_dbus_interfaces({"se.recompile.Mandos":
2637
"se.bsnet.fukt.Mandos"})
2638
class MandosDBusService(DBusObjectWithProperties):
3135
3136
@alternate_dbus_interfaces(
3137
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3138
class MandosDBusService(DBusObjectWithObjectManager):
2639
3139
"""A D-Bus proxy object"""
3140
2640
3141
def __init__(self):
2641
3142
dbus.service.Object.__init__(self, bus, "/")
3143
2642
3144
_interface = "se.recompile.Mandos"
2643
3145
2644
@dbus_interface_annotations(_interface)
2645
def _foo(self):
2646
return { "org.freedesktop.DBus.Property"
2647
".EmitsChangedSignal":
2648
"false"}
2649
2650
3146
@dbus.service.signal(_interface, signature="o")
2651
3147
def ClientAdded(self, objpath):
2652
3148
"D-Bus signal"
2657
3153
"D-Bus signal"
2658
3154
pass
2659
3155
3156
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3157
"true"})
2660
3158
@dbus.service.signal(_interface, signature="os")
2661
3159
def ClientRemoved(self, objpath, name):
2662
3160
"D-Bus signal"
2663
3161
pass
2664
3162
3163
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3164
"true"})
2665
3165
@dbus.service.method(_interface, out_signature="ao")
2666
3166
def GetAllClients(self):
2667
3167
"D-Bus method"
2668
return dbus.Array(c.dbus_object_path
2669
for c in
3168
return dbus.Array(c.dbus_object_path for c in
2670
3169
tcp_server.clients.itervalues())
2671
3170
3171
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3172
"true"})
2672
3173
@dbus.service.method(_interface,
2673
3174
out_signature="a{oa{sv}}")
2674
3175
def GetAllClientsWithProperties(self):
2675
3176
"D-Bus method"
2676
3177
return dbus.Dictionary(
2677
((c.dbus_object_path, c.GetAll(""))
2678
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() },
2679
3181
signature="oa{sv}")
2680
3182
2681
3183
@dbus.service.method(_interface, in_signature="o")
2685
3187
if c.dbus_object_path == object_path:
2686
3188
del tcp_server.clients[c.name]
2687
3189
c.remove_from_connection()
2688
# Don't signal anything except ClientRemoved
3190
# Don't signal the disabling
2689
3191
c.disable(quiet=True)
2690
# Emit D-Bus signal
2691
self.ClientRemoved(object_path, c.name)
3192
# Emit D-Bus signal for removal
3193
self.client_removed_signal(c)
2692
3194
return
2693
3195
raise KeyError(object_path)
2694
3196
2695
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)
2696
3234
2697
3235
mandos_dbus_service = MandosDBusService()
2698
3236
2699
3237
def cleanup():
2700
3238
"Cleanup function; run on exit"
2701
service.cleanup()
3239
if zeroconf:
3240
service.cleanup()
2702
3241
2703
3242
multiprocessing.active_children()
3243
wnull.close()
2704
3244
if not (tcp_server.clients or client_settings):
2705
3245
return
2706
3246
2717
3257
2718
3258
# A list of attributes that can not be pickled
2719
3259
# + secret.
2720
exclude = set(("bus", "changedstate", "secret",
2721
"checker"))
2722
for name, typ in (inspect.getmembers
2723
(dbus.service.Object)):
3260
exclude = { "bus", "changedstate", "secret",
3261
"checker", "server_settings" }
3262
for name, typ in inspect.getmembers(dbus.service
3263
.Object):
2724
3264
exclude.add(name)
2725
3265
2726
3266
client_dict["encrypted_secret"] = (client
2733
3273
del client_settings[client.name]["secret"]
2734
3274
2735
3275
try:
2736
with (tempfile.NamedTemporaryFile
2737
(mode='wb', suffix=".pickle", prefix='clients-',
2738
dir=os.path.dirname(stored_state_path),
2739
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:
2740
3282
pickle.dump((clients, client_settings), stored_state)
2741
tempname=stored_state.name
3283
tempname = stored_state.name
2742
3284
os.rename(tempname, stored_state_path)
2743
3285
except (IOError, OSError) as e:
2744
3286
if not debug:
2747
3289
except NameError:
2748
3290
pass
2749
3291
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2750
logger.warning("Could not save persistent state: {0}"
3292
logger.warning("Could not save persistent state: {}"
2751
3293
.format(os.strerror(e.errno)))
2752
3294
else:
2753
3295
logger.warning("Could not save persistent state:",
2754
3296
exc_info=e)
2755
raise e
3297
raise
2756
3298
2757
3299
# Delete all clients, and settings from config
2758
3300
while tcp_server.clients:
2759
3301
name, client = tcp_server.clients.popitem()
2760
3302
if use_dbus:
2761
3303
client.remove_from_connection()
2762
# Don't signal anything except ClientRemoved
3304
# Don't signal the disabling
2763
3305
client.disable(quiet=True)
3306
# Emit D-Bus signal for removal
2764
3307
if use_dbus:
2765
# Emit D-Bus signal
2766
mandos_dbus_service.ClientRemoved(client
2767
.dbus_object_path,
2768
client.name)
3308
mandos_dbus_service.client_removed_signal(client)
2769
3309
client_settings.clear()
2770
3310
2771
3311
atexit.register(cleanup)
2772
3312
2773
3313
for client in tcp_server.clients.itervalues():
2774
3314
if use_dbus:
2775
# Emit D-Bus signal
2776
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3315
# Emit D-Bus signal for adding
3316
mandos_dbus_service.client_added_signal(client)
2777
3317
# Need to initiate checking of clients
2778
3318
if client.enabled:
2779
3319
client.init_checker()
2782
3322
tcp_server.server_activate()
2783
3323
2784
3324
# Find out what port we got
2785
service.port = tcp_server.socket.getsockname()[1]
3325
if zeroconf:
3326
service.port = tcp_server.socket.getsockname()[1]
2786
3327
if use_ipv6:
2787
3328
logger.info("Now listening on address %r, port %d,"
2788
3329
" flowinfo %d, scope_id %d",
2794
3335
#service.interface = tcp_server.socket.getsockname()[3]
2795
3336
2796
3337
try:
2797
# From the Avahi example code
2798
try:
2799
service.activate()
2800
except dbus.exceptions.DBusException as error:
2801
logger.critical("D-Bus Exception", exc_info=error)
2802
cleanup()
2803
sys.exit(1)
2804
# 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
2805
3347
2806
3348
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2807
3349
lambda *args, **kwargs:
2822
3364
# Must run before the D-Bus bus name gets deregistered
2823
3365
cleanup()
2824
3366
3367
2825
3368
if __name__ == '__main__':
2826
3369
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0