To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 482
- compare with another revision
- download diff
- download tarball
- view history from revision 482
- Committer: Teddy Hogeborn
- Date: 2011-04-02 06:37:18 UTC
- Revision ID: teddy@fukt.bsnet.se-20110402063718-13ldrcuu0t33sdc4
* mandos: Tolerate restarting Avahi servers. Also Changed to new
"except x as y" exception syntax.
(AvahiService.entry_group_state_changed_match): New; contains the
SignalMatch object.
(AvahiService.remove): Really remove the group and the signal
connection, if any.
(AvahiService.add): Always create a new group and signal connection.
(AvahiService.cleanup): Changed to simply call remove().
(AvahiService.server_state_changed): Handle and log more bad states.
(AvahiService.activate): Set "follow_name_owner_changes=True" on the
Avahi Server proxy object.
(ClientDBus.checked_ok): Do not return anything.
(ClientDBus.CheckedOK): Do not return anything, as documented.
* mandos-monitor: Call D-Bus methods asynchronously.
"except x as y" exception syntax.
(AvahiService.entry_group_state_changed_match): New; contains the
SignalMatch object.
(AvahiService.remove): Really remove the group and the signal
connection, if any.
(AvahiService.add): Always create a new group and signal connection.
(AvahiService.cleanup): Changed to simply call remove().
(AvahiService.server_state_changed): Handle and log more bad states.
(AvahiService.activate): Set "follow_name_owner_changes=True" on the
Avahi Server proxy object.
(ClientDBus.checked_ok): Do not return anything.
(ClientDBus.CheckedOK): Do not return anything, as documented.
* mandos-monitor: Call D-Bus methods asynchronously.
- files added:
- DBUS-API
- debian/source
- files modified:
- .bzrignore
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 Björn Påhlsson
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 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
31
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
#
33
33
34
from __future__ import division, with_statement, absolute_import
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
35
36
36
37
import SocketServer as socketserver
37
38
import socket
38
import optparse
39
import argparse
39
40
import datetime
40
41
import errno
41
42
import gnutls.crypto
55
56
import logging
56
57
import logging.handlers
57
58
import pwd
58
from contextlib import closing
59
import contextlib
59
60
import struct
60
61
import fcntl
61
62
import functools
63
import cPickle as pickle
64
import multiprocessing
62
65
63
66
import dbus
64
67
import dbus.service
67
70
from dbus.mainloop.glib import DBusGMainLoop
68
71
import ctypes
69
72
import ctypes.util
73
import xml.dom.minidom
74
import inspect
70
75
71
76
try:
72
77
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
77
82
SO_BINDTODEVICE = None
78
83
79
84
80
version = "1.0.11"
85
version = "1.3.0"
81
86
82
logger = logging.Logger(u'mandos')
87
#logger = logging.getLogger('mandos')
88
logger = logging.Logger('mandos')
83
89
syslogger = (logging.handlers.SysLogHandler
84
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
85
address = "/dev/log"))
91
address = str("/dev/log")))
86
92
syslogger.setFormatter(logging.Formatter
87
(u'Mandos [%(process)d]: %(levelname)s:'
88
u' %(message)s'))
93
('Mandos [%(process)d]: %(levelname)s:'
94
' %(message)s'))
89
95
logger.addHandler(syslogger)
90
96
91
97
console = logging.StreamHandler()
92
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
93
u' %(levelname)s:'
94
u' %(message)s'))
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
99
' %(levelname)s:'
100
' %(message)s'))
95
101
logger.addHandler(console)
96
102
97
103
class AvahiError(Exception):
114
120
Attributes:
115
121
interface: integer; avahi.IF_UNSPEC or an interface index.
116
122
Used to optionally bind to the specified interface.
117
name: string; Example: u'Mandos'
118
type: string; Example: u'_mandos._tcp'.
123
name: string; Example: 'Mandos'
124
type: string; Example: '_mandos._tcp'.
119
125
See <http://www.dns-sd.org/ServiceTypes.html>
120
126
port: integer; what port to announce
121
127
TXT: list of strings; TXT record for the service
130
136
"""
131
137
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
132
138
servicetype = None, port = None, TXT = None,
133
domain = u"", host = u"", max_renames = 32768,
139
domain = "", host = "", max_renames = 32768,
134
140
protocol = avahi.PROTO_UNSPEC, bus = None):
135
141
self.interface = interface
136
142
self.name = name
145
151
self.group = None # our entry group
146
152
self.server = None
147
153
self.bus = bus
154
self.entry_group_state_changed_match = None
148
155
def rename(self):
149
156
"""Derived from the Avahi example code"""
150
157
if self.rename_count >= self.max_renames:
151
logger.critical(u"No suitable Zeroconf service name found"
152
u" after %i retries, exiting.",
158
logger.critical("No suitable Zeroconf service name found"
159
" after %i retries, exiting.",
153
160
self.rename_count)
154
raise AvahiServiceError(u"Too many renames")
155
self.name = self.server.GetAlternativeServiceName(self.name)
156
logger.info(u"Changing Zeroconf service name to %r ...",
157
unicode(self.name))
161
raise AvahiServiceError("Too many renames")
162
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
163
logger.info("Changing Zeroconf service name to %r ...",
164
self.name)
158
165
syslogger.setFormatter(logging.Formatter
159
(u'Mandos (%s) [%%(process)d]:'
160
u' %%(levelname)s: %%(message)s'
166
('Mandos (%s) [%%(process)d]:'
167
' %%(levelname)s: %%(message)s'
161
168
% self.name))
162
169
self.remove()
163
self.add()
170
try:
171
self.add()
172
except dbus.exceptions.DBusException as error:
173
logger.critical("DBusException: %s", error)
174
self.cleanup()
175
os._exit(1)
164
176
self.rename_count += 1
165
177
def remove(self):
166
178
"""Derived from the Avahi example code"""
167
179
if self.group is not None:
168
self.group.Reset()
180
try:
181
self.group.Free()
182
except (dbus.exceptions.UnknownMethodException,
183
dbus.exceptions.DBusException) as e:
184
pass
185
self.group = None
186
if self.entry_group_state_changed_match is not None:
187
self.entry_group_state_changed_match.remove()
188
self.entry_group_state_changed_match = None
169
189
def add(self):
170
190
"""Derived from the Avahi example code"""
171
if self.group is None:
172
self.group = dbus.Interface(
173
self.bus.get_object(avahi.DBUS_NAME,
174
self.server.EntryGroupNew()),
175
avahi.DBUS_INTERFACE_ENTRY_GROUP)
176
self.group.connect_to_signal('StateChanged',
177
self.entry_group_state_changed)
178
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
191
self.remove()
192
self.group = dbus.Interface(
193
self.bus.get_object(avahi.DBUS_NAME,
194
self.server.EntryGroupNew(),
195
follow_name_owner_changes=True),
196
avahi.DBUS_INTERFACE_ENTRY_GROUP)
197
self.entry_group_state_changed_match = (
198
self.group.connect_to_signal(
199
'StateChanged', self .entry_group_state_changed))
200
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
179
201
self.name, self.type)
180
202
self.group.AddService(
181
203
self.interface,
188
210
self.group.Commit()
189
211
def entry_group_state_changed(self, state, error):
190
212
"""Derived from the Avahi example code"""
191
logger.debug(u"Avahi state change: %i", state)
213
logger.debug("Avahi entry group state change: %i", state)
192
214
193
215
if state == avahi.ENTRY_GROUP_ESTABLISHED:
194
logger.debug(u"Zeroconf service established.")
216
logger.debug("Zeroconf service established.")
195
217
elif state == avahi.ENTRY_GROUP_COLLISION:
196
logger.warning(u"Zeroconf service name collision.")
218
logger.info("Zeroconf service name collision.")
197
219
self.rename()
198
220
elif state == avahi.ENTRY_GROUP_FAILURE:
199
logger.critical(u"Avahi: Error in group state changed %s",
221
logger.critical("Avahi: Error in group state changed %s",
200
222
unicode(error))
201
raise AvahiGroupError(u"State changed: %s"
223
raise AvahiGroupError("State changed: %s"
202
224
% unicode(error))
203
225
def cleanup(self):
204
226
"""Derived from the Avahi example code"""
205
if self.group is not None:
206
self.group.Free()
207
self.group = None
208
def server_state_changed(self, state):
227
self.remove()
228
def server_state_changed(self, state, error=None):
209
229
"""Derived from the Avahi example code"""
210
if state == avahi.SERVER_COLLISION:
211
logger.error(u"Zeroconf server name collision")
230
logger.debug("Avahi server state change: %i", state)
231
bad_states = { avahi.SERVER_INVALID:
232
"Zeroconf server invalid",
233
avahi.SERVER_REGISTERING: None,
234
avahi.SERVER_COLLISION:
235
"Zeroconf server name collision",
236
avahi.SERVER_FAILURE:
237
"Zeroconf server failure" }
238
if state in bad_states:
239
if bad_states[state]:
240
logger.error(bad_states[state])
212
241
self.remove()
213
242
elif state == avahi.SERVER_RUNNING:
214
243
self.add()
244
else:
245
logger.debug("Unknown state: %r", state)
215
246
def activate(self):
216
247
"""Derived from the Avahi example code"""
217
248
if self.server is None:
218
249
self.server = dbus.Interface(
219
250
self.bus.get_object(avahi.DBUS_NAME,
220
avahi.DBUS_PATH_SERVER),
251
avahi.DBUS_PATH_SERVER,
252
follow_name_owner_changes=True),
221
253
avahi.DBUS_INTERFACE_SERVER)
222
self.server.connect_to_signal(u"StateChanged",
254
self.server.connect_to_signal("StateChanged",
223
255
self.server_state_changed)
224
256
self.server_state_changed(self.server.GetState())
225
257
228
260
"""A representation of a client host served by this server.
229
261
230
262
Attributes:
231
name: string; from the config file, used in log messages and
232
D-Bus identifiers
233
fingerprint: string (40 or 32 hexadecimal digits); used to
234
uniquely identify the client
235
secret: bytestring; sent verbatim (over TLS) to client
236
host: string; available for use by the checker command
237
created: datetime.datetime(); (UTC) object creation
238
last_enabled: datetime.datetime(); (UTC)
239
enabled: bool()
240
last_checked_ok: datetime.datetime(); (UTC) or None
241
timeout: datetime.timedelta(); How long from last_checked_ok
242
until this client is invalid
243
interval: datetime.timedelta(); How often to start a new checker
244
disable_hook: If set, called by disable() as disable_hook(self)
263
_approved: bool(); 'None' if not yet approved/disapproved
264
approval_delay: datetime.timedelta(); Time to wait for approval
265
approval_duration: datetime.timedelta(); Duration of one approval
245
266
checker: subprocess.Popen(); a running checker process used
246
267
to see if the client lives.
247
268
'None' if no process is running.
248
checker_initiator_tag: a gobject event source tag, or None
249
disable_initiator_tag: - '' -
250
checker_callback_tag: - '' -
251
checker_command: string; External command which is run to check if
252
client lives. %() expansions are done at
269
checker_callback_tag: a gobject event source tag, or None
270
checker_command: string; External command which is run to check
271
if client lives. %() expansions are done at
253
272
runtime with vars(self) as dict, so that for
254
273
instance %(name)s can be used in the command.
274
checker_initiator_tag: a gobject event source tag, or None
275
created: datetime.datetime(); (UTC) object creation
255
276
current_checker_command: string; current running checker_command
277
disable_hook: If set, called by disable() as disable_hook(self)
278
disable_initiator_tag: a gobject event source tag, or None
279
enabled: bool()
280
fingerprint: string (40 or 32 hexadecimal digits); used to
281
uniquely identify the client
282
host: string; available for use by the checker command
283
interval: datetime.timedelta(); How often to start a new checker
284
last_approval_request: datetime.datetime(); (UTC) or None
285
last_checked_ok: datetime.datetime(); (UTC) or None
286
last_enabled: datetime.datetime(); (UTC)
287
name: string; from the config file, used in log messages and
288
D-Bus identifiers
289
secret: bytestring; sent verbatim (over TLS) to client
290
timeout: datetime.timedelta(); How long from last_checked_ok
291
until this client is disabled
292
runtime_expansions: Allowed attributes for runtime expansion.
256
293
"""
257
294
295
runtime_expansions = ("approval_delay", "approval_duration",
296
"created", "enabled", "fingerprint",
297
"host", "interval", "last_checked_ok",
298
"last_enabled", "name", "timeout")
299
258
300
@staticmethod
259
def _datetime_to_milliseconds(dt):
260
"Convert a datetime.datetime() to milliseconds"
261
return ((dt.days * 24 * 60 * 60 * 1000)
262
+ (dt.seconds * 1000)
263
+ (dt.microseconds // 1000))
301
def _timedelta_to_milliseconds(td):
302
"Convert a datetime.timedelta() to milliseconds"
303
return ((td.days * 24 * 60 * 60 * 1000)
304
+ (td.seconds * 1000)
305
+ (td.microseconds // 1000))
264
306
265
307
def timeout_milliseconds(self):
266
308
"Return the 'timeout' attribute in milliseconds"
267
return self._datetime_to_milliseconds(self.timeout)
309
return self._timedelta_to_milliseconds(self.timeout)
268
310
269
311
def interval_milliseconds(self):
270
312
"Return the 'interval' attribute in milliseconds"
271
return self._datetime_to_milliseconds(self.interval)
313
return self._timedelta_to_milliseconds(self.interval)
314
315
def approval_delay_milliseconds(self):
316
return self._timedelta_to_milliseconds(self.approval_delay)
272
317
273
318
def __init__(self, name = None, disable_hook=None, config=None):
274
319
"""Note: the 'checker' key in 'config' sets the
277
322
self.name = name
278
323
if config is None:
279
324
config = {}
280
logger.debug(u"Creating client %r", self.name)
325
logger.debug("Creating client %r", self.name)
281
326
# Uppercase and remove spaces from fingerprint for later
282
327
# comparison purposes with return value from the fingerprint()
283
328
# function
284
self.fingerprint = (config[u"fingerprint"].upper()
285
.replace(u" ", u""))
286
logger.debug(u" Fingerprint: %s", self.fingerprint)
287
if u"secret" in config:
288
self.secret = config[u"secret"].decode(u"base64")
289
elif u"secfile" in config:
290
with closing(open(os.path.expanduser
291
(os.path.expandvars
292
(config[u"secfile"])))) as secfile:
329
self.fingerprint = (config["fingerprint"].upper()
330
.replace(" ", ""))
331
logger.debug(" Fingerprint: %s", self.fingerprint)
332
if "secret" in config:
333
self.secret = config["secret"].decode("base64")
334
elif "secfile" in config:
335
with open(os.path.expanduser(os.path.expandvars
336
(config["secfile"])),
337
"rb") as secfile:
293
338
self.secret = secfile.read()
294
339
else:
295
raise TypeError(u"No secret or secfile for client %s"
340
raise TypeError("No secret or secfile for client %s"
296
341
% self.name)
297
self.host = config.get(u"host", u"")
342
self.host = config.get("host", "")
298
343
self.created = datetime.datetime.utcnow()
299
344
self.enabled = False
345
self.last_approval_request = None
300
346
self.last_enabled = None
301
347
self.last_checked_ok = None
302
self.timeout = string_to_delta(config[u"timeout"])
303
self.interval = string_to_delta(config[u"interval"])
348
self.timeout = string_to_delta(config["timeout"])
349
self.interval = string_to_delta(config["interval"])
304
350
self.disable_hook = disable_hook
305
351
self.checker = None
306
352
self.checker_initiator_tag = None
307
353
self.disable_initiator_tag = None
308
354
self.checker_callback_tag = None
309
self.checker_command = config[u"checker"]
355
self.checker_command = config["checker"]
310
356
self.current_checker_command = None
311
357
self.last_connect = None
358
self._approved = None
359
self.approved_by_default = config.get("approved_by_default",
360
True)
361
self.approvals_pending = 0
362
self.approval_delay = string_to_delta(
363
config["approval_delay"])
364
self.approval_duration = string_to_delta(
365
config["approval_duration"])
366
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
312
367
368
def send_changedstate(self):
369
self.changedstate.acquire()
370
self.changedstate.notify_all()
371
self.changedstate.release()
372
313
373
def enable(self):
314
374
"""Start this client's checker and timeout hooks"""
315
if getattr(self, u"enabled", False):
375
if getattr(self, "enabled", False):
316
376
# Already enabled
317
377
return
378
self.send_changedstate()
318
379
self.last_enabled = datetime.datetime.utcnow()
319
380
# Schedule a new checker to be started an 'interval' from now,
320
381
# and every interval from then on.
321
382
self.checker_initiator_tag = (gobject.timeout_add
322
383
(self.interval_milliseconds(),
323
384
self.start_checker))
324
# Also start a new checker *right now*.
325
self.start_checker()
326
385
# Schedule a disable() when 'timeout' has passed
327
386
self.disable_initiator_tag = (gobject.timeout_add
328
387
(self.timeout_milliseconds(),
329
388
self.disable))
330
389
self.enabled = True
390
# Also start a new checker *right now*.
391
self.start_checker()
331
392
332
def disable(self):
393
def disable(self, quiet=True):
333
394
"""Disable this client."""
334
395
if not getattr(self, "enabled", False):
335
396
return False
336
logger.info(u"Disabling client %s", self.name)
337
if getattr(self, u"disable_initiator_tag", False):
397
if not quiet:
398
self.send_changedstate()
399
if not quiet:
400
logger.info("Disabling client %s", self.name)
401
if getattr(self, "disable_initiator_tag", False):
338
402
gobject.source_remove(self.disable_initiator_tag)
339
403
self.disable_initiator_tag = None
340
if getattr(self, u"checker_initiator_tag", False):
404
if getattr(self, "checker_initiator_tag", False):
341
405
gobject.source_remove(self.checker_initiator_tag)
342
406
self.checker_initiator_tag = None
343
407
self.stop_checker()
358
422
if os.WIFEXITED(condition):
359
423
exitstatus = os.WEXITSTATUS(condition)
360
424
if exitstatus == 0:
361
logger.info(u"Checker for %(name)s succeeded",
425
logger.info("Checker for %(name)s succeeded",
362
426
vars(self))
363
427
self.checked_ok()
364
428
else:
365
logger.info(u"Checker for %(name)s failed",
429
logger.info("Checker for %(name)s failed",
366
430
vars(self))
367
431
else:
368
logger.warning(u"Checker for %(name)s crashed?",
432
logger.warning("Checker for %(name)s crashed?",
369
433
vars(self))
370
434
371
435
def checked_ok(self):
380
444
(self.timeout_milliseconds(),
381
445
self.disable))
382
446
447
def need_approval(self):
448
self.last_approval_request = datetime.datetime.utcnow()
449
383
450
def start_checker(self):
384
451
"""Start a new checker subprocess if one is not running.
385
452
391
458
# client would inevitably timeout, since no checker would get
392
459
# a chance to run to completion. If we instead leave running
393
460
# checkers alone, the checker would have to take more time
394
# than 'timeout' for the client to be declared invalid, which
395
# is as it should be.
461
# than 'timeout' for the client to be disabled, which is as it
462
# should be.
396
463
397
464
# If a checker exists, make sure it is not a zombie
398
if self.checker is not None:
465
try:
399
466
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
467
except (AttributeError, OSError) as error:
468
if (isinstance(error, OSError)
469
and error.errno != errno.ECHILD):
470
raise error
471
else:
400
472
if pid:
401
logger.warning(u"Checker was a zombie")
473
logger.warning("Checker was a zombie")
402
474
gobject.source_remove(self.checker_callback_tag)
403
475
self.checker_callback(pid, status,
404
476
self.current_checker_command)
409
481
command = self.checker_command % self.host
410
482
except TypeError:
411
483
# Escape attributes for the shell
412
escaped_attrs = dict((key,
413
re.escape(unicode(str(val),
414
errors=
415
u'replace')))
416
for key, val in
417
vars(self).iteritems())
484
escaped_attrs = dict(
485
(attr,
486
re.escape(unicode(str(getattr(self, attr, "")),
487
errors=
488
'replace')))
489
for attr in
490
self.runtime_expansions)
491
418
492
try:
419
493
command = self.checker_command % escaped_attrs
420
except TypeError, error:
421
logger.error(u'Could not format string "%s":'
422
u' %s', self.checker_command, error)
494
except TypeError as error:
495
logger.error('Could not format string "%s":'
496
' %s', self.checker_command, error)
423
497
return True # Try again later
424
498
self.current_checker_command = command
425
499
try:
426
logger.info(u"Starting checker %r for %s",
500
logger.info("Starting checker %r for %s",
427
501
command, self.name)
428
502
# We don't need to redirect stdout and stderr, since
429
503
# in normal mode, that is already done by daemon(),
431
505
# always replaced by /dev/null.)
432
506
self.checker = subprocess.Popen(command,
433
507
close_fds=True,
434
shell=True, cwd=u"/")
508
shell=True, cwd="/")
435
509
self.checker_callback_tag = (gobject.child_watch_add
436
510
(self.checker.pid,
437
511
self.checker_callback,
442
516
if pid:
443
517
gobject.source_remove(self.checker_callback_tag)
444
518
self.checker_callback(pid, status, command)
445
except OSError, error:
446
logger.error(u"Failed to start subprocess: %s",
519
except OSError as error:
520
logger.error("Failed to start subprocess: %s",
447
521
error)
448
522
# Re-run this periodically if run by gobject.timeout_add
449
523
return True
453
527
if self.checker_callback_tag:
454
528
gobject.source_remove(self.checker_callback_tag)
455
529
self.checker_callback_tag = None
456
if getattr(self, u"checker", None) is None:
530
if getattr(self, "checker", None) is None:
457
531
return
458
logger.debug(u"Stopping checker for %(name)s", vars(self))
532
logger.debug("Stopping checker for %(name)s", vars(self))
459
533
try:
460
534
os.kill(self.checker.pid, signal.SIGTERM)
461
#os.sleep(0.5)
535
#time.sleep(0.5)
462
536
#if self.checker.poll() is None:
463
537
# os.kill(self.checker.pid, signal.SIGKILL)
464
except OSError, error:
538
except OSError as error:
465
539
if error.errno != errno.ESRCH: # No such process
466
540
raise
467
541
self.checker = None
468
469
def still_valid(self):
470
"""Has the timeout not yet passed for this client?"""
471
if not getattr(self, u"enabled", False):
472
return False
473
now = datetime.datetime.utcnow()
474
if self.last_checked_ok is None:
475
return now < (self.created + self.timeout)
476
else:
477
return now < (self.last_checked_ok + self.timeout)
478
479
480
class ClientDBus(Client, dbus.service.Object):
542
543
def dbus_service_property(dbus_interface, signature="v",
544
access="readwrite", byte_arrays=False):
545
"""Decorators for marking methods of a DBusObjectWithProperties to
546
become properties on the D-Bus.
547
548
The decorated method will be called with no arguments by "Get"
549
and with one argument by "Set".
550
551
The parameters, where they are supported, are the same as
552
dbus.service.method, except there is only "signature", since the
553
type from Get() and the type sent to Set() is the same.
554
"""
555
# Encoding deeply encoded byte arrays is not supported yet by the
556
# "Set" method, so we fail early here:
557
if byte_arrays and signature != "ay":
558
raise ValueError("Byte arrays not supported for non-'ay'"
559
" signature %r" % signature)
560
def decorator(func):
561
func._dbus_is_property = True
562
func._dbus_interface = dbus_interface
563
func._dbus_signature = signature
564
func._dbus_access = access
565
func._dbus_name = func.__name__
566
if func._dbus_name.endswith("_dbus_property"):
567
func._dbus_name = func._dbus_name[:-14]
568
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
569
return func
570
return decorator
571
572
573
class DBusPropertyException(dbus.exceptions.DBusException):
574
"""A base class for D-Bus property-related exceptions
575
"""
576
def __unicode__(self):
577
return unicode(str(self))
578
579
580
class DBusPropertyAccessException(DBusPropertyException):
581
"""A property's access permissions disallows an operation.
582
"""
583
pass
584
585
586
class DBusPropertyNotFound(DBusPropertyException):
587
"""An attempt was made to access a non-existing property.
588
"""
589
pass
590
591
592
class DBusObjectWithProperties(dbus.service.Object):
593
"""A D-Bus object with properties.
594
595
Classes inheriting from this can use the dbus_service_property
596
decorator to expose methods as D-Bus properties. It exposes the
597
standard Get(), Set(), and GetAll() methods on the D-Bus.
598
"""
599
600
@staticmethod
601
def _is_dbus_property(obj):
602
return getattr(obj, "_dbus_is_property", False)
603
604
def _get_all_dbus_properties(self):
605
"""Returns a generator of (name, attribute) pairs
606
"""
607
return ((prop._dbus_name, prop)
608
for name, prop in
609
inspect.getmembers(self, self._is_dbus_property))
610
611
def _get_dbus_property(self, interface_name, property_name):
612
"""Returns a bound method if one exists which is a D-Bus
613
property with the specified name and interface.
614
"""
615
for name in (property_name,
616
property_name + "_dbus_property"):
617
prop = getattr(self, name, None)
618
if (prop is None
619
or not self._is_dbus_property(prop)
620
or prop._dbus_name != property_name
621
or (interface_name and prop._dbus_interface
622
and interface_name != prop._dbus_interface)):
623
continue
624
return prop
625
# No such property
626
raise DBusPropertyNotFound(self.dbus_object_path + ":"
627
+ interface_name + "."
628
+ property_name)
629
630
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
631
out_signature="v")
632
def Get(self, interface_name, property_name):
633
"""Standard D-Bus property Get() method, see D-Bus standard.
634
"""
635
prop = self._get_dbus_property(interface_name, property_name)
636
if prop._dbus_access == "write":
637
raise DBusPropertyAccessException(property_name)
638
value = prop()
639
if not hasattr(value, "variant_level"):
640
return value
641
return type(value)(value, variant_level=value.variant_level+1)
642
643
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
644
def Set(self, interface_name, property_name, value):
645
"""Standard D-Bus property Set() method, see D-Bus standard.
646
"""
647
prop = self._get_dbus_property(interface_name, property_name)
648
if prop._dbus_access == "read":
649
raise DBusPropertyAccessException(property_name)
650
if prop._dbus_get_args_options["byte_arrays"]:
651
# The byte_arrays option is not supported yet on
652
# signatures other than "ay".
653
if prop._dbus_signature != "ay":
654
raise ValueError
655
value = dbus.ByteArray(''.join(unichr(byte)
656
for byte in value))
657
prop(value)
658
659
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
660
out_signature="a{sv}")
661
def GetAll(self, interface_name):
662
"""Standard D-Bus property GetAll() method, see D-Bus
663
standard.
664
665
Note: Will not include properties with access="write".
666
"""
667
all = {}
668
for name, prop in self._get_all_dbus_properties():
669
if (interface_name
670
and interface_name != prop._dbus_interface):
671
# Interface non-empty but did not match
672
continue
673
# Ignore write-only properties
674
if prop._dbus_access == "write":
675
continue
676
value = prop()
677
if not hasattr(value, "variant_level"):
678
all[name] = value
679
continue
680
all[name] = type(value)(value, variant_level=
681
value.variant_level+1)
682
return dbus.Dictionary(all, signature="sv")
683
684
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
685
out_signature="s",
686
path_keyword='object_path',
687
connection_keyword='connection')
688
def Introspect(self, object_path, connection):
689
"""Standard D-Bus method, overloaded to insert property tags.
690
"""
691
xmlstring = dbus.service.Object.Introspect(self, object_path,
692
connection)
693
try:
694
document = xml.dom.minidom.parseString(xmlstring)
695
def make_tag(document, name, prop):
696
e = document.createElement("property")
697
e.setAttribute("name", name)
698
e.setAttribute("type", prop._dbus_signature)
699
e.setAttribute("access", prop._dbus_access)
700
return e
701
for if_tag in document.getElementsByTagName("interface"):
702
for tag in (make_tag(document, name, prop)
703
for name, prop
704
in self._get_all_dbus_properties()
705
if prop._dbus_interface
706
== if_tag.getAttribute("name")):
707
if_tag.appendChild(tag)
708
# Add the names to the return values for the
709
# "org.freedesktop.DBus.Properties" methods
710
if (if_tag.getAttribute("name")
711
== "org.freedesktop.DBus.Properties"):
712
for cn in if_tag.getElementsByTagName("method"):
713
if cn.getAttribute("name") == "Get":
714
for arg in cn.getElementsByTagName("arg"):
715
if (arg.getAttribute("direction")
716
== "out"):
717
arg.setAttribute("name", "value")
718
elif cn.getAttribute("name") == "GetAll":
719
for arg in cn.getElementsByTagName("arg"):
720
if (arg.getAttribute("direction")
721
== "out"):
722
arg.setAttribute("name", "props")
723
xmlstring = document.toxml("utf-8")
724
document.unlink()
725
except (AttributeError, xml.dom.DOMException,
726
xml.parsers.expat.ExpatError) as error:
727
logger.error("Failed to override Introspection method",
728
error)
729
return xmlstring
730
731
732
class ClientDBus(Client, DBusObjectWithProperties):
481
733
"""A Client class using D-Bus
482
734
483
735
Attributes:
484
736
dbus_object_path: dbus.ObjectPath
485
737
bus: dbus.SystemBus()
486
738
"""
739
740
runtime_expansions = (Client.runtime_expansions
741
+ ("dbus_object_path",))
742
487
743
# dbus.service.Object doesn't use super(), so we can't either.
488
744
489
745
def __init__(self, bus = None, *args, **kwargs):
746
self._approvals_pending = 0
490
747
self.bus = bus
491
748
Client.__init__(self, *args, **kwargs)
492
749
# Only now, when this client is initialized, can it show up on
493
750
# the D-Bus
751
client_object_name = unicode(self.name).translate(
752
{ord("."): ord("_"),
753
ord("-"): ord("_")})
494
754
self.dbus_object_path = (dbus.ObjectPath
495
(u"/clients/"
496
+ self.name.replace(u".", u"_")))
497
dbus.service.Object.__init__(self, self.bus,
498
self.dbus_object_path)
755
("/clients/" + client_object_name))
756
DBusObjectWithProperties.__init__(self, self.bus,
757
self.dbus_object_path)
758
759
def _get_approvals_pending(self):
760
return self._approvals_pending
761
def _set_approvals_pending(self, value):
762
old_value = self._approvals_pending
763
self._approvals_pending = value
764
bval = bool(value)
765
if (hasattr(self, "dbus_object_path")
766
and bval is not bool(old_value)):
767
dbus_bool = dbus.Boolean(bval, variant_level=1)
768
self.PropertyChanged(dbus.String("ApprovalPending"),
769
dbus_bool)
770
771
approvals_pending = property(_get_approvals_pending,
772
_set_approvals_pending)
773
del _get_approvals_pending, _set_approvals_pending
499
774
500
775
@staticmethod
501
776
def _datetime_to_dbus(dt, variant_level=0):
504
779
variant_level=variant_level)
505
780
506
781
def enable(self):
507
oldstate = getattr(self, u"enabled", False)
782
oldstate = getattr(self, "enabled", False)
508
783
r = Client.enable(self)
509
784
if oldstate != self.enabled:
510
785
# Emit D-Bus signals
511
self.PropertyChanged(dbus.String(u"enabled"),
786
self.PropertyChanged(dbus.String("Enabled"),
512
787
dbus.Boolean(True, variant_level=1))
513
788
self.PropertyChanged(
514
dbus.String(u"last_enabled"),
789
dbus.String("LastEnabled"),
515
790
self._datetime_to_dbus(self.last_enabled,
516
791
variant_level=1))
517
792
return r
518
793
519
def disable(self, signal = True):
520
oldstate = getattr(self, u"enabled", False)
521
r = Client.disable(self)
522
if signal and oldstate != self.enabled:
794
def disable(self, quiet = False):
795
oldstate = getattr(self, "enabled", False)
796
r = Client.disable(self, quiet=quiet)
797
if not quiet and oldstate != self.enabled:
523
798
# Emit D-Bus signal
524
self.PropertyChanged(dbus.String(u"enabled"),
799
self.PropertyChanged(dbus.String("Enabled"),
525
800
dbus.Boolean(False, variant_level=1))
526
801
return r
527
802
530
805
self.remove_from_connection()
531
806
except LookupError:
532
807
pass
533
if hasattr(dbus.service.Object, u"__del__"):
534
dbus.service.Object.__del__(self, *args, **kwargs)
808
if hasattr(DBusObjectWithProperties, "__del__"):
809
DBusObjectWithProperties.__del__(self, *args, **kwargs)
535
810
Client.__del__(self, *args, **kwargs)
536
811
537
812
def checker_callback(self, pid, condition, command,
539
814
self.checker_callback_tag = None
540
815
self.checker = None
541
816
# Emit D-Bus signal
542
self.PropertyChanged(dbus.String(u"checker_running"),
817
self.PropertyChanged(dbus.String("CheckerRunning"),
543
818
dbus.Boolean(False, variant_level=1))
544
819
if os.WIFEXITED(condition):
545
820
exitstatus = os.WEXITSTATUS(condition)
557
832
*args, **kwargs)
558
833
559
834
def checked_ok(self, *args, **kwargs):
560
r = Client.checked_ok(self, *args, **kwargs)
835
Client.checked_ok(self, *args, **kwargs)
561
836
# Emit D-Bus signal
562
837
self.PropertyChanged(
563
dbus.String(u"last_checked_ok"),
838
dbus.String("LastCheckedOK"),
564
839
(self._datetime_to_dbus(self.last_checked_ok,
565
840
variant_level=1)))
841
842
def need_approval(self, *args, **kwargs):
843
r = Client.need_approval(self, *args, **kwargs)
844
# Emit D-Bus signal
845
self.PropertyChanged(
846
dbus.String("LastApprovalRequest"),
847
(self._datetime_to_dbus(self.last_approval_request,
848
variant_level=1)))
566
849
return r
567
850
568
851
def start_checker(self, *args, **kwargs):
578
861
# Emit D-Bus signal
579
862
self.CheckerStarted(self.current_checker_command)
580
863
self.PropertyChanged(
581
dbus.String(u"checker_running"),
864
dbus.String("CheckerRunning"),
582
865
dbus.Boolean(True, variant_level=1))
583
866
return r
584
867
585
868
def stop_checker(self, *args, **kwargs):
586
old_checker = getattr(self, u"checker", None)
869
old_checker = getattr(self, "checker", None)
587
870
r = Client.stop_checker(self, *args, **kwargs)
588
871
if (old_checker is not None
589
and getattr(self, u"checker", None) is None):
590
self.PropertyChanged(dbus.String(u"checker_running"),
872
and getattr(self, "checker", None) is None):
873
self.PropertyChanged(dbus.String("CheckerRunning"),
591
874
dbus.Boolean(False, variant_level=1))
592
875
return r
593
594
## D-Bus methods & signals
595
_interface = u"se.bsnet.fukt.Mandos.Client"
596
597
# CheckedOK - method
598
@dbus.service.method(_interface)
599
def CheckedOK(self):
600
return self.checked_ok()
876
877
def _reset_approved(self):
878
self._approved = None
879
return False
880
881
def approve(self, value=True):
882
self.send_changedstate()
883
self._approved = value
884
gobject.timeout_add(self._timedelta_to_milliseconds
885
(self.approval_duration),
886
self._reset_approved)
887
888
889
## D-Bus methods, signals & properties
890
_interface = "se.bsnet.fukt.Mandos.Client"
891
892
## Signals
601
893
602
894
# CheckerCompleted - signal
603
@dbus.service.signal(_interface, signature=u"nxs")
895
@dbus.service.signal(_interface, signature="nxs")
604
896
def CheckerCompleted(self, exitcode, waitstatus, command):
605
897
"D-Bus signal"
606
898
pass
607
899
608
900
# CheckerStarted - signal
609
@dbus.service.signal(_interface, signature=u"s")
901
@dbus.service.signal(_interface, signature="s")
610
902
def CheckerStarted(self, command):
611
903
"D-Bus signal"
612
904
pass
613
905
614
# GetAllProperties - method
615
@dbus.service.method(_interface, out_signature=u"a{sv}")
616
def GetAllProperties(self):
617
"D-Bus method"
618
return dbus.Dictionary({
619
dbus.String(u"name"):
620
dbus.String(self.name, variant_level=1),
621
dbus.String(u"fingerprint"):
622
dbus.String(self.fingerprint, variant_level=1),
623
dbus.String(u"host"):
624
dbus.String(self.host, variant_level=1),
625
dbus.String(u"created"):
626
self._datetime_to_dbus(self.created,
627
variant_level=1),
628
dbus.String(u"last_enabled"):
629
(self._datetime_to_dbus(self.last_enabled,
630
variant_level=1)
631
if self.last_enabled is not None
632
else dbus.Boolean(False, variant_level=1)),
633
dbus.String(u"enabled"):
634
dbus.Boolean(self.enabled, variant_level=1),
635
dbus.String(u"last_checked_ok"):
636
(self._datetime_to_dbus(self.last_checked_ok,
637
variant_level=1)
638
if self.last_checked_ok is not None
639
else dbus.Boolean (False, variant_level=1)),
640
dbus.String(u"timeout"):
641
dbus.UInt64(self.timeout_milliseconds(),
642
variant_level=1),
643
dbus.String(u"interval"):
644
dbus.UInt64(self.interval_milliseconds(),
645
variant_level=1),
646
dbus.String(u"checker"):
647
dbus.String(self.checker_command,
648
variant_level=1),
649
dbus.String(u"checker_running"):
650
dbus.Boolean(self.checker is not None,
651
variant_level=1),
652
dbus.String(u"object_path"):
653
dbus.ObjectPath(self.dbus_object_path,
654
variant_level=1)
655
}, signature=u"sv")
656
657
# IsStillValid - method
658
@dbus.service.method(_interface, out_signature=u"b")
659
def IsStillValid(self):
660
return self.still_valid()
661
662
906
# PropertyChanged - signal
663
@dbus.service.signal(_interface, signature=u"sv")
907
@dbus.service.signal(_interface, signature="sv")
664
908
def PropertyChanged(self, property, value):
665
909
"D-Bus signal"
666
910
pass
667
911
668
# ReceivedSecret - signal
912
# GotSecret - signal
669
913
@dbus.service.signal(_interface)
670
def ReceivedSecret(self):
671
"D-Bus signal"
914
def GotSecret(self):
915
"""D-Bus signal
916
Is sent after a successful transfer of secret from the Mandos
917
server to mandos-client
918
"""
672
919
pass
673
920
674
921
# Rejected - signal
675
@dbus.service.signal(_interface)
676
def Rejected(self):
922
@dbus.service.signal(_interface, signature="s")
923
def Rejected(self, reason):
677
924
"D-Bus signal"
678
925
pass
679
926
680
# SetChecker - method
681
@dbus.service.method(_interface, in_signature=u"s")
682
def SetChecker(self, checker):
683
"D-Bus setter method"
684
self.checker_command = checker
685
# Emit D-Bus signal
686
self.PropertyChanged(dbus.String(u"checker"),
687
dbus.String(self.checker_command,
688
variant_level=1))
689
690
# SetHost - method
691
@dbus.service.method(_interface, in_signature=u"s")
692
def SetHost(self, host):
693
"D-Bus setter method"
694
self.host = host
695
# Emit D-Bus signal
696
self.PropertyChanged(dbus.String(u"host"),
697
dbus.String(self.host, variant_level=1))
698
699
# SetInterval - method
700
@dbus.service.method(_interface, in_signature=u"t")
701
def SetInterval(self, milliseconds):
702
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
703
# Emit D-Bus signal
704
self.PropertyChanged(dbus.String(u"interval"),
705
(dbus.UInt64(self.interval_milliseconds(),
706
variant_level=1)))
707
708
# SetSecret - method
709
@dbus.service.method(_interface, in_signature=u"ay",
710
byte_arrays=True)
711
def SetSecret(self, secret):
712
"D-Bus setter method"
713
self.secret = str(secret)
714
715
# SetTimeout - method
716
@dbus.service.method(_interface, in_signature=u"t")
717
def SetTimeout(self, milliseconds):
718
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
719
# Emit D-Bus signal
720
self.PropertyChanged(dbus.String(u"timeout"),
721
(dbus.UInt64(self.timeout_milliseconds(),
722
variant_level=1)))
927
# NeedApproval - signal
928
@dbus.service.signal(_interface, signature="tb")
929
def NeedApproval(self, timeout, default):
930
"D-Bus signal"
931
return self.need_approval()
932
933
## Methods
934
935
# Approve - method
936
@dbus.service.method(_interface, in_signature="b")
937
def Approve(self, value):
938
self.approve(value)
939
940
# CheckedOK - method
941
@dbus.service.method(_interface)
942
def CheckedOK(self):
943
self.checked_ok()
723
944
724
945
# Enable - method
725
946
@dbus.service.method(_interface)
744
965
def StopChecker(self):
745
966
self.stop_checker()
746
967
968
## Properties
969
970
# ApprovalPending - property
971
@dbus_service_property(_interface, signature="b", access="read")
972
def ApprovalPending_dbus_property(self):
973
return dbus.Boolean(bool(self.approvals_pending))
974
975
# ApprovedByDefault - property
976
@dbus_service_property(_interface, signature="b",
977
access="readwrite")
978
def ApprovedByDefault_dbus_property(self, value=None):
979
if value is None: # get
980
return dbus.Boolean(self.approved_by_default)
981
self.approved_by_default = bool(value)
982
# Emit D-Bus signal
983
self.PropertyChanged(dbus.String("ApprovedByDefault"),
984
dbus.Boolean(value, variant_level=1))
985
986
# ApprovalDelay - property
987
@dbus_service_property(_interface, signature="t",
988
access="readwrite")
989
def ApprovalDelay_dbus_property(self, value=None):
990
if value is None: # get
991
return dbus.UInt64(self.approval_delay_milliseconds())
992
self.approval_delay = datetime.timedelta(0, 0, 0, value)
993
# Emit D-Bus signal
994
self.PropertyChanged(dbus.String("ApprovalDelay"),
995
dbus.UInt64(value, variant_level=1))
996
997
# ApprovalDuration - property
998
@dbus_service_property(_interface, signature="t",
999
access="readwrite")
1000
def ApprovalDuration_dbus_property(self, value=None):
1001
if value is None: # get
1002
return dbus.UInt64(self._timedelta_to_milliseconds(
1003
self.approval_duration))
1004
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1005
# Emit D-Bus signal
1006
self.PropertyChanged(dbus.String("ApprovalDuration"),
1007
dbus.UInt64(value, variant_level=1))
1008
1009
# Name - property
1010
@dbus_service_property(_interface, signature="s", access="read")
1011
def Name_dbus_property(self):
1012
return dbus.String(self.name)
1013
1014
# Fingerprint - property
1015
@dbus_service_property(_interface, signature="s", access="read")
1016
def Fingerprint_dbus_property(self):
1017
return dbus.String(self.fingerprint)
1018
1019
# Host - property
1020
@dbus_service_property(_interface, signature="s",
1021
access="readwrite")
1022
def Host_dbus_property(self, value=None):
1023
if value is None: # get
1024
return dbus.String(self.host)
1025
self.host = value
1026
# Emit D-Bus signal
1027
self.PropertyChanged(dbus.String("Host"),
1028
dbus.String(value, variant_level=1))
1029
1030
# Created - property
1031
@dbus_service_property(_interface, signature="s", access="read")
1032
def Created_dbus_property(self):
1033
return dbus.String(self._datetime_to_dbus(self.created))
1034
1035
# LastEnabled - property
1036
@dbus_service_property(_interface, signature="s", access="read")
1037
def LastEnabled_dbus_property(self):
1038
if self.last_enabled is None:
1039
return dbus.String("")
1040
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1041
1042
# Enabled - property
1043
@dbus_service_property(_interface, signature="b",
1044
access="readwrite")
1045
def Enabled_dbus_property(self, value=None):
1046
if value is None: # get
1047
return dbus.Boolean(self.enabled)
1048
if value:
1049
self.enable()
1050
else:
1051
self.disable()
1052
1053
# LastCheckedOK - property
1054
@dbus_service_property(_interface, signature="s",
1055
access="readwrite")
1056
def LastCheckedOK_dbus_property(self, value=None):
1057
if value is not None:
1058
self.checked_ok()
1059
return
1060
if self.last_checked_ok is None:
1061
return dbus.String("")
1062
return dbus.String(self._datetime_to_dbus(self
1063
.last_checked_ok))
1064
1065
# LastApprovalRequest - property
1066
@dbus_service_property(_interface, signature="s", access="read")
1067
def LastApprovalRequest_dbus_property(self):
1068
if self.last_approval_request is None:
1069
return dbus.String("")
1070
return dbus.String(self.
1071
_datetime_to_dbus(self
1072
.last_approval_request))
1073
1074
# Timeout - property
1075
@dbus_service_property(_interface, signature="t",
1076
access="readwrite")
1077
def Timeout_dbus_property(self, value=None):
1078
if value is None: # get
1079
return dbus.UInt64(self.timeout_milliseconds())
1080
self.timeout = datetime.timedelta(0, 0, 0, value)
1081
# Emit D-Bus signal
1082
self.PropertyChanged(dbus.String("Timeout"),
1083
dbus.UInt64(value, variant_level=1))
1084
if getattr(self, "disable_initiator_tag", None) is None:
1085
return
1086
# Reschedule timeout
1087
gobject.source_remove(self.disable_initiator_tag)
1088
self.disable_initiator_tag = None
1089
time_to_die = (self.
1090
_timedelta_to_milliseconds((self
1091
.last_checked_ok
1092
+ self.timeout)
1093
- datetime.datetime
1094
.utcnow()))
1095
if time_to_die <= 0:
1096
# The timeout has passed
1097
self.disable()
1098
else:
1099
self.disable_initiator_tag = (gobject.timeout_add
1100
(time_to_die, self.disable))
1101
1102
# Interval - property
1103
@dbus_service_property(_interface, signature="t",
1104
access="readwrite")
1105
def Interval_dbus_property(self, value=None):
1106
if value is None: # get
1107
return dbus.UInt64(self.interval_milliseconds())
1108
self.interval = datetime.timedelta(0, 0, 0, value)
1109
# Emit D-Bus signal
1110
self.PropertyChanged(dbus.String("Interval"),
1111
dbus.UInt64(value, variant_level=1))
1112
if getattr(self, "checker_initiator_tag", None) is None:
1113
return
1114
# Reschedule checker run
1115
gobject.source_remove(self.checker_initiator_tag)
1116
self.checker_initiator_tag = (gobject.timeout_add
1117
(value, self.start_checker))
1118
self.start_checker() # Start one now, too
1119
1120
# Checker - property
1121
@dbus_service_property(_interface, signature="s",
1122
access="readwrite")
1123
def Checker_dbus_property(self, value=None):
1124
if value is None: # get
1125
return dbus.String(self.checker_command)
1126
self.checker_command = value
1127
# Emit D-Bus signal
1128
self.PropertyChanged(dbus.String("Checker"),
1129
dbus.String(self.checker_command,
1130
variant_level=1))
1131
1132
# CheckerRunning - property
1133
@dbus_service_property(_interface, signature="b",
1134
access="readwrite")
1135
def CheckerRunning_dbus_property(self, value=None):
1136
if value is None: # get
1137
return dbus.Boolean(self.checker is not None)
1138
if value:
1139
self.start_checker()
1140
else:
1141
self.stop_checker()
1142
1143
# ObjectPath - property
1144
@dbus_service_property(_interface, signature="o", access="read")
1145
def ObjectPath_dbus_property(self):
1146
return self.dbus_object_path # is already a dbus.ObjectPath
1147
1148
# Secret = property
1149
@dbus_service_property(_interface, signature="ay",
1150
access="write", byte_arrays=True)
1151
def Secret_dbus_property(self, value):
1152
self.secret = str(value)
1153
747
1154
del _interface
748
1155
749
1156
1157
class ProxyClient(object):
1158
def __init__(self, child_pipe, fpr, address):
1159
self._pipe = child_pipe
1160
self._pipe.send(('init', fpr, address))
1161
if not self._pipe.recv():
1162
raise KeyError()
1163
1164
def __getattribute__(self, name):
1165
if(name == '_pipe'):
1166
return super(ProxyClient, self).__getattribute__(name)
1167
self._pipe.send(('getattr', name))
1168
data = self._pipe.recv()
1169
if data[0] == 'data':
1170
return data[1]
1171
if data[0] == 'function':
1172
def func(*args, **kwargs):
1173
self._pipe.send(('funcall', name, args, kwargs))
1174
return self._pipe.recv()[1]
1175
return func
1176
1177
def __setattr__(self, name, value):
1178
if(name == '_pipe'):
1179
return super(ProxyClient, self).__setattr__(name, value)
1180
self._pipe.send(('setattr', name, value))
1181
1182
750
1183
class ClientHandler(socketserver.BaseRequestHandler, object):
751
1184
"""A class to handle client connections.
752
1185
754
1187
Note: This will run in its own forked process."""
755
1188
756
1189
def handle(self):
757
logger.info(u"TCP connection from: %s",
758
unicode(self.client_address))
759
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
760
# Open IPC pipe to parent process
761
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
1190
with contextlib.closing(self.server.child_pipe) as child_pipe:
1191
logger.info("TCP connection from: %s",
1192
unicode(self.client_address))
1193
logger.debug("Pipe FD: %d",
1194
self.server.child_pipe.fileno())
1195
762
1196
session = (gnutls.connection
763
1197
.ClientSession(self.request,
764
1198
gnutls.connection
765
1199
.X509Credentials()))
766
767
line = self.request.makefile().readline()
768
logger.debug(u"Protocol version: %r", line)
769
try:
770
if int(line.strip().split()[0]) > 1:
771
raise RuntimeError
772
except (ValueError, IndexError, RuntimeError), error:
773
logger.error(u"Unknown protocol version: %s", error)
774
return
775
1200
776
1201
# Note: gnutls.connection.X509Credentials is really a
777
1202
# generic GnuTLS certificate credentials object so long as
778
1203
# no X.509 keys are added to it. Therefore, we can use it
779
1204
# here despite using OpenPGP certificates.
780
781
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
782
# u"+AES-256-CBC", u"+SHA1",
783
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
784
# u"+DHE-DSS"))
1205
1206
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1207
# "+AES-256-CBC", "+SHA1",
1208
# "+COMP-NULL", "+CTYPE-OPENPGP",
1209
# "+DHE-DSS"))
785
1210
# Use a fallback default, since this MUST be set.
786
1211
priority = self.server.gnutls_priority
787
1212
if priority is None:
788
priority = u"NORMAL"
1213
priority = "NORMAL"
789
1214
(gnutls.library.functions
790
1215
.gnutls_priority_set_direct(session._c_object,
791
1216
priority, None))
792
1217
1218
# Start communication using the Mandos protocol
1219
# Get protocol number
1220
line = self.request.makefile().readline()
1221
logger.debug("Protocol version: %r", line)
1222
try:
1223
if int(line.strip().split()[0]) > 1:
1224
raise RuntimeError
1225
except (ValueError, IndexError, RuntimeError) as error:
1226
logger.error("Unknown protocol version: %s", error)
1227
return
1228
1229
# Start GnuTLS connection
793
1230
try:
794
1231
session.handshake()
795
except gnutls.errors.GNUTLSError, error:
796
logger.warning(u"Handshake failed: %s", error)
1232
except gnutls.errors.GNUTLSError as error:
1233
logger.warning("Handshake failed: %s", error)
797
1234
# Do not run session.bye() here: the session is not
798
1235
# established. Just abandon the request.
799
1236
return
800
logger.debug(u"Handshake succeeded")
1237
logger.debug("Handshake succeeded")
1238
1239
approval_required = False
801
1240
try:
802
fpr = self.fingerprint(self.peer_certificate(session))
803
except (TypeError, gnutls.errors.GNUTLSError), error:
804
logger.warning(u"Bad certificate: %s", error)
805
session.bye()
806
return
807
logger.debug(u"Fingerprint: %s", fpr)
1241
try:
1242
fpr = self.fingerprint(self.peer_certificate
1243
(session))
1244
except (TypeError,
1245
gnutls.errors.GNUTLSError) as error:
1246
logger.warning("Bad certificate: %s", error)
1247
return
1248
logger.debug("Fingerprint: %s", fpr)
1249
1250
try:
1251
client = ProxyClient(child_pipe, fpr,
1252
self.client_address)
1253
except KeyError:
1254
return
1255
1256
if client.approval_delay:
1257
delay = client.approval_delay
1258
client.approvals_pending += 1
1259
approval_required = True
1260
1261
while True:
1262
if not client.enabled:
1263
logger.warning("Client %s is disabled",
1264
client.name)
1265
if self.server.use_dbus:
1266
# Emit D-Bus signal
1267
client.Rejected("Disabled")
1268
return
1269
1270
if client._approved or not client.approval_delay:
1271
#We are approved or approval is disabled
1272
break
1273
elif client._approved is None:
1274
logger.info("Client %s needs approval",
1275
client.name)
1276
if self.server.use_dbus:
1277
# Emit D-Bus signal
1278
client.NeedApproval(
1279
client.approval_delay_milliseconds(),
1280
client.approved_by_default)
1281
else:
1282
logger.warning("Client %s was not approved",
1283
client.name)
1284
if self.server.use_dbus:
1285
# Emit D-Bus signal
1286
client.Rejected("Denied")
1287
return
1288
1289
#wait until timeout or approved
1290
#x = float(client._timedelta_to_milliseconds(delay))
1291
time = datetime.datetime.now()
1292
client.changedstate.acquire()
1293
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1294
client.changedstate.release()
1295
time2 = datetime.datetime.now()
1296
if (time2 - time) >= delay:
1297
if not client.approved_by_default:
1298
logger.warning("Client %s timed out while"
1299
" waiting for approval",
1300
client.name)
1301
if self.server.use_dbus:
1302
# Emit D-Bus signal
1303
client.Rejected("Approval timed out")
1304
return
1305
else:
1306
break
1307
else:
1308
delay -= time2 - time
1309
1310
sent_size = 0
1311
while sent_size < len(client.secret):
1312
try:
1313
sent = session.send(client.secret[sent_size:])
1314
except gnutls.errors.GNUTLSError as error:
1315
logger.warning("gnutls send failed")
1316
return
1317
logger.debug("Sent: %d, remaining: %d",
1318
sent, len(client.secret)
1319
- (sent_size + sent))
1320
sent_size += sent
1321
1322
logger.info("Sending secret to %s", client.name)
1323
# bump the timeout as if seen
1324
client.checked_ok()
1325
if self.server.use_dbus:
1326
# Emit D-Bus signal
1327
client.GotSecret()
808
1328
809
for c in self.server.clients:
810
if c.fingerprint == fpr:
811
client = c
812
break
813
else:
814
ipc.write(u"NOTFOUND %s %s\n"
815
% (fpr, unicode(self.client_address)))
816
session.bye()
817
return
818
# Have to check if client.still_valid(), since it is
819
# possible that the client timed out while establishing
820
# the GnuTLS session.
821
if not client.still_valid():
822
ipc.write(u"INVALID %s\n" % client.name)
823
session.bye()
824
return
825
ipc.write(u"SENDING %s\n" % client.name)
826
sent_size = 0
827
while sent_size < len(client.secret):
828
sent = session.send(client.secret[sent_size:])
829
logger.debug(u"Sent: %d, remaining: %d",
830
sent, len(client.secret)
831
- (sent_size + sent))
832
sent_size += sent
833
session.bye()
1329
finally:
1330
if approval_required:
1331
client.approvals_pending -= 1
1332
try:
1333
session.bye()
1334
except gnutls.errors.GNUTLSError as error:
1335
logger.warning("GnuTLS bye failed")
834
1336
835
1337
@staticmethod
836
1338
def peer_certificate(session):
846
1348
.gnutls_certificate_get_peers
847
1349
(session._c_object, ctypes.byref(list_size)))
848
1350
if not bool(cert_list) and list_size.value != 0:
849
raise gnutls.errors.GNUTLSError(u"error getting peer"
850
u" certificate")
1351
raise gnutls.errors.GNUTLSError("error getting peer"
1352
" certificate")
851
1353
if list_size.value == 0:
852
1354
return None
853
1355
cert = cert_list[0]
879
1381
if crtverify.value != 0:
880
1382
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
881
1383
raise (gnutls.errors.CertificateSecurityError
882
(u"Verify failed"))
1384
("Verify failed"))
883
1385
# New buffer for the fingerprint
884
1386
buf = ctypes.create_string_buffer(20)
885
1387
buf_len = ctypes.c_size_t()
892
1394
# Convert the buffer to a Python bytestring
893
1395
fpr = ctypes.string_at(buf, buf_len.value)
894
1396
# Convert the bytestring to hexadecimal notation
895
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1397
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
896
1398
return hex_fpr
897
1399
898
1400
899
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
900
"""Like socketserver.ForkingMixIn, but also pass a pipe."""
1401
class MultiprocessingMixIn(object):
1402
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1403
def sub_process_main(self, request, address):
1404
try:
1405
self.finish_request(request, address)
1406
except:
1407
self.handle_error(request, address)
1408
self.close_request(request)
1409
1410
def process_request(self, request, address):
1411
"""Start a new process to process the request."""
1412
multiprocessing.Process(target = self.sub_process_main,
1413
args = (request, address)).start()
1414
1415
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1416
""" adds a pipe to the MixIn """
901
1417
def process_request(self, request, client_address):
902
1418
"""Overrides and wraps the original process_request().
903
1419
904
1420
This function creates a new pipe in self.pipe
905
1421
"""
906
self.pipe = os.pipe()
907
super(ForkingMixInWithPipe,
1422
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1423
1424
super(MultiprocessingMixInWithPipe,
908
1425
self).process_request(request, client_address)
909
os.close(self.pipe[1]) # close write end
910
self.add_pipe(self.pipe[0])
911
def add_pipe(self, pipe):
1426
self.child_pipe.close()
1427
self.add_pipe(parent_pipe)
1428
1429
def add_pipe(self, parent_pipe):
912
1430
"""Dummy function; override as necessary"""
913
os.close(pipe)
914
915
916
class IPv6_TCPServer(ForkingMixInWithPipe,
1431
raise NotImplementedError
1432
1433
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
917
1434
socketserver.TCPServer, object):
918
1435
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
919
1436
935
1452
bind to an address or port if they were not specified."""
936
1453
if self.interface is not None:
937
1454
if SO_BINDTODEVICE is None:
938
logger.error(u"SO_BINDTODEVICE does not exist;"
939
u" cannot bind to interface %s",
1455
logger.error("SO_BINDTODEVICE does not exist;"
1456
" cannot bind to interface %s",
940
1457
self.interface)
941
1458
else:
942
1459
try:
943
1460
self.socket.setsockopt(socket.SOL_SOCKET,
944
1461
SO_BINDTODEVICE,
945
1462
str(self.interface
946
+ u'\0'))
947
except socket.error, error:
1463
+ '\0'))
1464
except socket.error as error:
948
1465
if error[0] == errno.EPERM:
949
logger.error(u"No permission to"
950
u" bind to interface %s",
1466
logger.error("No permission to"
1467
" bind to interface %s",
951
1468
self.interface)
952
1469
elif error[0] == errno.ENOPROTOOPT:
953
logger.error(u"SO_BINDTODEVICE not available;"
954
u" cannot bind to interface %s",
1470
logger.error("SO_BINDTODEVICE not available;"
1471
" cannot bind to interface %s",
955
1472
self.interface)
956
1473
else:
957
1474
raise
959
1476
if self.server_address[0] or self.server_address[1]:
960
1477
if not self.server_address[0]:
961
1478
if self.address_family == socket.AF_INET6:
962
any_address = u"::" # in6addr_any
1479
any_address = "::" # in6addr_any
963
1480
else:
964
1481
any_address = socket.INADDR_ANY
965
1482
self.server_address = (any_address,
983
1500
clients: set of Client objects
984
1501
gnutls_priority GnuTLS priority string
985
1502
use_dbus: Boolean; to emit D-Bus signals or not
986
clients: set of Client objects
987
gnutls_priority GnuTLS priority string
988
use_dbus: Boolean; to emit D-Bus signals or not
989
1503
990
1504
Assumes a gobject.MainLoop event loop.
991
1505
"""
1007
1521
return socketserver.TCPServer.server_activate(self)
1008
1522
def enable(self):
1009
1523
self.enabled = True
1010
def add_pipe(self, pipe):
1524
def add_pipe(self, parent_pipe):
1011
1525
# Call "handle_ipc" for both data and EOF events
1012
gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1013
self.handle_ipc)
1014
def handle_ipc(self, source, condition, file_objects={}):
1526
gobject.io_add_watch(parent_pipe.fileno(),
1527
gobject.IO_IN | gobject.IO_HUP,
1528
functools.partial(self.handle_ipc,
1529
parent_pipe = parent_pipe))
1530
1531
def handle_ipc(self, source, condition, parent_pipe=None,
1532
client_object=None):
1015
1533
condition_names = {
1016
gobject.IO_IN: u"IN", # There is data to read.
1017
gobject.IO_OUT: u"OUT", # Data can be written (without
1534
gobject.IO_IN: "IN", # There is data to read.
1535
gobject.IO_OUT: "OUT", # Data can be written (without
1018
1536
# blocking).
1019
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1020
gobject.IO_ERR: u"ERR", # Error condition.
1021
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1537
gobject.IO_PRI: "PRI", # There is urgent data to read.
1538
gobject.IO_ERR: "ERR", # Error condition.
1539
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1022
1540
# broken, usually for pipes and
1023
1541
# sockets).
1024
1542
}
1026
1544
for cond, name in
1027
1545
condition_names.iteritems()
1028
1546
if cond & condition)
1029
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1030
conditions_string)
1031
1032
# Turn the pipe file descriptor into a Python file object
1033
if source not in file_objects:
1034
file_objects[source] = os.fdopen(source, u"r", 1)
1035
1036
# Read a line from the file object
1037
cmdline = file_objects[source].readline()
1038
if not cmdline: # Empty line means end of file
1039
# close the IPC pipe
1040
file_objects[source].close()
1041
del file_objects[source]
1042
1043
# Stop calling this function
1044
return False
1045
1046
logger.debug(u"IPC command: %r", cmdline)
1047
1048
# Parse and act on command
1049
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1050
1051
if cmd == u"NOTFOUND":
1052
logger.warning(u"Client not found for fingerprint: %s",
1053
args)
1054
if self.use_dbus:
1055
# Emit D-Bus signal
1056
mandos_dbus_service.ClientNotFound(args)
1057
elif cmd == u"INVALID":
1058
for client in self.clients:
1059
if client.name == args:
1060
logger.warning(u"Client %s is invalid", args)
1061
if self.use_dbus:
1062
# Emit D-Bus signal
1063
client.Rejected()
1064
break
1065
else:
1066
logger.error(u"Unknown client %s is invalid", args)
1067
elif cmd == u"SENDING":
1068
for client in self.clients:
1069
if client.name == args:
1070
logger.info(u"Sending secret to %s", client.name)
1071
client.checked_ok()
1072
if self.use_dbus:
1073
# Emit D-Bus signal
1074
client.ReceivedSecret()
1075
break
1076
else:
1077
logger.error(u"Sending secret to unknown client %s",
1078
args)
1079
else:
1080
logger.error(u"Unknown IPC command: %r", cmdline)
1081
1082
# Keep calling this function
1547
# error or the other end of multiprocessing.Pipe has closed
1548
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1549
return False
1550
1551
# Read a request from the child
1552
request = parent_pipe.recv()
1553
command = request[0]
1554
1555
if command == 'init':
1556
fpr = request[1]
1557
address = request[2]
1558
1559
for c in self.clients:
1560
if c.fingerprint == fpr:
1561
client = c
1562
break
1563
else:
1564
logger.warning("Client not found for fingerprint: %s, ad"
1565
"dress: %s", fpr, address)
1566
if self.use_dbus:
1567
# Emit D-Bus signal
1568
mandos_dbus_service.ClientNotFound(fpr, address[0])
1569
parent_pipe.send(False)
1570
return False
1571
1572
gobject.io_add_watch(parent_pipe.fileno(),
1573
gobject.IO_IN | gobject.IO_HUP,
1574
functools.partial(self.handle_ipc,
1575
parent_pipe = parent_pipe,
1576
client_object = client))
1577
parent_pipe.send(True)
1578
# remove the old hook in favor of the new above hook on same fileno
1579
return False
1580
if command == 'funcall':
1581
funcname = request[1]
1582
args = request[2]
1583
kwargs = request[3]
1584
1585
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1586
1587
if command == 'getattr':
1588
attrname = request[1]
1589
if callable(client_object.__getattribute__(attrname)):
1590
parent_pipe.send(('function',))
1591
else:
1592
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
1593
1594
if command == 'setattr':
1595
attrname = request[1]
1596
value = request[2]
1597
setattr(client_object, attrname, value)
1598
1083
1599
return True
1084
1600
1085
1601
1086
1602
def string_to_delta(interval):
1087
1603
"""Parse a string and return a datetime.timedelta
1088
1604
1089
>>> string_to_delta(u'7d')
1605
>>> string_to_delta('7d')
1090
1606
datetime.timedelta(7)
1091
>>> string_to_delta(u'60s')
1607
>>> string_to_delta('60s')
1092
1608
datetime.timedelta(0, 60)
1093
>>> string_to_delta(u'60m')
1609
>>> string_to_delta('60m')
1094
1610
datetime.timedelta(0, 3600)
1095
>>> string_to_delta(u'24h')
1611
>>> string_to_delta('24h')
1096
1612
datetime.timedelta(1)
1097
>>> string_to_delta(u'1w')
1613
>>> string_to_delta('1w')
1098
1614
datetime.timedelta(7)
1099
>>> string_to_delta(u'5m 30s')
1615
>>> string_to_delta('5m 30s')
1100
1616
datetime.timedelta(0, 330)
1101
1617
"""
1102
1618
timevalue = datetime.timedelta(0)
1104
1620
try:
1105
1621
suffix = unicode(s[-1])
1106
1622
value = int(s[:-1])
1107
if suffix == u"d":
1623
if suffix == "d":
1108
1624
delta = datetime.timedelta(value)
1109
elif suffix == u"s":
1625
elif suffix == "s":
1110
1626
delta = datetime.timedelta(0, value)
1111
elif suffix == u"m":
1627
elif suffix == "m":
1112
1628
delta = datetime.timedelta(0, 0, 0, 0, value)
1113
elif suffix == u"h":
1629
elif suffix == "h":
1114
1630
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1115
elif suffix == u"w":
1631
elif suffix == "w":
1116
1632
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1117
1633
else:
1118
raise ValueError
1119
except (ValueError, IndexError):
1120
raise ValueError
1634
raise ValueError("Unknown suffix %r" % suffix)
1635
except (ValueError, IndexError) as e:
1636
raise ValueError(*(e.args))
1121
1637
timevalue += delta
1122
1638
return timevalue
1123
1639
1129
1645
global if_nametoindex
1130
1646
try:
1131
1647
if_nametoindex = (ctypes.cdll.LoadLibrary
1132
(ctypes.util.find_library(u"c"))
1648
(ctypes.util.find_library("c"))
1133
1649
.if_nametoindex)
1134
1650
except (OSError, AttributeError):
1135
logger.warning(u"Doing if_nametoindex the hard way")
1651
logger.warning("Doing if_nametoindex the hard way")
1136
1652
def if_nametoindex(interface):
1137
1653
"Get an interface index the hard way, i.e. using fcntl()"
1138
1654
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1139
with closing(socket.socket()) as s:
1655
with contextlib.closing(socket.socket()) as s:
1140
1656
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1141
struct.pack(str(u"16s16x"),
1657
struct.pack(str("16s16x"),
1142
1658
interface))
1143
interface_index = struct.unpack(str(u"I"),
1659
interface_index = struct.unpack(str("I"),
1144
1660
ifreq[16:20])[0]
1145
1661
return interface_index
1146
1662
return if_nametoindex(interface)
1154
1670
sys.exit()
1155
1671
os.setsid()
1156
1672
if not nochdir:
1157
os.chdir(u"/")
1673
os.chdir("/")
1158
1674
if os.fork():
1159
1675
sys.exit()
1160
1676
if not noclose:
1162
1678
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1163
1679
if not stat.S_ISCHR(os.fstat(null).st_mode):
1164
1680
raise OSError(errno.ENODEV,
1165
u"/dev/null not a character device")
1681
"%s not a character device"
1682
% os.path.devnull)
1166
1683
os.dup2(null, sys.stdin.fileno())
1167
1684
os.dup2(null, sys.stdout.fileno())
1168
1685
os.dup2(null, sys.stderr.fileno())
1172
1689
1173
1690
def main():
1174
1691
1175
######################################################################
1692
##################################################################
1176
1693
# Parsing of options, both command line and config file
1177
1694
1178
parser = optparse.OptionParser(version = "%%prog %s" % version)
1179
parser.add_option("-i", u"--interface", type=u"string",
1180
metavar="IF", help=u"Bind to interface IF")
1181
parser.add_option("-a", u"--address", type=u"string",
1182
help=u"Address to listen for requests on")
1183
parser.add_option("-p", u"--port", type=u"int",
1184
help=u"Port number to receive requests on")
1185
parser.add_option("--check", action=u"store_true",
1186
help=u"Run self-test")
1187
parser.add_option("--debug", action=u"store_true",
1188
help=u"Debug mode; run in foreground and log to"
1189
u" terminal")
1190
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1191
u" priority string (see GnuTLS documentation)")
1192
parser.add_option("--servicename", type=u"string",
1193
metavar=u"NAME", help=u"Zeroconf service name")
1194
parser.add_option("--configdir", type=u"string",
1195
default=u"/etc/mandos", metavar=u"DIR",
1196
help=u"Directory to search for configuration"
1197
u" files")
1198
parser.add_option("--no-dbus", action=u"store_false",
1199
dest=u"use_dbus", help=u"Do not provide D-Bus"
1200
u" system bus interface")
1201
parser.add_option("--no-ipv6", action=u"store_false",
1202
dest=u"use_ipv6", help=u"Do not use IPv6")
1203
options = parser.parse_args()[0]
1695
parser = argparse.ArgumentParser()
1696
parser.add_argument("-v", "--version", action="version",
1697
version = "%%(prog)s %s" % version,
1698
help="show version number and exit")
1699
parser.add_argument("-i", "--interface", metavar="IF",
1700
help="Bind to interface IF")
1701
parser.add_argument("-a", "--address",
1702
help="Address to listen for requests on")
1703
parser.add_argument("-p", "--port", type=int,
1704
help="Port number to receive requests on")
1705
parser.add_argument("--check", action="store_true",
1706
help="Run self-test")
1707
parser.add_argument("--debug", action="store_true",
1708
help="Debug mode; run in foreground and log"
1709
" to terminal")
1710
parser.add_argument("--debuglevel", metavar="LEVEL",
1711
help="Debug level for stdout output")
1712
parser.add_argument("--priority", help="GnuTLS"
1713
" priority string (see GnuTLS documentation)")
1714
parser.add_argument("--servicename",
1715
metavar="NAME", help="Zeroconf service name")
1716
parser.add_argument("--configdir",
1717
default="/etc/mandos", metavar="DIR",
1718
help="Directory to search for configuration"
1719
" files")
1720
parser.add_argument("--no-dbus", action="store_false",
1721
dest="use_dbus", help="Do not provide D-Bus"
1722
" system bus interface")
1723
parser.add_argument("--no-ipv6", action="store_false",
1724
dest="use_ipv6", help="Do not use IPv6")
1725
options = parser.parse_args()
1204
1726
1205
1727
if options.check:
1206
1728
import doctest
1208
1730
sys.exit()
1209
1731
1210
1732
# Default values for config file for server-global settings
1211
server_defaults = { u"interface": u"",
1212
u"address": u"",
1213
u"port": u"",
1214
u"debug": u"False",
1215
u"priority":
1216
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1217
u"servicename": u"Mandos",
1218
u"use_dbus": u"True",
1219
u"use_ipv6": u"True",
1733
server_defaults = { "interface": "",
1734
"address": "",
1735
"port": "",
1736
"debug": "False",
1737
"priority":
1738
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1739
"servicename": "Mandos",
1740
"use_dbus": "True",
1741
"use_ipv6": "True",
1742
"debuglevel": "",
1220
1743
}
1221
1744
1222
1745
# Parse config file for server-global settings
1223
1746
server_config = configparser.SafeConfigParser(server_defaults)
1224
1747
del server_defaults
1225
1748
server_config.read(os.path.join(options.configdir,
1226
u"mandos.conf"))
1749
"mandos.conf"))
1227
1750
# Convert the SafeConfigParser object to a dict
1228
1751
server_settings = server_config.defaults()
1229
1752
# Use the appropriate methods on the non-string config options
1230
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1231
server_settings[option] = server_config.getboolean(u"DEFAULT",
1753
for option in ("debug", "use_dbus", "use_ipv6"):
1754
server_settings[option] = server_config.getboolean("DEFAULT",
1232
1755
option)
1233
1756
if server_settings["port"]:
1234
server_settings["port"] = server_config.getint(u"DEFAULT",
1235
u"port")
1757
server_settings["port"] = server_config.getint("DEFAULT",
1758
"port")
1236
1759
del server_config
1237
1760
1238
1761
# Override the settings from the config file with command line
1239
1762
# options, if set.
1240
for option in (u"interface", u"address", u"port", u"debug",
1241
u"priority", u"servicename", u"configdir",
1242
u"use_dbus", u"use_ipv6"):
1763
for option in ("interface", "address", "port", "debug",
1764
"priority", "servicename", "configdir",
1765
"use_dbus", "use_ipv6", "debuglevel"):
1243
1766
value = getattr(options, option)
1244
1767
if value is not None:
1245
1768
server_settings[option] = value
1253
1776
##################################################################
1254
1777
1255
1778
# For convenience
1256
debug = server_settings[u"debug"]
1257
use_dbus = server_settings[u"use_dbus"]
1258
use_ipv6 = server_settings[u"use_ipv6"]
1259
1260
if not debug:
1261
syslogger.setLevel(logging.WARNING)
1262
console.setLevel(logging.WARNING)
1263
1264
if server_settings[u"servicename"] != u"Mandos":
1779
debug = server_settings["debug"]
1780
debuglevel = server_settings["debuglevel"]
1781
use_dbus = server_settings["use_dbus"]
1782
use_ipv6 = server_settings["use_ipv6"]
1783
1784
if server_settings["servicename"] != "Mandos":
1265
1785
syslogger.setFormatter(logging.Formatter
1266
(u'Mandos (%s) [%%(process)d]:'
1267
u' %%(levelname)s: %%(message)s'
1268
% server_settings[u"servicename"]))
1786
('Mandos (%s) [%%(process)d]:'
1787
' %%(levelname)s: %%(message)s'
1788
% server_settings["servicename"]))
1269
1789
1270
1790
# Parse config file with clients
1271
client_defaults = { u"timeout": u"1h",
1272
u"interval": u"5m",
1273
u"checker": u"fping -q -- %%(host)s",
1274
u"host": u"",
1791
client_defaults = { "timeout": "1h",
1792
"interval": "5m",
1793
"checker": "fping -q -- %%(host)s",
1794
"host": "",
1795
"approval_delay": "0s",
1796
"approval_duration": "1s",
1275
1797
}
1276
1798
client_config = configparser.SafeConfigParser(client_defaults)
1277
client_config.read(os.path.join(server_settings[u"configdir"],
1278
u"clients.conf"))
1799
client_config.read(os.path.join(server_settings["configdir"],
1800
"clients.conf"))
1279
1801
1280
1802
global mandos_dbus_service
1281
1803
mandos_dbus_service = None
1282
1804
1283
tcp_server = MandosServer((server_settings[u"address"],
1284
server_settings[u"port"]),
1805
tcp_server = MandosServer((server_settings["address"],
1806
server_settings["port"]),
1285
1807
ClientHandler,
1286
interface=server_settings[u"interface"],
1808
interface=(server_settings["interface"]
1809
or None),
1287
1810
use_ipv6=use_ipv6,
1288
1811
gnutls_priority=
1289
server_settings[u"priority"],
1812
server_settings["priority"],
1290
1813
use_dbus=use_dbus)
1291
pidfilename = u"/var/run/mandos.pid"
1292
try:
1293
pidfile = open(pidfilename, u"w")
1294
except IOError:
1295
logger.error(u"Could not open file %r", pidfilename)
1814
if not debug:
1815
pidfilename = "/var/run/mandos.pid"
1816
try:
1817
pidfile = open(pidfilename, "w")
1818
except IOError:
1819
logger.error("Could not open file %r", pidfilename)
1296
1820
1297
1821
try:
1298
uid = pwd.getpwnam(u"_mandos").pw_uid
1299
gid = pwd.getpwnam(u"_mandos").pw_gid
1822
uid = pwd.getpwnam("_mandos").pw_uid
1823
gid = pwd.getpwnam("_mandos").pw_gid
1300
1824
except KeyError:
1301
1825
try:
1302
uid = pwd.getpwnam(u"mandos").pw_uid
1303
gid = pwd.getpwnam(u"mandos").pw_gid
1826
uid = pwd.getpwnam("mandos").pw_uid
1827
gid = pwd.getpwnam("mandos").pw_gid
1304
1828
except KeyError:
1305
1829
try:
1306
uid = pwd.getpwnam(u"nobody").pw_uid
1307
gid = pwd.getpwnam(u"nobody").pw_gid
1830
uid = pwd.getpwnam("nobody").pw_uid
1831
gid = pwd.getpwnam("nobody").pw_gid
1308
1832
except KeyError:
1309
1833
uid = 65534
1310
1834
gid = 65534
1311
1835
try:
1312
1836
os.setgid(gid)
1313
1837
os.setuid(uid)
1314
except OSError, error:
1838
except OSError as error:
1315
1839
if error[0] != errno.EPERM:
1316
1840
raise error
1317
1841
1318
# Enable all possible GnuTLS debugging
1842
if not debug and not debuglevel:
1843
syslogger.setLevel(logging.WARNING)
1844
console.setLevel(logging.WARNING)
1845
if debuglevel:
1846
level = getattr(logging, debuglevel.upper())
1847
syslogger.setLevel(level)
1848
console.setLevel(level)
1849
1319
1850
if debug:
1851
# Enable all possible GnuTLS debugging
1852
1320
1853
# "Use a log level over 10 to enable all debugging options."
1321
1854
# - GnuTLS manual
1322
1855
gnutls.library.functions.gnutls_global_set_log_level(11)
1323
1856
1324
1857
@gnutls.library.types.gnutls_log_func
1325
1858
def debug_gnutls(level, string):
1326
logger.debug(u"GnuTLS: %s", string[:-1])
1859
logger.debug("GnuTLS: %s", string[:-1])
1327
1860
1328
1861
(gnutls.library.functions
1329
1862
.gnutls_global_set_log_function(debug_gnutls))
1863
1864
# Redirect stdin so all checkers get /dev/null
1865
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1866
os.dup2(null, sys.stdin.fileno())
1867
if null > 2:
1868
os.close(null)
1869
else:
1870
# No console logging
1871
logger.removeHandler(console)
1872
1873
# Need to fork before connecting to D-Bus
1874
if not debug:
1875
# Close all input and output, do double fork, etc.
1876
daemon()
1330
1877
1331
1878
global main_loop
1332
1879
# From the Avahi example code
1335
1882
bus = dbus.SystemBus()
1336
1883
# End of Avahi example code
1337
1884
if use_dbus:
1338
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1885
try:
1886
bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1887
bus, do_not_queue=True)
1888
except dbus.exceptions.NameExistsException as e:
1889
logger.error(unicode(e) + ", disabling D-Bus")
1890
use_dbus = False
1891
server_settings["use_dbus"] = False
1892
tcp_server.use_dbus = False
1339
1893
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1340
service = AvahiService(name = server_settings[u"servicename"],
1341
servicetype = u"_mandos._tcp",
1894
service = AvahiService(name = server_settings["servicename"],
1895
servicetype = "_mandos._tcp",
1342
1896
protocol = protocol, bus = bus)
1343
1897
if server_settings["interface"]:
1344
1898
service.interface = (if_nametoindex
1345
(str(server_settings[u"interface"])))
1899
(str(server_settings["interface"])))
1900
1901
global multiprocessing_manager
1902
multiprocessing_manager = multiprocessing.Manager()
1346
1903
1347
1904
client_class = Client
1348
1905
if use_dbus:
1349
1906
client_class = functools.partial(ClientDBus, bus = bus)
1907
def client_config_items(config, section):
1908
special_settings = {
1909
"approved_by_default":
1910
lambda: config.getboolean(section,
1911
"approved_by_default"),
1912
}
1913
for name, value in config.items(section):
1914
try:
1915
yield (name, special_settings[name]())
1916
except KeyError:
1917
yield (name, value)
1918
1350
1919
tcp_server.clients.update(set(
1351
1920
client_class(name = section,
1352
config= dict(client_config.items(section)))
1921
config= dict(client_config_items(
1922
client_config, section)))
1353
1923
for section in client_config.sections()))
1354
1924
if not tcp_server.clients:
1355
logger.warning(u"No clients defined")
1356
1357
if debug:
1358
# Redirect stdin so all checkers get /dev/null
1359
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1360
os.dup2(null, sys.stdin.fileno())
1361
if null > 2:
1362
os.close(null)
1363
else:
1364
# No console logging
1365
logger.removeHandler(console)
1366
# Close all input and output, do double fork, etc.
1367
daemon()
1368
1369
try:
1370
with closing(pidfile):
1371
pid = os.getpid()
1372
pidfile.write(str(pid) + "\n")
1373
del pidfile
1374
except IOError:
1375
logger.error(u"Could not write to file %r with PID %d",
1376
pidfilename, pid)
1377
except NameError:
1378
# "pidfile" was never created
1379
pass
1380
del pidfilename
1381
1382
def cleanup():
1383
"Cleanup function; run on exit"
1384
service.cleanup()
1925
logger.warning("No clients defined")
1385
1926
1386
while tcp_server.clients:
1387
client = tcp_server.clients.pop()
1388
client.disable_hook = None
1389
client.disable()
1390
1391
atexit.register(cleanup)
1392
1393
1927
if not debug:
1928
try:
1929
with pidfile:
1930
pid = os.getpid()
1931
pidfile.write(str(pid) + "\n".encode("utf-8"))
1932
del pidfile
1933
except IOError:
1934
logger.error("Could not write to file %r with PID %d",
1935
pidfilename, pid)
1936
except NameError:
1937
# "pidfile" was never created
1938
pass
1939
del pidfilename
1940
1394
1941
signal.signal(signal.SIGINT, signal.SIG_IGN)
1942
1395
1943
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1396
1944
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1397
1945
1399
1947
class MandosDBusService(dbus.service.Object):
1400
1948
"""A D-Bus proxy object"""
1401
1949
def __init__(self):
1402
dbus.service.Object.__init__(self, bus, u"/")
1403
_interface = u"se.bsnet.fukt.Mandos"
1404
1405
@dbus.service.signal(_interface, signature=u"oa{sv}")
1406
def ClientAdded(self, objpath, properties):
1407
"D-Bus signal"
1408
pass
1409
1410
@dbus.service.signal(_interface, signature=u"s")
1411
def ClientNotFound(self, fingerprint):
1412
"D-Bus signal"
1413
pass
1414
1415
@dbus.service.signal(_interface, signature=u"os")
1950
dbus.service.Object.__init__(self, bus, "/")
1951
_interface = "se.bsnet.fukt.Mandos"
1952
1953
@dbus.service.signal(_interface, signature="o")
1954
def ClientAdded(self, objpath):
1955
"D-Bus signal"
1956
pass
1957
1958
@dbus.service.signal(_interface, signature="ss")
1959
def ClientNotFound(self, fingerprint, address):
1960
"D-Bus signal"
1961
pass
1962
1963
@dbus.service.signal(_interface, signature="os")
1416
1964
def ClientRemoved(self, objpath, name):
1417
1965
"D-Bus signal"
1418
1966
pass
1419
1967
1420
@dbus.service.method(_interface, out_signature=u"ao")
1968
@dbus.service.method(_interface, out_signature="ao")
1421
1969
def GetAllClients(self):
1422
1970
"D-Bus method"
1423
1971
return dbus.Array(c.dbus_object_path
1424
1972
for c in tcp_server.clients)
1425
1973
1426
1974
@dbus.service.method(_interface,
1427
out_signature=u"a{oa{sv}}")
1975
out_signature="a{oa{sv}}")
1428
1976
def GetAllClientsWithProperties(self):
1429
1977
"D-Bus method"
1430
1978
return dbus.Dictionary(
1431
((c.dbus_object_path, c.GetAllProperties())
1979
((c.dbus_object_path, c.GetAll(""))
1432
1980
for c in tcp_server.clients),
1433
signature=u"oa{sv}")
1981
signature="oa{sv}")
1434
1982
1435
@dbus.service.method(_interface, in_signature=u"o")
1983
@dbus.service.method(_interface, in_signature="o")
1436
1984
def RemoveClient(self, object_path):
1437
1985
"D-Bus method"
1438
1986
for c in tcp_server.clients:
1440
1988
tcp_server.clients.remove(c)
1441
1989
c.remove_from_connection()
1442
1990
# Don't signal anything except ClientRemoved
1443
c.disable(signal=False)
1991
c.disable(quiet=True)
1444
1992
# Emit D-Bus signal
1445
1993
self.ClientRemoved(object_path, c.name)
1446
1994
return
1447
raise KeyError
1995
raise KeyError(object_path)
1448
1996
1449
1997
del _interface
1450
1998
1451
1999
mandos_dbus_service = MandosDBusService()
1452
2000
2001
def cleanup():
2002
"Cleanup function; run on exit"
2003
service.cleanup()
2004
2005
while tcp_server.clients:
2006
client = tcp_server.clients.pop()
2007
if use_dbus:
2008
client.remove_from_connection()
2009
client.disable_hook = None
2010
# Don't signal anything except ClientRemoved
2011
client.disable(quiet=True)
2012
if use_dbus:
2013
# Emit D-Bus signal
2014
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2015
client.name)
2016
2017
atexit.register(cleanup)
2018
1453
2019
for client in tcp_server.clients:
1454
2020
if use_dbus:
1455
2021
# Emit D-Bus signal
1456
mandos_dbus_service.ClientAdded(client.dbus_object_path,
1457
client.GetAllProperties())
2022
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1458
2023
client.enable()
1459
2024
1460
2025
tcp_server.enable()
1463
2028
# Find out what port we got
1464
2029
service.port = tcp_server.socket.getsockname()[1]
1465
2030
if use_ipv6:
1466
logger.info(u"Now listening on address %r, port %d,"
2031
logger.info("Now listening on address %r, port %d,"
1467
2032
" flowinfo %d, scope_id %d"
1468
2033
% tcp_server.socket.getsockname())
1469
2034
else: # IPv4
1470
logger.info(u"Now listening on address %r, port %d"
2035
logger.info("Now listening on address %r, port %d"
1471
2036
% tcp_server.socket.getsockname())
1472
2037
1473
2038
#service.interface = tcp_server.socket.getsockname()[3]
1476
2041
# From the Avahi example code
1477
2042
try:
1478
2043
service.activate()
1479
except dbus.exceptions.DBusException, error:
1480
logger.critical(u"DBusException: %s", error)
2044
except dbus.exceptions.DBusException as error:
2045
logger.critical("DBusException: %s", error)
2046
cleanup()
1481
2047
sys.exit(1)
1482
2048
# End of Avahi example code
1483
2049
1486
2052
(tcp_server.handle_request
1487
2053
(*args[2:], **kwargs) or True))
1488
2054
1489
logger.debug(u"Starting main loop")
2055
logger.debug("Starting main loop")
1490
2056
main_loop.run()
1491
except AvahiError, error:
1492
logger.critical(u"AvahiError: %s", error)
2057
except AvahiError as error:
2058
logger.critical("AvahiError: %s", error)
2059
cleanup()
1493
2060
sys.exit(1)
1494
2061
except KeyboardInterrupt:
1495
2062
if debug:
1496
print >> sys.stderr
1497
logger.debug(u"Server received KeyboardInterrupt")
1498
logger.debug(u"Server exiting")
2063
print("", file=sys.stderr)
2064
logger.debug("Server received KeyboardInterrupt")
2065
logger.debug("Server exiting")
2066
# Must run before the D-Bus bus name gets deregistered
2067
cleanup()
1499
2068
1500
2069
if __name__ == '__main__':
1501
2070
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0