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