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