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 502
- compare with another revision
- download diff
- download tarball
- view history from revision 502
- Committer: Teddy Hogeborn
- Date: 2011-09-26 19:36:18 UTC
- mfrom: (24.1.184 mandos)
- Revision ID: teddy@fukt.bsnet.se-20110926193618-vtj5c9hena1maixx
Merge from Björn
- 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.10"
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
226
266
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
227
273
class Client(object):
228
274
"""A representation of a client host served by this server.
229
275
230
276
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)
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
245
280
checker: subprocess.Popen(); a running checker process used
246
281
to see if the client lives.
247
282
'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
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
253
286
runtime with vars(self) as dict, so that for
254
287
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
255
290
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
256
310
"""
257
311
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
312
runtime_expansions = ("approval_delay", "approval_duration",
313
"created", "enabled", "fingerprint",
314
"host", "interval", "last_checked_ok",
315
"last_enabled", "name", "timeout")
316
265
317
def timeout_milliseconds(self):
266
318
"Return the 'timeout' attribute in milliseconds"
267
return self._datetime_to_milliseconds(self.timeout)
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)
268
324
269
325
def interval_milliseconds(self):
270
326
"Return the 'interval' attribute in milliseconds"
271
return self._datetime_to_milliseconds(self.interval)
327
return _timedelta_to_milliseconds(self.interval)
328
329
def approval_delay_milliseconds(self):
330
return _timedelta_to_milliseconds(self.approval_delay)
272
331
273
332
def __init__(self, name = None, disable_hook=None, config=None):
274
333
"""Note: the 'checker' key in 'config' sets the
277
336
self.name = name
278
337
if config is None:
279
338
config = {}
280
logger.debug(u"Creating client %r", self.name)
339
logger.debug("Creating client %r", self.name)
281
340
# Uppercase and remove spaces from fingerprint for later
282
341
# comparison purposes with return value from the fingerprint()
283
342
# 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:
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:
293
352
self.secret = secfile.read()
294
353
else:
295
raise TypeError(u"No secret or secfile for client %s"
354
raise TypeError("No secret or secfile for client %s"
296
355
% self.name)
297
self.host = config.get(u"host", u"")
356
self.host = config.get("host", "")
298
357
self.created = datetime.datetime.utcnow()
299
358
self.enabled = False
359
self.last_approval_request = None
300
360
self.last_enabled = None
301
361
self.last_checked_ok = None
302
self.timeout = string_to_delta(config[u"timeout"])
303
self.interval = string_to_delta(config[u"interval"])
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"])
304
365
self.disable_hook = disable_hook
305
366
self.checker = None
306
367
self.checker_initiator_tag = None
307
368
self.disable_initiator_tag = None
369
self.expires = None
308
370
self.checker_callback_tag = None
309
self.checker_command = config[u"checker"]
371
self.checker_command = config["checker"]
310
372
self.current_checker_command = None
311
373
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())
312
383
384
def send_changedstate(self):
385
self.changedstate.acquire()
386
self.changedstate.notify_all()
387
self.changedstate.release()
388
313
389
def enable(self):
314
390
"""Start this client's checker and timeout hooks"""
315
if getattr(self, u"enabled", False):
391
if getattr(self, "enabled", False):
316
392
# Already enabled
317
393
return
318
self.last_enabled = datetime.datetime.utcnow()
394
self.send_changedstate()
319
395
# Schedule a new checker to be started an 'interval' from now,
320
396
# and every interval from then on.
321
397
self.checker_initiator_tag = (gobject.timeout_add
322
398
(self.interval_milliseconds(),
323
399
self.start_checker))
324
# Also start a new checker *right now*.
325
self.start_checker()
326
400
# Schedule a disable() when 'timeout' has passed
401
self.expires = datetime.datetime.utcnow() + self.timeout
327
402
self.disable_initiator_tag = (gobject.timeout_add
328
403
(self.timeout_milliseconds(),
329
404
self.disable))
330
405
self.enabled = True
406
self.last_enabled = datetime.datetime.utcnow()
407
# Also start a new checker *right now*.
408
self.start_checker()
331
409
332
def disable(self):
410
def disable(self, quiet=True):
333
411
"""Disable this client."""
334
412
if not getattr(self, "enabled", False):
335
413
return False
336
logger.info(u"Disabling client %s", self.name)
337
if getattr(self, u"disable_initiator_tag", 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):
338
419
gobject.source_remove(self.disable_initiator_tag)
339
420
self.disable_initiator_tag = None
340
if getattr(self, u"checker_initiator_tag", False):
421
self.expires = None
422
if getattr(self, "checker_initiator_tag", False):
341
423
gobject.source_remove(self.checker_initiator_tag)
342
424
self.checker_initiator_tag = None
343
425
self.stop_checker()
358
440
if os.WIFEXITED(condition):
359
441
exitstatus = os.WEXITSTATUS(condition)
360
442
if exitstatus == 0:
361
logger.info(u"Checker for %(name)s succeeded",
443
logger.info("Checker for %(name)s succeeded",
362
444
vars(self))
363
445
self.checked_ok()
364
446
else:
365
logger.info(u"Checker for %(name)s failed",
447
logger.info("Checker for %(name)s failed",
366
448
vars(self))
367
449
else:
368
logger.warning(u"Checker for %(name)s crashed?",
450
logger.warning("Checker for %(name)s crashed?",
369
451
vars(self))
370
452
371
def checked_ok(self):
453
def checked_ok(self, timeout=None):
372
454
"""Bump up the timeout for this client.
373
455
374
456
This should only be called when the client has been seen,
375
457
alive and well.
376
458
"""
459
if timeout is None:
460
timeout = self.timeout
377
461
self.last_checked_ok = datetime.datetime.utcnow()
378
462
gobject.source_remove(self.disable_initiator_tag)
463
self.expires = datetime.datetime.utcnow() + timeout
379
464
self.disable_initiator_tag = (gobject.timeout_add
380
(self.timeout_milliseconds(),
465
(_timedelta_to_milliseconds(timeout),
381
466
self.disable))
382
467
468
def need_approval(self):
469
self.last_approval_request = datetime.datetime.utcnow()
470
383
471
def start_checker(self):
384
472
"""Start a new checker subprocess if one is not running.
385
473
391
479
# client would inevitably timeout, since no checker would get
392
480
# a chance to run to completion. If we instead leave running
393
481
# 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.
482
# than 'timeout' for the client to be disabled, which is as it
483
# should be.
396
484
397
485
# If a checker exists, make sure it is not a zombie
398
if self.checker is not None:
486
try:
399
487
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:
400
493
if pid:
401
logger.warning(u"Checker was a zombie")
494
logger.warning("Checker was a zombie")
402
495
gobject.source_remove(self.checker_callback_tag)
403
496
self.checker_callback(pid, status,
404
497
self.current_checker_command)
409
502
command = self.checker_command % self.host
410
503
except TypeError:
411
504
# 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())
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
418
513
try:
419
514
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)
515
except TypeError as error:
516
logger.error('Could not format string "%s":'
517
' %s', self.checker_command, error)
423
518
return True # Try again later
424
519
self.current_checker_command = command
425
520
try:
426
logger.info(u"Starting checker %r for %s",
521
logger.info("Starting checker %r for %s",
427
522
command, self.name)
428
523
# We don't need to redirect stdout and stderr, since
429
524
# in normal mode, that is already done by daemon(),
431
526
# always replaced by /dev/null.)
432
527
self.checker = subprocess.Popen(command,
433
528
close_fds=True,
434
shell=True, cwd=u"/")
529
shell=True, cwd="/")
435
530
self.checker_callback_tag = (gobject.child_watch_add
436
531
(self.checker.pid,
437
532
self.checker_callback,
442
537
if pid:
443
538
gobject.source_remove(self.checker_callback_tag)
444
539
self.checker_callback(pid, status, command)
445
except OSError, error:
446
logger.error(u"Failed to start subprocess: %s",
540
except OSError as error:
541
logger.error("Failed to start subprocess: %s",
447
542
error)
448
543
# Re-run this periodically if run by gobject.timeout_add
449
544
return True
453
548
if self.checker_callback_tag:
454
549
gobject.source_remove(self.checker_callback_tag)
455
550
self.checker_callback_tag = None
456
if getattr(self, u"checker", None) is None:
551
if getattr(self, "checker", None) is None:
457
552
return
458
logger.debug(u"Stopping checker for %(name)s", vars(self))
553
logger.debug("Stopping checker for %(name)s", vars(self))
459
554
try:
460
555
os.kill(self.checker.pid, signal.SIGTERM)
461
#os.sleep(0.5)
556
#time.sleep(0.5)
462
557
#if self.checker.poll() is None:
463
558
# os.kill(self.checker.pid, signal.SIGKILL)
464
except OSError, error:
559
except OSError as error:
465
560
if error.errno != errno.ESRCH: # No such process
466
561
raise
467
562
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):
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):
481
761
"""A Client class using D-Bus
482
762
483
763
Attributes:
484
764
dbus_object_path: dbus.ObjectPath
485
765
bus: dbus.SystemBus()
486
766
"""
767
768
runtime_expansions = (Client.runtime_expansions
769
+ ("dbus_object_path",))
770
487
771
# dbus.service.Object doesn't use super(), so we can't either.
488
772
489
773
def __init__(self, bus = None, *args, **kwargs):
774
self._approvals_pending = 0
490
775
self.bus = bus
491
776
Client.__init__(self, *args, **kwargs)
492
777
# Only now, when this client is initialized, can it show up on
493
778
# the D-Bus
779
client_object_name = unicode(self.name).translate(
780
{ord("."): ord("_"),
781
ord("-"): ord("_")})
494
782
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)
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
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
527
842
528
843
def __del__(self, *args, **kwargs):
529
844
try:
530
845
self.remove_from_connection()
531
846
except LookupError:
532
847
pass
533
if hasattr(dbus.service.Object, u"__del__"):
534
dbus.service.Object.__del__(self, *args, **kwargs)
848
if hasattr(DBusObjectWithProperties, "__del__"):
849
DBusObjectWithProperties.__del__(self, *args, **kwargs)
535
850
Client.__del__(self, *args, **kwargs)
536
851
537
852
def checker_callback(self, pid, condition, command,
538
853
*args, **kwargs):
539
854
self.checker_callback_tag = None
540
855
self.checker = None
541
# Emit D-Bus signal
542
self.PropertyChanged(dbus.String(u"checker_running"),
543
dbus.Boolean(False, variant_level=1))
544
856
if os.WIFEXITED(condition):
545
857
exitstatus = os.WEXITSTATUS(condition)
546
858
# Emit D-Bus signal
555
867
556
868
return Client.checker_callback(self, pid, condition, command,
557
869
*args, **kwargs)
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
870
568
871
def start_checker(self, *args, **kwargs):
569
872
old_checker = self.checker
570
873
if self.checker is not None:
577
880
and old_checker_pid != self.checker.pid):
578
881
# Emit D-Bus signal
579
882
self.CheckerStarted(self.current_checker_command)
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()
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
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
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
747
1147
del _interface
748
1148
749
1149
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
750
1176
class ClientHandler(socketserver.BaseRequestHandler, object):
751
1177
"""A class to handle client connections.
752
1178
754
1180
Note: This will run in its own forked process."""
755
1181
756
1182
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:
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
762
1189
session = (gnutls.connection
763
1190
.ClientSession(self.request,
764
1191
gnutls.connection
765
1192
.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
1193
776
1194
# Note: gnutls.connection.X509Credentials is really a
777
1195
# generic GnuTLS certificate credentials object so long as
778
1196
# no X.509 keys are added to it. Therefore, we can use it
779
1197
# 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"))
1198
1199
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1200
# "+AES-256-CBC", "+SHA1",
1201
# "+COMP-NULL", "+CTYPE-OPENPGP",
1202
# "+DHE-DSS"))
785
1203
# Use a fallback default, since this MUST be set.
786
1204
priority = self.server.gnutls_priority
787
1205
if priority is None:
788
priority = u"NORMAL"
1206
priority = "NORMAL"
789
1207
(gnutls.library.functions
790
1208
.gnutls_priority_set_direct(session._c_object,
791
1209
priority, None))
792
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
793
1223
try:
794
1224
session.handshake()
795
except gnutls.errors.GNUTLSError, error:
796
logger.warning(u"Handshake failed: %s", error)
1225
except gnutls.errors.GNUTLSError as error:
1226
logger.warning("Handshake failed: %s", error)
797
1227
# Do not run session.bye() here: the session is not
798
1228
# established. Just abandon the request.
799
1229
return
800
logger.debug(u"Handshake succeeded")
1230
logger.debug("Handshake succeeded")
1231
1232
approval_required = False
801
1233
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)
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()
808
1321
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()
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")
833
1329
834
1330
@staticmethod
835
1331
def peer_certificate(session):
845
1341
.gnutls_certificate_get_peers
846
1342
(session._c_object, ctypes.byref(list_size)))
847
1343
if not bool(cert_list) and list_size.value != 0:
848
raise gnutls.errors.GNUTLSError(u"error getting peer"
849
u" certificate")
1344
raise gnutls.errors.GNUTLSError("error getting peer"
1345
" certificate")
850
1346
if list_size.value == 0:
851
1347
return None
852
1348
cert = cert_list[0]
878
1374
if crtverify.value != 0:
879
1375
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
880
1376
raise (gnutls.errors.CertificateSecurityError
881
(u"Verify failed"))
1377
("Verify failed"))
882
1378
# New buffer for the fingerprint
883
1379
buf = ctypes.create_string_buffer(20)
884
1380
buf_len = ctypes.c_size_t()
891
1387
# Convert the buffer to a Python bytestring
892
1388
fpr = ctypes.string_at(buf, buf_len.value)
893
1389
# Convert the bytestring to hexadecimal notation
894
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1390
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
895
1391
return hex_fpr
896
1392
897
1393
898
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
899
"""Like socketserver.ForkingMixIn, but also pass a pipe."""
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 """
900
1410
def process_request(self, request, client_address):
901
1411
"""Overrides and wraps the original process_request().
902
1412
903
This function creates a new pipe in self.pipe
1413
This function creates a new pipe in self.pipe
904
1414
"""
905
self.pipe = os.pipe()
906
super(ForkingMixInWithPipe,
1415
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1416
1417
super(MultiprocessingMixInWithPipe,
907
1418
self).process_request(request, client_address)
908
os.close(self.pipe[1]) # close write end
909
self.add_pipe(self.pipe[0])
910
def add_pipe(self, pipe):
1419
self.child_pipe.close()
1420
self.add_pipe(parent_pipe)
1421
1422
def add_pipe(self, parent_pipe):
911
1423
"""Dummy function; override as necessary"""
912
os.close(pipe)
913
914
915
class IPv6_TCPServer(ForkingMixInWithPipe,
1424
raise NotImplementedError
1425
1426
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
916
1427
socketserver.TCPServer, object):
917
1428
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
918
1429
934
1445
bind to an address or port if they were not specified."""
935
1446
if self.interface is not None:
936
1447
if SO_BINDTODEVICE is None:
937
logger.error(u"SO_BINDTODEVICE does not exist;"
938
u" cannot bind to interface %s",
1448
logger.error("SO_BINDTODEVICE does not exist;"
1449
" cannot bind to interface %s",
939
1450
self.interface)
940
1451
else:
941
1452
try:
942
1453
self.socket.setsockopt(socket.SOL_SOCKET,
943
1454
SO_BINDTODEVICE,
944
1455
str(self.interface
945
+ u'\0'))
946
except socket.error, error:
1456
+ '\0'))
1457
except socket.error as error:
947
1458
if error[0] == errno.EPERM:
948
logger.error(u"No permission to"
949
u" bind to interface %s",
1459
logger.error("No permission to"
1460
" bind to interface %s",
950
1461
self.interface)
951
1462
elif error[0] == errno.ENOPROTOOPT:
952
logger.error(u"SO_BINDTODEVICE not available;"
953
u" cannot bind to interface %s",
1463
logger.error("SO_BINDTODEVICE not available;"
1464
" cannot bind to interface %s",
954
1465
self.interface)
955
1466
else:
956
1467
raise
958
1469
if self.server_address[0] or self.server_address[1]:
959
1470
if not self.server_address[0]:
960
1471
if self.address_family == socket.AF_INET6:
961
any_address = u"::" # in6addr_any
1472
any_address = "::" # in6addr_any
962
1473
else:
963
1474
any_address = socket.INADDR_ANY
964
1475
self.server_address = (any_address,
982
1493
clients: set of Client objects
983
1494
gnutls_priority GnuTLS priority string
984
1495
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
988
1496
989
1497
Assumes a gobject.MainLoop event loop.
990
1498
"""
1006
1514
return socketserver.TCPServer.server_activate(self)
1007
1515
def enable(self):
1008
1516
self.enabled = True
1009
def add_pipe(self, pipe):
1517
def add_pipe(self, parent_pipe):
1010
1518
# Call "handle_ipc" for both data and EOF events
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={}):
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):
1014
1526
condition_names = {
1015
gobject.IO_IN: u"IN", # There is data to read.
1016
gobject.IO_OUT: u"OUT", # Data can be written (without
1527
gobject.IO_IN: "IN", # There is data to read.
1528
gobject.IO_OUT: "OUT", # Data can be written (without
1017
1529
# blocking).
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
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
1021
1533
# broken, usually for pipes and
1022
1534
# sockets).
1023
1535
}
1025
1537
for cond, name in
1026
1538
condition_names.iteritems()
1027
1539
if cond & condition)
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
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
1082
1592
return True
1083
1593
1084
1594
1085
1595
def string_to_delta(interval):
1086
1596
"""Parse a string and return a datetime.timedelta
1087
1597
1088
>>> string_to_delta(u'7d')
1598
>>> string_to_delta('7d')
1089
1599
datetime.timedelta(7)
1090
>>> string_to_delta(u'60s')
1600
>>> string_to_delta('60s')
1091
1601
datetime.timedelta(0, 60)
1092
>>> string_to_delta(u'60m')
1602
>>> string_to_delta('60m')
1093
1603
datetime.timedelta(0, 3600)
1094
>>> string_to_delta(u'24h')
1604
>>> string_to_delta('24h')
1095
1605
datetime.timedelta(1)
1096
>>> string_to_delta(u'1w')
1606
>>> string_to_delta('1w')
1097
1607
datetime.timedelta(7)
1098
>>> string_to_delta(u'5m 30s')
1608
>>> string_to_delta('5m 30s')
1099
1609
datetime.timedelta(0, 330)
1100
1610
"""
1101
1611
timevalue = datetime.timedelta(0)
1103
1613
try:
1104
1614
suffix = unicode(s[-1])
1105
1615
value = int(s[:-1])
1106
if suffix == u"d":
1616
if suffix == "d":
1107
1617
delta = datetime.timedelta(value)
1108
elif suffix == u"s":
1618
elif suffix == "s":
1109
1619
delta = datetime.timedelta(0, value)
1110
elif suffix == u"m":
1620
elif suffix == "m":
1111
1621
delta = datetime.timedelta(0, 0, 0, 0, value)
1112
elif suffix == u"h":
1622
elif suffix == "h":
1113
1623
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1114
elif suffix == u"w":
1624
elif suffix == "w":
1115
1625
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1116
1626
else:
1117
raise ValueError
1118
except (ValueError, IndexError):
1119
raise ValueError
1627
raise ValueError("Unknown suffix %r" % suffix)
1628
except (ValueError, IndexError) as e:
1629
raise ValueError(*(e.args))
1120
1630
timevalue += delta
1121
1631
return timevalue
1122
1632
1128
1638
global if_nametoindex
1129
1639
try:
1130
1640
if_nametoindex = (ctypes.cdll.LoadLibrary
1131
(ctypes.util.find_library(u"c"))
1641
(ctypes.util.find_library("c"))
1132
1642
.if_nametoindex)
1133
1643
except (OSError, AttributeError):
1134
logger.warning(u"Doing if_nametoindex the hard way")
1644
logger.warning("Doing if_nametoindex the hard way")
1135
1645
def if_nametoindex(interface):
1136
1646
"Get an interface index the hard way, i.e. using fcntl()"
1137
1647
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1138
with closing(socket.socket()) as s:
1648
with contextlib.closing(socket.socket()) as s:
1139
1649
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1140
struct.pack(str(u"16s16x"),
1650
struct.pack(str("16s16x"),
1141
1651
interface))
1142
interface_index = struct.unpack(str(u"I"),
1652
interface_index = struct.unpack(str("I"),
1143
1653
ifreq[16:20])[0]
1144
1654
return interface_index
1145
1655
return if_nametoindex(interface)
1153
1663
sys.exit()
1154
1664
os.setsid()
1155
1665
if not nochdir:
1156
os.chdir(u"/")
1666
os.chdir("/")
1157
1667
if os.fork():
1158
1668
sys.exit()
1159
1669
if not noclose:
1161
1671
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1162
1672
if not stat.S_ISCHR(os.fstat(null).st_mode):
1163
1673
raise OSError(errno.ENODEV,
1164
u"/dev/null not a character device")
1674
"%s not a character device"
1675
% os.path.devnull)
1165
1676
os.dup2(null, sys.stdin.fileno())
1166
1677
os.dup2(null, sys.stdout.fileno())
1167
1678
os.dup2(null, sys.stderr.fileno())
1171
1682
1172
1683
def main():
1173
1684
1174
######################################################################
1685
##################################################################
1175
1686
# Parsing of options, both command line and config file
1176
1687
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]
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()
1203
1719
1204
1720
if options.check:
1205
1721
import doctest
1207
1723
sys.exit()
1208
1724
1209
1725
# Default values for config file for server-global settings
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",
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": "",
1219
1736
}
1220
1737
1221
1738
# Parse config file for server-global settings
1222
1739
server_config = configparser.SafeConfigParser(server_defaults)
1223
1740
del server_defaults
1224
1741
server_config.read(os.path.join(options.configdir,
1225
u"mandos.conf"))
1742
"mandos.conf"))
1226
1743
# Convert the SafeConfigParser object to a dict
1227
1744
server_settings = server_config.defaults()
1228
1745
# Use the appropriate methods on the non-string config options
1229
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1230
server_settings[option] = server_config.getboolean(u"DEFAULT",
1746
for option in ("debug", "use_dbus", "use_ipv6"):
1747
server_settings[option] = server_config.getboolean("DEFAULT",
1231
1748
option)
1232
1749
if server_settings["port"]:
1233
server_settings["port"] = server_config.getint(u"DEFAULT",
1234
u"port")
1750
server_settings["port"] = server_config.getint("DEFAULT",
1751
"port")
1235
1752
del server_config
1236
1753
1237
1754
# Override the settings from the config file with command line
1238
1755
# options, if set.
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"):
1756
for option in ("interface", "address", "port", "debug",
1757
"priority", "servicename", "configdir",
1758
"use_dbus", "use_ipv6", "debuglevel"):
1242
1759
value = getattr(options, option)
1243
1760
if value is not None:
1244
1761
server_settings[option] = value
1252
1769
##################################################################
1253
1770
1254
1771
# For convenience
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":
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":
1264
1778
syslogger.setFormatter(logging.Formatter
1265
(u'Mandos (%s) [%%(process)d]:'
1266
u' %%(levelname)s: %%(message)s'
1267
% server_settings[u"servicename"]))
1779
('Mandos (%s) [%%(process)d]:'
1780
' %%(levelname)s: %%(message)s'
1781
% server_settings["servicename"]))
1268
1782
1269
1783
# Parse config file with clients
1270
client_defaults = { u"timeout": u"1h",
1271
u"interval": u"5m",
1272
u"checker": u"fping -q -- %%(host)s",
1273
u"host": u"",
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",
1274
1791
}
1275
1792
client_config = configparser.SafeConfigParser(client_defaults)
1276
client_config.read(os.path.join(server_settings[u"configdir"],
1277
u"clients.conf"))
1793
client_config.read(os.path.join(server_settings["configdir"],
1794
"clients.conf"))
1278
1795
1279
1796
global mandos_dbus_service
1280
1797
mandos_dbus_service = None
1281
1798
1282
tcp_server = MandosServer((server_settings[u"address"],
1283
server_settings[u"port"]),
1799
tcp_server = MandosServer((server_settings["address"],
1800
server_settings["port"]),
1284
1801
ClientHandler,
1285
interface=server_settings[u"interface"],
1802
interface=(server_settings["interface"]
1803
or None),
1286
1804
use_ipv6=use_ipv6,
1287
1805
gnutls_priority=
1288
server_settings[u"priority"],
1806
server_settings["priority"],
1289
1807
use_dbus=use_dbus)
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)
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)
1295
1814
1296
1815
try:
1297
uid = pwd.getpwnam(u"_mandos").pw_uid
1298
gid = pwd.getpwnam(u"_mandos").pw_gid
1816
uid = pwd.getpwnam("_mandos").pw_uid
1817
gid = pwd.getpwnam("_mandos").pw_gid
1299
1818
except KeyError:
1300
1819
try:
1301
uid = pwd.getpwnam(u"mandos").pw_uid
1302
gid = pwd.getpwnam(u"mandos").pw_gid
1820
uid = pwd.getpwnam("mandos").pw_uid
1821
gid = pwd.getpwnam("mandos").pw_gid
1303
1822
except KeyError:
1304
1823
try:
1305
uid = pwd.getpwnam(u"nobody").pw_uid
1306
gid = pwd.getpwnam(u"nobody").pw_gid
1824
uid = pwd.getpwnam("nobody").pw_uid
1825
gid = pwd.getpwnam("nobody").pw_gid
1307
1826
except KeyError:
1308
1827
uid = 65534
1309
1828
gid = 65534
1310
1829
try:
1311
1830
os.setgid(gid)
1312
1831
os.setuid(uid)
1313
except OSError, error:
1832
except OSError as error:
1314
1833
if error[0] != errno.EPERM:
1315
1834
raise error
1316
1835
1317
# Enable all possible GnuTLS debugging
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
1318
1844
if debug:
1845
# Enable all possible GnuTLS debugging
1846
1319
1847
# "Use a log level over 10 to enable all debugging options."
1320
1848
# - GnuTLS manual
1321
1849
gnutls.library.functions.gnutls_global_set_log_level(11)
1322
1850
1323
1851
@gnutls.library.types.gnutls_log_func
1324
1852
def debug_gnutls(level, string):
1325
logger.debug(u"GnuTLS: %s", string[:-1])
1853
logger.debug("GnuTLS: %s", string[:-1])
1326
1854
1327
1855
(gnutls.library.functions
1328
1856
.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()
1329
1871
1330
1872
global main_loop
1331
1873
# From the Avahi example code
1334
1876
bus = dbus.SystemBus()
1335
1877
# End of Avahi example code
1336
1878
if use_dbus:
1337
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
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
1338
1887
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1339
service = AvahiService(name = server_settings[u"servicename"],
1340
servicetype = u"_mandos._tcp",
1888
service = AvahiService(name = server_settings["servicename"],
1889
servicetype = "_mandos._tcp",
1341
1890
protocol = protocol, bus = bus)
1342
1891
if server_settings["interface"]:
1343
1892
service.interface = (if_nametoindex
1344
(str(server_settings[u"interface"])))
1893
(str(server_settings["interface"])))
1894
1895
global multiprocessing_manager
1896
multiprocessing_manager = multiprocessing.Manager()
1345
1897
1346
1898
client_class = Client
1347
1899
if use_dbus:
1348
1900
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
1349
1913
tcp_server.clients.update(set(
1350
1914
client_class(name = section,
1351
config= dict(client_config.items(section)))
1915
config= dict(client_config_items(
1916
client_config, section)))
1352
1917
for section in client_config.sections()))
1353
1918
if not tcp_server.clients:
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()
1919
logger.warning("No clients defined")
1384
1920
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
1392
1921
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
1393
1935
signal.signal(signal.SIGINT, signal.SIG_IGN)
1936
1394
1937
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1395
1938
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1396
1939
1398
1941
class MandosDBusService(dbus.service.Object):
1399
1942
"""A D-Bus proxy object"""
1400
1943
def __init__(self):
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")
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")
1415
1958
def ClientRemoved(self, objpath, name):
1416
1959
"D-Bus signal"
1417
1960
pass
1418
1961
1419
@dbus.service.method(_interface, out_signature=u"ao")
1962
@dbus.service.method(_interface, out_signature="ao")
1420
1963
def GetAllClients(self):
1421
1964
"D-Bus method"
1422
1965
return dbus.Array(c.dbus_object_path
1423
1966
for c in tcp_server.clients)
1424
1967
1425
1968
@dbus.service.method(_interface,
1426
out_signature=u"a{oa{sv}}")
1969
out_signature="a{oa{sv}}")
1427
1970
def GetAllClientsWithProperties(self):
1428
1971
"D-Bus method"
1429
1972
return dbus.Dictionary(
1430
((c.dbus_object_path, c.GetAllProperties())
1973
((c.dbus_object_path, c.GetAll(""))
1431
1974
for c in tcp_server.clients),
1432
signature=u"oa{sv}")
1975
signature="oa{sv}")
1433
1976
1434
@dbus.service.method(_interface, in_signature=u"o")
1977
@dbus.service.method(_interface, in_signature="o")
1435
1978
def RemoveClient(self, object_path):
1436
1979
"D-Bus method"
1437
1980
for c in tcp_server.clients:
1439
1982
tcp_server.clients.remove(c)
1440
1983
c.remove_from_connection()
1441
1984
# Don't signal anything except ClientRemoved
1442
c.disable(signal=False)
1985
c.disable(quiet=True)
1443
1986
# Emit D-Bus signal
1444
1987
self.ClientRemoved(object_path, c.name)
1445
1988
return
1446
raise KeyError
1989
raise KeyError(object_path)
1447
1990
1448
1991
del _interface
1449
1992
1450
1993
mandos_dbus_service = MandosDBusService()
1451
1994
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
1452
2013
for client in tcp_server.clients:
1453
2014
if use_dbus:
1454
2015
# Emit D-Bus signal
1455
mandos_dbus_service.ClientAdded(client.dbus_object_path,
1456
client.GetAllProperties())
2016
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1457
2017
client.enable()
1458
2018
1459
2019
tcp_server.enable()
1462
2022
# Find out what port we got
1463
2023
service.port = tcp_server.socket.getsockname()[1]
1464
2024
if use_ipv6:
1465
logger.info(u"Now listening on address %r, port %d,"
2025
logger.info("Now listening on address %r, port %d,"
1466
2026
" flowinfo %d, scope_id %d"
1467
2027
% tcp_server.socket.getsockname())
1468
2028
else: # IPv4
1469
logger.info(u"Now listening on address %r, port %d"
2029
logger.info("Now listening on address %r, port %d"
1470
2030
% tcp_server.socket.getsockname())
1471
2031
1472
2032
#service.interface = tcp_server.socket.getsockname()[3]
1475
2035
# From the Avahi example code
1476
2036
try:
1477
2037
service.activate()
1478
except dbus.exceptions.DBusException, error:
1479
logger.critical(u"DBusException: %s", error)
2038
except dbus.exceptions.DBusException as error:
2039
logger.critical("DBusException: %s", error)
2040
cleanup()
1480
2041
sys.exit(1)
1481
2042
# End of Avahi example code
1482
2043
1485
2046
(tcp_server.handle_request
1486
2047
(*args[2:], **kwargs) or True))
1487
2048
1488
logger.debug(u"Starting main loop")
2049
logger.debug("Starting main loop")
1489
2050
main_loop.run()
1490
except AvahiError, error:
1491
logger.critical(u"AvahiError: %s", error)
2051
except AvahiError as error:
2052
logger.critical("AvahiError: %s", error)
2053
cleanup()
1492
2054
sys.exit(1)
1493
2055
except KeyboardInterrupt:
1494
2056
if debug:
1495
print >> sys.stderr
1496
logger.debug(u"Server received KeyboardInterrupt")
1497
logger.debug(u"Server exiting")
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()
1498
2062
1499
2063
if __name__ == '__main__':
1500
2064
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0