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