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