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