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