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