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