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 24.1.163
- compare with another revision
- download diff
- download tarball
- view history from revision 24.1.163
- Committer: Björn Påhlsson
- Date: 2010-09-12 18:12:11 UTC
- mto: (237.4.3 mandos-release)
- mto: This revision was merged to the branch mainline in revision 428.
- Revision ID: belorn@fukt.bsnet.se-20100912181211-wvkt0sk37zhx7tws
mandos-client: Added never ending loop for --connect
mandos-ctl: Better option parsing.
mandos-ctl: Better option parsing.
- files removed:
- DBUS-API
- 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,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 Björn Påhlsson
16
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
#
31
# Contact the authors at <mandos@recompile.se>.
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
#
33
33
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
36
37
from future_builtins import *
34
from __future__ import division, with_statement, absolute_import
38
35
39
36
import SocketServer as socketserver
40
37
import socket
41
import argparse
38
import optparse
42
39
import datetime
43
40
import errno
44
41
import gnutls.crypto
64
61
import functools
65
62
import cPickle as pickle
66
63
import multiprocessing
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
import collections
72
64
73
65
import dbus
74
66
import dbus.service
88
80
except ImportError:
89
81
SO_BINDTODEVICE = None
90
82
91
if sys.version_info.major == 2:
92
str = unicode
93
94
version = "1.6.9"
95
stored_state_file = "clients.pickle"
96
97
logger = logging.getLogger()
98
syslogger = None
99
100
try:
101
if_nametoindex = (ctypes.cdll.LoadLibrary
102
(ctypes.util.find_library("c"))
103
.if_nametoindex)
104
except (OSError, AttributeError):
105
def if_nametoindex(interface):
106
"Get an interface index the hard way, i.e. using fcntl()"
107
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
108
with contextlib.closing(socket.socket()) as s:
109
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
110
struct.pack(b"16s16x", interface))
111
interface_index = struct.unpack("I", ifreq[16:20])[0]
112
return interface_index
113
114
115
def initlogger(debug, level=logging.WARNING):
116
"""init logger and add loglevel"""
117
118
global syslogger
119
syslogger = (logging.handlers.SysLogHandler
120
(facility =
121
logging.handlers.SysLogHandler.LOG_DAEMON,
122
address = "/dev/log"))
123
syslogger.setFormatter(logging.Formatter
124
('Mandos [%(process)d]: %(levelname)s:'
125
' %(message)s'))
126
logger.addHandler(syslogger)
127
128
if debug:
129
console = logging.StreamHandler()
130
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
131
' [%(process)d]:'
132
' %(levelname)s:'
133
' %(message)s'))
134
logger.addHandler(console)
135
logger.setLevel(level)
136
137
138
class PGPError(Exception):
139
"""Exception if encryption/decryption fails"""
140
pass
141
142
143
class PGPEngine(object):
144
"""A simple class for OpenPGP symmetric encryption & decryption"""
145
def __init__(self):
146
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
147
self.gnupgargs = ['--batch',
148
'--home', self.tempdir,
149
'--force-mdc',
150
'--quiet',
151
'--no-use-agent']
152
153
def __enter__(self):
154
return self
155
156
def __exit__(self, exc_type, exc_value, traceback):
157
self._cleanup()
158
return False
159
160
def __del__(self):
161
self._cleanup()
162
163
def _cleanup(self):
164
if self.tempdir is not None:
165
# Delete contents of tempdir
166
for root, dirs, files in os.walk(self.tempdir,
167
topdown = False):
168
for filename in files:
169
os.remove(os.path.join(root, filename))
170
for dirname in dirs:
171
os.rmdir(os.path.join(root, dirname))
172
# Remove tempdir
173
os.rmdir(self.tempdir)
174
self.tempdir = None
175
176
def password_encode(self, password):
177
# Passphrase can not be empty and can not contain newlines or
178
# NUL bytes. So we prefix it and hex encode it.
179
encoded = b"mandos" + binascii.hexlify(password)
180
if len(encoded) > 2048:
181
# GnuPG can't handle long passwords, so encode differently
182
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
183
.replace(b"\n", b"\\n")
184
.replace(b"\0", b"\\x00"))
185
return encoded
186
187
def encrypt(self, data, password):
188
passphrase = self.password_encode(password)
189
with tempfile.NamedTemporaryFile(dir=self.tempdir
190
) as passfile:
191
passfile.write(passphrase)
192
passfile.flush()
193
proc = subprocess.Popen(['gpg', '--symmetric',
194
'--passphrase-file',
195
passfile.name]
196
+ self.gnupgargs,
197
stdin = subprocess.PIPE,
198
stdout = subprocess.PIPE,
199
stderr = subprocess.PIPE)
200
ciphertext, err = proc.communicate(input = data)
201
if proc.returncode != 0:
202
raise PGPError(err)
203
return ciphertext
204
205
def decrypt(self, data, password):
206
passphrase = self.password_encode(password)
207
with tempfile.NamedTemporaryFile(dir = self.tempdir
208
) as passfile:
209
passfile.write(passphrase)
210
passfile.flush()
211
proc = subprocess.Popen(['gpg', '--decrypt',
212
'--passphrase-file',
213
passfile.name]
214
+ self.gnupgargs,
215
stdin = subprocess.PIPE,
216
stdout = subprocess.PIPE,
217
stderr = subprocess.PIPE)
218
decrypted_plaintext, err = proc.communicate(input
219
= data)
220
if proc.returncode != 0:
221
raise PGPError(err)
222
return decrypted_plaintext
223
83
84
version = "1.0.14"
85
86
#logger = logging.getLogger(u'mandos')
87
logger = logging.Logger(u'mandos')
88
syslogger = (logging.handlers.SysLogHandler
89
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
90
address = "/dev/log"))
91
syslogger.setFormatter(logging.Formatter
92
(u'Mandos [%(process)d]: %(levelname)s:'
93
u' %(message)s'))
94
logger.addHandler(syslogger)
95
96
console = logging.StreamHandler()
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
98
u' %(levelname)s:'
99
u' %(message)s'))
100
logger.addHandler(console)
224
101
225
102
class AvahiError(Exception):
226
103
def __init__(self, value, *args, **kwargs):
227
104
self.value = value
228
return super(AvahiError, self).__init__(value, *args,
229
**kwargs)
105
super(AvahiError, self).__init__(value, *args, **kwargs)
106
def __unicode__(self):
107
return unicode(repr(self.value))
230
108
231
109
class AvahiServiceError(AvahiError):
232
110
pass
241
119
Attributes:
242
120
interface: integer; avahi.IF_UNSPEC or an interface index.
243
121
Used to optionally bind to the specified interface.
244
name: string; Example: 'Mandos'
245
type: string; Example: '_mandos._tcp'.
246
See <https://www.iana.org/assignments/service-names-port-numbers>
122
name: string; Example: u'Mandos'
123
type: string; Example: u'_mandos._tcp'.
124
See <http://www.dns-sd.org/ServiceTypes.html>
247
125
port: integer; what port to announce
248
126
TXT: list of strings; TXT record for the service
249
127
domain: string; Domain to publish on, default to .local if empty.
255
133
server: D-Bus Server
256
134
bus: dbus.SystemBus()
257
135
"""
258
259
136
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
137
servicetype = None, port = None, TXT = None,
261
domain = "", host = "", max_renames = 32768,
138
domain = u"", host = u"", max_renames = 32768,
262
139
protocol = avahi.PROTO_UNSPEC, bus = None):
263
140
self.interface = interface
264
141
self.name = name
273
150
self.group = None # our entry group
274
151
self.server = None
275
152
self.bus = bus
276
self.entry_group_state_changed_match = None
277
278
def rename(self, remove=True):
153
def rename(self):
279
154
"""Derived from the Avahi example code"""
280
155
if self.rename_count >= self.max_renames:
281
logger.critical("No suitable Zeroconf service name found"
282
" after %i retries, exiting.",
156
logger.critical(u"No suitable Zeroconf service name found"
157
u" after %i retries, exiting.",
283
158
self.rename_count)
284
raise AvahiServiceError("Too many renames")
285
self.name = str(self.server
286
.GetAlternativeServiceName(self.name))
159
raise AvahiServiceError(u"Too many renames")
160
self.name = unicode(self.server.GetAlternativeServiceName(self.name))
161
logger.info(u"Changing Zeroconf service name to %r ...",
162
self.name)
163
syslogger.setFormatter(logging.Formatter
164
(u'Mandos (%s) [%%(process)d]:'
165
u' %%(levelname)s: %%(message)s'
166
% self.name))
167
self.remove()
168
try:
169
self.add()
170
except dbus.exceptions.DBusException, error:
171
logger.critical(u"DBusException: %s", error)
172
self.cleanup()
173
os._exit(1)
287
174
self.rename_count += 1
288
logger.info("Changing Zeroconf service name to %r ...",
289
self.name)
290
if remove:
291
self.remove()
292
try:
293
self.add()
294
except dbus.exceptions.DBusException as error:
295
if (error.get_dbus_name()
296
== "org.freedesktop.Avahi.CollisionError"):
297
logger.info("Local Zeroconf service name collision.")
298
return self.rename(remove=False)
299
else:
300
logger.critical("D-Bus Exception", exc_info=error)
301
self.cleanup()
302
os._exit(1)
303
304
175
def remove(self):
305
176
"""Derived from the Avahi example code"""
306
if self.entry_group_state_changed_match is not None:
307
self.entry_group_state_changed_match.remove()
308
self.entry_group_state_changed_match = None
309
177
if self.group is not None:
310
178
self.group.Reset()
311
312
179
def add(self):
313
180
"""Derived from the Avahi example code"""
314
self.remove()
315
181
if self.group is None:
316
182
self.group = dbus.Interface(
317
183
self.bus.get_object(avahi.DBUS_NAME,
318
184
self.server.EntryGroupNew()),
319
185
avahi.DBUS_INTERFACE_ENTRY_GROUP)
320
self.entry_group_state_changed_match = (
321
self.group.connect_to_signal(
322
'StateChanged', self.entry_group_state_changed))
323
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
186
self.group.connect_to_signal('StateChanged',
187
self
188
.entry_group_state_changed)
189
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
324
190
self.name, self.type)
325
191
self.group.AddService(
326
192
self.interface,
331
197
dbus.UInt16(self.port),
332
198
avahi.string_array_to_txt_array(self.TXT))
333
199
self.group.Commit()
334
335
200
def entry_group_state_changed(self, state, error):
336
201
"""Derived from the Avahi example code"""
337
logger.debug("Avahi entry group state change: %i", state)
202
logger.debug(u"Avahi entry group state change: %i", state)
338
203
339
204
if state == avahi.ENTRY_GROUP_ESTABLISHED:
340
logger.debug("Zeroconf service established.")
205
logger.debug(u"Zeroconf service established.")
341
206
elif state == avahi.ENTRY_GROUP_COLLISION:
342
logger.info("Zeroconf service name collision.")
207
logger.warning(u"Zeroconf service name collision.")
343
208
self.rename()
344
209
elif state == avahi.ENTRY_GROUP_FAILURE:
345
logger.critical("Avahi: Error in group state changed %s",
346
str(error))
347
raise AvahiGroupError("State changed: {!s}"
348
.format(error))
349
210
logger.critical(u"Avahi: Error in group state changed %s",
211
unicode(error))
212
raise AvahiGroupError(u"State changed: %s"
213
% unicode(error))
350
214
def cleanup(self):
351
215
"""Derived from the Avahi example code"""
352
216
if self.group is not None:
353
try:
354
self.group.Free()
355
except (dbus.exceptions.UnknownMethodException,
356
dbus.exceptions.DBusException):
357
pass
217
self.group.Free()
358
218
self.group = None
359
self.remove()
360
361
def server_state_changed(self, state, error=None):
219
def server_state_changed(self, state):
362
220
"""Derived from the Avahi example code"""
363
logger.debug("Avahi server state change: %i", state)
364
bad_states = { avahi.SERVER_INVALID:
365
"Zeroconf server invalid",
366
avahi.SERVER_REGISTERING: None,
367
avahi.SERVER_COLLISION:
368
"Zeroconf server name collision",
369
avahi.SERVER_FAILURE:
370
"Zeroconf server failure" }
371
if state in bad_states:
372
if bad_states[state] is not None:
373
if error is None:
374
logger.error(bad_states[state])
375
else:
376
logger.error(bad_states[state] + ": %r", error)
377
self.cleanup()
221
logger.debug(u"Avahi server state change: %i", state)
222
if state == avahi.SERVER_COLLISION:
223
logger.error(u"Zeroconf server name collision")
224
self.remove()
378
225
elif state == avahi.SERVER_RUNNING:
379
226
self.add()
380
else:
381
if error is None:
382
logger.debug("Unknown state: %r", state)
383
else:
384
logger.debug("Unknown state: %r: %r", state, error)
385
386
227
def activate(self):
387
228
"""Derived from the Avahi example code"""
388
229
if self.server is None:
389
230
self.server = dbus.Interface(
390
231
self.bus.get_object(avahi.DBUS_NAME,
391
avahi.DBUS_PATH_SERVER,
392
follow_name_owner_changes=True),
232
avahi.DBUS_PATH_SERVER),
393
233
avahi.DBUS_INTERFACE_SERVER)
394
self.server.connect_to_signal("StateChanged",
234
self.server.connect_to_signal(u"StateChanged",
395
235
self.server_state_changed)
396
236
self.server_state_changed(self.server.GetState())
397
237
398
238
399
class AvahiServiceToSyslog(AvahiService):
400
def rename(self, *args, **kwargs):
401
"""Add the new name to the syslog messages"""
402
ret = AvahiService.rename(self, *args, **kwargs)
403
syslogger.setFormatter(logging.Formatter
404
('Mandos ({}) [%(process)d]:'
405
' %(levelname)s: %(message)s'
406
.format(self.name)))
407
return ret
408
409
410
239
class Client(object):
411
240
"""A representation of a client host served by this server.
412
241
413
242
Attributes:
414
approved: bool(); 'None' if not yet approved/disapproved
415
approval_delay: datetime.timedelta(); Time to wait for approval
416
approval_duration: datetime.timedelta(); Duration of one approval
243
name: string; from the config file, used in log messages and
244
D-Bus identifiers
245
fingerprint: string (40 or 32 hexadecimal digits); used to
246
uniquely identify the client
247
secret: bytestring; sent verbatim (over TLS) to client
248
host: string; available for use by the checker command
249
created: datetime.datetime(); (UTC) object creation
250
last_enabled: datetime.datetime(); (UTC)
251
enabled: bool()
252
last_checked_ok: datetime.datetime(); (UTC) or None
253
timeout: datetime.timedelta(); How long from last_checked_ok
254
until this client is disabled
255
interval: datetime.timedelta(); How often to start a new checker
256
disable_hook: If set, called by disable() as disable_hook(self)
417
257
checker: subprocess.Popen(); a running checker process used
418
258
to see if the client lives.
419
259
'None' if no process is running.
420
checker_callback_tag: a gobject event source tag, or None
421
checker_command: string; External command which is run to check
422
if client lives. %() expansions are done at
260
checker_initiator_tag: a gobject event source tag, or None
261
disable_initiator_tag: - '' -
262
checker_callback_tag: - '' -
263
checker_command: string; External command which is run to check if
264
client lives. %() expansions are done at
423
265
runtime with vars(self) as dict, so that for
424
266
instance %(name)s can be used in the command.
425
checker_initiator_tag: a gobject event source tag, or None
426
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
267
current_checker_command: string; current running checker_command
430
disable_initiator_tag: a gobject event source tag, or None
431
enabled: bool()
432
fingerprint: string (40 or 32 hexadecimal digits); used to
433
uniquely identify the client
434
host: string; available for use by the checker command
435
interval: datetime.timedelta(); How often to start a new checker
436
last_approval_request: datetime.datetime(); (UTC) or None
437
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
442
name: string; from the config file, used in log messages and
443
D-Bus identifiers
444
secret: bytestring; sent verbatim (over TLS) to client
445
timeout: datetime.timedelta(); How long from last_checked_ok
446
until this client is disabled
447
extended_timeout: extra long timeout when secret has been sent
448
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()
268
approved_delay: datetime.timedelta(); Time to wait for approval
269
_approved: bool(); 'None' if not yet approved/disapproved
270
approved_duration: datetime.timedelta(); Duration of one approval
452
271
"""
453
272
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
}
469
470
273
@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):
274
def _timedelta_to_milliseconds(td):
275
"Convert a datetime.timedelta() to milliseconds"
276
return ((td.days * 24 * 60 * 60 * 1000)
277
+ (td.seconds * 1000)
278
+ (td.microseconds // 1000))
279
280
def timeout_milliseconds(self):
281
"Return the 'timeout' attribute in milliseconds"
282
return self._timedelta_to_milliseconds(self.timeout)
283
284
def interval_milliseconds(self):
285
"Return the 'interval' attribute in milliseconds"
286
return self._timedelta_to_milliseconds(self.interval)
287
288
def approved_delay_milliseconds(self):
289
return self._timedelta_to_milliseconds(self.approved_delay)
290
291
def __init__(self, name = None, disable_hook=None, config=None):
292
"""Note: the 'checker' key in 'config' sets the
293
'checker_command' attribute and *not* the 'checker'
294
attribute."""
518
295
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)
296
if config is None:
297
config = {}
298
logger.debug(u"Creating client %r", self.name)
537
299
# Uppercase and remove spaces from fingerprint for later
538
300
# comparison purposes with return value from the fingerprint()
539
301
# 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
302
self.fingerprint = (config[u"fingerprint"].upper()
303
.replace(u" ", u""))
304
logger.debug(u" Fingerprint: %s", self.fingerprint)
305
if u"secret" in config:
306
self.secret = config[u"secret"].decode(u"base64")
307
elif u"secfile" in config:
308
with open(os.path.expanduser(os.path.expandvars
309
(config[u"secfile"])),
310
"rb") as secfile:
311
self.secret = secfile.read()
312
else:
313
raise TypeError(u"No secret or secfile for client %s"
314
% self.name)
315
self.host = config.get(u"host", u"")
316
self.created = datetime.datetime.utcnow()
317
self.enabled = False
318
self.last_enabled = None
319
self.last_checked_ok = None
320
self.timeout = string_to_delta(config[u"timeout"])
321
self.interval = string_to_delta(config[u"interval"])
322
self.disable_hook = disable_hook
545
323
self.checker = None
546
324
self.checker_initiator_tag = None
547
325
self.disable_initiator_tag = None
548
326
self.checker_callback_tag = None
327
self.checker_command = config[u"checker"]
549
328
self.current_checker_command = None
550
self.approved = None
329
self.last_connect = None
330
self._approved = None
331
self.approved_by_default = config.get(u"approved_by_default",
332
True)
551
333
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)
334
self.approved_delay = string_to_delta(
335
config[u"approved_delay"])
336
self.approved_duration = string_to_delta(
337
config[u"approved_duration"])
338
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
566
339
567
# Send notice to process children that client state has changed
568
340
def send_changedstate(self):
569
with self.changedstate:
570
self.changedstate.notify_all()
571
341
self.changedstate.acquire()
342
self.changedstate.notify_all()
343
self.changedstate.release()
344
572
345
def enable(self):
573
346
"""Start this client's checker and timeout hooks"""
574
if getattr(self, "enabled", False):
347
if getattr(self, u"enabled", False):
575
348
# Already enabled
576
349
return
577
self.expires = datetime.datetime.utcnow() + self.timeout
578
self.enabled = True
350
self.send_changedstate()
579
351
self.last_enabled = datetime.datetime.utcnow()
580
self.init_checker()
581
self.send_changedstate()
352
# Schedule a new checker to be started an 'interval' from now,
353
# and every interval from then on.
354
self.checker_initiator_tag = (gobject.timeout_add
355
(self.interval_milliseconds(),
356
self.start_checker))
357
# Schedule a disable() when 'timeout' has passed
358
self.disable_initiator_tag = (gobject.timeout_add
359
(self.timeout_milliseconds(),
360
self.disable))
361
self.enabled = True
362
# Also start a new checker *right now*.
363
self.start_checker()
582
364
583
365
def disable(self, quiet=True):
584
366
"""Disable this client."""
585
367
if not getattr(self, "enabled", False):
586
368
return False
587
369
if not quiet:
588
logger.info("Disabling client %s", self.name)
589
if getattr(self, "disable_initiator_tag", None) is not None:
370
self.send_changedstate()
371
if not quiet:
372
logger.info(u"Disabling client %s", self.name)
373
if getattr(self, u"disable_initiator_tag", False):
590
374
gobject.source_remove(self.disable_initiator_tag)
591
375
self.disable_initiator_tag = None
592
self.expires = None
593
if getattr(self, "checker_initiator_tag", None) is not None:
376
if getattr(self, u"checker_initiator_tag", False):
594
377
gobject.source_remove(self.checker_initiator_tag)
595
378
self.checker_initiator_tag = None
596
379
self.stop_checker()
380
if self.disable_hook:
381
self.disable_hook(self)
597
382
self.enabled = False
598
if not quiet:
599
self.send_changedstate()
600
383
# Do not run this again if called by a gobject.timeout_add
601
384
return False
602
385
603
386
def __del__(self):
387
self.disable_hook = None
604
388
self.disable()
605
389
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
390
def checker_callback(self, pid, condition, command):
626
391
"""The checker has completed, so take appropriate actions."""
627
392
self.checker_callback_tag = None
628
393
self.checker = None
629
394
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",
395
exitstatus = os.WEXITSTATUS(condition)
396
if exitstatus == 0:
397
logger.info(u"Checker for %(name)s succeeded",
633
398
vars(self))
634
399
self.checked_ok()
635
400
else:
636
logger.info("Checker for %(name)s failed",
401
logger.info(u"Checker for %(name)s failed",
637
402
vars(self))
638
403
else:
639
self.last_checker_status = -1
640
logger.warning("Checker for %(name)s crashed?",
404
logger.warning(u"Checker for %(name)s crashed?",
641
405
vars(self))
642
406
643
407
def checked_ok(self):
644
"""Assert that the client has been seen, alive and well."""
408
"""Bump up the timeout for this client.
409
410
This should only be called when the client has been seen,
411
alive and well.
412
"""
645
413
self.last_checked_ok = datetime.datetime.utcnow()
646
self.last_checker_status = 0
647
self.bump_timeout()
648
649
def bump_timeout(self, timeout=None):
650
"""Bump up the timeout for this client."""
651
if timeout is None:
652
timeout = self.timeout
653
if self.disable_initiator_tag is not None:
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = None
656
if getattr(self, "enabled", False):
657
self.disable_initiator_tag = (gobject.timeout_add
658
(int(timeout.total_seconds()
659
* 1000), self.disable))
660
self.expires = datetime.datetime.utcnow() + timeout
661
662
def need_approval(self):
663
self.last_approval_request = datetime.datetime.utcnow()
414
gobject.source_remove(self.disable_initiator_tag)
415
self.disable_initiator_tag = (gobject.timeout_add
416
(self.timeout_milliseconds(),
417
self.disable))
664
418
665
419
def start_checker(self):
666
420
"""Start a new checker subprocess if one is not running.
668
422
If a checker already exists, leave it running and do
669
423
nothing."""
670
424
# 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
425
# did that, then if a checker (for some reason) started
426
# running slowly and taking more than 'interval' time, the
427
# client would inevitably timeout, since no checker would get
428
# a chance to run to completion. If we instead leave running
675
429
# checkers alone, the checker would have to take more time
676
430
# than 'timeout' for the client to be disabled, which is as it
677
431
# should be.
679
433
# If a checker exists, make sure it is not a zombie
680
434
try:
681
435
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
436
except (AttributeError, OSError), error:
437
if (isinstance(error, OSError)
438
and error.errno != errno.ECHILD):
439
raise error
687
440
else:
688
441
if pid:
689
logger.warning("Checker was a zombie")
442
logger.warning(u"Checker was a zombie")
690
443
gobject.source_remove(self.checker_callback_tag)
691
444
self.checker_callback(pid, status,
692
445
self.current_checker_command)
693
446
# Start a new checker if needed
694
447
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
448
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
449
# In case checker_command has exactly one % operator
450
command = self.checker_command % self.host
451
except TypeError:
452
# Escape attributes for the shell
453
escaped_attrs = dict((key,
454
re.escape(unicode(str(val),
455
errors=
456
u'replace')))
457
for key, val in
458
vars(self).iteritems())
459
try:
460
command = self.checker_command % escaped_attrs
461
except TypeError, error:
462
logger.error(u'Could not format string "%s":'
463
u' %s', self.checker_command, error)
464
return True # Try again later
705
465
self.current_checker_command = command
706
466
try:
707
logger.info("Starting checker %r for %s",
467
logger.info(u"Starting checker %r for %s",
708
468
command, self.name)
709
469
# We don't need to redirect stdout and stderr, since
710
470
# in normal mode, that is already done by daemon(),
711
471
# and in debug mode we don't want to. (Stdin is
712
472
# 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
473
self.checker = subprocess.Popen(command,
722
474
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:
475
shell=True, cwd=u"/")
476
self.checker_callback_tag = (gobject.child_watch_add
477
(self.checker.pid,
478
self.checker_callback,
479
data=command))
480
# The checker may have completed before the gobject
481
# watch was added. Check for this.
736
482
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)
483
if pid:
484
gobject.source_remove(self.checker_callback_tag)
485
self.checker_callback(pid, status, command)
486
except OSError, error:
487
logger.error(u"Failed to start subprocess: %s",
488
error)
747
489
# Re-run this periodically if run by gobject.timeout_add
748
490
return True
749
491
752
494
if self.checker_callback_tag:
753
495
gobject.source_remove(self.checker_callback_tag)
754
496
self.checker_callback_tag = None
755
if getattr(self, "checker", None) is None:
497
if getattr(self, u"checker", None) is None:
756
498
return
757
logger.debug("Stopping checker for %(name)s", vars(self))
499
logger.debug(u"Stopping checker for %(name)s", vars(self))
758
500
try:
759
self.checker.terminate()
501
os.kill(self.checker.pid, signal.SIGTERM)
760
502
#time.sleep(0.5)
761
503
#if self.checker.poll() is None:
762
# self.checker.kill()
763
except OSError as error:
504
# os.kill(self.checker.pid, signal.SIGKILL)
505
except OSError, error:
764
506
if error.errno != errno.ESRCH: # No such process
765
507
raise
766
508
self.checker = None
767
509
768
769
def dbus_service_property(dbus_interface, signature="v",
770
access="readwrite", byte_arrays=False):
510
def dbus_service_property(dbus_interface, signature=u"v",
511
access=u"readwrite", byte_arrays=False):
771
512
"""Decorators for marking methods of a DBusObjectWithProperties to
772
513
become properties on the D-Bus.
773
514
780
521
"""
781
522
# Encoding deeply encoded byte arrays is not supported yet by the
782
523
# "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))
524
if byte_arrays and signature != u"ay":
525
raise ValueError(u"Byte arrays not supported for non-'ay'"
526
u" signature %r" % signature)
786
527
def decorator(func):
787
528
func._dbus_is_property = True
788
529
func._dbus_interface = dbus_interface
789
530
func._dbus_signature = signature
790
531
func._dbus_access = access
791
532
func._dbus_name = func.__name__
792
if func._dbus_name.endswith("_dbus_property"):
533
if func._dbus_name.endswith(u"_dbus_property"):
793
534
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
535
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
832
536
return func
833
537
return decorator
834
538
836
540
class DBusPropertyException(dbus.exceptions.DBusException):
837
541
"""A base class for D-Bus property-related exceptions
838
542
"""
839
pass
543
def __unicode__(self):
544
return unicode(str(self))
545
840
546
841
547
class DBusPropertyAccessException(DBusPropertyException):
842
548
"""A property's access permissions disallows an operation.
852
558
853
559
class DBusObjectWithProperties(dbus.service.Object):
854
560
"""A D-Bus object with properties.
855
561
856
562
Classes inheriting from this can use the dbus_service_property
857
563
decorator to expose methods as D-Bus properties. It exposes the
858
564
standard Get(), Set(), and GetAll() methods on the D-Bus.
859
565
"""
860
566
861
567
@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)
568
def _is_dbus_property(obj):
569
return getattr(obj, u"_dbus_is_property", False)
870
570
871
def _get_all_dbus_things(self, thing):
571
def _get_all_dbus_properties(self):
872
572
"""Returns a generator of (name, attribute) pairs
873
573
"""
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)))
574
return ((prop._dbus_name, prop)
575
for name, prop in
576
inspect.getmembers(self, self._is_dbus_property))
881
577
882
578
def _get_dbus_property(self, interface_name, property_name):
883
579
"""Returns a bound method if one exists which is a D-Bus
884
580
property with the specified name and interface.
885
581
"""
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
582
for name in (property_name,
583
property_name + u"_dbus_property"):
584
prop = getattr(self, name, None)
585
if (prop is None
586
or not self._is_dbus_property(prop)
587
or prop._dbus_name != property_name
588
or (interface_name and prop._dbus_interface
589
and interface_name != prop._dbus_interface)):
590
continue
591
return prop
894
592
# No such property
895
raise DBusPropertyNotFound(self.dbus_object_path + ":"
896
+ interface_name + "."
593
raise DBusPropertyNotFound(self.dbus_object_path + u":"
594
+ interface_name + u"."
897
595
+ property_name)
898
596
899
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
900
out_signature="v")
597
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
598
out_signature=u"v")
901
599
def Get(self, interface_name, property_name):
902
600
"""Standard D-Bus property Get() method, see D-Bus standard.
903
601
"""
904
602
prop = self._get_dbus_property(interface_name, property_name)
905
if prop._dbus_access == "write":
603
if prop._dbus_access == u"write":
906
604
raise DBusPropertyAccessException(property_name)
907
605
value = prop()
908
if not hasattr(value, "variant_level"):
606
if not hasattr(value, u"variant_level"):
909
607
return value
910
608
return type(value)(value, variant_level=value.variant_level+1)
911
609
912
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
610
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
913
611
def Set(self, interface_name, property_name, value):
914
612
"""Standard D-Bus property Set() method, see D-Bus standard.
915
613
"""
916
614
prop = self._get_dbus_property(interface_name, property_name)
917
if prop._dbus_access == "read":
615
if prop._dbus_access == u"read":
918
616
raise DBusPropertyAccessException(property_name)
919
if prop._dbus_get_args_options["byte_arrays"]:
617
if prop._dbus_get_args_options[u"byte_arrays"]:
920
618
# The byte_arrays option is not supported yet on
921
619
# 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))
620
if prop._dbus_signature != u"ay":
621
raise ValueError
622
value = dbus.ByteArray(''.join(unichr(byte)
623
for byte in value))
928
624
prop(value)
929
625
930
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
931
out_signature="a{sv}")
626
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
627
out_signature=u"a{sv}")
932
628
def GetAll(self, interface_name):
933
629
"""Standard D-Bus property GetAll() method, see D-Bus
934
630
standard.
935
631
936
632
Note: Will not include properties with access="write".
937
633
"""
938
properties = {}
939
for name, prop in self._get_all_dbus_things("property"):
634
all = {}
635
for name, prop in self._get_all_dbus_properties():
940
636
if (interface_name
941
637
and interface_name != prop._dbus_interface):
942
638
# Interface non-empty but did not match
943
639
continue
944
640
# Ignore write-only properties
945
if prop._dbus_access == "write":
641
if prop._dbus_access == u"write":
946
642
continue
947
643
value = prop()
948
if not hasattr(value, "variant_level"):
949
properties[name] = value
644
if not hasattr(value, u"variant_level"):
645
all[name] = value
950
646
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
647
all[name] = type(value)(value, variant_level=
648
value.variant_level+1)
649
return dbus.Dictionary(all, signature=u"sv")
962
650
963
651
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
964
out_signature="s",
652
out_signature=u"s",
965
653
path_keyword='object_path',
966
654
connection_keyword='connection')
967
655
def Introspect(self, object_path, connection):
968
"""Overloading of standard D-Bus method.
969
970
Inserts property tags and interface annotation tags.
656
"""Standard D-Bus method, overloaded to insert property tags.
971
657
"""
972
658
xmlstring = dbus.service.Object.Introspect(self, object_path,
973
659
connection)
974
660
try:
975
661
document = xml.dom.minidom.parseString(xmlstring)
976
662
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)
663
e = document.createElement(u"property")
664
e.setAttribute(u"name", name)
665
e.setAttribute(u"type", prop._dbus_signature)
666
e.setAttribute(u"access", prop._dbus_access)
981
667
return e
982
for if_tag in document.getElementsByTagName("interface"):
983
# Add property tags
668
for if_tag in document.getElementsByTagName(u"interface"):
984
669
for tag in (make_tag(document, name, prop)
985
670
for name, prop
986
in self._get_all_dbus_things("property")
671
in self._get_all_dbus_properties()
987
672
if prop._dbus_interface
988
== if_tag.getAttribute("name")):
673
== if_tag.getAttribute(u"name")):
989
674
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
675
# Add the names to the return values for the
1022
676
# "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")
677
if (if_tag.getAttribute(u"name")
678
== u"org.freedesktop.DBus.Properties"):
679
for cn in if_tag.getElementsByTagName(u"method"):
680
if cn.getAttribute(u"name") == u"Get":
681
for arg in cn.getElementsByTagName(u"arg"):
682
if (arg.getAttribute(u"direction")
683
== u"out"):
684
arg.setAttribute(u"name", u"value")
685
elif cn.getAttribute(u"name") == u"GetAll":
686
for arg in cn.getElementsByTagName(u"arg"):
687
if (arg.getAttribute(u"direction")
688
== u"out"):
689
arg.setAttribute(u"name", u"props")
690
xmlstring = document.toxml(u"utf-8")
1037
691
document.unlink()
1038
692
except (AttributeError, xml.dom.DOMException,
1039
xml.parsers.expat.ExpatError) as error:
1040
logger.error("Failed to override Introspection method",
1041
exc_info=error)
693
xml.parsers.expat.ExpatError), error:
694
logger.error(u"Failed to override Introspection method",
695
error)
1042
696
return xmlstring
1043
697
1044
698
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
699
class ClientDBus(Client, DBusObjectWithProperties):
1225
700
"""A Client class using D-Bus
1226
701
1228
703
dbus_object_path: dbus.ObjectPath
1229
704
bus: dbus.SystemBus()
1230
705
"""
1231
1232
runtime_expansions = (Client.runtime_expansions
1233
+ ("dbus_object_path",))
1234
1235
_interface = "se.recompile.Mandos.Client"
1236
1237
706
# dbus.service.Object doesn't use super(), so we can't either.
1238
707
1239
708
def __init__(self, bus = None, *args, **kwargs):
709
self._approvals_pending = 0
1240
710
self.bus = bus
1241
711
Client.__init__(self, *args, **kwargs)
1242
712
# Only now, when this client is initialized, can it show up on
1243
713
# the D-Bus
1244
client_object_name = str(self.name).translate(
1245
{ord("."): ord("_"),
1246
ord("-"): ord("_")})
1247
714
self.dbus_object_path = (dbus.ObjectPath
1248
("/clients/" + client_object_name))
715
(u"/clients/"
716
+ self.name.replace(u".", u"_")))
1249
717
DBusObjectWithProperties.__init__(self, self.bus,
1250
718
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
719
720
def _get_approvals_pending(self):
721
return self._approvals_pending
722
def _set_approvals_pending(self, value):
723
old_value = self._approvals_pending
724
self._approvals_pending = value
725
bval = bool(value)
726
if (hasattr(self, "dbus_object_path")
727
and bval is not bool(old_value)):
728
dbus_bool = dbus.Boolean(bval, variant_level=1)
729
self.PropertyChanged(dbus.String(u"approved_pending"),
730
dbus_bool)
731
732
approvals_pending = property(_get_approvals_pending,
733
_set_approvals_pending)
734
del _get_approvals_pending, _set_approvals_pending
735
736
@staticmethod
737
def _datetime_to_dbus(dt, variant_level=0):
738
"""Convert a UTC datetime.datetime() to a D-Bus type."""
739
return dbus.String(dt.isoformat(),
740
variant_level=variant_level)
741
742
def enable(self):
743
oldstate = getattr(self, u"enabled", False)
744
r = Client.enable(self)
745
if oldstate != self.enabled:
746
# Emit D-Bus signals
747
self.PropertyChanged(dbus.String(u"enabled"),
748
dbus.Boolean(True, variant_level=1))
749
self.PropertyChanged(
750
dbus.String(u"last_enabled"),
751
self._datetime_to_dbus(self.last_enabled,
752
variant_level=1))
753
return r
754
755
def disable(self, quiet = False):
756
oldstate = getattr(self, u"enabled", False)
757
r = Client.disable(self, quiet=quiet)
758
if not quiet and oldstate != self.enabled:
759
# Emit D-Bus signal
760
self.PropertyChanged(dbus.String(u"enabled"),
761
dbus.Boolean(False, variant_level=1))
762
return r
1334
763
1335
764
def __del__(self, *args, **kwargs):
1336
765
try:
1337
766
self.remove_from_connection()
1338
767
except LookupError:
1339
768
pass
1340
if hasattr(DBusObjectWithProperties, "__del__"):
769
if hasattr(DBusObjectWithProperties, u"__del__"):
1341
770
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1342
771
Client.__del__(self, *args, **kwargs)
1343
772
1345
774
*args, **kwargs):
1346
775
self.checker_callback_tag = None
1347
776
self.checker = None
777
# Emit D-Bus signal
778
self.PropertyChanged(dbus.String(u"checker_running"),
779
dbus.Boolean(False, variant_level=1))
1348
780
if os.WIFEXITED(condition):
1349
781
exitstatus = os.WEXITSTATUS(condition)
1350
782
# Emit D-Bus signal
1360
792
return Client.checker_callback(self, pid, condition, command,
1361
793
*args, **kwargs)
1362
794
795
def checked_ok(self, *args, **kwargs):
796
r = Client.checked_ok(self, *args, **kwargs)
797
# Emit D-Bus signal
798
self.PropertyChanged(
799
dbus.String(u"last_checked_ok"),
800
(self._datetime_to_dbus(self.last_checked_ok,
801
variant_level=1)))
802
return r
803
1363
804
def start_checker(self, *args, **kwargs):
1364
old_checker_pid = getattr(self.checker, "pid", None)
805
old_checker = self.checker
806
if self.checker is not None:
807
old_checker_pid = self.checker.pid
808
else:
809
old_checker_pid = None
1365
810
r = Client.start_checker(self, *args, **kwargs)
1366
811
# Only if new checker process was started
1367
812
if (self.checker is not None
1368
813
and old_checker_pid != self.checker.pid):
1369
814
# Emit D-Bus signal
1370
815
self.CheckerStarted(self.current_checker_command)
816
self.PropertyChanged(
817
dbus.String(u"checker_running"),
818
dbus.Boolean(True, variant_level=1))
1371
819
return r
1372
820
821
def stop_checker(self, *args, **kwargs):
822
old_checker = getattr(self, u"checker", None)
823
r = Client.stop_checker(self, *args, **kwargs)
824
if (old_checker is not None
825
and getattr(self, u"checker", None) is None):
826
self.PropertyChanged(dbus.String(u"checker_running"),
827
dbus.Boolean(False, variant_level=1))
828
return r
829
1373
830
def _reset_approved(self):
1374
self.approved = None
831
self._approved = None
1375
832
return False
1376
833
1377
834
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
835
self.send_changedstate()
836
self._approved = value
837
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration),
838
self._reset_approved)
839
1382
840
1383
841
## D-Bus methods, signals & properties
1384
1385
## Interfaces
842
_interface = u"se.bsnet.fukt.Mandos.Client"
1386
843
1387
844
## Signals
1388
845
1389
846
# CheckerCompleted - signal
1390
@dbus.service.signal(_interface, signature="nxs")
847
@dbus.service.signal(_interface, signature=u"nxs")
1391
848
def CheckerCompleted(self, exitcode, waitstatus, command):
1392
849
"D-Bus signal"
1393
850
pass
1394
851
1395
852
# CheckerStarted - signal
1396
@dbus.service.signal(_interface, signature="s")
853
@dbus.service.signal(_interface, signature=u"s")
1397
854
def CheckerStarted(self, command):
1398
855
"D-Bus signal"
1399
856
pass
1400
857
1401
858
# PropertyChanged - signal
1402
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1403
@dbus.service.signal(_interface, signature="sv")
859
@dbus.service.signal(_interface, signature=u"sv")
1404
860
def PropertyChanged(self, property, value):
1405
861
"D-Bus signal"
1406
862
pass
1415
871
pass
1416
872
1417
873
# Rejected - signal
1418
@dbus.service.signal(_interface, signature="s")
874
@dbus.service.signal(_interface, signature=u"s")
1419
875
def Rejected(self, reason):
1420
876
"D-Bus signal"
1421
877
pass
1422
878
1423
879
# NeedApproval - signal
1424
@dbus.service.signal(_interface, signature="tb")
880
@dbus.service.signal(_interface, signature=u"db")
1425
881
def NeedApproval(self, timeout, default):
1426
882
"D-Bus signal"
1427
return self.need_approval()
883
pass
1428
884
1429
885
## Methods
1430
886
1431
887
# Approve - method
1432
@dbus.service.method(_interface, in_signature="b")
888
@dbus.service.method(_interface, in_signature=u"b")
1433
889
def Approve(self, value):
1434
890
self.approve(value)
1435
891
1436
892
# CheckedOK - method
1437
893
@dbus.service.method(_interface)
1438
894
def CheckedOK(self):
1439
self.checked_ok()
895
return self.checked_ok()
1440
896
1441
897
# Enable - method
1442
898
@dbus.service.method(_interface)
1463
919
1464
920
## Properties
1465
921
1466
# ApprovalPending - property
1467
@dbus_service_property(_interface, signature="b", access="read")
1468
def ApprovalPending_dbus_property(self):
922
# approved_pending - property
923
@dbus_service_property(_interface, signature=u"b", access=u"read")
924
def approved_pending_dbus_property(self):
1469
925
return dbus.Boolean(bool(self.approvals_pending))
1470
926
1471
# ApprovedByDefault - property
1472
@dbus_service_property(_interface, signature="b",
1473
access="readwrite")
1474
def ApprovedByDefault_dbus_property(self, value=None):
1475
if value is None: # get
1476
return dbus.Boolean(self.approved_by_default)
1477
self.approved_by_default = bool(value)
1478
1479
# ApprovalDelay - property
1480
@dbus_service_property(_interface, signature="t",
1481
access="readwrite")
1482
def ApprovalDelay_dbus_property(self, value=None):
1483
if value is None: # get
1484
return dbus.UInt64(self.approval_delay.total_seconds()
1485
* 1000)
1486
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1487
1488
# ApprovalDuration - property
1489
@dbus_service_property(_interface, signature="t",
1490
access="readwrite")
1491
def ApprovalDuration_dbus_property(self, value=None):
1492
if value is None: # get
1493
return dbus.UInt64(self.approval_duration.total_seconds()
1494
* 1000)
1495
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1496
1497
# Name - property
1498
@dbus_service_property(_interface, signature="s", access="read")
1499
def Name_dbus_property(self):
927
# approved_by_default - property
928
@dbus_service_property(_interface, signature=u"b",
929
access=u"readwrite")
930
def approved_by_default_dbus_property(self):
931
return dbus.Boolean(self.approved_by_default)
932
933
# approved_delay - property
934
@dbus_service_property(_interface, signature=u"t",
935
access=u"readwrite")
936
def approved_delay_dbus_property(self):
937
return dbus.UInt64(self.approved_delay_milliseconds())
938
939
# approved_duration - property
940
@dbus_service_property(_interface, signature=u"t",
941
access=u"readwrite")
942
def approved_duration_dbus_property(self):
943
return dbus.UInt64(self._timedelta_to_milliseconds(
944
self.approved_duration))
945
946
# name - property
947
@dbus_service_property(_interface, signature=u"s", access=u"read")
948
def name_dbus_property(self):
1500
949
return dbus.String(self.name)
1501
950
1502
# Fingerprint - property
1503
@dbus_service_property(_interface, signature="s", access="read")
1504
def Fingerprint_dbus_property(self):
951
# fingerprint - property
952
@dbus_service_property(_interface, signature=u"s", access=u"read")
953
def fingerprint_dbus_property(self):
1505
954
return dbus.String(self.fingerprint)
1506
955
1507
# Host - property
1508
@dbus_service_property(_interface, signature="s",
1509
access="readwrite")
1510
def Host_dbus_property(self, value=None):
956
# host - property
957
@dbus_service_property(_interface, signature=u"s",
958
access=u"readwrite")
959
def host_dbus_property(self, value=None):
1511
960
if value is None: # get
1512
961
return dbus.String(self.host)
1513
self.host = str(value)
1514
1515
# Created - property
1516
@dbus_service_property(_interface, signature="s", access="read")
1517
def Created_dbus_property(self):
1518
return datetime_to_dbus(self.created)
1519
1520
# LastEnabled - property
1521
@dbus_service_property(_interface, signature="s", access="read")
1522
def LastEnabled_dbus_property(self):
1523
return datetime_to_dbus(self.last_enabled)
1524
1525
# Enabled - property
1526
@dbus_service_property(_interface, signature="b",
1527
access="readwrite")
1528
def Enabled_dbus_property(self, value=None):
962
self.host = value
963
# Emit D-Bus signal
964
self.PropertyChanged(dbus.String(u"host"),
965
dbus.String(value, variant_level=1))
966
967
# created - property
968
@dbus_service_property(_interface, signature=u"s", access=u"read")
969
def created_dbus_property(self):
970
return dbus.String(self._datetime_to_dbus(self.created))
971
972
# last_enabled - property
973
@dbus_service_property(_interface, signature=u"s", access=u"read")
974
def last_enabled_dbus_property(self):
975
if self.last_enabled is None:
976
return dbus.String(u"")
977
return dbus.String(self._datetime_to_dbus(self.last_enabled))
978
979
# enabled - property
980
@dbus_service_property(_interface, signature=u"b",
981
access=u"readwrite")
982
def enabled_dbus_property(self, value=None):
1529
983
if value is None: # get
1530
984
return dbus.Boolean(self.enabled)
1531
985
if value:
1533
987
else:
1534
988
self.disable()
1535
989
1536
# LastCheckedOK - property
1537
@dbus_service_property(_interface, signature="s",
1538
access="readwrite")
1539
def LastCheckedOK_dbus_property(self, value=None):
990
# last_checked_ok - property
991
@dbus_service_property(_interface, signature=u"s",
992
access=u"readwrite")
993
def last_checked_ok_dbus_property(self, value=None):
1540
994
if value is not None:
1541
995
self.checked_ok()
1542
996
return
1543
return datetime_to_dbus(self.last_checked_ok)
1544
1545
# LastCheckerStatus - property
1546
@dbus_service_property(_interface, signature="n",
1547
access="read")
1548
def LastCheckerStatus_dbus_property(self):
1549
return dbus.Int16(self.last_checker_status)
1550
1551
# Expires - property
1552
@dbus_service_property(_interface, signature="s", access="read")
1553
def Expires_dbus_property(self):
1554
return datetime_to_dbus(self.expires)
1555
1556
# LastApprovalRequest - property
1557
@dbus_service_property(_interface, signature="s", access="read")
1558
def LastApprovalRequest_dbus_property(self):
1559
return datetime_to_dbus(self.last_approval_request)
1560
1561
# Timeout - property
1562
@dbus_service_property(_interface, signature="t",
1563
access="readwrite")
1564
def Timeout_dbus_property(self, value=None):
997
if self.last_checked_ok is None:
998
return dbus.String(u"")
999
return dbus.String(self._datetime_to_dbus(self
1000
.last_checked_ok))
1001
1002
# timeout - property
1003
@dbus_service_property(_interface, signature=u"t",
1004
access=u"readwrite")
1005
def timeout_dbus_property(self, value=None):
1565
1006
if value is None: # get
1566
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1567
old_timeout = self.timeout
1007
return dbus.UInt64(self.timeout_milliseconds())
1568
1008
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)
1594
1595
# Interval - property
1596
@dbus_service_property(_interface, signature="t",
1597
access="readwrite")
1598
def Interval_dbus_property(self, value=None):
1599
if value is None: # get
1600
return dbus.UInt64(self.interval.total_seconds() * 1000)
1009
# Emit D-Bus signal
1010
self.PropertyChanged(dbus.String(u"timeout"),
1011
dbus.UInt64(value, variant_level=1))
1012
if getattr(self, u"disable_initiator_tag", None) is None:
1013
return
1014
# Reschedule timeout
1015
gobject.source_remove(self.disable_initiator_tag)
1016
self.disable_initiator_tag = None
1017
time_to_die = (self.
1018
_timedelta_to_milliseconds((self
1019
.last_checked_ok
1020
+ self.timeout)
1021
- datetime.datetime
1022
.utcnow()))
1023
if time_to_die <= 0:
1024
# The timeout has passed
1025
self.disable()
1026
else:
1027
self.disable_initiator_tag = (gobject.timeout_add
1028
(time_to_die, self.disable))
1029
1030
# interval - property
1031
@dbus_service_property(_interface, signature=u"t",
1032
access=u"readwrite")
1033
def interval_dbus_property(self, value=None):
1034
if value is None: # get
1035
return dbus.UInt64(self.interval_milliseconds())
1601
1036
self.interval = datetime.timedelta(0, 0, 0, value)
1602
if getattr(self, "checker_initiator_tag", None) is None:
1037
# Emit D-Bus signal
1038
self.PropertyChanged(dbus.String(u"interval"),
1039
dbus.UInt64(value, variant_level=1))
1040
if getattr(self, u"checker_initiator_tag", None) is None:
1603
1041
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
1611
# Checker - property
1612
@dbus_service_property(_interface, signature="s",
1613
access="readwrite")
1614
def Checker_dbus_property(self, value=None):
1042
# Reschedule checker run
1043
gobject.source_remove(self.checker_initiator_tag)
1044
self.checker_initiator_tag = (gobject.timeout_add
1045
(value, self.start_checker))
1046
self.start_checker() # Start one now, too
1047
1048
# checker - property
1049
@dbus_service_property(_interface, signature=u"s",
1050
access=u"readwrite")
1051
def checker_dbus_property(self, value=None):
1615
1052
if value is None: # get
1616
1053
return dbus.String(self.checker_command)
1617
self.checker_command = str(value)
1054
self.checker_command = value
1055
# Emit D-Bus signal
1056
self.PropertyChanged(dbus.String(u"checker"),
1057
dbus.String(self.checker_command,
1058
variant_level=1))
1618
1059
1619
# CheckerRunning - property
1620
@dbus_service_property(_interface, signature="b",
1621
access="readwrite")
1622
def CheckerRunning_dbus_property(self, value=None):
1060
# checker_running - property
1061
@dbus_service_property(_interface, signature=u"b",
1062
access=u"readwrite")
1063
def checker_running_dbus_property(self, value=None):
1623
1064
if value is None: # get
1624
1065
return dbus.Boolean(self.checker is not None)
1625
1066
if value:
1627
1068
else:
1628
1069
self.stop_checker()
1629
1070
1630
# ObjectPath - property
1631
@dbus_service_property(_interface, signature="o", access="read")
1632
def ObjectPath_dbus_property(self):
1071
# object_path - property
1072
@dbus_service_property(_interface, signature=u"o", access=u"read")
1073
def object_path_dbus_property(self):
1633
1074
return self.dbus_object_path # is already a dbus.ObjectPath
1634
1075
1635
# Secret = property
1636
@dbus_service_property(_interface, signature="ay",
1637
access="write", byte_arrays=True)
1638
def Secret_dbus_property(self, value):
1639
self.secret = bytes(value)
1076
# secret = property
1077
@dbus_service_property(_interface, signature=u"ay",
1078
access=u"write", byte_arrays=True)
1079
def secret_dbus_property(self, value):
1080
self.secret = str(value)
1640
1081
1641
1082
del _interface
1642
1083
1647
1088
self._pipe.send(('init', fpr, address))
1648
1089
if not self._pipe.recv():
1649
1090
raise KeyError()
1650
1091
1651
1092
def __getattribute__(self, name):
1652
if name == '_pipe':
1093
if(name == '_pipe'):
1653
1094
return super(ProxyClient, self).__getattribute__(name)
1654
1095
self._pipe.send(('getattr', name))
1655
1096
data = self._pipe.recv()
1660
1101
self._pipe.send(('funcall', name, args, kwargs))
1661
1102
return self._pipe.recv()[1]
1662
1103
return func
1663
1104
1664
1105
def __setattr__(self, name, value):
1665
if name == '_pipe':
1106
if(name == '_pipe'):
1666
1107
return super(ProxyClient, self).__setattr__(name, value)
1667
1108
self._pipe.send(('setattr', name, value))
1668
1109
1675
1116
1676
1117
def handle(self):
1677
1118
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",
1119
logger.info(u"TCP connection from: %s",
1120
unicode(self.client_address))
1121
logger.debug(u"Pipe FD: %d",
1681
1122
self.server.child_pipe.fileno())
1682
1123
1683
1124
session = (gnutls.connection
1684
1125
.ClientSession(self.request,
1685
1126
gnutls.connection
1686
1127
.X509Credentials()))
1687
1128
1688
1129
# Note: gnutls.connection.X509Credentials is really a
1689
1130
# generic GnuTLS certificate credentials object so long as
1690
1131
# no X.509 keys are added to it. Therefore, we can use it
1691
1132
# 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"))
1133
1134
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1135
# u"+AES-256-CBC", u"+SHA1",
1136
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1137
# u"+DHE-DSS"))
1697
1138
# Use a fallback default, since this MUST be set.
1698
1139
priority = self.server.gnutls_priority
1699
1140
if priority is None:
1700
priority = "NORMAL"
1141
priority = u"NORMAL"
1701
1142
(gnutls.library.functions
1702
1143
.gnutls_priority_set_direct(session._c_object,
1703
1144
priority, None))
1704
1145
1705
1146
# Start communication using the Mandos protocol
1706
1147
# Get protocol number
1707
1148
line = self.request.makefile().readline()
1708
logger.debug("Protocol version: %r", line)
1149
logger.debug(u"Protocol version: %r", line)
1709
1150
try:
1710
1151
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)
1152
raise RuntimeError
1153
except (ValueError, IndexError, RuntimeError), error:
1154
logger.error(u"Unknown protocol version: %s", error)
1714
1155
return
1715
1156
1716
1157
# Start GnuTLS connection
1717
1158
try:
1718
1159
session.handshake()
1719
except gnutls.errors.GNUTLSError as error:
1720
logger.warning("Handshake failed: %s", error)
1160
except gnutls.errors.GNUTLSError, error:
1161
logger.warning(u"Handshake failed: %s", error)
1721
1162
# Do not run session.bye() here: the session is not
1722
1163
# established. Just abandon the request.
1723
1164
return
1724
logger.debug("Handshake succeeded")
1725
1165
logger.debug(u"Handshake succeeded")
1166
1726
1167
approval_required = False
1727
1168
try:
1728
1169
try:
1729
1170
fpr = self.fingerprint(self.peer_certificate
1730
1171
(session))
1731
except (TypeError,
1732
gnutls.errors.GNUTLSError) as error:
1733
logger.warning("Bad certificate: %s", error)
1172
except (TypeError, gnutls.errors.GNUTLSError), error:
1173
logger.warning(u"Bad certificate: %s", error)
1734
1174
return
1735
logger.debug("Fingerprint: %s", fpr)
1736
1175
logger.debug(u"Fingerprint: %s", fpr)
1176
1737
1177
try:
1738
1178
client = ProxyClient(child_pipe, fpr,
1739
1179
self.client_address)
1740
1180
except KeyError:
1741
1181
return
1742
1182
1743
if client.approval_delay:
1744
delay = client.approval_delay
1183
if client.approved_delay:
1184
delay = client.approved_delay
1745
1185
client.approvals_pending += 1
1746
1186
approval_required = True
1747
1187
1748
1188
while True:
1749
1189
if not client.enabled:
1750
logger.info("Client %s is disabled",
1190
logger.warning(u"Client %s is disabled",
1751
1191
client.name)
1752
1192
if self.server.use_dbus:
1753
1193
# Emit D-Bus signal
1754
client.Rejected("Disabled")
1194
client.Rejected("Disabled")
1755
1195
return
1756
1196
1757
if client.approved or not client.approval_delay:
1197
if client._approved or not client.approved_delay:
1758
1198
#We are approved or approval is disabled
1759
1199
break
1760
elif client.approved is None:
1761
logger.info("Client %s needs approval",
1200
elif client._approved is None:
1201
logger.info(u"Client %s need approval",
1762
1202
client.name)
1763
1203
if self.server.use_dbus:
1764
1204
# Emit D-Bus signal
1765
1205
client.NeedApproval(
1766
client.approval_delay.total_seconds()
1767
* 1000, client.approved_by_default)
1206
client.approved_delay_milliseconds(),
1207
client.approved_by_default)
1768
1208
else:
1769
logger.warning("Client %s was not approved",
1209
logger.warning(u"Client %s was not approved",
1770
1210
client.name)
1771
1211
if self.server.use_dbus:
1772
1212
# Emit D-Bus signal
1773
client.Rejected("Denied")
1213
client.Rejected("Disapproved")
1774
1214
return
1775
1215
1776
1216
#wait until timeout or approved
1217
#x = float(client._timedelta_to_milliseconds(delay))
1777
1218
time = datetime.datetime.now()
1778
1219
client.changedstate.acquire()
1779
client.changedstate.wait(delay.total_seconds())
1220
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1780
1221
client.changedstate.release()
1781
1222
time2 = datetime.datetime.now()
1782
1223
if (time2 - time) >= delay:
1797
1238
while sent_size < len(client.secret):
1798
1239
try:
1799
1240
sent = session.send(client.secret[sent_size:])
1800
except gnutls.errors.GNUTLSError as error:
1801
logger.warning("gnutls send failed",
1802
exc_info=error)
1241
except (gnutls.errors.GNUTLSError), error:
1242
logger.warning("gnutls send failed")
1803
1243
return
1804
logger.debug("Sent: %d, remaining: %d",
1244
logger.debug(u"Sent: %d, remaining: %d",
1805
1245
sent, len(client.secret)
1806
1246
- (sent_size + sent))
1807
1247
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)
1248
1249
logger.info(u"Sending secret to %s", client.name)
1250
# bump the timeout as if seen
1251
client.checked_ok()
1812
1252
if self.server.use_dbus:
1813
1253
# Emit D-Bus signal
1814
1254
client.GotSecret()
1818
1258
client.approvals_pending -= 1
1819
1259
try:
1820
1260
session.bye()
1821
except gnutls.errors.GNUTLSError as error:
1822
logger.warning("GnuTLS bye failed",
1823
exc_info=error)
1261
except (gnutls.errors.GNUTLSError), error:
1262
logger.warning("gnutls bye failed")
1824
1263
1825
1264
@staticmethod
1826
1265
def peer_certificate(session):
1836
1275
.gnutls_certificate_get_peers
1837
1276
(session._c_object, ctypes.byref(list_size)))
1838
1277
if not bool(cert_list) and list_size.value != 0:
1839
raise gnutls.errors.GNUTLSError("error getting peer"
1840
" certificate")
1278
raise gnutls.errors.GNUTLSError(u"error getting peer"
1279
u" certificate")
1841
1280
if list_size.value == 0:
1842
1281
return None
1843
1282
cert = cert_list[0]
1869
1308
if crtverify.value != 0:
1870
1309
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1871
1310
raise (gnutls.errors.CertificateSecurityError
1872
("Verify failed"))
1311
(u"Verify failed"))
1873
1312
# New buffer for the fingerprint
1874
1313
buf = ctypes.create_string_buffer(20)
1875
1314
buf_len = ctypes.c_size_t()
1882
1321
# Convert the buffer to a Python bytestring
1883
1322
fpr = ctypes.string_at(buf, buf_len.value)
1884
1323
# Convert the bytestring to hexadecimal notation
1885
hex_fpr = binascii.hexlify(fpr).upper()
1324
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1886
1325
return hex_fpr
1887
1326
1888
1327
1891
1330
def sub_process_main(self, request, address):
1892
1331
try:
1893
1332
self.finish_request(request, address)
1894
except Exception:
1333
except:
1895
1334
self.handle_error(request, address)
1896
1335
self.close_request(request)
1897
1336
1898
1337
def process_request(self, request, address):
1899
1338
"""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
1339
multiprocessing.Process(target = self.sub_process_main,
1340
args = (request, address)).start()
1905
1341
1906
1342
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1907
1343
""" adds a pipe to the MixIn """
1911
1347
This function creates a new pipe in self.pipe
1912
1348
"""
1913
1349
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1914
1915
proc = MultiprocessingMixIn.process_request(self, request,
1916
client_address)
1350
1351
super(MultiprocessingMixInWithPipe,
1352
self).process_request(request, client_address)
1917
1353
self.child_pipe.close()
1918
self.add_pipe(parent_pipe, proc)
1919
1920
def add_pipe(self, parent_pipe, proc):
1354
self.add_pipe(parent_pipe)
1355
1356
def add_pipe(self, parent_pipe):
1921
1357
"""Dummy function; override as necessary"""
1922
raise NotImplementedError()
1923
1358
pass
1924
1359
1925
1360
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1926
1361
socketserver.TCPServer, object):
1932
1367
use_ipv6: Boolean; to use IPv6 or not
1933
1368
"""
1934
1369
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
"""
1370
interface=None, use_ipv6=True):
1939
1371
self.interface = interface
1940
1372
if use_ipv6:
1941
1373
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
1374
socketserver.TCPServer.__init__(self, server_address,
1969
1375
RequestHandlerClass)
1970
1971
1376
def server_bind(self):
1972
1377
"""This overrides the normal server_bind() function
1973
1378
to bind to an interface if one was specified, and also NOT to
1974
1379
bind to an address or port if they were not specified."""
1975
1380
if self.interface is not None:
1976
1381
if SO_BINDTODEVICE is None:
1977
logger.error("SO_BINDTODEVICE does not exist;"
1978
" cannot bind to interface %s",
1382
logger.error(u"SO_BINDTODEVICE does not exist;"
1383
u" cannot bind to interface %s",
1979
1384
self.interface)
1980
1385
else:
1981
1386
try:
1982
1387
self.socket.setsockopt(socket.SOL_SOCKET,
1983
1388
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)
1389
str(self.interface
1390
+ u'\0'))
1391
except socket.error, error:
1392
if error[0] == errno.EPERM:
1393
logger.error(u"No permission to"
1394
u" bind to interface %s",
1395
self.interface)
1396
elif error[0] == errno.ENOPROTOOPT:
1397
logger.error(u"SO_BINDTODEVICE not available;"
1398
u" cannot bind to interface %s",
1399
self.interface)
1997
1400
else:
1998
1401
raise
1999
1402
# Only bind(2) the socket if we really need to.
2000
1403
if self.server_address[0] or self.server_address[1]:
2001
1404
if not self.server_address[0]:
2002
1405
if self.address_family == socket.AF_INET6:
2003
any_address = "::" # in6addr_any
1406
any_address = u"::" # in6addr_any
2004
1407
else:
2005
any_address = "0.0.0.0" # INADDR_ANY
1408
any_address = socket.INADDR_ANY
2006
1409
self.server_address = (any_address,
2007
1410
self.server_address[1])
2008
1411
elif not self.server_address[1]:
2029
1432
"""
2030
1433
def __init__(self, server_address, RequestHandlerClass,
2031
1434
interface=None, use_ipv6=True, clients=None,
2032
gnutls_priority=None, use_dbus=True, socketfd=None):
1435
gnutls_priority=None, use_dbus=True):
2033
1436
self.enabled = False
2034
1437
self.clients = clients
2035
1438
if self.clients is None:
2036
self.clients = {}
1439
self.clients = set()
2037
1440
self.use_dbus = use_dbus
2038
1441
self.gnutls_priority = gnutls_priority
2039
1442
IPv6_TCPServer.__init__(self, server_address,
2040
1443
RequestHandlerClass,
2041
1444
interface = interface,
2042
use_ipv6 = use_ipv6,
2043
socketfd = socketfd)
1445
use_ipv6 = use_ipv6)
2044
1446
def server_activate(self):
2045
1447
if self.enabled:
2046
1448
return socketserver.TCPServer.server_activate(self)
2047
2048
1449
def enable(self):
2049
1450
self.enabled = True
2050
2051
def add_pipe(self, parent_pipe, proc):
1451
def add_pipe(self, parent_pipe):
2052
1452
# Call "handle_ipc" for both data and EOF events
2053
1453
gobject.io_add_watch(parent_pipe.fileno(),
2054
1454
gobject.IO_IN | gobject.IO_HUP,
2055
1455
functools.partial(self.handle_ipc,
2056
parent_pipe =
2057
parent_pipe,
2058
proc = proc))
2059
1456
parent_pipe = parent_pipe))
1457
2060
1458
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()
1459
client_object=None):
1460
condition_names = {
1461
gobject.IO_IN: u"IN", # There is data to read.
1462
gobject.IO_OUT: u"OUT", # Data can be written (without
1463
# blocking).
1464
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1465
gobject.IO_ERR: u"ERR", # Error condition.
1466
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1467
# broken, usually for pipes and
1468
# sockets).
1469
}
1470
conditions_string = ' | '.join(name
1471
for cond, name in
1472
condition_names.iteritems()
1473
if cond & condition)
1474
# error or the other end of multiprocessing.Pipe has closed
1475
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2066
1476
return False
2067
1477
2068
1478
# Read a request from the child
2073
1483
fpr = request[1]
2074
1484
address = request[2]
2075
1485
2076
for c in self.clients.itervalues():
1486
for c in self.clients:
2077
1487
if c.fingerprint == fpr:
2078
1488
client = c
2079
1489
break
2080
1490
else:
2081
logger.info("Client not found for fingerprint: %s, ad"
2082
"dress: %s", fpr, address)
1491
logger.warning(u"Client not found for fingerprint: %s, ad"
1492
u"dress: %s", fpr, address)
2083
1493
if self.use_dbus:
2084
1494
# Emit D-Bus signal
2085
mandos_dbus_service.ClientNotFound(fpr,
2086
address[0])
1495
mandos_dbus_service.ClientNotFound(fpr, address)
2087
1496
parent_pipe.send(False)
2088
1497
return False
2089
1498
2090
1499
gobject.io_add_watch(parent_pipe.fileno(),
2091
1500
gobject.IO_IN | gobject.IO_HUP,
2092
1501
functools.partial(self.handle_ipc,
2093
parent_pipe =
2094
parent_pipe,
2095
proc = proc,
2096
client_object =
2097
client))
1502
parent_pipe = parent_pipe,
1503
client_object = client))
2098
1504
parent_pipe.send(True)
2099
# remove the old hook in favor of the new above hook on
2100
# same fileno
1505
# remove the old hook in favor of the new above hook on same fileno
2101
1506
return False
2102
1507
if command == 'funcall':
2103
1508
funcname = request[1]
2104
1509
args = request[2]
2105
1510
kwargs = request[3]
2106
1511
2107
parent_pipe.send(('data', getattr(client_object,
2108
funcname)(*args,
2109
**kwargs)))
2110
1512
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1513
2111
1514
if command == 'getattr':
2112
1515
attrname = request[1]
2113
1516
if callable(client_object.__getattribute__(attrname)):
2114
1517
parent_pipe.send(('function',))
2115
1518
else:
2116
parent_pipe.send(('data', client_object
2117
.__getattribute__(attrname)))
1519
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2118
1520
2119
1521
if command == 'setattr':
2120
1522
attrname = request[1]
2121
1523
value = request[2]
2122
1524
setattr(client_object, attrname, value)
2123
1525
2124
1526
return True
2125
1527
2126
1528
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
1529
def string_to_delta(interval):
2227
1530
"""Parse a string and return a datetime.timedelta
2228
1531
2229
>>> string_to_delta('7d')
1532
>>> string_to_delta(u'7d')
2230
1533
datetime.timedelta(7)
2231
>>> string_to_delta('60s')
1534
>>> string_to_delta(u'60s')
2232
1535
datetime.timedelta(0, 60)
2233
>>> string_to_delta('60m')
1536
>>> string_to_delta(u'60m')
2234
1537
datetime.timedelta(0, 3600)
2235
>>> string_to_delta('24h')
1538
>>> string_to_delta(u'24h')
2236
1539
datetime.timedelta(1)
2237
>>> string_to_delta('1w')
1540
>>> string_to_delta(u'1w')
2238
1541
datetime.timedelta(7)
2239
>>> string_to_delta('5m 30s')
1542
>>> string_to_delta(u'5m 30s')
2240
1543
datetime.timedelta(0, 330)
2241
1544
"""
2242
2243
try:
2244
return rfc3339_duration_to_delta(interval)
2245
except ValueError:
2246
pass
2247
2248
1545
timevalue = datetime.timedelta(0)
2249
1546
for s in interval.split():
2250
1547
try:
2251
suffix = s[-1]
1548
suffix = unicode(s[-1])
2252
1549
value = int(s[:-1])
2253
if suffix == "d":
1550
if suffix == u"d":
2254
1551
delta = datetime.timedelta(value)
2255
elif suffix == "s":
1552
elif suffix == u"s":
2256
1553
delta = datetime.timedelta(0, value)
2257
elif suffix == "m":
1554
elif suffix == u"m":
2258
1555
delta = datetime.timedelta(0, 0, 0, 0, value)
2259
elif suffix == "h":
1556
elif suffix == u"h":
2260
1557
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2261
elif suffix == "w":
1558
elif suffix == u"w":
2262
1559
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2263
1560
else:
2264
raise ValueError("Unknown suffix {!r}"
2265
.format(suffix))
2266
except IndexError as e:
2267
raise ValueError(*(e.args))
1561
raise ValueError(u"Unknown suffix %r" % suffix)
1562
except (ValueError, IndexError), e:
1563
raise ValueError(e.message)
2268
1564
timevalue += delta
2269
1565
return timevalue
2270
1566
2271
1567
1568
def if_nametoindex(interface):
1569
"""Call the C function if_nametoindex(), or equivalent
1570
1571
Note: This function cannot accept a unicode string."""
1572
global if_nametoindex
1573
try:
1574
if_nametoindex = (ctypes.cdll.LoadLibrary
1575
(ctypes.util.find_library(u"c"))
1576
.if_nametoindex)
1577
except (OSError, AttributeError):
1578
logger.warning(u"Doing if_nametoindex the hard way")
1579
def if_nametoindex(interface):
1580
"Get an interface index the hard way, i.e. using fcntl()"
1581
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1582
with contextlib.closing(socket.socket()) as s:
1583
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1584
struct.pack(str(u"16s16x"),
1585
interface))
1586
interface_index = struct.unpack(str(u"I"),
1587
ifreq[16:20])[0]
1588
return interface_index
1589
return if_nametoindex(interface)
1590
1591
2272
1592
def daemon(nochdir = False, noclose = False):
2273
1593
"""See daemon(3). Standard BSD Unix function.
2274
1594
2277
1597
sys.exit()
2278
1598
os.setsid()
2279
1599
if not nochdir:
2280
os.chdir("/")
1600
os.chdir(u"/")
2281
1601
if os.fork():
2282
1602
sys.exit()
2283
1603
if not noclose:
2284
1604
# Close all standard open file descriptors
2285
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1605
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2286
1606
if not stat.S_ISCHR(os.fstat(null).st_mode):
2287
raise OSError(errno.ENODEV, "{} not a character device"
2288
.format(os.devnull))
1607
raise OSError(errno.ENODEV,
1608
u"%s not a character device"
1609
% os.path.devnull)
2289
1610
os.dup2(null, sys.stdin.fileno())
2290
1611
os.dup2(null, sys.stdout.fileno())
2291
1612
os.dup2(null, sys.stderr.fileno())
2298
1619
##################################################################
2299
1620
# Parsing of options, both command line and config file
2300
1621
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()
1622
parser = optparse.OptionParser(version = "%%prog %s" % version)
1623
parser.add_option("-i", u"--interface", type=u"string",
1624
metavar="IF", help=u"Bind to interface IF")
1625
parser.add_option("-a", u"--address", type=u"string",
1626
help=u"Address to listen for requests on")
1627
parser.add_option("-p", u"--port", type=u"int",
1628
help=u"Port number to receive requests on")
1629
parser.add_option("--check", action=u"store_true",
1630
help=u"Run self-test")
1631
parser.add_option("--debug", action=u"store_true",
1632
help=u"Debug mode; run in foreground and log to"
1633
u" terminal")
1634
parser.add_option("--debuglevel", type=u"string", metavar="Level",
1635
help=u"Debug level for stdout output")
1636
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1637
u" priority string (see GnuTLS documentation)")
1638
parser.add_option("--servicename", type=u"string",
1639
metavar=u"NAME", help=u"Zeroconf service name")
1640
parser.add_option("--configdir", type=u"string",
1641
default=u"/etc/mandos", metavar=u"DIR",
1642
help=u"Directory to search for configuration"
1643
u" files")
1644
parser.add_option("--no-dbus", action=u"store_false",
1645
dest=u"use_dbus", help=u"Do not provide D-Bus"
1646
u" system bus interface")
1647
parser.add_option("--no-ipv6", action=u"store_false",
1648
dest=u"use_ipv6", help=u"Do not use IPv6")
1649
options = parser.parse_args()[0]
2347
1650
2348
1651
if options.check:
2349
1652
import doctest
2350
fail_count, test_count = doctest.testmod()
2351
sys.exit(os.EX_OK if fail_count == 0 else 1)
1653
doctest.testmod()
1654
sys.exit()
2352
1655
2353
1656
# 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",
1657
server_defaults = { u"interface": u"",
1658
u"address": u"",
1659
u"port": u"",
1660
u"debug": u"False",
1661
u"priority":
1662
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1663
u"servicename": u"Mandos",
1664
u"use_dbus": u"True",
1665
u"use_ipv6": u"True",
1666
u"debuglevel": u"",
2369
1667
}
2370
1668
2371
1669
# Parse config file for server-global settings
2372
1670
server_config = configparser.SafeConfigParser(server_defaults)
2373
1671
del server_defaults
2374
1672
server_config.read(os.path.join(options.configdir,
2375
"mandos.conf"))
1673
u"mandos.conf"))
2376
1674
# Convert the SafeConfigParser object to a dict
2377
1675
server_settings = server_config.defaults()
2378
1676
# 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",
1677
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1678
server_settings[option] = server_config.getboolean(u"DEFAULT",
2381
1679
option)
2382
1680
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"])
1681
server_settings["port"] = server_config.getint(u"DEFAULT",
1682
u"port")
2394
1683
del server_config
2395
1684
2396
1685
# Override the settings from the config file with command line
2397
1686
# 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"):
1687
for option in (u"interface", u"address", u"port", u"debug",
1688
u"priority", u"servicename", u"configdir",
1689
u"use_dbus", u"use_ipv6", u"debuglevel"):
2402
1690
value = getattr(options, option)
2403
1691
if value is not None:
2404
1692
server_settings[option] = value
2405
1693
del options
2406
1694
# Force all strings to be unicode
2407
1695
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
1696
if type(server_settings[option]) is str:
1697
server_settings[option] = unicode(server_settings[option])
2418
1698
# Now we have our good server settings in "server_settings"
2419
1699
2420
1700
##################################################################
2421
1701
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
1702
# 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":
1703
debug = server_settings[u"debug"]
1704
debuglevel = server_settings[u"debuglevel"]
1705
use_dbus = server_settings[u"use_dbus"]
1706
use_ipv6 = server_settings[u"use_ipv6"]
1707
1708
if server_settings[u"servicename"] != u"Mandos":
2448
1709
syslogger.setFormatter(logging.Formatter
2449
('Mandos ({}) [%(process)d]:'
2450
' %(levelname)s: %(message)s'
2451
.format(server_settings
2452
["servicename"])))
1710
(u'Mandos (%s) [%%(process)d]:'
1711
u' %%(levelname)s: %%(message)s'
1712
% server_settings[u"servicename"]))
2453
1713
2454
1714
# 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"))
1715
client_defaults = { u"timeout": u"1h",
1716
u"interval": u"5m",
1717
u"checker": u"fping -q -- %%(host)s",
1718
u"host": u"",
1719
u"approved_delay": u"0s",
1720
u"approved_duration": u"1s",
1721
}
1722
client_config = configparser.SafeConfigParser(client_defaults)
1723
client_config.read(os.path.join(server_settings[u"configdir"],
1724
u"clients.conf"))
2459
1725
2460
1726
global mandos_dbus_service
2461
1727
mandos_dbus_service = None
2462
1728
2463
socketfd = None
2464
if server_settings["socket"] != "":
2465
socketfd = server_settings["socket"]
2466
tcp_server = MandosServer((server_settings["address"],
2467
server_settings["port"]),
1729
tcp_server = MandosServer((server_settings[u"address"],
1730
server_settings[u"port"]),
2468
1731
ClientHandler,
2469
interface=(server_settings["interface"]
1732
interface=(server_settings[u"interface"]
2470
1733
or None),
2471
1734
use_ipv6=use_ipv6,
2472
1735
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
2481
try:
2482
pidfile = open(pidfilename, "w")
2483
except IOError as e:
2484
logger.error("Could not open file %r", pidfilename,
2485
exc_info=e)
1736
server_settings[u"priority"],
1737
use_dbus=use_dbus)
1738
pidfilename = u"/var/run/mandos.pid"
1739
try:
1740
pidfile = open(pidfilename, u"w")
1741
except IOError:
1742
logger.error(u"Could not open file %r", pidfilename)
2486
1743
2487
for name in ("_mandos", "mandos", "nobody"):
1744
try:
1745
uid = pwd.getpwnam(u"_mandos").pw_uid
1746
gid = pwd.getpwnam(u"_mandos").pw_gid
1747
except KeyError:
2488
1748
try:
2489
uid = pwd.getpwnam(name).pw_uid
2490
gid = pwd.getpwnam(name).pw_gid
2491
break
1749
uid = pwd.getpwnam(u"mandos").pw_uid
1750
gid = pwd.getpwnam(u"mandos").pw_gid
2492
1751
except KeyError:
2493
continue
2494
else:
2495
uid = 65534
2496
gid = 65534
1752
try:
1753
uid = pwd.getpwnam(u"nobody").pw_uid
1754
gid = pwd.getpwnam(u"nobody").pw_gid
1755
except KeyError:
1756
uid = 65534
1757
gid = 65534
2497
1758
try:
2498
1759
os.setgid(gid)
2499
1760
os.setuid(uid)
2500
except OSError as error:
2501
if error.errno != errno.EPERM:
2502
raise
1761
except OSError, error:
1762
if error[0] != errno.EPERM:
1763
raise error
2503
1764
1765
# Enable all possible GnuTLS debugging
1766
1767
1768
if not debug and not debuglevel:
1769
syslogger.setLevel(logging.WARNING)
1770
console.setLevel(logging.WARNING)
1771
if debuglevel:
1772
level = getattr(logging, debuglevel.upper())
1773
syslogger.setLevel(level)
1774
console.setLevel(level)
1775
2504
1776
if debug:
2505
# Enable all possible GnuTLS debugging
2506
2507
1777
# "Use a log level over 10 to enable all debugging options."
2508
1778
# - GnuTLS manual
2509
1779
gnutls.library.functions.gnutls_global_set_log_level(11)
2510
1780
2511
1781
@gnutls.library.types.gnutls_log_func
2512
1782
def debug_gnutls(level, string):
2513
logger.debug("GnuTLS: %s", string[:-1])
1783
logger.debug(u"GnuTLS: %s", string[:-1])
2514
1784
2515
1785
(gnutls.library.functions
2516
1786
.gnutls_global_set_log_function(debug_gnutls))
2517
1787
2518
1788
# Redirect stdin so all checkers get /dev/null
2519
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1789
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2520
1790
os.dup2(null, sys.stdin.fileno())
2521
1791
if null > 2:
2522
1792
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()
1793
else:
1794
# No console logging
1795
logger.removeHandler(console)
1796
2532
1797
2533
1798
global main_loop
2534
1799
# From the Avahi example code
2535
DBusGMainLoop(set_as_default=True)
1800
DBusGMainLoop(set_as_default=True )
2536
1801
main_loop = gobject.MainLoop()
2537
1802
bus = dbus.SystemBus()
2538
1803
# End of Avahi example code
2539
1804
if use_dbus:
2540
1805
try:
2541
bus_name = dbus.service.BusName("se.recompile.Mandos",
1806
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
2542
1807
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)
1808
except dbus.exceptions.NameExistsException, e:
1809
logger.error(unicode(e) + u", disabling D-Bus")
2548
1810
use_dbus = False
2549
server_settings["use_dbus"] = False
1811
server_settings[u"use_dbus"] = False
2550
1812
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
1813
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1814
service = AvahiService(name = server_settings[u"servicename"],
1815
servicetype = u"_mandos._tcp",
1816
protocol = protocol, bus = bus)
1817
if server_settings["interface"]:
1818
service.interface = (if_nametoindex
1819
(str(server_settings[u"interface"])))
1820
1821
if not debug:
1822
# Close all input and output, do double fork, etc.
1823
daemon()
1824
2562
1825
global multiprocessing_manager
2563
1826
multiprocessing_manager = multiprocessing.Manager()
2564
1827
2565
1828
client_class = Client
2566
1829
if use_dbus:
2567
1830
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))
1831
def client_config_items(config, section):
1832
special_settings = {
1833
"approved_by_default":
1834
lambda: config.getboolean(section,
1835
"approved_by_default"),
1836
}
1837
for name, value in config.items(section):
2650
1838
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
1839
yield (name, special_settings[name]())
1840
except KeyError:
1841
yield (name, value)
1842
1843
tcp_server.clients.update(set(
1844
client_class(name = section,
1845
config= dict(client_config_items(
1846
client_config, section)))
1847
for section in client_config.sections()))
2676
1848
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)
1849
logger.warning(u"No clients defined")
1850
1851
try:
1852
with pidfile:
1853
pid = os.getpid()
1854
pidfile.write(str(pid) + "\n")
2688
1855
del pidfile
2689
del pidfilename
1856
except IOError:
1857
logger.error(u"Could not write to file %r with PID %d",
1858
pidfilename, pid)
1859
except NameError:
1860
# "pidfile" was never created
1861
pass
1862
del pidfilename
2690
1863
1864
if not debug:
1865
signal.signal(signal.SIGINT, signal.SIG_IGN)
2691
1866
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2692
1867
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2693
1868
2694
1869
if use_dbus:
2695
@alternate_dbus_interfaces({"se.recompile.Mandos":
2696
"se.bsnet.fukt.Mandos"})
2697
class MandosDBusService(DBusObjectWithProperties):
1870
class MandosDBusService(dbus.service.Object):
2698
1871
"""A D-Bus proxy object"""
2699
1872
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")
1873
dbus.service.Object.__init__(self, bus, u"/")
1874
_interface = u"se.bsnet.fukt.Mandos"
1875
1876
@dbus.service.signal(_interface, signature=u"o")
2710
1877
def ClientAdded(self, objpath):
2711
1878
"D-Bus signal"
2712
1879
pass
2713
1880
2714
@dbus.service.signal(_interface, signature="ss")
1881
@dbus.service.signal(_interface, signature=u"ss")
2715
1882
def ClientNotFound(self, fingerprint, address):
2716
1883
"D-Bus signal"
2717
1884
pass
2718
1885
2719
@dbus.service.signal(_interface, signature="os")
1886
@dbus.service.signal(_interface, signature=u"os")
2720
1887
def ClientRemoved(self, objpath, name):
2721
1888
"D-Bus signal"
2722
1889
pass
2723
1890
2724
@dbus.service.method(_interface, out_signature="ao")
1891
@dbus.service.method(_interface, out_signature=u"ao")
2725
1892
def GetAllClients(self):
2726
1893
"D-Bus method"
2727
1894
return dbus.Array(c.dbus_object_path
2728
for c in
2729
tcp_server.clients.itervalues())
1895
for c in tcp_server.clients)
2730
1896
2731
1897
@dbus.service.method(_interface,
2732
out_signature="a{oa{sv}}")
1898
out_signature=u"a{oa{sv}}")
2733
1899
def GetAllClientsWithProperties(self):
2734
1900
"D-Bus method"
2735
1901
return dbus.Dictionary(
2736
{ c.dbus_object_path: c.GetAll("")
2737
for c in tcp_server.clients.itervalues() },
2738
signature="oa{sv}")
1902
((c.dbus_object_path, c.GetAll(u""))
1903
for c in tcp_server.clients),
1904
signature=u"oa{sv}")
2739
1905
2740
@dbus.service.method(_interface, in_signature="o")
1906
@dbus.service.method(_interface, in_signature=u"o")
2741
1907
def RemoveClient(self, object_path):
2742
1908
"D-Bus method"
2743
for c in tcp_server.clients.itervalues():
1909
for c in tcp_server.clients:
2744
1910
if c.dbus_object_path == object_path:
2745
del tcp_server.clients[c.name]
1911
tcp_server.clients.remove(c)
2746
1912
c.remove_from_connection()
2747
1913
# Don't signal anything except ClientRemoved
2748
1914
c.disable(quiet=True)
2757
1923
2758
1924
def cleanup():
2759
1925
"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
1926
service.cleanup()
1927
2819
1928
while tcp_server.clients:
2820
name, client = tcp_server.clients.popitem()
1929
client = tcp_server.clients.pop()
2821
1930
if use_dbus:
2822
1931
client.remove_from_connection()
1932
client.disable_hook = None
2823
1933
# Don't signal anything except ClientRemoved
2824
1934
client.disable(quiet=True)
2825
1935
if use_dbus:
2826
1936
# Emit D-Bus signal
2827
mandos_dbus_service.ClientRemoved(client
2828
.dbus_object_path,
1937
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2829
1938
client.name)
2830
client_settings.clear()
2831
1939
2832
1940
atexit.register(cleanup)
2833
1941
2834
for client in tcp_server.clients.itervalues():
1942
for client in tcp_server.clients:
2835
1943
if use_dbus:
2836
1944
# Emit D-Bus signal
2837
1945
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2838
# Need to initiate checking of clients
2839
if client.enabled:
2840
client.init_checker()
1946
client.enable()
2841
1947
2842
1948
tcp_server.enable()
2843
1949
tcp_server.server_activate()
2844
1950
2845
1951
# Find out what port we got
2846
if zeroconf:
2847
service.port = tcp_server.socket.getsockname()[1]
1952
service.port = tcp_server.socket.getsockname()[1]
2848
1953
if use_ipv6:
2849
logger.info("Now listening on address %r, port %d,"
2850
" flowinfo %d, scope_id %d",
2851
*tcp_server.socket.getsockname())
1954
logger.info(u"Now listening on address %r, port %d,"
1955
" flowinfo %d, scope_id %d"
1956
% tcp_server.socket.getsockname())
2852
1957
else: # IPv4
2853
logger.info("Now listening on address %r, port %d",
2854
*tcp_server.socket.getsockname())
1958
logger.info(u"Now listening on address %r, port %d"
1959
% tcp_server.socket.getsockname())
2855
1960
2856
1961
#service.interface = tcp_server.socket.getsockname()[3]
2857
1962
2858
1963
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
1964
# From the Avahi example code
1965
try:
1966
service.activate()
1967
except dbus.exceptions.DBusException, error:
1968
logger.critical(u"DBusException: %s", error)
1969
cleanup()
1970
sys.exit(1)
1971
# End of Avahi example code
2868
1972
2869
1973
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2870
1974
lambda *args, **kwargs:
2871
1975
(tcp_server.handle_request
2872
1976
(*args[2:], **kwargs) or True))
2873
1977
2874
logger.debug("Starting main loop")
1978
logger.debug(u"Starting main loop")
2875
1979
main_loop.run()
2876
except AvahiError as error:
2877
logger.critical("Avahi Error", exc_info=error)
1980
except AvahiError, error:
1981
logger.critical(u"AvahiError: %s", error)
2878
1982
cleanup()
2879
1983
sys.exit(1)
2880
1984
except KeyboardInterrupt:
2881
1985
if debug:
2882
print("", file=sys.stderr)
2883
logger.debug("Server received KeyboardInterrupt")
2884
logger.debug("Server exiting")
1986
print >> sys.stderr
1987
logger.debug(u"Server received KeyboardInterrupt")
1988
logger.debug(u"Server exiting")
2885
1989
# Must run before the D-Bus bus name gets deregistered
2886
1990
cleanup()
2887
1991
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0