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