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