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