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