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 539
- compare with another revision
- download diff
- download tarball
- view history from revision 539
- Committer: teddy at recompile
- Date: 2011-12-27 14:15:40 UTC
- Revision ID: teddy@recompile.se-20111227141540-ajrabf33q59jfa7t
Reorder TODO entries
- files removed:
- debian/mandos-client.examples
- 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-2013 Teddy Hogeborn
15
# Copyright © 2008-2013 Björn Påhlsson
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 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
39
37
import SocketServer as socketserver
40
38
import socket
41
39
import argparse
67
65
import types
68
66
import binascii
69
67
import tempfile
70
import itertools
71
import collections
72
68
73
69
import dbus
74
70
import dbus.service
79
75
import ctypes.util
80
76
import xml.dom.minidom
81
77
import inspect
78
import GnuPGInterface
82
79
83
80
try:
84
81
SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
85
except ImportError:
89
86
SO_BINDTODEVICE = None
90
87
91
version = "1.6.1"
88
version = "1.4.1"
92
89
stored_state_file = "clients.pickle"
93
90
94
91
logger = logging.getLogger()
139
136
class PGPEngine(object):
140
137
"""A simple class for OpenPGP symmetric encryption & decryption"""
141
138
def __init__(self):
139
self.gnupg = GnuPGInterface.GnuPG()
142
140
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
143
self.gnupgargs = ['--batch',
144
'--home', self.tempdir,
145
'--force-mdc',
146
'--quiet',
147
'--no-use-agent']
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'])
148
146
149
147
def __enter__(self):
150
148
return self
151
149
152
def __exit__(self, exc_type, exc_value, traceback):
150
def __exit__ (self, exc_type, exc_value, traceback):
153
151
self._cleanup()
154
152
return False
155
153
175
173
return b"mandos" + binascii.hexlify(password)
176
174
177
175
def encrypt(self, data, password):
178
passphrase = self.password_encode(password)
179
with tempfile.NamedTemporaryFile(dir=self.tempdir
180
) as passfile:
181
passfile.write(passphrase)
182
passfile.flush()
183
proc = subprocess.Popen(['gpg', '--symmetric',
184
'--passphrase-file',
185
passfile.name]
186
+ self.gnupgargs,
187
stdin = subprocess.PIPE,
188
stdout = subprocess.PIPE,
189
stderr = subprocess.PIPE)
190
ciphertext, err = proc.communicate(input = data)
191
if proc.returncode != 0:
192
raise PGPError(err)
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
193
190
return ciphertext
194
191
195
192
def decrypt(self, data, password):
196
passphrase = self.password_encode(password)
197
with tempfile.NamedTemporaryFile(dir = self.tempdir
198
) as passfile:
199
passfile.write(passphrase)
200
passfile.flush()
201
proc = subprocess.Popen(['gpg', '--decrypt',
202
'--passphrase-file',
203
passfile.name]
204
+ self.gnupgargs,
205
stdin = subprocess.PIPE,
206
stdout = subprocess.PIPE,
207
stderr = subprocess.PIPE)
208
decrypted_plaintext, err = proc.communicate(input
209
= data)
210
if proc.returncode != 0:
211
raise PGPError(err)
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
212
207
return decrypted_plaintext
213
208
214
209
210
215
211
class AvahiError(Exception):
216
212
def __init__(self, value, *args, **kwargs):
217
213
self.value = value
234
230
Used to optionally bind to the specified interface.
235
231
name: string; Example: 'Mandos'
236
232
type: string; Example: '_mandos._tcp'.
237
See <https://www.iana.org/assignments/service-names-port-numbers>
233
See <http://www.dns-sd.org/ServiceTypes.html>
238
234
port: integer; what port to announce
239
235
TXT: list of strings; TXT record for the service
240
236
domain: string; Domain to publish on, default to .local if empty.
246
242
server: D-Bus Server
247
243
bus: dbus.SystemBus()
248
244
"""
249
250
245
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
251
246
servicetype = None, port = None, TXT = None,
252
247
domain = "", host = "", max_renames = 32768,
265
260
self.server = None
266
261
self.bus = bus
267
262
self.entry_group_state_changed_match = None
268
269
263
def rename(self):
270
264
"""Derived from the Avahi example code"""
271
265
if self.rename_count >= self.max_renames:
281
275
try:
282
276
self.add()
283
277
except dbus.exceptions.DBusException as error:
284
logger.critical("D-Bus Exception", exc_info=error)
278
logger.critical("DBusException: %s", error)
285
279
self.cleanup()
286
280
os._exit(1)
287
281
self.rename_count += 1
288
289
282
def remove(self):
290
283
"""Derived from the Avahi example code"""
291
284
if self.entry_group_state_changed_match is not None:
293
286
self.entry_group_state_changed_match = None
294
287
if self.group is not None:
295
288
self.group.Reset()
296
297
289
def add(self):
298
290
"""Derived from the Avahi example code"""
299
291
self.remove()
316
308
dbus.UInt16(self.port),
317
309
avahi.string_array_to_txt_array(self.TXT))
318
310
self.group.Commit()
319
320
311
def entry_group_state_changed(self, state, error):
321
312
"""Derived from the Avahi example code"""
322
313
logger.debug("Avahi entry group state change: %i", state)
329
320
elif state == avahi.ENTRY_GROUP_FAILURE:
330
321
logger.critical("Avahi: Error in group state changed %s",
331
322
unicode(error))
332
raise AvahiGroupError("State changed: {0!s}"
333
.format(error))
334
323
raise AvahiGroupError("State changed: %s"
324
% unicode(error))
335
325
def cleanup(self):
336
326
"""Derived from the Avahi example code"""
337
327
if self.group is not None:
342
332
pass
343
333
self.group = None
344
334
self.remove()
345
346
335
def server_state_changed(self, state, error=None):
347
336
"""Derived from the Avahi example code"""
348
337
logger.debug("Avahi server state change: %i", state)
367
356
logger.debug("Unknown state: %r", state)
368
357
else:
369
358
logger.debug("Unknown state: %r: %r", state, error)
370
371
359
def activate(self):
372
360
"""Derived from the Avahi example code"""
373
361
if self.server is None:
380
368
self.server_state_changed)
381
369
self.server_state_changed(self.server.GetState())
382
370
383
384
371
class AvahiServiceToSyslog(AvahiService):
385
372
def rename(self):
386
373
"""Add the new name to the syslog messages"""
387
374
ret = AvahiService.rename(self)
388
375
syslogger.setFormatter(logging.Formatter
389
('Mandos ({0}) [%(process)d]:'
390
' %(levelname)s: %(message)s'
391
.format(self.name)))
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
378
% self.name))
392
379
return ret
393
380
394
395
381
def timedelta_to_milliseconds(td):
396
382
"Convert a datetime.timedelta() to milliseconds"
397
383
return ((td.days * 24 * 60 * 60 * 1000)
398
384
+ (td.seconds * 1000)
399
385
+ (td.microseconds // 1000))
400
401
386
402
387
class Client(object):
403
388
"""A representation of a client host served by this server.
404
389
429
414
last_checked_ok: datetime.datetime(); (UTC) or None
430
415
last_checker_status: integer between 0 and 255 reflecting exit
431
416
status of last checker. -1 reflects crashed
432
checker, -2 means no checker completed yet.
417
checker, or None.
433
418
last_enabled: datetime.datetime(); (UTC) or None
434
419
name: string; from the config file, used in log messages and
435
420
D-Bus identifiers
436
421
secret: bytestring; sent verbatim (over TLS) to client
437
422
timeout: datetime.timedelta(); How long from last_checked_ok
438
423
until this client is disabled
439
extended_timeout: extra long timeout when secret has been sent
424
extended_timeout: extra long timeout when password has been sent
440
425
runtime_expansions: Allowed attributes for runtime expansion.
441
426
expires: datetime.datetime(); time (UTC) when a client will be
442
427
disabled, or None
443
server_settings: The server_settings dict from main()
444
428
"""
445
429
446
430
runtime_expansions = ("approval_delay", "approval_duration",
447
"created", "enabled", "expires",
448
"fingerprint", "host", "interval",
449
"last_approval_request", "last_checked_ok",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
450
433
"last_enabled", "name", "timeout")
451
client_defaults = { "timeout": "PT5M",
452
"extended_timeout": "PT15M",
453
"interval": "PT2M",
434
client_defaults = { "timeout": "5m",
435
"extended_timeout": "15m",
436
"interval": "2m",
454
437
"checker": "fping -q -- %%(host)s",
455
438
"host": "",
456
"approval_delay": "PT0S",
457
"approval_duration": "PT1S",
439
"approval_delay": "0s",
440
"approval_duration": "1s",
458
441
"approved_by_default": "True",
459
442
"enabled": "True",
460
443
}
473
456
474
457
def approval_delay_milliseconds(self):
475
458
return timedelta_to_milliseconds(self.approval_delay)
476
459
477
460
@staticmethod
478
461
def config_parser(config):
479
"""Construct a new dict of client settings of this form:
462
""" Construct a new dict of client settings of this form:
480
463
{ client_name: {setting_name: value, ...}, ...}
481
with exceptions for any special settings as defined above.
482
NOTE: Must be a pure function. Must return the same result
483
value given the same arguments.
484
"""
464
with exceptions for any special settings as defined above"""
485
465
settings = {}
486
466
for client_name in config.sections():
487
467
section = dict(config.items(client_name))
491
471
# Reformat values from string types to Python types
492
472
client["approved_by_default"] = config.getboolean(
493
473
client_name, "approved_by_default")
494
client["enabled"] = config.getboolean(client_name,
495
"enabled")
474
client["enabled"] = config.getboolean(client_name, "enabled")
496
475
497
476
client["fingerprint"] = (section["fingerprint"].upper()
498
477
.replace(" ", ""))
504
483
"rb") as secfile:
505
484
client["secret"] = secfile.read()
506
485
else:
507
raise TypeError("No secret or secfile for section {0}"
508
.format(section))
486
raise TypeError("No secret or secfile for section %s"
487
% section)
509
488
client["timeout"] = string_to_delta(section["timeout"])
510
489
client["extended_timeout"] = string_to_delta(
511
490
section["extended_timeout"])
517
496
client["checker_command"] = section["checker"]
518
497
client["last_approval_request"] = None
519
498
client["last_checked_ok"] = None
520
client["last_checker_status"] = -2
521
499
client["last_checker_status"] = None
500
if client["enabled"]:
501
client["last_enabled"] = datetime.datetime.utcnow()
502
client["expires"] = (datetime.datetime.utcnow()
503
+ client["timeout"])
504
else:
505
client["last_enabled"] = None
506
client["expires"] = None
507
522
508
return settings
523
524
def __init__(self, settings, name = None, server_settings=None):
509
510
511
def __init__(self, settings, name = None):
512
"""Note: the 'checker' key in 'config' sets the
513
'checker_command' attribute and *not* the 'checker'
514
attribute."""
525
515
self.name = name
526
if server_settings is None:
527
server_settings = {}
528
self.server_settings = server_settings
529
516
# adding all client settings
530
517
for setting, value in settings.iteritems():
531
518
setattr(self, setting, value)
532
519
533
if self.enabled:
534
if not hasattr(self, "last_enabled"):
535
self.last_enabled = datetime.datetime.utcnow()
536
if not hasattr(self, "expires"):
537
self.expires = (datetime.datetime.utcnow()
538
+ self.timeout)
539
else:
540
self.last_enabled = None
541
self.expires = None
542
543
520
logger.debug("Creating client %r", self.name)
544
521
# Uppercase and remove spaces from fingerprint for later
545
522
# comparison purposes with return value from the fingerprint()
546
523
# function
547
524
logger.debug(" Fingerprint: %s", self.fingerprint)
548
self.created = settings.get("created",
549
datetime.datetime.utcnow())
550
525
self.created = settings.get("created", datetime.datetime.utcnow())
526
551
527
# attributes specific for this server instance
552
528
self.checker = None
553
529
self.checker_initiator_tag = None
581
557
if getattr(self, "enabled", False):
582
558
# Already enabled
583
559
return
560
self.send_changedstate()
584
561
self.expires = datetime.datetime.utcnow() + self.timeout
585
562
self.enabled = True
586
563
self.last_enabled = datetime.datetime.utcnow()
587
564
self.init_checker()
588
self.send_changedstate()
589
565
590
566
def disable(self, quiet=True):
591
567
"""Disable this client."""
592
568
if not getattr(self, "enabled", False):
593
569
return False
594
570
if not quiet:
571
self.send_changedstate()
572
if not quiet:
595
573
logger.info("Disabling client %s", self.name)
596
if getattr(self, "disable_initiator_tag", None) is not None:
574
if getattr(self, "disable_initiator_tag", False):
597
575
gobject.source_remove(self.disable_initiator_tag)
598
576
self.disable_initiator_tag = None
599
577
self.expires = None
600
if getattr(self, "checker_initiator_tag", None) is not None:
578
if getattr(self, "checker_initiator_tag", False):
601
579
gobject.source_remove(self.checker_initiator_tag)
602
580
self.checker_initiator_tag = None
603
581
self.stop_checker()
604
582
self.enabled = False
605
if not quiet:
606
self.send_changedstate()
607
583
# Do not run this again if called by a gobject.timeout_add
608
584
return False
609
585
613
589
def init_checker(self):
614
590
# Schedule a new checker to be started an 'interval' from now,
615
591
# and every interval from then on.
616
if self.checker_initiator_tag is not None:
617
gobject.source_remove(self.checker_initiator_tag)
618
592
self.checker_initiator_tag = (gobject.timeout_add
619
593
(self.interval_milliseconds(),
620
594
self.start_checker))
621
595
# Schedule a disable() when 'timeout' has passed
622
if self.disable_initiator_tag is not None:
623
gobject.source_remove(self.disable_initiator_tag)
624
596
self.disable_initiator_tag = (gobject.timeout_add
625
597
(self.timeout_milliseconds(),
626
598
self.disable))
645
617
logger.warning("Checker for %(name)s crashed?",
646
618
vars(self))
647
619
648
def checked_ok(self):
649
"""Assert that the client has been seen, alive and well."""
650
self.last_checked_ok = datetime.datetime.utcnow()
651
self.last_checker_status = 0
652
self.bump_timeout()
653
654
def bump_timeout(self, timeout=None):
655
"""Bump up the timeout for this client."""
620
def checked_ok(self, timeout=None):
621
"""Bump up the timeout for this client.
622
623
This should only be called when the client has been seen,
624
alive and well.
625
"""
656
626
if timeout is None:
657
627
timeout = self.timeout
628
self.last_checked_ok = datetime.datetime.utcnow()
658
629
if self.disable_initiator_tag is not None:
659
630
gobject.source_remove(self.disable_initiator_tag)
660
self.disable_initiator_tag = None
661
631
if getattr(self, "enabled", False):
662
632
self.disable_initiator_tag = (gobject.timeout_add
663
633
(timedelta_to_milliseconds
673
643
If a checker already exists, leave it running and do
674
644
nothing."""
675
645
# The reason for not killing a running checker is that if we
676
# did that, and if a checker (for some reason) started running
677
# slowly and taking more than 'interval' time, then the client
678
# would inevitably timeout, since no checker would get a
679
# chance to run to completion. If we instead leave running
646
# did that, then if a checker (for some reason) started
647
# running slowly and taking more than 'interval' time, the
648
# client would inevitably timeout, since no checker would get
649
# a chance to run to completion. If we instead leave running
680
650
# checkers alone, the checker would have to take more time
681
651
# than 'timeout' for the client to be disabled, which is as it
682
652
# should be.
696
666
self.current_checker_command)
697
667
# Start a new checker if needed
698
668
if self.checker is None:
699
# Escape attributes for the shell
700
escaped_attrs = dict(
701
(attr, re.escape(unicode(getattr(self, attr))))
702
for attr in
703
self.runtime_expansions)
704
669
try:
705
command = self.checker_command % escaped_attrs
706
except TypeError as error:
707
logger.error('Could not format string "%s"',
708
self.checker_command, exc_info=error)
709
return True # Try again later
670
# In case checker_command has exactly one % operator
671
command = self.checker_command % self.host
672
except TypeError:
673
# Escape attributes for the shell
674
escaped_attrs = dict(
675
(attr,
676
re.escape(unicode(str(getattr(self, attr, "")),
677
errors=
678
'replace')))
679
for attr in
680
self.runtime_expansions)
681
682
try:
683
command = self.checker_command % escaped_attrs
684
except TypeError as error:
685
logger.error('Could not format string "%s":'
686
' %s', self.checker_command, error)
687
return True # Try again later
710
688
self.current_checker_command = command
711
689
try:
712
690
logger.info("Starting checker %r for %s",
715
693
# in normal mode, that is already done by daemon(),
716
694
# and in debug mode we don't want to. (Stdin is
717
695
# always replaced by /dev/null.)
718
# The exception is when not debugging but nevertheless
719
# running in the foreground; use the previously
720
# created wnull.
721
popen_args = {}
722
if (not self.server_settings["debug"]
723
and self.server_settings["foreground"]):
724
popen_args.update({"stdout": wnull,
725
"stderr": wnull })
726
696
self.checker = subprocess.Popen(command,
727
697
close_fds=True,
728
shell=True, cwd="/",
729
**popen_args)
730
except OSError as error:
731
logger.error("Failed to start subprocess",
732
exc_info=error)
733
return True
734
self.checker_callback_tag = (gobject.child_watch_add
735
(self.checker.pid,
736
self.checker_callback,
737
data=command))
738
# The checker may have completed before the gobject
739
# watch was added. Check for this.
740
try:
698
shell=True, cwd="/")
699
self.checker_callback_tag = (gobject.child_watch_add
700
(self.checker.pid,
701
self.checker_callback,
702
data=command))
703
# The checker may have completed before the gobject
704
# watch was added. Check for this.
741
705
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
706
if pid:
707
gobject.source_remove(self.checker_callback_tag)
708
self.checker_callback(pid, status, command)
742
709
except OSError as error:
743
if error.errno == errno.ECHILD:
744
# This should never happen
745
logger.error("Child process vanished",
746
exc_info=error)
747
return True
748
raise
749
if pid:
750
gobject.source_remove(self.checker_callback_tag)
751
self.checker_callback(pid, status, command)
710
logger.error("Failed to start subprocess: %s",
711
error)
752
712
# Re-run this periodically if run by gobject.timeout_add
753
713
return True
754
714
761
721
return
762
722
logger.debug("Stopping checker for %(name)s", vars(self))
763
723
try:
764
self.checker.terminate()
724
os.kill(self.checker.pid, signal.SIGTERM)
765
725
#time.sleep(0.5)
766
726
#if self.checker.poll() is None:
767
# self.checker.kill()
727
# os.kill(self.checker.pid, signal.SIGKILL)
768
728
except OSError as error:
769
729
if error.errno != errno.ESRCH: # No such process
770
730
raise
787
747
# "Set" method, so we fail early here:
788
748
if byte_arrays and signature != "ay":
789
749
raise ValueError("Byte arrays not supported for non-'ay'"
790
" signature {0!r}".format(signature))
750
" signature %r" % signature)
791
751
def decorator(func):
792
752
func._dbus_is_property = True
793
753
func._dbus_interface = dbus_interface
801
761
return decorator
802
762
803
763
804
def dbus_interface_annotations(dbus_interface):
805
"""Decorator for marking functions returning interface annotations
806
807
Usage:
808
809
@dbus_interface_annotations("org.example.Interface")
810
def _foo(self): # Function name does not matter
811
return {"org.freedesktop.DBus.Deprecated": "true",
812
"org.freedesktop.DBus.Property.EmitsChangedSignal":
813
"false"}
814
"""
815
def decorator(func):
816
func._dbus_is_interface = True
817
func._dbus_interface = dbus_interface
818
func._dbus_name = dbus_interface
819
return func
820
return decorator
821
822
823
def dbus_annotations(annotations):
824
"""Decorator to annotate D-Bus methods, signals or properties
825
Usage:
826
827
@dbus_service_property("org.example.Interface", signature="b",
828
access="r")
829
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
830
"org.freedesktop.DBus.Property."
831
"EmitsChangedSignal": "false"})
832
def Property_dbus_property(self):
833
return dbus.Boolean(False)
834
"""
835
def decorator(func):
836
func._dbus_annotations = annotations
837
return func
838
return decorator
839
840
841
764
class DBusPropertyException(dbus.exceptions.DBusException):
842
765
"""A base class for D-Bus property-related exceptions
843
766
"""
866
789
"""
867
790
868
791
@staticmethod
869
def _is_dbus_thing(thing):
870
"""Returns a function testing if an attribute is a D-Bus thing
871
872
If called like _is_dbus_thing("method") it returns a function
873
suitable for use as predicate to inspect.getmembers().
874
"""
875
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
876
False)
792
def _is_dbus_property(obj):
793
return getattr(obj, "_dbus_is_property", False)
877
794
878
def _get_all_dbus_things(self, thing):
795
def _get_all_dbus_properties(self):
879
796
"""Returns a generator of (name, attribute) pairs
880
797
"""
881
return ((getattr(athing.__get__(self), "_dbus_name",
882
name),
883
athing.__get__(self))
798
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
884
799
for cls in self.__class__.__mro__
885
for name, athing in
886
inspect.getmembers(cls,
887
self._is_dbus_thing(thing)))
800
for name, prop in
801
inspect.getmembers(cls, self._is_dbus_property))
888
802
889
803
def _get_dbus_property(self, interface_name, property_name):
890
804
"""Returns a bound method if one exists which is a D-Bus
892
806
"""
893
807
for cls in self.__class__.__mro__:
894
808
for name, value in (inspect.getmembers
895
(cls,
896
self._is_dbus_thing("property"))):
809
(cls, self._is_dbus_property)):
897
810
if (value._dbus_name == property_name
898
811
and value._dbus_interface == interface_name):
899
812
return value.__get__(self)
928
841
# signatures other than "ay".
929
842
if prop._dbus_signature != "ay":
930
843
raise ValueError
931
value = dbus.ByteArray(b''.join(chr(byte)
932
for byte in value))
844
value = dbus.ByteArray(''.join(unichr(byte)
845
for byte in value))
933
846
prop(value)
934
847
935
848
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
941
854
Note: Will not include properties with access="write".
942
855
"""
943
856
properties = {}
944
for name, prop in self._get_all_dbus_things("property"):
857
for name, prop in self._get_all_dbus_properties():
945
858
if (interface_name
946
859
and interface_name != prop._dbus_interface):
947
860
# Interface non-empty but did not match
962
875
path_keyword='object_path',
963
876
connection_keyword='connection')
964
877
def Introspect(self, object_path, connection):
965
"""Overloading of standard D-Bus method.
966
967
Inserts property tags and interface annotation tags.
878
"""Standard D-Bus method, overloaded to insert property tags.
968
879
"""
969
880
xmlstring = dbus.service.Object.Introspect(self, object_path,
970
881
connection)
977
888
e.setAttribute("access", prop._dbus_access)
978
889
return e
979
890
for if_tag in document.getElementsByTagName("interface"):
980
# Add property tags
981
891
for tag in (make_tag(document, name, prop)
982
892
for name, prop
983
in self._get_all_dbus_things("property")
893
in self._get_all_dbus_properties()
984
894
if prop._dbus_interface
985
895
== if_tag.getAttribute("name")):
986
896
if_tag.appendChild(tag)
987
# Add annotation tags
988
for typ in ("method", "signal", "property"):
989
for tag in if_tag.getElementsByTagName(typ):
990
annots = dict()
991
for name, prop in (self.
992
_get_all_dbus_things(typ)):
993
if (name == tag.getAttribute("name")
994
and prop._dbus_interface
995
== if_tag.getAttribute("name")):
996
annots.update(getattr
997
(prop,
998
"_dbus_annotations",
999
{}))
1000
for name, value in annots.iteritems():
1001
ann_tag = document.createElement(
1002
"annotation")
1003
ann_tag.setAttribute("name", name)
1004
ann_tag.setAttribute("value", value)
1005
tag.appendChild(ann_tag)
1006
# Add interface annotation tags
1007
for annotation, value in dict(
1008
itertools.chain.from_iterable(
1009
annotations().iteritems()
1010
for name, annotations in
1011
self._get_all_dbus_things("interface")
1012
if name == if_tag.getAttribute("name")
1013
)).iteritems():
1014
ann_tag = document.createElement("annotation")
1015
ann_tag.setAttribute("name", annotation)
1016
ann_tag.setAttribute("value", value)
1017
if_tag.appendChild(ann_tag)
1018
897
# Add the names to the return values for the
1019
898
# "org.freedesktop.DBus.Properties" methods
1020
899
if (if_tag.getAttribute("name")
1035
914
except (AttributeError, xml.dom.DOMException,
1036
915
xml.parsers.expat.ExpatError) as error:
1037
916
logger.error("Failed to override Introspection method",
1038
exc_info=error)
917
error)
1039
918
return xmlstring
1040
919
1041
920
1042
def datetime_to_dbus(dt, variant_level=0):
921
def datetime_to_dbus (dt, variant_level=0):
1043
922
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1044
923
if dt is None:
1045
924
return dbus.String("", variant_level = variant_level)
1047
926
variant_level=variant_level)
1048
927
1049
928
1050
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1051
"""A class decorator; applied to a subclass of
1052
dbus.service.Object, it will add alternate D-Bus attributes with
1053
interface names according to the "alt_interface_names" mapping.
1054
Usage:
1055
1056
@alternate_dbus_interfaces({"org.example.Interface":
1057
"net.example.AlternateInterface"})
1058
class SampleDBusObject(dbus.service.Object):
1059
@dbus.service.method("org.example.Interface")
1060
def SampleDBusMethod():
1061
pass
1062
1063
The above "SampleDBusMethod" on "SampleDBusObject" will be
1064
reachable via two interfaces: "org.example.Interface" and
1065
"net.example.AlternateInterface", the latter of which will have
1066
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1067
"true", unless "deprecate" is passed with a False value.
1068
1069
This works for methods and signals, and also for D-Bus properties
1070
(from DBusObjectWithProperties) and interfaces (from the
1071
dbus_interface_annotations decorator).
929
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
930
.__metaclass__):
931
"""Applied to an empty subclass of a D-Bus object, this metaclass
932
will add additional D-Bus attributes matching a certain pattern.
1072
933
"""
1073
def wrapper(cls):
1074
for orig_interface_name, alt_interface_name in (
1075
alt_interface_names.iteritems()):
1076
attr = {}
1077
interface_names = set()
1078
# Go though all attributes of the class
1079
for attrname, attribute in inspect.getmembers(cls):
934
def __new__(mcs, name, bases, attr):
935
# Go through all the base classes which could have D-Bus
936
# methods, signals, or properties in them
937
for base in (b for b in bases
938
if issubclass(b, dbus.service.Object)):
939
# Go though all attributes of the base class
940
for attrname, attribute in inspect.getmembers(base):
1080
941
# Ignore non-D-Bus attributes, and D-Bus attributes
1081
942
# with the wrong interface name
1082
943
if (not hasattr(attribute, "_dbus_interface")
1083
944
or not attribute._dbus_interface
1084
.startswith(orig_interface_name)):
945
.startswith("se.recompile.Mandos")):
1085
946
continue
1086
947
# Create an alternate D-Bus interface name based on
1087
948
# the current name
1088
949
alt_interface = (attribute._dbus_interface
1089
.replace(orig_interface_name,
1090
alt_interface_name))
1091
interface_names.add(alt_interface)
950
.replace("se.recompile.Mandos",
951
"se.bsnet.fukt.Mandos"))
1092
952
# Is this a D-Bus signal?
1093
953
if getattr(attribute, "_dbus_is_signal", False):
1094
# Extract the original non-method undecorated
1095
# function by black magic
954
# Extract the original non-method function by
955
# black magic
1096
956
nonmethod_func = (dict(
1097
957
zip(attribute.func_code.co_freevars,
1098
958
attribute.__closure__))["func"]
1109
969
nonmethod_func.func_name,
1110
970
nonmethod_func.func_defaults,
1111
971
nonmethod_func.func_closure)))
1112
# Copy annotations, if any
1113
try:
1114
new_function._dbus_annotations = (
1115
dict(attribute._dbus_annotations))
1116
except AttributeError:
1117
pass
1118
972
# Define a creator of a function to call both the
1119
# original and alternate functions, so both the
1120
# original and alternate signals gets sent when
1121
# the function is called
973
# old and new functions, so both the old and new
974
# signals gets sent when the function is called
1122
975
def fixscope(func1, func2):
1123
976
"""This function is a scope container to pass
1124
977
func1 and func2 to the "call_both" function
1131
984
return call_both
1132
985
# Create the "call_both" function and add it to
1133
986
# the class
1134
attr[attrname] = fixscope(attribute, new_function)
987
attr[attrname] = fixscope(attribute,
988
new_function)
1135
989
# Is this a D-Bus method?
1136
990
elif getattr(attribute, "_dbus_is_method", False):
1137
991
# Create a new, but exactly alike, function
1148
1002
attribute.func_name,
1149
1003
attribute.func_defaults,
1150
1004
attribute.func_closure)))
1151
# Copy annotations, if any
1152
try:
1153
attr[attrname]._dbus_annotations = (
1154
dict(attribute._dbus_annotations))
1155
except AttributeError:
1156
pass
1157
1005
# Is this a D-Bus property?
1158
1006
elif getattr(attribute, "_dbus_is_property", False):
1159
1007
# Create a new, but exactly alike, function
1173
1021
attribute.func_name,
1174
1022
attribute.func_defaults,
1175
1023
attribute.func_closure)))
1176
# Copy annotations, if any
1177
try:
1178
attr[attrname]._dbus_annotations = (
1179
dict(attribute._dbus_annotations))
1180
except AttributeError:
1181
pass
1182
# Is this a D-Bus interface?
1183
elif getattr(attribute, "_dbus_is_interface", False):
1184
# Create a new, but exactly alike, function
1185
# object. Decorate it to be a new D-Bus interface
1186
# with the alternate D-Bus interface name. Add it
1187
# to the class.
1188
attr[attrname] = (dbus_interface_annotations
1189
(alt_interface)
1190
(types.FunctionType
1191
(attribute.func_code,
1192
attribute.func_globals,
1193
attribute.func_name,
1194
attribute.func_defaults,
1195
attribute.func_closure)))
1196
if deprecate:
1197
# Deprecate all alternate interfaces
1198
iname="_AlternateDBusNames_interface_annotation{0}"
1199
for interface_name in interface_names:
1200
@dbus_interface_annotations(interface_name)
1201
def func(self):
1202
return { "org.freedesktop.DBus.Deprecated":
1203
"true" }
1204
# Find an unused name
1205
for aname in (iname.format(i)
1206
for i in itertools.count()):
1207
if aname not in attr:
1208
attr[aname] = func
1209
break
1210
if interface_names:
1211
# Replace the class with a new subclass of it with
1212
# methods, signals, etc. as created above.
1213
cls = type(b"{0}Alternate".format(cls.__name__),
1214
(cls,), attr)
1215
return cls
1216
return wrapper
1217
1218
1219
@alternate_dbus_interfaces({"se.recompile.Mandos":
1220
"se.bsnet.fukt.Mandos"})
1024
return type.__new__(mcs, name, bases, attr)
1025
1026
1221
1027
class ClientDBus(Client, DBusObjectWithProperties):
1222
1028
"""A Client class using D-Bus
1223
1029
1234
1040
def __init__(self, bus = None, *args, **kwargs):
1235
1041
self.bus = bus
1236
1042
Client.__init__(self, *args, **kwargs)
1043
self._approvals_pending = 0
1044
1045
self._approvals_pending = 0
1237
1046
# Only now, when this client is initialized, can it show up on
1238
1047
# the D-Bus
1239
1048
client_object_name = unicode(self.name).translate(
1243
1052
("/clients/" + client_object_name))
1244
1053
DBusObjectWithProperties.__init__(self, self.bus,
1245
1054
self.dbus_object_path)
1246
1055
1247
1056
def notifychangeproperty(transform_func,
1248
1057
dbus_name, type_func=lambda x: x,
1249
1058
variant_level=1):
1272
1081
1273
1082
return property(lambda self: getattr(self, attrname), setter)
1274
1083
1084
1275
1085
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1276
1086
approvals_pending = notifychangeproperty(dbus.Boolean,
1277
1087
"ApprovalPending",
1284
1094
checker is not None)
1285
1095
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1286
1096
"LastCheckedOK")
1287
last_checker_status = notifychangeproperty(dbus.Int16,
1288
"LastCheckerStatus")
1289
1097
last_approval_request = notifychangeproperty(
1290
1098
datetime_to_dbus, "LastApprovalRequest")
1291
1099
approved_by_default = notifychangeproperty(dbus.Boolean,
1359
1167
return False
1360
1168
1361
1169
def approve(self, value=True):
1170
self.send_changedstate()
1362
1171
self.approved = value
1363
1172
gobject.timeout_add(timedelta_to_milliseconds
1364
1173
(self.approval_duration),
1365
1174
self._reset_approved)
1366
self.send_changedstate()
1175
1367
1176
1368
1177
## D-Bus methods, signals & properties
1369
1178
_interface = "se.recompile.Mandos.Client"
1370
1179
1371
## Interfaces
1372
1373
@dbus_interface_annotations(_interface)
1374
def _foo(self):
1375
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1376
"false"}
1377
1378
1180
## Signals
1379
1181
1380
1182
# CheckerCompleted - signal
1416
1218
"D-Bus signal"
1417
1219
return self.need_approval()
1418
1220
1221
# NeRwequest - signal
1222
@dbus.service.signal(_interface, signature="s")
1223
def NewRequest(self, ip):
1224
"""D-Bus signal
1225
Is sent after a client request a password.
1226
"""
1227
pass
1228
1419
1229
## Methods
1420
1230
1421
1231
# Approve - method
1531
1341
return
1532
1342
return datetime_to_dbus(self.last_checked_ok)
1533
1343
1534
# LastCheckerStatus - property
1535
@dbus_service_property(_interface, signature="n",
1536
access="read")
1537
def LastCheckerStatus_dbus_property(self):
1538
return dbus.Int16(self.last_checker_status)
1539
1540
1344
# Expires - property
1541
1345
@dbus_service_property(_interface, signature="s", access="read")
1542
1346
def Expires_dbus_property(self):
1553
1357
def Timeout_dbus_property(self, value=None):
1554
1358
if value is None: # get
1555
1359
return dbus.UInt64(self.timeout_milliseconds())
1556
old_timeout = self.timeout
1557
1360
self.timeout = datetime.timedelta(0, 0, 0, value)
1558
# Reschedule disabling
1559
if self.enabled:
1560
now = datetime.datetime.utcnow()
1561
self.expires += self.timeout - old_timeout
1562
if self.expires <= now:
1563
# The timeout has passed
1564
self.disable()
1565
else:
1566
if (getattr(self, "disable_initiator_tag", None)
1567
is None):
1568
return
1569
gobject.source_remove(self.disable_initiator_tag)
1570
self.disable_initiator_tag = (
1571
gobject.timeout_add(
1572
timedelta_to_milliseconds(self.expires - now),
1573
self.disable))
1361
if getattr(self, "disable_initiator_tag", None) is None:
1362
return
1363
# Reschedule timeout
1364
gobject.source_remove(self.disable_initiator_tag)
1365
self.disable_initiator_tag = None
1366
self.expires = None
1367
time_to_die = timedelta_to_milliseconds((self
1368
.last_checked_ok
1369
+ self.timeout)
1370
- datetime.datetime
1371
.utcnow())
1372
if time_to_die <= 0:
1373
# The timeout has passed
1374
self.disable()
1375
else:
1376
self.expires = (datetime.datetime.utcnow()
1377
+ datetime.timedelta(milliseconds =
1378
time_to_die))
1379
self.disable_initiator_tag = (gobject.timeout_add
1380
(time_to_die, self.disable))
1574
1381
1575
1382
# ExtendedTimeout - property
1576
1383
@dbus_service_property(_interface, signature="t",
1655
1462
self._pipe.send(('setattr', name, value))
1656
1463
1657
1464
1465
class ClientDBusTransitional(ClientDBus):
1466
__metaclass__ = AlternateDBusNamesMetaclass
1467
1468
1658
1469
class ClientHandler(socketserver.BaseRequestHandler, object):
1659
1470
"""A class to handle client connections.
1660
1471
1728
1539
except KeyError:
1729
1540
return
1730
1541
1542
if self.server.use_dbus:
1543
# Emit D-Bus signal
1544
client.NewRequest(str(self.client_address))
1545
1731
1546
if client.approval_delay:
1732
1547
delay = client.approval_delay
1733
1548
client.approvals_pending += 1
1764
1579
#wait until timeout or approved
1765
1580
time = datetime.datetime.now()
1766
1581
client.changedstate.acquire()
1767
client.changedstate.wait(
1768
float(timedelta_to_milliseconds(delay)
1769
/ 1000))
1582
(client.changedstate.wait
1583
(float(client.timedelta_to_milliseconds(delay)
1584
/ 1000)))
1770
1585
client.changedstate.release()
1771
1586
time2 = datetime.datetime.now()
1772
1587
if (time2 - time) >= delay:
1788
1603
try:
1789
1604
sent = session.send(client.secret[sent_size:])
1790
1605
except gnutls.errors.GNUTLSError as error:
1791
logger.warning("gnutls send failed",
1792
exc_info=error)
1606
logger.warning("gnutls send failed")
1793
1607
return
1794
1608
logger.debug("Sent: %d, remaining: %d",
1795
1609
sent, len(client.secret)
1798
1612
1799
1613
logger.info("Sending secret to %s", client.name)
1800
1614
# bump the timeout using extended_timeout
1801
client.bump_timeout(client.extended_timeout)
1615
client.checked_ok(client.extended_timeout)
1802
1616
if self.server.use_dbus:
1803
1617
# Emit D-Bus signal
1804
1618
client.GotSecret()
1809
1623
try:
1810
1624
session.bye()
1811
1625
except gnutls.errors.GNUTLSError as error:
1812
logger.warning("GnuTLS bye failed",
1813
exc_info=error)
1626
logger.warning("GnuTLS bye failed")
1814
1627
1815
1628
@staticmethod
1816
1629
def peer_certificate(session):
1888
1701
def process_request(self, request, address):
1889
1702
"""Start a new process to process the request."""
1890
1703
proc = multiprocessing.Process(target = self.sub_process_main,
1891
args = (request, address))
1704
args = (request,
1705
address))
1892
1706
proc.start()
1893
1707
return proc
1894
1708
1922
1736
use_ipv6: Boolean; to use IPv6 or not
1923
1737
"""
1924
1738
def __init__(self, server_address, RequestHandlerClass,
1925
interface=None, use_ipv6=True, socketfd=None):
1926
"""If socketfd is set, use that file descriptor instead of
1927
creating a new one with socket.socket().
1928
"""
1739
interface=None, use_ipv6=True):
1929
1740
self.interface = interface
1930
1741
if use_ipv6:
1931
1742
self.address_family = socket.AF_INET6
1932
if socketfd is not None:
1933
# Save the file descriptor
1934
self.socketfd = socketfd
1935
# Save the original socket.socket() function
1936
self.socket_socket = socket.socket
1937
# To implement --socket, we monkey patch socket.socket.
1938
#
1939
# (When socketserver.TCPServer is a new-style class, we
1940
# could make self.socket into a property instead of monkey
1941
# patching socket.socket.)
1942
#
1943
# Create a one-time-only replacement for socket.socket()
1944
@functools.wraps(socket.socket)
1945
def socket_wrapper(*args, **kwargs):
1946
# Restore original function so subsequent calls are
1947
# not affected.
1948
socket.socket = self.socket_socket
1949
del self.socket_socket
1950
# This time only, return a new socket object from the
1951
# saved file descriptor.
1952
return socket.fromfd(self.socketfd, *args, **kwargs)
1953
# Replace socket.socket() function with wrapper
1954
socket.socket = socket_wrapper
1955
# The socketserver.TCPServer.__init__ will call
1956
# socket.socket(), which might be our replacement,
1957
# socket_wrapper(), if socketfd was set.
1958
1743
socketserver.TCPServer.__init__(self, server_address,
1959
1744
RequestHandlerClass)
1960
1961
1745
def server_bind(self):
1962
1746
"""This overrides the normal server_bind() function
1963
1747
to bind to an interface if one was specified, and also NOT to
1971
1755
try:
1972
1756
self.socket.setsockopt(socket.SOL_SOCKET,
1973
1757
SO_BINDTODEVICE,
1974
str(self.interface + '\0'))
1758
str(self.interface
1759
+ '\0'))
1975
1760
except socket.error as error:
1976
if error.errno == errno.EPERM:
1977
logger.error("No permission to bind to"
1978
" interface %s", self.interface)
1979
elif error.errno == errno.ENOPROTOOPT:
1761
if error[0] == errno.EPERM:
1762
logger.error("No permission to"
1763
" bind to interface %s",
1764
self.interface)
1765
elif error[0] == errno.ENOPROTOOPT:
1980
1766
logger.error("SO_BINDTODEVICE not available;"
1981
1767
" cannot bind to interface %s",
1982
1768
self.interface)
1983
elif error.errno == errno.ENODEV:
1984
logger.error("Interface %s does not exist,"
1985
" cannot bind", self.interface)
1986
1769
else:
1987
1770
raise
1988
1771
# Only bind(2) the socket if we really need to.
1991
1774
if self.address_family == socket.AF_INET6:
1992
1775
any_address = "::" # in6addr_any
1993
1776
else:
1994
any_address = "0.0.0.0" # INADDR_ANY
1777
any_address = socket.INADDR_ANY
1995
1778
self.server_address = (any_address,
1996
1779
self.server_address[1])
1997
1780
elif not self.server_address[1]:
2018
1801
"""
2019
1802
def __init__(self, server_address, RequestHandlerClass,
2020
1803
interface=None, use_ipv6=True, clients=None,
2021
gnutls_priority=None, use_dbus=True, socketfd=None):
1804
gnutls_priority=None, use_dbus=True):
2022
1805
self.enabled = False
2023
1806
self.clients = clients
2024
1807
if self.clients is None:
2028
1811
IPv6_TCPServer.__init__(self, server_address,
2029
1812
RequestHandlerClass,
2030
1813
interface = interface,
2031
use_ipv6 = use_ipv6,
2032
socketfd = socketfd)
1814
use_ipv6 = use_ipv6)
2033
1815
def server_activate(self):
2034
1816
if self.enabled:
2035
1817
return socketserver.TCPServer.server_activate(self)
2048
1830
2049
1831
def handle_ipc(self, source, condition, parent_pipe=None,
2050
1832
proc = None, client_object=None):
1833
condition_names = {
1834
gobject.IO_IN: "IN", # There is data to read.
1835
gobject.IO_OUT: "OUT", # Data can be written (without
1836
# blocking).
1837
gobject.IO_PRI: "PRI", # There is urgent data to read.
1838
gobject.IO_ERR: "ERR", # Error condition.
1839
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1840
# broken, usually for pipes and
1841
# sockets).
1842
}
1843
conditions_string = ' | '.join(name
1844
for cond, name in
1845
condition_names.iteritems()
1846
if cond & condition)
2051
1847
# error, or the other end of multiprocessing.Pipe has closed
2052
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1848
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2053
1849
# Wait for other process to exit
2054
1850
proc.join()
2055
1851
return False
2113
1909
return True
2114
1910
2115
1911
2116
def rfc3339_duration_to_delta(duration):
2117
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2118
2119
>>> rfc3339_duration_to_delta("P7D")
2120
datetime.timedelta(7)
2121
>>> rfc3339_duration_to_delta("PT60S")
2122
datetime.timedelta(0, 60)
2123
>>> rfc3339_duration_to_delta("PT60M")
2124
datetime.timedelta(0, 3600)
2125
>>> rfc3339_duration_to_delta("PT24H")
2126
datetime.timedelta(1)
2127
>>> rfc3339_duration_to_delta("P1W")
2128
datetime.timedelta(7)
2129
>>> rfc3339_duration_to_delta("PT5M30S")
2130
datetime.timedelta(0, 330)
2131
>>> rfc3339_duration_to_delta("P1DT3M20S")
2132
datetime.timedelta(1, 200)
2133
"""
2134
2135
# Parsing an RFC 3339 duration with regular expressions is not
2136
# possible - there would have to be multiple places for the same
2137
# values, like seconds. The current code, while more esoteric, is
2138
# cleaner without depending on a parsing library. If Python had a
2139
# built-in library for parsing we would use it, but we'd like to
2140
# avoid excessive use of external libraries.
2141
2142
# New type for defining tokens, syntax, and semantics all-in-one
2143
Token = collections.namedtuple("Token",
2144
("regexp", # To match token; if
2145
# "value" is not None,
2146
# must have a "group"
2147
# containing digits
2148
"value", # datetime.timedelta or
2149
# None
2150
"followers")) # Tokens valid after
2151
# this token
2152
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2153
# the "duration" ABNF definition in RFC 3339, Appendix A.
2154
token_end = Token(re.compile(r"$"), None, frozenset())
2155
token_second = Token(re.compile(r"(\d+)S"),
2156
datetime.timedelta(seconds=1),
2157
frozenset((token_end,)))
2158
token_minute = Token(re.compile(r"(\d+)M"),
2159
datetime.timedelta(minutes=1),
2160
frozenset((token_second, token_end)))
2161
token_hour = Token(re.compile(r"(\d+)H"),
2162
datetime.timedelta(hours=1),
2163
frozenset((token_minute, token_end)))
2164
token_time = Token(re.compile(r"T"),
2165
None,
2166
frozenset((token_hour, token_minute,
2167
token_second)))
2168
token_day = Token(re.compile(r"(\d+)D"),
2169
datetime.timedelta(days=1),
2170
frozenset((token_time, token_end)))
2171
token_month = Token(re.compile(r"(\d+)M"),
2172
datetime.timedelta(weeks=4),
2173
frozenset((token_day, token_end)))
2174
token_year = Token(re.compile(r"(\d+)Y"),
2175
datetime.timedelta(weeks=52),
2176
frozenset((token_month, token_end)))
2177
token_week = Token(re.compile(r"(\d+)W"),
2178
datetime.timedelta(weeks=1),
2179
frozenset((token_end,)))
2180
token_duration = Token(re.compile(r"P"), None,
2181
frozenset((token_year, token_month,
2182
token_day, token_time,
2183
token_week))),
2184
# Define starting values
2185
value = datetime.timedelta() # Value so far
2186
found_token = None
2187
followers = frozenset(token_duration,) # Following valid tokens
2188
s = duration # String left to parse
2189
# Loop until end token is found
2190
while found_token is not token_end:
2191
# Search for any currently valid tokens
2192
for token in followers:
2193
match = token.regexp.match(s)
2194
if match is not None:
2195
# Token found
2196
if token.value is not None:
2197
# Value found, parse digits
2198
factor = int(match.group(1), 10)
2199
# Add to value so far
2200
value += factor * token.value
2201
# Strip token from string
2202
s = token.regexp.sub("", s, 1)
2203
# Go to found token
2204
found_token = token
2205
# Set valid next tokens
2206
followers = found_token.followers
2207
break
2208
else:
2209
# No currently valid tokens were found
2210
raise ValueError("Invalid RFC 3339 duration")
2211
# End token found
2212
return value
2213
2214
2215
1912
def string_to_delta(interval):
2216
1913
"""Parse a string and return a datetime.timedelta
2217
1914
2228
1925
>>> string_to_delta('5m 30s')
2229
1926
datetime.timedelta(0, 330)
2230
1927
"""
2231
2232
try:
2233
return rfc3339_duration_to_delta(interval)
2234
except ValueError:
2235
pass
2236
2237
1928
timevalue = datetime.timedelta(0)
2238
1929
for s in interval.split():
2239
1930
try:
2250
1941
elif suffix == "w":
2251
1942
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2252
1943
else:
2253
raise ValueError("Unknown suffix {0!r}"
2254
.format(suffix))
1944
raise ValueError("Unknown suffix %r" % suffix)
2255
1945
except (ValueError, IndexError) as e:
2256
1946
raise ValueError(*(e.args))
2257
1947
timevalue += delta
2271
1961
sys.exit()
2272
1962
if not noclose:
2273
1963
# Close all standard open file descriptors
2274
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1964
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2275
1965
if not stat.S_ISCHR(os.fstat(null).st_mode):
2276
1966
raise OSError(errno.ENODEV,
2277
"{0} not a character device"
2278
.format(os.devnull))
1967
"%s not a character device"
1968
% os.path.devnull)
2279
1969
os.dup2(null, sys.stdin.fileno())
2280
1970
os.dup2(null, sys.stdout.fileno())
2281
1971
os.dup2(null, sys.stderr.fileno())
2290
1980
2291
1981
parser = argparse.ArgumentParser()
2292
1982
parser.add_argument("-v", "--version", action="version",
2293
version = "%(prog)s {0}".format(version),
1983
version = "%%(prog)s %s" % version,
2294
1984
help="show version number and exit")
2295
1985
parser.add_argument("-i", "--interface", metavar="IF",
2296
1986
help="Bind to interface IF")
2302
1992
help="Run self-test")
2303
1993
parser.add_argument("--debug", action="store_true",
2304
1994
help="Debug mode; run in foreground and log"
2305
" to terminal", default=None)
1995
" to terminal")
2306
1996
parser.add_argument("--debuglevel", metavar="LEVEL",
2307
1997
help="Debug level for stdout output")
2308
1998
parser.add_argument("--priority", help="GnuTLS"
2315
2005
" files")
2316
2006
parser.add_argument("--no-dbus", action="store_false",
2317
2007
dest="use_dbus", help="Do not provide D-Bus"
2318
" system bus interface", default=None)
2008
" system bus interface")
2319
2009
parser.add_argument("--no-ipv6", action="store_false",
2320
dest="use_ipv6", help="Do not use IPv6",
2321
default=None)
2010
dest="use_ipv6", help="Do not use IPv6")
2322
2011
parser.add_argument("--no-restore", action="store_false",
2323
2012
dest="restore", help="Do not restore stored"
2324
" state", default=None)
2325
parser.add_argument("--socket", type=int,
2326
help="Specify a file descriptor to a network"
2327
" socket to use instead of creating one")
2013
" state")
2328
2014
parser.add_argument("--statedir", metavar="DIR",
2329
2015
help="Directory to save/restore state in")
2330
parser.add_argument("--foreground", action="store_true",
2331
help="Run in foreground", default=None)
2332
2016
2333
2017
options = parser.parse_args()
2334
2018
2349
2033
"use_ipv6": "True",
2350
2034
"debuglevel": "",
2351
2035
"restore": "True",
2352
"socket": "",
2353
"statedir": "/var/lib/mandos",
2354
"foreground": "False",
2036
"statedir": "/var/lib/mandos"
2355
2037
}
2356
2038
2357
2039
# Parse config file for server-global settings
2362
2044
# Convert the SafeConfigParser object to a dict
2363
2045
server_settings = server_config.defaults()
2364
2046
# Use the appropriate methods on the non-string config options
2365
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2047
for option in ("debug", "use_dbus", "use_ipv6"):
2366
2048
server_settings[option] = server_config.getboolean("DEFAULT",
2367
2049
option)
2368
2050
if server_settings["port"]:
2369
2051
server_settings["port"] = server_config.getint("DEFAULT",
2370
2052
"port")
2371
if server_settings["socket"]:
2372
server_settings["socket"] = server_config.getint("DEFAULT",
2373
"socket")
2374
# Later, stdin will, and stdout and stderr might, be dup'ed
2375
# over with an opened os.devnull. But we don't want this to
2376
# happen with a supplied network socket.
2377
if 0 <= server_settings["socket"] <= 2:
2378
server_settings["socket"] = os.dup(server_settings
2379
["socket"])
2380
2053
del server_config
2381
2054
2382
2055
# Override the settings from the config file with command line
2384
2057
for option in ("interface", "address", "port", "debug",
2385
2058
"priority", "servicename", "configdir",
2386
2059
"use_dbus", "use_ipv6", "debuglevel", "restore",
2387
"statedir", "socket", "foreground"):
2060
"statedir"):
2388
2061
value = getattr(options, option)
2389
2062
if value is not None:
2390
2063
server_settings[option] = value
2393
2066
for option in server_settings.keys():
2394
2067
if type(server_settings[option]) is str:
2395
2068
server_settings[option] = unicode(server_settings[option])
2396
# Force all boolean options to be boolean
2397
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2398
"foreground"):
2399
server_settings[option] = bool(server_settings[option])
2400
# Debug implies foreground
2401
if server_settings["debug"]:
2402
server_settings["foreground"] = True
2403
2069
# Now we have our good server settings in "server_settings"
2404
2070
2405
2071
##################################################################
2411
2077
use_ipv6 = server_settings["use_ipv6"]
2412
2078
stored_state_path = os.path.join(server_settings["statedir"],
2413
2079
stored_state_file)
2414
foreground = server_settings["foreground"]
2415
2080
2416
2081
if debug:
2417
2082
initlogger(debug, logging.DEBUG)
2424
2089
2425
2090
if server_settings["servicename"] != "Mandos":
2426
2091
syslogger.setFormatter(logging.Formatter
2427
('Mandos ({0}) [%(process)d]:'
2428
' %(levelname)s: %(message)s'
2429
.format(server_settings
2430
["servicename"])))
2092
('Mandos (%s) [%%(process)d]:'
2093
' %%(levelname)s: %%(message)s'
2094
% server_settings["servicename"]))
2431
2095
2432
2096
# Parse config file with clients
2433
client_config = configparser.SafeConfigParser(Client
2434
.client_defaults)
2097
client_config = configparser.SafeConfigParser(Client.client_defaults)
2435
2098
client_config.read(os.path.join(server_settings["configdir"],
2436
2099
"clients.conf"))
2437
2100
2446
2109
use_ipv6=use_ipv6,
2447
2110
gnutls_priority=
2448
2111
server_settings["priority"],
2449
use_dbus=use_dbus,
2450
socketfd=(server_settings["socket"]
2451
or None))
2452
if not foreground:
2453
pidfilename = "/run/mandos.pid"
2454
pidfile = None
2112
use_dbus=use_dbus)
2113
if not debug:
2114
pidfilename = "/var/run/mandos.pid"
2455
2115
try:
2456
2116
pidfile = open(pidfilename, "w")
2457
except IOError as e:
2458
logger.error("Could not open file %r", pidfilename,
2459
exc_info=e)
2117
except IOError:
2118
logger.error("Could not open file %r", pidfilename)
2460
2119
2461
for name in ("_mandos", "mandos", "nobody"):
2120
try:
2121
uid = pwd.getpwnam("_mandos").pw_uid
2122
gid = pwd.getpwnam("_mandos").pw_gid
2123
except KeyError:
2462
2124
try:
2463
uid = pwd.getpwnam(name).pw_uid
2464
gid = pwd.getpwnam(name).pw_gid
2465
break
2125
uid = pwd.getpwnam("mandos").pw_uid
2126
gid = pwd.getpwnam("mandos").pw_gid
2466
2127
except KeyError:
2467
continue
2468
else:
2469
uid = 65534
2470
gid = 65534
2128
try:
2129
uid = pwd.getpwnam("nobody").pw_uid
2130
gid = pwd.getpwnam("nobody").pw_gid
2131
except KeyError:
2132
uid = 65534
2133
gid = 65534
2471
2134
try:
2472
2135
os.setgid(gid)
2473
2136
os.setuid(uid)
2474
2137
except OSError as error:
2475
if error.errno != errno.EPERM:
2138
if error[0] != errno.EPERM:
2476
2139
raise error
2477
2140
2478
2141
if debug:
2490
2153
.gnutls_global_set_log_function(debug_gnutls))
2491
2154
2492
2155
# Redirect stdin so all checkers get /dev/null
2493
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2494
2157
os.dup2(null, sys.stdin.fileno())
2495
2158
if null > 2:
2496
2159
os.close(null)
2497
2160
2498
2161
# Need to fork before connecting to D-Bus
2499
if not foreground:
2162
if not debug:
2500
2163
# Close all input and output, do double fork, etc.
2501
2164
daemon()
2502
2165
2503
# multiprocessing will use threads, so before we use gobject we
2504
# need to inform gobject that threads will be used.
2505
2166
gobject.threads_init()
2506
2167
2507
2168
global main_loop
2508
2169
# From the Avahi example code
2509
DBusGMainLoop(set_as_default=True)
2170
DBusGMainLoop(set_as_default=True )
2510
2171
main_loop = gobject.MainLoop()
2511
2172
bus = dbus.SystemBus()
2512
2173
# End of Avahi example code
2518
2179
("se.bsnet.fukt.Mandos", bus,
2519
2180
do_not_queue=True))
2520
2181
except dbus.exceptions.NameExistsException as e:
2521
logger.error("Disabling D-Bus:", exc_info=e)
2182
logger.error(unicode(e) + ", disabling D-Bus")
2522
2183
use_dbus = False
2523
2184
server_settings["use_dbus"] = False
2524
2185
tcp_server.use_dbus = False
2536
2197
2537
2198
client_class = Client
2538
2199
if use_dbus:
2539
client_class = functools.partial(ClientDBus, bus = bus)
2200
client_class = functools.partial(ClientDBusTransitional,
2201
bus = bus)
2540
2202
2541
2203
client_settings = Client.config_parser(client_config)
2542
2204
old_client_settings = {}
2543
2205
clients_data = {}
2544
2206
2545
# This is used to redirect stdout and stderr for checker processes
2546
global wnull
2547
wnull = open(os.devnull, "w") # A writable /dev/null
2548
# Only used if server is running in foreground but not in debug
2549
# mode
2550
if debug or not foreground:
2551
wnull.close()
2552
2553
2207
# Get client data and settings from last running state.
2554
2208
if server_settings["restore"]:
2555
2209
try:
2558
2212
(stored_state))
2559
2213
os.remove(stored_state_path)
2560
2214
except IOError as e:
2561
if e.errno == errno.ENOENT:
2562
logger.warning("Could not load persistent state: {0}"
2563
.format(os.strerror(e.errno)))
2564
else:
2565
logger.critical("Could not load persistent state:",
2566
exc_info=e)
2215
logger.warning("Could not load persistent state: {0}"
2216
.format(e))
2217
if e.errno != errno.ENOENT:
2567
2218
raise
2568
2219
except EOFError as e:
2569
2220
logger.warning("Could not load persistent state: "
2570
"EOFError:", exc_info=e)
2221
"EOFError: {0}".format(e))
2571
2222
2572
2223
with PGPEngine() as pgp:
2573
2224
for client_name, client in clients_data.iteritems():
2574
# Skip removed clients
2575
if client_name not in client_settings:
2576
continue
2577
2578
2225
# Decide which value to use after restoring saved state.
2579
2226
# We have three different values: Old config file,
2580
2227
# new config file, and saved state.
2594
2241
2595
2242
# Clients who has passed its expire date can still be
2596
2243
# enabled if its last checker was successful. Clients
2597
# whose checker succeeded before we stored its state is
2598
# assumed to have successfully run all checkers during
2599
# downtime.
2244
# whose checker failed before we stored its state is
2245
# assumed to have failed all checkers during downtime.
2600
2246
if client["enabled"]:
2601
2247
if datetime.datetime.utcnow() >= client["expires"]:
2602
2248
if not client["last_checked_ok"]:
2603
2249
logger.warning(
2604
2250
"disabling client {0} - Client never "
2605
"performed a successful checker"
2606
.format(client_name))
2251
"performed a successfull checker"
2252
.format(client["name"]))
2607
2253
client["enabled"] = False
2608
2254
elif client["last_checker_status"] != 0:
2609
2255
logger.warning(
2610
2256
"disabling client {0} - Client "
2611
2257
"last checker failed with error code {1}"
2612
.format(client_name,
2258
.format(client["name"],
2613
2259
client["last_checker_status"]))
2614
2260
client["enabled"] = False
2615
2261
else:
2616
2262
client["expires"] = (datetime.datetime
2617
2263
.utcnow()
2618
2264
+ client["timeout"])
2619
logger.debug("Last checker succeeded,"
2620
" keeping {0} enabled"
2621
.format(client_name))
2265
2622
2266
try:
2623
2267
client["secret"] = (
2624
2268
pgp.decrypt(client["encrypted_secret"],
2630
2274
.format(client_name))
2631
2275
client["secret"] = (
2632
2276
client_settings[client_name]["secret"])
2277
2633
2278
2634
2279
# Add/remove clients based on new changes made to config
2635
for client_name in (set(old_client_settings)
2636
- set(client_settings)):
2280
for client_name in set(old_client_settings) - set(client_settings):
2637
2281
del clients_data[client_name]
2638
for client_name in (set(client_settings)
2639
- set(old_client_settings)):
2282
for client_name in set(client_settings) - set(old_client_settings):
2640
2283
clients_data[client_name] = client_settings[client_name]
2641
2642
# Create all client objects
2284
2285
# Create clients all clients
2643
2286
for client_name, client in clients_data.iteritems():
2644
2287
tcp_server.clients[client_name] = client_class(
2645
name = client_name, settings = client,
2646
server_settings = server_settings)
2288
name = client_name, settings = client)
2647
2289
2648
2290
if not tcp_server.clients:
2649
2291
logger.warning("No clients defined")
2650
2651
if not foreground:
2652
if pidfile is not None:
2653
try:
2654
with pidfile:
2655
pid = os.getpid()
2656
pidfile.write(str(pid) + "\n".encode("utf-8"))
2657
except IOError:
2658
logger.error("Could not write to file %r with PID %d",
2659
pidfilename, pid)
2660
del pidfile
2292
2293
if not debug:
2294
try:
2295
with pidfile:
2296
pid = os.getpid()
2297
pidfile.write(str(pid) + "\n".encode("utf-8"))
2298
del pidfile
2299
except IOError:
2300
logger.error("Could not write to file %r with PID %d",
2301
pidfilename, pid)
2302
except NameError:
2303
# "pidfile" was never created
2304
pass
2661
2305
del pidfilename
2306
signal.signal(signal.SIGINT, signal.SIG_IGN)
2662
2307
2663
2308
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2664
2309
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2665
2310
2666
2311
if use_dbus:
2667
@alternate_dbus_interfaces({"se.recompile.Mandos":
2668
"se.bsnet.fukt.Mandos"})
2669
class MandosDBusService(DBusObjectWithProperties):
2312
class MandosDBusService(dbus.service.Object):
2670
2313
"""A D-Bus proxy object"""
2671
2314
def __init__(self):
2672
2315
dbus.service.Object.__init__(self, bus, "/")
2673
2316
_interface = "se.recompile.Mandos"
2674
2317
2675
@dbus_interface_annotations(_interface)
2676
def _foo(self):
2677
return { "org.freedesktop.DBus.Property"
2678
".EmitsChangedSignal":
2679
"false"}
2680
2681
2318
@dbus.service.signal(_interface, signature="o")
2682
2319
def ClientAdded(self, objpath):
2683
2320
"D-Bus signal"
2725
2362
2726
2363
del _interface
2727
2364
2728
mandos_dbus_service = MandosDBusService()
2365
class MandosDBusServiceTransitional(MandosDBusService):
2366
__metaclass__ = AlternateDBusNamesMetaclass
2367
mandos_dbus_service = MandosDBusServiceTransitional()
2729
2368
2730
2369
def cleanup():
2731
2370
"Cleanup function; run on exit"
2732
2371
service.cleanup()
2733
2372
2734
2373
multiprocessing.active_children()
2735
wnull.close()
2736
2374
if not (tcp_server.clients or client_settings):
2737
2375
return
2738
2376
2750
2388
# A list of attributes that can not be pickled
2751
2389
# + secret.
2752
2390
exclude = set(("bus", "changedstate", "secret",
2753
"checker", "server_settings"))
2391
"checker"))
2754
2392
for name, typ in (inspect.getmembers
2755
2393
(dbus.service.Object)):
2756
2394
exclude.add(name)
2765
2403
del client_settings[client.name]["secret"]
2766
2404
2767
2405
try:
2768
with (tempfile.NamedTemporaryFile
2769
(mode='wb', suffix=".pickle", prefix='clients-',
2770
dir=os.path.dirname(stored_state_path),
2771
delete=False)) as stored_state:
2406
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2407
prefix="clients-",
2408
dir=os.path.dirname
2409
(stored_state_path))
2410
with os.fdopen(tempfd, "wb") as stored_state:
2772
2411
pickle.dump((clients, client_settings), stored_state)
2773
tempname=stored_state.name
2774
2412
os.rename(tempname, stored_state_path)
2775
2413
except (IOError, OSError) as e:
2414
logger.warning("Could not save persistent state: {0}"
2415
.format(e))
2776
2416
if not debug:
2777
2417
try:
2778
2418
os.remove(tempname)
2779
2419
except NameError:
2780
2420
pass
2781
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2782
logger.warning("Could not save persistent state: {0}"
2783
.format(os.strerror(e.errno)))
2784
else:
2785
logger.warning("Could not save persistent state:",
2786
exc_info=e)
2421
if e.errno not in set((errno.ENOENT, errno.EACCES,
2422
errno.EEXIST)):
2787
2423
raise e
2788
2424
2789
2425
# Delete all clients, and settings from config
2817
2453
service.port = tcp_server.socket.getsockname()[1]
2818
2454
if use_ipv6:
2819
2455
logger.info("Now listening on address %r, port %d,"
2820
" flowinfo %d, scope_id %d",
2821
*tcp_server.socket.getsockname())
2456
" flowinfo %d, scope_id %d"
2457
% tcp_server.socket.getsockname())
2822
2458
else: # IPv4
2823
logger.info("Now listening on address %r, port %d",
2824
*tcp_server.socket.getsockname())
2459
logger.info("Now listening on address %r, port %d"
2460
% tcp_server.socket.getsockname())
2825
2461
2826
2462
#service.interface = tcp_server.socket.getsockname()[3]
2827
2463
2830
2466
try:
2831
2467
service.activate()
2832
2468
except dbus.exceptions.DBusException as error:
2833
logger.critical("D-Bus Exception", exc_info=error)
2469
logger.critical("DBusException: %s", error)
2834
2470
cleanup()
2835
2471
sys.exit(1)
2836
2472
# End of Avahi example code
2843
2479
logger.debug("Starting main loop")
2844
2480
main_loop.run()
2845
2481
except AvahiError as error:
2846
logger.critical("Avahi Error", exc_info=error)
2482
logger.critical("AvahiError: %s", error)
2847
2483
cleanup()
2848
2484
sys.exit(1)
2849
2485
except KeyboardInterrupt:
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0