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