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 237.4.4
- compare with another revision
- download diff
- download tarball
- view history from revision 237.4.4
- Committer: Björn Påhlsson
- Date: 2010-10-02 17:23:41 UTC
- mto: (24.1.170 mandos) (237.4.29 release)
- mto: This revision was merged to the branch mainline in revision 453.
- Revision ID: belorn@fukt.bsnet.se-20101002172341-l9aflokaxce8nrsk
Tags: version-1.2.1-1
* Makefile (version): Changed to "1.2.1".
* NEWS (Version 1.2.1): New entry.
* debian/changelog (1.2.1): - '' -
* NEWS (Version 1.2.1): New entry.
* debian/changelog (1.2.1): - '' -
- files removed:
- debian/mandos-client.examples
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- 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-2010 Teddy Hogeborn
15
# Copyright © 2008-2010 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.2.1"
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
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
257
disable_hook: If set, called by disable() as disable_hook(self)
430
258
disable_initiator_tag: a gobject event source tag, or None
431
259
enabled: bool()
432
260
fingerprint: string (40 or 32 hexadecimal digits); used to
435
263
interval: datetime.timedelta(); How often to start a new checker
436
264
last_approval_request: datetime.datetime(); (UTC) or None
437
265
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
266
last_enabled: datetime.datetime(); (UTC)
442
267
name: string; from the config file, used in log messages and
443
268
D-Bus identifiers
444
269
secret: bytestring; sent verbatim (over TLS) to client
445
270
timeout: datetime.timedelta(); How long from last_checked_ok
446
271
until this client is disabled
447
extended_timeout: extra long timeout when secret has been sent
448
272
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
273
"""
453
274
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
}
275
runtime_expansions = (u"approval_delay", u"approval_duration",
276
u"created", u"enabled", u"fingerprint",
277
u"host", u"interval", u"last_checked_ok",
278
u"last_enabled", u"name", u"timeout")
469
279
470
280
@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
client["fingerprint"] = (section["fingerprint"].upper()
491
.replace(" ", ""))
492
if "secret" in section:
493
client["secret"] = section["secret"].decode("base64")
494
elif "secfile" in section:
495
with open(os.path.expanduser(os.path.expandvars
496
(section["secfile"])),
497
"rb") as secfile:
498
client["secret"] = secfile.read()
499
else:
500
raise TypeError("No secret or secfile for section {}"
501
.format(section))
502
client["timeout"] = string_to_delta(section["timeout"])
503
client["extended_timeout"] = string_to_delta(
504
section["extended_timeout"])
505
client["interval"] = string_to_delta(section["interval"])
506
client["approval_delay"] = string_to_delta(
507
section["approval_delay"])
508
client["approval_duration"] = string_to_delta(
509
section["approval_duration"])
510
client["checker_command"] = section["checker"]
511
client["last_approval_request"] = None
512
client["last_checked_ok"] = None
513
client["last_checker_status"] = -2
514
515
return settings
516
517
def __init__(self, settings, name = None, server_settings=None):
281
def _timedelta_to_milliseconds(td):
282
"Convert a datetime.timedelta() to milliseconds"
283
return ((td.days * 24 * 60 * 60 * 1000)
284
+ (td.seconds * 1000)
285
+ (td.microseconds // 1000))
286
287
def timeout_milliseconds(self):
288
"Return the 'timeout' attribute in milliseconds"
289
return self._timedelta_to_milliseconds(self.timeout)
290
291
def interval_milliseconds(self):
292
"Return the 'interval' attribute in milliseconds"
293
return self._timedelta_to_milliseconds(self.interval)
294
295
def approval_delay_milliseconds(self):
296
return self._timedelta_to_milliseconds(self.approval_delay)
297
298
def __init__(self, name = None, disable_hook=None, config=None):
299
"""Note: the 'checker' key in 'config' sets the
300
'checker_command' attribute and *not* the 'checker'
301
attribute."""
518
302
self.name = name
519
if server_settings is None:
520
server_settings = {}
521
self.server_settings = server_settings
522
# adding all client settings
523
for setting, value in settings.items():
524
setattr(self, setting, value)
525
526
if self.enabled:
527
if not hasattr(self, "last_enabled"):
528
self.last_enabled = datetime.datetime.utcnow()
529
if not hasattr(self, "expires"):
530
self.expires = (datetime.datetime.utcnow()
531
+ self.timeout)
532
else:
533
self.last_enabled = None
534
self.expires = None
535
536
logger.debug("Creating client %r", self.name)
303
if config is None:
304
config = {}
305
logger.debug(u"Creating client %r", self.name)
537
306
# Uppercase and remove spaces from fingerprint for later
538
307
# comparison purposes with return value from the fingerprint()
539
308
# function
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
309
self.fingerprint = (config[u"fingerprint"].upper()
310
.replace(u" ", u""))
311
logger.debug(u" Fingerprint: %s", self.fingerprint)
312
if u"secret" in config:
313
self.secret = config[u"secret"].decode(u"base64")
314
elif u"secfile" in config:
315
with open(os.path.expanduser(os.path.expandvars
316
(config[u"secfile"])),
317
"rb") as secfile:
318
self.secret = secfile.read()
319
else:
320
raise TypeError(u"No secret or secfile for client %s"
321
% self.name)
322
self.host = config.get(u"host", u"")
323
self.created = datetime.datetime.utcnow()
324
self.enabled = False
325
self.last_approval_request = None
326
self.last_enabled = None
327
self.last_checked_ok = None
328
self.timeout = string_to_delta(config[u"timeout"])
329
self.interval = string_to_delta(config[u"interval"])
330
self.disable_hook = disable_hook
545
331
self.checker = None
546
332
self.checker_initiator_tag = None
547
333
self.disable_initiator_tag = None
548
334
self.checker_callback_tag = None
335
self.checker_command = config[u"checker"]
549
336
self.current_checker_command = None
550
self.approved = None
337
self.last_connect = None
338
self._approved = None
339
self.approved_by_default = config.get(u"approved_by_default",
340
True)
551
341
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)
342
self.approval_delay = string_to_delta(
343
config[u"approval_delay"])
344
self.approval_duration = string_to_delta(
345
config[u"approval_duration"])
346
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
566
347
567
# Send notice to process children that client state has changed
568
348
def send_changedstate(self):
569
with self.changedstate:
570
self.changedstate.notify_all()
571
349
self.changedstate.acquire()
350
self.changedstate.notify_all()
351
self.changedstate.release()
352
572
353
def enable(self):
573
354
"""Start this client's checker and timeout hooks"""
574
if getattr(self, "enabled", False):
355
if getattr(self, u"enabled", False):
575
356
# Already enabled
576
357
return
577
self.expires = datetime.datetime.utcnow() + self.timeout
578
self.enabled = True
358
self.send_changedstate()
579
359
self.last_enabled = datetime.datetime.utcnow()
580
self.init_checker()
581
self.send_changedstate()
360
# Schedule a new checker to be started an 'interval' from now,
361
# and every interval from then on.
362
self.checker_initiator_tag = (gobject.timeout_add
363
(self.interval_milliseconds(),
364
self.start_checker))
365
# Schedule a disable() when 'timeout' has passed
366
self.disable_initiator_tag = (gobject.timeout_add
367
(self.timeout_milliseconds(),
368
self.disable))
369
self.enabled = True
370
# Also start a new checker *right now*.
371
self.start_checker()
582
372
583
373
def disable(self, quiet=True):
584
374
"""Disable this client."""
585
375
if not getattr(self, "enabled", False):
586
376
return False
587
377
if not quiet:
588
logger.info("Disabling client %s", self.name)
589
if getattr(self, "disable_initiator_tag", None) is not None:
378
self.send_changedstate()
379
if not quiet:
380
logger.info(u"Disabling client %s", self.name)
381
if getattr(self, u"disable_initiator_tag", False):
590
382
gobject.source_remove(self.disable_initiator_tag)
591
383
self.disable_initiator_tag = None
592
self.expires = None
593
if getattr(self, "checker_initiator_tag", None) is not None:
384
if getattr(self, u"checker_initiator_tag", False):
594
385
gobject.source_remove(self.checker_initiator_tag)
595
386
self.checker_initiator_tag = None
596
387
self.stop_checker()
388
if self.disable_hook:
389
self.disable_hook(self)
597
390
self.enabled = False
598
if not quiet:
599
self.send_changedstate()
600
391
# Do not run this again if called by a gobject.timeout_add
601
392
return False
602
393
603
394
def __del__(self):
395
self.disable_hook = None
604
396
self.disable()
605
397
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
398
def checker_callback(self, pid, condition, command):
626
399
"""The checker has completed, so take appropriate actions."""
627
400
self.checker_callback_tag = None
628
401
self.checker = None
629
402
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",
403
exitstatus = os.WEXITSTATUS(condition)
404
if exitstatus == 0:
405
logger.info(u"Checker for %(name)s succeeded",
633
406
vars(self))
634
407
self.checked_ok()
635
408
else:
636
logger.info("Checker for %(name)s failed",
409
logger.info(u"Checker for %(name)s failed",
637
410
vars(self))
638
411
else:
639
self.last_checker_status = -1
640
logger.warning("Checker for %(name)s crashed?",
412
logger.warning(u"Checker for %(name)s crashed?",
641
413
vars(self))
642
414
643
415
def checked_ok(self):
644
"""Assert that the client has been seen, alive and well."""
416
"""Bump up the timeout for this client.
417
418
This should only be called when the client has been seen,
419
alive and well.
420
"""
645
421
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
422
gobject.source_remove(self.disable_initiator_tag)
423
self.disable_initiator_tag = (gobject.timeout_add
424
(self.timeout_milliseconds(),
425
self.disable))
661
426
662
427
def need_approval(self):
663
428
self.last_approval_request = datetime.datetime.utcnow()
668
433
If a checker already exists, leave it running and do
669
434
nothing."""
670
435
# 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
436
# did that, then if a checker (for some reason) started
437
# running slowly and taking more than 'interval' time, the
438
# client would inevitably timeout, since no checker would get
439
# a chance to run to completion. If we instead leave running
675
440
# checkers alone, the checker would have to take more time
676
441
# than 'timeout' for the client to be disabled, which is as it
677
442
# should be.
679
444
# If a checker exists, make sure it is not a zombie
680
445
try:
681
446
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
447
except (AttributeError, OSError), error:
448
if (isinstance(error, OSError)
449
and error.errno != errno.ECHILD):
450
raise error
687
451
else:
688
452
if pid:
689
logger.warning("Checker was a zombie")
453
logger.warning(u"Checker was a zombie")
690
454
gobject.source_remove(self.checker_callback_tag)
691
455
self.checker_callback(pid, status,
692
456
self.current_checker_command)
693
457
# Start a new checker if needed
694
458
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
459
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
460
# In case checker_command has exactly one % operator
461
command = self.checker_command % self.host
462
except TypeError:
463
# Escape attributes for the shell
464
escaped_attrs = dict(
465
(attr,
466
re.escape(unicode(str(getattr(self, attr, u"")),
467
errors=
468
u'replace')))
469
for attr in
470
self.runtime_expansions)
471
472
try:
473
command = self.checker_command % escaped_attrs
474
except TypeError, error:
475
logger.error(u'Could not format string "%s":'
476
u' %s', self.checker_command, error)
477
return True # Try again later
705
478
self.current_checker_command = command
706
479
try:
707
logger.info("Starting checker %r for %s",
480
logger.info(u"Starting checker %r for %s",
708
481
command, self.name)
709
482
# We don't need to redirect stdout and stderr, since
710
483
# in normal mode, that is already done by daemon(),
711
484
# and in debug mode we don't want to. (Stdin is
712
485
# 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
486
self.checker = subprocess.Popen(command,
722
487
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:
488
shell=True, cwd=u"/")
489
self.checker_callback_tag = (gobject.child_watch_add
490
(self.checker.pid,
491
self.checker_callback,
492
data=command))
493
# The checker may have completed before the gobject
494
# watch was added. Check for this.
736
495
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)
496
if pid:
497
gobject.source_remove(self.checker_callback_tag)
498
self.checker_callback(pid, status, command)
499
except OSError, error:
500
logger.error(u"Failed to start subprocess: %s",
501
error)
747
502
# Re-run this periodically if run by gobject.timeout_add
748
503
return True
749
504
752
507
if self.checker_callback_tag:
753
508
gobject.source_remove(self.checker_callback_tag)
754
509
self.checker_callback_tag = None
755
if getattr(self, "checker", None) is None:
510
if getattr(self, u"checker", None) is None:
756
511
return
757
logger.debug("Stopping checker for %(name)s", vars(self))
512
logger.debug(u"Stopping checker for %(name)s", vars(self))
758
513
try:
759
self.checker.terminate()
514
os.kill(self.checker.pid, signal.SIGTERM)
760
515
#time.sleep(0.5)
761
516
#if self.checker.poll() is None:
762
# self.checker.kill()
763
except OSError as error:
517
# os.kill(self.checker.pid, signal.SIGKILL)
518
except OSError, error:
764
519
if error.errno != errno.ESRCH: # No such process
765
520
raise
766
521
self.checker = None
767
522
768
769
def dbus_service_property(dbus_interface, signature="v",
770
access="readwrite", byte_arrays=False):
523
def dbus_service_property(dbus_interface, signature=u"v",
524
access=u"readwrite", byte_arrays=False):
771
525
"""Decorators for marking methods of a DBusObjectWithProperties to
772
526
become properties on the D-Bus.
773
527
780
534
"""
781
535
# Encoding deeply encoded byte arrays is not supported yet by the
782
536
# "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))
537
if byte_arrays and signature != u"ay":
538
raise ValueError(u"Byte arrays not supported for non-'ay'"
539
u" signature %r" % signature)
786
540
def decorator(func):
787
541
func._dbus_is_property = True
788
542
func._dbus_interface = dbus_interface
789
543
func._dbus_signature = signature
790
544
func._dbus_access = access
791
545
func._dbus_name = func.__name__
792
if func._dbus_name.endswith("_dbus_property"):
546
if func._dbus_name.endswith(u"_dbus_property"):
793
547
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
548
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
832
549
return func
833
550
return decorator
834
551
836
553
class DBusPropertyException(dbus.exceptions.DBusException):
837
554
"""A base class for D-Bus property-related exceptions
838
555
"""
839
pass
556
def __unicode__(self):
557
return unicode(str(self))
558
840
559
841
560
class DBusPropertyAccessException(DBusPropertyException):
842
561
"""A property's access permissions disallows an operation.
852
571
853
572
class DBusObjectWithProperties(dbus.service.Object):
854
573
"""A D-Bus object with properties.
855
574
856
575
Classes inheriting from this can use the dbus_service_property
857
576
decorator to expose methods as D-Bus properties. It exposes the
858
577
standard Get(), Set(), and GetAll() methods on the D-Bus.
859
578
"""
860
579
861
580
@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)
581
def _is_dbus_property(obj):
582
return getattr(obj, u"_dbus_is_property", False)
870
583
871
def _get_all_dbus_things(self, thing):
584
def _get_all_dbus_properties(self):
872
585
"""Returns a generator of (name, attribute) pairs
873
586
"""
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)))
587
return ((prop._dbus_name, prop)
588
for name, prop in
589
inspect.getmembers(self, self._is_dbus_property))
881
590
882
591
def _get_dbus_property(self, interface_name, property_name):
883
592
"""Returns a bound method if one exists which is a D-Bus
884
593
property with the specified name and interface.
885
594
"""
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
595
for name in (property_name,
596
property_name + u"_dbus_property"):
597
prop = getattr(self, name, None)
598
if (prop is None
599
or not self._is_dbus_property(prop)
600
or prop._dbus_name != property_name
601
or (interface_name and prop._dbus_interface
602
and interface_name != prop._dbus_interface)):
603
continue
604
return prop
894
605
# No such property
895
raise DBusPropertyNotFound(self.dbus_object_path + ":"
896
+ interface_name + "."
606
raise DBusPropertyNotFound(self.dbus_object_path + u":"
607
+ interface_name + u"."
897
608
+ property_name)
898
609
899
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
900
out_signature="v")
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
611
out_signature=u"v")
901
612
def Get(self, interface_name, property_name):
902
613
"""Standard D-Bus property Get() method, see D-Bus standard.
903
614
"""
904
615
prop = self._get_dbus_property(interface_name, property_name)
905
if prop._dbus_access == "write":
616
if prop._dbus_access == u"write":
906
617
raise DBusPropertyAccessException(property_name)
907
618
value = prop()
908
if not hasattr(value, "variant_level"):
619
if not hasattr(value, u"variant_level"):
909
620
return value
910
621
return type(value)(value, variant_level=value.variant_level+1)
911
622
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
623
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
913
624
def Set(self, interface_name, property_name, value):
914
625
"""Standard D-Bus property Set() method, see D-Bus standard.
915
626
"""
916
627
prop = self._get_dbus_property(interface_name, property_name)
917
if prop._dbus_access == "read":
628
if prop._dbus_access == u"read":
918
629
raise DBusPropertyAccessException(property_name)
919
if prop._dbus_get_args_options["byte_arrays"]:
630
if prop._dbus_get_args_options[u"byte_arrays"]:
920
631
# The byte_arrays option is not supported yet on
921
632
# 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))
633
if prop._dbus_signature != u"ay":
634
raise ValueError
635
value = dbus.ByteArray(''.join(unichr(byte)
636
for byte in value))
928
637
prop(value)
929
638
930
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
931
out_signature="a{sv}")
639
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
640
out_signature=u"a{sv}")
932
641
def GetAll(self, interface_name):
933
642
"""Standard D-Bus property GetAll() method, see D-Bus
934
643
standard.
935
644
936
645
Note: Will not include properties with access="write".
937
646
"""
938
properties = {}
939
for name, prop in self._get_all_dbus_things("property"):
647
all = {}
648
for name, prop in self._get_all_dbus_properties():
940
649
if (interface_name
941
650
and interface_name != prop._dbus_interface):
942
651
# Interface non-empty but did not match
943
652
continue
944
653
# Ignore write-only properties
945
if prop._dbus_access == "write":
654
if prop._dbus_access == u"write":
946
655
continue
947
656
value = prop()
948
if not hasattr(value, "variant_level"):
949
properties[name] = value
657
if not hasattr(value, u"variant_level"):
658
all[name] = value
950
659
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
660
all[name] = type(value)(value, variant_level=
661
value.variant_level+1)
662
return dbus.Dictionary(all, signature=u"sv")
962
663
963
664
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
964
out_signature="s",
665
out_signature=u"s",
965
666
path_keyword='object_path',
966
667
connection_keyword='connection')
967
668
def Introspect(self, object_path, connection):
968
"""Overloading of standard D-Bus method.
969
970
Inserts property tags and interface annotation tags.
669
"""Standard D-Bus method, overloaded to insert property tags.
971
670
"""
972
671
xmlstring = dbus.service.Object.Introspect(self, object_path,
973
672
connection)
974
673
try:
975
674
document = xml.dom.minidom.parseString(xmlstring)
976
675
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)
676
e = document.createElement(u"property")
677
e.setAttribute(u"name", name)
678
e.setAttribute(u"type", prop._dbus_signature)
679
e.setAttribute(u"access", prop._dbus_access)
981
680
return e
982
for if_tag in document.getElementsByTagName("interface"):
983
# Add property tags
681
for if_tag in document.getElementsByTagName(u"interface"):
984
682
for tag in (make_tag(document, name, prop)
985
683
for name, prop
986
in self._get_all_dbus_things("property")
684
in self._get_all_dbus_properties()
987
685
if prop._dbus_interface
988
== if_tag.getAttribute("name")):
686
== if_tag.getAttribute(u"name")):
989
687
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
688
# Add the names to the return values for the
1022
689
# "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")
690
if (if_tag.getAttribute(u"name")
691
== u"org.freedesktop.DBus.Properties"):
692
for cn in if_tag.getElementsByTagName(u"method"):
693
if cn.getAttribute(u"name") == u"Get":
694
for arg in cn.getElementsByTagName(u"arg"):
695
if (arg.getAttribute(u"direction")
696
== u"out"):
697
arg.setAttribute(u"name", u"value")
698
elif cn.getAttribute(u"name") == u"GetAll":
699
for arg in cn.getElementsByTagName(u"arg"):
700
if (arg.getAttribute(u"direction")
701
== u"out"):
702
arg.setAttribute(u"name", u"props")
703
xmlstring = document.toxml(u"utf-8")
1037
704
document.unlink()
1038
705
except (AttributeError, xml.dom.DOMException,
1039
xml.parsers.expat.ExpatError) as error:
1040
logger.error("Failed to override Introspection method",
1041
exc_info=error)
706
xml.parsers.expat.ExpatError), error:
707
logger.error(u"Failed to override Introspection method",
708
error)
1042
709
return xmlstring
1043
710
1044
711
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
712
class ClientDBus(Client, DBusObjectWithProperties):
1225
713
"""A Client class using D-Bus
1226
714
1230
718
"""
1231
719
1232
720
runtime_expansions = (Client.runtime_expansions
1233
+ ("dbus_object_path",))
1234
1235
_interface = "se.recompile.Mandos.Client"
721
+ (u"dbus_object_path",))
1236
722
1237
723
# dbus.service.Object doesn't use super(), so we can't either.
1238
724
1239
725
def __init__(self, bus = None, *args, **kwargs):
726
self._approvals_pending = 0
1240
727
self.bus = bus
1241
728
Client.__init__(self, *args, **kwargs)
1242
729
# Only now, when this client is initialized, can it show up on
1243
730
# the D-Bus
1244
client_object_name = str(self.name).translate(
1245
{ord("."): ord("_"),
1246
ord("-"): ord("_")})
731
client_object_name = unicode(self.name).translate(
732
{ord(u"."): ord(u"_"),
733
ord(u"-"): ord(u"_")})
1247
734
self.dbus_object_path = (dbus.ObjectPath
1248
("/clients/" + client_object_name))
735
(u"/clients/" + client_object_name))
1249
736
DBusObjectWithProperties.__init__(self, self.bus,
1250
737
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
738
739
def _get_approvals_pending(self):
740
return self._approvals_pending
741
def _set_approvals_pending(self, value):
742
old_value = self._approvals_pending
743
self._approvals_pending = value
744
bval = bool(value)
745
if (hasattr(self, "dbus_object_path")
746
and bval is not bool(old_value)):
747
dbus_bool = dbus.Boolean(bval, variant_level=1)
748
self.PropertyChanged(dbus.String(u"ApprovalPending"),
749
dbus_bool)
750
751
approvals_pending = property(_get_approvals_pending,
752
_set_approvals_pending)
753
del _get_approvals_pending, _set_approvals_pending
754
755
@staticmethod
756
def _datetime_to_dbus(dt, variant_level=0):
757
"""Convert a UTC datetime.datetime() to a D-Bus type."""
758
return dbus.String(dt.isoformat(),
759
variant_level=variant_level)
760
761
def enable(self):
762
oldstate = getattr(self, u"enabled", False)
763
r = Client.enable(self)
764
if oldstate != self.enabled:
765
# Emit D-Bus signals
766
self.PropertyChanged(dbus.String(u"Enabled"),
767
dbus.Boolean(True, variant_level=1))
768
self.PropertyChanged(
769
dbus.String(u"LastEnabled"),
770
self._datetime_to_dbus(self.last_enabled,
771
variant_level=1))
772
return r
773
774
def disable(self, quiet = False):
775
oldstate = getattr(self, u"enabled", False)
776
r = Client.disable(self, quiet=quiet)
777
if not quiet and oldstate != self.enabled:
778
# Emit D-Bus signal
779
self.PropertyChanged(dbus.String(u"Enabled"),
780
dbus.Boolean(False, variant_level=1))
781
return r
1334
782
1335
783
def __del__(self, *args, **kwargs):
1336
784
try:
1337
785
self.remove_from_connection()
1338
786
except LookupError:
1339
787
pass
1340
if hasattr(DBusObjectWithProperties, "__del__"):
788
if hasattr(DBusObjectWithProperties, u"__del__"):
1341
789
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1342
790
Client.__del__(self, *args, **kwargs)
1343
791
1345
793
*args, **kwargs):
1346
794
self.checker_callback_tag = None
1347
795
self.checker = None
796
# Emit D-Bus signal
797
self.PropertyChanged(dbus.String(u"CheckerRunning"),
798
dbus.Boolean(False, variant_level=1))
1348
799
if os.WIFEXITED(condition):
1349
800
exitstatus = os.WEXITSTATUS(condition)
1350
801
# Emit D-Bus signal
1360
811
return Client.checker_callback(self, pid, condition, command,
1361
812
*args, **kwargs)
1362
813
814
def checked_ok(self, *args, **kwargs):
815
r = Client.checked_ok(self, *args, **kwargs)
816
# Emit D-Bus signal
817
self.PropertyChanged(
818
dbus.String(u"LastCheckedOK"),
819
(self._datetime_to_dbus(self.last_checked_ok,
820
variant_level=1)))
821
return r
822
823
def need_approval(self, *args, **kwargs):
824
r = Client.need_approval(self, *args, **kwargs)
825
# Emit D-Bus signal
826
self.PropertyChanged(
827
dbus.String(u"LastApprovalRequest"),
828
(self._datetime_to_dbus(self.last_approval_request,
829
variant_level=1)))
830
return r
831
1363
832
def start_checker(self, *args, **kwargs):
1364
old_checker_pid = getattr(self.checker, "pid", None)
833
old_checker = self.checker
834
if self.checker is not None:
835
old_checker_pid = self.checker.pid
836
else:
837
old_checker_pid = None
1365
838
r = Client.start_checker(self, *args, **kwargs)
1366
839
# Only if new checker process was started
1367
840
if (self.checker is not None
1368
841
and old_checker_pid != self.checker.pid):
1369
842
# Emit D-Bus signal
1370
843
self.CheckerStarted(self.current_checker_command)
844
self.PropertyChanged(
845
dbus.String(u"CheckerRunning"),
846
dbus.Boolean(True, variant_level=1))
1371
847
return r
1372
848
849
def stop_checker(self, *args, **kwargs):
850
old_checker = getattr(self, u"checker", None)
851
r = Client.stop_checker(self, *args, **kwargs)
852
if (old_checker is not None
853
and getattr(self, u"checker", None) is None):
854
self.PropertyChanged(dbus.String(u"CheckerRunning"),
855
dbus.Boolean(False, variant_level=1))
856
return r
857
1373
858
def _reset_approved(self):
1374
self.approved = None
859
self._approved = None
1375
860
return False
1376
861
1377
862
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
863
self.send_changedstate()
864
self._approved = value
865
gobject.timeout_add(self._timedelta_to_milliseconds
866
(self.approval_duration),
867
self._reset_approved)
868
1382
869
1383
870
## D-Bus methods, signals & properties
1384
1385
## Interfaces
871
_interface = u"se.bsnet.fukt.Mandos.Client"
1386
872
1387
873
## Signals
1388
874
1389
875
# CheckerCompleted - signal
1390
@dbus.service.signal(_interface, signature="nxs")
876
@dbus.service.signal(_interface, signature=u"nxs")
1391
877
def CheckerCompleted(self, exitcode, waitstatus, command):
1392
878
"D-Bus signal"
1393
879
pass
1394
880
1395
881
# CheckerStarted - signal
1396
@dbus.service.signal(_interface, signature="s")
882
@dbus.service.signal(_interface, signature=u"s")
1397
883
def CheckerStarted(self, command):
1398
884
"D-Bus signal"
1399
885
pass
1400
886
1401
887
# PropertyChanged - signal
1402
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1403
@dbus.service.signal(_interface, signature="sv")
888
@dbus.service.signal(_interface, signature=u"sv")
1404
889
def PropertyChanged(self, property, value):
1405
890
"D-Bus signal"
1406
891
pass
1415
900
pass
1416
901
1417
902
# Rejected - signal
1418
@dbus.service.signal(_interface, signature="s")
903
@dbus.service.signal(_interface, signature=u"s")
1419
904
def Rejected(self, reason):
1420
905
"D-Bus signal"
1421
906
pass
1422
907
1423
908
# NeedApproval - signal
1424
@dbus.service.signal(_interface, signature="tb")
909
@dbus.service.signal(_interface, signature=u"tb")
1425
910
def NeedApproval(self, timeout, default):
1426
911
"D-Bus signal"
1427
912
return self.need_approval()
1429
914
## Methods
1430
915
1431
916
# Approve - method
1432
@dbus.service.method(_interface, in_signature="b")
917
@dbus.service.method(_interface, in_signature=u"b")
1433
918
def Approve(self, value):
1434
919
self.approve(value)
1435
920
1436
921
# CheckedOK - method
1437
922
@dbus.service.method(_interface)
1438
923
def CheckedOK(self):
1439
self.checked_ok()
924
return self.checked_ok()
1440
925
1441
926
# Enable - method
1442
927
@dbus.service.method(_interface)
1464
949
## Properties
1465
950
1466
951
# ApprovalPending - property
1467
@dbus_service_property(_interface, signature="b", access="read")
952
@dbus_service_property(_interface, signature=u"b", access=u"read")
1468
953
def ApprovalPending_dbus_property(self):
1469
954
return dbus.Boolean(bool(self.approvals_pending))
1470
955
1471
956
# ApprovedByDefault - property
1472
@dbus_service_property(_interface, signature="b",
1473
access="readwrite")
957
@dbus_service_property(_interface, signature=u"b",
958
access=u"readwrite")
1474
959
def ApprovedByDefault_dbus_property(self, value=None):
1475
960
if value is None: # get
1476
961
return dbus.Boolean(self.approved_by_default)
1477
962
self.approved_by_default = bool(value)
963
# Emit D-Bus signal
964
self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
965
dbus.Boolean(value, variant_level=1))
1478
966
1479
967
# ApprovalDelay - property
1480
@dbus_service_property(_interface, signature="t",
1481
access="readwrite")
968
@dbus_service_property(_interface, signature=u"t",
969
access=u"readwrite")
1482
970
def ApprovalDelay_dbus_property(self, value=None):
1483
971
if value is None: # get
1484
return dbus.UInt64(self.approval_delay.total_seconds()
1485
* 1000)
972
return dbus.UInt64(self.approval_delay_milliseconds())
1486
973
self.approval_delay = datetime.timedelta(0, 0, 0, value)
974
# Emit D-Bus signal
975
self.PropertyChanged(dbus.String(u"ApprovalDelay"),
976
dbus.UInt64(value, variant_level=1))
1487
977
1488
978
# ApprovalDuration - property
1489
@dbus_service_property(_interface, signature="t",
1490
access="readwrite")
979
@dbus_service_property(_interface, signature=u"t",
980
access=u"readwrite")
1491
981
def ApprovalDuration_dbus_property(self, value=None):
1492
982
if value is None: # get
1493
return dbus.UInt64(self.approval_duration.total_seconds()
1494
* 1000)
983
return dbus.UInt64(self._timedelta_to_milliseconds(
984
self.approval_duration))
1495
985
self.approval_duration = datetime.timedelta(0, 0, 0, value)
986
# Emit D-Bus signal
987
self.PropertyChanged(dbus.String(u"ApprovalDuration"),
988
dbus.UInt64(value, variant_level=1))
1496
989
1497
990
# Name - property
1498
@dbus_service_property(_interface, signature="s", access="read")
991
@dbus_service_property(_interface, signature=u"s", access=u"read")
1499
992
def Name_dbus_property(self):
1500
993
return dbus.String(self.name)
1501
994
1502
995
# Fingerprint - property
1503
@dbus_service_property(_interface, signature="s", access="read")
996
@dbus_service_property(_interface, signature=u"s", access=u"read")
1504
997
def Fingerprint_dbus_property(self):
1505
998
return dbus.String(self.fingerprint)
1506
999
1507
1000
# Host - property
1508
@dbus_service_property(_interface, signature="s",
1509
access="readwrite")
1001
@dbus_service_property(_interface, signature=u"s",
1002
access=u"readwrite")
1510
1003
def Host_dbus_property(self, value=None):
1511
1004
if value is None: # get
1512
1005
return dbus.String(self.host)
1513
self.host = str(value)
1006
self.host = value
1007
# Emit D-Bus signal
1008
self.PropertyChanged(dbus.String(u"Host"),
1009
dbus.String(value, variant_level=1))
1514
1010
1515
1011
# Created - property
1516
@dbus_service_property(_interface, signature="s", access="read")
1012
@dbus_service_property(_interface, signature=u"s", access=u"read")
1517
1013
def Created_dbus_property(self):
1518
return datetime_to_dbus(self.created)
1014
return dbus.String(self._datetime_to_dbus(self.created))
1519
1015
1520
1016
# LastEnabled - property
1521
@dbus_service_property(_interface, signature="s", access="read")
1017
@dbus_service_property(_interface, signature=u"s", access=u"read")
1522
1018
def LastEnabled_dbus_property(self):
1523
return datetime_to_dbus(self.last_enabled)
1019
if self.last_enabled is None:
1020
return dbus.String(u"")
1021
return dbus.String(self._datetime_to_dbus(self.last_enabled))
1524
1022
1525
1023
# Enabled - property
1526
@dbus_service_property(_interface, signature="b",
1527
access="readwrite")
1024
@dbus_service_property(_interface, signature=u"b",
1025
access=u"readwrite")
1528
1026
def Enabled_dbus_property(self, value=None):
1529
1027
if value is None: # get
1530
1028
return dbus.Boolean(self.enabled)
1534
1032
self.disable()
1535
1033
1536
1034
# LastCheckedOK - property
1537
@dbus_service_property(_interface, signature="s",
1538
access="readwrite")
1035
@dbus_service_property(_interface, signature=u"s",
1036
access=u"readwrite")
1539
1037
def LastCheckedOK_dbus_property(self, value=None):
1540
1038
if value is not None:
1541
1039
self.checked_ok()
1542
1040
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)
1041
if self.last_checked_ok is None:
1042
return dbus.String(u"")
1043
return dbus.String(self._datetime_to_dbus(self
1044
.last_checked_ok))
1555
1045
1556
1046
# LastApprovalRequest - property
1557
@dbus_service_property(_interface, signature="s", access="read")
1047
@dbus_service_property(_interface, signature=u"s", access=u"read")
1558
1048
def LastApprovalRequest_dbus_property(self):
1559
return datetime_to_dbus(self.last_approval_request)
1049
if self.last_approval_request is None:
1050
return dbus.String(u"")
1051
return dbus.String(self.
1052
_datetime_to_dbus(self
1053
.last_approval_request))
1560
1054
1561
1055
# Timeout - property
1562
@dbus_service_property(_interface, signature="t",
1563
access="readwrite")
1056
@dbus_service_property(_interface, signature=u"t",
1057
access=u"readwrite")
1564
1058
def Timeout_dbus_property(self, value=None):
1565
1059
if value is None: # get
1566
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1567
old_timeout = self.timeout
1060
return dbus.UInt64(self.timeout_milliseconds())
1568
1061
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)
1062
# Emit D-Bus signal
1063
self.PropertyChanged(dbus.String(u"Timeout"),
1064
dbus.UInt64(value, variant_level=1))
1065
if getattr(self, u"disable_initiator_tag", None) is None:
1066
return
1067
# Reschedule timeout
1068
gobject.source_remove(self.disable_initiator_tag)
1069
self.disable_initiator_tag = None
1070
time_to_die = (self.
1071
_timedelta_to_milliseconds((self
1072
.last_checked_ok
1073
+ self.timeout)
1074
- datetime.datetime
1075
.utcnow()))
1076
if time_to_die <= 0:
1077
# The timeout has passed
1078
self.disable()
1079
else:
1080
self.disable_initiator_tag = (gobject.timeout_add
1081
(time_to_die, self.disable))
1594
1082
1595
1083
# Interval - property
1596
@dbus_service_property(_interface, signature="t",
1597
access="readwrite")
1084
@dbus_service_property(_interface, signature=u"t",
1085
access=u"readwrite")
1598
1086
def Interval_dbus_property(self, value=None):
1599
1087
if value is None: # get
1600
return dbus.UInt64(self.interval.total_seconds() * 1000)
1088
return dbus.UInt64(self.interval_milliseconds())
1601
1089
self.interval = datetime.timedelta(0, 0, 0, value)
1602
if getattr(self, "checker_initiator_tag", None) is None:
1090
# Emit D-Bus signal
1091
self.PropertyChanged(dbus.String(u"Interval"),
1092
dbus.UInt64(value, variant_level=1))
1093
if getattr(self, u"checker_initiator_tag", None) is None:
1603
1094
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
1095
# Reschedule checker run
1096
gobject.source_remove(self.checker_initiator_tag)
1097
self.checker_initiator_tag = (gobject.timeout_add
1098
(value, self.start_checker))
1099
self.start_checker() # Start one now, too
1100
1611
1101
# Checker - property
1612
@dbus_service_property(_interface, signature="s",
1613
access="readwrite")
1102
@dbus_service_property(_interface, signature=u"s",
1103
access=u"readwrite")
1614
1104
def Checker_dbus_property(self, value=None):
1615
1105
if value is None: # get
1616
1106
return dbus.String(self.checker_command)
1617
self.checker_command = str(value)
1107
self.checker_command = value
1108
# Emit D-Bus signal
1109
self.PropertyChanged(dbus.String(u"Checker"),
1110
dbus.String(self.checker_command,
1111
variant_level=1))
1618
1112
1619
1113
# CheckerRunning - property
1620
@dbus_service_property(_interface, signature="b",
1621
access="readwrite")
1114
@dbus_service_property(_interface, signature=u"b",
1115
access=u"readwrite")
1622
1116
def CheckerRunning_dbus_property(self, value=None):
1623
1117
if value is None: # get
1624
1118
return dbus.Boolean(self.checker is not None)
1628
1122
self.stop_checker()
1629
1123
1630
1124
# ObjectPath - property
1631
@dbus_service_property(_interface, signature="o", access="read")
1125
@dbus_service_property(_interface, signature=u"o", access=u"read")
1632
1126
def ObjectPath_dbus_property(self):
1633
1127
return self.dbus_object_path # is already a dbus.ObjectPath
1634
1128
1635
1129
# Secret = property
1636
@dbus_service_property(_interface, signature="ay",
1637
access="write", byte_arrays=True)
1130
@dbus_service_property(_interface, signature=u"ay",
1131
access=u"write", byte_arrays=True)
1638
1132
def Secret_dbus_property(self, value):
1639
self.secret = bytes(value)
1133
self.secret = str(value)
1640
1134
1641
1135
del _interface
1642
1136
1647
1141
self._pipe.send(('init', fpr, address))
1648
1142
if not self._pipe.recv():
1649
1143
raise KeyError()
1650
1144
1651
1145
def __getattribute__(self, name):
1652
if name == '_pipe':
1146
if(name == '_pipe'):
1653
1147
return super(ProxyClient, self).__getattribute__(name)
1654
1148
self._pipe.send(('getattr', name))
1655
1149
data = self._pipe.recv()
1660
1154
self._pipe.send(('funcall', name, args, kwargs))
1661
1155
return self._pipe.recv()[1]
1662
1156
return func
1663
1157
1664
1158
def __setattr__(self, name, value):
1665
if name == '_pipe':
1159
if(name == '_pipe'):
1666
1160
return super(ProxyClient, self).__setattr__(name, value)
1667
1161
self._pipe.send(('setattr', name, value))
1668
1162
1675
1169
1676
1170
def handle(self):
1677
1171
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",
1172
logger.info(u"TCP connection from: %s",
1173
unicode(self.client_address))
1174
logger.debug(u"Pipe FD: %d",
1681
1175
self.server.child_pipe.fileno())
1682
1176
1683
1177
session = (gnutls.connection
1684
1178
.ClientSession(self.request,
1685
1179
gnutls.connection
1686
1180
.X509Credentials()))
1687
1181
1688
1182
# Note: gnutls.connection.X509Credentials is really a
1689
1183
# generic GnuTLS certificate credentials object so long as
1690
1184
# no X.509 keys are added to it. Therefore, we can use it
1691
1185
# 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"))
1186
1187
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1188
# u"+AES-256-CBC", u"+SHA1",
1189
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1190
# u"+DHE-DSS"))
1697
1191
# Use a fallback default, since this MUST be set.
1698
1192
priority = self.server.gnutls_priority
1699
1193
if priority is None:
1700
priority = "NORMAL"
1194
priority = u"NORMAL"
1701
1195
(gnutls.library.functions
1702
1196
.gnutls_priority_set_direct(session._c_object,
1703
1197
priority, None))
1704
1198
1705
1199
# Start communication using the Mandos protocol
1706
1200
# Get protocol number
1707
1201
line = self.request.makefile().readline()
1708
logger.debug("Protocol version: %r", line)
1202
logger.debug(u"Protocol version: %r", line)
1709
1203
try:
1710
1204
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)
1205
raise RuntimeError
1206
except (ValueError, IndexError, RuntimeError), error:
1207
logger.error(u"Unknown protocol version: %s", error)
1714
1208
return
1715
1209
1716
1210
# Start GnuTLS connection
1717
1211
try:
1718
1212
session.handshake()
1719
except gnutls.errors.GNUTLSError as error:
1720
logger.warning("Handshake failed: %s", error)
1213
except gnutls.errors.GNUTLSError, error:
1214
logger.warning(u"Handshake failed: %s", error)
1721
1215
# Do not run session.bye() here: the session is not
1722
1216
# established. Just abandon the request.
1723
1217
return
1724
logger.debug("Handshake succeeded")
1725
1218
logger.debug(u"Handshake succeeded")
1219
1726
1220
approval_required = False
1727
1221
try:
1728
1222
try:
1729
1223
fpr = self.fingerprint(self.peer_certificate
1730
1224
(session))
1731
except (TypeError,
1732
gnutls.errors.GNUTLSError) as error:
1733
logger.warning("Bad certificate: %s", error)
1225
except (TypeError, gnutls.errors.GNUTLSError), error:
1226
logger.warning(u"Bad certificate: %s", error)
1734
1227
return
1735
logger.debug("Fingerprint: %s", fpr)
1736
1228
logger.debug(u"Fingerprint: %s", fpr)
1229
1737
1230
try:
1738
1231
client = ProxyClient(child_pipe, fpr,
1739
1232
self.client_address)
1747
1240
1748
1241
while True:
1749
1242
if not client.enabled:
1750
logger.info("Client %s is disabled",
1243
logger.warning(u"Client %s is disabled",
1751
1244
client.name)
1752
1245
if self.server.use_dbus:
1753
1246
# Emit D-Bus signal
1754
client.Rejected("Disabled")
1247
client.Rejected("Disabled")
1755
1248
return
1756
1249
1757
if client.approved or not client.approval_delay:
1250
if client._approved or not client.approval_delay:
1758
1251
#We are approved or approval is disabled
1759
1252
break
1760
elif client.approved is None:
1761
logger.info("Client %s needs approval",
1253
elif client._approved is None:
1254
logger.info(u"Client %s needs approval",
1762
1255
client.name)
1763
1256
if self.server.use_dbus:
1764
1257
# Emit D-Bus signal
1765
1258
client.NeedApproval(
1766
client.approval_delay.total_seconds()
1767
* 1000, client.approved_by_default)
1259
client.approval_delay_milliseconds(),
1260
client.approved_by_default)
1768
1261
else:
1769
logger.warning("Client %s was not approved",
1262
logger.warning(u"Client %s was not approved",
1770
1263
client.name)
1771
1264
if self.server.use_dbus:
1772
1265
# Emit D-Bus signal
1774
1267
return
1775
1268
1776
1269
#wait until timeout or approved
1270
#x = float(client._timedelta_to_milliseconds(delay))
1777
1271
time = datetime.datetime.now()
1778
1272
client.changedstate.acquire()
1779
client.changedstate.wait(delay.total_seconds())
1273
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1780
1274
client.changedstate.release()
1781
1275
time2 = datetime.datetime.now()
1782
1276
if (time2 - time) >= delay:
1797
1291
while sent_size < len(client.secret):
1798
1292
try:
1799
1293
sent = session.send(client.secret[sent_size:])
1800
except gnutls.errors.GNUTLSError as error:
1801
logger.warning("gnutls send failed",
1802
exc_info=error)
1294
except (gnutls.errors.GNUTLSError), error:
1295
logger.warning("gnutls send failed")
1803
1296
return
1804
logger.debug("Sent: %d, remaining: %d",
1297
logger.debug(u"Sent: %d, remaining: %d",
1805
1298
sent, len(client.secret)
1806
1299
- (sent_size + sent))
1807
1300
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)
1301
1302
logger.info(u"Sending secret to %s", client.name)
1303
# bump the timeout as if seen
1304
client.checked_ok()
1812
1305
if self.server.use_dbus:
1813
1306
# Emit D-Bus signal
1814
1307
client.GotSecret()
1818
1311
client.approvals_pending -= 1
1819
1312
try:
1820
1313
session.bye()
1821
except gnutls.errors.GNUTLSError as error:
1822
logger.warning("GnuTLS bye failed",
1823
exc_info=error)
1314
except (gnutls.errors.GNUTLSError), error:
1315
logger.warning("GnuTLS bye failed")
1824
1316
1825
1317
@staticmethod
1826
1318
def peer_certificate(session):
1836
1328
.gnutls_certificate_get_peers
1837
1329
(session._c_object, ctypes.byref(list_size)))
1838
1330
if not bool(cert_list) and list_size.value != 0:
1839
raise gnutls.errors.GNUTLSError("error getting peer"
1840
" certificate")
1331
raise gnutls.errors.GNUTLSError(u"error getting peer"
1332
u" certificate")
1841
1333
if list_size.value == 0:
1842
1334
return None
1843
1335
cert = cert_list[0]
1869
1361
if crtverify.value != 0:
1870
1362
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1871
1363
raise (gnutls.errors.CertificateSecurityError
1872
("Verify failed"))
1364
(u"Verify failed"))
1873
1365
# New buffer for the fingerprint
1874
1366
buf = ctypes.create_string_buffer(20)
1875
1367
buf_len = ctypes.c_size_t()
1882
1374
# Convert the buffer to a Python bytestring
1883
1375
fpr = ctypes.string_at(buf, buf_len.value)
1884
1376
# Convert the bytestring to hexadecimal notation
1885
hex_fpr = binascii.hexlify(fpr).upper()
1377
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1886
1378
return hex_fpr
1887
1379
1888
1380
1891
1383
def sub_process_main(self, request, address):
1892
1384
try:
1893
1385
self.finish_request(request, address)
1894
except Exception:
1386
except:
1895
1387
self.handle_error(request, address)
1896
1388
self.close_request(request)
1897
1389
1898
1390
def process_request(self, request, address):
1899
1391
"""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
1392
multiprocessing.Process(target = self.sub_process_main,
1393
args = (request, address)).start()
1905
1394
1906
1395
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1907
1396
""" adds a pipe to the MixIn """
1911
1400
This function creates a new pipe in self.pipe
1912
1401
"""
1913
1402
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1914
1915
proc = MultiprocessingMixIn.process_request(self, request,
1916
client_address)
1403
1404
super(MultiprocessingMixInWithPipe,
1405
self).process_request(request, client_address)
1917
1406
self.child_pipe.close()
1918
self.add_pipe(parent_pipe, proc)
1919
1920
def add_pipe(self, parent_pipe, proc):
1407
self.add_pipe(parent_pipe)
1408
1409
def add_pipe(self, parent_pipe):
1921
1410
"""Dummy function; override as necessary"""
1922
raise NotImplementedError()
1923
1411
pass
1924
1412
1925
1413
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1926
1414
socketserver.TCPServer, object):
1932
1420
use_ipv6: Boolean; to use IPv6 or not
1933
1421
"""
1934
1422
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
"""
1423
interface=None, use_ipv6=True):
1939
1424
self.interface = interface
1940
1425
if use_ipv6:
1941
1426
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
1427
socketserver.TCPServer.__init__(self, server_address,
1969
1428
RequestHandlerClass)
1970
1971
1429
def server_bind(self):
1972
1430
"""This overrides the normal server_bind() function
1973
1431
to bind to an interface if one was specified, and also NOT to
1974
1432
bind to an address or port if they were not specified."""
1975
1433
if self.interface is not None:
1976
1434
if SO_BINDTODEVICE is None:
1977
logger.error("SO_BINDTODEVICE does not exist;"
1978
" cannot bind to interface %s",
1435
logger.error(u"SO_BINDTODEVICE does not exist;"
1436
u" cannot bind to interface %s",
1979
1437
self.interface)
1980
1438
else:
1981
1439
try:
1982
1440
self.socket.setsockopt(socket.SOL_SOCKET,
1983
1441
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)
1442
str(self.interface
1443
+ u'\0'))
1444
except socket.error, error:
1445
if error[0] == errno.EPERM:
1446
logger.error(u"No permission to"
1447
u" bind to interface %s",
1448
self.interface)
1449
elif error[0] == errno.ENOPROTOOPT:
1450
logger.error(u"SO_BINDTODEVICE not available;"
1451
u" cannot bind to interface %s",
1452
self.interface)
1997
1453
else:
1998
1454
raise
1999
1455
# Only bind(2) the socket if we really need to.
2000
1456
if self.server_address[0] or self.server_address[1]:
2001
1457
if not self.server_address[0]:
2002
1458
if self.address_family == socket.AF_INET6:
2003
any_address = "::" # in6addr_any
1459
any_address = u"::" # in6addr_any
2004
1460
else:
2005
any_address = "0.0.0.0" # INADDR_ANY
1461
any_address = socket.INADDR_ANY
2006
1462
self.server_address = (any_address,
2007
1463
self.server_address[1])
2008
1464
elif not self.server_address[1]:
2029
1485
"""
2030
1486
def __init__(self, server_address, RequestHandlerClass,
2031
1487
interface=None, use_ipv6=True, clients=None,
2032
gnutls_priority=None, use_dbus=True, socketfd=None):
1488
gnutls_priority=None, use_dbus=True):
2033
1489
self.enabled = False
2034
1490
self.clients = clients
2035
1491
if self.clients is None:
2036
self.clients = {}
1492
self.clients = set()
2037
1493
self.use_dbus = use_dbus
2038
1494
self.gnutls_priority = gnutls_priority
2039
1495
IPv6_TCPServer.__init__(self, server_address,
2040
1496
RequestHandlerClass,
2041
1497
interface = interface,
2042
use_ipv6 = use_ipv6,
2043
socketfd = socketfd)
1498
use_ipv6 = use_ipv6)
2044
1499
def server_activate(self):
2045
1500
if self.enabled:
2046
1501
return socketserver.TCPServer.server_activate(self)
2047
2048
1502
def enable(self):
2049
1503
self.enabled = True
2050
2051
def add_pipe(self, parent_pipe, proc):
1504
def add_pipe(self, parent_pipe):
2052
1505
# Call "handle_ipc" for both data and EOF events
2053
1506
gobject.io_add_watch(parent_pipe.fileno(),
2054
1507
gobject.IO_IN | gobject.IO_HUP,
2055
1508
functools.partial(self.handle_ipc,
2056
parent_pipe =
2057
parent_pipe,
2058
proc = proc))
2059
1509
parent_pipe = parent_pipe))
1510
2060
1511
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()
1512
client_object=None):
1513
condition_names = {
1514
gobject.IO_IN: u"IN", # There is data to read.
1515
gobject.IO_OUT: u"OUT", # Data can be written (without
1516
# blocking).
1517
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1518
gobject.IO_ERR: u"ERR", # Error condition.
1519
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1520
# broken, usually for pipes and
1521
# sockets).
1522
}
1523
conditions_string = ' | '.join(name
1524
for cond, name in
1525
condition_names.iteritems()
1526
if cond & condition)
1527
# error or the other end of multiprocessing.Pipe has closed
1528
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2066
1529
return False
2067
1530
2068
1531
# Read a request from the child
2073
1536
fpr = request[1]
2074
1537
address = request[2]
2075
1538
2076
for c in self.clients.itervalues():
1539
for c in self.clients:
2077
1540
if c.fingerprint == fpr:
2078
1541
client = c
2079
1542
break
2080
1543
else:
2081
logger.info("Client not found for fingerprint: %s, ad"
2082
"dress: %s", fpr, address)
1544
logger.warning(u"Client not found for fingerprint: %s, ad"
1545
u"dress: %s", fpr, address)
2083
1546
if self.use_dbus:
2084
1547
# Emit D-Bus signal
2085
mandos_dbus_service.ClientNotFound(fpr,
2086
address[0])
1548
mandos_dbus_service.ClientNotFound(fpr, address[0])
2087
1549
parent_pipe.send(False)
2088
1550
return False
2089
1551
2090
1552
gobject.io_add_watch(parent_pipe.fileno(),
2091
1553
gobject.IO_IN | gobject.IO_HUP,
2092
1554
functools.partial(self.handle_ipc,
2093
parent_pipe =
2094
parent_pipe,
2095
proc = proc,
2096
client_object =
2097
client))
1555
parent_pipe = parent_pipe,
1556
client_object = client))
2098
1557
parent_pipe.send(True)
2099
# remove the old hook in favor of the new above hook on
2100
# same fileno
1558
# remove the old hook in favor of the new above hook on same fileno
2101
1559
return False
2102
1560
if command == 'funcall':
2103
1561
funcname = request[1]
2104
1562
args = request[2]
2105
1563
kwargs = request[3]
2106
1564
2107
parent_pipe.send(('data', getattr(client_object,
2108
funcname)(*args,
2109
**kwargs)))
2110
1565
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1566
2111
1567
if command == 'getattr':
2112
1568
attrname = request[1]
2113
1569
if callable(client_object.__getattribute__(attrname)):
2114
1570
parent_pipe.send(('function',))
2115
1571
else:
2116
parent_pipe.send(('data', client_object
2117
.__getattribute__(attrname)))
1572
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2118
1573
2119
1574
if command == 'setattr':
2120
1575
attrname = request[1]
2121
1576
value = request[2]
2122
1577
setattr(client_object, attrname, value)
2123
1578
2124
1579
return True
2125
1580
2126
1581
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
1582
def string_to_delta(interval):
2227
1583
"""Parse a string and return a datetime.timedelta
2228
1584
2229
>>> string_to_delta('7d')
1585
>>> string_to_delta(u'7d')
2230
1586
datetime.timedelta(7)
2231
>>> string_to_delta('60s')
1587
>>> string_to_delta(u'60s')
2232
1588
datetime.timedelta(0, 60)
2233
>>> string_to_delta('60m')
1589
>>> string_to_delta(u'60m')
2234
1590
datetime.timedelta(0, 3600)
2235
>>> string_to_delta('24h')
1591
>>> string_to_delta(u'24h')
2236
1592
datetime.timedelta(1)
2237
>>> string_to_delta('1w')
1593
>>> string_to_delta(u'1w')
2238
1594
datetime.timedelta(7)
2239
>>> string_to_delta('5m 30s')
1595
>>> string_to_delta(u'5m 30s')
2240
1596
datetime.timedelta(0, 330)
2241
1597
"""
2242
2243
try:
2244
return rfc3339_duration_to_delta(interval)
2245
except ValueError:
2246
pass
2247
2248
1598
timevalue = datetime.timedelta(0)
2249
1599
for s in interval.split():
2250
1600
try:
2251
suffix = s[-1]
1601
suffix = unicode(s[-1])
2252
1602
value = int(s[:-1])
2253
if suffix == "d":
1603
if suffix == u"d":
2254
1604
delta = datetime.timedelta(value)
2255
elif suffix == "s":
1605
elif suffix == u"s":
2256
1606
delta = datetime.timedelta(0, value)
2257
elif suffix == "m":
1607
elif suffix == u"m":
2258
1608
delta = datetime.timedelta(0, 0, 0, 0, value)
2259
elif suffix == "h":
1609
elif suffix == u"h":
2260
1610
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2261
elif suffix == "w":
1611
elif suffix == u"w":
2262
1612
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2263
1613
else:
2264
raise ValueError("Unknown suffix {!r}"
2265
.format(suffix))
2266
except IndexError as e:
2267
raise ValueError(*(e.args))
1614
raise ValueError(u"Unknown suffix %r" % suffix)
1615
except (ValueError, IndexError), e:
1616
raise ValueError(e.message)
2268
1617
timevalue += delta
2269
1618
return timevalue
2270
1619
2271
1620
1621
def if_nametoindex(interface):
1622
"""Call the C function if_nametoindex(), or equivalent
1623
1624
Note: This function cannot accept a unicode string."""
1625
global if_nametoindex
1626
try:
1627
if_nametoindex = (ctypes.cdll.LoadLibrary
1628
(ctypes.util.find_library(u"c"))
1629
.if_nametoindex)
1630
except (OSError, AttributeError):
1631
logger.warning(u"Doing if_nametoindex the hard way")
1632
def if_nametoindex(interface):
1633
"Get an interface index the hard way, i.e. using fcntl()"
1634
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1635
with contextlib.closing(socket.socket()) as s:
1636
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1637
struct.pack(str(u"16s16x"),
1638
interface))
1639
interface_index = struct.unpack(str(u"I"),
1640
ifreq[16:20])[0]
1641
return interface_index
1642
return if_nametoindex(interface)
1643
1644
2272
1645
def daemon(nochdir = False, noclose = False):
2273
1646
"""See daemon(3). Standard BSD Unix function.
2274
1647
2277
1650
sys.exit()
2278
1651
os.setsid()
2279
1652
if not nochdir:
2280
os.chdir("/")
1653
os.chdir(u"/")
2281
1654
if os.fork():
2282
1655
sys.exit()
2283
1656
if not noclose:
2284
1657
# Close all standard open file descriptors
2285
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1658
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2286
1659
if not stat.S_ISCHR(os.fstat(null).st_mode):
2287
raise OSError(errno.ENODEV, "{} not a character device"
2288
.format(os.devnull))
1660
raise OSError(errno.ENODEV,
1661
u"%s not a character device"
1662
% os.path.devnull)
2289
1663
os.dup2(null, sys.stdin.fileno())
2290
1664
os.dup2(null, sys.stdout.fileno())
2291
1665
os.dup2(null, sys.stderr.fileno())
2298
1672
##################################################################
2299
1673
# Parsing of options, both command line and config file
2300
1674
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()
1675
parser = optparse.OptionParser(version = "%%prog %s" % version)
1676
parser.add_option("-i", u"--interface", type=u"string",
1677
metavar="IF", help=u"Bind to interface IF")
1678
parser.add_option("-a", u"--address", type=u"string",
1679
help=u"Address to listen for requests on")
1680
parser.add_option("-p", u"--port", type=u"int",
1681
help=u"Port number to receive requests on")
1682
parser.add_option("--check", action=u"store_true",
1683
help=u"Run self-test")
1684
parser.add_option("--debug", action=u"store_true",
1685
help=u"Debug mode; run in foreground and log to"
1686
u" terminal")
1687
parser.add_option("--debuglevel", type=u"string", metavar="LEVEL",
1688
help=u"Debug level for stdout output")
1689
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1690
u" priority string (see GnuTLS documentation)")
1691
parser.add_option("--servicename", type=u"string",
1692
metavar=u"NAME", help=u"Zeroconf service name")
1693
parser.add_option("--configdir", type=u"string",
1694
default=u"/etc/mandos", metavar=u"DIR",
1695
help=u"Directory to search for configuration"
1696
u" files")
1697
parser.add_option("--no-dbus", action=u"store_false",
1698
dest=u"use_dbus", help=u"Do not provide D-Bus"
1699
u" system bus interface")
1700
parser.add_option("--no-ipv6", action=u"store_false",
1701
dest=u"use_ipv6", help=u"Do not use IPv6")
1702
options = parser.parse_args()[0]
2347
1703
2348
1704
if options.check:
2349
1705
import doctest
2350
fail_count, test_count = doctest.testmod()
2351
sys.exit(os.EX_OK if fail_count == 0 else 1)
1706
doctest.testmod()
1707
sys.exit()
2352
1708
2353
1709
# 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:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2360
"servicename": "Mandos",
2361
"use_dbus": "True",
2362
"use_ipv6": "True",
2363
"debuglevel": "",
2364
"restore": "True",
2365
"socket": "",
2366
"statedir": "/var/lib/mandos",
2367
"foreground": "False",
2368
"zeroconf": "True",
1710
server_defaults = { u"interface": u"",
1711
u"address": u"",
1712
u"port": u"",
1713
u"debug": u"False",
1714
u"priority":
1715
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1716
u"servicename": u"Mandos",
1717
u"use_dbus": u"True",
1718
u"use_ipv6": u"True",
1719
u"debuglevel": u"",
2369
1720
}
2370
1721
2371
1722
# Parse config file for server-global settings
2372
1723
server_config = configparser.SafeConfigParser(server_defaults)
2373
1724
del server_defaults
2374
1725
server_config.read(os.path.join(options.configdir,
2375
"mandos.conf"))
1726
u"mandos.conf"))
2376
1727
# Convert the SafeConfigParser object to a dict
2377
1728
server_settings = server_config.defaults()
2378
1729
# Use the appropriate methods on the non-string config options
2379
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2380
server_settings[option] = server_config.getboolean("DEFAULT",
1730
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1731
server_settings[option] = server_config.getboolean(u"DEFAULT",
2381
1732
option)
2382
1733
if server_settings["port"]:
2383
server_settings["port"] = server_config.getint("DEFAULT",
2384
"port")
2385
if server_settings["socket"]:
2386
server_settings["socket"] = server_config.getint("DEFAULT",
2387
"socket")
2388
# Later, stdin will, and stdout and stderr might, be dup'ed
2389
# over with an opened os.devnull. But we don't want this to
2390
# happen with a supplied network socket.
2391
if 0 <= server_settings["socket"] <= 2:
2392
server_settings["socket"] = os.dup(server_settings
2393
["socket"])
1734
server_settings["port"] = server_config.getint(u"DEFAULT",
1735
u"port")
2394
1736
del server_config
2395
1737
2396
1738
# Override the settings from the config file with command line
2397
1739
# options, if set.
2398
for option in ("interface", "address", "port", "debug",
2399
"priority", "servicename", "configdir",
2400
"use_dbus", "use_ipv6", "debuglevel", "restore",
2401
"statedir", "socket", "foreground", "zeroconf"):
1740
for option in (u"interface", u"address", u"port", u"debug",
1741
u"priority", u"servicename", u"configdir",
1742
u"use_dbus", u"use_ipv6", u"debuglevel"):
2402
1743
value = getattr(options, option)
2403
1744
if value is not None:
2404
1745
server_settings[option] = value
2405
1746
del options
2406
1747
# Force all strings to be unicode
2407
1748
for option in server_settings.keys():
2408
if isinstance(server_settings[option], bytes):
2409
server_settings[option] = (server_settings[option]
2410
.decode("utf-8"))
2411
# Force all boolean options to be boolean
2412
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2413
"foreground", "zeroconf"):
2414
server_settings[option] = bool(server_settings[option])
2415
# Debug implies foreground
2416
if server_settings["debug"]:
2417
server_settings["foreground"] = True
1749
if type(server_settings[option]) is str:
1750
server_settings[option] = unicode(server_settings[option])
2418
1751
# Now we have our good server settings in "server_settings"
2419
1752
2420
1753
##################################################################
2421
1754
2422
if (not server_settings["zeroconf"] and
2423
not (server_settings["port"]
2424
or server_settings["socket"] != "")):
2425
parser.error("Needs port or socket to work without"
2426
" Zeroconf")
2427
2428
1755
# For convenience
2429
debug = server_settings["debug"]
2430
debuglevel = server_settings["debuglevel"]
2431
use_dbus = server_settings["use_dbus"]
2432
use_ipv6 = server_settings["use_ipv6"]
2433
stored_state_path = os.path.join(server_settings["statedir"],
2434
stored_state_file)
2435
foreground = server_settings["foreground"]
2436
zeroconf = server_settings["zeroconf"]
2437
2438
if debug:
2439
initlogger(debug, logging.DEBUG)
2440
else:
2441
if not debuglevel:
2442
initlogger(debug)
2443
else:
2444
level = getattr(logging, debuglevel.upper())
2445
initlogger(debug, level)
2446
2447
if server_settings["servicename"] != "Mandos":
1756
debug = server_settings[u"debug"]
1757
debuglevel = server_settings[u"debuglevel"]
1758
use_dbus = server_settings[u"use_dbus"]
1759
use_ipv6 = server_settings[u"use_ipv6"]
1760
1761
if server_settings[u"servicename"] != u"Mandos":
2448
1762
syslogger.setFormatter(logging.Formatter
2449
('Mandos ({}) [%(process)d]:'
2450
' %(levelname)s: %(message)s'
2451
.format(server_settings
2452
["servicename"])))
1763
(u'Mandos (%s) [%%(process)d]:'
1764
u' %%(levelname)s: %%(message)s'
1765
% server_settings[u"servicename"]))
2453
1766
2454
1767
# Parse config file with clients
2455
client_config = configparser.SafeConfigParser(Client
2456
.client_defaults)
2457
client_config.read(os.path.join(server_settings["configdir"],
2458
"clients.conf"))
1768
client_defaults = { u"timeout": u"1h",
1769
u"interval": u"5m",
1770
u"checker": u"fping -q -- %%(host)s",
1771
u"host": u"",
1772
u"approval_delay": u"0s",
1773
u"approval_duration": u"1s",
1774
}
1775
client_config = configparser.SafeConfigParser(client_defaults)
1776
client_config.read(os.path.join(server_settings[u"configdir"],
1777
u"clients.conf"))
2459
1778
2460
1779
global mandos_dbus_service
2461
1780
mandos_dbus_service = None
2462
1781
2463
socketfd = None
2464
if server_settings["socket"] != "":
2465
socketfd = server_settings["socket"]
2466
tcp_server = MandosServer((server_settings["address"],
2467
server_settings["port"]),
1782
tcp_server = MandosServer((server_settings[u"address"],
1783
server_settings[u"port"]),
2468
1784
ClientHandler,
2469
interface=(server_settings["interface"]
1785
interface=(server_settings[u"interface"]
2470
1786
or None),
2471
1787
use_ipv6=use_ipv6,
2472
1788
gnutls_priority=
2473
server_settings["priority"],
2474
use_dbus=use_dbus,
2475
socketfd=socketfd)
2476
if not foreground:
2477
pidfilename = "/run/mandos.pid"
2478
if not os.path.isdir("/run/."):
2479
pidfilename = "/var/run/mandos.pid"
2480
pidfile = None
1789
server_settings[u"priority"],
1790
use_dbus=use_dbus)
1791
if not debug:
1792
pidfilename = u"/var/run/mandos.pid"
2481
1793
try:
2482
pidfile = open(pidfilename, "w")
2483
except IOError as e:
2484
logger.error("Could not open file %r", pidfilename,
2485
exc_info=e)
1794
pidfile = open(pidfilename, u"w")
1795
except IOError:
1796
logger.error(u"Could not open file %r", pidfilename)
2486
1797
2487
for name in ("_mandos", "mandos", "nobody"):
1798
try:
1799
uid = pwd.getpwnam(u"_mandos").pw_uid
1800
gid = pwd.getpwnam(u"_mandos").pw_gid
1801
except KeyError:
2488
1802
try:
2489
uid = pwd.getpwnam(name).pw_uid
2490
gid = pwd.getpwnam(name).pw_gid
2491
break
1803
uid = pwd.getpwnam(u"mandos").pw_uid
1804
gid = pwd.getpwnam(u"mandos").pw_gid
2492
1805
except KeyError:
2493
continue
2494
else:
2495
uid = 65534
2496
gid = 65534
1806
try:
1807
uid = pwd.getpwnam(u"nobody").pw_uid
1808
gid = pwd.getpwnam(u"nobody").pw_gid
1809
except KeyError:
1810
uid = 65534
1811
gid = 65534
2497
1812
try:
2498
1813
os.setgid(gid)
2499
1814
os.setuid(uid)
2500
except OSError as error:
2501
if error.errno != errno.EPERM:
2502
raise
1815
except OSError, error:
1816
if error[0] != errno.EPERM:
1817
raise error
2503
1818
1819
if not debug and not debuglevel:
1820
syslogger.setLevel(logging.WARNING)
1821
console.setLevel(logging.WARNING)
1822
if debuglevel:
1823
level = getattr(logging, debuglevel.upper())
1824
syslogger.setLevel(level)
1825
console.setLevel(level)
1826
2504
1827
if debug:
2505
1828
# Enable all possible GnuTLS debugging
2506
1829
2510
1833
2511
1834
@gnutls.library.types.gnutls_log_func
2512
1835
def debug_gnutls(level, string):
2513
logger.debug("GnuTLS: %s", string[:-1])
1836
logger.debug(u"GnuTLS: %s", string[:-1])
2514
1837
2515
1838
(gnutls.library.functions
2516
1839
.gnutls_global_set_log_function(debug_gnutls))
2517
1840
2518
1841
# Redirect stdin so all checkers get /dev/null
2519
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1842
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2520
1843
os.dup2(null, sys.stdin.fileno())
2521
1844
if null > 2:
2522
1845
os.close(null)
2523
2524
# Need to fork before connecting to D-Bus
2525
if not foreground:
2526
# Close all input and output, do double fork, etc.
2527
daemon()
2528
2529
# multiprocessing will use threads, so before we use gobject we
2530
# need to inform gobject that threads will be used.
2531
gobject.threads_init()
1846
else:
1847
# No console logging
1848
logger.removeHandler(console)
1849
2532
1850
2533
1851
global main_loop
2534
1852
# From the Avahi example code
2535
DBusGMainLoop(set_as_default=True)
1853
DBusGMainLoop(set_as_default=True )
2536
1854
main_loop = gobject.MainLoop()
2537
1855
bus = dbus.SystemBus()
2538
1856
# End of Avahi example code
2539
1857
if use_dbus:
2540
1858
try:
2541
bus_name = dbus.service.BusName("se.recompile.Mandos",
1859
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2542
1860
bus, do_not_queue=True)
2543
old_bus_name = (dbus.service.BusName
2544
("se.bsnet.fukt.Mandos", bus,
2545
do_not_queue=True))
2546
except dbus.exceptions.NameExistsException as e:
2547
logger.error("Disabling D-Bus:", exc_info=e)
1861
except dbus.exceptions.NameExistsException, e:
1862
logger.error(unicode(e) + u", disabling D-Bus")
2548
1863
use_dbus = False
2549
server_settings["use_dbus"] = False
1864
server_settings[u"use_dbus"] = False
2550
1865
tcp_server.use_dbus = False
2551
if zeroconf:
2552
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2553
service = AvahiServiceToSyslog(name =
2554
server_settings["servicename"],
2555
servicetype = "_mandos._tcp",
2556
protocol = protocol, bus = bus)
2557
if server_settings["interface"]:
2558
service.interface = (if_nametoindex
2559
(server_settings["interface"]
2560
.encode("utf-8")))
2561
1866
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1867
service = AvahiService(name = server_settings[u"servicename"],
1868
servicetype = u"_mandos._tcp",
1869
protocol = protocol, bus = bus)
1870
if server_settings["interface"]:
1871
service.interface = (if_nametoindex
1872
(str(server_settings[u"interface"])))
1873
1874
if not debug:
1875
# Close all input and output, do double fork, etc.
1876
daemon()
1877
2562
1878
global multiprocessing_manager
2563
1879
multiprocessing_manager = multiprocessing.Manager()
2564
1880
2565
1881
client_class = Client
2566
1882
if use_dbus:
2567
1883
client_class = functools.partial(ClientDBus, bus = bus)
2568
2569
client_settings = Client.config_parser(client_config)
2570
old_client_settings = {}
2571
clients_data = {}
2572
2573
# This is used to redirect stdout and stderr for checker processes
2574
global wnull
2575
wnull = open(os.devnull, "w") # A writable /dev/null
2576
# Only used if server is running in foreground but not in debug
2577
# mode
2578
if debug or not foreground:
2579
wnull.close()
2580
2581
# Get client data and settings from last running state.
2582
if server_settings["restore"]:
2583
try:
2584
with open(stored_state_path, "rb") as stored_state:
2585
clients_data, old_client_settings = (pickle.load
2586
(stored_state))
2587
os.remove(stored_state_path)
2588
except IOError as e:
2589
if e.errno == errno.ENOENT:
2590
logger.warning("Could not load persistent state: {}"
2591
.format(os.strerror(e.errno)))
2592
else:
2593
logger.critical("Could not load persistent state:",
2594
exc_info=e)
2595
raise
2596
except EOFError as e:
2597
logger.warning("Could not load persistent state: "
2598
"EOFError:", exc_info=e)
2599
2600
with PGPEngine() as pgp:
2601
for client_name, client in clients_data.items():
2602
# Skip removed clients
2603
if client_name not in client_settings:
2604
continue
2605
2606
# Decide which value to use after restoring saved state.
2607
# We have three different values: Old config file,
2608
# new config file, and saved state.
2609
# New config value takes precedence if it differs from old
2610
# config value, otherwise use saved state.
2611
for name, value in client_settings[client_name].items():
2612
try:
2613
# For each value in new config, check if it
2614
# differs from the old config value (Except for
2615
# the "secret" attribute)
2616
if (name != "secret" and
2617
value != old_client_settings[client_name]
2618
[name]):
2619
client[name] = value
2620
except KeyError:
2621
pass
2622
2623
# Clients who has passed its expire date can still be
2624
# enabled if its last checker was successful. Clients
2625
# whose checker succeeded before we stored its state is
2626
# assumed to have successfully run all checkers during
2627
# downtime.
2628
if client["enabled"]:
2629
if datetime.datetime.utcnow() >= client["expires"]:
2630
if not client["last_checked_ok"]:
2631
logger.warning(
2632
"disabling client {} - Client never "
2633
"performed a successful checker"
2634
.format(client_name))
2635
client["enabled"] = False
2636
elif client["last_checker_status"] != 0:
2637
logger.warning(
2638
"disabling client {} - Client last"
2639
" checker failed with error code {}"
2640
.format(client_name,
2641
client["last_checker_status"]))
2642
client["enabled"] = False
2643
else:
2644
client["expires"] = (datetime.datetime
2645
.utcnow()
2646
+ client["timeout"])
2647
logger.debug("Last checker succeeded,"
2648
" keeping {} enabled"
2649
.format(client_name))
1884
def client_config_items(config, section):
1885
special_settings = {
1886
"approved_by_default":
1887
lambda: config.getboolean(section,
1888
"approved_by_default"),
1889
}
1890
for name, value in config.items(section):
2650
1891
try:
2651
client["secret"] = (
2652
pgp.decrypt(client["encrypted_secret"],
2653
client_settings[client_name]
2654
["secret"]))
2655
except PGPError:
2656
# If decryption fails, we use secret from new settings
2657
logger.debug("Failed to decrypt {} old secret"
2658
.format(client_name))
2659
client["secret"] = (
2660
client_settings[client_name]["secret"])
2661
2662
# Add/remove clients based on new changes made to config
2663
for client_name in (set(old_client_settings)
2664
- set(client_settings)):
2665
del clients_data[client_name]
2666
for client_name in (set(client_settings)
2667
- set(old_client_settings)):
2668
clients_data[client_name] = client_settings[client_name]
2669
2670
# Create all client objects
2671
for client_name, client in clients_data.items():
2672
tcp_server.clients[client_name] = client_class(
2673
name = client_name, settings = client,
2674
server_settings = server_settings)
2675
1892
yield (name, special_settings[name]())
1893
except KeyError:
1894
yield (name, value)
1895
1896
tcp_server.clients.update(set(
1897
client_class(name = section,
1898
config= dict(client_config_items(
1899
client_config, section)))
1900
for section in client_config.sections()))
2676
1901
if not tcp_server.clients:
2677
logger.warning("No clients defined")
2678
2679
if not foreground:
2680
if pidfile is not None:
2681
try:
2682
with pidfile:
2683
pid = os.getpid()
2684
pidfile.write("{}\n".format(pid).encode("utf-8"))
2685
except IOError:
2686
logger.error("Could not write to file %r with PID %d",
2687
pidfilename, pid)
2688
del pidfile
1902
logger.warning(u"No clients defined")
1903
1904
if not debug:
1905
try:
1906
with pidfile:
1907
pid = os.getpid()
1908
pidfile.write(str(pid) + "\n")
1909
del pidfile
1910
except IOError:
1911
logger.error(u"Could not write to file %r with PID %d",
1912
pidfilename, pid)
1913
except NameError:
1914
# "pidfile" was never created
1915
pass
2689
1916
del pidfilename
2690
1917
1918
signal.signal(signal.SIGINT, signal.SIG_IGN)
1919
2691
1920
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2692
1921
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2693
1922
2694
1923
if use_dbus:
2695
@alternate_dbus_interfaces({"se.recompile.Mandos":
2696
"se.bsnet.fukt.Mandos"})
2697
class MandosDBusService(DBusObjectWithProperties):
1924
class MandosDBusService(dbus.service.Object):
2698
1925
"""A D-Bus proxy object"""
2699
1926
def __init__(self):
2700
dbus.service.Object.__init__(self, bus, "/")
2701
_interface = "se.recompile.Mandos"
2702
2703
@dbus_interface_annotations(_interface)
2704
def _foo(self):
2705
return { "org.freedesktop.DBus.Property"
2706
".EmitsChangedSignal":
2707
"false"}
2708
2709
@dbus.service.signal(_interface, signature="o")
1927
dbus.service.Object.__init__(self, bus, u"/")
1928
_interface = u"se.bsnet.fukt.Mandos"
1929
1930
@dbus.service.signal(_interface, signature=u"o")
2710
1931
def ClientAdded(self, objpath):
2711
1932
"D-Bus signal"
2712
1933
pass
2713
1934
2714
@dbus.service.signal(_interface, signature="ss")
1935
@dbus.service.signal(_interface, signature=u"ss")
2715
1936
def ClientNotFound(self, fingerprint, address):
2716
1937
"D-Bus signal"
2717
1938
pass
2718
1939
2719
@dbus.service.signal(_interface, signature="os")
1940
@dbus.service.signal(_interface, signature=u"os")
2720
1941
def ClientRemoved(self, objpath, name):
2721
1942
"D-Bus signal"
2722
1943
pass
2723
1944
2724
@dbus.service.method(_interface, out_signature="ao")
1945
@dbus.service.method(_interface, out_signature=u"ao")
2725
1946
def GetAllClients(self):
2726
1947
"D-Bus method"
2727
1948
return dbus.Array(c.dbus_object_path
2728
for c in
2729
tcp_server.clients.itervalues())
1949
for c in tcp_server.clients)
2730
1950
2731
1951
@dbus.service.method(_interface,
2732
out_signature="a{oa{sv}}")
1952
out_signature=u"a{oa{sv}}")
2733
1953
def GetAllClientsWithProperties(self):
2734
1954
"D-Bus method"
2735
1955
return dbus.Dictionary(
2736
{ c.dbus_object_path: c.GetAll("")
2737
for c in tcp_server.clients.itervalues() },
2738
signature="oa{sv}")
1956
((c.dbus_object_path, c.GetAll(u""))
1957
for c in tcp_server.clients),
1958
signature=u"oa{sv}")
2739
1959
2740
@dbus.service.method(_interface, in_signature="o")
1960
@dbus.service.method(_interface, in_signature=u"o")
2741
1961
def RemoveClient(self, object_path):
2742
1962
"D-Bus method"
2743
for c in tcp_server.clients.itervalues():
1963
for c in tcp_server.clients:
2744
1964
if c.dbus_object_path == object_path:
2745
del tcp_server.clients[c.name]
1965
tcp_server.clients.remove(c)
2746
1966
c.remove_from_connection()
2747
1967
# Don't signal anything except ClientRemoved
2748
1968
c.disable(quiet=True)
2757
1977
2758
1978
def cleanup():
2759
1979
"Cleanup function; run on exit"
2760
if zeroconf:
2761
service.cleanup()
2762
2763
multiprocessing.active_children()
2764
wnull.close()
2765
if not (tcp_server.clients or client_settings):
2766
return
2767
2768
# Store client before exiting. Secrets are encrypted with key
2769
# based on what config file has. If config file is
2770
# removed/edited, old secret will thus be unrecovable.
2771
clients = {}
2772
with PGPEngine() as pgp:
2773
for client in tcp_server.clients.itervalues():
2774
key = client_settings[client.name]["secret"]
2775
client.encrypted_secret = pgp.encrypt(client.secret,
2776
key)
2777
client_dict = {}
2778
2779
# A list of attributes that can not be pickled
2780
# + secret.
2781
exclude = { "bus", "changedstate", "secret",
2782
"checker", "server_settings" }
2783
for name, typ in (inspect.getmembers
2784
(dbus.service.Object)):
2785
exclude.add(name)
2786
2787
client_dict["encrypted_secret"] = (client
2788
.encrypted_secret)
2789
for attr in client.client_structure:
2790
if attr not in exclude:
2791
client_dict[attr] = getattr(client, attr)
2792
2793
clients[client.name] = client_dict
2794
del client_settings[client.name]["secret"]
2795
2796
try:
2797
with (tempfile.NamedTemporaryFile
2798
(mode='wb', suffix=".pickle", prefix='clients-',
2799
dir=os.path.dirname(stored_state_path),
2800
delete=False)) as stored_state:
2801
pickle.dump((clients, client_settings), stored_state)
2802
tempname=stored_state.name
2803
os.rename(tempname, stored_state_path)
2804
except (IOError, OSError) as e:
2805
if not debug:
2806
try:
2807
os.remove(tempname)
2808
except NameError:
2809
pass
2810
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2811
logger.warning("Could not save persistent state: {}"
2812
.format(os.strerror(e.errno)))
2813
else:
2814
logger.warning("Could not save persistent state:",
2815
exc_info=e)
2816
raise
2817
2818
# Delete all clients, and settings from config
1980
service.cleanup()
1981
2819
1982
while tcp_server.clients:
2820
name, client = tcp_server.clients.popitem()
1983
client = tcp_server.clients.pop()
2821
1984
if use_dbus:
2822
1985
client.remove_from_connection()
1986
client.disable_hook = None
2823
1987
# Don't signal anything except ClientRemoved
2824
1988
client.disable(quiet=True)
2825
1989
if use_dbus:
2826
1990
# Emit D-Bus signal
2827
mandos_dbus_service.ClientRemoved(client
2828
.dbus_object_path,
1991
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2829
1992
client.name)
2830
client_settings.clear()
2831
1993
2832
1994
atexit.register(cleanup)
2833
1995
2834
for client in tcp_server.clients.itervalues():
1996
for client in tcp_server.clients:
2835
1997
if use_dbus:
2836
1998
# Emit D-Bus signal
2837
1999
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2838
# Need to initiate checking of clients
2839
if client.enabled:
2840
client.init_checker()
2000
client.enable()
2841
2001
2842
2002
tcp_server.enable()
2843
2003
tcp_server.server_activate()
2844
2004
2845
2005
# Find out what port we got
2846
if zeroconf:
2847
service.port = tcp_server.socket.getsockname()[1]
2006
service.port = tcp_server.socket.getsockname()[1]
2848
2007
if use_ipv6:
2849
logger.info("Now listening on address %r, port %d,"
2850
" flowinfo %d, scope_id %d",
2851
*tcp_server.socket.getsockname())
2008
logger.info(u"Now listening on address %r, port %d,"
2009
" flowinfo %d, scope_id %d"
2010
% tcp_server.socket.getsockname())
2852
2011
else: # IPv4
2853
logger.info("Now listening on address %r, port %d",
2854
*tcp_server.socket.getsockname())
2012
logger.info(u"Now listening on address %r, port %d"
2013
% tcp_server.socket.getsockname())
2855
2014
2856
2015
#service.interface = tcp_server.socket.getsockname()[3]
2857
2016
2858
2017
try:
2859
if zeroconf:
2860
# From the Avahi example code
2861
try:
2862
service.activate()
2863
except dbus.exceptions.DBusException as error:
2864
logger.critical("D-Bus Exception", exc_info=error)
2865
cleanup()
2866
sys.exit(1)
2867
# End of Avahi example code
2018
# From the Avahi example code
2019
try:
2020
service.activate()
2021
except dbus.exceptions.DBusException, error:
2022
logger.critical(u"DBusException: %s", error)
2023
cleanup()
2024
sys.exit(1)
2025
# End of Avahi example code
2868
2026
2869
2027
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2870
2028
lambda *args, **kwargs:
2871
2029
(tcp_server.handle_request
2872
2030
(*args[2:], **kwargs) or True))
2873
2031
2874
logger.debug("Starting main loop")
2032
logger.debug(u"Starting main loop")
2875
2033
main_loop.run()
2876
except AvahiError as error:
2877
logger.critical("Avahi Error", exc_info=error)
2034
except AvahiError, error:
2035
logger.critical(u"AvahiError: %s", error)
2878
2036
cleanup()
2879
2037
sys.exit(1)
2880
2038
except KeyboardInterrupt:
2881
2039
if debug:
2882
print("", file=sys.stderr)
2883
logger.debug("Server received KeyboardInterrupt")
2884
logger.debug("Server exiting")
2040
print >> sys.stderr
2041
logger.debug(u"Server received KeyboardInterrupt")
2042
logger.debug(u"Server exiting")
2885
2043
# Must run before the D-Bus bus name gets deregistered
2886
2044
cleanup()
2887
2045
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0