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