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