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