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 441
- compare with another revision
- download diff
- download tarball
- view history from revision 441
- Committer: Teddy Hogeborn
- Date: 2010-09-25 23:52:17 UTC
- Revision ID: teddy@fukt.bsnet.se-20100925235217-4hhqfryz1ste6uw3
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
to "_" in D-Bus object paths.
(MandosServer.handle_ipc): Bug fix: Send only address string to
D-Bus signal, not whole tuple.
* mandos-ctl: New options "--approve-by-default", "--deny-by-default",
"--approval-delay", and "--approval-duration".
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new options.
* mandos-monitor (MandosClientWidget.update): Fix spelling.
to "_" in D-Bus object paths.
(MandosServer.handle_ipc): Bug fix: Send only address string to
D-Bus signal, not whole tuple.
* mandos-ctl: New options "--approve-by-default", "--deny-by-default",
"--approval-delay", and "--approval-duration".
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new options.
* mandos-monitor (MandosClientWidget.update): Fix spelling.
- files removed:
- debian/source
- network-hooks.d
- 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-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 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
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
#
31
# Contact the authors at <mandos@recompile.se>.
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
62
61
import functools
63
62
import cPickle as pickle
64
63
import multiprocessing
65
import types
66
import binascii
67
import tempfile
68
import itertools
69
64
70
65
import dbus
71
66
import dbus.service
76
71
import ctypes.util
77
72
import xml.dom.minidom
78
73
import inspect
79
import GnuPGInterface
80
74
81
75
try:
82
76
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
86
80
except ImportError:
87
81
SO_BINDTODEVICE = None
88
82
89
version = "1.5.3"
90
stored_state_file = "clients.pickle"
91
92
logger = logging.getLogger()
83
84
version = "1.0.14"
85
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
93
88
syslogger = (logging.handlers.SysLogHandler
94
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
96
97
try:
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
100
.if_nametoindex)
101
except (OSError, AttributeError):
102
def if_nametoindex(interface):
103
"Get an interface index the hard way, i.e. using fcntl()"
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
with contextlib.closing(socket.socket()) as s:
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
108
interface))
109
interface_index = struct.unpack(str("I"),
110
ifreq[16:20])[0]
111
return interface_index
112
113
114
def initlogger(debug, level=logging.WARNING):
115
"""init logger and add loglevel"""
116
117
syslogger.setFormatter(logging.Formatter
118
('Mandos [%(process)d]: %(levelname)s:'
119
' %(message)s'))
120
logger.addHandler(syslogger)
121
122
if debug:
123
console = logging.StreamHandler()
124
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
125
' [%(process)d]:'
126
' %(levelname)s:'
127
' %(message)s'))
128
logger.addHandler(console)
129
logger.setLevel(level)
130
131
132
class PGPError(Exception):
133
"""Exception if encryption/decryption fails"""
134
pass
135
136
137
class PGPEngine(object):
138
"""A simple class for OpenPGP symmetric encryption & decryption"""
139
def __init__(self):
140
self.gnupg = GnuPGInterface.GnuPG()
141
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
142
self.gnupg = GnuPGInterface.GnuPG()
143
self.gnupg.options.meta_interactive = False
144
self.gnupg.options.homedir = self.tempdir
145
self.gnupg.options.extra_args.extend(['--force-mdc',
146
'--quiet',
147
'--no-use-agent'])
148
149
def __enter__(self):
150
return self
151
152
def __exit__ (self, exc_type, exc_value, traceback):
153
self._cleanup()
154
return False
155
156
def __del__(self):
157
self._cleanup()
158
159
def _cleanup(self):
160
if self.tempdir is not None:
161
# Delete contents of tempdir
162
for root, dirs, files in os.walk(self.tempdir,
163
topdown = False):
164
for filename in files:
165
os.remove(os.path.join(root, filename))
166
for dirname in dirs:
167
os.rmdir(os.path.join(root, dirname))
168
# Remove tempdir
169
os.rmdir(self.tempdir)
170
self.tempdir = None
171
172
def password_encode(self, password):
173
# Passphrase can not be empty and can not contain newlines or
174
# NUL bytes. So we prefix it and hex encode it.
175
return b"mandos" + binascii.hexlify(password)
176
177
def encrypt(self, data, password):
178
self.gnupg.passphrase = self.password_encode(password)
179
with open(os.devnull, "w") as devnull:
180
try:
181
proc = self.gnupg.run(['--symmetric'],
182
create_fhs=['stdin', 'stdout'],
183
attach_fhs={'stderr': devnull})
184
with contextlib.closing(proc.handles['stdin']) as f:
185
f.write(data)
186
with contextlib.closing(proc.handles['stdout']) as f:
187
ciphertext = f.read()
188
proc.wait()
189
except IOError as e:
190
raise PGPError(e)
191
self.gnupg.passphrase = None
192
return ciphertext
193
194
def decrypt(self, data, password):
195
self.gnupg.passphrase = self.password_encode(password)
196
with open(os.devnull, "w") as devnull:
197
try:
198
proc = self.gnupg.run(['--decrypt'],
199
create_fhs=['stdin', 'stdout'],
200
attach_fhs={'stderr': devnull})
201
with contextlib.closing(proc.handles['stdin']) as f:
202
f.write(data)
203
with contextlib.closing(proc.handles['stdout']) as f:
204
decrypted_plaintext = f.read()
205
proc.wait()
206
except IOError as e:
207
raise PGPError(e)
208
self.gnupg.passphrase = None
209
return decrypted_plaintext
210
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
93
u' %(message)s'))
94
logger.addHandler(syslogger)
95
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
u' %(levelname)s:'
99
u' %(message)s'))
100
logger.addHandler(console)
211
101
212
102
class AvahiError(Exception):
213
103
def __init__(self, value, *args, **kwargs):
229
119
Attributes:
230
120
interface: integer; avahi.IF_UNSPEC or an interface index.
231
121
Used to optionally bind to the specified interface.
232
name: string; Example: 'Mandos'
233
type: string; Example: '_mandos._tcp'.
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
234
124
See <http://www.dns-sd.org/ServiceTypes.html>
235
125
port: integer; what port to announce
236
126
TXT: list of strings; TXT record for the service
243
133
server: D-Bus Server
244
134
bus: dbus.SystemBus()
245
135
"""
246
247
136
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
248
137
servicetype = None, port = None, TXT = None,
249
domain = "", host = "", max_renames = 32768,
138
domain = u"", host = u"", max_renames = 32768,
250
139
protocol = avahi.PROTO_UNSPEC, bus = None):
251
140
self.interface = interface
252
141
self.name = name
261
150
self.group = None # our entry group
262
151
self.server = None
263
152
self.bus = bus
264
self.entry_group_state_changed_match = None
265
266
153
def rename(self):
267
154
"""Derived from the Avahi example code"""
268
155
if self.rename_count >= self.max_renames:
269
logger.critical("No suitable Zeroconf service name found"
270
" after %i retries, exiting.",
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
271
158
self.rename_count)
272
raise AvahiServiceError("Too many renames")
273
self.name = unicode(self.server
274
.GetAlternativeServiceName(self.name))
275
logger.info("Changing Zeroconf service name to %r ...",
159
raise AvahiServiceError(u"Too many renames")
160
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
161
logger.info(u"Changing Zeroconf service name to %r ...",
276
162
self.name)
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
166
% self.name))
277
167
self.remove()
278
168
try:
279
169
self.add()
280
except dbus.exceptions.DBusException as error:
281
logger.critical("D-Bus Exception", exc_info=error)
170
except dbus.exceptions.DBusException, error:
171
logger.critical(u"DBusException: %s", error)
282
172
self.cleanup()
283
173
os._exit(1)
284
174
self.rename_count += 1
285
286
175
def remove(self):
287
176
"""Derived from the Avahi example code"""
288
if self.entry_group_state_changed_match is not None:
289
self.entry_group_state_changed_match.remove()
290
self.entry_group_state_changed_match = None
291
177
if self.group is not None:
292
178
self.group.Reset()
293
294
179
def add(self):
295
180
"""Derived from the Avahi example code"""
296
self.remove()
297
181
if self.group is None:
298
182
self.group = dbus.Interface(
299
183
self.bus.get_object(avahi.DBUS_NAME,
300
184
self.server.EntryGroupNew()),
301
185
avahi.DBUS_INTERFACE_ENTRY_GROUP)
302
self.entry_group_state_changed_match = (
303
self.group.connect_to_signal(
304
'StateChanged', self.entry_group_state_changed))
305
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
186
self.group.connect_to_signal('StateChanged',
187
self
188
.entry_group_state_changed)
189
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
306
190
self.name, self.type)
307
191
self.group.AddService(
308
192
self.interface,
313
197
dbus.UInt16(self.port),
314
198
avahi.string_array_to_txt_array(self.TXT))
315
199
self.group.Commit()
316
317
200
def entry_group_state_changed(self, state, error):
318
201
"""Derived from the Avahi example code"""
319
logger.debug("Avahi entry group state change: %i", state)
202
logger.debug(u"Avahi entry group state change: %i", state)
320
203
321
204
if state == avahi.ENTRY_GROUP_ESTABLISHED:
322
logger.debug("Zeroconf service established.")
205
logger.debug(u"Zeroconf service established.")
323
206
elif state == avahi.ENTRY_GROUP_COLLISION:
324
logger.info("Zeroconf service name collision.")
207
logger.warning(u"Zeroconf service name collision.")
325
208
self.rename()
326
209
elif state == avahi.ENTRY_GROUP_FAILURE:
327
logger.critical("Avahi: Error in group state changed %s",
210
logger.critical(u"Avahi: Error in group state changed %s",
328
211
unicode(error))
329
raise AvahiGroupError("State changed: {0!s}"
330
.format(error))
331
212
raise AvahiGroupError(u"State changed: %s"
213
% unicode(error))
332
214
def cleanup(self):
333
215
"""Derived from the Avahi example code"""
334
216
if self.group is not None:
335
try:
336
self.group.Free()
337
except (dbus.exceptions.UnknownMethodException,
338
dbus.exceptions.DBusException):
339
pass
217
self.group.Free()
340
218
self.group = None
341
self.remove()
342
343
def server_state_changed(self, state, error=None):
219
def server_state_changed(self, state):
344
220
"""Derived from the Avahi example code"""
345
logger.debug("Avahi server state change: %i", state)
346
bad_states = { avahi.SERVER_INVALID:
347
"Zeroconf server invalid",
348
avahi.SERVER_REGISTERING: None,
349
avahi.SERVER_COLLISION:
350
"Zeroconf server name collision",
351
avahi.SERVER_FAILURE:
352
"Zeroconf server failure" }
353
if state in bad_states:
354
if bad_states[state] is not None:
355
if error is None:
356
logger.error(bad_states[state])
357
else:
358
logger.error(bad_states[state] + ": %r", error)
359
self.cleanup()
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
224
self.remove()
360
225
elif state == avahi.SERVER_RUNNING:
361
226
self.add()
362
else:
363
if error is None:
364
logger.debug("Unknown state: %r", state)
365
else:
366
logger.debug("Unknown state: %r: %r", state, error)
367
368
227
def activate(self):
369
228
"""Derived from the Avahi example code"""
370
229
if self.server is None:
371
230
self.server = dbus.Interface(
372
231
self.bus.get_object(avahi.DBUS_NAME,
373
avahi.DBUS_PATH_SERVER,
374
follow_name_owner_changes=True),
232
avahi.DBUS_PATH_SERVER),
375
233
avahi.DBUS_INTERFACE_SERVER)
376
self.server.connect_to_signal("StateChanged",
234
self.server.connect_to_signal(u"StateChanged",
377
235
self.server_state_changed)
378
236
self.server_state_changed(self.server.GetState())
379
237
380
class AvahiServiceToSyslog(AvahiService):
381
def rename(self):
382
"""Add the new name to the syslog messages"""
383
ret = AvahiService.rename(self)
384
syslogger.setFormatter(logging.Formatter
385
('Mandos ({0}) [%(process)d]:'
386
' %(levelname)s: %(message)s'
387
.format(self.name)))
388
return ret
389
390
def timedelta_to_milliseconds(td):
391
"Convert a datetime.timedelta() to milliseconds"
392
return ((td.days * 24 * 60 * 60 * 1000)
393
+ (td.seconds * 1000)
394
+ (td.microseconds // 1000))
395
238
396
239
class Client(object):
397
240
"""A representation of a client host served by this server.
398
241
399
242
Attributes:
400
approved: bool(); 'None' if not yet approved/disapproved
243
_approved: bool(); 'None' if not yet approved/disapproved
401
244
approval_delay: datetime.timedelta(); Time to wait for approval
402
245
approval_duration: datetime.timedelta(); Duration of one approval
403
246
checker: subprocess.Popen(); a running checker process used
404
247
to see if the client lives.
405
248
'None' if no process is running.
406
checker_callback_tag: a gobject event source tag, or None
249
checker_callback_tag: - '' -
407
250
checker_command: string; External command which is run to check
408
251
if client lives. %() expansions are done at
409
252
runtime with vars(self) as dict, so that for
410
253
instance %(name)s can be used in the command.
411
254
checker_initiator_tag: a gobject event source tag, or None
412
255
created: datetime.datetime(); (UTC) object creation
413
client_structure: Object describing what attributes a client has
414
and is used for storing the client at exit
415
256
current_checker_command: string; current running checker_command
416
disable_initiator_tag: a gobject event source tag, or None
257
disable_hook: If set, called by disable() as disable_hook(self)
258
disable_initiator_tag: - '' -
417
259
enabled: bool()
418
260
fingerprint: string (40 or 32 hexadecimal digits); used to
419
261
uniquely identify the client
420
262
host: string; available for use by the checker command
421
263
interval: datetime.timedelta(); How often to start a new checker
422
last_approval_request: datetime.datetime(); (UTC) or None
423
264
last_checked_ok: datetime.datetime(); (UTC) or None
424
last_checker_status: integer between 0 and 255 reflecting exit
425
status of last checker. -1 reflects crashed
426
checker, -2 means no checker completed yet.
427
last_enabled: datetime.datetime(); (UTC) or None
265
last_enabled: datetime.datetime(); (UTC)
428
266
name: string; from the config file, used in log messages and
429
267
D-Bus identifiers
430
268
secret: bytestring; sent verbatim (over TLS) to client
431
269
timeout: datetime.timedelta(); How long from last_checked_ok
432
270
until this client is disabled
433
extended_timeout: extra long timeout when secret has been sent
434
271
runtime_expansions: Allowed attributes for runtime expansion.
435
expires: datetime.datetime(); time (UTC) when a client will be
436
disabled, or None
437
272
"""
438
273
439
runtime_expansions = ("approval_delay", "approval_duration",
440
"created", "enabled", "fingerprint",
441
"host", "interval", "last_checked_ok",
442
"last_enabled", "name", "timeout")
443
client_defaults = { "timeout": "5m",
444
"extended_timeout": "15m",
445
"interval": "2m",
446
"checker": "fping -q -- %%(host)s",
447
"host": "",
448
"approval_delay": "0s",
449
"approval_duration": "1s",
450
"approved_by_default": "True",
451
"enabled": "True",
452
}
274
runtime_expansions = (u"approval_delay", u"approval_duration",
275
u"created", u"enabled", u"fingerprint",
276
u"host", u"interval", u"last_checked_ok",
277
u"last_enabled", u"name", u"timeout")
278
279
@staticmethod
280
def _timedelta_to_milliseconds(td):
281
"Convert a datetime.timedelta() to milliseconds"
282
return ((td.days * 24 * 60 * 60 * 1000)
283
+ (td.seconds * 1000)
284
+ (td.microseconds // 1000))
453
285
454
286
def timeout_milliseconds(self):
455
287
"Return the 'timeout' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.timeout)
457
458
def extended_timeout_milliseconds(self):
459
"Return the 'extended_timeout' attribute in milliseconds"
460
return timedelta_to_milliseconds(self.extended_timeout)
288
return self._timedelta_to_milliseconds(self.timeout)
461
289
462
290
def interval_milliseconds(self):
463
291
"Return the 'interval' attribute in milliseconds"
464
return timedelta_to_milliseconds(self.interval)
465
292
return self._timedelta_to_milliseconds(self.interval)
293
466
294
def approval_delay_milliseconds(self):
467
return timedelta_to_milliseconds(self.approval_delay)
468
469
@staticmethod
470
def config_parser(config):
471
"""Construct a new dict of client settings of this form:
472
{ client_name: {setting_name: value, ...}, ...}
473
with exceptions for any special settings as defined above.
474
NOTE: Must be a pure function. Must return the same result
475
value given the same arguments.
476
"""
477
settings = {}
478
for client_name in config.sections():
479
section = dict(config.items(client_name))
480
client = settings[client_name] = {}
481
482
client["host"] = section["host"]
483
# Reformat values from string types to Python types
484
client["approved_by_default"] = config.getboolean(
485
client_name, "approved_by_default")
486
client["enabled"] = config.getboolean(client_name,
487
"enabled")
488
489
client["fingerprint"] = (section["fingerprint"].upper()
490
.replace(" ", ""))
491
if "secret" in section:
492
client["secret"] = section["secret"].decode("base64")
493
elif "secfile" in section:
494
with open(os.path.expanduser(os.path.expandvars
495
(section["secfile"])),
496
"rb") as secfile:
497
client["secret"] = secfile.read()
498
else:
499
raise TypeError("No secret or secfile for section {0}"
500
.format(section))
501
client["timeout"] = string_to_delta(section["timeout"])
502
client["extended_timeout"] = string_to_delta(
503
section["extended_timeout"])
504
client["interval"] = string_to_delta(section["interval"])
505
client["approval_delay"] = string_to_delta(
506
section["approval_delay"])
507
client["approval_duration"] = string_to_delta(
508
section["approval_duration"])
509
client["checker_command"] = section["checker"]
510
client["last_approval_request"] = None
511
client["last_checked_ok"] = None
512
client["last_checker_status"] = -2
513
514
return settings
515
516
def __init__(self, settings, name = None):
295
return self._timedelta_to_milliseconds(self.approval_delay)
296
297
def __init__(self, name = None, disable_hook=None, config=None):
298
"""Note: the 'checker' key in 'config' sets the
299
'checker_command' attribute and *not* the 'checker'
300
attribute."""
517
301
self.name = name
518
# adding all client settings
519
for setting, value in settings.iteritems():
520
setattr(self, setting, value)
521
522
if self.enabled:
523
if not hasattr(self, "last_enabled"):
524
self.last_enabled = datetime.datetime.utcnow()
525
if not hasattr(self, "expires"):
526
self.expires = (datetime.datetime.utcnow()
527
+ self.timeout)
528
else:
529
self.last_enabled = None
530
self.expires = None
531
532
logger.debug("Creating client %r", self.name)
302
if config is None:
303
config = {}
304
logger.debug(u"Creating client %r", self.name)
533
305
# Uppercase and remove spaces from fingerprint for later
534
306
# comparison purposes with return value from the fingerprint()
535
307
# function
536
logger.debug(" Fingerprint: %s", self.fingerprint)
537
self.created = settings.get("created",
538
datetime.datetime.utcnow())
539
540
# attributes specific for this server instance
308
self.fingerprint = (config[u"fingerprint"].upper()
309
.replace(u" ", u""))
310
logger.debug(u" Fingerprint: %s", self.fingerprint)
311
if u"secret" in config:
312
self.secret = config[u"secret"].decode(u"base64")
313
elif u"secfile" in config:
314
with open(os.path.expanduser(os.path.expandvars
315
(config[u"secfile"])),
316
"rb") as secfile:
317
self.secret = secfile.read()
318
else:
319
raise TypeError(u"No secret or secfile for client %s"
320
% self.name)
321
self.host = config.get(u"host", u"")
322
self.created = datetime.datetime.utcnow()
323
self.enabled = False
324
self.last_enabled = None
325
self.last_checked_ok = None
326
self.timeout = string_to_delta(config[u"timeout"])
327
self.interval = string_to_delta(config[u"interval"])
328
self.disable_hook = disable_hook
541
329
self.checker = None
542
330
self.checker_initiator_tag = None
543
331
self.disable_initiator_tag = None
544
332
self.checker_callback_tag = None
333
self.checker_command = config[u"checker"]
545
334
self.current_checker_command = None
546
self.approved = None
335
self.last_connect = None
336
self._approved = None
337
self.approved_by_default = config.get(u"approved_by_default",
338
True)
547
339
self.approvals_pending = 0
548
self.changedstate = (multiprocessing_manager
549
.Condition(multiprocessing_manager
550
.Lock()))
551
self.client_structure = [attr for attr in
552
self.__dict__.iterkeys()
553
if not attr.startswith("_")]
554
self.client_structure.append("client_structure")
555
556
for name, t in inspect.getmembers(type(self),
557
lambda obj:
558
isinstance(obj,
559
property)):
560
if not name.startswith("_"):
561
self.client_structure.append(name)
340
self.approval_delay = string_to_delta(
341
config[u"approval_delay"])
342
self.approval_duration = string_to_delta(
343
config[u"approval_duration"])
344
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
562
345
563
# Send notice to process children that client state has changed
564
346
def send_changedstate(self):
565
with self.changedstate:
566
self.changedstate.notify_all()
567
347
self.changedstate.acquire()
348
self.changedstate.notify_all()
349
self.changedstate.release()
350
568
351
def enable(self):
569
352
"""Start this client's checker and timeout hooks"""
570
if getattr(self, "enabled", False):
353
if getattr(self, u"enabled", False):
571
354
# Already enabled
572
355
return
573
356
self.send_changedstate()
574
self.expires = datetime.datetime.utcnow() + self.timeout
575
self.enabled = True
576
357
self.last_enabled = datetime.datetime.utcnow()
577
self.init_checker()
578
579
def disable(self, quiet=True):
580
"""Disable this client."""
581
if not getattr(self, "enabled", False):
582
return False
583
if not quiet:
584
self.send_changedstate()
585
if not quiet:
586
logger.info("Disabling client %s", self.name)
587
if getattr(self, "disable_initiator_tag", False):
588
gobject.source_remove(self.disable_initiator_tag)
589
self.disable_initiator_tag = None
590
self.expires = None
591
if getattr(self, "checker_initiator_tag", False):
592
gobject.source_remove(self.checker_initiator_tag)
593
self.checker_initiator_tag = None
594
self.stop_checker()
595
self.enabled = False
596
# Do not run this again if called by a gobject.timeout_add
597
return False
598
599
def __del__(self):
600
self.disable()
601
602
def init_checker(self):
603
358
# Schedule a new checker to be started an 'interval' from now,
604
359
# and every interval from then on.
605
360
self.checker_initiator_tag = (gobject.timeout_add
609
364
self.disable_initiator_tag = (gobject.timeout_add
610
365
(self.timeout_milliseconds(),
611
366
self.disable))
367
self.enabled = True
612
368
# Also start a new checker *right now*.
613
369
self.start_checker()
614
370
371
def disable(self, quiet=True):
372
"""Disable this client."""
373
if not getattr(self, "enabled", False):
374
return False
375
if not quiet:
376
self.send_changedstate()
377
if not quiet:
378
logger.info(u"Disabling client %s", self.name)
379
if getattr(self, u"disable_initiator_tag", False):
380
gobject.source_remove(self.disable_initiator_tag)
381
self.disable_initiator_tag = None
382
if getattr(self, u"checker_initiator_tag", False):
383
gobject.source_remove(self.checker_initiator_tag)
384
self.checker_initiator_tag = None
385
self.stop_checker()
386
if self.disable_hook:
387
self.disable_hook(self)
388
self.enabled = False
389
# Do not run this again if called by a gobject.timeout_add
390
return False
391
392
def __del__(self):
393
self.disable_hook = None
394
self.disable()
395
615
396
def checker_callback(self, pid, condition, command):
616
397
"""The checker has completed, so take appropriate actions."""
617
398
self.checker_callback_tag = None
618
399
self.checker = None
619
400
if os.WIFEXITED(condition):
620
self.last_checker_status = os.WEXITSTATUS(condition)
621
if self.last_checker_status == 0:
622
logger.info("Checker for %(name)s succeeded",
401
exitstatus = os.WEXITSTATUS(condition)
402
if exitstatus == 0:
403
logger.info(u"Checker for %(name)s succeeded",
623
404
vars(self))
624
405
self.checked_ok()
625
406
else:
626
logger.info("Checker for %(name)s failed",
407
logger.info(u"Checker for %(name)s failed",
627
408
vars(self))
628
409
else:
629
self.last_checker_status = -1
630
logger.warning("Checker for %(name)s crashed?",
410
logger.warning(u"Checker for %(name)s crashed?",
631
411
vars(self))
632
412
633
413
def checked_ok(self):
634
"""Assert that the client has been seen, alive and well."""
414
"""Bump up the timeout for this client.
415
416
This should only be called when the client has been seen,
417
alive and well.
418
"""
635
419
self.last_checked_ok = datetime.datetime.utcnow()
636
self.last_checker_status = 0
637
self.bump_timeout()
638
639
def bump_timeout(self, timeout=None):
640
"""Bump up the timeout for this client."""
641
if timeout is None:
642
timeout = self.timeout
643
if self.disable_initiator_tag is not None:
644
gobject.source_remove(self.disable_initiator_tag)
645
if getattr(self, "enabled", False):
646
self.disable_initiator_tag = (gobject.timeout_add
647
(timedelta_to_milliseconds
648
(timeout), self.disable))
649
self.expires = datetime.datetime.utcnow() + timeout
650
651
def need_approval(self):
652
self.last_approval_request = datetime.datetime.utcnow()
420
gobject.source_remove(self.disable_initiator_tag)
421
self.disable_initiator_tag = (gobject.timeout_add
422
(self.timeout_milliseconds(),
423
self.disable))
653
424
654
425
def start_checker(self):
655
426
"""Start a new checker subprocess if one is not running.
668
439
# If a checker exists, make sure it is not a zombie
669
440
try:
670
441
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
671
except (AttributeError, OSError) as error:
442
except (AttributeError, OSError), error:
672
443
if (isinstance(error, OSError)
673
444
and error.errno != errno.ECHILD):
674
445
raise error
675
446
else:
676
447
if pid:
677
logger.warning("Checker was a zombie")
448
logger.warning(u"Checker was a zombie")
678
449
gobject.source_remove(self.checker_callback_tag)
679
450
self.checker_callback(pid, status,
680
451
self.current_checker_command)
687
458
# Escape attributes for the shell
688
459
escaped_attrs = dict(
689
460
(attr,
690
re.escape(unicode(str(getattr(self, attr, "")),
461
re.escape(unicode(str(getattr(self, attr, u"")),
691
462
errors=
692
'replace')))
463
u'replace')))
693
464
for attr in
694
465
self.runtime_expansions)
695
466
696
467
try:
697
468
command = self.checker_command % escaped_attrs
698
except TypeError as error:
699
logger.error('Could not format string "%s"',
700
self.checker_command, exc_info=error)
469
except TypeError, error:
470
logger.error(u'Could not format string "%s":'
471
u' %s', self.checker_command, error)
701
472
return True # Try again later
702
473
self.current_checker_command = command
703
474
try:
704
logger.info("Starting checker %r for %s",
475
logger.info(u"Starting checker %r for %s",
705
476
command, self.name)
706
477
# We don't need to redirect stdout and stderr, since
707
478
# in normal mode, that is already done by daemon(),
709
480
# always replaced by /dev/null.)
710
481
self.checker = subprocess.Popen(command,
711
482
close_fds=True,
712
shell=True, cwd="/")
483
shell=True, cwd=u"/")
713
484
self.checker_callback_tag = (gobject.child_watch_add
714
485
(self.checker.pid,
715
486
self.checker_callback,
720
491
if pid:
721
492
gobject.source_remove(self.checker_callback_tag)
722
493
self.checker_callback(pid, status, command)
723
except OSError as error:
724
logger.error("Failed to start subprocess",
725
exc_info=error)
494
except OSError, error:
495
logger.error(u"Failed to start subprocess: %s",
496
error)
726
497
# Re-run this periodically if run by gobject.timeout_add
727
498
return True
728
499
731
502
if self.checker_callback_tag:
732
503
gobject.source_remove(self.checker_callback_tag)
733
504
self.checker_callback_tag = None
734
if getattr(self, "checker", None) is None:
505
if getattr(self, u"checker", None) is None:
735
506
return
736
logger.debug("Stopping checker for %(name)s", vars(self))
507
logger.debug(u"Stopping checker for %(name)s", vars(self))
737
508
try:
738
self.checker.terminate()
509
os.kill(self.checker.pid, signal.SIGTERM)
739
510
#time.sleep(0.5)
740
511
#if self.checker.poll() is None:
741
# self.checker.kill()
742
except OSError as error:
512
# os.kill(self.checker.pid, signal.SIGKILL)
513
except OSError, error:
743
514
if error.errno != errno.ESRCH: # No such process
744
515
raise
745
516
self.checker = None
746
517
747
748
def dbus_service_property(dbus_interface, signature="v",
749
access="readwrite", byte_arrays=False):
518
def dbus_service_property(dbus_interface, signature=u"v",
519
access=u"readwrite", byte_arrays=False):
750
520
"""Decorators for marking methods of a DBusObjectWithProperties to
751
521
become properties on the D-Bus.
752
522
759
529
"""
760
530
# Encoding deeply encoded byte arrays is not supported yet by the
761
531
# "Set" method, so we fail early here:
762
if byte_arrays and signature != "ay":
763
raise ValueError("Byte arrays not supported for non-'ay'"
764
" signature {0!r}".format(signature))
532
if byte_arrays and signature != u"ay":
533
raise ValueError(u"Byte arrays not supported for non-'ay'"
534
u" signature %r" % signature)
765
535
def decorator(func):
766
536
func._dbus_is_property = True
767
537
func._dbus_interface = dbus_interface
768
538
func._dbus_signature = signature
769
539
func._dbus_access = access
770
540
func._dbus_name = func.__name__
771
if func._dbus_name.endswith("_dbus_property"):
541
if func._dbus_name.endswith(u"_dbus_property"):
772
542
func._dbus_name = func._dbus_name[:-14]
773
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
774
return func
775
return decorator
776
777
778
def dbus_interface_annotations(dbus_interface):
779
"""Decorator for marking functions returning interface annotations
780
781
Usage:
782
783
@dbus_interface_annotations("org.example.Interface")
784
def _foo(self): # Function name does not matter
785
return {"org.freedesktop.DBus.Deprecated": "true",
786
"org.freedesktop.DBus.Property.EmitsChangedSignal":
787
"false"}
788
"""
789
def decorator(func):
790
func._dbus_is_interface = True
791
func._dbus_interface = dbus_interface
792
func._dbus_name = dbus_interface
793
return func
794
return decorator
795
796
797
def dbus_annotations(annotations):
798
"""Decorator to annotate D-Bus methods, signals or properties
799
Usage:
800
801
@dbus_service_property("org.example.Interface", signature="b",
802
access="r")
803
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
804
"org.freedesktop.DBus.Property."
805
"EmitsChangedSignal": "false"})
806
def Property_dbus_property(self):
807
return dbus.Boolean(False)
808
"""
809
def decorator(func):
810
func._dbus_annotations = annotations
543
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
811
544
return func
812
545
return decorator
813
546
833
566
834
567
class DBusObjectWithProperties(dbus.service.Object):
835
568
"""A D-Bus object with properties.
836
569
837
570
Classes inheriting from this can use the dbus_service_property
838
571
decorator to expose methods as D-Bus properties. It exposes the
839
572
standard Get(), Set(), and GetAll() methods on the D-Bus.
840
573
"""
841
574
842
575
@staticmethod
843
def _is_dbus_thing(thing):
844
"""Returns a function testing if an attribute is a D-Bus thing
845
846
If called like _is_dbus_thing("method") it returns a function
847
suitable for use as predicate to inspect.getmembers().
848
"""
849
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
850
False)
576
def _is_dbus_property(obj):
577
return getattr(obj, u"_dbus_is_property", False)
851
578
852
def _get_all_dbus_things(self, thing):
579
def _get_all_dbus_properties(self):
853
580
"""Returns a generator of (name, attribute) pairs
854
581
"""
855
return ((getattr(athing.__get__(self), "_dbus_name",
856
name),
857
athing.__get__(self))
858
for cls in self.__class__.__mro__
859
for name, athing in
860
inspect.getmembers(cls,
861
self._is_dbus_thing(thing)))
582
return ((prop._dbus_name, prop)
583
for name, prop in
584
inspect.getmembers(self, self._is_dbus_property))
862
585
863
586
def _get_dbus_property(self, interface_name, property_name):
864
587
"""Returns a bound method if one exists which is a D-Bus
865
588
property with the specified name and interface.
866
589
"""
867
for cls in self.__class__.__mro__:
868
for name, value in (inspect.getmembers
869
(cls,
870
self._is_dbus_thing("property"))):
871
if (value._dbus_name == property_name
872
and value._dbus_interface == interface_name):
873
return value.__get__(self)
874
590
for name in (property_name,
591
property_name + u"_dbus_property"):
592
prop = getattr(self, name, None)
593
if (prop is None
594
or not self._is_dbus_property(prop)
595
or prop._dbus_name != property_name
596
or (interface_name and prop._dbus_interface
597
and interface_name != prop._dbus_interface)):
598
continue
599
return prop
875
600
# No such property
876
raise DBusPropertyNotFound(self.dbus_object_path + ":"
877
+ interface_name + "."
601
raise DBusPropertyNotFound(self.dbus_object_path + u":"
602
+ interface_name + u"."
878
603
+ property_name)
879
604
880
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
881
out_signature="v")
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
606
out_signature=u"v")
882
607
def Get(self, interface_name, property_name):
883
608
"""Standard D-Bus property Get() method, see D-Bus standard.
884
609
"""
885
610
prop = self._get_dbus_property(interface_name, property_name)
886
if prop._dbus_access == "write":
611
if prop._dbus_access == u"write":
887
612
raise DBusPropertyAccessException(property_name)
888
613
value = prop()
889
if not hasattr(value, "variant_level"):
614
if not hasattr(value, u"variant_level"):
890
615
return value
891
616
return type(value)(value, variant_level=value.variant_level+1)
892
617
893
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
618
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
894
619
def Set(self, interface_name, property_name, value):
895
620
"""Standard D-Bus property Set() method, see D-Bus standard.
896
621
"""
897
622
prop = self._get_dbus_property(interface_name, property_name)
898
if prop._dbus_access == "read":
623
if prop._dbus_access == u"read":
899
624
raise DBusPropertyAccessException(property_name)
900
if prop._dbus_get_args_options["byte_arrays"]:
625
if prop._dbus_get_args_options[u"byte_arrays"]:
901
626
# The byte_arrays option is not supported yet on
902
627
# signatures other than "ay".
903
if prop._dbus_signature != "ay":
628
if prop._dbus_signature != u"ay":
904
629
raise ValueError
905
value = dbus.ByteArray(b''.join(chr(byte)
906
for byte in value))
630
value = dbus.ByteArray(''.join(unichr(byte)
631
for byte in value))
907
632
prop(value)
908
633
909
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
910
out_signature="a{sv}")
634
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
635
out_signature=u"a{sv}")
911
636
def GetAll(self, interface_name):
912
637
"""Standard D-Bus property GetAll() method, see D-Bus
913
638
standard.
914
639
915
640
Note: Will not include properties with access="write".
916
641
"""
917
properties = {}
918
for name, prop in self._get_all_dbus_things("property"):
642
all = {}
643
for name, prop in self._get_all_dbus_properties():
919
644
if (interface_name
920
645
and interface_name != prop._dbus_interface):
921
646
# Interface non-empty but did not match
922
647
continue
923
648
# Ignore write-only properties
924
if prop._dbus_access == "write":
649
if prop._dbus_access == u"write":
925
650
continue
926
651
value = prop()
927
if not hasattr(value, "variant_level"):
928
properties[name] = value
652
if not hasattr(value, u"variant_level"):
653
all[name] = value
929
654
continue
930
properties[name] = type(value)(value, variant_level=
931
value.variant_level+1)
932
return dbus.Dictionary(properties, signature="sv")
655
all[name] = type(value)(value, variant_level=
656
value.variant_level+1)
657
return dbus.Dictionary(all, signature=u"sv")
933
658
934
659
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
935
out_signature="s",
660
out_signature=u"s",
936
661
path_keyword='object_path',
937
662
connection_keyword='connection')
938
663
def Introspect(self, object_path, connection):
939
"""Overloading of standard D-Bus method.
940
941
Inserts property tags and interface annotation tags.
664
"""Standard D-Bus method, overloaded to insert property tags.
942
665
"""
943
666
xmlstring = dbus.service.Object.Introspect(self, object_path,
944
667
connection)
945
668
try:
946
669
document = xml.dom.minidom.parseString(xmlstring)
947
670
def make_tag(document, name, prop):
948
e = document.createElement("property")
949
e.setAttribute("name", name)
950
e.setAttribute("type", prop._dbus_signature)
951
e.setAttribute("access", prop._dbus_access)
671
e = document.createElement(u"property")
672
e.setAttribute(u"name", name)
673
e.setAttribute(u"type", prop._dbus_signature)
674
e.setAttribute(u"access", prop._dbus_access)
952
675
return e
953
for if_tag in document.getElementsByTagName("interface"):
954
# Add property tags
676
for if_tag in document.getElementsByTagName(u"interface"):
955
677
for tag in (make_tag(document, name, prop)
956
678
for name, prop
957
in self._get_all_dbus_things("property")
679
in self._get_all_dbus_properties()
958
680
if prop._dbus_interface
959
== if_tag.getAttribute("name")):
681
== if_tag.getAttribute(u"name")):
960
682
if_tag.appendChild(tag)
961
# Add annotation tags
962
for typ in ("method", "signal", "property"):
963
for tag in if_tag.getElementsByTagName(typ):
964
annots = dict()
965
for name, prop in (self.
966
_get_all_dbus_things(typ)):
967
if (name == tag.getAttribute("name")
968
and prop._dbus_interface
969
== if_tag.getAttribute("name")):
970
annots.update(getattr
971
(prop,
972
"_dbus_annotations",
973
{}))
974
for name, value in annots.iteritems():
975
ann_tag = document.createElement(
976
"annotation")
977
ann_tag.setAttribute("name", name)
978
ann_tag.setAttribute("value", value)
979
tag.appendChild(ann_tag)
980
# Add interface annotation tags
981
for annotation, value in dict(
982
itertools.chain(
983
*(annotations().iteritems()
984
for name, annotations in
985
self._get_all_dbus_things("interface")
986
if name == if_tag.getAttribute("name")
987
))).iteritems():
988
ann_tag = document.createElement("annotation")
989
ann_tag.setAttribute("name", annotation)
990
ann_tag.setAttribute("value", value)
991
if_tag.appendChild(ann_tag)
992
683
# Add the names to the return values for the
993
684
# "org.freedesktop.DBus.Properties" methods
994
if (if_tag.getAttribute("name")
995
== "org.freedesktop.DBus.Properties"):
996
for cn in if_tag.getElementsByTagName("method"):
997
if cn.getAttribute("name") == "Get":
998
for arg in cn.getElementsByTagName("arg"):
999
if (arg.getAttribute("direction")
1000
== "out"):
1001
arg.setAttribute("name", "value")
1002
elif cn.getAttribute("name") == "GetAll":
1003
for arg in cn.getElementsByTagName("arg"):
1004
if (arg.getAttribute("direction")
1005
== "out"):
1006
arg.setAttribute("name", "props")
1007
xmlstring = document.toxml("utf-8")
685
if (if_tag.getAttribute(u"name")
686
== u"org.freedesktop.DBus.Properties"):
687
for cn in if_tag.getElementsByTagName(u"method"):
688
if cn.getAttribute(u"name") == u"Get":
689
for arg in cn.getElementsByTagName(u"arg"):
690
if (arg.getAttribute(u"direction")
691
== u"out"):
692
arg.setAttribute(u"name", u"value")
693
elif cn.getAttribute(u"name") == u"GetAll":
694
for arg in cn.getElementsByTagName(u"arg"):
695
if (arg.getAttribute(u"direction")
696
== u"out"):
697
arg.setAttribute(u"name", u"props")
698
xmlstring = document.toxml(u"utf-8")
1008
699
document.unlink()
1009
700
except (AttributeError, xml.dom.DOMException,
1010
xml.parsers.expat.ExpatError) as error:
1011
logger.error("Failed to override Introspection method",
1012
exc_info=error)
701
xml.parsers.expat.ExpatError), error:
702
logger.error(u"Failed to override Introspection method",
703
error)
1013
704
return xmlstring
1014
705
1015
706
1016
def datetime_to_dbus (dt, variant_level=0):
1017
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1018
if dt is None:
1019
return dbus.String("", variant_level = variant_level)
1020
return dbus.String(dt.isoformat(),
1021
variant_level=variant_level)
1022
1023
1024
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
1025
.__metaclass__):
1026
"""Applied to an empty subclass of a D-Bus object, this metaclass
1027
will add additional D-Bus attributes matching a certain pattern.
1028
"""
1029
def __new__(mcs, name, bases, attr):
1030
# Go through all the base classes which could have D-Bus
1031
# methods, signals, or properties in them
1032
old_interface_names = []
1033
for base in (b for b in bases
1034
if issubclass(b, dbus.service.Object)):
1035
# Go though all attributes of the base class
1036
for attrname, attribute in inspect.getmembers(base):
1037
# Ignore non-D-Bus attributes, and D-Bus attributes
1038
# with the wrong interface name
1039
if (not hasattr(attribute, "_dbus_interface")
1040
or not attribute._dbus_interface
1041
.startswith("se.recompile.Mandos")):
1042
continue
1043
# Create an alternate D-Bus interface name based on
1044
# the current name
1045
alt_interface = (attribute._dbus_interface
1046
.replace("se.recompile.Mandos",
1047
"se.bsnet.fukt.Mandos"))
1048
if alt_interface != attribute._dbus_interface:
1049
old_interface_names.append(alt_interface)
1050
# Is this a D-Bus signal?
1051
if getattr(attribute, "_dbus_is_signal", False):
1052
# Extract the original non-method function by
1053
# black magic
1054
nonmethod_func = (dict(
1055
zip(attribute.func_code.co_freevars,
1056
attribute.__closure__))["func"]
1057
.cell_contents)
1058
# Create a new, but exactly alike, function
1059
# object, and decorate it to be a new D-Bus signal
1060
# with the alternate D-Bus interface name
1061
new_function = (dbus.service.signal
1062
(alt_interface,
1063
attribute._dbus_signature)
1064
(types.FunctionType(
1065
nonmethod_func.func_code,
1066
nonmethod_func.func_globals,
1067
nonmethod_func.func_name,
1068
nonmethod_func.func_defaults,
1069
nonmethod_func.func_closure)))
1070
# Copy annotations, if any
1071
try:
1072
new_function._dbus_annotations = (
1073
dict(attribute._dbus_annotations))
1074
except AttributeError:
1075
pass
1076
# Define a creator of a function to call both the
1077
# old and new functions, so both the old and new
1078
# signals gets sent when the function is called
1079
def fixscope(func1, func2):
1080
"""This function is a scope container to pass
1081
func1 and func2 to the "call_both" function
1082
outside of its arguments"""
1083
def call_both(*args, **kwargs):
1084
"""This function will emit two D-Bus
1085
signals by calling func1 and func2"""
1086
func1(*args, **kwargs)
1087
func2(*args, **kwargs)
1088
return call_both
1089
# Create the "call_both" function and add it to
1090
# the class
1091
attr[attrname] = fixscope(attribute,
1092
new_function)
1093
# Is this a D-Bus method?
1094
elif getattr(attribute, "_dbus_is_method", False):
1095
# Create a new, but exactly alike, function
1096
# object. Decorate it to be a new D-Bus method
1097
# with the alternate D-Bus interface name. Add it
1098
# to the class.
1099
attr[attrname] = (dbus.service.method
1100
(alt_interface,
1101
attribute._dbus_in_signature,
1102
attribute._dbus_out_signature)
1103
(types.FunctionType
1104
(attribute.func_code,
1105
attribute.func_globals,
1106
attribute.func_name,
1107
attribute.func_defaults,
1108
attribute.func_closure)))
1109
# Copy annotations, if any
1110
try:
1111
attr[attrname]._dbus_annotations = (
1112
dict(attribute._dbus_annotations))
1113
except AttributeError:
1114
pass
1115
# Is this a D-Bus property?
1116
elif getattr(attribute, "_dbus_is_property", False):
1117
# Create a new, but exactly alike, function
1118
# object, and decorate it to be a new D-Bus
1119
# property with the alternate D-Bus interface
1120
# name. Add it to the class.
1121
attr[attrname] = (dbus_service_property
1122
(alt_interface,
1123
attribute._dbus_signature,
1124
attribute._dbus_access,
1125
attribute
1126
._dbus_get_args_options
1127
["byte_arrays"])
1128
(types.FunctionType
1129
(attribute.func_code,
1130
attribute.func_globals,
1131
attribute.func_name,
1132
attribute.func_defaults,
1133
attribute.func_closure)))
1134
# Copy annotations, if any
1135
try:
1136
attr[attrname]._dbus_annotations = (
1137
dict(attribute._dbus_annotations))
1138
except AttributeError:
1139
pass
1140
# Is this a D-Bus interface?
1141
elif getattr(attribute, "_dbus_is_interface", False):
1142
# Create a new, but exactly alike, function
1143
# object. Decorate it to be a new D-Bus interface
1144
# with the alternate D-Bus interface name. Add it
1145
# to the class.
1146
attr[attrname] = (dbus_interface_annotations
1147
(alt_interface)
1148
(types.FunctionType
1149
(attribute.func_code,
1150
attribute.func_globals,
1151
attribute.func_name,
1152
attribute.func_defaults,
1153
attribute.func_closure)))
1154
# Deprecate all old interfaces
1155
iname="_AlternateDBusNamesMetaclass_interface_annotation{0}"
1156
for old_interface_name in old_interface_names:
1157
@dbus_interface_annotations(old_interface_name)
1158
def func(self):
1159
return { "org.freedesktop.DBus.Deprecated": "true" }
1160
# Find an unused name
1161
for aname in (iname.format(i) for i in itertools.count()):
1162
if aname not in attr:
1163
attr[aname] = func
1164
break
1165
return type.__new__(mcs, name, bases, attr)
1166
1167
1168
707
class ClientDBus(Client, DBusObjectWithProperties):
1169
708
"""A Client class using D-Bus
1170
709
1174
713
"""
1175
714
1176
715
runtime_expansions = (Client.runtime_expansions
1177
+ ("dbus_object_path",))
716
+ (u"dbus_object_path",))
1178
717
1179
718
# dbus.service.Object doesn't use super(), so we can't either.
1180
719
1181
720
def __init__(self, bus = None, *args, **kwargs):
721
self._approvals_pending = 0
1182
722
self.bus = bus
1183
723
Client.__init__(self, *args, **kwargs)
1184
724
# Only now, when this client is initialized, can it show up on
1185
725
# the D-Bus
1186
726
client_object_name = unicode(self.name).translate(
1187
{ord("."): ord("_"),
1188
ord("-"): ord("_")})
727
{ord(u"."): ord(u"_"),
728
ord(u"-"): ord(u"_")})
1189
729
self.dbus_object_path = (dbus.ObjectPath
1190
("/clients/" + client_object_name))
730
(u"/clients/" + client_object_name))
1191
731
DBusObjectWithProperties.__init__(self, self.bus,
1192
732
self.dbus_object_path)
1193
1194
def notifychangeproperty(transform_func,
1195
dbus_name, type_func=lambda x: x,
1196
variant_level=1):
1197
""" Modify a variable so that it's a property which announces
1198
its changes to DBus.
1199
1200
transform_fun: Function that takes a value and a variant_level
1201
and transforms it to a D-Bus type.
1202
dbus_name: D-Bus name of the variable
1203
type_func: Function that transform the value before sending it
1204
to the D-Bus. Default: no transform
1205
variant_level: D-Bus variant level. Default: 1
1206
"""
1207
attrname = "_{0}".format(dbus_name)
1208
def setter(self, value):
1209
if hasattr(self, "dbus_object_path"):
1210
if (not hasattr(self, attrname) or
1211
type_func(getattr(self, attrname, None))
1212
!= type_func(value)):
1213
dbus_value = transform_func(type_func(value),
1214
variant_level
1215
=variant_level)
1216
self.PropertyChanged(dbus.String(dbus_name),
1217
dbus_value)
1218
setattr(self, attrname, value)
1219
1220
return property(lambda self: getattr(self, attrname), setter)
1221
1222
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1223
approvals_pending = notifychangeproperty(dbus.Boolean,
1224
"ApprovalPending",
1225
type_func = bool)
1226
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1227
last_enabled = notifychangeproperty(datetime_to_dbus,
1228
"LastEnabled")
1229
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1230
type_func = lambda checker:
1231
checker is not None)
1232
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1233
"LastCheckedOK")
1234
last_checker_status = notifychangeproperty(dbus.Int16,
1235
"LastCheckerStatus")
1236
last_approval_request = notifychangeproperty(
1237
datetime_to_dbus, "LastApprovalRequest")
1238
approved_by_default = notifychangeproperty(dbus.Boolean,
1239
"ApprovedByDefault")
1240
approval_delay = notifychangeproperty(dbus.UInt64,
1241
"ApprovalDelay",
1242
type_func =
1243
timedelta_to_milliseconds)
1244
approval_duration = notifychangeproperty(
1245
dbus.UInt64, "ApprovalDuration",
1246
type_func = timedelta_to_milliseconds)
1247
host = notifychangeproperty(dbus.String, "Host")
1248
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1249
type_func =
1250
timedelta_to_milliseconds)
1251
extended_timeout = notifychangeproperty(
1252
dbus.UInt64, "ExtendedTimeout",
1253
type_func = timedelta_to_milliseconds)
1254
interval = notifychangeproperty(dbus.UInt64,
1255
"Interval",
1256
type_func =
1257
timedelta_to_milliseconds)
1258
checker_command = notifychangeproperty(dbus.String, "Checker")
1259
1260
del notifychangeproperty
733
734
def _get_approvals_pending(self):
735
return self._approvals_pending
736
def _set_approvals_pending(self, value):
737
old_value = self._approvals_pending
738
self._approvals_pending = value
739
bval = bool(value)
740
if (hasattr(self, "dbus_object_path")
741
and bval is not bool(old_value)):
742
dbus_bool = dbus.Boolean(bval, variant_level=1)
743
self.PropertyChanged(dbus.String(u"ApprovalPending"),
744
dbus_bool)
745
746
approvals_pending = property(_get_approvals_pending,
747
_set_approvals_pending)
748
del _get_approvals_pending, _set_approvals_pending
749
750
@staticmethod
751
def _datetime_to_dbus(dt, variant_level=0):
752
"""Convert a UTC datetime.datetime() to a D-Bus type."""
753
return dbus.String(dt.isoformat(),
754
variant_level=variant_level)
755
756
def enable(self):
757
oldstate = getattr(self, u"enabled", False)
758
r = Client.enable(self)
759
if oldstate != self.enabled:
760
# Emit D-Bus signals
761
self.PropertyChanged(dbus.String(u"Enabled"),
762
dbus.Boolean(True, variant_level=1))
763
self.PropertyChanged(
764
dbus.String(u"LastEnabled"),
765
self._datetime_to_dbus(self.last_enabled,
766
variant_level=1))
767
return r
768
769
def disable(self, quiet = False):
770
oldstate = getattr(self, u"enabled", False)
771
r = Client.disable(self, quiet=quiet)
772
if not quiet and oldstate != self.enabled:
773
# Emit D-Bus signal
774
self.PropertyChanged(dbus.String(u"Enabled"),
775
dbus.Boolean(False, variant_level=1))
776
return r
1261
777
1262
778
def __del__(self, *args, **kwargs):
1263
779
try:
1264
780
self.remove_from_connection()
1265
781
except LookupError:
1266
782
pass
1267
if hasattr(DBusObjectWithProperties, "__del__"):
783
if hasattr(DBusObjectWithProperties, u"__del__"):
1268
784
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1269
785
Client.__del__(self, *args, **kwargs)
1270
786
1272
788
*args, **kwargs):
1273
789
self.checker_callback_tag = None
1274
790
self.checker = None
791
# Emit D-Bus signal
792
self.PropertyChanged(dbus.String(u"CheckerRunning"),
793
dbus.Boolean(False, variant_level=1))
1275
794
if os.WIFEXITED(condition):
1276
795
exitstatus = os.WEXITSTATUS(condition)
1277
796
# Emit D-Bus signal
1287
806
return Client.checker_callback(self, pid, condition, command,
1288
807
*args, **kwargs)
1289
808
809
def checked_ok(self, *args, **kwargs):
810
r = Client.checked_ok(self, *args, **kwargs)
811
# Emit D-Bus signal
812
self.PropertyChanged(
813
dbus.String(u"LastCheckedOK"),
814
(self._datetime_to_dbus(self.last_checked_ok,
815
variant_level=1)))
816
return r
817
1290
818
def start_checker(self, *args, **kwargs):
1291
819
old_checker = self.checker
1292
820
if self.checker is not None:
1299
827
and old_checker_pid != self.checker.pid):
1300
828
# Emit D-Bus signal
1301
829
self.CheckerStarted(self.current_checker_command)
830
self.PropertyChanged(
831
dbus.String(u"CheckerRunning"),
832
dbus.Boolean(True, variant_level=1))
1302
833
return r
1303
834
835
def stop_checker(self, *args, **kwargs):
836
old_checker = getattr(self, u"checker", None)
837
r = Client.stop_checker(self, *args, **kwargs)
838
if (old_checker is not None
839
and getattr(self, u"checker", None) is None):
840
self.PropertyChanged(dbus.String(u"CheckerRunning"),
841
dbus.Boolean(False, variant_level=1))
842
return r
843
1304
844
def _reset_approved(self):
1305
self.approved = None
845
self._approved = None
1306
846
return False
1307
847
1308
848
def approve(self, value=True):
1309
849
self.send_changedstate()
1310
self.approved = value
1311
gobject.timeout_add(timedelta_to_milliseconds
850
self._approved = value
851
gobject.timeout_add(self._timedelta_to_milliseconds
1312
852
(self.approval_duration),
1313
853
self._reset_approved)
1314
854
855
1315
856
## D-Bus methods, signals & properties
1316
_interface = "se.recompile.Mandos.Client"
1317
1318
## Interfaces
1319
1320
@dbus_interface_annotations(_interface)
1321
def _foo(self):
1322
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1323
"false"}
857
_interface = u"se.bsnet.fukt.Mandos.Client"
1324
858
1325
859
## Signals
1326
860
1327
861
# CheckerCompleted - signal
1328
@dbus.service.signal(_interface, signature="nxs")
862
@dbus.service.signal(_interface, signature=u"nxs")
1329
863
def CheckerCompleted(self, exitcode, waitstatus, command):
1330
864
"D-Bus signal"
1331
865
pass
1332
866
1333
867
# CheckerStarted - signal
1334
@dbus.service.signal(_interface, signature="s")
868
@dbus.service.signal(_interface, signature=u"s")
1335
869
def CheckerStarted(self, command):
1336
870
"D-Bus signal"
1337
871
pass
1338
872
1339
873
# PropertyChanged - signal
1340
@dbus.service.signal(_interface, signature="sv")
874
@dbus.service.signal(_interface, signature=u"sv")
1341
875
def PropertyChanged(self, property, value):
1342
876
"D-Bus signal"
1343
877
pass
1352
886
pass
1353
887
1354
888
# Rejected - signal
1355
@dbus.service.signal(_interface, signature="s")
889
@dbus.service.signal(_interface, signature=u"s")
1356
890
def Rejected(self, reason):
1357
891
"D-Bus signal"
1358
892
pass
1359
893
1360
894
# NeedApproval - signal
1361
@dbus.service.signal(_interface, signature="tb")
895
@dbus.service.signal(_interface, signature=u"tb")
1362
896
def NeedApproval(self, timeout, default):
1363
897
"D-Bus signal"
1364
return self.need_approval()
898
pass
1365
899
1366
900
## Methods
1367
901
1368
902
# Approve - method
1369
@dbus.service.method(_interface, in_signature="b")
903
@dbus.service.method(_interface, in_signature=u"b")
1370
904
def Approve(self, value):
1371
905
self.approve(value)
1372
906
1373
907
# CheckedOK - method
1374
908
@dbus.service.method(_interface)
1375
909
def CheckedOK(self):
1376
self.checked_ok()
910
return self.checked_ok()
1377
911
1378
912
# Enable - method
1379
913
@dbus.service.method(_interface)
1401
935
## Properties
1402
936
1403
937
# ApprovalPending - property
1404
@dbus_service_property(_interface, signature="b", access="read")
938
@dbus_service_property(_interface, signature=u"b", access=u"read")
1405
939
def ApprovalPending_dbus_property(self):
1406
940
return dbus.Boolean(bool(self.approvals_pending))
1407
941
1408
942
# ApprovedByDefault - property
1409
@dbus_service_property(_interface, signature="b",
1410
access="readwrite")
943
@dbus_service_property(_interface, signature=u"b",
944
access=u"readwrite")
1411
945
def ApprovedByDefault_dbus_property(self, value=None):
1412
946
if value is None: # get
1413
947
return dbus.Boolean(self.approved_by_default)
1414
948
self.approved_by_default = bool(value)
949
# Emit D-Bus signal
950
self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
951
dbus.Boolean(value, variant_level=1))
1415
952
1416
953
# ApprovalDelay - property
1417
@dbus_service_property(_interface, signature="t",
1418
access="readwrite")
954
@dbus_service_property(_interface, signature=u"t",
955
access=u"readwrite")
1419
956
def ApprovalDelay_dbus_property(self, value=None):
1420
957
if value is None: # get
1421
958
return dbus.UInt64(self.approval_delay_milliseconds())
1422
959
self.approval_delay = datetime.timedelta(0, 0, 0, value)
960
# Emit D-Bus signal
961
self.PropertyChanged(dbus.String(u"ApprovalDelay"),
962
dbus.UInt64(value, variant_level=1))
1423
963
1424
964
# ApprovalDuration - property
1425
@dbus_service_property(_interface, signature="t",
1426
access="readwrite")
965
@dbus_service_property(_interface, signature=u"t",
966
access=u"readwrite")
1427
967
def ApprovalDuration_dbus_property(self, value=None):
1428
968
if value is None: # get
1429
return dbus.UInt64(timedelta_to_milliseconds(
969
return dbus.UInt64(self._timedelta_to_milliseconds(
1430
970
self.approval_duration))
1431
971
self.approval_duration = datetime.timedelta(0, 0, 0, value)
972
# Emit D-Bus signal
973
self.PropertyChanged(dbus.String(u"ApprovalDuration"),
974
dbus.UInt64(value, variant_level=1))
1432
975
1433
976
# Name - property
1434
@dbus_service_property(_interface, signature="s", access="read")
977
@dbus_service_property(_interface, signature=u"s", access=u"read")
1435
978
def Name_dbus_property(self):
1436
979
return dbus.String(self.name)
1437
980
1438
981
# Fingerprint - property
1439
@dbus_service_property(_interface, signature="s", access="read")
982
@dbus_service_property(_interface, signature=u"s", access=u"read")
1440
983
def Fingerprint_dbus_property(self):
1441
984
return dbus.String(self.fingerprint)
1442
985
1443
986
# Host - property
1444
@dbus_service_property(_interface, signature="s",
1445
access="readwrite")
987
@dbus_service_property(_interface, signature=u"s",
988
access=u"readwrite")
1446
989
def Host_dbus_property(self, value=None):
1447
990
if value is None: # get
1448
991
return dbus.String(self.host)
1449
self.host = unicode(value)
992
self.host = value
993
# Emit D-Bus signal
994
self.PropertyChanged(dbus.String(u"Host"),
995
dbus.String(value, variant_level=1))
1450
996
1451
997
# Created - property
1452
@dbus_service_property(_interface, signature="s", access="read")
998
@dbus_service_property(_interface, signature=u"s", access=u"read")
1453
999
def Created_dbus_property(self):
1454
return datetime_to_dbus(self.created)
1000
return dbus.String(self._datetime_to_dbus(self.created))
1455
1001
1456
1002
# LastEnabled - property
1457
@dbus_service_property(_interface, signature="s", access="read")
1003
@dbus_service_property(_interface, signature=u"s", access=u"read")
1458
1004
def LastEnabled_dbus_property(self):
1459
return datetime_to_dbus(self.last_enabled)
1005
if self.last_enabled is None:
1006
return dbus.String(u"")
1007
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1460
1008
1461
1009
# Enabled - property
1462
@dbus_service_property(_interface, signature="b",
1463
access="readwrite")
1010
@dbus_service_property(_interface, signature=u"b",
1011
access=u"readwrite")
1464
1012
def Enabled_dbus_property(self, value=None):
1465
1013
if value is None: # get
1466
1014
return dbus.Boolean(self.enabled)
1470
1018
self.disable()
1471
1019
1472
1020
# LastCheckedOK - property
1473
@dbus_service_property(_interface, signature="s",
1474
access="readwrite")
1021
@dbus_service_property(_interface, signature=u"s",
1022
access=u"readwrite")
1475
1023
def LastCheckedOK_dbus_property(self, value=None):
1476
1024
if value is not None:
1477
1025
self.checked_ok()
1478
1026
return
1479
return datetime_to_dbus(self.last_checked_ok)
1480
1481
# LastCheckerStatus - property
1482
@dbus_service_property(_interface, signature="n",
1483
access="read")
1484
def LastCheckerStatus_dbus_property(self):
1485
return dbus.Int16(self.last_checker_status)
1486
1487
# Expires - property
1488
@dbus_service_property(_interface, signature="s", access="read")
1489
def Expires_dbus_property(self):
1490
return datetime_to_dbus(self.expires)
1491
1492
# LastApprovalRequest - property
1493
@dbus_service_property(_interface, signature="s", access="read")
1494
def LastApprovalRequest_dbus_property(self):
1495
return datetime_to_dbus(self.last_approval_request)
1027
if self.last_checked_ok is None:
1028
return dbus.String(u"")
1029
return dbus.String(self._datetime_to_dbus(self
1030
.last_checked_ok))
1496
1031
1497
1032
# Timeout - property
1498
@dbus_service_property(_interface, signature="t",
1499
access="readwrite")
1033
@dbus_service_property(_interface, signature=u"t",
1034
access=u"readwrite")
1500
1035
def Timeout_dbus_property(self, value=None):
1501
1036
if value is None: # get
1502
1037
return dbus.UInt64(self.timeout_milliseconds())
1503
1038
self.timeout = datetime.timedelta(0, 0, 0, value)
1039
# Emit D-Bus signal
1040
self.PropertyChanged(dbus.String(u"Timeout"),
1041
dbus.UInt64(value, variant_level=1))
1042
if getattr(self, u"disable_initiator_tag", None) is None:
1043
return
1504
1044
# Reschedule timeout
1505
if self.enabled:
1506
now = datetime.datetime.utcnow()
1507
time_to_die = timedelta_to_milliseconds(
1508
(self.last_checked_ok + self.timeout) - now)
1509
if time_to_die <= 0:
1510
# The timeout has passed
1511
self.disable()
1512
else:
1513
self.expires = (now +
1514
datetime.timedelta(milliseconds =
1515
time_to_die))
1516
if (getattr(self, "disable_initiator_tag", None)
1517
is None):
1518
return
1519
gobject.source_remove(self.disable_initiator_tag)
1520
self.disable_initiator_tag = (gobject.timeout_add
1521
(time_to_die,
1522
self.disable))
1523
1524
# ExtendedTimeout - property
1525
@dbus_service_property(_interface, signature="t",
1526
access="readwrite")
1527
def ExtendedTimeout_dbus_property(self, value=None):
1528
if value is None: # get
1529
return dbus.UInt64(self.extended_timeout_milliseconds())
1530
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1045
gobject.source_remove(self.disable_initiator_tag)
1046
self.disable_initiator_tag = None
1047
time_to_die = (self.
1048
_timedelta_to_milliseconds((self
1049
.last_checked_ok
1050
+ self.timeout)
1051
- datetime.datetime
1052
.utcnow()))
1053
if time_to_die <= 0:
1054
# The timeout has passed
1055
self.disable()
1056
else:
1057
self.disable_initiator_tag = (gobject.timeout_add
1058
(time_to_die, self.disable))
1531
1059
1532
1060
# Interval - property
1533
@dbus_service_property(_interface, signature="t",
1534
access="readwrite")
1061
@dbus_service_property(_interface, signature=u"t",
1062
access=u"readwrite")
1535
1063
def Interval_dbus_property(self, value=None):
1536
1064
if value is None: # get
1537
1065
return dbus.UInt64(self.interval_milliseconds())
1538
1066
self.interval = datetime.timedelta(0, 0, 0, value)
1539
if getattr(self, "checker_initiator_tag", None) is None:
1067
# Emit D-Bus signal
1068
self.PropertyChanged(dbus.String(u"Interval"),
1069
dbus.UInt64(value, variant_level=1))
1070
if getattr(self, u"checker_initiator_tag", None) is None:
1540
1071
return
1541
if self.enabled:
1542
# Reschedule checker run
1543
gobject.source_remove(self.checker_initiator_tag)
1544
self.checker_initiator_tag = (gobject.timeout_add
1545
(value, self.start_checker))
1546
self.start_checker() # Start one now, too
1547
1072
# Reschedule checker run
1073
gobject.source_remove(self.checker_initiator_tag)
1074
self.checker_initiator_tag = (gobject.timeout_add
1075
(value, self.start_checker))
1076
self.start_checker() # Start one now, too
1077
1548
1078
# Checker - property
1549
@dbus_service_property(_interface, signature="s",
1550
access="readwrite")
1079
@dbus_service_property(_interface, signature=u"s",
1080
access=u"readwrite")
1551
1081
def Checker_dbus_property(self, value=None):
1552
1082
if value is None: # get
1553
1083
return dbus.String(self.checker_command)
1554
self.checker_command = unicode(value)
1084
self.checker_command = value
1085
# Emit D-Bus signal
1086
self.PropertyChanged(dbus.String(u"Checker"),
1087
dbus.String(self.checker_command,
1088
variant_level=1))
1555
1089
1556
1090
# CheckerRunning - property
1557
@dbus_service_property(_interface, signature="b",
1558
access="readwrite")
1091
@dbus_service_property(_interface, signature=u"b",
1092
access=u"readwrite")
1559
1093
def CheckerRunning_dbus_property(self, value=None):
1560
1094
if value is None: # get
1561
1095
return dbus.Boolean(self.checker is not None)
1565
1099
self.stop_checker()
1566
1100
1567
1101
# ObjectPath - property
1568
@dbus_service_property(_interface, signature="o", access="read")
1102
@dbus_service_property(_interface, signature=u"o", access=u"read")
1569
1103
def ObjectPath_dbus_property(self):
1570
1104
return self.dbus_object_path # is already a dbus.ObjectPath
1571
1105
1572
1106
# Secret = property
1573
@dbus_service_property(_interface, signature="ay",
1574
access="write", byte_arrays=True)
1107
@dbus_service_property(_interface, signature=u"ay",
1108
access=u"write", byte_arrays=True)
1575
1109
def Secret_dbus_property(self, value):
1576
1110
self.secret = str(value)
1577
1111
1584
1118
self._pipe.send(('init', fpr, address))
1585
1119
if not self._pipe.recv():
1586
1120
raise KeyError()
1587
1121
1588
1122
def __getattribute__(self, name):
1589
if name == '_pipe':
1123
if(name == '_pipe'):
1590
1124
return super(ProxyClient, self).__getattribute__(name)
1591
1125
self._pipe.send(('getattr', name))
1592
1126
data = self._pipe.recv()
1597
1131
self._pipe.send(('funcall', name, args, kwargs))
1598
1132
return self._pipe.recv()[1]
1599
1133
return func
1600
1134
1601
1135
def __setattr__(self, name, value):
1602
if name == '_pipe':
1136
if(name == '_pipe'):
1603
1137
return super(ProxyClient, self).__setattr__(name, value)
1604
1138
self._pipe.send(('setattr', name, value))
1605
1139
1606
1140
1607
class ClientDBusTransitional(ClientDBus):
1608
__metaclass__ = AlternateDBusNamesMetaclass
1609
1610
1611
1141
class ClientHandler(socketserver.BaseRequestHandler, object):
1612
1142
"""A class to handle client connections.
1613
1143
1616
1146
1617
1147
def handle(self):
1618
1148
with contextlib.closing(self.server.child_pipe) as child_pipe:
1619
logger.info("TCP connection from: %s",
1149
logger.info(u"TCP connection from: %s",
1620
1150
unicode(self.client_address))
1621
logger.debug("Pipe FD: %d",
1151
logger.debug(u"Pipe FD: %d",
1622
1152
self.server.child_pipe.fileno())
1623
1153
1624
1154
session = (gnutls.connection
1625
1155
.ClientSession(self.request,
1626
1156
gnutls.connection
1627
1157
.X509Credentials()))
1628
1158
1629
1159
# Note: gnutls.connection.X509Credentials is really a
1630
1160
# generic GnuTLS certificate credentials object so long as
1631
1161
# no X.509 keys are added to it. Therefore, we can use it
1632
1162
# here despite using OpenPGP certificates.
1633
1634
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1635
# "+AES-256-CBC", "+SHA1",
1636
# "+COMP-NULL", "+CTYPE-OPENPGP",
1637
# "+DHE-DSS"))
1163
1164
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1165
# u"+AES-256-CBC", u"+SHA1",
1166
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1167
# u"+DHE-DSS"))
1638
1168
# Use a fallback default, since this MUST be set.
1639
1169
priority = self.server.gnutls_priority
1640
1170
if priority is None:
1641
priority = "NORMAL"
1171
priority = u"NORMAL"
1642
1172
(gnutls.library.functions
1643
1173
.gnutls_priority_set_direct(session._c_object,
1644
1174
priority, None))
1645
1175
1646
1176
# Start communication using the Mandos protocol
1647
1177
# Get protocol number
1648
1178
line = self.request.makefile().readline()
1649
logger.debug("Protocol version: %r", line)
1179
logger.debug(u"Protocol version: %r", line)
1650
1180
try:
1651
1181
if int(line.strip().split()[0]) > 1:
1652
1182
raise RuntimeError
1653
except (ValueError, IndexError, RuntimeError) as error:
1654
logger.error("Unknown protocol version: %s", error)
1183
except (ValueError, IndexError, RuntimeError), error:
1184
logger.error(u"Unknown protocol version: %s", error)
1655
1185
return
1656
1186
1657
1187
# Start GnuTLS connection
1658
1188
try:
1659
1189
session.handshake()
1660
except gnutls.errors.GNUTLSError as error:
1661
logger.warning("Handshake failed: %s", error)
1190
except gnutls.errors.GNUTLSError, error:
1191
logger.warning(u"Handshake failed: %s", error)
1662
1192
# Do not run session.bye() here: the session is not
1663
1193
# established. Just abandon the request.
1664
1194
return
1665
logger.debug("Handshake succeeded")
1666
1195
logger.debug(u"Handshake succeeded")
1196
1667
1197
approval_required = False
1668
1198
try:
1669
1199
try:
1670
1200
fpr = self.fingerprint(self.peer_certificate
1671
1201
(session))
1672
except (TypeError,
1673
gnutls.errors.GNUTLSError) as error:
1674
logger.warning("Bad certificate: %s", error)
1202
except (TypeError, gnutls.errors.GNUTLSError), error:
1203
logger.warning(u"Bad certificate: %s", error)
1675
1204
return
1676
logger.debug("Fingerprint: %s", fpr)
1677
1205
logger.debug(u"Fingerprint: %s", fpr)
1206
1678
1207
try:
1679
1208
client = ProxyClient(child_pipe, fpr,
1680
1209
self.client_address)
1688
1217
1689
1218
while True:
1690
1219
if not client.enabled:
1691
logger.info("Client %s is disabled",
1220
logger.warning(u"Client %s is disabled",
1692
1221
client.name)
1693
1222
if self.server.use_dbus:
1694
1223
# Emit D-Bus signal
1695
client.Rejected("Disabled")
1224
client.Rejected("Disabled")
1696
1225
return
1697
1226
1698
if client.approved or not client.approval_delay:
1227
if client._approved or not client.approval_delay:
1699
1228
#We are approved or approval is disabled
1700
1229
break
1701
elif client.approved is None:
1702
logger.info("Client %s needs approval",
1230
elif client._approved is None:
1231
logger.info(u"Client %s needs approval",
1703
1232
client.name)
1704
1233
if self.server.use_dbus:
1705
1234
# Emit D-Bus signal
1707
1236
client.approval_delay_milliseconds(),
1708
1237
client.approved_by_default)
1709
1238
else:
1710
logger.warning("Client %s was not approved",
1239
logger.warning(u"Client %s was not approved",
1711
1240
client.name)
1712
1241
if self.server.use_dbus:
1713
1242
# Emit D-Bus signal
1715
1244
return
1716
1245
1717
1246
#wait until timeout or approved
1247
#x = float(client._timedelta_to_milliseconds(delay))
1718
1248
time = datetime.datetime.now()
1719
1249
client.changedstate.acquire()
1720
(client.changedstate.wait
1721
(float(client.timedelta_to_milliseconds(delay)
1722
/ 1000)))
1250
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1723
1251
client.changedstate.release()
1724
1252
time2 = datetime.datetime.now()
1725
1253
if (time2 - time) >= delay:
1740
1268
while sent_size < len(client.secret):
1741
1269
try:
1742
1270
sent = session.send(client.secret[sent_size:])
1743
except gnutls.errors.GNUTLSError as error:
1744
logger.warning("gnutls send failed",
1745
exc_info=error)
1271
except (gnutls.errors.GNUTLSError), error:
1272
logger.warning("gnutls send failed")
1746
1273
return
1747
logger.debug("Sent: %d, remaining: %d",
1274
logger.debug(u"Sent: %d, remaining: %d",
1748
1275
sent, len(client.secret)
1749
1276
- (sent_size + sent))
1750
1277
sent_size += sent
1751
1752
logger.info("Sending secret to %s", client.name)
1753
# bump the timeout using extended_timeout
1754
client.bump_timeout(client.extended_timeout)
1278
1279
logger.info(u"Sending secret to %s", client.name)
1280
# bump the timeout as if seen
1281
client.checked_ok()
1755
1282
if self.server.use_dbus:
1756
1283
# Emit D-Bus signal
1757
1284
client.GotSecret()
1761
1288
client.approvals_pending -= 1
1762
1289
try:
1763
1290
session.bye()
1764
except gnutls.errors.GNUTLSError as error:
1765
logger.warning("GnuTLS bye failed",
1766
exc_info=error)
1291
except (gnutls.errors.GNUTLSError), error:
1292
logger.warning("GnuTLS bye failed")
1767
1293
1768
1294
@staticmethod
1769
1295
def peer_certificate(session):
1779
1305
.gnutls_certificate_get_peers
1780
1306
(session._c_object, ctypes.byref(list_size)))
1781
1307
if not bool(cert_list) and list_size.value != 0:
1782
raise gnutls.errors.GNUTLSError("error getting peer"
1783
" certificate")
1308
raise gnutls.errors.GNUTLSError(u"error getting peer"
1309
u" certificate")
1784
1310
if list_size.value == 0:
1785
1311
return None
1786
1312
cert = cert_list[0]
1812
1338
if crtverify.value != 0:
1813
1339
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1814
1340
raise (gnutls.errors.CertificateSecurityError
1815
("Verify failed"))
1341
(u"Verify failed"))
1816
1342
# New buffer for the fingerprint
1817
1343
buf = ctypes.create_string_buffer(20)
1818
1344
buf_len = ctypes.c_size_t()
1825
1351
# Convert the buffer to a Python bytestring
1826
1352
fpr = ctypes.string_at(buf, buf_len.value)
1827
1353
# Convert the bytestring to hexadecimal notation
1828
hex_fpr = binascii.hexlify(fpr).upper()
1354
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1829
1355
return hex_fpr
1830
1356
1831
1357
1834
1360
def sub_process_main(self, request, address):
1835
1361
try:
1836
1362
self.finish_request(request, address)
1837
except Exception:
1363
except:
1838
1364
self.handle_error(request, address)
1839
1365
self.close_request(request)
1840
1366
1841
1367
def process_request(self, request, address):
1842
1368
"""Start a new process to process the request."""
1843
proc = multiprocessing.Process(target = self.sub_process_main,
1844
args = (request,
1845
address))
1846
proc.start()
1847
return proc
1848
1369
multiprocessing.Process(target = self.sub_process_main,
1370
args = (request, address)).start()
1849
1371
1850
1372
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1851
1373
""" adds a pipe to the MixIn """
1855
1377
This function creates a new pipe in self.pipe
1856
1378
"""
1857
1379
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1858
1859
proc = MultiprocessingMixIn.process_request(self, request,
1860
client_address)
1380
1381
super(MultiprocessingMixInWithPipe,
1382
self).process_request(request, client_address)
1861
1383
self.child_pipe.close()
1862
self.add_pipe(parent_pipe, proc)
1863
1864
def add_pipe(self, parent_pipe, proc):
1384
self.add_pipe(parent_pipe)
1385
1386
def add_pipe(self, parent_pipe):
1865
1387
"""Dummy function; override as necessary"""
1866
raise NotImplementedError
1867
1388
pass
1868
1389
1869
1390
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1870
1391
socketserver.TCPServer, object):
1888
1409
bind to an address or port if they were not specified."""
1889
1410
if self.interface is not None:
1890
1411
if SO_BINDTODEVICE is None:
1891
logger.error("SO_BINDTODEVICE does not exist;"
1892
" cannot bind to interface %s",
1412
logger.error(u"SO_BINDTODEVICE does not exist;"
1413
u" cannot bind to interface %s",
1893
1414
self.interface)
1894
1415
else:
1895
1416
try:
1896
1417
self.socket.setsockopt(socket.SOL_SOCKET,
1897
1418
SO_BINDTODEVICE,
1898
1419
str(self.interface
1899
+ '\0'))
1900
except socket.error as error:
1420
+ u'\0'))
1421
except socket.error, error:
1901
1422
if error[0] == errno.EPERM:
1902
logger.error("No permission to"
1903
" bind to interface %s",
1423
logger.error(u"No permission to"
1424
u" bind to interface %s",
1904
1425
self.interface)
1905
1426
elif error[0] == errno.ENOPROTOOPT:
1906
logger.error("SO_BINDTODEVICE not available;"
1907
" cannot bind to interface %s",
1427
logger.error(u"SO_BINDTODEVICE not available;"
1428
u" cannot bind to interface %s",
1908
1429
self.interface)
1909
1430
else:
1910
1431
raise
1912
1433
if self.server_address[0] or self.server_address[1]:
1913
1434
if not self.server_address[0]:
1914
1435
if self.address_family == socket.AF_INET6:
1915
any_address = "::" # in6addr_any
1436
any_address = u"::" # in6addr_any
1916
1437
else:
1917
1438
any_address = socket.INADDR_ANY
1918
1439
self.server_address = (any_address,
1945
1466
self.enabled = False
1946
1467
self.clients = clients
1947
1468
if self.clients is None:
1948
self.clients = {}
1469
self.clients = set()
1949
1470
self.use_dbus = use_dbus
1950
1471
self.gnutls_priority = gnutls_priority
1951
1472
IPv6_TCPServer.__init__(self, server_address,
1955
1476
def server_activate(self):
1956
1477
if self.enabled:
1957
1478
return socketserver.TCPServer.server_activate(self)
1958
1959
1479
def enable(self):
1960
1480
self.enabled = True
1961
1962
def add_pipe(self, parent_pipe, proc):
1481
def add_pipe(self, parent_pipe):
1963
1482
# Call "handle_ipc" for both data and EOF events
1964
1483
gobject.io_add_watch(parent_pipe.fileno(),
1965
1484
gobject.IO_IN | gobject.IO_HUP,
1966
1485
functools.partial(self.handle_ipc,
1967
parent_pipe =
1968
parent_pipe,
1969
proc = proc))
1970
1486
parent_pipe = parent_pipe))
1487
1971
1488
def handle_ipc(self, source, condition, parent_pipe=None,
1972
proc = None, client_object=None):
1489
client_object=None):
1973
1490
condition_names = {
1974
gobject.IO_IN: "IN", # There is data to read.
1975
gobject.IO_OUT: "OUT", # Data can be written (without
1491
gobject.IO_IN: u"IN", # There is data to read.
1492
gobject.IO_OUT: u"OUT", # Data can be written (without
1976
1493
# blocking).
1977
gobject.IO_PRI: "PRI", # There is urgent data to read.
1978
gobject.IO_ERR: "ERR", # Error condition.
1979
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1494
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1495
gobject.IO_ERR: u"ERR", # Error condition.
1496
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1980
1497
# broken, usually for pipes and
1981
1498
# sockets).
1982
1499
}
1984
1501
for cond, name in
1985
1502
condition_names.iteritems()
1986
1503
if cond & condition)
1987
# error, or the other end of multiprocessing.Pipe has closed
1504
# error or the other end of multiprocessing.Pipe has closed
1988
1505
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
1989
# Wait for other process to exit
1990
proc.join()
1991
1506
return False
1992
1507
1993
1508
# Read a request from the child
1998
1513
fpr = request[1]
1999
1514
address = request[2]
2000
1515
2001
for c in self.clients.itervalues():
1516
for c in self.clients:
2002
1517
if c.fingerprint == fpr:
2003
1518
client = c
2004
1519
break
2005
1520
else:
2006
logger.info("Client not found for fingerprint: %s, ad"
2007
"dress: %s", fpr, address)
1521
logger.warning(u"Client not found for fingerprint: %s, ad"
1522
u"dress: %s", fpr, address)
2008
1523
if self.use_dbus:
2009
1524
# Emit D-Bus signal
2010
mandos_dbus_service.ClientNotFound(fpr,
2011
address[0])
1525
mandos_dbus_service.ClientNotFound(fpr, address[0])
2012
1526
parent_pipe.send(False)
2013
1527
return False
2014
1528
2015
1529
gobject.io_add_watch(parent_pipe.fileno(),
2016
1530
gobject.IO_IN | gobject.IO_HUP,
2017
1531
functools.partial(self.handle_ipc,
2018
parent_pipe =
2019
parent_pipe,
2020
proc = proc,
2021
client_object =
2022
client))
1532
parent_pipe = parent_pipe,
1533
client_object = client))
2023
1534
parent_pipe.send(True)
2024
# remove the old hook in favor of the new above hook on
2025
# same fileno
1535
# remove the old hook in favor of the new above hook on same fileno
2026
1536
return False
2027
1537
if command == 'funcall':
2028
1538
funcname = request[1]
2029
1539
args = request[2]
2030
1540
kwargs = request[3]
2031
1541
2032
parent_pipe.send(('data', getattr(client_object,
2033
funcname)(*args,
2034
**kwargs)))
2035
1542
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1543
2036
1544
if command == 'getattr':
2037
1545
attrname = request[1]
2038
1546
if callable(client_object.__getattribute__(attrname)):
2039
1547
parent_pipe.send(('function',))
2040
1548
else:
2041
parent_pipe.send(('data', client_object
2042
.__getattribute__(attrname)))
1549
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2043
1550
2044
1551
if command == 'setattr':
2045
1552
attrname = request[1]
2046
1553
value = request[2]
2047
1554
setattr(client_object, attrname, value)
2048
1555
2049
1556
return True
2050
1557
2051
1558
2052
1559
def string_to_delta(interval):
2053
1560
"""Parse a string and return a datetime.timedelta
2054
1561
2055
>>> string_to_delta('7d')
1562
>>> string_to_delta(u'7d')
2056
1563
datetime.timedelta(7)
2057
>>> string_to_delta('60s')
1564
>>> string_to_delta(u'60s')
2058
1565
datetime.timedelta(0, 60)
2059
>>> string_to_delta('60m')
1566
>>> string_to_delta(u'60m')
2060
1567
datetime.timedelta(0, 3600)
2061
>>> string_to_delta('24h')
1568
>>> string_to_delta(u'24h')
2062
1569
datetime.timedelta(1)
2063
>>> string_to_delta('1w')
1570
>>> string_to_delta(u'1w')
2064
1571
datetime.timedelta(7)
2065
>>> string_to_delta('5m 30s')
1572
>>> string_to_delta(u'5m 30s')
2066
1573
datetime.timedelta(0, 330)
2067
1574
"""
2068
1575
timevalue = datetime.timedelta(0)
2070
1577
try:
2071
1578
suffix = unicode(s[-1])
2072
1579
value = int(s[:-1])
2073
if suffix == "d":
1580
if suffix == u"d":
2074
1581
delta = datetime.timedelta(value)
2075
elif suffix == "s":
1582
elif suffix == u"s":
2076
1583
delta = datetime.timedelta(0, value)
2077
elif suffix == "m":
1584
elif suffix == u"m":
2078
1585
delta = datetime.timedelta(0, 0, 0, 0, value)
2079
elif suffix == "h":
1586
elif suffix == u"h":
2080
1587
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2081
elif suffix == "w":
1588
elif suffix == u"w":
2082
1589
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2083
1590
else:
2084
raise ValueError("Unknown suffix {0!r}"
2085
.format(suffix))
2086
except (ValueError, IndexError) as e:
2087
raise ValueError(*(e.args))
1591
raise ValueError(u"Unknown suffix %r" % suffix)
1592
except (ValueError, IndexError), e:
1593
raise ValueError(e.message)
2088
1594
timevalue += delta
2089
1595
return timevalue
2090
1596
2091
1597
1598
def if_nametoindex(interface):
1599
"""Call the C function if_nametoindex(), or equivalent
1600
1601
Note: This function cannot accept a unicode string."""
1602
global if_nametoindex
1603
try:
1604
if_nametoindex = (ctypes.cdll.LoadLibrary
1605
(ctypes.util.find_library(u"c"))
1606
.if_nametoindex)
1607
except (OSError, AttributeError):
1608
logger.warning(u"Doing if_nametoindex the hard way")
1609
def if_nametoindex(interface):
1610
"Get an interface index the hard way, i.e. using fcntl()"
1611
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1612
with contextlib.closing(socket.socket()) as s:
1613
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1614
struct.pack(str(u"16s16x"),
1615
interface))
1616
interface_index = struct.unpack(str(u"I"),
1617
ifreq[16:20])[0]
1618
return interface_index
1619
return if_nametoindex(interface)
1620
1621
2092
1622
def daemon(nochdir = False, noclose = False):
2093
1623
"""See daemon(3). Standard BSD Unix function.
2094
1624
2097
1627
sys.exit()
2098
1628
os.setsid()
2099
1629
if not nochdir:
2100
os.chdir("/")
1630
os.chdir(u"/")
2101
1631
if os.fork():
2102
1632
sys.exit()
2103
1633
if not noclose:
2104
1634
# Close all standard open file descriptors
2105
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1635
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2106
1636
if not stat.S_ISCHR(os.fstat(null).st_mode):
2107
1637
raise OSError(errno.ENODEV,
2108
"{0} not a character device"
2109
.format(os.devnull))
1638
u"%s not a character device"
1639
% os.path.devnull)
2110
1640
os.dup2(null, sys.stdin.fileno())
2111
1641
os.dup2(null, sys.stdout.fileno())
2112
1642
os.dup2(null, sys.stderr.fileno())
2119
1649
##################################################################
2120
1650
# Parsing of options, both command line and config file
2121
1651
2122
parser = argparse.ArgumentParser()
2123
parser.add_argument("-v", "--version", action="version",
2124
version = "%(prog)s {0}".format(version),
2125
help="show version number and exit")
2126
parser.add_argument("-i", "--interface", metavar="IF",
2127
help="Bind to interface IF")
2128
parser.add_argument("-a", "--address",
2129
help="Address to listen for requests on")
2130
parser.add_argument("-p", "--port", type=int,
2131
help="Port number to receive requests on")
2132
parser.add_argument("--check", action="store_true",
2133
help="Run self-test")
2134
parser.add_argument("--debug", action="store_true",
2135
help="Debug mode; run in foreground and log"
2136
" to terminal")
2137
parser.add_argument("--debuglevel", metavar="LEVEL",
2138
help="Debug level for stdout output")
2139
parser.add_argument("--priority", help="GnuTLS"
2140
" priority string (see GnuTLS documentation)")
2141
parser.add_argument("--servicename",
2142
metavar="NAME", help="Zeroconf service name")
2143
parser.add_argument("--configdir",
2144
default="/etc/mandos", metavar="DIR",
2145
help="Directory to search for configuration"
2146
" files")
2147
parser.add_argument("--no-dbus", action="store_false",
2148
dest="use_dbus", help="Do not provide D-Bus"
2149
" system bus interface")
2150
parser.add_argument("--no-ipv6", action="store_false",
2151
dest="use_ipv6", help="Do not use IPv6")
2152
parser.add_argument("--no-restore", action="store_false",
2153
dest="restore", help="Do not restore stored"
2154
" state")
2155
parser.add_argument("--statedir", metavar="DIR",
2156
help="Directory to save/restore state in")
2157
2158
options = parser.parse_args()
1652
parser = optparse.OptionParser(version = "%%prog %s" % version)
1653
parser.add_option("-i", u"--interface", type=u"string",
1654
metavar="IF", help=u"Bind to interface IF")
1655
parser.add_option("-a", u"--address", type=u"string",
1656
help=u"Address to listen for requests on")
1657
parser.add_option("-p", u"--port", type=u"int",
1658
help=u"Port number to receive requests on")
1659
parser.add_option("--check", action=u"store_true",
1660
help=u"Run self-test")
1661
parser.add_option("--debug", action=u"store_true",
1662
help=u"Debug mode; run in foreground and log to"
1663
u" terminal")
1664
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1665
help=u"Debug level for stdout output")
1666
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1667
u" priority string (see GnuTLS documentation)")
1668
parser.add_option("--servicename", type=u"string",
1669
metavar=u"NAME", help=u"Zeroconf service name")
1670
parser.add_option("--configdir", type=u"string",
1671
default=u"/etc/mandos", metavar=u"DIR",
1672
help=u"Directory to search for configuration"
1673
u" files")
1674
parser.add_option("--no-dbus", action=u"store_false",
1675
dest=u"use_dbus", help=u"Do not provide D-Bus"
1676
u" system bus interface")
1677
parser.add_option("--no-ipv6", action=u"store_false",
1678
dest=u"use_ipv6", help=u"Do not use IPv6")
1679
options = parser.parse_args()[0]
2159
1680
2160
1681
if options.check:
2161
1682
import doctest
2163
1684
sys.exit()
2164
1685
2165
1686
# Default values for config file for server-global settings
2166
server_defaults = { "interface": "",
2167
"address": "",
2168
"port": "",
2169
"debug": "False",
2170
"priority":
2171
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2172
"servicename": "Mandos",
2173
"use_dbus": "True",
2174
"use_ipv6": "True",
2175
"debuglevel": "",
2176
"restore": "True",
2177
"statedir": "/var/lib/mandos"
1687
server_defaults = { u"interface": u"",
1688
u"address": u"",
1689
u"port": u"",
1690
u"debug": u"False",
1691
u"priority":
1692
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1693
u"servicename": u"Mandos",
1694
u"use_dbus": u"True",
1695
u"use_ipv6": u"True",
1696
u"debuglevel": u"",
2178
1697
}
2179
1698
2180
1699
# Parse config file for server-global settings
2181
1700
server_config = configparser.SafeConfigParser(server_defaults)
2182
1701
del server_defaults
2183
1702
server_config.read(os.path.join(options.configdir,
2184
"mandos.conf"))
1703
u"mandos.conf"))
2185
1704
# Convert the SafeConfigParser object to a dict
2186
1705
server_settings = server_config.defaults()
2187
1706
# Use the appropriate methods on the non-string config options
2188
for option in ("debug", "use_dbus", "use_ipv6"):
2189
server_settings[option] = server_config.getboolean("DEFAULT",
1707
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1708
server_settings[option] = server_config.getboolean(u"DEFAULT",
2190
1709
option)
2191
1710
if server_settings["port"]:
2192
server_settings["port"] = server_config.getint("DEFAULT",
2193
"port")
1711
server_settings["port"] = server_config.getint(u"DEFAULT",
1712
u"port")
2194
1713
del server_config
2195
1714
2196
1715
# Override the settings from the config file with command line
2197
1716
# options, if set.
2198
for option in ("interface", "address", "port", "debug",
2199
"priority", "servicename", "configdir",
2200
"use_dbus", "use_ipv6", "debuglevel", "restore",
2201
"statedir"):
1717
for option in (u"interface", u"address", u"port", u"debug",
1718
u"priority", u"servicename", u"configdir",
1719
u"use_dbus", u"use_ipv6", u"debuglevel"):
2202
1720
value = getattr(options, option)
2203
1721
if value is not None:
2204
1722
server_settings[option] = value
2212
1730
##################################################################
2213
1731
2214
1732
# For convenience
2215
debug = server_settings["debug"]
2216
debuglevel = server_settings["debuglevel"]
2217
use_dbus = server_settings["use_dbus"]
2218
use_ipv6 = server_settings["use_ipv6"]
2219
stored_state_path = os.path.join(server_settings["statedir"],
2220
stored_state_file)
2221
2222
if debug:
2223
initlogger(debug, logging.DEBUG)
2224
else:
2225
if not debuglevel:
2226
initlogger(debug)
2227
else:
2228
level = getattr(logging, debuglevel.upper())
2229
initlogger(debug, level)
2230
2231
if server_settings["servicename"] != "Mandos":
1733
debug = server_settings[u"debug"]
1734
debuglevel = server_settings[u"debuglevel"]
1735
use_dbus = server_settings[u"use_dbus"]
1736
use_ipv6 = server_settings[u"use_ipv6"]
1737
1738
if server_settings[u"servicename"] != u"Mandos":
2232
1739
syslogger.setFormatter(logging.Formatter
2233
('Mandos ({0}) [%(process)d]:'
2234
' %(levelname)s: %(message)s'
2235
.format(server_settings
2236
["servicename"])))
1740
(u'Mandos (%s) [%%(process)d]:'
1741
u' %%(levelname)s: %%(message)s'
1742
% server_settings[u"servicename"]))
2237
1743
2238
1744
# Parse config file with clients
2239
client_config = configparser.SafeConfigParser(Client
2240
.client_defaults)
2241
client_config.read(os.path.join(server_settings["configdir"],
2242
"clients.conf"))
1745
client_defaults = { u"timeout": u"1h",
1746
u"interval": u"5m",
1747
u"checker": u"fping -q -- %%(host)s",
1748
u"host": u"",
1749
u"approval_delay": u"0s",
1750
u"approval_duration": u"1s",
1751
}
1752
client_config = configparser.SafeConfigParser(client_defaults)
1753
client_config.read(os.path.join(server_settings[u"configdir"],
1754
u"clients.conf"))
2243
1755
2244
1756
global mandos_dbus_service
2245
1757
mandos_dbus_service = None
2246
1758
2247
tcp_server = MandosServer((server_settings["address"],
2248
server_settings["port"]),
1759
tcp_server = MandosServer((server_settings[u"address"],
1760
server_settings[u"port"]),
2249
1761
ClientHandler,
2250
interface=(server_settings["interface"]
1762
interface=(server_settings[u"interface"]
2251
1763
or None),
2252
1764
use_ipv6=use_ipv6,
2253
1765
gnutls_priority=
2254
server_settings["priority"],
1766
server_settings[u"priority"],
2255
1767
use_dbus=use_dbus)
2256
1768
if not debug:
2257
pidfilename = "/var/run/mandos.pid"
1769
pidfilename = u"/var/run/mandos.pid"
2258
1770
try:
2259
pidfile = open(pidfilename, "w")
2260
except IOError as e:
2261
logger.error("Could not open file %r", pidfilename,
2262
exc_info=e)
1771
pidfile = open(pidfilename, u"w")
1772
except IOError:
1773
logger.error(u"Could not open file %r", pidfilename)
2263
1774
2264
for name in ("_mandos", "mandos", "nobody"):
1775
try:
1776
uid = pwd.getpwnam(u"_mandos").pw_uid
1777
gid = pwd.getpwnam(u"_mandos").pw_gid
1778
except KeyError:
2265
1779
try:
2266
uid = pwd.getpwnam(name).pw_uid
2267
gid = pwd.getpwnam(name).pw_gid
2268
break
1780
uid = pwd.getpwnam(u"mandos").pw_uid
1781
gid = pwd.getpwnam(u"mandos").pw_gid
2269
1782
except KeyError:
2270
continue
2271
else:
2272
uid = 65534
2273
gid = 65534
1783
try:
1784
uid = pwd.getpwnam(u"nobody").pw_uid
1785
gid = pwd.getpwnam(u"nobody").pw_gid
1786
except KeyError:
1787
uid = 65534
1788
gid = 65534
2274
1789
try:
2275
1790
os.setgid(gid)
2276
1791
os.setuid(uid)
2277
except OSError as error:
1792
except OSError, error:
2278
1793
if error[0] != errno.EPERM:
2279
1794
raise error
2280
1795
1796
if not debug and not debuglevel:
1797
syslogger.setLevel(logging.WARNING)
1798
console.setLevel(logging.WARNING)
1799
if debuglevel:
1800
level = getattr(logging, debuglevel.upper())
1801
syslogger.setLevel(level)
1802
console.setLevel(level)
1803
2281
1804
if debug:
2282
1805
# Enable all possible GnuTLS debugging
2283
1806
2287
1810
2288
1811
@gnutls.library.types.gnutls_log_func
2289
1812
def debug_gnutls(level, string):
2290
logger.debug("GnuTLS: %s", string[:-1])
1813
logger.debug(u"GnuTLS: %s", string[:-1])
2291
1814
2292
1815
(gnutls.library.functions
2293
1816
.gnutls_global_set_log_function(debug_gnutls))
2294
1817
2295
1818
# Redirect stdin so all checkers get /dev/null
2296
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1819
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2297
1820
os.dup2(null, sys.stdin.fileno())
2298
1821
if null > 2:
2299
1822
os.close(null)
2300
2301
# Need to fork before connecting to D-Bus
2302
if not debug:
2303
# Close all input and output, do double fork, etc.
2304
daemon()
2305
2306
gobject.threads_init()
1823
else:
1824
# No console logging
1825
logger.removeHandler(console)
1826
2307
1827
2308
1828
global main_loop
2309
1829
# From the Avahi example code
2310
DBusGMainLoop(set_as_default=True)
1830
DBusGMainLoop(set_as_default=True )
2311
1831
main_loop = gobject.MainLoop()
2312
1832
bus = dbus.SystemBus()
2313
1833
# End of Avahi example code
2314
1834
if use_dbus:
2315
1835
try:
2316
bus_name = dbus.service.BusName("se.recompile.Mandos",
1836
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2317
1837
bus, do_not_queue=True)
2318
old_bus_name = (dbus.service.BusName
2319
("se.bsnet.fukt.Mandos", bus,
2320
do_not_queue=True))
2321
except dbus.exceptions.NameExistsException as e:
2322
logger.error("Disabling D-Bus:", exc_info=e)
1838
except dbus.exceptions.NameExistsException, e:
1839
logger.error(unicode(e) + u", disabling D-Bus")
2323
1840
use_dbus = False
2324
server_settings["use_dbus"] = False
1841
server_settings[u"use_dbus"] = False
2325
1842
tcp_server.use_dbus = False
2326
1843
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2327
service = AvahiServiceToSyslog(name =
2328
server_settings["servicename"],
2329
servicetype = "_mandos._tcp",
2330
protocol = protocol, bus = bus)
1844
service = AvahiService(name = server_settings[u"servicename"],
1845
servicetype = u"_mandos._tcp",
1846
protocol = protocol, bus = bus)
2331
1847
if server_settings["interface"]:
2332
1848
service.interface = (if_nametoindex
2333
(str(server_settings["interface"])))
2334
1849
(str(server_settings[u"interface"])))
1850
1851
if not debug:
1852
# Close all input and output, do double fork, etc.
1853
daemon()
1854
2335
1855
global multiprocessing_manager
2336
1856
multiprocessing_manager = multiprocessing.Manager()
2337
1857
2338
1858
client_class = Client
2339
1859
if use_dbus:
2340
client_class = functools.partial(ClientDBusTransitional,
2341
bus = bus)
2342
2343
client_settings = Client.config_parser(client_config)
2344
old_client_settings = {}
2345
clients_data = {}
2346
2347
# Get client data and settings from last running state.
2348
if server_settings["restore"]:
2349
try:
2350
with open(stored_state_path, "rb") as stored_state:
2351
clients_data, old_client_settings = (pickle.load
2352
(stored_state))
2353
os.remove(stored_state_path)
2354
except IOError as e:
2355
if e.errno == errno.ENOENT:
2356
logger.warning("Could not load persistent state: {0}"
2357
.format(os.strerror(e.errno)))
2358
else:
2359
logger.critical("Could not load persistent state:",
2360
exc_info=e)
2361
raise
2362
except EOFError as e:
2363
logger.warning("Could not load persistent state: "
2364
"EOFError:", exc_info=e)
2365
2366
with PGPEngine() as pgp:
2367
for client_name, client in clients_data.iteritems():
2368
# Decide which value to use after restoring saved state.
2369
# We have three different values: Old config file,
2370
# new config file, and saved state.
2371
# New config value takes precedence if it differs from old
2372
# config value, otherwise use saved state.
2373
for name, value in client_settings[client_name].items():
2374
try:
2375
# For each value in new config, check if it
2376
# differs from the old config value (Except for
2377
# the "secret" attribute)
2378
if (name != "secret" and
2379
value != old_client_settings[client_name]
2380
[name]):
2381
client[name] = value
2382
except KeyError:
2383
pass
2384
2385
# Clients who has passed its expire date can still be
2386
# enabled if its last checker was successful. Clients
2387
# whose checker succeeded before we stored its state is
2388
# assumed to have successfully run all checkers during
2389
# downtime.
2390
if client["enabled"]:
2391
if datetime.datetime.utcnow() >= client["expires"]:
2392
if not client["last_checked_ok"]:
2393
logger.warning(
2394
"disabling client {0} - Client never "
2395
"performed a successful checker"
2396
.format(client_name))
2397
client["enabled"] = False
2398
elif client["last_checker_status"] != 0:
2399
logger.warning(
2400
"disabling client {0} - Client "
2401
"last checker failed with error code {1}"
2402
.format(client_name,
2403
client["last_checker_status"]))
2404
client["enabled"] = False
2405
else:
2406
client["expires"] = (datetime.datetime
2407
.utcnow()
2408
+ client["timeout"])
2409
logger.debug("Last checker succeeded,"
2410
" keeping {0} enabled"
2411
.format(client_name))
1860
client_class = functools.partial(ClientDBus, bus = bus)
1861
def client_config_items(config, section):
1862
special_settings = {
1863
"approved_by_default":
1864
lambda: config.getboolean(section,
1865
"approved_by_default"),
1866
}
1867
for name, value in config.items(section):
2412
1868
try:
2413
client["secret"] = (
2414
pgp.decrypt(client["encrypted_secret"],
2415
client_settings[client_name]
2416
["secret"]))
2417
except PGPError:
2418
# If decryption fails, we use secret from new settings
2419
logger.debug("Failed to decrypt {0} old secret"
2420
.format(client_name))
2421
client["secret"] = (
2422
client_settings[client_name]["secret"])
2423
2424
# Add/remove clients based on new changes made to config
2425
for client_name in (set(old_client_settings)
2426
- set(client_settings)):
2427
del clients_data[client_name]
2428
for client_name in (set(client_settings)
2429
- set(old_client_settings)):
2430
clients_data[client_name] = client_settings[client_name]
2431
2432
# Create all client objects
2433
for client_name, client in clients_data.iteritems():
2434
tcp_server.clients[client_name] = client_class(
2435
name = client_name, settings = client)
2436
1869
yield (name, special_settings[name]())
1870
except KeyError:
1871
yield (name, value)
1872
1873
tcp_server.clients.update(set(
1874
client_class(name = section,
1875
config= dict(client_config_items(
1876
client_config, section)))
1877
for section in client_config.sections()))
2437
1878
if not tcp_server.clients:
2438
logger.warning("No clients defined")
2439
1879
logger.warning(u"No clients defined")
1880
2440
1881
if not debug:
2441
1882
try:
2442
1883
with pidfile:
2443
1884
pid = os.getpid()
2444
pidfile.write(str(pid) + "\n".encode("utf-8"))
1885
pidfile.write(str(pid) + "\n")
2445
1886
del pidfile
2446
1887
except IOError:
2447
logger.error("Could not write to file %r with PID %d",
1888
logger.error(u"Could not write to file %r with PID %d",
2448
1889
pidfilename, pid)
2449
1890
except NameError:
2450
1891
# "pidfile" was never created
2451
1892
pass
2452
1893
del pidfilename
1894
2453
1895
signal.signal(signal.SIGINT, signal.SIG_IGN)
2454
1896
2455
1897
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2456
1898
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2457
1899
2458
1900
if use_dbus:
2459
class MandosDBusService(DBusObjectWithProperties):
1901
class MandosDBusService(dbus.service.Object):
2460
1902
"""A D-Bus proxy object"""
2461
1903
def __init__(self):
2462
dbus.service.Object.__init__(self, bus, "/")
2463
_interface = "se.recompile.Mandos"
2464
2465
@dbus_interface_annotations(_interface)
2466
def _foo(self):
2467
return { "org.freedesktop.DBus.Property"
2468
".EmitsChangedSignal":
2469
"false"}
2470
2471
@dbus.service.signal(_interface, signature="o")
1904
dbus.service.Object.__init__(self, bus, u"/")
1905
_interface = u"se.bsnet.fukt.Mandos"
1906
1907
@dbus.service.signal(_interface, signature=u"o")
2472
1908
def ClientAdded(self, objpath):
2473
1909
"D-Bus signal"
2474
1910
pass
2475
1911
2476
@dbus.service.signal(_interface, signature="ss")
1912
@dbus.service.signal(_interface, signature=u"ss")
2477
1913
def ClientNotFound(self, fingerprint, address):
2478
1914
"D-Bus signal"
2479
1915
pass
2480
1916
2481
@dbus.service.signal(_interface, signature="os")
1917
@dbus.service.signal(_interface, signature=u"os")
2482
1918
def ClientRemoved(self, objpath, name):
2483
1919
"D-Bus signal"
2484
1920
pass
2485
1921
2486
@dbus.service.method(_interface, out_signature="ao")
1922
@dbus.service.method(_interface, out_signature=u"ao")
2487
1923
def GetAllClients(self):
2488
1924
"D-Bus method"
2489
1925
return dbus.Array(c.dbus_object_path
2490
for c in
2491
tcp_server.clients.itervalues())
1926
for c in tcp_server.clients)
2492
1927
2493
1928
@dbus.service.method(_interface,
2494
out_signature="a{oa{sv}}")
1929
out_signature=u"a{oa{sv}}")
2495
1930
def GetAllClientsWithProperties(self):
2496
1931
"D-Bus method"
2497
1932
return dbus.Dictionary(
2498
((c.dbus_object_path, c.GetAll(""))
2499
for c in tcp_server.clients.itervalues()),
2500
signature="oa{sv}")
1933
((c.dbus_object_path, c.GetAll(u""))
1934
for c in tcp_server.clients),
1935
signature=u"oa{sv}")
2501
1936
2502
@dbus.service.method(_interface, in_signature="o")
1937
@dbus.service.method(_interface, in_signature=u"o")
2503
1938
def RemoveClient(self, object_path):
2504
1939
"D-Bus method"
2505
for c in tcp_server.clients.itervalues():
1940
for c in tcp_server.clients:
2506
1941
if c.dbus_object_path == object_path:
2507
del tcp_server.clients[c.name]
1942
tcp_server.clients.remove(c)
2508
1943
c.remove_from_connection()
2509
1944
# Don't signal anything except ClientRemoved
2510
1945
c.disable(quiet=True)
2515
1950
2516
1951
del _interface
2517
1952
2518
class MandosDBusServiceTransitional(MandosDBusService):
2519
__metaclass__ = AlternateDBusNamesMetaclass
2520
mandos_dbus_service = MandosDBusServiceTransitional()
1953
mandos_dbus_service = MandosDBusService()
2521
1954
2522
1955
def cleanup():
2523
1956
"Cleanup function; run on exit"
2524
1957
service.cleanup()
2525
1958
2526
multiprocessing.active_children()
2527
if not (tcp_server.clients or client_settings):
2528
return
2529
2530
# Store client before exiting. Secrets are encrypted with key
2531
# based on what config file has. If config file is
2532
# removed/edited, old secret will thus be unrecovable.
2533
clients = {}
2534
with PGPEngine() as pgp:
2535
for client in tcp_server.clients.itervalues():
2536
key = client_settings[client.name]["secret"]
2537
client.encrypted_secret = pgp.encrypt(client.secret,
2538
key)
2539
client_dict = {}
2540
2541
# A list of attributes that can not be pickled
2542
# + secret.
2543
exclude = set(("bus", "changedstate", "secret",
2544
"checker"))
2545
for name, typ in (inspect.getmembers
2546
(dbus.service.Object)):
2547
exclude.add(name)
2548
2549
client_dict["encrypted_secret"] = (client
2550
.encrypted_secret)
2551
for attr in client.client_structure:
2552
if attr not in exclude:
2553
client_dict[attr] = getattr(client, attr)
2554
2555
clients[client.name] = client_dict
2556
del client_settings[client.name]["secret"]
2557
2558
try:
2559
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2560
prefix="clients-",
2561
dir=os.path.dirname
2562
(stored_state_path))
2563
with os.fdopen(tempfd, "wb") as stored_state:
2564
pickle.dump((clients, client_settings), stored_state)
2565
os.rename(tempname, stored_state_path)
2566
except (IOError, OSError) as e:
2567
if not debug:
2568
try:
2569
os.remove(tempname)
2570
except NameError:
2571
pass
2572
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2573
logger.warning("Could not save persistent state: {0}"
2574
.format(os.strerror(e.errno)))
2575
else:
2576
logger.warning("Could not save persistent state:",
2577
exc_info=e)
2578
raise e
2579
2580
# Delete all clients, and settings from config
2581
1959
while tcp_server.clients:
2582
name, client = tcp_server.clients.popitem()
1960
client = tcp_server.clients.pop()
2583
1961
if use_dbus:
2584
1962
client.remove_from_connection()
1963
client.disable_hook = None
2585
1964
# Don't signal anything except ClientRemoved
2586
1965
client.disable(quiet=True)
2587
1966
if use_dbus:
2588
1967
# Emit D-Bus signal
2589
mandos_dbus_service.ClientRemoved(client
2590
.dbus_object_path,
1968
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2591
1969
client.name)
2592
client_settings.clear()
2593
1970
2594
1971
atexit.register(cleanup)
2595
1972
2596
for client in tcp_server.clients.itervalues():
1973
for client in tcp_server.clients:
2597
1974
if use_dbus:
2598
1975
# Emit D-Bus signal
2599
1976
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2600
# Need to initiate checking of clients
2601
if client.enabled:
2602
client.init_checker()
1977
client.enable()
2603
1978
2604
1979
tcp_server.enable()
2605
1980
tcp_server.server_activate()
2607
1982
# Find out what port we got
2608
1983
service.port = tcp_server.socket.getsockname()[1]
2609
1984
if use_ipv6:
2610
logger.info("Now listening on address %r, port %d,"
2611
" flowinfo %d, scope_id %d",
2612
*tcp_server.socket.getsockname())
1985
logger.info(u"Now listening on address %r, port %d,"
1986
" flowinfo %d, scope_id %d"
1987
% tcp_server.socket.getsockname())
2613
1988
else: # IPv4
2614
logger.info("Now listening on address %r, port %d",
2615
*tcp_server.socket.getsockname())
1989
logger.info(u"Now listening on address %r, port %d"
1990
% tcp_server.socket.getsockname())
2616
1991
2617
1992
#service.interface = tcp_server.socket.getsockname()[3]
2618
1993
2620
1995
# From the Avahi example code
2621
1996
try:
2622
1997
service.activate()
2623
except dbus.exceptions.DBusException as error:
2624
logger.critical("D-Bus Exception", exc_info=error)
1998
except dbus.exceptions.DBusException, error:
1999
logger.critical(u"DBusException: %s", error)
2625
2000
cleanup()
2626
2001
sys.exit(1)
2627
2002
# End of Avahi example code
2631
2006
(tcp_server.handle_request
2632
2007
(*args[2:], **kwargs) or True))
2633
2008
2634
logger.debug("Starting main loop")
2009
logger.debug(u"Starting main loop")
2635
2010
main_loop.run()
2636
except AvahiError as error:
2637
logger.critical("Avahi Error", exc_info=error)
2011
except AvahiError, error:
2012
logger.critical(u"AvahiError: %s", error)
2638
2013
cleanup()
2639
2014
sys.exit(1)
2640
2015
except KeyboardInterrupt:
2641
2016
if debug:
2642
print("", file=sys.stderr)
2643
logger.debug("Server received KeyboardInterrupt")
2644
logger.debug("Server exiting")
2017
print >> sys.stderr
2018
logger.debug(u"Server received KeyboardInterrupt")
2019
logger.debug(u"Server exiting")
2645
2020
# Must run before the D-Bus bus name gets deregistered
2646
2021
cleanup()
2647
2022
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0