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