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