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