/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
 
1
#!/usr/bin/python2.7
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2011 Teddy Hogeborn
15
 
# Copyright © 2008-2011 Björn Påhlsson
 
14
# Copyright © 2008-2014 Teddy Hogeborn
 
15
# Copyright © 2008-2014 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
 
37
from future_builtins import *
 
38
 
37
39
import SocketServer as socketserver
38
40
import socket
39
41
import argparse
65
67
import types
66
68
import binascii
67
69
import tempfile
 
70
import itertools
 
71
import collections
68
72
 
69
73
import dbus
70
74
import dbus.service
75
79
import ctypes.util
76
80
import xml.dom.minidom
77
81
import inspect
78
 
import GnuPGInterface
79
82
 
80
83
try:
81
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
88
    except ImportError:
86
89
        SO_BINDTODEVICE = None
87
90
 
 
91
if sys.version_info.major == 2:
 
92
    str = unicode
88
93
 
89
 
version = "1.4.1"
 
94
version = "1.6.9"
90
95
stored_state_file = "clients.pickle"
91
96
 
92
97
logger = logging.getLogger()
93
 
syslogger = (logging.handlers.SysLogHandler
94
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
 
              address = str("/dev/log")))
 
98
syslogger = None
96
99
 
97
100
try:
98
101
    if_nametoindex = (ctypes.cdll.LoadLibrary
104
107
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
105
108
        with contextlib.closing(socket.socket()) as s:
106
109
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
 
                                struct.pack(str("16s16x"),
108
 
                                            interface))
109
 
        interface_index = struct.unpack(str("I"),
110
 
                                        ifreq[16:20])[0]
 
110
                                struct.pack(b"16s16x", interface))
 
111
        interface_index = struct.unpack("I", ifreq[16:20])[0]
111
112
        return interface_index
112
113
 
113
114
 
114
 
def initlogger(level=logging.WARNING):
 
115
def initlogger(debug, level=logging.WARNING):
115
116
    """init logger and add loglevel"""
116
117
    
 
118
    global syslogger
 
119
    syslogger = (logging.handlers.SysLogHandler
 
120
                 (facility =
 
121
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
122
                  address = "/dev/log"))
117
123
    syslogger.setFormatter(logging.Formatter
118
124
                           ('Mandos [%(process)d]: %(levelname)s:'
119
125
                            ' %(message)s'))
120
126
    logger.addHandler(syslogger)
121
127
    
122
 
    console = logging.StreamHandler()
123
 
    console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
124
 
                                           ' [%(process)d]:'
125
 
                                           ' %(levelname)s:'
126
 
                                           ' %(message)s'))
127
 
    logger.addHandler(console)
 
128
    if debug:
 
129
        console = logging.StreamHandler()
 
130
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
131
                                               ' [%(process)d]:'
 
132
                                               ' %(levelname)s:'
 
133
                                               ' %(message)s'))
 
134
        logger.addHandler(console)
128
135
    logger.setLevel(level)
129
136
 
130
137
 
131
 
class CryptoError(Exception):
 
138
class PGPError(Exception):
 
139
    """Exception if encryption/decryption fails"""
132
140
    pass
133
141
 
134
142
 
135
 
class Crypto(object):
 
143
class PGPEngine(object):
136
144
    """A simple class for OpenPGP symmetric encryption & decryption"""
137
145
    def __init__(self):
138
 
        self.gnupg = GnuPGInterface.GnuPG()
139
146
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
140
 
        self.gnupg = GnuPGInterface.GnuPG()
141
 
        self.gnupg.options.meta_interactive = False
142
 
        self.gnupg.options.homedir = self.tempdir
143
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
144
 
                                              '--quiet'])
 
147
        self.gnupgargs = ['--batch',
 
148
                          '--home', self.tempdir,
 
149
                          '--force-mdc',
 
150
                          '--quiet',
 
151
                          '--no-use-agent']
145
152
    
146
153
    def __enter__(self):
147
154
        return self
148
155
    
149
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
156
    def __exit__(self, exc_type, exc_value, traceback):
150
157
        self._cleanup()
151
158
        return False
152
159
    
169
176
    def password_encode(self, password):
170
177
        # Passphrase can not be empty and can not contain newlines or
171
178
        # NUL bytes.  So we prefix it and hex encode it.
172
 
        return b"mandos" + binascii.hexlify(password)
 
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
173
186
    
174
187
    def encrypt(self, data, password):
175
 
        self.gnupg.passphrase = self.password_encode(password)
176
 
        with open(os.devnull) as devnull:
177
 
            try:
178
 
                proc = self.gnupg.run(['--symmetric'],
179
 
                                      create_fhs=['stdin', 'stdout'],
180
 
                                      attach_fhs={'stderr': devnull})
181
 
                with contextlib.closing(proc.handles['stdin']) as f:
182
 
                    f.write(data)
183
 
                with contextlib.closing(proc.handles['stdout']) as f:
184
 
                    ciphertext = f.read()
185
 
                proc.wait()
186
 
            except IOError as e:
187
 
                raise CryptoError(e)
188
 
        self.gnupg.passphrase = None
 
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)
189
203
        return ciphertext
190
204
    
191
205
    def decrypt(self, data, password):
192
 
        self.gnupg.passphrase = self.password_encode(password)
193
 
        with open(os.devnull) as devnull:
194
 
            try:
195
 
                proc = self.gnupg.run(['--decrypt'],
196
 
                                      create_fhs=['stdin', 'stdout'],
197
 
                                      attach_fhs={'stderr': devnull})
198
 
                with contextlib.closing(proc.handles['stdin'] ) as f:
199
 
                    f.write(data)
200
 
                with contextlib.closing(proc.handles['stdout']) as f:
201
 
                    decrypted_plaintext = f.read()
202
 
                proc.wait()
203
 
            except IOError as e:
204
 
                raise CryptoError(e)
205
 
        self.gnupg.passphrase = None
 
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)
206
222
        return decrypted_plaintext
207
223
 
208
224
 
209
 
 
210
225
class AvahiError(Exception):
211
226
    def __init__(self, value, *args, **kwargs):
212
227
        self.value = value
213
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
214
 
    def __unicode__(self):
215
 
        return unicode(repr(self.value))
 
228
        return super(AvahiError, self).__init__(value, *args,
 
229
                                                **kwargs)
216
230
 
217
231
class AvahiServiceError(AvahiError):
218
232
    pass
229
243
               Used to optionally bind to the specified interface.
230
244
    name: string; Example: 'Mandos'
231
245
    type: string; Example: '_mandos._tcp'.
232
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
246
     See <https://www.iana.org/assignments/service-names-port-numbers>
233
247
    port: integer; what port to announce
234
248
    TXT: list of strings; TXT record for the service
235
249
    domain: string; Domain to publish on, default to .local if empty.
241
255
    server: D-Bus Server
242
256
    bus: dbus.SystemBus()
243
257
    """
 
258
    
244
259
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
245
260
                 servicetype = None, port = None, TXT = None,
246
261
                 domain = "", host = "", max_renames = 32768,
259
274
        self.server = None
260
275
        self.bus = bus
261
276
        self.entry_group_state_changed_match = None
262
 
    def rename(self):
 
277
    
 
278
    def rename(self, remove=True):
263
279
        """Derived from the Avahi example code"""
264
280
        if self.rename_count >= self.max_renames:
265
281
            logger.critical("No suitable Zeroconf service name found"
266
282
                            " after %i retries, exiting.",
267
283
                            self.rename_count)
268
284
            raise AvahiServiceError("Too many renames")
269
 
        self.name = unicode(self.server
270
 
                            .GetAlternativeServiceName(self.name))
 
285
        self.name = str(self.server
 
286
                        .GetAlternativeServiceName(self.name))
 
287
        self.rename_count += 1
271
288
        logger.info("Changing Zeroconf service name to %r ...",
272
289
                    self.name)
273
 
        self.remove()
 
290
        if remove:
 
291
            self.remove()
274
292
        try:
275
293
            self.add()
276
294
        except dbus.exceptions.DBusException as error:
277
 
            logger.critical("DBusException: %s", error)
278
 
            self.cleanup()
279
 
            os._exit(1)
280
 
        self.rename_count += 1
 
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
    
281
304
    def remove(self):
282
305
        """Derived from the Avahi example code"""
283
306
        if self.entry_group_state_changed_match is not None:
285
308
            self.entry_group_state_changed_match = None
286
309
        if self.group is not None:
287
310
            self.group.Reset()
 
311
    
288
312
    def add(self):
289
313
        """Derived from the Avahi example code"""
290
314
        self.remove()
307
331
            dbus.UInt16(self.port),
308
332
            avahi.string_array_to_txt_array(self.TXT))
309
333
        self.group.Commit()
 
334
    
310
335
    def entry_group_state_changed(self, state, error):
311
336
        """Derived from the Avahi example code"""
312
337
        logger.debug("Avahi entry group state change: %i", state)
318
343
            self.rename()
319
344
        elif state == avahi.ENTRY_GROUP_FAILURE:
320
345
            logger.critical("Avahi: Error in group state changed %s",
321
 
                            unicode(error))
322
 
            raise AvahiGroupError("State changed: %s"
323
 
                                  % unicode(error))
 
346
                            str(error))
 
347
            raise AvahiGroupError("State changed: {!s}"
 
348
                                  .format(error))
 
349
    
324
350
    def cleanup(self):
325
351
        """Derived from the Avahi example code"""
326
352
        if self.group is not None:
331
357
                pass
332
358
            self.group = None
333
359
        self.remove()
 
360
    
334
361
    def server_state_changed(self, state, error=None):
335
362
        """Derived from the Avahi example code"""
336
363
        logger.debug("Avahi server state change: %i", state)
355
382
                logger.debug("Unknown state: %r", state)
356
383
            else:
357
384
                logger.debug("Unknown state: %r: %r", state, error)
 
385
    
358
386
    def activate(self):
359
387
        """Derived from the Avahi example code"""
360
388
        if self.server is None:
367
395
                                 self.server_state_changed)
368
396
        self.server_state_changed(self.server.GetState())
369
397
 
 
398
 
370
399
class AvahiServiceToSyslog(AvahiService):
371
 
    def rename(self):
 
400
    def rename(self, *args, **kwargs):
372
401
        """Add the new name to the syslog messages"""
373
 
        ret = AvahiService.rename(self)
 
402
        ret = AvahiService.rename(self, *args, **kwargs)
374
403
        syslogger.setFormatter(logging.Formatter
375
 
                               ('Mandos (%s) [%%(process)d]:'
376
 
                                ' %%(levelname)s: %%(message)s'
377
 
                                % self.name))
 
404
                               ('Mandos ({}) [%(process)d]:'
 
405
                                ' %(levelname)s: %(message)s'
 
406
                                .format(self.name)))
378
407
        return ret
379
408
 
380
 
def _timedelta_to_milliseconds(td):
381
 
    "Convert a datetime.timedelta() to milliseconds"
382
 
    return ((td.days * 24 * 60 * 60 * 1000)
383
 
            + (td.seconds * 1000)
384
 
            + (td.microseconds // 1000))
385
 
        
 
409
 
386
410
class Client(object):
387
411
    """A representation of a client host served by this server.
388
412
    
389
413
    Attributes:
390
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
414
    approved:   bool(); 'None' if not yet approved/disapproved
391
415
    approval_delay: datetime.timedelta(); Time to wait for approval
392
416
    approval_duration: datetime.timedelta(); Duration of one approval
393
417
    checker:    subprocess.Popen(); a running checker process used
411
435
    interval:   datetime.timedelta(); How often to start a new checker
412
436
    last_approval_request: datetime.datetime(); (UTC) or None
413
437
    last_checked_ok: datetime.datetime(); (UTC) or None
414
 
 
415
438
    last_checker_status: integer between 0 and 255 reflecting exit
416
439
                         status of last checker. -1 reflects crashed
417
 
                         checker, or None.
 
440
                         checker, -2 means no checker completed yet.
418
441
    last_enabled: datetime.datetime(); (UTC) or None
419
442
    name:       string; from the config file, used in log messages and
420
443
                        D-Bus identifiers
421
444
    secret:     bytestring; sent verbatim (over TLS) to client
422
445
    timeout:    datetime.timedelta(); How long from last_checked_ok
423
446
                                      until this client is disabled
424
 
    extended_timeout:   extra long timeout when password has been sent
 
447
    extended_timeout:   extra long timeout when secret has been sent
425
448
    runtime_expansions: Allowed attributes for runtime expansion.
426
449
    expires:    datetime.datetime(); time (UTC) when a client will be
427
450
                disabled, or None
 
451
    server_settings: The server_settings dict from main()
428
452
    """
429
453
    
430
454
    runtime_expansions = ("approval_delay", "approval_duration",
431
 
                          "created", "enabled", "fingerprint",
432
 
                          "host", "interval", "last_checked_ok",
 
455
                          "created", "enabled", "expires",
 
456
                          "fingerprint", "host", "interval",
 
457
                          "last_approval_request", "last_checked_ok",
433
458
                          "last_enabled", "name", "timeout")
434
 
    
435
 
    def timeout_milliseconds(self):
436
 
        "Return the 'timeout' attribute in milliseconds"
437
 
        return _timedelta_to_milliseconds(self.timeout)
438
 
    
439
 
    def extended_timeout_milliseconds(self):
440
 
        "Return the 'extended_timeout' attribute in milliseconds"
441
 
        return _timedelta_to_milliseconds(self.extended_timeout)
442
 
    
443
 
    def interval_milliseconds(self):
444
 
        "Return the 'interval' attribute in milliseconds"
445
 
        return _timedelta_to_milliseconds(self.interval)
446
 
    
447
 
    def approval_delay_milliseconds(self):
448
 
        return _timedelta_to_milliseconds(self.approval_delay)
449
 
    
450
 
    def __init__(self, name = None, config=None):
451
 
        """Note: the 'checker' key in 'config' sets the
452
 
        'checker_command' attribute and *not* the 'checker'
453
 
        attribute."""
 
459
    client_defaults = { "timeout": "PT5M",
 
460
                        "extended_timeout": "PT15M",
 
461
                        "interval": "PT2M",
 
462
                        "checker": "fping -q -- %%(host)s",
 
463
                        "host": "",
 
464
                        "approval_delay": "PT0S",
 
465
                        "approval_duration": "PT1S",
 
466
                        "approved_by_default": "True",
 
467
                        "enabled": "True",
 
468
                        }
 
469
    
 
470
    @staticmethod
 
471
    def config_parser(config):
 
472
        """Construct a new dict of client settings of this form:
 
473
        { client_name: {setting_name: value, ...}, ...}
 
474
        with exceptions for any special settings as defined above.
 
475
        NOTE: Must be a pure function. Must return the same result
 
476
        value given the same arguments.
 
477
        """
 
478
        settings = {}
 
479
        for client_name in config.sections():
 
480
            section = dict(config.items(client_name))
 
481
            client = settings[client_name] = {}
 
482
            
 
483
            client["host"] = section["host"]
 
484
            # Reformat values from string types to Python types
 
485
            client["approved_by_default"] = config.getboolean(
 
486
                client_name, "approved_by_default")
 
487
            client["enabled"] = config.getboolean(client_name,
 
488
                                                  "enabled")
 
489
            
 
490
            client["fingerprint"] = (section["fingerprint"].upper()
 
491
                                     .replace(" ", ""))
 
492
            if "secret" in section:
 
493
                client["secret"] = section["secret"].decode("base64")
 
494
            elif "secfile" in section:
 
495
                with open(os.path.expanduser(os.path.expandvars
 
496
                                             (section["secfile"])),
 
497
                          "rb") as secfile:
 
498
                    client["secret"] = secfile.read()
 
499
            else:
 
500
                raise TypeError("No secret or secfile for section {}"
 
501
                                .format(section))
 
502
            client["timeout"] = string_to_delta(section["timeout"])
 
503
            client["extended_timeout"] = string_to_delta(
 
504
                section["extended_timeout"])
 
505
            client["interval"] = string_to_delta(section["interval"])
 
506
            client["approval_delay"] = string_to_delta(
 
507
                section["approval_delay"])
 
508
            client["approval_duration"] = string_to_delta(
 
509
                section["approval_duration"])
 
510
            client["checker_command"] = section["checker"]
 
511
            client["last_approval_request"] = None
 
512
            client["last_checked_ok"] = None
 
513
            client["last_checker_status"] = -2
 
514
        
 
515
        return settings
 
516
    
 
517
    def __init__(self, settings, name = None, server_settings=None):
454
518
        self.name = name
455
 
        if config is None:
456
 
            config = {}
 
519
        if server_settings is None:
 
520
            server_settings = {}
 
521
        self.server_settings = server_settings
 
522
        # adding all client settings
 
523
        for setting, value in settings.items():
 
524
            setattr(self, setting, value)
 
525
        
 
526
        if self.enabled:
 
527
            if not hasattr(self, "last_enabled"):
 
528
                self.last_enabled = datetime.datetime.utcnow()
 
529
            if not hasattr(self, "expires"):
 
530
                self.expires = (datetime.datetime.utcnow()
 
531
                                + self.timeout)
 
532
        else:
 
533
            self.last_enabled = None
 
534
            self.expires = None
 
535
        
457
536
        logger.debug("Creating client %r", self.name)
458
537
        # Uppercase and remove spaces from fingerprint for later
459
538
        # comparison purposes with return value from the fingerprint()
460
539
        # function
461
 
        self.fingerprint = (config["fingerprint"].upper()
462
 
                            .replace(" ", ""))
463
540
        logger.debug("  Fingerprint: %s", self.fingerprint)
464
 
        if "secret" in config:
465
 
            self.secret = config["secret"].decode("base64")
466
 
        elif "secfile" in config:
467
 
            with open(os.path.expanduser(os.path.expandvars
468
 
                                         (config["secfile"])),
469
 
                      "rb") as secfile:
470
 
                self.secret = secfile.read()
471
 
        else:
472
 
            raise TypeError("No secret or secfile for client %s"
473
 
                            % self.name)
474
 
        self.host = config.get("host", "")
475
 
        self.created = datetime.datetime.utcnow()
476
 
        self.enabled = config.get("enabled", True)
477
 
        self.last_approval_request = None
478
 
        if self.enabled:
479
 
            self.last_enabled = datetime.datetime.utcnow()
480
 
        else:
481
 
            self.last_enabled = None
482
 
        self.last_checked_ok = None
483
 
        self.last_checker_status = None
484
 
        self.timeout = string_to_delta(config["timeout"])
485
 
        self.extended_timeout = string_to_delta(config
486
 
                                                ["extended_timeout"])
487
 
        self.interval = string_to_delta(config["interval"])
 
541
        self.created = settings.get("created",
 
542
                                    datetime.datetime.utcnow())
 
543
        
 
544
        # attributes specific for this server instance
488
545
        self.checker = None
489
546
        self.checker_initiator_tag = None
490
547
        self.disable_initiator_tag = None
491
 
        if self.enabled:
492
 
            self.expires = datetime.datetime.utcnow() + self.timeout
493
 
        else:
494
 
            self.expires = None
495
548
        self.checker_callback_tag = None
496
 
        self.checker_command = config["checker"]
497
549
        self.current_checker_command = None
498
 
        self._approved = None
499
 
        self.approved_by_default = config.get("approved_by_default",
500
 
                                              True)
 
550
        self.approved = None
501
551
        self.approvals_pending = 0
502
 
        self.approval_delay = string_to_delta(
503
 
            config["approval_delay"])
504
 
        self.approval_duration = string_to_delta(
505
 
            config["approval_duration"])
506
552
        self.changedstate = (multiprocessing_manager
507
553
                             .Condition(multiprocessing_manager
508
554
                                        .Lock()))
528
574
        if getattr(self, "enabled", False):
529
575
            # Already enabled
530
576
            return
531
 
        self.send_changedstate()
532
577
        self.expires = datetime.datetime.utcnow() + self.timeout
533
578
        self.enabled = True
534
579
        self.last_enabled = datetime.datetime.utcnow()
535
580
        self.init_checker()
 
581
        self.send_changedstate()
536
582
    
537
583
    def disable(self, quiet=True):
538
584
        """Disable this client."""
539
585
        if not getattr(self, "enabled", False):
540
586
            return False
541
587
        if not quiet:
542
 
            self.send_changedstate()
543
 
        if not quiet:
544
588
            logger.info("Disabling client %s", self.name)
545
 
        if getattr(self, "disable_initiator_tag", False):
 
589
        if getattr(self, "disable_initiator_tag", None) is not None:
546
590
            gobject.source_remove(self.disable_initiator_tag)
547
591
            self.disable_initiator_tag = None
548
592
        self.expires = None
549
 
        if getattr(self, "checker_initiator_tag", False):
 
593
        if getattr(self, "checker_initiator_tag", None) is not None:
550
594
            gobject.source_remove(self.checker_initiator_tag)
551
595
            self.checker_initiator_tag = None
552
596
        self.stop_checker()
553
597
        self.enabled = False
 
598
        if not quiet:
 
599
            self.send_changedstate()
554
600
        # Do not run this again if called by a gobject.timeout_add
555
601
        return False
556
602
    
560
606
    def init_checker(self):
561
607
        # Schedule a new checker to be started an 'interval' from now,
562
608
        # and every interval from then on.
 
609
        if self.checker_initiator_tag is not None:
 
610
            gobject.source_remove(self.checker_initiator_tag)
563
611
        self.checker_initiator_tag = (gobject.timeout_add
564
 
                                      (self.interval_milliseconds(),
 
612
                                      (int(self.interval
 
613
                                           .total_seconds() * 1000),
565
614
                                       self.start_checker))
566
615
        # Schedule a disable() when 'timeout' has passed
 
616
        if self.disable_initiator_tag is not None:
 
617
            gobject.source_remove(self.disable_initiator_tag)
567
618
        self.disable_initiator_tag = (gobject.timeout_add
568
 
                                   (self.timeout_milliseconds(),
569
 
                                    self.disable))
 
619
                                      (int(self.timeout
 
620
                                           .total_seconds() * 1000),
 
621
                                       self.disable))
570
622
        # Also start a new checker *right now*.
571
623
        self.start_checker()
572
624
    
575
627
        self.checker_callback_tag = None
576
628
        self.checker = None
577
629
        if os.WIFEXITED(condition):
578
 
            self.last_checker_status =  os.WEXITSTATUS(condition)
 
630
            self.last_checker_status = os.WEXITSTATUS(condition)
579
631
            if self.last_checker_status == 0:
580
632
                logger.info("Checker for %(name)s succeeded",
581
633
                            vars(self))
588
640
            logger.warning("Checker for %(name)s crashed?",
589
641
                           vars(self))
590
642
    
591
 
    def checked_ok(self, timeout=None):
592
 
        """Bump up the timeout for this client.
593
 
        
594
 
        This should only be called when the client has been seen,
595
 
        alive and well.
596
 
        """
 
643
    def checked_ok(self):
 
644
        """Assert that the client has been seen, alive and well."""
 
645
        self.last_checked_ok = datetime.datetime.utcnow()
 
646
        self.last_checker_status = 0
 
647
        self.bump_timeout()
 
648
    
 
649
    def bump_timeout(self, timeout=None):
 
650
        """Bump up the timeout for this client."""
597
651
        if timeout is None:
598
652
            timeout = self.timeout
599
 
        self.last_checked_ok = datetime.datetime.utcnow()
600
653
        if self.disable_initiator_tag is not None:
601
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
            self.disable_initiator_tag = None
602
656
        if getattr(self, "enabled", False):
603
657
            self.disable_initiator_tag = (gobject.timeout_add
604
 
                                          (_timedelta_to_milliseconds
605
 
                                           (timeout), self.disable))
 
658
                                          (int(timeout.total_seconds()
 
659
                                               * 1000), self.disable))
606
660
            self.expires = datetime.datetime.utcnow() + timeout
607
661
    
608
662
    def need_approval(self):
614
668
        If a checker already exists, leave it running and do
615
669
        nothing."""
616
670
        # The reason for not killing a running checker is that if we
617
 
        # did that, then if a checker (for some reason) started
618
 
        # running slowly and taking more than 'interval' time, the
619
 
        # client would inevitably timeout, since no checker would get
620
 
        # a chance to run to completion.  If we instead leave running
 
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
621
675
        # checkers alone, the checker would have to take more time
622
676
        # than 'timeout' for the client to be disabled, which is as it
623
677
        # should be.
625
679
        # If a checker exists, make sure it is not a zombie
626
680
        try:
627
681
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
628
 
        except (AttributeError, OSError) as error:
629
 
            if (isinstance(error, OSError)
630
 
                and error.errno != errno.ECHILD):
631
 
                raise error
 
682
        except AttributeError:
 
683
            pass
 
684
        except OSError as error:
 
685
            if error.errno != errno.ECHILD:
 
686
                raise
632
687
        else:
633
688
            if pid:
634
689
                logger.warning("Checker was a zombie")
637
692
                                      self.current_checker_command)
638
693
        # Start a new checker if needed
639
694
        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 }
640
699
            try:
641
 
                # In case checker_command has exactly one % operator
642
 
                command = self.checker_command % self.host
643
 
            except TypeError:
644
 
                # Escape attributes for the shell
645
 
                escaped_attrs = dict(
646
 
                    (attr,
647
 
                     re.escape(unicode(str(getattr(self, attr, "")),
648
 
                                       errors=
649
 
                                       'replace')))
650
 
                    for attr in
651
 
                    self.runtime_expansions)
652
 
                
653
 
                try:
654
 
                    command = self.checker_command % escaped_attrs
655
 
                except TypeError as error:
656
 
                    logger.error('Could not format string "%s":'
657
 
                                 ' %s', self.checker_command, error)
658
 
                    return True # Try again later
 
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
659
705
            self.current_checker_command = command
660
706
            try:
661
707
                logger.info("Starting checker %r for %s",
664
710
                # in normal mode, that is already done by daemon(),
665
711
                # and in debug mode we don't want to.  (Stdin is
666
712
                # 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 })
667
721
                self.checker = subprocess.Popen(command,
668
722
                                                close_fds=True,
669
 
                                                shell=True, cwd="/")
670
 
                self.checker_callback_tag = (gobject.child_watch_add
671
 
                                             (self.checker.pid,
672
 
                                              self.checker_callback,
673
 
                                              data=command))
674
 
                # The checker may have completed before the gobject
675
 
                # watch was added.  Check for this.
 
723
                                                shell=True, cwd="/",
 
724
                                                **popen_args)
 
725
            except OSError as error:
 
726
                logger.error("Failed to start subprocess",
 
727
                             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:
676
736
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
677
 
                if pid:
678
 
                    gobject.source_remove(self.checker_callback_tag)
679
 
                    self.checker_callback(pid, status, command)
680
737
            except OSError as error:
681
 
                logger.error("Failed to start subprocess: %s",
682
 
                             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)
683
747
        # Re-run this periodically if run by gobject.timeout_add
684
748
        return True
685
749
    
692
756
            return
693
757
        logger.debug("Stopping checker for %(name)s", vars(self))
694
758
        try:
695
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
759
            self.checker.terminate()
696
760
            #time.sleep(0.5)
697
761
            #if self.checker.poll() is None:
698
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
762
            #    self.checker.kill()
699
763
        except OSError as error:
700
764
            if error.errno != errno.ESRCH: # No such process
701
765
                raise
718
782
    # "Set" method, so we fail early here:
719
783
    if byte_arrays and signature != "ay":
720
784
        raise ValueError("Byte arrays not supported for non-'ay'"
721
 
                         " signature %r" % signature)
 
785
                         " signature {!r}".format(signature))
722
786
    def decorator(func):
723
787
        func._dbus_is_property = True
724
788
        func._dbus_interface = dbus_interface
732
796
    return decorator
733
797
 
734
798
 
 
799
def dbus_interface_annotations(dbus_interface):
 
800
    """Decorator for marking functions returning interface annotations
 
801
    
 
802
    Usage:
 
803
    
 
804
    @dbus_interface_annotations("org.example.Interface")
 
805
    def _foo(self):  # Function name does not matter
 
806
        return {"org.freedesktop.DBus.Deprecated": "true",
 
807
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
808
                    "false"}
 
809
    """
 
810
    def decorator(func):
 
811
        func._dbus_is_interface = True
 
812
        func._dbus_interface = dbus_interface
 
813
        func._dbus_name = dbus_interface
 
814
        return func
 
815
    return decorator
 
816
 
 
817
 
 
818
def dbus_annotations(annotations):
 
819
    """Decorator to annotate D-Bus methods, signals or properties
 
820
    Usage:
 
821
    
 
822
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
823
                       "org.freedesktop.DBus.Property."
 
824
                       "EmitsChangedSignal": "false"})
 
825
    @dbus_service_property("org.example.Interface", signature="b",
 
826
                           access="r")
 
827
    def Property_dbus_property(self):
 
828
        return dbus.Boolean(False)
 
829
    """
 
830
    def decorator(func):
 
831
        func._dbus_annotations = annotations
 
832
        return func
 
833
    return decorator
 
834
 
 
835
 
735
836
class DBusPropertyException(dbus.exceptions.DBusException):
736
837
    """A base class for D-Bus property-related exceptions
737
838
    """
738
 
    def __unicode__(self):
739
 
        return unicode(str(self))
740
 
 
 
839
    pass
741
840
 
742
841
class DBusPropertyAccessException(DBusPropertyException):
743
842
    """A property's access permissions disallows an operation.
760
859
    """
761
860
    
762
861
    @staticmethod
763
 
    def _is_dbus_property(obj):
764
 
        return getattr(obj, "_dbus_is_property", False)
 
862
    def _is_dbus_thing(thing):
 
863
        """Returns a function testing if an attribute is a D-Bus thing
 
864
        
 
865
        If called like _is_dbus_thing("method") it returns a function
 
866
        suitable for use as predicate to inspect.getmembers().
 
867
        """
 
868
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
869
                                   False)
765
870
    
766
 
    def _get_all_dbus_properties(self):
 
871
    def _get_all_dbus_things(self, thing):
767
872
        """Returns a generator of (name, attribute) pairs
768
873
        """
769
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
874
        return ((getattr(athing.__get__(self), "_dbus_name",
 
875
                         name),
 
876
                 athing.__get__(self))
770
877
                for cls in self.__class__.__mro__
771
 
                for name, prop in
772
 
                inspect.getmembers(cls, self._is_dbus_property))
 
878
                for name, athing in
 
879
                inspect.getmembers(cls,
 
880
                                   self._is_dbus_thing(thing)))
773
881
    
774
882
    def _get_dbus_property(self, interface_name, property_name):
775
883
        """Returns a bound method if one exists which is a D-Bus
777
885
        """
778
886
        for cls in  self.__class__.__mro__:
779
887
            for name, value in (inspect.getmembers
780
 
                                (cls, self._is_dbus_property)):
 
888
                                (cls,
 
889
                                 self._is_dbus_thing("property"))):
781
890
                if (value._dbus_name == property_name
782
891
                    and value._dbus_interface == interface_name):
783
892
                    return value.__get__(self)
811
920
            # The byte_arrays option is not supported yet on
812
921
            # signatures other than "ay".
813
922
            if prop._dbus_signature != "ay":
814
 
                raise ValueError
815
 
            value = dbus.ByteArray(''.join(unichr(byte)
816
 
                                           for byte in value))
 
923
                raise ValueError("Byte arrays not supported for non-"
 
924
                                 "'ay' signature {!r}"
 
925
                                 .format(prop._dbus_signature))
 
926
            value = dbus.ByteArray(b''.join(chr(byte)
 
927
                                            for byte in value))
817
928
        prop(value)
818
929
    
819
930
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
825
936
        Note: Will not include properties with access="write".
826
937
        """
827
938
        properties = {}
828
 
        for name, prop in self._get_all_dbus_properties():
 
939
        for name, prop in self._get_all_dbus_things("property"):
829
940
            if (interface_name
830
941
                and interface_name != prop._dbus_interface):
831
942
                # Interface non-empty but did not match
841
952
                                           value.variant_level+1)
842
953
        return dbus.Dictionary(properties, signature="sv")
843
954
    
 
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
    
844
963
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
845
964
                         out_signature="s",
846
965
                         path_keyword='object_path',
847
966
                         connection_keyword='connection')
848
967
    def Introspect(self, object_path, connection):
849
 
        """Standard D-Bus method, overloaded to insert property tags.
 
968
        """Overloading of standard D-Bus method.
 
969
        
 
970
        Inserts property tags and interface annotation tags.
850
971
        """
851
972
        xmlstring = dbus.service.Object.Introspect(self, object_path,
852
973
                                                   connection)
859
980
                e.setAttribute("access", prop._dbus_access)
860
981
                return e
861
982
            for if_tag in document.getElementsByTagName("interface"):
 
983
                # Add property tags
862
984
                for tag in (make_tag(document, name, prop)
863
985
                            for name, prop
864
 
                            in self._get_all_dbus_properties()
 
986
                            in self._get_all_dbus_things("property")
865
987
                            if prop._dbus_interface
866
988
                            == if_tag.getAttribute("name")):
867
989
                    if_tag.appendChild(tag)
 
990
                # Add annotation tags
 
991
                for typ in ("method", "signal", "property"):
 
992
                    for tag in if_tag.getElementsByTagName(typ):
 
993
                        annots = dict()
 
994
                        for name, prop in (self.
 
995
                                           _get_all_dbus_things(typ)):
 
996
                            if (name == tag.getAttribute("name")
 
997
                                and prop._dbus_interface
 
998
                                == if_tag.getAttribute("name")):
 
999
                                annots.update(getattr
 
1000
                                              (prop,
 
1001
                                               "_dbus_annotations",
 
1002
                                               {}))
 
1003
                        for name, value in annots.items():
 
1004
                            ann_tag = document.createElement(
 
1005
                                "annotation")
 
1006
                            ann_tag.setAttribute("name", name)
 
1007
                            ann_tag.setAttribute("value", value)
 
1008
                            tag.appendChild(ann_tag)
 
1009
                # Add interface annotation tags
 
1010
                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():
 
1017
                    ann_tag = document.createElement("annotation")
 
1018
                    ann_tag.setAttribute("name", annotation)
 
1019
                    ann_tag.setAttribute("value", value)
 
1020
                    if_tag.appendChild(ann_tag)
868
1021
                # Add the names to the return values for the
869
1022
                # "org.freedesktop.DBus.Properties" methods
870
1023
                if (if_tag.getAttribute("name")
885
1038
        except (AttributeError, xml.dom.DOMException,
886
1039
                xml.parsers.expat.ExpatError) as error:
887
1040
            logger.error("Failed to override Introspection method",
888
 
                         error)
 
1041
                         exc_info=error)
889
1042
        return xmlstring
890
1043
 
891
1044
 
892
 
def datetime_to_dbus (dt, variant_level=0):
 
1045
def datetime_to_dbus(dt, variant_level=0):
893
1046
    """Convert a UTC datetime.datetime() to a D-Bus type."""
894
1047
    if dt is None:
895
1048
        return dbus.String("", variant_level = variant_level)
897
1050
                       variant_level=variant_level)
898
1051
 
899
1052
 
900
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
901
 
                                  .__metaclass__):
902
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
903
 
    will add additional D-Bus attributes matching a certain pattern.
 
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).
904
1075
    """
905
 
    def __new__(mcs, name, bases, attr):
906
 
        # Go through all the base classes which could have D-Bus
907
 
        # methods, signals, or properties in them
908
 
        for base in (b for b in bases
909
 
                     if issubclass(b, dbus.service.Object)):
910
 
            # Go though all attributes of the base class
911
 
            for attrname, attribute in inspect.getmembers(base):
 
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):
912
1083
                # Ignore non-D-Bus attributes, and D-Bus attributes
913
1084
                # with the wrong interface name
914
1085
                if (not hasattr(attribute, "_dbus_interface")
915
1086
                    or not attribute._dbus_interface
916
 
                    .startswith("se.recompile.Mandos")):
 
1087
                    .startswith(orig_interface_name)):
917
1088
                    continue
918
1089
                # Create an alternate D-Bus interface name based on
919
1090
                # the current name
920
1091
                alt_interface = (attribute._dbus_interface
921
 
                                 .replace("se.recompile.Mandos",
922
 
                                          "se.bsnet.fukt.Mandos"))
 
1092
                                 .replace(orig_interface_name,
 
1093
                                          alt_interface_name))
 
1094
                interface_names.add(alt_interface)
923
1095
                # Is this a D-Bus signal?
924
1096
                if getattr(attribute, "_dbus_is_signal", False):
925
 
                    # Extract the original non-method function by
926
 
                    # black magic
 
1097
                    # Extract the original non-method undecorated
 
1098
                    # function by black magic
927
1099
                    nonmethod_func = (dict(
928
1100
                            zip(attribute.func_code.co_freevars,
929
1101
                                attribute.__closure__))["func"]
940
1112
                                nonmethod_func.func_name,
941
1113
                                nonmethod_func.func_defaults,
942
1114
                                nonmethod_func.func_closure)))
 
1115
                    # Copy annotations, if any
 
1116
                    try:
 
1117
                        new_function._dbus_annotations = (
 
1118
                            dict(attribute._dbus_annotations))
 
1119
                    except AttributeError:
 
1120
                        pass
943
1121
                    # Define a creator of a function to call both the
944
 
                    # old and new functions, so both the old and new
945
 
                    # signals gets sent when the function is called
 
1122
                    # original and alternate functions, so both the
 
1123
                    # original and alternate signals gets sent when
 
1124
                    # the function is called
946
1125
                    def fixscope(func1, func2):
947
1126
                        """This function is a scope container to pass
948
1127
                        func1 and func2 to the "call_both" function
955
1134
                        return call_both
956
1135
                    # Create the "call_both" function and add it to
957
1136
                    # the class
958
 
                    attr[attrname] = fixscope(attribute,
959
 
                                              new_function)
 
1137
                    attr[attrname] = fixscope(attribute, new_function)
960
1138
                # Is this a D-Bus method?
961
1139
                elif getattr(attribute, "_dbus_is_method", False):
962
1140
                    # Create a new, but exactly alike, function
973
1151
                                        attribute.func_name,
974
1152
                                        attribute.func_defaults,
975
1153
                                        attribute.func_closure)))
 
1154
                    # Copy annotations, if any
 
1155
                    try:
 
1156
                        attr[attrname]._dbus_annotations = (
 
1157
                            dict(attribute._dbus_annotations))
 
1158
                    except AttributeError:
 
1159
                        pass
976
1160
                # Is this a D-Bus property?
977
1161
                elif getattr(attribute, "_dbus_is_property", False):
978
1162
                    # Create a new, but exactly alike, function
992
1176
                                        attribute.func_name,
993
1177
                                        attribute.func_defaults,
994
1178
                                        attribute.func_closure)))
995
 
        return type.__new__(mcs, name, bases, attr)
996
 
 
997
 
 
 
1179
                    # Copy annotations, if any
 
1180
                    try:
 
1181
                        attr[attrname]._dbus_annotations = (
 
1182
                            dict(attribute._dbus_annotations))
 
1183
                    except AttributeError:
 
1184
                        pass
 
1185
                # Is this a D-Bus interface?
 
1186
                elif getattr(attribute, "_dbus_is_interface", False):
 
1187
                    # Create a new, but exactly alike, function
 
1188
                    # object.  Decorate it to be a new D-Bus interface
 
1189
                    # with the alternate D-Bus interface name.  Add it
 
1190
                    # to the class.
 
1191
                    attr[attrname] = (dbus_interface_annotations
 
1192
                                      (alt_interface)
 
1193
                                      (types.FunctionType
 
1194
                                       (attribute.func_code,
 
1195
                                        attribute.func_globals,
 
1196
                                        attribute.func_name,
 
1197
                                        attribute.func_defaults,
 
1198
                                        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"})
998
1224
class ClientDBus(Client, DBusObjectWithProperties):
999
1225
    """A Client class using D-Bus
1000
1226
    
1006
1232
    runtime_expansions = (Client.runtime_expansions
1007
1233
                          + ("dbus_object_path",))
1008
1234
    
 
1235
    _interface = "se.recompile.Mandos.Client"
 
1236
    
1009
1237
    # dbus.service.Object doesn't use super(), so we can't either.
1010
1238
    
1011
1239
    def __init__(self, bus = None, *args, **kwargs):
1012
1240
        self.bus = bus
1013
1241
        Client.__init__(self, *args, **kwargs)
1014
 
        
1015
 
        self._approvals_pending = 0
1016
1242
        # Only now, when this client is initialized, can it show up on
1017
1243
        # the D-Bus
1018
 
        client_object_name = unicode(self.name).translate(
 
1244
        client_object_name = str(self.name).translate(
1019
1245
            {ord("."): ord("_"),
1020
1246
             ord("-"): ord("_")})
1021
1247
        self.dbus_object_path = (dbus.ObjectPath
1022
1248
                                 ("/clients/" + client_object_name))
1023
1249
        DBusObjectWithProperties.__init__(self, self.bus,
1024
1250
                                          self.dbus_object_path)
1025
 
        
 
1251
    
1026
1252
    def notifychangeproperty(transform_func,
1027
1253
                             dbus_name, type_func=lambda x: x,
1028
 
                             variant_level=1):
 
1254
                             variant_level=1, invalidate_only=False,
 
1255
                             _interface=_interface):
1029
1256
        """ Modify a variable so that it's a property which announces
1030
1257
        its changes to DBus.
1031
1258
        
1036
1263
                   to the D-Bus.  Default: no transform
1037
1264
        variant_level: D-Bus variant level.  Default: 1
1038
1265
        """
1039
 
        attrname = "_{0}".format(dbus_name)
 
1266
        attrname = "_{}".format(dbus_name)
1040
1267
        def setter(self, value):
1041
1268
            if hasattr(self, "dbus_object_path"):
1042
1269
                if (not hasattr(self, attrname) or
1043
1270
                    type_func(getattr(self, attrname, None))
1044
1271
                    != type_func(value)):
1045
 
                    dbus_value = transform_func(type_func(value),
1046
 
                                                variant_level
1047
 
                                                =variant_level)
1048
 
                    self.PropertyChanged(dbus.String(dbus_name),
1049
 
                                         dbus_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())
1050
1287
            setattr(self, attrname, value)
1051
1288
        
1052
1289
        return property(lambda self: getattr(self, attrname), setter)
1053
1290
    
1054
 
    
1055
1291
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1056
1292
    approvals_pending = notifychangeproperty(dbus.Boolean,
1057
1293
                                             "ApprovalPending",
1064
1300
                                       checker is not None)
1065
1301
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1066
1302
                                           "LastCheckedOK")
 
1303
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1304
                                               "LastCheckerStatus")
1067
1305
    last_approval_request = notifychangeproperty(
1068
1306
        datetime_to_dbus, "LastApprovalRequest")
1069
1307
    approved_by_default = notifychangeproperty(dbus.Boolean,
1070
1308
                                               "ApprovedByDefault")
1071
 
    approval_delay = notifychangeproperty(dbus.UInt16,
 
1309
    approval_delay = notifychangeproperty(dbus.UInt64,
1072
1310
                                          "ApprovalDelay",
1073
1311
                                          type_func =
1074
 
                                          _timedelta_to_milliseconds)
 
1312
                                          lambda td: td.total_seconds()
 
1313
                                          * 1000)
1075
1314
    approval_duration = notifychangeproperty(
1076
 
        dbus.UInt16, "ApprovalDuration",
1077
 
        type_func = _timedelta_to_milliseconds)
 
1315
        dbus.UInt64, "ApprovalDuration",
 
1316
        type_func = lambda td: td.total_seconds() * 1000)
1078
1317
    host = notifychangeproperty(dbus.String, "Host")
1079
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1080
 
                                   type_func =
1081
 
                                   _timedelta_to_milliseconds)
 
1318
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1319
                                   type_func = lambda td:
 
1320
                                       td.total_seconds() * 1000)
1082
1321
    extended_timeout = notifychangeproperty(
1083
 
        dbus.UInt16, "ExtendedTimeout",
1084
 
        type_func = _timedelta_to_milliseconds)
1085
 
    interval = notifychangeproperty(dbus.UInt16,
 
1322
        dbus.UInt64, "ExtendedTimeout",
 
1323
        type_func = lambda td: td.total_seconds() * 1000)
 
1324
    interval = notifychangeproperty(dbus.UInt64,
1086
1325
                                    "Interval",
1087
1326
                                    type_func =
1088
 
                                    _timedelta_to_milliseconds)
 
1327
                                    lambda td: td.total_seconds()
 
1328
                                    * 1000)
1089
1329
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1330
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1331
                                  invalidate_only=True)
1090
1332
    
1091
1333
    del notifychangeproperty
1092
1334
    
1119
1361
                                       *args, **kwargs)
1120
1362
    
1121
1363
    def start_checker(self, *args, **kwargs):
1122
 
        old_checker = self.checker
1123
 
        if self.checker is not None:
1124
 
            old_checker_pid = self.checker.pid
1125
 
        else:
1126
 
            old_checker_pid = None
 
1364
        old_checker_pid = getattr(self.checker, "pid", None)
1127
1365
        r = Client.start_checker(self, *args, **kwargs)
1128
1366
        # Only if new checker process was started
1129
1367
        if (self.checker is not None
1133
1371
        return r
1134
1372
    
1135
1373
    def _reset_approved(self):
1136
 
        self._approved = None
 
1374
        self.approved = None
1137
1375
        return False
1138
1376
    
1139
1377
    def approve(self, value=True):
 
1378
        self.approved = value
 
1379
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1380
                                * 1000), self._reset_approved)
1140
1381
        self.send_changedstate()
1141
 
        self._approved = value
1142
 
        gobject.timeout_add(_timedelta_to_milliseconds
1143
 
                            (self.approval_duration),
1144
 
                            self._reset_approved)
1145
 
    
1146
1382
    
1147
1383
    ## D-Bus methods, signals & properties
1148
 
    _interface = "se.recompile.Mandos.Client"
 
1384
    
 
1385
    ## Interfaces
1149
1386
    
1150
1387
    ## Signals
1151
1388
    
1162
1399
        pass
1163
1400
    
1164
1401
    # PropertyChanged - signal
 
1402
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1165
1403
    @dbus.service.signal(_interface, signature="sv")
1166
1404
    def PropertyChanged(self, property, value):
1167
1405
        "D-Bus signal"
1188
1426
        "D-Bus signal"
1189
1427
        return self.need_approval()
1190
1428
    
1191
 
    # NeRwequest - signal
1192
 
    @dbus.service.signal(_interface, signature="s")
1193
 
    def NewRequest(self, ip):
1194
 
        """D-Bus signal
1195
 
        Is sent after a client request a password.
1196
 
        """
1197
 
        pass
1198
 
    
1199
1429
    ## Methods
1200
1430
    
1201
1431
    # Approve - method
1251
1481
                           access="readwrite")
1252
1482
    def ApprovalDelay_dbus_property(self, value=None):
1253
1483
        if value is None:       # get
1254
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1484
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1485
                               * 1000)
1255
1486
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1256
1487
    
1257
1488
    # ApprovalDuration - property
1259
1490
                           access="readwrite")
1260
1491
    def ApprovalDuration_dbus_property(self, value=None):
1261
1492
        if value is None:       # get
1262
 
            return dbus.UInt64(_timedelta_to_milliseconds(
1263
 
                    self.approval_duration))
 
1493
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1494
                               * 1000)
1264
1495
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1265
1496
    
1266
1497
    # Name - property
1279
1510
    def Host_dbus_property(self, value=None):
1280
1511
        if value is None:       # get
1281
1512
            return dbus.String(self.host)
1282
 
        self.host = value
 
1513
        self.host = str(value)
1283
1514
    
1284
1515
    # Created - property
1285
1516
    @dbus_service_property(_interface, signature="s", access="read")
1311
1542
            return
1312
1543
        return datetime_to_dbus(self.last_checked_ok)
1313
1544
    
 
1545
    # LastCheckerStatus - property
 
1546
    @dbus_service_property(_interface, signature="n",
 
1547
                           access="read")
 
1548
    def LastCheckerStatus_dbus_property(self):
 
1549
        return dbus.Int16(self.last_checker_status)
 
1550
    
1314
1551
    # Expires - property
1315
1552
    @dbus_service_property(_interface, signature="s", access="read")
1316
1553
    def Expires_dbus_property(self):
1326
1563
                           access="readwrite")
1327
1564
    def Timeout_dbus_property(self, value=None):
1328
1565
        if value is None:       # get
1329
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1566
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1567
        old_timeout = self.timeout
1330
1568
        self.timeout = datetime.timedelta(0, 0, 0, value)
1331
 
        if getattr(self, "disable_initiator_tag", None) is None:
1332
 
            return
1333
 
        # Reschedule timeout
1334
 
        gobject.source_remove(self.disable_initiator_tag)
1335
 
        self.disable_initiator_tag = None
1336
 
        self.expires = None
1337
 
        time_to_die = _timedelta_to_milliseconds((self
1338
 
                                                  .last_checked_ok
1339
 
                                                  + self.timeout)
1340
 
                                                 - datetime.datetime
1341
 
                                                 .utcnow())
1342
 
        if time_to_die <= 0:
1343
 
            # The timeout has passed
1344
 
            self.disable()
1345
 
        else:
1346
 
            self.expires = (datetime.datetime.utcnow()
1347
 
                            + datetime.timedelta(milliseconds =
1348
 
                                                 time_to_die))
1349
 
            self.disable_initiator_tag = (gobject.timeout_add
1350
 
                                          (time_to_die, self.disable))
 
1569
        # Reschedule disabling
 
1570
        if self.enabled:
 
1571
            now = datetime.datetime.utcnow()
 
1572
            self.expires += self.timeout - old_timeout
 
1573
            if self.expires <= now:
 
1574
                # The timeout has passed
 
1575
                self.disable()
 
1576
            else:
 
1577
                if (getattr(self, "disable_initiator_tag", None)
 
1578
                    is None):
 
1579
                    return
 
1580
                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))
1351
1585
    
1352
1586
    # ExtendedTimeout - property
1353
1587
    @dbus_service_property(_interface, signature="t",
1354
1588
                           access="readwrite")
1355
1589
    def ExtendedTimeout_dbus_property(self, value=None):
1356
1590
        if value is None:       # get
1357
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1591
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1592
                               * 1000)
1358
1593
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1359
1594
    
1360
1595
    # Interval - property
1362
1597
                           access="readwrite")
1363
1598
    def Interval_dbus_property(self, value=None):
1364
1599
        if value is None:       # get
1365
 
            return dbus.UInt64(self.interval_milliseconds())
 
1600
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1366
1601
        self.interval = datetime.timedelta(0, 0, 0, value)
1367
1602
        if getattr(self, "checker_initiator_tag", None) is None:
1368
1603
            return
1379
1614
    def Checker_dbus_property(self, value=None):
1380
1615
        if value is None:       # get
1381
1616
            return dbus.String(self.checker_command)
1382
 
        self.checker_command = value
 
1617
        self.checker_command = str(value)
1383
1618
    
1384
1619
    # CheckerRunning - property
1385
1620
    @dbus_service_property(_interface, signature="b",
1401
1636
    @dbus_service_property(_interface, signature="ay",
1402
1637
                           access="write", byte_arrays=True)
1403
1638
    def Secret_dbus_property(self, value):
1404
 
        self.secret = str(value)
 
1639
        self.secret = bytes(value)
1405
1640
    
1406
1641
    del _interface
1407
1642
 
1414
1649
            raise KeyError()
1415
1650
    
1416
1651
    def __getattribute__(self, name):
1417
 
        if(name == '_pipe'):
 
1652
        if name == '_pipe':
1418
1653
            return super(ProxyClient, self).__getattribute__(name)
1419
1654
        self._pipe.send(('getattr', name))
1420
1655
        data = self._pipe.recv()
1427
1662
            return func
1428
1663
    
1429
1664
    def __setattr__(self, name, value):
1430
 
        if(name == '_pipe'):
 
1665
        if name == '_pipe':
1431
1666
            return super(ProxyClient, self).__setattr__(name, value)
1432
1667
        self._pipe.send(('setattr', name, value))
1433
1668
 
1434
1669
 
1435
 
class ClientDBusTransitional(ClientDBus):
1436
 
    __metaclass__ = AlternateDBusNamesMetaclass
1437
 
 
1438
 
 
1439
1670
class ClientHandler(socketserver.BaseRequestHandler, object):
1440
1671
    """A class to handle client connections.
1441
1672
    
1445
1676
    def handle(self):
1446
1677
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1447
1678
            logger.info("TCP connection from: %s",
1448
 
                        unicode(self.client_address))
 
1679
                        str(self.client_address))
1449
1680
            logger.debug("Pipe FD: %d",
1450
1681
                         self.server.child_pipe.fileno())
1451
1682
            
1477
1708
            logger.debug("Protocol version: %r", line)
1478
1709
            try:
1479
1710
                if int(line.strip().split()[0]) > 1:
1480
 
                    raise RuntimeError
 
1711
                    raise RuntimeError(line)
1481
1712
            except (ValueError, IndexError, RuntimeError) as error:
1482
1713
                logger.error("Unknown protocol version: %s", error)
1483
1714
                return
1502
1733
                    logger.warning("Bad certificate: %s", error)
1503
1734
                    return
1504
1735
                logger.debug("Fingerprint: %s", fpr)
1505
 
                if self.server.use_dbus:
1506
 
                    # Emit D-Bus signal
1507
 
                    client.NewRequest(str(self.client_address))
1508
1736
                
1509
1737
                try:
1510
1738
                    client = ProxyClient(child_pipe, fpr,
1526
1754
                            client.Rejected("Disabled")
1527
1755
                        return
1528
1756
                    
1529
 
                    if client._approved or not client.approval_delay:
 
1757
                    if client.approved or not client.approval_delay:
1530
1758
                        #We are approved or approval is disabled
1531
1759
                        break
1532
 
                    elif client._approved is None:
 
1760
                    elif client.approved is None:
1533
1761
                        logger.info("Client %s needs approval",
1534
1762
                                    client.name)
1535
1763
                        if self.server.use_dbus:
1536
1764
                            # Emit D-Bus signal
1537
1765
                            client.NeedApproval(
1538
 
                                client.approval_delay_milliseconds(),
1539
 
                                client.approved_by_default)
 
1766
                                client.approval_delay.total_seconds()
 
1767
                                * 1000, client.approved_by_default)
1540
1768
                    else:
1541
1769
                        logger.warning("Client %s was not approved",
1542
1770
                                       client.name)
1548
1776
                    #wait until timeout or approved
1549
1777
                    time = datetime.datetime.now()
1550
1778
                    client.changedstate.acquire()
1551
 
                    (client.changedstate.wait
1552
 
                     (float(client._timedelta_to_milliseconds(delay)
1553
 
                            / 1000)))
 
1779
                    client.changedstate.wait(delay.total_seconds())
1554
1780
                    client.changedstate.release()
1555
1781
                    time2 = datetime.datetime.now()
1556
1782
                    if (time2 - time) >= delay:
1572
1798
                    try:
1573
1799
                        sent = session.send(client.secret[sent_size:])
1574
1800
                    except gnutls.errors.GNUTLSError as error:
1575
 
                        logger.warning("gnutls send failed")
 
1801
                        logger.warning("gnutls send failed",
 
1802
                                       exc_info=error)
1576
1803
                        return
1577
1804
                    logger.debug("Sent: %d, remaining: %d",
1578
1805
                                 sent, len(client.secret)
1581
1808
                
1582
1809
                logger.info("Sending secret to %s", client.name)
1583
1810
                # bump the timeout using extended_timeout
1584
 
                client.checked_ok(client.extended_timeout)
 
1811
                client.bump_timeout(client.extended_timeout)
1585
1812
                if self.server.use_dbus:
1586
1813
                    # Emit D-Bus signal
1587
1814
                    client.GotSecret()
1592
1819
                try:
1593
1820
                    session.bye()
1594
1821
                except gnutls.errors.GNUTLSError as error:
1595
 
                    logger.warning("GnuTLS bye failed")
 
1822
                    logger.warning("GnuTLS bye failed",
 
1823
                                   exc_info=error)
1596
1824
    
1597
1825
    @staticmethod
1598
1826
    def peer_certificate(session):
1663
1891
    def sub_process_main(self, request, address):
1664
1892
        try:
1665
1893
            self.finish_request(request, address)
1666
 
        except:
 
1894
        except Exception:
1667
1895
            self.handle_error(request, address)
1668
1896
        self.close_request(request)
1669
1897
    
1670
1898
    def process_request(self, request, address):
1671
1899
        """Start a new process to process the request."""
1672
1900
        proc = multiprocessing.Process(target = self.sub_process_main,
1673
 
                                       args = (request,
1674
 
                                               address))
 
1901
                                       args = (request, address))
1675
1902
        proc.start()
1676
1903
        return proc
1677
1904
 
1692
1919
    
1693
1920
    def add_pipe(self, parent_pipe, proc):
1694
1921
        """Dummy function; override as necessary"""
1695
 
        raise NotImplementedError
 
1922
        raise NotImplementedError()
1696
1923
 
1697
1924
 
1698
1925
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1705
1932
        use_ipv6:       Boolean; to use IPv6 or not
1706
1933
    """
1707
1934
    def __init__(self, server_address, RequestHandlerClass,
1708
 
                 interface=None, use_ipv6=True):
 
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
        """
1709
1939
        self.interface = interface
1710
1940
        if use_ipv6:
1711
1941
            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.
1712
1968
        socketserver.TCPServer.__init__(self, server_address,
1713
1969
                                        RequestHandlerClass)
 
1970
    
1714
1971
    def server_bind(self):
1715
1972
        """This overrides the normal server_bind() function
1716
1973
        to bind to an interface if one was specified, and also NOT to
1724
1981
                try:
1725
1982
                    self.socket.setsockopt(socket.SOL_SOCKET,
1726
1983
                                           SO_BINDTODEVICE,
1727
 
                                           str(self.interface
1728
 
                                               + '\0'))
 
1984
                                           (self.interface + "\0")
 
1985
                                           .encode("utf-8"))
1729
1986
                except socket.error as error:
1730
 
                    if error[0] == errno.EPERM:
1731
 
                        logger.error("No permission to"
1732
 
                                     " bind to interface %s",
1733
 
                                     self.interface)
1734
 
                    elif error[0] == errno.ENOPROTOOPT:
 
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:
1735
1991
                        logger.error("SO_BINDTODEVICE not available;"
1736
1992
                                     " cannot bind to interface %s",
1737
1993
                                     self.interface)
 
1994
                    elif error.errno == errno.ENODEV:
 
1995
                        logger.error("Interface %s does not exist,"
 
1996
                                     " cannot bind", self.interface)
1738
1997
                    else:
1739
1998
                        raise
1740
1999
        # Only bind(2) the socket if we really need to.
1743
2002
                if self.address_family == socket.AF_INET6:
1744
2003
                    any_address = "::" # in6addr_any
1745
2004
                else:
1746
 
                    any_address = socket.INADDR_ANY
 
2005
                    any_address = "0.0.0.0" # INADDR_ANY
1747
2006
                self.server_address = (any_address,
1748
2007
                                       self.server_address[1])
1749
2008
            elif not self.server_address[1]:
1770
2029
    """
1771
2030
    def __init__(self, server_address, RequestHandlerClass,
1772
2031
                 interface=None, use_ipv6=True, clients=None,
1773
 
                 gnutls_priority=None, use_dbus=True):
 
2032
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1774
2033
        self.enabled = False
1775
2034
        self.clients = clients
1776
2035
        if self.clients is None:
1780
2039
        IPv6_TCPServer.__init__(self, server_address,
1781
2040
                                RequestHandlerClass,
1782
2041
                                interface = interface,
1783
 
                                use_ipv6 = use_ipv6)
 
2042
                                use_ipv6 = use_ipv6,
 
2043
                                socketfd = socketfd)
1784
2044
    def server_activate(self):
1785
2045
        if self.enabled:
1786
2046
            return socketserver.TCPServer.server_activate(self)
1799
2059
    
1800
2060
    def handle_ipc(self, source, condition, parent_pipe=None,
1801
2061
                   proc = None, client_object=None):
1802
 
        condition_names = {
1803
 
            gobject.IO_IN: "IN",   # There is data to read.
1804
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1805
 
                                    # blocking).
1806
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1807
 
            gobject.IO_ERR: "ERR", # Error condition.
1808
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1809
 
                                    # broken, usually for pipes and
1810
 
                                    # sockets).
1811
 
            }
1812
 
        conditions_string = ' | '.join(name
1813
 
                                       for cond, name in
1814
 
                                       condition_names.iteritems()
1815
 
                                       if cond & condition)
1816
2062
        # error, or the other end of multiprocessing.Pipe has closed
1817
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2063
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1818
2064
            # Wait for other process to exit
1819
2065
            proc.join()
1820
2066
            return False
1878
2124
        return True
1879
2125
 
1880
2126
 
 
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
 
1881
2226
def string_to_delta(interval):
1882
2227
    """Parse a string and return a datetime.timedelta
1883
2228
    
1894
2239
    >>> string_to_delta('5m 30s')
1895
2240
    datetime.timedelta(0, 330)
1896
2241
    """
 
2242
    
 
2243
    try:
 
2244
        return rfc3339_duration_to_delta(interval)
 
2245
    except ValueError:
 
2246
        pass
 
2247
    
1897
2248
    timevalue = datetime.timedelta(0)
1898
2249
    for s in interval.split():
1899
2250
        try:
1900
 
            suffix = unicode(s[-1])
 
2251
            suffix = s[-1]
1901
2252
            value = int(s[:-1])
1902
2253
            if suffix == "d":
1903
2254
                delta = datetime.timedelta(value)
1910
2261
            elif suffix == "w":
1911
2262
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1912
2263
            else:
1913
 
                raise ValueError("Unknown suffix %r" % suffix)
1914
 
        except (ValueError, IndexError) as e:
 
2264
                raise ValueError("Unknown suffix {!r}"
 
2265
                                 .format(suffix))
 
2266
        except IndexError as e:
1915
2267
            raise ValueError(*(e.args))
1916
2268
        timevalue += delta
1917
2269
    return timevalue
1930
2282
        sys.exit()
1931
2283
    if not noclose:
1932
2284
        # Close all standard open file descriptors
1933
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2285
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1934
2286
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1935
 
            raise OSError(errno.ENODEV,
1936
 
                          "%s not a character device"
1937
 
                          % os.path.devnull)
 
2287
            raise OSError(errno.ENODEV, "{} not a character device"
 
2288
                          .format(os.devnull))
1938
2289
        os.dup2(null, sys.stdin.fileno())
1939
2290
        os.dup2(null, sys.stdout.fileno())
1940
2291
        os.dup2(null, sys.stderr.fileno())
1949
2300
    
1950
2301
    parser = argparse.ArgumentParser()
1951
2302
    parser.add_argument("-v", "--version", action="version",
1952
 
                        version = "%%(prog)s %s" % version,
 
2303
                        version = "%(prog)s {}".format(version),
1953
2304
                        help="show version number and exit")
1954
2305
    parser.add_argument("-i", "--interface", metavar="IF",
1955
2306
                        help="Bind to interface IF")
1961
2312
                        help="Run self-test")
1962
2313
    parser.add_argument("--debug", action="store_true",
1963
2314
                        help="Debug mode; run in foreground and log"
1964
 
                        " to terminal")
 
2315
                        " to terminal", default=None)
1965
2316
    parser.add_argument("--debuglevel", metavar="LEVEL",
1966
2317
                        help="Debug level for stdout output")
1967
2318
    parser.add_argument("--priority", help="GnuTLS"
1974
2325
                        " files")
1975
2326
    parser.add_argument("--no-dbus", action="store_false",
1976
2327
                        dest="use_dbus", help="Do not provide D-Bus"
1977
 
                        " system bus interface")
 
2328
                        " system bus interface", default=None)
1978
2329
    parser.add_argument("--no-ipv6", action="store_false",
1979
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2330
                        dest="use_ipv6", help="Do not use IPv6",
 
2331
                        default=None)
1980
2332
    parser.add_argument("--no-restore", action="store_false",
1981
2333
                        dest="restore", help="Do not restore stored"
1982
 
                        " state")
 
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")
1983
2338
    parser.add_argument("--statedir", metavar="DIR",
1984
2339
                        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)
1985
2345
    
1986
2346
    options = parser.parse_args()
1987
2347
    
1988
2348
    if options.check:
1989
2349
        import doctest
1990
 
        doctest.testmod()
1991
 
        sys.exit()
 
2350
        fail_count, test_count = doctest.testmod()
 
2351
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1992
2352
    
1993
2353
    # Default values for config file for server-global settings
1994
2354
    server_defaults = { "interface": "",
1996
2356
                        "port": "",
1997
2357
                        "debug": "False",
1998
2358
                        "priority":
1999
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2359
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2000
2360
                        "servicename": "Mandos",
2001
2361
                        "use_dbus": "True",
2002
2362
                        "use_ipv6": "True",
2003
2363
                        "debuglevel": "",
2004
2364
                        "restore": "True",
2005
 
                        "statedir": "/var/lib/mandos"
 
2365
                        "socket": "",
 
2366
                        "statedir": "/var/lib/mandos",
 
2367
                        "foreground": "False",
 
2368
                        "zeroconf": "True",
2006
2369
                        }
2007
2370
    
2008
2371
    # Parse config file for server-global settings
2013
2376
    # Convert the SafeConfigParser object to a dict
2014
2377
    server_settings = server_config.defaults()
2015
2378
    # Use the appropriate methods on the non-string config options
2016
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2379
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2017
2380
        server_settings[option] = server_config.getboolean("DEFAULT",
2018
2381
                                                           option)
2019
2382
    if server_settings["port"]:
2020
2383
        server_settings["port"] = server_config.getint("DEFAULT",
2021
2384
                                                       "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"])
2022
2394
    del server_config
2023
2395
    
2024
2396
    # Override the settings from the config file with command line
2026
2398
    for option in ("interface", "address", "port", "debug",
2027
2399
                   "priority", "servicename", "configdir",
2028
2400
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2029
 
                   "statedir"):
 
2401
                   "statedir", "socket", "foreground", "zeroconf"):
2030
2402
        value = getattr(options, option)
2031
2403
        if value is not None:
2032
2404
            server_settings[option] = value
2033
2405
    del options
2034
2406
    # Force all strings to be unicode
2035
2407
    for option in server_settings.keys():
2036
 
        if type(server_settings[option]) is str:
2037
 
            server_settings[option] = unicode(server_settings[option])
 
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
2038
2418
    # Now we have our good server settings in "server_settings"
2039
2419
    
2040
2420
    ##################################################################
2041
2421
    
 
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
    
2042
2428
    # For convenience
2043
2429
    debug = server_settings["debug"]
2044
2430
    debuglevel = server_settings["debuglevel"]
2046
2432
    use_ipv6 = server_settings["use_ipv6"]
2047
2433
    stored_state_path = os.path.join(server_settings["statedir"],
2048
2434
                                     stored_state_file)
 
2435
    foreground = server_settings["foreground"]
 
2436
    zeroconf = server_settings["zeroconf"]
2049
2437
    
2050
2438
    if debug:
2051
 
        initlogger(logging.DEBUG)
 
2439
        initlogger(debug, logging.DEBUG)
2052
2440
    else:
2053
2441
        if not debuglevel:
2054
 
            initlogger()
 
2442
            initlogger(debug)
2055
2443
        else:
2056
2444
            level = getattr(logging, debuglevel.upper())
2057
 
            initlogger(level)
 
2445
            initlogger(debug, level)
2058
2446
    
2059
2447
    if server_settings["servicename"] != "Mandos":
2060
2448
        syslogger.setFormatter(logging.Formatter
2061
 
                               ('Mandos (%s) [%%(process)d]:'
2062
 
                                ' %%(levelname)s: %%(message)s'
2063
 
                                % server_settings["servicename"]))
 
2449
                               ('Mandos ({}) [%(process)d]:'
 
2450
                                ' %(levelname)s: %(message)s'
 
2451
                                .format(server_settings
 
2452
                                        ["servicename"])))
2064
2453
    
2065
2454
    # Parse config file with clients
2066
 
    client_defaults = { "timeout": "5m",
2067
 
                        "extended_timeout": "15m",
2068
 
                        "interval": "2m",
2069
 
                        "checker": "fping -q -- %%(host)s",
2070
 
                        "host": "",
2071
 
                        "approval_delay": "0s",
2072
 
                        "approval_duration": "1s",
2073
 
                        }
2074
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2455
    client_config = configparser.SafeConfigParser(Client
 
2456
                                                  .client_defaults)
2075
2457
    client_config.read(os.path.join(server_settings["configdir"],
2076
2458
                                    "clients.conf"))
2077
2459
    
2078
2460
    global mandos_dbus_service
2079
2461
    mandos_dbus_service = None
2080
2462
    
 
2463
    socketfd = None
 
2464
    if server_settings["socket"] != "":
 
2465
        socketfd = server_settings["socket"]
2081
2466
    tcp_server = MandosServer((server_settings["address"],
2082
2467
                               server_settings["port"]),
2083
2468
                              ClientHandler,
2086
2471
                              use_ipv6=use_ipv6,
2087
2472
                              gnutls_priority=
2088
2473
                              server_settings["priority"],
2089
 
                              use_dbus=use_dbus)
2090
 
    if not debug:
2091
 
        pidfilename = "/var/run/mandos.pid"
 
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
2092
2481
        try:
2093
2482
            pidfile = open(pidfilename, "w")
2094
 
        except IOError:
2095
 
            logger.error("Could not open file %r", pidfilename)
 
2483
        except IOError as e:
 
2484
            logger.error("Could not open file %r", pidfilename,
 
2485
                         exc_info=e)
2096
2486
    
2097
 
    try:
2098
 
        uid = pwd.getpwnam("_mandos").pw_uid
2099
 
        gid = pwd.getpwnam("_mandos").pw_gid
2100
 
    except KeyError:
 
2487
    for name in ("_mandos", "mandos", "nobody"):
2101
2488
        try:
2102
 
            uid = pwd.getpwnam("mandos").pw_uid
2103
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2489
            uid = pwd.getpwnam(name).pw_uid
 
2490
            gid = pwd.getpwnam(name).pw_gid
 
2491
            break
2104
2492
        except KeyError:
2105
 
            try:
2106
 
                uid = pwd.getpwnam("nobody").pw_uid
2107
 
                gid = pwd.getpwnam("nobody").pw_gid
2108
 
            except KeyError:
2109
 
                uid = 65534
2110
 
                gid = 65534
 
2493
            continue
 
2494
    else:
 
2495
        uid = 65534
 
2496
        gid = 65534
2111
2497
    try:
2112
2498
        os.setgid(gid)
2113
2499
        os.setuid(uid)
2114
2500
    except OSError as error:
2115
 
        if error[0] != errno.EPERM:
2116
 
            raise error
 
2501
        if error.errno != errno.EPERM:
 
2502
            raise
2117
2503
    
2118
2504
    if debug:
2119
2505
        # Enable all possible GnuTLS debugging
2130
2516
         .gnutls_global_set_log_function(debug_gnutls))
2131
2517
        
2132
2518
        # Redirect stdin so all checkers get /dev/null
2133
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2519
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2134
2520
        os.dup2(null, sys.stdin.fileno())
2135
2521
        if null > 2:
2136
2522
            os.close(null)
2137
 
    else:
2138
 
        # No console logging
2139
 
        logger.removeHandler(console)
2140
2523
    
2141
2524
    # Need to fork before connecting to D-Bus
2142
 
    if not debug:
 
2525
    if not foreground:
2143
2526
        # Close all input and output, do double fork, etc.
2144
2527
        daemon()
2145
2528
    
 
2529
    # multiprocessing will use threads, so before we use gobject we
 
2530
    # need to inform gobject that threads will be used.
 
2531
    gobject.threads_init()
 
2532
    
2146
2533
    global main_loop
2147
2534
    # From the Avahi example code
2148
 
    DBusGMainLoop(set_as_default=True )
 
2535
    DBusGMainLoop(set_as_default=True)
2149
2536
    main_loop = gobject.MainLoop()
2150
2537
    bus = dbus.SystemBus()
2151
2538
    # End of Avahi example code
2157
2544
                            ("se.bsnet.fukt.Mandos", bus,
2158
2545
                             do_not_queue=True))
2159
2546
        except dbus.exceptions.NameExistsException as e:
2160
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2547
            logger.error("Disabling D-Bus:", exc_info=e)
2161
2548
            use_dbus = False
2162
2549
            server_settings["use_dbus"] = False
2163
2550
            tcp_server.use_dbus = False
2164
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2165
 
    service = AvahiServiceToSyslog(name =
2166
 
                                   server_settings["servicename"],
2167
 
                                   servicetype = "_mandos._tcp",
2168
 
                                   protocol = protocol, bus = bus)
2169
 
    if server_settings["interface"]:
2170
 
        service.interface = (if_nametoindex
2171
 
                             (str(server_settings["interface"])))
 
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")))
2172
2561
    
2173
2562
    global multiprocessing_manager
2174
2563
    multiprocessing_manager = multiprocessing.Manager()
2175
2564
    
2176
2565
    client_class = Client
2177
2566
    if use_dbus:
2178
 
        client_class = functools.partial(ClientDBusTransitional,
2179
 
                                         bus = bus)
2180
 
    
2181
 
    special_settings = {
2182
 
        # Some settings need to be accessd by special methods;
2183
 
        # booleans need .getboolean(), etc.  Here is a list of them:
2184
 
        "approved_by_default":
2185
 
            lambda section:
2186
 
            client_config.getboolean(section, "approved_by_default"),
2187
 
        "enabled":
2188
 
            lambda section:
2189
 
            client_config.getboolean(section, "enabled"),
2190
 
        }
2191
 
    # Construct a new dict of client settings of this form:
2192
 
    # { client_name: {setting_name: value, ...}, ...}
2193
 
    # with exceptions for any special settings as defined above
2194
 
    client_settings = dict((clientname,
2195
 
                           dict((setting,
2196
 
                                 (value
2197
 
                                  if setting not in special_settings
2198
 
                                  else special_settings[setting]
2199
 
                                  (clientname)))
2200
 
                                for setting, value in
2201
 
                                client_config.items(clientname)))
2202
 
                          for clientname in client_config.sections())
2203
 
    
 
2567
        client_class = functools.partial(ClientDBus, bus = bus)
 
2568
    
 
2569
    client_settings = Client.config_parser(client_config)
2204
2570
    old_client_settings = {}
2205
 
    clients_data = []
 
2571
    clients_data = {}
 
2572
    
 
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()
2206
2580
    
2207
2581
    # Get client data and settings from last running state.
2208
2582
    if server_settings["restore"]:
2212
2586
                                                     (stored_state))
2213
2587
            os.remove(stored_state_path)
2214
2588
        except IOError as e:
2215
 
            logger.warning("Could not load persistent state: {0}"
2216
 
                           .format(e))
2217
 
            if e.errno != errno.ENOENT:
 
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)
2218
2595
                raise
 
2596
        except EOFError as e:
 
2597
            logger.warning("Could not load persistent state: "
 
2598
                           "EOFError:", exc_info=e)
2219
2599
    
2220
 
    with Crypto() as crypt:
2221
 
        for client in clients_data:
2222
 
            client_name = client["name"]
 
2600
    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
2223
2605
            
2224
2606
            # Decide which value to use after restoring saved state.
2225
2607
            # We have three different values: Old config file,
2234
2616
                    if (name != "secret" and
2235
2617
                        value != old_client_settings[client_name]
2236
2618
                        [name]):
2237
 
                        setattr(client, name, value)
 
2619
                        client[name] = value
2238
2620
                except KeyError:
2239
2621
                    pass
2240
2622
            
2241
2623
            # Clients who has passed its expire date can still be
2242
 
            # enabled if its last checker was sucessful.  Clients
2243
 
            # whose checker failed before we stored its state is
2244
 
            # assumed to have failed all checkers during downtime.
2245
 
            if client["enabled"] and client["last_checked_ok"]:
2246
 
                if ((datetime.datetime.utcnow()
2247
 
                     - client["last_checked_ok"])
2248
 
                    > client["interval"]):
2249
 
                    if client["last_checker_status"] != 0:
 
2624
            # enabled if its last checker was successful.  Clients
 
2625
            # whose checker succeeded before we stored its state is
 
2626
            # assumed to have successfully run all checkers during
 
2627
            # downtime.
 
2628
            if client["enabled"]:
 
2629
                if datetime.datetime.utcnow() >= client["expires"]:
 
2630
                    if not client["last_checked_ok"]:
 
2631
                        logger.warning(
 
2632
                            "disabling client {} - Client never "
 
2633
                            "performed a successful checker"
 
2634
                            .format(client_name))
 
2635
                        client["enabled"] = False
 
2636
                    elif client["last_checker_status"] != 0:
 
2637
                        logger.warning(
 
2638
                            "disabling client {} - Client last"
 
2639
                            " checker failed with error code {}"
 
2640
                            .format(client_name,
 
2641
                                    client["last_checker_status"]))
2250
2642
                        client["enabled"] = False
2251
2643
                    else:
2252
2644
                        client["expires"] = (datetime.datetime
2253
2645
                                             .utcnow()
2254
2646
                                             + client["timeout"])
2255
 
            
2256
 
            client["changedstate"] = (multiprocessing_manager
2257
 
                                      .Condition
2258
 
                                      (multiprocessing_manager
2259
 
                                       .Lock()))
2260
 
            if use_dbus:
2261
 
                new_client = (ClientDBusTransitional.__new__
2262
 
                              (ClientDBusTransitional))
2263
 
                tcp_server.clients[client_name] = new_client
2264
 
                new_client.bus = bus
2265
 
                for name, value in client.iteritems():
2266
 
                    setattr(new_client, name, value)
2267
 
                client_object_name = unicode(client_name).translate(
2268
 
                    {ord("."): ord("_"),
2269
 
                     ord("-"): ord("_")})
2270
 
                new_client.dbus_object_path = (dbus.ObjectPath
2271
 
                                               ("/clients/"
2272
 
                                                + client_object_name))
2273
 
                DBusObjectWithProperties.__init__(new_client,
2274
 
                                                  new_client.bus,
2275
 
                                                  new_client
2276
 
                                                  .dbus_object_path)
2277
 
            else:
2278
 
                tcp_server.clients[client_name] = (Client.__new__
2279
 
                                                   (Client))
2280
 
                for name, value in client.iteritems():
2281
 
                    setattr(tcp_server.clients[client_name],
2282
 
                            name, value)
2283
 
            
 
2647
                        logger.debug("Last checker succeeded,"
 
2648
                                     " keeping {} enabled"
 
2649
                                     .format(client_name))
2284
2650
            try:
2285
 
                tcp_server.clients[client_name].secret = (
2286
 
                    crypt.decrypt(tcp_server.clients[client_name]
2287
 
                                  .encrypted_secret,
2288
 
                                  client_settings[client_name]
2289
 
                                  ["secret"]))
2290
 
            except CryptoError:
 
2651
                client["secret"] = (
 
2652
                    pgp.decrypt(client["encrypted_secret"],
 
2653
                                client_settings[client_name]
 
2654
                                ["secret"]))
 
2655
            except PGPError:
2291
2656
                # If decryption fails, we use secret from new settings
2292
 
                tcp_server.clients[client_name].secret = (
 
2657
                logger.debug("Failed to decrypt {} old secret"
 
2658
                             .format(client_name))
 
2659
                client["secret"] = (
2293
2660
                    client_settings[client_name]["secret"])
2294
2661
    
2295
 
    # Create/remove clients based on new changes made to config
2296
 
    for clientname in set(old_client_settings) - set(client_settings):
2297
 
        del tcp_server.clients[clientname]
2298
 
    for clientname in set(client_settings) - set(old_client_settings):
2299
 
        tcp_server.clients[clientname] = (client_class(name
2300
 
                                                       = clientname,
2301
 
                                                       config =
2302
 
                                                       client_settings
2303
 
                                                       [clientname]))
 
2662
    # Add/remove clients based on new changes made to config
 
2663
    for client_name in (set(old_client_settings)
 
2664
                        - set(client_settings)):
 
2665
        del clients_data[client_name]
 
2666
    for client_name in (set(client_settings)
 
2667
                        - set(old_client_settings)):
 
2668
        clients_data[client_name] = client_settings[client_name]
 
2669
    
 
2670
    # Create all client objects
 
2671
    for client_name, client in clients_data.items():
 
2672
        tcp_server.clients[client_name] = client_class(
 
2673
            name = client_name, settings = client,
 
2674
            server_settings = server_settings)
2304
2675
    
2305
2676
    if not tcp_server.clients:
2306
2677
        logger.warning("No clients defined")
2307
 
        
2308
 
    if not debug:
2309
 
        try:
2310
 
            with pidfile:
2311
 
                pid = os.getpid()
2312
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2313
 
            del pidfile
2314
 
        except IOError:
2315
 
            logger.error("Could not write to file %r with PID %d",
2316
 
                         pidfilename, pid)
2317
 
        except NameError:
2318
 
            # "pidfile" was never created
2319
 
            pass
 
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
2320
2689
        del pidfilename
2321
 
        
2322
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2323
2690
    
2324
2691
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2325
2692
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2326
2693
    
2327
2694
    if use_dbus:
2328
 
        class MandosDBusService(dbus.service.Object):
 
2695
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2696
                                        "se.bsnet.fukt.Mandos"})
 
2697
        class MandosDBusService(DBusObjectWithProperties):
2329
2698
            """A D-Bus proxy object"""
2330
2699
            def __init__(self):
2331
2700
                dbus.service.Object.__init__(self, bus, "/")
2332
2701
            _interface = "se.recompile.Mandos"
2333
2702
            
 
2703
            @dbus_interface_annotations(_interface)
 
2704
            def _foo(self):
 
2705
                return { "org.freedesktop.DBus.Property"
 
2706
                         ".EmitsChangedSignal":
 
2707
                             "false"}
 
2708
            
2334
2709
            @dbus.service.signal(_interface, signature="o")
2335
2710
            def ClientAdded(self, objpath):
2336
2711
                "D-Bus signal"
2358
2733
            def GetAllClientsWithProperties(self):
2359
2734
                "D-Bus method"
2360
2735
                return dbus.Dictionary(
2361
 
                    ((c.dbus_object_path, c.GetAll(""))
2362
 
                     for c in tcp_server.clients.itervalues()),
 
2736
                    { c.dbus_object_path: c.GetAll("")
 
2737
                      for c in tcp_server.clients.itervalues() },
2363
2738
                    signature="oa{sv}")
2364
2739
            
2365
2740
            @dbus.service.method(_interface, in_signature="o")
2378
2753
            
2379
2754
            del _interface
2380
2755
        
2381
 
        class MandosDBusServiceTransitional(MandosDBusService):
2382
 
            __metaclass__ = AlternateDBusNamesMetaclass
2383
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2756
        mandos_dbus_service = MandosDBusService()
2384
2757
    
2385
2758
    def cleanup():
2386
2759
        "Cleanup function; run on exit"
2387
 
        service.cleanup()
 
2760
        if zeroconf:
 
2761
            service.cleanup()
2388
2762
        
2389
2763
        multiprocessing.active_children()
 
2764
        wnull.close()
2390
2765
        if not (tcp_server.clients or client_settings):
2391
2766
            return
2392
2767
        
2393
2768
        # Store client before exiting. Secrets are encrypted with key
2394
2769
        # based on what config file has. If config file is
2395
2770
        # removed/edited, old secret will thus be unrecovable.
2396
 
        clients = []
2397
 
        with Crypto() as crypt:
 
2771
        clients = {}
 
2772
        with PGPEngine() as pgp:
2398
2773
            for client in tcp_server.clients.itervalues():
2399
2774
                key = client_settings[client.name]["secret"]
2400
 
                client.encrypted_secret = crypt.encrypt(client.secret,
2401
 
                                                        key)
 
2775
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2776
                                                      key)
2402
2777
                client_dict = {}
2403
2778
                
2404
 
                # A list of attributes that will not be stored when
2405
 
                # shutting down.
2406
 
                exclude = set(("bus", "changedstate", "secret"))
 
2779
                # A list of attributes that can not be pickled
 
2780
                # + secret.
 
2781
                exclude = { "bus", "changedstate", "secret",
 
2782
                            "checker", "server_settings" }
2407
2783
                for name, typ in (inspect.getmembers
2408
2784
                                  (dbus.service.Object)):
2409
2785
                    exclude.add(name)
2414
2790
                    if attr not in exclude:
2415
2791
                        client_dict[attr] = getattr(client, attr)
2416
2792
                
2417
 
                clients.append(client_dict)
 
2793
                clients[client.name] = client_dict
2418
2794
                del client_settings[client.name]["secret"]
2419
2795
        
2420
2796
        try:
2421
 
            with os.fdopen(os.open(stored_state_path,
2422
 
                                   os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2423
 
                                   0600), "wb") as stored_state:
 
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:
2424
2801
                pickle.dump((clients, client_settings), stored_state)
 
2802
                tempname=stored_state.name
 
2803
            os.rename(tempname, stored_state_path)
2425
2804
        except (IOError, OSError) as e:
2426
 
            logger.warning("Could not save persistent state: {0}"
2427
 
                           .format(e))
2428
 
            if e.errno not in (errno.ENOENT, errno.EACCES):
 
2805
            if not debug:
 
2806
                try:
 
2807
                    os.remove(tempname)
 
2808
                except NameError:
 
2809
                    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)
2429
2816
                raise
2430
2817
        
2431
2818
        # Delete all clients, and settings from config
2456
2843
    tcp_server.server_activate()
2457
2844
    
2458
2845
    # Find out what port we got
2459
 
    service.port = tcp_server.socket.getsockname()[1]
 
2846
    if zeroconf:
 
2847
        service.port = tcp_server.socket.getsockname()[1]
2460
2848
    if use_ipv6:
2461
2849
        logger.info("Now listening on address %r, port %d,"
2462
 
                    " flowinfo %d, scope_id %d"
2463
 
                    % tcp_server.socket.getsockname())
 
2850
                    " flowinfo %d, scope_id %d",
 
2851
                    *tcp_server.socket.getsockname())
2464
2852
    else:                       # IPv4
2465
 
        logger.info("Now listening on address %r, port %d"
2466
 
                    % tcp_server.socket.getsockname())
 
2853
        logger.info("Now listening on address %r, port %d",
 
2854
                    *tcp_server.socket.getsockname())
2467
2855
    
2468
2856
    #service.interface = tcp_server.socket.getsockname()[3]
2469
2857
    
2470
2858
    try:
2471
 
        # From the Avahi example code
2472
 
        try:
2473
 
            service.activate()
2474
 
        except dbus.exceptions.DBusException as error:
2475
 
            logger.critical("DBusException: %s", error)
2476
 
            cleanup()
2477
 
            sys.exit(1)
2478
 
        # End of Avahi example code
 
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
2479
2868
        
2480
2869
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2481
2870
                             lambda *args, **kwargs:
2485
2874
        logger.debug("Starting main loop")
2486
2875
        main_loop.run()
2487
2876
    except AvahiError as error:
2488
 
        logger.critical("AvahiError: %s", error)
 
2877
        logger.critical("Avahi Error", exc_info=error)
2489
2878
        cleanup()
2490
2879
        sys.exit(1)
2491
2880
    except KeyboardInterrupt:
2496
2885
    # Must run before the D-Bus bus name gets deregistered
2497
2886
    cleanup()
2498
2887
 
2499
 
 
2500
2888
if __name__ == '__main__':
2501
2889
    main()