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 435
- compare with another revision
- download diff
- download tarball
- view history from revision 435
- Committer: teddy at bsnet
- Date: 2010-09-23 20:14:08 UTC
- Revision ID: teddy@fukt.bsnet.se-20100923201408-4vcvjmml000fr8y5
* Makefile (DOCS): Added "plymouth.8mandos".
(install-server): Also install "mandos-monitor.8" and
"mandos-ctl.8".
(install-client-nokey): Also install "plymouth.8mandos".
(uninstall-server): Also remove "mandos-monitor.8" and
"mandos-ctl.8".
(uninstall-client): Also remove "plymouth.8mandos".
* plugins.d/plymouth.xml: New.
(install-server): Also install "mandos-monitor.8" and
"mandos-ctl.8".
(install-client-nokey): Also install "plymouth.8mandos".
(uninstall-server): Also remove "mandos-monitor.8" and
"mandos-ctl.8".
(uninstall-client): Also remove "plymouth.8mandos".
* plugins.d/plymouth.xml: New.
- 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
403
approval_delay: datetime.timedelta(); Time to wait for approval
404
approval_duration: datetime.timedelta(); Duration of one approval
243
name: string; from the config file, used in log messages and
244
D-Bus identifiers
245
fingerprint: string (40 or 32 hexadecimal digits); used to
246
uniquely identify the client
247
secret: bytestring; sent verbatim (over TLS) to client
248
host: string; available for use by the checker command
249
created: datetime.datetime(); (UTC) object creation
250
last_enabled: datetime.datetime(); (UTC)
251
enabled: bool()
252
last_checked_ok: datetime.datetime(); (UTC) or None
253
timeout: datetime.timedelta(); How long from last_checked_ok
254
until this client is disabled
255
interval: datetime.timedelta(); How often to start a new checker
256
disable_hook: If set, called by disable() as disable_hook(self)
405
257
checker: subprocess.Popen(); a running checker process used
406
258
to see if the client lives.
407
259
'None' if no process is running.
408
checker_callback_tag: a gobject event source tag, or None
409
checker_command: string; External command which is run to check
410
if client lives. %() expansions are done at
260
checker_initiator_tag: a gobject event source tag, or None
261
disable_initiator_tag: - '' -
262
checker_callback_tag: - '' -
263
checker_command: string; External command which is run to check if
264
client lives. %() expansions are done at
411
265
runtime with vars(self) as dict, so that for
412
266
instance %(name)s can be used in the command.
413
checker_initiator_tag: a gobject event source tag, or None
414
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
267
current_checker_command: string; current running checker_command
418
disable_initiator_tag: a gobject event source tag, or None
419
enabled: bool()
420
fingerprint: string (40 or 32 hexadecimal digits); used to
421
uniquely identify the client
422
host: string; available for use by the checker command
423
interval: datetime.timedelta(); How often to start a new checker
424
last_approval_request: datetime.datetime(); (UTC) or None
425
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
430
name: string; from the config file, used in log messages and
431
D-Bus identifiers
432
secret: bytestring; sent verbatim (over TLS) to client
433
timeout: datetime.timedelta(); How long from last_checked_ok
434
until this client is disabled
435
extended_timeout: extra long timeout when secret has been sent
436
runtime_expansions: Allowed attributes for runtime expansion.
437
expires: datetime.datetime(); time (UTC) when a client will be
438
disabled, or None
268
approval_delay: datetime.timedelta(); Time to wait for approval
269
_approved: bool(); 'None' if not yet approved/disapproved
270
approval_duration: datetime.timedelta(); Duration of one approval
439
271
"""
440
272
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
}
273
@staticmethod
274
def _timedelta_to_milliseconds(td):
275
"Convert a datetime.timedelta() to milliseconds"
276
return ((td.days * 24 * 60 * 60 * 1000)
277
+ (td.seconds * 1000)
278
+ (td.microseconds // 1000))
455
279
456
280
def timeout_milliseconds(self):
457
281
"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)
282
return self._timedelta_to_milliseconds(self.timeout)
463
283
464
284
def interval_milliseconds(self):
465
285
"Return the 'interval' attribute in milliseconds"
466
return timedelta_to_milliseconds(self.interval)
467
286
return self._timedelta_to_milliseconds(self.interval)
287
468
288
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):
289
return self._timedelta_to_milliseconds(self.approval_delay)
290
291
def __init__(self, name = None, disable_hook=None, config=None):
292
"""Note: the 'checker' key in 'config' sets the
293
'checker_command' attribute and *not* the 'checker'
294
attribute."""
519
295
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)
296
if config is None:
297
config = {}
298
logger.debug(u"Creating client %r", self.name)
535
299
# Uppercase and remove spaces from fingerprint for later
536
300
# comparison purposes with return value from the fingerprint()
537
301
# 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
302
self.fingerprint = (config[u"fingerprint"].upper()
303
.replace(u" ", u""))
304
logger.debug(u" Fingerprint: %s", self.fingerprint)
305
if u"secret" in config:
306
self.secret = config[u"secret"].decode(u"base64")
307
elif u"secfile" in config:
308
with open(os.path.expanduser(os.path.expandvars
309
(config[u"secfile"])),
310
"rb") as secfile:
311
self.secret = secfile.read()
312
else:
313
raise TypeError(u"No secret or secfile for client %s"
314
% self.name)
315
self.host = config.get(u"host", u"")
316
self.created = datetime.datetime.utcnow()
317
self.enabled = False
318
self.last_enabled = None
319
self.last_checked_ok = None
320
self.timeout = string_to_delta(config[u"timeout"])
321
self.interval = string_to_delta(config[u"interval"])
322
self.disable_hook = disable_hook
543
323
self.checker = None
544
324
self.checker_initiator_tag = None
545
325
self.disable_initiator_tag = None
546
326
self.checker_callback_tag = None
327
self.checker_command = config[u"checker"]
547
328
self.current_checker_command = None
548
self.approved = None
329
self.last_connect = None
330
self._approved = None
331
self.approved_by_default = config.get(u"approved_by_default",
332
True)
549
333
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)
334
self.approval_delay = string_to_delta(
335
config[u"approval_delay"])
336
self.approval_duration = string_to_delta(
337
config[u"approval_duration"])
338
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
564
339
565
# Send notice to process children that client state has changed
566
340
def send_changedstate(self):
567
with self.changedstate:
568
self.changedstate.notify_all()
569
341
self.changedstate.acquire()
342
self.changedstate.notify_all()
343
self.changedstate.release()
344
570
345
def enable(self):
571
346
"""Start this client's checker and timeout hooks"""
572
if getattr(self, "enabled", False):
347
if getattr(self, u"enabled", False):
573
348
# Already enabled
574
349
return
575
self.expires = datetime.datetime.utcnow() + self.timeout
576
self.enabled = True
350
self.send_changedstate()
577
351
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
352
# Schedule a new checker to be started an 'interval' from now,
606
353
# and every interval from then on.
607
if self.checker_initiator_tag is not None:
608
gobject.source_remove(self.checker_initiator_tag)
609
354
self.checker_initiator_tag = (gobject.timeout_add
610
355
(self.interval_milliseconds(),
611
356
self.start_checker))
612
357
# 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
358
self.disable_initiator_tag = (gobject.timeout_add
616
359
(self.timeout_milliseconds(),
617
360
self.disable))
361
self.enabled = True
618
362
# Also start a new checker *right now*.
619
363
self.start_checker()
620
364
365
def disable(self, quiet=True):
366
"""Disable this client."""
367
if not getattr(self, "enabled", False):
368
return False
369
if not quiet:
370
self.send_changedstate()
371
if not quiet:
372
logger.info(u"Disabling client %s", self.name)
373
if getattr(self, u"disable_initiator_tag", False):
374
gobject.source_remove(self.disable_initiator_tag)
375
self.disable_initiator_tag = None
376
if getattr(self, u"checker_initiator_tag", False):
377
gobject.source_remove(self.checker_initiator_tag)
378
self.checker_initiator_tag = None
379
self.stop_checker()
380
if self.disable_hook:
381
self.disable_hook(self)
382
self.enabled = False
383
# Do not run this again if called by a gobject.timeout_add
384
return False
385
386
def __del__(self):
387
self.disable_hook = None
388
self.disable()
389
621
390
def checker_callback(self, pid, condition, command):
622
391
"""The checker has completed, so take appropriate actions."""
623
392
self.checker_callback_tag = None
624
393
self.checker = None
625
394
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",
395
exitstatus = os.WEXITSTATUS(condition)
396
if exitstatus == 0:
397
logger.info(u"Checker for %(name)s succeeded",
629
398
vars(self))
630
399
self.checked_ok()
631
400
else:
632
logger.info("Checker for %(name)s failed",
401
logger.info(u"Checker for %(name)s failed",
633
402
vars(self))
634
403
else:
635
self.last_checker_status = -1
636
logger.warning("Checker for %(name)s crashed?",
404
logger.warning(u"Checker for %(name)s crashed?",
637
405
vars(self))
638
406
639
407
def checked_ok(self):
640
"""Assert that the client has been seen, alive and well."""
408
"""Bump up the timeout for this client.
409
410
This should only be called when the client has been seen,
411
alive and well.
412
"""
641
413
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()
414
gobject.source_remove(self.disable_initiator_tag)
415
self.disable_initiator_tag = (gobject.timeout_add
416
(self.timeout_milliseconds(),
417
self.disable))
660
418
661
419
def start_checker(self):
662
420
"""Start a new checker subprocess if one is not running.
664
422
If a checker already exists, leave it running and do
665
423
nothing."""
666
424
# 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
425
# did that, then if a checker (for some reason) started
426
# running slowly and taking more than 'interval' time, the
427
# client would inevitably timeout, since no checker would get
428
# a chance to run to completion. If we instead leave running
671
429
# checkers alone, the checker would have to take more time
672
430
# than 'timeout' for the client to be disabled, which is as it
673
431
# should be.
675
433
# If a checker exists, make sure it is not a zombie
676
434
try:
677
435
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
678
except (AttributeError, OSError) as error:
436
except (AttributeError, OSError), error:
679
437
if (isinstance(error, OSError)
680
438
and error.errno != errno.ECHILD):
681
439
raise error
682
440
else:
683
441
if pid:
684
logger.warning("Checker was a zombie")
442
logger.warning(u"Checker was a zombie")
685
443
gobject.source_remove(self.checker_callback_tag)
686
444
self.checker_callback(pid, status,
687
445
self.current_checker_command)
692
450
command = self.checker_command % self.host
693
451
except TypeError:
694
452
# Escape attributes for the shell
695
escaped_attrs = dict(
696
(attr,
697
re.escape(unicode(str(getattr(self, attr, "")),
698
errors=
699
'replace')))
700
for attr in
701
self.runtime_expansions)
702
453
escaped_attrs = dict((key,
454
re.escape(unicode(str(val),
455
errors=
456
u'replace')))
457
for key, val in
458
vars(self).iteritems())
703
459
try:
704
460
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)
461
except TypeError, error:
462
logger.error(u'Could not format string "%s":'
463
u' %s', self.checker_command, error)
708
464
return True # Try again later
709
465
self.current_checker_command = command
710
466
try:
711
logger.info("Starting checker %r for %s",
467
logger.info(u"Starting checker %r for %s",
712
468
command, self.name)
713
469
# We don't need to redirect stdout and stderr, since
714
470
# in normal mode, that is already done by daemon(),
716
472
# always replaced by /dev/null.)
717
473
self.checker = subprocess.Popen(command,
718
474
close_fds=True,
719
shell=True, cwd="/")
475
shell=True, cwd=u"/")
720
476
self.checker_callback_tag = (gobject.child_watch_add
721
477
(self.checker.pid,
722
478
self.checker_callback,
727
483
if pid:
728
484
gobject.source_remove(self.checker_callback_tag)
729
485
self.checker_callback(pid, status, command)
730
except OSError as error:
731
logger.error("Failed to start subprocess",
732
exc_info=error)
486
except OSError, error:
487
logger.error(u"Failed to start subprocess: %s",
488
error)
733
489
# Re-run this periodically if run by gobject.timeout_add
734
490
return True
735
491
738
494
if self.checker_callback_tag:
739
495
gobject.source_remove(self.checker_callback_tag)
740
496
self.checker_callback_tag = None
741
if getattr(self, "checker", None) is None:
497
if getattr(self, u"checker", None) is None:
742
498
return
743
logger.debug("Stopping checker for %(name)s", vars(self))
499
logger.debug(u"Stopping checker for %(name)s", vars(self))
744
500
try:
745
self.checker.terminate()
501
os.kill(self.checker.pid, signal.SIGTERM)
746
502
#time.sleep(0.5)
747
503
#if self.checker.poll() is None:
748
# self.checker.kill()
749
except OSError as error:
504
# os.kill(self.checker.pid, signal.SIGKILL)
505
except OSError, error:
750
506
if error.errno != errno.ESRCH: # No such process
751
507
raise
752
508
self.checker = None
753
509
754
755
def dbus_service_property(dbus_interface, signature="v",
756
access="readwrite", byte_arrays=False):
510
def dbus_service_property(dbus_interface, signature=u"v",
511
access=u"readwrite", byte_arrays=False):
757
512
"""Decorators for marking methods of a DBusObjectWithProperties to
758
513
become properties on the D-Bus.
759
514
766
521
"""
767
522
# Encoding deeply encoded byte arrays is not supported yet by the
768
523
# "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))
524
if byte_arrays and signature != u"ay":
525
raise ValueError(u"Byte arrays not supported for non-'ay'"
526
u" signature %r" % signature)
772
527
def decorator(func):
773
528
func._dbus_is_property = True
774
529
func._dbus_interface = dbus_interface
775
530
func._dbus_signature = signature
776
531
func._dbus_access = access
777
532
func._dbus_name = func.__name__
778
if func._dbus_name.endswith("_dbus_property"):
533
if func._dbus_name.endswith(u"_dbus_property"):
779
534
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
535
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
818
536
return func
819
537
return decorator
820
538
840
558
841
559
class DBusObjectWithProperties(dbus.service.Object):
842
560
"""A D-Bus object with properties.
843
561
844
562
Classes inheriting from this can use the dbus_service_property
845
563
decorator to expose methods as D-Bus properties. It exposes the
846
564
standard Get(), Set(), and GetAll() methods on the D-Bus.
847
565
"""
848
566
849
567
@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)
568
def _is_dbus_property(obj):
569
return getattr(obj, u"_dbus_is_property", False)
858
570
859
def _get_all_dbus_things(self, thing):
571
def _get_all_dbus_properties(self):
860
572
"""Returns a generator of (name, attribute) pairs
861
573
"""
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)))
574
return ((prop._dbus_name, prop)
575
for name, prop in
576
inspect.getmembers(self, self._is_dbus_property))
869
577
870
578
def _get_dbus_property(self, interface_name, property_name):
871
579
"""Returns a bound method if one exists which is a D-Bus
872
580
property with the specified name and interface.
873
581
"""
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
582
for name in (property_name,
583
property_name + u"_dbus_property"):
584
prop = getattr(self, name, None)
585
if (prop is None
586
or not self._is_dbus_property(prop)
587
or prop._dbus_name != property_name
588
or (interface_name and prop._dbus_interface
589
and interface_name != prop._dbus_interface)):
590
continue
591
return prop
882
592
# No such property
883
raise DBusPropertyNotFound(self.dbus_object_path + ":"
884
+ interface_name + "."
593
raise DBusPropertyNotFound(self.dbus_object_path + u":"
594
+ interface_name + u"."
885
595
+ property_name)
886
596
887
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
888
out_signature="v")
597
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
598
out_signature=u"v")
889
599
def Get(self, interface_name, property_name):
890
600
"""Standard D-Bus property Get() method, see D-Bus standard.
891
601
"""
892
602
prop = self._get_dbus_property(interface_name, property_name)
893
if prop._dbus_access == "write":
603
if prop._dbus_access == u"write":
894
604
raise DBusPropertyAccessException(property_name)
895
605
value = prop()
896
if not hasattr(value, "variant_level"):
606
if not hasattr(value, u"variant_level"):
897
607
return value
898
608
return type(value)(value, variant_level=value.variant_level+1)
899
609
900
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
901
611
def Set(self, interface_name, property_name, value):
902
612
"""Standard D-Bus property Set() method, see D-Bus standard.
903
613
"""
904
614
prop = self._get_dbus_property(interface_name, property_name)
905
if prop._dbus_access == "read":
615
if prop._dbus_access == u"read":
906
616
raise DBusPropertyAccessException(property_name)
907
if prop._dbus_get_args_options["byte_arrays"]:
617
if prop._dbus_get_args_options[u"byte_arrays"]:
908
618
# The byte_arrays option is not supported yet on
909
619
# signatures other than "ay".
910
if prop._dbus_signature != "ay":
620
if prop._dbus_signature != u"ay":
911
621
raise ValueError
912
value = dbus.ByteArray(b''.join(chr(byte)
913
for byte in value))
622
value = dbus.ByteArray(''.join(unichr(byte)
623
for byte in value))
914
624
prop(value)
915
625
916
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
917
out_signature="a{sv}")
626
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
627
out_signature=u"a{sv}")
918
628
def GetAll(self, interface_name):
919
629
"""Standard D-Bus property GetAll() method, see D-Bus
920
630
standard.
921
631
922
632
Note: Will not include properties with access="write".
923
633
"""
924
properties = {}
925
for name, prop in self._get_all_dbus_things("property"):
634
all = {}
635
for name, prop in self._get_all_dbus_properties():
926
636
if (interface_name
927
637
and interface_name != prop._dbus_interface):
928
638
# Interface non-empty but did not match
929
639
continue
930
640
# Ignore write-only properties
931
if prop._dbus_access == "write":
641
if prop._dbus_access == u"write":
932
642
continue
933
643
value = prop()
934
if not hasattr(value, "variant_level"):
935
properties[name] = value
644
if not hasattr(value, u"variant_level"):
645
all[name] = value
936
646
continue
937
properties[name] = type(value)(value, variant_level=
938
value.variant_level+1)
939
return dbus.Dictionary(properties, signature="sv")
647
all[name] = type(value)(value, variant_level=
648
value.variant_level+1)
649
return dbus.Dictionary(all, signature=u"sv")
940
650
941
651
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
942
out_signature="s",
652
out_signature=u"s",
943
653
path_keyword='object_path',
944
654
connection_keyword='connection')
945
655
def Introspect(self, object_path, connection):
946
"""Overloading of standard D-Bus method.
947
948
Inserts property tags and interface annotation tags.
656
"""Standard D-Bus method, overloaded to insert property tags.
949
657
"""
950
658
xmlstring = dbus.service.Object.Introspect(self, object_path,
951
659
connection)
952
660
try:
953
661
document = xml.dom.minidom.parseString(xmlstring)
954
662
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)
663
e = document.createElement(u"property")
664
e.setAttribute(u"name", name)
665
e.setAttribute(u"type", prop._dbus_signature)
666
e.setAttribute(u"access", prop._dbus_access)
959
667
return e
960
for if_tag in document.getElementsByTagName("interface"):
961
# Add property tags
668
for if_tag in document.getElementsByTagName(u"interface"):
962
669
for tag in (make_tag(document, name, prop)
963
670
for name, prop
964
in self._get_all_dbus_things("property")
671
in self._get_all_dbus_properties()
965
672
if prop._dbus_interface
966
== if_tag.getAttribute("name")):
673
== if_tag.getAttribute(u"name")):
967
674
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
675
# Add the names to the return values for the
1000
676
# "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")
677
if (if_tag.getAttribute(u"name")
678
== u"org.freedesktop.DBus.Properties"):
679
for cn in if_tag.getElementsByTagName(u"method"):
680
if cn.getAttribute(u"name") == u"Get":
681
for arg in cn.getElementsByTagName(u"arg"):
682
if (arg.getAttribute(u"direction")
683
== u"out"):
684
arg.setAttribute(u"name", u"value")
685
elif cn.getAttribute(u"name") == u"GetAll":
686
for arg in cn.getElementsByTagName(u"arg"):
687
if (arg.getAttribute(u"direction")
688
== u"out"):
689
arg.setAttribute(u"name", u"props")
690
xmlstring = document.toxml(u"utf-8")
1015
691
document.unlink()
1016
692
except (AttributeError, xml.dom.DOMException,
1017
xml.parsers.expat.ExpatError) as error:
1018
logger.error("Failed to override Introspection method",
1019
exc_info=error)
693
xml.parsers.expat.ExpatError), error:
694
logger.error(u"Failed to override Introspection method",
695
error)
1020
696
return xmlstring
1021
697
1022
698
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
699
class ClientDBus(Client, DBusObjectWithProperties):
1203
700
"""A Client class using D-Bus
1204
701
1206
703
dbus_object_path: dbus.ObjectPath
1207
704
bus: dbus.SystemBus()
1208
705
"""
1209
1210
runtime_expansions = (Client.runtime_expansions
1211
+ ("dbus_object_path",))
1212
1213
706
# dbus.service.Object doesn't use super(), so we can't either.
1214
707
1215
708
def __init__(self, bus = None, *args, **kwargs):
709
self._approvals_pending = 0
1216
710
self.bus = bus
1217
711
Client.__init__(self, *args, **kwargs)
1218
712
# Only now, when this client is initialized, can it show up on
1219
713
# the D-Bus
1220
client_object_name = unicode(self.name).translate(
1221
{ord("."): ord("_"),
1222
ord("-"): ord("_")})
1223
714
self.dbus_object_path = (dbus.ObjectPath
1224
("/clients/" + client_object_name))
715
(u"/clients/"
716
+ self.name.replace(u".", u"_")))
1225
717
DBusObjectWithProperties.__init__(self, self.bus,
1226
718
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
719
720
def _get_approvals_pending(self):
721
return self._approvals_pending
722
def _set_approvals_pending(self, value):
723
old_value = self._approvals_pending
724
self._approvals_pending = value
725
bval = bool(value)
726
if (hasattr(self, "dbus_object_path")
727
and bval is not bool(old_value)):
728
dbus_bool = dbus.Boolean(bval, variant_level=1)
729
self.PropertyChanged(dbus.String(u"ApprovalPending"),
730
dbus_bool)
731
732
approvals_pending = property(_get_approvals_pending,
733
_set_approvals_pending)
734
del _get_approvals_pending, _set_approvals_pending
735
736
@staticmethod
737
def _datetime_to_dbus(dt, variant_level=0):
738
"""Convert a UTC datetime.datetime() to a D-Bus type."""
739
return dbus.String(dt.isoformat(),
740
variant_level=variant_level)
741
742
def enable(self):
743
oldstate = getattr(self, u"enabled", False)
744
r = Client.enable(self)
745
if oldstate != self.enabled:
746
# Emit D-Bus signals
747
self.PropertyChanged(dbus.String(u"Enabled"),
748
dbus.Boolean(True, variant_level=1))
749
self.PropertyChanged(
750
dbus.String(u"LastEnabled"),
751
self._datetime_to_dbus(self.last_enabled,
752
variant_level=1))
753
return r
754
755
def disable(self, quiet = False):
756
oldstate = getattr(self, u"enabled", False)
757
r = Client.disable(self, quiet=quiet)
758
if not quiet and oldstate != self.enabled:
759
# Emit D-Bus signal
760
self.PropertyChanged(dbus.String(u"Enabled"),
761
dbus.Boolean(False, variant_level=1))
762
return r
1295
763
1296
764
def __del__(self, *args, **kwargs):
1297
765
try:
1298
766
self.remove_from_connection()
1299
767
except LookupError:
1300
768
pass
1301
if hasattr(DBusObjectWithProperties, "__del__"):
769
if hasattr(DBusObjectWithProperties, u"__del__"):
1302
770
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1303
771
Client.__del__(self, *args, **kwargs)
1304
772
1306
774
*args, **kwargs):
1307
775
self.checker_callback_tag = None
1308
776
self.checker = None
777
# Emit D-Bus signal
778
self.PropertyChanged(dbus.String(u"CheckerRunning"),
779
dbus.Boolean(False, variant_level=1))
1309
780
if os.WIFEXITED(condition):
1310
781
exitstatus = os.WEXITSTATUS(condition)
1311
782
# Emit D-Bus signal
1321
792
return Client.checker_callback(self, pid, condition, command,
1322
793
*args, **kwargs)
1323
794
795
def checked_ok(self, *args, **kwargs):
796
r = Client.checked_ok(self, *args, **kwargs)
797
# Emit D-Bus signal
798
self.PropertyChanged(
799
dbus.String(u"LastCheckedOK"),
800
(self._datetime_to_dbus(self.last_checked_ok,
801
variant_level=1)))
802
return r
803
1324
804
def start_checker(self, *args, **kwargs):
1325
805
old_checker = self.checker
1326
806
if self.checker is not None:
1333
813
and old_checker_pid != self.checker.pid):
1334
814
# Emit D-Bus signal
1335
815
self.CheckerStarted(self.current_checker_command)
816
self.PropertyChanged(
817
dbus.String(u"CheckerRunning"),
818
dbus.Boolean(True, variant_level=1))
1336
819
return r
1337
820
821
def stop_checker(self, *args, **kwargs):
822
old_checker = getattr(self, u"checker", None)
823
r = Client.stop_checker(self, *args, **kwargs)
824
if (old_checker is not None
825
and getattr(self, u"checker", None) is None):
826
self.PropertyChanged(dbus.String(u"CheckerRunning"),
827
dbus.Boolean(False, variant_level=1))
828
return r
829
1338
830
def _reset_approved(self):
1339
self.approved = None
831
self._approved = None
1340
832
return False
1341
833
1342
834
def approve(self, value=True):
1343
self.approved = value
1344
gobject.timeout_add(timedelta_to_milliseconds
835
self.send_changedstate()
836
self._approved = value
837
gobject.timeout_add(self._timedelta_to_milliseconds
1345
838
(self.approval_duration),
1346
839
self._reset_approved)
1347
self.send_changedstate()
840
1348
841
1349
842
## 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"}
843
_interface = u"se.bsnet.fukt.Mandos.Client"
1358
844
1359
845
## Signals
1360
846
1361
847
# CheckerCompleted - signal
1362
@dbus.service.signal(_interface, signature="nxs")
848
@dbus.service.signal(_interface, signature=u"nxs")
1363
849
def CheckerCompleted(self, exitcode, waitstatus, command):
1364
850
"D-Bus signal"
1365
851
pass
1366
852
1367
853
# CheckerStarted - signal
1368
@dbus.service.signal(_interface, signature="s")
854
@dbus.service.signal(_interface, signature=u"s")
1369
855
def CheckerStarted(self, command):
1370
856
"D-Bus signal"
1371
857
pass
1372
858
1373
859
# PropertyChanged - signal
1374
@dbus.service.signal(_interface, signature="sv")
860
@dbus.service.signal(_interface, signature=u"sv")
1375
861
def PropertyChanged(self, property, value):
1376
862
"D-Bus signal"
1377
863
pass
1386
872
pass
1387
873
1388
874
# Rejected - signal
1389
@dbus.service.signal(_interface, signature="s")
875
@dbus.service.signal(_interface, signature=u"s")
1390
876
def Rejected(self, reason):
1391
877
"D-Bus signal"
1392
878
pass
1393
879
1394
880
# NeedApproval - signal
1395
@dbus.service.signal(_interface, signature="tb")
881
@dbus.service.signal(_interface, signature=u"tb")
1396
882
def NeedApproval(self, timeout, default):
1397
883
"D-Bus signal"
1398
return self.need_approval()
884
pass
1399
885
1400
886
## Methods
1401
887
1402
888
# Approve - method
1403
@dbus.service.method(_interface, in_signature="b")
889
@dbus.service.method(_interface, in_signature=u"b")
1404
890
def Approve(self, value):
1405
891
self.approve(value)
1406
892
1407
893
# CheckedOK - method
1408
894
@dbus.service.method(_interface)
1409
895
def CheckedOK(self):
1410
self.checked_ok()
896
return self.checked_ok()
1411
897
1412
898
# Enable - method
1413
899
@dbus.service.method(_interface)
1435
921
## Properties
1436
922
1437
923
# ApprovalPending - property
1438
@dbus_service_property(_interface, signature="b", access="read")
924
@dbus_service_property(_interface, signature=u"b", access=u"read")
1439
925
def ApprovalPending_dbus_property(self):
1440
926
return dbus.Boolean(bool(self.approvals_pending))
1441
927
1442
928
# ApprovedByDefault - property
1443
@dbus_service_property(_interface, signature="b",
1444
access="readwrite")
929
@dbus_service_property(_interface, signature=u"b",
930
access=u"readwrite")
1445
931
def ApprovedByDefault_dbus_property(self, value=None):
1446
932
if value is None: # get
1447
933
return dbus.Boolean(self.approved_by_default)
1448
934
self.approved_by_default = bool(value)
935
# Emit D-Bus signal
936
self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
937
dbus.Boolean(value, variant_level=1))
1449
938
1450
939
# ApprovalDelay - property
1451
@dbus_service_property(_interface, signature="t",
1452
access="readwrite")
940
@dbus_service_property(_interface, signature=u"t",
941
access=u"readwrite")
1453
942
def ApprovalDelay_dbus_property(self, value=None):
1454
943
if value is None: # get
1455
944
return dbus.UInt64(self.approval_delay_milliseconds())
1456
945
self.approval_delay = datetime.timedelta(0, 0, 0, value)
946
# Emit D-Bus signal
947
self.PropertyChanged(dbus.String(u"ApprovalDelay"),
948
dbus.UInt64(value, variant_level=1))
1457
949
1458
950
# ApprovalDuration - property
1459
@dbus_service_property(_interface, signature="t",
1460
access="readwrite")
951
@dbus_service_property(_interface, signature=u"t",
952
access=u"readwrite")
1461
953
def ApprovalDuration_dbus_property(self, value=None):
1462
954
if value is None: # get
1463
return dbus.UInt64(timedelta_to_milliseconds(
955
return dbus.UInt64(self._timedelta_to_milliseconds(
1464
956
self.approval_duration))
1465
957
self.approval_duration = datetime.timedelta(0, 0, 0, value)
958
# Emit D-Bus signal
959
self.PropertyChanged(dbus.String(u"ApprovalDuration"),
960
dbus.UInt64(value, variant_level=1))
1466
961
1467
962
# Name - property
1468
@dbus_service_property(_interface, signature="s", access="read")
963
@dbus_service_property(_interface, signature=u"s", access=u"read")
1469
964
def Name_dbus_property(self):
1470
965
return dbus.String(self.name)
1471
966
1472
967
# Fingerprint - property
1473
@dbus_service_property(_interface, signature="s", access="read")
968
@dbus_service_property(_interface, signature=u"s", access=u"read")
1474
969
def Fingerprint_dbus_property(self):
1475
970
return dbus.String(self.fingerprint)
1476
971
1477
972
# Host - property
1478
@dbus_service_property(_interface, signature="s",
1479
access="readwrite")
973
@dbus_service_property(_interface, signature=u"s",
974
access=u"readwrite")
1480
975
def Host_dbus_property(self, value=None):
1481
976
if value is None: # get
1482
977
return dbus.String(self.host)
1483
self.host = unicode(value)
978
self.host = value
979
# Emit D-Bus signal
980
self.PropertyChanged(dbus.String(u"Host"),
981
dbus.String(value, variant_level=1))
1484
982
1485
983
# Created - property
1486
@dbus_service_property(_interface, signature="s", access="read")
984
@dbus_service_property(_interface, signature=u"s", access=u"read")
1487
985
def Created_dbus_property(self):
1488
return datetime_to_dbus(self.created)
986
return dbus.String(self._datetime_to_dbus(self.created))
1489
987
1490
988
# LastEnabled - property
1491
@dbus_service_property(_interface, signature="s", access="read")
989
@dbus_service_property(_interface, signature=u"s", access=u"read")
1492
990
def LastEnabled_dbus_property(self):
1493
return datetime_to_dbus(self.last_enabled)
991
if self.last_enabled is None:
992
return dbus.String(u"")
993
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1494
994
1495
995
# Enabled - property
1496
@dbus_service_property(_interface, signature="b",
1497
access="readwrite")
996
@dbus_service_property(_interface, signature=u"b",
997
access=u"readwrite")
1498
998
def Enabled_dbus_property(self, value=None):
1499
999
if value is None: # get
1500
1000
return dbus.Boolean(self.enabled)
1504
1004
self.disable()
1505
1005
1506
1006
# LastCheckedOK - property
1507
@dbus_service_property(_interface, signature="s",
1508
access="readwrite")
1007
@dbus_service_property(_interface, signature=u"s",
1008
access=u"readwrite")
1509
1009
def LastCheckedOK_dbus_property(self, value=None):
1510
1010
if value is not None:
1511
1011
self.checked_ok()
1512
1012
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)
1013
if self.last_checked_ok is None:
1014
return dbus.String(u"")
1015
return dbus.String(self._datetime_to_dbus(self
1016
.last_checked_ok))
1530
1017
1531
1018
# Timeout - property
1532
@dbus_service_property(_interface, signature="t",
1533
access="readwrite")
1019
@dbus_service_property(_interface, signature=u"t",
1020
access=u"readwrite")
1534
1021
def Timeout_dbus_property(self, value=None):
1535
1022
if value is None: # get
1536
1023
return dbus.UInt64(self.timeout_milliseconds())
1537
old_timeout = self.timeout
1538
1024
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)
1025
# Emit D-Bus signal
1026
self.PropertyChanged(dbus.String(u"Timeout"),
1027
dbus.UInt64(value, variant_level=1))
1028
if getattr(self, u"disable_initiator_tag", None) is None:
1029
return
1030
# Reschedule timeout
1031
gobject.source_remove(self.disable_initiator_tag)
1032
self.disable_initiator_tag = None
1033
time_to_die = (self.
1034
_timedelta_to_milliseconds((self
1035
.last_checked_ok
1036
+ self.timeout)
1037
- datetime.datetime
1038
.utcnow()))
1039
if time_to_die <= 0:
1040
# The timeout has passed
1041
self.disable()
1042
else:
1043
self.disable_initiator_tag = (gobject.timeout_add
1044
(time_to_die, self.disable))
1563
1045
1564
1046
# Interval - property
1565
@dbus_service_property(_interface, signature="t",
1566
access="readwrite")
1047
@dbus_service_property(_interface, signature=u"t",
1048
access=u"readwrite")
1567
1049
def Interval_dbus_property(self, value=None):
1568
1050
if value is None: # get
1569
1051
return dbus.UInt64(self.interval_milliseconds())
1570
1052
self.interval = datetime.timedelta(0, 0, 0, value)
1571
if getattr(self, "checker_initiator_tag", None) is None:
1053
# Emit D-Bus signal
1054
self.PropertyChanged(dbus.String(u"Interval"),
1055
dbus.UInt64(value, variant_level=1))
1056
if getattr(self, u"checker_initiator_tag", None) is None:
1572
1057
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
1058
# Reschedule checker run
1059
gobject.source_remove(self.checker_initiator_tag)
1060
self.checker_initiator_tag = (gobject.timeout_add
1061
(value, self.start_checker))
1062
self.start_checker() # Start one now, too
1063
1580
1064
# Checker - property
1581
@dbus_service_property(_interface, signature="s",
1582
access="readwrite")
1065
@dbus_service_property(_interface, signature=u"s",
1066
access=u"readwrite")
1583
1067
def Checker_dbus_property(self, value=None):
1584
1068
if value is None: # get
1585
1069
return dbus.String(self.checker_command)
1586
self.checker_command = unicode(value)
1070
self.checker_command = value
1071
# Emit D-Bus signal
1072
self.PropertyChanged(dbus.String(u"Checker"),
1073
dbus.String(self.checker_command,
1074
variant_level=1))
1587
1075
1588
1076
# CheckerRunning - property
1589
@dbus_service_property(_interface, signature="b",
1590
access="readwrite")
1077
@dbus_service_property(_interface, signature=u"b",
1078
access=u"readwrite")
1591
1079
def CheckerRunning_dbus_property(self, value=None):
1592
1080
if value is None: # get
1593
1081
return dbus.Boolean(self.checker is not None)
1597
1085
self.stop_checker()
1598
1086
1599
1087
# ObjectPath - property
1600
@dbus_service_property(_interface, signature="o", access="read")
1088
@dbus_service_property(_interface, signature=u"o", access=u"read")
1601
1089
def ObjectPath_dbus_property(self):
1602
1090
return self.dbus_object_path # is already a dbus.ObjectPath
1603
1091
1604
1092
# Secret = property
1605
@dbus_service_property(_interface, signature="ay",
1606
access="write", byte_arrays=True)
1093
@dbus_service_property(_interface, signature=u"ay",
1094
access=u"write", byte_arrays=True)
1607
1095
def Secret_dbus_property(self, value):
1608
1096
self.secret = str(value)
1609
1097
1616
1104
self._pipe.send(('init', fpr, address))
1617
1105
if not self._pipe.recv():
1618
1106
raise KeyError()
1619
1107
1620
1108
def __getattribute__(self, name):
1621
if name == '_pipe':
1109
if(name == '_pipe'):
1622
1110
return super(ProxyClient, self).__getattribute__(name)
1623
1111
self._pipe.send(('getattr', name))
1624
1112
data = self._pipe.recv()
1629
1117
self._pipe.send(('funcall', name, args, kwargs))
1630
1118
return self._pipe.recv()[1]
1631
1119
return func
1632
1120
1633
1121
def __setattr__(self, name, value):
1634
if name == '_pipe':
1122
if(name == '_pipe'):
1635
1123
return super(ProxyClient, self).__setattr__(name, value)
1636
1124
self._pipe.send(('setattr', name, value))
1637
1125
1644
1132
1645
1133
def handle(self):
1646
1134
with contextlib.closing(self.server.child_pipe) as child_pipe:
1647
logger.info("TCP connection from: %s",
1135
logger.info(u"TCP connection from: %s",
1648
1136
unicode(self.client_address))
1649
logger.debug("Pipe FD: %d",
1137
logger.debug(u"Pipe FD: %d",
1650
1138
self.server.child_pipe.fileno())
1651
1139
1652
1140
session = (gnutls.connection
1653
1141
.ClientSession(self.request,
1654
1142
gnutls.connection
1655
1143
.X509Credentials()))
1656
1144
1657
1145
# Note: gnutls.connection.X509Credentials is really a
1658
1146
# generic GnuTLS certificate credentials object so long as
1659
1147
# no X.509 keys are added to it. Therefore, we can use it
1660
1148
# 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"))
1149
1150
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1151
# u"+AES-256-CBC", u"+SHA1",
1152
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1153
# u"+DHE-DSS"))
1666
1154
# Use a fallback default, since this MUST be set.
1667
1155
priority = self.server.gnutls_priority
1668
1156
if priority is None:
1669
priority = "NORMAL"
1157
priority = u"NORMAL"
1670
1158
(gnutls.library.functions
1671
1159
.gnutls_priority_set_direct(session._c_object,
1672
1160
priority, None))
1673
1161
1674
1162
# Start communication using the Mandos protocol
1675
1163
# Get protocol number
1676
1164
line = self.request.makefile().readline()
1677
logger.debug("Protocol version: %r", line)
1165
logger.debug(u"Protocol version: %r", line)
1678
1166
try:
1679
1167
if int(line.strip().split()[0]) > 1:
1680
1168
raise RuntimeError
1681
except (ValueError, IndexError, RuntimeError) as error:
1682
logger.error("Unknown protocol version: %s", error)
1169
except (ValueError, IndexError, RuntimeError), error:
1170
logger.error(u"Unknown protocol version: %s", error)
1683
1171
return
1684
1172
1685
1173
# Start GnuTLS connection
1686
1174
try:
1687
1175
session.handshake()
1688
except gnutls.errors.GNUTLSError as error:
1689
logger.warning("Handshake failed: %s", error)
1176
except gnutls.errors.GNUTLSError, error:
1177
logger.warning(u"Handshake failed: %s", error)
1690
1178
# Do not run session.bye() here: the session is not
1691
1179
# established. Just abandon the request.
1692
1180
return
1693
logger.debug("Handshake succeeded")
1694
1181
logger.debug(u"Handshake succeeded")
1182
1695
1183
approval_required = False
1696
1184
try:
1697
1185
try:
1698
1186
fpr = self.fingerprint(self.peer_certificate
1699
1187
(session))
1700
except (TypeError,
1701
gnutls.errors.GNUTLSError) as error:
1702
logger.warning("Bad certificate: %s", error)
1188
except (TypeError, gnutls.errors.GNUTLSError), error:
1189
logger.warning(u"Bad certificate: %s", error)
1703
1190
return
1704
logger.debug("Fingerprint: %s", fpr)
1705
1191
logger.debug(u"Fingerprint: %s", fpr)
1192
1706
1193
try:
1707
1194
client = ProxyClient(child_pipe, fpr,
1708
1195
self.client_address)
1716
1203
1717
1204
while True:
1718
1205
if not client.enabled:
1719
logger.info("Client %s is disabled",
1206
logger.warning(u"Client %s is disabled",
1720
1207
client.name)
1721
1208
if self.server.use_dbus:
1722
1209
# Emit D-Bus signal
1723
client.Rejected("Disabled")
1210
client.Rejected("Disabled")
1724
1211
return
1725
1212
1726
if client.approved or not client.approval_delay:
1213
if client._approved or not client.approval_delay:
1727
1214
#We are approved or approval is disabled
1728
1215
break
1729
elif client.approved is None:
1730
logger.info("Client %s needs approval",
1216
elif client._approved is None:
1217
logger.info(u"Client %s needs approval",
1731
1218
client.name)
1732
1219
if self.server.use_dbus:
1733
1220
# Emit D-Bus signal
1735
1222
client.approval_delay_milliseconds(),
1736
1223
client.approved_by_default)
1737
1224
else:
1738
logger.warning("Client %s was not approved",
1225
logger.warning(u"Client %s was not approved",
1739
1226
client.name)
1740
1227
if self.server.use_dbus:
1741
1228
# Emit D-Bus signal
1743
1230
return
1744
1231
1745
1232
#wait until timeout or approved
1233
#x = float(client._timedelta_to_milliseconds(delay))
1746
1234
time = datetime.datetime.now()
1747
1235
client.changedstate.acquire()
1748
client.changedstate.wait(
1749
float(timedelta_to_milliseconds(delay)
1750
/ 1000))
1236
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1751
1237
client.changedstate.release()
1752
1238
time2 = datetime.datetime.now()
1753
1239
if (time2 - time) >= delay:
1768
1254
while sent_size < len(client.secret):
1769
1255
try:
1770
1256
sent = session.send(client.secret[sent_size:])
1771
except gnutls.errors.GNUTLSError as error:
1772
logger.warning("gnutls send failed",
1773
exc_info=error)
1257
except (gnutls.errors.GNUTLSError), error:
1258
logger.warning("gnutls send failed")
1774
1259
return
1775
logger.debug("Sent: %d, remaining: %d",
1260
logger.debug(u"Sent: %d, remaining: %d",
1776
1261
sent, len(client.secret)
1777
1262
- (sent_size + sent))
1778
1263
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)
1264
1265
logger.info(u"Sending secret to %s", client.name)
1266
# bump the timeout as if seen
1267
client.checked_ok()
1783
1268
if self.server.use_dbus:
1784
1269
# Emit D-Bus signal
1785
1270
client.GotSecret()
1789
1274
client.approvals_pending -= 1
1790
1275
try:
1791
1276
session.bye()
1792
except gnutls.errors.GNUTLSError as error:
1793
logger.warning("GnuTLS bye failed",
1794
exc_info=error)
1277
except (gnutls.errors.GNUTLSError), error:
1278
logger.warning("GnuTLS bye failed")
1795
1279
1796
1280
@staticmethod
1797
1281
def peer_certificate(session):
1807
1291
.gnutls_certificate_get_peers
1808
1292
(session._c_object, ctypes.byref(list_size)))
1809
1293
if not bool(cert_list) and list_size.value != 0:
1810
raise gnutls.errors.GNUTLSError("error getting peer"
1811
" certificate")
1294
raise gnutls.errors.GNUTLSError(u"error getting peer"
1295
u" certificate")
1812
1296
if list_size.value == 0:
1813
1297
return None
1814
1298
cert = cert_list[0]
1840
1324
if crtverify.value != 0:
1841
1325
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1842
1326
raise (gnutls.errors.CertificateSecurityError
1843
("Verify failed"))
1327
(u"Verify failed"))
1844
1328
# New buffer for the fingerprint
1845
1329
buf = ctypes.create_string_buffer(20)
1846
1330
buf_len = ctypes.c_size_t()
1853
1337
# Convert the buffer to a Python bytestring
1854
1338
fpr = ctypes.string_at(buf, buf_len.value)
1855
1339
# Convert the bytestring to hexadecimal notation
1856
hex_fpr = binascii.hexlify(fpr).upper()
1340
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1857
1341
return hex_fpr
1858
1342
1859
1343
1862
1346
def sub_process_main(self, request, address):
1863
1347
try:
1864
1348
self.finish_request(request, address)
1865
except Exception:
1349
except:
1866
1350
self.handle_error(request, address)
1867
1351
self.close_request(request)
1868
1352
1869
1353
def process_request(self, request, address):
1870
1354
"""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
1355
multiprocessing.Process(target = self.sub_process_main,
1356
args = (request, address)).start()
1876
1357
1877
1358
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1878
1359
""" adds a pipe to the MixIn """
1882
1363
This function creates a new pipe in self.pipe
1883
1364
"""
1884
1365
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1885
1886
proc = MultiprocessingMixIn.process_request(self, request,
1887
client_address)
1366
1367
super(MultiprocessingMixInWithPipe,
1368
self).process_request(request, client_address)
1888
1369
self.child_pipe.close()
1889
self.add_pipe(parent_pipe, proc)
1890
1891
def add_pipe(self, parent_pipe, proc):
1370
self.add_pipe(parent_pipe)
1371
1372
def add_pipe(self, parent_pipe):
1892
1373
"""Dummy function; override as necessary"""
1893
raise NotImplementedError
1894
1374
pass
1895
1375
1896
1376
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1897
1377
socketserver.TCPServer, object):
1915
1395
bind to an address or port if they were not specified."""
1916
1396
if self.interface is not None:
1917
1397
if SO_BINDTODEVICE is None:
1918
logger.error("SO_BINDTODEVICE does not exist;"
1919
" cannot bind to interface %s",
1398
logger.error(u"SO_BINDTODEVICE does not exist;"
1399
u" cannot bind to interface %s",
1920
1400
self.interface)
1921
1401
else:
1922
1402
try:
1923
1403
self.socket.setsockopt(socket.SOL_SOCKET,
1924
1404
SO_BINDTODEVICE,
1925
1405
str(self.interface
1926
+ '\0'))
1927
except socket.error as error:
1406
+ u'\0'))
1407
except socket.error, error:
1928
1408
if error[0] == errno.EPERM:
1929
logger.error("No permission to"
1930
" bind to interface %s",
1409
logger.error(u"No permission to"
1410
u" bind to interface %s",
1931
1411
self.interface)
1932
1412
elif error[0] == errno.ENOPROTOOPT:
1933
logger.error("SO_BINDTODEVICE not available;"
1934
" cannot bind to interface %s",
1413
logger.error(u"SO_BINDTODEVICE not available;"
1414
u" cannot bind to interface %s",
1935
1415
self.interface)
1936
1416
else:
1937
1417
raise
1939
1419
if self.server_address[0] or self.server_address[1]:
1940
1420
if not self.server_address[0]:
1941
1421
if self.address_family == socket.AF_INET6:
1942
any_address = "::" # in6addr_any
1422
any_address = u"::" # in6addr_any
1943
1423
else:
1944
1424
any_address = socket.INADDR_ANY
1945
1425
self.server_address = (any_address,
1972
1452
self.enabled = False
1973
1453
self.clients = clients
1974
1454
if self.clients is None:
1975
self.clients = {}
1455
self.clients = set()
1976
1456
self.use_dbus = use_dbus
1977
1457
self.gnutls_priority = gnutls_priority
1978
1458
IPv6_TCPServer.__init__(self, server_address,
1982
1462
def server_activate(self):
1983
1463
if self.enabled:
1984
1464
return socketserver.TCPServer.server_activate(self)
1985
1986
1465
def enable(self):
1987
1466
self.enabled = True
1988
1989
def add_pipe(self, parent_pipe, proc):
1467
def add_pipe(self, parent_pipe):
1990
1468
# Call "handle_ipc" for both data and EOF events
1991
1469
gobject.io_add_watch(parent_pipe.fileno(),
1992
1470
gobject.IO_IN | gobject.IO_HUP,
1993
1471
functools.partial(self.handle_ipc,
1994
parent_pipe =
1995
parent_pipe,
1996
proc = proc))
1997
1472
parent_pipe = parent_pipe))
1473
1998
1474
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()
1475
client_object=None):
1476
condition_names = {
1477
gobject.IO_IN: u"IN", # There is data to read.
1478
gobject.IO_OUT: u"OUT", # Data can be written (without
1479
# blocking).
1480
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1481
gobject.IO_ERR: u"ERR", # Error condition.
1482
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1483
# broken, usually for pipes and
1484
# sockets).
1485
}
1486
conditions_string = ' | '.join(name
1487
for cond, name in
1488
condition_names.iteritems()
1489
if cond & condition)
1490
# error or the other end of multiprocessing.Pipe has closed
1491
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2004
1492
return False
2005
1493
2006
1494
# Read a request from the child
2011
1499
fpr = request[1]
2012
1500
address = request[2]
2013
1501
2014
for c in self.clients.itervalues():
1502
for c in self.clients:
2015
1503
if c.fingerprint == fpr:
2016
1504
client = c
2017
1505
break
2018
1506
else:
2019
logger.info("Client not found for fingerprint: %s, ad"
2020
"dress: %s", fpr, address)
1507
logger.warning(u"Client not found for fingerprint: %s, ad"
1508
u"dress: %s", fpr, address)
2021
1509
if self.use_dbus:
2022
1510
# Emit D-Bus signal
2023
mandos_dbus_service.ClientNotFound(fpr,
2024
address[0])
1511
mandos_dbus_service.ClientNotFound(fpr, address)
2025
1512
parent_pipe.send(False)
2026
1513
return False
2027
1514
2028
1515
gobject.io_add_watch(parent_pipe.fileno(),
2029
1516
gobject.IO_IN | gobject.IO_HUP,
2030
1517
functools.partial(self.handle_ipc,
2031
parent_pipe =
2032
parent_pipe,
2033
proc = proc,
2034
client_object =
2035
client))
1518
parent_pipe = parent_pipe,
1519
client_object = client))
2036
1520
parent_pipe.send(True)
2037
# remove the old hook in favor of the new above hook on
2038
# same fileno
1521
# remove the old hook in favor of the new above hook on same fileno
2039
1522
return False
2040
1523
if command == 'funcall':
2041
1524
funcname = request[1]
2042
1525
args = request[2]
2043
1526
kwargs = request[3]
2044
1527
2045
parent_pipe.send(('data', getattr(client_object,
2046
funcname)(*args,
2047
**kwargs)))
2048
1528
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1529
2049
1530
if command == 'getattr':
2050
1531
attrname = request[1]
2051
1532
if callable(client_object.__getattribute__(attrname)):
2052
1533
parent_pipe.send(('function',))
2053
1534
else:
2054
parent_pipe.send(('data', client_object
2055
.__getattribute__(attrname)))
1535
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2056
1536
2057
1537
if command == 'setattr':
2058
1538
attrname = request[1]
2059
1539
value = request[2]
2060
1540
setattr(client_object, attrname, value)
2061
1541
2062
1542
return True
2063
1543
2064
1544
2065
1545
def string_to_delta(interval):
2066
1546
"""Parse a string and return a datetime.timedelta
2067
1547
2068
>>> string_to_delta('7d')
1548
>>> string_to_delta(u'7d')
2069
1549
datetime.timedelta(7)
2070
>>> string_to_delta('60s')
1550
>>> string_to_delta(u'60s')
2071
1551
datetime.timedelta(0, 60)
2072
>>> string_to_delta('60m')
1552
>>> string_to_delta(u'60m')
2073
1553
datetime.timedelta(0, 3600)
2074
>>> string_to_delta('24h')
1554
>>> string_to_delta(u'24h')
2075
1555
datetime.timedelta(1)
2076
>>> string_to_delta('1w')
1556
>>> string_to_delta(u'1w')
2077
1557
datetime.timedelta(7)
2078
>>> string_to_delta('5m 30s')
1558
>>> string_to_delta(u'5m 30s')
2079
1559
datetime.timedelta(0, 330)
2080
1560
"""
2081
1561
timevalue = datetime.timedelta(0)
2083
1563
try:
2084
1564
suffix = unicode(s[-1])
2085
1565
value = int(s[:-1])
2086
if suffix == "d":
1566
if suffix == u"d":
2087
1567
delta = datetime.timedelta(value)
2088
elif suffix == "s":
1568
elif suffix == u"s":
2089
1569
delta = datetime.timedelta(0, value)
2090
elif suffix == "m":
1570
elif suffix == u"m":
2091
1571
delta = datetime.timedelta(0, 0, 0, 0, value)
2092
elif suffix == "h":
1572
elif suffix == u"h":
2093
1573
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2094
elif suffix == "w":
1574
elif suffix == u"w":
2095
1575
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2096
1576
else:
2097
raise ValueError("Unknown suffix {0!r}"
2098
.format(suffix))
2099
except (ValueError, IndexError) as e:
2100
raise ValueError(*(e.args))
1577
raise ValueError(u"Unknown suffix %r" % suffix)
1578
except (ValueError, IndexError), e:
1579
raise ValueError(e.message)
2101
1580
timevalue += delta
2102
1581
return timevalue
2103
1582
2104
1583
1584
def if_nametoindex(interface):
1585
"""Call the C function if_nametoindex(), or equivalent
1586
1587
Note: This function cannot accept a unicode string."""
1588
global if_nametoindex
1589
try:
1590
if_nametoindex = (ctypes.cdll.LoadLibrary
1591
(ctypes.util.find_library(u"c"))
1592
.if_nametoindex)
1593
except (OSError, AttributeError):
1594
logger.warning(u"Doing if_nametoindex the hard way")
1595
def if_nametoindex(interface):
1596
"Get an interface index the hard way, i.e. using fcntl()"
1597
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1598
with contextlib.closing(socket.socket()) as s:
1599
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1600
struct.pack(str(u"16s16x"),
1601
interface))
1602
interface_index = struct.unpack(str(u"I"),
1603
ifreq[16:20])[0]
1604
return interface_index
1605
return if_nametoindex(interface)
1606
1607
2105
1608
def daemon(nochdir = False, noclose = False):
2106
1609
"""See daemon(3). Standard BSD Unix function.
2107
1610
2110
1613
sys.exit()
2111
1614
os.setsid()
2112
1615
if not nochdir:
2113
os.chdir("/")
1616
os.chdir(u"/")
2114
1617
if os.fork():
2115
1618
sys.exit()
2116
1619
if not noclose:
2117
1620
# Close all standard open file descriptors
2118
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1621
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2119
1622
if not stat.S_ISCHR(os.fstat(null).st_mode):
2120
1623
raise OSError(errno.ENODEV,
2121
"{0} not a character device"
2122
.format(os.devnull))
1624
u"%s not a character device"
1625
% os.path.devnull)
2123
1626
os.dup2(null, sys.stdin.fileno())
2124
1627
os.dup2(null, sys.stdout.fileno())
2125
1628
os.dup2(null, sys.stderr.fileno())
2132
1635
##################################################################
2133
1636
# Parsing of options, both command line and config file
2134
1637
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()
1638
parser = optparse.OptionParser(version = "%%prog %s" % version)
1639
parser.add_option("-i", u"--interface", type=u"string",
1640
metavar="IF", help=u"Bind to interface IF")
1641
parser.add_option("-a", u"--address", type=u"string",
1642
help=u"Address to listen for requests on")
1643
parser.add_option("-p", u"--port", type=u"int",
1644
help=u"Port number to receive requests on")
1645
parser.add_option("--check", action=u"store_true",
1646
help=u"Run self-test")
1647
parser.add_option("--debug", action=u"store_true",
1648
help=u"Debug mode; run in foreground and log to"
1649
u" terminal")
1650
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1651
help=u"Debug level for stdout output")
1652
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1653
u" priority string (see GnuTLS documentation)")
1654
parser.add_option("--servicename", type=u"string",
1655
metavar=u"NAME", help=u"Zeroconf service name")
1656
parser.add_option("--configdir", type=u"string",
1657
default=u"/etc/mandos", metavar=u"DIR",
1658
help=u"Directory to search for configuration"
1659
u" files")
1660
parser.add_option("--no-dbus", action=u"store_false",
1661
dest=u"use_dbus", help=u"Do not provide D-Bus"
1662
u" system bus interface")
1663
parser.add_option("--no-ipv6", action=u"store_false",
1664
dest=u"use_ipv6", help=u"Do not use IPv6")
1665
options = parser.parse_args()[0]
2172
1666
2173
1667
if options.check:
2174
1668
import doctest
2176
1670
sys.exit()
2177
1671
2178
1672
# 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"
1673
server_defaults = { u"interface": u"",
1674
u"address": u"",
1675
u"port": u"",
1676
u"debug": u"False",
1677
u"priority":
1678
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1679
u"servicename": u"Mandos",
1680
u"use_dbus": u"True",
1681
u"use_ipv6": u"True",
1682
u"debuglevel": u"",
2191
1683
}
2192
1684
2193
1685
# Parse config file for server-global settings
2194
1686
server_config = configparser.SafeConfigParser(server_defaults)
2195
1687
del server_defaults
2196
1688
server_config.read(os.path.join(options.configdir,
2197
"mandos.conf"))
1689
u"mandos.conf"))
2198
1690
# Convert the SafeConfigParser object to a dict
2199
1691
server_settings = server_config.defaults()
2200
1692
# 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",
1693
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1694
server_settings[option] = server_config.getboolean(u"DEFAULT",
2203
1695
option)
2204
1696
if server_settings["port"]:
2205
server_settings["port"] = server_config.getint("DEFAULT",
2206
"port")
1697
server_settings["port"] = server_config.getint(u"DEFAULT",
1698
u"port")
2207
1699
del server_config
2208
1700
2209
1701
# Override the settings from the config file with command line
2210
1702
# options, if set.
2211
for option in ("interface", "address", "port", "debug",
2212
"priority", "servicename", "configdir",
2213
"use_dbus", "use_ipv6", "debuglevel", "restore",
2214
"statedir"):
1703
for option in (u"interface", u"address", u"port", u"debug",
1704
u"priority", u"servicename", u"configdir",
1705
u"use_dbus", u"use_ipv6", u"debuglevel"):
2215
1706
value = getattr(options, option)
2216
1707
if value is not None:
2217
1708
server_settings[option] = value
2225
1716
##################################################################
2226
1717
2227
1718
# 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":
1719
debug = server_settings[u"debug"]
1720
debuglevel = server_settings[u"debuglevel"]
1721
use_dbus = server_settings[u"use_dbus"]
1722
use_ipv6 = server_settings[u"use_ipv6"]
1723
1724
if server_settings[u"servicename"] != u"Mandos":
2245
1725
syslogger.setFormatter(logging.Formatter
2246
('Mandos ({0}) [%(process)d]:'
2247
' %(levelname)s: %(message)s'
2248
.format(server_settings
2249
["servicename"])))
1726
(u'Mandos (%s) [%%(process)d]:'
1727
u' %%(levelname)s: %%(message)s'
1728
% server_settings[u"servicename"]))
2250
1729
2251
1730
# 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"))
1731
client_defaults = { u"timeout": u"1h",
1732
u"interval": u"5m",
1733
u"checker": u"fping -q -- %%(host)s",
1734
u"host": u"",
1735
u"approval_delay": u"0s",
1736
u"approval_duration": u"1s",
1737
}
1738
client_config = configparser.SafeConfigParser(client_defaults)
1739
client_config.read(os.path.join(server_settings[u"configdir"],
1740
u"clients.conf"))
2256
1741
2257
1742
global mandos_dbus_service
2258
1743
mandos_dbus_service = None
2259
1744
2260
tcp_server = MandosServer((server_settings["address"],
2261
server_settings["port"]),
1745
tcp_server = MandosServer((server_settings[u"address"],
1746
server_settings[u"port"]),
2262
1747
ClientHandler,
2263
interface=(server_settings["interface"]
1748
interface=(server_settings[u"interface"]
2264
1749
or None),
2265
1750
use_ipv6=use_ipv6,
2266
1751
gnutls_priority=
2267
server_settings["priority"],
1752
server_settings[u"priority"],
2268
1753
use_dbus=use_dbus)
2269
if not debug:
2270
pidfilename = "/var/run/mandos.pid"
2271
try:
2272
pidfile = open(pidfilename, "w")
2273
except IOError as e:
2274
logger.error("Could not open file %r", pidfilename,
2275
exc_info=e)
1754
pidfilename = u"/var/run/mandos.pid"
1755
try:
1756
pidfile = open(pidfilename, u"w")
1757
except IOError:
1758
logger.error(u"Could not open file %r", pidfilename)
2276
1759
2277
for name in ("_mandos", "mandos", "nobody"):
1760
try:
1761
uid = pwd.getpwnam(u"_mandos").pw_uid
1762
gid = pwd.getpwnam(u"_mandos").pw_gid
1763
except KeyError:
2278
1764
try:
2279
uid = pwd.getpwnam(name).pw_uid
2280
gid = pwd.getpwnam(name).pw_gid
2281
break
1765
uid = pwd.getpwnam(u"mandos").pw_uid
1766
gid = pwd.getpwnam(u"mandos").pw_gid
2282
1767
except KeyError:
2283
continue
2284
else:
2285
uid = 65534
2286
gid = 65534
1768
try:
1769
uid = pwd.getpwnam(u"nobody").pw_uid
1770
gid = pwd.getpwnam(u"nobody").pw_gid
1771
except KeyError:
1772
uid = 65534
1773
gid = 65534
2287
1774
try:
2288
1775
os.setgid(gid)
2289
1776
os.setuid(uid)
2290
except OSError as error:
1777
except OSError, error:
2291
1778
if error[0] != errno.EPERM:
2292
1779
raise error
2293
1780
1781
if not debug and not debuglevel:
1782
syslogger.setLevel(logging.WARNING)
1783
console.setLevel(logging.WARNING)
1784
if debuglevel:
1785
level = getattr(logging, debuglevel.upper())
1786
syslogger.setLevel(level)
1787
console.setLevel(level)
1788
2294
1789
if debug:
2295
1790
# Enable all possible GnuTLS debugging
2296
1791
2300
1795
2301
1796
@gnutls.library.types.gnutls_log_func
2302
1797
def debug_gnutls(level, string):
2303
logger.debug("GnuTLS: %s", string[:-1])
1798
logger.debug(u"GnuTLS: %s", string[:-1])
2304
1799
2305
1800
(gnutls.library.functions
2306
1801
.gnutls_global_set_log_function(debug_gnutls))
2307
1802
2308
1803
# Redirect stdin so all checkers get /dev/null
2309
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1804
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2310
1805
os.dup2(null, sys.stdin.fileno())
2311
1806
if null > 2:
2312
1807
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()
1808
else:
1809
# No console logging
1810
logger.removeHandler(console)
1811
2320
1812
2321
1813
global main_loop
2322
1814
# From the Avahi example code
2323
DBusGMainLoop(set_as_default=True)
1815
DBusGMainLoop(set_as_default=True )
2324
1816
main_loop = gobject.MainLoop()
2325
1817
bus = dbus.SystemBus()
2326
1818
# End of Avahi example code
2327
1819
if use_dbus:
2328
1820
try:
2329
bus_name = dbus.service.BusName("se.recompile.Mandos",
1821
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2330
1822
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)
1823
except dbus.exceptions.NameExistsException, e:
1824
logger.error(unicode(e) + u", disabling D-Bus")
2336
1825
use_dbus = False
2337
server_settings["use_dbus"] = False
1826
server_settings[u"use_dbus"] = False
2338
1827
tcp_server.use_dbus = False
2339
1828
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)
1829
service = AvahiService(name = server_settings[u"servicename"],
1830
servicetype = u"_mandos._tcp",
1831
protocol = protocol, bus = bus)
2344
1832
if server_settings["interface"]:
2345
1833
service.interface = (if_nametoindex
2346
(str(server_settings["interface"])))
2347
1834
(str(server_settings[u"interface"])))
1835
1836
if not debug:
1837
# Close all input and output, do double fork, etc.
1838
daemon()
1839
2348
1840
global multiprocessing_manager
2349
1841
multiprocessing_manager = multiprocessing.Manager()
2350
1842
2351
1843
client_class = Client
2352
1844
if use_dbus:
2353
1845
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))
1846
def client_config_items(config, section):
1847
special_settings = {
1848
"approved_by_default":
1849
lambda: config.getboolean(section,
1850
"approved_by_default"),
1851
}
1852
for name, value in config.items(section):
2424
1853
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
1854
yield (name, special_settings[name]())
1855
except KeyError:
1856
yield (name, value)
1857
1858
tcp_server.clients.update(set(
1859
client_class(name = section,
1860
config= dict(client_config_items(
1861
client_config, section)))
1862
for section in client_config.sections()))
2449
1863
if not tcp_server.clients:
2450
logger.warning("No clients defined")
1864
logger.warning(u"No clients defined")
1865
1866
try:
1867
with pidfile:
1868
pid = os.getpid()
1869
pidfile.write(str(pid) + "\n")
1870
del pidfile
1871
except IOError:
1872
logger.error(u"Could not write to file %r with PID %d",
1873
pidfilename, pid)
1874
except NameError:
1875
# "pidfile" was never created
1876
pass
1877
del pidfilename
2451
1878
2452
1879
if not debug:
2453
try:
2454
with pidfile:
2455
pid = os.getpid()
2456
pidfile.write(str(pid) + "\n".encode("utf-8"))
2457
del pidfile
2458
except IOError:
2459
logger.error("Could not write to file %r with PID %d",
2460
pidfilename, pid)
2461
except NameError:
2462
# "pidfile" was never created
2463
pass
2464
del pidfilename
2465
1880
signal.signal(signal.SIGINT, signal.SIG_IGN)
2466
2467
1881
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2468
1882
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2469
1883
2470
1884
if use_dbus:
2471
@alternate_dbus_interfaces({"se.recompile.Mandos":
2472
"se.bsnet.fukt.Mandos"})
2473
class MandosDBusService(DBusObjectWithProperties):
1885
class MandosDBusService(dbus.service.Object):
2474
1886
"""A D-Bus proxy object"""
2475
1887
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")
1888
dbus.service.Object.__init__(self, bus, u"/")
1889
_interface = u"se.bsnet.fukt.Mandos"
1890
1891
@dbus.service.signal(_interface, signature=u"o")
2486
1892
def ClientAdded(self, objpath):
2487
1893
"D-Bus signal"
2488
1894
pass
2489
1895
2490
@dbus.service.signal(_interface, signature="ss")
1896
@dbus.service.signal(_interface, signature=u"ss")
2491
1897
def ClientNotFound(self, fingerprint, address):
2492
1898
"D-Bus signal"
2493
1899
pass
2494
1900
2495
@dbus.service.signal(_interface, signature="os")
1901
@dbus.service.signal(_interface, signature=u"os")
2496
1902
def ClientRemoved(self, objpath, name):
2497
1903
"D-Bus signal"
2498
1904
pass
2499
1905
2500
@dbus.service.method(_interface, out_signature="ao")
1906
@dbus.service.method(_interface, out_signature=u"ao")
2501
1907
def GetAllClients(self):
2502
1908
"D-Bus method"
2503
1909
return dbus.Array(c.dbus_object_path
2504
for c in
2505
tcp_server.clients.itervalues())
1910
for c in tcp_server.clients)
2506
1911
2507
1912
@dbus.service.method(_interface,
2508
out_signature="a{oa{sv}}")
1913
out_signature=u"a{oa{sv}}")
2509
1914
def GetAllClientsWithProperties(self):
2510
1915
"D-Bus method"
2511
1916
return dbus.Dictionary(
2512
((c.dbus_object_path, c.GetAll(""))
2513
for c in tcp_server.clients.itervalues()),
2514
signature="oa{sv}")
1917
((c.dbus_object_path, c.GetAll(u""))
1918
for c in tcp_server.clients),
1919
signature=u"oa{sv}")
2515
1920
2516
@dbus.service.method(_interface, in_signature="o")
1921
@dbus.service.method(_interface, in_signature=u"o")
2517
1922
def RemoveClient(self, object_path):
2518
1923
"D-Bus method"
2519
for c in tcp_server.clients.itervalues():
1924
for c in tcp_server.clients:
2520
1925
if c.dbus_object_path == object_path:
2521
del tcp_server.clients[c.name]
1926
tcp_server.clients.remove(c)
2522
1927
c.remove_from_connection()
2523
1928
# Don't signal anything except ClientRemoved
2524
1929
c.disable(quiet=True)
2535
1940
"Cleanup function; run on exit"
2536
1941
service.cleanup()
2537
1942
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
1943
while tcp_server.clients:
2594
name, client = tcp_server.clients.popitem()
1944
client = tcp_server.clients.pop()
2595
1945
if use_dbus:
2596
1946
client.remove_from_connection()
1947
client.disable_hook = None
2597
1948
# Don't signal anything except ClientRemoved
2598
1949
client.disable(quiet=True)
2599
1950
if use_dbus:
2600
1951
# Emit D-Bus signal
2601
mandos_dbus_service.ClientRemoved(client
2602
.dbus_object_path,
1952
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2603
1953
client.name)
2604
client_settings.clear()
2605
1954
2606
1955
atexit.register(cleanup)
2607
1956
2608
for client in tcp_server.clients.itervalues():
1957
for client in tcp_server.clients:
2609
1958
if use_dbus:
2610
1959
# Emit D-Bus signal
2611
1960
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2612
# Need to initiate checking of clients
2613
if client.enabled:
2614
client.init_checker()
1961
client.enable()
2615
1962
2616
1963
tcp_server.enable()
2617
1964
tcp_server.server_activate()
2619
1966
# Find out what port we got
2620
1967
service.port = tcp_server.socket.getsockname()[1]
2621
1968
if use_ipv6:
2622
logger.info("Now listening on address %r, port %d,"
2623
" flowinfo %d, scope_id %d",
2624
*tcp_server.socket.getsockname())
1969
logger.info(u"Now listening on address %r, port %d,"
1970
" flowinfo %d, scope_id %d"
1971
% tcp_server.socket.getsockname())
2625
1972
else: # IPv4
2626
logger.info("Now listening on address %r, port %d",
2627
*tcp_server.socket.getsockname())
1973
logger.info(u"Now listening on address %r, port %d"
1974
% tcp_server.socket.getsockname())
2628
1975
2629
1976
#service.interface = tcp_server.socket.getsockname()[3]
2630
1977
2632
1979
# From the Avahi example code
2633
1980
try:
2634
1981
service.activate()
2635
except dbus.exceptions.DBusException as error:
2636
logger.critical("D-Bus Exception", exc_info=error)
1982
except dbus.exceptions.DBusException, error:
1983
logger.critical(u"DBusException: %s", error)
2637
1984
cleanup()
2638
1985
sys.exit(1)
2639
1986
# End of Avahi example code
2643
1990
(tcp_server.handle_request
2644
1991
(*args[2:], **kwargs) or True))
2645
1992
2646
logger.debug("Starting main loop")
1993
logger.debug(u"Starting main loop")
2647
1994
main_loop.run()
2648
except AvahiError as error:
2649
logger.critical("Avahi Error", exc_info=error)
1995
except AvahiError, error:
1996
logger.critical(u"AvahiError: %s", error)
2650
1997
cleanup()
2651
1998
sys.exit(1)
2652
1999
except KeyboardInterrupt:
2653
2000
if debug:
2654
print("", file=sys.stderr)
2655
logger.debug("Server received KeyboardInterrupt")
2656
logger.debug("Server exiting")
2001
print >> sys.stderr
2002
logger.debug(u"Server received KeyboardInterrupt")
2003
logger.debug(u"Server exiting")
2657
2004
# Must run before the D-Bus bus name gets deregistered
2658
2005
cleanup()
2659
2006
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0