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