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 654
- compare with another revision
- download diff
- download tarball
- view history from revision 654
- Committer: Teddy Hogeborn
- Date: 2014-02-16 02:42:42 UTC
- Revision ID: teddy@recompile.se-20140216024242-9wiw1nkxgt7ohovj
Fix running of self-tests.
* debian/control (Build-Depends): Add Python dependencies to
successfully run self-tests.
* debian/copyright: GPLv3 now has its own license file - use it.
* debian/watch: Set PGP signature URL.
* mandos (main): Bug fix: When running self-tests, set exit code.
* mandos-ctl (main): Cosmetic fix; use os.EX_OK instead of plain 0.
* debian/control (Build-Depends): Add Python dependencies to
successfully run self-tests.
* debian/copyright: GPLv3 now has its own license file - use it.
* debian/watch: Set PGP signature URL.
* mandos (main): Bug fix: When running self-tests, set exit code.
* mandos-ctl (main): Cosmetic fix; use os.EX_OK instead of plain 0.
- files added:
- DBUS-API
- debian/source
- network-hooks.d
- files removed:
- plugins.d/plymouth
- files modified:
- .bzrignore
added
removed
mandos
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 Björn Påhlsson
14
# Copyright © 2008-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 Björn Påhlsson
16
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
#
31
# Contact the authors at <mandos@fukt.bsnet.se>.
31
# Contact the authors at <mandos@recompile.se>.
32
32
#
33
33
34
from __future__ import division, with_statement, absolute_import
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
36
37
from future_builtins import *
35
38
36
39
import SocketServer as socketserver
37
40
import socket
38
import optparse
41
import argparse
39
42
import datetime
40
43
import errno
41
44
import gnutls.crypto
61
64
import functools
62
65
import cPickle as pickle
63
66
import multiprocessing
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
import collections
64
72
65
73
import dbus
66
74
import dbus.service
80
88
except ImportError:
81
89
SO_BINDTODEVICE = None
82
90
83
84
version = "1.0.14"
85
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
91
version = "1.6.3"
92
stored_state_file = "clients.pickle"
93
94
logger = logging.getLogger()
88
95
syslogger = (logging.handlers.SysLogHandler
89
96
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
93
u' %(message)s'))
94
logger.addHandler(syslogger)
95
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
u' %(levelname)s:'
99
u' %(message)s'))
100
logger.addHandler(console)
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
101
220
102
221
class AvahiError(Exception):
103
222
def __init__(self, value, *args, **kwargs):
119
238
Attributes:
120
239
interface: integer; avahi.IF_UNSPEC or an interface index.
121
240
Used to optionally bind to the specified interface.
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
241
name: string; Example: 'Mandos'
242
type: string; Example: '_mandos._tcp'.
243
See <https://www.iana.org/assignments/service-names-port-numbers>
125
244
port: integer; what port to announce
126
245
TXT: list of strings; TXT record for the service
127
246
domain: string; Domain to publish on, default to .local if empty.
133
252
server: D-Bus Server
134
253
bus: dbus.SystemBus()
135
254
"""
255
136
256
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
137
257
servicetype = None, port = None, TXT = None,
138
domain = u"", host = u"", max_renames = 32768,
258
domain = "", host = "", max_renames = 32768,
139
259
protocol = avahi.PROTO_UNSPEC, bus = None):
140
260
self.interface = interface
141
261
self.name = name
150
270
self.group = None # our entry group
151
271
self.server = None
152
272
self.bus = bus
273
self.entry_group_state_changed_match = None
274
153
275
def rename(self):
154
276
"""Derived from the Avahi example code"""
155
277
if self.rename_count >= self.max_renames:
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
278
logger.critical("No suitable Zeroconf service name found"
279
" after %i retries, exiting.",
158
280
self.rename_count)
159
raise AvahiServiceError(u"Too many renames")
160
self.name = self.server.GetAlternativeServiceName(self.name)
161
logger.info(u"Changing Zeroconf service name to %r ...",
162
unicode(self.name))
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
166
% self.name))
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 ...",
285
self.name)
167
286
self.remove()
168
self.add()
287
try:
288
self.add()
289
except dbus.exceptions.DBusException as error:
290
logger.critical("D-Bus Exception", exc_info=error)
291
self.cleanup()
292
os._exit(1)
169
293
self.rename_count += 1
294
170
295
def remove(self):
171
296
"""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
172
300
if self.group is not None:
173
301
self.group.Reset()
302
174
303
def add(self):
175
304
"""Derived from the Avahi example code"""
305
self.remove()
176
306
if self.group is None:
177
307
self.group = dbus.Interface(
178
308
self.bus.get_object(avahi.DBUS_NAME,
179
309
self.server.EntryGroupNew()),
180
310
avahi.DBUS_INTERFACE_ENTRY_GROUP)
181
self.group.connect_to_signal('StateChanged',
182
self
183
.entry_group_state_changed)
184
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
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' ...",
185
315
self.name, self.type)
186
316
self.group.AddService(
187
317
self.interface,
192
322
dbus.UInt16(self.port),
193
323
avahi.string_array_to_txt_array(self.TXT))
194
324
self.group.Commit()
325
195
326
def entry_group_state_changed(self, state, error):
196
327
"""Derived from the Avahi example code"""
197
logger.debug(u"Avahi state change: %i", state)
328
logger.debug("Avahi entry group state change: %i", state)
198
329
199
330
if state == avahi.ENTRY_GROUP_ESTABLISHED:
200
logger.debug(u"Zeroconf service established.")
331
logger.debug("Zeroconf service established.")
201
332
elif state == avahi.ENTRY_GROUP_COLLISION:
202
logger.warning(u"Zeroconf service name collision.")
333
logger.info("Zeroconf service name collision.")
203
334
self.rename()
204
335
elif state == avahi.ENTRY_GROUP_FAILURE:
205
logger.critical(u"Avahi: Error in group state changed %s",
336
logger.critical("Avahi: Error in group state changed %s",
206
337
unicode(error))
207
raise AvahiGroupError(u"State changed: %s"
208
% unicode(error))
338
raise AvahiGroupError("State changed: {0!s}"
339
.format(error))
340
209
341
def cleanup(self):
210
342
"""Derived from the Avahi example code"""
211
343
if self.group is not None:
212
self.group.Free()
344
try:
345
self.group.Free()
346
except (dbus.exceptions.UnknownMethodException,
347
dbus.exceptions.DBusException):
348
pass
213
349
self.group = None
214
def server_state_changed(self, state):
350
self.remove()
351
352
def server_state_changed(self, state, error=None):
215
353
"""Derived from the Avahi example code"""
216
if state == avahi.SERVER_COLLISION:
217
logger.error(u"Zeroconf server name collision")
218
self.remove()
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()
219
369
elif state == avahi.SERVER_RUNNING:
220
370
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
221
377
def activate(self):
222
378
"""Derived from the Avahi example code"""
223
379
if self.server is None:
224
380
self.server = dbus.Interface(
225
381
self.bus.get_object(avahi.DBUS_NAME,
226
avahi.DBUS_PATH_SERVER),
382
avahi.DBUS_PATH_SERVER,
383
follow_name_owner_changes=True),
227
384
avahi.DBUS_INTERFACE_SERVER)
228
self.server.connect_to_signal(u"StateChanged",
385
self.server.connect_to_signal("StateChanged",
229
386
self.server_state_changed)
230
387
self.server_state_changed(self.server.GetState())
231
388
232
389
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
233
408
class Client(object):
234
409
"""A representation of a client host served by this server.
235
410
236
411
Attributes:
237
name: string; from the config file, used in log messages and
238
D-Bus identifiers
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
415
checker: subprocess.Popen(); a running checker process used
416
to see if the client lives.
417
'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
421
runtime with vars(self) as dict, so that for
422
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
current_checker_command: string; current running checker_command
428
disable_initiator_tag: a gobject event source tag, or None
429
enabled: bool()
239
430
fingerprint: string (40 or 32 hexadecimal digits); used to
240
431
uniquely identify the client
241
secret: bytestring; sent verbatim (over TLS) to client
242
432
host: string; available for use by the checker command
243
created: datetime.datetime(); (UTC) object creation
244
last_enabled: datetime.datetime(); (UTC)
245
enabled: bool()
433
interval: datetime.timedelta(); How often to start a new checker
434
last_approval_request: datetime.datetime(); (UTC) or None
246
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
247
443
timeout: datetime.timedelta(); How long from last_checked_ok
248
444
until this client is disabled
249
interval: datetime.timedelta(); How often to start a new checker
250
disable_hook: If set, called by disable() as disable_hook(self)
251
checker: subprocess.Popen(); a running checker process used
252
to see if the client lives.
253
'None' if no process is running.
254
checker_initiator_tag: a gobject event source tag, or None
255
disable_initiator_tag: - '' -
256
checker_callback_tag: - '' -
257
checker_command: string; External command which is run to check if
258
client lives. %() expansions are done at
259
runtime with vars(self) as dict, so that for
260
instance %(name)s can be used in the command.
261
current_checker_command: string; current running checker_command
262
approved_delay: datetime.timedelta(); Time to wait for approval
263
_approved: bool(); 'None' if not yet approved/disapproved
264
approved_duration: datetime.timedelta(); Duration of one approval
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()
265
450
"""
266
451
267
@staticmethod
268
def _timedelta_to_milliseconds(td):
269
"Convert a datetime.timedelta() to milliseconds"
270
return ((td.days * 24 * 60 * 60 * 1000)
271
+ (td.seconds * 1000)
272
+ (td.microseconds // 1000))
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
467
274
468
def timeout_milliseconds(self):
275
469
"Return the 'timeout' attribute in milliseconds"
276
return self._timedelta_to_milliseconds(self.timeout)
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)
277
475
278
476
def interval_milliseconds(self):
279
477
"Return the 'interval' attribute in milliseconds"
280
return self._timedelta_to_milliseconds(self.interval)
281
282
def approved_delay_milliseconds(self):
283
return self._timedelta_to_milliseconds(self.approved_delay)
284
285
def __init__(self, name = None, disable_hook=None, config=None):
286
"""Note: the 'checker' key in 'config' sets the
287
'checker_command' attribute and *not* the 'checker'
288
attribute."""
478
return timedelta_to_milliseconds(self.interval)
479
480
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
531
self.name = name
290
if config is None:
291
config = {}
292
logger.debug(u"Creating client %r", self.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)
293
550
# Uppercase and remove spaces from fingerprint for later
294
551
# comparison purposes with return value from the fingerprint()
295
552
# function
296
self.fingerprint = (config[u"fingerprint"].upper()
297
.replace(u" ", u""))
298
logger.debug(u" Fingerprint: %s", self.fingerprint)
299
if u"secret" in config:
300
self.secret = config[u"secret"].decode(u"base64")
301
elif u"secfile" in config:
302
with open(os.path.expanduser(os.path.expandvars
303
(config[u"secfile"])),
304
"rb") as secfile:
305
self.secret = secfile.read()
306
else:
307
#XXX Need to allow secret on demand!
308
raise TypeError(u"No secret or secfile for client %s"
309
% self.name)
310
self.host = config.get(u"host", u"")
311
self.created = datetime.datetime.utcnow()
312
self.enabled = False
313
self.last_enabled = None
314
self.last_checked_ok = None
315
self.timeout = string_to_delta(config[u"timeout"])
316
self.interval = string_to_delta(config[u"interval"])
317
self.disable_hook = disable_hook
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
318
558
self.checker = None
319
559
self.checker_initiator_tag = None
320
560
self.disable_initiator_tag = None
321
561
self.checker_callback_tag = None
322
self.checker_command = config[u"checker"]
323
562
self.current_checker_command = None
324
self.last_connect = None
325
self._approved = None
326
self.approved_by_default = config.get(u"approved_by_default",
327
True)
563
self.approved = None
328
564
self.approvals_pending = 0
329
self.approved_delay = string_to_delta(
330
config[u"approved_delay"])
331
self.approved_duration = string_to_delta(
332
config[u"approved_duration"])
333
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
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
579
580
# Send notice to process children that client state has changed
335
581
def send_changedstate(self):
336
self.changedstate.acquire()
337
self.changedstate.notify_all()
338
self.changedstate.release()
339
582
with self.changedstate:
583
self.changedstate.notify_all()
584
340
585
def enable(self):
341
586
"""Start this client's checker and timeout hooks"""
342
if getattr(self, u"enabled", False):
587
if getattr(self, "enabled", False):
343
588
# Already enabled
344
589
return
345
self.send_changedstate()
590
self.expires = datetime.datetime.utcnow() + self.timeout
591
self.enabled = True
346
592
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):
347
620
# Schedule a new checker to be started an 'interval' from now,
348
621
# and every interval from then on.
622
if self.checker_initiator_tag is not None:
623
gobject.source_remove(self.checker_initiator_tag)
349
624
self.checker_initiator_tag = (gobject.timeout_add
350
625
(self.interval_milliseconds(),
351
626
self.start_checker))
352
627
# Schedule a disable() when 'timeout' has passed
628
if self.disable_initiator_tag is not None:
629
gobject.source_remove(self.disable_initiator_tag)
353
630
self.disable_initiator_tag = (gobject.timeout_add
354
631
(self.timeout_milliseconds(),
355
632
self.disable))
356
self.enabled = True
357
633
# Also start a new checker *right now*.
358
634
self.start_checker()
359
635
360
def disable(self, quiet=True):
361
"""Disable this client."""
362
if not getattr(self, "enabled", False):
363
return False
364
if not quiet:
365
self.send_changedstate()
366
if not quiet:
367
logger.info(u"Disabling client %s", self.name)
368
if getattr(self, u"disable_initiator_tag", False):
369
gobject.source_remove(self.disable_initiator_tag)
370
self.disable_initiator_tag = None
371
if getattr(self, u"checker_initiator_tag", False):
372
gobject.source_remove(self.checker_initiator_tag)
373
self.checker_initiator_tag = None
374
self.stop_checker()
375
if self.disable_hook:
376
self.disable_hook(self)
377
self.enabled = False
378
# Do not run this again if called by a gobject.timeout_add
379
return False
380
381
def __del__(self):
382
self.disable_hook = None
383
self.disable()
384
385
636
def checker_callback(self, pid, condition, command):
386
637
"""The checker has completed, so take appropriate actions."""
387
638
self.checker_callback_tag = None
388
639
self.checker = None
389
640
if os.WIFEXITED(condition):
390
exitstatus = os.WEXITSTATUS(condition)
391
if exitstatus == 0:
392
logger.info(u"Checker for %(name)s succeeded",
641
self.last_checker_status = os.WEXITSTATUS(condition)
642
if self.last_checker_status == 0:
643
logger.info("Checker for %(name)s succeeded",
393
644
vars(self))
394
645
self.checked_ok()
395
646
else:
396
logger.info(u"Checker for %(name)s failed",
647
logger.info("Checker for %(name)s failed",
397
648
vars(self))
398
649
else:
399
logger.warning(u"Checker for %(name)s crashed?",
650
self.last_checker_status = -1
651
logger.warning("Checker for %(name)s crashed?",
400
652
vars(self))
401
653
402
654
def checked_ok(self):
403
"""Bump up the timeout for this client.
404
405
This should only be called when the client has been seen,
406
alive and well.
407
"""
655
"""Assert that the client has been seen, alive and well."""
408
656
self.last_checked_ok = datetime.datetime.utcnow()
409
gobject.source_remove(self.disable_initiator_tag)
410
self.disable_initiator_tag = (gobject.timeout_add
411
(self.timeout_milliseconds(),
412
self.disable))
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()
413
675
414
676
def start_checker(self):
415
677
"""Start a new checker subprocess if one is not running.
417
679
If a checker already exists, leave it running and do
418
680
nothing."""
419
681
# The reason for not killing a running checker is that if we
420
# did that, then if a checker (for some reason) started
421
# running slowly and taking more than 'interval' time, the
422
# client would inevitably timeout, since no checker would get
423
# a chance to run to completion. If we instead leave running
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
424
686
# checkers alone, the checker would have to take more time
425
687
# than 'timeout' for the client to be disabled, which is as it
426
688
# should be.
428
690
# If a checker exists, make sure it is not a zombie
429
691
try:
430
692
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
431
except (AttributeError, OSError), error:
432
if (isinstance(error, OSError)
433
and error.errno != errno.ECHILD):
434
raise error
693
except AttributeError:
694
pass
695
except OSError as error:
696
if error.errno != errno.ECHILD:
697
raise
435
698
else:
436
699
if pid:
437
logger.warning(u"Checker was a zombie")
700
logger.warning("Checker was a zombie")
438
701
gobject.source_remove(self.checker_callback_tag)
439
702
self.checker_callback(pid, status,
440
703
self.current_checker_command)
441
704
# Start a new checker if needed
442
705
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)
443
711
try:
444
# In case checker_command has exactly one % operator
445
command = self.checker_command % self.host
446
except TypeError:
447
# Escape attributes for the shell
448
escaped_attrs = dict((key,
449
re.escape(unicode(str(val),
450
errors=
451
u'replace')))
452
for key, val in
453
vars(self).iteritems())
454
try:
455
command = self.checker_command % escaped_attrs
456
except TypeError, error:
457
logger.error(u'Could not format string "%s":'
458
u' %s', self.checker_command, error)
459
return True # Try again later
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
460
717
self.current_checker_command = command
461
718
try:
462
logger.info(u"Starting checker %r for %s",
719
logger.info("Starting checker %r for %s",
463
720
command, self.name)
464
721
# We don't need to redirect stdout and stderr, since
465
722
# in normal mode, that is already done by daemon(),
466
723
# and in debug mode we don't want to. (Stdin is
467
724
# 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 })
468
733
self.checker = subprocess.Popen(command,
469
734
close_fds=True,
470
shell=True, cwd=u"/")
471
self.checker_callback_tag = (gobject.child_watch_add
472
(self.checker.pid,
473
self.checker_callback,
474
data=command))
475
# The checker may have completed before the gobject
476
# watch was added. Check for this.
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:
477
748
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
478
if pid:
479
gobject.source_remove(self.checker_callback_tag)
480
self.checker_callback(pid, status, command)
481
except OSError, error:
482
logger.error(u"Failed to start subprocess: %s",
483
error)
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)
484
759
# Re-run this periodically if run by gobject.timeout_add
485
760
return True
486
761
489
764
if self.checker_callback_tag:
490
765
gobject.source_remove(self.checker_callback_tag)
491
766
self.checker_callback_tag = None
492
if getattr(self, u"checker", None) is None:
767
if getattr(self, "checker", None) is None:
493
768
return
494
logger.debug(u"Stopping checker for %(name)s", vars(self))
769
logger.debug("Stopping checker for %(name)s", vars(self))
495
770
try:
496
os.kill(self.checker.pid, signal.SIGTERM)
771
self.checker.terminate()
497
772
#time.sleep(0.5)
498
773
#if self.checker.poll() is None:
499
# os.kill(self.checker.pid, signal.SIGKILL)
500
except OSError, error:
774
# self.checker.kill()
775
except OSError as error:
501
776
if error.errno != errno.ESRCH: # No such process
502
777
raise
503
778
self.checker = None
504
779
505
def dbus_service_property(dbus_interface, signature=u"v",
506
access=u"readwrite", byte_arrays=False):
780
781
def dbus_service_property(dbus_interface, signature="v",
782
access="readwrite", byte_arrays=False):
507
783
"""Decorators for marking methods of a DBusObjectWithProperties to
508
784
become properties on the D-Bus.
509
785
516
792
"""
517
793
# Encoding deeply encoded byte arrays is not supported yet by the
518
794
# "Set" method, so we fail early here:
519
if byte_arrays and signature != u"ay":
520
raise ValueError(u"Byte arrays not supported for non-'ay'"
521
u" signature %r" % signature)
795
if byte_arrays and signature != "ay":
796
raise ValueError("Byte arrays not supported for non-'ay'"
797
" signature {0!r}".format(signature))
522
798
def decorator(func):
523
799
func._dbus_is_property = True
524
800
func._dbus_interface = dbus_interface
525
801
func._dbus_signature = signature
526
802
func._dbus_access = access
527
803
func._dbus_name = func.__name__
528
if func._dbus_name.endswith(u"_dbus_property"):
804
if func._dbus_name.endswith("_dbus_property"):
529
805
func._dbus_name = func._dbus_name[:-14]
530
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
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
531
844
return func
532
845
return decorator
533
846
553
866
554
867
class DBusObjectWithProperties(dbus.service.Object):
555
868
"""A D-Bus object with properties.
556
869
557
870
Classes inheriting from this can use the dbus_service_property
558
871
decorator to expose methods as D-Bus properties. It exposes the
559
872
standard Get(), Set(), and GetAll() methods on the D-Bus.
560
873
"""
561
874
562
875
@staticmethod
563
def _is_dbus_property(obj):
564
return getattr(obj, u"_dbus_is_property", False)
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)
565
884
566
def _get_all_dbus_properties(self):
885
def _get_all_dbus_things(self, thing):
567
886
"""Returns a generator of (name, attribute) pairs
568
887
"""
569
return ((prop._dbus_name, prop)
570
for name, prop in
571
inspect.getmembers(self, self._is_dbus_property))
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)))
572
895
573
896
def _get_dbus_property(self, interface_name, property_name):
574
897
"""Returns a bound method if one exists which is a D-Bus
575
898
property with the specified name and interface.
576
899
"""
577
for name in (property_name,
578
property_name + u"_dbus_property"):
579
prop = getattr(self, name, None)
580
if (prop is None
581
or not self._is_dbus_property(prop)
582
or prop._dbus_name != property_name
583
or (interface_name and prop._dbus_interface
584
and interface_name != prop._dbus_interface)):
585
continue
586
return prop
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
587
908
# No such property
588
raise DBusPropertyNotFound(self.dbus_object_path + u":"
589
+ interface_name + u"."
909
raise DBusPropertyNotFound(self.dbus_object_path + ":"
910
+ interface_name + "."
590
911
+ property_name)
591
912
592
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
593
out_signature=u"v")
913
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
914
out_signature="v")
594
915
def Get(self, interface_name, property_name):
595
916
"""Standard D-Bus property Get() method, see D-Bus standard.
596
917
"""
597
918
prop = self._get_dbus_property(interface_name, property_name)
598
if prop._dbus_access == u"write":
919
if prop._dbus_access == "write":
599
920
raise DBusPropertyAccessException(property_name)
600
921
value = prop()
601
if not hasattr(value, u"variant_level"):
922
if not hasattr(value, "variant_level"):
602
923
return value
603
924
return type(value)(value, variant_level=value.variant_level+1)
604
925
605
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
926
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
606
927
def Set(self, interface_name, property_name, value):
607
928
"""Standard D-Bus property Set() method, see D-Bus standard.
608
929
"""
609
930
prop = self._get_dbus_property(interface_name, property_name)
610
if prop._dbus_access == u"read":
931
if prop._dbus_access == "read":
611
932
raise DBusPropertyAccessException(property_name)
612
if prop._dbus_get_args_options[u"byte_arrays"]:
933
if prop._dbus_get_args_options["byte_arrays"]:
613
934
# The byte_arrays option is not supported yet on
614
935
# signatures other than "ay".
615
if prop._dbus_signature != u"ay":
616
raise ValueError
617
value = dbus.ByteArray(''.join(unichr(byte)
618
for byte in value))
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))
619
942
prop(value)
620
943
621
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
622
out_signature=u"a{sv}")
944
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
945
out_signature="a{sv}")
623
946
def GetAll(self, interface_name):
624
947
"""Standard D-Bus property GetAll() method, see D-Bus
625
948
standard.
626
949
627
950
Note: Will not include properties with access="write".
628
951
"""
629
all = {}
630
for name, prop in self._get_all_dbus_properties():
952
properties = {}
953
for name, prop in self._get_all_dbus_things("property"):
631
954
if (interface_name
632
955
and interface_name != prop._dbus_interface):
633
956
# Interface non-empty but did not match
634
957
continue
635
958
# Ignore write-only properties
636
if prop._dbus_access == u"write":
959
if prop._dbus_access == "write":
637
960
continue
638
961
value = prop()
639
if not hasattr(value, u"variant_level"):
640
all[name] = value
962
if not hasattr(value, "variant_level"):
963
properties[name] = value
641
964
continue
642
all[name] = type(value)(value, variant_level=
643
value.variant_level+1)
644
return dbus.Dictionary(all, signature=u"sv")
965
properties[name] = type(value)(value, variant_level=
966
value.variant_level+1)
967
return dbus.Dictionary(properties, signature="sv")
645
968
646
969
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
647
out_signature=u"s",
970
out_signature="s",
648
971
path_keyword='object_path',
649
972
connection_keyword='connection')
650
973
def Introspect(self, object_path, connection):
651
"""Standard D-Bus method, overloaded to insert property tags.
974
"""Overloading of standard D-Bus method.
975
976
Inserts property tags and interface annotation tags.
652
977
"""
653
978
xmlstring = dbus.service.Object.Introspect(self, object_path,
654
979
connection)
655
980
try:
656
981
document = xml.dom.minidom.parseString(xmlstring)
657
982
def make_tag(document, name, prop):
658
e = document.createElement(u"property")
659
e.setAttribute(u"name", name)
660
e.setAttribute(u"type", prop._dbus_signature)
661
e.setAttribute(u"access", prop._dbus_access)
983
e = document.createElement("property")
984
e.setAttribute("name", name)
985
e.setAttribute("type", prop._dbus_signature)
986
e.setAttribute("access", prop._dbus_access)
662
987
return e
663
for if_tag in document.getElementsByTagName(u"interface"):
988
for if_tag in document.getElementsByTagName("interface"):
989
# Add property tags
664
990
for tag in (make_tag(document, name, prop)
665
991
for name, prop
666
in self._get_all_dbus_properties()
992
in self._get_all_dbus_things("property")
667
993
if prop._dbus_interface
668
== if_tag.getAttribute(u"name")):
994
== if_tag.getAttribute("name")):
669
995
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)
670
1027
# Add the names to the return values for the
671
1028
# "org.freedesktop.DBus.Properties" methods
672
if (if_tag.getAttribute(u"name")
673
== u"org.freedesktop.DBus.Properties"):
674
for cn in if_tag.getElementsByTagName(u"method"):
675
if cn.getAttribute(u"name") == u"Get":
676
for arg in cn.getElementsByTagName(u"arg"):
677
if (arg.getAttribute(u"direction")
678
== u"out"):
679
arg.setAttribute(u"name", u"value")
680
elif cn.getAttribute(u"name") == u"GetAll":
681
for arg in cn.getElementsByTagName(u"arg"):
682
if (arg.getAttribute(u"direction")
683
== u"out"):
684
arg.setAttribute(u"name", u"props")
685
xmlstring = document.toxml(u"utf-8")
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")
686
1043
document.unlink()
687
1044
except (AttributeError, xml.dom.DOMException,
688
xml.parsers.expat.ExpatError), error:
689
logger.error(u"Failed to override Introspection method",
690
error)
1045
xml.parsers.expat.ExpatError) as error:
1046
logger.error("Failed to override Introspection method",
1047
exc_info=error)
691
1048
return xmlstring
692
1049
693
1050
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"})
694
1230
class ClientDBus(Client, DBusObjectWithProperties):
695
1231
"""A Client class using D-Bus
696
1232
698
1234
dbus_object_path: dbus.ObjectPath
699
1235
bus: dbus.SystemBus()
700
1236
"""
1237
1238
runtime_expansions = (Client.runtime_expansions
1239
+ ("dbus_object_path",))
1240
701
1241
# dbus.service.Object doesn't use super(), so we can't either.
702
1242
703
1243
def __init__(self, bus = None, *args, **kwargs):
704
self._approvals_pending = 0
705
1244
self.bus = bus
706
1245
Client.__init__(self, *args, **kwargs)
707
1246
# Only now, when this client is initialized, can it show up on
708
1247
# the D-Bus
1248
client_object_name = unicode(self.name).translate(
1249
{ord("."): ord("_"),
1250
ord("-"): ord("_")})
709
1251
self.dbus_object_path = (dbus.ObjectPath
710
(u"/clients/"
711
+ self.name.replace(u".", u"_")))
1252
("/clients/" + client_object_name))
712
1253
DBusObjectWithProperties.__init__(self, self.bus,
713
1254
self.dbus_object_path)
714
715
#Could possible return a bool(self._approvals_pending),
716
#but this could mess up approvals_pending += 1 XXX
717
def _get_approvals_pending(self):
718
return self._approvals_pending
719
def _set_approvals_pending(self, value):
720
old_value = self._approvals_pending
721
self._approvals_pending = value
722
bval = bool(value)
723
if (hasattr(self, "dbus_object_path")
724
and bval is not bool(old_value)):
725
dbus_bool = dbus.Boolean(bval, variant_level=1)
726
self.PropertyChanged(dbus.String(u"approved_pending"),
727
dbus_bool)
728
729
approvals_pending = property(_get_approvals_pending,
730
_set_approvals_pending)
731
del _get_approvals_pending, _set_approvals_pending
732
733
@staticmethod
734
def _datetime_to_dbus(dt, variant_level=0):
735
"""Convert a UTC datetime.datetime() to a D-Bus type."""
736
return dbus.String(dt.isoformat(),
737
variant_level=variant_level)
738
739
def enable(self):
740
oldstate = getattr(self, u"enabled", False)
741
r = Client.enable(self)
742
if oldstate != self.enabled:
743
# Emit D-Bus signals
744
self.PropertyChanged(dbus.String(u"enabled"),
745
dbus.Boolean(True, variant_level=1))
746
self.PropertyChanged(
747
dbus.String(u"last_enabled"),
748
self._datetime_to_dbus(self.last_enabled,
749
variant_level=1))
750
return r
751
752
def disable(self, quiet = False):
753
oldstate = getattr(self, u"enabled", False)
754
r = Client.disable(self, quiet=quiet)
755
if not quiet and oldstate != self.enabled:
756
# Emit D-Bus signal
757
self.PropertyChanged(dbus.String(u"enabled"),
758
dbus.Boolean(False, variant_level=1))
759
return r
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
760
1323
761
1324
def __del__(self, *args, **kwargs):
762
1325
try:
763
1326
self.remove_from_connection()
764
1327
except LookupError:
765
1328
pass
766
if hasattr(DBusObjectWithProperties, u"__del__"):
1329
if hasattr(DBusObjectWithProperties, "__del__"):
767
1330
DBusObjectWithProperties.__del__(self, *args, **kwargs)
768
1331
Client.__del__(self, *args, **kwargs)
769
1332
771
1334
*args, **kwargs):
772
1335
self.checker_callback_tag = None
773
1336
self.checker = None
774
# Emit D-Bus signal
775
self.PropertyChanged(dbus.String(u"checker_running"),
776
dbus.Boolean(False, variant_level=1))
777
1337
if os.WIFEXITED(condition):
778
1338
exitstatus = os.WEXITSTATUS(condition)
779
1339
# Emit D-Bus signal
789
1349
return Client.checker_callback(self, pid, condition, command,
790
1350
*args, **kwargs)
791
1351
792
def checked_ok(self, *args, **kwargs):
793
r = Client.checked_ok(self, *args, **kwargs)
794
# Emit D-Bus signal
795
self.PropertyChanged(
796
dbus.String(u"last_checked_ok"),
797
(self._datetime_to_dbus(self.last_checked_ok,
798
variant_level=1)))
799
return r
800
801
1352
def start_checker(self, *args, **kwargs):
802
1353
old_checker = self.checker
803
1354
if self.checker is not None:
810
1361
and old_checker_pid != self.checker.pid):
811
1362
# Emit D-Bus signal
812
1363
self.CheckerStarted(self.current_checker_command)
813
self.PropertyChanged(
814
dbus.String(u"checker_running"),
815
dbus.Boolean(True, variant_level=1))
816
1364
return r
817
1365
818
def stop_checker(self, *args, **kwargs):
819
old_checker = getattr(self, u"checker", None)
820
r = Client.stop_checker(self, *args, **kwargs)
821
if (old_checker is not None
822
and getattr(self, u"checker", None) is None):
823
self.PropertyChanged(dbus.String(u"checker_running"),
824
dbus.Boolean(False, variant_level=1))
825
return r
826
827
1366
def _reset_approved(self):
828
self._approved = None
1367
self.approved = None
829
1368
return False
830
1369
831
1370
def approve(self, value=True):
832
self.send_changedstate()
833
self._approved = value
834
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration),
1371
self.approved = value
1372
gobject.timeout_add(timedelta_to_milliseconds
1373
(self.approval_duration),
835
1374
self._reset_approved)
836
1375
self.send_changedstate()
837
1376
838
1377
## D-Bus methods, signals & properties
839
_interface = u"se.bsnet.fukt.Mandos.Client"
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"}
840
1386
841
1387
## Signals
842
1388
843
1389
# CheckerCompleted - signal
844
@dbus.service.signal(_interface, signature=u"nxs")
1390
@dbus.service.signal(_interface, signature="nxs")
845
1391
def CheckerCompleted(self, exitcode, waitstatus, command):
846
1392
"D-Bus signal"
847
1393
pass
848
1394
849
1395
# CheckerStarted - signal
850
@dbus.service.signal(_interface, signature=u"s")
1396
@dbus.service.signal(_interface, signature="s")
851
1397
def CheckerStarted(self, command):
852
1398
"D-Bus signal"
853
1399
pass
854
1400
855
1401
# PropertyChanged - signal
856
@dbus.service.signal(_interface, signature=u"sv")
1402
@dbus.service.signal(_interface, signature="sv")
857
1403
def PropertyChanged(self, property, value):
858
1404
"D-Bus signal"
859
1405
pass
860
1406
861
1407
# GotSecret - signal
862
# XXXTEDDY Is sent after succesfull transfer of secret from mandos-server to mandos-client
863
1408
@dbus.service.signal(_interface)
864
1409
def GotSecret(self):
865
"D-Bus signal"
1410
"""D-Bus signal
1411
Is sent after a successful transfer of secret from the Mandos
1412
server to mandos-client
1413
"""
866
1414
pass
867
1415
868
1416
# Rejected - signal
869
@dbus.service.signal(_interface, signature=u"s")
1417
@dbus.service.signal(_interface, signature="s")
870
1418
def Rejected(self, reason):
871
1419
"D-Bus signal"
872
1420
pass
873
1421
874
1422
# NeedApproval - signal
875
@dbus.service.signal(_interface, signature=u"db")
1423
@dbus.service.signal(_interface, signature="tb")
876
1424
def NeedApproval(self, timeout, default):
877
1425
"D-Bus signal"
878
pass
1426
return self.need_approval()
879
1427
880
1428
## Methods
881
1429
882
1430
# Approve - method
883
@dbus.service.method(_interface, in_signature=u"b")
1431
@dbus.service.method(_interface, in_signature="b")
884
1432
def Approve(self, value):
885
1433
self.approve(value)
886
1434
887
1435
# CheckedOK - method
888
1436
@dbus.service.method(_interface)
889
1437
def CheckedOK(self):
890
return self.checked_ok()
1438
self.checked_ok()
891
1439
892
1440
# Enable - method
893
1441
@dbus.service.method(_interface)
914
1462
915
1463
## Properties
916
1464
917
# approved_pending - property
918
@dbus_service_property(_interface, signature=u"b", access=u"read")
919
def approved_pending_dbus_property(self):
1465
# ApprovalPending - property
1466
@dbus_service_property(_interface, signature="b", access="read")
1467
def ApprovalPending_dbus_property(self):
920
1468
return dbus.Boolean(bool(self.approvals_pending))
921
1469
922
# approved_by_default - property
923
@dbus_service_property(_interface, signature=u"b",
924
access=u"readwrite")
925
def approved_by_default_dbus_property(self):
926
return dbus.Boolean(self.approved_by_default)
927
928
# approved_delay - property
929
@dbus_service_property(_interface, signature=u"t",
930
access=u"readwrite")
931
def approved_delay_dbus_property(self):
932
return dbus.UInt64(self.approved_delay_milliseconds())
933
934
# approved_duration - property
935
@dbus_service_property(_interface, signature=u"t",
936
access=u"readwrite")
937
def approved_duration_dbus_property(self):
938
return dbus.UInt64(self._timedelta_to_milliseconds(
939
self.approved_duration))
940
941
# name - property
942
@dbus_service_property(_interface, signature=u"s", access=u"read")
943
def name_dbus_property(self):
1470
# ApprovedByDefault - property
1471
@dbus_service_property(_interface, signature="b",
1472
access="readwrite")
1473
def ApprovedByDefault_dbus_property(self, value=None):
1474
if value is None: # get
1475
return dbus.Boolean(self.approved_by_default)
1476
self.approved_by_default = bool(value)
1477
1478
# ApprovalDelay - property
1479
@dbus_service_property(_interface, signature="t",
1480
access="readwrite")
1481
def ApprovalDelay_dbus_property(self, value=None):
1482
if value is None: # get
1483
return dbus.UInt64(self.approval_delay_milliseconds())
1484
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1485
1486
# ApprovalDuration - property
1487
@dbus_service_property(_interface, signature="t",
1488
access="readwrite")
1489
def ApprovalDuration_dbus_property(self, value=None):
1490
if value is None: # get
1491
return dbus.UInt64(timedelta_to_milliseconds(
1492
self.approval_duration))
1493
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1494
1495
# Name - property
1496
@dbus_service_property(_interface, signature="s", access="read")
1497
def Name_dbus_property(self):
944
1498
return dbus.String(self.name)
945
1499
946
# fingerprint - property
947
@dbus_service_property(_interface, signature=u"s", access=u"read")
948
def fingerprint_dbus_property(self):
1500
# Fingerprint - property
1501
@dbus_service_property(_interface, signature="s", access="read")
1502
def Fingerprint_dbus_property(self):
949
1503
return dbus.String(self.fingerprint)
950
1504
951
# host - property
952
@dbus_service_property(_interface, signature=u"s",
953
access=u"readwrite")
954
def host_dbus_property(self, value=None):
1505
# Host - property
1506
@dbus_service_property(_interface, signature="s",
1507
access="readwrite")
1508
def Host_dbus_property(self, value=None):
955
1509
if value is None: # get
956
1510
return dbus.String(self.host)
957
self.host = value
958
# Emit D-Bus signal
959
self.PropertyChanged(dbus.String(u"host"),
960
dbus.String(value, variant_level=1))
961
962
# created - property
963
@dbus_service_property(_interface, signature=u"s", access=u"read")
964
def created_dbus_property(self):
965
return dbus.String(self._datetime_to_dbus(self.created))
966
967
# last_enabled - property
968
@dbus_service_property(_interface, signature=u"s", access=u"read")
969
def last_enabled_dbus_property(self):
970
if self.last_enabled is None:
971
return dbus.String(u"")
972
return dbus.String(self._datetime_to_dbus(self.last_enabled))
973
974
# enabled - property
975
@dbus_service_property(_interface, signature=u"b",
976
access=u"readwrite")
977
def enabled_dbus_property(self, value=None):
1511
self.host = unicode(value)
1512
1513
# Created - property
1514
@dbus_service_property(_interface, signature="s", access="read")
1515
def Created_dbus_property(self):
1516
return datetime_to_dbus(self.created)
1517
1518
# LastEnabled - property
1519
@dbus_service_property(_interface, signature="s", access="read")
1520
def LastEnabled_dbus_property(self):
1521
return datetime_to_dbus(self.last_enabled)
1522
1523
# Enabled - property
1524
@dbus_service_property(_interface, signature="b",
1525
access="readwrite")
1526
def Enabled_dbus_property(self, value=None):
978
1527
if value is None: # get
979
1528
return dbus.Boolean(self.enabled)
980
1529
if value:
982
1531
else:
983
1532
self.disable()
984
1533
985
# last_checked_ok - property
986
@dbus_service_property(_interface, signature=u"s",
987
access=u"readwrite")
988
def last_checked_ok_dbus_property(self, value=None):
1534
# LastCheckedOK - property
1535
@dbus_service_property(_interface, signature="s",
1536
access="readwrite")
1537
def LastCheckedOK_dbus_property(self, value=None):
989
1538
if value is not None:
990
1539
self.checked_ok()
991
1540
return
992
if self.last_checked_ok is None:
993
return dbus.String(u"")
994
return dbus.String(self._datetime_to_dbus(self
995
.last_checked_ok))
996
997
# timeout - property
998
@dbus_service_property(_interface, signature=u"t",
999
access=u"readwrite")
1000
def timeout_dbus_property(self, value=None):
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)
1558
1559
# Timeout - property
1560
@dbus_service_property(_interface, signature="t",
1561
access="readwrite")
1562
def Timeout_dbus_property(self, value=None):
1001
1563
if value is None: # get
1002
1564
return dbus.UInt64(self.timeout_milliseconds())
1565
old_timeout = self.timeout
1003
1566
self.timeout = datetime.timedelta(0, 0, 0, value)
1004
# Emit D-Bus signal
1005
self.PropertyChanged(dbus.String(u"timeout"),
1006
dbus.UInt64(value, variant_level=1))
1007
if getattr(self, u"disable_initiator_tag", None) is None:
1008
return
1009
# Reschedule timeout
1010
gobject.source_remove(self.disable_initiator_tag)
1011
self.disable_initiator_tag = None
1012
time_to_die = (self.
1013
_timedelta_to_milliseconds((self
1014
.last_checked_ok
1015
+ self.timeout)
1016
- datetime.datetime
1017
.utcnow()))
1018
if time_to_die <= 0:
1019
# The timeout has passed
1020
self.disable()
1021
else:
1022
self.disable_initiator_tag = (gobject.timeout_add
1023
(time_to_die, self.disable))
1024
1025
# interval - property
1026
@dbus_service_property(_interface, signature=u"t",
1027
access=u"readwrite")
1028
def interval_dbus_property(self, value=None):
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)
1591
1592
# Interval - property
1593
@dbus_service_property(_interface, signature="t",
1594
access="readwrite")
1595
def Interval_dbus_property(self, value=None):
1029
1596
if value is None: # get
1030
1597
return dbus.UInt64(self.interval_milliseconds())
1031
1598
self.interval = datetime.timedelta(0, 0, 0, value)
1032
# Emit D-Bus signal
1033
self.PropertyChanged(dbus.String(u"interval"),
1034
dbus.UInt64(value, variant_level=1))
1035
if getattr(self, u"checker_initiator_tag", None) is None:
1599
if getattr(self, "checker_initiator_tag", None) is None:
1036
1600
return
1037
# Reschedule checker run
1038
gobject.source_remove(self.checker_initiator_tag)
1039
self.checker_initiator_tag = (gobject.timeout_add
1040
(value, self.start_checker))
1041
self.start_checker() # Start one now, too
1042
1043
# checker - property
1044
@dbus_service_property(_interface, signature=u"s",
1045
access=u"readwrite")
1046
def checker_dbus_property(self, value=None):
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
1608
# Checker - property
1609
@dbus_service_property(_interface, signature="s",
1610
access="readwrite")
1611
def Checker_dbus_property(self, value=None):
1047
1612
if value is None: # get
1048
1613
return dbus.String(self.checker_command)
1049
self.checker_command = value
1050
# Emit D-Bus signal
1051
self.PropertyChanged(dbus.String(u"checker"),
1052
dbus.String(self.checker_command,
1053
variant_level=1))
1614
self.checker_command = unicode(value)
1054
1615
1055
# checker_running - property
1056
@dbus_service_property(_interface, signature=u"b",
1057
access=u"readwrite")
1058
def checker_running_dbus_property(self, value=None):
1616
# CheckerRunning - property
1617
@dbus_service_property(_interface, signature="b",
1618
access="readwrite")
1619
def CheckerRunning_dbus_property(self, value=None):
1059
1620
if value is None: # get
1060
1621
return dbus.Boolean(self.checker is not None)
1061
1622
if value:
1063
1624
else:
1064
1625
self.stop_checker()
1065
1626
1066
# object_path - property
1067
@dbus_service_property(_interface, signature=u"o", access=u"read")
1068
def object_path_dbus_property(self):
1627
# ObjectPath - property
1628
@dbus_service_property(_interface, signature="o", access="read")
1629
def ObjectPath_dbus_property(self):
1069
1630
return self.dbus_object_path # is already a dbus.ObjectPath
1070
1631
1071
# secret = property
1072
@dbus_service_property(_interface, signature=u"ay",
1073
access=u"write", byte_arrays=True)
1074
def secret_dbus_property(self, value):
1632
# Secret = property
1633
@dbus_service_property(_interface, signature="ay",
1634
access="write", byte_arrays=True)
1635
def Secret_dbus_property(self, value):
1075
1636
self.secret = str(value)
1076
1637
1077
1638
del _interface
1083
1644
self._pipe.send(('init', fpr, address))
1084
1645
if not self._pipe.recv():
1085
1646
raise KeyError()
1086
1647
1087
1648
def __getattribute__(self, name):
1088
if(name == '_pipe'):
1649
if name == '_pipe':
1089
1650
return super(ProxyClient, self).__getattribute__(name)
1090
1651
self._pipe.send(('getattr', name))
1091
1652
data = self._pipe.recv()
1096
1657
self._pipe.send(('funcall', name, args, kwargs))
1097
1658
return self._pipe.recv()[1]
1098
1659
return func
1099
1660
1100
1661
def __setattr__(self, name, value):
1101
if(name == '_pipe'):
1662
if name == '_pipe':
1102
1663
return super(ProxyClient, self).__setattr__(name, value)
1103
1664
self._pipe.send(('setattr', name, value))
1104
1665
1111
1672
1112
1673
def handle(self):
1113
1674
with contextlib.closing(self.server.child_pipe) as child_pipe:
1114
logger.info(u"TCP connection from: %s",
1675
logger.info("TCP connection from: %s",
1115
1676
unicode(self.client_address))
1116
logger.debug(u"Pipe FD: %d",
1677
logger.debug("Pipe FD: %d",
1117
1678
self.server.child_pipe.fileno())
1118
1679
1119
1680
session = (gnutls.connection
1120
1681
.ClientSession(self.request,
1121
1682
gnutls.connection
1122
1683
.X509Credentials()))
1123
1684
1124
1685
# Note: gnutls.connection.X509Credentials is really a
1125
1686
# generic GnuTLS certificate credentials object so long as
1126
1687
# no X.509 keys are added to it. Therefore, we can use it
1127
1688
# here despite using OpenPGP certificates.
1128
1129
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1130
# u"+AES-256-CBC", u"+SHA1",
1131
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1132
# u"+DHE-DSS"))
1689
1690
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1691
# "+AES-256-CBC", "+SHA1",
1692
# "+COMP-NULL", "+CTYPE-OPENPGP",
1693
# "+DHE-DSS"))
1133
1694
# Use a fallback default, since this MUST be set.
1134
1695
priority = self.server.gnutls_priority
1135
1696
if priority is None:
1136
priority = u"NORMAL"
1697
priority = "NORMAL"
1137
1698
(gnutls.library.functions
1138
1699
.gnutls_priority_set_direct(session._c_object,
1139
1700
priority, None))
1140
1701
1141
1702
# Start communication using the Mandos protocol
1142
1703
# Get protocol number
1143
1704
line = self.request.makefile().readline()
1144
logger.debug(u"Protocol version: %r", line)
1705
logger.debug("Protocol version: %r", line)
1145
1706
try:
1146
1707
if int(line.strip().split()[0]) > 1:
1147
raise RuntimeError
1148
except (ValueError, IndexError, RuntimeError), error:
1149
logger.error(u"Unknown protocol version: %s", error)
1708
raise RuntimeError(line)
1709
except (ValueError, IndexError, RuntimeError) as error:
1710
logger.error("Unknown protocol version: %s", error)
1150
1711
return
1151
1712
1152
1713
# Start GnuTLS connection
1153
1714
try:
1154
1715
session.handshake()
1155
except gnutls.errors.GNUTLSError, error:
1156
logger.warning(u"Handshake failed: %s", error)
1716
except gnutls.errors.GNUTLSError as error:
1717
logger.warning("Handshake failed: %s", error)
1157
1718
# Do not run session.bye() here: the session is not
1158
1719
# established. Just abandon the request.
1159
1720
return
1160
logger.debug(u"Handshake succeeded")
1161
1721
logger.debug("Handshake succeeded")
1722
1162
1723
approval_required = False
1163
1724
try:
1164
1725
try:
1165
1726
fpr = self.fingerprint(self.peer_certificate
1166
1727
(session))
1167
except (TypeError, gnutls.errors.GNUTLSError), error:
1168
logger.warning(u"Bad certificate: %s", error)
1728
except (TypeError,
1729
gnutls.errors.GNUTLSError) as error:
1730
logger.warning("Bad certificate: %s", error)
1169
1731
return
1170
logger.debug(u"Fingerprint: %s", fpr)
1171
1732
logger.debug("Fingerprint: %s", fpr)
1733
1172
1734
try:
1173
1735
client = ProxyClient(child_pipe, fpr,
1174
1736
self.client_address)
1175
1737
except KeyError:
1176
1738
return
1177
1739
1178
if client.approved_delay:
1179
delay = client.approved_delay
1740
if client.approval_delay:
1741
delay = client.approval_delay
1180
1742
client.approvals_pending += 1
1181
1743
approval_required = True
1182
1744
1183
1745
while True:
1184
1746
if not client.enabled:
1185
logger.warning(u"Client %s is disabled",
1747
logger.info("Client %s is disabled",
1186
1748
client.name)
1187
1749
if self.server.use_dbus:
1188
1750
# Emit D-Bus signal
1189
client.Rejected("Disabled")
1751
client.Rejected("Disabled")
1190
1752
return
1191
1753
1192
if client._approved or not client.approved_delay:
1754
if client.approved or not client.approval_delay:
1193
1755
#We are approved or approval is disabled
1194
1756
break
1195
elif client._approved is None:
1196
logger.info(u"Client %s need approval",
1757
elif client.approved is None:
1758
logger.info("Client %s needs approval",
1197
1759
client.name)
1198
1760
if self.server.use_dbus:
1199
1761
# Emit D-Bus signal
1200
1762
client.NeedApproval(
1201
client.approved_delay_milliseconds(),
1763
client.approval_delay_milliseconds(),
1202
1764
client.approved_by_default)
1203
1765
else:
1204
logger.warning(u"Client %s was not approved",
1766
logger.warning("Client %s was not approved",
1205
1767
client.name)
1206
1768
if self.server.use_dbus:
1207
1769
# Emit D-Bus signal
1208
client.Rejected("Disapproved")
1770
client.Rejected("Denied")
1209
1771
return
1210
1772
1211
1773
#wait until timeout or approved
1212
#x = float(client._timedelta_to_milliseconds(delay))
1213
1774
time = datetime.datetime.now()
1214
1775
client.changedstate.acquire()
1215
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1776
client.changedstate.wait(
1777
float(timedelta_to_milliseconds(delay)
1778
/ 1000))
1216
1779
client.changedstate.release()
1217
1780
time2 = datetime.datetime.now()
1218
1781
if (time2 - time) >= delay:
1222
1785
client.name)
1223
1786
if self.server.use_dbus:
1224
1787
# Emit D-Bus signal
1225
client.Rejected("Time out")
1788
client.Rejected("Approval timed out")
1226
1789
return
1227
1790
else:
1228
1791
break
1231
1794
1232
1795
sent_size = 0
1233
1796
while sent_size < len(client.secret):
1234
# XXX handle session exception
1235
sent = session.send(client.secret[sent_size:])
1236
logger.debug(u"Sent: %d, remaining: %d",
1797
try:
1798
sent = session.send(client.secret[sent_size:])
1799
except gnutls.errors.GNUTLSError as error:
1800
logger.warning("gnutls send failed",
1801
exc_info=error)
1802
return
1803
logger.debug("Sent: %d, remaining: %d",
1237
1804
sent, len(client.secret)
1238
1805
- (sent_size + sent))
1239
1806
sent_size += sent
1240
1241
logger.info(u"Sending secret to %s", client.name)
1242
# bump the timeout as if seen
1243
client.checked_ok()
1807
1808
logger.info("Sending secret to %s", client.name)
1809
# bump the timeout using extended_timeout
1810
client.bump_timeout(client.extended_timeout)
1244
1811
if self.server.use_dbus:
1245
1812
# Emit D-Bus signal
1246
1813
client.GotSecret()
1248
1815
finally:
1249
1816
if approval_required:
1250
1817
client.approvals_pending -= 1
1251
session.bye()
1818
try:
1819
session.bye()
1820
except gnutls.errors.GNUTLSError as error:
1821
logger.warning("GnuTLS bye failed",
1822
exc_info=error)
1252
1823
1253
1824
@staticmethod
1254
1825
def peer_certificate(session):
1264
1835
.gnutls_certificate_get_peers
1265
1836
(session._c_object, ctypes.byref(list_size)))
1266
1837
if not bool(cert_list) and list_size.value != 0:
1267
raise gnutls.errors.GNUTLSError(u"error getting peer"
1268
u" certificate")
1838
raise gnutls.errors.GNUTLSError("error getting peer"
1839
" certificate")
1269
1840
if list_size.value == 0:
1270
1841
return None
1271
1842
cert = cert_list[0]
1297
1868
if crtverify.value != 0:
1298
1869
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1299
1870
raise (gnutls.errors.CertificateSecurityError
1300
(u"Verify failed"))
1871
("Verify failed"))
1301
1872
# New buffer for the fingerprint
1302
1873
buf = ctypes.create_string_buffer(20)
1303
1874
buf_len = ctypes.c_size_t()
1310
1881
# Convert the buffer to a Python bytestring
1311
1882
fpr = ctypes.string_at(buf, buf_len.value)
1312
1883
# Convert the bytestring to hexadecimal notation
1313
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1884
hex_fpr = binascii.hexlify(fpr).upper()
1314
1885
return hex_fpr
1315
1886
1316
1887
1319
1890
def sub_process_main(self, request, address):
1320
1891
try:
1321
1892
self.finish_request(request, address)
1322
except:
1893
except Exception:
1323
1894
self.handle_error(request, address)
1324
1895
self.close_request(request)
1325
1896
1326
1897
def process_request(self, request, address):
1327
1898
"""Start a new process to process the request."""
1328
multiprocessing.Process(target = self.sub_process_main,
1329
args = (request, address)).start()
1899
proc = multiprocessing.Process(target = self.sub_process_main,
1900
args = (request, address))
1901
proc.start()
1902
return proc
1903
1330
1904
1331
1905
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1332
1906
""" adds a pipe to the MixIn """
1336
1910
This function creates a new pipe in self.pipe
1337
1911
"""
1338
1912
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1339
1340
super(MultiprocessingMixInWithPipe,
1341
self).process_request(request, client_address)
1913
1914
proc = MultiprocessingMixIn.process_request(self, request,
1915
client_address)
1342
1916
self.child_pipe.close()
1343
self.add_pipe(parent_pipe)
1344
1345
def add_pipe(self, parent_pipe):
1917
self.add_pipe(parent_pipe, proc)
1918
1919
def add_pipe(self, parent_pipe, proc):
1346
1920
"""Dummy function; override as necessary"""
1347
pass
1921
raise NotImplementedError()
1922
1348
1923
1349
1924
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1350
1925
socketserver.TCPServer, object):
1356
1931
use_ipv6: Boolean; to use IPv6 or not
1357
1932
"""
1358
1933
def __init__(self, server_address, RequestHandlerClass,
1359
interface=None, use_ipv6=True):
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
"""
1360
1938
self.interface = interface
1361
1939
if use_ipv6:
1362
1940
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.
1363
1967
socketserver.TCPServer.__init__(self, server_address,
1364
1968
RequestHandlerClass)
1969
1365
1970
def server_bind(self):
1366
1971
"""This overrides the normal server_bind() function
1367
1972
to bind to an interface if one was specified, and also NOT to
1368
1973
bind to an address or port if they were not specified."""
1369
1974
if self.interface is not None:
1370
1975
if SO_BINDTODEVICE is None:
1371
logger.error(u"SO_BINDTODEVICE does not exist;"
1372
u" cannot bind to interface %s",
1976
logger.error("SO_BINDTODEVICE does not exist;"
1977
" cannot bind to interface %s",
1373
1978
self.interface)
1374
1979
else:
1375
1980
try:
1376
1981
self.socket.setsockopt(socket.SOL_SOCKET,
1377
1982
SO_BINDTODEVICE,
1378
str(self.interface
1379
+ u'\0'))
1380
except socket.error, error:
1381
if error[0] == errno.EPERM:
1382
logger.error(u"No permission to"
1383
u" bind to interface %s",
1384
self.interface)
1385
elif error[0] == errno.ENOPROTOOPT:
1386
logger.error(u"SO_BINDTODEVICE not available;"
1387
u" cannot bind to interface %s",
1388
self.interface)
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)
1389
1995
else:
1390
1996
raise
1391
1997
# Only bind(2) the socket if we really need to.
1392
1998
if self.server_address[0] or self.server_address[1]:
1393
1999
if not self.server_address[0]:
1394
2000
if self.address_family == socket.AF_INET6:
1395
any_address = u"::" # in6addr_any
2001
any_address = "::" # in6addr_any
1396
2002
else:
1397
any_address = socket.INADDR_ANY
2003
any_address = "0.0.0.0" # INADDR_ANY
1398
2004
self.server_address = (any_address,
1399
2005
self.server_address[1])
1400
2006
elif not self.server_address[1]:
1421
2027
"""
1422
2028
def __init__(self, server_address, RequestHandlerClass,
1423
2029
interface=None, use_ipv6=True, clients=None,
1424
gnutls_priority=None, use_dbus=True):
2030
gnutls_priority=None, use_dbus=True, socketfd=None):
1425
2031
self.enabled = False
1426
2032
self.clients = clients
1427
2033
if self.clients is None:
1428
self.clients = set()
2034
self.clients = {}
1429
2035
self.use_dbus = use_dbus
1430
2036
self.gnutls_priority = gnutls_priority
1431
2037
IPv6_TCPServer.__init__(self, server_address,
1432
2038
RequestHandlerClass,
1433
2039
interface = interface,
1434
use_ipv6 = use_ipv6)
2040
use_ipv6 = use_ipv6,
2041
socketfd = socketfd)
1435
2042
def server_activate(self):
1436
2043
if self.enabled:
1437
2044
return socketserver.TCPServer.server_activate(self)
2045
1438
2046
def enable(self):
1439
2047
self.enabled = True
1440
def add_pipe(self, parent_pipe):
2048
2049
def add_pipe(self, parent_pipe, proc):
1441
2050
# Call "handle_ipc" for both data and EOF events
1442
2051
gobject.io_add_watch(parent_pipe.fileno(),
1443
2052
gobject.IO_IN | gobject.IO_HUP,
1444
2053
functools.partial(self.handle_ipc,
1445
parent_pipe = parent_pipe))
1446
2054
parent_pipe =
2055
parent_pipe,
2056
proc = proc))
2057
1447
2058
def handle_ipc(self, source, condition, parent_pipe=None,
1448
client_object=None):
1449
condition_names = {
1450
gobject.IO_IN: u"IN", # There is data to read.
1451
gobject.IO_OUT: u"OUT", # Data can be written (without
1452
# blocking).
1453
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1454
gobject.IO_ERR: u"ERR", # Error condition.
1455
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1456
# broken, usually for pipes and
1457
# sockets).
1458
}
1459
conditions_string = ' | '.join(name
1460
for cond, name in
1461
condition_names.iteritems()
1462
if cond & condition)
1463
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1464
conditions_string)
1465
1466
# XXXTEDDY error or the other end of multiprocessing.Pipe has closed
1467
if condition & gobject.IO_HUP or condition & gobject.IO_ERR:
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()
1468
2064
return False
1469
2065
1470
2066
# Read a request from the child
1471
2067
request = parent_pipe.recv()
1472
logger.debug(u"IPC request: %s", repr(request))
1473
2068
command = request[0]
1474
2069
1475
2070
if command == 'init':
1476
2071
fpr = request[1]
1477
2072
address = request[2]
1478
2073
1479
for c in self.clients:
2074
for c in self.clients.itervalues():
1480
2075
if c.fingerprint == fpr:
1481
2076
client = c
1482
2077
break
1483
2078
else:
1484
logger.warning(u"Client not found for fingerprint: %s, ad"
1485
u"dress: %s", fpr, address)
2079
logger.info("Client not found for fingerprint: %s, ad"
2080
"dress: %s", fpr, address)
1486
2081
if self.use_dbus:
1487
2082
# Emit D-Bus signal
1488
mandos_dbus_service.ClientNotFound(fpr, address)
2083
mandos_dbus_service.ClientNotFound(fpr,
2084
address[0])
1489
2085
parent_pipe.send(False)
1490
2086
return False
1491
2087
1492
2088
gobject.io_add_watch(parent_pipe.fileno(),
1493
2089
gobject.IO_IN | gobject.IO_HUP,
1494
2090
functools.partial(self.handle_ipc,
1495
parent_pipe = parent_pipe,
1496
client_object = client))
2091
parent_pipe =
2092
parent_pipe,
2093
proc = proc,
2094
client_object =
2095
client))
1497
2096
parent_pipe.send(True)
1498
# remove the old hook in favor of the new above hook on same fileno
2097
# remove the old hook in favor of the new above hook on
2098
# same fileno
1499
2099
return False
1500
2100
if command == 'funcall':
1501
2101
funcname = request[1]
1502
2102
args = request[2]
1503
2103
kwargs = request[3]
1504
2104
1505
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1506
2105
parent_pipe.send(('data', getattr(client_object,
2106
funcname)(*args,
2107
**kwargs)))
2108
1507
2109
if command == 'getattr':
1508
2110
attrname = request[1]
1509
2111
if callable(client_object.__getattribute__(attrname)):
1510
2112
parent_pipe.send(('function',))
1511
2113
else:
1512
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2114
parent_pipe.send(('data', client_object
2115
.__getattribute__(attrname)))
1513
2116
1514
2117
if command == 'setattr':
1515
2118
attrname = request[1]
1516
2119
value = request[2]
1517
2120
setattr(client_object, attrname, value)
1518
2121
1519
2122
return True
1520
2123
1521
2124
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
1522
2224
def string_to_delta(interval):
1523
2225
"""Parse a string and return a datetime.timedelta
1524
2226
1525
>>> string_to_delta(u'7d')
2227
>>> string_to_delta('7d')
1526
2228
datetime.timedelta(7)
1527
>>> string_to_delta(u'60s')
2229
>>> string_to_delta('60s')
1528
2230
datetime.timedelta(0, 60)
1529
>>> string_to_delta(u'60m')
2231
>>> string_to_delta('60m')
1530
2232
datetime.timedelta(0, 3600)
1531
>>> string_to_delta(u'24h')
2233
>>> string_to_delta('24h')
1532
2234
datetime.timedelta(1)
1533
>>> string_to_delta(u'1w')
2235
>>> string_to_delta('1w')
1534
2236
datetime.timedelta(7)
1535
>>> string_to_delta(u'5m 30s')
2237
>>> string_to_delta('5m 30s')
1536
2238
datetime.timedelta(0, 330)
1537
2239
"""
2240
2241
try:
2242
return rfc3339_duration_to_delta(interval)
2243
except ValueError:
2244
pass
2245
1538
2246
timevalue = datetime.timedelta(0)
1539
2247
for s in interval.split():
1540
2248
try:
1541
2249
suffix = unicode(s[-1])
1542
2250
value = int(s[:-1])
1543
if suffix == u"d":
2251
if suffix == "d":
1544
2252
delta = datetime.timedelta(value)
1545
elif suffix == u"s":
2253
elif suffix == "s":
1546
2254
delta = datetime.timedelta(0, value)
1547
elif suffix == u"m":
2255
elif suffix == "m":
1548
2256
delta = datetime.timedelta(0, 0, 0, 0, value)
1549
elif suffix == u"h":
2257
elif suffix == "h":
1550
2258
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1551
elif suffix == u"w":
2259
elif suffix == "w":
1552
2260
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1553
2261
else:
1554
raise ValueError(u"Unknown suffix %r" % suffix)
1555
except (ValueError, IndexError), e:
1556
raise ValueError(e.message)
2262
raise ValueError("Unknown suffix {0!r}"
2263
.format(suffix))
2264
except IndexError as e:
2265
raise ValueError(*(e.args))
1557
2266
timevalue += delta
1558
2267
return timevalue
1559
2268
1560
2269
1561
def if_nametoindex(interface):
1562
"""Call the C function if_nametoindex(), or equivalent
1563
1564
Note: This function cannot accept a unicode string."""
1565
global if_nametoindex
1566
try:
1567
if_nametoindex = (ctypes.cdll.LoadLibrary
1568
(ctypes.util.find_library(u"c"))
1569
.if_nametoindex)
1570
except (OSError, AttributeError):
1571
logger.warning(u"Doing if_nametoindex the hard way")
1572
def if_nametoindex(interface):
1573
"Get an interface index the hard way, i.e. using fcntl()"
1574
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1575
with contextlib.closing(socket.socket()) as s:
1576
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1577
struct.pack(str(u"16s16x"),
1578
interface))
1579
interface_index = struct.unpack(str(u"I"),
1580
ifreq[16:20])[0]
1581
return interface_index
1582
return if_nametoindex(interface)
1583
1584
1585
2270
def daemon(nochdir = False, noclose = False):
1586
2271
"""See daemon(3). Standard BSD Unix function.
1587
2272
1590
2275
sys.exit()
1591
2276
os.setsid()
1592
2277
if not nochdir:
1593
os.chdir(u"/")
2278
os.chdir("/")
1594
2279
if os.fork():
1595
2280
sys.exit()
1596
2281
if not noclose:
1597
2282
# Close all standard open file descriptors
1598
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2283
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1599
2284
if not stat.S_ISCHR(os.fstat(null).st_mode):
1600
2285
raise OSError(errno.ENODEV,
1601
u"%s not a character device"
1602
% os.path.devnull)
2286
"{0} not a character device"
2287
.format(os.devnull))
1603
2288
os.dup2(null, sys.stdin.fileno())
1604
2289
os.dup2(null, sys.stdout.fileno())
1605
2290
os.dup2(null, sys.stderr.fileno())
1612
2297
##################################################################
1613
2298
# Parsing of options, both command line and config file
1614
2299
1615
parser = optparse.OptionParser(version = "%%prog %s" % version)
1616
parser.add_option("-i", u"--interface", type=u"string",
1617
metavar="IF", help=u"Bind to interface IF")
1618
parser.add_option("-a", u"--address", type=u"string",
1619
help=u"Address to listen for requests on")
1620
parser.add_option("-p", u"--port", type=u"int",
1621
help=u"Port number to receive requests on")
1622
parser.add_option("--check", action=u"store_true",
1623
help=u"Run self-test")
1624
parser.add_option("--debug", action=u"store_true",
1625
help=u"Debug mode; run in foreground and log to"
1626
u" terminal")
1627
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1628
u" priority string (see GnuTLS documentation)")
1629
parser.add_option("--servicename", type=u"string",
1630
metavar=u"NAME", help=u"Zeroconf service name")
1631
parser.add_option("--configdir", type=u"string",
1632
default=u"/etc/mandos", metavar=u"DIR",
1633
help=u"Directory to search for configuration"
1634
u" files")
1635
parser.add_option("--no-dbus", action=u"store_false",
1636
dest=u"use_dbus", help=u"Do not provide D-Bus"
1637
u" system bus interface")
1638
parser.add_option("--no-ipv6", action=u"store_false",
1639
dest=u"use_ipv6", help=u"Do not use IPv6")
1640
options = parser.parse_args()[0]
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()
1641
2343
1642
2344
if options.check:
1643
2345
import doctest
1644
doctest.testmod()
1645
sys.exit()
2346
fail_count, test_count = doctest.testmod()
2347
sys.exit(os.EX_OK if fail_count == 0 else 1)
1646
2348
1647
2349
# Default values for config file for server-global settings
1648
server_defaults = { u"interface": u"",
1649
u"address": u"",
1650
u"port": u"",
1651
u"debug": u"False",
1652
u"priority":
1653
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1654
u"servicename": u"Mandos",
1655
u"use_dbus": u"True",
1656
u"use_ipv6": u"True",
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",
1657
2364
}
1658
2365
1659
2366
# Parse config file for server-global settings
1660
2367
server_config = configparser.SafeConfigParser(server_defaults)
1661
2368
del server_defaults
1662
2369
server_config.read(os.path.join(options.configdir,
1663
u"mandos.conf"))
2370
"mandos.conf"))
1664
2371
# Convert the SafeConfigParser object to a dict
1665
2372
server_settings = server_config.defaults()
1666
2373
# Use the appropriate methods on the non-string config options
1667
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1668
server_settings[option] = server_config.getboolean(u"DEFAULT",
2374
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2375
server_settings[option] = server_config.getboolean("DEFAULT",
1669
2376
option)
1670
2377
if server_settings["port"]:
1671
server_settings["port"] = server_config.getint(u"DEFAULT",
1672
u"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"])
1673
2389
del server_config
1674
2390
1675
2391
# Override the settings from the config file with command line
1676
2392
# options, if set.
1677
for option in (u"interface", u"address", u"port", u"debug",
1678
u"priority", u"servicename", u"configdir",
1679
u"use_dbus", u"use_ipv6"):
2393
for option in ("interface", "address", "port", "debug",
2394
"priority", "servicename", "configdir",
2395
"use_dbus", "use_ipv6", "debuglevel", "restore",
2396
"statedir", "socket", "foreground"):
1680
2397
value = getattr(options, option)
1681
2398
if value is not None:
1682
2399
server_settings[option] = value
1685
2402
for option in server_settings.keys():
1686
2403
if type(server_settings[option]) is str:
1687
2404
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
1688
2412
# Now we have our good server settings in "server_settings"
1689
2413
1690
2414
##################################################################
1691
2415
1692
2416
# For convenience
1693
debug = server_settings[u"debug"]
1694
use_dbus = server_settings[u"use_dbus"]
1695
use_ipv6 = server_settings[u"use_ipv6"]
1696
1697
if not debug:
1698
syslogger.setLevel(logging.WARNING)
1699
console.setLevel(logging.WARNING)
1700
1701
if server_settings[u"servicename"] != u"Mandos":
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":
1702
2435
syslogger.setFormatter(logging.Formatter
1703
(u'Mandos (%s) [%%(process)d]:'
1704
u' %%(levelname)s: %%(message)s'
1705
% server_settings[u"servicename"]))
2436
('Mandos ({0}) [%(process)d]:'
2437
' %(levelname)s: %(message)s'
2438
.format(server_settings
2439
["servicename"])))
1706
2440
1707
2441
# Parse config file with clients
1708
client_defaults = { u"timeout": u"1h",
1709
u"interval": u"5m",
1710
u"checker": u"fping -q -- %%(host)s",
1711
u"host": u"",
1712
u"approved_delay": u"0s",
1713
u"approved_duration": u"1s",
1714
}
1715
client_config = configparser.SafeConfigParser(client_defaults)
1716
client_config.read(os.path.join(server_settings[u"configdir"],
1717
u"clients.conf"))
2442
client_config = configparser.SafeConfigParser(Client
2443
.client_defaults)
2444
client_config.read(os.path.join(server_settings["configdir"],
2445
"clients.conf"))
1718
2446
1719
2447
global mandos_dbus_service
1720
2448
mandos_dbus_service = None
1721
2449
1722
tcp_server = MandosServer((server_settings[u"address"],
1723
server_settings[u"port"]),
2450
tcp_server = MandosServer((server_settings["address"],
2451
server_settings["port"]),
1724
2452
ClientHandler,
1725
interface=server_settings[u"interface"],
2453
interface=(server_settings["interface"]
2454
or None),
1726
2455
use_ipv6=use_ipv6,
1727
2456
gnutls_priority=
1728
server_settings[u"priority"],
1729
use_dbus=use_dbus)
1730
pidfilename = u"/var/run/mandos.pid"
1731
try:
1732
pidfile = open(pidfilename, u"w")
1733
except IOError:
1734
logger.error(u"Could not open file %r", pidfilename)
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)
1735
2471
1736
try:
1737
uid = pwd.getpwnam(u"_mandos").pw_uid
1738
gid = pwd.getpwnam(u"_mandos").pw_gid
1739
except KeyError:
2472
for name in ("_mandos", "mandos", "nobody"):
1740
2473
try:
1741
uid = pwd.getpwnam(u"mandos").pw_uid
1742
gid = pwd.getpwnam(u"mandos").pw_gid
2474
uid = pwd.getpwnam(name).pw_uid
2475
gid = pwd.getpwnam(name).pw_gid
2476
break
1743
2477
except KeyError:
1744
try:
1745
uid = pwd.getpwnam(u"nobody").pw_uid
1746
gid = pwd.getpwnam(u"nobody").pw_gid
1747
except KeyError:
1748
uid = 65534
1749
gid = 65534
2478
continue
2479
else:
2480
uid = 65534
2481
gid = 65534
1750
2482
try:
1751
2483
os.setgid(gid)
1752
2484
os.setuid(uid)
1753
except OSError, error:
1754
if error[0] != errno.EPERM:
1755
raise error
2485
except OSError as error:
2486
if error.errno != errno.EPERM:
2487
raise
1756
2488
1757
# Enable all possible GnuTLS debugging
1758
2489
if debug:
2490
# Enable all possible GnuTLS debugging
2491
1759
2492
# "Use a log level over 10 to enable all debugging options."
1760
2493
# - GnuTLS manual
1761
2494
gnutls.library.functions.gnutls_global_set_log_level(11)
1762
2495
1763
2496
@gnutls.library.types.gnutls_log_func
1764
2497
def debug_gnutls(level, string):
1765
logger.debug(u"GnuTLS: %s", string[:-1])
2498
logger.debug("GnuTLS: %s", string[:-1])
1766
2499
1767
2500
(gnutls.library.functions
1768
2501
.gnutls_global_set_log_function(debug_gnutls))
2502
2503
# Redirect stdin so all checkers get /dev/null
2504
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2505
os.dup2(null, sys.stdin.fileno())
2506
if null > 2:
2507
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()
1769
2517
1770
2518
global main_loop
1771
2519
# From the Avahi example code
1772
DBusGMainLoop(set_as_default=True )
2520
DBusGMainLoop(set_as_default=True)
1773
2521
main_loop = gobject.MainLoop()
1774
2522
bus = dbus.SystemBus()
1775
2523
# End of Avahi example code
1776
2524
if use_dbus:
1777
2525
try:
1778
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2526
bus_name = dbus.service.BusName("se.recompile.Mandos",
1779
2527
bus, do_not_queue=True)
1780
except dbus.exceptions.NameExistsException, e:
1781
logger.error(unicode(e) + u", disabling D-Bus")
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)
1782
2533
use_dbus = False
1783
server_settings[u"use_dbus"] = False
2534
server_settings["use_dbus"] = False
1784
2535
tcp_server.use_dbus = False
1785
2536
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1786
service = AvahiService(name = server_settings[u"servicename"],
1787
servicetype = u"_mandos._tcp",
1788
protocol = protocol, bus = bus)
2537
service = AvahiServiceToSyslog(name =
2538
server_settings["servicename"],
2539
servicetype = "_mandos._tcp",
2540
protocol = protocol, bus = bus)
1789
2541
if server_settings["interface"]:
1790
2542
service.interface = (if_nametoindex
1791
(str(server_settings[u"interface"])))
1792
2543
(str(server_settings["interface"])))
2544
1793
2545
global multiprocessing_manager
1794
2546
multiprocessing_manager = multiprocessing.Manager()
1795
2547
1796
2548
client_class = Client
1797
2549
if use_dbus:
1798
2550
client_class = functools.partial(ClientDBus, bus = bus)
1799
def client_config_items(config, section):
1800
special_settings = {
1801
"approved_by_default":
1802
lambda: config.getboolean(section,
1803
"approved_by_default"),
1804
}
1805
for name, value in config.items(section):
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))
1806
2633
try:
1807
yield (name, special_settings[name]())
1808
except KeyError:
1809
yield (name, value)
1810
1811
tcp_server.clients.update(set(
1812
client_class(name = section,
1813
config= dict(client_config_items(
1814
client_config, section)))
1815
for section in client_config.sections()))
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
1816
2659
if not tcp_server.clients:
1817
logger.warning(u"No clients defined")
1818
1819
if debug:
1820
# Redirect stdin so all checkers get /dev/null
1821
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1822
os.dup2(null, sys.stdin.fileno())
1823
if null > 2:
1824
os.close(null)
1825
else:
1826
# No console logging
1827
logger.removeHandler(console)
1828
# Close all input and output, do double fork, etc.
1829
daemon()
1830
1831
try:
1832
with pidfile:
1833
pid = os.getpid()
1834
pidfile.write(str(pid) + "\n")
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)
1835
2671
del pidfile
1836
except IOError:
1837
logger.error(u"Could not write to file %r with PID %d",
1838
pidfilename, pid)
1839
except NameError:
1840
# "pidfile" was never created
1841
pass
1842
del pidfilename
2672
del pidfilename
1843
2673
1844
if not debug:
1845
signal.signal(signal.SIGINT, signal.SIG_IGN)
1846
2674
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1847
2675
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1848
2676
1849
2677
if use_dbus:
1850
class MandosDBusService(dbus.service.Object):
2678
@alternate_dbus_interfaces({"se.recompile.Mandos":
2679
"se.bsnet.fukt.Mandos"})
2680
class MandosDBusService(DBusObjectWithProperties):
1851
2681
"""A D-Bus proxy object"""
1852
2682
def __init__(self):
1853
dbus.service.Object.__init__(self, bus, u"/")
1854
_interface = u"se.bsnet.fukt.Mandos"
1855
1856
@dbus.service.signal(_interface, signature=u"o")
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")
1857
2693
def ClientAdded(self, objpath):
1858
2694
"D-Bus signal"
1859
2695
pass
1860
2696
1861
@dbus.service.signal(_interface, signature=u"ss")
2697
@dbus.service.signal(_interface, signature="ss")
1862
2698
def ClientNotFound(self, fingerprint, address):
1863
2699
"D-Bus signal"
1864
2700
pass
1865
2701
1866
@dbus.service.signal(_interface, signature=u"os")
2702
@dbus.service.signal(_interface, signature="os")
1867
2703
def ClientRemoved(self, objpath, name):
1868
2704
"D-Bus signal"
1869
2705
pass
1870
2706
1871
@dbus.service.method(_interface, out_signature=u"ao")
2707
@dbus.service.method(_interface, out_signature="ao")
1872
2708
def GetAllClients(self):
1873
2709
"D-Bus method"
1874
2710
return dbus.Array(c.dbus_object_path
1875
for c in tcp_server.clients)
2711
for c in
2712
tcp_server.clients.itervalues())
1876
2713
1877
2714
@dbus.service.method(_interface,
1878
out_signature=u"a{oa{sv}}")
2715
out_signature="a{oa{sv}}")
1879
2716
def GetAllClientsWithProperties(self):
1880
2717
"D-Bus method"
1881
2718
return dbus.Dictionary(
1882
((c.dbus_object_path, c.GetAll(u""))
1883
for c in tcp_server.clients),
1884
signature=u"oa{sv}")
2719
((c.dbus_object_path, c.GetAll(""))
2720
for c in tcp_server.clients.itervalues()),
2721
signature="oa{sv}")
1885
2722
1886
@dbus.service.method(_interface, in_signature=u"o")
2723
@dbus.service.method(_interface, in_signature="o")
1887
2724
def RemoveClient(self, object_path):
1888
2725
"D-Bus method"
1889
for c in tcp_server.clients:
2726
for c in tcp_server.clients.itervalues():
1890
2727
if c.dbus_object_path == object_path:
1891
tcp_server.clients.remove(c)
2728
del tcp_server.clients[c.name]
1892
2729
c.remove_from_connection()
1893
2730
# Don't signal anything except ClientRemoved
1894
2731
c.disable(quiet=True)
1905
2742
"Cleanup function; run on exit"
1906
2743
service.cleanup()
1907
2744
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
1908
2801
while tcp_server.clients:
1909
client = tcp_server.clients.pop()
2802
name, client = tcp_server.clients.popitem()
1910
2803
if use_dbus:
1911
2804
client.remove_from_connection()
1912
client.disable_hook = None
1913
2805
# Don't signal anything except ClientRemoved
1914
2806
client.disable(quiet=True)
1915
2807
if use_dbus:
1916
2808
# Emit D-Bus signal
1917
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2809
mandos_dbus_service.ClientRemoved(client
2810
.dbus_object_path,
1918
2811
client.name)
2812
client_settings.clear()
1919
2813
1920
2814
atexit.register(cleanup)
1921
2815
1922
for client in tcp_server.clients:
2816
for client in tcp_server.clients.itervalues():
1923
2817
if use_dbus:
1924
2818
# Emit D-Bus signal
1925
2819
mandos_dbus_service.ClientAdded(client.dbus_object_path)
1926
client.enable()
2820
# Need to initiate checking of clients
2821
if client.enabled:
2822
client.init_checker()
1927
2823
1928
2824
tcp_server.enable()
1929
2825
tcp_server.server_activate()
1931
2827
# Find out what port we got
1932
2828
service.port = tcp_server.socket.getsockname()[1]
1933
2829
if use_ipv6:
1934
logger.info(u"Now listening on address %r, port %d,"
1935
" flowinfo %d, scope_id %d"
1936
% tcp_server.socket.getsockname())
2830
logger.info("Now listening on address %r, port %d,"
2831
" flowinfo %d, scope_id %d",
2832
*tcp_server.socket.getsockname())
1937
2833
else: # IPv4
1938
logger.info(u"Now listening on address %r, port %d"
1939
% tcp_server.socket.getsockname())
2834
logger.info("Now listening on address %r, port %d",
2835
*tcp_server.socket.getsockname())
1940
2836
1941
2837
#service.interface = tcp_server.socket.getsockname()[3]
1942
2838
1944
2840
# From the Avahi example code
1945
2841
try:
1946
2842
service.activate()
1947
except dbus.exceptions.DBusException, error:
1948
logger.critical(u"DBusException: %s", error)
2843
except dbus.exceptions.DBusException as error:
2844
logger.critical("D-Bus Exception", exc_info=error)
1949
2845
cleanup()
1950
2846
sys.exit(1)
1951
2847
# End of Avahi example code
1955
2851
(tcp_server.handle_request
1956
2852
(*args[2:], **kwargs) or True))
1957
2853
1958
logger.debug(u"Starting main loop")
2854
logger.debug("Starting main loop")
1959
2855
main_loop.run()
1960
except AvahiError, error:
1961
logger.critical(u"AvahiError: %s", error)
2856
except AvahiError as error:
2857
logger.critical("Avahi Error", exc_info=error)
1962
2858
cleanup()
1963
2859
sys.exit(1)
1964
2860
except KeyboardInterrupt:
1965
2861
if debug:
1966
print >> sys.stderr
1967
logger.debug(u"Server received KeyboardInterrupt")
1968
logger.debug(u"Server exiting")
2862
print("", file=sys.stderr)
2863
logger.debug("Server received KeyboardInterrupt")
2864
logger.debug("Server exiting")
1969
2865
# Must run before the D-Bus bus name gets deregistered
1970
2866
cleanup()
1971
2867
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0