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