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