/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
63
65
import cPickle as pickle
64
66
import multiprocessing
65
67
import types
 
68
import binascii
 
69
import tempfile
 
70
import itertools
 
71
import collections
66
72
 
67
73
import dbus
68
74
import dbus.service
82
88
    except ImportError:
83
89
        SO_BINDTODEVICE = None
84
90
 
85
 
 
86
 
version = "1.4.1"
87
 
 
88
 
#logger = logging.getLogger('mandos')
89
 
logger = logging.Logger('mandos')
90
 
syslogger = (logging.handlers.SysLogHandler
91
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
 
              address = str("/dev/log")))
93
 
syslogger.setFormatter(logging.Formatter
94
 
                       ('Mandos [%(process)d]: %(levelname)s:'
95
 
                        ' %(message)s'))
96
 
logger.addHandler(syslogger)
97
 
 
98
 
console = logging.StreamHandler()
99
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
100
 
                                       ' %(levelname)s:'
101
 
                                       ' %(message)s'))
102
 
logger.addHandler(console)
 
91
if sys.version_info.major == 2:
 
92
    str = unicode
 
93
 
 
94
version = "1.6.9"
 
95
stored_state_file = "clients.pickle"
 
96
 
 
97
logger = logging.getLogger()
 
98
syslogger = None
 
99
 
 
100
try:
 
101
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
102
                      (ctypes.util.find_library("c"))
 
103
                      .if_nametoindex)
 
104
except (OSError, AttributeError):
 
105
    def if_nametoindex(interface):
 
106
        "Get an interface index the hard way, i.e. using fcntl()"
 
107
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
108
        with contextlib.closing(socket.socket()) as s:
 
109
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
110
                                struct.pack(b"16s16x", interface))
 
111
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
112
        return interface_index
 
113
 
 
114
 
 
115
def initlogger(debug, level=logging.WARNING):
 
116
    """init logger and add loglevel"""
 
117
    
 
118
    global syslogger
 
119
    syslogger = (logging.handlers.SysLogHandler
 
120
                 (facility =
 
121
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
122
                  address = "/dev/log"))
 
123
    syslogger.setFormatter(logging.Formatter
 
124
                           ('Mandos [%(process)d]: %(levelname)s:'
 
125
                            ' %(message)s'))
 
126
    logger.addHandler(syslogger)
 
127
    
 
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)
 
135
    logger.setLevel(level)
 
136
 
 
137
 
 
138
class PGPError(Exception):
 
139
    """Exception if encryption/decryption fails"""
 
140
    pass
 
141
 
 
142
 
 
143
class PGPEngine(object):
 
144
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
145
    def __init__(self):
 
146
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
147
        self.gnupgargs = ['--batch',
 
148
                          '--home', self.tempdir,
 
149
                          '--force-mdc',
 
150
                          '--quiet',
 
151
                          '--no-use-agent']
 
152
    
 
153
    def __enter__(self):
 
154
        return self
 
155
    
 
156
    def __exit__(self, exc_type, exc_value, traceback):
 
157
        self._cleanup()
 
158
        return False
 
159
    
 
160
    def __del__(self):
 
161
        self._cleanup()
 
162
    
 
163
    def _cleanup(self):
 
164
        if self.tempdir is not None:
 
165
            # Delete contents of tempdir
 
166
            for root, dirs, files in os.walk(self.tempdir,
 
167
                                             topdown = False):
 
168
                for filename in files:
 
169
                    os.remove(os.path.join(root, filename))
 
170
                for dirname in dirs:
 
171
                    os.rmdir(os.path.join(root, dirname))
 
172
            # Remove tempdir
 
173
            os.rmdir(self.tempdir)
 
174
            self.tempdir = None
 
175
    
 
176
    def password_encode(self, password):
 
177
        # Passphrase can not be empty and can not contain newlines or
 
178
        # NUL bytes.  So we prefix it and hex encode it.
 
179
        encoded = b"mandos" + binascii.hexlify(password)
 
180
        if len(encoded) > 2048:
 
181
            # GnuPG can't handle long passwords, so encode differently
 
182
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
183
                       .replace(b"\n", b"\\n")
 
184
                       .replace(b"\0", b"\\x00"))
 
185
        return encoded
 
186
    
 
187
    def encrypt(self, data, password):
 
188
        passphrase = self.password_encode(password)
 
189
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
190
                                         ) as passfile:
 
191
            passfile.write(passphrase)
 
192
            passfile.flush()
 
193
            proc = subprocess.Popen(['gpg', '--symmetric',
 
194
                                     '--passphrase-file',
 
195
                                     passfile.name]
 
196
                                    + self.gnupgargs,
 
197
                                    stdin = subprocess.PIPE,
 
198
                                    stdout = subprocess.PIPE,
 
199
                                    stderr = subprocess.PIPE)
 
200
            ciphertext, err = proc.communicate(input = data)
 
201
        if proc.returncode != 0:
 
202
            raise PGPError(err)
 
203
        return ciphertext
 
204
    
 
205
    def decrypt(self, data, password):
 
206
        passphrase = self.password_encode(password)
 
207
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
208
                                         ) as passfile:
 
209
            passfile.write(passphrase)
 
210
            passfile.flush()
 
211
            proc = subprocess.Popen(['gpg', '--decrypt',
 
212
                                     '--passphrase-file',
 
213
                                     passfile.name]
 
214
                                    + self.gnupgargs,
 
215
                                    stdin = subprocess.PIPE,
 
216
                                    stdout = subprocess.PIPE,
 
217
                                    stderr = subprocess.PIPE)
 
218
            decrypted_plaintext, err = proc.communicate(input
 
219
                                                        = data)
 
220
        if proc.returncode != 0:
 
221
            raise PGPError(err)
 
222
        return decrypted_plaintext
 
223
 
103
224
 
104
225
class AvahiError(Exception):
105
226
    def __init__(self, value, *args, **kwargs):
106
227
        self.value = value
107
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
108
 
    def __unicode__(self):
109
 
        return unicode(repr(self.value))
 
228
        return super(AvahiError, self).__init__(value, *args,
 
229
                                                **kwargs)
110
230
 
111
231
class AvahiServiceError(AvahiError):
112
232
    pass
123
243
               Used to optionally bind to the specified interface.
124
244
    name: string; Example: 'Mandos'
125
245
    type: string; Example: '_mandos._tcp'.
126
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
246
     See <https://www.iana.org/assignments/service-names-port-numbers>
127
247
    port: integer; what port to announce
128
248
    TXT: list of strings; TXT record for the service
129
249
    domain: string; Domain to publish on, default to .local if empty.
135
255
    server: D-Bus Server
136
256
    bus: dbus.SystemBus()
137
257
    """
 
258
    
138
259
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
139
260
                 servicetype = None, port = None, TXT = None,
140
261
                 domain = "", host = "", max_renames = 32768,
153
274
        self.server = None
154
275
        self.bus = bus
155
276
        self.entry_group_state_changed_match = None
156
 
    def rename(self):
 
277
    
 
278
    def rename(self, remove=True):
157
279
        """Derived from the Avahi example code"""
158
280
        if self.rename_count >= self.max_renames:
159
281
            logger.critical("No suitable Zeroconf service name found"
160
282
                            " after %i retries, exiting.",
161
283
                            self.rename_count)
162
284
            raise AvahiServiceError("Too many renames")
163
 
        self.name = unicode(self.server
164
 
                            .GetAlternativeServiceName(self.name))
 
285
        self.name = str(self.server
 
286
                        .GetAlternativeServiceName(self.name))
 
287
        self.rename_count += 1
165
288
        logger.info("Changing Zeroconf service name to %r ...",
166
289
                    self.name)
167
 
        syslogger.setFormatter(logging.Formatter
168
 
                               ('Mandos (%s) [%%(process)d]:'
169
 
                                ' %%(levelname)s: %%(message)s'
170
 
                                % self.name))
171
 
        self.remove()
 
290
        if remove:
 
291
            self.remove()
172
292
        try:
173
293
            self.add()
174
294
        except dbus.exceptions.DBusException as error:
175
 
            logger.critical("DBusException: %s", error)
176
 
            self.cleanup()
177
 
            os._exit(1)
178
 
        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
    
179
304
    def remove(self):
180
305
        """Derived from the Avahi example code"""
181
306
        if self.entry_group_state_changed_match is not None:
183
308
            self.entry_group_state_changed_match = None
184
309
        if self.group is not None:
185
310
            self.group.Reset()
 
311
    
186
312
    def add(self):
187
313
        """Derived from the Avahi example code"""
188
314
        self.remove()
193
319
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
194
320
        self.entry_group_state_changed_match = (
195
321
            self.group.connect_to_signal(
196
 
                'StateChanged', self .entry_group_state_changed))
 
322
                'StateChanged', self.entry_group_state_changed))
197
323
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
198
324
                     self.name, self.type)
199
325
        self.group.AddService(
205
331
            dbus.UInt16(self.port),
206
332
            avahi.string_array_to_txt_array(self.TXT))
207
333
        self.group.Commit()
 
334
    
208
335
    def entry_group_state_changed(self, state, error):
209
336
        """Derived from the Avahi example code"""
210
337
        logger.debug("Avahi entry group state change: %i", state)
216
343
            self.rename()
217
344
        elif state == avahi.ENTRY_GROUP_FAILURE:
218
345
            logger.critical("Avahi: Error in group state changed %s",
219
 
                            unicode(error))
220
 
            raise AvahiGroupError("State changed: %s"
221
 
                                  % unicode(error))
 
346
                            str(error))
 
347
            raise AvahiGroupError("State changed: {!s}"
 
348
                                  .format(error))
 
349
    
222
350
    def cleanup(self):
223
351
        """Derived from the Avahi example code"""
224
352
        if self.group is not None:
225
353
            try:
226
354
                self.group.Free()
227
355
            except (dbus.exceptions.UnknownMethodException,
228
 
                    dbus.exceptions.DBusException) as e:
 
356
                    dbus.exceptions.DBusException):
229
357
                pass
230
358
            self.group = None
231
359
        self.remove()
 
360
    
232
361
    def server_state_changed(self, state, error=None):
233
362
        """Derived from the Avahi example code"""
234
363
        logger.debug("Avahi server state change: %i", state)
253
382
                logger.debug("Unknown state: %r", state)
254
383
            else:
255
384
                logger.debug("Unknown state: %r: %r", state, error)
 
385
    
256
386
    def activate(self):
257
387
        """Derived from the Avahi example code"""
258
388
        if self.server is None:
266
396
        self.server_state_changed(self.server.GetState())
267
397
 
268
398
 
269
 
def _timedelta_to_milliseconds(td):
270
 
    "Convert a datetime.timedelta() to milliseconds"
271
 
    return ((td.days * 24 * 60 * 60 * 1000)
272
 
            + (td.seconds * 1000)
273
 
            + (td.microseconds // 1000))
274
 
        
 
399
class AvahiServiceToSyslog(AvahiService):
 
400
    def rename(self, *args, **kwargs):
 
401
        """Add the new name to the syslog messages"""
 
402
        ret = AvahiService.rename(self, *args, **kwargs)
 
403
        syslogger.setFormatter(logging.Formatter
 
404
                               ('Mandos ({}) [%(process)d]:'
 
405
                                ' %(levelname)s: %(message)s'
 
406
                                .format(self.name)))
 
407
        return ret
 
408
 
 
409
 
275
410
class Client(object):
276
411
    """A representation of a client host served by this server.
277
412
    
278
413
    Attributes:
279
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
414
    approved:   bool(); 'None' if not yet approved/disapproved
280
415
    approval_delay: datetime.timedelta(); Time to wait for approval
281
416
    approval_duration: datetime.timedelta(); Duration of one approval
282
417
    checker:    subprocess.Popen(); a running checker process used
289
424
                     instance %(name)s can be used in the command.
290
425
    checker_initiator_tag: a gobject event source tag, or None
291
426
    created:    datetime.datetime(); (UTC) object creation
 
427
    client_structure: Object describing what attributes a client has
 
428
                      and is used for storing the client at exit
292
429
    current_checker_command: string; current running checker_command
293
 
    disable_hook:  If set, called by disable() as disable_hook(self)
294
430
    disable_initiator_tag: a gobject event source tag, or None
295
431
    enabled:    bool()
296
432
    fingerprint: string (40 or 32 hexadecimal digits); used to
299
435
    interval:   datetime.timedelta(); How often to start a new checker
300
436
    last_approval_request: datetime.datetime(); (UTC) or None
301
437
    last_checked_ok: datetime.datetime(); (UTC) or None
302
 
    last_enabled: datetime.datetime(); (UTC)
 
438
    last_checker_status: integer between 0 and 255 reflecting exit
 
439
                         status of last checker. -1 reflects crashed
 
440
                         checker, -2 means no checker completed yet.
 
441
    last_enabled: datetime.datetime(); (UTC) or None
303
442
    name:       string; from the config file, used in log messages and
304
443
                        D-Bus identifiers
305
444
    secret:     bytestring; sent verbatim (over TLS) to client
306
445
    timeout:    datetime.timedelta(); How long from last_checked_ok
307
446
                                      until this client is disabled
308
 
    extended_timeout:   extra long timeout when password has been sent
 
447
    extended_timeout:   extra long timeout when secret has been sent
309
448
    runtime_expansions: Allowed attributes for runtime expansion.
310
449
    expires:    datetime.datetime(); time (UTC) when a client will be
311
450
                disabled, or None
 
451
    server_settings: The server_settings dict from main()
312
452
    """
313
453
    
314
454
    runtime_expansions = ("approval_delay", "approval_duration",
315
 
                          "created", "enabled", "fingerprint",
316
 
                          "host", "interval", "last_checked_ok",
 
455
                          "created", "enabled", "expires",
 
456
                          "fingerprint", "host", "interval",
 
457
                          "last_approval_request", "last_checked_ok",
317
458
                          "last_enabled", "name", "timeout")
318
 
    
319
 
    def timeout_milliseconds(self):
320
 
        "Return the 'timeout' attribute in milliseconds"
321
 
        return _timedelta_to_milliseconds(self.timeout)
322
 
    
323
 
    def extended_timeout_milliseconds(self):
324
 
        "Return the 'extended_timeout' attribute in milliseconds"
325
 
        return _timedelta_to_milliseconds(self.extended_timeout)
326
 
    
327
 
    def interval_milliseconds(self):
328
 
        "Return the 'interval' attribute in milliseconds"
329
 
        return _timedelta_to_milliseconds(self.interval)
330
 
    
331
 
    def approval_delay_milliseconds(self):
332
 
        return _timedelta_to_milliseconds(self.approval_delay)
333
 
    
334
 
    def __init__(self, name = None, disable_hook=None, config=None):
335
 
        """Note: the 'checker' key in 'config' sets the
336
 
        'checker_command' attribute and *not* the 'checker'
337
 
        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):
338
518
        self.name = name
339
 
        if config is None:
340
 
            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
        
341
536
        logger.debug("Creating client %r", self.name)
342
537
        # Uppercase and remove spaces from fingerprint for later
343
538
        # comparison purposes with return value from the fingerprint()
344
539
        # function
345
 
        self.fingerprint = (config["fingerprint"].upper()
346
 
                            .replace(" ", ""))
347
540
        logger.debug("  Fingerprint: %s", self.fingerprint)
348
 
        if "secret" in config:
349
 
            self.secret = config["secret"].decode("base64")
350
 
        elif "secfile" in config:
351
 
            with open(os.path.expanduser(os.path.expandvars
352
 
                                         (config["secfile"])),
353
 
                      "rb") as secfile:
354
 
                self.secret = secfile.read()
355
 
        else:
356
 
            raise TypeError("No secret or secfile for client %s"
357
 
                            % self.name)
358
 
        self.host = config.get("host", "")
359
 
        self.created = datetime.datetime.utcnow()
360
 
        self.enabled = False
361
 
        self.last_approval_request = None
362
 
        self.last_enabled = None
363
 
        self.last_checked_ok = None
364
 
        self.timeout = string_to_delta(config["timeout"])
365
 
        self.extended_timeout = string_to_delta(config
366
 
                                                ["extended_timeout"])
367
 
        self.interval = string_to_delta(config["interval"])
368
 
        self.disable_hook = disable_hook
 
541
        self.created = settings.get("created",
 
542
                                    datetime.datetime.utcnow())
 
543
        
 
544
        # attributes specific for this server instance
369
545
        self.checker = None
370
546
        self.checker_initiator_tag = None
371
547
        self.disable_initiator_tag = None
372
 
        self.expires = None
373
548
        self.checker_callback_tag = None
374
 
        self.checker_command = config["checker"]
375
549
        self.current_checker_command = None
376
 
        self.last_connect = None
377
 
        self._approved = None
378
 
        self.approved_by_default = config.get("approved_by_default",
379
 
                                              True)
 
550
        self.approved = None
380
551
        self.approvals_pending = 0
381
 
        self.approval_delay = string_to_delta(
382
 
            config["approval_delay"])
383
 
        self.approval_duration = string_to_delta(
384
 
            config["approval_duration"])
385
552
        self.changedstate = (multiprocessing_manager
386
553
                             .Condition(multiprocessing_manager
387
554
                                        .Lock()))
 
555
        self.client_structure = [attr for attr in
 
556
                                 self.__dict__.iterkeys()
 
557
                                 if not attr.startswith("_")]
 
558
        self.client_structure.append("client_structure")
 
559
        
 
560
        for name, t in inspect.getmembers(type(self),
 
561
                                          lambda obj:
 
562
                                              isinstance(obj,
 
563
                                                         property)):
 
564
            if not name.startswith("_"):
 
565
                self.client_structure.append(name)
388
566
    
 
567
    # Send notice to process children that client state has changed
389
568
    def send_changedstate(self):
390
 
        self.changedstate.acquire()
391
 
        self.changedstate.notify_all()
392
 
        self.changedstate.release()
 
569
        with self.changedstate:
 
570
            self.changedstate.notify_all()
393
571
    
394
572
    def enable(self):
395
573
        """Start this client's checker and timeout hooks"""
396
574
        if getattr(self, "enabled", False):
397
575
            # Already enabled
398
576
            return
399
 
        self.send_changedstate()
400
 
        # Schedule a new checker to be started an 'interval' from now,
401
 
        # and every interval from then on.
402
 
        self.checker_initiator_tag = (gobject.timeout_add
403
 
                                      (self.interval_milliseconds(),
404
 
                                       self.start_checker))
405
 
        # Schedule a disable() when 'timeout' has passed
406
577
        self.expires = datetime.datetime.utcnow() + self.timeout
407
 
        self.disable_initiator_tag = (gobject.timeout_add
408
 
                                   (self.timeout_milliseconds(),
409
 
                                    self.disable))
410
578
        self.enabled = True
411
579
        self.last_enabled = datetime.datetime.utcnow()
412
 
        # Also start a new checker *right now*.
413
 
        self.start_checker()
 
580
        self.init_checker()
 
581
        self.send_changedstate()
414
582
    
415
583
    def disable(self, quiet=True):
416
584
        """Disable this client."""
417
585
        if not getattr(self, "enabled", False):
418
586
            return False
419
587
        if not quiet:
420
 
            self.send_changedstate()
421
 
        if not quiet:
422
588
            logger.info("Disabling client %s", self.name)
423
 
        if getattr(self, "disable_initiator_tag", False):
 
589
        if getattr(self, "disable_initiator_tag", None) is not None:
424
590
            gobject.source_remove(self.disable_initiator_tag)
425
591
            self.disable_initiator_tag = None
426
592
        self.expires = None
427
 
        if getattr(self, "checker_initiator_tag", False):
 
593
        if getattr(self, "checker_initiator_tag", None) is not None:
428
594
            gobject.source_remove(self.checker_initiator_tag)
429
595
            self.checker_initiator_tag = None
430
596
        self.stop_checker()
431
 
        if self.disable_hook:
432
 
            self.disable_hook(self)
433
597
        self.enabled = False
 
598
        if not quiet:
 
599
            self.send_changedstate()
434
600
        # Do not run this again if called by a gobject.timeout_add
435
601
        return False
436
602
    
437
603
    def __del__(self):
438
 
        self.disable_hook = None
439
604
        self.disable()
440
605
    
 
606
    def init_checker(self):
 
607
        # Schedule a new checker to be started an 'interval' from now,
 
608
        # and every interval from then on.
 
609
        if self.checker_initiator_tag is not None:
 
610
            gobject.source_remove(self.checker_initiator_tag)
 
611
        self.checker_initiator_tag = (gobject.timeout_add
 
612
                                      (int(self.interval
 
613
                                           .total_seconds() * 1000),
 
614
                                       self.start_checker))
 
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)
 
618
        self.disable_initiator_tag = (gobject.timeout_add
 
619
                                      (int(self.timeout
 
620
                                           .total_seconds() * 1000),
 
621
                                       self.disable))
 
622
        # Also start a new checker *right now*.
 
623
        self.start_checker()
 
624
    
441
625
    def checker_callback(self, pid, condition, command):
442
626
        """The checker has completed, so take appropriate actions."""
443
627
        self.checker_callback_tag = None
444
628
        self.checker = None
445
629
        if os.WIFEXITED(condition):
446
 
            exitstatus = os.WEXITSTATUS(condition)
447
 
            if exitstatus == 0:
 
630
            self.last_checker_status = os.WEXITSTATUS(condition)
 
631
            if self.last_checker_status == 0:
448
632
                logger.info("Checker for %(name)s succeeded",
449
633
                            vars(self))
450
634
                self.checked_ok()
452
636
                logger.info("Checker for %(name)s failed",
453
637
                            vars(self))
454
638
        else:
 
639
            self.last_checker_status = -1
455
640
            logger.warning("Checker for %(name)s crashed?",
456
641
                           vars(self))
457
642
    
458
 
    def checked_ok(self, timeout=None):
459
 
        """Bump up the timeout for this client.
460
 
        
461
 
        This should only be called when the client has been seen,
462
 
        alive and well.
463
 
        """
 
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."""
464
651
        if timeout is None:
465
652
            timeout = self.timeout
466
 
        self.last_checked_ok = datetime.datetime.utcnow()
467
653
        if self.disable_initiator_tag is not None:
468
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
            self.disable_initiator_tag = None
469
656
        if getattr(self, "enabled", False):
470
657
            self.disable_initiator_tag = (gobject.timeout_add
471
 
                                          (_timedelta_to_milliseconds
472
 
                                           (timeout), self.disable))
 
658
                                          (int(timeout.total_seconds()
 
659
                                               * 1000), self.disable))
473
660
            self.expires = datetime.datetime.utcnow() + timeout
474
661
    
475
662
    def need_approval(self):
481
668
        If a checker already exists, leave it running and do
482
669
        nothing."""
483
670
        # The reason for not killing a running checker is that if we
484
 
        # did that, then if a checker (for some reason) started
485
 
        # running slowly and taking more than 'interval' time, the
486
 
        # client would inevitably timeout, since no checker would get
487
 
        # 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
488
675
        # checkers alone, the checker would have to take more time
489
676
        # than 'timeout' for the client to be disabled, which is as it
490
677
        # should be.
492
679
        # If a checker exists, make sure it is not a zombie
493
680
        try:
494
681
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
495
 
        except (AttributeError, OSError) as error:
496
 
            if (isinstance(error, OSError)
497
 
                and error.errno != errno.ECHILD):
498
 
                raise error
 
682
        except AttributeError:
 
683
            pass
 
684
        except OSError as error:
 
685
            if error.errno != errno.ECHILD:
 
686
                raise
499
687
        else:
500
688
            if pid:
501
689
                logger.warning("Checker was a zombie")
504
692
                                      self.current_checker_command)
505
693
        # Start a new checker if needed
506
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 }
507
699
            try:
508
 
                # In case checker_command has exactly one % operator
509
 
                command = self.checker_command % self.host
510
 
            except TypeError:
511
 
                # Escape attributes for the shell
512
 
                escaped_attrs = dict(
513
 
                    (attr,
514
 
                     re.escape(unicode(str(getattr(self, attr, "")),
515
 
                                       errors=
516
 
                                       'replace')))
517
 
                    for attr in
518
 
                    self.runtime_expansions)
519
 
                
520
 
                try:
521
 
                    command = self.checker_command % escaped_attrs
522
 
                except TypeError as error:
523
 
                    logger.error('Could not format string "%s":'
524
 
                                 ' %s', self.checker_command, error)
525
 
                    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
526
705
            self.current_checker_command = command
527
706
            try:
528
707
                logger.info("Starting checker %r for %s",
531
710
                # in normal mode, that is already done by daemon(),
532
711
                # and in debug mode we don't want to.  (Stdin is
533
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 })
534
721
                self.checker = subprocess.Popen(command,
535
722
                                                close_fds=True,
536
 
                                                shell=True, cwd="/")
537
 
                self.checker_callback_tag = (gobject.child_watch_add
538
 
                                             (self.checker.pid,
539
 
                                              self.checker_callback,
540
 
                                              data=command))
541
 
                # The checker may have completed before the gobject
542
 
                # 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:
543
736
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
544
 
                if pid:
545
 
                    gobject.source_remove(self.checker_callback_tag)
546
 
                    self.checker_callback(pid, status, command)
547
737
            except OSError as error:
548
 
                logger.error("Failed to start subprocess: %s",
549
 
                             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)
550
747
        # Re-run this periodically if run by gobject.timeout_add
551
748
        return True
552
749
    
559
756
            return
560
757
        logger.debug("Stopping checker for %(name)s", vars(self))
561
758
        try:
562
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
759
            self.checker.terminate()
563
760
            #time.sleep(0.5)
564
761
            #if self.checker.poll() is None:
565
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
762
            #    self.checker.kill()
566
763
        except OSError as error:
567
764
            if error.errno != errno.ESRCH: # No such process
568
765
                raise
585
782
    # "Set" method, so we fail early here:
586
783
    if byte_arrays and signature != "ay":
587
784
        raise ValueError("Byte arrays not supported for non-'ay'"
588
 
                         " signature %r" % signature)
 
785
                         " signature {!r}".format(signature))
589
786
    def decorator(func):
590
787
        func._dbus_is_property = True
591
788
        func._dbus_interface = dbus_interface
599
796
    return decorator
600
797
 
601
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
 
602
836
class DBusPropertyException(dbus.exceptions.DBusException):
603
837
    """A base class for D-Bus property-related exceptions
604
838
    """
605
 
    def __unicode__(self):
606
 
        return unicode(str(self))
607
 
 
 
839
    pass
608
840
 
609
841
class DBusPropertyAccessException(DBusPropertyException):
610
842
    """A property's access permissions disallows an operation.
627
859
    """
628
860
    
629
861
    @staticmethod
630
 
    def _is_dbus_property(obj):
631
 
        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)
632
870
    
633
 
    def _get_all_dbus_properties(self):
 
871
    def _get_all_dbus_things(self, thing):
634
872
        """Returns a generator of (name, attribute) pairs
635
873
        """
636
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
874
        return ((getattr(athing.__get__(self), "_dbus_name",
 
875
                         name),
 
876
                 athing.__get__(self))
637
877
                for cls in self.__class__.__mro__
638
 
                for name, prop in
639
 
                inspect.getmembers(cls, self._is_dbus_property))
 
878
                for name, athing in
 
879
                inspect.getmembers(cls,
 
880
                                   self._is_dbus_thing(thing)))
640
881
    
641
882
    def _get_dbus_property(self, interface_name, property_name):
642
883
        """Returns a bound method if one exists which is a D-Bus
644
885
        """
645
886
        for cls in  self.__class__.__mro__:
646
887
            for name, value in (inspect.getmembers
647
 
                                (cls, self._is_dbus_property)):
 
888
                                (cls,
 
889
                                 self._is_dbus_thing("property"))):
648
890
                if (value._dbus_name == property_name
649
891
                    and value._dbus_interface == interface_name):
650
892
                    return value.__get__(self)
678
920
            # The byte_arrays option is not supported yet on
679
921
            # signatures other than "ay".
680
922
            if prop._dbus_signature != "ay":
681
 
                raise ValueError
682
 
            value = dbus.ByteArray(''.join(unichr(byte)
683
 
                                           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))
684
928
        prop(value)
685
929
    
686
930
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
691
935
        
692
936
        Note: Will not include properties with access="write".
693
937
        """
694
 
        all = {}
695
 
        for name, prop in self._get_all_dbus_properties():
 
938
        properties = {}
 
939
        for name, prop in self._get_all_dbus_things("property"):
696
940
            if (interface_name
697
941
                and interface_name != prop._dbus_interface):
698
942
                # Interface non-empty but did not match
702
946
                continue
703
947
            value = prop()
704
948
            if not hasattr(value, "variant_level"):
705
 
                all[name] = value
 
949
                properties[name] = value
706
950
                continue
707
 
            all[name] = type(value)(value, variant_level=
708
 
                                    value.variant_level+1)
709
 
        return dbus.Dictionary(all, signature="sv")
 
951
            properties[name] = type(value)(value, variant_level=
 
952
                                           value.variant_level+1)
 
953
        return dbus.Dictionary(properties, signature="sv")
 
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
710
962
    
711
963
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
712
964
                         out_signature="s",
713
965
                         path_keyword='object_path',
714
966
                         connection_keyword='connection')
715
967
    def Introspect(self, object_path, connection):
716
 
        """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.
717
971
        """
718
972
        xmlstring = dbus.service.Object.Introspect(self, object_path,
719
973
                                                   connection)
726
980
                e.setAttribute("access", prop._dbus_access)
727
981
                return e
728
982
            for if_tag in document.getElementsByTagName("interface"):
 
983
                # Add property tags
729
984
                for tag in (make_tag(document, name, prop)
730
985
                            for name, prop
731
 
                            in self._get_all_dbus_properties()
 
986
                            in self._get_all_dbus_things("property")
732
987
                            if prop._dbus_interface
733
988
                            == if_tag.getAttribute("name")):
734
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)
735
1021
                # Add the names to the return values for the
736
1022
                # "org.freedesktop.DBus.Properties" methods
737
1023
                if (if_tag.getAttribute("name")
752
1038
        except (AttributeError, xml.dom.DOMException,
753
1039
                xml.parsers.expat.ExpatError) as error:
754
1040
            logger.error("Failed to override Introspection method",
755
 
                         error)
 
1041
                         exc_info=error)
756
1042
        return xmlstring
757
1043
 
758
1044
 
759
 
def datetime_to_dbus (dt, variant_level=0):
 
1045
def datetime_to_dbus(dt, variant_level=0):
760
1046
    """Convert a UTC datetime.datetime() to a D-Bus type."""
761
1047
    if dt is None:
762
1048
        return dbus.String("", variant_level = variant_level)
763
1049
    return dbus.String(dt.isoformat(),
764
1050
                       variant_level=variant_level)
765
1051
 
766
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
767
 
                                  .__metaclass__):
768
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
769
 
    will add additional D-Bus attributes matching a certain pattern.
 
1052
 
 
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).
770
1075
    """
771
 
    def __new__(mcs, name, bases, attr):
772
 
        # Go through all the base classes which could have D-Bus
773
 
        # methods, signals, or properties in them
774
 
        for base in (b for b in bases
775
 
                     if issubclass(b, dbus.service.Object)):
776
 
            # Go though all attributes of the base class
777
 
            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):
778
1083
                # Ignore non-D-Bus attributes, and D-Bus attributes
779
1084
                # with the wrong interface name
780
1085
                if (not hasattr(attribute, "_dbus_interface")
781
1086
                    or not attribute._dbus_interface
782
 
                    .startswith("se.recompile.Mandos")):
 
1087
                    .startswith(orig_interface_name)):
783
1088
                    continue
784
1089
                # Create an alternate D-Bus interface name based on
785
1090
                # the current name
786
1091
                alt_interface = (attribute._dbus_interface
787
 
                                 .replace("se.recompile.Mandos",
788
 
                                          "se.bsnet.fukt.Mandos"))
 
1092
                                 .replace(orig_interface_name,
 
1093
                                          alt_interface_name))
 
1094
                interface_names.add(alt_interface)
789
1095
                # Is this a D-Bus signal?
790
1096
                if getattr(attribute, "_dbus_is_signal", False):
791
 
                    # Extract the original non-method function by
792
 
                    # black magic
 
1097
                    # Extract the original non-method undecorated
 
1098
                    # function by black magic
793
1099
                    nonmethod_func = (dict(
794
1100
                            zip(attribute.func_code.co_freevars,
795
1101
                                attribute.__closure__))["func"]
806
1112
                                nonmethod_func.func_name,
807
1113
                                nonmethod_func.func_defaults,
808
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
809
1121
                    # Define a creator of a function to call both the
810
 
                    # old and new functions, so both the old and new
811
 
                    # 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
812
1125
                    def fixscope(func1, func2):
813
1126
                        """This function is a scope container to pass
814
1127
                        func1 and func2 to the "call_both" function
821
1134
                        return call_both
822
1135
                    # Create the "call_both" function and add it to
823
1136
                    # the class
824
 
                    attr[attrname] = fixscope(attribute,
825
 
                                              new_function)
 
1137
                    attr[attrname] = fixscope(attribute, new_function)
826
1138
                # Is this a D-Bus method?
827
1139
                elif getattr(attribute, "_dbus_is_method", False):
828
1140
                    # Create a new, but exactly alike, function
839
1151
                                        attribute.func_name,
840
1152
                                        attribute.func_defaults,
841
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
842
1160
                # Is this a D-Bus property?
843
1161
                elif getattr(attribute, "_dbus_is_property", False):
844
1162
                    # Create a new, but exactly alike, function
858
1176
                                        attribute.func_name,
859
1177
                                        attribute.func_defaults,
860
1178
                                        attribute.func_closure)))
861
 
        return type.__new__(mcs, name, bases, attr)
862
 
 
 
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"})
863
1224
class ClientDBus(Client, DBusObjectWithProperties):
864
1225
    """A Client class using D-Bus
865
1226
    
871
1232
    runtime_expansions = (Client.runtime_expansions
872
1233
                          + ("dbus_object_path",))
873
1234
    
 
1235
    _interface = "se.recompile.Mandos.Client"
 
1236
    
874
1237
    # dbus.service.Object doesn't use super(), so we can't either.
875
1238
    
876
1239
    def __init__(self, bus = None, *args, **kwargs):
877
 
        self._approvals_pending = 0
878
1240
        self.bus = bus
879
1241
        Client.__init__(self, *args, **kwargs)
880
1242
        # Only now, when this client is initialized, can it show up on
881
1243
        # the D-Bus
882
 
        client_object_name = unicode(self.name).translate(
 
1244
        client_object_name = str(self.name).translate(
883
1245
            {ord("."): ord("_"),
884
1246
             ord("-"): ord("_")})
885
1247
        self.dbus_object_path = (dbus.ObjectPath
886
1248
                                 ("/clients/" + client_object_name))
887
1249
        DBusObjectWithProperties.__init__(self, self.bus,
888
1250
                                          self.dbus_object_path)
889
 
        
 
1251
    
890
1252
    def notifychangeproperty(transform_func,
891
1253
                             dbus_name, type_func=lambda x: x,
892
 
                             variant_level=1):
 
1254
                             variant_level=1, invalidate_only=False,
 
1255
                             _interface=_interface):
893
1256
        """ Modify a variable so that it's a property which announces
894
1257
        its changes to DBus.
895
 
 
 
1258
        
896
1259
        transform_fun: Function that takes a value and a variant_level
897
1260
                       and transforms it to a D-Bus type.
898
1261
        dbus_name: D-Bus name of the variable
900
1263
                   to the D-Bus.  Default: no transform
901
1264
        variant_level: D-Bus variant level.  Default: 1
902
1265
        """
903
 
        attrname = "_{0}".format(dbus_name)
 
1266
        attrname = "_{}".format(dbus_name)
904
1267
        def setter(self, value):
905
1268
            if hasattr(self, "dbus_object_path"):
906
1269
                if (not hasattr(self, attrname) or
907
1270
                    type_func(getattr(self, attrname, None))
908
1271
                    != type_func(value)):
909
 
                    dbus_value = transform_func(type_func(value),
910
 
                                                variant_level
911
 
                                                =variant_level)
912
 
                    self.PropertyChanged(dbus.String(dbus_name),
913
 
                                         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())
914
1287
            setattr(self, attrname, value)
915
1288
        
916
1289
        return property(lambda self: getattr(self, attrname), setter)
917
1290
    
918
 
    
919
1291
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
920
1292
    approvals_pending = notifychangeproperty(dbus.Boolean,
921
1293
                                             "ApprovalPending",
928
1300
                                       checker is not None)
929
1301
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
930
1302
                                           "LastCheckedOK")
 
1303
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1304
                                               "LastCheckerStatus")
931
1305
    last_approval_request = notifychangeproperty(
932
1306
        datetime_to_dbus, "LastApprovalRequest")
933
1307
    approved_by_default = notifychangeproperty(dbus.Boolean,
934
1308
                                               "ApprovedByDefault")
935
 
    approval_delay = notifychangeproperty(dbus.UInt16,
 
1309
    approval_delay = notifychangeproperty(dbus.UInt64,
936
1310
                                          "ApprovalDelay",
937
1311
                                          type_func =
938
 
                                          _timedelta_to_milliseconds)
 
1312
                                          lambda td: td.total_seconds()
 
1313
                                          * 1000)
939
1314
    approval_duration = notifychangeproperty(
940
 
        dbus.UInt16, "ApprovalDuration",
941
 
        type_func = _timedelta_to_milliseconds)
 
1315
        dbus.UInt64, "ApprovalDuration",
 
1316
        type_func = lambda td: td.total_seconds() * 1000)
942
1317
    host = notifychangeproperty(dbus.String, "Host")
943
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
944
 
                                   type_func =
945
 
                                   _timedelta_to_milliseconds)
 
1318
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1319
                                   type_func = lambda td:
 
1320
                                       td.total_seconds() * 1000)
946
1321
    extended_timeout = notifychangeproperty(
947
 
        dbus.UInt16, "ExtendedTimeout",
948
 
        type_func = _timedelta_to_milliseconds)
949
 
    interval = notifychangeproperty(dbus.UInt16,
 
1322
        dbus.UInt64, "ExtendedTimeout",
 
1323
        type_func = lambda td: td.total_seconds() * 1000)
 
1324
    interval = notifychangeproperty(dbus.UInt64,
950
1325
                                    "Interval",
951
1326
                                    type_func =
952
 
                                    _timedelta_to_milliseconds)
 
1327
                                    lambda td: td.total_seconds()
 
1328
                                    * 1000)
953
1329
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1330
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1331
                                  invalidate_only=True)
954
1332
    
955
1333
    del notifychangeproperty
956
1334
    
983
1361
                                       *args, **kwargs)
984
1362
    
985
1363
    def start_checker(self, *args, **kwargs):
986
 
        old_checker = self.checker
987
 
        if self.checker is not None:
988
 
            old_checker_pid = self.checker.pid
989
 
        else:
990
 
            old_checker_pid = None
 
1364
        old_checker_pid = getattr(self.checker, "pid", None)
991
1365
        r = Client.start_checker(self, *args, **kwargs)
992
1366
        # Only if new checker process was started
993
1367
        if (self.checker is not None
997
1371
        return r
998
1372
    
999
1373
    def _reset_approved(self):
1000
 
        self._approved = None
 
1374
        self.approved = None
1001
1375
        return False
1002
1376
    
1003
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)
1004
1381
        self.send_changedstate()
1005
 
        self._approved = value
1006
 
        gobject.timeout_add(_timedelta_to_milliseconds
1007
 
                            (self.approval_duration),
1008
 
                            self._reset_approved)
1009
 
    
1010
1382
    
1011
1383
    ## D-Bus methods, signals & properties
1012
 
    _interface = "se.recompile.Mandos.Client"
 
1384
    
 
1385
    ## Interfaces
1013
1386
    
1014
1387
    ## Signals
1015
1388
    
1026
1399
        pass
1027
1400
    
1028
1401
    # PropertyChanged - signal
 
1402
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1029
1403
    @dbus.service.signal(_interface, signature="sv")
1030
1404
    def PropertyChanged(self, property, value):
1031
1405
        "D-Bus signal"
1107
1481
                           access="readwrite")
1108
1482
    def ApprovalDelay_dbus_property(self, value=None):
1109
1483
        if value is None:       # get
1110
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1484
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1485
                               * 1000)
1111
1486
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1112
1487
    
1113
1488
    # ApprovalDuration - property
1115
1490
                           access="readwrite")
1116
1491
    def ApprovalDuration_dbus_property(self, value=None):
1117
1492
        if value is None:       # get
1118
 
            return dbus.UInt64(_timedelta_to_milliseconds(
1119
 
                    self.approval_duration))
 
1493
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1494
                               * 1000)
1120
1495
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1121
1496
    
1122
1497
    # Name - property
1135
1510
    def Host_dbus_property(self, value=None):
1136
1511
        if value is None:       # get
1137
1512
            return dbus.String(self.host)
1138
 
        self.host = value
 
1513
        self.host = str(value)
1139
1514
    
1140
1515
    # Created - property
1141
1516
    @dbus_service_property(_interface, signature="s", access="read")
1142
1517
    def Created_dbus_property(self):
1143
 
        return dbus.String(datetime_to_dbus(self.created))
 
1518
        return datetime_to_dbus(self.created)
1144
1519
    
1145
1520
    # LastEnabled - property
1146
1521
    @dbus_service_property(_interface, signature="s", access="read")
1167
1542
            return
1168
1543
        return datetime_to_dbus(self.last_checked_ok)
1169
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
    
1170
1551
    # Expires - property
1171
1552
    @dbus_service_property(_interface, signature="s", access="read")
1172
1553
    def Expires_dbus_property(self):
1182
1563
                           access="readwrite")
1183
1564
    def Timeout_dbus_property(self, value=None):
1184
1565
        if value is None:       # get
1185
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1566
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1567
        old_timeout = self.timeout
1186
1568
        self.timeout = datetime.timedelta(0, 0, 0, value)
1187
 
        if getattr(self, "disable_initiator_tag", None) is None:
1188
 
            return
1189
 
        # Reschedule timeout
1190
 
        gobject.source_remove(self.disable_initiator_tag)
1191
 
        self.disable_initiator_tag = None
1192
 
        self.expires = None
1193
 
        time_to_die = _timedelta_to_milliseconds((self
1194
 
                                                  .last_checked_ok
1195
 
                                                  + self.timeout)
1196
 
                                                 - datetime.datetime
1197
 
                                                 .utcnow())
1198
 
        if time_to_die <= 0:
1199
 
            # The timeout has passed
1200
 
            self.disable()
1201
 
        else:
1202
 
            self.expires = (datetime.datetime.utcnow()
1203
 
                            + datetime.timedelta(milliseconds =
1204
 
                                                 time_to_die))
1205
 
            self.disable_initiator_tag = (gobject.timeout_add
1206
 
                                          (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))
1207
1585
    
1208
1586
    # ExtendedTimeout - property
1209
1587
    @dbus_service_property(_interface, signature="t",
1210
1588
                           access="readwrite")
1211
1589
    def ExtendedTimeout_dbus_property(self, value=None):
1212
1590
        if value is None:       # get
1213
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1591
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1592
                               * 1000)
1214
1593
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1215
1594
    
1216
1595
    # Interval - property
1218
1597
                           access="readwrite")
1219
1598
    def Interval_dbus_property(self, value=None):
1220
1599
        if value is None:       # get
1221
 
            return dbus.UInt64(self.interval_milliseconds())
 
1600
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1222
1601
        self.interval = datetime.timedelta(0, 0, 0, value)
1223
1602
        if getattr(self, "checker_initiator_tag", None) is None:
1224
1603
            return
1225
 
        # Reschedule checker run
1226
 
        gobject.source_remove(self.checker_initiator_tag)
1227
 
        self.checker_initiator_tag = (gobject.timeout_add
1228
 
                                      (value, self.start_checker))
1229
 
        self.start_checker()    # Start one now, too
 
1604
        if self.enabled:
 
1605
            # Reschedule checker run
 
1606
            gobject.source_remove(self.checker_initiator_tag)
 
1607
            self.checker_initiator_tag = (gobject.timeout_add
 
1608
                                          (value, self.start_checker))
 
1609
            self.start_checker()    # Start one now, too
1230
1610
    
1231
1611
    # Checker - property
1232
1612
    @dbus_service_property(_interface, signature="s",
1234
1614
    def Checker_dbus_property(self, value=None):
1235
1615
        if value is None:       # get
1236
1616
            return dbus.String(self.checker_command)
1237
 
        self.checker_command = value
 
1617
        self.checker_command = str(value)
1238
1618
    
1239
1619
    # CheckerRunning - property
1240
1620
    @dbus_service_property(_interface, signature="b",
1256
1636
    @dbus_service_property(_interface, signature="ay",
1257
1637
                           access="write", byte_arrays=True)
1258
1638
    def Secret_dbus_property(self, value):
1259
 
        self.secret = str(value)
 
1639
        self.secret = bytes(value)
1260
1640
    
1261
1641
    del _interface
1262
1642
 
1269
1649
            raise KeyError()
1270
1650
    
1271
1651
    def __getattribute__(self, name):
1272
 
        if(name == '_pipe'):
 
1652
        if name == '_pipe':
1273
1653
            return super(ProxyClient, self).__getattribute__(name)
1274
1654
        self._pipe.send(('getattr', name))
1275
1655
        data = self._pipe.recv()
1282
1662
            return func
1283
1663
    
1284
1664
    def __setattr__(self, name, value):
1285
 
        if(name == '_pipe'):
 
1665
        if name == '_pipe':
1286
1666
            return super(ProxyClient, self).__setattr__(name, value)
1287
1667
        self._pipe.send(('setattr', name, value))
1288
1668
 
1289
 
class ClientDBusTransitional(ClientDBus):
1290
 
    __metaclass__ = AlternateDBusNamesMetaclass
1291
1669
 
1292
1670
class ClientHandler(socketserver.BaseRequestHandler, object):
1293
1671
    """A class to handle client connections.
1298
1676
    def handle(self):
1299
1677
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1300
1678
            logger.info("TCP connection from: %s",
1301
 
                        unicode(self.client_address))
 
1679
                        str(self.client_address))
1302
1680
            logger.debug("Pipe FD: %d",
1303
1681
                         self.server.child_pipe.fileno())
1304
1682
            
1330
1708
            logger.debug("Protocol version: %r", line)
1331
1709
            try:
1332
1710
                if int(line.strip().split()[0]) > 1:
1333
 
                    raise RuntimeError
 
1711
                    raise RuntimeError(line)
1334
1712
            except (ValueError, IndexError, RuntimeError) as error:
1335
1713
                logger.error("Unknown protocol version: %s", error)
1336
1714
                return
1376
1754
                            client.Rejected("Disabled")
1377
1755
                        return
1378
1756
                    
1379
 
                    if client._approved or not client.approval_delay:
 
1757
                    if client.approved or not client.approval_delay:
1380
1758
                        #We are approved or approval is disabled
1381
1759
                        break
1382
 
                    elif client._approved is None:
 
1760
                    elif client.approved is None:
1383
1761
                        logger.info("Client %s needs approval",
1384
1762
                                    client.name)
1385
1763
                        if self.server.use_dbus:
1386
1764
                            # Emit D-Bus signal
1387
1765
                            client.NeedApproval(
1388
 
                                client.approval_delay_milliseconds(),
1389
 
                                client.approved_by_default)
 
1766
                                client.approval_delay.total_seconds()
 
1767
                                * 1000, client.approved_by_default)
1390
1768
                    else:
1391
1769
                        logger.warning("Client %s was not approved",
1392
1770
                                       client.name)
1398
1776
                    #wait until timeout or approved
1399
1777
                    time = datetime.datetime.now()
1400
1778
                    client.changedstate.acquire()
1401
 
                    (client.changedstate.wait
1402
 
                     (float(client._timedelta_to_milliseconds(delay)
1403
 
                            / 1000)))
 
1779
                    client.changedstate.wait(delay.total_seconds())
1404
1780
                    client.changedstate.release()
1405
1781
                    time2 = datetime.datetime.now()
1406
1782
                    if (time2 - time) >= delay:
1422
1798
                    try:
1423
1799
                        sent = session.send(client.secret[sent_size:])
1424
1800
                    except gnutls.errors.GNUTLSError as error:
1425
 
                        logger.warning("gnutls send failed")
 
1801
                        logger.warning("gnutls send failed",
 
1802
                                       exc_info=error)
1426
1803
                        return
1427
1804
                    logger.debug("Sent: %d, remaining: %d",
1428
1805
                                 sent, len(client.secret)
1431
1808
                
1432
1809
                logger.info("Sending secret to %s", client.name)
1433
1810
                # bump the timeout using extended_timeout
1434
 
                client.checked_ok(client.extended_timeout)
 
1811
                client.bump_timeout(client.extended_timeout)
1435
1812
                if self.server.use_dbus:
1436
1813
                    # Emit D-Bus signal
1437
1814
                    client.GotSecret()
1442
1819
                try:
1443
1820
                    session.bye()
1444
1821
                except gnutls.errors.GNUTLSError as error:
1445
 
                    logger.warning("GnuTLS bye failed")
 
1822
                    logger.warning("GnuTLS bye failed",
 
1823
                                   exc_info=error)
1446
1824
    
1447
1825
    @staticmethod
1448
1826
    def peer_certificate(session):
1504
1882
        # Convert the buffer to a Python bytestring
1505
1883
        fpr = ctypes.string_at(buf, buf_len.value)
1506
1884
        # Convert the bytestring to hexadecimal notation
1507
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1885
        hex_fpr = binascii.hexlify(fpr).upper()
1508
1886
        return hex_fpr
1509
1887
 
1510
1888
 
1513
1891
    def sub_process_main(self, request, address):
1514
1892
        try:
1515
1893
            self.finish_request(request, address)
1516
 
        except:
 
1894
        except Exception:
1517
1895
            self.handle_error(request, address)
1518
1896
        self.close_request(request)
1519
1897
    
1520
1898
    def process_request(self, request, address):
1521
1899
        """Start a new process to process the request."""
1522
1900
        proc = multiprocessing.Process(target = self.sub_process_main,
1523
 
                                       args = (request,
1524
 
                                               address))
 
1901
                                       args = (request, address))
1525
1902
        proc.start()
1526
1903
        return proc
1527
1904
 
1542
1919
    
1543
1920
    def add_pipe(self, parent_pipe, proc):
1544
1921
        """Dummy function; override as necessary"""
1545
 
        raise NotImplementedError
 
1922
        raise NotImplementedError()
1546
1923
 
1547
1924
 
1548
1925
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1555
1932
        use_ipv6:       Boolean; to use IPv6 or not
1556
1933
    """
1557
1934
    def __init__(self, server_address, RequestHandlerClass,
1558
 
                 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
        """
1559
1939
        self.interface = interface
1560
1940
        if use_ipv6:
1561
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.
1562
1968
        socketserver.TCPServer.__init__(self, server_address,
1563
1969
                                        RequestHandlerClass)
 
1970
    
1564
1971
    def server_bind(self):
1565
1972
        """This overrides the normal server_bind() function
1566
1973
        to bind to an interface if one was specified, and also NOT to
1574
1981
                try:
1575
1982
                    self.socket.setsockopt(socket.SOL_SOCKET,
1576
1983
                                           SO_BINDTODEVICE,
1577
 
                                           str(self.interface
1578
 
                                               + '\0'))
 
1984
                                           (self.interface + "\0")
 
1985
                                           .encode("utf-8"))
1579
1986
                except socket.error as error:
1580
 
                    if error[0] == errno.EPERM:
1581
 
                        logger.error("No permission to"
1582
 
                                     " bind to interface %s",
1583
 
                                     self.interface)
1584
 
                    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:
1585
1991
                        logger.error("SO_BINDTODEVICE not available;"
1586
1992
                                     " cannot bind to interface %s",
1587
1993
                                     self.interface)
 
1994
                    elif error.errno == errno.ENODEV:
 
1995
                        logger.error("Interface %s does not exist,"
 
1996
                                     " cannot bind", self.interface)
1588
1997
                    else:
1589
1998
                        raise
1590
1999
        # Only bind(2) the socket if we really need to.
1593
2002
                if self.address_family == socket.AF_INET6:
1594
2003
                    any_address = "::" # in6addr_any
1595
2004
                else:
1596
 
                    any_address = socket.INADDR_ANY
 
2005
                    any_address = "0.0.0.0" # INADDR_ANY
1597
2006
                self.server_address = (any_address,
1598
2007
                                       self.server_address[1])
1599
2008
            elif not self.server_address[1]:
1620
2029
    """
1621
2030
    def __init__(self, server_address, RequestHandlerClass,
1622
2031
                 interface=None, use_ipv6=True, clients=None,
1623
 
                 gnutls_priority=None, use_dbus=True):
 
2032
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1624
2033
        self.enabled = False
1625
2034
        self.clients = clients
1626
2035
        if self.clients is None:
1627
 
            self.clients = set()
 
2036
            self.clients = {}
1628
2037
        self.use_dbus = use_dbus
1629
2038
        self.gnutls_priority = gnutls_priority
1630
2039
        IPv6_TCPServer.__init__(self, server_address,
1631
2040
                                RequestHandlerClass,
1632
2041
                                interface = interface,
1633
 
                                use_ipv6 = use_ipv6)
 
2042
                                use_ipv6 = use_ipv6,
 
2043
                                socketfd = socketfd)
1634
2044
    def server_activate(self):
1635
2045
        if self.enabled:
1636
2046
            return socketserver.TCPServer.server_activate(self)
1649
2059
    
1650
2060
    def handle_ipc(self, source, condition, parent_pipe=None,
1651
2061
                   proc = None, client_object=None):
1652
 
        condition_names = {
1653
 
            gobject.IO_IN: "IN",   # There is data to read.
1654
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1655
 
                                    # blocking).
1656
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1657
 
            gobject.IO_ERR: "ERR", # Error condition.
1658
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1659
 
                                    # broken, usually for pipes and
1660
 
                                    # sockets).
1661
 
            }
1662
 
        conditions_string = ' | '.join(name
1663
 
                                       for cond, name in
1664
 
                                       condition_names.iteritems()
1665
 
                                       if cond & condition)
1666
2062
        # error, or the other end of multiprocessing.Pipe has closed
1667
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2063
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1668
2064
            # Wait for other process to exit
1669
2065
            proc.join()
1670
2066
            return False
1677
2073
            fpr = request[1]
1678
2074
            address = request[2]
1679
2075
            
1680
 
            for c in self.clients:
 
2076
            for c in self.clients.itervalues():
1681
2077
                if c.fingerprint == fpr:
1682
2078
                    client = c
1683
2079
                    break
1728
2124
        return True
1729
2125
 
1730
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
 
1731
2226
def string_to_delta(interval):
1732
2227
    """Parse a string and return a datetime.timedelta
1733
2228
    
1744
2239
    >>> string_to_delta('5m 30s')
1745
2240
    datetime.timedelta(0, 330)
1746
2241
    """
 
2242
    
 
2243
    try:
 
2244
        return rfc3339_duration_to_delta(interval)
 
2245
    except ValueError:
 
2246
        pass
 
2247
    
1747
2248
    timevalue = datetime.timedelta(0)
1748
2249
    for s in interval.split():
1749
2250
        try:
1750
 
            suffix = unicode(s[-1])
 
2251
            suffix = s[-1]
1751
2252
            value = int(s[:-1])
1752
2253
            if suffix == "d":
1753
2254
                delta = datetime.timedelta(value)
1760
2261
            elif suffix == "w":
1761
2262
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1762
2263
            else:
1763
 
                raise ValueError("Unknown suffix %r" % suffix)
1764
 
        except (ValueError, IndexError) as e:
 
2264
                raise ValueError("Unknown suffix {!r}"
 
2265
                                 .format(suffix))
 
2266
        except IndexError as e:
1765
2267
            raise ValueError(*(e.args))
1766
2268
        timevalue += delta
1767
2269
    return timevalue
1768
2270
 
1769
2271
 
1770
 
def if_nametoindex(interface):
1771
 
    """Call the C function if_nametoindex(), or equivalent
1772
 
    
1773
 
    Note: This function cannot accept a unicode string."""
1774
 
    global if_nametoindex
1775
 
    try:
1776
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1777
 
                          (ctypes.util.find_library("c"))
1778
 
                          .if_nametoindex)
1779
 
    except (OSError, AttributeError):
1780
 
        logger.warning("Doing if_nametoindex the hard way")
1781
 
        def if_nametoindex(interface):
1782
 
            "Get an interface index the hard way, i.e. using fcntl()"
1783
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1784
 
            with contextlib.closing(socket.socket()) as s:
1785
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1786
 
                                    struct.pack(str("16s16x"),
1787
 
                                                interface))
1788
 
            interface_index = struct.unpack(str("I"),
1789
 
                                            ifreq[16:20])[0]
1790
 
            return interface_index
1791
 
    return if_nametoindex(interface)
1792
 
 
1793
 
 
1794
2272
def daemon(nochdir = False, noclose = False):
1795
2273
    """See daemon(3).  Standard BSD Unix function.
1796
2274
    
1804
2282
        sys.exit()
1805
2283
    if not noclose:
1806
2284
        # Close all standard open file descriptors
1807
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2285
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1808
2286
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1809
 
            raise OSError(errno.ENODEV,
1810
 
                          "%s not a character device"
1811
 
                          % os.path.devnull)
 
2287
            raise OSError(errno.ENODEV, "{} not a character device"
 
2288
                          .format(os.devnull))
1812
2289
        os.dup2(null, sys.stdin.fileno())
1813
2290
        os.dup2(null, sys.stdout.fileno())
1814
2291
        os.dup2(null, sys.stderr.fileno())
1823
2300
    
1824
2301
    parser = argparse.ArgumentParser()
1825
2302
    parser.add_argument("-v", "--version", action="version",
1826
 
                        version = "%%(prog)s %s" % version,
 
2303
                        version = "%(prog)s {}".format(version),
1827
2304
                        help="show version number and exit")
1828
2305
    parser.add_argument("-i", "--interface", metavar="IF",
1829
2306
                        help="Bind to interface IF")
1835
2312
                        help="Run self-test")
1836
2313
    parser.add_argument("--debug", action="store_true",
1837
2314
                        help="Debug mode; run in foreground and log"
1838
 
                        " to terminal")
 
2315
                        " to terminal", default=None)
1839
2316
    parser.add_argument("--debuglevel", metavar="LEVEL",
1840
2317
                        help="Debug level for stdout output")
1841
2318
    parser.add_argument("--priority", help="GnuTLS"
1848
2325
                        " files")
1849
2326
    parser.add_argument("--no-dbus", action="store_false",
1850
2327
                        dest="use_dbus", help="Do not provide D-Bus"
1851
 
                        " system bus interface")
 
2328
                        " system bus interface", default=None)
1852
2329
    parser.add_argument("--no-ipv6", action="store_false",
1853
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2330
                        dest="use_ipv6", help="Do not use IPv6",
 
2331
                        default=None)
 
2332
    parser.add_argument("--no-restore", action="store_false",
 
2333
                        dest="restore", help="Do not restore stored"
 
2334
                        " state", default=None)
 
2335
    parser.add_argument("--socket", type=int,
 
2336
                        help="Specify a file descriptor to a network"
 
2337
                        " socket to use instead of creating one")
 
2338
    parser.add_argument("--statedir", metavar="DIR",
 
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)
 
2345
    
1854
2346
    options = parser.parse_args()
1855
2347
    
1856
2348
    if options.check:
1857
2349
        import doctest
1858
 
        doctest.testmod()
1859
 
        sys.exit()
 
2350
        fail_count, test_count = doctest.testmod()
 
2351
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1860
2352
    
1861
2353
    # Default values for config file for server-global settings
1862
2354
    server_defaults = { "interface": "",
1864
2356
                        "port": "",
1865
2357
                        "debug": "False",
1866
2358
                        "priority":
1867
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2359
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1868
2360
                        "servicename": "Mandos",
1869
2361
                        "use_dbus": "True",
1870
2362
                        "use_ipv6": "True",
1871
2363
                        "debuglevel": "",
 
2364
                        "restore": "True",
 
2365
                        "socket": "",
 
2366
                        "statedir": "/var/lib/mandos",
 
2367
                        "foreground": "False",
 
2368
                        "zeroconf": "True",
1872
2369
                        }
1873
2370
    
1874
2371
    # Parse config file for server-global settings
1879
2376
    # Convert the SafeConfigParser object to a dict
1880
2377
    server_settings = server_config.defaults()
1881
2378
    # Use the appropriate methods on the non-string config options
1882
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2379
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1883
2380
        server_settings[option] = server_config.getboolean("DEFAULT",
1884
2381
                                                           option)
1885
2382
    if server_settings["port"]:
1886
2383
        server_settings["port"] = server_config.getint("DEFAULT",
1887
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"])
1888
2394
    del server_config
1889
2395
    
1890
2396
    # Override the settings from the config file with command line
1891
2397
    # options, if set.
1892
2398
    for option in ("interface", "address", "port", "debug",
1893
2399
                   "priority", "servicename", "configdir",
1894
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2400
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2401
                   "statedir", "socket", "foreground", "zeroconf"):
1895
2402
        value = getattr(options, option)
1896
2403
        if value is not None:
1897
2404
            server_settings[option] = value
1898
2405
    del options
1899
2406
    # Force all strings to be unicode
1900
2407
    for option in server_settings.keys():
1901
 
        if type(server_settings[option]) is str:
1902
 
            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
1903
2418
    # Now we have our good server settings in "server_settings"
1904
2419
    
1905
2420
    ##################################################################
1906
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
    
1907
2428
    # For convenience
1908
2429
    debug = server_settings["debug"]
1909
2430
    debuglevel = server_settings["debuglevel"]
1910
2431
    use_dbus = server_settings["use_dbus"]
1911
2432
    use_ipv6 = server_settings["use_ipv6"]
 
2433
    stored_state_path = os.path.join(server_settings["statedir"],
 
2434
                                     stored_state_file)
 
2435
    foreground = server_settings["foreground"]
 
2436
    zeroconf = server_settings["zeroconf"]
 
2437
    
 
2438
    if debug:
 
2439
        initlogger(debug, logging.DEBUG)
 
2440
    else:
 
2441
        if not debuglevel:
 
2442
            initlogger(debug)
 
2443
        else:
 
2444
            level = getattr(logging, debuglevel.upper())
 
2445
            initlogger(debug, level)
1912
2446
    
1913
2447
    if server_settings["servicename"] != "Mandos":
1914
2448
        syslogger.setFormatter(logging.Formatter
1915
 
                               ('Mandos (%s) [%%(process)d]:'
1916
 
                                ' %%(levelname)s: %%(message)s'
1917
 
                                % server_settings["servicename"]))
 
2449
                               ('Mandos ({}) [%(process)d]:'
 
2450
                                ' %(levelname)s: %(message)s'
 
2451
                                .format(server_settings
 
2452
                                        ["servicename"])))
1918
2453
    
1919
2454
    # Parse config file with clients
1920
 
    client_defaults = { "timeout": "5m",
1921
 
                        "extended_timeout": "15m",
1922
 
                        "interval": "2m",
1923
 
                        "checker": "fping -q -- %%(host)s",
1924
 
                        "host": "",
1925
 
                        "approval_delay": "0s",
1926
 
                        "approval_duration": "1s",
1927
 
                        }
1928
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2455
    client_config = configparser.SafeConfigParser(Client
 
2456
                                                  .client_defaults)
1929
2457
    client_config.read(os.path.join(server_settings["configdir"],
1930
2458
                                    "clients.conf"))
1931
2459
    
1932
2460
    global mandos_dbus_service
1933
2461
    mandos_dbus_service = None
1934
2462
    
 
2463
    socketfd = None
 
2464
    if server_settings["socket"] != "":
 
2465
        socketfd = server_settings["socket"]
1935
2466
    tcp_server = MandosServer((server_settings["address"],
1936
2467
                               server_settings["port"]),
1937
2468
                              ClientHandler,
1940
2471
                              use_ipv6=use_ipv6,
1941
2472
                              gnutls_priority=
1942
2473
                              server_settings["priority"],
1943
 
                              use_dbus=use_dbus)
1944
 
    if not debug:
1945
 
        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
1946
2481
        try:
1947
2482
            pidfile = open(pidfilename, "w")
1948
 
        except IOError:
1949
 
            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)
1950
2486
    
1951
 
    try:
1952
 
        uid = pwd.getpwnam("_mandos").pw_uid
1953
 
        gid = pwd.getpwnam("_mandos").pw_gid
1954
 
    except KeyError:
 
2487
    for name in ("_mandos", "mandos", "nobody"):
1955
2488
        try:
1956
 
            uid = pwd.getpwnam("mandos").pw_uid
1957
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2489
            uid = pwd.getpwnam(name).pw_uid
 
2490
            gid = pwd.getpwnam(name).pw_gid
 
2491
            break
1958
2492
        except KeyError:
1959
 
            try:
1960
 
                uid = pwd.getpwnam("nobody").pw_uid
1961
 
                gid = pwd.getpwnam("nobody").pw_gid
1962
 
            except KeyError:
1963
 
                uid = 65534
1964
 
                gid = 65534
 
2493
            continue
 
2494
    else:
 
2495
        uid = 65534
 
2496
        gid = 65534
1965
2497
    try:
1966
2498
        os.setgid(gid)
1967
2499
        os.setuid(uid)
1968
2500
    except OSError as error:
1969
 
        if error[0] != errno.EPERM:
1970
 
            raise error
1971
 
    
1972
 
    if not debug and not debuglevel:
1973
 
        syslogger.setLevel(logging.WARNING)
1974
 
        console.setLevel(logging.WARNING)
1975
 
    if debuglevel:
1976
 
        level = getattr(logging, debuglevel.upper())
1977
 
        syslogger.setLevel(level)
1978
 
        console.setLevel(level)
 
2501
        if error.errno != errno.EPERM:
 
2502
            raise
1979
2503
    
1980
2504
    if debug:
1981
2505
        # Enable all possible GnuTLS debugging
1992
2516
         .gnutls_global_set_log_function(debug_gnutls))
1993
2517
        
1994
2518
        # Redirect stdin so all checkers get /dev/null
1995
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2519
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1996
2520
        os.dup2(null, sys.stdin.fileno())
1997
2521
        if null > 2:
1998
2522
            os.close(null)
1999
 
    else:
2000
 
        # No console logging
2001
 
        logger.removeHandler(console)
2002
2523
    
2003
2524
    # Need to fork before connecting to D-Bus
2004
 
    if not debug:
 
2525
    if not foreground:
2005
2526
        # Close all input and output, do double fork, etc.
2006
2527
        daemon()
2007
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
    
2008
2533
    global main_loop
2009
2534
    # From the Avahi example code
2010
 
    DBusGMainLoop(set_as_default=True )
 
2535
    DBusGMainLoop(set_as_default=True)
2011
2536
    main_loop = gobject.MainLoop()
2012
2537
    bus = dbus.SystemBus()
2013
2538
    # End of Avahi example code
2019
2544
                            ("se.bsnet.fukt.Mandos", bus,
2020
2545
                             do_not_queue=True))
2021
2546
        except dbus.exceptions.NameExistsException as e:
2022
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2547
            logger.error("Disabling D-Bus:", exc_info=e)
2023
2548
            use_dbus = False
2024
2549
            server_settings["use_dbus"] = False
2025
2550
            tcp_server.use_dbus = False
2026
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2027
 
    service = AvahiService(name = server_settings["servicename"],
2028
 
                           servicetype = "_mandos._tcp",
2029
 
                           protocol = protocol, bus = bus)
2030
 
    if server_settings["interface"]:
2031
 
        service.interface = (if_nametoindex
2032
 
                             (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")))
2033
2561
    
2034
2562
    global multiprocessing_manager
2035
2563
    multiprocessing_manager = multiprocessing.Manager()
2036
2564
    
2037
2565
    client_class = Client
2038
2566
    if use_dbus:
2039
 
        client_class = functools.partial(ClientDBusTransitional,
2040
 
                                         bus = bus)
2041
 
    def client_config_items(config, section):
2042
 
        special_settings = {
2043
 
            "approved_by_default":
2044
 
                lambda: config.getboolean(section,
2045
 
                                          "approved_by_default"),
2046
 
            }
2047
 
        for name, value in config.items(section):
 
2567
        client_class = functools.partial(ClientDBus, bus = bus)
 
2568
    
 
2569
    client_settings = Client.config_parser(client_config)
 
2570
    old_client_settings = {}
 
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()
 
2580
    
 
2581
    # Get client data and settings from last running state.
 
2582
    if server_settings["restore"]:
 
2583
        try:
 
2584
            with open(stored_state_path, "rb") as stored_state:
 
2585
                clients_data, old_client_settings = (pickle.load
 
2586
                                                     (stored_state))
 
2587
            os.remove(stored_state_path)
 
2588
        except IOError as e:
 
2589
            if e.errno == errno.ENOENT:
 
2590
                logger.warning("Could not load persistent state: {}"
 
2591
                                .format(os.strerror(e.errno)))
 
2592
            else:
 
2593
                logger.critical("Could not load persistent state:",
 
2594
                                exc_info=e)
 
2595
                raise
 
2596
        except EOFError as e:
 
2597
            logger.warning("Could not load persistent state: "
 
2598
                           "EOFError:", exc_info=e)
 
2599
    
 
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
 
2605
            
 
2606
            # Decide which value to use after restoring saved state.
 
2607
            # We have three different values: Old config file,
 
2608
            # new config file, and saved state.
 
2609
            # New config value takes precedence if it differs from old
 
2610
            # config value, otherwise use saved state.
 
2611
            for name, value in client_settings[client_name].items():
 
2612
                try:
 
2613
                    # For each value in new config, check if it
 
2614
                    # differs from the old config value (Except for
 
2615
                    # the "secret" attribute)
 
2616
                    if (name != "secret" and
 
2617
                        value != old_client_settings[client_name]
 
2618
                        [name]):
 
2619
                        client[name] = value
 
2620
                except KeyError:
 
2621
                    pass
 
2622
            
 
2623
            # Clients who has passed its expire date can still be
 
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"]))
 
2642
                        client["enabled"] = False
 
2643
                    else:
 
2644
                        client["expires"] = (datetime.datetime
 
2645
                                             .utcnow()
 
2646
                                             + client["timeout"])
 
2647
                        logger.debug("Last checker succeeded,"
 
2648
                                     " keeping {} enabled"
 
2649
                                     .format(client_name))
2048
2650
            try:
2049
 
                yield (name, special_settings[name]())
2050
 
            except KeyError:
2051
 
                yield (name, value)
2052
 
    
2053
 
    tcp_server.clients.update(set(
2054
 
            client_class(name = section,
2055
 
                         config= dict(client_config_items(
2056
 
                        client_config, section)))
2057
 
            for section in client_config.sections()))
 
2651
                client["secret"] = (
 
2652
                    pgp.decrypt(client["encrypted_secret"],
 
2653
                                client_settings[client_name]
 
2654
                                ["secret"]))
 
2655
            except PGPError:
 
2656
                # If decryption fails, we use secret from new settings
 
2657
                logger.debug("Failed to decrypt {} old secret"
 
2658
                             .format(client_name))
 
2659
                client["secret"] = (
 
2660
                    client_settings[client_name]["secret"])
 
2661
    
 
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)
 
2675
    
2058
2676
    if not tcp_server.clients:
2059
2677
        logger.warning("No clients defined")
2060
 
        
2061
 
    if not debug:
2062
 
        try:
2063
 
            with pidfile:
2064
 
                pid = os.getpid()
2065
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2066
 
            del pidfile
2067
 
        except IOError:
2068
 
            logger.error("Could not write to file %r with PID %d",
2069
 
                         pidfilename, pid)
2070
 
        except NameError:
2071
 
            # "pidfile" was never created
2072
 
            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
2073
2689
        del pidfilename
2074
 
        
2075
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2076
2690
    
2077
2691
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2078
2692
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2079
2693
    
2080
2694
    if use_dbus:
2081
 
        class MandosDBusService(dbus.service.Object):
 
2695
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2696
                                        "se.bsnet.fukt.Mandos"})
 
2697
        class MandosDBusService(DBusObjectWithProperties):
2082
2698
            """A D-Bus proxy object"""
2083
2699
            def __init__(self):
2084
2700
                dbus.service.Object.__init__(self, bus, "/")
2085
2701
            _interface = "se.recompile.Mandos"
2086
2702
            
 
2703
            @dbus_interface_annotations(_interface)
 
2704
            def _foo(self):
 
2705
                return { "org.freedesktop.DBus.Property"
 
2706
                         ".EmitsChangedSignal":
 
2707
                             "false"}
 
2708
            
2087
2709
            @dbus.service.signal(_interface, signature="o")
2088
2710
            def ClientAdded(self, objpath):
2089
2711
                "D-Bus signal"
2103
2725
            def GetAllClients(self):
2104
2726
                "D-Bus method"
2105
2727
                return dbus.Array(c.dbus_object_path
2106
 
                                  for c in tcp_server.clients)
 
2728
                                  for c in
 
2729
                                  tcp_server.clients.itervalues())
2107
2730
            
2108
2731
            @dbus.service.method(_interface,
2109
2732
                                 out_signature="a{oa{sv}}")
2110
2733
            def GetAllClientsWithProperties(self):
2111
2734
                "D-Bus method"
2112
2735
                return dbus.Dictionary(
2113
 
                    ((c.dbus_object_path, c.GetAll(""))
2114
 
                     for c in tcp_server.clients),
 
2736
                    { c.dbus_object_path: c.GetAll("")
 
2737
                      for c in tcp_server.clients.itervalues() },
2115
2738
                    signature="oa{sv}")
2116
2739
            
2117
2740
            @dbus.service.method(_interface, in_signature="o")
2118
2741
            def RemoveClient(self, object_path):
2119
2742
                "D-Bus method"
2120
 
                for c in tcp_server.clients:
 
2743
                for c in tcp_server.clients.itervalues():
2121
2744
                    if c.dbus_object_path == object_path:
2122
 
                        tcp_server.clients.remove(c)
 
2745
                        del tcp_server.clients[c.name]
2123
2746
                        c.remove_from_connection()
2124
2747
                        # Don't signal anything except ClientRemoved
2125
2748
                        c.disable(quiet=True)
2130
2753
            
2131
2754
            del _interface
2132
2755
        
2133
 
        class MandosDBusServiceTransitional(MandosDBusService):
2134
 
            __metaclass__ = AlternateDBusNamesMetaclass
2135
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2756
        mandos_dbus_service = MandosDBusService()
2136
2757
    
2137
2758
    def cleanup():
2138
2759
        "Cleanup function; run on exit"
2139
 
        service.cleanup()
 
2760
        if zeroconf:
 
2761
            service.cleanup()
2140
2762
        
2141
2763
        multiprocessing.active_children()
 
2764
        wnull.close()
 
2765
        if not (tcp_server.clients or client_settings):
 
2766
            return
 
2767
        
 
2768
        # Store client before exiting. Secrets are encrypted with key
 
2769
        # based on what config file has. If config file is
 
2770
        # removed/edited, old secret will thus be unrecovable.
 
2771
        clients = {}
 
2772
        with PGPEngine() as pgp:
 
2773
            for client in tcp_server.clients.itervalues():
 
2774
                key = client_settings[client.name]["secret"]
 
2775
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2776
                                                      key)
 
2777
                client_dict = {}
 
2778
                
 
2779
                # A list of attributes that can not be pickled
 
2780
                # + secret.
 
2781
                exclude = { "bus", "changedstate", "secret",
 
2782
                            "checker", "server_settings" }
 
2783
                for name, typ in (inspect.getmembers
 
2784
                                  (dbus.service.Object)):
 
2785
                    exclude.add(name)
 
2786
                
 
2787
                client_dict["encrypted_secret"] = (client
 
2788
                                                   .encrypted_secret)
 
2789
                for attr in client.client_structure:
 
2790
                    if attr not in exclude:
 
2791
                        client_dict[attr] = getattr(client, attr)
 
2792
                
 
2793
                clients[client.name] = client_dict
 
2794
                del client_settings[client.name]["secret"]
 
2795
        
 
2796
        try:
 
2797
            with (tempfile.NamedTemporaryFile
 
2798
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2799
                   dir=os.path.dirname(stored_state_path),
 
2800
                   delete=False)) as stored_state:
 
2801
                pickle.dump((clients, client_settings), stored_state)
 
2802
                tempname=stored_state.name
 
2803
            os.rename(tempname, stored_state_path)
 
2804
        except (IOError, OSError) as e:
 
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)
 
2816
                raise
 
2817
        
 
2818
        # Delete all clients, and settings from config
2142
2819
        while tcp_server.clients:
2143
 
            client = tcp_server.clients.pop()
 
2820
            name, client = tcp_server.clients.popitem()
2144
2821
            if use_dbus:
2145
2822
                client.remove_from_connection()
2146
 
            client.disable_hook = None
2147
2823
            # Don't signal anything except ClientRemoved
2148
2824
            client.disable(quiet=True)
2149
2825
            if use_dbus:
2151
2827
                mandos_dbus_service.ClientRemoved(client
2152
2828
                                                  .dbus_object_path,
2153
2829
                                                  client.name)
 
2830
        client_settings.clear()
2154
2831
    
2155
2832
    atexit.register(cleanup)
2156
2833
    
2157
 
    for client in tcp_server.clients:
 
2834
    for client in tcp_server.clients.itervalues():
2158
2835
        if use_dbus:
2159
2836
            # Emit D-Bus signal
2160
2837
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2161
 
        client.enable()
 
2838
        # Need to initiate checking of clients
 
2839
        if client.enabled:
 
2840
            client.init_checker()
2162
2841
    
2163
2842
    tcp_server.enable()
2164
2843
    tcp_server.server_activate()
2165
2844
    
2166
2845
    # Find out what port we got
2167
 
    service.port = tcp_server.socket.getsockname()[1]
 
2846
    if zeroconf:
 
2847
        service.port = tcp_server.socket.getsockname()[1]
2168
2848
    if use_ipv6:
2169
2849
        logger.info("Now listening on address %r, port %d,"
2170
 
                    " flowinfo %d, scope_id %d"
2171
 
                    % tcp_server.socket.getsockname())
 
2850
                    " flowinfo %d, scope_id %d",
 
2851
                    *tcp_server.socket.getsockname())
2172
2852
    else:                       # IPv4
2173
 
        logger.info("Now listening on address %r, port %d"
2174
 
                    % tcp_server.socket.getsockname())
 
2853
        logger.info("Now listening on address %r, port %d",
 
2854
                    *tcp_server.socket.getsockname())
2175
2855
    
2176
2856
    #service.interface = tcp_server.socket.getsockname()[3]
2177
2857
    
2178
2858
    try:
2179
 
        # From the Avahi example code
2180
 
        try:
2181
 
            service.activate()
2182
 
        except dbus.exceptions.DBusException as error:
2183
 
            logger.critical("DBusException: %s", error)
2184
 
            cleanup()
2185
 
            sys.exit(1)
2186
 
        # 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
2187
2868
        
2188
2869
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2189
2870
                             lambda *args, **kwargs:
2193
2874
        logger.debug("Starting main loop")
2194
2875
        main_loop.run()
2195
2876
    except AvahiError as error:
2196
 
        logger.critical("AvahiError: %s", error)
 
2877
        logger.critical("Avahi Error", exc_info=error)
2197
2878
        cleanup()
2198
2879
        sys.exit(1)
2199
2880
    except KeyboardInterrupt:
2204
2885
    # Must run before the D-Bus bus name gets deregistered
2205
2886
    cleanup()
2206
2887
 
2207
 
 
2208
2888
if __name__ == '__main__':
2209
2889
    main()