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