To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 237.7.261
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.261
- Committer: Teddy Hogeborn
- Date: 2014-07-14 21:41:08 UTC
- mto: (237.7.272 trunk)
- mto: This revision was merged to the branch mainline in revision 319.
- Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.
* mandos-monitor (MandosClientWidget.__init__): Log client creation.
(MandosClientWidget.checker_completed): Log a successful checker.
(MandosClientWidget.checker_started): Log starting of a checker.
(UserInterface.__init__): New optional "log_level" argument.
(UserInterface.log_message, UserInterface.log_message_raw): Take
optional
"level"
arg.
(UserInterface.toggle_log_display): Log visibility change.
(UserInterface.change_log_display): Log wrap mode change.
(UserInterface.process_input): Show new "v" key in help message and
process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.
* mandos-monitor (MandosClientWidget.__init__): Log client creation.
(MandosClientWidget.checker_completed): Log a successful checker.
(MandosClientWidget.checker_started): Log starting of a checker.
(UserInterface.__init__): New optional "log_level" argument.
(UserInterface.log_message, UserInterface.log_message_raw): Take
optional
"level"
arg.
(UserInterface.toggle_log_display): Log visibility change.
(UserInterface.change_log_display): Log wrap mode change.
(UserInterface.process_input): Show new "v" key in help message and
process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.
- files added:
- debian/mandos-client.examples
- debian/source
- debian/upstream
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2010 Teddy Hogeborn
15
# Copyright © 2008-2010 Björn Påhlsson
14
# Copyright © 2008-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 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
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
#
31
# Contact the authors at <mandos@fukt.bsnet.se>.
31
# Contact the authors at <mandos@recompile.se>.
32
32
#
33
33
34
from __future__ import division, with_statement, absolute_import
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
36
37
from future_builtins import *
35
38
36
39
import SocketServer as socketserver
37
40
import socket
38
import optparse
41
import argparse
39
42
import datetime
40
43
import errno
41
44
import gnutls.crypto
61
64
import functools
62
65
import cPickle as pickle
63
66
import multiprocessing
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
import collections
64
72
65
73
import dbus
66
74
import dbus.service
80
88
except ImportError:
81
89
SO_BINDTODEVICE = None
82
90
83
84
version = "1.2"
85
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
88
syslogger = (logging.handlers.SysLogHandler
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
93
u' %(message)s'))
94
logger.addHandler(syslogger)
95
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
u' %(levelname)s:'
99
u' %(message)s'))
100
logger.addHandler(console)
91
version = "1.6.6"
92
stored_state_file = "clients.pickle"
93
94
logger = logging.getLogger()
95
syslogger = None
96
97
try:
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
100
.if_nametoindex)
101
except (OSError, AttributeError):
102
def if_nametoindex(interface):
103
"Get an interface index the hard way, i.e. using fcntl()"
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
with contextlib.closing(socket.socket()) as s:
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
108
interface))
109
interface_index = struct.unpack(str("I"),
110
ifreq[16:20])[0]
111
return interface_index
112
113
114
def initlogger(debug, level=logging.WARNING):
115
"""init logger and add loglevel"""
116
117
global syslogger
118
syslogger = (logging.handlers.SysLogHandler
119
(facility =
120
logging.handlers.SysLogHandler.LOG_DAEMON,
121
address = str("/dev/log")))
122
syslogger.setFormatter(logging.Formatter
123
('Mandos [%(process)d]: %(levelname)s:'
124
' %(message)s'))
125
logger.addHandler(syslogger)
126
127
if debug:
128
console = logging.StreamHandler()
129
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
130
' [%(process)d]:'
131
' %(levelname)s:'
132
' %(message)s'))
133
logger.addHandler(console)
134
logger.setLevel(level)
135
136
137
class PGPError(Exception):
138
"""Exception if encryption/decryption fails"""
139
pass
140
141
142
class PGPEngine(object):
143
"""A simple class for OpenPGP symmetric encryption & decryption"""
144
def __init__(self):
145
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
146
self.gnupgargs = ['--batch',
147
'--home', self.tempdir,
148
'--force-mdc',
149
'--quiet',
150
'--no-use-agent']
151
152
def __enter__(self):
153
return self
154
155
def __exit__(self, exc_type, exc_value, traceback):
156
self._cleanup()
157
return False
158
159
def __del__(self):
160
self._cleanup()
161
162
def _cleanup(self):
163
if self.tempdir is not None:
164
# Delete contents of tempdir
165
for root, dirs, files in os.walk(self.tempdir,
166
topdown = False):
167
for filename in files:
168
os.remove(os.path.join(root, filename))
169
for dirname in dirs:
170
os.rmdir(os.path.join(root, dirname))
171
# Remove tempdir
172
os.rmdir(self.tempdir)
173
self.tempdir = None
174
175
def password_encode(self, password):
176
# Passphrase can not be empty and can not contain newlines or
177
# NUL bytes. So we prefix it and hex encode it.
178
encoded = b"mandos" + binascii.hexlify(password)
179
if len(encoded) > 2048:
180
# GnuPG can't handle long passwords, so encode differently
181
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
182
.replace(b"\n", b"\\n")
183
.replace(b"\0", b"\\x00"))
184
return encoded
185
186
def encrypt(self, data, password):
187
passphrase = self.password_encode(password)
188
with tempfile.NamedTemporaryFile(dir=self.tempdir
189
) as passfile:
190
passfile.write(passphrase)
191
passfile.flush()
192
proc = subprocess.Popen(['gpg', '--symmetric',
193
'--passphrase-file',
194
passfile.name]
195
+ self.gnupgargs,
196
stdin = subprocess.PIPE,
197
stdout = subprocess.PIPE,
198
stderr = subprocess.PIPE)
199
ciphertext, err = proc.communicate(input = data)
200
if proc.returncode != 0:
201
raise PGPError(err)
202
return ciphertext
203
204
def decrypt(self, data, password):
205
passphrase = self.password_encode(password)
206
with tempfile.NamedTemporaryFile(dir = self.tempdir
207
) as passfile:
208
passfile.write(passphrase)
209
passfile.flush()
210
proc = subprocess.Popen(['gpg', '--decrypt',
211
'--passphrase-file',
212
passfile.name]
213
+ self.gnupgargs,
214
stdin = subprocess.PIPE,
215
stdout = subprocess.PIPE,
216
stderr = subprocess.PIPE)
217
decrypted_plaintext, err = proc.communicate(input
218
= data)
219
if proc.returncode != 0:
220
raise PGPError(err)
221
return decrypted_plaintext
222
101
223
102
224
class AvahiError(Exception):
103
225
def __init__(self, value, *args, **kwargs):
119
241
Attributes:
120
242
interface: integer; avahi.IF_UNSPEC or an interface index.
121
243
Used to optionally bind to the specified interface.
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
244
name: string; Example: 'Mandos'
245
type: string; Example: '_mandos._tcp'.
246
See <https://www.iana.org/assignments/service-names-port-numbers>
125
247
port: integer; what port to announce
126
248
TXT: list of strings; TXT record for the service
127
249
domain: string; Domain to publish on, default to .local if empty.
133
255
server: D-Bus Server
134
256
bus: dbus.SystemBus()
135
257
"""
258
136
259
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
137
260
servicetype = None, port = None, TXT = None,
138
domain = u"", host = u"", max_renames = 32768,
261
domain = "", host = "", max_renames = 32768,
139
262
protocol = avahi.PROTO_UNSPEC, bus = None):
140
263
self.interface = interface
141
264
self.name = name
150
273
self.group = None # our entry group
151
274
self.server = None
152
275
self.bus = bus
276
self.entry_group_state_changed_match = None
277
153
278
def rename(self):
154
279
"""Derived from the Avahi example code"""
155
280
if self.rename_count >= self.max_renames:
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
281
logger.critical("No suitable Zeroconf service name found"
282
" after %i retries, exiting.",
158
283
self.rename_count)
159
raise AvahiServiceError(u"Too many renames")
160
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
161
logger.info(u"Changing Zeroconf service name to %r ...",
284
raise AvahiServiceError("Too many renames")
285
self.name = unicode(self.server
286
.GetAlternativeServiceName(self.name))
287
logger.info("Changing Zeroconf service name to %r ...",
162
288
self.name)
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
166
% self.name))
167
289
self.remove()
168
290
try:
169
291
self.add()
170
except dbus.exceptions.DBusException, error:
171
logger.critical(u"DBusException: %s", error)
292
except dbus.exceptions.DBusException as error:
293
logger.critical("D-Bus Exception", exc_info=error)
172
294
self.cleanup()
173
295
os._exit(1)
174
296
self.rename_count += 1
297
175
298
def remove(self):
176
299
"""Derived from the Avahi example code"""
300
if self.entry_group_state_changed_match is not None:
301
self.entry_group_state_changed_match.remove()
302
self.entry_group_state_changed_match = None
177
303
if self.group is not None:
178
304
self.group.Reset()
305
179
306
def add(self):
180
307
"""Derived from the Avahi example code"""
308
self.remove()
181
309
if self.group is None:
182
310
self.group = dbus.Interface(
183
311
self.bus.get_object(avahi.DBUS_NAME,
184
312
self.server.EntryGroupNew()),
185
313
avahi.DBUS_INTERFACE_ENTRY_GROUP)
186
self.group.connect_to_signal('StateChanged',
187
self
188
.entry_group_state_changed)
189
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
314
self.entry_group_state_changed_match = (
315
self.group.connect_to_signal(
316
'StateChanged', self.entry_group_state_changed))
317
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
190
318
self.name, self.type)
191
319
self.group.AddService(
192
320
self.interface,
197
325
dbus.UInt16(self.port),
198
326
avahi.string_array_to_txt_array(self.TXT))
199
327
self.group.Commit()
328
200
329
def entry_group_state_changed(self, state, error):
201
330
"""Derived from the Avahi example code"""
202
logger.debug(u"Avahi entry group state change: %i", state)
331
logger.debug("Avahi entry group state change: %i", state)
203
332
204
333
if state == avahi.ENTRY_GROUP_ESTABLISHED:
205
logger.debug(u"Zeroconf service established.")
334
logger.debug("Zeroconf service established.")
206
335
elif state == avahi.ENTRY_GROUP_COLLISION:
207
logger.warning(u"Zeroconf service name collision.")
336
logger.info("Zeroconf service name collision.")
208
337
self.rename()
209
338
elif state == avahi.ENTRY_GROUP_FAILURE:
210
logger.critical(u"Avahi: Error in group state changed %s",
339
logger.critical("Avahi: Error in group state changed %s",
211
340
unicode(error))
212
raise AvahiGroupError(u"State changed: %s"
213
% unicode(error))
341
raise AvahiGroupError("State changed: {0!s}"
342
.format(error))
343
214
344
def cleanup(self):
215
345
"""Derived from the Avahi example code"""
216
346
if self.group is not None:
217
self.group.Free()
347
try:
348
self.group.Free()
349
except (dbus.exceptions.UnknownMethodException,
350
dbus.exceptions.DBusException):
351
pass
218
352
self.group = None
219
def server_state_changed(self, state):
353
self.remove()
354
355
def server_state_changed(self, state, error=None):
220
356
"""Derived from the Avahi example code"""
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
224
self.remove()
357
logger.debug("Avahi server state change: %i", state)
358
bad_states = { avahi.SERVER_INVALID:
359
"Zeroconf server invalid",
360
avahi.SERVER_REGISTERING: None,
361
avahi.SERVER_COLLISION:
362
"Zeroconf server name collision",
363
avahi.SERVER_FAILURE:
364
"Zeroconf server failure" }
365
if state in bad_states:
366
if bad_states[state] is not None:
367
if error is None:
368
logger.error(bad_states[state])
369
else:
370
logger.error(bad_states[state] + ": %r", error)
371
self.cleanup()
225
372
elif state == avahi.SERVER_RUNNING:
226
373
self.add()
374
else:
375
if error is None:
376
logger.debug("Unknown state: %r", state)
377
else:
378
logger.debug("Unknown state: %r: %r", state, error)
379
227
380
def activate(self):
228
381
"""Derived from the Avahi example code"""
229
382
if self.server is None:
230
383
self.server = dbus.Interface(
231
384
self.bus.get_object(avahi.DBUS_NAME,
232
avahi.DBUS_PATH_SERVER),
385
avahi.DBUS_PATH_SERVER,
386
follow_name_owner_changes=True),
233
387
avahi.DBUS_INTERFACE_SERVER)
234
self.server.connect_to_signal(u"StateChanged",
388
self.server.connect_to_signal("StateChanged",
235
389
self.server_state_changed)
236
390
self.server_state_changed(self.server.GetState())
237
391
238
392
393
class AvahiServiceToSyslog(AvahiService):
394
def rename(self):
395
"""Add the new name to the syslog messages"""
396
ret = AvahiService.rename(self)
397
syslogger.setFormatter(logging.Formatter
398
('Mandos ({0}) [%(process)d]:'
399
' %(levelname)s: %(message)s'
400
.format(self.name)))
401
return ret
402
403
404
def timedelta_to_milliseconds(td):
405
"Convert a datetime.timedelta() to milliseconds"
406
return ((td.days * 24 * 60 * 60 * 1000)
407
+ (td.seconds * 1000)
408
+ (td.microseconds // 1000))
409
410
239
411
class Client(object):
240
412
"""A representation of a client host served by this server.
241
413
242
414
Attributes:
243
_approved: bool(); 'None' if not yet approved/disapproved
415
approved: bool(); 'None' if not yet approved/disapproved
244
416
approval_delay: datetime.timedelta(); Time to wait for approval
245
417
approval_duration: datetime.timedelta(); Duration of one approval
246
418
checker: subprocess.Popen(); a running checker process used
253
425
instance %(name)s can be used in the command.
254
426
checker_initiator_tag: a gobject event source tag, or None
255
427
created: datetime.datetime(); (UTC) object creation
428
client_structure: Object describing what attributes a client has
429
and is used for storing the client at exit
256
430
current_checker_command: string; current running checker_command
257
disable_hook: If set, called by disable() as disable_hook(self)
258
431
disable_initiator_tag: a gobject event source tag, or None
259
432
enabled: bool()
260
433
fingerprint: string (40 or 32 hexadecimal digits); used to
263
436
interval: datetime.timedelta(); How often to start a new checker
264
437
last_approval_request: datetime.datetime(); (UTC) or None
265
438
last_checked_ok: datetime.datetime(); (UTC) or None
266
last_enabled: datetime.datetime(); (UTC)
439
last_checker_status: integer between 0 and 255 reflecting exit
440
status of last checker. -1 reflects crashed
441
checker, -2 means no checker completed yet.
442
last_enabled: datetime.datetime(); (UTC) or None
267
443
name: string; from the config file, used in log messages and
268
444
D-Bus identifiers
269
445
secret: bytestring; sent verbatim (over TLS) to client
270
446
timeout: datetime.timedelta(); How long from last_checked_ok
271
447
until this client is disabled
448
extended_timeout: extra long timeout when secret has been sent
272
449
runtime_expansions: Allowed attributes for runtime expansion.
450
expires: datetime.datetime(); time (UTC) when a client will be
451
disabled, or None
452
server_settings: The server_settings dict from main()
273
453
"""
274
454
275
runtime_expansions = (u"approval_delay", u"approval_duration",
276
u"created", u"enabled", u"fingerprint",
277
u"host", u"interval", u"last_checked_ok",
278
u"last_enabled", u"name", u"timeout")
279
280
@staticmethod
281
def _timedelta_to_milliseconds(td):
282
"Convert a datetime.timedelta() to milliseconds"
283
return ((td.days * 24 * 60 * 60 * 1000)
284
+ (td.seconds * 1000)
285
+ (td.microseconds // 1000))
455
runtime_expansions = ("approval_delay", "approval_duration",
456
"created", "enabled", "expires",
457
"fingerprint", "host", "interval",
458
"last_approval_request", "last_checked_ok",
459
"last_enabled", "name", "timeout")
460
client_defaults = { "timeout": "PT5M",
461
"extended_timeout": "PT15M",
462
"interval": "PT2M",
463
"checker": "fping -q -- %%(host)s",
464
"host": "",
465
"approval_delay": "PT0S",
466
"approval_duration": "PT1S",
467
"approved_by_default": "True",
468
"enabled": "True",
469
}
286
470
287
471
def timeout_milliseconds(self):
288
472
"Return the 'timeout' attribute in milliseconds"
289
return self._timedelta_to_milliseconds(self.timeout)
473
return timedelta_to_milliseconds(self.timeout)
474
475
def extended_timeout_milliseconds(self):
476
"Return the 'extended_timeout' attribute in milliseconds"
477
return timedelta_to_milliseconds(self.extended_timeout)
290
478
291
479
def interval_milliseconds(self):
292
480
"Return the 'interval' attribute in milliseconds"
293
return self._timedelta_to_milliseconds(self.interval)
294
481
return timedelta_to_milliseconds(self.interval)
482
295
483
def approval_delay_milliseconds(self):
296
return self._timedelta_to_milliseconds(self.approval_delay)
297
298
def __init__(self, name = None, disable_hook=None, config=None):
299
"""Note: the 'checker' key in 'config' sets the
300
'checker_command' attribute and *not* the 'checker'
301
attribute."""
484
return timedelta_to_milliseconds(self.approval_delay)
485
486
@staticmethod
487
def config_parser(config):
488
"""Construct a new dict of client settings of this form:
489
{ client_name: {setting_name: value, ...}, ...}
490
with exceptions for any special settings as defined above.
491
NOTE: Must be a pure function. Must return the same result
492
value given the same arguments.
493
"""
494
settings = {}
495
for client_name in config.sections():
496
section = dict(config.items(client_name))
497
client = settings[client_name] = {}
498
499
client["host"] = section["host"]
500
# Reformat values from string types to Python types
501
client["approved_by_default"] = config.getboolean(
502
client_name, "approved_by_default")
503
client["enabled"] = config.getboolean(client_name,
504
"enabled")
505
506
client["fingerprint"] = (section["fingerprint"].upper()
507
.replace(" ", ""))
508
if "secret" in section:
509
client["secret"] = section["secret"].decode("base64")
510
elif "secfile" in section:
511
with open(os.path.expanduser(os.path.expandvars
512
(section["secfile"])),
513
"rb") as secfile:
514
client["secret"] = secfile.read()
515
else:
516
raise TypeError("No secret or secfile for section {0}"
517
.format(section))
518
client["timeout"] = string_to_delta(section["timeout"])
519
client["extended_timeout"] = string_to_delta(
520
section["extended_timeout"])
521
client["interval"] = string_to_delta(section["interval"])
522
client["approval_delay"] = string_to_delta(
523
section["approval_delay"])
524
client["approval_duration"] = string_to_delta(
525
section["approval_duration"])
526
client["checker_command"] = section["checker"]
527
client["last_approval_request"] = None
528
client["last_checked_ok"] = None
529
client["last_checker_status"] = -2
530
531
return settings
532
533
def __init__(self, settings, name = None, server_settings=None):
302
534
self.name = name
303
if config is None:
304
config = {}
305
logger.debug(u"Creating client %r", self.name)
535
if server_settings is None:
536
server_settings = {}
537
self.server_settings = server_settings
538
# adding all client settings
539
for setting, value in settings.iteritems():
540
setattr(self, setting, value)
541
542
if self.enabled:
543
if not hasattr(self, "last_enabled"):
544
self.last_enabled = datetime.datetime.utcnow()
545
if not hasattr(self, "expires"):
546
self.expires = (datetime.datetime.utcnow()
547
+ self.timeout)
548
else:
549
self.last_enabled = None
550
self.expires = None
551
552
logger.debug("Creating client %r", self.name)
306
553
# Uppercase and remove spaces from fingerprint for later
307
554
# comparison purposes with return value from the fingerprint()
308
555
# function
309
self.fingerprint = (config[u"fingerprint"].upper()
310
.replace(u" ", u""))
311
logger.debug(u" Fingerprint: %s", self.fingerprint)
312
if u"secret" in config:
313
self.secret = config[u"secret"].decode(u"base64")
314
elif u"secfile" in config:
315
with open(os.path.expanduser(os.path.expandvars
316
(config[u"secfile"])),
317
"rb") as secfile:
318
self.secret = secfile.read()
319
else:
320
raise TypeError(u"No secret or secfile for client %s"
321
% self.name)
322
self.host = config.get(u"host", u"")
323
self.created = datetime.datetime.utcnow()
324
self.enabled = False
325
self.last_approval_request = None
326
self.last_enabled = None
327
self.last_checked_ok = None
328
self.timeout = string_to_delta(config[u"timeout"])
329
self.interval = string_to_delta(config[u"interval"])
330
self.disable_hook = disable_hook
556
logger.debug(" Fingerprint: %s", self.fingerprint)
557
self.created = settings.get("created",
558
datetime.datetime.utcnow())
559
560
# attributes specific for this server instance
331
561
self.checker = None
332
562
self.checker_initiator_tag = None
333
563
self.disable_initiator_tag = None
334
564
self.checker_callback_tag = None
335
self.checker_command = config[u"checker"]
336
565
self.current_checker_command = None
337
self.last_connect = None
338
self._approved = None
339
self.approved_by_default = config.get(u"approved_by_default",
340
True)
566
self.approved = None
341
567
self.approvals_pending = 0
342
self.approval_delay = string_to_delta(
343
config[u"approval_delay"])
344
self.approval_duration = string_to_delta(
345
config[u"approval_duration"])
346
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
568
self.changedstate = (multiprocessing_manager
569
.Condition(multiprocessing_manager
570
.Lock()))
571
self.client_structure = [attr for attr in
572
self.__dict__.iterkeys()
573
if not attr.startswith("_")]
574
self.client_structure.append("client_structure")
575
576
for name, t in inspect.getmembers(type(self),
577
lambda obj:
578
isinstance(obj,
579
property)):
580
if not name.startswith("_"):
581
self.client_structure.append(name)
347
582
583
# Send notice to process children that client state has changed
348
584
def send_changedstate(self):
349
self.changedstate.acquire()
350
self.changedstate.notify_all()
351
self.changedstate.release()
352
585
with self.changedstate:
586
self.changedstate.notify_all()
587
353
588
def enable(self):
354
589
"""Start this client's checker and timeout hooks"""
355
if getattr(self, u"enabled", False):
590
if getattr(self, "enabled", False):
356
591
# Already enabled
357
592
return
358
self.send_changedstate()
593
self.expires = datetime.datetime.utcnow() + self.timeout
594
self.enabled = True
359
595
self.last_enabled = datetime.datetime.utcnow()
596
self.init_checker()
597
self.send_changedstate()
598
599
def disable(self, quiet=True):
600
"""Disable this client."""
601
if not getattr(self, "enabled", False):
602
return False
603
if not quiet:
604
logger.info("Disabling client %s", self.name)
605
if getattr(self, "disable_initiator_tag", None) is not None:
606
gobject.source_remove(self.disable_initiator_tag)
607
self.disable_initiator_tag = None
608
self.expires = None
609
if getattr(self, "checker_initiator_tag", None) is not None:
610
gobject.source_remove(self.checker_initiator_tag)
611
self.checker_initiator_tag = None
612
self.stop_checker()
613
self.enabled = False
614
if not quiet:
615
self.send_changedstate()
616
# Do not run this again if called by a gobject.timeout_add
617
return False
618
619
def __del__(self):
620
self.disable()
621
622
def init_checker(self):
360
623
# Schedule a new checker to be started an 'interval' from now,
361
624
# and every interval from then on.
625
if self.checker_initiator_tag is not None:
626
gobject.source_remove(self.checker_initiator_tag)
362
627
self.checker_initiator_tag = (gobject.timeout_add
363
628
(self.interval_milliseconds(),
364
629
self.start_checker))
365
630
# Schedule a disable() when 'timeout' has passed
631
if self.disable_initiator_tag is not None:
632
gobject.source_remove(self.disable_initiator_tag)
366
633
self.disable_initiator_tag = (gobject.timeout_add
367
634
(self.timeout_milliseconds(),
368
635
self.disable))
369
self.enabled = True
370
636
# Also start a new checker *right now*.
371
637
self.start_checker()
372
638
373
def disable(self, quiet=True):
374
"""Disable this client."""
375
if not getattr(self, "enabled", False):
376
return False
377
if not quiet:
378
self.send_changedstate()
379
if not quiet:
380
logger.info(u"Disabling client %s", self.name)
381
if getattr(self, u"disable_initiator_tag", False):
382
gobject.source_remove(self.disable_initiator_tag)
383
self.disable_initiator_tag = None
384
if getattr(self, u"checker_initiator_tag", False):
385
gobject.source_remove(self.checker_initiator_tag)
386
self.checker_initiator_tag = None
387
self.stop_checker()
388
if self.disable_hook:
389
self.disable_hook(self)
390
self.enabled = False
391
# Do not run this again if called by a gobject.timeout_add
392
return False
393
394
def __del__(self):
395
self.disable_hook = None
396
self.disable()
397
398
639
def checker_callback(self, pid, condition, command):
399
640
"""The checker has completed, so take appropriate actions."""
400
641
self.checker_callback_tag = None
401
642
self.checker = None
402
643
if os.WIFEXITED(condition):
403
exitstatus = os.WEXITSTATUS(condition)
404
if exitstatus == 0:
405
logger.info(u"Checker for %(name)s succeeded",
644
self.last_checker_status = os.WEXITSTATUS(condition)
645
if self.last_checker_status == 0:
646
logger.info("Checker for %(name)s succeeded",
406
647
vars(self))
407
648
self.checked_ok()
408
649
else:
409
logger.info(u"Checker for %(name)s failed",
650
logger.info("Checker for %(name)s failed",
410
651
vars(self))
411
652
else:
412
logger.warning(u"Checker for %(name)s crashed?",
653
self.last_checker_status = -1
654
logger.warning("Checker for %(name)s crashed?",
413
655
vars(self))
414
656
415
657
def checked_ok(self):
416
"""Bump up the timeout for this client.
417
418
This should only be called when the client has been seen,
419
alive and well.
420
"""
658
"""Assert that the client has been seen, alive and well."""
421
659
self.last_checked_ok = datetime.datetime.utcnow()
422
gobject.source_remove(self.disable_initiator_tag)
423
self.disable_initiator_tag = (gobject.timeout_add
424
(self.timeout_milliseconds(),
425
self.disable))
660
self.last_checker_status = 0
661
self.bump_timeout()
662
663
def bump_timeout(self, timeout=None):
664
"""Bump up the timeout for this client."""
665
if timeout is None:
666
timeout = self.timeout
667
if self.disable_initiator_tag is not None:
668
gobject.source_remove(self.disable_initiator_tag)
669
self.disable_initiator_tag = None
670
if getattr(self, "enabled", False):
671
self.disable_initiator_tag = (gobject.timeout_add
672
(timedelta_to_milliseconds
673
(timeout), self.disable))
674
self.expires = datetime.datetime.utcnow() + timeout
426
675
427
676
def need_approval(self):
428
677
self.last_approval_request = datetime.datetime.utcnow()
433
682
If a checker already exists, leave it running and do
434
683
nothing."""
435
684
# The reason for not killing a running checker is that if we
436
# did that, then if a checker (for some reason) started
437
# running slowly and taking more than 'interval' time, the
438
# client would inevitably timeout, since no checker would get
439
# a chance to run to completion. If we instead leave running
685
# did that, and if a checker (for some reason) started running
686
# slowly and taking more than 'interval' time, then the client
687
# would inevitably timeout, since no checker would get a
688
# chance to run to completion. If we instead leave running
440
689
# checkers alone, the checker would have to take more time
441
690
# than 'timeout' for the client to be disabled, which is as it
442
691
# should be.
444
693
# If a checker exists, make sure it is not a zombie
445
694
try:
446
695
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
447
except (AttributeError, OSError), error:
448
if (isinstance(error, OSError)
449
and error.errno != errno.ECHILD):
450
raise error
696
except AttributeError:
697
pass
698
except OSError as error:
699
if error.errno != errno.ECHILD:
700
raise
451
701
else:
452
702
if pid:
453
logger.warning(u"Checker was a zombie")
703
logger.warning("Checker was a zombie")
454
704
gobject.source_remove(self.checker_callback_tag)
455
705
self.checker_callback(pid, status,
456
706
self.current_checker_command)
457
707
# Start a new checker if needed
458
708
if self.checker is None:
709
# Escape attributes for the shell
710
escaped_attrs = dict(
711
(attr, re.escape(unicode(getattr(self, attr))))
712
for attr in
713
self.runtime_expansions)
459
714
try:
460
# In case checker_command has exactly one % operator
461
command = self.checker_command % self.host
462
except TypeError:
463
# Escape attributes for the shell
464
escaped_attrs = dict(
465
(attr,
466
re.escape(unicode(str(getattr(self, attr, u"")),
467
errors=
468
u'replace')))
469
for attr in
470
self.runtime_expansions)
471
472
try:
473
command = self.checker_command % escaped_attrs
474
except TypeError, error:
475
logger.error(u'Could not format string "%s":'
476
u' %s', self.checker_command, error)
477
return True # Try again later
715
command = self.checker_command % escaped_attrs
716
except TypeError as error:
717
logger.error('Could not format string "%s"',
718
self.checker_command, exc_info=error)
719
return True # Try again later
478
720
self.current_checker_command = command
479
721
try:
480
logger.info(u"Starting checker %r for %s",
722
logger.info("Starting checker %r for %s",
481
723
command, self.name)
482
724
# We don't need to redirect stdout and stderr, since
483
725
# in normal mode, that is already done by daemon(),
484
726
# and in debug mode we don't want to. (Stdin is
485
727
# always replaced by /dev/null.)
728
# The exception is when not debugging but nevertheless
729
# running in the foreground; use the previously
730
# created wnull.
731
popen_args = {}
732
if (not self.server_settings["debug"]
733
and self.server_settings["foreground"]):
734
popen_args.update({"stdout": wnull,
735
"stderr": wnull })
486
736
self.checker = subprocess.Popen(command,
487
737
close_fds=True,
488
shell=True, cwd=u"/")
489
self.checker_callback_tag = (gobject.child_watch_add
490
(self.checker.pid,
491
self.checker_callback,
492
data=command))
493
# The checker may have completed before the gobject
494
# watch was added. Check for this.
738
shell=True, cwd="/",
739
**popen_args)
740
except OSError as error:
741
logger.error("Failed to start subprocess",
742
exc_info=error)
743
return True
744
self.checker_callback_tag = (gobject.child_watch_add
745
(self.checker.pid,
746
self.checker_callback,
747
data=command))
748
# The checker may have completed before the gobject
749
# watch was added. Check for this.
750
try:
495
751
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
496
if pid:
497
gobject.source_remove(self.checker_callback_tag)
498
self.checker_callback(pid, status, command)
499
except OSError, error:
500
logger.error(u"Failed to start subprocess: %s",
501
error)
752
except OSError as error:
753
if error.errno == errno.ECHILD:
754
# This should never happen
755
logger.error("Child process vanished",
756
exc_info=error)
757
return True
758
raise
759
if pid:
760
gobject.source_remove(self.checker_callback_tag)
761
self.checker_callback(pid, status, command)
502
762
# Re-run this periodically if run by gobject.timeout_add
503
763
return True
504
764
507
767
if self.checker_callback_tag:
508
768
gobject.source_remove(self.checker_callback_tag)
509
769
self.checker_callback_tag = None
510
if getattr(self, u"checker", None) is None:
770
if getattr(self, "checker", None) is None:
511
771
return
512
logger.debug(u"Stopping checker for %(name)s", vars(self))
772
logger.debug("Stopping checker for %(name)s", vars(self))
513
773
try:
514
os.kill(self.checker.pid, signal.SIGTERM)
774
self.checker.terminate()
515
775
#time.sleep(0.5)
516
776
#if self.checker.poll() is None:
517
# os.kill(self.checker.pid, signal.SIGKILL)
518
except OSError, error:
777
# self.checker.kill()
778
except OSError as error:
519
779
if error.errno != errno.ESRCH: # No such process
520
780
raise
521
781
self.checker = None
522
782
523
def dbus_service_property(dbus_interface, signature=u"v",
524
access=u"readwrite", byte_arrays=False):
783
784
def dbus_service_property(dbus_interface, signature="v",
785
access="readwrite", byte_arrays=False):
525
786
"""Decorators for marking methods of a DBusObjectWithProperties to
526
787
become properties on the D-Bus.
527
788
534
795
"""
535
796
# Encoding deeply encoded byte arrays is not supported yet by the
536
797
# "Set" method, so we fail early here:
537
if byte_arrays and signature != u"ay":
538
raise ValueError(u"Byte arrays not supported for non-'ay'"
539
u" signature %r" % signature)
798
if byte_arrays and signature != "ay":
799
raise ValueError("Byte arrays not supported for non-'ay'"
800
" signature {0!r}".format(signature))
540
801
def decorator(func):
541
802
func._dbus_is_property = True
542
803
func._dbus_interface = dbus_interface
543
804
func._dbus_signature = signature
544
805
func._dbus_access = access
545
806
func._dbus_name = func.__name__
546
if func._dbus_name.endswith(u"_dbus_property"):
807
if func._dbus_name.endswith("_dbus_property"):
547
808
func._dbus_name = func._dbus_name[:-14]
548
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
809
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
810
return func
811
return decorator
812
813
814
def dbus_interface_annotations(dbus_interface):
815
"""Decorator for marking functions returning interface annotations
816
817
Usage:
818
819
@dbus_interface_annotations("org.example.Interface")
820
def _foo(self): # Function name does not matter
821
return {"org.freedesktop.DBus.Deprecated": "true",
822
"org.freedesktop.DBus.Property.EmitsChangedSignal":
823
"false"}
824
"""
825
def decorator(func):
826
func._dbus_is_interface = True
827
func._dbus_interface = dbus_interface
828
func._dbus_name = dbus_interface
829
return func
830
return decorator
831
832
833
def dbus_annotations(annotations):
834
"""Decorator to annotate D-Bus methods, signals or properties
835
Usage:
836
837
@dbus_service_property("org.example.Interface", signature="b",
838
access="r")
839
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
840
"org.freedesktop.DBus.Property."
841
"EmitsChangedSignal": "false"})
842
def Property_dbus_property(self):
843
return dbus.Boolean(False)
844
"""
845
def decorator(func):
846
func._dbus_annotations = annotations
549
847
return func
550
848
return decorator
551
849
571
869
572
870
class DBusObjectWithProperties(dbus.service.Object):
573
871
"""A D-Bus object with properties.
574
872
575
873
Classes inheriting from this can use the dbus_service_property
576
874
decorator to expose methods as D-Bus properties. It exposes the
577
875
standard Get(), Set(), and GetAll() methods on the D-Bus.
578
876
"""
579
877
580
878
@staticmethod
581
def _is_dbus_property(obj):
582
return getattr(obj, u"_dbus_is_property", False)
879
def _is_dbus_thing(thing):
880
"""Returns a function testing if an attribute is a D-Bus thing
881
882
If called like _is_dbus_thing("method") it returns a function
883
suitable for use as predicate to inspect.getmembers().
884
"""
885
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
886
False)
583
887
584
def _get_all_dbus_properties(self):
888
def _get_all_dbus_things(self, thing):
585
889
"""Returns a generator of (name, attribute) pairs
586
890
"""
587
return ((prop._dbus_name, prop)
588
for name, prop in
589
inspect.getmembers(self, self._is_dbus_property))
891
return ((getattr(athing.__get__(self), "_dbus_name",
892
name),
893
athing.__get__(self))
894
for cls in self.__class__.__mro__
895
for name, athing in
896
inspect.getmembers(cls,
897
self._is_dbus_thing(thing)))
590
898
591
899
def _get_dbus_property(self, interface_name, property_name):
592
900
"""Returns a bound method if one exists which is a D-Bus
593
901
property with the specified name and interface.
594
902
"""
595
for name in (property_name,
596
property_name + u"_dbus_property"):
597
prop = getattr(self, name, None)
598
if (prop is None
599
or not self._is_dbus_property(prop)
600
or prop._dbus_name != property_name
601
or (interface_name and prop._dbus_interface
602
and interface_name != prop._dbus_interface)):
603
continue
604
return prop
903
for cls in self.__class__.__mro__:
904
for name, value in (inspect.getmembers
905
(cls,
906
self._is_dbus_thing("property"))):
907
if (value._dbus_name == property_name
908
and value._dbus_interface == interface_name):
909
return value.__get__(self)
910
605
911
# No such property
606
raise DBusPropertyNotFound(self.dbus_object_path + u":"
607
+ interface_name + u"."
912
raise DBusPropertyNotFound(self.dbus_object_path + ":"
913
+ interface_name + "."
608
914
+ property_name)
609
915
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
611
out_signature=u"v")
916
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
917
out_signature="v")
612
918
def Get(self, interface_name, property_name):
613
919
"""Standard D-Bus property Get() method, see D-Bus standard.
614
920
"""
615
921
prop = self._get_dbus_property(interface_name, property_name)
616
if prop._dbus_access == u"write":
922
if prop._dbus_access == "write":
617
923
raise DBusPropertyAccessException(property_name)
618
924
value = prop()
619
if not hasattr(value, u"variant_level"):
925
if not hasattr(value, "variant_level"):
620
926
return value
621
927
return type(value)(value, variant_level=value.variant_level+1)
622
928
623
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
929
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
624
930
def Set(self, interface_name, property_name, value):
625
931
"""Standard D-Bus property Set() method, see D-Bus standard.
626
932
"""
627
933
prop = self._get_dbus_property(interface_name, property_name)
628
if prop._dbus_access == u"read":
934
if prop._dbus_access == "read":
629
935
raise DBusPropertyAccessException(property_name)
630
if prop._dbus_get_args_options[u"byte_arrays"]:
936
if prop._dbus_get_args_options["byte_arrays"]:
631
937
# The byte_arrays option is not supported yet on
632
938
# signatures other than "ay".
633
if prop._dbus_signature != u"ay":
634
raise ValueError
635
value = dbus.ByteArray(''.join(unichr(byte)
636
for byte in value))
939
if prop._dbus_signature != "ay":
940
raise ValueError("Byte arrays not supported for non-"
941
"'ay' signature {0!r}"
942
.format(prop._dbus_signature))
943
value = dbus.ByteArray(b''.join(chr(byte)
944
for byte in value))
637
945
prop(value)
638
946
639
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
640
out_signature=u"a{sv}")
947
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
948
out_signature="a{sv}")
641
949
def GetAll(self, interface_name):
642
950
"""Standard D-Bus property GetAll() method, see D-Bus
643
951
standard.
644
952
645
953
Note: Will not include properties with access="write".
646
954
"""
647
all = {}
648
for name, prop in self._get_all_dbus_properties():
955
properties = {}
956
for name, prop in self._get_all_dbus_things("property"):
649
957
if (interface_name
650
958
and interface_name != prop._dbus_interface):
651
959
# Interface non-empty but did not match
652
960
continue
653
961
# Ignore write-only properties
654
if prop._dbus_access == u"write":
962
if prop._dbus_access == "write":
655
963
continue
656
964
value = prop()
657
if not hasattr(value, u"variant_level"):
658
all[name] = value
965
if not hasattr(value, "variant_level"):
966
properties[name] = value
659
967
continue
660
all[name] = type(value)(value, variant_level=
661
value.variant_level+1)
662
return dbus.Dictionary(all, signature=u"sv")
968
properties[name] = type(value)(value, variant_level=
969
value.variant_level+1)
970
return dbus.Dictionary(properties, signature="sv")
663
971
664
972
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
665
out_signature=u"s",
973
out_signature="s",
666
974
path_keyword='object_path',
667
975
connection_keyword='connection')
668
976
def Introspect(self, object_path, connection):
669
"""Standard D-Bus method, overloaded to insert property tags.
977
"""Overloading of standard D-Bus method.
978
979
Inserts property tags and interface annotation tags.
670
980
"""
671
981
xmlstring = dbus.service.Object.Introspect(self, object_path,
672
982
connection)
673
983
try:
674
984
document = xml.dom.minidom.parseString(xmlstring)
675
985
def make_tag(document, name, prop):
676
e = document.createElement(u"property")
677
e.setAttribute(u"name", name)
678
e.setAttribute(u"type", prop._dbus_signature)
679
e.setAttribute(u"access", prop._dbus_access)
986
e = document.createElement("property")
987
e.setAttribute("name", name)
988
e.setAttribute("type", prop._dbus_signature)
989
e.setAttribute("access", prop._dbus_access)
680
990
return e
681
for if_tag in document.getElementsByTagName(u"interface"):
991
for if_tag in document.getElementsByTagName("interface"):
992
# Add property tags
682
993
for tag in (make_tag(document, name, prop)
683
994
for name, prop
684
in self._get_all_dbus_properties()
995
in self._get_all_dbus_things("property")
685
996
if prop._dbus_interface
686
== if_tag.getAttribute(u"name")):
997
== if_tag.getAttribute("name")):
687
998
if_tag.appendChild(tag)
999
# Add annotation tags
1000
for typ in ("method", "signal", "property"):
1001
for tag in if_tag.getElementsByTagName(typ):
1002
annots = dict()
1003
for name, prop in (self.
1004
_get_all_dbus_things(typ)):
1005
if (name == tag.getAttribute("name")
1006
and prop._dbus_interface
1007
== if_tag.getAttribute("name")):
1008
annots.update(getattr
1009
(prop,
1010
"_dbus_annotations",
1011
{}))
1012
for name, value in annots.iteritems():
1013
ann_tag = document.createElement(
1014
"annotation")
1015
ann_tag.setAttribute("name", name)
1016
ann_tag.setAttribute("value", value)
1017
tag.appendChild(ann_tag)
1018
# Add interface annotation tags
1019
for annotation, value in dict(
1020
itertools.chain.from_iterable(
1021
annotations().iteritems()
1022
for name, annotations in
1023
self._get_all_dbus_things("interface")
1024
if name == if_tag.getAttribute("name")
1025
)).iteritems():
1026
ann_tag = document.createElement("annotation")
1027
ann_tag.setAttribute("name", annotation)
1028
ann_tag.setAttribute("value", value)
1029
if_tag.appendChild(ann_tag)
688
1030
# Add the names to the return values for the
689
1031
# "org.freedesktop.DBus.Properties" methods
690
if (if_tag.getAttribute(u"name")
691
== u"org.freedesktop.DBus.Properties"):
692
for cn in if_tag.getElementsByTagName(u"method"):
693
if cn.getAttribute(u"name") == u"Get":
694
for arg in cn.getElementsByTagName(u"arg"):
695
if (arg.getAttribute(u"direction")
696
== u"out"):
697
arg.setAttribute(u"name", u"value")
698
elif cn.getAttribute(u"name") == u"GetAll":
699
for arg in cn.getElementsByTagName(u"arg"):
700
if (arg.getAttribute(u"direction")
701
== u"out"):
702
arg.setAttribute(u"name", u"props")
703
xmlstring = document.toxml(u"utf-8")
1032
if (if_tag.getAttribute("name")
1033
== "org.freedesktop.DBus.Properties"):
1034
for cn in if_tag.getElementsByTagName("method"):
1035
if cn.getAttribute("name") == "Get":
1036
for arg in cn.getElementsByTagName("arg"):
1037
if (arg.getAttribute("direction")
1038
== "out"):
1039
arg.setAttribute("name", "value")
1040
elif cn.getAttribute("name") == "GetAll":
1041
for arg in cn.getElementsByTagName("arg"):
1042
if (arg.getAttribute("direction")
1043
== "out"):
1044
arg.setAttribute("name", "props")
1045
xmlstring = document.toxml("utf-8")
704
1046
document.unlink()
705
1047
except (AttributeError, xml.dom.DOMException,
706
xml.parsers.expat.ExpatError), error:
707
logger.error(u"Failed to override Introspection method",
708
error)
1048
xml.parsers.expat.ExpatError) as error:
1049
logger.error("Failed to override Introspection method",
1050
exc_info=error)
709
1051
return xmlstring
710
1052
711
1053
1054
def datetime_to_dbus(dt, variant_level=0):
1055
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1056
if dt is None:
1057
return dbus.String("", variant_level = variant_level)
1058
return dbus.String(dt.isoformat(),
1059
variant_level=variant_level)
1060
1061
1062
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1063
"""A class decorator; applied to a subclass of
1064
dbus.service.Object, it will add alternate D-Bus attributes with
1065
interface names according to the "alt_interface_names" mapping.
1066
Usage:
1067
1068
@alternate_dbus_interfaces({"org.example.Interface":
1069
"net.example.AlternateInterface"})
1070
class SampleDBusObject(dbus.service.Object):
1071
@dbus.service.method("org.example.Interface")
1072
def SampleDBusMethod():
1073
pass
1074
1075
The above "SampleDBusMethod" on "SampleDBusObject" will be
1076
reachable via two interfaces: "org.example.Interface" and
1077
"net.example.AlternateInterface", the latter of which will have
1078
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1079
"true", unless "deprecate" is passed with a False value.
1080
1081
This works for methods and signals, and also for D-Bus properties
1082
(from DBusObjectWithProperties) and interfaces (from the
1083
dbus_interface_annotations decorator).
1084
"""
1085
def wrapper(cls):
1086
for orig_interface_name, alt_interface_name in (
1087
alt_interface_names.iteritems()):
1088
attr = {}
1089
interface_names = set()
1090
# Go though all attributes of the class
1091
for attrname, attribute in inspect.getmembers(cls):
1092
# Ignore non-D-Bus attributes, and D-Bus attributes
1093
# with the wrong interface name
1094
if (not hasattr(attribute, "_dbus_interface")
1095
or not attribute._dbus_interface
1096
.startswith(orig_interface_name)):
1097
continue
1098
# Create an alternate D-Bus interface name based on
1099
# the current name
1100
alt_interface = (attribute._dbus_interface
1101
.replace(orig_interface_name,
1102
alt_interface_name))
1103
interface_names.add(alt_interface)
1104
# Is this a D-Bus signal?
1105
if getattr(attribute, "_dbus_is_signal", False):
1106
# Extract the original non-method undecorated
1107
# function by black magic
1108
nonmethod_func = (dict(
1109
zip(attribute.func_code.co_freevars,
1110
attribute.__closure__))["func"]
1111
.cell_contents)
1112
# Create a new, but exactly alike, function
1113
# object, and decorate it to be a new D-Bus signal
1114
# with the alternate D-Bus interface name
1115
new_function = (dbus.service.signal
1116
(alt_interface,
1117
attribute._dbus_signature)
1118
(types.FunctionType(
1119
nonmethod_func.func_code,
1120
nonmethod_func.func_globals,
1121
nonmethod_func.func_name,
1122
nonmethod_func.func_defaults,
1123
nonmethod_func.func_closure)))
1124
# Copy annotations, if any
1125
try:
1126
new_function._dbus_annotations = (
1127
dict(attribute._dbus_annotations))
1128
except AttributeError:
1129
pass
1130
# Define a creator of a function to call both the
1131
# original and alternate functions, so both the
1132
# original and alternate signals gets sent when
1133
# the function is called
1134
def fixscope(func1, func2):
1135
"""This function is a scope container to pass
1136
func1 and func2 to the "call_both" function
1137
outside of its arguments"""
1138
def call_both(*args, **kwargs):
1139
"""This function will emit two D-Bus
1140
signals by calling func1 and func2"""
1141
func1(*args, **kwargs)
1142
func2(*args, **kwargs)
1143
return call_both
1144
# Create the "call_both" function and add it to
1145
# the class
1146
attr[attrname] = fixscope(attribute, new_function)
1147
# Is this a D-Bus method?
1148
elif getattr(attribute, "_dbus_is_method", False):
1149
# Create a new, but exactly alike, function
1150
# object. Decorate it to be a new D-Bus method
1151
# with the alternate D-Bus interface name. Add it
1152
# to the class.
1153
attr[attrname] = (dbus.service.method
1154
(alt_interface,
1155
attribute._dbus_in_signature,
1156
attribute._dbus_out_signature)
1157
(types.FunctionType
1158
(attribute.func_code,
1159
attribute.func_globals,
1160
attribute.func_name,
1161
attribute.func_defaults,
1162
attribute.func_closure)))
1163
# Copy annotations, if any
1164
try:
1165
attr[attrname]._dbus_annotations = (
1166
dict(attribute._dbus_annotations))
1167
except AttributeError:
1168
pass
1169
# Is this a D-Bus property?
1170
elif getattr(attribute, "_dbus_is_property", False):
1171
# Create a new, but exactly alike, function
1172
# object, and decorate it to be a new D-Bus
1173
# property with the alternate D-Bus interface
1174
# name. Add it to the class.
1175
attr[attrname] = (dbus_service_property
1176
(alt_interface,
1177
attribute._dbus_signature,
1178
attribute._dbus_access,
1179
attribute
1180
._dbus_get_args_options
1181
["byte_arrays"])
1182
(types.FunctionType
1183
(attribute.func_code,
1184
attribute.func_globals,
1185
attribute.func_name,
1186
attribute.func_defaults,
1187
attribute.func_closure)))
1188
# Copy annotations, if any
1189
try:
1190
attr[attrname]._dbus_annotations = (
1191
dict(attribute._dbus_annotations))
1192
except AttributeError:
1193
pass
1194
# Is this a D-Bus interface?
1195
elif getattr(attribute, "_dbus_is_interface", False):
1196
# Create a new, but exactly alike, function
1197
# object. Decorate it to be a new D-Bus interface
1198
# with the alternate D-Bus interface name. Add it
1199
# to the class.
1200
attr[attrname] = (dbus_interface_annotations
1201
(alt_interface)
1202
(types.FunctionType
1203
(attribute.func_code,
1204
attribute.func_globals,
1205
attribute.func_name,
1206
attribute.func_defaults,
1207
attribute.func_closure)))
1208
if deprecate:
1209
# Deprecate all alternate interfaces
1210
iname="_AlternateDBusNames_interface_annotation{0}"
1211
for interface_name in interface_names:
1212
@dbus_interface_annotations(interface_name)
1213
def func(self):
1214
return { "org.freedesktop.DBus.Deprecated":
1215
"true" }
1216
# Find an unused name
1217
for aname in (iname.format(i)
1218
for i in itertools.count()):
1219
if aname not in attr:
1220
attr[aname] = func
1221
break
1222
if interface_names:
1223
# Replace the class with a new subclass of it with
1224
# methods, signals, etc. as created above.
1225
cls = type(b"{0}Alternate".format(cls.__name__),
1226
(cls,), attr)
1227
return cls
1228
return wrapper
1229
1230
1231
@alternate_dbus_interfaces({"se.recompile.Mandos":
1232
"se.bsnet.fukt.Mandos"})
712
1233
class ClientDBus(Client, DBusObjectWithProperties):
713
1234
"""A Client class using D-Bus
714
1235
718
1239
"""
719
1240
720
1241
runtime_expansions = (Client.runtime_expansions
721
+ (u"dbus_object_path",))
1242
+ ("dbus_object_path",))
722
1243
723
1244
# dbus.service.Object doesn't use super(), so we can't either.
724
1245
725
1246
def __init__(self, bus = None, *args, **kwargs):
726
self._approvals_pending = 0
727
1247
self.bus = bus
728
1248
Client.__init__(self, *args, **kwargs)
729
1249
# Only now, when this client is initialized, can it show up on
730
1250
# the D-Bus
731
1251
client_object_name = unicode(self.name).translate(
732
{ord(u"."): ord(u"_"),
733
ord(u"-"): ord(u"_")})
1252
{ord("."): ord("_"),
1253
ord("-"): ord("_")})
734
1254
self.dbus_object_path = (dbus.ObjectPath
735
(u"/clients/" + client_object_name))
1255
("/clients/" + client_object_name))
736
1256
DBusObjectWithProperties.__init__(self, self.bus,
737
1257
self.dbus_object_path)
738
739
def _get_approvals_pending(self):
740
return self._approvals_pending
741
def _set_approvals_pending(self, value):
742
old_value = self._approvals_pending
743
self._approvals_pending = value
744
bval = bool(value)
745
if (hasattr(self, "dbus_object_path")
746
and bval is not bool(old_value)):
747
dbus_bool = dbus.Boolean(bval, variant_level=1)
748
self.PropertyChanged(dbus.String(u"ApprovalPending"),
749
dbus_bool)
750
751
approvals_pending = property(_get_approvals_pending,
752
_set_approvals_pending)
753
del _get_approvals_pending, _set_approvals_pending
754
755
@staticmethod
756
def _datetime_to_dbus(dt, variant_level=0):
757
"""Convert a UTC datetime.datetime() to a D-Bus type."""
758
return dbus.String(dt.isoformat(),
759
variant_level=variant_level)
760
761
def enable(self):
762
oldstate = getattr(self, u"enabled", False)
763
r = Client.enable(self)
764
if oldstate != self.enabled:
765
# Emit D-Bus signals
766
self.PropertyChanged(dbus.String(u"Enabled"),
767
dbus.Boolean(True, variant_level=1))
768
self.PropertyChanged(
769
dbus.String(u"LastEnabled"),
770
self._datetime_to_dbus(self.last_enabled,
771
variant_level=1))
772
return r
773
774
def disable(self, quiet = False):
775
oldstate = getattr(self, u"enabled", False)
776
r = Client.disable(self, quiet=quiet)
777
if not quiet and oldstate != self.enabled:
778
# Emit D-Bus signal
779
self.PropertyChanged(dbus.String(u"Enabled"),
780
dbus.Boolean(False, variant_level=1))
781
return r
1258
1259
def notifychangeproperty(transform_func,
1260
dbus_name, type_func=lambda x: x,
1261
variant_level=1):
1262
""" Modify a variable so that it's a property which announces
1263
its changes to DBus.
1264
1265
transform_fun: Function that takes a value and a variant_level
1266
and transforms it to a D-Bus type.
1267
dbus_name: D-Bus name of the variable
1268
type_func: Function that transform the value before sending it
1269
to the D-Bus. Default: no transform
1270
variant_level: D-Bus variant level. Default: 1
1271
"""
1272
attrname = "_{0}".format(dbus_name)
1273
def setter(self, value):
1274
if hasattr(self, "dbus_object_path"):
1275
if (not hasattr(self, attrname) or
1276
type_func(getattr(self, attrname, None))
1277
!= type_func(value)):
1278
dbus_value = transform_func(type_func(value),
1279
variant_level
1280
=variant_level)
1281
self.PropertyChanged(dbus.String(dbus_name),
1282
dbus_value)
1283
setattr(self, attrname, value)
1284
1285
return property(lambda self: getattr(self, attrname), setter)
1286
1287
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1288
approvals_pending = notifychangeproperty(dbus.Boolean,
1289
"ApprovalPending",
1290
type_func = bool)
1291
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1292
last_enabled = notifychangeproperty(datetime_to_dbus,
1293
"LastEnabled")
1294
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1295
type_func = lambda checker:
1296
checker is not None)
1297
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1298
"LastCheckedOK")
1299
last_checker_status = notifychangeproperty(dbus.Int16,
1300
"LastCheckerStatus")
1301
last_approval_request = notifychangeproperty(
1302
datetime_to_dbus, "LastApprovalRequest")
1303
approved_by_default = notifychangeproperty(dbus.Boolean,
1304
"ApprovedByDefault")
1305
approval_delay = notifychangeproperty(dbus.UInt64,
1306
"ApprovalDelay",
1307
type_func =
1308
timedelta_to_milliseconds)
1309
approval_duration = notifychangeproperty(
1310
dbus.UInt64, "ApprovalDuration",
1311
type_func = timedelta_to_milliseconds)
1312
host = notifychangeproperty(dbus.String, "Host")
1313
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1314
type_func =
1315
timedelta_to_milliseconds)
1316
extended_timeout = notifychangeproperty(
1317
dbus.UInt64, "ExtendedTimeout",
1318
type_func = timedelta_to_milliseconds)
1319
interval = notifychangeproperty(dbus.UInt64,
1320
"Interval",
1321
type_func =
1322
timedelta_to_milliseconds)
1323
checker_command = notifychangeproperty(dbus.String, "Checker")
1324
1325
del notifychangeproperty
782
1326
783
1327
def __del__(self, *args, **kwargs):
784
1328
try:
785
1329
self.remove_from_connection()
786
1330
except LookupError:
787
1331
pass
788
if hasattr(DBusObjectWithProperties, u"__del__"):
1332
if hasattr(DBusObjectWithProperties, "__del__"):
789
1333
DBusObjectWithProperties.__del__(self, *args, **kwargs)
790
1334
Client.__del__(self, *args, **kwargs)
791
1335
793
1337
*args, **kwargs):
794
1338
self.checker_callback_tag = None
795
1339
self.checker = None
796
# Emit D-Bus signal
797
self.PropertyChanged(dbus.String(u"CheckerRunning"),
798
dbus.Boolean(False, variant_level=1))
799
1340
if os.WIFEXITED(condition):
800
1341
exitstatus = os.WEXITSTATUS(condition)
801
1342
# Emit D-Bus signal
811
1352
return Client.checker_callback(self, pid, condition, command,
812
1353
*args, **kwargs)
813
1354
814
def checked_ok(self, *args, **kwargs):
815
r = Client.checked_ok(self, *args, **kwargs)
816
# Emit D-Bus signal
817
self.PropertyChanged(
818
dbus.String(u"LastCheckedOK"),
819
(self._datetime_to_dbus(self.last_checked_ok,
820
variant_level=1)))
821
return r
822
823
def need_approval(self, *args, **kwargs):
824
r = Client.need_approval(self, *args, **kwargs)
825
# Emit D-Bus signal
826
self.PropertyChanged(
827
dbus.String(u"LastApprovalRequest"),
828
(self._datetime_to_dbus(self.last_approval_request,
829
variant_level=1)))
830
return r
831
832
1355
def start_checker(self, *args, **kwargs):
833
old_checker = self.checker
834
if self.checker is not None:
835
old_checker_pid = self.checker.pid
836
else:
837
old_checker_pid = None
1356
old_checker_pid = getattr(self.checker, "pid", None)
838
1357
r = Client.start_checker(self, *args, **kwargs)
839
1358
# Only if new checker process was started
840
1359
if (self.checker is not None
841
1360
and old_checker_pid != self.checker.pid):
842
1361
# Emit D-Bus signal
843
1362
self.CheckerStarted(self.current_checker_command)
844
self.PropertyChanged(
845
dbus.String(u"CheckerRunning"),
846
dbus.Boolean(True, variant_level=1))
847
1363
return r
848
1364
849
def stop_checker(self, *args, **kwargs):
850
old_checker = getattr(self, u"checker", None)
851
r = Client.stop_checker(self, *args, **kwargs)
852
if (old_checker is not None
853
and getattr(self, u"checker", None) is None):
854
self.PropertyChanged(dbus.String(u"CheckerRunning"),
855
dbus.Boolean(False, variant_level=1))
856
return r
857
858
1365
def _reset_approved(self):
859
self._approved = None
1366
self.approved = None
860
1367
return False
861
1368
862
1369
def approve(self, value=True):
863
self.send_changedstate()
864
self._approved = value
865
gobject.timeout_add(self._timedelta_to_milliseconds
1370
self.approved = value
1371
gobject.timeout_add(timedelta_to_milliseconds
866
1372
(self.approval_duration),
867
1373
self._reset_approved)
868
1374
self.send_changedstate()
869
1375
870
1376
## D-Bus methods, signals & properties
871
_interface = u"se.bsnet.fukt.Mandos.Client"
1377
_interface = "se.recompile.Mandos.Client"
1378
1379
## Interfaces
1380
1381
@dbus_interface_annotations(_interface)
1382
def _foo(self):
1383
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1384
"false"}
872
1385
873
1386
## Signals
874
1387
875
1388
# CheckerCompleted - signal
876
@dbus.service.signal(_interface, signature=u"nxs")
1389
@dbus.service.signal(_interface, signature="nxs")
877
1390
def CheckerCompleted(self, exitcode, waitstatus, command):
878
1391
"D-Bus signal"
879
1392
pass
880
1393
881
1394
# CheckerStarted - signal
882
@dbus.service.signal(_interface, signature=u"s")
1395
@dbus.service.signal(_interface, signature="s")
883
1396
def CheckerStarted(self, command):
884
1397
"D-Bus signal"
885
1398
pass
886
1399
887
1400
# PropertyChanged - signal
888
@dbus.service.signal(_interface, signature=u"sv")
1401
@dbus.service.signal(_interface, signature="sv")
889
1402
def PropertyChanged(self, property, value):
890
1403
"D-Bus signal"
891
1404
pass
900
1413
pass
901
1414
902
1415
# Rejected - signal
903
@dbus.service.signal(_interface, signature=u"s")
1416
@dbus.service.signal(_interface, signature="s")
904
1417
def Rejected(self, reason):
905
1418
"D-Bus signal"
906
1419
pass
907
1420
908
1421
# NeedApproval - signal
909
@dbus.service.signal(_interface, signature=u"tb")
1422
@dbus.service.signal(_interface, signature="tb")
910
1423
def NeedApproval(self, timeout, default):
911
1424
"D-Bus signal"
912
1425
return self.need_approval()
914
1427
## Methods
915
1428
916
1429
# Approve - method
917
@dbus.service.method(_interface, in_signature=u"b")
1430
@dbus.service.method(_interface, in_signature="b")
918
1431
def Approve(self, value):
919
1432
self.approve(value)
920
1433
921
1434
# CheckedOK - method
922
1435
@dbus.service.method(_interface)
923
1436
def CheckedOK(self):
924
return self.checked_ok()
1437
self.checked_ok()
925
1438
926
1439
# Enable - method
927
1440
@dbus.service.method(_interface)
949
1462
## Properties
950
1463
951
1464
# ApprovalPending - property
952
@dbus_service_property(_interface, signature=u"b", access=u"read")
1465
@dbus_service_property(_interface, signature="b", access="read")
953
1466
def ApprovalPending_dbus_property(self):
954
1467
return dbus.Boolean(bool(self.approvals_pending))
955
1468
956
1469
# ApprovedByDefault - property
957
@dbus_service_property(_interface, signature=u"b",
958
access=u"readwrite")
1470
@dbus_service_property(_interface, signature="b",
1471
access="readwrite")
959
1472
def ApprovedByDefault_dbus_property(self, value=None):
960
1473
if value is None: # get
961
1474
return dbus.Boolean(self.approved_by_default)
962
1475
self.approved_by_default = bool(value)
963
# Emit D-Bus signal
964
self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
965
dbus.Boolean(value, variant_level=1))
966
1476
967
1477
# ApprovalDelay - property
968
@dbus_service_property(_interface, signature=u"t",
969
access=u"readwrite")
1478
@dbus_service_property(_interface, signature="t",
1479
access="readwrite")
970
1480
def ApprovalDelay_dbus_property(self, value=None):
971
1481
if value is None: # get
972
1482
return dbus.UInt64(self.approval_delay_milliseconds())
973
1483
self.approval_delay = datetime.timedelta(0, 0, 0, value)
974
# Emit D-Bus signal
975
self.PropertyChanged(dbus.String(u"ApprovalDelay"),
976
dbus.UInt64(value, variant_level=1))
977
1484
978
1485
# ApprovalDuration - property
979
@dbus_service_property(_interface, signature=u"t",
980
access=u"readwrite")
1486
@dbus_service_property(_interface, signature="t",
1487
access="readwrite")
981
1488
def ApprovalDuration_dbus_property(self, value=None):
982
1489
if value is None: # get
983
return dbus.UInt64(self._timedelta_to_milliseconds(
1490
return dbus.UInt64(timedelta_to_milliseconds(
984
1491
self.approval_duration))
985
1492
self.approval_duration = datetime.timedelta(0, 0, 0, value)
986
# Emit D-Bus signal
987
self.PropertyChanged(dbus.String(u"ApprovalDuration"),
988
dbus.UInt64(value, variant_level=1))
989
1493
990
1494
# Name - property
991
@dbus_service_property(_interface, signature=u"s", access=u"read")
1495
@dbus_service_property(_interface, signature="s", access="read")
992
1496
def Name_dbus_property(self):
993
1497
return dbus.String(self.name)
994
1498
995
1499
# Fingerprint - property
996
@dbus_service_property(_interface, signature=u"s", access=u"read")
1500
@dbus_service_property(_interface, signature="s", access="read")
997
1501
def Fingerprint_dbus_property(self):
998
1502
return dbus.String(self.fingerprint)
999
1503
1000
1504
# Host - property
1001
@dbus_service_property(_interface, signature=u"s",
1002
access=u"readwrite")
1505
@dbus_service_property(_interface, signature="s",
1506
access="readwrite")
1003
1507
def Host_dbus_property(self, value=None):
1004
1508
if value is None: # get
1005
1509
return dbus.String(self.host)
1006
self.host = value
1007
# Emit D-Bus signal
1008
self.PropertyChanged(dbus.String(u"Host"),
1009
dbus.String(value, variant_level=1))
1510
self.host = unicode(value)
1010
1511
1011
1512
# Created - property
1012
@dbus_service_property(_interface, signature=u"s", access=u"read")
1513
@dbus_service_property(_interface, signature="s", access="read")
1013
1514
def Created_dbus_property(self):
1014
return dbus.String(self._datetime_to_dbus(self.created))
1515
return datetime_to_dbus(self.created)
1015
1516
1016
1517
# LastEnabled - property
1017
@dbus_service_property(_interface, signature=u"s", access=u"read")
1518
@dbus_service_property(_interface, signature="s", access="read")
1018
1519
def LastEnabled_dbus_property(self):
1019
if self.last_enabled is None:
1020
return dbus.String(u"")
1021
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1520
return datetime_to_dbus(self.last_enabled)
1022
1521
1023
1522
# Enabled - property
1024
@dbus_service_property(_interface, signature=u"b",
1025
access=u"readwrite")
1523
@dbus_service_property(_interface, signature="b",
1524
access="readwrite")
1026
1525
def Enabled_dbus_property(self, value=None):
1027
1526
if value is None: # get
1028
1527
return dbus.Boolean(self.enabled)
1032
1531
self.disable()
1033
1532
1034
1533
# LastCheckedOK - property
1035
@dbus_service_property(_interface, signature=u"s",
1036
access=u"readwrite")
1534
@dbus_service_property(_interface, signature="s",
1535
access="readwrite")
1037
1536
def LastCheckedOK_dbus_property(self, value=None):
1038
1537
if value is not None:
1039
1538
self.checked_ok()
1040
1539
return
1041
if self.last_checked_ok is None:
1042
return dbus.String(u"")
1043
return dbus.String(self._datetime_to_dbus(self
1044
.last_checked_ok))
1540
return datetime_to_dbus(self.last_checked_ok)
1541
1542
# LastCheckerStatus - property
1543
@dbus_service_property(_interface, signature="n",
1544
access="read")
1545
def LastCheckerStatus_dbus_property(self):
1546
return dbus.Int16(self.last_checker_status)
1547
1548
# Expires - property
1549
@dbus_service_property(_interface, signature="s", access="read")
1550
def Expires_dbus_property(self):
1551
return datetime_to_dbus(self.expires)
1045
1552
1046
1553
# LastApprovalRequest - property
1047
@dbus_service_property(_interface, signature=u"s", access=u"read")
1554
@dbus_service_property(_interface, signature="s", access="read")
1048
1555
def LastApprovalRequest_dbus_property(self):
1049
if self.last_approval_request is None:
1050
return dbus.String(u"")
1051
return dbus.String(self.
1052
_datetime_to_dbus(self
1053
.last_approval_request))
1556
return datetime_to_dbus(self.last_approval_request)
1054
1557
1055
1558
# Timeout - property
1056
@dbus_service_property(_interface, signature=u"t",
1057
access=u"readwrite")
1559
@dbus_service_property(_interface, signature="t",
1560
access="readwrite")
1058
1561
def Timeout_dbus_property(self, value=None):
1059
1562
if value is None: # get
1060
1563
return dbus.UInt64(self.timeout_milliseconds())
1564
old_timeout = self.timeout
1061
1565
self.timeout = datetime.timedelta(0, 0, 0, value)
1062
# Emit D-Bus signal
1063
self.PropertyChanged(dbus.String(u"Timeout"),
1064
dbus.UInt64(value, variant_level=1))
1065
if getattr(self, u"disable_initiator_tag", None) is None:
1066
return
1067
# Reschedule timeout
1068
gobject.source_remove(self.disable_initiator_tag)
1069
self.disable_initiator_tag = None
1070
time_to_die = (self.
1071
_timedelta_to_milliseconds((self
1072
.last_checked_ok
1073
+ self.timeout)
1074
- datetime.datetime
1075
.utcnow()))
1076
if time_to_die <= 0:
1077
# The timeout has passed
1078
self.disable()
1079
else:
1080
self.disable_initiator_tag = (gobject.timeout_add
1081
(time_to_die, self.disable))
1566
# Reschedule disabling
1567
if self.enabled:
1568
now = datetime.datetime.utcnow()
1569
self.expires += self.timeout - old_timeout
1570
if self.expires <= now:
1571
# The timeout has passed
1572
self.disable()
1573
else:
1574
if (getattr(self, "disable_initiator_tag", None)
1575
is None):
1576
return
1577
gobject.source_remove(self.disable_initiator_tag)
1578
self.disable_initiator_tag = (
1579
gobject.timeout_add(
1580
timedelta_to_milliseconds(self.expires - now),
1581
self.disable))
1582
1583
# ExtendedTimeout - property
1584
@dbus_service_property(_interface, signature="t",
1585
access="readwrite")
1586
def ExtendedTimeout_dbus_property(self, value=None):
1587
if value is None: # get
1588
return dbus.UInt64(self.extended_timeout_milliseconds())
1589
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1082
1590
1083
1591
# Interval - property
1084
@dbus_service_property(_interface, signature=u"t",
1085
access=u"readwrite")
1592
@dbus_service_property(_interface, signature="t",
1593
access="readwrite")
1086
1594
def Interval_dbus_property(self, value=None):
1087
1595
if value is None: # get
1088
1596
return dbus.UInt64(self.interval_milliseconds())
1089
1597
self.interval = datetime.timedelta(0, 0, 0, value)
1090
# Emit D-Bus signal
1091
self.PropertyChanged(dbus.String(u"Interval"),
1092
dbus.UInt64(value, variant_level=1))
1093
if getattr(self, u"checker_initiator_tag", None) is None:
1598
if getattr(self, "checker_initiator_tag", None) is None:
1094
1599
return
1095
# Reschedule checker run
1096
gobject.source_remove(self.checker_initiator_tag)
1097
self.checker_initiator_tag = (gobject.timeout_add
1098
(value, self.start_checker))
1099
self.start_checker() # Start one now, too
1100
1600
if self.enabled:
1601
# Reschedule checker run
1602
gobject.source_remove(self.checker_initiator_tag)
1603
self.checker_initiator_tag = (gobject.timeout_add
1604
(value, self.start_checker))
1605
self.start_checker() # Start one now, too
1606
1101
1607
# Checker - property
1102
@dbus_service_property(_interface, signature=u"s",
1103
access=u"readwrite")
1608
@dbus_service_property(_interface, signature="s",
1609
access="readwrite")
1104
1610
def Checker_dbus_property(self, value=None):
1105
1611
if value is None: # get
1106
1612
return dbus.String(self.checker_command)
1107
self.checker_command = value
1108
# Emit D-Bus signal
1109
self.PropertyChanged(dbus.String(u"Checker"),
1110
dbus.String(self.checker_command,
1111
variant_level=1))
1613
self.checker_command = unicode(value)
1112
1614
1113
1615
# CheckerRunning - property
1114
@dbus_service_property(_interface, signature=u"b",
1115
access=u"readwrite")
1616
@dbus_service_property(_interface, signature="b",
1617
access="readwrite")
1116
1618
def CheckerRunning_dbus_property(self, value=None):
1117
1619
if value is None: # get
1118
1620
return dbus.Boolean(self.checker is not None)
1122
1624
self.stop_checker()
1123
1625
1124
1626
# ObjectPath - property
1125
@dbus_service_property(_interface, signature=u"o", access=u"read")
1627
@dbus_service_property(_interface, signature="o", access="read")
1126
1628
def ObjectPath_dbus_property(self):
1127
1629
return self.dbus_object_path # is already a dbus.ObjectPath
1128
1630
1129
1631
# Secret = property
1130
@dbus_service_property(_interface, signature=u"ay",
1131
access=u"write", byte_arrays=True)
1632
@dbus_service_property(_interface, signature="ay",
1633
access="write", byte_arrays=True)
1132
1634
def Secret_dbus_property(self, value):
1133
1635
self.secret = str(value)
1134
1636
1141
1643
self._pipe.send(('init', fpr, address))
1142
1644
if not self._pipe.recv():
1143
1645
raise KeyError()
1144
1646
1145
1647
def __getattribute__(self, name):
1146
if(name == '_pipe'):
1648
if name == '_pipe':
1147
1649
return super(ProxyClient, self).__getattribute__(name)
1148
1650
self._pipe.send(('getattr', name))
1149
1651
data = self._pipe.recv()
1154
1656
self._pipe.send(('funcall', name, args, kwargs))
1155
1657
return self._pipe.recv()[1]
1156
1658
return func
1157
1659
1158
1660
def __setattr__(self, name, value):
1159
if(name == '_pipe'):
1661
if name == '_pipe':
1160
1662
return super(ProxyClient, self).__setattr__(name, value)
1161
1663
self._pipe.send(('setattr', name, value))
1162
1664
1169
1671
1170
1672
def handle(self):
1171
1673
with contextlib.closing(self.server.child_pipe) as child_pipe:
1172
logger.info(u"TCP connection from: %s",
1674
logger.info("TCP connection from: %s",
1173
1675
unicode(self.client_address))
1174
logger.debug(u"Pipe FD: %d",
1676
logger.debug("Pipe FD: %d",
1175
1677
self.server.child_pipe.fileno())
1176
1678
1177
1679
session = (gnutls.connection
1178
1680
.ClientSession(self.request,
1179
1681
gnutls.connection
1180
1682
.X509Credentials()))
1181
1683
1182
1684
# Note: gnutls.connection.X509Credentials is really a
1183
1685
# generic GnuTLS certificate credentials object so long as
1184
1686
# no X.509 keys are added to it. Therefore, we can use it
1185
1687
# here despite using OpenPGP certificates.
1186
1187
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1188
# u"+AES-256-CBC", u"+SHA1",
1189
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1190
# u"+DHE-DSS"))
1688
1689
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1690
# "+AES-256-CBC", "+SHA1",
1691
# "+COMP-NULL", "+CTYPE-OPENPGP",
1692
# "+DHE-DSS"))
1191
1693
# Use a fallback default, since this MUST be set.
1192
1694
priority = self.server.gnutls_priority
1193
1695
if priority is None:
1194
priority = u"NORMAL"
1696
priority = "NORMAL"
1195
1697
(gnutls.library.functions
1196
1698
.gnutls_priority_set_direct(session._c_object,
1197
1699
priority, None))
1198
1700
1199
1701
# Start communication using the Mandos protocol
1200
1702
# Get protocol number
1201
1703
line = self.request.makefile().readline()
1202
logger.debug(u"Protocol version: %r", line)
1704
logger.debug("Protocol version: %r", line)
1203
1705
try:
1204
1706
if int(line.strip().split()[0]) > 1:
1205
raise RuntimeError
1206
except (ValueError, IndexError, RuntimeError), error:
1207
logger.error(u"Unknown protocol version: %s", error)
1707
raise RuntimeError(line)
1708
except (ValueError, IndexError, RuntimeError) as error:
1709
logger.error("Unknown protocol version: %s", error)
1208
1710
return
1209
1711
1210
1712
# Start GnuTLS connection
1211
1713
try:
1212
1714
session.handshake()
1213
except gnutls.errors.GNUTLSError, error:
1214
logger.warning(u"Handshake failed: %s", error)
1715
except gnutls.errors.GNUTLSError as error:
1716
logger.warning("Handshake failed: %s", error)
1215
1717
# Do not run session.bye() here: the session is not
1216
1718
# established. Just abandon the request.
1217
1719
return
1218
logger.debug(u"Handshake succeeded")
1219
1720
logger.debug("Handshake succeeded")
1721
1220
1722
approval_required = False
1221
1723
try:
1222
1724
try:
1223
1725
fpr = self.fingerprint(self.peer_certificate
1224
1726
(session))
1225
except (TypeError, gnutls.errors.GNUTLSError), error:
1226
logger.warning(u"Bad certificate: %s", error)
1727
except (TypeError,
1728
gnutls.errors.GNUTLSError) as error:
1729
logger.warning("Bad certificate: %s", error)
1227
1730
return
1228
logger.debug(u"Fingerprint: %s", fpr)
1229
1731
logger.debug("Fingerprint: %s", fpr)
1732
1230
1733
try:
1231
1734
client = ProxyClient(child_pipe, fpr,
1232
1735
self.client_address)
1240
1743
1241
1744
while True:
1242
1745
if not client.enabled:
1243
logger.warning(u"Client %s is disabled",
1746
logger.info("Client %s is disabled",
1244
1747
client.name)
1245
1748
if self.server.use_dbus:
1246
1749
# Emit D-Bus signal
1247
client.Rejected("Disabled")
1750
client.Rejected("Disabled")
1248
1751
return
1249
1752
1250
if client._approved or not client.approval_delay:
1753
if client.approved or not client.approval_delay:
1251
1754
#We are approved or approval is disabled
1252
1755
break
1253
elif client._approved is None:
1254
logger.info(u"Client %s needs approval",
1756
elif client.approved is None:
1757
logger.info("Client %s needs approval",
1255
1758
client.name)
1256
1759
if self.server.use_dbus:
1257
1760
# Emit D-Bus signal
1259
1762
client.approval_delay_milliseconds(),
1260
1763
client.approved_by_default)
1261
1764
else:
1262
logger.warning(u"Client %s was not approved",
1765
logger.warning("Client %s was not approved",
1263
1766
client.name)
1264
1767
if self.server.use_dbus:
1265
1768
# Emit D-Bus signal
1267
1770
return
1268
1771
1269
1772
#wait until timeout or approved
1270
#x = float(client._timedelta_to_milliseconds(delay))
1271
1773
time = datetime.datetime.now()
1272
1774
client.changedstate.acquire()
1273
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1775
client.changedstate.wait(
1776
float(timedelta_to_milliseconds(delay)
1777
/ 1000))
1274
1778
client.changedstate.release()
1275
1779
time2 = datetime.datetime.now()
1276
1780
if (time2 - time) >= delay:
1291
1795
while sent_size < len(client.secret):
1292
1796
try:
1293
1797
sent = session.send(client.secret[sent_size:])
1294
except (gnutls.errors.GNUTLSError), error:
1295
logger.warning("gnutls send failed")
1798
except gnutls.errors.GNUTLSError as error:
1799
logger.warning("gnutls send failed",
1800
exc_info=error)
1296
1801
return
1297
logger.debug(u"Sent: %d, remaining: %d",
1802
logger.debug("Sent: %d, remaining: %d",
1298
1803
sent, len(client.secret)
1299
1804
- (sent_size + sent))
1300
1805
sent_size += sent
1301
1302
logger.info(u"Sending secret to %s", client.name)
1303
# bump the timeout as if seen
1304
client.checked_ok()
1806
1807
logger.info("Sending secret to %s", client.name)
1808
# bump the timeout using extended_timeout
1809
client.bump_timeout(client.extended_timeout)
1305
1810
if self.server.use_dbus:
1306
1811
# Emit D-Bus signal
1307
1812
client.GotSecret()
1311
1816
client.approvals_pending -= 1
1312
1817
try:
1313
1818
session.bye()
1314
except (gnutls.errors.GNUTLSError), error:
1315
logger.warning("GnuTLS bye failed")
1819
except gnutls.errors.GNUTLSError as error:
1820
logger.warning("GnuTLS bye failed",
1821
exc_info=error)
1316
1822
1317
1823
@staticmethod
1318
1824
def peer_certificate(session):
1328
1834
.gnutls_certificate_get_peers
1329
1835
(session._c_object, ctypes.byref(list_size)))
1330
1836
if not bool(cert_list) and list_size.value != 0:
1331
raise gnutls.errors.GNUTLSError(u"error getting peer"
1332
u" certificate")
1837
raise gnutls.errors.GNUTLSError("error getting peer"
1838
" certificate")
1333
1839
if list_size.value == 0:
1334
1840
return None
1335
1841
cert = cert_list[0]
1361
1867
if crtverify.value != 0:
1362
1868
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1363
1869
raise (gnutls.errors.CertificateSecurityError
1364
(u"Verify failed"))
1870
("Verify failed"))
1365
1871
# New buffer for the fingerprint
1366
1872
buf = ctypes.create_string_buffer(20)
1367
1873
buf_len = ctypes.c_size_t()
1374
1880
# Convert the buffer to a Python bytestring
1375
1881
fpr = ctypes.string_at(buf, buf_len.value)
1376
1882
# Convert the bytestring to hexadecimal notation
1377
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1883
hex_fpr = binascii.hexlify(fpr).upper()
1378
1884
return hex_fpr
1379
1885
1380
1886
1383
1889
def sub_process_main(self, request, address):
1384
1890
try:
1385
1891
self.finish_request(request, address)
1386
except:
1892
except Exception:
1387
1893
self.handle_error(request, address)
1388
1894
self.close_request(request)
1389
1895
1390
1896
def process_request(self, request, address):
1391
1897
"""Start a new process to process the request."""
1392
multiprocessing.Process(target = self.sub_process_main,
1393
args = (request, address)).start()
1898
proc = multiprocessing.Process(target = self.sub_process_main,
1899
args = (request, address))
1900
proc.start()
1901
return proc
1902
1394
1903
1395
1904
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1396
1905
""" adds a pipe to the MixIn """
1400
1909
This function creates a new pipe in self.pipe
1401
1910
"""
1402
1911
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1403
1404
super(MultiprocessingMixInWithPipe,
1405
self).process_request(request, client_address)
1912
1913
proc = MultiprocessingMixIn.process_request(self, request,
1914
client_address)
1406
1915
self.child_pipe.close()
1407
self.add_pipe(parent_pipe)
1408
1409
def add_pipe(self, parent_pipe):
1916
self.add_pipe(parent_pipe, proc)
1917
1918
def add_pipe(self, parent_pipe, proc):
1410
1919
"""Dummy function; override as necessary"""
1411
pass
1920
raise NotImplementedError()
1921
1412
1922
1413
1923
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1414
1924
socketserver.TCPServer, object):
1420
1930
use_ipv6: Boolean; to use IPv6 or not
1421
1931
"""
1422
1932
def __init__(self, server_address, RequestHandlerClass,
1423
interface=None, use_ipv6=True):
1933
interface=None, use_ipv6=True, socketfd=None):
1934
"""If socketfd is set, use that file descriptor instead of
1935
creating a new one with socket.socket().
1936
"""
1424
1937
self.interface = interface
1425
1938
if use_ipv6:
1426
1939
self.address_family = socket.AF_INET6
1940
if socketfd is not None:
1941
# Save the file descriptor
1942
self.socketfd = socketfd
1943
# Save the original socket.socket() function
1944
self.socket_socket = socket.socket
1945
# To implement --socket, we monkey patch socket.socket.
1946
#
1947
# (When socketserver.TCPServer is a new-style class, we
1948
# could make self.socket into a property instead of monkey
1949
# patching socket.socket.)
1950
#
1951
# Create a one-time-only replacement for socket.socket()
1952
@functools.wraps(socket.socket)
1953
def socket_wrapper(*args, **kwargs):
1954
# Restore original function so subsequent calls are
1955
# not affected.
1956
socket.socket = self.socket_socket
1957
del self.socket_socket
1958
# This time only, return a new socket object from the
1959
# saved file descriptor.
1960
return socket.fromfd(self.socketfd, *args, **kwargs)
1961
# Replace socket.socket() function with wrapper
1962
socket.socket = socket_wrapper
1963
# The socketserver.TCPServer.__init__ will call
1964
# socket.socket(), which might be our replacement,
1965
# socket_wrapper(), if socketfd was set.
1427
1966
socketserver.TCPServer.__init__(self, server_address,
1428
1967
RequestHandlerClass)
1968
1429
1969
def server_bind(self):
1430
1970
"""This overrides the normal server_bind() function
1431
1971
to bind to an interface if one was specified, and also NOT to
1432
1972
bind to an address or port if they were not specified."""
1433
1973
if self.interface is not None:
1434
1974
if SO_BINDTODEVICE is None:
1435
logger.error(u"SO_BINDTODEVICE does not exist;"
1436
u" cannot bind to interface %s",
1975
logger.error("SO_BINDTODEVICE does not exist;"
1976
" cannot bind to interface %s",
1437
1977
self.interface)
1438
1978
else:
1439
1979
try:
1440
1980
self.socket.setsockopt(socket.SOL_SOCKET,
1441
1981
SO_BINDTODEVICE,
1442
str(self.interface
1443
+ u'\0'))
1444
except socket.error, error:
1445
if error[0] == errno.EPERM:
1446
logger.error(u"No permission to"
1447
u" bind to interface %s",
1448
self.interface)
1449
elif error[0] == errno.ENOPROTOOPT:
1450
logger.error(u"SO_BINDTODEVICE not available;"
1451
u" cannot bind to interface %s",
1452
self.interface)
1982
str(self.interface + '\0'))
1983
except socket.error as error:
1984
if error.errno == errno.EPERM:
1985
logger.error("No permission to bind to"
1986
" interface %s", self.interface)
1987
elif error.errno == errno.ENOPROTOOPT:
1988
logger.error("SO_BINDTODEVICE not available;"
1989
" cannot bind to interface %s",
1990
self.interface)
1991
elif error.errno == errno.ENODEV:
1992
logger.error("Interface %s does not exist,"
1993
" cannot bind", self.interface)
1453
1994
else:
1454
1995
raise
1455
1996
# Only bind(2) the socket if we really need to.
1456
1997
if self.server_address[0] or self.server_address[1]:
1457
1998
if not self.server_address[0]:
1458
1999
if self.address_family == socket.AF_INET6:
1459
any_address = u"::" # in6addr_any
2000
any_address = "::" # in6addr_any
1460
2001
else:
1461
any_address = socket.INADDR_ANY
2002
any_address = "0.0.0.0" # INADDR_ANY
1462
2003
self.server_address = (any_address,
1463
2004
self.server_address[1])
1464
2005
elif not self.server_address[1]:
1485
2026
"""
1486
2027
def __init__(self, server_address, RequestHandlerClass,
1487
2028
interface=None, use_ipv6=True, clients=None,
1488
gnutls_priority=None, use_dbus=True):
2029
gnutls_priority=None, use_dbus=True, socketfd=None):
1489
2030
self.enabled = False
1490
2031
self.clients = clients
1491
2032
if self.clients is None:
1492
self.clients = set()
2033
self.clients = {}
1493
2034
self.use_dbus = use_dbus
1494
2035
self.gnutls_priority = gnutls_priority
1495
2036
IPv6_TCPServer.__init__(self, server_address,
1496
2037
RequestHandlerClass,
1497
2038
interface = interface,
1498
use_ipv6 = use_ipv6)
2039
use_ipv6 = use_ipv6,
2040
socketfd = socketfd)
1499
2041
def server_activate(self):
1500
2042
if self.enabled:
1501
2043
return socketserver.TCPServer.server_activate(self)
2044
1502
2045
def enable(self):
1503
2046
self.enabled = True
1504
def add_pipe(self, parent_pipe):
2047
2048
def add_pipe(self, parent_pipe, proc):
1505
2049
# Call "handle_ipc" for both data and EOF events
1506
2050
gobject.io_add_watch(parent_pipe.fileno(),
1507
2051
gobject.IO_IN | gobject.IO_HUP,
1508
2052
functools.partial(self.handle_ipc,
1509
parent_pipe = parent_pipe))
1510
2053
parent_pipe =
2054
parent_pipe,
2055
proc = proc))
2056
1511
2057
def handle_ipc(self, source, condition, parent_pipe=None,
1512
client_object=None):
1513
condition_names = {
1514
gobject.IO_IN: u"IN", # There is data to read.
1515
gobject.IO_OUT: u"OUT", # Data can be written (without
1516
# blocking).
1517
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1518
gobject.IO_ERR: u"ERR", # Error condition.
1519
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1520
# broken, usually for pipes and
1521
# sockets).
1522
}
1523
conditions_string = ' | '.join(name
1524
for cond, name in
1525
condition_names.iteritems()
1526
if cond & condition)
1527
# error or the other end of multiprocessing.Pipe has closed
1528
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2058
proc = None, client_object=None):
2059
# error, or the other end of multiprocessing.Pipe has closed
2060
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2061
# Wait for other process to exit
2062
proc.join()
1529
2063
return False
1530
2064
1531
2065
# Read a request from the child
1536
2070
fpr = request[1]
1537
2071
address = request[2]
1538
2072
1539
for c in self.clients:
2073
for c in self.clients.itervalues():
1540
2074
if c.fingerprint == fpr:
1541
2075
client = c
1542
2076
break
1543
2077
else:
1544
logger.warning(u"Client not found for fingerprint: %s, ad"
1545
u"dress: %s", fpr, address)
2078
logger.info("Client not found for fingerprint: %s, ad"
2079
"dress: %s", fpr, address)
1546
2080
if self.use_dbus:
1547
2081
# Emit D-Bus signal
1548
mandos_dbus_service.ClientNotFound(fpr, address[0])
2082
mandos_dbus_service.ClientNotFound(fpr,
2083
address[0])
1549
2084
parent_pipe.send(False)
1550
2085
return False
1551
2086
1552
2087
gobject.io_add_watch(parent_pipe.fileno(),
1553
2088
gobject.IO_IN | gobject.IO_HUP,
1554
2089
functools.partial(self.handle_ipc,
1555
parent_pipe = parent_pipe,
1556
client_object = client))
2090
parent_pipe =
2091
parent_pipe,
2092
proc = proc,
2093
client_object =
2094
client))
1557
2095
parent_pipe.send(True)
1558
# remove the old hook in favor of the new above hook on same fileno
2096
# remove the old hook in favor of the new above hook on
2097
# same fileno
1559
2098
return False
1560
2099
if command == 'funcall':
1561
2100
funcname = request[1]
1562
2101
args = request[2]
1563
2102
kwargs = request[3]
1564
2103
1565
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1566
2104
parent_pipe.send(('data', getattr(client_object,
2105
funcname)(*args,
2106
**kwargs)))
2107
1567
2108
if command == 'getattr':
1568
2109
attrname = request[1]
1569
2110
if callable(client_object.__getattribute__(attrname)):
1570
2111
parent_pipe.send(('function',))
1571
2112
else:
1572
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2113
parent_pipe.send(('data', client_object
2114
.__getattribute__(attrname)))
1573
2115
1574
2116
if command == 'setattr':
1575
2117
attrname = request[1]
1576
2118
value = request[2]
1577
2119
setattr(client_object, attrname, value)
1578
2120
1579
2121
return True
1580
2122
1581
2123
2124
def rfc3339_duration_to_delta(duration):
2125
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2126
2127
>>> rfc3339_duration_to_delta("P7D")
2128
datetime.timedelta(7)
2129
>>> rfc3339_duration_to_delta("PT60S")
2130
datetime.timedelta(0, 60)
2131
>>> rfc3339_duration_to_delta("PT60M")
2132
datetime.timedelta(0, 3600)
2133
>>> rfc3339_duration_to_delta("PT24H")
2134
datetime.timedelta(1)
2135
>>> rfc3339_duration_to_delta("P1W")
2136
datetime.timedelta(7)
2137
>>> rfc3339_duration_to_delta("PT5M30S")
2138
datetime.timedelta(0, 330)
2139
>>> rfc3339_duration_to_delta("P1DT3M20S")
2140
datetime.timedelta(1, 200)
2141
"""
2142
2143
# Parsing an RFC 3339 duration with regular expressions is not
2144
# possible - there would have to be multiple places for the same
2145
# values, like seconds. The current code, while more esoteric, is
2146
# cleaner without depending on a parsing library. If Python had a
2147
# built-in library for parsing we would use it, but we'd like to
2148
# avoid excessive use of external libraries.
2149
2150
# New type for defining tokens, syntax, and semantics all-in-one
2151
Token = collections.namedtuple("Token",
2152
("regexp", # To match token; if
2153
# "value" is not None,
2154
# must have a "group"
2155
# containing digits
2156
"value", # datetime.timedelta or
2157
# None
2158
"followers")) # Tokens valid after
2159
# this token
2160
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2161
# the "duration" ABNF definition in RFC 3339, Appendix A.
2162
token_end = Token(re.compile(r"$"), None, frozenset())
2163
token_second = Token(re.compile(r"(\d+)S"),
2164
datetime.timedelta(seconds=1),
2165
frozenset((token_end,)))
2166
token_minute = Token(re.compile(r"(\d+)M"),
2167
datetime.timedelta(minutes=1),
2168
frozenset((token_second, token_end)))
2169
token_hour = Token(re.compile(r"(\d+)H"),
2170
datetime.timedelta(hours=1),
2171
frozenset((token_minute, token_end)))
2172
token_time = Token(re.compile(r"T"),
2173
None,
2174
frozenset((token_hour, token_minute,
2175
token_second)))
2176
token_day = Token(re.compile(r"(\d+)D"),
2177
datetime.timedelta(days=1),
2178
frozenset((token_time, token_end)))
2179
token_month = Token(re.compile(r"(\d+)M"),
2180
datetime.timedelta(weeks=4),
2181
frozenset((token_day, token_end)))
2182
token_year = Token(re.compile(r"(\d+)Y"),
2183
datetime.timedelta(weeks=52),
2184
frozenset((token_month, token_end)))
2185
token_week = Token(re.compile(r"(\d+)W"),
2186
datetime.timedelta(weeks=1),
2187
frozenset((token_end,)))
2188
token_duration = Token(re.compile(r"P"), None,
2189
frozenset((token_year, token_month,
2190
token_day, token_time,
2191
token_week))),
2192
# Define starting values
2193
value = datetime.timedelta() # Value so far
2194
found_token = None
2195
followers = frozenset(token_duration,) # Following valid tokens
2196
s = duration # String left to parse
2197
# Loop until end token is found
2198
while found_token is not token_end:
2199
# Search for any currently valid tokens
2200
for token in followers:
2201
match = token.regexp.match(s)
2202
if match is not None:
2203
# Token found
2204
if token.value is not None:
2205
# Value found, parse digits
2206
factor = int(match.group(1), 10)
2207
# Add to value so far
2208
value += factor * token.value
2209
# Strip token from string
2210
s = token.regexp.sub("", s, 1)
2211
# Go to found token
2212
found_token = token
2213
# Set valid next tokens
2214
followers = found_token.followers
2215
break
2216
else:
2217
# No currently valid tokens were found
2218
raise ValueError("Invalid RFC 3339 duration")
2219
# End token found
2220
return value
2221
2222
1582
2223
def string_to_delta(interval):
1583
2224
"""Parse a string and return a datetime.timedelta
1584
2225
1585
>>> string_to_delta(u'7d')
2226
>>> string_to_delta('7d')
1586
2227
datetime.timedelta(7)
1587
>>> string_to_delta(u'60s')
2228
>>> string_to_delta('60s')
1588
2229
datetime.timedelta(0, 60)
1589
>>> string_to_delta(u'60m')
2230
>>> string_to_delta('60m')
1590
2231
datetime.timedelta(0, 3600)
1591
>>> string_to_delta(u'24h')
2232
>>> string_to_delta('24h')
1592
2233
datetime.timedelta(1)
1593
>>> string_to_delta(u'1w')
2234
>>> string_to_delta('1w')
1594
2235
datetime.timedelta(7)
1595
>>> string_to_delta(u'5m 30s')
2236
>>> string_to_delta('5m 30s')
1596
2237
datetime.timedelta(0, 330)
1597
2238
"""
2239
2240
try:
2241
return rfc3339_duration_to_delta(interval)
2242
except ValueError:
2243
pass
2244
1598
2245
timevalue = datetime.timedelta(0)
1599
2246
for s in interval.split():
1600
2247
try:
1601
2248
suffix = unicode(s[-1])
1602
2249
value = int(s[:-1])
1603
if suffix == u"d":
2250
if suffix == "d":
1604
2251
delta = datetime.timedelta(value)
1605
elif suffix == u"s":
2252
elif suffix == "s":
1606
2253
delta = datetime.timedelta(0, value)
1607
elif suffix == u"m":
2254
elif suffix == "m":
1608
2255
delta = datetime.timedelta(0, 0, 0, 0, value)
1609
elif suffix == u"h":
2256
elif suffix == "h":
1610
2257
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1611
elif suffix == u"w":
2258
elif suffix == "w":
1612
2259
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1613
2260
else:
1614
raise ValueError(u"Unknown suffix %r" % suffix)
1615
except (ValueError, IndexError), e:
1616
raise ValueError(e.message)
2261
raise ValueError("Unknown suffix {0!r}"
2262
.format(suffix))
2263
except IndexError as e:
2264
raise ValueError(*(e.args))
1617
2265
timevalue += delta
1618
2266
return timevalue
1619
2267
1620
2268
1621
def if_nametoindex(interface):
1622
"""Call the C function if_nametoindex(), or equivalent
1623
1624
Note: This function cannot accept a unicode string."""
1625
global if_nametoindex
1626
try:
1627
if_nametoindex = (ctypes.cdll.LoadLibrary
1628
(ctypes.util.find_library(u"c"))
1629
.if_nametoindex)
1630
except (OSError, AttributeError):
1631
logger.warning(u"Doing if_nametoindex the hard way")
1632
def if_nametoindex(interface):
1633
"Get an interface index the hard way, i.e. using fcntl()"
1634
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1635
with contextlib.closing(socket.socket()) as s:
1636
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1637
struct.pack(str(u"16s16x"),
1638
interface))
1639
interface_index = struct.unpack(str(u"I"),
1640
ifreq[16:20])[0]
1641
return interface_index
1642
return if_nametoindex(interface)
1643
1644
1645
2269
def daemon(nochdir = False, noclose = False):
1646
2270
"""See daemon(3). Standard BSD Unix function.
1647
2271
1650
2274
sys.exit()
1651
2275
os.setsid()
1652
2276
if not nochdir:
1653
os.chdir(u"/")
2277
os.chdir("/")
1654
2278
if os.fork():
1655
2279
sys.exit()
1656
2280
if not noclose:
1657
2281
# Close all standard open file descriptors
1658
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2282
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1659
2283
if not stat.S_ISCHR(os.fstat(null).st_mode):
1660
2284
raise OSError(errno.ENODEV,
1661
u"%s not a character device"
1662
% os.path.devnull)
2285
"{0} not a character device"
2286
.format(os.devnull))
1663
2287
os.dup2(null, sys.stdin.fileno())
1664
2288
os.dup2(null, sys.stdout.fileno())
1665
2289
os.dup2(null, sys.stderr.fileno())
1672
2296
##################################################################
1673
2297
# Parsing of options, both command line and config file
1674
2298
1675
parser = optparse.OptionParser(version = "%%prog %s" % version)
1676
parser.add_option("-i", u"--interface", type=u"string",
1677
metavar="IF", help=u"Bind to interface IF")
1678
parser.add_option("-a", u"--address", type=u"string",
1679
help=u"Address to listen for requests on")
1680
parser.add_option("-p", u"--port", type=u"int",
1681
help=u"Port number to receive requests on")
1682
parser.add_option("--check", action=u"store_true",
1683
help=u"Run self-test")
1684
parser.add_option("--debug", action=u"store_true",
1685
help=u"Debug mode; run in foreground and log to"
1686
u" terminal")
1687
parser.add_option("--debuglevel", type=u"string", metavar="LEVEL",
1688
help=u"Debug level for stdout output")
1689
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1690
u" priority string (see GnuTLS documentation)")
1691
parser.add_option("--servicename", type=u"string",
1692
metavar=u"NAME", help=u"Zeroconf service name")
1693
parser.add_option("--configdir", type=u"string",
1694
default=u"/etc/mandos", metavar=u"DIR",
1695
help=u"Directory to search for configuration"
1696
u" files")
1697
parser.add_option("--no-dbus", action=u"store_false",
1698
dest=u"use_dbus", help=u"Do not provide D-Bus"
1699
u" system bus interface")
1700
parser.add_option("--no-ipv6", action=u"store_false",
1701
dest=u"use_ipv6", help=u"Do not use IPv6")
1702
options = parser.parse_args()[0]
2299
parser = argparse.ArgumentParser()
2300
parser.add_argument("-v", "--version", action="version",
2301
version = "%(prog)s {0}".format(version),
2302
help="show version number and exit")
2303
parser.add_argument("-i", "--interface", metavar="IF",
2304
help="Bind to interface IF")
2305
parser.add_argument("-a", "--address",
2306
help="Address to listen for requests on")
2307
parser.add_argument("-p", "--port", type=int,
2308
help="Port number to receive requests on")
2309
parser.add_argument("--check", action="store_true",
2310
help="Run self-test")
2311
parser.add_argument("--debug", action="store_true",
2312
help="Debug mode; run in foreground and log"
2313
" to terminal", default=None)
2314
parser.add_argument("--debuglevel", metavar="LEVEL",
2315
help="Debug level for stdout output")
2316
parser.add_argument("--priority", help="GnuTLS"
2317
" priority string (see GnuTLS documentation)")
2318
parser.add_argument("--servicename",
2319
metavar="NAME", help="Zeroconf service name")
2320
parser.add_argument("--configdir",
2321
default="/etc/mandos", metavar="DIR",
2322
help="Directory to search for configuration"
2323
" files")
2324
parser.add_argument("--no-dbus", action="store_false",
2325
dest="use_dbus", help="Do not provide D-Bus"
2326
" system bus interface", default=None)
2327
parser.add_argument("--no-ipv6", action="store_false",
2328
dest="use_ipv6", help="Do not use IPv6",
2329
default=None)
2330
parser.add_argument("--no-restore", action="store_false",
2331
dest="restore", help="Do not restore stored"
2332
" state", default=None)
2333
parser.add_argument("--socket", type=int,
2334
help="Specify a file descriptor to a network"
2335
" socket to use instead of creating one")
2336
parser.add_argument("--statedir", metavar="DIR",
2337
help="Directory to save/restore state in")
2338
parser.add_argument("--foreground", action="store_true",
2339
help="Run in foreground", default=None)
2340
parser.add_argument("--no-zeroconf", action="store_false",
2341
dest="zeroconf", help="Do not use Zeroconf",
2342
default=None)
2343
2344
options = parser.parse_args()
1703
2345
1704
2346
if options.check:
1705
2347
import doctest
1706
doctest.testmod()
1707
sys.exit()
2348
fail_count, test_count = doctest.testmod()
2349
sys.exit(os.EX_OK if fail_count == 0 else 1)
1708
2350
1709
2351
# Default values for config file for server-global settings
1710
server_defaults = { u"interface": u"",
1711
u"address": u"",
1712
u"port": u"",
1713
u"debug": u"False",
1714
u"priority":
1715
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1716
u"servicename": u"Mandos",
1717
u"use_dbus": u"True",
1718
u"use_ipv6": u"True",
1719
u"debuglevel": u"",
2352
server_defaults = { "interface": "",
2353
"address": "",
2354
"port": "",
2355
"debug": "False",
2356
"priority":
2357
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2358
"servicename": "Mandos",
2359
"use_dbus": "True",
2360
"use_ipv6": "True",
2361
"debuglevel": "",
2362
"restore": "True",
2363
"socket": "",
2364
"statedir": "/var/lib/mandos",
2365
"foreground": "False",
2366
"zeroconf": "True",
1720
2367
}
1721
2368
1722
2369
# Parse config file for server-global settings
1723
2370
server_config = configparser.SafeConfigParser(server_defaults)
1724
2371
del server_defaults
1725
2372
server_config.read(os.path.join(options.configdir,
1726
u"mandos.conf"))
2373
"mandos.conf"))
1727
2374
# Convert the SafeConfigParser object to a dict
1728
2375
server_settings = server_config.defaults()
1729
2376
# Use the appropriate methods on the non-string config options
1730
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1731
server_settings[option] = server_config.getboolean(u"DEFAULT",
2377
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2378
server_settings[option] = server_config.getboolean("DEFAULT",
1732
2379
option)
1733
2380
if server_settings["port"]:
1734
server_settings["port"] = server_config.getint(u"DEFAULT",
1735
u"port")
2381
server_settings["port"] = server_config.getint("DEFAULT",
2382
"port")
2383
if server_settings["socket"]:
2384
server_settings["socket"] = server_config.getint("DEFAULT",
2385
"socket")
2386
# Later, stdin will, and stdout and stderr might, be dup'ed
2387
# over with an opened os.devnull. But we don't want this to
2388
# happen with a supplied network socket.
2389
if 0 <= server_settings["socket"] <= 2:
2390
server_settings["socket"] = os.dup(server_settings
2391
["socket"])
1736
2392
del server_config
1737
2393
1738
2394
# Override the settings from the config file with command line
1739
2395
# options, if set.
1740
for option in (u"interface", u"address", u"port", u"debug",
1741
u"priority", u"servicename", u"configdir",
1742
u"use_dbus", u"use_ipv6", u"debuglevel"):
2396
for option in ("interface", "address", "port", "debug",
2397
"priority", "servicename", "configdir",
2398
"use_dbus", "use_ipv6", "debuglevel", "restore",
2399
"statedir", "socket", "foreground", "zeroconf"):
1743
2400
value = getattr(options, option)
1744
2401
if value is not None:
1745
2402
server_settings[option] = value
1748
2405
for option in server_settings.keys():
1749
2406
if type(server_settings[option]) is str:
1750
2407
server_settings[option] = unicode(server_settings[option])
2408
# Force all boolean options to be boolean
2409
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2410
"foreground", "zeroconf"):
2411
server_settings[option] = bool(server_settings[option])
2412
# Debug implies foreground
2413
if server_settings["debug"]:
2414
server_settings["foreground"] = True
1751
2415
# Now we have our good server settings in "server_settings"
1752
2416
1753
2417
##################################################################
1754
2418
2419
if (not server_settings["zeroconf"] and
2420
not (server_settings["port"]
2421
or server_settings["socket"] != "")):
2422
parser.error("Needs port or socket to work without"
2423
" Zeroconf")
2424
1755
2425
# For convenience
1756
debug = server_settings[u"debug"]
1757
debuglevel = server_settings[u"debuglevel"]
1758
use_dbus = server_settings[u"use_dbus"]
1759
use_ipv6 = server_settings[u"use_ipv6"]
1760
1761
if server_settings[u"servicename"] != u"Mandos":
2426
debug = server_settings["debug"]
2427
debuglevel = server_settings["debuglevel"]
2428
use_dbus = server_settings["use_dbus"]
2429
use_ipv6 = server_settings["use_ipv6"]
2430
stored_state_path = os.path.join(server_settings["statedir"],
2431
stored_state_file)
2432
foreground = server_settings["foreground"]
2433
zeroconf = server_settings["zeroconf"]
2434
2435
if debug:
2436
initlogger(debug, logging.DEBUG)
2437
else:
2438
if not debuglevel:
2439
initlogger(debug)
2440
else:
2441
level = getattr(logging, debuglevel.upper())
2442
initlogger(debug, level)
2443
2444
if server_settings["servicename"] != "Mandos":
1762
2445
syslogger.setFormatter(logging.Formatter
1763
(u'Mandos (%s) [%%(process)d]:'
1764
u' %%(levelname)s: %%(message)s'
1765
% server_settings[u"servicename"]))
2446
('Mandos ({0}) [%(process)d]:'
2447
' %(levelname)s: %(message)s'
2448
.format(server_settings
2449
["servicename"])))
1766
2450
1767
2451
# Parse config file with clients
1768
client_defaults = { u"timeout": u"1h",
1769
u"interval": u"5m",
1770
u"checker": u"fping -q -- %%(host)s",
1771
u"host": u"",
1772
u"approval_delay": u"0s",
1773
u"approval_duration": u"1s",
1774
}
1775
client_config = configparser.SafeConfigParser(client_defaults)
1776
client_config.read(os.path.join(server_settings[u"configdir"],
1777
u"clients.conf"))
2452
client_config = configparser.SafeConfigParser(Client
2453
.client_defaults)
2454
client_config.read(os.path.join(server_settings["configdir"],
2455
"clients.conf"))
1778
2456
1779
2457
global mandos_dbus_service
1780
2458
mandos_dbus_service = None
1781
2459
1782
tcp_server = MandosServer((server_settings[u"address"],
1783
server_settings[u"port"]),
2460
socketfd = None
2461
if server_settings["socket"] != "":
2462
socketfd = server_settings["socket"]
2463
tcp_server = MandosServer((server_settings["address"],
2464
server_settings["port"]),
1784
2465
ClientHandler,
1785
interface=(server_settings[u"interface"]
2466
interface=(server_settings["interface"]
1786
2467
or None),
1787
2468
use_ipv6=use_ipv6,
1788
2469
gnutls_priority=
1789
server_settings[u"priority"],
1790
use_dbus=use_dbus)
1791
if not debug:
1792
pidfilename = u"/var/run/mandos.pid"
2470
server_settings["priority"],
2471
use_dbus=use_dbus,
2472
socketfd=socketfd)
2473
if not foreground:
2474
pidfilename = "/run/mandos.pid"
2475
if not os.path.isdir("/run/."):
2476
pidfilename = "/var/run/mandos.pid"
2477
pidfile = None
1793
2478
try:
1794
pidfile = open(pidfilename, u"w")
1795
except IOError:
1796
logger.error(u"Could not open file %r", pidfilename)
2479
pidfile = open(pidfilename, "w")
2480
except IOError as e:
2481
logger.error("Could not open file %r", pidfilename,
2482
exc_info=e)
1797
2483
1798
try:
1799
uid = pwd.getpwnam(u"_mandos").pw_uid
1800
gid = pwd.getpwnam(u"_mandos").pw_gid
1801
except KeyError:
2484
for name in ("_mandos", "mandos", "nobody"):
1802
2485
try:
1803
uid = pwd.getpwnam(u"mandos").pw_uid
1804
gid = pwd.getpwnam(u"mandos").pw_gid
2486
uid = pwd.getpwnam(name).pw_uid
2487
gid = pwd.getpwnam(name).pw_gid
2488
break
1805
2489
except KeyError:
1806
try:
1807
uid = pwd.getpwnam(u"nobody").pw_uid
1808
gid = pwd.getpwnam(u"nobody").pw_gid
1809
except KeyError:
1810
uid = 65534
1811
gid = 65534
2490
continue
2491
else:
2492
uid = 65534
2493
gid = 65534
1812
2494
try:
1813
2495
os.setgid(gid)
1814
2496
os.setuid(uid)
1815
except OSError, error:
1816
if error[0] != errno.EPERM:
1817
raise error
2497
except OSError as error:
2498
if error.errno != errno.EPERM:
2499
raise
1818
2500
1819
if not debug and not debuglevel:
1820
syslogger.setLevel(logging.WARNING)
1821
console.setLevel(logging.WARNING)
1822
if debuglevel:
1823
level = getattr(logging, debuglevel.upper())
1824
syslogger.setLevel(level)
1825
console.setLevel(level)
1826
1827
2501
if debug:
1828
2502
# Enable all possible GnuTLS debugging
1829
2503
1833
2507
1834
2508
@gnutls.library.types.gnutls_log_func
1835
2509
def debug_gnutls(level, string):
1836
logger.debug(u"GnuTLS: %s", string[:-1])
2510
logger.debug("GnuTLS: %s", string[:-1])
1837
2511
1838
2512
(gnutls.library.functions
1839
2513
.gnutls_global_set_log_function(debug_gnutls))
1840
2514
1841
2515
# Redirect stdin so all checkers get /dev/null
1842
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2516
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1843
2517
os.dup2(null, sys.stdin.fileno())
1844
2518
if null > 2:
1845
2519
os.close(null)
1846
else:
1847
# No console logging
1848
logger.removeHandler(console)
1849
2520
2521
# Need to fork before connecting to D-Bus
2522
if not foreground:
2523
# Close all input and output, do double fork, etc.
2524
daemon()
2525
2526
# multiprocessing will use threads, so before we use gobject we
2527
# need to inform gobject that threads will be used.
2528
gobject.threads_init()
1850
2529
1851
2530
global main_loop
1852
2531
# From the Avahi example code
1853
DBusGMainLoop(set_as_default=True )
2532
DBusGMainLoop(set_as_default=True)
1854
2533
main_loop = gobject.MainLoop()
1855
2534
bus = dbus.SystemBus()
1856
2535
# End of Avahi example code
1857
2536
if use_dbus:
1858
2537
try:
1859
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2538
bus_name = dbus.service.BusName("se.recompile.Mandos",
1860
2539
bus, do_not_queue=True)
1861
except dbus.exceptions.NameExistsException, e:
1862
logger.error(unicode(e) + u", disabling D-Bus")
2540
old_bus_name = (dbus.service.BusName
2541
("se.bsnet.fukt.Mandos", bus,
2542
do_not_queue=True))
2543
except dbus.exceptions.NameExistsException as e:
2544
logger.error("Disabling D-Bus:", exc_info=e)
1863
2545
use_dbus = False
1864
server_settings[u"use_dbus"] = False
2546
server_settings["use_dbus"] = False
1865
2547
tcp_server.use_dbus = False
1866
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1867
service = AvahiService(name = server_settings[u"servicename"],
1868
servicetype = u"_mandos._tcp",
1869
protocol = protocol, bus = bus)
1870
if server_settings["interface"]:
1871
service.interface = (if_nametoindex
1872
(str(server_settings[u"interface"])))
1873
1874
if not debug:
1875
# Close all input and output, do double fork, etc.
1876
daemon()
1877
2548
if zeroconf:
2549
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2550
service = AvahiServiceToSyslog(name =
2551
server_settings["servicename"],
2552
servicetype = "_mandos._tcp",
2553
protocol = protocol, bus = bus)
2554
if server_settings["interface"]:
2555
service.interface = (if_nametoindex
2556
(str(server_settings["interface"])))
2557
1878
2558
global multiprocessing_manager
1879
2559
multiprocessing_manager = multiprocessing.Manager()
1880
2560
1881
2561
client_class = Client
1882
2562
if use_dbus:
1883
2563
client_class = functools.partial(ClientDBus, bus = bus)
1884
def client_config_items(config, section):
1885
special_settings = {
1886
"approved_by_default":
1887
lambda: config.getboolean(section,
1888
"approved_by_default"),
1889
}
1890
for name, value in config.items(section):
2564
2565
client_settings = Client.config_parser(client_config)
2566
old_client_settings = {}
2567
clients_data = {}
2568
2569
# This is used to redirect stdout and stderr for checker processes
2570
global wnull
2571
wnull = open(os.devnull, "w") # A writable /dev/null
2572
# Only used if server is running in foreground but not in debug
2573
# mode
2574
if debug or not foreground:
2575
wnull.close()
2576
2577
# Get client data and settings from last running state.
2578
if server_settings["restore"]:
2579
try:
2580
with open(stored_state_path, "rb") as stored_state:
2581
clients_data, old_client_settings = (pickle.load
2582
(stored_state))
2583
os.remove(stored_state_path)
2584
except IOError as e:
2585
if e.errno == errno.ENOENT:
2586
logger.warning("Could not load persistent state: {0}"
2587
.format(os.strerror(e.errno)))
2588
else:
2589
logger.critical("Could not load persistent state:",
2590
exc_info=e)
2591
raise
2592
except EOFError as e:
2593
logger.warning("Could not load persistent state: "
2594
"EOFError:", exc_info=e)
2595
2596
with PGPEngine() as pgp:
2597
for client_name, client in clients_data.iteritems():
2598
# Skip removed clients
2599
if client_name not in client_settings:
2600
continue
2601
2602
# Decide which value to use after restoring saved state.
2603
# We have three different values: Old config file,
2604
# new config file, and saved state.
2605
# New config value takes precedence if it differs from old
2606
# config value, otherwise use saved state.
2607
for name, value in client_settings[client_name].items():
2608
try:
2609
# For each value in new config, check if it
2610
# differs from the old config value (Except for
2611
# the "secret" attribute)
2612
if (name != "secret" and
2613
value != old_client_settings[client_name]
2614
[name]):
2615
client[name] = value
2616
except KeyError:
2617
pass
2618
2619
# Clients who has passed its expire date can still be
2620
# enabled if its last checker was successful. Clients
2621
# whose checker succeeded before we stored its state is
2622
# assumed to have successfully run all checkers during
2623
# downtime.
2624
if client["enabled"]:
2625
if datetime.datetime.utcnow() >= client["expires"]:
2626
if not client["last_checked_ok"]:
2627
logger.warning(
2628
"disabling client {0} - Client never "
2629
"performed a successful checker"
2630
.format(client_name))
2631
client["enabled"] = False
2632
elif client["last_checker_status"] != 0:
2633
logger.warning(
2634
"disabling client {0} - Client "
2635
"last checker failed with error code {1}"
2636
.format(client_name,
2637
client["last_checker_status"]))
2638
client["enabled"] = False
2639
else:
2640
client["expires"] = (datetime.datetime
2641
.utcnow()
2642
+ client["timeout"])
2643
logger.debug("Last checker succeeded,"
2644
" keeping {0} enabled"
2645
.format(client_name))
1891
2646
try:
1892
yield (name, special_settings[name]())
1893
except KeyError:
1894
yield (name, value)
1895
1896
tcp_server.clients.update(set(
1897
client_class(name = section,
1898
config= dict(client_config_items(
1899
client_config, section)))
1900
for section in client_config.sections()))
2647
client["secret"] = (
2648
pgp.decrypt(client["encrypted_secret"],
2649
client_settings[client_name]
2650
["secret"]))
2651
except PGPError:
2652
# If decryption fails, we use secret from new settings
2653
logger.debug("Failed to decrypt {0} old secret"
2654
.format(client_name))
2655
client["secret"] = (
2656
client_settings[client_name]["secret"])
2657
2658
# Add/remove clients based on new changes made to config
2659
for client_name in (set(old_client_settings)
2660
- set(client_settings)):
2661
del clients_data[client_name]
2662
for client_name in (set(client_settings)
2663
- set(old_client_settings)):
2664
clients_data[client_name] = client_settings[client_name]
2665
2666
# Create all client objects
2667
for client_name, client in clients_data.iteritems():
2668
tcp_server.clients[client_name] = client_class(
2669
name = client_name, settings = client,
2670
server_settings = server_settings)
2671
1901
2672
if not tcp_server.clients:
1902
logger.warning(u"No clients defined")
1903
1904
if not debug:
1905
try:
1906
with pidfile:
1907
pid = os.getpid()
1908
pidfile.write(str(pid) + "\n")
1909
del pidfile
1910
except IOError:
1911
logger.error(u"Could not write to file %r with PID %d",
1912
pidfilename, pid)
1913
except NameError:
1914
# "pidfile" was never created
1915
pass
2673
logger.warning("No clients defined")
2674
2675
if not foreground:
2676
if pidfile is not None:
2677
try:
2678
with pidfile:
2679
pid = os.getpid()
2680
pidfile.write(str(pid) + "\n".encode("utf-8"))
2681
except IOError:
2682
logger.error("Could not write to file %r with PID %d",
2683
pidfilename, pid)
2684
del pidfile
1916
2685
del pidfilename
1917
1918
signal.signal(signal.SIGINT, signal.SIG_IGN)
1919
2686
1920
2687
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1921
2688
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1922
2689
1923
2690
if use_dbus:
1924
class MandosDBusService(dbus.service.Object):
2691
@alternate_dbus_interfaces({"se.recompile.Mandos":
2692
"se.bsnet.fukt.Mandos"})
2693
class MandosDBusService(DBusObjectWithProperties):
1925
2694
"""A D-Bus proxy object"""
1926
2695
def __init__(self):
1927
dbus.service.Object.__init__(self, bus, u"/")
1928
_interface = u"se.bsnet.fukt.Mandos"
1929
1930
@dbus.service.signal(_interface, signature=u"o")
2696
dbus.service.Object.__init__(self, bus, "/")
2697
_interface = "se.recompile.Mandos"
2698
2699
@dbus_interface_annotations(_interface)
2700
def _foo(self):
2701
return { "org.freedesktop.DBus.Property"
2702
".EmitsChangedSignal":
2703
"false"}
2704
2705
@dbus.service.signal(_interface, signature="o")
1931
2706
def ClientAdded(self, objpath):
1932
2707
"D-Bus signal"
1933
2708
pass
1934
2709
1935
@dbus.service.signal(_interface, signature=u"ss")
2710
@dbus.service.signal(_interface, signature="ss")
1936
2711
def ClientNotFound(self, fingerprint, address):
1937
2712
"D-Bus signal"
1938
2713
pass
1939
2714
1940
@dbus.service.signal(_interface, signature=u"os")
2715
@dbus.service.signal(_interface, signature="os")
1941
2716
def ClientRemoved(self, objpath, name):
1942
2717
"D-Bus signal"
1943
2718
pass
1944
2719
1945
@dbus.service.method(_interface, out_signature=u"ao")
2720
@dbus.service.method(_interface, out_signature="ao")
1946
2721
def GetAllClients(self):
1947
2722
"D-Bus method"
1948
2723
return dbus.Array(c.dbus_object_path
1949
for c in tcp_server.clients)
2724
for c in
2725
tcp_server.clients.itervalues())
1950
2726
1951
2727
@dbus.service.method(_interface,
1952
out_signature=u"a{oa{sv}}")
2728
out_signature="a{oa{sv}}")
1953
2729
def GetAllClientsWithProperties(self):
1954
2730
"D-Bus method"
1955
2731
return dbus.Dictionary(
1956
((c.dbus_object_path, c.GetAll(u""))
1957
for c in tcp_server.clients),
1958
signature=u"oa{sv}")
2732
((c.dbus_object_path, c.GetAll(""))
2733
for c in tcp_server.clients.itervalues()),
2734
signature="oa{sv}")
1959
2735
1960
@dbus.service.method(_interface, in_signature=u"o")
2736
@dbus.service.method(_interface, in_signature="o")
1961
2737
def RemoveClient(self, object_path):
1962
2738
"D-Bus method"
1963
for c in tcp_server.clients:
2739
for c in tcp_server.clients.itervalues():
1964
2740
if c.dbus_object_path == object_path:
1965
tcp_server.clients.remove(c)
2741
del tcp_server.clients[c.name]
1966
2742
c.remove_from_connection()
1967
2743
# Don't signal anything except ClientRemoved
1968
2744
c.disable(quiet=True)
1977
2753
1978
2754
def cleanup():
1979
2755
"Cleanup function; run on exit"
1980
service.cleanup()
1981
2756
if zeroconf:
2757
service.cleanup()
2758
2759
multiprocessing.active_children()
2760
wnull.close()
2761
if not (tcp_server.clients or client_settings):
2762
return
2763
2764
# Store client before exiting. Secrets are encrypted with key
2765
# based on what config file has. If config file is
2766
# removed/edited, old secret will thus be unrecovable.
2767
clients = {}
2768
with PGPEngine() as pgp:
2769
for client in tcp_server.clients.itervalues():
2770
key = client_settings[client.name]["secret"]
2771
client.encrypted_secret = pgp.encrypt(client.secret,
2772
key)
2773
client_dict = {}
2774
2775
# A list of attributes that can not be pickled
2776
# + secret.
2777
exclude = set(("bus", "changedstate", "secret",
2778
"checker", "server_settings"))
2779
for name, typ in (inspect.getmembers
2780
(dbus.service.Object)):
2781
exclude.add(name)
2782
2783
client_dict["encrypted_secret"] = (client
2784
.encrypted_secret)
2785
for attr in client.client_structure:
2786
if attr not in exclude:
2787
client_dict[attr] = getattr(client, attr)
2788
2789
clients[client.name] = client_dict
2790
del client_settings[client.name]["secret"]
2791
2792
try:
2793
with (tempfile.NamedTemporaryFile
2794
(mode='wb', suffix=".pickle", prefix='clients-',
2795
dir=os.path.dirname(stored_state_path),
2796
delete=False)) as stored_state:
2797
pickle.dump((clients, client_settings), stored_state)
2798
tempname=stored_state.name
2799
os.rename(tempname, stored_state_path)
2800
except (IOError, OSError) as e:
2801
if not debug:
2802
try:
2803
os.remove(tempname)
2804
except NameError:
2805
pass
2806
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2807
logger.warning("Could not save persistent state: {0}"
2808
.format(os.strerror(e.errno)))
2809
else:
2810
logger.warning("Could not save persistent state:",
2811
exc_info=e)
2812
raise
2813
2814
# Delete all clients, and settings from config
1982
2815
while tcp_server.clients:
1983
client = tcp_server.clients.pop()
2816
name, client = tcp_server.clients.popitem()
1984
2817
if use_dbus:
1985
2818
client.remove_from_connection()
1986
client.disable_hook = None
1987
2819
# Don't signal anything except ClientRemoved
1988
2820
client.disable(quiet=True)
1989
2821
if use_dbus:
1990
2822
# Emit D-Bus signal
1991
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2823
mandos_dbus_service.ClientRemoved(client
2824
.dbus_object_path,
1992
2825
client.name)
2826
client_settings.clear()
1993
2827
1994
2828
atexit.register(cleanup)
1995
2829
1996
for client in tcp_server.clients:
2830
for client in tcp_server.clients.itervalues():
1997
2831
if use_dbus:
1998
2832
# Emit D-Bus signal
1999
2833
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2000
client.enable()
2834
# Need to initiate checking of clients
2835
if client.enabled:
2836
client.init_checker()
2001
2837
2002
2838
tcp_server.enable()
2003
2839
tcp_server.server_activate()
2004
2840
2005
2841
# Find out what port we got
2006
service.port = tcp_server.socket.getsockname()[1]
2842
if zeroconf:
2843
service.port = tcp_server.socket.getsockname()[1]
2007
2844
if use_ipv6:
2008
logger.info(u"Now listening on address %r, port %d,"
2009
" flowinfo %d, scope_id %d"
2010
% tcp_server.socket.getsockname())
2845
logger.info("Now listening on address %r, port %d,"
2846
" flowinfo %d, scope_id %d",
2847
*tcp_server.socket.getsockname())
2011
2848
else: # IPv4
2012
logger.info(u"Now listening on address %r, port %d"
2013
% tcp_server.socket.getsockname())
2849
logger.info("Now listening on address %r, port %d",
2850
*tcp_server.socket.getsockname())
2014
2851
2015
2852
#service.interface = tcp_server.socket.getsockname()[3]
2016
2853
2017
2854
try:
2018
# From the Avahi example code
2019
try:
2020
service.activate()
2021
except dbus.exceptions.DBusException, error:
2022
logger.critical(u"DBusException: %s", error)
2023
cleanup()
2024
sys.exit(1)
2025
# End of Avahi example code
2855
if zeroconf:
2856
# From the Avahi example code
2857
try:
2858
service.activate()
2859
except dbus.exceptions.DBusException as error:
2860
logger.critical("D-Bus Exception", exc_info=error)
2861
cleanup()
2862
sys.exit(1)
2863
# End of Avahi example code
2026
2864
2027
2865
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2028
2866
lambda *args, **kwargs:
2029
2867
(tcp_server.handle_request
2030
2868
(*args[2:], **kwargs) or True))
2031
2869
2032
logger.debug(u"Starting main loop")
2870
logger.debug("Starting main loop")
2033
2871
main_loop.run()
2034
except AvahiError, error:
2035
logger.critical(u"AvahiError: %s", error)
2872
except AvahiError as error:
2873
logger.critical("Avahi Error", exc_info=error)
2036
2874
cleanup()
2037
2875
sys.exit(1)
2038
2876
except KeyboardInterrupt:
2039
2877
if debug:
2040
print >> sys.stderr
2041
logger.debug(u"Server received KeyboardInterrupt")
2042
logger.debug(u"Server exiting")
2878
print("", file=sys.stderr)
2879
logger.debug("Server received KeyboardInterrupt")
2880
logger.debug("Server exiting")
2043
2881
# Must run before the D-Bus bus name gets deregistered
2044
2882
cleanup()
2045
2883
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0