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