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 728
- compare with another revision
- download diff
- download tarball
- view history from revision 728
- Committer: Teddy Hogeborn
- Date: 2014-08-06 21:45:09 UTC
- mfrom: (237.4.53 release)
- Revision ID: teddy@recompile.se-20140806214509-d6sprf3gnmahcfax
Merge from release branch.
- files added:
- debian/mandos-client.examples
- debian/upstream
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos
1
#!/usr/bin/python
1
#!/usr/bin/python2.7
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-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
65
67
import types
66
68
import binascii
67
69
import tempfile
70
import itertools
71
import collections
68
72
69
73
import dbus
70
74
import dbus.service
75
79
import ctypes.util
76
80
import xml.dom.minidom
77
81
import inspect
78
import GnuPGInterface
79
82
80
83
try:
81
84
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
88
except ImportError:
86
89
SO_BINDTODEVICE = None
87
90
88
89
version = "1.4.1"
91
version = "1.6.8"
90
92
stored_state_file = "clients.pickle"
91
93
92
94
logger = logging.getLogger()
93
syslogger = (logging.handlers.SysLogHandler
94
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
address = str("/dev/log")))
95
syslogger = None
96
96
97
97
try:
98
98
if_nametoindex = (ctypes.cdll.LoadLibrary
111
111
return interface_index
112
112
113
113
114
def initlogger(level=logging.WARNING):
114
def initlogger(debug, level=logging.WARNING):
115
115
"""init logger and add loglevel"""
116
116
117
global syslogger
118
syslogger = (logging.handlers.SysLogHandler
119
(facility =
120
logging.handlers.SysLogHandler.LOG_DAEMON,
121
address = str("/dev/log")))
117
122
syslogger.setFormatter(logging.Formatter
118
123
('Mandos [%(process)d]: %(levelname)s:'
119
124
' %(message)s'))
120
125
logger.addHandler(syslogger)
121
126
122
console = logging.StreamHandler()
123
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
124
' [%(process)d]:'
125
' %(levelname)s:'
126
' %(message)s'))
127
logger.addHandler(console)
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)
128
134
logger.setLevel(level)
129
135
130
136
136
142
class PGPEngine(object):
137
143
"""A simple class for OpenPGP symmetric encryption & decryption"""
138
144
def __init__(self):
139
self.gnupg = GnuPGInterface.GnuPG()
140
145
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
141
self.gnupg = GnuPGInterface.GnuPG()
142
self.gnupg.options.meta_interactive = False
143
self.gnupg.options.homedir = self.tempdir
144
self.gnupg.options.extra_args.extend(['--force-mdc',
145
'--quiet'])
146
self.gnupgargs = ['--batch',
147
'--home', self.tempdir,
148
'--force-mdc',
149
'--quiet',
150
'--no-use-agent']
146
151
147
152
def __enter__(self):
148
153
return self
149
154
150
def __exit__ (self, exc_type, exc_value, traceback):
155
def __exit__(self, exc_type, exc_value, traceback):
151
156
self._cleanup()
152
157
return False
153
158
170
175
def password_encode(self, password):
171
176
# Passphrase can not be empty and can not contain newlines or
172
177
# NUL bytes. So we prefix it and hex encode it.
173
return b"mandos" + binascii.hexlify(password)
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
174
185
175
186
def encrypt(self, data, password):
176
self.gnupg.passphrase = self.password_encode(password)
177
with open(os.devnull) as devnull:
178
try:
179
proc = self.gnupg.run(['--symmetric'],
180
create_fhs=['stdin', 'stdout'],
181
attach_fhs={'stderr': devnull})
182
with contextlib.closing(proc.handles['stdin']) as f:
183
f.write(data)
184
with contextlib.closing(proc.handles['stdout']) as f:
185
ciphertext = f.read()
186
proc.wait()
187
except IOError as e:
188
raise PGPError(e)
189
self.gnupg.passphrase = None
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)
190
202
return ciphertext
191
203
192
204
def decrypt(self, data, password):
193
self.gnupg.passphrase = self.password_encode(password)
194
with open(os.devnull) as devnull:
195
try:
196
proc = self.gnupg.run(['--decrypt'],
197
create_fhs=['stdin', 'stdout'],
198
attach_fhs={'stderr': devnull})
199
with contextlib.closing(proc.handles['stdin'] ) as f:
200
f.write(data)
201
with contextlib.closing(proc.handles['stdout']) as f:
202
decrypted_plaintext = f.read()
203
proc.wait()
204
except IOError as e:
205
raise PGPError(e)
206
self.gnupg.passphrase = None
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)
207
221
return decrypted_plaintext
208
222
209
223
210
211
224
class AvahiError(Exception):
212
225
def __init__(self, value, *args, **kwargs):
213
226
self.value = value
230
243
Used to optionally bind to the specified interface.
231
244
name: string; Example: 'Mandos'
232
245
type: string; Example: '_mandos._tcp'.
233
See <http://www.dns-sd.org/ServiceTypes.html>
246
See <https://www.iana.org/assignments/service-names-port-numbers>
234
247
port: integer; what port to announce
235
248
TXT: list of strings; TXT record for the service
236
249
domain: string; Domain to publish on, default to .local if empty.
242
255
server: D-Bus Server
243
256
bus: dbus.SystemBus()
244
257
"""
258
245
259
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
246
260
servicetype = None, port = None, TXT = None,
247
261
domain = "", host = "", max_renames = 32768,
260
274
self.server = None
261
275
self.bus = bus
262
276
self.entry_group_state_changed_match = None
277
263
278
def rename(self):
264
279
"""Derived from the Avahi example code"""
265
280
if self.rename_count >= self.max_renames:
275
290
try:
276
291
self.add()
277
292
except dbus.exceptions.DBusException as error:
278
logger.critical("DBusException: %s", error)
293
logger.critical("D-Bus Exception", exc_info=error)
279
294
self.cleanup()
280
295
os._exit(1)
281
296
self.rename_count += 1
297
282
298
def remove(self):
283
299
"""Derived from the Avahi example code"""
284
300
if self.entry_group_state_changed_match is not None:
286
302
self.entry_group_state_changed_match = None
287
303
if self.group is not None:
288
304
self.group.Reset()
305
289
306
def add(self):
290
307
"""Derived from the Avahi example code"""
291
308
self.remove()
308
325
dbus.UInt16(self.port),
309
326
avahi.string_array_to_txt_array(self.TXT))
310
327
self.group.Commit()
328
311
329
def entry_group_state_changed(self, state, error):
312
330
"""Derived from the Avahi example code"""
313
331
logger.debug("Avahi entry group state change: %i", state)
320
338
elif state == avahi.ENTRY_GROUP_FAILURE:
321
339
logger.critical("Avahi: Error in group state changed %s",
322
340
unicode(error))
323
raise AvahiGroupError("State changed: %s"
324
% unicode(error))
341
raise AvahiGroupError("State changed: {!s}"
342
.format(error))
343
325
344
def cleanup(self):
326
345
"""Derived from the Avahi example code"""
327
346
if self.group is not None:
332
351
pass
333
352
self.group = None
334
353
self.remove()
354
335
355
def server_state_changed(self, state, error=None):
336
356
"""Derived from the Avahi example code"""
337
357
logger.debug("Avahi server state change: %i", state)
356
376
logger.debug("Unknown state: %r", state)
357
377
else:
358
378
logger.debug("Unknown state: %r: %r", state, error)
379
359
380
def activate(self):
360
381
"""Derived from the Avahi example code"""
361
382
if self.server is None:
368
389
self.server_state_changed)
369
390
self.server_state_changed(self.server.GetState())
370
391
392
371
393
class AvahiServiceToSyslog(AvahiService):
372
394
def rename(self):
373
395
"""Add the new name to the syslog messages"""
374
396
ret = AvahiService.rename(self)
375
397
syslogger.setFormatter(logging.Formatter
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
378
% self.name))
398
('Mandos ({}) [%(process)d]:'
399
' %(levelname)s: %(message)s'
400
.format(self.name)))
379
401
return ret
380
402
381
def timedelta_to_milliseconds(td):
382
"Convert a datetime.timedelta() to milliseconds"
383
return ((td.days * 24 * 60 * 60 * 1000)
384
+ (td.seconds * 1000)
385
+ (td.microseconds // 1000))
386
403
387
404
class Client(object):
388
405
"""A representation of a client host served by this server.
389
406
412
429
interval: datetime.timedelta(); How often to start a new checker
413
430
last_approval_request: datetime.datetime(); (UTC) or None
414
431
last_checked_ok: datetime.datetime(); (UTC) or None
415
416
432
last_checker_status: integer between 0 and 255 reflecting exit
417
433
status of last checker. -1 reflects crashed
418
checker, or None.
434
checker, -2 means no checker completed yet.
419
435
last_enabled: datetime.datetime(); (UTC) or None
420
436
name: string; from the config file, used in log messages and
421
437
D-Bus identifiers
422
438
secret: bytestring; sent verbatim (over TLS) to client
423
439
timeout: datetime.timedelta(); How long from last_checked_ok
424
440
until this client is disabled
425
extended_timeout: extra long timeout when password has been sent
441
extended_timeout: extra long timeout when secret has been sent
426
442
runtime_expansions: Allowed attributes for runtime expansion.
427
443
expires: datetime.datetime(); time (UTC) when a client will be
428
444
disabled, or None
445
server_settings: The server_settings dict from main()
429
446
"""
430
447
431
448
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
449
"created", "enabled", "expires",
450
"fingerprint", "host", "interval",
451
"last_approval_request", "last_checked_ok",
434
452
"last_enabled", "name", "timeout")
435
436
def timeout_milliseconds(self):
437
"Return the 'timeout' attribute in milliseconds"
438
return timedelta_to_milliseconds(self.timeout)
439
440
def extended_timeout_milliseconds(self):
441
"Return the 'extended_timeout' attribute in milliseconds"
442
return timedelta_to_milliseconds(self.extended_timeout)
443
444
def interval_milliseconds(self):
445
"Return the 'interval' attribute in milliseconds"
446
return timedelta_to_milliseconds(self.interval)
447
448
def approval_delay_milliseconds(self):
449
return timedelta_to_milliseconds(self.approval_delay)
450
451
def __init__(self, name = None, config=None):
452
"""Note: the 'checker' key in 'config' sets the
453
'checker_command' attribute and *not* the 'checker'
454
attribute."""
453
client_defaults = { "timeout": "PT5M",
454
"extended_timeout": "PT15M",
455
"interval": "PT2M",
456
"checker": "fping -q -- %%(host)s",
457
"host": "",
458
"approval_delay": "PT0S",
459
"approval_duration": "PT1S",
460
"approved_by_default": "True",
461
"enabled": "True",
462
}
463
464
@staticmethod
465
def config_parser(config):
466
"""Construct a new dict of client settings of this form:
467
{ client_name: {setting_name: value, ...}, ...}
468
with exceptions for any special settings as defined above.
469
NOTE: Must be a pure function. Must return the same result
470
value given the same arguments.
471
"""
472
settings = {}
473
for client_name in config.sections():
474
section = dict(config.items(client_name))
475
client = settings[client_name] = {}
476
477
client["host"] = section["host"]
478
# Reformat values from string types to Python types
479
client["approved_by_default"] = config.getboolean(
480
client_name, "approved_by_default")
481
client["enabled"] = config.getboolean(client_name,
482
"enabled")
483
484
client["fingerprint"] = (section["fingerprint"].upper()
485
.replace(" ", ""))
486
if "secret" in section:
487
client["secret"] = section["secret"].decode("base64")
488
elif "secfile" in section:
489
with open(os.path.expanduser(os.path.expandvars
490
(section["secfile"])),
491
"rb") as secfile:
492
client["secret"] = secfile.read()
493
else:
494
raise TypeError("No secret or secfile for section {}"
495
.format(section))
496
client["timeout"] = string_to_delta(section["timeout"])
497
client["extended_timeout"] = string_to_delta(
498
section["extended_timeout"])
499
client["interval"] = string_to_delta(section["interval"])
500
client["approval_delay"] = string_to_delta(
501
section["approval_delay"])
502
client["approval_duration"] = string_to_delta(
503
section["approval_duration"])
504
client["checker_command"] = section["checker"]
505
client["last_approval_request"] = None
506
client["last_checked_ok"] = None
507
client["last_checker_status"] = -2
508
509
return settings
510
511
def __init__(self, settings, name = None, server_settings=None):
455
512
self.name = name
456
if config is None:
457
config = {}
513
if server_settings is None:
514
server_settings = {}
515
self.server_settings = server_settings
516
# adding all client settings
517
for setting, value in settings.items():
518
setattr(self, setting, value)
519
520
if self.enabled:
521
if not hasattr(self, "last_enabled"):
522
self.last_enabled = datetime.datetime.utcnow()
523
if not hasattr(self, "expires"):
524
self.expires = (datetime.datetime.utcnow()
525
+ self.timeout)
526
else:
527
self.last_enabled = None
528
self.expires = None
529
458
530
logger.debug("Creating client %r", self.name)
459
531
# Uppercase and remove spaces from fingerprint for later
460
532
# comparison purposes with return value from the fingerprint()
461
533
# function
462
self.fingerprint = (config["fingerprint"].upper()
463
.replace(" ", ""))
464
534
logger.debug(" Fingerprint: %s", self.fingerprint)
465
if "secret" in config:
466
self.secret = config["secret"].decode("base64")
467
elif "secfile" in config:
468
with open(os.path.expanduser(os.path.expandvars
469
(config["secfile"])),
470
"rb") as secfile:
471
self.secret = secfile.read()
472
else:
473
raise TypeError("No secret or secfile for client %s"
474
% self.name)
475
self.host = config.get("host", "")
476
self.created = datetime.datetime.utcnow()
477
self.enabled = config.get("enabled", True)
478
self.last_approval_request = None
479
if self.enabled:
480
self.last_enabled = datetime.datetime.utcnow()
481
else:
482
self.last_enabled = None
483
self.last_checked_ok = None
484
self.last_checker_status = None
485
self.timeout = string_to_delta(config["timeout"])
486
self.extended_timeout = string_to_delta(config
487
["extended_timeout"])
488
self.interval = string_to_delta(config["interval"])
535
self.created = settings.get("created",
536
datetime.datetime.utcnow())
537
538
# attributes specific for this server instance
489
539
self.checker = None
490
540
self.checker_initiator_tag = None
491
541
self.disable_initiator_tag = None
492
if self.enabled:
493
self.expires = datetime.datetime.utcnow() + self.timeout
494
else:
495
self.expires = None
496
542
self.checker_callback_tag = None
497
self.checker_command = config["checker"]
498
543
self.current_checker_command = None
499
544
self.approved = None
500
self.approved_by_default = config.get("approved_by_default",
501
True)
502
545
self.approvals_pending = 0
503
self.approval_delay = string_to_delta(
504
config["approval_delay"])
505
self.approval_duration = string_to_delta(
506
config["approval_duration"])
507
546
self.changedstate = (multiprocessing_manager
508
547
.Condition(multiprocessing_manager
509
548
.Lock()))
529
568
if getattr(self, "enabled", False):
530
569
# Already enabled
531
570
return
532
self.send_changedstate()
533
571
self.expires = datetime.datetime.utcnow() + self.timeout
534
572
self.enabled = True
535
573
self.last_enabled = datetime.datetime.utcnow()
536
574
self.init_checker()
575
self.send_changedstate()
537
576
538
577
def disable(self, quiet=True):
539
578
"""Disable this client."""
540
579
if not getattr(self, "enabled", False):
541
580
return False
542
581
if not quiet:
543
self.send_changedstate()
544
if not quiet:
545
582
logger.info("Disabling client %s", self.name)
546
if getattr(self, "disable_initiator_tag", False):
583
if getattr(self, "disable_initiator_tag", None) is not None:
547
584
gobject.source_remove(self.disable_initiator_tag)
548
585
self.disable_initiator_tag = None
549
586
self.expires = None
550
if getattr(self, "checker_initiator_tag", False):
587
if getattr(self, "checker_initiator_tag", None) is not None:
551
588
gobject.source_remove(self.checker_initiator_tag)
552
589
self.checker_initiator_tag = None
553
590
self.stop_checker()
554
591
self.enabled = False
592
if not quiet:
593
self.send_changedstate()
555
594
# Do not run this again if called by a gobject.timeout_add
556
595
return False
557
596
561
600
def init_checker(self):
562
601
# Schedule a new checker to be started an 'interval' from now,
563
602
# and every interval from then on.
603
if self.checker_initiator_tag is not None:
604
gobject.source_remove(self.checker_initiator_tag)
564
605
self.checker_initiator_tag = (gobject.timeout_add
565
(self.interval_milliseconds(),
606
(int(self.interval
607
.total_seconds() * 1000),
566
608
self.start_checker))
567
609
# Schedule a disable() when 'timeout' has passed
610
if self.disable_initiator_tag is not None:
611
gobject.source_remove(self.disable_initiator_tag)
568
612
self.disable_initiator_tag = (gobject.timeout_add
569
(self.timeout_milliseconds(),
570
self.disable))
613
(int(self.timeout
614
.total_seconds() * 1000),
615
self.disable))
571
616
# Also start a new checker *right now*.
572
617
self.start_checker()
573
618
589
634
logger.warning("Checker for %(name)s crashed?",
590
635
vars(self))
591
636
592
def checked_ok(self, timeout=None):
593
"""Bump up the timeout for this client.
594
595
This should only be called when the client has been seen,
596
alive and well.
597
"""
637
def checked_ok(self):
638
"""Assert that the client has been seen, alive and well."""
639
self.last_checked_ok = datetime.datetime.utcnow()
640
self.last_checker_status = 0
641
self.bump_timeout()
642
643
def bump_timeout(self, timeout=None):
644
"""Bump up the timeout for this client."""
598
645
if timeout is None:
599
646
timeout = self.timeout
600
self.last_checked_ok = datetime.datetime.utcnow()
601
647
if self.disable_initiator_tag is not None:
602
648
gobject.source_remove(self.disable_initiator_tag)
649
self.disable_initiator_tag = None
603
650
if getattr(self, "enabled", False):
604
651
self.disable_initiator_tag = (gobject.timeout_add
605
(timedelta_to_milliseconds
606
(timeout), self.disable))
652
(int(timeout.total_seconds()
653
* 1000), self.disable))
607
654
self.expires = datetime.datetime.utcnow() + timeout
608
655
609
656
def need_approval(self):
615
662
If a checker already exists, leave it running and do
616
663
nothing."""
617
664
# The reason for not killing a running checker is that if we
618
# did that, then if a checker (for some reason) started
619
# running slowly and taking more than 'interval' time, the
620
# client would inevitably timeout, since no checker would get
621
# a chance to run to completion. If we instead leave running
665
# did that, and if a checker (for some reason) started running
666
# slowly and taking more than 'interval' time, then the client
667
# would inevitably timeout, since no checker would get a
668
# chance to run to completion. If we instead leave running
622
669
# checkers alone, the checker would have to take more time
623
670
# than 'timeout' for the client to be disabled, which is as it
624
671
# should be.
626
673
# If a checker exists, make sure it is not a zombie
627
674
try:
628
675
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
629
except (AttributeError, OSError) as error:
630
if (isinstance(error, OSError)
631
and error.errno != errno.ECHILD):
632
raise error
676
except AttributeError:
677
pass
678
except OSError as error:
679
if error.errno != errno.ECHILD:
680
raise
633
681
else:
634
682
if pid:
635
683
logger.warning("Checker was a zombie")
638
686
self.current_checker_command)
639
687
# Start a new checker if needed
640
688
if self.checker is None:
689
# Escape attributes for the shell
690
escaped_attrs = { attr:
691
re.escape(unicode(getattr(self,
692
attr)))
693
for attr in self.runtime_expansions }
641
694
try:
642
# In case checker_command has exactly one % operator
643
command = self.checker_command % self.host
644
except TypeError:
645
# Escape attributes for the shell
646
escaped_attrs = dict(
647
(attr,
648
re.escape(unicode(str(getattr(self, attr, "")),
649
errors=
650
'replace')))
651
for attr in
652
self.runtime_expansions)
653
654
try:
655
command = self.checker_command % escaped_attrs
656
except TypeError as error:
657
logger.error('Could not format string "%s":'
658
' %s', self.checker_command, error)
659
return True # Try again later
695
command = self.checker_command % escaped_attrs
696
except TypeError as error:
697
logger.error('Could not format string "%s"',
698
self.checker_command, exc_info=error)
699
return True # Try again later
660
700
self.current_checker_command = command
661
701
try:
662
702
logger.info("Starting checker %r for %s",
665
705
# in normal mode, that is already done by daemon(),
666
706
# and in debug mode we don't want to. (Stdin is
667
707
# always replaced by /dev/null.)
708
# The exception is when not debugging but nevertheless
709
# running in the foreground; use the previously
710
# created wnull.
711
popen_args = {}
712
if (not self.server_settings["debug"]
713
and self.server_settings["foreground"]):
714
popen_args.update({"stdout": wnull,
715
"stderr": wnull })
668
716
self.checker = subprocess.Popen(command,
669
717
close_fds=True,
670
shell=True, cwd="/")
671
self.checker_callback_tag = (gobject.child_watch_add
672
(self.checker.pid,
673
self.checker_callback,
674
data=command))
675
# The checker may have completed before the gobject
676
# watch was added. Check for this.
718
shell=True, cwd="/",
719
**popen_args)
720
except OSError as error:
721
logger.error("Failed to start subprocess",
722
exc_info=error)
723
return True
724
self.checker_callback_tag = (gobject.child_watch_add
725
(self.checker.pid,
726
self.checker_callback,
727
data=command))
728
# The checker may have completed before the gobject
729
# watch was added. Check for this.
730
try:
677
731
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
678
if pid:
679
gobject.source_remove(self.checker_callback_tag)
680
self.checker_callback(pid, status, command)
681
732
except OSError as error:
682
logger.error("Failed to start subprocess: %s",
683
error)
733
if error.errno == errno.ECHILD:
734
# This should never happen
735
logger.error("Child process vanished",
736
exc_info=error)
737
return True
738
raise
739
if pid:
740
gobject.source_remove(self.checker_callback_tag)
741
self.checker_callback(pid, status, command)
684
742
# Re-run this periodically if run by gobject.timeout_add
685
743
return True
686
744
693
751
return
694
752
logger.debug("Stopping checker for %(name)s", vars(self))
695
753
try:
696
os.kill(self.checker.pid, signal.SIGTERM)
754
self.checker.terminate()
697
755
#time.sleep(0.5)
698
756
#if self.checker.poll() is None:
699
# os.kill(self.checker.pid, signal.SIGKILL)
757
# self.checker.kill()
700
758
except OSError as error:
701
759
if error.errno != errno.ESRCH: # No such process
702
760
raise
719
777
# "Set" method, so we fail early here:
720
778
if byte_arrays and signature != "ay":
721
779
raise ValueError("Byte arrays not supported for non-'ay'"
722
" signature %r" % signature)
780
" signature {!r}".format(signature))
723
781
def decorator(func):
724
782
func._dbus_is_property = True
725
783
func._dbus_interface = dbus_interface
733
791
return decorator
734
792
735
793
794
def dbus_interface_annotations(dbus_interface):
795
"""Decorator for marking functions returning interface annotations
796
797
Usage:
798
799
@dbus_interface_annotations("org.example.Interface")
800
def _foo(self): # Function name does not matter
801
return {"org.freedesktop.DBus.Deprecated": "true",
802
"org.freedesktop.DBus.Property.EmitsChangedSignal":
803
"false"}
804
"""
805
def decorator(func):
806
func._dbus_is_interface = True
807
func._dbus_interface = dbus_interface
808
func._dbus_name = dbus_interface
809
return func
810
return decorator
811
812
813
def dbus_annotations(annotations):
814
"""Decorator to annotate D-Bus methods, signals or properties
815
Usage:
816
817
@dbus_service_property("org.example.Interface", signature="b",
818
access="r")
819
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
820
"org.freedesktop.DBus.Property."
821
"EmitsChangedSignal": "false"})
822
def Property_dbus_property(self):
823
return dbus.Boolean(False)
824
"""
825
def decorator(func):
826
func._dbus_annotations = annotations
827
return func
828
return decorator
829
830
736
831
class DBusPropertyException(dbus.exceptions.DBusException):
737
832
"""A base class for D-Bus property-related exceptions
738
833
"""
761
856
"""
762
857
763
858
@staticmethod
764
def _is_dbus_property(obj):
765
return getattr(obj, "_dbus_is_property", False)
859
def _is_dbus_thing(thing):
860
"""Returns a function testing if an attribute is a D-Bus thing
861
862
If called like _is_dbus_thing("method") it returns a function
863
suitable for use as predicate to inspect.getmembers().
864
"""
865
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
866
False)
766
867
767
def _get_all_dbus_properties(self):
868
def _get_all_dbus_things(self, thing):
768
869
"""Returns a generator of (name, attribute) pairs
769
870
"""
770
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
871
return ((getattr(athing.__get__(self), "_dbus_name",
872
name),
873
athing.__get__(self))
771
874
for cls in self.__class__.__mro__
772
for name, prop in
773
inspect.getmembers(cls, self._is_dbus_property))
875
for name, athing in
876
inspect.getmembers(cls,
877
self._is_dbus_thing(thing)))
774
878
775
879
def _get_dbus_property(self, interface_name, property_name):
776
880
"""Returns a bound method if one exists which is a D-Bus
778
882
"""
779
883
for cls in self.__class__.__mro__:
780
884
for name, value in (inspect.getmembers
781
(cls, self._is_dbus_property)):
885
(cls,
886
self._is_dbus_thing("property"))):
782
887
if (value._dbus_name == property_name
783
888
and value._dbus_interface == interface_name):
784
889
return value.__get__(self)
812
917
# The byte_arrays option is not supported yet on
813
918
# signatures other than "ay".
814
919
if prop._dbus_signature != "ay":
815
raise ValueError
816
value = dbus.ByteArray(''.join(unichr(byte)
817
for byte in value))
920
raise ValueError("Byte arrays not supported for non-"
921
"'ay' signature {!r}"
922
.format(prop._dbus_signature))
923
value = dbus.ByteArray(b''.join(chr(byte)
924
for byte in value))
818
925
prop(value)
819
926
820
927
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
826
933
Note: Will not include properties with access="write".
827
934
"""
828
935
properties = {}
829
for name, prop in self._get_all_dbus_properties():
936
for name, prop in self._get_all_dbus_things("property"):
830
937
if (interface_name
831
938
and interface_name != prop._dbus_interface):
832
939
# Interface non-empty but did not match
847
954
path_keyword='object_path',
848
955
connection_keyword='connection')
849
956
def Introspect(self, object_path, connection):
850
"""Standard D-Bus method, overloaded to insert property tags.
957
"""Overloading of standard D-Bus method.
958
959
Inserts property tags and interface annotation tags.
851
960
"""
852
961
xmlstring = dbus.service.Object.Introspect(self, object_path,
853
962
connection)
860
969
e.setAttribute("access", prop._dbus_access)
861
970
return e
862
971
for if_tag in document.getElementsByTagName("interface"):
972
# Add property tags
863
973
for tag in (make_tag(document, name, prop)
864
974
for name, prop
865
in self._get_all_dbus_properties()
975
in self._get_all_dbus_things("property")
866
976
if prop._dbus_interface
867
977
== if_tag.getAttribute("name")):
868
978
if_tag.appendChild(tag)
979
# Add annotation tags
980
for typ in ("method", "signal", "property"):
981
for tag in if_tag.getElementsByTagName(typ):
982
annots = dict()
983
for name, prop in (self.
984
_get_all_dbus_things(typ)):
985
if (name == tag.getAttribute("name")
986
and prop._dbus_interface
987
== if_tag.getAttribute("name")):
988
annots.update(getattr
989
(prop,
990
"_dbus_annotations",
991
{}))
992
for name, value in annots.items():
993
ann_tag = document.createElement(
994
"annotation")
995
ann_tag.setAttribute("name", name)
996
ann_tag.setAttribute("value", value)
997
tag.appendChild(ann_tag)
998
# Add interface annotation tags
999
for annotation, value in dict(
1000
itertools.chain.from_iterable(
1001
annotations().items()
1002
for name, annotations in
1003
self._get_all_dbus_things("interface")
1004
if name == if_tag.getAttribute("name")
1005
)).items():
1006
ann_tag = document.createElement("annotation")
1007
ann_tag.setAttribute("name", annotation)
1008
ann_tag.setAttribute("value", value)
1009
if_tag.appendChild(ann_tag)
869
1010
# Add the names to the return values for the
870
1011
# "org.freedesktop.DBus.Properties" methods
871
1012
if (if_tag.getAttribute("name")
886
1027
except (AttributeError, xml.dom.DOMException,
887
1028
xml.parsers.expat.ExpatError) as error:
888
1029
logger.error("Failed to override Introspection method",
889
error)
1030
exc_info=error)
890
1031
return xmlstring
891
1032
892
1033
893
def datetime_to_dbus (dt, variant_level=0):
1034
def datetime_to_dbus(dt, variant_level=0):
894
1035
"""Convert a UTC datetime.datetime() to a D-Bus type."""
895
1036
if dt is None:
896
1037
return dbus.String("", variant_level = variant_level)
898
1039
variant_level=variant_level)
899
1040
900
1041
901
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
902
.__metaclass__):
903
"""Applied to an empty subclass of a D-Bus object, this metaclass
904
will add additional D-Bus attributes matching a certain pattern.
1042
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1043
"""A class decorator; applied to a subclass of
1044
dbus.service.Object, it will add alternate D-Bus attributes with
1045
interface names according to the "alt_interface_names" mapping.
1046
Usage:
1047
1048
@alternate_dbus_interfaces({"org.example.Interface":
1049
"net.example.AlternateInterface"})
1050
class SampleDBusObject(dbus.service.Object):
1051
@dbus.service.method("org.example.Interface")
1052
def SampleDBusMethod():
1053
pass
1054
1055
The above "SampleDBusMethod" on "SampleDBusObject" will be
1056
reachable via two interfaces: "org.example.Interface" and
1057
"net.example.AlternateInterface", the latter of which will have
1058
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1059
"true", unless "deprecate" is passed with a False value.
1060
1061
This works for methods and signals, and also for D-Bus properties
1062
(from DBusObjectWithProperties) and interfaces (from the
1063
dbus_interface_annotations decorator).
905
1064
"""
906
def __new__(mcs, name, bases, attr):
907
# Go through all the base classes which could have D-Bus
908
# methods, signals, or properties in them
909
for base in (b for b in bases
910
if issubclass(b, dbus.service.Object)):
911
# Go though all attributes of the base class
912
for attrname, attribute in inspect.getmembers(base):
1065
def wrapper(cls):
1066
for orig_interface_name, alt_interface_name in (
1067
alt_interface_names.items()):
1068
attr = {}
1069
interface_names = set()
1070
# Go though all attributes of the class
1071
for attrname, attribute in inspect.getmembers(cls):
913
1072
# Ignore non-D-Bus attributes, and D-Bus attributes
914
1073
# with the wrong interface name
915
1074
if (not hasattr(attribute, "_dbus_interface")
916
1075
or not attribute._dbus_interface
917
.startswith("se.recompile.Mandos")):
1076
.startswith(orig_interface_name)):
918
1077
continue
919
1078
# Create an alternate D-Bus interface name based on
920
1079
# the current name
921
1080
alt_interface = (attribute._dbus_interface
922
.replace("se.recompile.Mandos",
923
"se.bsnet.fukt.Mandos"))
1081
.replace(orig_interface_name,
1082
alt_interface_name))
1083
interface_names.add(alt_interface)
924
1084
# Is this a D-Bus signal?
925
1085
if getattr(attribute, "_dbus_is_signal", False):
926
# Extract the original non-method function by
927
# black magic
1086
# Extract the original non-method undecorated
1087
# function by black magic
928
1088
nonmethod_func = (dict(
929
1089
zip(attribute.func_code.co_freevars,
930
1090
attribute.__closure__))["func"]
941
1101
nonmethod_func.func_name,
942
1102
nonmethod_func.func_defaults,
943
1103
nonmethod_func.func_closure)))
1104
# Copy annotations, if any
1105
try:
1106
new_function._dbus_annotations = (
1107
dict(attribute._dbus_annotations))
1108
except AttributeError:
1109
pass
944
1110
# Define a creator of a function to call both the
945
# old and new functions, so both the old and new
946
# signals gets sent when the function is called
1111
# original and alternate functions, so both the
1112
# original and alternate signals gets sent when
1113
# the function is called
947
1114
def fixscope(func1, func2):
948
1115
"""This function is a scope container to pass
949
1116
func1 and func2 to the "call_both" function
956
1123
return call_both
957
1124
# Create the "call_both" function and add it to
958
1125
# the class
959
attr[attrname] = fixscope(attribute,
960
new_function)
1126
attr[attrname] = fixscope(attribute, new_function)
961
1127
# Is this a D-Bus method?
962
1128
elif getattr(attribute, "_dbus_is_method", False):
963
1129
# Create a new, but exactly alike, function
974
1140
attribute.func_name,
975
1141
attribute.func_defaults,
976
1142
attribute.func_closure)))
1143
# Copy annotations, if any
1144
try:
1145
attr[attrname]._dbus_annotations = (
1146
dict(attribute._dbus_annotations))
1147
except AttributeError:
1148
pass
977
1149
# Is this a D-Bus property?
978
1150
elif getattr(attribute, "_dbus_is_property", False):
979
1151
# Create a new, but exactly alike, function
993
1165
attribute.func_name,
994
1166
attribute.func_defaults,
995
1167
attribute.func_closure)))
996
return type.__new__(mcs, name, bases, attr)
997
998
1168
# Copy annotations, if any
1169
try:
1170
attr[attrname]._dbus_annotations = (
1171
dict(attribute._dbus_annotations))
1172
except AttributeError:
1173
pass
1174
# Is this a D-Bus interface?
1175
elif getattr(attribute, "_dbus_is_interface", False):
1176
# Create a new, but exactly alike, function
1177
# object. Decorate it to be a new D-Bus interface
1178
# with the alternate D-Bus interface name. Add it
1179
# to the class.
1180
attr[attrname] = (dbus_interface_annotations
1181
(alt_interface)
1182
(types.FunctionType
1183
(attribute.func_code,
1184
attribute.func_globals,
1185
attribute.func_name,
1186
attribute.func_defaults,
1187
attribute.func_closure)))
1188
if deprecate:
1189
# Deprecate all alternate interfaces
1190
iname="_AlternateDBusNames_interface_annotation{}"
1191
for interface_name in interface_names:
1192
@dbus_interface_annotations(interface_name)
1193
def func(self):
1194
return { "org.freedesktop.DBus.Deprecated":
1195
"true" }
1196
# Find an unused name
1197
for aname in (iname.format(i)
1198
for i in itertools.count()):
1199
if aname not in attr:
1200
attr[aname] = func
1201
break
1202
if interface_names:
1203
# Replace the class with a new subclass of it with
1204
# methods, signals, etc. as created above.
1205
cls = type(b"{}Alternate".format(cls.__name__),
1206
(cls,), attr)
1207
return cls
1208
return wrapper
1209
1210
1211
@alternate_dbus_interfaces({"se.recompile.Mandos":
1212
"se.bsnet.fukt.Mandos"})
999
1213
class ClientDBus(Client, DBusObjectWithProperties):
1000
1214
"""A Client class using D-Bus
1001
1215
1012
1226
def __init__(self, bus = None, *args, **kwargs):
1013
1227
self.bus = bus
1014
1228
Client.__init__(self, *args, **kwargs)
1015
1016
self._approvals_pending = 0
1017
1229
# Only now, when this client is initialized, can it show up on
1018
1230
# the D-Bus
1019
1231
client_object_name = unicode(self.name).translate(
1023
1235
("/clients/" + client_object_name))
1024
1236
DBusObjectWithProperties.__init__(self, self.bus,
1025
1237
self.dbus_object_path)
1026
1238
1027
1239
def notifychangeproperty(transform_func,
1028
1240
dbus_name, type_func=lambda x: x,
1029
1241
variant_level=1):
1037
1249
to the D-Bus. Default: no transform
1038
1250
variant_level: D-Bus variant level. Default: 1
1039
1251
"""
1040
attrname = "_{0}".format(dbus_name)
1252
attrname = "_{}".format(dbus_name)
1041
1253
def setter(self, value):
1042
1254
if hasattr(self, "dbus_object_path"):
1043
1255
if (not hasattr(self, attrname) or
1052
1264
1053
1265
return property(lambda self: getattr(self, attrname), setter)
1054
1266
1055
1056
1267
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1057
1268
approvals_pending = notifychangeproperty(dbus.Boolean,
1058
1269
"ApprovalPending",
1065
1276
checker is not None)
1066
1277
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1067
1278
"LastCheckedOK")
1279
last_checker_status = notifychangeproperty(dbus.Int16,
1280
"LastCheckerStatus")
1068
1281
last_approval_request = notifychangeproperty(
1069
1282
datetime_to_dbus, "LastApprovalRequest")
1070
1283
approved_by_default = notifychangeproperty(dbus.Boolean,
1071
1284
"ApprovedByDefault")
1072
approval_delay = notifychangeproperty(dbus.UInt16,
1285
approval_delay = notifychangeproperty(dbus.UInt64,
1073
1286
"ApprovalDelay",
1074
1287
type_func =
1075
timedelta_to_milliseconds)
1288
lambda td: td.total_seconds()
1289
* 1000)
1076
1290
approval_duration = notifychangeproperty(
1077
dbus.UInt16, "ApprovalDuration",
1078
type_func = timedelta_to_milliseconds)
1291
dbus.UInt64, "ApprovalDuration",
1292
type_func = lambda td: td.total_seconds() * 1000)
1079
1293
host = notifychangeproperty(dbus.String, "Host")
1080
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1081
type_func =
1082
timedelta_to_milliseconds)
1294
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1295
type_func = lambda td:
1296
td.total_seconds() * 1000)
1083
1297
extended_timeout = notifychangeproperty(
1084
dbus.UInt16, "ExtendedTimeout",
1085
type_func = timedelta_to_milliseconds)
1086
interval = notifychangeproperty(dbus.UInt16,
1298
dbus.UInt64, "ExtendedTimeout",
1299
type_func = lambda td: td.total_seconds() * 1000)
1300
interval = notifychangeproperty(dbus.UInt64,
1087
1301
"Interval",
1088
1302
type_func =
1089
timedelta_to_milliseconds)
1303
lambda td: td.total_seconds()
1304
* 1000)
1090
1305
checker_command = notifychangeproperty(dbus.String, "Checker")
1091
1306
1092
1307
del notifychangeproperty
1120
1335
*args, **kwargs)
1121
1336
1122
1337
def start_checker(self, *args, **kwargs):
1123
old_checker = self.checker
1124
if self.checker is not None:
1125
old_checker_pid = self.checker.pid
1126
else:
1127
old_checker_pid = None
1338
old_checker_pid = getattr(self.checker, "pid", None)
1128
1339
r = Client.start_checker(self, *args, **kwargs)
1129
1340
# Only if new checker process was started
1130
1341
if (self.checker is not None
1138
1349
return False
1139
1350
1140
1351
def approve(self, value=True):
1141
self.send_changedstate()
1142
1352
self.approved = value
1143
gobject.timeout_add(timedelta_to_milliseconds
1144
(self.approval_duration),
1145
self._reset_approved)
1146
1353
gobject.timeout_add(int(self.approval_duration.total_seconds()
1354
* 1000), self._reset_approved)
1355
self.send_changedstate()
1147
1356
1148
1357
## D-Bus methods, signals & properties
1149
1358
_interface = "se.recompile.Mandos.Client"
1150
1359
1360
## Interfaces
1361
1362
@dbus_interface_annotations(_interface)
1363
def _foo(self):
1364
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1365
"false"}
1366
1151
1367
## Signals
1152
1368
1153
1369
# CheckerCompleted - signal
1189
1405
"D-Bus signal"
1190
1406
return self.need_approval()
1191
1407
1192
# NeRwequest - signal
1193
@dbus.service.signal(_interface, signature="s")
1194
def NewRequest(self, ip):
1195
"""D-Bus signal
1196
Is sent after a client request a password.
1197
"""
1198
pass
1199
1200
1408
## Methods
1201
1409
1202
1410
# Approve - method
1252
1460
access="readwrite")
1253
1461
def ApprovalDelay_dbus_property(self, value=None):
1254
1462
if value is None: # get
1255
return dbus.UInt64(self.approval_delay_milliseconds())
1463
return dbus.UInt64(self.approval_delay.total_seconds()
1464
* 1000)
1256
1465
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1257
1466
1258
1467
# ApprovalDuration - property
1260
1469
access="readwrite")
1261
1470
def ApprovalDuration_dbus_property(self, value=None):
1262
1471
if value is None: # get
1263
return dbus.UInt64(timedelta_to_milliseconds(
1264
self.approval_duration))
1472
return dbus.UInt64(self.approval_duration.total_seconds()
1473
* 1000)
1265
1474
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1266
1475
1267
1476
# Name - property
1312
1521
return
1313
1522
return datetime_to_dbus(self.last_checked_ok)
1314
1523
1524
# LastCheckerStatus - property
1525
@dbus_service_property(_interface, signature="n",
1526
access="read")
1527
def LastCheckerStatus_dbus_property(self):
1528
return dbus.Int16(self.last_checker_status)
1529
1315
1530
# Expires - property
1316
1531
@dbus_service_property(_interface, signature="s", access="read")
1317
1532
def Expires_dbus_property(self):
1327
1542
access="readwrite")
1328
1543
def Timeout_dbus_property(self, value=None):
1329
1544
if value is None: # get
1330
return dbus.UInt64(self.timeout_milliseconds())
1545
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1546
old_timeout = self.timeout
1331
1547
self.timeout = datetime.timedelta(0, 0, 0, value)
1332
if getattr(self, "disable_initiator_tag", None) is None:
1333
return
1334
# Reschedule timeout
1335
gobject.source_remove(self.disable_initiator_tag)
1336
self.disable_initiator_tag = None
1337
self.expires = None
1338
time_to_die = timedelta_to_milliseconds((self
1339
.last_checked_ok
1340
+ self.timeout)
1341
- datetime.datetime
1342
.utcnow())
1343
if time_to_die <= 0:
1344
# The timeout has passed
1345
self.disable()
1346
else:
1347
self.expires = (datetime.datetime.utcnow()
1348
+ datetime.timedelta(milliseconds =
1349
time_to_die))
1350
self.disable_initiator_tag = (gobject.timeout_add
1351
(time_to_die, self.disable))
1548
# Reschedule disabling
1549
if self.enabled:
1550
now = datetime.datetime.utcnow()
1551
self.expires += self.timeout - old_timeout
1552
if self.expires <= now:
1553
# The timeout has passed
1554
self.disable()
1555
else:
1556
if (getattr(self, "disable_initiator_tag", None)
1557
is None):
1558
return
1559
gobject.source_remove(self.disable_initiator_tag)
1560
self.disable_initiator_tag = (
1561
gobject.timeout_add(
1562
int((self.expires - now).total_seconds()
1563
* 1000), self.disable))
1352
1564
1353
1565
# ExtendedTimeout - property
1354
1566
@dbus_service_property(_interface, signature="t",
1355
1567
access="readwrite")
1356
1568
def ExtendedTimeout_dbus_property(self, value=None):
1357
1569
if value is None: # get
1358
return dbus.UInt64(self.extended_timeout_milliseconds())
1570
return dbus.UInt64(self.extended_timeout.total_seconds()
1571
* 1000)
1359
1572
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1360
1573
1361
1574
# Interval - property
1363
1576
access="readwrite")
1364
1577
def Interval_dbus_property(self, value=None):
1365
1578
if value is None: # get
1366
return dbus.UInt64(self.interval_milliseconds())
1579
return dbus.UInt64(self.interval.total_seconds() * 1000)
1367
1580
self.interval = datetime.timedelta(0, 0, 0, value)
1368
1581
if getattr(self, "checker_initiator_tag", None) is None:
1369
1582
return
1433
1646
self._pipe.send(('setattr', name, value))
1434
1647
1435
1648
1436
class ClientDBusTransitional(ClientDBus):
1437
__metaclass__ = AlternateDBusNamesMetaclass
1438
1439
1440
1649
class ClientHandler(socketserver.BaseRequestHandler, object):
1441
1650
"""A class to handle client connections.
1442
1651
1478
1687
logger.debug("Protocol version: %r", line)
1479
1688
try:
1480
1689
if int(line.strip().split()[0]) > 1:
1481
raise RuntimeError
1690
raise RuntimeError(line)
1482
1691
except (ValueError, IndexError, RuntimeError) as error:
1483
1692
logger.error("Unknown protocol version: %s", error)
1484
1693
return
1510
1719
except KeyError:
1511
1720
return
1512
1721
1513
if self.server.use_dbus:
1514
# Emit D-Bus signal
1515
client.NewRequest(str(self.client_address))
1516
1517
1722
if client.approval_delay:
1518
1723
delay = client.approval_delay
1519
1724
client.approvals_pending += 1
1537
1742
if self.server.use_dbus:
1538
1743
# Emit D-Bus signal
1539
1744
client.NeedApproval(
1540
client.approval_delay_milliseconds(),
1541
client.approved_by_default)
1745
client.approval_delay.total_seconds()
1746
* 1000, client.approved_by_default)
1542
1747
else:
1543
1748
logger.warning("Client %s was not approved",
1544
1749
client.name)
1550
1755
#wait until timeout or approved
1551
1756
time = datetime.datetime.now()
1552
1757
client.changedstate.acquire()
1553
(client.changedstate.wait
1554
(float(client.timedelta_to_milliseconds(delay)
1555
/ 1000)))
1758
client.changedstate.wait(delay.total_seconds())
1556
1759
client.changedstate.release()
1557
1760
time2 = datetime.datetime.now()
1558
1761
if (time2 - time) >= delay:
1574
1777
try:
1575
1778
sent = session.send(client.secret[sent_size:])
1576
1779
except gnutls.errors.GNUTLSError as error:
1577
logger.warning("gnutls send failed")
1780
logger.warning("gnutls send failed",
1781
exc_info=error)
1578
1782
return
1579
1783
logger.debug("Sent: %d, remaining: %d",
1580
1784
sent, len(client.secret)
1583
1787
1584
1788
logger.info("Sending secret to %s", client.name)
1585
1789
# bump the timeout using extended_timeout
1586
client.checked_ok(client.extended_timeout)
1790
client.bump_timeout(client.extended_timeout)
1587
1791
if self.server.use_dbus:
1588
1792
# Emit D-Bus signal
1589
1793
client.GotSecret()
1594
1798
try:
1595
1799
session.bye()
1596
1800
except gnutls.errors.GNUTLSError as error:
1597
logger.warning("GnuTLS bye failed")
1801
logger.warning("GnuTLS bye failed",
1802
exc_info=error)
1598
1803
1599
1804
@staticmethod
1600
1805
def peer_certificate(session):
1665
1870
def sub_process_main(self, request, address):
1666
1871
try:
1667
1872
self.finish_request(request, address)
1668
except:
1873
except Exception:
1669
1874
self.handle_error(request, address)
1670
1875
self.close_request(request)
1671
1876
1672
1877
def process_request(self, request, address):
1673
1878
"""Start a new process to process the request."""
1674
1879
proc = multiprocessing.Process(target = self.sub_process_main,
1675
args = (request,
1676
address))
1880
args = (request, address))
1677
1881
proc.start()
1678
1882
return proc
1679
1883
1694
1898
1695
1899
def add_pipe(self, parent_pipe, proc):
1696
1900
"""Dummy function; override as necessary"""
1697
raise NotImplementedError
1901
raise NotImplementedError()
1698
1902
1699
1903
1700
1904
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1707
1911
use_ipv6: Boolean; to use IPv6 or not
1708
1912
"""
1709
1913
def __init__(self, server_address, RequestHandlerClass,
1710
interface=None, use_ipv6=True):
1914
interface=None, use_ipv6=True, socketfd=None):
1915
"""If socketfd is set, use that file descriptor instead of
1916
creating a new one with socket.socket().
1917
"""
1711
1918
self.interface = interface
1712
1919
if use_ipv6:
1713
1920
self.address_family = socket.AF_INET6
1921
if socketfd is not None:
1922
# Save the file descriptor
1923
self.socketfd = socketfd
1924
# Save the original socket.socket() function
1925
self.socket_socket = socket.socket
1926
# To implement --socket, we monkey patch socket.socket.
1927
#
1928
# (When socketserver.TCPServer is a new-style class, we
1929
# could make self.socket into a property instead of monkey
1930
# patching socket.socket.)
1931
#
1932
# Create a one-time-only replacement for socket.socket()
1933
@functools.wraps(socket.socket)
1934
def socket_wrapper(*args, **kwargs):
1935
# Restore original function so subsequent calls are
1936
# not affected.
1937
socket.socket = self.socket_socket
1938
del self.socket_socket
1939
# This time only, return a new socket object from the
1940
# saved file descriptor.
1941
return socket.fromfd(self.socketfd, *args, **kwargs)
1942
# Replace socket.socket() function with wrapper
1943
socket.socket = socket_wrapper
1944
# The socketserver.TCPServer.__init__ will call
1945
# socket.socket(), which might be our replacement,
1946
# socket_wrapper(), if socketfd was set.
1714
1947
socketserver.TCPServer.__init__(self, server_address,
1715
1948
RequestHandlerClass)
1949
1716
1950
def server_bind(self):
1717
1951
"""This overrides the normal server_bind() function
1718
1952
to bind to an interface if one was specified, and also NOT to
1726
1960
try:
1727
1961
self.socket.setsockopt(socket.SOL_SOCKET,
1728
1962
SO_BINDTODEVICE,
1729
str(self.interface
1730
+ '\0'))
1963
str(self.interface + '\0'))
1731
1964
except socket.error as error:
1732
if error[0] == errno.EPERM:
1733
logger.error("No permission to"
1734
" bind to interface %s",
1735
self.interface)
1736
elif error[0] == errno.ENOPROTOOPT:
1965
if error.errno == errno.EPERM:
1966
logger.error("No permission to bind to"
1967
" interface %s", self.interface)
1968
elif error.errno == errno.ENOPROTOOPT:
1737
1969
logger.error("SO_BINDTODEVICE not available;"
1738
1970
" cannot bind to interface %s",
1739
1971
self.interface)
1972
elif error.errno == errno.ENODEV:
1973
logger.error("Interface %s does not exist,"
1974
" cannot bind", self.interface)
1740
1975
else:
1741
1976
raise
1742
1977
# Only bind(2) the socket if we really need to.
1745
1980
if self.address_family == socket.AF_INET6:
1746
1981
any_address = "::" # in6addr_any
1747
1982
else:
1748
any_address = socket.INADDR_ANY
1983
any_address = "0.0.0.0" # INADDR_ANY
1749
1984
self.server_address = (any_address,
1750
1985
self.server_address[1])
1751
1986
elif not self.server_address[1]:
1772
2007
"""
1773
2008
def __init__(self, server_address, RequestHandlerClass,
1774
2009
interface=None, use_ipv6=True, clients=None,
1775
gnutls_priority=None, use_dbus=True):
2010
gnutls_priority=None, use_dbus=True, socketfd=None):
1776
2011
self.enabled = False
1777
2012
self.clients = clients
1778
2013
if self.clients is None:
1782
2017
IPv6_TCPServer.__init__(self, server_address,
1783
2018
RequestHandlerClass,
1784
2019
interface = interface,
1785
use_ipv6 = use_ipv6)
2020
use_ipv6 = use_ipv6,
2021
socketfd = socketfd)
1786
2022
def server_activate(self):
1787
2023
if self.enabled:
1788
2024
return socketserver.TCPServer.server_activate(self)
1801
2037
1802
2038
def handle_ipc(self, source, condition, parent_pipe=None,
1803
2039
proc = None, client_object=None):
1804
condition_names = {
1805
gobject.IO_IN: "IN", # There is data to read.
1806
gobject.IO_OUT: "OUT", # Data can be written (without
1807
# blocking).
1808
gobject.IO_PRI: "PRI", # There is urgent data to read.
1809
gobject.IO_ERR: "ERR", # Error condition.
1810
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1811
# broken, usually for pipes and
1812
# sockets).
1813
}
1814
conditions_string = ' | '.join(name
1815
for cond, name in
1816
condition_names.iteritems()
1817
if cond & condition)
1818
2040
# error, or the other end of multiprocessing.Pipe has closed
1819
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2041
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1820
2042
# Wait for other process to exit
1821
2043
proc.join()
1822
2044
return False
1880
2102
return True
1881
2103
1882
2104
2105
def rfc3339_duration_to_delta(duration):
2106
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2107
2108
>>> rfc3339_duration_to_delta("P7D")
2109
datetime.timedelta(7)
2110
>>> rfc3339_duration_to_delta("PT60S")
2111
datetime.timedelta(0, 60)
2112
>>> rfc3339_duration_to_delta("PT60M")
2113
datetime.timedelta(0, 3600)
2114
>>> rfc3339_duration_to_delta("PT24H")
2115
datetime.timedelta(1)
2116
>>> rfc3339_duration_to_delta("P1W")
2117
datetime.timedelta(7)
2118
>>> rfc3339_duration_to_delta("PT5M30S")
2119
datetime.timedelta(0, 330)
2120
>>> rfc3339_duration_to_delta("P1DT3M20S")
2121
datetime.timedelta(1, 200)
2122
"""
2123
2124
# Parsing an RFC 3339 duration with regular expressions is not
2125
# possible - there would have to be multiple places for the same
2126
# values, like seconds. The current code, while more esoteric, is
2127
# cleaner without depending on a parsing library. If Python had a
2128
# built-in library for parsing we would use it, but we'd like to
2129
# avoid excessive use of external libraries.
2130
2131
# New type for defining tokens, syntax, and semantics all-in-one
2132
Token = collections.namedtuple("Token",
2133
("regexp", # To match token; if
2134
# "value" is not None,
2135
# must have a "group"
2136
# containing digits
2137
"value", # datetime.timedelta or
2138
# None
2139
"followers")) # Tokens valid after
2140
# this token
2141
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2142
# the "duration" ABNF definition in RFC 3339, Appendix A.
2143
token_end = Token(re.compile(r"$"), None, frozenset())
2144
token_second = Token(re.compile(r"(\d+)S"),
2145
datetime.timedelta(seconds=1),
2146
frozenset((token_end,)))
2147
token_minute = Token(re.compile(r"(\d+)M"),
2148
datetime.timedelta(minutes=1),
2149
frozenset((token_second, token_end)))
2150
token_hour = Token(re.compile(r"(\d+)H"),
2151
datetime.timedelta(hours=1),
2152
frozenset((token_minute, token_end)))
2153
token_time = Token(re.compile(r"T"),
2154
None,
2155
frozenset((token_hour, token_minute,
2156
token_second)))
2157
token_day = Token(re.compile(r"(\d+)D"),
2158
datetime.timedelta(days=1),
2159
frozenset((token_time, token_end)))
2160
token_month = Token(re.compile(r"(\d+)M"),
2161
datetime.timedelta(weeks=4),
2162
frozenset((token_day, token_end)))
2163
token_year = Token(re.compile(r"(\d+)Y"),
2164
datetime.timedelta(weeks=52),
2165
frozenset((token_month, token_end)))
2166
token_week = Token(re.compile(r"(\d+)W"),
2167
datetime.timedelta(weeks=1),
2168
frozenset((token_end,)))
2169
token_duration = Token(re.compile(r"P"), None,
2170
frozenset((token_year, token_month,
2171
token_day, token_time,
2172
token_week)))
2173
# Define starting values
2174
value = datetime.timedelta() # Value so far
2175
found_token = None
2176
followers = frozenset((token_duration,)) # Following valid tokens
2177
s = duration # String left to parse
2178
# Loop until end token is found
2179
while found_token is not token_end:
2180
# Search for any currently valid tokens
2181
for token in followers:
2182
match = token.regexp.match(s)
2183
if match is not None:
2184
# Token found
2185
if token.value is not None:
2186
# Value found, parse digits
2187
factor = int(match.group(1), 10)
2188
# Add to value so far
2189
value += factor * token.value
2190
# Strip token from string
2191
s = token.regexp.sub("", s, 1)
2192
# Go to found token
2193
found_token = token
2194
# Set valid next tokens
2195
followers = found_token.followers
2196
break
2197
else:
2198
# No currently valid tokens were found
2199
raise ValueError("Invalid RFC 3339 duration")
2200
# End token found
2201
return value
2202
2203
1883
2204
def string_to_delta(interval):
1884
2205
"""Parse a string and return a datetime.timedelta
1885
2206
1896
2217
>>> string_to_delta('5m 30s')
1897
2218
datetime.timedelta(0, 330)
1898
2219
"""
2220
2221
try:
2222
return rfc3339_duration_to_delta(interval)
2223
except ValueError:
2224
pass
2225
1899
2226
timevalue = datetime.timedelta(0)
1900
2227
for s in interval.split():
1901
2228
try:
1912
2239
elif suffix == "w":
1913
2240
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1914
2241
else:
1915
raise ValueError("Unknown suffix %r" % suffix)
1916
except (ValueError, IndexError) as e:
2242
raise ValueError("Unknown suffix {!r}"
2243
.format(suffix))
2244
except IndexError as e:
1917
2245
raise ValueError(*(e.args))
1918
2246
timevalue += delta
1919
2247
return timevalue
1932
2260
sys.exit()
1933
2261
if not noclose:
1934
2262
# Close all standard open file descriptors
1935
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2263
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1936
2264
if not stat.S_ISCHR(os.fstat(null).st_mode):
1937
raise OSError(errno.ENODEV,
1938
"%s not a character device"
1939
% os.path.devnull)
2265
raise OSError(errno.ENODEV, "{} not a character device"
2266
.format(os.devnull))
1940
2267
os.dup2(null, sys.stdin.fileno())
1941
2268
os.dup2(null, sys.stdout.fileno())
1942
2269
os.dup2(null, sys.stderr.fileno())
1951
2278
1952
2279
parser = argparse.ArgumentParser()
1953
2280
parser.add_argument("-v", "--version", action="version",
1954
version = "%%(prog)s %s" % version,
2281
version = "%(prog)s {}".format(version),
1955
2282
help="show version number and exit")
1956
2283
parser.add_argument("-i", "--interface", metavar="IF",
1957
2284
help="Bind to interface IF")
1963
2290
help="Run self-test")
1964
2291
parser.add_argument("--debug", action="store_true",
1965
2292
help="Debug mode; run in foreground and log"
1966
" to terminal")
2293
" to terminal", default=None)
1967
2294
parser.add_argument("--debuglevel", metavar="LEVEL",
1968
2295
help="Debug level for stdout output")
1969
2296
parser.add_argument("--priority", help="GnuTLS"
1976
2303
" files")
1977
2304
parser.add_argument("--no-dbus", action="store_false",
1978
2305
dest="use_dbus", help="Do not provide D-Bus"
1979
" system bus interface")
2306
" system bus interface", default=None)
1980
2307
parser.add_argument("--no-ipv6", action="store_false",
1981
dest="use_ipv6", help="Do not use IPv6")
2308
dest="use_ipv6", help="Do not use IPv6",
2309
default=None)
1982
2310
parser.add_argument("--no-restore", action="store_false",
1983
2311
dest="restore", help="Do not restore stored"
1984
" state")
2312
" state", default=None)
2313
parser.add_argument("--socket", type=int,
2314
help="Specify a file descriptor to a network"
2315
" socket to use instead of creating one")
1985
2316
parser.add_argument("--statedir", metavar="DIR",
1986
2317
help="Directory to save/restore state in")
2318
parser.add_argument("--foreground", action="store_true",
2319
help="Run in foreground", default=None)
2320
parser.add_argument("--no-zeroconf", action="store_false",
2321
dest="zeroconf", help="Do not use Zeroconf",
2322
default=None)
1987
2323
1988
2324
options = parser.parse_args()
1989
2325
1990
2326
if options.check:
1991
2327
import doctest
1992
doctest.testmod()
1993
sys.exit()
2328
fail_count, test_count = doctest.testmod()
2329
sys.exit(os.EX_OK if fail_count == 0 else 1)
1994
2330
1995
2331
# Default values for config file for server-global settings
1996
2332
server_defaults = { "interface": "",
1998
2334
"port": "",
1999
2335
"debug": "False",
2000
2336
"priority":
2001
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2337
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2002
2338
"servicename": "Mandos",
2003
2339
"use_dbus": "True",
2004
2340
"use_ipv6": "True",
2005
2341
"debuglevel": "",
2006
2342
"restore": "True",
2007
"statedir": "/var/lib/mandos"
2343
"socket": "",
2344
"statedir": "/var/lib/mandos",
2345
"foreground": "False",
2346
"zeroconf": "True",
2008
2347
}
2009
2348
2010
2349
# Parse config file for server-global settings
2015
2354
# Convert the SafeConfigParser object to a dict
2016
2355
server_settings = server_config.defaults()
2017
2356
# Use the appropriate methods on the non-string config options
2018
for option in ("debug", "use_dbus", "use_ipv6"):
2357
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2019
2358
server_settings[option] = server_config.getboolean("DEFAULT",
2020
2359
option)
2021
2360
if server_settings["port"]:
2022
2361
server_settings["port"] = server_config.getint("DEFAULT",
2023
2362
"port")
2363
if server_settings["socket"]:
2364
server_settings["socket"] = server_config.getint("DEFAULT",
2365
"socket")
2366
# Later, stdin will, and stdout and stderr might, be dup'ed
2367
# over with an opened os.devnull. But we don't want this to
2368
# happen with a supplied network socket.
2369
if 0 <= server_settings["socket"] <= 2:
2370
server_settings["socket"] = os.dup(server_settings
2371
["socket"])
2024
2372
del server_config
2025
2373
2026
2374
# Override the settings from the config file with command line
2028
2376
for option in ("interface", "address", "port", "debug",
2029
2377
"priority", "servicename", "configdir",
2030
2378
"use_dbus", "use_ipv6", "debuglevel", "restore",
2031
"statedir"):
2379
"statedir", "socket", "foreground", "zeroconf"):
2032
2380
value = getattr(options, option)
2033
2381
if value is not None:
2034
2382
server_settings[option] = value
2037
2385
for option in server_settings.keys():
2038
2386
if type(server_settings[option]) is str:
2039
2387
server_settings[option] = unicode(server_settings[option])
2388
# Force all boolean options to be boolean
2389
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2390
"foreground", "zeroconf"):
2391
server_settings[option] = bool(server_settings[option])
2392
# Debug implies foreground
2393
if server_settings["debug"]:
2394
server_settings["foreground"] = True
2040
2395
# Now we have our good server settings in "server_settings"
2041
2396
2042
2397
##################################################################
2043
2398
2399
if (not server_settings["zeroconf"] and
2400
not (server_settings["port"]
2401
or server_settings["socket"] != "")):
2402
parser.error("Needs port or socket to work without"
2403
" Zeroconf")
2404
2044
2405
# For convenience
2045
2406
debug = server_settings["debug"]
2046
2407
debuglevel = server_settings["debuglevel"]
2048
2409
use_ipv6 = server_settings["use_ipv6"]
2049
2410
stored_state_path = os.path.join(server_settings["statedir"],
2050
2411
stored_state_file)
2412
foreground = server_settings["foreground"]
2413
zeroconf = server_settings["zeroconf"]
2051
2414
2052
2415
if debug:
2053
initlogger(logging.DEBUG)
2416
initlogger(debug, logging.DEBUG)
2054
2417
else:
2055
2418
if not debuglevel:
2056
initlogger()
2419
initlogger(debug)
2057
2420
else:
2058
2421
level = getattr(logging, debuglevel.upper())
2059
initlogger(level)
2422
initlogger(debug, level)
2060
2423
2061
2424
if server_settings["servicename"] != "Mandos":
2062
2425
syslogger.setFormatter(logging.Formatter
2063
('Mandos (%s) [%%(process)d]:'
2064
' %%(levelname)s: %%(message)s'
2065
% server_settings["servicename"]))
2426
('Mandos ({}) [%(process)d]:'
2427
' %(levelname)s: %(message)s'
2428
.format(server_settings
2429
["servicename"])))
2066
2430
2067
2431
# Parse config file with clients
2068
client_defaults = { "timeout": "5m",
2069
"extended_timeout": "15m",
2070
"interval": "2m",
2071
"checker": "fping -q -- %%(host)s",
2072
"host": "",
2073
"approval_delay": "0s",
2074
"approval_duration": "1s",
2075
}
2076
client_config = configparser.SafeConfigParser(client_defaults)
2432
client_config = configparser.SafeConfigParser(Client
2433
.client_defaults)
2077
2434
client_config.read(os.path.join(server_settings["configdir"],
2078
2435
"clients.conf"))
2079
2436
2080
2437
global mandos_dbus_service
2081
2438
mandos_dbus_service = None
2082
2439
2440
socketfd = None
2441
if server_settings["socket"] != "":
2442
socketfd = server_settings["socket"]
2083
2443
tcp_server = MandosServer((server_settings["address"],
2084
2444
server_settings["port"]),
2085
2445
ClientHandler,
2088
2448
use_ipv6=use_ipv6,
2089
2449
gnutls_priority=
2090
2450
server_settings["priority"],
2091
use_dbus=use_dbus)
2092
if not debug:
2093
pidfilename = "/var/run/mandos.pid"
2451
use_dbus=use_dbus,
2452
socketfd=socketfd)
2453
if not foreground:
2454
pidfilename = "/run/mandos.pid"
2455
if not os.path.isdir("/run/."):
2456
pidfilename = "/var/run/mandos.pid"
2457
pidfile = None
2094
2458
try:
2095
2459
pidfile = open(pidfilename, "w")
2096
except IOError:
2097
logger.error("Could not open file %r", pidfilename)
2460
except IOError as e:
2461
logger.error("Could not open file %r", pidfilename,
2462
exc_info=e)
2098
2463
2099
try:
2100
uid = pwd.getpwnam("_mandos").pw_uid
2101
gid = pwd.getpwnam("_mandos").pw_gid
2102
except KeyError:
2464
for name in ("_mandos", "mandos", "nobody"):
2103
2465
try:
2104
uid = pwd.getpwnam("mandos").pw_uid
2105
gid = pwd.getpwnam("mandos").pw_gid
2466
uid = pwd.getpwnam(name).pw_uid
2467
gid = pwd.getpwnam(name).pw_gid
2468
break
2106
2469
except KeyError:
2107
try:
2108
uid = pwd.getpwnam("nobody").pw_uid
2109
gid = pwd.getpwnam("nobody").pw_gid
2110
except KeyError:
2111
uid = 65534
2112
gid = 65534
2470
continue
2471
else:
2472
uid = 65534
2473
gid = 65534
2113
2474
try:
2114
2475
os.setgid(gid)
2115
2476
os.setuid(uid)
2116
2477
except OSError as error:
2117
if error[0] != errno.EPERM:
2118
raise error
2478
if error.errno != errno.EPERM:
2479
raise
2119
2480
2120
2481
if debug:
2121
2482
# Enable all possible GnuTLS debugging
2132
2493
.gnutls_global_set_log_function(debug_gnutls))
2133
2494
2134
2495
# Redirect stdin so all checkers get /dev/null
2135
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2496
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2136
2497
os.dup2(null, sys.stdin.fileno())
2137
2498
if null > 2:
2138
2499
os.close(null)
2139
else:
2140
# No console logging
2141
logger.removeHandler(console)
2142
2500
2143
2501
# Need to fork before connecting to D-Bus
2144
if not debug:
2502
if not foreground:
2145
2503
# Close all input and output, do double fork, etc.
2146
2504
daemon()
2147
2505
2506
# multiprocessing will use threads, so before we use gobject we
2507
# need to inform gobject that threads will be used.
2508
gobject.threads_init()
2509
2148
2510
global main_loop
2149
2511
# From the Avahi example code
2150
DBusGMainLoop(set_as_default=True )
2512
DBusGMainLoop(set_as_default=True)
2151
2513
main_loop = gobject.MainLoop()
2152
2514
bus = dbus.SystemBus()
2153
2515
# End of Avahi example code
2159
2521
("se.bsnet.fukt.Mandos", bus,
2160
2522
do_not_queue=True))
2161
2523
except dbus.exceptions.NameExistsException as e:
2162
logger.error(unicode(e) + ", disabling D-Bus")
2524
logger.error("Disabling D-Bus:", exc_info=e)
2163
2525
use_dbus = False
2164
2526
server_settings["use_dbus"] = False
2165
2527
tcp_server.use_dbus = False
2166
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2167
service = AvahiServiceToSyslog(name =
2168
server_settings["servicename"],
2169
servicetype = "_mandos._tcp",
2170
protocol = protocol, bus = bus)
2171
if server_settings["interface"]:
2172
service.interface = (if_nametoindex
2173
(str(server_settings["interface"])))
2528
if zeroconf:
2529
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2530
service = AvahiServiceToSyslog(name =
2531
server_settings["servicename"],
2532
servicetype = "_mandos._tcp",
2533
protocol = protocol, bus = bus)
2534
if server_settings["interface"]:
2535
service.interface = (if_nametoindex
2536
(str(server_settings["interface"])))
2174
2537
2175
2538
global multiprocessing_manager
2176
2539
multiprocessing_manager = multiprocessing.Manager()
2177
2540
2178
2541
client_class = Client
2179
2542
if use_dbus:
2180
client_class = functools.partial(ClientDBusTransitional,
2181
bus = bus)
2182
2183
special_settings = {
2184
# Some settings need to be accessd by special methods;
2185
# booleans need .getboolean(), etc. Here is a list of them:
2186
"approved_by_default":
2187
lambda section:
2188
client_config.getboolean(section, "approved_by_default"),
2189
"enabled":
2190
lambda section:
2191
client_config.getboolean(section, "enabled"),
2192
}
2193
# Construct a new dict of client settings of this form:
2194
# { client_name: {setting_name: value, ...}, ...}
2195
# with exceptions for any special settings as defined above
2196
client_settings = dict((clientname,
2197
dict((setting,
2198
(value
2199
if setting not in special_settings
2200
else special_settings[setting]
2201
(clientname)))
2202
for setting, value in
2203
client_config.items(clientname)))
2204
for clientname in client_config.sections())
2205
2543
client_class = functools.partial(ClientDBus, bus = bus)
2544
2545
client_settings = Client.config_parser(client_config)
2206
2546
old_client_settings = {}
2207
clients_data = []
2547
clients_data = {}
2548
2549
# This is used to redirect stdout and stderr for checker processes
2550
global wnull
2551
wnull = open(os.devnull, "w") # A writable /dev/null
2552
# Only used if server is running in foreground but not in debug
2553
# mode
2554
if debug or not foreground:
2555
wnull.close()
2208
2556
2209
2557
# Get client data and settings from last running state.
2210
2558
if server_settings["restore"]:
2214
2562
(stored_state))
2215
2563
os.remove(stored_state_path)
2216
2564
except IOError as e:
2217
logger.warning("Could not load persistent state: {0}"
2218
.format(e))
2219
if e.errno != errno.ENOENT:
2565
if e.errno == errno.ENOENT:
2566
logger.warning("Could not load persistent state: {}"
2567
.format(os.strerror(e.errno)))
2568
else:
2569
logger.critical("Could not load persistent state:",
2570
exc_info=e)
2220
2571
raise
2572
except EOFError as e:
2573
logger.warning("Could not load persistent state: "
2574
"EOFError:", exc_info=e)
2221
2575
2222
2576
with PGPEngine() as pgp:
2223
for client in clients_data:
2224
client_name = client["name"]
2577
for client_name, client in clients_data.items():
2578
# Skip removed clients
2579
if client_name not in client_settings:
2580
continue
2225
2581
2226
2582
# Decide which value to use after restoring saved state.
2227
2583
# We have three different values: Old config file,
2236
2592
if (name != "secret" and
2237
2593
value != old_client_settings[client_name]
2238
2594
[name]):
2239
setattr(client, name, value)
2595
client[name] = value
2240
2596
except KeyError:
2241
2597
pass
2242
2598
2243
2599
# Clients who has passed its expire date can still be
2244
# enabled if its last checker was sucessful. Clients
2245
# whose checker failed before we stored its state is
2246
# assumed to have failed all checkers during downtime.
2600
# enabled if its last checker was successful. Clients
2601
# whose checker succeeded before we stored its state is
2602
# assumed to have successfully run all checkers during
2603
# downtime.
2247
2604
if client["enabled"]:
2248
if client["expires"] <= (datetime.datetime
2249
.utcnow()):
2250
# Client has expired
2251
if client["last_checker_status"] != 0:
2605
if datetime.datetime.utcnow() >= client["expires"]:
2606
if not client["last_checked_ok"]:
2607
logger.warning(
2608
"disabling client {} - Client never "
2609
"performed a successful checker"
2610
.format(client_name))
2611
client["enabled"] = False
2612
elif client["last_checker_status"] != 0:
2613
logger.warning(
2614
"disabling client {} - Client last"
2615
" checker failed with error code {}"
2616
.format(client_name,
2617
client["last_checker_status"]))
2252
2618
client["enabled"] = False
2253
2619
else:
2254
2620
client["expires"] = (datetime.datetime
2255
2621
.utcnow()
2256
2622
+ client["timeout"])
2257
2258
client["changedstate"] = (multiprocessing_manager
2259
.Condition
2260
(multiprocessing_manager
2261
.Lock()))
2262
if use_dbus:
2263
new_client = (ClientDBusTransitional.__new__
2264
(ClientDBusTransitional))
2265
tcp_server.clients[client_name] = new_client
2266
new_client.bus = bus
2267
for name, value in client.iteritems():
2268
setattr(new_client, name, value)
2269
client_object_name = unicode(client_name).translate(
2270
{ord("."): ord("_"),
2271
ord("-"): ord("_")})
2272
new_client.dbus_object_path = (dbus.ObjectPath
2273
("/clients/"
2274
+ client_object_name))
2275
DBusObjectWithProperties.__init__(new_client,
2276
new_client.bus,
2277
new_client
2278
.dbus_object_path)
2279
else:
2280
tcp_server.clients[client_name] = (Client.__new__
2281
(Client))
2282
for name, value in client.iteritems():
2283
setattr(tcp_server.clients[client_name],
2284
name, value)
2285
2623
logger.debug("Last checker succeeded,"
2624
" keeping {} enabled"
2625
.format(client_name))
2286
2626
try:
2287
tcp_server.clients[client_name].secret = (
2288
pgp.decrypt(tcp_server.clients[client_name]
2289
.encrypted_secret,
2627
client["secret"] = (
2628
pgp.decrypt(client["encrypted_secret"],
2290
2629
client_settings[client_name]
2291
2630
["secret"]))
2292
2631
except PGPError:
2293
2632
# If decryption fails, we use secret from new settings
2294
logger.debug("Failed to decrypt {0} old secret"
2633
logger.debug("Failed to decrypt {} old secret"
2295
2634
.format(client_name))
2296
tcp_server.clients[client_name].secret = (
2635
client["secret"] = (
2297
2636
client_settings[client_name]["secret"])
2298
2637
2299
# Create/remove clients based on new changes made to config
2300
for clientname in set(old_client_settings) - set(client_settings):
2301
del tcp_server.clients[clientname]
2302
for clientname in set(client_settings) - set(old_client_settings):
2303
tcp_server.clients[clientname] = (client_class(name
2304
= clientname,
2305
config =
2306
client_settings
2307
[clientname]))
2638
# Add/remove clients based on new changes made to config
2639
for client_name in (set(old_client_settings)
2640
- set(client_settings)):
2641
del clients_data[client_name]
2642
for client_name in (set(client_settings)
2643
- set(old_client_settings)):
2644
clients_data[client_name] = client_settings[client_name]
2645
2646
# Create all client objects
2647
for client_name, client in clients_data.items():
2648
tcp_server.clients[client_name] = client_class(
2649
name = client_name, settings = client,
2650
server_settings = server_settings)
2308
2651
2309
2652
if not tcp_server.clients:
2310
2653
logger.warning("No clients defined")
2311
2312
if not debug:
2313
try:
2314
with pidfile:
2315
pid = os.getpid()
2316
pidfile.write(str(pid) + "\n".encode("utf-8"))
2317
del pidfile
2318
except IOError:
2319
logger.error("Could not write to file %r with PID %d",
2320
pidfilename, pid)
2321
except NameError:
2322
# "pidfile" was never created
2323
pass
2654
2655
if not foreground:
2656
if pidfile is not None:
2657
try:
2658
with pidfile:
2659
pid = os.getpid()
2660
pidfile.write(str(pid) + "\n".encode("utf-8"))
2661
except IOError:
2662
logger.error("Could not write to file %r with PID %d",
2663
pidfilename, pid)
2664
del pidfile
2324
2665
del pidfilename
2325
2326
signal.signal(signal.SIGINT, signal.SIG_IGN)
2327
2666
2328
2667
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2329
2668
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2330
2669
2331
2670
if use_dbus:
2332
class MandosDBusService(dbus.service.Object):
2671
@alternate_dbus_interfaces({"se.recompile.Mandos":
2672
"se.bsnet.fukt.Mandos"})
2673
class MandosDBusService(DBusObjectWithProperties):
2333
2674
"""A D-Bus proxy object"""
2334
2675
def __init__(self):
2335
2676
dbus.service.Object.__init__(self, bus, "/")
2336
2677
_interface = "se.recompile.Mandos"
2337
2678
2679
@dbus_interface_annotations(_interface)
2680
def _foo(self):
2681
return { "org.freedesktop.DBus.Property"
2682
".EmitsChangedSignal":
2683
"false"}
2684
2338
2685
@dbus.service.signal(_interface, signature="o")
2339
2686
def ClientAdded(self, objpath):
2340
2687
"D-Bus signal"
2382
2729
2383
2730
del _interface
2384
2731
2385
class MandosDBusServiceTransitional(MandosDBusService):
2386
__metaclass__ = AlternateDBusNamesMetaclass
2387
mandos_dbus_service = MandosDBusServiceTransitional()
2732
mandos_dbus_service = MandosDBusService()
2388
2733
2389
2734
def cleanup():
2390
2735
"Cleanup function; run on exit"
2391
service.cleanup()
2736
if zeroconf:
2737
service.cleanup()
2392
2738
2393
2739
multiprocessing.active_children()
2740
wnull.close()
2394
2741
if not (tcp_server.clients or client_settings):
2395
2742
return
2396
2743
2397
2744
# Store client before exiting. Secrets are encrypted with key
2398
2745
# based on what config file has. If config file is
2399
2746
# removed/edited, old secret will thus be unrecovable.
2400
clients = []
2747
clients = {}
2401
2748
with PGPEngine() as pgp:
2402
2749
for client in tcp_server.clients.itervalues():
2403
2750
key = client_settings[client.name]["secret"]
2405
2752
key)
2406
2753
client_dict = {}
2407
2754
2408
# A list of attributes that will not be stored when
2409
# shutting down.
2410
exclude = set(("bus", "changedstate", "secret"))
2755
# A list of attributes that can not be pickled
2756
# + secret.
2757
exclude = { "bus", "changedstate", "secret",
2758
"checker", "server_settings" }
2411
2759
for name, typ in (inspect.getmembers
2412
2760
(dbus.service.Object)):
2413
2761
exclude.add(name)
2418
2766
if attr not in exclude:
2419
2767
client_dict[attr] = getattr(client, attr)
2420
2768
2421
clients.append(client_dict)
2769
clients[client.name] = client_dict
2422
2770
del client_settings[client.name]["secret"]
2423
2771
2424
2772
try:
2425
with os.fdopen(os.open(stored_state_path,
2426
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2427
0600), "wb") as stored_state:
2773
with (tempfile.NamedTemporaryFile
2774
(mode='wb', suffix=".pickle", prefix='clients-',
2775
dir=os.path.dirname(stored_state_path),
2776
delete=False)) as stored_state:
2428
2777
pickle.dump((clients, client_settings), stored_state)
2778
tempname=stored_state.name
2779
os.rename(tempname, stored_state_path)
2429
2780
except (IOError, OSError) as e:
2430
logger.warning("Could not save persistent state: {0}"
2431
.format(e))
2432
if e.errno not in (errno.ENOENT, errno.EACCES):
2781
if not debug:
2782
try:
2783
os.remove(tempname)
2784
except NameError:
2785
pass
2786
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2787
logger.warning("Could not save persistent state: {}"
2788
.format(os.strerror(e.errno)))
2789
else:
2790
logger.warning("Could not save persistent state:",
2791
exc_info=e)
2433
2792
raise
2434
2793
2435
2794
# Delete all clients, and settings from config
2460
2819
tcp_server.server_activate()
2461
2820
2462
2821
# Find out what port we got
2463
service.port = tcp_server.socket.getsockname()[1]
2822
if zeroconf:
2823
service.port = tcp_server.socket.getsockname()[1]
2464
2824
if use_ipv6:
2465
2825
logger.info("Now listening on address %r, port %d,"
2466
" flowinfo %d, scope_id %d"
2467
% tcp_server.socket.getsockname())
2826
" flowinfo %d, scope_id %d",
2827
*tcp_server.socket.getsockname())
2468
2828
else: # IPv4
2469
logger.info("Now listening on address %r, port %d"
2470
% tcp_server.socket.getsockname())
2829
logger.info("Now listening on address %r, port %d",
2830
*tcp_server.socket.getsockname())
2471
2831
2472
2832
#service.interface = tcp_server.socket.getsockname()[3]
2473
2833
2474
2834
try:
2475
# From the Avahi example code
2476
try:
2477
service.activate()
2478
except dbus.exceptions.DBusException as error:
2479
logger.critical("DBusException: %s", error)
2480
cleanup()
2481
sys.exit(1)
2482
# End of Avahi example code
2835
if zeroconf:
2836
# From the Avahi example code
2837
try:
2838
service.activate()
2839
except dbus.exceptions.DBusException as error:
2840
logger.critical("D-Bus Exception", exc_info=error)
2841
cleanup()
2842
sys.exit(1)
2843
# End of Avahi example code
2483
2844
2484
2845
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2485
2846
lambda *args, **kwargs:
2489
2850
logger.debug("Starting main loop")
2490
2851
main_loop.run()
2491
2852
except AvahiError as error:
2492
logger.critical("AvahiError: %s", error)
2853
logger.critical("Avahi Error", exc_info=error)
2493
2854
cleanup()
2494
2855
sys.exit(1)
2495
2856
except KeyboardInterrupt:
2500
2861
# Must run before the D-Bus bus name gets deregistered
2501
2862
cleanup()
2502
2863
2503
2504
2864
if __name__ == '__main__':
2505
2865
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0