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