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