/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

* mandos (AvahiService.rename, Client.start_checker,
          DBusObjectWithProperties.Introspect, main): Use new
          "exc_info" keyword argument to logger to log exception
          information.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python2.7
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2014 Teddy Hogeborn
15
 
# Copyright © 2008-2014 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
68
66
import binascii
69
67
import tempfile
70
68
import itertools
71
 
import collections
72
69
 
73
70
import dbus
74
71
import dbus.service
79
76
import ctypes.util
80
77
import xml.dom.minidom
81
78
import inspect
 
79
import GnuPGInterface
82
80
 
83
81
try:
84
82
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
86
    except ImportError:
89
87
        SO_BINDTODEVICE = None
90
88
 
91
 
if sys.version_info.major == 2:
92
 
    str = unicode
93
 
 
94
 
version = "1.6.9"
 
89
version = "1.5.3"
95
90
stored_state_file = "clients.pickle"
96
91
 
97
92
logger = logging.getLogger()
98
 
syslogger = None
 
93
syslogger = (logging.handlers.SysLogHandler
 
94
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
95
              address = str("/dev/log")))
99
96
 
100
97
try:
101
98
    if_nametoindex = (ctypes.cdll.LoadLibrary
107
104
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
108
105
        with contextlib.closing(socket.socket()) as s:
109
106
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
110
 
                                struct.pack(b"16s16x", interface))
111
 
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
107
                                struct.pack(str("16s16x"),
 
108
                                            interface))
 
109
        interface_index = struct.unpack(str("I"),
 
110
                                        ifreq[16:20])[0]
112
111
        return interface_index
113
112
 
114
113
 
115
114
def initlogger(debug, level=logging.WARNING):
116
115
    """init logger and add loglevel"""
117
116
    
118
 
    global syslogger
119
 
    syslogger = (logging.handlers.SysLogHandler
120
 
                 (facility =
121
 
                  logging.handlers.SysLogHandler.LOG_DAEMON,
122
 
                  address = "/dev/log"))
123
117
    syslogger.setFormatter(logging.Formatter
124
118
                           ('Mandos [%(process)d]: %(levelname)s:'
125
119
                            ' %(message)s'))
143
137
class PGPEngine(object):
144
138
    """A simple class for OpenPGP symmetric encryption & decryption"""
145
139
    def __init__(self):
 
140
        self.gnupg = GnuPGInterface.GnuPG()
146
141
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
147
 
        self.gnupgargs = ['--batch',
148
 
                          '--home', self.tempdir,
149
 
                          '--force-mdc',
150
 
                          '--quiet',
151
 
                          '--no-use-agent']
 
142
        self.gnupg = GnuPGInterface.GnuPG()
 
143
        self.gnupg.options.meta_interactive = False
 
144
        self.gnupg.options.homedir = self.tempdir
 
145
        self.gnupg.options.extra_args.extend(['--force-mdc',
 
146
                                              '--quiet',
 
147
                                              '--no-use-agent'])
152
148
    
153
149
    def __enter__(self):
154
150
        return self
155
151
    
156
 
    def __exit__(self, exc_type, exc_value, traceback):
 
152
    def __exit__ (self, exc_type, exc_value, traceback):
157
153
        self._cleanup()
158
154
        return False
159
155
    
176
172
    def password_encode(self, password):
177
173
        # Passphrase can not be empty and can not contain newlines or
178
174
        # NUL bytes.  So we prefix it and hex encode it.
179
 
        encoded = b"mandos" + binascii.hexlify(password)
180
 
        if len(encoded) > 2048:
181
 
            # GnuPG can't handle long passwords, so encode differently
182
 
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
183
 
                       .replace(b"\n", b"\\n")
184
 
                       .replace(b"\0", b"\\x00"))
185
 
        return encoded
 
175
        return b"mandos" + binascii.hexlify(password)
186
176
    
187
177
    def encrypt(self, data, password):
188
 
        passphrase = self.password_encode(password)
189
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
190
 
                                         ) as passfile:
191
 
            passfile.write(passphrase)
192
 
            passfile.flush()
193
 
            proc = subprocess.Popen(['gpg', '--symmetric',
194
 
                                     '--passphrase-file',
195
 
                                     passfile.name]
196
 
                                    + self.gnupgargs,
197
 
                                    stdin = subprocess.PIPE,
198
 
                                    stdout = subprocess.PIPE,
199
 
                                    stderr = subprocess.PIPE)
200
 
            ciphertext, err = proc.communicate(input = data)
201
 
        if proc.returncode != 0:
202
 
            raise PGPError(err)
 
178
        self.gnupg.passphrase = self.password_encode(password)
 
179
        with open(os.devnull, "w") as devnull:
 
180
            try:
 
181
                proc = self.gnupg.run(['--symmetric'],
 
182
                                      create_fhs=['stdin', 'stdout'],
 
183
                                      attach_fhs={'stderr': devnull})
 
184
                with contextlib.closing(proc.handles['stdin']) as f:
 
185
                    f.write(data)
 
186
                with contextlib.closing(proc.handles['stdout']) as f:
 
187
                    ciphertext = f.read()
 
188
                proc.wait()
 
189
            except IOError as e:
 
190
                raise PGPError(e)
 
191
        self.gnupg.passphrase = None
203
192
        return ciphertext
204
193
    
205
194
    def decrypt(self, data, password):
206
 
        passphrase = self.password_encode(password)
207
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
208
 
                                         ) as passfile:
209
 
            passfile.write(passphrase)
210
 
            passfile.flush()
211
 
            proc = subprocess.Popen(['gpg', '--decrypt',
212
 
                                     '--passphrase-file',
213
 
                                     passfile.name]
214
 
                                    + self.gnupgargs,
215
 
                                    stdin = subprocess.PIPE,
216
 
                                    stdout = subprocess.PIPE,
217
 
                                    stderr = subprocess.PIPE)
218
 
            decrypted_plaintext, err = proc.communicate(input
219
 
                                                        = data)
220
 
        if proc.returncode != 0:
221
 
            raise PGPError(err)
 
195
        self.gnupg.passphrase = self.password_encode(password)
 
196
        with open(os.devnull, "w") as devnull:
 
197
            try:
 
198
                proc = self.gnupg.run(['--decrypt'],
 
199
                                      create_fhs=['stdin', 'stdout'],
 
200
                                      attach_fhs={'stderr': devnull})
 
201
                with contextlib.closing(proc.handles['stdin']) as f:
 
202
                    f.write(data)
 
203
                with contextlib.closing(proc.handles['stdout']) as f:
 
204
                    decrypted_plaintext = f.read()
 
205
                proc.wait()
 
206
            except IOError as e:
 
207
                raise PGPError(e)
 
208
        self.gnupg.passphrase = None
222
209
        return decrypted_plaintext
223
210
 
224
211
 
 
212
 
225
213
class AvahiError(Exception):
226
214
    def __init__(self, value, *args, **kwargs):
227
215
        self.value = value
228
 
        return super(AvahiError, self).__init__(value, *args,
229
 
                                                **kwargs)
 
216
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
217
    def __unicode__(self):
 
218
        return unicode(repr(self.value))
230
219
 
231
220
class AvahiServiceError(AvahiError):
232
221
    pass
243
232
               Used to optionally bind to the specified interface.
244
233
    name: string; Example: 'Mandos'
245
234
    type: string; Example: '_mandos._tcp'.
246
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
235
                  See <http://www.dns-sd.org/ServiceTypes.html>
247
236
    port: integer; what port to announce
248
237
    TXT: list of strings; TXT record for the service
249
238
    domain: string; Domain to publish on, default to .local if empty.
255
244
    server: D-Bus Server
256
245
    bus: dbus.SystemBus()
257
246
    """
258
 
    
259
247
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
248
                 servicetype = None, port = None, TXT = None,
261
249
                 domain = "", host = "", max_renames = 32768,
274
262
        self.server = None
275
263
        self.bus = bus
276
264
        self.entry_group_state_changed_match = None
277
 
    
278
 
    def rename(self, remove=True):
 
265
    def rename(self):
279
266
        """Derived from the Avahi example code"""
280
267
        if self.rename_count >= self.max_renames:
281
268
            logger.critical("No suitable Zeroconf service name found"
282
269
                            " after %i retries, exiting.",
283
270
                            self.rename_count)
284
271
            raise AvahiServiceError("Too many renames")
285
 
        self.name = str(self.server
286
 
                        .GetAlternativeServiceName(self.name))
287
 
        self.rename_count += 1
 
272
        self.name = unicode(self.server
 
273
                            .GetAlternativeServiceName(self.name))
288
274
        logger.info("Changing Zeroconf service name to %r ...",
289
275
                    self.name)
290
 
        if remove:
291
 
            self.remove()
 
276
        self.remove()
292
277
        try:
293
278
            self.add()
294
279
        except dbus.exceptions.DBusException as error:
295
 
            if (error.get_dbus_name()
296
 
                == "org.freedesktop.Avahi.CollisionError"):
297
 
                logger.info("Local Zeroconf service name collision.")
298
 
                return self.rename(remove=False)
299
 
            else:
300
 
                logger.critical("D-Bus Exception", exc_info=error)
301
 
                self.cleanup()
302
 
                os._exit(1)
303
 
    
 
280
            logger.critical("D-Bus Exception", exc_info=error)
 
281
            self.cleanup()
 
282
            os._exit(1)
 
283
        self.rename_count += 1
304
284
    def remove(self):
305
285
        """Derived from the Avahi example code"""
306
286
        if self.entry_group_state_changed_match is not None:
308
288
            self.entry_group_state_changed_match = None
309
289
        if self.group is not None:
310
290
            self.group.Reset()
311
 
    
312
291
    def add(self):
313
292
        """Derived from the Avahi example code"""
314
293
        self.remove()
331
310
            dbus.UInt16(self.port),
332
311
            avahi.string_array_to_txt_array(self.TXT))
333
312
        self.group.Commit()
334
 
    
335
313
    def entry_group_state_changed(self, state, error):
336
314
        """Derived from the Avahi example code"""
337
315
        logger.debug("Avahi entry group state change: %i", state)
343
321
            self.rename()
344
322
        elif state == avahi.ENTRY_GROUP_FAILURE:
345
323
            logger.critical("Avahi: Error in group state changed %s",
346
 
                            str(error))
347
 
            raise AvahiGroupError("State changed: {!s}"
348
 
                                  .format(error))
349
 
    
 
324
                            unicode(error))
 
325
            raise AvahiGroupError("State changed: %s"
 
326
                                  % unicode(error))
350
327
    def cleanup(self):
351
328
        """Derived from the Avahi example code"""
352
329
        if self.group is not None:
357
334
                pass
358
335
            self.group = None
359
336
        self.remove()
360
 
    
361
337
    def server_state_changed(self, state, error=None):
362
338
        """Derived from the Avahi example code"""
363
339
        logger.debug("Avahi server state change: %i", state)
382
358
                logger.debug("Unknown state: %r", state)
383
359
            else:
384
360
                logger.debug("Unknown state: %r: %r", state, error)
385
 
    
386
361
    def activate(self):
387
362
        """Derived from the Avahi example code"""
388
363
        if self.server is None:
395
370
                                 self.server_state_changed)
396
371
        self.server_state_changed(self.server.GetState())
397
372
 
398
 
 
399
373
class AvahiServiceToSyslog(AvahiService):
400
 
    def rename(self, *args, **kwargs):
 
374
    def rename(self):
401
375
        """Add the new name to the syslog messages"""
402
 
        ret = AvahiService.rename(self, *args, **kwargs)
 
376
        ret = AvahiService.rename(self)
403
377
        syslogger.setFormatter(logging.Formatter
404
 
                               ('Mandos ({}) [%(process)d]:'
405
 
                                ' %(levelname)s: %(message)s'
406
 
                                .format(self.name)))
 
378
                               ('Mandos (%s) [%%(process)d]:'
 
379
                                ' %%(levelname)s: %%(message)s'
 
380
                                % self.name))
407
381
        return ret
408
382
 
409
 
 
 
383
def timedelta_to_milliseconds(td):
 
384
    "Convert a datetime.timedelta() to milliseconds"
 
385
    return ((td.days * 24 * 60 * 60 * 1000)
 
386
            + (td.seconds * 1000)
 
387
            + (td.microseconds // 1000))
 
388
        
410
389
class Client(object):
411
390
    """A representation of a client host served by this server.
412
391
    
448
427
    runtime_expansions: Allowed attributes for runtime expansion.
449
428
    expires:    datetime.datetime(); time (UTC) when a client will be
450
429
                disabled, or None
451
 
    server_settings: The server_settings dict from main()
452
430
    """
453
431
    
454
432
    runtime_expansions = ("approval_delay", "approval_duration",
455
 
                          "created", "enabled", "expires",
456
 
                          "fingerprint", "host", "interval",
457
 
                          "last_approval_request", "last_checked_ok",
 
433
                          "created", "enabled", "fingerprint",
 
434
                          "host", "interval", "last_checked_ok",
458
435
                          "last_enabled", "name", "timeout")
459
 
    client_defaults = { "timeout": "PT5M",
460
 
                        "extended_timeout": "PT15M",
461
 
                        "interval": "PT2M",
 
436
    client_defaults = { "timeout": "5m",
 
437
                        "extended_timeout": "15m",
 
438
                        "interval": "2m",
462
439
                        "checker": "fping -q -- %%(host)s",
463
440
                        "host": "",
464
 
                        "approval_delay": "PT0S",
465
 
                        "approval_duration": "PT1S",
 
441
                        "approval_delay": "0s",
 
442
                        "approval_duration": "1s",
466
443
                        "approved_by_default": "True",
467
444
                        "enabled": "True",
468
445
                        }
469
446
    
 
447
    def timeout_milliseconds(self):
 
448
        "Return the 'timeout' attribute in milliseconds"
 
449
        return timedelta_to_milliseconds(self.timeout)
 
450
    
 
451
    def extended_timeout_milliseconds(self):
 
452
        "Return the 'extended_timeout' attribute in milliseconds"
 
453
        return timedelta_to_milliseconds(self.extended_timeout)
 
454
    
 
455
    def interval_milliseconds(self):
 
456
        "Return the 'interval' attribute in milliseconds"
 
457
        return timedelta_to_milliseconds(self.interval)
 
458
    
 
459
    def approval_delay_milliseconds(self):
 
460
        return timedelta_to_milliseconds(self.approval_delay)
 
461
 
470
462
    @staticmethod
471
463
    def config_parser(config):
472
464
        """Construct a new dict of client settings of this form:
497
489
                          "rb") as secfile:
498
490
                    client["secret"] = secfile.read()
499
491
            else:
500
 
                raise TypeError("No secret or secfile for section {}"
501
 
                                .format(section))
 
492
                raise TypeError("No secret or secfile for section %s"
 
493
                                % section)
502
494
            client["timeout"] = string_to_delta(section["timeout"])
503
495
            client["extended_timeout"] = string_to_delta(
504
496
                section["extended_timeout"])
513
505
            client["last_checker_status"] = -2
514
506
        
515
507
        return settings
516
 
    
517
 
    def __init__(self, settings, name = None, server_settings=None):
 
508
        
 
509
        
 
510
    def __init__(self, settings, name = None):
 
511
        """Note: the 'checker' key in 'config' sets the
 
512
        'checker_command' attribute and *not* the 'checker'
 
513
        attribute."""
518
514
        self.name = name
519
 
        if server_settings is None:
520
 
            server_settings = {}
521
 
        self.server_settings = server_settings
522
515
        # adding all client settings
523
 
        for setting, value in settings.items():
 
516
        for setting, value in settings.iteritems():
524
517
            setattr(self, setting, value)
525
518
        
526
519
        if self.enabled:
532
525
        else:
533
526
            self.last_enabled = None
534
527
            self.expires = None
535
 
        
 
528
       
536
529
        logger.debug("Creating client %r", self.name)
537
530
        # Uppercase and remove spaces from fingerprint for later
538
531
        # comparison purposes with return value from the fingerprint()
540
533
        logger.debug("  Fingerprint: %s", self.fingerprint)
541
534
        self.created = settings.get("created",
542
535
                                    datetime.datetime.utcnow())
543
 
        
 
536
 
544
537
        # attributes specific for this server instance
545
538
        self.checker = None
546
539
        self.checker_initiator_tag = None
574
567
        if getattr(self, "enabled", False):
575
568
            # Already enabled
576
569
            return
 
570
        self.send_changedstate()
577
571
        self.expires = datetime.datetime.utcnow() + self.timeout
578
572
        self.enabled = True
579
573
        self.last_enabled = datetime.datetime.utcnow()
580
574
        self.init_checker()
581
 
        self.send_changedstate()
582
575
    
583
576
    def disable(self, quiet=True):
584
577
        """Disable this client."""
585
578
        if not getattr(self, "enabled", False):
586
579
            return False
587
580
        if not quiet:
 
581
            self.send_changedstate()
 
582
        if not quiet:
588
583
            logger.info("Disabling client %s", self.name)
589
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
584
        if getattr(self, "disable_initiator_tag", False):
590
585
            gobject.source_remove(self.disable_initiator_tag)
591
586
            self.disable_initiator_tag = None
592
587
        self.expires = None
593
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
588
        if getattr(self, "checker_initiator_tag", False):
594
589
            gobject.source_remove(self.checker_initiator_tag)
595
590
            self.checker_initiator_tag = None
596
591
        self.stop_checker()
597
592
        self.enabled = False
598
 
        if not quiet:
599
 
            self.send_changedstate()
600
593
        # Do not run this again if called by a gobject.timeout_add
601
594
        return False
602
595
    
606
599
    def init_checker(self):
607
600
        # Schedule a new checker to be started an 'interval' from now,
608
601
        # and every interval from then on.
609
 
        if self.checker_initiator_tag is not None:
610
 
            gobject.source_remove(self.checker_initiator_tag)
611
602
        self.checker_initiator_tag = (gobject.timeout_add
612
 
                                      (int(self.interval
613
 
                                           .total_seconds() * 1000),
 
603
                                      (self.interval_milliseconds(),
614
604
                                       self.start_checker))
615
605
        # Schedule a disable() when 'timeout' has passed
616
 
        if self.disable_initiator_tag is not None:
617
 
            gobject.source_remove(self.disable_initiator_tag)
618
606
        self.disable_initiator_tag = (gobject.timeout_add
619
 
                                      (int(self.timeout
620
 
                                           .total_seconds() * 1000),
621
 
                                       self.disable))
 
607
                                   (self.timeout_milliseconds(),
 
608
                                    self.disable))
622
609
        # Also start a new checker *right now*.
623
610
        self.start_checker()
624
611
    
652
639
            timeout = self.timeout
653
640
        if self.disable_initiator_tag is not None:
654
641
            gobject.source_remove(self.disable_initiator_tag)
655
 
            self.disable_initiator_tag = None
656
642
        if getattr(self, "enabled", False):
657
643
            self.disable_initiator_tag = (gobject.timeout_add
658
 
                                          (int(timeout.total_seconds()
659
 
                                               * 1000), self.disable))
 
644
                                          (timedelta_to_milliseconds
 
645
                                           (timeout), self.disable))
660
646
            self.expires = datetime.datetime.utcnow() + timeout
661
647
    
662
648
    def need_approval(self):
668
654
        If a checker already exists, leave it running and do
669
655
        nothing."""
670
656
        # The reason for not killing a running checker is that if we
671
 
        # did that, and if a checker (for some reason) started running
672
 
        # slowly and taking more than 'interval' time, then the client
673
 
        # would inevitably timeout, since no checker would get a
674
 
        # chance to run to completion.  If we instead leave running
 
657
        # did that, then if a checker (for some reason) started
 
658
        # running slowly and taking more than 'interval' time, the
 
659
        # client would inevitably timeout, since no checker would get
 
660
        # a chance to run to completion.  If we instead leave running
675
661
        # checkers alone, the checker would have to take more time
676
662
        # than 'timeout' for the client to be disabled, which is as it
677
663
        # should be.
679
665
        # If a checker exists, make sure it is not a zombie
680
666
        try:
681
667
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
682
 
        except AttributeError:
683
 
            pass
684
 
        except OSError as error:
685
 
            if error.errno != errno.ECHILD:
686
 
                raise
 
668
        except (AttributeError, OSError) as error:
 
669
            if (isinstance(error, OSError)
 
670
                and error.errno != errno.ECHILD):
 
671
                raise error
687
672
        else:
688
673
            if pid:
689
674
                logger.warning("Checker was a zombie")
692
677
                                      self.current_checker_command)
693
678
        # Start a new checker if needed
694
679
        if self.checker is None:
695
 
            # Escape attributes for the shell
696
 
            escaped_attrs = { attr:
697
 
                                  re.escape(str(getattr(self, attr)))
698
 
                              for attr in self.runtime_expansions }
699
680
            try:
700
 
                command = self.checker_command % escaped_attrs
701
 
            except TypeError as error:
702
 
                logger.error('Could not format string "%s"',
703
 
                             self.checker_command, exc_info=error)
704
 
                return True # Try again later
 
681
                # In case checker_command has exactly one % operator
 
682
                command = self.checker_command % self.host
 
683
            except TypeError:
 
684
                # Escape attributes for the shell
 
685
                escaped_attrs = dict(
 
686
                    (attr,
 
687
                     re.escape(unicode(str(getattr(self, attr, "")),
 
688
                                       errors=
 
689
                                       'replace')))
 
690
                    for attr in
 
691
                    self.runtime_expansions)
 
692
                
 
693
                try:
 
694
                    command = self.checker_command % escaped_attrs
 
695
                except TypeError as error:
 
696
                    logger.error('Could not format string "%s"',
 
697
                                 self.checker_command, exc_info=error)
 
698
                    return True # Try again later
705
699
            self.current_checker_command = command
706
700
            try:
707
701
                logger.info("Starting checker %r for %s",
710
704
                # in normal mode, that is already done by daemon(),
711
705
                # and in debug mode we don't want to.  (Stdin is
712
706
                # always replaced by /dev/null.)
713
 
                # The exception is when not debugging but nevertheless
714
 
                # running in the foreground; use the previously
715
 
                # created wnull.
716
 
                popen_args = {}
717
 
                if (not self.server_settings["debug"]
718
 
                    and self.server_settings["foreground"]):
719
 
                    popen_args.update({"stdout": wnull,
720
 
                                       "stderr": wnull })
721
707
                self.checker = subprocess.Popen(command,
722
708
                                                close_fds=True,
723
 
                                                shell=True, cwd="/",
724
 
                                                **popen_args)
 
709
                                                shell=True, cwd="/")
 
710
                self.checker_callback_tag = (gobject.child_watch_add
 
711
                                             (self.checker.pid,
 
712
                                              self.checker_callback,
 
713
                                              data=command))
 
714
                # The checker may have completed before the gobject
 
715
                # watch was added.  Check for this.
 
716
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
717
                if pid:
 
718
                    gobject.source_remove(self.checker_callback_tag)
 
719
                    self.checker_callback(pid, status, command)
725
720
            except OSError as error:
726
721
                logger.error("Failed to start subprocess",
727
722
                             exc_info=error)
728
 
                return True
729
 
            self.checker_callback_tag = (gobject.child_watch_add
730
 
                                         (self.checker.pid,
731
 
                                          self.checker_callback,
732
 
                                          data=command))
733
 
            # The checker may have completed before the gobject
734
 
            # watch was added.  Check for this.
735
 
            try:
736
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
737
 
            except OSError as error:
738
 
                if error.errno == errno.ECHILD:
739
 
                    # This should never happen
740
 
                    logger.error("Child process vanished",
741
 
                                 exc_info=error)
742
 
                    return True
743
 
                raise
744
 
            if pid:
745
 
                gobject.source_remove(self.checker_callback_tag)
746
 
                self.checker_callback(pid, status, command)
747
723
        # Re-run this periodically if run by gobject.timeout_add
748
724
        return True
749
725
    
782
758
    # "Set" method, so we fail early here:
783
759
    if byte_arrays and signature != "ay":
784
760
        raise ValueError("Byte arrays not supported for non-'ay'"
785
 
                         " signature {!r}".format(signature))
 
761
                         " signature %r" % signature)
786
762
    def decorator(func):
787
763
        func._dbus_is_property = True
788
764
        func._dbus_interface = dbus_interface
797
773
 
798
774
 
799
775
def dbus_interface_annotations(dbus_interface):
800
 
    """Decorator for marking functions returning interface annotations
 
776
    """Decorator for marking functions returning interface annotations.
801
777
    
802
778
    Usage:
803
779
    
819
795
    """Decorator to annotate D-Bus methods, signals or properties
820
796
    Usage:
821
797
    
822
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
823
 
                       "org.freedesktop.DBus.Property."
824
 
                       "EmitsChangedSignal": "false"})
825
798
    @dbus_service_property("org.example.Interface", signature="b",
826
799
                           access="r")
 
800
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
801
                        "org.freedesktop.DBus.Property."
 
802
                        "EmitsChangedSignal": "false"})
827
803
    def Property_dbus_property(self):
828
804
        return dbus.Boolean(False)
829
805
    """
836
812
class DBusPropertyException(dbus.exceptions.DBusException):
837
813
    """A base class for D-Bus property-related exceptions
838
814
    """
839
 
    pass
 
815
    def __unicode__(self):
 
816
        return unicode(str(self))
 
817
 
840
818
 
841
819
class DBusPropertyAccessException(DBusPropertyException):
842
820
    """A property's access permissions disallows an operation.
865
843
        If called like _is_dbus_thing("method") it returns a function
866
844
        suitable for use as predicate to inspect.getmembers().
867
845
        """
868
 
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
846
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
869
847
                                   False)
870
848
    
871
849
    def _get_all_dbus_things(self, thing):
920
898
            # The byte_arrays option is not supported yet on
921
899
            # signatures other than "ay".
922
900
            if prop._dbus_signature != "ay":
923
 
                raise ValueError("Byte arrays not supported for non-"
924
 
                                 "'ay' signature {!r}"
925
 
                                 .format(prop._dbus_signature))
 
901
                raise ValueError
926
902
            value = dbus.ByteArray(b''.join(chr(byte)
927
903
                                            for byte in value))
928
904
        prop(value)
952
928
                                           value.variant_level+1)
953
929
        return dbus.Dictionary(properties, signature="sv")
954
930
    
955
 
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
956
 
    def PropertiesChanged(self, interface_name, changed_properties,
957
 
                          invalidated_properties):
958
 
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
959
 
        standard.
960
 
        """
961
 
        pass
962
 
    
963
931
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
964
932
                         out_signature="s",
965
933
                         path_keyword='object_path',
1000
968
                                              (prop,
1001
969
                                               "_dbus_annotations",
1002
970
                                               {}))
1003
 
                        for name, value in annots.items():
 
971
                        for name, value in annots.iteritems():
1004
972
                            ann_tag = document.createElement(
1005
973
                                "annotation")
1006
974
                            ann_tag.setAttribute("name", name)
1008
976
                            tag.appendChild(ann_tag)
1009
977
                # Add interface annotation tags
1010
978
                for annotation, value in dict(
1011
 
                    itertools.chain.from_iterable(
1012
 
                        annotations().items()
1013
 
                        for name, annotations in
1014
 
                        self._get_all_dbus_things("interface")
1015
 
                        if name == if_tag.getAttribute("name")
1016
 
                        )).items():
 
979
                    itertools.chain(
 
980
                        *(annotations().iteritems()
 
981
                          for name, annotations in
 
982
                          self._get_all_dbus_things("interface")
 
983
                          if name == if_tag.getAttribute("name")
 
984
                          ))).iteritems():
1017
985
                    ann_tag = document.createElement("annotation")
1018
986
                    ann_tag.setAttribute("name", annotation)
1019
987
                    ann_tag.setAttribute("value", value)
1042
1010
        return xmlstring
1043
1011
 
1044
1012
 
1045
 
def datetime_to_dbus(dt, variant_level=0):
 
1013
def datetime_to_dbus (dt, variant_level=0):
1046
1014
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1047
1015
    if dt is None:
1048
1016
        return dbus.String("", variant_level = variant_level)
1050
1018
                       variant_level=variant_level)
1051
1019
 
1052
1020
 
1053
 
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1054
 
    """A class decorator; applied to a subclass of
1055
 
    dbus.service.Object, it will add alternate D-Bus attributes with
1056
 
    interface names according to the "alt_interface_names" mapping.
1057
 
    Usage:
1058
 
    
1059
 
    @alternate_dbus_interfaces({"org.example.Interface":
1060
 
                                    "net.example.AlternateInterface"})
1061
 
    class SampleDBusObject(dbus.service.Object):
1062
 
        @dbus.service.method("org.example.Interface")
1063
 
        def SampleDBusMethod():
1064
 
            pass
1065
 
    
1066
 
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1067
 
    reachable via two interfaces: "org.example.Interface" and
1068
 
    "net.example.AlternateInterface", the latter of which will have
1069
 
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1070
 
    "true", unless "deprecate" is passed with a False value.
1071
 
    
1072
 
    This works for methods and signals, and also for D-Bus properties
1073
 
    (from DBusObjectWithProperties) and interfaces (from the
1074
 
    dbus_interface_annotations decorator).
 
1021
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
1022
                                  .__metaclass__):
 
1023
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
1024
    will add additional D-Bus attributes matching a certain pattern.
1075
1025
    """
1076
 
    def wrapper(cls):
1077
 
        for orig_interface_name, alt_interface_name in (
1078
 
            alt_interface_names.items()):
1079
 
            attr = {}
1080
 
            interface_names = set()
1081
 
            # Go though all attributes of the class
1082
 
            for attrname, attribute in inspect.getmembers(cls):
 
1026
    def __new__(mcs, name, bases, attr):
 
1027
        # Go through all the base classes which could have D-Bus
 
1028
        # methods, signals, or properties in them
 
1029
        old_interface_names = []
 
1030
        for base in (b for b in bases
 
1031
                     if issubclass(b, dbus.service.Object)):
 
1032
            # Go though all attributes of the base class
 
1033
            for attrname, attribute in inspect.getmembers(base):
1083
1034
                # Ignore non-D-Bus attributes, and D-Bus attributes
1084
1035
                # with the wrong interface name
1085
1036
                if (not hasattr(attribute, "_dbus_interface")
1086
1037
                    or not attribute._dbus_interface
1087
 
                    .startswith(orig_interface_name)):
 
1038
                    .startswith("se.recompile.Mandos")):
1088
1039
                    continue
1089
1040
                # Create an alternate D-Bus interface name based on
1090
1041
                # the current name
1091
1042
                alt_interface = (attribute._dbus_interface
1092
 
                                 .replace(orig_interface_name,
1093
 
                                          alt_interface_name))
1094
 
                interface_names.add(alt_interface)
 
1043
                                 .replace("se.recompile.Mandos",
 
1044
                                          "se.bsnet.fukt.Mandos"))
 
1045
                if alt_interface != attribute._dbus_interface:
 
1046
                    old_interface_names.append(alt_interface)
1095
1047
                # Is this a D-Bus signal?
1096
1048
                if getattr(attribute, "_dbus_is_signal", False):
1097
 
                    # Extract the original non-method undecorated
1098
 
                    # function by black magic
 
1049
                    # Extract the original non-method function by
 
1050
                    # black magic
1099
1051
                    nonmethod_func = (dict(
1100
1052
                            zip(attribute.func_code.co_freevars,
1101
1053
                                attribute.__closure__))["func"]
1119
1071
                    except AttributeError:
1120
1072
                        pass
1121
1073
                    # Define a creator of a function to call both the
1122
 
                    # original and alternate functions, so both the
1123
 
                    # original and alternate signals gets sent when
1124
 
                    # the function is called
 
1074
                    # old and new functions, so both the old and new
 
1075
                    # signals gets sent when the function is called
1125
1076
                    def fixscope(func1, func2):
1126
1077
                        """This function is a scope container to pass
1127
1078
                        func1 and func2 to the "call_both" function
1134
1085
                        return call_both
1135
1086
                    # Create the "call_both" function and add it to
1136
1087
                    # the class
1137
 
                    attr[attrname] = fixscope(attribute, new_function)
 
1088
                    attr[attrname] = fixscope(attribute,
 
1089
                                              new_function)
1138
1090
                # Is this a D-Bus method?
1139
1091
                elif getattr(attribute, "_dbus_is_method", False):
1140
1092
                    # Create a new, but exactly alike, function
1196
1148
                                        attribute.func_name,
1197
1149
                                        attribute.func_defaults,
1198
1150
                                        attribute.func_closure)))
1199
 
            if deprecate:
1200
 
                # Deprecate all alternate interfaces
1201
 
                iname="_AlternateDBusNames_interface_annotation{}"
1202
 
                for interface_name in interface_names:
1203
 
                    @dbus_interface_annotations(interface_name)
1204
 
                    def func(self):
1205
 
                        return { "org.freedesktop.DBus.Deprecated":
1206
 
                                     "true" }
1207
 
                    # Find an unused name
1208
 
                    for aname in (iname.format(i)
1209
 
                                  for i in itertools.count()):
1210
 
                        if aname not in attr:
1211
 
                            attr[aname] = func
1212
 
                            break
1213
 
            if interface_names:
1214
 
                # Replace the class with a new subclass of it with
1215
 
                # methods, signals, etc. as created above.
1216
 
                cls = type(b"{}Alternate".format(cls.__name__),
1217
 
                           (cls,), attr)
1218
 
        return cls
1219
 
    return wrapper
1220
 
 
1221
 
 
1222
 
@alternate_dbus_interfaces({"se.recompile.Mandos":
1223
 
                                "se.bsnet.fukt.Mandos"})
 
1151
        # Deprecate all old interfaces
 
1152
        basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"
 
1153
        for old_interface_name in old_interface_names:
 
1154
            @dbus_interface_annotations(old_interface_name)
 
1155
            def func(self):
 
1156
                return { "org.freedesktop.DBus.Deprecated": "true" }
 
1157
            # Find an unused name
 
1158
            for aname in (basename.format(i) for i in
 
1159
                          itertools.count()):
 
1160
                if aname not in attr:
 
1161
                    attr[aname] = func
 
1162
                    break
 
1163
        return type.__new__(mcs, name, bases, attr)
 
1164
 
 
1165
 
1224
1166
class ClientDBus(Client, DBusObjectWithProperties):
1225
1167
    """A Client class using D-Bus
1226
1168
    
1232
1174
    runtime_expansions = (Client.runtime_expansions
1233
1175
                          + ("dbus_object_path",))
1234
1176
    
1235
 
    _interface = "se.recompile.Mandos.Client"
1236
 
    
1237
1177
    # dbus.service.Object doesn't use super(), so we can't either.
1238
1178
    
1239
1179
    def __init__(self, bus = None, *args, **kwargs):
1241
1181
        Client.__init__(self, *args, **kwargs)
1242
1182
        # Only now, when this client is initialized, can it show up on
1243
1183
        # the D-Bus
1244
 
        client_object_name = str(self.name).translate(
 
1184
        client_object_name = unicode(self.name).translate(
1245
1185
            {ord("."): ord("_"),
1246
1186
             ord("-"): ord("_")})
1247
1187
        self.dbus_object_path = (dbus.ObjectPath
1248
1188
                                 ("/clients/" + client_object_name))
1249
1189
        DBusObjectWithProperties.__init__(self, self.bus,
1250
1190
                                          self.dbus_object_path)
1251
 
    
 
1191
        
1252
1192
    def notifychangeproperty(transform_func,
1253
1193
                             dbus_name, type_func=lambda x: x,
1254
 
                             variant_level=1, invalidate_only=False,
1255
 
                             _interface=_interface):
 
1194
                             variant_level=1):
1256
1195
        """ Modify a variable so that it's a property which announces
1257
1196
        its changes to DBus.
1258
1197
        
1263
1202
                   to the D-Bus.  Default: no transform
1264
1203
        variant_level: D-Bus variant level.  Default: 1
1265
1204
        """
1266
 
        attrname = "_{}".format(dbus_name)
 
1205
        attrname = "_{0}".format(dbus_name)
1267
1206
        def setter(self, value):
1268
1207
            if hasattr(self, "dbus_object_path"):
1269
1208
                if (not hasattr(self, attrname) or
1270
1209
                    type_func(getattr(self, attrname, None))
1271
1210
                    != type_func(value)):
1272
 
                    if invalidate_only:
1273
 
                        self.PropertiesChanged(_interface,
1274
 
                                               dbus.Dictionary(),
1275
 
                                               dbus.Array
1276
 
                                               ((dbus_name,)))
1277
 
                    else:
1278
 
                        dbus_value = transform_func(type_func(value),
1279
 
                                                    variant_level
1280
 
                                                    =variant_level)
1281
 
                        self.PropertyChanged(dbus.String(dbus_name),
1282
 
                                             dbus_value)
1283
 
                        self.PropertiesChanged(_interface,
1284
 
                                               dbus.Dictionary({
1285
 
                                    dbus.String(dbus_name):
1286
 
                                        dbus_value }), dbus.Array())
 
1211
                    dbus_value = transform_func(type_func(value),
 
1212
                                                variant_level
 
1213
                                                =variant_level)
 
1214
                    self.PropertyChanged(dbus.String(dbus_name),
 
1215
                                         dbus_value)
1287
1216
            setattr(self, attrname, value)
1288
1217
        
1289
1218
        return property(lambda self: getattr(self, attrname), setter)
1290
1219
    
 
1220
    
1291
1221
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1292
1222
    approvals_pending = notifychangeproperty(dbus.Boolean,
1293
1223
                                             "ApprovalPending",
1309
1239
    approval_delay = notifychangeproperty(dbus.UInt64,
1310
1240
                                          "ApprovalDelay",
1311
1241
                                          type_func =
1312
 
                                          lambda td: td.total_seconds()
1313
 
                                          * 1000)
 
1242
                                          timedelta_to_milliseconds)
1314
1243
    approval_duration = notifychangeproperty(
1315
1244
        dbus.UInt64, "ApprovalDuration",
1316
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1245
        type_func = timedelta_to_milliseconds)
1317
1246
    host = notifychangeproperty(dbus.String, "Host")
1318
1247
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1319
 
                                   type_func = lambda td:
1320
 
                                       td.total_seconds() * 1000)
 
1248
                                   type_func =
 
1249
                                   timedelta_to_milliseconds)
1321
1250
    extended_timeout = notifychangeproperty(
1322
1251
        dbus.UInt64, "ExtendedTimeout",
1323
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1252
        type_func = timedelta_to_milliseconds)
1324
1253
    interval = notifychangeproperty(dbus.UInt64,
1325
1254
                                    "Interval",
1326
1255
                                    type_func =
1327
 
                                    lambda td: td.total_seconds()
1328
 
                                    * 1000)
 
1256
                                    timedelta_to_milliseconds)
1329
1257
    checker_command = notifychangeproperty(dbus.String, "Checker")
1330
 
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1331
 
                                  invalidate_only=True)
1332
1258
    
1333
1259
    del notifychangeproperty
1334
1260
    
1361
1287
                                       *args, **kwargs)
1362
1288
    
1363
1289
    def start_checker(self, *args, **kwargs):
1364
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
1290
        old_checker = self.checker
 
1291
        if self.checker is not None:
 
1292
            old_checker_pid = self.checker.pid
 
1293
        else:
 
1294
            old_checker_pid = None
1365
1295
        r = Client.start_checker(self, *args, **kwargs)
1366
1296
        # Only if new checker process was started
1367
1297
        if (self.checker is not None
1375
1305
        return False
1376
1306
    
1377
1307
    def approve(self, value=True):
 
1308
        self.send_changedstate()
1378
1309
        self.approved = value
1379
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1380
 
                                * 1000), self._reset_approved)
1381
 
        self.send_changedstate()
 
1310
        gobject.timeout_add(timedelta_to_milliseconds
 
1311
                            (self.approval_duration),
 
1312
                            self._reset_approved)
 
1313
    
1382
1314
    
1383
1315
    ## D-Bus methods, signals & properties
 
1316
    _interface = "se.recompile.Mandos.Client"
1384
1317
    
1385
1318
    ## Interfaces
1386
1319
    
 
1320
    @dbus_interface_annotations(_interface)
 
1321
    def _foo(self):
 
1322
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1323
                     "false"}
 
1324
    
1387
1325
    ## Signals
1388
1326
    
1389
1327
    # CheckerCompleted - signal
1399
1337
        pass
1400
1338
    
1401
1339
    # PropertyChanged - signal
1402
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1403
1340
    @dbus.service.signal(_interface, signature="sv")
1404
1341
    def PropertyChanged(self, property, value):
1405
1342
        "D-Bus signal"
1481
1418
                           access="readwrite")
1482
1419
    def ApprovalDelay_dbus_property(self, value=None):
1483
1420
        if value is None:       # get
1484
 
            return dbus.UInt64(self.approval_delay.total_seconds()
1485
 
                               * 1000)
 
1421
            return dbus.UInt64(self.approval_delay_milliseconds())
1486
1422
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1487
1423
    
1488
1424
    # ApprovalDuration - property
1490
1426
                           access="readwrite")
1491
1427
    def ApprovalDuration_dbus_property(self, value=None):
1492
1428
        if value is None:       # get
1493
 
            return dbus.UInt64(self.approval_duration.total_seconds()
1494
 
                               * 1000)
 
1429
            return dbus.UInt64(timedelta_to_milliseconds(
 
1430
                    self.approval_duration))
1495
1431
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1496
1432
    
1497
1433
    # Name - property
1510
1446
    def Host_dbus_property(self, value=None):
1511
1447
        if value is None:       # get
1512
1448
            return dbus.String(self.host)
1513
 
        self.host = str(value)
 
1449
        self.host = unicode(value)
1514
1450
    
1515
1451
    # Created - property
1516
1452
    @dbus_service_property(_interface, signature="s", access="read")
1563
1499
                           access="readwrite")
1564
1500
    def Timeout_dbus_property(self, value=None):
1565
1501
        if value is None:       # get
1566
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1567
 
        old_timeout = self.timeout
 
1502
            return dbus.UInt64(self.timeout_milliseconds())
1568
1503
        self.timeout = datetime.timedelta(0, 0, 0, value)
1569
 
        # Reschedule disabling
 
1504
        # Reschedule timeout
1570
1505
        if self.enabled:
1571
1506
            now = datetime.datetime.utcnow()
1572
 
            self.expires += self.timeout - old_timeout
1573
 
            if self.expires <= now:
 
1507
            time_to_die = timedelta_to_milliseconds(
 
1508
                (self.last_checked_ok + self.timeout) - now)
 
1509
            if time_to_die <= 0:
1574
1510
                # The timeout has passed
1575
1511
                self.disable()
1576
1512
            else:
 
1513
                self.expires = (now +
 
1514
                                datetime.timedelta(milliseconds =
 
1515
                                                   time_to_die))
1577
1516
                if (getattr(self, "disable_initiator_tag", None)
1578
1517
                    is None):
1579
1518
                    return
1580
1519
                gobject.source_remove(self.disable_initiator_tag)
1581
 
                self.disable_initiator_tag = (
1582
 
                    gobject.timeout_add(
1583
 
                        int((self.expires - now).total_seconds()
1584
 
                            * 1000), self.disable))
 
1520
                self.disable_initiator_tag = (gobject.timeout_add
 
1521
                                              (time_to_die,
 
1522
                                               self.disable))
1585
1523
    
1586
1524
    # ExtendedTimeout - property
1587
1525
    @dbus_service_property(_interface, signature="t",
1588
1526
                           access="readwrite")
1589
1527
    def ExtendedTimeout_dbus_property(self, value=None):
1590
1528
        if value is None:       # get
1591
 
            return dbus.UInt64(self.extended_timeout.total_seconds()
1592
 
                               * 1000)
 
1529
            return dbus.UInt64(self.extended_timeout_milliseconds())
1593
1530
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1594
1531
    
1595
1532
    # Interval - property
1597
1534
                           access="readwrite")
1598
1535
    def Interval_dbus_property(self, value=None):
1599
1536
        if value is None:       # get
1600
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1537
            return dbus.UInt64(self.interval_milliseconds())
1601
1538
        self.interval = datetime.timedelta(0, 0, 0, value)
1602
1539
        if getattr(self, "checker_initiator_tag", None) is None:
1603
1540
            return
1614
1551
    def Checker_dbus_property(self, value=None):
1615
1552
        if value is None:       # get
1616
1553
            return dbus.String(self.checker_command)
1617
 
        self.checker_command = str(value)
 
1554
        self.checker_command = unicode(value)
1618
1555
    
1619
1556
    # CheckerRunning - property
1620
1557
    @dbus_service_property(_interface, signature="b",
1636
1573
    @dbus_service_property(_interface, signature="ay",
1637
1574
                           access="write", byte_arrays=True)
1638
1575
    def Secret_dbus_property(self, value):
1639
 
        self.secret = bytes(value)
 
1576
        self.secret = str(value)
1640
1577
    
1641
1578
    del _interface
1642
1579
 
1667
1604
        self._pipe.send(('setattr', name, value))
1668
1605
 
1669
1606
 
 
1607
class ClientDBusTransitional(ClientDBus):
 
1608
    __metaclass__ = AlternateDBusNamesMetaclass
 
1609
 
 
1610
 
1670
1611
class ClientHandler(socketserver.BaseRequestHandler, object):
1671
1612
    """A class to handle client connections.
1672
1613
    
1676
1617
    def handle(self):
1677
1618
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1678
1619
            logger.info("TCP connection from: %s",
1679
 
                        str(self.client_address))
 
1620
                        unicode(self.client_address))
1680
1621
            logger.debug("Pipe FD: %d",
1681
1622
                         self.server.child_pipe.fileno())
1682
1623
            
1708
1649
            logger.debug("Protocol version: %r", line)
1709
1650
            try:
1710
1651
                if int(line.strip().split()[0]) > 1:
1711
 
                    raise RuntimeError(line)
 
1652
                    raise RuntimeError
1712
1653
            except (ValueError, IndexError, RuntimeError) as error:
1713
1654
                logger.error("Unknown protocol version: %s", error)
1714
1655
                return
1763
1704
                        if self.server.use_dbus:
1764
1705
                            # Emit D-Bus signal
1765
1706
                            client.NeedApproval(
1766
 
                                client.approval_delay.total_seconds()
1767
 
                                * 1000, client.approved_by_default)
 
1707
                                client.approval_delay_milliseconds(),
 
1708
                                client.approved_by_default)
1768
1709
                    else:
1769
1710
                        logger.warning("Client %s was not approved",
1770
1711
                                       client.name)
1776
1717
                    #wait until timeout or approved
1777
1718
                    time = datetime.datetime.now()
1778
1719
                    client.changedstate.acquire()
1779
 
                    client.changedstate.wait(delay.total_seconds())
 
1720
                    (client.changedstate.wait
 
1721
                     (float(client.timedelta_to_milliseconds(delay)
 
1722
                            / 1000)))
1780
1723
                    client.changedstate.release()
1781
1724
                    time2 = datetime.datetime.now()
1782
1725
                    if (time2 - time) >= delay:
1798
1741
                    try:
1799
1742
                        sent = session.send(client.secret[sent_size:])
1800
1743
                    except gnutls.errors.GNUTLSError as error:
1801
 
                        logger.warning("gnutls send failed",
1802
 
                                       exc_info=error)
 
1744
                        logger.warning("gnutls send failed")
1803
1745
                        return
1804
1746
                    logger.debug("Sent: %d, remaining: %d",
1805
1747
                                 sent, len(client.secret)
1819
1761
                try:
1820
1762
                    session.bye()
1821
1763
                except gnutls.errors.GNUTLSError as error:
1822
 
                    logger.warning("GnuTLS bye failed",
1823
 
                                   exc_info=error)
 
1764
                    logger.warning("GnuTLS bye failed")
1824
1765
    
1825
1766
    @staticmethod
1826
1767
    def peer_certificate(session):
1898
1839
    def process_request(self, request, address):
1899
1840
        """Start a new process to process the request."""
1900
1841
        proc = multiprocessing.Process(target = self.sub_process_main,
1901
 
                                       args = (request, address))
 
1842
                                       args = (request,
 
1843
                                               address))
1902
1844
        proc.start()
1903
1845
        return proc
1904
1846
 
1919
1861
    
1920
1862
    def add_pipe(self, parent_pipe, proc):
1921
1863
        """Dummy function; override as necessary"""
1922
 
        raise NotImplementedError()
 
1864
        raise NotImplementedError
1923
1865
 
1924
1866
 
1925
1867
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1932
1874
        use_ipv6:       Boolean; to use IPv6 or not
1933
1875
    """
1934
1876
    def __init__(self, server_address, RequestHandlerClass,
1935
 
                 interface=None, use_ipv6=True, socketfd=None):
1936
 
        """If socketfd is set, use that file descriptor instead of
1937
 
        creating a new one with socket.socket().
1938
 
        """
 
1877
                 interface=None, use_ipv6=True):
1939
1878
        self.interface = interface
1940
1879
        if use_ipv6:
1941
1880
            self.address_family = socket.AF_INET6
1942
 
        if socketfd is not None:
1943
 
            # Save the file descriptor
1944
 
            self.socketfd = socketfd
1945
 
            # Save the original socket.socket() function
1946
 
            self.socket_socket = socket.socket
1947
 
            # To implement --socket, we monkey patch socket.socket.
1948
 
            # 
1949
 
            # (When socketserver.TCPServer is a new-style class, we
1950
 
            # could make self.socket into a property instead of monkey
1951
 
            # patching socket.socket.)
1952
 
            # 
1953
 
            # Create a one-time-only replacement for socket.socket()
1954
 
            @functools.wraps(socket.socket)
1955
 
            def socket_wrapper(*args, **kwargs):
1956
 
                # Restore original function so subsequent calls are
1957
 
                # not affected.
1958
 
                socket.socket = self.socket_socket
1959
 
                del self.socket_socket
1960
 
                # This time only, return a new socket object from the
1961
 
                # saved file descriptor.
1962
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
1963
 
            # Replace socket.socket() function with wrapper
1964
 
            socket.socket = socket_wrapper
1965
 
        # The socketserver.TCPServer.__init__ will call
1966
 
        # socket.socket(), which might be our replacement,
1967
 
        # socket_wrapper(), if socketfd was set.
1968
1881
        socketserver.TCPServer.__init__(self, server_address,
1969
1882
                                        RequestHandlerClass)
1970
 
    
1971
1883
    def server_bind(self):
1972
1884
        """This overrides the normal server_bind() function
1973
1885
        to bind to an interface if one was specified, and also NOT to
1981
1893
                try:
1982
1894
                    self.socket.setsockopt(socket.SOL_SOCKET,
1983
1895
                                           SO_BINDTODEVICE,
1984
 
                                           (self.interface + "\0")
1985
 
                                           .encode("utf-8"))
 
1896
                                           str(self.interface
 
1897
                                               + '\0'))
1986
1898
                except socket.error as error:
1987
 
                    if error.errno == errno.EPERM:
1988
 
                        logger.error("No permission to bind to"
1989
 
                                     " interface %s", self.interface)
1990
 
                    elif error.errno == errno.ENOPROTOOPT:
 
1899
                    if error[0] == errno.EPERM:
 
1900
                        logger.error("No permission to"
 
1901
                                     " bind to interface %s",
 
1902
                                     self.interface)
 
1903
                    elif error[0] == errno.ENOPROTOOPT:
1991
1904
                        logger.error("SO_BINDTODEVICE not available;"
1992
1905
                                     " cannot bind to interface %s",
1993
1906
                                     self.interface)
1994
 
                    elif error.errno == errno.ENODEV:
1995
 
                        logger.error("Interface %s does not exist,"
1996
 
                                     " cannot bind", self.interface)
1997
1907
                    else:
1998
1908
                        raise
1999
1909
        # Only bind(2) the socket if we really need to.
2002
1912
                if self.address_family == socket.AF_INET6:
2003
1913
                    any_address = "::" # in6addr_any
2004
1914
                else:
2005
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1915
                    any_address = socket.INADDR_ANY
2006
1916
                self.server_address = (any_address,
2007
1917
                                       self.server_address[1])
2008
1918
            elif not self.server_address[1]:
2029
1939
    """
2030
1940
    def __init__(self, server_address, RequestHandlerClass,
2031
1941
                 interface=None, use_ipv6=True, clients=None,
2032
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
1942
                 gnutls_priority=None, use_dbus=True):
2033
1943
        self.enabled = False
2034
1944
        self.clients = clients
2035
1945
        if self.clients is None:
2039
1949
        IPv6_TCPServer.__init__(self, server_address,
2040
1950
                                RequestHandlerClass,
2041
1951
                                interface = interface,
2042
 
                                use_ipv6 = use_ipv6,
2043
 
                                socketfd = socketfd)
 
1952
                                use_ipv6 = use_ipv6)
2044
1953
    def server_activate(self):
2045
1954
        if self.enabled:
2046
1955
            return socketserver.TCPServer.server_activate(self)
2059
1968
    
2060
1969
    def handle_ipc(self, source, condition, parent_pipe=None,
2061
1970
                   proc = None, client_object=None):
 
1971
        condition_names = {
 
1972
            gobject.IO_IN: "IN",   # There is data to read.
 
1973
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1974
                                    # blocking).
 
1975
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1976
            gobject.IO_ERR: "ERR", # Error condition.
 
1977
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1978
                                    # broken, usually for pipes and
 
1979
                                    # sockets).
 
1980
            }
 
1981
        conditions_string = ' | '.join(name
 
1982
                                       for cond, name in
 
1983
                                       condition_names.iteritems()
 
1984
                                       if cond & condition)
2062
1985
        # error, or the other end of multiprocessing.Pipe has closed
2063
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
1986
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2064
1987
            # Wait for other process to exit
2065
1988
            proc.join()
2066
1989
            return False
2124
2047
        return True
2125
2048
 
2126
2049
 
2127
 
def rfc3339_duration_to_delta(duration):
2128
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2129
 
    
2130
 
    >>> rfc3339_duration_to_delta("P7D")
2131
 
    datetime.timedelta(7)
2132
 
    >>> rfc3339_duration_to_delta("PT60S")
2133
 
    datetime.timedelta(0, 60)
2134
 
    >>> rfc3339_duration_to_delta("PT60M")
2135
 
    datetime.timedelta(0, 3600)
2136
 
    >>> rfc3339_duration_to_delta("PT24H")
2137
 
    datetime.timedelta(1)
2138
 
    >>> rfc3339_duration_to_delta("P1W")
2139
 
    datetime.timedelta(7)
2140
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2141
 
    datetime.timedelta(0, 330)
2142
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2143
 
    datetime.timedelta(1, 200)
2144
 
    """
2145
 
    
2146
 
    # Parsing an RFC 3339 duration with regular expressions is not
2147
 
    # possible - there would have to be multiple places for the same
2148
 
    # values, like seconds.  The current code, while more esoteric, is
2149
 
    # cleaner without depending on a parsing library.  If Python had a
2150
 
    # built-in library for parsing we would use it, but we'd like to
2151
 
    # avoid excessive use of external libraries.
2152
 
    
2153
 
    # New type for defining tokens, syntax, and semantics all-in-one
2154
 
    Token = collections.namedtuple("Token",
2155
 
                                   ("regexp", # To match token; if
2156
 
                                              # "value" is not None,
2157
 
                                              # must have a "group"
2158
 
                                              # containing digits
2159
 
                                    "value",  # datetime.timedelta or
2160
 
                                              # None
2161
 
                                    "followers")) # Tokens valid after
2162
 
                                                  # this token
2163
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2164
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2165
 
    token_end = Token(re.compile(r"$"), None, frozenset())
2166
 
    token_second = Token(re.compile(r"(\d+)S"),
2167
 
                         datetime.timedelta(seconds=1),
2168
 
                         frozenset((token_end,)))
2169
 
    token_minute = Token(re.compile(r"(\d+)M"),
2170
 
                         datetime.timedelta(minutes=1),
2171
 
                         frozenset((token_second, token_end)))
2172
 
    token_hour = Token(re.compile(r"(\d+)H"),
2173
 
                       datetime.timedelta(hours=1),
2174
 
                       frozenset((token_minute, token_end)))
2175
 
    token_time = Token(re.compile(r"T"),
2176
 
                       None,
2177
 
                       frozenset((token_hour, token_minute,
2178
 
                                  token_second)))
2179
 
    token_day = Token(re.compile(r"(\d+)D"),
2180
 
                      datetime.timedelta(days=1),
2181
 
                      frozenset((token_time, token_end)))
2182
 
    token_month = Token(re.compile(r"(\d+)M"),
2183
 
                        datetime.timedelta(weeks=4),
2184
 
                        frozenset((token_day, token_end)))
2185
 
    token_year = Token(re.compile(r"(\d+)Y"),
2186
 
                       datetime.timedelta(weeks=52),
2187
 
                       frozenset((token_month, token_end)))
2188
 
    token_week = Token(re.compile(r"(\d+)W"),
2189
 
                       datetime.timedelta(weeks=1),
2190
 
                       frozenset((token_end,)))
2191
 
    token_duration = Token(re.compile(r"P"), None,
2192
 
                           frozenset((token_year, token_month,
2193
 
                                      token_day, token_time,
2194
 
                                      token_week)))
2195
 
    # Define starting values
2196
 
    value = datetime.timedelta() # Value so far
2197
 
    found_token = None
2198
 
    followers = frozenset((token_duration,)) # Following valid tokens
2199
 
    s = duration                # String left to parse
2200
 
    # Loop until end token is found
2201
 
    while found_token is not token_end:
2202
 
        # Search for any currently valid tokens
2203
 
        for token in followers:
2204
 
            match = token.regexp.match(s)
2205
 
            if match is not None:
2206
 
                # Token found
2207
 
                if token.value is not None:
2208
 
                    # Value found, parse digits
2209
 
                    factor = int(match.group(1), 10)
2210
 
                    # Add to value so far
2211
 
                    value += factor * token.value
2212
 
                # Strip token from string
2213
 
                s = token.regexp.sub("", s, 1)
2214
 
                # Go to found token
2215
 
                found_token = token
2216
 
                # Set valid next tokens
2217
 
                followers = found_token.followers
2218
 
                break
2219
 
        else:
2220
 
            # No currently valid tokens were found
2221
 
            raise ValueError("Invalid RFC 3339 duration")
2222
 
    # End token found
2223
 
    return value
2224
 
 
2225
 
 
2226
2050
def string_to_delta(interval):
2227
2051
    """Parse a string and return a datetime.timedelta
2228
2052
    
2239
2063
    >>> string_to_delta('5m 30s')
2240
2064
    datetime.timedelta(0, 330)
2241
2065
    """
2242
 
    
2243
 
    try:
2244
 
        return rfc3339_duration_to_delta(interval)
2245
 
    except ValueError:
2246
 
        pass
2247
 
    
2248
2066
    timevalue = datetime.timedelta(0)
2249
2067
    for s in interval.split():
2250
2068
        try:
2251
 
            suffix = s[-1]
 
2069
            suffix = unicode(s[-1])
2252
2070
            value = int(s[:-1])
2253
2071
            if suffix == "d":
2254
2072
                delta = datetime.timedelta(value)
2261
2079
            elif suffix == "w":
2262
2080
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2263
2081
            else:
2264
 
                raise ValueError("Unknown suffix {!r}"
2265
 
                                 .format(suffix))
2266
 
        except IndexError as e:
 
2082
                raise ValueError("Unknown suffix %r" % suffix)
 
2083
        except (ValueError, IndexError) as e:
2267
2084
            raise ValueError(*(e.args))
2268
2085
        timevalue += delta
2269
2086
    return timevalue
2284
2101
        # Close all standard open file descriptors
2285
2102
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2286
2103
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2287
 
            raise OSError(errno.ENODEV, "{} not a character device"
2288
 
                          .format(os.devnull))
 
2104
            raise OSError(errno.ENODEV,
 
2105
                          "%s not a character device"
 
2106
                          % os.devnull)
2289
2107
        os.dup2(null, sys.stdin.fileno())
2290
2108
        os.dup2(null, sys.stdout.fileno())
2291
2109
        os.dup2(null, sys.stderr.fileno())
2300
2118
    
2301
2119
    parser = argparse.ArgumentParser()
2302
2120
    parser.add_argument("-v", "--version", action="version",
2303
 
                        version = "%(prog)s {}".format(version),
 
2121
                        version = "%%(prog)s %s" % version,
2304
2122
                        help="show version number and exit")
2305
2123
    parser.add_argument("-i", "--interface", metavar="IF",
2306
2124
                        help="Bind to interface IF")
2312
2130
                        help="Run self-test")
2313
2131
    parser.add_argument("--debug", action="store_true",
2314
2132
                        help="Debug mode; run in foreground and log"
2315
 
                        " to terminal", default=None)
 
2133
                        " to terminal")
2316
2134
    parser.add_argument("--debuglevel", metavar="LEVEL",
2317
2135
                        help="Debug level for stdout output")
2318
2136
    parser.add_argument("--priority", help="GnuTLS"
2325
2143
                        " files")
2326
2144
    parser.add_argument("--no-dbus", action="store_false",
2327
2145
                        dest="use_dbus", help="Do not provide D-Bus"
2328
 
                        " system bus interface", default=None)
 
2146
                        " system bus interface")
2329
2147
    parser.add_argument("--no-ipv6", action="store_false",
2330
 
                        dest="use_ipv6", help="Do not use IPv6",
2331
 
                        default=None)
 
2148
                        dest="use_ipv6", help="Do not use IPv6")
2332
2149
    parser.add_argument("--no-restore", action="store_false",
2333
2150
                        dest="restore", help="Do not restore stored"
2334
 
                        " state", default=None)
2335
 
    parser.add_argument("--socket", type=int,
2336
 
                        help="Specify a file descriptor to a network"
2337
 
                        " socket to use instead of creating one")
 
2151
                        " state")
2338
2152
    parser.add_argument("--statedir", metavar="DIR",
2339
2153
                        help="Directory to save/restore state in")
2340
 
    parser.add_argument("--foreground", action="store_true",
2341
 
                        help="Run in foreground", default=None)
2342
 
    parser.add_argument("--no-zeroconf", action="store_false",
2343
 
                        dest="zeroconf", help="Do not use Zeroconf",
2344
 
                        default=None)
2345
2154
    
2346
2155
    options = parser.parse_args()
2347
2156
    
2348
2157
    if options.check:
2349
2158
        import doctest
2350
 
        fail_count, test_count = doctest.testmod()
2351
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2159
        doctest.testmod()
 
2160
        sys.exit()
2352
2161
    
2353
2162
    # Default values for config file for server-global settings
2354
2163
    server_defaults = { "interface": "",
2356
2165
                        "port": "",
2357
2166
                        "debug": "False",
2358
2167
                        "priority":
2359
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2168
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2360
2169
                        "servicename": "Mandos",
2361
2170
                        "use_dbus": "True",
2362
2171
                        "use_ipv6": "True",
2363
2172
                        "debuglevel": "",
2364
2173
                        "restore": "True",
2365
 
                        "socket": "",
2366
 
                        "statedir": "/var/lib/mandos",
2367
 
                        "foreground": "False",
2368
 
                        "zeroconf": "True",
 
2174
                        "statedir": "/var/lib/mandos"
2369
2175
                        }
2370
2176
    
2371
2177
    # Parse config file for server-global settings
2376
2182
    # Convert the SafeConfigParser object to a dict
2377
2183
    server_settings = server_config.defaults()
2378
2184
    # Use the appropriate methods on the non-string config options
2379
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
2185
    for option in ("debug", "use_dbus", "use_ipv6"):
2380
2186
        server_settings[option] = server_config.getboolean("DEFAULT",
2381
2187
                                                           option)
2382
2188
    if server_settings["port"]:
2383
2189
        server_settings["port"] = server_config.getint("DEFAULT",
2384
2190
                                                       "port")
2385
 
    if server_settings["socket"]:
2386
 
        server_settings["socket"] = server_config.getint("DEFAULT",
2387
 
                                                         "socket")
2388
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
2389
 
        # over with an opened os.devnull.  But we don't want this to
2390
 
        # happen with a supplied network socket.
2391
 
        if 0 <= server_settings["socket"] <= 2:
2392
 
            server_settings["socket"] = os.dup(server_settings
2393
 
                                               ["socket"])
2394
2191
    del server_config
2395
2192
    
2396
2193
    # Override the settings from the config file with command line
2398
2195
    for option in ("interface", "address", "port", "debug",
2399
2196
                   "priority", "servicename", "configdir",
2400
2197
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2401
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
2198
                   "statedir"):
2402
2199
        value = getattr(options, option)
2403
2200
        if value is not None:
2404
2201
            server_settings[option] = value
2405
2202
    del options
2406
2203
    # Force all strings to be unicode
2407
2204
    for option in server_settings.keys():
2408
 
        if isinstance(server_settings[option], bytes):
2409
 
            server_settings[option] = (server_settings[option]
2410
 
                                       .decode("utf-8"))
2411
 
    # Force all boolean options to be boolean
2412
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2413
 
                   "foreground", "zeroconf"):
2414
 
        server_settings[option] = bool(server_settings[option])
2415
 
    # Debug implies foreground
2416
 
    if server_settings["debug"]:
2417
 
        server_settings["foreground"] = True
 
2205
        if type(server_settings[option]) is str:
 
2206
            server_settings[option] = unicode(server_settings[option])
2418
2207
    # Now we have our good server settings in "server_settings"
2419
2208
    
2420
2209
    ##################################################################
2421
2210
    
2422
 
    if (not server_settings["zeroconf"] and
2423
 
        not (server_settings["port"]
2424
 
             or server_settings["socket"] != "")):
2425
 
            parser.error("Needs port or socket to work without"
2426
 
                         " Zeroconf")
2427
 
    
2428
2211
    # For convenience
2429
2212
    debug = server_settings["debug"]
2430
2213
    debuglevel = server_settings["debuglevel"]
2432
2215
    use_ipv6 = server_settings["use_ipv6"]
2433
2216
    stored_state_path = os.path.join(server_settings["statedir"],
2434
2217
                                     stored_state_file)
2435
 
    foreground = server_settings["foreground"]
2436
 
    zeroconf = server_settings["zeroconf"]
2437
2218
    
2438
2219
    if debug:
2439
2220
        initlogger(debug, logging.DEBUG)
2446
2227
    
2447
2228
    if server_settings["servicename"] != "Mandos":
2448
2229
        syslogger.setFormatter(logging.Formatter
2449
 
                               ('Mandos ({}) [%(process)d]:'
2450
 
                                ' %(levelname)s: %(message)s'
2451
 
                                .format(server_settings
2452
 
                                        ["servicename"])))
 
2230
                               ('Mandos (%s) [%%(process)d]:'
 
2231
                                ' %%(levelname)s: %%(message)s'
 
2232
                                % server_settings["servicename"]))
2453
2233
    
2454
2234
    # Parse config file with clients
2455
2235
    client_config = configparser.SafeConfigParser(Client
2460
2240
    global mandos_dbus_service
2461
2241
    mandos_dbus_service = None
2462
2242
    
2463
 
    socketfd = None
2464
 
    if server_settings["socket"] != "":
2465
 
        socketfd = server_settings["socket"]
2466
2243
    tcp_server = MandosServer((server_settings["address"],
2467
2244
                               server_settings["port"]),
2468
2245
                              ClientHandler,
2471
2248
                              use_ipv6=use_ipv6,
2472
2249
                              gnutls_priority=
2473
2250
                              server_settings["priority"],
2474
 
                              use_dbus=use_dbus,
2475
 
                              socketfd=socketfd)
2476
 
    if not foreground:
2477
 
        pidfilename = "/run/mandos.pid"
2478
 
        if not os.path.isdir("/run/."):
2479
 
            pidfilename = "/var/run/mandos.pid"
2480
 
        pidfile = None
 
2251
                              use_dbus=use_dbus)
 
2252
    if not debug:
 
2253
        pidfilename = "/var/run/mandos.pid"
2481
2254
        try:
2482
2255
            pidfile = open(pidfilename, "w")
2483
 
        except IOError as e:
2484
 
            logger.error("Could not open file %r", pidfilename,
2485
 
                         exc_info=e)
 
2256
        except IOError:
 
2257
            logger.error("Could not open file %r", pidfilename)
2486
2258
    
2487
 
    for name in ("_mandos", "mandos", "nobody"):
 
2259
    try:
 
2260
        uid = pwd.getpwnam("_mandos").pw_uid
 
2261
        gid = pwd.getpwnam("_mandos").pw_gid
 
2262
    except KeyError:
2488
2263
        try:
2489
 
            uid = pwd.getpwnam(name).pw_uid
2490
 
            gid = pwd.getpwnam(name).pw_gid
2491
 
            break
 
2264
            uid = pwd.getpwnam("mandos").pw_uid
 
2265
            gid = pwd.getpwnam("mandos").pw_gid
2492
2266
        except KeyError:
2493
 
            continue
2494
 
    else:
2495
 
        uid = 65534
2496
 
        gid = 65534
 
2267
            try:
 
2268
                uid = pwd.getpwnam("nobody").pw_uid
 
2269
                gid = pwd.getpwnam("nobody").pw_gid
 
2270
            except KeyError:
 
2271
                uid = 65534
 
2272
                gid = 65534
2497
2273
    try:
2498
2274
        os.setgid(gid)
2499
2275
        os.setuid(uid)
2500
2276
    except OSError as error:
2501
 
        if error.errno != errno.EPERM:
2502
 
            raise
 
2277
        if error[0] != errno.EPERM:
 
2278
            raise error
2503
2279
    
2504
2280
    if debug:
2505
2281
        # Enable all possible GnuTLS debugging
2522
2298
            os.close(null)
2523
2299
    
2524
2300
    # Need to fork before connecting to D-Bus
2525
 
    if not foreground:
 
2301
    if not debug:
2526
2302
        # Close all input and output, do double fork, etc.
2527
2303
        daemon()
2528
2304
    
2529
 
    # multiprocessing will use threads, so before we use gobject we
2530
 
    # need to inform gobject that threads will be used.
2531
2305
    gobject.threads_init()
2532
2306
    
2533
2307
    global main_loop
2544
2318
                            ("se.bsnet.fukt.Mandos", bus,
2545
2319
                             do_not_queue=True))
2546
2320
        except dbus.exceptions.NameExistsException as e:
2547
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
2321
            logger.error(unicode(e) + ", disabling D-Bus")
2548
2322
            use_dbus = False
2549
2323
            server_settings["use_dbus"] = False
2550
2324
            tcp_server.use_dbus = False
2551
 
    if zeroconf:
2552
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2553
 
        service = AvahiServiceToSyslog(name =
2554
 
                                       server_settings["servicename"],
2555
 
                                       servicetype = "_mandos._tcp",
2556
 
                                       protocol = protocol, bus = bus)
2557
 
        if server_settings["interface"]:
2558
 
            service.interface = (if_nametoindex
2559
 
                                 (server_settings["interface"]
2560
 
                                  .encode("utf-8")))
 
2325
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2326
    service = AvahiServiceToSyslog(name =
 
2327
                                   server_settings["servicename"],
 
2328
                                   servicetype = "_mandos._tcp",
 
2329
                                   protocol = protocol, bus = bus)
 
2330
    if server_settings["interface"]:
 
2331
        service.interface = (if_nametoindex
 
2332
                             (str(server_settings["interface"])))
2561
2333
    
2562
2334
    global multiprocessing_manager
2563
2335
    multiprocessing_manager = multiprocessing.Manager()
2564
2336
    
2565
2337
    client_class = Client
2566
2338
    if use_dbus:
2567
 
        client_class = functools.partial(ClientDBus, bus = bus)
 
2339
        client_class = functools.partial(ClientDBusTransitional,
 
2340
                                         bus = bus)
2568
2341
    
2569
2342
    client_settings = Client.config_parser(client_config)
2570
2343
    old_client_settings = {}
2571
2344
    clients_data = {}
2572
2345
    
2573
 
    # This is used to redirect stdout and stderr for checker processes
2574
 
    global wnull
2575
 
    wnull = open(os.devnull, "w") # A writable /dev/null
2576
 
    # Only used if server is running in foreground but not in debug
2577
 
    # mode
2578
 
    if debug or not foreground:
2579
 
        wnull.close()
2580
 
    
2581
2346
    # Get client data and settings from last running state.
2582
2347
    if server_settings["restore"]:
2583
2348
        try:
2586
2351
                                                     (stored_state))
2587
2352
            os.remove(stored_state_path)
2588
2353
        except IOError as e:
2589
 
            if e.errno == errno.ENOENT:
2590
 
                logger.warning("Could not load persistent state: {}"
2591
 
                                .format(os.strerror(e.errno)))
2592
 
            else:
2593
 
                logger.critical("Could not load persistent state:",
2594
 
                                exc_info=e)
 
2354
            logger.warning("Could not load persistent state: {0}"
 
2355
                           .format(e))
 
2356
            if e.errno != errno.ENOENT:
2595
2357
                raise
2596
2358
        except EOFError as e:
2597
2359
            logger.warning("Could not load persistent state: "
2598
 
                           "EOFError:", exc_info=e)
 
2360
                           "EOFError: {0}".format(e))
2599
2361
    
2600
2362
    with PGPEngine() as pgp:
2601
 
        for client_name, client in clients_data.items():
2602
 
            # Skip removed clients
2603
 
            if client_name not in client_settings:
2604
 
                continue
2605
 
            
 
2363
        for client_name, client in clients_data.iteritems():
2606
2364
            # Decide which value to use after restoring saved state.
2607
2365
            # We have three different values: Old config file,
2608
2366
            # new config file, and saved state.
2629
2387
                if datetime.datetime.utcnow() >= client["expires"]:
2630
2388
                    if not client["last_checked_ok"]:
2631
2389
                        logger.warning(
2632
 
                            "disabling client {} - Client never "
 
2390
                            "disabling client {0} - Client never "
2633
2391
                            "performed a successful checker"
2634
2392
                            .format(client_name))
2635
2393
                        client["enabled"] = False
2636
2394
                    elif client["last_checker_status"] != 0:
2637
2395
                        logger.warning(
2638
 
                            "disabling client {} - Client last"
2639
 
                            " checker failed with error code {}"
 
2396
                            "disabling client {0} - Client "
 
2397
                            "last checker failed with error code {1}"
2640
2398
                            .format(client_name,
2641
2399
                                    client["last_checker_status"]))
2642
2400
                        client["enabled"] = False
2645
2403
                                             .utcnow()
2646
2404
                                             + client["timeout"])
2647
2405
                        logger.debug("Last checker succeeded,"
2648
 
                                     " keeping {} enabled"
 
2406
                                     " keeping {0} enabled"
2649
2407
                                     .format(client_name))
2650
2408
            try:
2651
2409
                client["secret"] = (
2654
2412
                                ["secret"]))
2655
2413
            except PGPError:
2656
2414
                # If decryption fails, we use secret from new settings
2657
 
                logger.debug("Failed to decrypt {} old secret"
 
2415
                logger.debug("Failed to decrypt {0} old secret"
2658
2416
                             .format(client_name))
2659
2417
                client["secret"] = (
2660
2418
                    client_settings[client_name]["secret"])
 
2419
 
2661
2420
    
2662
2421
    # Add/remove clients based on new changes made to config
2663
2422
    for client_name in (set(old_client_settings)
2666
2425
    for client_name in (set(client_settings)
2667
2426
                        - set(old_client_settings)):
2668
2427
        clients_data[client_name] = client_settings[client_name]
2669
 
    
 
2428
 
2670
2429
    # Create all client objects
2671
 
    for client_name, client in clients_data.items():
 
2430
    for client_name, client in clients_data.iteritems():
2672
2431
        tcp_server.clients[client_name] = client_class(
2673
 
            name = client_name, settings = client,
2674
 
            server_settings = server_settings)
 
2432
            name = client_name, settings = client)
2675
2433
    
2676
2434
    if not tcp_server.clients:
2677
2435
        logger.warning("No clients defined")
2678
 
    
2679
 
    if not foreground:
2680
 
        if pidfile is not None:
2681
 
            try:
2682
 
                with pidfile:
2683
 
                    pid = os.getpid()
2684
 
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
2685
 
            except IOError:
2686
 
                logger.error("Could not write to file %r with PID %d",
2687
 
                             pidfilename, pid)
2688
 
        del pidfile
 
2436
        
 
2437
    if not debug:
 
2438
        try:
 
2439
            with pidfile:
 
2440
                pid = os.getpid()
 
2441
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2442
            del pidfile
 
2443
        except IOError:
 
2444
            logger.error("Could not write to file %r with PID %d",
 
2445
                         pidfilename, pid)
 
2446
        except NameError:
 
2447
            # "pidfile" was never created
 
2448
            pass
2689
2449
        del pidfilename
 
2450
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2690
2451
    
2691
2452
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2692
2453
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2693
2454
    
2694
2455
    if use_dbus:
2695
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2696
 
                                        "se.bsnet.fukt.Mandos"})
2697
2456
        class MandosDBusService(DBusObjectWithProperties):
2698
2457
            """A D-Bus proxy object"""
2699
2458
            def __init__(self):
2733
2492
            def GetAllClientsWithProperties(self):
2734
2493
                "D-Bus method"
2735
2494
                return dbus.Dictionary(
2736
 
                    { c.dbus_object_path: c.GetAll("")
2737
 
                      for c in tcp_server.clients.itervalues() },
 
2495
                    ((c.dbus_object_path, c.GetAll(""))
 
2496
                     for c in tcp_server.clients.itervalues()),
2738
2497
                    signature="oa{sv}")
2739
2498
            
2740
2499
            @dbus.service.method(_interface, in_signature="o")
2753
2512
            
2754
2513
            del _interface
2755
2514
        
2756
 
        mandos_dbus_service = MandosDBusService()
 
2515
        class MandosDBusServiceTransitional(MandosDBusService):
 
2516
            __metaclass__ = AlternateDBusNamesMetaclass
 
2517
        mandos_dbus_service = MandosDBusServiceTransitional()
2757
2518
    
2758
2519
    def cleanup():
2759
2520
        "Cleanup function; run on exit"
2760
 
        if zeroconf:
2761
 
            service.cleanup()
 
2521
        service.cleanup()
2762
2522
        
2763
2523
        multiprocessing.active_children()
2764
 
        wnull.close()
2765
2524
        if not (tcp_server.clients or client_settings):
2766
2525
            return
2767
2526
        
2778
2537
                
2779
2538
                # A list of attributes that can not be pickled
2780
2539
                # + secret.
2781
 
                exclude = { "bus", "changedstate", "secret",
2782
 
                            "checker", "server_settings" }
 
2540
                exclude = set(("bus", "changedstate", "secret",
 
2541
                               "checker"))
2783
2542
                for name, typ in (inspect.getmembers
2784
2543
                                  (dbus.service.Object)):
2785
2544
                    exclude.add(name)
2794
2553
                del client_settings[client.name]["secret"]
2795
2554
        
2796
2555
        try:
2797
 
            with (tempfile.NamedTemporaryFile
2798
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2799
 
                   dir=os.path.dirname(stored_state_path),
2800
 
                   delete=False)) as stored_state:
 
2556
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
 
2557
                                                prefix="clients-",
 
2558
                                                dir=os.path.dirname
 
2559
                                                (stored_state_path))
 
2560
            with os.fdopen(tempfd, "wb") as stored_state:
2801
2561
                pickle.dump((clients, client_settings), stored_state)
2802
 
                tempname=stored_state.name
2803
2562
            os.rename(tempname, stored_state_path)
2804
2563
        except (IOError, OSError) as e:
 
2564
            logger.warning("Could not save persistent state: {0}"
 
2565
                           .format(e))
2805
2566
            if not debug:
2806
2567
                try:
2807
2568
                    os.remove(tempname)
2808
2569
                except NameError:
2809
2570
                    pass
2810
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2811
 
                logger.warning("Could not save persistent state: {}"
2812
 
                               .format(os.strerror(e.errno)))
2813
 
            else:
2814
 
                logger.warning("Could not save persistent state:",
2815
 
                               exc_info=e)
2816
 
                raise
 
2571
            if e.errno not in set((errno.ENOENT, errno.EACCES,
 
2572
                                   errno.EEXIST)):
 
2573
                raise e
2817
2574
        
2818
2575
        # Delete all clients, and settings from config
2819
2576
        while tcp_server.clients:
2843
2600
    tcp_server.server_activate()
2844
2601
    
2845
2602
    # Find out what port we got
2846
 
    if zeroconf:
2847
 
        service.port = tcp_server.socket.getsockname()[1]
 
2603
    service.port = tcp_server.socket.getsockname()[1]
2848
2604
    if use_ipv6:
2849
2605
        logger.info("Now listening on address %r, port %d,"
2850
 
                    " flowinfo %d, scope_id %d",
2851
 
                    *tcp_server.socket.getsockname())
 
2606
                    " flowinfo %d, scope_id %d"
 
2607
                    % tcp_server.socket.getsockname())
2852
2608
    else:                       # IPv4
2853
 
        logger.info("Now listening on address %r, port %d",
2854
 
                    *tcp_server.socket.getsockname())
 
2609
        logger.info("Now listening on address %r, port %d"
 
2610
                    % tcp_server.socket.getsockname())
2855
2611
    
2856
2612
    #service.interface = tcp_server.socket.getsockname()[3]
2857
2613
    
2858
2614
    try:
2859
 
        if zeroconf:
2860
 
            # From the Avahi example code
2861
 
            try:
2862
 
                service.activate()
2863
 
            except dbus.exceptions.DBusException as error:
2864
 
                logger.critical("D-Bus Exception", exc_info=error)
2865
 
                cleanup()
2866
 
                sys.exit(1)
2867
 
            # End of Avahi example code
 
2615
        # From the Avahi example code
 
2616
        try:
 
2617
            service.activate()
 
2618
        except dbus.exceptions.DBusException as error:
 
2619
            logger.critical("D-Bus Exception", exc_info=error)
 
2620
            cleanup()
 
2621
            sys.exit(1)
 
2622
        # End of Avahi example code
2868
2623
        
2869
2624
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2870
2625
                             lambda *args, **kwargs: