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
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>. This includes the
9
# methods "add" and "remove" in the "AvahiService" class, the
10
# "server_state_changed" and "entry_group_state_changed" functions,
11
# and some lines in "main".
9
# methods "add", "remove", "server_state_changed",
10
# "entry_group_state_changed", "cleanup", and "activate" in the
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
import SocketServer
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
44
45
import gnutls.library.functions
45
46
import gnutls.library.constants
46
47
import gnutls.library.types
47
import ConfigParser
48
import ConfigParser as configparser
48
49
import sys
49
50
import re
50
51
import os
51
52
import signal
52
from sets import Set
53
53
import subprocess
54
54
import atexit
55
55
import stat
56
56
import logging
57
57
import logging.handlers
58
58
import pwd
59
from contextlib import closing
59
import contextlib
60
import struct
61
import fcntl
62
import functools
63
import cPickle as pickle
64
import multiprocessing
60
65
61
66
import dbus
62
67
import dbus.service
65
70
from dbus.mainloop.glib import DBusGMainLoop
66
71
import ctypes
67
72
import ctypes.util
73
import xml.dom.minidom
74
import inspect
68
75
69
76
try:
70
77
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
72
79
try:
73
80
from IN import SO_BINDTODEVICE
74
81
except ImportError:
75
# From /usr/include/asm/socket.h
76
SO_BINDTODEVICE = 25
77
78
79
version = "1.0.8"
80
82
SO_BINDTODEVICE = None
83
84
85
version = "1.3.1"
86
87
#logger = logging.getLogger('mandos')
81
88
logger = logging.Logger('mandos')
82
89
syslogger = (logging.handlers.SysLogHandler
83
90
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
84
address = "/dev/log"))
91
address = str("/dev/log")))
85
92
syslogger.setFormatter(logging.Formatter
86
93
('Mandos [%(process)d]: %(levelname)s:'
87
94
' %(message)s'))
89
96
90
97
console = logging.StreamHandler()
91
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
92
' %(levelname)s: %(message)s'))
99
' %(levelname)s:'
100
' %(message)s'))
93
101
logger.addHandler(console)
94
102
95
103
class AvahiError(Exception):
122
130
max_renames: integer; maximum number of renames
123
131
rename_count: integer; counter so we only rename after collisions
124
132
a sensible number of times
133
group: D-Bus Entry Group
134
server: D-Bus Server
135
bus: dbus.SystemBus()
125
136
"""
126
137
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
127
138
servicetype = None, port = None, TXT = None,
128
139
domain = "", host = "", max_renames = 32768,
129
protocol = avahi.PROTO_UNSPEC):
140
protocol = avahi.PROTO_UNSPEC, bus = None):
130
141
self.interface = interface
131
142
self.name = name
132
143
self.type = servicetype
137
148
self.rename_count = 0
138
149
self.max_renames = max_renames
139
150
self.protocol = protocol
151
self.group = None # our entry group
152
self.server = None
153
self.bus = bus
154
self.entry_group_state_changed_match = None
140
155
def rename(self):
141
156
"""Derived from the Avahi example code"""
142
157
if self.rename_count >= self.max_renames:
143
logger.critical(u"No suitable Zeroconf service name found"
144
u" after %i retries, exiting.",
158
logger.critical("No suitable Zeroconf service name found"
159
" after %i retries, exiting.",
145
160
self.rename_count)
146
raise AvahiServiceError(u"Too many renames")
147
self.name = server.GetAlternativeServiceName(self.name)
148
logger.info(u"Changing Zeroconf service name to %r ...",
149
str(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)
150
165
syslogger.setFormatter(logging.Formatter
151
166
('Mandos (%s) [%%(process)d]:'
152
167
' %%(levelname)s: %%(message)s'
153
168
% self.name))
154
169
self.remove()
155
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)
156
176
self.rename_count += 1
157
177
def remove(self):
158
178
"""Derived from the Avahi example code"""
159
if group is not None:
160
group.Reset()
179
if self.entry_group_state_changed_match is not None:
180
self.entry_group_state_changed_match.remove()
181
self.entry_group_state_changed_match = None
182
if self.group is not None:
183
self.group.Reset()
161
184
def add(self):
162
185
"""Derived from the Avahi example code"""
163
global group
164
if group is None:
165
group = dbus.Interface(bus.get_object
166
(avahi.DBUS_NAME,
167
server.EntryGroupNew()),
168
avahi.DBUS_INTERFACE_ENTRY_GROUP)
169
group.connect_to_signal('StateChanged',
170
entry_group_state_changed)
171
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
172
service.name, service.type)
173
group.AddService(
174
self.interface, # interface
175
self.protocol, # protocol
176
dbus.UInt32(0), # flags
177
self.name, self.type,
178
self.domain, self.host,
179
dbus.UInt16(self.port),
180
avahi.string_array_to_txt_array(self.TXT))
181
group.Commit()
182
183
# From the Avahi example code:
184
group = None # our entry group
185
# End of Avahi example code
186
187
188
def _datetime_to_dbus(dt, variant_level=0):
189
"""Convert a UTC datetime.datetime() to a D-Bus type."""
190
return dbus.String(dt.isoformat(), variant_level=variant_level)
191
192
186
self.remove()
187
if self.group is None:
188
self.group = dbus.Interface(
189
self.bus.get_object(avahi.DBUS_NAME,
190
self.server.EntryGroupNew()),
191
avahi.DBUS_INTERFACE_ENTRY_GROUP)
192
self.entry_group_state_changed_match = (
193
self.group.connect_to_signal(
194
'StateChanged', self .entry_group_state_changed))
195
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
196
self.name, self.type)
197
self.group.AddService(
198
self.interface,
199
self.protocol,
200
dbus.UInt32(0), # flags
201
self.name, self.type,
202
self.domain, self.host,
203
dbus.UInt16(self.port),
204
avahi.string_array_to_txt_array(self.TXT))
205
self.group.Commit()
206
def entry_group_state_changed(self, state, error):
207
"""Derived from the Avahi example code"""
208
logger.debug("Avahi entry group state change: %i", state)
209
210
if state == avahi.ENTRY_GROUP_ESTABLISHED:
211
logger.debug("Zeroconf service established.")
212
elif state == avahi.ENTRY_GROUP_COLLISION:
213
logger.info("Zeroconf service name collision.")
214
self.rename()
215
elif state == avahi.ENTRY_GROUP_FAILURE:
216
logger.critical("Avahi: Error in group state changed %s",
217
unicode(error))
218
raise AvahiGroupError("State changed: %s"
219
% unicode(error))
220
def cleanup(self):
221
"""Derived from the Avahi example code"""
222
if self.group is not None:
223
try:
224
self.group.Free()
225
except (dbus.exceptions.UnknownMethodException,
226
dbus.exceptions.DBusException) as e:
227
pass
228
self.group = None
229
self.remove()
230
def server_state_changed(self, state, error=None):
231
"""Derived from the Avahi example code"""
232
logger.debug("Avahi server state change: %i", state)
233
bad_states = { avahi.SERVER_INVALID:
234
"Zeroconf server invalid",
235
avahi.SERVER_REGISTERING: None,
236
avahi.SERVER_COLLISION:
237
"Zeroconf server name collision",
238
avahi.SERVER_FAILURE:
239
"Zeroconf server failure" }
240
if state in bad_states:
241
if bad_states[state] is not None:
242
if error is None:
243
logger.error(bad_states[state])
244
else:
245
logger.error(bad_states[state] + ": %r", error)
246
self.cleanup()
247
elif state == avahi.SERVER_RUNNING:
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)
254
def activate(self):
255
"""Derived from the Avahi example code"""
256
if self.server is None:
257
self.server = dbus.Interface(
258
self.bus.get_object(avahi.DBUS_NAME,
259
avahi.DBUS_PATH_SERVER,
260
follow_name_owner_changes=True),
261
avahi.DBUS_INTERFACE_SERVER)
262
self.server.connect_to_signal("StateChanged",
263
self.server_state_changed)
264
self.server_state_changed(self.server.GetState())
265
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
193
273
class Client(object):
194
274
"""A representation of a client host served by this server.
195
275
196
276
Attributes:
197
name: string; from the config file, used in log messages and
198
D-Bus identifiers
199
fingerprint: string (40 or 32 hexadecimal digits); used to
200
uniquely identify the client
201
secret: bytestring; sent verbatim (over TLS) to client
202
host: string; available for use by the checker command
203
created: datetime.datetime(); (UTC) object creation
204
last_enabled: datetime.datetime(); (UTC)
205
enabled: bool()
206
last_checked_ok: datetime.datetime(); (UTC) or None
207
timeout: datetime.timedelta(); How long from last_checked_ok
208
until this client is invalid
209
interval: datetime.timedelta(); How often to start a new checker
210
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
211
280
checker: subprocess.Popen(); a running checker process used
212
281
to see if the client lives.
213
282
'None' if no process is running.
214
checker_initiator_tag: a gobject event source tag, or None
215
disable_initiator_tag: - '' -
216
checker_callback_tag: - '' -
217
checker_command: string; External command which is run to check if
218
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
219
286
runtime with vars(self) as dict, so that for
220
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
221
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
222
310
"""
311
312
runtime_expansions = ("approval_delay", "approval_duration",
313
"created", "enabled", "fingerprint",
314
"host", "interval", "last_checked_ok",
315
"last_enabled", "name", "timeout")
316
223
317
def timeout_milliseconds(self):
224
318
"Return the 'timeout' attribute in milliseconds"
225
return ((self.timeout.days * 24 * 60 * 60 * 1000)
226
+ (self.timeout.seconds * 1000)
227
+ (self.timeout.microseconds // 1000))
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)
228
324
229
325
def interval_milliseconds(self):
230
326
"Return the 'interval' attribute in milliseconds"
231
return ((self.interval.days * 24 * 60 * 60 * 1000)
232
+ (self.interval.seconds * 1000)
233
+ (self.interval.microseconds // 1000))
327
return _timedelta_to_milliseconds(self.interval)
328
329
def approval_delay_milliseconds(self):
330
return _timedelta_to_milliseconds(self.approval_delay)
234
331
235
332
def __init__(self, name = None, disable_hook=None, config=None):
236
333
"""Note: the 'checker' key in 'config' sets the
239
336
self.name = name
240
337
if config is None:
241
338
config = {}
242
logger.debug(u"Creating client %r", self.name)
339
logger.debug("Creating client %r", self.name)
243
340
# Uppercase and remove spaces from fingerprint for later
244
341
# comparison purposes with return value from the fingerprint()
245
342
# function
246
343
self.fingerprint = (config["fingerprint"].upper()
247
.replace(u" ", u""))
248
logger.debug(u" Fingerprint: %s", self.fingerprint)
344
.replace(" ", ""))
345
logger.debug(" Fingerprint: %s", self.fingerprint)
249
346
if "secret" in config:
250
self.secret = config["secret"].decode(u"base64")
347
self.secret = config["secret"].decode("base64")
251
348
elif "secfile" in config:
252
with closing(open(os.path.expanduser
253
(os.path.expandvars
254
(config["secfile"])))) as secfile:
349
with open(os.path.expanduser(os.path.expandvars
350
(config["secfile"])),
351
"rb") as secfile:
255
352
self.secret = secfile.read()
256
353
else:
257
raise TypeError(u"No secret or secfile for client %s"
354
raise TypeError("No secret or secfile for client %s"
258
355
% self.name)
259
356
self.host = config.get("host", "")
260
357
self.created = datetime.datetime.utcnow()
261
358
self.enabled = False
359
self.last_approval_request = None
262
360
self.last_enabled = None
263
361
self.last_checked_ok = None
264
362
self.timeout = string_to_delta(config["timeout"])
363
self.extended_timeout = string_to_delta(config["extended_timeout"])
265
364
self.interval = string_to_delta(config["interval"])
266
365
self.disable_hook = disable_hook
267
366
self.checker = None
268
367
self.checker_initiator_tag = None
269
368
self.disable_initiator_tag = None
369
self.expires = None
270
370
self.checker_callback_tag = None
271
371
self.checker_command = config["checker"]
272
372
self.current_checker_command = None
273
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())
274
383
384
def send_changedstate(self):
385
self.changedstate.acquire()
386
self.changedstate.notify_all()
387
self.changedstate.release()
388
275
389
def enable(self):
276
390
"""Start this client's checker and timeout hooks"""
277
self.last_enabled = datetime.datetime.utcnow()
391
if getattr(self, "enabled", False):
392
# Already enabled
393
return
394
self.send_changedstate()
278
395
# Schedule a new checker to be started an 'interval' from now,
279
396
# and every interval from then on.
280
397
self.checker_initiator_tag = (gobject.timeout_add
281
398
(self.interval_milliseconds(),
282
399
self.start_checker))
283
# Also start a new checker *right now*.
284
self.start_checker()
285
400
# Schedule a disable() when 'timeout' has passed
401
self.expires = datetime.datetime.utcnow() + self.timeout
286
402
self.disable_initiator_tag = (gobject.timeout_add
287
403
(self.timeout_milliseconds(),
288
404
self.disable))
289
405
self.enabled = True
406
self.last_enabled = datetime.datetime.utcnow()
407
# Also start a new checker *right now*.
408
self.start_checker()
290
409
291
def disable(self):
410
def disable(self, quiet=True):
292
411
"""Disable this client."""
293
412
if not getattr(self, "enabled", False):
294
413
return False
295
logger.info(u"Disabling client %s", self.name)
414
if not quiet:
415
self.send_changedstate()
416
if not quiet:
417
logger.info("Disabling client %s", self.name)
296
418
if getattr(self, "disable_initiator_tag", False):
297
419
gobject.source_remove(self.disable_initiator_tag)
298
420
self.disable_initiator_tag = None
421
self.expires = None
299
422
if getattr(self, "checker_initiator_tag", False):
300
423
gobject.source_remove(self.checker_initiator_tag)
301
424
self.checker_initiator_tag = None
317
440
if os.WIFEXITED(condition):
318
441
exitstatus = os.WEXITSTATUS(condition)
319
442
if exitstatus == 0:
320
logger.info(u"Checker for %(name)s succeeded",
443
logger.info("Checker for %(name)s succeeded",
321
444
vars(self))
322
445
self.checked_ok()
323
446
else:
324
logger.info(u"Checker for %(name)s failed",
447
logger.info("Checker for %(name)s failed",
325
448
vars(self))
326
449
else:
327
logger.warning(u"Checker for %(name)s crashed?",
450
logger.warning("Checker for %(name)s crashed?",
328
451
vars(self))
329
452
330
def checked_ok(self):
453
def checked_ok(self, timeout=None):
331
454
"""Bump up the timeout for this client.
332
455
333
456
This should only be called when the client has been seen,
334
457
alive and well.
335
458
"""
459
if timeout is None:
460
timeout = self.timeout
336
461
self.last_checked_ok = datetime.datetime.utcnow()
337
462
gobject.source_remove(self.disable_initiator_tag)
463
self.expires = datetime.datetime.utcnow() + timeout
338
464
self.disable_initiator_tag = (gobject.timeout_add
339
(self.timeout_milliseconds(),
465
(_timedelta_to_milliseconds(timeout),
340
466
self.disable))
341
467
468
def need_approval(self):
469
self.last_approval_request = datetime.datetime.utcnow()
470
342
471
def start_checker(self):
343
472
"""Start a new checker subprocess if one is not running.
344
473
350
479
# client would inevitably timeout, since no checker would get
351
480
# a chance to run to completion. If we instead leave running
352
481
# checkers alone, the checker would have to take more time
353
# than 'timeout' for the client to be declared invalid, which
354
# is as it should be.
482
# than 'timeout' for the client to be disabled, which is as it
483
# should be.
355
484
356
485
# If a checker exists, make sure it is not a zombie
357
if self.checker is not None:
486
try:
358
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:
359
493
if pid:
360
494
logger.warning("Checker was a zombie")
361
495
gobject.source_remove(self.checker_callback_tag)
368
502
command = self.checker_command % self.host
369
503
except TypeError:
370
504
# Escape attributes for the shell
371
escaped_attrs = dict((key, re.escape(str(val)))
372
for key, val in
373
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
374
513
try:
375
514
command = self.checker_command % escaped_attrs
376
except TypeError, error:
377
logger.error(u'Could not format string "%s":'
378
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)
379
518
return True # Try again later
380
519
self.current_checker_command = command
381
520
try:
382
logger.info(u"Starting checker %r for %s",
521
logger.info("Starting checker %r for %s",
383
522
command, self.name)
384
523
# We don't need to redirect stdout and stderr, since
385
524
# in normal mode, that is already done by daemon(),
398
537
if pid:
399
538
gobject.source_remove(self.checker_callback_tag)
400
539
self.checker_callback(pid, status, command)
401
except OSError, error:
402
logger.error(u"Failed to start subprocess: %s",
540
except OSError as error:
541
logger.error("Failed to start subprocess: %s",
403
542
error)
404
543
# Re-run this periodically if run by gobject.timeout_add
405
544
return True
411
550
self.checker_callback_tag = None
412
551
if getattr(self, "checker", None) is None:
413
552
return
414
logger.debug(u"Stopping checker for %(name)s", vars(self))
553
logger.debug("Stopping checker for %(name)s", vars(self))
415
554
try:
416
555
os.kill(self.checker.pid, signal.SIGTERM)
417
#os.sleep(0.5)
556
#time.sleep(0.5)
418
557
#if self.checker.poll() is None:
419
558
# os.kill(self.checker.pid, signal.SIGKILL)
420
except OSError, error:
559
except OSError as error:
421
560
if error.errno != errno.ESRCH: # No such process
422
561
raise
423
562
self.checker = None
424
425
def still_valid(self):
426
"""Has the timeout not yet passed for this client?"""
427
if not getattr(self, "enabled", False):
428
return False
429
now = datetime.datetime.utcnow()
430
if self.last_checked_ok is None:
431
return now < (self.created + self.timeout)
432
else:
433
return now < (self.last_checked_ok + self.timeout)
434
435
436
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):
437
761
"""A Client class using D-Bus
438
762
439
763
Attributes:
440
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
764
dbus_object_path: dbus.ObjectPath
765
bus: dbus.SystemBus()
441
766
"""
767
768
runtime_expansions = (Client.runtime_expansions
769
+ ("dbus_object_path",))
770
442
771
# dbus.service.Object doesn't use super(), so we can't either.
443
772
444
def __init__(self, *args, **kwargs):
773
def __init__(self, bus = None, *args, **kwargs):
774
self._approvals_pending = 0
775
self.bus = bus
445
776
Client.__init__(self, *args, **kwargs)
446
777
# Only now, when this client is initialized, can it show up on
447
778
# the D-Bus
779
client_object_name = unicode(self.name).translate(
780
{ord("."): ord("_"),
781
ord("-"): ord("_")})
448
782
self.dbus_object_path = (dbus.ObjectPath
449
("/clients/"
450
+ self.name.replace(".", "_")))
451
dbus.service.Object.__init__(self, bus,
452
self.dbus_object_path)
453
def enable(self):
454
oldstate = getattr(self, "enabled", False)
455
r = Client.enable(self)
456
if oldstate != self.enabled:
457
# Emit D-Bus signals
458
self.PropertyChanged(dbus.String(u"enabled"),
459
dbus.Boolean(True, variant_level=1))
460
self.PropertyChanged(dbus.String(u"last_enabled"),
461
(_datetime_to_dbus(self.last_enabled,
462
variant_level=1)))
463
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")
464
840
465
def disable(self, signal = True):
466
oldstate = getattr(self, "enabled", False)
467
r = Client.disable(self)
468
if signal and oldstate != self.enabled:
469
# Emit D-Bus signal
470
self.PropertyChanged(dbus.String(u"enabled"),
471
dbus.Boolean(False, variant_level=1))
472
return r
841
del notifychangeproperty
473
842
474
843
def __del__(self, *args, **kwargs):
475
844
try:
476
845
self.remove_from_connection()
477
846
except LookupError:
478
847
pass
479
if hasattr(dbus.service.Object, "__del__"):
480
dbus.service.Object.__del__(self, *args, **kwargs)
848
if hasattr(DBusObjectWithProperties, "__del__"):
849
DBusObjectWithProperties.__del__(self, *args, **kwargs)
481
850
Client.__del__(self, *args, **kwargs)
482
851
483
852
def checker_callback(self, pid, condition, command,
484
853
*args, **kwargs):
485
854
self.checker_callback_tag = None
486
855
self.checker = None
487
# Emit D-Bus signal
488
self.PropertyChanged(dbus.String(u"checker_running"),
489
dbus.Boolean(False, variant_level=1))
490
856
if os.WIFEXITED(condition):
491
857
exitstatus = os.WEXITSTATUS(condition)
492
858
# Emit D-Bus signal
501
867
502
868
return Client.checker_callback(self, pid, condition, command,
503
869
*args, **kwargs)
504
505
def checked_ok(self, *args, **kwargs):
506
r = Client.checked_ok(self, *args, **kwargs)
507
# Emit D-Bus signal
508
self.PropertyChanged(
509
dbus.String(u"last_checked_ok"),
510
(_datetime_to_dbus(self.last_checked_ok,
511
variant_level=1)))
512
return r
513
870
514
871
def start_checker(self, *args, **kwargs):
515
872
old_checker = self.checker
516
873
if self.checker is not None:
523
880
and old_checker_pid != self.checker.pid):
524
881
# Emit D-Bus signal
525
882
self.CheckerStarted(self.current_checker_command)
526
self.PropertyChanged(
527
dbus.String("checker_running"),
528
dbus.Boolean(True, variant_level=1))
529
return r
530
531
def stop_checker(self, *args, **kwargs):
532
old_checker = getattr(self, "checker", None)
533
r = Client.stop_checker(self, *args, **kwargs)
534
if (old_checker is not None
535
and getattr(self, "checker", None) is None):
536
self.PropertyChanged(dbus.String(u"checker_running"),
537
dbus.Boolean(False, variant_level=1))
538
return r
539
540
## D-Bus methods & signals
541
_interface = u"se.bsnet.fukt.Mandos.Client"
542
543
# CheckedOK - method
544
CheckedOK = dbus.service.method(_interface)(checked_ok)
545
CheckedOK.__name__ = "CheckedOK"
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
546
901
547
902
# CheckerCompleted - signal
548
903
@dbus.service.signal(_interface, signature="nxs")
556
911
"D-Bus signal"
557
912
pass
558
913
559
# GetAllProperties - method
560
@dbus.service.method(_interface, out_signature="a{sv}")
561
def GetAllProperties(self):
562
"D-Bus method"
563
return dbus.Dictionary({
564
dbus.String("name"):
565
dbus.String(self.name, variant_level=1),
566
dbus.String("fingerprint"):
567
dbus.String(self.fingerprint, variant_level=1),
568
dbus.String("host"):
569
dbus.String(self.host, variant_level=1),
570
dbus.String("created"):
571
_datetime_to_dbus(self.created, variant_level=1),
572
dbus.String("last_enabled"):
573
(_datetime_to_dbus(self.last_enabled,
574
variant_level=1)
575
if self.last_enabled is not None
576
else dbus.Boolean(False, variant_level=1)),
577
dbus.String("enabled"):
578
dbus.Boolean(self.enabled, variant_level=1),
579
dbus.String("last_checked_ok"):
580
(_datetime_to_dbus(self.last_checked_ok,
581
variant_level=1)
582
if self.last_checked_ok is not None
583
else dbus.Boolean (False, variant_level=1)),
584
dbus.String("timeout"):
585
dbus.UInt64(self.timeout_milliseconds(),
586
variant_level=1),
587
dbus.String("interval"):
588
dbus.UInt64(self.interval_milliseconds(),
589
variant_level=1),
590
dbus.String("checker"):
591
dbus.String(self.checker_command,
592
variant_level=1),
593
dbus.String("checker_running"):
594
dbus.Boolean(self.checker is not None,
595
variant_level=1),
596
dbus.String("object_path"):
597
dbus.ObjectPath(self.dbus_object_path,
598
variant_level=1)
599
}, signature="sv")
600
601
# IsStillValid - method
602
@dbus.service.method(_interface, out_signature="b")
603
def IsStillValid(self):
604
return self.still_valid()
605
606
914
# PropertyChanged - signal
607
915
@dbus.service.signal(_interface, signature="sv")
608
916
def PropertyChanged(self, property, value):
609
917
"D-Bus signal"
610
918
pass
611
919
612
# ReceivedSecret - signal
920
# GotSecret - signal
613
921
@dbus.service.signal(_interface)
614
def ReceivedSecret(self):
615
"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
"""
616
927
pass
617
928
618
929
# Rejected - signal
619
@dbus.service.signal(_interface)
620
def Rejected(self):
930
@dbus.service.signal(_interface, signature="s")
931
def Rejected(self, reason):
621
932
"D-Bus signal"
622
933
pass
623
934
624
# SetChecker - method
625
@dbus.service.method(_interface, in_signature="s")
626
def SetChecker(self, checker):
627
"D-Bus setter method"
628
self.checker_command = checker
629
# Emit D-Bus signal
630
self.PropertyChanged(dbus.String(u"checker"),
631
dbus.String(self.checker_command,
632
variant_level=1))
633
634
# SetHost - method
635
@dbus.service.method(_interface, in_signature="s")
636
def SetHost(self, host):
637
"D-Bus setter method"
638
self.host = host
639
# Emit D-Bus signal
640
self.PropertyChanged(dbus.String(u"host"),
641
dbus.String(self.host, variant_level=1))
642
643
# SetInterval - method
644
@dbus.service.method(_interface, in_signature="t")
645
def SetInterval(self, milliseconds):
646
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
647
# Emit D-Bus signal
648
self.PropertyChanged(dbus.String(u"interval"),
649
(dbus.UInt64(self.interval_milliseconds(),
650
variant_level=1)))
651
652
# SetSecret - method
653
@dbus.service.method(_interface, in_signature="ay",
654
byte_arrays=True)
655
def SetSecret(self, secret):
656
"D-Bus setter method"
657
self.secret = str(secret)
658
659
# SetTimeout - method
660
@dbus.service.method(_interface, in_signature="t")
661
def SetTimeout(self, milliseconds):
662
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
663
# Emit D-Bus signal
664
self.PropertyChanged(dbus.String(u"timeout"),
665
(dbus.UInt64(self.timeout_milliseconds(),
666
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()
667
952
668
953
# Enable - method
669
Enable = dbus.service.method(_interface)(enable)
670
Enable.__name__ = "Enable"
954
@dbus.service.method(_interface)
955
def Enable(self):
956
"D-Bus method"
957
self.enable()
671
958
672
959
# StartChecker - method
673
960
@dbus.service.method(_interface)
682
969
self.disable()
683
970
684
971
# StopChecker - method
685
StopChecker = dbus.service.method(_interface)(stop_checker)
686
StopChecker.__name__ = "StopChecker"
972
@dbus.service.method(_interface)
973
def StopChecker(self):
974
self.stop_checker()
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)
687
1146
688
1147
del _interface
689
1148
690
1149
691
class ClientHandler(SocketServer.BaseRequestHandler, object):
1150
class ProxyClient(object):
1151
def __init__(self, child_pipe, fpr, address):
1152
self._pipe = child_pipe
1153
self._pipe.send(('init', fpr, address))
1154
if not self._pipe.recv():
1155
raise KeyError()
1156
1157
def __getattribute__(self, name):
1158
if(name == '_pipe'):
1159
return super(ProxyClient, self).__getattribute__(name)
1160
self._pipe.send(('getattr', name))
1161
data = self._pipe.recv()
1162
if data[0] == 'data':
1163
return data[1]
1164
if data[0] == 'function':
1165
def func(*args, **kwargs):
1166
self._pipe.send(('funcall', name, args, kwargs))
1167
return self._pipe.recv()[1]
1168
return func
1169
1170
def __setattr__(self, name, value):
1171
if(name == '_pipe'):
1172
return super(ProxyClient, self).__setattr__(name, value)
1173
self._pipe.send(('setattr', name, value))
1174
1175
1176
class ClientHandler(socketserver.BaseRequestHandler, object):
692
1177
"""A class to handle client connections.
693
1178
694
1179
Instantiated once for each connection to handle it.
695
1180
Note: This will run in its own forked process."""
696
1181
697
1182
def handle(self):
698
logger.info(u"TCP connection from: %s",
699
unicode(self.client_address))
700
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
701
# Open IPC pipe to parent process
702
with closing(os.fdopen(self.server.pipe[1], "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
703
1189
session = (gnutls.connection
704
1190
.ClientSession(self.request,
705
1191
gnutls.connection
706
1192
.X509Credentials()))
707
708
line = self.request.makefile().readline()
709
logger.debug(u"Protocol version: %r", line)
710
try:
711
if int(line.strip().split()[0]) > 1:
712
raise RuntimeError
713
except (ValueError, IndexError, RuntimeError), error:
714
logger.error(u"Unknown protocol version: %s", error)
715
return
716
1193
717
1194
# Note: gnutls.connection.X509Credentials is really a
718
1195
# generic GnuTLS certificate credentials object so long as
719
1196
# no X.509 keys are added to it. Therefore, we can use it
720
1197
# here despite using OpenPGP certificates.
721
1198
722
1199
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
723
# "+AES-256-CBC", "+SHA1",
724
# "+COMP-NULL", "+CTYPE-OPENPGP",
725
# "+DHE-DSS"))
1200
# "+AES-256-CBC", "+SHA1",
1201
# "+COMP-NULL", "+CTYPE-OPENPGP",
1202
# "+DHE-DSS"))
726
1203
# Use a fallback default, since this MUST be set.
727
1204
priority = self.server.gnutls_priority
728
1205
if priority is None:
730
1207
(gnutls.library.functions
731
1208
.gnutls_priority_set_direct(session._c_object,
732
1209
priority, None))
733
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
734
1223
try:
735
1224
session.handshake()
736
except gnutls.errors.GNUTLSError, error:
737
logger.warning(u"Handshake failed: %s", error)
1225
except gnutls.errors.GNUTLSError as error:
1226
logger.warning("Handshake failed: %s", error)
738
1227
# Do not run session.bye() here: the session is not
739
1228
# established. Just abandon the request.
740
1229
return
741
logger.debug(u"Handshake succeeded")
1230
logger.debug("Handshake succeeded")
1231
1232
approval_required = False
742
1233
try:
743
fpr = self.fingerprint(self.peer_certificate(session))
744
except (TypeError, gnutls.errors.GNUTLSError), error:
745
logger.warning(u"Bad certificate: %s", error)
746
session.bye()
747
return
748
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()
749
1321
750
for c in self.server.clients:
751
if c.fingerprint == fpr:
752
client = c
753
break
754
else:
755
ipc.write("NOTFOUND %s\n" % fpr)
756
session.bye()
757
return
758
# Have to check if client.still_valid(), since it is
759
# possible that the client timed out while establishing
760
# the GnuTLS session.
761
if not client.still_valid():
762
ipc.write("INVALID %s\n" % client.name)
763
session.bye()
764
return
765
ipc.write("SENDING %s\n" % client.name)
766
sent_size = 0
767
while sent_size < len(client.secret):
768
sent = session.send(client.secret[sent_size:])
769
logger.debug(u"Sent: %d, remaining: %d",
770
sent, len(client.secret)
771
- (sent_size + sent))
772
sent_size += sent
773
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")
774
1329
775
1330
@staticmethod
776
1331
def peer_certificate(session):
832
1387
# Convert the buffer to a Python bytestring
833
1388
fpr = ctypes.string_at(buf, buf_len.value)
834
1389
# Convert the bytestring to hexadecimal notation
835
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1390
hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
836
1391
return hex_fpr
837
1392
838
1393
839
class ForkingMixInWithPipe(SocketServer.ForkingMixIn, object):
840
"""Like SocketServer.ForkingMixIn, but also pass a pipe.
841
842
Assumes a gobject.MainLoop event loop.
843
"""
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 """
844
1410
def process_request(self, request, client_address):
845
1411
"""Overrides and wraps the original process_request().
846
1412
847
This function creates a new pipe in self.pipe
1413
This function creates a new pipe in self.pipe
848
1414
"""
849
self.pipe = os.pipe()
850
super(ForkingMixInWithPipe,
1415
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1416
1417
super(MultiprocessingMixInWithPipe,
851
1418
self).process_request(request, client_address)
852
os.close(self.pipe[1]) # close write end
853
# Call "handle_ipc" for both data and EOF events
854
gobject.io_add_watch(self.pipe[0],
855
gobject.IO_IN | gobject.IO_HUP,
856
self.handle_ipc)
857
def handle_ipc(source, condition):
1419
self.child_pipe.close()
1420
self.add_pipe(parent_pipe)
1421
1422
def add_pipe(self, parent_pipe):
858
1423
"""Dummy function; override as necessary"""
859
os.close(source)
860
return False
861
862
863
class IPv6_TCPServer(ForkingMixInWithPipe,
864
SocketServer.TCPServer, object):
1424
raise NotImplementedError
1425
1426
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1427
socketserver.TCPServer, object):
865
1428
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
866
1429
867
1430
Attributes:
868
1431
enabled: Boolean; whether this server is activated yet
869
1432
interface: None or a network interface name (string)
870
1433
use_ipv6: Boolean; to use IPv6 or not
871
----
872
clients: Set() of Client objects
873
gnutls_priority GnuTLS priority string
874
use_dbus: Boolean; to emit D-Bus signals or not
875
1434
"""
876
1435
def __init__(self, server_address, RequestHandlerClass,
877
interface=None, use_ipv6=True, clients=None,
878
gnutls_priority=None, use_dbus=True):
879
self.enabled = False
1436
interface=None, use_ipv6=True):
880
1437
self.interface = interface
881
1438
if use_ipv6:
882
1439
self.address_family = socket.AF_INET6
883
self.clients = clients
884
self.use_dbus = use_dbus
885
self.gnutls_priority = gnutls_priority
886
SocketServer.TCPServer.__init__(self, server_address,
1440
socketserver.TCPServer.__init__(self, server_address,
887
1441
RequestHandlerClass)
888
1442
def server_bind(self):
889
1443
"""This overrides the normal server_bind() function
890
1444
to bind to an interface if one was specified, and also NOT to
891
1445
bind to an address or port if they were not specified."""
892
1446
if self.interface is not None:
893
try:
894
self.socket.setsockopt(socket.SOL_SOCKET,
895
SO_BINDTODEVICE,
896
self.interface + '\0')
897
except socket.error, error:
898
if error[0] == errno.EPERM:
899
logger.error(u"No permission to"
900
u" bind to interface %s",
901
self.interface)
902
else:
903
raise
1447
if SO_BINDTODEVICE is None:
1448
logger.error("SO_BINDTODEVICE does not exist;"
1449
" cannot bind to interface %s",
1450
self.interface)
1451
else:
1452
try:
1453
self.socket.setsockopt(socket.SOL_SOCKET,
1454
SO_BINDTODEVICE,
1455
str(self.interface
1456
+ '\0'))
1457
except socket.error as error:
1458
if error[0] == errno.EPERM:
1459
logger.error("No permission to"
1460
" bind to interface %s",
1461
self.interface)
1462
elif error[0] == errno.ENOPROTOOPT:
1463
logger.error("SO_BINDTODEVICE not available;"
1464
" cannot bind to interface %s",
1465
self.interface)
1466
else:
1467
raise
904
1468
# Only bind(2) the socket if we really need to.
905
1469
if self.server_address[0] or self.server_address[1]:
906
1470
if not self.server_address[0]:
919
1483
# 0, # flowinfo
920
1484
# if_nametoindex
921
1485
# (self.interface))
922
return SocketServer.TCPServer.server_bind(self)
1486
return socketserver.TCPServer.server_bind(self)
1487
1488
1489
class MandosServer(IPv6_TCPServer):
1490
"""Mandos server.
1491
1492
Attributes:
1493
clients: set of Client objects
1494
gnutls_priority GnuTLS priority string
1495
use_dbus: Boolean; to emit D-Bus signals or not
1496
1497
Assumes a gobject.MainLoop event loop.
1498
"""
1499
def __init__(self, server_address, RequestHandlerClass,
1500
interface=None, use_ipv6=True, clients=None,
1501
gnutls_priority=None, use_dbus=True):
1502
self.enabled = False
1503
self.clients = clients
1504
if self.clients is None:
1505
self.clients = set()
1506
self.use_dbus = use_dbus
1507
self.gnutls_priority = gnutls_priority
1508
IPv6_TCPServer.__init__(self, server_address,
1509
RequestHandlerClass,
1510
interface = interface,
1511
use_ipv6 = use_ipv6)
923
1512
def server_activate(self):
924
1513
if self.enabled:
925
return SocketServer.TCPServer.server_activate(self)
1514
return socketserver.TCPServer.server_activate(self)
926
1515
def enable(self):
927
1516
self.enabled = True
928
def handle_ipc(self, source, condition, file_objects={}):
1517
def add_pipe(self, parent_pipe):
1518
# Call "handle_ipc" for both data and EOF events
1519
gobject.io_add_watch(parent_pipe.fileno(),
1520
gobject.IO_IN | gobject.IO_HUP,
1521
functools.partial(self.handle_ipc,
1522
parent_pipe = parent_pipe))
1523
1524
def handle_ipc(self, source, condition, parent_pipe=None,
1525
client_object=None):
929
1526
condition_names = {
930
gobject.IO_IN: "IN", # There is data to read.
1527
gobject.IO_IN: "IN", # There is data to read.
931
1528
gobject.IO_OUT: "OUT", # Data can be written (without
932
# blocking).
1529
# blocking).
933
1530
gobject.IO_PRI: "PRI", # There is urgent data to read.
934
1531
gobject.IO_ERR: "ERR", # Error condition.
935
1532
gobject.IO_HUP: "HUP" # Hung up (the connection has been
936
# broken, usually for pipes and
937
# sockets).
1533
# broken, usually for pipes and
1534
# sockets).
938
1535
}
939
1536
conditions_string = ' | '.join(name
940
1537
for cond, name in
941
1538
condition_names.iteritems()
942
1539
if cond & condition)
943
logger.debug("Handling IPC: FD = %d, condition = %s", source,
944
conditions_string)
945
946
# Turn the pipe file descriptor into a Python file object
947
if source not in file_objects:
948
file_objects[source] = os.fdopen(source, "r", 1)
949
950
# Read a line from the file object
951
cmdline = file_objects[source].readline()
952
if not cmdline: # Empty line means end of file
953
# close the IPC pipe
954
file_objects[source].close()
955
del file_objects[source]
956
957
# Stop calling this function
958
return False
959
960
logger.debug("IPC command: %r", cmdline)
961
962
# Parse and act on command
963
cmd, args = cmdline.rstrip("\r\n").split(None, 1)
964
965
if cmd == "NOTFOUND":
966
logger.warning(u"Client not found for fingerprint: %s",
967
args)
968
if self.use_dbus:
969
# Emit D-Bus signal
970
mandos_dbus_service.ClientNotFound(args)
971
elif cmd == "INVALID":
972
for client in self.clients:
973
if client.name == args:
974
logger.warning(u"Client %s is invalid", args)
975
if self.use_dbus:
976
# Emit D-Bus signal
977
client.Rejected()
978
break
979
else:
980
logger.error(u"Unknown client %s is invalid", args)
981
elif cmd == "SENDING":
982
for client in self.clients:
983
if client.name == args:
984
logger.info(u"Sending secret to %s", client.name)
985
client.checked_ok()
986
if self.use_dbus:
987
# Emit D-Bus signal
988
client.ReceivedSecret()
989
break
990
else:
991
logger.error(u"Sending secret to unknown client %s",
992
args)
993
else:
994
logger.error("Unknown IPC command: %r", cmdline)
995
996
# 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
997
1592
return True
998
1593
999
1594
1008
1603
datetime.timedelta(0, 3600)
1009
1604
>>> string_to_delta('24h')
1010
1605
datetime.timedelta(1)
1011
>>> string_to_delta(u'1w')
1606
>>> string_to_delta('1w')
1012
1607
datetime.timedelta(7)
1013
1608
>>> string_to_delta('5m 30s')
1014
1609
datetime.timedelta(0, 330)
1018
1613
try:
1019
1614
suffix = unicode(s[-1])
1020
1615
value = int(s[:-1])
1021
if suffix == u"d":
1616
if suffix == "d":
1022
1617
delta = datetime.timedelta(value)
1023
elif suffix == u"s":
1618
elif suffix == "s":
1024
1619
delta = datetime.timedelta(0, value)
1025
elif suffix == u"m":
1620
elif suffix == "m":
1026
1621
delta = datetime.timedelta(0, 0, 0, 0, value)
1027
elif suffix == u"h":
1622
elif suffix == "h":
1028
1623
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1029
elif suffix == u"w":
1624
elif suffix == "w":
1030
1625
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1031
1626
else:
1032
raise ValueError
1033
except (ValueError, IndexError):
1034
raise ValueError
1627
raise ValueError("Unknown suffix %r" % suffix)
1628
except (ValueError, IndexError) as e:
1629
raise ValueError(*(e.args))
1035
1630
timevalue += delta
1036
1631
return timevalue
1037
1632
1038
1633
1039
def server_state_changed(state):
1040
"""Derived from the Avahi example code"""
1041
if state == avahi.SERVER_COLLISION:
1042
logger.error(u"Zeroconf server name collision")
1043
service.remove()
1044
elif state == avahi.SERVER_RUNNING:
1045
service.add()
1046
1047
1048
def entry_group_state_changed(state, error):
1049
"""Derived from the Avahi example code"""
1050
logger.debug(u"Avahi state change: %i", state)
1051
1052
if state == avahi.ENTRY_GROUP_ESTABLISHED:
1053
logger.debug(u"Zeroconf service established.")
1054
elif state == avahi.ENTRY_GROUP_COLLISION:
1055
logger.warning(u"Zeroconf service name collision.")
1056
service.rename()
1057
elif state == avahi.ENTRY_GROUP_FAILURE:
1058
logger.critical(u"Avahi: Error in group state changed %s",
1059
unicode(error))
1060
raise AvahiGroupError(u"State changed: %s" % unicode(error))
1061
1062
1634
def if_nametoindex(interface):
1063
"""Call the C function if_nametoindex(), or equivalent"""
1635
"""Call the C function if_nametoindex(), or equivalent
1636
1637
Note: This function cannot accept a unicode string."""
1064
1638
global if_nametoindex
1065
1639
try:
1066
1640
if_nametoindex = (ctypes.cdll.LoadLibrary
1067
1641
(ctypes.util.find_library("c"))
1068
1642
.if_nametoindex)
1069
1643
except (OSError, AttributeError):
1070
if "struct" not in sys.modules:
1071
import struct
1072
if "fcntl" not in sys.modules:
1073
import fcntl
1644
logger.warning("Doing if_nametoindex the hard way")
1074
1645
def if_nametoindex(interface):
1075
1646
"Get an interface index the hard way, i.e. using fcntl()"
1076
1647
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1077
with closing(socket.socket()) as s:
1648
with contextlib.closing(socket.socket()) as s:
1078
1649
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1079
struct.pack("16s16x", interface))
1080
interface_index = struct.unpack("I", ifreq[16:20])[0]
1650
struct.pack(str("16s16x"),
1651
interface))
1652
interface_index = struct.unpack(str("I"),
1653
ifreq[16:20])[0]
1081
1654
return interface_index
1082
1655
return if_nametoindex(interface)
1083
1656
1098
1671
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1099
1672
if not stat.S_ISCHR(os.fstat(null).st_mode):
1100
1673
raise OSError(errno.ENODEV,
1101
"/dev/null not a character device")
1674
"%s not a character device"
1675
% os.path.devnull)
1102
1676
os.dup2(null, sys.stdin.fileno())
1103
1677
os.dup2(null, sys.stdout.fileno())
1104
1678
os.dup2(null, sys.stderr.fileno())
1108
1682
1109
1683
def main():
1110
1684
1111
######################################################################
1685
##################################################################
1112
1686
# Parsing of options, both command line and config file
1113
1687
1114
parser = optparse.OptionParser(version = "%%prog %s" % version)
1115
parser.add_option("-i", "--interface", type="string",
1116
metavar="IF", help="Bind to interface IF")
1117
parser.add_option("-a", "--address", type="string",
1118
help="Address to listen for requests on")
1119
parser.add_option("-p", "--port", type="int",
1120
help="Port number to receive requests on")
1121
parser.add_option("--check", action="store_true",
1122
help="Run self-test")
1123
parser.add_option("--debug", action="store_true",
1124
help="Debug mode; run in foreground and log to"
1125
" terminal")
1126
parser.add_option("--priority", type="string", help="GnuTLS"
1127
" priority string (see GnuTLS documentation)")
1128
parser.add_option("--servicename", type="string", metavar="NAME",
1129
help="Zeroconf service name")
1130
parser.add_option("--configdir", type="string",
1131
default="/etc/mandos", metavar="DIR",
1132
help="Directory to search for configuration"
1133
" files")
1134
parser.add_option("--no-dbus", action="store_false",
1135
dest="use_dbus",
1136
help="Do not provide D-Bus system bus"
1137
" interface")
1138
parser.add_option("--no-ipv6", action="store_false",
1139
dest="use_ipv6", help="Do not use IPv6")
1140
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()
1141
1719
1142
1720
if options.check:
1143
1721
import doctest
1154
1732
"servicename": "Mandos",
1155
1733
"use_dbus": "True",
1156
1734
"use_ipv6": "True",
1735
"debuglevel": "",
1157
1736
}
1158
1737
1159
1738
# Parse config file for server-global settings
1160
server_config = ConfigParser.SafeConfigParser(server_defaults)
1739
server_config = configparser.SafeConfigParser(server_defaults)
1161
1740
del server_defaults
1162
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1741
server_config.read(os.path.join(options.configdir,
1742
"mandos.conf"))
1163
1743
# Convert the SafeConfigParser object to a dict
1164
1744
server_settings = server_config.defaults()
1165
1745
# Use the appropriate methods on the non-string config options
1166
server_settings["debug"] = server_config.getboolean("DEFAULT",
1167
"debug")
1168
server_settings["use_dbus"] = server_config.getboolean("DEFAULT",
1169
"use_dbus")
1170
server_settings["use_ipv6"] = server_config.getboolean("DEFAULT",
1171
"use_ipv6")
1746
for option in ("debug", "use_dbus", "use_ipv6"):
1747
server_settings[option] = server_config.getboolean("DEFAULT",
1748
option)
1172
1749
if server_settings["port"]:
1173
1750
server_settings["port"] = server_config.getint("DEFAULT",
1174
1751
"port")
1178
1755
# options, if set.
1179
1756
for option in ("interface", "address", "port", "debug",
1180
1757
"priority", "servicename", "configdir",
1181
"use_dbus", "use_ipv6"):
1758
"use_dbus", "use_ipv6", "debuglevel"):
1182
1759
value = getattr(options, option)
1183
1760
if value is not None:
1184
1761
server_settings[option] = value
1185
1762
del options
1763
# Force all strings to be unicode
1764
for option in server_settings.keys():
1765
if type(server_settings[option]) is str:
1766
server_settings[option] = unicode(server_settings[option])
1186
1767
# Now we have our good server settings in "server_settings"
1187
1768
1188
1769
##################################################################
1189
1770
1190
1771
# For convenience
1191
1772
debug = server_settings["debug"]
1773
debuglevel = server_settings["debuglevel"]
1192
1774
use_dbus = server_settings["use_dbus"]
1193
1775
use_ipv6 = server_settings["use_ipv6"]
1194
1195
if not debug:
1196
syslogger.setLevel(logging.WARNING)
1197
console.setLevel(logging.WARNING)
1198
1776
1199
1777
if server_settings["servicename"] != "Mandos":
1200
1778
syslogger.setFormatter(logging.Formatter
1201
1779
('Mandos (%s) [%%(process)d]:'
1203
1781
% server_settings["servicename"]))
1204
1782
1205
1783
# Parse config file with clients
1206
client_defaults = { "timeout": "1h",
1207
"interval": "5m",
1784
client_defaults = { "timeout": "5m",
1785
"extended_timeout": "15m",
1786
"interval": "2m",
1208
1787
"checker": "fping -q -- %%(host)s",
1209
1788
"host": "",
1789
"approval_delay": "0s",
1790
"approval_duration": "1s",
1210
1791
}
1211
client_config = ConfigParser.SafeConfigParser(client_defaults)
1792
client_config = configparser.SafeConfigParser(client_defaults)
1212
1793
client_config.read(os.path.join(server_settings["configdir"],
1213
1794
"clients.conf"))
1214
1795
1215
1796
global mandos_dbus_service
1216
1797
mandos_dbus_service = None
1217
1798
1218
clients = Set()
1219
tcp_server = IPv6_TCPServer((server_settings["address"],
1220
server_settings["port"]),
1221
ClientHandler,
1222
interface=
1223
server_settings["interface"],
1224
use_ipv6=use_ipv6,
1225
clients=clients,
1226
gnutls_priority=
1227
server_settings["priority"],
1228
use_dbus=use_dbus)
1229
pidfilename = "/var/run/mandos.pid"
1230
try:
1231
pidfile = open(pidfilename, "w")
1232
except IOError:
1233
logger.error("Could not open file %r", pidfilename)
1799
tcp_server = MandosServer((server_settings["address"],
1800
server_settings["port"]),
1801
ClientHandler,
1802
interface=(server_settings["interface"]
1803
or None),
1804
use_ipv6=use_ipv6,
1805
gnutls_priority=
1806
server_settings["priority"],
1807
use_dbus=use_dbus)
1808
if not debug:
1809
pidfilename = "/var/run/mandos.pid"
1810
try:
1811
pidfile = open(pidfilename, "w")
1812
except IOError:
1813
logger.error("Could not open file %r", pidfilename)
1234
1814
1235
1815
try:
1236
1816
uid = pwd.getpwnam("_mandos").pw_uid
1242
1822
except KeyError:
1243
1823
try:
1244
1824
uid = pwd.getpwnam("nobody").pw_uid
1245
gid = pwd.getpwnam("nogroup").pw_gid
1825
gid = pwd.getpwnam("nobody").pw_gid
1246
1826
except KeyError:
1247
1827
uid = 65534
1248
1828
gid = 65534
1249
1829
try:
1250
1830
os.setgid(gid)
1251
1831
os.setuid(uid)
1252
except OSError, error:
1832
except OSError as error:
1253
1833
if error[0] != errno.EPERM:
1254
1834
raise error
1255
1835
1256
# 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
1257
1844
if debug:
1845
# Enable all possible GnuTLS debugging
1846
1258
1847
# "Use a log level over 10 to enable all debugging options."
1259
1848
# - GnuTLS manual
1260
1849
gnutls.library.functions.gnutls_global_set_log_level(11)
1265
1854
1266
1855
(gnutls.library.functions
1267
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)
1268
1866
1269
global service
1270
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1271
service = AvahiService(name = server_settings["servicename"],
1272
servicetype = "_mandos._tcp",
1273
protocol = protocol)
1274
if server_settings["interface"]:
1275
service.interface = (if_nametoindex
1276
(server_settings["interface"]))
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()
1277
1871
1278
1872
global main_loop
1279
global bus
1280
global server
1281
1873
# From the Avahi example code
1282
1874
DBusGMainLoop(set_as_default=True )
1283
1875
main_loop = gobject.MainLoop()
1284
1876
bus = dbus.SystemBus()
1285
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1286
avahi.DBUS_PATH_SERVER),
1287
avahi.DBUS_INTERFACE_SERVER)
1288
1877
# End of Avahi example code
1289
1878
if use_dbus:
1290
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
1887
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1888
service = AvahiService(name = server_settings["servicename"],
1889
servicetype = "_mandos._tcp",
1890
protocol = protocol, bus = bus)
1891
if server_settings["interface"]:
1892
service.interface = (if_nametoindex
1893
(str(server_settings["interface"])))
1894
1895
global multiprocessing_manager
1896
multiprocessing_manager = multiprocessing.Manager()
1291
1897
1292
1898
client_class = Client
1293
1899
if use_dbus:
1294
client_class = ClientDBus
1295
clients.update(Set(
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
1913
tcp_server.clients.update(set(
1296
1914
client_class(name = section,
1297
config= dict(client_config.items(section)))
1915
config= dict(client_config_items(
1916
client_config, section)))
1298
1917
for section in client_config.sections()))
1299
if not clients:
1300
logger.warning(u"No clients defined")
1301
1302
if debug:
1303
# Redirect stdin so all checkers get /dev/null
1304
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1305
os.dup2(null, sys.stdin.fileno())
1306
if null > 2:
1307
os.close(null)
1308
else:
1309
# No console logging
1310
logger.removeHandler(console)
1311
# Close all input and output, do double fork, etc.
1312
daemon()
1313
1314
try:
1315
with closing(pidfile):
1316
pid = os.getpid()
1317
pidfile.write(str(pid) + "\n")
1318
del pidfile
1319
except IOError:
1320
logger.error(u"Could not write to file %r with PID %d",
1321
pidfilename, pid)
1322
except NameError:
1323
# "pidfile" was never created
1324
pass
1325
del pidfilename
1326
1327
def cleanup():
1328
"Cleanup function; run on exit"
1329
global group
1330
# From the Avahi example code
1331
if not group is None:
1332
group.Free()
1333
group = None
1334
# End of Avahi example code
1918
if not tcp_server.clients:
1919
logger.warning("No clients defined")
1335
1920
1336
while clients:
1337
client = clients.pop()
1338
client.disable_hook = None
1339
client.disable()
1340
1341
atexit.register(cleanup)
1342
1343
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
1344
1935
signal.signal(signal.SIGINT, signal.SIG_IGN)
1936
1345
1937
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1346
1938
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1347
1939
1350
1942
"""A D-Bus proxy object"""
1351
1943
def __init__(self):
1352
1944
dbus.service.Object.__init__(self, bus, "/")
1353
_interface = u"se.bsnet.fukt.Mandos"
1945
_interface = "se.bsnet.fukt.Mandos"
1354
1946
1355
@dbus.service.signal(_interface, signature="oa{sv}")
1356
def ClientAdded(self, objpath, properties):
1947
@dbus.service.signal(_interface, signature="o")
1948
def ClientAdded(self, objpath):
1357
1949
"D-Bus signal"
1358
1950
pass
1359
1951
1360
@dbus.service.signal(_interface, signature="s")
1361
def ClientNotFound(self, fingerprint):
1952
@dbus.service.signal(_interface, signature="ss")
1953
def ClientNotFound(self, fingerprint, address):
1362
1954
"D-Bus signal"
1363
1955
pass
1364
1956
1370
1962
@dbus.service.method(_interface, out_signature="ao")
1371
1963
def GetAllClients(self):
1372
1964
"D-Bus method"
1373
return dbus.Array(c.dbus_object_path for c in clients)
1965
return dbus.Array(c.dbus_object_path
1966
for c in tcp_server.clients)
1374
1967
1375
@dbus.service.method(_interface, out_signature="a{oa{sv}}")
1968
@dbus.service.method(_interface,
1969
out_signature="a{oa{sv}}")
1376
1970
def GetAllClientsWithProperties(self):
1377
1971
"D-Bus method"
1378
1972
return dbus.Dictionary(
1379
((c.dbus_object_path, c.GetAllProperties())
1380
for c in clients),
1973
((c.dbus_object_path, c.GetAll(""))
1974
for c in tcp_server.clients),
1381
1975
signature="oa{sv}")
1382
1976
1383
1977
@dbus.service.method(_interface, in_signature="o")
1384
1978
def RemoveClient(self, object_path):
1385
1979
"D-Bus method"
1386
for c in clients:
1980
for c in tcp_server.clients:
1387
1981
if c.dbus_object_path == object_path:
1388
clients.remove(c)
1982
tcp_server.clients.remove(c)
1389
1983
c.remove_from_connection()
1390
1984
# Don't signal anything except ClientRemoved
1391
c.disable(signal=False)
1985
c.disable(quiet=True)
1392
1986
# Emit D-Bus signal
1393
1987
self.ClientRemoved(object_path, c.name)
1394
1988
return
1395
raise KeyError
1989
raise KeyError(object_path)
1396
1990
1397
1991
del _interface
1398
1992
1399
1993
mandos_dbus_service = MandosDBusService()
1400
1994
1401
for client in clients:
1995
def cleanup():
1996
"Cleanup function; run on exit"
1997
service.cleanup()
1998
1999
while tcp_server.clients:
2000
client = tcp_server.clients.pop()
2001
if use_dbus:
2002
client.remove_from_connection()
2003
client.disable_hook = None
2004
# Don't signal anything except ClientRemoved
2005
client.disable(quiet=True)
2006
if use_dbus:
2007
# Emit D-Bus signal
2008
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2009
client.name)
2010
2011
atexit.register(cleanup)
2012
2013
for client in tcp_server.clients:
1402
2014
if use_dbus:
1403
2015
# Emit D-Bus signal
1404
mandos_dbus_service.ClientAdded(client.dbus_object_path,
1405
client.GetAllProperties())
2016
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1406
2017
client.enable()
1407
2018
1408
2019
tcp_server.enable()
1411
2022
# Find out what port we got
1412
2023
service.port = tcp_server.socket.getsockname()[1]
1413
2024
if use_ipv6:
1414
logger.info(u"Now listening on address %r, port %d,"
2025
logger.info("Now listening on address %r, port %d,"
1415
2026
" flowinfo %d, scope_id %d"
1416
2027
% tcp_server.socket.getsockname())
1417
2028
else: # IPv4
1418
logger.info(u"Now listening on address %r, port %d"
2029
logger.info("Now listening on address %r, port %d"
1419
2030
% tcp_server.socket.getsockname())
1420
2031
1421
2032
#service.interface = tcp_server.socket.getsockname()[3]
1422
2033
1423
2034
try:
1424
2035
# From the Avahi example code
1425
server.connect_to_signal("StateChanged", server_state_changed)
1426
2036
try:
1427
server_state_changed(server.GetState())
1428
except dbus.exceptions.DBusException, error:
1429
logger.critical(u"DBusException: %s", error)
2037
service.activate()
2038
except dbus.exceptions.DBusException as error:
2039
logger.critical("DBusException: %s", error)
2040
cleanup()
1430
2041
sys.exit(1)
1431
2042
# End of Avahi example code
1432
2043
1435
2046
(tcp_server.handle_request
1436
2047
(*args[2:], **kwargs) or True))
1437
2048
1438
logger.debug(u"Starting main loop")
2049
logger.debug("Starting main loop")
1439
2050
main_loop.run()
1440
except AvahiError, error:
1441
logger.critical(u"AvahiError: %s", error)
2051
except AvahiError as error:
2052
logger.critical("AvahiError: %s", error)
2053
cleanup()
1442
2054
sys.exit(1)
1443
2055
except KeyboardInterrupt:
1444
2056
if debug:
1445
print >> sys.stderr
2057
print("", file=sys.stderr)
1446
2058
logger.debug("Server received KeyboardInterrupt")
1447
2059
logger.debug("Server exiting")
2060
# Must run before the D-Bus bus name gets deregistered
2061
cleanup()
1448
2062
1449
2063
if __name__ == '__main__':
1450
2064
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0