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