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