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