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 609
- compare with another revision
- download diff
- download tarball
- view history from revision 609
- Committer: Teddy Hogeborn
- Date: 2012-06-23 00:58:49 UTC
- Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
duration.
(rfc3339_duration_to_delta): New function.
(string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
(EXAMPLE): Update to new interval format.
(SEE ALSO): Reference RFC 3339.
* mandos: All client options for time intervals now take an RFC 3339
duration.
(rfc3339_duration_to_delta): New function.
(string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
(EXAMPLE): Update to new interval format.
(SEE ALSO): Reference RFC 3339.
- 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.0.14"
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.
495
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)
716
shell=True, cwd="/")
717
except OSError as error:
718
logger.error("Failed to start subprocess",
719
exc_info=error)
720
self.checker_callback_tag = (gobject.child_watch_add
721
(self.checker.pid,
722
self.checker_callback,
723
data=command))
724
# The checker may have completed before the gobject
725
# watch was added. Check for this.
726
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
727
if pid:
728
gobject.source_remove(self.checker_callback_tag)
729
self.checker_callback(pid, status, command)
502
730
# Re-run this periodically if run by gobject.timeout_add
503
731
return True
504
732
507
735
if self.checker_callback_tag:
508
736
gobject.source_remove(self.checker_callback_tag)
509
737
self.checker_callback_tag = None
510
if getattr(self, u"checker", None) is None:
738
if getattr(self, "checker", None) is None:
511
739
return
512
logger.debug(u"Stopping checker for %(name)s", vars(self))
740
logger.debug("Stopping checker for %(name)s", vars(self))
513
741
try:
514
os.kill(self.checker.pid, signal.SIGTERM)
742
self.checker.terminate()
515
743
#time.sleep(0.5)
516
744
#if self.checker.poll() is None:
517
# os.kill(self.checker.pid, signal.SIGKILL)
518
except OSError, error:
745
# self.checker.kill()
746
except OSError as error:
519
747
if error.errno != errno.ESRCH: # No such process
520
748
raise
521
749
self.checker = None
522
750
523
def dbus_service_property(dbus_interface, signature=u"v",
524
access=u"readwrite", byte_arrays=False):
751
752
def dbus_service_property(dbus_interface, signature="v",
753
access="readwrite", byte_arrays=False):
525
754
"""Decorators for marking methods of a DBusObjectWithProperties to
526
755
become properties on the D-Bus.
527
756
534
763
"""
535
764
# Encoding deeply encoded byte arrays is not supported yet by the
536
765
# "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)
766
if byte_arrays and signature != "ay":
767
raise ValueError("Byte arrays not supported for non-'ay'"
768
" signature {0!r}".format(signature))
540
769
def decorator(func):
541
770
func._dbus_is_property = True
542
771
func._dbus_interface = dbus_interface
543
772
func._dbus_signature = signature
544
773
func._dbus_access = access
545
774
func._dbus_name = func.__name__
546
if func._dbus_name.endswith(u"_dbus_property"):
775
if func._dbus_name.endswith("_dbus_property"):
547
776
func._dbus_name = func._dbus_name[:-14]
548
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
777
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
778
return func
779
return decorator
780
781
782
def dbus_interface_annotations(dbus_interface):
783
"""Decorator for marking functions returning interface annotations
784
785
Usage:
786
787
@dbus_interface_annotations("org.example.Interface")
788
def _foo(self): # Function name does not matter
789
return {"org.freedesktop.DBus.Deprecated": "true",
790
"org.freedesktop.DBus.Property.EmitsChangedSignal":
791
"false"}
792
"""
793
def decorator(func):
794
func._dbus_is_interface = True
795
func._dbus_interface = dbus_interface
796
func._dbus_name = dbus_interface
797
return func
798
return decorator
799
800
801
def dbus_annotations(annotations):
802
"""Decorator to annotate D-Bus methods, signals or properties
803
Usage:
804
805
@dbus_service_property("org.example.Interface", signature="b",
806
access="r")
807
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
808
"org.freedesktop.DBus.Property."
809
"EmitsChangedSignal": "false"})
810
def Property_dbus_property(self):
811
return dbus.Boolean(False)
812
"""
813
def decorator(func):
814
func._dbus_annotations = annotations
549
815
return func
550
816
return decorator
551
817
571
837
572
838
class DBusObjectWithProperties(dbus.service.Object):
573
839
"""A D-Bus object with properties.
574
840
575
841
Classes inheriting from this can use the dbus_service_property
576
842
decorator to expose methods as D-Bus properties. It exposes the
577
843
standard Get(), Set(), and GetAll() methods on the D-Bus.
578
844
"""
579
845
580
846
@staticmethod
581
def _is_dbus_property(obj):
582
return getattr(obj, u"_dbus_is_property", False)
847
def _is_dbus_thing(thing):
848
"""Returns a function testing if an attribute is a D-Bus thing
849
850
If called like _is_dbus_thing("method") it returns a function
851
suitable for use as predicate to inspect.getmembers().
852
"""
853
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
854
False)
583
855
584
def _get_all_dbus_properties(self):
856
def _get_all_dbus_things(self, thing):
585
857
"""Returns a generator of (name, attribute) pairs
586
858
"""
587
return ((prop._dbus_name, prop)
588
for name, prop in
589
inspect.getmembers(self, self._is_dbus_property))
859
return ((getattr(athing.__get__(self), "_dbus_name",
860
name),
861
athing.__get__(self))
862
for cls in self.__class__.__mro__
863
for name, athing in
864
inspect.getmembers(cls,
865
self._is_dbus_thing(thing)))
590
866
591
867
def _get_dbus_property(self, interface_name, property_name):
592
868
"""Returns a bound method if one exists which is a D-Bus
593
869
property with the specified name and interface.
594
870
"""
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
871
for cls in self.__class__.__mro__:
872
for name, value in (inspect.getmembers
873
(cls,
874
self._is_dbus_thing("property"))):
875
if (value._dbus_name == property_name
876
and value._dbus_interface == interface_name):
877
return value.__get__(self)
878
605
879
# No such property
606
raise DBusPropertyNotFound(self.dbus_object_path + u":"
607
+ interface_name + u"."
880
raise DBusPropertyNotFound(self.dbus_object_path + ":"
881
+ interface_name + "."
608
882
+ property_name)
609
883
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
611
out_signature=u"v")
884
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
885
out_signature="v")
612
886
def Get(self, interface_name, property_name):
613
887
"""Standard D-Bus property Get() method, see D-Bus standard.
614
888
"""
615
889
prop = self._get_dbus_property(interface_name, property_name)
616
if prop._dbus_access == u"write":
890
if prop._dbus_access == "write":
617
891
raise DBusPropertyAccessException(property_name)
618
892
value = prop()
619
if not hasattr(value, u"variant_level"):
893
if not hasattr(value, "variant_level"):
620
894
return value
621
895
return type(value)(value, variant_level=value.variant_level+1)
622
896
623
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
897
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
624
898
def Set(self, interface_name, property_name, value):
625
899
"""Standard D-Bus property Set() method, see D-Bus standard.
626
900
"""
627
901
prop = self._get_dbus_property(interface_name, property_name)
628
if prop._dbus_access == u"read":
902
if prop._dbus_access == "read":
629
903
raise DBusPropertyAccessException(property_name)
630
if prop._dbus_get_args_options[u"byte_arrays"]:
904
if prop._dbus_get_args_options["byte_arrays"]:
631
905
# The byte_arrays option is not supported yet on
632
906
# signatures other than "ay".
633
if prop._dbus_signature != u"ay":
907
if prop._dbus_signature != "ay":
634
908
raise ValueError
635
value = dbus.ByteArray(''.join(unichr(byte)
636
for byte in value))
909
value = dbus.ByteArray(b''.join(chr(byte)
910
for byte in value))
637
911
prop(value)
638
912
639
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
640
out_signature=u"a{sv}")
913
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
914
out_signature="a{sv}")
641
915
def GetAll(self, interface_name):
642
916
"""Standard D-Bus property GetAll() method, see D-Bus
643
917
standard.
644
918
645
919
Note: Will not include properties with access="write".
646
920
"""
647
all = {}
648
for name, prop in self._get_all_dbus_properties():
921
properties = {}
922
for name, prop in self._get_all_dbus_things("property"):
649
923
if (interface_name
650
924
and interface_name != prop._dbus_interface):
651
925
# Interface non-empty but did not match
652
926
continue
653
927
# Ignore write-only properties
654
if prop._dbus_access == u"write":
928
if prop._dbus_access == "write":
655
929
continue
656
930
value = prop()
657
if not hasattr(value, u"variant_level"):
658
all[name] = value
931
if not hasattr(value, "variant_level"):
932
properties[name] = value
659
933
continue
660
all[name] = type(value)(value, variant_level=
661
value.variant_level+1)
662
return dbus.Dictionary(all, signature=u"sv")
934
properties[name] = type(value)(value, variant_level=
935
value.variant_level+1)
936
return dbus.Dictionary(properties, signature="sv")
663
937
664
938
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
665
out_signature=u"s",
939
out_signature="s",
666
940
path_keyword='object_path',
667
941
connection_keyword='connection')
668
942
def Introspect(self, object_path, connection):
669
"""Standard D-Bus method, overloaded to insert property tags.
943
"""Overloading of standard D-Bus method.
944
945
Inserts property tags and interface annotation tags.
670
946
"""
671
947
xmlstring = dbus.service.Object.Introspect(self, object_path,
672
948
connection)
673
949
try:
674
950
document = xml.dom.minidom.parseString(xmlstring)
675
951
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)
952
e = document.createElement("property")
953
e.setAttribute("name", name)
954
e.setAttribute("type", prop._dbus_signature)
955
e.setAttribute("access", prop._dbus_access)
680
956
return e
681
for if_tag in document.getElementsByTagName(u"interface"):
957
for if_tag in document.getElementsByTagName("interface"):
958
# Add property tags
682
959
for tag in (make_tag(document, name, prop)
683
960
for name, prop
684
in self._get_all_dbus_properties()
961
in self._get_all_dbus_things("property")
685
962
if prop._dbus_interface
686
== if_tag.getAttribute(u"name")):
963
== if_tag.getAttribute("name")):
687
964
if_tag.appendChild(tag)
965
# Add annotation tags
966
for typ in ("method", "signal", "property"):
967
for tag in if_tag.getElementsByTagName(typ):
968
annots = dict()
969
for name, prop in (self.
970
_get_all_dbus_things(typ)):
971
if (name == tag.getAttribute("name")
972
and prop._dbus_interface
973
== if_tag.getAttribute("name")):
974
annots.update(getattr
975
(prop,
976
"_dbus_annotations",
977
{}))
978
for name, value in annots.iteritems():
979
ann_tag = document.createElement(
980
"annotation")
981
ann_tag.setAttribute("name", name)
982
ann_tag.setAttribute("value", value)
983
tag.appendChild(ann_tag)
984
# Add interface annotation tags
985
for annotation, value in dict(
986
itertools.chain.from_iterable(
987
annotations().iteritems()
988
for name, annotations in
989
self._get_all_dbus_things("interface")
990
if name == if_tag.getAttribute("name")
991
)).iteritems():
992
ann_tag = document.createElement("annotation")
993
ann_tag.setAttribute("name", annotation)
994
ann_tag.setAttribute("value", value)
995
if_tag.appendChild(ann_tag)
688
996
# Add the names to the return values for the
689
997
# "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")
998
if (if_tag.getAttribute("name")
999
== "org.freedesktop.DBus.Properties"):
1000
for cn in if_tag.getElementsByTagName("method"):
1001
if cn.getAttribute("name") == "Get":
1002
for arg in cn.getElementsByTagName("arg"):
1003
if (arg.getAttribute("direction")
1004
== "out"):
1005
arg.setAttribute("name", "value")
1006
elif cn.getAttribute("name") == "GetAll":
1007
for arg in cn.getElementsByTagName("arg"):
1008
if (arg.getAttribute("direction")
1009
== "out"):
1010
arg.setAttribute("name", "props")
1011
xmlstring = document.toxml("utf-8")
704
1012
document.unlink()
705
1013
except (AttributeError, xml.dom.DOMException,
706
xml.parsers.expat.ExpatError), error:
707
logger.error(u"Failed to override Introspection method",
708
error)
1014
xml.parsers.expat.ExpatError) as error:
1015
logger.error("Failed to override Introspection method",
1016
exc_info=error)
709
1017
return xmlstring
710
1018
711
1019
1020
def datetime_to_dbus(dt, variant_level=0):
1021
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1022
if dt is None:
1023
return dbus.String("", variant_level = variant_level)
1024
return dbus.String(dt.isoformat(),
1025
variant_level=variant_level)
1026
1027
1028
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1029
"""A class decorator; applied to a subclass of
1030
dbus.service.Object, it will add alternate D-Bus attributes with
1031
interface names according to the "alt_interface_names" mapping.
1032
Usage:
1033
1034
@alternate_dbus_interfaces({"org.example.Interface":
1035
"net.example.AlternateInterface"})
1036
class SampleDBusObject(dbus.service.Object):
1037
@dbus.service.method("org.example.Interface")
1038
def SampleDBusMethod():
1039
pass
1040
1041
The above "SampleDBusMethod" on "SampleDBusObject" will be
1042
reachable via two interfaces: "org.example.Interface" and
1043
"net.example.AlternateInterface", the latter of which will have
1044
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1045
"true", unless "deprecate" is passed with a False value.
1046
1047
This works for methods and signals, and also for D-Bus properties
1048
(from DBusObjectWithProperties) and interfaces (from the
1049
dbus_interface_annotations decorator).
1050
"""
1051
def wrapper(cls):
1052
for orig_interface_name, alt_interface_name in (
1053
alt_interface_names.iteritems()):
1054
attr = {}
1055
interface_names = set()
1056
# Go though all attributes of the class
1057
for attrname, attribute in inspect.getmembers(cls):
1058
# Ignore non-D-Bus attributes, and D-Bus attributes
1059
# with the wrong interface name
1060
if (not hasattr(attribute, "_dbus_interface")
1061
or not attribute._dbus_interface
1062
.startswith(orig_interface_name)):
1063
continue
1064
# Create an alternate D-Bus interface name based on
1065
# the current name
1066
alt_interface = (attribute._dbus_interface
1067
.replace(orig_interface_name,
1068
alt_interface_name))
1069
interface_names.add(alt_interface)
1070
# Is this a D-Bus signal?
1071
if getattr(attribute, "_dbus_is_signal", False):
1072
# Extract the original non-method function by
1073
# black magic
1074
nonmethod_func = (dict(
1075
zip(attribute.func_code.co_freevars,
1076
attribute.__closure__))["func"]
1077
.cell_contents)
1078
# Create a new, but exactly alike, function
1079
# object, and decorate it to be a new D-Bus signal
1080
# with the alternate D-Bus interface name
1081
new_function = (dbus.service.signal
1082
(alt_interface,
1083
attribute._dbus_signature)
1084
(types.FunctionType(
1085
nonmethod_func.func_code,
1086
nonmethod_func.func_globals,
1087
nonmethod_func.func_name,
1088
nonmethod_func.func_defaults,
1089
nonmethod_func.func_closure)))
1090
# Copy annotations, if any
1091
try:
1092
new_function._dbus_annotations = (
1093
dict(attribute._dbus_annotations))
1094
except AttributeError:
1095
pass
1096
# Define a creator of a function to call both the
1097
# original and alternate functions, so both the
1098
# original and alternate signals gets sent when
1099
# the function is called
1100
def fixscope(func1, func2):
1101
"""This function is a scope container to pass
1102
func1 and func2 to the "call_both" function
1103
outside of its arguments"""
1104
def call_both(*args, **kwargs):
1105
"""This function will emit two D-Bus
1106
signals by calling func1 and func2"""
1107
func1(*args, **kwargs)
1108
func2(*args, **kwargs)
1109
return call_both
1110
# Create the "call_both" function and add it to
1111
# the class
1112
attr[attrname] = fixscope(attribute, new_function)
1113
# Is this a D-Bus method?
1114
elif getattr(attribute, "_dbus_is_method", False):
1115
# Create a new, but exactly alike, function
1116
# object. Decorate it to be a new D-Bus method
1117
# with the alternate D-Bus interface name. Add it
1118
# to the class.
1119
attr[attrname] = (dbus.service.method
1120
(alt_interface,
1121
attribute._dbus_in_signature,
1122
attribute._dbus_out_signature)
1123
(types.FunctionType
1124
(attribute.func_code,
1125
attribute.func_globals,
1126
attribute.func_name,
1127
attribute.func_defaults,
1128
attribute.func_closure)))
1129
# Copy annotations, if any
1130
try:
1131
attr[attrname]._dbus_annotations = (
1132
dict(attribute._dbus_annotations))
1133
except AttributeError:
1134
pass
1135
# Is this a D-Bus property?
1136
elif getattr(attribute, "_dbus_is_property", False):
1137
# Create a new, but exactly alike, function
1138
# object, and decorate it to be a new D-Bus
1139
# property with the alternate D-Bus interface
1140
# name. Add it to the class.
1141
attr[attrname] = (dbus_service_property
1142
(alt_interface,
1143
attribute._dbus_signature,
1144
attribute._dbus_access,
1145
attribute
1146
._dbus_get_args_options
1147
["byte_arrays"])
1148
(types.FunctionType
1149
(attribute.func_code,
1150
attribute.func_globals,
1151
attribute.func_name,
1152
attribute.func_defaults,
1153
attribute.func_closure)))
1154
# Copy annotations, if any
1155
try:
1156
attr[attrname]._dbus_annotations = (
1157
dict(attribute._dbus_annotations))
1158
except AttributeError:
1159
pass
1160
# Is this a D-Bus interface?
1161
elif getattr(attribute, "_dbus_is_interface", False):
1162
# Create a new, but exactly alike, function
1163
# object. Decorate it to be a new D-Bus interface
1164
# with the alternate D-Bus interface name. Add it
1165
# to the class.
1166
attr[attrname] = (dbus_interface_annotations
1167
(alt_interface)
1168
(types.FunctionType
1169
(attribute.func_code,
1170
attribute.func_globals,
1171
attribute.func_name,
1172
attribute.func_defaults,
1173
attribute.func_closure)))
1174
if deprecate:
1175
# Deprecate all alternate interfaces
1176
iname="_AlternateDBusNames_interface_annotation{0}"
1177
for interface_name in interface_names:
1178
@dbus_interface_annotations(interface_name)
1179
def func(self):
1180
return { "org.freedesktop.DBus.Deprecated":
1181
"true" }
1182
# Find an unused name
1183
for aname in (iname.format(i)
1184
for i in itertools.count()):
1185
if aname not in attr:
1186
attr[aname] = func
1187
break
1188
if interface_names:
1189
# Replace the class with a new subclass of it with
1190
# methods, signals, etc. as created above.
1191
cls = type(b"{0}Alternate".format(cls.__name__),
1192
(cls,), attr)
1193
return cls
1194
return wrapper
1195
1196
1197
@alternate_dbus_interfaces({"se.recompile.Mandos":
1198
"se.bsnet.fukt.Mandos"})
712
1199
class ClientDBus(Client, DBusObjectWithProperties):
713
1200
"""A Client class using D-Bus
714
1201
718
1205
"""
719
1206
720
1207
runtime_expansions = (Client.runtime_expansions
721
+ (u"dbus_object_path",))
1208
+ ("dbus_object_path",))
722
1209
723
1210
# dbus.service.Object doesn't use super(), so we can't either.
724
1211
725
1212
def __init__(self, bus = None, *args, **kwargs):
726
self._approvals_pending = 0
727
1213
self.bus = bus
728
1214
Client.__init__(self, *args, **kwargs)
729
1215
# Only now, when this client is initialized, can it show up on
730
1216
# the D-Bus
731
1217
client_object_name = unicode(self.name).translate(
732
{ord(u"."): ord(u"_"),
733
ord(u"-"): ord(u"_")})
1218
{ord("."): ord("_"),
1219
ord("-"): ord("_")})
734
1220
self.dbus_object_path = (dbus.ObjectPath
735
(u"/clients/" + client_object_name))
1221
("/clients/" + client_object_name))
736
1222
DBusObjectWithProperties.__init__(self, self.bus,
737
1223
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
1224
1225
def notifychangeproperty(transform_func,
1226
dbus_name, type_func=lambda x: x,
1227
variant_level=1):
1228
""" Modify a variable so that it's a property which announces
1229
its changes to DBus.
1230
1231
transform_fun: Function that takes a value and a variant_level
1232
and transforms it to a D-Bus type.
1233
dbus_name: D-Bus name of the variable
1234
type_func: Function that transform the value before sending it
1235
to the D-Bus. Default: no transform
1236
variant_level: D-Bus variant level. Default: 1
1237
"""
1238
attrname = "_{0}".format(dbus_name)
1239
def setter(self, value):
1240
if hasattr(self, "dbus_object_path"):
1241
if (not hasattr(self, attrname) or
1242
type_func(getattr(self, attrname, None))
1243
!= type_func(value)):
1244
dbus_value = transform_func(type_func(value),
1245
variant_level
1246
=variant_level)
1247
self.PropertyChanged(dbus.String(dbus_name),
1248
dbus_value)
1249
setattr(self, attrname, value)
1250
1251
return property(lambda self: getattr(self, attrname), setter)
1252
1253
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1254
approvals_pending = notifychangeproperty(dbus.Boolean,
1255
"ApprovalPending",
1256
type_func = bool)
1257
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1258
last_enabled = notifychangeproperty(datetime_to_dbus,
1259
"LastEnabled")
1260
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1261
type_func = lambda checker:
1262
checker is not None)
1263
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1264
"LastCheckedOK")
1265
last_checker_status = notifychangeproperty(dbus.Int16,
1266
"LastCheckerStatus")
1267
last_approval_request = notifychangeproperty(
1268
datetime_to_dbus, "LastApprovalRequest")
1269
approved_by_default = notifychangeproperty(dbus.Boolean,
1270
"ApprovedByDefault")
1271
approval_delay = notifychangeproperty(dbus.UInt64,
1272
"ApprovalDelay",
1273
type_func =
1274
timedelta_to_milliseconds)
1275
approval_duration = notifychangeproperty(
1276
dbus.UInt64, "ApprovalDuration",
1277
type_func = timedelta_to_milliseconds)
1278
host = notifychangeproperty(dbus.String, "Host")
1279
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1280
type_func =
1281
timedelta_to_milliseconds)
1282
extended_timeout = notifychangeproperty(
1283
dbus.UInt64, "ExtendedTimeout",
1284
type_func = timedelta_to_milliseconds)
1285
interval = notifychangeproperty(dbus.UInt64,
1286
"Interval",
1287
type_func =
1288
timedelta_to_milliseconds)
1289
checker_command = notifychangeproperty(dbus.String, "Checker")
1290
1291
del notifychangeproperty
782
1292
783
1293
def __del__(self, *args, **kwargs):
784
1294
try:
785
1295
self.remove_from_connection()
786
1296
except LookupError:
787
1297
pass
788
if hasattr(DBusObjectWithProperties, u"__del__"):
1298
if hasattr(DBusObjectWithProperties, "__del__"):
789
1299
DBusObjectWithProperties.__del__(self, *args, **kwargs)
790
1300
Client.__del__(self, *args, **kwargs)
791
1301
793
1303
*args, **kwargs):
794
1304
self.checker_callback_tag = None
795
1305
self.checker = None
796
# Emit D-Bus signal
797
self.PropertyChanged(dbus.String(u"CheckerRunning"),
798
dbus.Boolean(False, variant_level=1))
799
1306
if os.WIFEXITED(condition):
800
1307
exitstatus = os.WEXITSTATUS(condition)
801
1308
# Emit D-Bus signal
811
1318
return Client.checker_callback(self, pid, condition, command,
812
1319
*args, **kwargs)
813
1320
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
1321
def start_checker(self, *args, **kwargs):
833
1322
old_checker = self.checker
834
1323
if self.checker is not None:
841
1330
and old_checker_pid != self.checker.pid):
842
1331
# Emit D-Bus signal
843
1332
self.CheckerStarted(self.current_checker_command)
844
self.PropertyChanged(
845
dbus.String(u"CheckerRunning"),
846
dbus.Boolean(True, variant_level=1))
847
1333
return r
848
1334
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
1335
def _reset_approved(self):
859
self._approved = None
1336
self.approved = None
860
1337
return False
861
1338
862
1339
def approve(self, value=True):
863
self.send_changedstate()
864
self._approved = value
865
gobject.timeout_add(self._timedelta_to_milliseconds
1340
self.approved = value
1341
gobject.timeout_add(timedelta_to_milliseconds
866
1342
(self.approval_duration),
867
1343
self._reset_approved)
868
1344
self.send_changedstate()
869
1345
870
1346
## D-Bus methods, signals & properties
871
_interface = u"se.bsnet.fukt.Mandos.Client"
1347
_interface = "se.recompile.Mandos.Client"
1348
1349
## Interfaces
1350
1351
@dbus_interface_annotations(_interface)
1352
def _foo(self):
1353
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1354
"false"}
872
1355
873
1356
## Signals
874
1357
875
1358
# CheckerCompleted - signal
876
@dbus.service.signal(_interface, signature=u"nxs")
1359
@dbus.service.signal(_interface, signature="nxs")
877
1360
def CheckerCompleted(self, exitcode, waitstatus, command):
878
1361
"D-Bus signal"
879
1362
pass
880
1363
881
1364
# CheckerStarted - signal
882
@dbus.service.signal(_interface, signature=u"s")
1365
@dbus.service.signal(_interface, signature="s")
883
1366
def CheckerStarted(self, command):
884
1367
"D-Bus signal"
885
1368
pass
886
1369
887
1370
# PropertyChanged - signal
888
@dbus.service.signal(_interface, signature=u"sv")
1371
@dbus.service.signal(_interface, signature="sv")
889
1372
def PropertyChanged(self, property, value):
890
1373
"D-Bus signal"
891
1374
pass
900
1383
pass
901
1384
902
1385
# Rejected - signal
903
@dbus.service.signal(_interface, signature=u"s")
1386
@dbus.service.signal(_interface, signature="s")
904
1387
def Rejected(self, reason):
905
1388
"D-Bus signal"
906
1389
pass
907
1390
908
1391
# NeedApproval - signal
909
@dbus.service.signal(_interface, signature=u"tb")
1392
@dbus.service.signal(_interface, signature="tb")
910
1393
def NeedApproval(self, timeout, default):
911
1394
"D-Bus signal"
912
1395
return self.need_approval()
914
1397
## Methods
915
1398
916
1399
# Approve - method
917
@dbus.service.method(_interface, in_signature=u"b")
1400
@dbus.service.method(_interface, in_signature="b")
918
1401
def Approve(self, value):
919
1402
self.approve(value)
920
1403
921
1404
# CheckedOK - method
922
1405
@dbus.service.method(_interface)
923
1406
def CheckedOK(self):
924
return self.checked_ok()
1407
self.checked_ok()
925
1408
926
1409
# Enable - method
927
1410
@dbus.service.method(_interface)
949
1432
## Properties
950
1433
951
1434
# ApprovalPending - property
952
@dbus_service_property(_interface, signature=u"b", access=u"read")
1435
@dbus_service_property(_interface, signature="b", access="read")
953
1436
def ApprovalPending_dbus_property(self):
954
1437
return dbus.Boolean(bool(self.approvals_pending))
955
1438
956
1439
# ApprovedByDefault - property
957
@dbus_service_property(_interface, signature=u"b",
958
access=u"readwrite")
1440
@dbus_service_property(_interface, signature="b",
1441
access="readwrite")
959
1442
def ApprovedByDefault_dbus_property(self, value=None):
960
1443
if value is None: # get
961
1444
return dbus.Boolean(self.approved_by_default)
962
1445
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
1446
967
1447
# ApprovalDelay - property
968
@dbus_service_property(_interface, signature=u"t",
969
access=u"readwrite")
1448
@dbus_service_property(_interface, signature="t",
1449
access="readwrite")
970
1450
def ApprovalDelay_dbus_property(self, value=None):
971
1451
if value is None: # get
972
1452
return dbus.UInt64(self.approval_delay_milliseconds())
973
1453
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
1454
978
1455
# ApprovalDuration - property
979
@dbus_service_property(_interface, signature=u"t",
980
access=u"readwrite")
1456
@dbus_service_property(_interface, signature="t",
1457
access="readwrite")
981
1458
def ApprovalDuration_dbus_property(self, value=None):
982
1459
if value is None: # get
983
return dbus.UInt64(self._timedelta_to_milliseconds(
1460
return dbus.UInt64(timedelta_to_milliseconds(
984
1461
self.approval_duration))
985
1462
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
1463
990
1464
# Name - property
991
@dbus_service_property(_interface, signature=u"s", access=u"read")
1465
@dbus_service_property(_interface, signature="s", access="read")
992
1466
def Name_dbus_property(self):
993
1467
return dbus.String(self.name)
994
1468
995
1469
# Fingerprint - property
996
@dbus_service_property(_interface, signature=u"s", access=u"read")
1470
@dbus_service_property(_interface, signature="s", access="read")
997
1471
def Fingerprint_dbus_property(self):
998
1472
return dbus.String(self.fingerprint)
999
1473
1000
1474
# Host - property
1001
@dbus_service_property(_interface, signature=u"s",
1002
access=u"readwrite")
1475
@dbus_service_property(_interface, signature="s",
1476
access="readwrite")
1003
1477
def Host_dbus_property(self, value=None):
1004
1478
if value is None: # get
1005
1479
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))
1480
self.host = unicode(value)
1010
1481
1011
1482
# Created - property
1012
@dbus_service_property(_interface, signature=u"s", access=u"read")
1483
@dbus_service_property(_interface, signature="s", access="read")
1013
1484
def Created_dbus_property(self):
1014
return dbus.String(self._datetime_to_dbus(self.created))
1485
return datetime_to_dbus(self.created)
1015
1486
1016
1487
# LastEnabled - property
1017
@dbus_service_property(_interface, signature=u"s", access=u"read")
1488
@dbus_service_property(_interface, signature="s", access="read")
1018
1489
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))
1490
return datetime_to_dbus(self.last_enabled)
1022
1491
1023
1492
# Enabled - property
1024
@dbus_service_property(_interface, signature=u"b",
1025
access=u"readwrite")
1493
@dbus_service_property(_interface, signature="b",
1494
access="readwrite")
1026
1495
def Enabled_dbus_property(self, value=None):
1027
1496
if value is None: # get
1028
1497
return dbus.Boolean(self.enabled)
1032
1501
self.disable()
1033
1502
1034
1503
# LastCheckedOK - property
1035
@dbus_service_property(_interface, signature=u"s",
1036
access=u"readwrite")
1504
@dbus_service_property(_interface, signature="s",
1505
access="readwrite")
1037
1506
def LastCheckedOK_dbus_property(self, value=None):
1038
1507
if value is not None:
1039
1508
self.checked_ok()
1040
1509
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))
1510
return datetime_to_dbus(self.last_checked_ok)
1511
1512
# LastCheckerStatus - property
1513
@dbus_service_property(_interface, signature="n",
1514
access="read")
1515
def LastCheckerStatus_dbus_property(self):
1516
return dbus.Int16(self.last_checker_status)
1517
1518
# Expires - property
1519
@dbus_service_property(_interface, signature="s", access="read")
1520
def Expires_dbus_property(self):
1521
return datetime_to_dbus(self.expires)
1045
1522
1046
1523
# LastApprovalRequest - property
1047
@dbus_service_property(_interface, signature=u"s", access=u"read")
1524
@dbus_service_property(_interface, signature="s", access="read")
1048
1525
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))
1526
return datetime_to_dbus(self.last_approval_request)
1054
1527
1055
1528
# Timeout - property
1056
@dbus_service_property(_interface, signature=u"t",
1057
access=u"readwrite")
1529
@dbus_service_property(_interface, signature="t",
1530
access="readwrite")
1058
1531
def Timeout_dbus_property(self, value=None):
1059
1532
if value is None: # get
1060
1533
return dbus.UInt64(self.timeout_milliseconds())
1534
old_timeout = self.timeout
1061
1535
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))
1536
# Reschedule disabling
1537
if self.enabled:
1538
now = datetime.datetime.utcnow()
1539
self.expires += self.timeout - old_timeout
1540
if self.expires <= now:
1541
# The timeout has passed
1542
self.disable()
1543
else:
1544
if (getattr(self, "disable_initiator_tag", None)
1545
is None):
1546
return
1547
gobject.source_remove(self.disable_initiator_tag)
1548
self.disable_initiator_tag = (
1549
gobject.timeout_add(
1550
timedelta_to_milliseconds(self.expires - now),
1551
self.disable))
1552
1553
# ExtendedTimeout - property
1554
@dbus_service_property(_interface, signature="t",
1555
access="readwrite")
1556
def ExtendedTimeout_dbus_property(self, value=None):
1557
if value is None: # get
1558
return dbus.UInt64(self.extended_timeout_milliseconds())
1559
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1082
1560
1083
1561
# Interval - property
1084
@dbus_service_property(_interface, signature=u"t",
1085
access=u"readwrite")
1562
@dbus_service_property(_interface, signature="t",
1563
access="readwrite")
1086
1564
def Interval_dbus_property(self, value=None):
1087
1565
if value is None: # get
1088
1566
return dbus.UInt64(self.interval_milliseconds())
1089
1567
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:
1568
if getattr(self, "checker_initiator_tag", None) is None:
1094
1569
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
1570
if self.enabled:
1571
# Reschedule checker run
1572
gobject.source_remove(self.checker_initiator_tag)
1573
self.checker_initiator_tag = (gobject.timeout_add
1574
(value, self.start_checker))
1575
self.start_checker() # Start one now, too
1576
1101
1577
# Checker - property
1102
@dbus_service_property(_interface, signature=u"s",
1103
access=u"readwrite")
1578
@dbus_service_property(_interface, signature="s",
1579
access="readwrite")
1104
1580
def Checker_dbus_property(self, value=None):
1105
1581
if value is None: # get
1106
1582
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))
1583
self.checker_command = unicode(value)
1112
1584
1113
1585
# CheckerRunning - property
1114
@dbus_service_property(_interface, signature=u"b",
1115
access=u"readwrite")
1586
@dbus_service_property(_interface, signature="b",
1587
access="readwrite")
1116
1588
def CheckerRunning_dbus_property(self, value=None):
1117
1589
if value is None: # get
1118
1590
return dbus.Boolean(self.checker is not None)
1122
1594
self.stop_checker()
1123
1595
1124
1596
# ObjectPath - property
1125
@dbus_service_property(_interface, signature=u"o", access=u"read")
1597
@dbus_service_property(_interface, signature="o", access="read")
1126
1598
def ObjectPath_dbus_property(self):
1127
1599
return self.dbus_object_path # is already a dbus.ObjectPath
1128
1600
1129
1601
# Secret = property
1130
@dbus_service_property(_interface, signature=u"ay",
1131
access=u"write", byte_arrays=True)
1602
@dbus_service_property(_interface, signature="ay",
1603
access="write", byte_arrays=True)
1132
1604
def Secret_dbus_property(self, value):
1133
1605
self.secret = str(value)
1134
1606
1141
1613
self._pipe.send(('init', fpr, address))
1142
1614
if not self._pipe.recv():
1143
1615
raise KeyError()
1144
1616
1145
1617
def __getattribute__(self, name):
1146
if(name == '_pipe'):
1618
if name == '_pipe':
1147
1619
return super(ProxyClient, self).__getattribute__(name)
1148
1620
self._pipe.send(('getattr', name))
1149
1621
data = self._pipe.recv()
1154
1626
self._pipe.send(('funcall', name, args, kwargs))
1155
1627
return self._pipe.recv()[1]
1156
1628
return func
1157
1629
1158
1630
def __setattr__(self, name, value):
1159
if(name == '_pipe'):
1631
if name == '_pipe':
1160
1632
return super(ProxyClient, self).__setattr__(name, value)
1161
1633
self._pipe.send(('setattr', name, value))
1162
1634
1169
1641
1170
1642
def handle(self):
1171
1643
with contextlib.closing(self.server.child_pipe) as child_pipe:
1172
logger.info(u"TCP connection from: %s",
1644
logger.info("TCP connection from: %s",
1173
1645
unicode(self.client_address))
1174
logger.debug(u"Pipe FD: %d",
1646
logger.debug("Pipe FD: %d",
1175
1647
self.server.child_pipe.fileno())
1176
1648
1177
1649
session = (gnutls.connection
1178
1650
.ClientSession(self.request,
1179
1651
gnutls.connection
1180
1652
.X509Credentials()))
1181
1653
1182
1654
# Note: gnutls.connection.X509Credentials is really a
1183
1655
# generic GnuTLS certificate credentials object so long as
1184
1656
# no X.509 keys are added to it. Therefore, we can use it
1185
1657
# 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"))
1658
1659
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1660
# "+AES-256-CBC", "+SHA1",
1661
# "+COMP-NULL", "+CTYPE-OPENPGP",
1662
# "+DHE-DSS"))
1191
1663
# Use a fallback default, since this MUST be set.
1192
1664
priority = self.server.gnutls_priority
1193
1665
if priority is None:
1194
priority = u"NORMAL"
1666
priority = "NORMAL"
1195
1667
(gnutls.library.functions
1196
1668
.gnutls_priority_set_direct(session._c_object,
1197
1669
priority, None))
1198
1670
1199
1671
# Start communication using the Mandos protocol
1200
1672
# Get protocol number
1201
1673
line = self.request.makefile().readline()
1202
logger.debug(u"Protocol version: %r", line)
1674
logger.debug("Protocol version: %r", line)
1203
1675
try:
1204
1676
if int(line.strip().split()[0]) > 1:
1205
1677
raise RuntimeError
1206
except (ValueError, IndexError, RuntimeError), error:
1207
logger.error(u"Unknown protocol version: %s", error)
1678
except (ValueError, IndexError, RuntimeError) as error:
1679
logger.error("Unknown protocol version: %s", error)
1208
1680
return
1209
1681
1210
1682
# Start GnuTLS connection
1211
1683
try:
1212
1684
session.handshake()
1213
except gnutls.errors.GNUTLSError, error:
1214
logger.warning(u"Handshake failed: %s", error)
1685
except gnutls.errors.GNUTLSError as error:
1686
logger.warning("Handshake failed: %s", error)
1215
1687
# Do not run session.bye() here: the session is not
1216
1688
# established. Just abandon the request.
1217
1689
return
1218
logger.debug(u"Handshake succeeded")
1219
1690
logger.debug("Handshake succeeded")
1691
1220
1692
approval_required = False
1221
1693
try:
1222
1694
try:
1223
1695
fpr = self.fingerprint(self.peer_certificate
1224
1696
(session))
1225
except (TypeError, gnutls.errors.GNUTLSError), error:
1226
logger.warning(u"Bad certificate: %s", error)
1697
except (TypeError,
1698
gnutls.errors.GNUTLSError) as error:
1699
logger.warning("Bad certificate: %s", error)
1227
1700
return
1228
logger.debug(u"Fingerprint: %s", fpr)
1229
1701
logger.debug("Fingerprint: %s", fpr)
1702
1230
1703
try:
1231
1704
client = ProxyClient(child_pipe, fpr,
1232
1705
self.client_address)
1240
1713
1241
1714
while True:
1242
1715
if not client.enabled:
1243
logger.warning(u"Client %s is disabled",
1716
logger.info("Client %s is disabled",
1244
1717
client.name)
1245
1718
if self.server.use_dbus:
1246
1719
# Emit D-Bus signal
1247
client.Rejected("Disabled")
1720
client.Rejected("Disabled")
1248
1721
return
1249
1722
1250
if client._approved or not client.approval_delay:
1723
if client.approved or not client.approval_delay:
1251
1724
#We are approved or approval is disabled
1252
1725
break
1253
elif client._approved is None:
1254
logger.info(u"Client %s needs approval",
1726
elif client.approved is None:
1727
logger.info("Client %s needs approval",
1255
1728
client.name)
1256
1729
if self.server.use_dbus:
1257
1730
# Emit D-Bus signal
1259
1732
client.approval_delay_milliseconds(),
1260
1733
client.approved_by_default)
1261
1734
else:
1262
logger.warning(u"Client %s was not approved",
1735
logger.warning("Client %s was not approved",
1263
1736
client.name)
1264
1737
if self.server.use_dbus:
1265
1738
# Emit D-Bus signal
1267
1740
return
1268
1741
1269
1742
#wait until timeout or approved
1270
#x = float(client._timedelta_to_milliseconds(delay))
1271
1743
time = datetime.datetime.now()
1272
1744
client.changedstate.acquire()
1273
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1745
client.changedstate.wait(
1746
float(timedelta_to_milliseconds(delay)
1747
/ 1000))
1274
1748
client.changedstate.release()
1275
1749
time2 = datetime.datetime.now()
1276
1750
if (time2 - time) >= delay:
1291
1765
while sent_size < len(client.secret):
1292
1766
try:
1293
1767
sent = session.send(client.secret[sent_size:])
1294
except (gnutls.errors.GNUTLSError), error:
1295
logger.warning("gnutls send failed")
1768
except gnutls.errors.GNUTLSError as error:
1769
logger.warning("gnutls send failed",
1770
exc_info=error)
1296
1771
return
1297
logger.debug(u"Sent: %d, remaining: %d",
1772
logger.debug("Sent: %d, remaining: %d",
1298
1773
sent, len(client.secret)
1299
1774
- (sent_size + sent))
1300
1775
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()
1776
1777
logger.info("Sending secret to %s", client.name)
1778
# bump the timeout using extended_timeout
1779
client.bump_timeout(client.extended_timeout)
1305
1780
if self.server.use_dbus:
1306
1781
# Emit D-Bus signal
1307
1782
client.GotSecret()
1311
1786
client.approvals_pending -= 1
1312
1787
try:
1313
1788
session.bye()
1314
except (gnutls.errors.GNUTLSError), error:
1315
logger.warning("GnuTLS bye failed")
1789
except gnutls.errors.GNUTLSError as error:
1790
logger.warning("GnuTLS bye failed",
1791
exc_info=error)
1316
1792
1317
1793
@staticmethod
1318
1794
def peer_certificate(session):
1328
1804
.gnutls_certificate_get_peers
1329
1805
(session._c_object, ctypes.byref(list_size)))
1330
1806
if not bool(cert_list) and list_size.value != 0:
1331
raise gnutls.errors.GNUTLSError(u"error getting peer"
1332
u" certificate")
1807
raise gnutls.errors.GNUTLSError("error getting peer"
1808
" certificate")
1333
1809
if list_size.value == 0:
1334
1810
return None
1335
1811
cert = cert_list[0]
1361
1837
if crtverify.value != 0:
1362
1838
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1363
1839
raise (gnutls.errors.CertificateSecurityError
1364
(u"Verify failed"))
1840
("Verify failed"))
1365
1841
# New buffer for the fingerprint
1366
1842
buf = ctypes.create_string_buffer(20)
1367
1843
buf_len = ctypes.c_size_t()
1374
1850
# Convert the buffer to a Python bytestring
1375
1851
fpr = ctypes.string_at(buf, buf_len.value)
1376
1852
# Convert the bytestring to hexadecimal notation
1377
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1853
hex_fpr = binascii.hexlify(fpr).upper()
1378
1854
return hex_fpr
1379
1855
1380
1856
1383
1859
def sub_process_main(self, request, address):
1384
1860
try:
1385
1861
self.finish_request(request, address)
1386
except:
1862
except Exception:
1387
1863
self.handle_error(request, address)
1388
1864
self.close_request(request)
1389
1865
1390
1866
def process_request(self, request, address):
1391
1867
"""Start a new process to process the request."""
1392
multiprocessing.Process(target = self.sub_process_main,
1393
args = (request, address)).start()
1868
proc = multiprocessing.Process(target = self.sub_process_main,
1869
args = (request, address))
1870
proc.start()
1871
return proc
1872
1394
1873
1395
1874
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1396
1875
""" adds a pipe to the MixIn """
1400
1879
This function creates a new pipe in self.pipe
1401
1880
"""
1402
1881
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1403
1404
super(MultiprocessingMixInWithPipe,
1405
self).process_request(request, client_address)
1882
1883
proc = MultiprocessingMixIn.process_request(self, request,
1884
client_address)
1406
1885
self.child_pipe.close()
1407
self.add_pipe(parent_pipe)
1408
1409
def add_pipe(self, parent_pipe):
1886
self.add_pipe(parent_pipe, proc)
1887
1888
def add_pipe(self, parent_pipe, proc):
1410
1889
"""Dummy function; override as necessary"""
1411
pass
1890
raise NotImplementedError
1891
1412
1892
1413
1893
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1414
1894
socketserver.TCPServer, object):
1420
1900
use_ipv6: Boolean; to use IPv6 or not
1421
1901
"""
1422
1902
def __init__(self, server_address, RequestHandlerClass,
1423
interface=None, use_ipv6=True):
1903
interface=None, use_ipv6=True, socketfd=None):
1904
"""If socketfd is set, use that file descriptor instead of
1905
creating a new one with socket.socket().
1906
"""
1424
1907
self.interface = interface
1425
1908
if use_ipv6:
1426
1909
self.address_family = socket.AF_INET6
1910
if socketfd is not None:
1911
# Save the file descriptor
1912
self.socketfd = socketfd
1913
# Save the original socket.socket() function
1914
self.socket_socket = socket.socket
1915
# To implement --socket, we monkey patch socket.socket.
1916
#
1917
# (When socketserver.TCPServer is a new-style class, we
1918
# could make self.socket into a property instead of monkey
1919
# patching socket.socket.)
1920
#
1921
# Create a one-time-only replacement for socket.socket()
1922
@functools.wraps(socket.socket)
1923
def socket_wrapper(*args, **kwargs):
1924
# Restore original function so subsequent calls are
1925
# not affected.
1926
socket.socket = self.socket_socket
1927
del self.socket_socket
1928
# This time only, return a new socket object from the
1929
# saved file descriptor.
1930
return socket.fromfd(self.socketfd, *args, **kwargs)
1931
# Replace socket.socket() function with wrapper
1932
socket.socket = socket_wrapper
1933
# The socketserver.TCPServer.__init__ will call
1934
# socket.socket(), which might be our replacement,
1935
# socket_wrapper(), if socketfd was set.
1427
1936
socketserver.TCPServer.__init__(self, server_address,
1428
1937
RequestHandlerClass)
1938
1429
1939
def server_bind(self):
1430
1940
"""This overrides the normal server_bind() function
1431
1941
to bind to an interface if one was specified, and also NOT to
1432
1942
bind to an address or port if they were not specified."""
1433
1943
if self.interface is not None:
1434
1944
if SO_BINDTODEVICE is None:
1435
logger.error(u"SO_BINDTODEVICE does not exist;"
1436
u" cannot bind to interface %s",
1945
logger.error("SO_BINDTODEVICE does not exist;"
1946
" cannot bind to interface %s",
1437
1947
self.interface)
1438
1948
else:
1439
1949
try:
1440
1950
self.socket.setsockopt(socket.SOL_SOCKET,
1441
1951
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)
1952
str(self.interface + '\0'))
1953
except socket.error as error:
1954
if error.errno == errno.EPERM:
1955
logger.error("No permission to bind to"
1956
" interface %s", self.interface)
1957
elif error.errno == errno.ENOPROTOOPT:
1958
logger.error("SO_BINDTODEVICE not available;"
1959
" cannot bind to interface %s",
1960
self.interface)
1961
elif error.errno == errno.ENODEV:
1962
logger.error("Interface %s does not exist,"
1963
" cannot bind", self.interface)
1453
1964
else:
1454
1965
raise
1455
1966
# Only bind(2) the socket if we really need to.
1456
1967
if self.server_address[0] or self.server_address[1]:
1457
1968
if not self.server_address[0]:
1458
1969
if self.address_family == socket.AF_INET6:
1459
any_address = u"::" # in6addr_any
1970
any_address = "::" # in6addr_any
1460
1971
else:
1461
1972
any_address = socket.INADDR_ANY
1462
1973
self.server_address = (any_address,
1485
1996
"""
1486
1997
def __init__(self, server_address, RequestHandlerClass,
1487
1998
interface=None, use_ipv6=True, clients=None,
1488
gnutls_priority=None, use_dbus=True):
1999
gnutls_priority=None, use_dbus=True, socketfd=None):
1489
2000
self.enabled = False
1490
2001
self.clients = clients
1491
2002
if self.clients is None:
1492
self.clients = set()
2003
self.clients = {}
1493
2004
self.use_dbus = use_dbus
1494
2005
self.gnutls_priority = gnutls_priority
1495
2006
IPv6_TCPServer.__init__(self, server_address,
1496
2007
RequestHandlerClass,
1497
2008
interface = interface,
1498
use_ipv6 = use_ipv6)
2009
use_ipv6 = use_ipv6,
2010
socketfd = socketfd)
1499
2011
def server_activate(self):
1500
2012
if self.enabled:
1501
2013
return socketserver.TCPServer.server_activate(self)
2014
1502
2015
def enable(self):
1503
2016
self.enabled = True
1504
def add_pipe(self, parent_pipe):
2017
2018
def add_pipe(self, parent_pipe, proc):
1505
2019
# Call "handle_ipc" for both data and EOF events
1506
2020
gobject.io_add_watch(parent_pipe.fileno(),
1507
2021
gobject.IO_IN | gobject.IO_HUP,
1508
2022
functools.partial(self.handle_ipc,
1509
parent_pipe = parent_pipe))
1510
2023
parent_pipe =
2024
parent_pipe,
2025
proc = proc))
2026
1511
2027
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):
2028
proc = None, client_object=None):
2029
# error, or the other end of multiprocessing.Pipe has closed
2030
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2031
# Wait for other process to exit
2032
proc.join()
1529
2033
return False
1530
2034
1531
2035
# Read a request from the child
1536
2040
fpr = request[1]
1537
2041
address = request[2]
1538
2042
1539
for c in self.clients:
2043
for c in self.clients.itervalues():
1540
2044
if c.fingerprint == fpr:
1541
2045
client = c
1542
2046
break
1543
2047
else:
1544
logger.warning(u"Client not found for fingerprint: %s, ad"
1545
u"dress: %s", fpr, address)
2048
logger.info("Client not found for fingerprint: %s, ad"
2049
"dress: %s", fpr, address)
1546
2050
if self.use_dbus:
1547
2051
# Emit D-Bus signal
1548
mandos_dbus_service.ClientNotFound(fpr, address[0])
2052
mandos_dbus_service.ClientNotFound(fpr,
2053
address[0])
1549
2054
parent_pipe.send(False)
1550
2055
return False
1551
2056
1552
2057
gobject.io_add_watch(parent_pipe.fileno(),
1553
2058
gobject.IO_IN | gobject.IO_HUP,
1554
2059
functools.partial(self.handle_ipc,
1555
parent_pipe = parent_pipe,
1556
client_object = client))
2060
parent_pipe =
2061
parent_pipe,
2062
proc = proc,
2063
client_object =
2064
client))
1557
2065
parent_pipe.send(True)
1558
# remove the old hook in favor of the new above hook on same fileno
2066
# remove the old hook in favor of the new above hook on
2067
# same fileno
1559
2068
return False
1560
2069
if command == 'funcall':
1561
2070
funcname = request[1]
1562
2071
args = request[2]
1563
2072
kwargs = request[3]
1564
2073
1565
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1566
2074
parent_pipe.send(('data', getattr(client_object,
2075
funcname)(*args,
2076
**kwargs)))
2077
1567
2078
if command == 'getattr':
1568
2079
attrname = request[1]
1569
2080
if callable(client_object.__getattribute__(attrname)):
1570
2081
parent_pipe.send(('function',))
1571
2082
else:
1572
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2083
parent_pipe.send(('data', client_object
2084
.__getattribute__(attrname)))
1573
2085
1574
2086
if command == 'setattr':
1575
2087
attrname = request[1]
1576
2088
value = request[2]
1577
2089
setattr(client_object, attrname, value)
1578
2090
1579
2091
return True
1580
2092
1581
2093
2094
def rfc3339_duration_to_delta(duration):
2095
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2096
2097
>>> rfc3339_duration_to_delta("P7D")
2098
datetime.timedelta(7)
2099
>>> rfc3339_duration_to_delta("PT60S")
2100
datetime.timedelta(0, 60)
2101
>>> rfc3339_duration_to_delta("PT60M")
2102
datetime.timedelta(0, 3600)
2103
>>> rfc3339_duration_to_delta("PT24H")
2104
datetime.timedelta(1)
2105
>>> rfc3339_duration_to_delta("P1W")
2106
datetime.timedelta(7)
2107
>>> rfc3339_duration_to_delta("PT5M30S")
2108
datetime.timedelta(0, 330)
2109
>>> rfc3339_duration_to_delta("P1DT3M20S")
2110
datetime.timedelta(1, 200)
2111
"""
2112
2113
# Parsing an RFC 3339 duration with regular expressions is not
2114
# possible - there would have to be multiple places for the same
2115
# values, like seconds. The current code, while more esoteric, is
2116
# cleaner without depending on a parsing library. If Python had a
2117
# built-in library for parsing we would use it, but we'd like to
2118
# avoid excessive use of external libraries.
2119
2120
# New type for defining tokens, syntax, and semantics all-in-one
2121
Token = collections.namedtuple("Token",
2122
("regexp", # To match token; if
2123
# "value" is not None,
2124
# must have a "group"
2125
# containing digits
2126
"value", # datetime.timedelta or
2127
# None
2128
"followers")) # Tokens valid after
2129
# this token
2130
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2131
# the "duration" ABNF definition in RFC 3339, Appendix A.
2132
token_end = Token(re.compile(r"$"), None, frozenset())
2133
token_second = Token(re.compile(r"(\d+)S"),
2134
datetime.timedelta(seconds=1),
2135
frozenset((token_end,)))
2136
token_minute = Token(re.compile(r"(\d+)M"),
2137
datetime.timedelta(minutes=1),
2138
frozenset((token_second, token_end)))
2139
token_hour = Token(re.compile(r"(\d+)H"),
2140
datetime.timedelta(hours=1),
2141
frozenset((token_minute, token_end)))
2142
token_time = Token(re.compile(r"T"),
2143
None,
2144
frozenset((token_hour, token_minute,
2145
token_second)))
2146
token_day = Token(re.compile(r"(\d+)D"),
2147
datetime.timedelta(days=1),
2148
frozenset((token_time, token_end)))
2149
token_month = Token(re.compile(r"(\d+)M"),
2150
datetime.timedelta(weeks=4),
2151
frozenset((token_day, token_end)))
2152
token_year = Token(re.compile(r"(\d+)Y"),
2153
datetime.timedelta(weeks=52),
2154
frozenset((token_month, token_end)))
2155
token_week = Token(re.compile(r"(\d+)W"),
2156
datetime.timedelta(weeks=1),
2157
frozenset((token_end,)))
2158
token_duration = Token(re.compile(r"P"), None,
2159
frozenset((token_year, token_month,
2160
token_day, token_time,
2161
token_week))),
2162
# Define starting values
2163
value = datetime.timedelta() # Value so far
2164
found_token = None
2165
followers = frozenset(token_duration,) # Following valid tokens
2166
s = duration # String left to parse
2167
# Loop until end token is found
2168
while found_token is not token_end:
2169
# Search for any currently valid tokens
2170
for token in followers:
2171
match = token.regexp.match(s)
2172
if match is not None:
2173
# Token found
2174
if token.value is not None:
2175
# Value found, parse digits
2176
factor = int(match.group(1), 10)
2177
# Add to value so far
2178
value += factor * token.value
2179
# Strip token from string
2180
s = token.regexp.sub("", s, 1)
2181
# Go to found token
2182
found_token = token
2183
# Set valid next tokens
2184
followers = found_token.followers
2185
break
2186
else:
2187
# No currently valid tokens were found
2188
raise ValueError("Invalid RFC 3339 duration")
2189
# End token found
2190
return value
2191
2192
1582
2193
def string_to_delta(interval):
1583
2194
"""Parse a string and return a datetime.timedelta
1584
2195
1585
>>> string_to_delta(u'7d')
2196
>>> string_to_delta('7d')
1586
2197
datetime.timedelta(7)
1587
>>> string_to_delta(u'60s')
2198
>>> string_to_delta('60s')
1588
2199
datetime.timedelta(0, 60)
1589
>>> string_to_delta(u'60m')
2200
>>> string_to_delta('60m')
1590
2201
datetime.timedelta(0, 3600)
1591
>>> string_to_delta(u'24h')
2202
>>> string_to_delta('24h')
1592
2203
datetime.timedelta(1)
1593
>>> string_to_delta(u'1w')
2204
>>> string_to_delta('1w')
1594
2205
datetime.timedelta(7)
1595
>>> string_to_delta(u'5m 30s')
2206
>>> string_to_delta('5m 30s')
1596
2207
datetime.timedelta(0, 330)
1597
2208
"""
2209
2210
try:
2211
return rfc3339_duration_to_delta(interval)
2212
except ValueError:
2213
pass
2214
1598
2215
timevalue = datetime.timedelta(0)
1599
2216
for s in interval.split():
1600
2217
try:
1601
2218
suffix = unicode(s[-1])
1602
2219
value = int(s[:-1])
1603
if suffix == u"d":
2220
if suffix == "d":
1604
2221
delta = datetime.timedelta(value)
1605
elif suffix == u"s":
2222
elif suffix == "s":
1606
2223
delta = datetime.timedelta(0, value)
1607
elif suffix == u"m":
2224
elif suffix == "m":
1608
2225
delta = datetime.timedelta(0, 0, 0, 0, value)
1609
elif suffix == u"h":
2226
elif suffix == "h":
1610
2227
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1611
elif suffix == u"w":
2228
elif suffix == "w":
1612
2229
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1613
2230
else:
1614
raise ValueError(u"Unknown suffix %r" % suffix)
1615
except (ValueError, IndexError), e:
1616
raise ValueError(e.message)
2231
raise ValueError("Unknown suffix {0!r}"
2232
.format(suffix))
2233
except (ValueError, IndexError) as e:
2234
raise ValueError(*(e.args))
1617
2235
timevalue += delta
1618
2236
return timevalue
1619
2237
1620
2238
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
2239
def daemon(nochdir = False, noclose = False):
1646
2240
"""See daemon(3). Standard BSD Unix function.
1647
2241
1650
2244
sys.exit()
1651
2245
os.setsid()
1652
2246
if not nochdir:
1653
os.chdir(u"/")
2247
os.chdir("/")
1654
2248
if os.fork():
1655
2249
sys.exit()
1656
2250
if not noclose:
1657
2251
# Close all standard open file descriptors
1658
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2252
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1659
2253
if not stat.S_ISCHR(os.fstat(null).st_mode):
1660
2254
raise OSError(errno.ENODEV,
1661
u"%s not a character device"
1662
% os.path.devnull)
2255
"{0} not a character device"
2256
.format(os.devnull))
1663
2257
os.dup2(null, sys.stdin.fileno())
1664
2258
os.dup2(null, sys.stdout.fileno())
1665
2259
os.dup2(null, sys.stderr.fileno())
1672
2266
##################################################################
1673
2267
# Parsing of options, both command line and config file
1674
2268
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]
2269
parser = argparse.ArgumentParser()
2270
parser.add_argument("-v", "--version", action="version",
2271
version = "%(prog)s {0}".format(version),
2272
help="show version number and exit")
2273
parser.add_argument("-i", "--interface", metavar="IF",
2274
help="Bind to interface IF")
2275
parser.add_argument("-a", "--address",
2276
help="Address to listen for requests on")
2277
parser.add_argument("-p", "--port", type=int,
2278
help="Port number to receive requests on")
2279
parser.add_argument("--check", action="store_true",
2280
help="Run self-test")
2281
parser.add_argument("--debug", action="store_true",
2282
help="Debug mode; run in foreground and log"
2283
" to terminal")
2284
parser.add_argument("--debuglevel", metavar="LEVEL",
2285
help="Debug level for stdout output")
2286
parser.add_argument("--priority", help="GnuTLS"
2287
" priority string (see GnuTLS documentation)")
2288
parser.add_argument("--servicename",
2289
metavar="NAME", help="Zeroconf service name")
2290
parser.add_argument("--configdir",
2291
default="/etc/mandos", metavar="DIR",
2292
help="Directory to search for configuration"
2293
" files")
2294
parser.add_argument("--no-dbus", action="store_false",
2295
dest="use_dbus", help="Do not provide D-Bus"
2296
" system bus interface")
2297
parser.add_argument("--no-ipv6", action="store_false",
2298
dest="use_ipv6", help="Do not use IPv6")
2299
parser.add_argument("--no-restore", action="store_false",
2300
dest="restore", help="Do not restore stored"
2301
" state")
2302
parser.add_argument("--socket", type=int,
2303
help="Specify a file descriptor to a network"
2304
" socket to use instead of creating one")
2305
parser.add_argument("--statedir", metavar="DIR",
2306
help="Directory to save/restore state in")
2307
parser.add_argument("--foreground", action="store_true",
2308
help="Run in foreground")
2309
2310
options = parser.parse_args()
1703
2311
1704
2312
if options.check:
1705
2313
import doctest
1707
2315
sys.exit()
1708
2316
1709
2317
# 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"",
2318
server_defaults = { "interface": "",
2319
"address": "",
2320
"port": "",
2321
"debug": "False",
2322
"priority":
2323
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2324
"servicename": "Mandos",
2325
"use_dbus": "True",
2326
"use_ipv6": "True",
2327
"debuglevel": "",
2328
"restore": "True",
2329
"socket": "",
2330
"statedir": "/var/lib/mandos",
2331
"foreground": "False",
1720
2332
}
1721
2333
1722
2334
# Parse config file for server-global settings
1723
2335
server_config = configparser.SafeConfigParser(server_defaults)
1724
2336
del server_defaults
1725
2337
server_config.read(os.path.join(options.configdir,
1726
u"mandos.conf"))
2338
"mandos.conf"))
1727
2339
# Convert the SafeConfigParser object to a dict
1728
2340
server_settings = server_config.defaults()
1729
2341
# 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",
2342
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2343
server_settings[option] = server_config.getboolean("DEFAULT",
1732
2344
option)
1733
2345
if server_settings["port"]:
1734
server_settings["port"] = server_config.getint(u"DEFAULT",
1735
u"port")
2346
server_settings["port"] = server_config.getint("DEFAULT",
2347
"port")
2348
if server_settings["socket"]:
2349
server_settings["socket"] = server_config.getint("DEFAULT",
2350
"socket")
2351
# Later, stdin will, and stdout and stderr might, be dup'ed
2352
# over with an opened os.devnull. But we don't want this to
2353
# happen with a supplied network socket.
2354
if 0 <= server_settings["socket"] <= 2:
2355
server_settings["socket"] = os.dup(server_settings
2356
["socket"])
1736
2357
del server_config
1737
2358
1738
2359
# Override the settings from the config file with command line
1739
2360
# 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"):
2361
for option in ("interface", "address", "port", "debug",
2362
"priority", "servicename", "configdir",
2363
"use_dbus", "use_ipv6", "debuglevel", "restore",
2364
"statedir", "socket", "foreground"):
1743
2365
value = getattr(options, option)
1744
2366
if value is not None:
1745
2367
server_settings[option] = value
1748
2370
for option in server_settings.keys():
1749
2371
if type(server_settings[option]) is str:
1750
2372
server_settings[option] = unicode(server_settings[option])
2373
# Debug implies foreground
2374
if server_settings["debug"]:
2375
server_settings["foreground"] = True
1751
2376
# Now we have our good server settings in "server_settings"
1752
2377
1753
2378
##################################################################
1754
2379
1755
2380
# 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":
2381
debug = server_settings["debug"]
2382
debuglevel = server_settings["debuglevel"]
2383
use_dbus = server_settings["use_dbus"]
2384
use_ipv6 = server_settings["use_ipv6"]
2385
stored_state_path = os.path.join(server_settings["statedir"],
2386
stored_state_file)
2387
foreground = server_settings["foreground"]
2388
2389
if debug:
2390
initlogger(debug, logging.DEBUG)
2391
else:
2392
if not debuglevel:
2393
initlogger(debug)
2394
else:
2395
level = getattr(logging, debuglevel.upper())
2396
initlogger(debug, level)
2397
2398
if server_settings["servicename"] != "Mandos":
1762
2399
syslogger.setFormatter(logging.Formatter
1763
(u'Mandos (%s) [%%(process)d]:'
1764
u' %%(levelname)s: %%(message)s'
1765
% server_settings[u"servicename"]))
2400
('Mandos ({0}) [%(process)d]:'
2401
' %(levelname)s: %(message)s'
2402
.format(server_settings
2403
["servicename"])))
1766
2404
1767
2405
# 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"))
2406
client_config = configparser.SafeConfigParser(Client
2407
.client_defaults)
2408
client_config.read(os.path.join(server_settings["configdir"],
2409
"clients.conf"))
1778
2410
1779
2411
global mandos_dbus_service
1780
2412
mandos_dbus_service = None
1781
2413
1782
tcp_server = MandosServer((server_settings[u"address"],
1783
server_settings[u"port"]),
2414
tcp_server = MandosServer((server_settings["address"],
2415
server_settings["port"]),
1784
2416
ClientHandler,
1785
interface=(server_settings[u"interface"]
2417
interface=(server_settings["interface"]
1786
2418
or None),
1787
2419
use_ipv6=use_ipv6,
1788
2420
gnutls_priority=
1789
server_settings[u"priority"],
1790
use_dbus=use_dbus)
1791
if not debug:
1792
pidfilename = u"/var/run/mandos.pid"
2421
server_settings["priority"],
2422
use_dbus=use_dbus,
2423
socketfd=(server_settings["socket"]
2424
or None))
2425
if not foreground:
2426
pidfilename = "/var/run/mandos.pid"
2427
pidfile = None
1793
2428
try:
1794
pidfile = open(pidfilename, u"w")
1795
except IOError:
1796
logger.error(u"Could not open file %r", pidfilename)
2429
pidfile = open(pidfilename, "w")
2430
except IOError as e:
2431
logger.error("Could not open file %r", pidfilename,
2432
exc_info=e)
1797
2433
1798
try:
1799
uid = pwd.getpwnam(u"_mandos").pw_uid
1800
gid = pwd.getpwnam(u"_mandos").pw_gid
1801
except KeyError:
2434
for name in ("_mandos", "mandos", "nobody"):
1802
2435
try:
1803
uid = pwd.getpwnam(u"mandos").pw_uid
1804
gid = pwd.getpwnam(u"mandos").pw_gid
2436
uid = pwd.getpwnam(name).pw_uid
2437
gid = pwd.getpwnam(name).pw_gid
2438
break
1805
2439
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
2440
continue
2441
else:
2442
uid = 65534
2443
gid = 65534
1812
2444
try:
1813
2445
os.setgid(gid)
1814
2446
os.setuid(uid)
1815
except OSError, error:
1816
if error[0] != errno.EPERM:
2447
except OSError as error:
2448
if error.errno != errno.EPERM:
1817
2449
raise error
1818
2450
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
2451
if debug:
1828
2452
# Enable all possible GnuTLS debugging
1829
2453
1833
2457
1834
2458
@gnutls.library.types.gnutls_log_func
1835
2459
def debug_gnutls(level, string):
1836
logger.debug(u"GnuTLS: %s", string[:-1])
2460
logger.debug("GnuTLS: %s", string[:-1])
1837
2461
1838
2462
(gnutls.library.functions
1839
2463
.gnutls_global_set_log_function(debug_gnutls))
1840
2464
1841
2465
# Redirect stdin so all checkers get /dev/null
1842
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2466
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1843
2467
os.dup2(null, sys.stdin.fileno())
1844
2468
if null > 2:
1845
2469
os.close(null)
1846
else:
1847
# No console logging
1848
logger.removeHandler(console)
1849
2470
2471
# Need to fork before connecting to D-Bus
2472
if not foreground:
2473
# Close all input and output, do double fork, etc.
2474
daemon()
2475
2476
# multiprocessing will use threads, so before we use gobject we
2477
# need to inform gobject that threads will be used.
2478
gobject.threads_init()
1850
2479
1851
2480
global main_loop
1852
2481
# From the Avahi example code
1853
DBusGMainLoop(set_as_default=True )
2482
DBusGMainLoop(set_as_default=True)
1854
2483
main_loop = gobject.MainLoop()
1855
2484
bus = dbus.SystemBus()
1856
2485
# End of Avahi example code
1857
2486
if use_dbus:
1858
2487
try:
1859
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2488
bus_name = dbus.service.BusName("se.recompile.Mandos",
1860
2489
bus, do_not_queue=True)
1861
except dbus.exceptions.NameExistsException, e:
1862
logger.error(unicode(e) + u", disabling D-Bus")
2490
old_bus_name = (dbus.service.BusName
2491
("se.bsnet.fukt.Mandos", bus,
2492
do_not_queue=True))
2493
except dbus.exceptions.NameExistsException as e:
2494
logger.error("Disabling D-Bus:", exc_info=e)
1863
2495
use_dbus = False
1864
server_settings[u"use_dbus"] = False
2496
server_settings["use_dbus"] = False
1865
2497
tcp_server.use_dbus = False
1866
2498
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)
2499
service = AvahiServiceToSyslog(name =
2500
server_settings["servicename"],
2501
servicetype = "_mandos._tcp",
2502
protocol = protocol, bus = bus)
1870
2503
if server_settings["interface"]:
1871
2504
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
2505
(str(server_settings["interface"])))
2506
1878
2507
global multiprocessing_manager
1879
2508
multiprocessing_manager = multiprocessing.Manager()
1880
2509
1881
2510
client_class = Client
1882
2511
if use_dbus:
1883
2512
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):
2513
2514
client_settings = Client.config_parser(client_config)
2515
old_client_settings = {}
2516
clients_data = {}
2517
2518
# Get client data and settings from last running state.
2519
if server_settings["restore"]:
2520
try:
2521
with open(stored_state_path, "rb") as stored_state:
2522
clients_data, old_client_settings = (pickle.load
2523
(stored_state))
2524
os.remove(stored_state_path)
2525
except IOError as e:
2526
if e.errno == errno.ENOENT:
2527
logger.warning("Could not load persistent state: {0}"
2528
.format(os.strerror(e.errno)))
2529
else:
2530
logger.critical("Could not load persistent state:",
2531
exc_info=e)
2532
raise
2533
except EOFError as e:
2534
logger.warning("Could not load persistent state: "
2535
"EOFError:", exc_info=e)
2536
2537
with PGPEngine() as pgp:
2538
for client_name, client in clients_data.iteritems():
2539
# Decide which value to use after restoring saved state.
2540
# We have three different values: Old config file,
2541
# new config file, and saved state.
2542
# New config value takes precedence if it differs from old
2543
# config value, otherwise use saved state.
2544
for name, value in client_settings[client_name].items():
2545
try:
2546
# For each value in new config, check if it
2547
# differs from the old config value (Except for
2548
# the "secret" attribute)
2549
if (name != "secret" and
2550
value != old_client_settings[client_name]
2551
[name]):
2552
client[name] = value
2553
except KeyError:
2554
pass
2555
2556
# Clients who has passed its expire date can still be
2557
# enabled if its last checker was successful. Clients
2558
# whose checker succeeded before we stored its state is
2559
# assumed to have successfully run all checkers during
2560
# downtime.
2561
if client["enabled"]:
2562
if datetime.datetime.utcnow() >= client["expires"]:
2563
if not client["last_checked_ok"]:
2564
logger.warning(
2565
"disabling client {0} - Client never "
2566
"performed a successful checker"
2567
.format(client_name))
2568
client["enabled"] = False
2569
elif client["last_checker_status"] != 0:
2570
logger.warning(
2571
"disabling client {0} - Client "
2572
"last checker failed with error code {1}"
2573
.format(client_name,
2574
client["last_checker_status"]))
2575
client["enabled"] = False
2576
else:
2577
client["expires"] = (datetime.datetime
2578
.utcnow()
2579
+ client["timeout"])
2580
logger.debug("Last checker succeeded,"
2581
" keeping {0} enabled"
2582
.format(client_name))
1891
2583
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()))
2584
client["secret"] = (
2585
pgp.decrypt(client["encrypted_secret"],
2586
client_settings[client_name]
2587
["secret"]))
2588
except PGPError:
2589
# If decryption fails, we use secret from new settings
2590
logger.debug("Failed to decrypt {0} old secret"
2591
.format(client_name))
2592
client["secret"] = (
2593
client_settings[client_name]["secret"])
2594
2595
# Add/remove clients based on new changes made to config
2596
for client_name in (set(old_client_settings)
2597
- set(client_settings)):
2598
del clients_data[client_name]
2599
for client_name in (set(client_settings)
2600
- set(old_client_settings)):
2601
clients_data[client_name] = client_settings[client_name]
2602
2603
# Create all client objects
2604
for client_name, client in clients_data.iteritems():
2605
tcp_server.clients[client_name] = client_class(
2606
name = client_name, settings = client)
2607
1901
2608
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
2609
logger.warning("No clients defined")
2610
2611
if not foreground:
2612
if pidfile is not None:
2613
try:
2614
with pidfile:
2615
pid = os.getpid()
2616
pidfile.write(str(pid) + "\n".encode("utf-8"))
2617
except IOError:
2618
logger.error("Could not write to file %r with PID %d",
2619
pidfilename, pid)
2620
del pidfile
1916
2621
del pidfilename
1917
1918
signal.signal(signal.SIGINT, signal.SIG_IGN)
1919
2622
1920
2623
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1921
2624
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1922
2625
1923
2626
if use_dbus:
1924
class MandosDBusService(dbus.service.Object):
2627
@alternate_dbus_interfaces({"se.recompile.Mandos":
2628
"se.bsnet.fukt.Mandos"})
2629
class MandosDBusService(DBusObjectWithProperties):
1925
2630
"""A D-Bus proxy object"""
1926
2631
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")
2632
dbus.service.Object.__init__(self, bus, "/")
2633
_interface = "se.recompile.Mandos"
2634
2635
@dbus_interface_annotations(_interface)
2636
def _foo(self):
2637
return { "org.freedesktop.DBus.Property"
2638
".EmitsChangedSignal":
2639
"false"}
2640
2641
@dbus.service.signal(_interface, signature="o")
1931
2642
def ClientAdded(self, objpath):
1932
2643
"D-Bus signal"
1933
2644
pass
1934
2645
1935
@dbus.service.signal(_interface, signature=u"ss")
2646
@dbus.service.signal(_interface, signature="ss")
1936
2647
def ClientNotFound(self, fingerprint, address):
1937
2648
"D-Bus signal"
1938
2649
pass
1939
2650
1940
@dbus.service.signal(_interface, signature=u"os")
2651
@dbus.service.signal(_interface, signature="os")
1941
2652
def ClientRemoved(self, objpath, name):
1942
2653
"D-Bus signal"
1943
2654
pass
1944
2655
1945
@dbus.service.method(_interface, out_signature=u"ao")
2656
@dbus.service.method(_interface, out_signature="ao")
1946
2657
def GetAllClients(self):
1947
2658
"D-Bus method"
1948
2659
return dbus.Array(c.dbus_object_path
1949
for c in tcp_server.clients)
2660
for c in
2661
tcp_server.clients.itervalues())
1950
2662
1951
2663
@dbus.service.method(_interface,
1952
out_signature=u"a{oa{sv}}")
2664
out_signature="a{oa{sv}}")
1953
2665
def GetAllClientsWithProperties(self):
1954
2666
"D-Bus method"
1955
2667
return dbus.Dictionary(
1956
((c.dbus_object_path, c.GetAll(u""))
1957
for c in tcp_server.clients),
1958
signature=u"oa{sv}")
2668
((c.dbus_object_path, c.GetAll(""))
2669
for c in tcp_server.clients.itervalues()),
2670
signature="oa{sv}")
1959
2671
1960
@dbus.service.method(_interface, in_signature=u"o")
2672
@dbus.service.method(_interface, in_signature="o")
1961
2673
def RemoveClient(self, object_path):
1962
2674
"D-Bus method"
1963
for c in tcp_server.clients:
2675
for c in tcp_server.clients.itervalues():
1964
2676
if c.dbus_object_path == object_path:
1965
tcp_server.clients.remove(c)
2677
del tcp_server.clients[c.name]
1966
2678
c.remove_from_connection()
1967
2679
# Don't signal anything except ClientRemoved
1968
2680
c.disable(quiet=True)
1979
2691
"Cleanup function; run on exit"
1980
2692
service.cleanup()
1981
2693
2694
multiprocessing.active_children()
2695
if not (tcp_server.clients or client_settings):
2696
return
2697
2698
# Store client before exiting. Secrets are encrypted with key
2699
# based on what config file has. If config file is
2700
# removed/edited, old secret will thus be unrecovable.
2701
clients = {}
2702
with PGPEngine() as pgp:
2703
for client in tcp_server.clients.itervalues():
2704
key = client_settings[client.name]["secret"]
2705
client.encrypted_secret = pgp.encrypt(client.secret,
2706
key)
2707
client_dict = {}
2708
2709
# A list of attributes that can not be pickled
2710
# + secret.
2711
exclude = set(("bus", "changedstate", "secret",
2712
"checker"))
2713
for name, typ in (inspect.getmembers
2714
(dbus.service.Object)):
2715
exclude.add(name)
2716
2717
client_dict["encrypted_secret"] = (client
2718
.encrypted_secret)
2719
for attr in client.client_structure:
2720
if attr not in exclude:
2721
client_dict[attr] = getattr(client, attr)
2722
2723
clients[client.name] = client_dict
2724
del client_settings[client.name]["secret"]
2725
2726
try:
2727
with (tempfile.NamedTemporaryFile
2728
(mode='wb', suffix=".pickle", prefix='clients-',
2729
dir=os.path.dirname(stored_state_path),
2730
delete=False)) as stored_state:
2731
pickle.dump((clients, client_settings), stored_state)
2732
tempname=stored_state.name
2733
os.rename(tempname, stored_state_path)
2734
except (IOError, OSError) as e:
2735
if not debug:
2736
try:
2737
os.remove(tempname)
2738
except NameError:
2739
pass
2740
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2741
logger.warning("Could not save persistent state: {0}"
2742
.format(os.strerror(e.errno)))
2743
else:
2744
logger.warning("Could not save persistent state:",
2745
exc_info=e)
2746
raise e
2747
2748
# Delete all clients, and settings from config
1982
2749
while tcp_server.clients:
1983
client = tcp_server.clients.pop()
2750
name, client = tcp_server.clients.popitem()
1984
2751
if use_dbus:
1985
2752
client.remove_from_connection()
1986
client.disable_hook = None
1987
2753
# Don't signal anything except ClientRemoved
1988
2754
client.disable(quiet=True)
1989
2755
if use_dbus:
1990
2756
# Emit D-Bus signal
1991
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2757
mandos_dbus_service.ClientRemoved(client
2758
.dbus_object_path,
1992
2759
client.name)
2760
client_settings.clear()
1993
2761
1994
2762
atexit.register(cleanup)
1995
2763
1996
for client in tcp_server.clients:
2764
for client in tcp_server.clients.itervalues():
1997
2765
if use_dbus:
1998
2766
# Emit D-Bus signal
1999
2767
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2000
client.enable()
2768
# Need to initiate checking of clients
2769
if client.enabled:
2770
client.init_checker()
2001
2771
2002
2772
tcp_server.enable()
2003
2773
tcp_server.server_activate()
2005
2775
# Find out what port we got
2006
2776
service.port = tcp_server.socket.getsockname()[1]
2007
2777
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())
2778
logger.info("Now listening on address %r, port %d,"
2779
" flowinfo %d, scope_id %d",
2780
*tcp_server.socket.getsockname())
2011
2781
else: # IPv4
2012
logger.info(u"Now listening on address %r, port %d"
2013
% tcp_server.socket.getsockname())
2782
logger.info("Now listening on address %r, port %d",
2783
*tcp_server.socket.getsockname())
2014
2784
2015
2785
#service.interface = tcp_server.socket.getsockname()[3]
2016
2786
2018
2788
# From the Avahi example code
2019
2789
try:
2020
2790
service.activate()
2021
except dbus.exceptions.DBusException, error:
2022
logger.critical(u"DBusException: %s", error)
2791
except dbus.exceptions.DBusException as error:
2792
logger.critical("D-Bus Exception", exc_info=error)
2023
2793
cleanup()
2024
2794
sys.exit(1)
2025
2795
# End of Avahi example code
2029
2799
(tcp_server.handle_request
2030
2800
(*args[2:], **kwargs) or True))
2031
2801
2032
logger.debug(u"Starting main loop")
2802
logger.debug("Starting main loop")
2033
2803
main_loop.run()
2034
except AvahiError, error:
2035
logger.critical(u"AvahiError: %s", error)
2804
except AvahiError as error:
2805
logger.critical("Avahi Error", exc_info=error)
2036
2806
cleanup()
2037
2807
sys.exit(1)
2038
2808
except KeyboardInterrupt:
2039
2809
if debug:
2040
print >> sys.stderr
2041
logger.debug(u"Server received KeyboardInterrupt")
2042
logger.debug(u"Server exiting")
2810
print("", file=sys.stderr)
2811
logger.debug("Server received KeyboardInterrupt")
2812
logger.debug("Server exiting")
2043
2813
# Must run before the D-Bus bus name gets deregistered
2044
2814
cleanup()
2045
2815
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0