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