/mandos/trunk

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

  • Committer: Teddy Hogeborn
  • Date: 2012-05-12 19:56:55 UTC
  • mfrom: (237.6.2 nmu)
  • mto: (237.4.31 release)
  • mto: This revision was merged to the branch mainline in revision 586.
  • Revision ID: teddy@recompile.se-20120512195655-cy7w8ts3l9p22l3z
Tags: version-1.5.3-1.2
Merge NMU change

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-2012 Teddy Hogeborn
 
15
# Copyright © 2008-2012 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
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.2"
 
88
version = "1.5.3"
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',
 
146
                                              '--no-use-agent'])
148
147
    
149
148
    def __enter__(self):
150
149
        return self
151
150
    
152
 
    def __exit__(self, exc_type, exc_value, traceback):
 
151
    def __exit__ (self, exc_type, exc_value, traceback):
153
152
        self._cleanup()
154
153
        return False
155
154
    
172
171
    def password_encode(self, password):
173
172
        # Passphrase can not be empty and can not contain newlines or
174
173
        # NUL bytes.  So we prefix it and hex encode it.
175
 
        encoded = b"mandos" + binascii.hexlify(password)
176
 
        if len(encoded) > 2048:
177
 
            # GnuPG can't handle long passwords, so encode differently
178
 
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
179
 
                       .replace(b"\n", b"\\n")
180
 
                       .replace(b"\0", b"\\x00"))
181
 
        return encoded
 
174
        return b"mandos" + binascii.hexlify(password)
182
175
    
183
176
    def encrypt(self, data, password):
184
 
        passphrase = self.password_encode(password)
185
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
186
 
                                         ) as passfile:
187
 
            passfile.write(passphrase)
188
 
            passfile.flush()
189
 
            proc = subprocess.Popen(['gpg', '--symmetric',
190
 
                                     '--passphrase-file',
191
 
                                     passfile.name]
192
 
                                    + self.gnupgargs,
193
 
                                    stdin = subprocess.PIPE,
194
 
                                    stdout = subprocess.PIPE,
195
 
                                    stderr = subprocess.PIPE)
196
 
            ciphertext, err = proc.communicate(input = data)
197
 
        if proc.returncode != 0:
198
 
            raise PGPError(err)
 
177
        self.gnupg.passphrase = self.password_encode(password)
 
178
        with open(os.devnull) as devnull:
 
179
            try:
 
180
                proc = self.gnupg.run(['--symmetric'],
 
181
                                      create_fhs=['stdin', 'stdout'],
 
182
                                      attach_fhs={'stderr': devnull})
 
183
                with contextlib.closing(proc.handles['stdin']) as f:
 
184
                    f.write(data)
 
185
                with contextlib.closing(proc.handles['stdout']) as f:
 
186
                    ciphertext = f.read()
 
187
                proc.wait()
 
188
            except IOError as e:
 
189
                raise PGPError(e)
 
190
        self.gnupg.passphrase = None
199
191
        return ciphertext
200
192
    
201
193
    def decrypt(self, data, password):
202
 
        passphrase = self.password_encode(password)
203
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
204
 
                                         ) as passfile:
205
 
            passfile.write(passphrase)
206
 
            passfile.flush()
207
 
            proc = subprocess.Popen(['gpg', '--decrypt',
208
 
                                     '--passphrase-file',
209
 
                                     passfile.name]
210
 
                                    + self.gnupgargs,
211
 
                                    stdin = subprocess.PIPE,
212
 
                                    stdout = subprocess.PIPE,
213
 
                                    stderr = subprocess.PIPE)
214
 
            decrypted_plaintext, err = proc.communicate(input
215
 
                                                        = data)
216
 
        if proc.returncode != 0:
217
 
            raise PGPError(err)
 
194
        self.gnupg.passphrase = self.password_encode(password)
 
195
        with open(os.devnull) as devnull:
 
196
            try:
 
197
                proc = self.gnupg.run(['--decrypt'],
 
198
                                      create_fhs=['stdin', 'stdout'],
 
199
                                      attach_fhs={'stderr': devnull})
 
200
                with contextlib.closing(proc.handles['stdin'] ) as f:
 
201
                    f.write(data)
 
202
                with contextlib.closing(proc.handles['stdout']) as f:
 
203
                    decrypted_plaintext = f.read()
 
204
                proc.wait()
 
205
            except IOError as e:
 
206
                raise PGPError(e)
 
207
        self.gnupg.passphrase = None
218
208
        return decrypted_plaintext
219
209
 
220
210
 
 
211
 
221
212
class AvahiError(Exception):
222
213
    def __init__(self, value, *args, **kwargs):
223
214
        self.value = value
240
231
               Used to optionally bind to the specified interface.
241
232
    name: string; Example: 'Mandos'
242
233
    type: string; Example: '_mandos._tcp'.
243
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
234
                  See <http://www.dns-sd.org/ServiceTypes.html>
244
235
    port: integer; what port to announce
245
236
    TXT: list of strings; TXT record for the service
246
237
    domain: string; Domain to publish on, default to .local if empty.
252
243
    server: D-Bus Server
253
244
    bus: dbus.SystemBus()
254
245
    """
255
 
    
256
246
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
257
247
                 servicetype = None, port = None, TXT = None,
258
248
                 domain = "", host = "", max_renames = 32768,
271
261
        self.server = None
272
262
        self.bus = bus
273
263
        self.entry_group_state_changed_match = None
274
 
    
275
264
    def rename(self):
276
265
        """Derived from the Avahi example code"""
277
266
        if self.rename_count >= self.max_renames:
287
276
        try:
288
277
            self.add()
289
278
        except dbus.exceptions.DBusException as error:
290
 
            logger.critical("D-Bus Exception", exc_info=error)
 
279
            logger.critical("DBusException: %s", error)
291
280
            self.cleanup()
292
281
            os._exit(1)
293
282
        self.rename_count += 1
294
 
    
295
283
    def remove(self):
296
284
        """Derived from the Avahi example code"""
297
285
        if self.entry_group_state_changed_match is not None:
299
287
            self.entry_group_state_changed_match = None
300
288
        if self.group is not None:
301
289
            self.group.Reset()
302
 
    
303
290
    def add(self):
304
291
        """Derived from the Avahi example code"""
305
292
        self.remove()
322
309
            dbus.UInt16(self.port),
323
310
            avahi.string_array_to_txt_array(self.TXT))
324
311
        self.group.Commit()
325
 
    
326
312
    def entry_group_state_changed(self, state, error):
327
313
        """Derived from the Avahi example code"""
328
314
        logger.debug("Avahi entry group state change: %i", state)
335
321
        elif state == avahi.ENTRY_GROUP_FAILURE:
336
322
            logger.critical("Avahi: Error in group state changed %s",
337
323
                            unicode(error))
338
 
            raise AvahiGroupError("State changed: {0!s}"
339
 
                                  .format(error))
340
 
    
 
324
            raise AvahiGroupError("State changed: %s"
 
325
                                  % unicode(error))
341
326
    def cleanup(self):
342
327
        """Derived from the Avahi example code"""
343
328
        if self.group is not None:
348
333
                pass
349
334
            self.group = None
350
335
        self.remove()
351
 
    
352
336
    def server_state_changed(self, state, error=None):
353
337
        """Derived from the Avahi example code"""
354
338
        logger.debug("Avahi server state change: %i", state)
373
357
                logger.debug("Unknown state: %r", state)
374
358
            else:
375
359
                logger.debug("Unknown state: %r: %r", state, error)
376
 
    
377
360
    def activate(self):
378
361
        """Derived from the Avahi example code"""
379
362
        if self.server is None:
386
369
                                 self.server_state_changed)
387
370
        self.server_state_changed(self.server.GetState())
388
371
 
389
 
 
390
372
class AvahiServiceToSyslog(AvahiService):
391
373
    def rename(self):
392
374
        """Add the new name to the syslog messages"""
393
375
        ret = AvahiService.rename(self)
394
376
        syslogger.setFormatter(logging.Formatter
395
 
                               ('Mandos ({0}) [%(process)d]:'
396
 
                                ' %(levelname)s: %(message)s'
397
 
                                .format(self.name)))
 
377
                               ('Mandos (%s) [%%(process)d]:'
 
378
                                ' %%(levelname)s: %%(message)s'
 
379
                                % self.name))
398
380
        return ret
399
381
 
400
 
 
401
382
def timedelta_to_milliseconds(td):
402
383
    "Convert a datetime.timedelta() to milliseconds"
403
384
    return ((td.days * 24 * 60 * 60 * 1000)
404
385
            + (td.seconds * 1000)
405
386
            + (td.microseconds // 1000))
406
 
 
407
 
 
 
387
        
408
388
class Client(object):
409
389
    """A representation of a client host served by this server.
410
390
    
446
426
    runtime_expansions: Allowed attributes for runtime expansion.
447
427
    expires:    datetime.datetime(); time (UTC) when a client will be
448
428
                disabled, or None
449
 
    server_settings: The server_settings dict from main()
450
429
    """
451
430
    
452
431
    runtime_expansions = ("approval_delay", "approval_duration",
453
 
                          "created", "enabled", "expires",
454
 
                          "fingerprint", "host", "interval",
455
 
                          "last_approval_request", "last_checked_ok",
 
432
                          "created", "enabled", "fingerprint",
 
433
                          "host", "interval", "last_checked_ok",
456
434
                          "last_enabled", "name", "timeout")
457
 
    client_defaults = { "timeout": "PT5M",
458
 
                        "extended_timeout": "PT15M",
459
 
                        "interval": "PT2M",
 
435
    client_defaults = { "timeout": "5m",
 
436
                        "extended_timeout": "15m",
 
437
                        "interval": "2m",
460
438
                        "checker": "fping -q -- %%(host)s",
461
439
                        "host": "",
462
 
                        "approval_delay": "PT0S",
463
 
                        "approval_duration": "PT1S",
 
440
                        "approval_delay": "0s",
 
441
                        "approval_duration": "1s",
464
442
                        "approved_by_default": "True",
465
443
                        "enabled": "True",
466
444
                        }
479
457
    
480
458
    def approval_delay_milliseconds(self):
481
459
        return timedelta_to_milliseconds(self.approval_delay)
482
 
    
 
460
 
483
461
    @staticmethod
484
462
    def config_parser(config):
485
463
        """Construct a new dict of client settings of this form:
510
488
                          "rb") as secfile:
511
489
                    client["secret"] = secfile.read()
512
490
            else:
513
 
                raise TypeError("No secret or secfile for section {0}"
514
 
                                .format(section))
 
491
                raise TypeError("No secret or secfile for section %s"
 
492
                                % section)
515
493
            client["timeout"] = string_to_delta(section["timeout"])
516
494
            client["extended_timeout"] = string_to_delta(
517
495
                section["extended_timeout"])
526
504
            client["last_checker_status"] = -2
527
505
        
528
506
        return settings
529
 
    
530
 
    def __init__(self, settings, name = None, server_settings=None):
 
507
        
 
508
        
 
509
    def __init__(self, settings, name = None):
 
510
        """Note: the 'checker' key in 'config' sets the
 
511
        'checker_command' attribute and *not* the 'checker'
 
512
        attribute."""
531
513
        self.name = name
532
 
        if server_settings is None:
533
 
            server_settings = {}
534
 
        self.server_settings = server_settings
535
514
        # adding all client settings
536
515
        for setting, value in settings.iteritems():
537
516
            setattr(self, setting, value)
545
524
        else:
546
525
            self.last_enabled = None
547
526
            self.expires = None
548
 
        
 
527
       
549
528
        logger.debug("Creating client %r", self.name)
550
529
        # Uppercase and remove spaces from fingerprint for later
551
530
        # comparison purposes with return value from the fingerprint()
553
532
        logger.debug("  Fingerprint: %s", self.fingerprint)
554
533
        self.created = settings.get("created",
555
534
                                    datetime.datetime.utcnow())
556
 
        
 
535
 
557
536
        # attributes specific for this server instance
558
537
        self.checker = None
559
538
        self.checker_initiator_tag = None
587
566
        if getattr(self, "enabled", False):
588
567
            # Already enabled
589
568
            return
 
569
        self.send_changedstate()
590
570
        self.expires = datetime.datetime.utcnow() + self.timeout
591
571
        self.enabled = True
592
572
        self.last_enabled = datetime.datetime.utcnow()
593
573
        self.init_checker()
594
 
        self.send_changedstate()
595
574
    
596
575
    def disable(self, quiet=True):
597
576
        """Disable this client."""
598
577
        if not getattr(self, "enabled", False):
599
578
            return False
600
579
        if not quiet:
 
580
            self.send_changedstate()
 
581
        if not quiet:
601
582
            logger.info("Disabling client %s", self.name)
602
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
583
        if getattr(self, "disable_initiator_tag", False):
603
584
            gobject.source_remove(self.disable_initiator_tag)
604
585
            self.disable_initiator_tag = None
605
586
        self.expires = None
606
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
587
        if getattr(self, "checker_initiator_tag", False):
607
588
            gobject.source_remove(self.checker_initiator_tag)
608
589
            self.checker_initiator_tag = None
609
590
        self.stop_checker()
610
591
        self.enabled = False
611
 
        if not quiet:
612
 
            self.send_changedstate()
613
592
        # Do not run this again if called by a gobject.timeout_add
614
593
        return False
615
594
    
619
598
    def init_checker(self):
620
599
        # Schedule a new checker to be started an 'interval' from now,
621
600
        # and every interval from then on.
622
 
        if self.checker_initiator_tag is not None:
623
 
            gobject.source_remove(self.checker_initiator_tag)
624
601
        self.checker_initiator_tag = (gobject.timeout_add
625
602
                                      (self.interval_milliseconds(),
626
603
                                       self.start_checker))
627
604
        # Schedule a disable() when 'timeout' has passed
628
 
        if self.disable_initiator_tag is not None:
629
 
            gobject.source_remove(self.disable_initiator_tag)
630
605
        self.disable_initiator_tag = (gobject.timeout_add
631
606
                                   (self.timeout_milliseconds(),
632
607
                                    self.disable))
663
638
            timeout = self.timeout
664
639
        if self.disable_initiator_tag is not None:
665
640
            gobject.source_remove(self.disable_initiator_tag)
666
 
            self.disable_initiator_tag = None
667
641
        if getattr(self, "enabled", False):
668
642
            self.disable_initiator_tag = (gobject.timeout_add
669
643
                                          (timedelta_to_milliseconds
679
653
        If a checker already exists, leave it running and do
680
654
        nothing."""
681
655
        # The reason for not killing a running checker is that if we
682
 
        # did that, and if a checker (for some reason) started running
683
 
        # slowly and taking more than 'interval' time, then the client
684
 
        # would inevitably timeout, since no checker would get a
685
 
        # chance to run to completion.  If we instead leave running
 
656
        # did that, then if a checker (for some reason) started
 
657
        # running slowly and taking more than 'interval' time, the
 
658
        # client would inevitably timeout, since no checker would get
 
659
        # a chance to run to completion.  If we instead leave running
686
660
        # checkers alone, the checker would have to take more time
687
661
        # than 'timeout' for the client to be disabled, which is as it
688
662
        # should be.
702
676
                                      self.current_checker_command)
703
677
        # Start a new checker if needed
704
678
        if self.checker is None:
705
 
            # Escape attributes for the shell
706
 
            escaped_attrs = dict(
707
 
                (attr, re.escape(unicode(getattr(self, attr))))
708
 
                for attr in
709
 
                self.runtime_expansions)
710
679
            try:
711
 
                command = self.checker_command % escaped_attrs
712
 
            except TypeError as error:
713
 
                logger.error('Could not format string "%s"',
714
 
                             self.checker_command, exc_info=error)
715
 
                return True # Try again later
 
680
                # In case checker_command has exactly one % operator
 
681
                command = self.checker_command % self.host
 
682
            except TypeError:
 
683
                # Escape attributes for the shell
 
684
                escaped_attrs = dict(
 
685
                    (attr,
 
686
                     re.escape(unicode(str(getattr(self, attr, "")),
 
687
                                       errors=
 
688
                                       'replace')))
 
689
                    for attr in
 
690
                    self.runtime_expansions)
 
691
                
 
692
                try:
 
693
                    command = self.checker_command % escaped_attrs
 
694
                except TypeError as error:
 
695
                    logger.error('Could not format string "%s":'
 
696
                                 ' %s', self.checker_command, error)
 
697
                    return True # Try again later
716
698
            self.current_checker_command = command
717
699
            try:
718
700
                logger.info("Starting checker %r for %s",
721
703
                # in normal mode, that is already done by daemon(),
722
704
                # and in debug mode we don't want to.  (Stdin is
723
705
                # always replaced by /dev/null.)
724
 
                # The exception is when not debugging but nevertheless
725
 
                # running in the foreground; use the previously
726
 
                # created wnull.
727
 
                popen_args = {}
728
 
                if (not self.server_settings["debug"]
729
 
                    and self.server_settings["foreground"]):
730
 
                    popen_args.update({"stdout": wnull,
731
 
                                       "stderr": wnull })
732
706
                self.checker = subprocess.Popen(command,
733
707
                                                close_fds=True,
734
 
                                                shell=True, cwd="/",
735
 
                                                **popen_args)
736
 
            except OSError as error:
737
 
                logger.error("Failed to start subprocess",
738
 
                             exc_info=error)
739
 
                return True
740
 
            self.checker_callback_tag = (gobject.child_watch_add
741
 
                                         (self.checker.pid,
742
 
                                          self.checker_callback,
743
 
                                          data=command))
744
 
            # The checker may have completed before the gobject
745
 
            # watch was added.  Check for this.
746
 
            try:
 
708
                                                shell=True, cwd="/")
 
709
                self.checker_callback_tag = (gobject.child_watch_add
 
710
                                             (self.checker.pid,
 
711
                                              self.checker_callback,
 
712
                                              data=command))
 
713
                # The checker may have completed before the gobject
 
714
                # watch was added.  Check for this.
747
715
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
716
                if pid:
 
717
                    gobject.source_remove(self.checker_callback_tag)
 
718
                    self.checker_callback(pid, status, command)
748
719
            except OSError as error:
749
 
                if error.errno == errno.ECHILD:
750
 
                    # This should never happen
751
 
                    logger.error("Child process vanished",
752
 
                                 exc_info=error)
753
 
                    return True
754
 
                raise
755
 
            if pid:
756
 
                gobject.source_remove(self.checker_callback_tag)
757
 
                self.checker_callback(pid, status, command)
 
720
                logger.error("Failed to start subprocess: %s",
 
721
                             error)
758
722
        # Re-run this periodically if run by gobject.timeout_add
759
723
        return True
760
724
    
767
731
            return
768
732
        logger.debug("Stopping checker for %(name)s", vars(self))
769
733
        try:
770
 
            self.checker.terminate()
 
734
            os.kill(self.checker.pid, signal.SIGTERM)
771
735
            #time.sleep(0.5)
772
736
            #if self.checker.poll() is None:
773
 
            #    self.checker.kill()
 
737
            #    os.kill(self.checker.pid, signal.SIGKILL)
774
738
        except OSError as error:
775
739
            if error.errno != errno.ESRCH: # No such process
776
740
                raise
793
757
    # "Set" method, so we fail early here:
794
758
    if byte_arrays and signature != "ay":
795
759
        raise ValueError("Byte arrays not supported for non-'ay'"
796
 
                         " signature {0!r}".format(signature))
 
760
                         " signature %r" % signature)
797
761
    def decorator(func):
798
762
        func._dbus_is_property = True
799
763
        func._dbus_interface = dbus_interface
807
771
    return decorator
808
772
 
809
773
 
810
 
def dbus_interface_annotations(dbus_interface):
811
 
    """Decorator for marking functions returning interface annotations
812
 
    
813
 
    Usage:
814
 
    
815
 
    @dbus_interface_annotations("org.example.Interface")
816
 
    def _foo(self):  # Function name does not matter
817
 
        return {"org.freedesktop.DBus.Deprecated": "true",
818
 
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
819
 
                    "false"}
820
 
    """
821
 
    def decorator(func):
822
 
        func._dbus_is_interface = True
823
 
        func._dbus_interface = dbus_interface
824
 
        func._dbus_name = dbus_interface
825
 
        return func
826
 
    return decorator
827
 
 
828
 
 
829
 
def dbus_annotations(annotations):
830
 
    """Decorator to annotate D-Bus methods, signals or properties
831
 
    Usage:
832
 
    
833
 
    @dbus_service_property("org.example.Interface", signature="b",
834
 
                           access="r")
835
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
836
 
                        "org.freedesktop.DBus.Property."
837
 
                        "EmitsChangedSignal": "false"})
838
 
    def Property_dbus_property(self):
839
 
        return dbus.Boolean(False)
840
 
    """
841
 
    def decorator(func):
842
 
        func._dbus_annotations = annotations
843
 
        return func
844
 
    return decorator
845
 
 
846
 
 
847
774
class DBusPropertyException(dbus.exceptions.DBusException):
848
775
    """A base class for D-Bus property-related exceptions
849
776
    """
872
799
    """
873
800
    
874
801
    @staticmethod
875
 
    def _is_dbus_thing(thing):
876
 
        """Returns a function testing if an attribute is a D-Bus thing
877
 
        
878
 
        If called like _is_dbus_thing("method") it returns a function
879
 
        suitable for use as predicate to inspect.getmembers().
880
 
        """
881
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
882
 
                                   False)
 
802
    def _is_dbus_property(obj):
 
803
        return getattr(obj, "_dbus_is_property", False)
883
804
    
884
 
    def _get_all_dbus_things(self, thing):
 
805
    def _get_all_dbus_properties(self):
885
806
        """Returns a generator of (name, attribute) pairs
886
807
        """
887
 
        return ((getattr(athing.__get__(self), "_dbus_name",
888
 
                         name),
889
 
                 athing.__get__(self))
 
808
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
890
809
                for cls in self.__class__.__mro__
891
 
                for name, athing in
892
 
                inspect.getmembers(cls,
893
 
                                   self._is_dbus_thing(thing)))
 
810
                for name, prop in
 
811
                inspect.getmembers(cls, self._is_dbus_property))
894
812
    
895
813
    def _get_dbus_property(self, interface_name, property_name):
896
814
        """Returns a bound method if one exists which is a D-Bus
898
816
        """
899
817
        for cls in  self.__class__.__mro__:
900
818
            for name, value in (inspect.getmembers
901
 
                                (cls,
902
 
                                 self._is_dbus_thing("property"))):
 
819
                                (cls, self._is_dbus_property)):
903
820
                if (value._dbus_name == property_name
904
821
                    and value._dbus_interface == interface_name):
905
822
                    return value.__get__(self)
947
864
        Note: Will not include properties with access="write".
948
865
        """
949
866
        properties = {}
950
 
        for name, prop in self._get_all_dbus_things("property"):
 
867
        for name, prop in self._get_all_dbus_properties():
951
868
            if (interface_name
952
869
                and interface_name != prop._dbus_interface):
953
870
                # Interface non-empty but did not match
968
885
                         path_keyword='object_path',
969
886
                         connection_keyword='connection')
970
887
    def Introspect(self, object_path, connection):
971
 
        """Overloading of standard D-Bus method.
972
 
        
973
 
        Inserts property tags and interface annotation tags.
 
888
        """Standard D-Bus method, overloaded to insert property tags.
974
889
        """
975
890
        xmlstring = dbus.service.Object.Introspect(self, object_path,
976
891
                                                   connection)
983
898
                e.setAttribute("access", prop._dbus_access)
984
899
                return e
985
900
            for if_tag in document.getElementsByTagName("interface"):
986
 
                # Add property tags
987
901
                for tag in (make_tag(document, name, prop)
988
902
                            for name, prop
989
 
                            in self._get_all_dbus_things("property")
 
903
                            in self._get_all_dbus_properties()
990
904
                            if prop._dbus_interface
991
905
                            == if_tag.getAttribute("name")):
992
906
                    if_tag.appendChild(tag)
993
 
                # Add annotation tags
994
 
                for typ in ("method", "signal", "property"):
995
 
                    for tag in if_tag.getElementsByTagName(typ):
996
 
                        annots = dict()
997
 
                        for name, prop in (self.
998
 
                                           _get_all_dbus_things(typ)):
999
 
                            if (name == tag.getAttribute("name")
1000
 
                                and prop._dbus_interface
1001
 
                                == if_tag.getAttribute("name")):
1002
 
                                annots.update(getattr
1003
 
                                              (prop,
1004
 
                                               "_dbus_annotations",
1005
 
                                               {}))
1006
 
                        for name, value in annots.iteritems():
1007
 
                            ann_tag = document.createElement(
1008
 
                                "annotation")
1009
 
                            ann_tag.setAttribute("name", name)
1010
 
                            ann_tag.setAttribute("value", value)
1011
 
                            tag.appendChild(ann_tag)
1012
 
                # Add interface annotation tags
1013
 
                for annotation, value in dict(
1014
 
                    itertools.chain.from_iterable(
1015
 
                        annotations().iteritems()
1016
 
                        for name, annotations in
1017
 
                        self._get_all_dbus_things("interface")
1018
 
                        if name == if_tag.getAttribute("name")
1019
 
                        )).iteritems():
1020
 
                    ann_tag = document.createElement("annotation")
1021
 
                    ann_tag.setAttribute("name", annotation)
1022
 
                    ann_tag.setAttribute("value", value)
1023
 
                    if_tag.appendChild(ann_tag)
1024
907
                # Add the names to the return values for the
1025
908
                # "org.freedesktop.DBus.Properties" methods
1026
909
                if (if_tag.getAttribute("name")
1041
924
        except (AttributeError, xml.dom.DOMException,
1042
925
                xml.parsers.expat.ExpatError) as error:
1043
926
            logger.error("Failed to override Introspection method",
1044
 
                         exc_info=error)
 
927
                         error)
1045
928
        return xmlstring
1046
929
 
1047
930
 
1048
 
def datetime_to_dbus(dt, variant_level=0):
 
931
def datetime_to_dbus (dt, variant_level=0):
1049
932
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1050
933
    if dt is None:
1051
934
        return dbus.String("", variant_level = variant_level)
1053
936
                       variant_level=variant_level)
1054
937
 
1055
938
 
1056
 
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1057
 
    """A class decorator; applied to a subclass of
1058
 
    dbus.service.Object, it will add alternate D-Bus attributes with
1059
 
    interface names according to the "alt_interface_names" mapping.
1060
 
    Usage:
1061
 
    
1062
 
    @alternate_dbus_interfaces({"org.example.Interface":
1063
 
                                    "net.example.AlternateInterface"})
1064
 
    class SampleDBusObject(dbus.service.Object):
1065
 
        @dbus.service.method("org.example.Interface")
1066
 
        def SampleDBusMethod():
1067
 
            pass
1068
 
    
1069
 
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1070
 
    reachable via two interfaces: "org.example.Interface" and
1071
 
    "net.example.AlternateInterface", the latter of which will have
1072
 
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1073
 
    "true", unless "deprecate" is passed with a False value.
1074
 
    
1075
 
    This works for methods and signals, and also for D-Bus properties
1076
 
    (from DBusObjectWithProperties) and interfaces (from the
1077
 
    dbus_interface_annotations decorator).
 
939
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
940
                                  .__metaclass__):
 
941
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
942
    will add additional D-Bus attributes matching a certain pattern.
1078
943
    """
1079
 
    def wrapper(cls):
1080
 
        for orig_interface_name, alt_interface_name in (
1081
 
            alt_interface_names.iteritems()):
1082
 
            attr = {}
1083
 
            interface_names = set()
1084
 
            # Go though all attributes of the class
1085
 
            for attrname, attribute in inspect.getmembers(cls):
 
944
    def __new__(mcs, name, bases, attr):
 
945
        # Go through all the base classes which could have D-Bus
 
946
        # methods, signals, or properties in them
 
947
        for base in (b for b in bases
 
948
                     if issubclass(b, dbus.service.Object)):
 
949
            # Go though all attributes of the base class
 
950
            for attrname, attribute in inspect.getmembers(base):
1086
951
                # Ignore non-D-Bus attributes, and D-Bus attributes
1087
952
                # with the wrong interface name
1088
953
                if (not hasattr(attribute, "_dbus_interface")
1089
954
                    or not attribute._dbus_interface
1090
 
                    .startswith(orig_interface_name)):
 
955
                    .startswith("se.recompile.Mandos")):
1091
956
                    continue
1092
957
                # Create an alternate D-Bus interface name based on
1093
958
                # the current name
1094
959
                alt_interface = (attribute._dbus_interface
1095
 
                                 .replace(orig_interface_name,
1096
 
                                          alt_interface_name))
1097
 
                interface_names.add(alt_interface)
 
960
                                 .replace("se.recompile.Mandos",
 
961
                                          "se.bsnet.fukt.Mandos"))
1098
962
                # Is this a D-Bus signal?
1099
963
                if getattr(attribute, "_dbus_is_signal", False):
1100
 
                    # Extract the original non-method undecorated
1101
 
                    # function by black magic
 
964
                    # Extract the original non-method function by
 
965
                    # black magic
1102
966
                    nonmethod_func = (dict(
1103
967
                            zip(attribute.func_code.co_freevars,
1104
968
                                attribute.__closure__))["func"]
1115
979
                                nonmethod_func.func_name,
1116
980
                                nonmethod_func.func_defaults,
1117
981
                                nonmethod_func.func_closure)))
1118
 
                    # Copy annotations, if any
1119
 
                    try:
1120
 
                        new_function._dbus_annotations = (
1121
 
                            dict(attribute._dbus_annotations))
1122
 
                    except AttributeError:
1123
 
                        pass
1124
982
                    # Define a creator of a function to call both the
1125
 
                    # original and alternate functions, so both the
1126
 
                    # original and alternate signals gets sent when
1127
 
                    # the function is called
 
983
                    # old and new functions, so both the old and new
 
984
                    # signals gets sent when the function is called
1128
985
                    def fixscope(func1, func2):
1129
986
                        """This function is a scope container to pass
1130
987
                        func1 and func2 to the "call_both" function
1137
994
                        return call_both
1138
995
                    # Create the "call_both" function and add it to
1139
996
                    # the class
1140
 
                    attr[attrname] = fixscope(attribute, new_function)
 
997
                    attr[attrname] = fixscope(attribute,
 
998
                                              new_function)
1141
999
                # Is this a D-Bus method?
1142
1000
                elif getattr(attribute, "_dbus_is_method", False):
1143
1001
                    # Create a new, but exactly alike, function
1154
1012
                                        attribute.func_name,
1155
1013
                                        attribute.func_defaults,
1156
1014
                                        attribute.func_closure)))
1157
 
                    # Copy annotations, if any
1158
 
                    try:
1159
 
                        attr[attrname]._dbus_annotations = (
1160
 
                            dict(attribute._dbus_annotations))
1161
 
                    except AttributeError:
1162
 
                        pass
1163
1015
                # Is this a D-Bus property?
1164
1016
                elif getattr(attribute, "_dbus_is_property", False):
1165
1017
                    # Create a new, but exactly alike, function
1179
1031
                                        attribute.func_name,
1180
1032
                                        attribute.func_defaults,
1181
1033
                                        attribute.func_closure)))
1182
 
                    # Copy annotations, if any
1183
 
                    try:
1184
 
                        attr[attrname]._dbus_annotations = (
1185
 
                            dict(attribute._dbus_annotations))
1186
 
                    except AttributeError:
1187
 
                        pass
1188
 
                # Is this a D-Bus interface?
1189
 
                elif getattr(attribute, "_dbus_is_interface", False):
1190
 
                    # Create a new, but exactly alike, function
1191
 
                    # object.  Decorate it to be a new D-Bus interface
1192
 
                    # with the alternate D-Bus interface name.  Add it
1193
 
                    # to the class.
1194
 
                    attr[attrname] = (dbus_interface_annotations
1195
 
                                      (alt_interface)
1196
 
                                      (types.FunctionType
1197
 
                                       (attribute.func_code,
1198
 
                                        attribute.func_globals,
1199
 
                                        attribute.func_name,
1200
 
                                        attribute.func_defaults,
1201
 
                                        attribute.func_closure)))
1202
 
            if deprecate:
1203
 
                # Deprecate all alternate interfaces
1204
 
                iname="_AlternateDBusNames_interface_annotation{0}"
1205
 
                for interface_name in interface_names:
1206
 
                    @dbus_interface_annotations(interface_name)
1207
 
                    def func(self):
1208
 
                        return { "org.freedesktop.DBus.Deprecated":
1209
 
                                     "true" }
1210
 
                    # Find an unused name
1211
 
                    for aname in (iname.format(i)
1212
 
                                  for i in itertools.count()):
1213
 
                        if aname not in attr:
1214
 
                            attr[aname] = func
1215
 
                            break
1216
 
            if interface_names:
1217
 
                # Replace the class with a new subclass of it with
1218
 
                # methods, signals, etc. as created above.
1219
 
                cls = type(b"{0}Alternate".format(cls.__name__),
1220
 
                           (cls,), attr)
1221
 
        return cls
1222
 
    return wrapper
1223
 
 
1224
 
 
1225
 
@alternate_dbus_interfaces({"se.recompile.Mandos":
1226
 
                                "se.bsnet.fukt.Mandos"})
 
1034
        return type.__new__(mcs, name, bases, attr)
 
1035
 
 
1036
 
1227
1037
class ClientDBus(Client, DBusObjectWithProperties):
1228
1038
    """A Client class using D-Bus
1229
1039
    
1249
1059
                                 ("/clients/" + client_object_name))
1250
1060
        DBusObjectWithProperties.__init__(self, self.bus,
1251
1061
                                          self.dbus_object_path)
1252
 
    
 
1062
        
1253
1063
    def notifychangeproperty(transform_func,
1254
1064
                             dbus_name, type_func=lambda x: x,
1255
1065
                             variant_level=1):
1278
1088
        
1279
1089
        return property(lambda self: getattr(self, attrname), setter)
1280
1090
    
 
1091
    
1281
1092
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1282
1093
    approvals_pending = notifychangeproperty(dbus.Boolean,
1283
1094
                                             "ApprovalPending",
1365
1176
        return False
1366
1177
    
1367
1178
    def approve(self, value=True):
 
1179
        self.send_changedstate()
1368
1180
        self.approved = value
1369
1181
        gobject.timeout_add(timedelta_to_milliseconds
1370
1182
                            (self.approval_duration),
1371
1183
                            self._reset_approved)
1372
 
        self.send_changedstate()
 
1184
    
1373
1185
    
1374
1186
    ## D-Bus methods, signals & properties
1375
1187
    _interface = "se.recompile.Mandos.Client"
1376
1188
    
1377
 
    ## Interfaces
1378
 
    
1379
 
    @dbus_interface_annotations(_interface)
1380
 
    def _foo(self):
1381
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1382
 
                     "false"}
1383
 
    
1384
1189
    ## Signals
1385
1190
    
1386
1191
    # CheckerCompleted - signal
1559
1364
    def Timeout_dbus_property(self, value=None):
1560
1365
        if value is None:       # get
1561
1366
            return dbus.UInt64(self.timeout_milliseconds())
1562
 
        old_timeout = self.timeout
1563
1367
        self.timeout = datetime.timedelta(0, 0, 0, value)
1564
 
        # Reschedule disabling
 
1368
        # Reschedule timeout
1565
1369
        if self.enabled:
1566
1370
            now = datetime.datetime.utcnow()
1567
 
            self.expires += self.timeout - old_timeout
1568
 
            if self.expires <= now:
 
1371
            time_to_die = timedelta_to_milliseconds(
 
1372
                (self.last_checked_ok + self.timeout) - now)
 
1373
            if time_to_die <= 0:
1569
1374
                # The timeout has passed
1570
1375
                self.disable()
1571
1376
            else:
 
1377
                self.expires = (now +
 
1378
                                datetime.timedelta(milliseconds =
 
1379
                                                   time_to_die))
1572
1380
                if (getattr(self, "disable_initiator_tag", None)
1573
1381
                    is None):
1574
1382
                    return
1575
1383
                gobject.source_remove(self.disable_initiator_tag)
1576
 
                self.disable_initiator_tag = (
1577
 
                    gobject.timeout_add(
1578
 
                        timedelta_to_milliseconds(self.expires - now),
1579
 
                        self.disable))
 
1384
                self.disable_initiator_tag = (gobject.timeout_add
 
1385
                                              (time_to_die,
 
1386
                                               self.disable))
1580
1387
    
1581
1388
    # ExtendedTimeout - property
1582
1389
    @dbus_service_property(_interface, signature="t",
1661
1468
        self._pipe.send(('setattr', name, value))
1662
1469
 
1663
1470
 
 
1471
class ClientDBusTransitional(ClientDBus):
 
1472
    __metaclass__ = AlternateDBusNamesMetaclass
 
1473
 
 
1474
 
1664
1475
class ClientHandler(socketserver.BaseRequestHandler, object):
1665
1476
    """A class to handle client connections.
1666
1477
    
1770
1581
                    #wait until timeout or approved
1771
1582
                    time = datetime.datetime.now()
1772
1583
                    client.changedstate.acquire()
1773
 
                    client.changedstate.wait(
1774
 
                        float(timedelta_to_milliseconds(delay)
1775
 
                              / 1000))
 
1584
                    (client.changedstate.wait
 
1585
                     (float(client.timedelta_to_milliseconds(delay)
 
1586
                            / 1000)))
1776
1587
                    client.changedstate.release()
1777
1588
                    time2 = datetime.datetime.now()
1778
1589
                    if (time2 - time) >= delay:
1794
1605
                    try:
1795
1606
                        sent = session.send(client.secret[sent_size:])
1796
1607
                    except gnutls.errors.GNUTLSError as error:
1797
 
                        logger.warning("gnutls send failed",
1798
 
                                       exc_info=error)
 
1608
                        logger.warning("gnutls send failed")
1799
1609
                        return
1800
1610
                    logger.debug("Sent: %d, remaining: %d",
1801
1611
                                 sent, len(client.secret)
1815
1625
                try:
1816
1626
                    session.bye()
1817
1627
                except gnutls.errors.GNUTLSError as error:
1818
 
                    logger.warning("GnuTLS bye failed",
1819
 
                                   exc_info=error)
 
1628
                    logger.warning("GnuTLS bye failed")
1820
1629
    
1821
1630
    @staticmethod
1822
1631
    def peer_certificate(session):
1894
1703
    def process_request(self, request, address):
1895
1704
        """Start a new process to process the request."""
1896
1705
        proc = multiprocessing.Process(target = self.sub_process_main,
1897
 
                                       args = (request, address))
 
1706
                                       args = (request,
 
1707
                                               address))
1898
1708
        proc.start()
1899
1709
        return proc
1900
1710
 
1928
1738
        use_ipv6:       Boolean; to use IPv6 or not
1929
1739
    """
1930
1740
    def __init__(self, server_address, RequestHandlerClass,
1931
 
                 interface=None, use_ipv6=True, socketfd=None):
1932
 
        """If socketfd is set, use that file descriptor instead of
1933
 
        creating a new one with socket.socket().
1934
 
        """
 
1741
                 interface=None, use_ipv6=True):
1935
1742
        self.interface = interface
1936
1743
        if use_ipv6:
1937
1744
            self.address_family = socket.AF_INET6
1938
 
        if socketfd is not None:
1939
 
            # Save the file descriptor
1940
 
            self.socketfd = socketfd
1941
 
            # Save the original socket.socket() function
1942
 
            self.socket_socket = socket.socket
1943
 
            # To implement --socket, we monkey patch socket.socket.
1944
 
            # 
1945
 
            # (When socketserver.TCPServer is a new-style class, we
1946
 
            # could make self.socket into a property instead of monkey
1947
 
            # patching socket.socket.)
1948
 
            # 
1949
 
            # Create a one-time-only replacement for socket.socket()
1950
 
            @functools.wraps(socket.socket)
1951
 
            def socket_wrapper(*args, **kwargs):
1952
 
                # Restore original function so subsequent calls are
1953
 
                # not affected.
1954
 
                socket.socket = self.socket_socket
1955
 
                del self.socket_socket
1956
 
                # This time only, return a new socket object from the
1957
 
                # saved file descriptor.
1958
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
1959
 
            # Replace socket.socket() function with wrapper
1960
 
            socket.socket = socket_wrapper
1961
 
        # The socketserver.TCPServer.__init__ will call
1962
 
        # socket.socket(), which might be our replacement,
1963
 
        # socket_wrapper(), if socketfd was set.
1964
1745
        socketserver.TCPServer.__init__(self, server_address,
1965
1746
                                        RequestHandlerClass)
1966
 
    
1967
1747
    def server_bind(self):
1968
1748
        """This overrides the normal server_bind() function
1969
1749
        to bind to an interface if one was specified, and also NOT to
1977
1757
                try:
1978
1758
                    self.socket.setsockopt(socket.SOL_SOCKET,
1979
1759
                                           SO_BINDTODEVICE,
1980
 
                                           str(self.interface + '\0'))
 
1760
                                           str(self.interface
 
1761
                                               + '\0'))
1981
1762
                except socket.error as error:
1982
 
                    if error.errno == errno.EPERM:
1983
 
                        logger.error("No permission to bind to"
1984
 
                                     " interface %s", self.interface)
1985
 
                    elif error.errno == errno.ENOPROTOOPT:
 
1763
                    if error[0] == errno.EPERM:
 
1764
                        logger.error("No permission to"
 
1765
                                     " bind to interface %s",
 
1766
                                     self.interface)
 
1767
                    elif error[0] == errno.ENOPROTOOPT:
1986
1768
                        logger.error("SO_BINDTODEVICE not available;"
1987
1769
                                     " cannot bind to interface %s",
1988
1770
                                     self.interface)
1989
 
                    elif error.errno == errno.ENODEV:
1990
 
                        logger.error("Interface %s does not exist,"
1991
 
                                     " cannot bind", self.interface)
1992
1771
                    else:
1993
1772
                        raise
1994
1773
        # Only bind(2) the socket if we really need to.
1997
1776
                if self.address_family == socket.AF_INET6:
1998
1777
                    any_address = "::" # in6addr_any
1999
1778
                else:
2000
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1779
                    any_address = socket.INADDR_ANY
2001
1780
                self.server_address = (any_address,
2002
1781
                                       self.server_address[1])
2003
1782
            elif not self.server_address[1]:
2024
1803
    """
2025
1804
    def __init__(self, server_address, RequestHandlerClass,
2026
1805
                 interface=None, use_ipv6=True, clients=None,
2027
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
1806
                 gnutls_priority=None, use_dbus=True):
2028
1807
        self.enabled = False
2029
1808
        self.clients = clients
2030
1809
        if self.clients is None:
2034
1813
        IPv6_TCPServer.__init__(self, server_address,
2035
1814
                                RequestHandlerClass,
2036
1815
                                interface = interface,
2037
 
                                use_ipv6 = use_ipv6,
2038
 
                                socketfd = socketfd)
 
1816
                                use_ipv6 = use_ipv6)
2039
1817
    def server_activate(self):
2040
1818
        if self.enabled:
2041
1819
            return socketserver.TCPServer.server_activate(self)
2054
1832
    
2055
1833
    def handle_ipc(self, source, condition, parent_pipe=None,
2056
1834
                   proc = None, client_object=None):
 
1835
        condition_names = {
 
1836
            gobject.IO_IN: "IN",   # There is data to read.
 
1837
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1838
                                    # blocking).
 
1839
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1840
            gobject.IO_ERR: "ERR", # Error condition.
 
1841
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1842
                                    # broken, usually for pipes and
 
1843
                                    # sockets).
 
1844
            }
 
1845
        conditions_string = ' | '.join(name
 
1846
                                       for cond, name in
 
1847
                                       condition_names.iteritems()
 
1848
                                       if cond & condition)
2057
1849
        # error, or the other end of multiprocessing.Pipe has closed
2058
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
1850
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2059
1851
            # Wait for other process to exit
2060
1852
            proc.join()
2061
1853
            return False
2119
1911
        return True
2120
1912
 
2121
1913
 
2122
 
def rfc3339_duration_to_delta(duration):
2123
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2124
 
    
2125
 
    >>> rfc3339_duration_to_delta("P7D")
2126
 
    datetime.timedelta(7)
2127
 
    >>> rfc3339_duration_to_delta("PT60S")
2128
 
    datetime.timedelta(0, 60)
2129
 
    >>> rfc3339_duration_to_delta("PT60M")
2130
 
    datetime.timedelta(0, 3600)
2131
 
    >>> rfc3339_duration_to_delta("PT24H")
2132
 
    datetime.timedelta(1)
2133
 
    >>> rfc3339_duration_to_delta("P1W")
2134
 
    datetime.timedelta(7)
2135
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2136
 
    datetime.timedelta(0, 330)
2137
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2138
 
    datetime.timedelta(1, 200)
2139
 
    """
2140
 
    
2141
 
    # Parsing an RFC 3339 duration with regular expressions is not
2142
 
    # possible - there would have to be multiple places for the same
2143
 
    # values, like seconds.  The current code, while more esoteric, is
2144
 
    # cleaner without depending on a parsing library.  If Python had a
2145
 
    # built-in library for parsing we would use it, but we'd like to
2146
 
    # avoid excessive use of external libraries.
2147
 
    
2148
 
    # New type for defining tokens, syntax, and semantics all-in-one
2149
 
    Token = collections.namedtuple("Token",
2150
 
                                   ("regexp", # To match token; if
2151
 
                                              # "value" is not None,
2152
 
                                              # must have a "group"
2153
 
                                              # containing digits
2154
 
                                    "value",  # datetime.timedelta or
2155
 
                                              # None
2156
 
                                    "followers")) # Tokens valid after
2157
 
                                                  # this token
2158
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2159
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2160
 
    token_end = Token(re.compile(r"$"), None, frozenset())
2161
 
    token_second = Token(re.compile(r"(\d+)S"),
2162
 
                         datetime.timedelta(seconds=1),
2163
 
                         frozenset((token_end,)))
2164
 
    token_minute = Token(re.compile(r"(\d+)M"),
2165
 
                         datetime.timedelta(minutes=1),
2166
 
                         frozenset((token_second, token_end)))
2167
 
    token_hour = Token(re.compile(r"(\d+)H"),
2168
 
                       datetime.timedelta(hours=1),
2169
 
                       frozenset((token_minute, token_end)))
2170
 
    token_time = Token(re.compile(r"T"),
2171
 
                       None,
2172
 
                       frozenset((token_hour, token_minute,
2173
 
                                  token_second)))
2174
 
    token_day = Token(re.compile(r"(\d+)D"),
2175
 
                      datetime.timedelta(days=1),
2176
 
                      frozenset((token_time, token_end)))
2177
 
    token_month = Token(re.compile(r"(\d+)M"),
2178
 
                        datetime.timedelta(weeks=4),
2179
 
                        frozenset((token_day, token_end)))
2180
 
    token_year = Token(re.compile(r"(\d+)Y"),
2181
 
                       datetime.timedelta(weeks=52),
2182
 
                       frozenset((token_month, token_end)))
2183
 
    token_week = Token(re.compile(r"(\d+)W"),
2184
 
                       datetime.timedelta(weeks=1),
2185
 
                       frozenset((token_end,)))
2186
 
    token_duration = Token(re.compile(r"P"), None,
2187
 
                           frozenset((token_year, token_month,
2188
 
                                      token_day, token_time,
2189
 
                                      token_week))),
2190
 
    # Define starting values
2191
 
    value = datetime.timedelta() # Value so far
2192
 
    found_token = None
2193
 
    followers = frozenset(token_duration,) # Following valid tokens
2194
 
    s = duration                # String left to parse
2195
 
    # Loop until end token is found
2196
 
    while found_token is not token_end:
2197
 
        # Search for any currently valid tokens
2198
 
        for token in followers:
2199
 
            match = token.regexp.match(s)
2200
 
            if match is not None:
2201
 
                # Token found
2202
 
                if token.value is not None:
2203
 
                    # Value found, parse digits
2204
 
                    factor = int(match.group(1), 10)
2205
 
                    # Add to value so far
2206
 
                    value += factor * token.value
2207
 
                # Strip token from string
2208
 
                s = token.regexp.sub("", s, 1)
2209
 
                # Go to found token
2210
 
                found_token = token
2211
 
                # Set valid next tokens
2212
 
                followers = found_token.followers
2213
 
                break
2214
 
        else:
2215
 
            # No currently valid tokens were found
2216
 
            raise ValueError("Invalid RFC 3339 duration")
2217
 
    # End token found
2218
 
    return value
2219
 
 
2220
 
 
2221
1914
def string_to_delta(interval):
2222
1915
    """Parse a string and return a datetime.timedelta
2223
1916
    
2234
1927
    >>> string_to_delta('5m 30s')
2235
1928
    datetime.timedelta(0, 330)
2236
1929
    """
2237
 
    
2238
 
    try:
2239
 
        return rfc3339_duration_to_delta(interval)
2240
 
    except ValueError:
2241
 
        pass
2242
 
    
2243
1930
    timevalue = datetime.timedelta(0)
2244
1931
    for s in interval.split():
2245
1932
        try:
2256
1943
            elif suffix == "w":
2257
1944
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2258
1945
            else:
2259
 
                raise ValueError("Unknown suffix {0!r}"
2260
 
                                 .format(suffix))
 
1946
                raise ValueError("Unknown suffix %r" % suffix)
2261
1947
        except (ValueError, IndexError) as e:
2262
1948
            raise ValueError(*(e.args))
2263
1949
        timevalue += delta
2277
1963
        sys.exit()
2278
1964
    if not noclose:
2279
1965
        # Close all standard open file descriptors
2280
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1966
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2281
1967
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2282
1968
            raise OSError(errno.ENODEV,
2283
 
                          "{0} not a character device"
2284
 
                          .format(os.devnull))
 
1969
                          "%s not a character device"
 
1970
                          % os.path.devnull)
2285
1971
        os.dup2(null, sys.stdin.fileno())
2286
1972
        os.dup2(null, sys.stdout.fileno())
2287
1973
        os.dup2(null, sys.stderr.fileno())
2296
1982
    
2297
1983
    parser = argparse.ArgumentParser()
2298
1984
    parser.add_argument("-v", "--version", action="version",
2299
 
                        version = "%(prog)s {0}".format(version),
 
1985
                        version = "%%(prog)s %s" % version,
2300
1986
                        help="show version number and exit")
2301
1987
    parser.add_argument("-i", "--interface", metavar="IF",
2302
1988
                        help="Bind to interface IF")
2308
1994
                        help="Run self-test")
2309
1995
    parser.add_argument("--debug", action="store_true",
2310
1996
                        help="Debug mode; run in foreground and log"
2311
 
                        " to terminal", default=None)
 
1997
                        " to terminal")
2312
1998
    parser.add_argument("--debuglevel", metavar="LEVEL",
2313
1999
                        help="Debug level for stdout output")
2314
2000
    parser.add_argument("--priority", help="GnuTLS"
2321
2007
                        " files")
2322
2008
    parser.add_argument("--no-dbus", action="store_false",
2323
2009
                        dest="use_dbus", help="Do not provide D-Bus"
2324
 
                        " system bus interface", default=None)
 
2010
                        " system bus interface")
2325
2011
    parser.add_argument("--no-ipv6", action="store_false",
2326
 
                        dest="use_ipv6", help="Do not use IPv6",
2327
 
                        default=None)
 
2012
                        dest="use_ipv6", help="Do not use IPv6")
2328
2013
    parser.add_argument("--no-restore", action="store_false",
2329
2014
                        dest="restore", help="Do not restore stored"
2330
 
                        " state", default=None)
2331
 
    parser.add_argument("--socket", type=int,
2332
 
                        help="Specify a file descriptor to a network"
2333
 
                        " socket to use instead of creating one")
 
2015
                        " state")
2334
2016
    parser.add_argument("--statedir", metavar="DIR",
2335
2017
                        help="Directory to save/restore state in")
2336
 
    parser.add_argument("--foreground", action="store_true",
2337
 
                        help="Run in foreground", default=None)
2338
2018
    
2339
2019
    options = parser.parse_args()
2340
2020
    
2349
2029
                        "port": "",
2350
2030
                        "debug": "False",
2351
2031
                        "priority":
2352
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2032
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2353
2033
                        "servicename": "Mandos",
2354
2034
                        "use_dbus": "True",
2355
2035
                        "use_ipv6": "True",
2356
2036
                        "debuglevel": "",
2357
2037
                        "restore": "True",
2358
 
                        "socket": "",
2359
 
                        "statedir": "/var/lib/mandos",
2360
 
                        "foreground": "False",
 
2038
                        "statedir": "/var/lib/mandos"
2361
2039
                        }
2362
2040
    
2363
2041
    # Parse config file for server-global settings
2368
2046
    # Convert the SafeConfigParser object to a dict
2369
2047
    server_settings = server_config.defaults()
2370
2048
    # Use the appropriate methods on the non-string config options
2371
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
2049
    for option in ("debug", "use_dbus", "use_ipv6"):
2372
2050
        server_settings[option] = server_config.getboolean("DEFAULT",
2373
2051
                                                           option)
2374
2052
    if server_settings["port"]:
2375
2053
        server_settings["port"] = server_config.getint("DEFAULT",
2376
2054
                                                       "port")
2377
 
    if server_settings["socket"]:
2378
 
        server_settings["socket"] = server_config.getint("DEFAULT",
2379
 
                                                         "socket")
2380
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
2381
 
        # over with an opened os.devnull.  But we don't want this to
2382
 
        # happen with a supplied network socket.
2383
 
        if 0 <= server_settings["socket"] <= 2:
2384
 
            server_settings["socket"] = os.dup(server_settings
2385
 
                                               ["socket"])
2386
2055
    del server_config
2387
2056
    
2388
2057
    # Override the settings from the config file with command line
2390
2059
    for option in ("interface", "address", "port", "debug",
2391
2060
                   "priority", "servicename", "configdir",
2392
2061
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2393
 
                   "statedir", "socket", "foreground"):
 
2062
                   "statedir"):
2394
2063
        value = getattr(options, option)
2395
2064
        if value is not None:
2396
2065
            server_settings[option] = value
2399
2068
    for option in server_settings.keys():
2400
2069
        if type(server_settings[option]) is str:
2401
2070
            server_settings[option] = unicode(server_settings[option])
2402
 
    # Force all boolean options to be boolean
2403
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2404
 
                   "foreground"):
2405
 
        server_settings[option] = bool(server_settings[option])
2406
 
    # Debug implies foreground
2407
 
    if server_settings["debug"]:
2408
 
        server_settings["foreground"] = True
2409
2071
    # Now we have our good server settings in "server_settings"
2410
2072
    
2411
2073
    ##################################################################
2417
2079
    use_ipv6 = server_settings["use_ipv6"]
2418
2080
    stored_state_path = os.path.join(server_settings["statedir"],
2419
2081
                                     stored_state_file)
2420
 
    foreground = server_settings["foreground"]
2421
2082
    
2422
2083
    if debug:
2423
2084
        initlogger(debug, logging.DEBUG)
2430
2091
    
2431
2092
    if server_settings["servicename"] != "Mandos":
2432
2093
        syslogger.setFormatter(logging.Formatter
2433
 
                               ('Mandos ({0}) [%(process)d]:'
2434
 
                                ' %(levelname)s: %(message)s'
2435
 
                                .format(server_settings
2436
 
                                        ["servicename"])))
 
2094
                               ('Mandos (%s) [%%(process)d]:'
 
2095
                                ' %%(levelname)s: %%(message)s'
 
2096
                                % server_settings["servicename"]))
2437
2097
    
2438
2098
    # Parse config file with clients
2439
2099
    client_config = configparser.SafeConfigParser(Client
2452
2112
                              use_ipv6=use_ipv6,
2453
2113
                              gnutls_priority=
2454
2114
                              server_settings["priority"],
2455
 
                              use_dbus=use_dbus,
2456
 
                              socketfd=(server_settings["socket"]
2457
 
                                        or None))
2458
 
    if not foreground:
2459
 
        pidfilename = "/run/mandos.pid"
2460
 
        if not os.path.isdir("/run/."):
2461
 
            pidfilename = "/var/run/mandos.pid"
2462
 
        pidfile = None
 
2115
                              use_dbus=use_dbus)
 
2116
    if not debug:
 
2117
        pidfilename = "/var/run/mandos.pid"
2463
2118
        try:
2464
2119
            pidfile = open(pidfilename, "w")
2465
 
        except IOError as e:
2466
 
            logger.error("Could not open file %r", pidfilename,
2467
 
                         exc_info=e)
 
2120
        except IOError:
 
2121
            logger.error("Could not open file %r", pidfilename)
2468
2122
    
2469
 
    for name in ("_mandos", "mandos", "nobody"):
 
2123
    try:
 
2124
        uid = pwd.getpwnam("_mandos").pw_uid
 
2125
        gid = pwd.getpwnam("_mandos").pw_gid
 
2126
    except KeyError:
2470
2127
        try:
2471
 
            uid = pwd.getpwnam(name).pw_uid
2472
 
            gid = pwd.getpwnam(name).pw_gid
2473
 
            break
 
2128
            uid = pwd.getpwnam("mandos").pw_uid
 
2129
            gid = pwd.getpwnam("mandos").pw_gid
2474
2130
        except KeyError:
2475
 
            continue
2476
 
    else:
2477
 
        uid = 65534
2478
 
        gid = 65534
 
2131
            try:
 
2132
                uid = pwd.getpwnam("nobody").pw_uid
 
2133
                gid = pwd.getpwnam("nobody").pw_gid
 
2134
            except KeyError:
 
2135
                uid = 65534
 
2136
                gid = 65534
2479
2137
    try:
2480
2138
        os.setgid(gid)
2481
2139
        os.setuid(uid)
2482
2140
    except OSError as error:
2483
 
        if error.errno != errno.EPERM:
 
2141
        if error[0] != errno.EPERM:
2484
2142
            raise error
2485
2143
    
2486
2144
    if debug:
2498
2156
         .gnutls_global_set_log_function(debug_gnutls))
2499
2157
        
2500
2158
        # Redirect stdin so all checkers get /dev/null
2501
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
2159
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2502
2160
        os.dup2(null, sys.stdin.fileno())
2503
2161
        if null > 2:
2504
2162
            os.close(null)
2505
2163
    
2506
2164
    # Need to fork before connecting to D-Bus
2507
 
    if not foreground:
 
2165
    if not debug:
2508
2166
        # Close all input and output, do double fork, etc.
2509
2167
        daemon()
2510
2168
    
2511
 
    # multiprocessing will use threads, so before we use gobject we
2512
 
    # need to inform gobject that threads will be used.
2513
2169
    gobject.threads_init()
2514
2170
    
2515
2171
    global main_loop
2516
2172
    # From the Avahi example code
2517
 
    DBusGMainLoop(set_as_default=True)
 
2173
    DBusGMainLoop(set_as_default=True )
2518
2174
    main_loop = gobject.MainLoop()
2519
2175
    bus = dbus.SystemBus()
2520
2176
    # End of Avahi example code
2526
2182
                            ("se.bsnet.fukt.Mandos", bus,
2527
2183
                             do_not_queue=True))
2528
2184
        except dbus.exceptions.NameExistsException as e:
2529
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
2185
            logger.error(unicode(e) + ", disabling D-Bus")
2530
2186
            use_dbus = False
2531
2187
            server_settings["use_dbus"] = False
2532
2188
            tcp_server.use_dbus = False
2544
2200
    
2545
2201
    client_class = Client
2546
2202
    if use_dbus:
2547
 
        client_class = functools.partial(ClientDBus, bus = bus)
 
2203
        client_class = functools.partial(ClientDBusTransitional,
 
2204
                                         bus = bus)
2548
2205
    
2549
2206
    client_settings = Client.config_parser(client_config)
2550
2207
    old_client_settings = {}
2551
2208
    clients_data = {}
2552
2209
    
2553
 
    # This is used to redirect stdout and stderr for checker processes
2554
 
    global wnull
2555
 
    wnull = open(os.devnull, "w") # A writable /dev/null
2556
 
    # Only used if server is running in foreground but not in debug
2557
 
    # mode
2558
 
    if debug or not foreground:
2559
 
        wnull.close()
2560
 
    
2561
2210
    # Get client data and settings from last running state.
2562
2211
    if server_settings["restore"]:
2563
2212
        try:
2566
2215
                                                     (stored_state))
2567
2216
            os.remove(stored_state_path)
2568
2217
        except IOError as e:
2569
 
            if e.errno == errno.ENOENT:
2570
 
                logger.warning("Could not load persistent state: {0}"
2571
 
                                .format(os.strerror(e.errno)))
2572
 
            else:
2573
 
                logger.critical("Could not load persistent state:",
2574
 
                                exc_info=e)
 
2218
            logger.warning("Could not load persistent state: {0}"
 
2219
                           .format(e))
 
2220
            if e.errno != errno.ENOENT:
2575
2221
                raise
2576
2222
        except EOFError as e:
2577
2223
            logger.warning("Could not load persistent state: "
2578
 
                           "EOFError:", exc_info=e)
 
2224
                           "EOFError: {0}".format(e))
2579
2225
    
2580
2226
    with PGPEngine() as pgp:
2581
2227
        for client_name, client in clients_data.iteritems():
2582
 
            # Skip removed clients
2583
 
            if client_name not in client_settings:
2584
 
                continue
2585
 
            
2586
2228
            # Decide which value to use after restoring saved state.
2587
2229
            # We have three different values: Old config file,
2588
2230
            # new config file, and saved state.
2638
2280
                             .format(client_name))
2639
2281
                client["secret"] = (
2640
2282
                    client_settings[client_name]["secret"])
 
2283
 
2641
2284
    
2642
2285
    # Add/remove clients based on new changes made to config
2643
2286
    for client_name in (set(old_client_settings)
2646
2289
    for client_name in (set(client_settings)
2647
2290
                        - set(old_client_settings)):
2648
2291
        clients_data[client_name] = client_settings[client_name]
2649
 
    
 
2292
 
2650
2293
    # Create all client objects
2651
2294
    for client_name, client in clients_data.iteritems():
2652
2295
        tcp_server.clients[client_name] = client_class(
2653
 
            name = client_name, settings = client,
2654
 
            server_settings = server_settings)
 
2296
            name = client_name, settings = client)
2655
2297
    
2656
2298
    if not tcp_server.clients:
2657
2299
        logger.warning("No clients defined")
2658
 
    
2659
 
    if not foreground:
2660
 
        if pidfile is not None:
2661
 
            try:
2662
 
                with pidfile:
2663
 
                    pid = os.getpid()
2664
 
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
2665
 
            except IOError:
2666
 
                logger.error("Could not write to file %r with PID %d",
2667
 
                             pidfilename, pid)
2668
 
        del pidfile
 
2300
        
 
2301
    if not debug:
 
2302
        try:
 
2303
            with pidfile:
 
2304
                pid = os.getpid()
 
2305
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2306
            del pidfile
 
2307
        except IOError:
 
2308
            logger.error("Could not write to file %r with PID %d",
 
2309
                         pidfilename, pid)
 
2310
        except NameError:
 
2311
            # "pidfile" was never created
 
2312
            pass
2669
2313
        del pidfilename
 
2314
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2670
2315
    
2671
2316
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2672
2317
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2673
2318
    
2674
2319
    if use_dbus:
2675
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2676
 
                                        "se.bsnet.fukt.Mandos"})
2677
 
        class MandosDBusService(DBusObjectWithProperties):
 
2320
        class MandosDBusService(dbus.service.Object):
2678
2321
            """A D-Bus proxy object"""
2679
2322
            def __init__(self):
2680
2323
                dbus.service.Object.__init__(self, bus, "/")
2681
2324
            _interface = "se.recompile.Mandos"
2682
2325
            
2683
 
            @dbus_interface_annotations(_interface)
2684
 
            def _foo(self):
2685
 
                return { "org.freedesktop.DBus.Property"
2686
 
                         ".EmitsChangedSignal":
2687
 
                             "false"}
2688
 
            
2689
2326
            @dbus.service.signal(_interface, signature="o")
2690
2327
            def ClientAdded(self, objpath):
2691
2328
                "D-Bus signal"
2733
2370
            
2734
2371
            del _interface
2735
2372
        
2736
 
        mandos_dbus_service = MandosDBusService()
 
2373
        class MandosDBusServiceTransitional(MandosDBusService):
 
2374
            __metaclass__ = AlternateDBusNamesMetaclass
 
2375
        mandos_dbus_service = MandosDBusServiceTransitional()
2737
2376
    
2738
2377
    def cleanup():
2739
2378
        "Cleanup function; run on exit"
2740
2379
        service.cleanup()
2741
2380
        
2742
2381
        multiprocessing.active_children()
2743
 
        wnull.close()
2744
2382
        if not (tcp_server.clients or client_settings):
2745
2383
            return
2746
2384
        
2758
2396
                # A list of attributes that can not be pickled
2759
2397
                # + secret.
2760
2398
                exclude = set(("bus", "changedstate", "secret",
2761
 
                               "checker", "server_settings"))
 
2399
                               "checker"))
2762
2400
                for name, typ in (inspect.getmembers
2763
2401
                                  (dbus.service.Object)):
2764
2402
                    exclude.add(name)
2773
2411
                del client_settings[client.name]["secret"]
2774
2412
        
2775
2413
        try:
2776
 
            with (tempfile.NamedTemporaryFile
2777
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2778
 
                   dir=os.path.dirname(stored_state_path),
2779
 
                   delete=False)) as stored_state:
 
2414
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
 
2415
                                                prefix="clients-",
 
2416
                                                dir=os.path.dirname
 
2417
                                                (stored_state_path))
 
2418
            with os.fdopen(tempfd, "wb") as stored_state:
2780
2419
                pickle.dump((clients, client_settings), stored_state)
2781
 
                tempname=stored_state.name
2782
2420
            os.rename(tempname, stored_state_path)
2783
2421
        except (IOError, OSError) as e:
 
2422
            logger.warning("Could not save persistent state: {0}"
 
2423
                           .format(e))
2784
2424
            if not debug:
2785
2425
                try:
2786
2426
                    os.remove(tempname)
2787
2427
                except NameError:
2788
2428
                    pass
2789
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2790
 
                logger.warning("Could not save persistent state: {0}"
2791
 
                               .format(os.strerror(e.errno)))
2792
 
            else:
2793
 
                logger.warning("Could not save persistent state:",
2794
 
                               exc_info=e)
 
2429
            if e.errno not in set((errno.ENOENT, errno.EACCES,
 
2430
                                   errno.EEXIST)):
2795
2431
                raise e
2796
2432
        
2797
2433
        # Delete all clients, and settings from config
2825
2461
    service.port = tcp_server.socket.getsockname()[1]
2826
2462
    if use_ipv6:
2827
2463
        logger.info("Now listening on address %r, port %d,"
2828
 
                    " flowinfo %d, scope_id %d",
2829
 
                    *tcp_server.socket.getsockname())
 
2464
                    " flowinfo %d, scope_id %d"
 
2465
                    % tcp_server.socket.getsockname())
2830
2466
    else:                       # IPv4
2831
 
        logger.info("Now listening on address %r, port %d",
2832
 
                    *tcp_server.socket.getsockname())
 
2467
        logger.info("Now listening on address %r, port %d"
 
2468
                    % tcp_server.socket.getsockname())
2833
2469
    
2834
2470
    #service.interface = tcp_server.socket.getsockname()[3]
2835
2471
    
2838
2474
        try:
2839
2475
            service.activate()
2840
2476
        except dbus.exceptions.DBusException as error:
2841
 
            logger.critical("D-Bus Exception", exc_info=error)
 
2477
            logger.critical("DBusException: %s", error)
2842
2478
            cleanup()
2843
2479
            sys.exit(1)
2844
2480
        # End of Avahi example code
2851
2487
        logger.debug("Starting main loop")
2852
2488
        main_loop.run()
2853
2489
    except AvahiError as error:
2854
 
        logger.critical("Avahi Error", exc_info=error)
 
2490
        logger.critical("AvahiError: %s", error)
2855
2491
        cleanup()
2856
2492
        sys.exit(1)
2857
2493
    except KeyboardInterrupt: