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