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