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