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