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