/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-03-10 18:03:38 UTC
  • Revision ID: teddy@recompile.se-20150310180338-pcxw6r2qmw9k6br9
Add ":!RSA" to GnuTLS priority string, to disallow non-DHE kx.

If Mandos was somehow made to use a non-ephemeral Diffie-Hellman key
exchange algorithm in the TLS handshake, any saved network traffic
could then be decrypted later if the Mandos client key was obtained.
By default, Mandos uses ephemeral DH key exchanges which does not have
this problem, but a non-ephemeral key exchange algorithm was still
enabled by default.  The simplest solution is to simply turn that off,
which ensures that Mandos will always use ephemeral DH key exchanges.

There is a "PFS" priority string specifier, but we can't use it because:

1. Security-wise, it is a mix between "NORMAL" and "SECURE128" - it
   enables a lot more algorithms than "SECURE256".

2. It is only available since GnuTLS 3.2.4.

Thanks to Andreas Fischer <af@bantuX.org> for reporting this issue.

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
66
 
import hashlib
 
68
import binascii
 
69
import tempfile
 
70
import itertools
 
71
import collections
67
72
 
68
73
import dbus
69
74
import dbus.service
74
79
import ctypes.util
75
80
import xml.dom.minidom
76
81
import inspect
77
 
import Crypto.Cipher.AES
78
82
 
79
83
try:
80
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
84
88
    except ImportError:
85
89
        SO_BINDTODEVICE = None
86
90
 
 
91
if sys.version_info.major == 2:
 
92
    str = unicode
87
93
 
88
 
version = "1.4.1"
 
94
version = "1.6.9"
 
95
stored_state_file = "clients.pickle"
89
96
 
90
97
logger = logging.getLogger()
91
 
stored_state_path = "/var/lib/mandos/clients.pickle"
92
 
 
93
 
syslogger = (logging.handlers.SysLogHandler
94
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
 
              address = str("/dev/log")))
96
 
syslogger.setFormatter(logging.Formatter
97
 
                       ('Mandos [%(process)d]: %(levelname)s:'
98
 
                        ' %(message)s'))
99
 
logger.addHandler(syslogger)
100
 
 
101
 
console = logging.StreamHandler()
102
 
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
103
 
                                       ' [%(process)d]:'
104
 
                                       ' %(levelname)s:'
105
 
                                       ' %(message)s'))
106
 
logger.addHandler(console)
 
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
107
223
 
108
224
 
109
225
class AvahiError(Exception):
110
226
    def __init__(self, value, *args, **kwargs):
111
227
        self.value = value
112
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
113
 
    def __unicode__(self):
114
 
        return unicode(repr(self.value))
 
228
        return super(AvahiError, self).__init__(value, *args,
 
229
                                                **kwargs)
115
230
 
116
231
class AvahiServiceError(AvahiError):
117
232
    pass
128
243
               Used to optionally bind to the specified interface.
129
244
    name: string; Example: 'Mandos'
130
245
    type: string; Example: '_mandos._tcp'.
131
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
246
     See <https://www.iana.org/assignments/service-names-port-numbers>
132
247
    port: integer; what port to announce
133
248
    TXT: list of strings; TXT record for the service
134
249
    domain: string; Domain to publish on, default to .local if empty.
140
255
    server: D-Bus Server
141
256
    bus: dbus.SystemBus()
142
257
    """
 
258
    
143
259
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
144
260
                 servicetype = None, port = None, TXT = None,
145
261
                 domain = "", host = "", max_renames = 32768,
158
274
        self.server = None
159
275
        self.bus = bus
160
276
        self.entry_group_state_changed_match = None
161
 
    def rename(self):
 
277
    
 
278
    def rename(self, remove=True):
162
279
        """Derived from the Avahi example code"""
163
280
        if self.rename_count >= self.max_renames:
164
281
            logger.critical("No suitable Zeroconf service name found"
165
282
                            " after %i retries, exiting.",
166
283
                            self.rename_count)
167
284
            raise AvahiServiceError("Too many renames")
168
 
        self.name = unicode(self.server
169
 
                            .GetAlternativeServiceName(self.name))
 
285
        self.name = str(self.server
 
286
                        .GetAlternativeServiceName(self.name))
 
287
        self.rename_count += 1
170
288
        logger.info("Changing Zeroconf service name to %r ...",
171
289
                    self.name)
172
 
        self.remove()
 
290
        if remove:
 
291
            self.remove()
173
292
        try:
174
293
            self.add()
175
294
        except dbus.exceptions.DBusException as error:
176
 
            logger.critical("DBusException: %s", error)
177
 
            self.cleanup()
178
 
            os._exit(1)
179
 
        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
    
180
304
    def remove(self):
181
305
        """Derived from the Avahi example code"""
182
306
        if self.entry_group_state_changed_match is not None:
184
308
            self.entry_group_state_changed_match = None
185
309
        if self.group is not None:
186
310
            self.group.Reset()
 
311
    
187
312
    def add(self):
188
313
        """Derived from the Avahi example code"""
189
314
        self.remove()
206
331
            dbus.UInt16(self.port),
207
332
            avahi.string_array_to_txt_array(self.TXT))
208
333
        self.group.Commit()
 
334
    
209
335
    def entry_group_state_changed(self, state, error):
210
336
        """Derived from the Avahi example code"""
211
337
        logger.debug("Avahi entry group state change: %i", state)
217
343
            self.rename()
218
344
        elif state == avahi.ENTRY_GROUP_FAILURE:
219
345
            logger.critical("Avahi: Error in group state changed %s",
220
 
                            unicode(error))
221
 
            raise AvahiGroupError("State changed: %s"
222
 
                                  % unicode(error))
 
346
                            str(error))
 
347
            raise AvahiGroupError("State changed: {!s}"
 
348
                                  .format(error))
 
349
    
223
350
    def cleanup(self):
224
351
        """Derived from the Avahi example code"""
225
352
        if self.group is not None:
226
353
            try:
227
354
                self.group.Free()
228
355
            except (dbus.exceptions.UnknownMethodException,
229
 
                    dbus.exceptions.DBusException) as e:
 
356
                    dbus.exceptions.DBusException):
230
357
                pass
231
358
            self.group = None
232
359
        self.remove()
 
360
    
233
361
    def server_state_changed(self, state, error=None):
234
362
        """Derived from the Avahi example code"""
235
363
        logger.debug("Avahi server state change: %i", state)
254
382
                logger.debug("Unknown state: %r", state)
255
383
            else:
256
384
                logger.debug("Unknown state: %r: %r", state, error)
 
385
    
257
386
    def activate(self):
258
387
        """Derived from the Avahi example code"""
259
388
        if self.server is None:
266
395
                                 self.server_state_changed)
267
396
        self.server_state_changed(self.server.GetState())
268
397
 
 
398
 
269
399
class AvahiServiceToSyslog(AvahiService):
270
 
    def rename(self):
 
400
    def rename(self, *args, **kwargs):
271
401
        """Add the new name to the syslog messages"""
272
 
        ret = AvahiService.rename(self)
 
402
        ret = AvahiService.rename(self, *args, **kwargs)
273
403
        syslogger.setFormatter(logging.Formatter
274
 
                               ('Mandos (%s) [%%(process)d]:'
275
 
                                ' %%(levelname)s: %%(message)s'
276
 
                                % self.name))
 
404
                               ('Mandos ({}) [%(process)d]:'
 
405
                                ' %(levelname)s: %(message)s'
 
406
                                .format(self.name)))
277
407
        return ret
278
408
 
279
 
def _timedelta_to_milliseconds(td):
280
 
    "Convert a datetime.timedelta() to milliseconds"
281
 
    return ((td.days * 24 * 60 * 60 * 1000)
282
 
            + (td.seconds * 1000)
283
 
            + (td.microseconds // 1000))
284
 
        
 
409
 
285
410
class Client(object):
286
411
    """A representation of a client host served by this server.
287
412
    
288
413
    Attributes:
289
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
414
    approved:   bool(); 'None' if not yet approved/disapproved
290
415
    approval_delay: datetime.timedelta(); Time to wait for approval
291
416
    approval_duration: datetime.timedelta(); Duration of one approval
292
417
    checker:    subprocess.Popen(); a running checker process used
310
435
    interval:   datetime.timedelta(); How often to start a new checker
311
436
    last_approval_request: datetime.datetime(); (UTC) or None
312
437
    last_checked_ok: datetime.datetime(); (UTC) or None
313
 
    last_checker_status: integer between 0 and 255 reflecting exit status
314
 
                         of last checker. -1 reflect crashed checker,
315
 
                         or None.
316
 
    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
317
442
    name:       string; from the config file, used in log messages and
318
443
                        D-Bus identifiers
319
444
    secret:     bytestring; sent verbatim (over TLS) to client
320
445
    timeout:    datetime.timedelta(); How long from last_checked_ok
321
446
                                      until this client is disabled
322
 
    extended_timeout:   extra long timeout when password has been sent
 
447
    extended_timeout:   extra long timeout when secret has been sent
323
448
    runtime_expansions: Allowed attributes for runtime expansion.
324
449
    expires:    datetime.datetime(); time (UTC) when a client will be
325
450
                disabled, or None
 
451
    server_settings: The server_settings dict from main()
326
452
    """
327
453
    
328
454
    runtime_expansions = ("approval_delay", "approval_duration",
329
 
                          "created", "enabled", "fingerprint",
330
 
                          "host", "interval", "last_checked_ok",
 
455
                          "created", "enabled", "expires",
 
456
                          "fingerprint", "host", "interval",
 
457
                          "last_approval_request", "last_checked_ok",
331
458
                          "last_enabled", "name", "timeout")
332
 
    
333
 
    def timeout_milliseconds(self):
334
 
        "Return the 'timeout' attribute in milliseconds"
335
 
        return _timedelta_to_milliseconds(self.timeout)
336
 
    
337
 
    def extended_timeout_milliseconds(self):
338
 
        "Return the 'extended_timeout' attribute in milliseconds"
339
 
        return _timedelta_to_milliseconds(self.extended_timeout)
340
 
    
341
 
    def interval_milliseconds(self):
342
 
        "Return the 'interval' attribute in milliseconds"
343
 
        return _timedelta_to_milliseconds(self.interval)
344
 
    
345
 
    def approval_delay_milliseconds(self):
346
 
        return _timedelta_to_milliseconds(self.approval_delay)
347
 
    
348
 
    def __init__(self, name = None, config=None):
349
 
        """Note: the 'checker' key in 'config' sets the
350
 
        'checker_command' attribute and *not* the 'checker'
351
 
        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
            # Uppercase and remove spaces from fingerprint for later
 
491
            # comparison purposes with return value from the
 
492
            # fingerprint() function
 
493
            client["fingerprint"] = (section["fingerprint"].upper()
 
494
                                     .replace(" ", ""))
 
495
            if "secret" in section:
 
496
                client["secret"] = section["secret"].decode("base64")
 
497
            elif "secfile" in section:
 
498
                with open(os.path.expanduser(os.path.expandvars
 
499
                                             (section["secfile"])),
 
500
                          "rb") as secfile:
 
501
                    client["secret"] = secfile.read()
 
502
            else:
 
503
                raise TypeError("No secret or secfile for section {}"
 
504
                                .format(section))
 
505
            client["timeout"] = string_to_delta(section["timeout"])
 
506
            client["extended_timeout"] = string_to_delta(
 
507
                section["extended_timeout"])
 
508
            client["interval"] = string_to_delta(section["interval"])
 
509
            client["approval_delay"] = string_to_delta(
 
510
                section["approval_delay"])
 
511
            client["approval_duration"] = string_to_delta(
 
512
                section["approval_duration"])
 
513
            client["checker_command"] = section["checker"]
 
514
            client["last_approval_request"] = None
 
515
            client["last_checked_ok"] = None
 
516
            client["last_checker_status"] = -2
 
517
        
 
518
        return settings
 
519
    
 
520
    def __init__(self, settings, name = None, server_settings=None):
352
521
        self.name = name
353
 
        if config is None:
354
 
            config = {}
 
522
        if server_settings is None:
 
523
            server_settings = {}
 
524
        self.server_settings = server_settings
 
525
        # adding all client settings
 
526
        for setting, value in settings.items():
 
527
            setattr(self, setting, value)
 
528
        
 
529
        if self.enabled:
 
530
            if not hasattr(self, "last_enabled"):
 
531
                self.last_enabled = datetime.datetime.utcnow()
 
532
            if not hasattr(self, "expires"):
 
533
                self.expires = (datetime.datetime.utcnow()
 
534
                                + self.timeout)
 
535
        else:
 
536
            self.last_enabled = None
 
537
            self.expires = None
 
538
        
355
539
        logger.debug("Creating client %r", self.name)
356
 
        # Uppercase and remove spaces from fingerprint for later
357
 
        # comparison purposes with return value from the fingerprint()
358
 
        # function
359
 
        self.fingerprint = (config["fingerprint"].upper()
360
 
                            .replace(" ", ""))
361
540
        logger.debug("  Fingerprint: %s", self.fingerprint)
362
 
        if "secret" in config:
363
 
            self.secret = config["secret"].decode("base64")
364
 
        elif "secfile" in config:
365
 
            with open(os.path.expanduser(os.path.expandvars
366
 
                                         (config["secfile"])),
367
 
                      "rb") as secfile:
368
 
                self.secret = secfile.read()
369
 
        else:
370
 
            raise TypeError("No secret or secfile for client %s"
371
 
                            % self.name)
372
 
        self.host = config.get("host", "")
373
 
        self.created = datetime.datetime.utcnow()
374
 
        self.enabled = True
375
 
        self.last_approval_request = None
376
 
        self.last_enabled = datetime.datetime.utcnow()
377
 
        self.last_checked_ok = None
378
 
        self.last_checker_status = None
379
 
        self.timeout = string_to_delta(config["timeout"])
380
 
        self.extended_timeout = string_to_delta(config
381
 
                                                ["extended_timeout"])
382
 
        self.interval = string_to_delta(config["interval"])
 
541
        self.created = settings.get("created",
 
542
                                    datetime.datetime.utcnow())
 
543
        
 
544
        # attributes specific for this server instance
383
545
        self.checker = None
384
546
        self.checker_initiator_tag = None
385
547
        self.disable_initiator_tag = None
386
 
        self.expires = datetime.datetime.utcnow() + self.timeout
387
548
        self.checker_callback_tag = None
388
 
        self.checker_command = config["checker"]
389
549
        self.current_checker_command = None
390
 
        self._approved = None
391
 
        self.approved_by_default = config.get("approved_by_default",
392
 
                                              True)
 
550
        self.approved = None
393
551
        self.approvals_pending = 0
394
 
        self.approval_delay = string_to_delta(
395
 
            config["approval_delay"])
396
 
        self.approval_duration = string_to_delta(
397
 
            config["approval_duration"])
398
552
        self.changedstate = (multiprocessing_manager
399
553
                             .Condition(multiprocessing_manager
400
554
                                        .Lock()))
401
 
        self.client_structure = [attr for attr in self.__dict__.iterkeys() if not attr.startswith("_")]
 
555
        self.client_structure = [attr for attr in
 
556
                                 self.__dict__.iterkeys()
 
557
                                 if not attr.startswith("_")]
402
558
        self.client_structure.append("client_structure")
403
 
 
404
 
 
 
559
        
405
560
        for name, t in inspect.getmembers(type(self),
406
 
                                          lambda obj: isinstance(obj, property)):
 
561
                                          lambda obj:
 
562
                                              isinstance(obj,
 
563
                                                         property)):
407
564
            if not name.startswith("_"):
408
565
                self.client_structure.append(name)
409
566
    
417
574
        if getattr(self, "enabled", False):
418
575
            # Already enabled
419
576
            return
420
 
        self.send_changedstate()
421
577
        self.expires = datetime.datetime.utcnow() + self.timeout
422
578
        self.enabled = True
423
579
        self.last_enabled = datetime.datetime.utcnow()
424
580
        self.init_checker()
 
581
        self.send_changedstate()
425
582
    
426
583
    def disable(self, quiet=True):
427
584
        """Disable this client."""
428
585
        if not getattr(self, "enabled", False):
429
586
            return False
430
587
        if not quiet:
431
 
            self.send_changedstate()
432
 
        if not quiet:
433
588
            logger.info("Disabling client %s", self.name)
434
 
        if getattr(self, "disable_initiator_tag", False):
 
589
        if getattr(self, "disable_initiator_tag", None) is not None:
435
590
            gobject.source_remove(self.disable_initiator_tag)
436
591
            self.disable_initiator_tag = None
437
592
        self.expires = None
438
 
        if getattr(self, "checker_initiator_tag", False):
 
593
        if getattr(self, "checker_initiator_tag", None) is not None:
439
594
            gobject.source_remove(self.checker_initiator_tag)
440
595
            self.checker_initiator_tag = None
441
596
        self.stop_checker()
442
597
        self.enabled = False
 
598
        if not quiet:
 
599
            self.send_changedstate()
443
600
        # Do not run this again if called by a gobject.timeout_add
444
601
        return False
445
602
    
446
603
    def __del__(self):
447
604
        self.disable()
448
 
 
 
605
    
449
606
    def init_checker(self):
450
607
        # Schedule a new checker to be started an 'interval' from now,
451
608
        # and every interval from then on.
 
609
        if self.checker_initiator_tag is not None:
 
610
            gobject.source_remove(self.checker_initiator_tag)
452
611
        self.checker_initiator_tag = (gobject.timeout_add
453
 
                                      (self.interval_milliseconds(),
 
612
                                      (int(self.interval
 
613
                                           .total_seconds() * 1000),
454
614
                                       self.start_checker))
455
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)
456
618
        self.disable_initiator_tag = (gobject.timeout_add
457
 
                                   (self.timeout_milliseconds(),
458
 
                                    self.disable))
 
619
                                      (int(self.timeout
 
620
                                           .total_seconds() * 1000),
 
621
                                       self.disable))
459
622
        # Also start a new checker *right now*.
460
623
        self.start_checker()
461
 
 
462
 
        
 
624
    
463
625
    def checker_callback(self, pid, condition, command):
464
626
        """The checker has completed, so take appropriate actions."""
465
627
        self.checker_callback_tag = None
466
628
        self.checker = None
467
629
        if os.WIFEXITED(condition):
468
 
            self.last_checker_status =  os.WEXITSTATUS(condition)
 
630
            self.last_checker_status = os.WEXITSTATUS(condition)
469
631
            if self.last_checker_status == 0:
470
632
                logger.info("Checker for %(name)s succeeded",
471
633
                            vars(self))
478
640
            logger.warning("Checker for %(name)s crashed?",
479
641
                           vars(self))
480
642
    
481
 
    def checked_ok(self, timeout=None):
482
 
        """Bump up the timeout for this client.
483
 
        
484
 
        This should only be called when the client has been seen,
485
 
        alive and well.
486
 
        """
 
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."""
487
651
        if timeout is None:
488
652
            timeout = self.timeout
489
 
        self.last_checked_ok = datetime.datetime.utcnow()
490
653
        if self.disable_initiator_tag is not None:
491
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
            self.disable_initiator_tag = None
492
656
        if getattr(self, "enabled", False):
493
657
            self.disable_initiator_tag = (gobject.timeout_add
494
 
                                          (_timedelta_to_milliseconds
495
 
                                           (timeout), self.disable))
 
658
                                          (int(timeout.total_seconds()
 
659
                                               * 1000), self.disable))
496
660
            self.expires = datetime.datetime.utcnow() + timeout
497
661
    
498
662
    def need_approval(self):
504
668
        If a checker already exists, leave it running and do
505
669
        nothing."""
506
670
        # The reason for not killing a running checker is that if we
507
 
        # did that, then if a checker (for some reason) started
508
 
        # running slowly and taking more than 'interval' time, the
509
 
        # client would inevitably timeout, since no checker would get
510
 
        # 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
511
675
        # checkers alone, the checker would have to take more time
512
676
        # than 'timeout' for the client to be disabled, which is as it
513
677
        # should be.
515
679
        # If a checker exists, make sure it is not a zombie
516
680
        try:
517
681
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
518
 
        except (AttributeError, OSError) as error:
519
 
            if (isinstance(error, OSError)
520
 
                and error.errno != errno.ECHILD):
521
 
                raise error
 
682
        except AttributeError:
 
683
            pass
 
684
        except OSError as error:
 
685
            if error.errno != errno.ECHILD:
 
686
                raise
522
687
        else:
523
688
            if pid:
524
689
                logger.warning("Checker was a zombie")
527
692
                                      self.current_checker_command)
528
693
        # Start a new checker if needed
529
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 }
530
699
            try:
531
 
                # In case checker_command has exactly one % operator
532
 
                command = self.checker_command % self.host
533
 
            except TypeError:
534
 
                # Escape attributes for the shell
535
 
                escaped_attrs = dict(
536
 
                    (attr,
537
 
                     re.escape(unicode(str(getattr(self, attr, "")),
538
 
                                       errors=
539
 
                                       'replace')))
540
 
                    for attr in
541
 
                    self.runtime_expansions)
542
 
                
543
 
                try:
544
 
                    command = self.checker_command % escaped_attrs
545
 
                except TypeError as error:
546
 
                    logger.error('Could not format string "%s":'
547
 
                                 ' %s', self.checker_command, error)
548
 
                    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
549
705
            self.current_checker_command = command
550
706
            try:
551
707
                logger.info("Starting checker %r for %s",
554
710
                # in normal mode, that is already done by daemon(),
555
711
                # and in debug mode we don't want to.  (Stdin is
556
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 })
557
721
                self.checker = subprocess.Popen(command,
558
722
                                                close_fds=True,
559
 
                                                shell=True, cwd="/")
560
 
                self.checker_callback_tag = (gobject.child_watch_add
561
 
                                             (self.checker.pid,
562
 
                                              self.checker_callback,
563
 
                                              data=command))
564
 
                # The checker may have completed before the gobject
565
 
                # 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:
566
736
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
567
 
                if pid:
568
 
                    gobject.source_remove(self.checker_callback_tag)
569
 
                    self.checker_callback(pid, status, command)
570
737
            except OSError as error:
571
 
                logger.error("Failed to start subprocess: %s",
572
 
                             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)
573
747
        # Re-run this periodically if run by gobject.timeout_add
574
748
        return True
575
749
    
582
756
            return
583
757
        logger.debug("Stopping checker for %(name)s", vars(self))
584
758
        try:
585
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
759
            self.checker.terminate()
586
760
            #time.sleep(0.5)
587
761
            #if self.checker.poll() is None:
588
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
762
            #    self.checker.kill()
589
763
        except OSError as error:
590
764
            if error.errno != errno.ESRCH: # No such process
591
765
                raise
592
766
        self.checker = None
593
767
 
594
 
    # Encrypts a client secret and stores it in a varible encrypted_secret
595
 
    def encrypt_secret(self, key):
596
 
        # Encryption-key need to be of a specific size, so we hash inputed key
597
 
        hasheng = hashlib.sha256()
598
 
        hasheng.update(key)
599
 
        encryptionkey = hasheng.digest()
600
 
 
601
 
        # Create validation hash so we know at decryption if it was sucessful
602
 
        hasheng = hashlib.sha256()
603
 
        hasheng.update(self.secret)
604
 
        validationhash = hasheng.digest()
605
 
 
606
 
        # Encrypt secret
607
 
        iv = os.urandom(Crypto.Cipher.AES.block_size)
608
 
        ciphereng = Crypto.Cipher.AES.new(encryptionkey,
609
 
                                        Crypto.Cipher.AES.MODE_CFB, iv)
610
 
        ciphertext = ciphereng.encrypt(validationhash+self.secret)
611
 
        self.encrypted_secret = (ciphertext, iv)
612
 
 
613
 
    # Decrypt a encrypted client secret
614
 
    def decrypt_secret(self, key):
615
 
        # Decryption-key need to be of a specific size, so we hash inputed key
616
 
        hasheng = hashlib.sha256()
617
 
        hasheng.update(key)
618
 
        encryptionkey = hasheng.digest()
619
 
 
620
 
        # Decrypt encrypted secret
621
 
        ciphertext, iv = self.encrypted_secret
622
 
        ciphereng = Crypto.Cipher.AES.new(encryptionkey,
623
 
                                        Crypto.Cipher.AES.MODE_CFB, iv)
624
 
        plain = ciphereng.decrypt(ciphertext)
625
 
 
626
 
        # Validate decrypted secret to know if it was succesful
627
 
        hasheng = hashlib.sha256()
628
 
        validationhash = plain[:hasheng.digest_size]
629
 
        secret = plain[hasheng.digest_size:]
630
 
        hasheng.update(secret)
631
 
 
632
 
        # if validation fails, we use key as new secret. Otherwhise, we use
633
 
        # the decrypted secret
634
 
        if hasheng.digest() == validationhash:
635
 
            self.secret = secret
636
 
        else:
637
 
            self.secret = key
638
 
        del self.encrypted_secret
639
 
 
640
768
 
641
769
def dbus_service_property(dbus_interface, signature="v",
642
770
                          access="readwrite", byte_arrays=False):
654
782
    # "Set" method, so we fail early here:
655
783
    if byte_arrays and signature != "ay":
656
784
        raise ValueError("Byte arrays not supported for non-'ay'"
657
 
                         " signature %r" % signature)
 
785
                         " signature {!r}".format(signature))
658
786
    def decorator(func):
659
787
        func._dbus_is_property = True
660
788
        func._dbus_interface = dbus_interface
668
796
    return decorator
669
797
 
670
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
 
671
836
class DBusPropertyException(dbus.exceptions.DBusException):
672
837
    """A base class for D-Bus property-related exceptions
673
838
    """
674
 
    def __unicode__(self):
675
 
        return unicode(str(self))
676
 
 
 
839
    pass
677
840
 
678
841
class DBusPropertyAccessException(DBusPropertyException):
679
842
    """A property's access permissions disallows an operation.
696
859
    """
697
860
    
698
861
    @staticmethod
699
 
    def _is_dbus_property(obj):
700
 
        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)
701
870
    
702
 
    def _get_all_dbus_properties(self):
 
871
    def _get_all_dbus_things(self, thing):
703
872
        """Returns a generator of (name, attribute) pairs
704
873
        """
705
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
874
        return ((getattr(athing.__get__(self), "_dbus_name",
 
875
                         name),
 
876
                 athing.__get__(self))
706
877
                for cls in self.__class__.__mro__
707
 
                for name, prop in
708
 
                inspect.getmembers(cls, self._is_dbus_property))
 
878
                for name, athing in
 
879
                inspect.getmembers(cls,
 
880
                                   self._is_dbus_thing(thing)))
709
881
    
710
882
    def _get_dbus_property(self, interface_name, property_name):
711
883
        """Returns a bound method if one exists which is a D-Bus
713
885
        """
714
886
        for cls in  self.__class__.__mro__:
715
887
            for name, value in (inspect.getmembers
716
 
                                (cls, self._is_dbus_property)):
 
888
                                (cls,
 
889
                                 self._is_dbus_thing("property"))):
717
890
                if (value._dbus_name == property_name
718
891
                    and value._dbus_interface == interface_name):
719
892
                    return value.__get__(self)
747
920
            # The byte_arrays option is not supported yet on
748
921
            # signatures other than "ay".
749
922
            if prop._dbus_signature != "ay":
750
 
                raise ValueError
751
 
            value = dbus.ByteArray(''.join(unichr(byte)
752
 
                                           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))
753
928
        prop(value)
754
929
    
755
930
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
760
935
        
761
936
        Note: Will not include properties with access="write".
762
937
        """
763
 
        all = {}
764
 
        for name, prop in self._get_all_dbus_properties():
 
938
        properties = {}
 
939
        for name, prop in self._get_all_dbus_things("property"):
765
940
            if (interface_name
766
941
                and interface_name != prop._dbus_interface):
767
942
                # Interface non-empty but did not match
771
946
                continue
772
947
            value = prop()
773
948
            if not hasattr(value, "variant_level"):
774
 
                all[name] = value
 
949
                properties[name] = value
775
950
                continue
776
 
            all[name] = type(value)(value, variant_level=
777
 
                                    value.variant_level+1)
778
 
        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
779
962
    
780
963
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
781
964
                         out_signature="s",
782
965
                         path_keyword='object_path',
783
966
                         connection_keyword='connection')
784
967
    def Introspect(self, object_path, connection):
785
 
        """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.
786
971
        """
787
972
        xmlstring = dbus.service.Object.Introspect(self, object_path,
788
973
                                                   connection)
795
980
                e.setAttribute("access", prop._dbus_access)
796
981
                return e
797
982
            for if_tag in document.getElementsByTagName("interface"):
 
983
                # Add property tags
798
984
                for tag in (make_tag(document, name, prop)
799
985
                            for name, prop
800
 
                            in self._get_all_dbus_properties()
 
986
                            in self._get_all_dbus_things("property")
801
987
                            if prop._dbus_interface
802
988
                            == if_tag.getAttribute("name")):
803
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)
804
1021
                # Add the names to the return values for the
805
1022
                # "org.freedesktop.DBus.Properties" methods
806
1023
                if (if_tag.getAttribute("name")
821
1038
        except (AttributeError, xml.dom.DOMException,
822
1039
                xml.parsers.expat.ExpatError) as error:
823
1040
            logger.error("Failed to override Introspection method",
824
 
                         error)
 
1041
                         exc_info=error)
825
1042
        return xmlstring
826
1043
 
827
1044
 
828
 
def datetime_to_dbus (dt, variant_level=0):
 
1045
def datetime_to_dbus(dt, variant_level=0):
829
1046
    """Convert a UTC datetime.datetime() to a D-Bus type."""
830
1047
    if dt is None:
831
1048
        return dbus.String("", variant_level = variant_level)
832
1049
    return dbus.String(dt.isoformat(),
833
1050
                       variant_level=variant_level)
834
1051
 
835
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
836
 
                                  .__metaclass__):
837
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
838
 
    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).
839
1075
    """
840
 
    def __new__(mcs, name, bases, attr):
841
 
        # Go through all the base classes which could have D-Bus
842
 
        # methods, signals, or properties in them
843
 
        for base in (b for b in bases
844
 
                     if issubclass(b, dbus.service.Object)):
845
 
            # Go though all attributes of the base class
846
 
            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):
847
1083
                # Ignore non-D-Bus attributes, and D-Bus attributes
848
1084
                # with the wrong interface name
849
1085
                if (not hasattr(attribute, "_dbus_interface")
850
1086
                    or not attribute._dbus_interface
851
 
                    .startswith("se.recompile.Mandos")):
 
1087
                    .startswith(orig_interface_name)):
852
1088
                    continue
853
1089
                # Create an alternate D-Bus interface name based on
854
1090
                # the current name
855
1091
                alt_interface = (attribute._dbus_interface
856
 
                                 .replace("se.recompile.Mandos",
857
 
                                          "se.bsnet.fukt.Mandos"))
 
1092
                                 .replace(orig_interface_name,
 
1093
                                          alt_interface_name))
 
1094
                interface_names.add(alt_interface)
858
1095
                # Is this a D-Bus signal?
859
1096
                if getattr(attribute, "_dbus_is_signal", False):
860
 
                    # Extract the original non-method function by
861
 
                    # black magic
 
1097
                    # Extract the original non-method undecorated
 
1098
                    # function by black magic
862
1099
                    nonmethod_func = (dict(
863
1100
                            zip(attribute.func_code.co_freevars,
864
1101
                                attribute.__closure__))["func"]
875
1112
                                nonmethod_func.func_name,
876
1113
                                nonmethod_func.func_defaults,
877
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
878
1121
                    # Define a creator of a function to call both the
879
 
                    # old and new functions, so both the old and new
880
 
                    # 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
881
1125
                    def fixscope(func1, func2):
882
1126
                        """This function is a scope container to pass
883
1127
                        func1 and func2 to the "call_both" function
890
1134
                        return call_both
891
1135
                    # Create the "call_both" function and add it to
892
1136
                    # the class
893
 
                    attr[attrname] = fixscope(attribute,
894
 
                                              new_function)
 
1137
                    attr[attrname] = fixscope(attribute, new_function)
895
1138
                # Is this a D-Bus method?
896
1139
                elif getattr(attribute, "_dbus_is_method", False):
897
1140
                    # Create a new, but exactly alike, function
908
1151
                                        attribute.func_name,
909
1152
                                        attribute.func_defaults,
910
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
911
1160
                # Is this a D-Bus property?
912
1161
                elif getattr(attribute, "_dbus_is_property", False):
913
1162
                    # Create a new, but exactly alike, function
927
1176
                                        attribute.func_name,
928
1177
                                        attribute.func_defaults,
929
1178
                                        attribute.func_closure)))
930
 
        return type.__new__(mcs, name, bases, attr)
931
 
 
 
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"})
932
1224
class ClientDBus(Client, DBusObjectWithProperties):
933
1225
    """A Client class using D-Bus
934
1226
    
940
1232
    runtime_expansions = (Client.runtime_expansions
941
1233
                          + ("dbus_object_path",))
942
1234
    
 
1235
    _interface = "se.recompile.Mandos.Client"
 
1236
    
943
1237
    # dbus.service.Object doesn't use super(), so we can't either.
944
1238
    
945
1239
    def __init__(self, bus = None, *args, **kwargs):
946
1240
        self.bus = bus
947
1241
        Client.__init__(self, *args, **kwargs)
948
 
 
949
 
        self._approvals_pending = 0
950
1242
        # Only now, when this client is initialized, can it show up on
951
1243
        # the D-Bus
952
 
        client_object_name = unicode(self.name).translate(
 
1244
        client_object_name = str(self.name).translate(
953
1245
            {ord("."): ord("_"),
954
1246
             ord("-"): ord("_")})
955
1247
        self.dbus_object_path = (dbus.ObjectPath
956
1248
                                 ("/clients/" + client_object_name))
957
1249
        DBusObjectWithProperties.__init__(self, self.bus,
958
1250
                                          self.dbus_object_path)
959
 
        
 
1251
    
960
1252
    def notifychangeproperty(transform_func,
961
1253
                             dbus_name, type_func=lambda x: x,
962
 
                             variant_level=1):
 
1254
                             variant_level=1, invalidate_only=False,
 
1255
                             _interface=_interface):
963
1256
        """ Modify a variable so that it's a property which announces
964
1257
        its changes to DBus.
965
 
 
 
1258
        
966
1259
        transform_fun: Function that takes a value and a variant_level
967
1260
                       and transforms it to a D-Bus type.
968
1261
        dbus_name: D-Bus name of the variable
970
1263
                   to the D-Bus.  Default: no transform
971
1264
        variant_level: D-Bus variant level.  Default: 1
972
1265
        """
973
 
        attrname = "_{0}".format(dbus_name)
 
1266
        attrname = "_{}".format(dbus_name)
974
1267
        def setter(self, value):
975
1268
            if hasattr(self, "dbus_object_path"):
976
1269
                if (not hasattr(self, attrname) or
977
1270
                    type_func(getattr(self, attrname, None))
978
1271
                    != type_func(value)):
979
 
                    dbus_value = transform_func(type_func(value),
980
 
                                                variant_level
981
 
                                                =variant_level)
982
 
                    self.PropertyChanged(dbus.String(dbus_name),
983
 
                                         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())
984
1287
            setattr(self, attrname, value)
985
1288
        
986
1289
        return property(lambda self: getattr(self, attrname), setter)
987
1290
    
988
 
    
989
1291
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
990
1292
    approvals_pending = notifychangeproperty(dbus.Boolean,
991
1293
                                             "ApprovalPending",
998
1300
                                       checker is not None)
999
1301
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1000
1302
                                           "LastCheckedOK")
 
1303
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1304
                                               "LastCheckerStatus")
1001
1305
    last_approval_request = notifychangeproperty(
1002
1306
        datetime_to_dbus, "LastApprovalRequest")
1003
1307
    approved_by_default = notifychangeproperty(dbus.Boolean,
1004
1308
                                               "ApprovedByDefault")
1005
 
    approval_delay = notifychangeproperty(dbus.UInt16,
 
1309
    approval_delay = notifychangeproperty(dbus.UInt64,
1006
1310
                                          "ApprovalDelay",
1007
1311
                                          type_func =
1008
 
                                          _timedelta_to_milliseconds)
 
1312
                                          lambda td: td.total_seconds()
 
1313
                                          * 1000)
1009
1314
    approval_duration = notifychangeproperty(
1010
 
        dbus.UInt16, "ApprovalDuration",
1011
 
        type_func = _timedelta_to_milliseconds)
 
1315
        dbus.UInt64, "ApprovalDuration",
 
1316
        type_func = lambda td: td.total_seconds() * 1000)
1012
1317
    host = notifychangeproperty(dbus.String, "Host")
1013
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1014
 
                                   type_func =
1015
 
                                   _timedelta_to_milliseconds)
 
1318
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1319
                                   type_func = lambda td:
 
1320
                                       td.total_seconds() * 1000)
1016
1321
    extended_timeout = notifychangeproperty(
1017
 
        dbus.UInt16, "ExtendedTimeout",
1018
 
        type_func = _timedelta_to_milliseconds)
1019
 
    interval = notifychangeproperty(dbus.UInt16,
 
1322
        dbus.UInt64, "ExtendedTimeout",
 
1323
        type_func = lambda td: td.total_seconds() * 1000)
 
1324
    interval = notifychangeproperty(dbus.UInt64,
1020
1325
                                    "Interval",
1021
1326
                                    type_func =
1022
 
                                    _timedelta_to_milliseconds)
 
1327
                                    lambda td: td.total_seconds()
 
1328
                                    * 1000)
1023
1329
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1330
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1331
                                  invalidate_only=True)
1024
1332
    
1025
1333
    del notifychangeproperty
1026
1334
    
1053
1361
                                       *args, **kwargs)
1054
1362
    
1055
1363
    def start_checker(self, *args, **kwargs):
1056
 
        old_checker = self.checker
1057
 
        if self.checker is not None:
1058
 
            old_checker_pid = self.checker.pid
1059
 
        else:
1060
 
            old_checker_pid = None
 
1364
        old_checker_pid = getattr(self.checker, "pid", None)
1061
1365
        r = Client.start_checker(self, *args, **kwargs)
1062
1366
        # Only if new checker process was started
1063
1367
        if (self.checker is not None
1067
1371
        return r
1068
1372
    
1069
1373
    def _reset_approved(self):
1070
 
        self._approved = None
 
1374
        self.approved = None
1071
1375
        return False
1072
1376
    
1073
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)
1074
1381
        self.send_changedstate()
1075
 
        self._approved = value
1076
 
        gobject.timeout_add(_timedelta_to_milliseconds
1077
 
                            (self.approval_duration),
1078
 
                            self._reset_approved)
1079
 
    
1080
1382
    
1081
1383
    ## D-Bus methods, signals & properties
1082
 
    _interface = "se.recompile.Mandos.Client"
 
1384
    
 
1385
    ## Interfaces
1083
1386
    
1084
1387
    ## Signals
1085
1388
    
1096
1399
        pass
1097
1400
    
1098
1401
    # PropertyChanged - signal
 
1402
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1099
1403
    @dbus.service.signal(_interface, signature="sv")
1100
1404
    def PropertyChanged(self, property, value):
1101
1405
        "D-Bus signal"
1177
1481
                           access="readwrite")
1178
1482
    def ApprovalDelay_dbus_property(self, value=None):
1179
1483
        if value is None:       # get
1180
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1484
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1485
                               * 1000)
1181
1486
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1182
1487
    
1183
1488
    # ApprovalDuration - property
1185
1490
                           access="readwrite")
1186
1491
    def ApprovalDuration_dbus_property(self, value=None):
1187
1492
        if value is None:       # get
1188
 
            return dbus.UInt64(_timedelta_to_milliseconds(
1189
 
                    self.approval_duration))
 
1493
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1494
                               * 1000)
1190
1495
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1191
1496
    
1192
1497
    # Name - property
1205
1510
    def Host_dbus_property(self, value=None):
1206
1511
        if value is None:       # get
1207
1512
            return dbus.String(self.host)
1208
 
        self.host = value
 
1513
        self.host = str(value)
1209
1514
    
1210
1515
    # Created - property
1211
1516
    @dbus_service_property(_interface, signature="s", access="read")
1212
1517
    def Created_dbus_property(self):
1213
 
        return dbus.String(datetime_to_dbus(self.created))
 
1518
        return datetime_to_dbus(self.created)
1214
1519
    
1215
1520
    # LastEnabled - property
1216
1521
    @dbus_service_property(_interface, signature="s", access="read")
1237
1542
            return
1238
1543
        return datetime_to_dbus(self.last_checked_ok)
1239
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
    
1240
1551
    # Expires - property
1241
1552
    @dbus_service_property(_interface, signature="s", access="read")
1242
1553
    def Expires_dbus_property(self):
1252
1563
                           access="readwrite")
1253
1564
    def Timeout_dbus_property(self, value=None):
1254
1565
        if value is None:       # get
1255
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1566
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1567
        old_timeout = self.timeout
1256
1568
        self.timeout = datetime.timedelta(0, 0, 0, value)
1257
 
        if getattr(self, "disable_initiator_tag", None) is None:
1258
 
            return
1259
 
        # Reschedule timeout
1260
 
        gobject.source_remove(self.disable_initiator_tag)
1261
 
        self.disable_initiator_tag = None
1262
 
        self.expires = None
1263
 
        time_to_die = _timedelta_to_milliseconds((self
1264
 
                                                  .last_checked_ok
1265
 
                                                  + self.timeout)
1266
 
                                                 - datetime.datetime
1267
 
                                                 .utcnow())
1268
 
        if time_to_die <= 0:
1269
 
            # The timeout has passed
1270
 
            self.disable()
1271
 
        else:
1272
 
            self.expires = (datetime.datetime.utcnow()
1273
 
                            + datetime.timedelta(milliseconds =
1274
 
                                                 time_to_die))
1275
 
            self.disable_initiator_tag = (gobject.timeout_add
1276
 
                                          (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))
1277
1585
    
1278
1586
    # ExtendedTimeout - property
1279
1587
    @dbus_service_property(_interface, signature="t",
1280
1588
                           access="readwrite")
1281
1589
    def ExtendedTimeout_dbus_property(self, value=None):
1282
1590
        if value is None:       # get
1283
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1591
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1592
                               * 1000)
1284
1593
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1285
1594
    
1286
1595
    # Interval - property
1288
1597
                           access="readwrite")
1289
1598
    def Interval_dbus_property(self, value=None):
1290
1599
        if value is None:       # get
1291
 
            return dbus.UInt64(self.interval_milliseconds())
 
1600
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1292
1601
        self.interval = datetime.timedelta(0, 0, 0, value)
1293
1602
        if getattr(self, "checker_initiator_tag", None) is None:
1294
1603
            return
1295
 
        # Reschedule checker run
1296
 
        gobject.source_remove(self.checker_initiator_tag)
1297
 
        self.checker_initiator_tag = (gobject.timeout_add
1298
 
                                      (value, self.start_checker))
1299
 
        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
1300
1610
    
1301
1611
    # Checker - property
1302
1612
    @dbus_service_property(_interface, signature="s",
1304
1614
    def Checker_dbus_property(self, value=None):
1305
1615
        if value is None:       # get
1306
1616
            return dbus.String(self.checker_command)
1307
 
        self.checker_command = value
 
1617
        self.checker_command = str(value)
1308
1618
    
1309
1619
    # CheckerRunning - property
1310
1620
    @dbus_service_property(_interface, signature="b",
1326
1636
    @dbus_service_property(_interface, signature="ay",
1327
1637
                           access="write", byte_arrays=True)
1328
1638
    def Secret_dbus_property(self, value):
1329
 
        self.secret = str(value)
 
1639
        self.secret = bytes(value)
1330
1640
    
1331
1641
    del _interface
1332
1642
 
1339
1649
            raise KeyError()
1340
1650
    
1341
1651
    def __getattribute__(self, name):
1342
 
        if(name == '_pipe'):
 
1652
        if name == '_pipe':
1343
1653
            return super(ProxyClient, self).__getattribute__(name)
1344
1654
        self._pipe.send(('getattr', name))
1345
1655
        data = self._pipe.recv()
1352
1662
            return func
1353
1663
    
1354
1664
    def __setattr__(self, name, value):
1355
 
        if(name == '_pipe'):
 
1665
        if name == '_pipe':
1356
1666
            return super(ProxyClient, self).__setattr__(name, value)
1357
1667
        self._pipe.send(('setattr', name, value))
1358
1668
 
1359
 
class ClientDBusTransitional(ClientDBus):
1360
 
    __metaclass__ = AlternateDBusNamesMetaclass
1361
1669
 
1362
1670
class ClientHandler(socketserver.BaseRequestHandler, object):
1363
1671
    """A class to handle client connections.
1368
1676
    def handle(self):
1369
1677
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1370
1678
            logger.info("TCP connection from: %s",
1371
 
                        unicode(self.client_address))
 
1679
                        str(self.client_address))
1372
1680
            logger.debug("Pipe FD: %d",
1373
1681
                         self.server.child_pipe.fileno())
1374
1682
            
1400
1708
            logger.debug("Protocol version: %r", line)
1401
1709
            try:
1402
1710
                if int(line.strip().split()[0]) > 1:
1403
 
                    raise RuntimeError
 
1711
                    raise RuntimeError(line)
1404
1712
            except (ValueError, IndexError, RuntimeError) as error:
1405
1713
                logger.error("Unknown protocol version: %s", error)
1406
1714
                return
1446
1754
                            client.Rejected("Disabled")
1447
1755
                        return
1448
1756
                    
1449
 
                    if client._approved or not client.approval_delay:
 
1757
                    if client.approved or not client.approval_delay:
1450
1758
                        #We are approved or approval is disabled
1451
1759
                        break
1452
 
                    elif client._approved is None:
 
1760
                    elif client.approved is None:
1453
1761
                        logger.info("Client %s needs approval",
1454
1762
                                    client.name)
1455
1763
                        if self.server.use_dbus:
1456
1764
                            # Emit D-Bus signal
1457
1765
                            client.NeedApproval(
1458
 
                                client.approval_delay_milliseconds(),
1459
 
                                client.approved_by_default)
 
1766
                                client.approval_delay.total_seconds()
 
1767
                                * 1000, client.approved_by_default)
1460
1768
                    else:
1461
1769
                        logger.warning("Client %s was not approved",
1462
1770
                                       client.name)
1468
1776
                    #wait until timeout or approved
1469
1777
                    time = datetime.datetime.now()
1470
1778
                    client.changedstate.acquire()
1471
 
                    (client.changedstate.wait
1472
 
                     (float(client._timedelta_to_milliseconds(delay)
1473
 
                            / 1000)))
 
1779
                    client.changedstate.wait(delay.total_seconds())
1474
1780
                    client.changedstate.release()
1475
1781
                    time2 = datetime.datetime.now()
1476
1782
                    if (time2 - time) >= delay:
1492
1798
                    try:
1493
1799
                        sent = session.send(client.secret[sent_size:])
1494
1800
                    except gnutls.errors.GNUTLSError as error:
1495
 
                        logger.warning("gnutls send failed")
 
1801
                        logger.warning("gnutls send failed",
 
1802
                                       exc_info=error)
1496
1803
                        return
1497
1804
                    logger.debug("Sent: %d, remaining: %d",
1498
1805
                                 sent, len(client.secret)
1501
1808
                
1502
1809
                logger.info("Sending secret to %s", client.name)
1503
1810
                # bump the timeout using extended_timeout
1504
 
                client.checked_ok(client.extended_timeout)
 
1811
                client.bump_timeout(client.extended_timeout)
1505
1812
                if self.server.use_dbus:
1506
1813
                    # Emit D-Bus signal
1507
1814
                    client.GotSecret()
1512
1819
                try:
1513
1820
                    session.bye()
1514
1821
                except gnutls.errors.GNUTLSError as error:
1515
 
                    logger.warning("GnuTLS bye failed")
 
1822
                    logger.warning("GnuTLS bye failed",
 
1823
                                   exc_info=error)
1516
1824
    
1517
1825
    @staticmethod
1518
1826
    def peer_certificate(session):
1574
1882
        # Convert the buffer to a Python bytestring
1575
1883
        fpr = ctypes.string_at(buf, buf_len.value)
1576
1884
        # Convert the bytestring to hexadecimal notation
1577
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1885
        hex_fpr = binascii.hexlify(fpr).upper()
1578
1886
        return hex_fpr
1579
1887
 
1580
1888
 
1583
1891
    def sub_process_main(self, request, address):
1584
1892
        try:
1585
1893
            self.finish_request(request, address)
1586
 
        except:
 
1894
        except Exception:
1587
1895
            self.handle_error(request, address)
1588
1896
        self.close_request(request)
1589
1897
    
1590
1898
    def process_request(self, request, address):
1591
1899
        """Start a new process to process the request."""
1592
1900
        proc = multiprocessing.Process(target = self.sub_process_main,
1593
 
                                       args = (request,
1594
 
                                               address))
 
1901
                                       args = (request, address))
1595
1902
        proc.start()
1596
1903
        return proc
1597
1904
 
1612
1919
    
1613
1920
    def add_pipe(self, parent_pipe, proc):
1614
1921
        """Dummy function; override as necessary"""
1615
 
        raise NotImplementedError
 
1922
        raise NotImplementedError()
1616
1923
 
1617
1924
 
1618
1925
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1625
1932
        use_ipv6:       Boolean; to use IPv6 or not
1626
1933
    """
1627
1934
    def __init__(self, server_address, RequestHandlerClass,
1628
 
                 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
        """
1629
1939
        self.interface = interface
1630
1940
        if use_ipv6:
1631
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.
1632
1968
        socketserver.TCPServer.__init__(self, server_address,
1633
1969
                                        RequestHandlerClass)
 
1970
    
1634
1971
    def server_bind(self):
1635
1972
        """This overrides the normal server_bind() function
1636
1973
        to bind to an interface if one was specified, and also NOT to
1644
1981
                try:
1645
1982
                    self.socket.setsockopt(socket.SOL_SOCKET,
1646
1983
                                           SO_BINDTODEVICE,
1647
 
                                           str(self.interface
1648
 
                                               + '\0'))
 
1984
                                           (self.interface + "\0")
 
1985
                                           .encode("utf-8"))
1649
1986
                except socket.error as error:
1650
 
                    if error[0] == errno.EPERM:
1651
 
                        logger.error("No permission to"
1652
 
                                     " bind to interface %s",
1653
 
                                     self.interface)
1654
 
                    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:
1655
1991
                        logger.error("SO_BINDTODEVICE not available;"
1656
1992
                                     " cannot bind to interface %s",
1657
1993
                                     self.interface)
 
1994
                    elif error.errno == errno.ENODEV:
 
1995
                        logger.error("Interface %s does not exist,"
 
1996
                                     " cannot bind", self.interface)
1658
1997
                    else:
1659
1998
                        raise
1660
1999
        # Only bind(2) the socket if we really need to.
1663
2002
                if self.address_family == socket.AF_INET6:
1664
2003
                    any_address = "::" # in6addr_any
1665
2004
                else:
1666
 
                    any_address = socket.INADDR_ANY
 
2005
                    any_address = "0.0.0.0" # INADDR_ANY
1667
2006
                self.server_address = (any_address,
1668
2007
                                       self.server_address[1])
1669
2008
            elif not self.server_address[1]:
1690
2029
    """
1691
2030
    def __init__(self, server_address, RequestHandlerClass,
1692
2031
                 interface=None, use_ipv6=True, clients=None,
1693
 
                 gnutls_priority=None, use_dbus=True):
 
2032
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1694
2033
        self.enabled = False
1695
2034
        self.clients = clients
1696
2035
        if self.clients is None:
1700
2039
        IPv6_TCPServer.__init__(self, server_address,
1701
2040
                                RequestHandlerClass,
1702
2041
                                interface = interface,
1703
 
                                use_ipv6 = use_ipv6)
 
2042
                                use_ipv6 = use_ipv6,
 
2043
                                socketfd = socketfd)
1704
2044
    def server_activate(self):
1705
2045
        if self.enabled:
1706
2046
            return socketserver.TCPServer.server_activate(self)
1719
2059
    
1720
2060
    def handle_ipc(self, source, condition, parent_pipe=None,
1721
2061
                   proc = None, client_object=None):
1722
 
        condition_names = {
1723
 
            gobject.IO_IN: "IN",   # There is data to read.
1724
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1725
 
                                    # blocking).
1726
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1727
 
            gobject.IO_ERR: "ERR", # Error condition.
1728
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1729
 
                                    # broken, usually for pipes and
1730
 
                                    # sockets).
1731
 
            }
1732
 
        conditions_string = ' | '.join(name
1733
 
                                       for cond, name in
1734
 
                                       condition_names.iteritems()
1735
 
                                       if cond & condition)
1736
2062
        # error, or the other end of multiprocessing.Pipe has closed
1737
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2063
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1738
2064
            # Wait for other process to exit
1739
2065
            proc.join()
1740
2066
            return False
1798
2124
        return True
1799
2125
 
1800
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
 
1801
2226
def string_to_delta(interval):
1802
2227
    """Parse a string and return a datetime.timedelta
1803
2228
    
1814
2239
    >>> string_to_delta('5m 30s')
1815
2240
    datetime.timedelta(0, 330)
1816
2241
    """
 
2242
    
 
2243
    try:
 
2244
        return rfc3339_duration_to_delta(interval)
 
2245
    except ValueError:
 
2246
        pass
 
2247
    
1817
2248
    timevalue = datetime.timedelta(0)
1818
2249
    for s in interval.split():
1819
2250
        try:
1820
 
            suffix = unicode(s[-1])
 
2251
            suffix = s[-1]
1821
2252
            value = int(s[:-1])
1822
2253
            if suffix == "d":
1823
2254
                delta = datetime.timedelta(value)
1830
2261
            elif suffix == "w":
1831
2262
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1832
2263
            else:
1833
 
                raise ValueError("Unknown suffix %r" % suffix)
1834
 
        except (ValueError, IndexError) as e:
 
2264
                raise ValueError("Unknown suffix {!r}"
 
2265
                                 .format(suffix))
 
2266
        except IndexError as e:
1835
2267
            raise ValueError(*(e.args))
1836
2268
        timevalue += delta
1837
2269
    return timevalue
1838
2270
 
1839
2271
 
1840
 
def if_nametoindex(interface):
1841
 
    """Call the C function if_nametoindex(), or equivalent
1842
 
    
1843
 
    Note: This function cannot accept a unicode string."""
1844
 
    global if_nametoindex
1845
 
    try:
1846
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1847
 
                          (ctypes.util.find_library("c"))
1848
 
                          .if_nametoindex)
1849
 
    except (OSError, AttributeError):
1850
 
        logger.warning("Doing if_nametoindex the hard way")
1851
 
        def if_nametoindex(interface):
1852
 
            "Get an interface index the hard way, i.e. using fcntl()"
1853
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1854
 
            with contextlib.closing(socket.socket()) as s:
1855
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1856
 
                                    struct.pack(str("16s16x"),
1857
 
                                                interface))
1858
 
            interface_index = struct.unpack(str("I"),
1859
 
                                            ifreq[16:20])[0]
1860
 
            return interface_index
1861
 
    return if_nametoindex(interface)
1862
 
 
1863
 
 
1864
2272
def daemon(nochdir = False, noclose = False):
1865
2273
    """See daemon(3).  Standard BSD Unix function.
1866
2274
    
1874
2282
        sys.exit()
1875
2283
    if not noclose:
1876
2284
        # Close all standard open file descriptors
1877
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2285
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1878
2286
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1879
 
            raise OSError(errno.ENODEV,
1880
 
                          "%s not a character device"
1881
 
                          % os.path.devnull)
 
2287
            raise OSError(errno.ENODEV, "{} not a character device"
 
2288
                          .format(os.devnull))
1882
2289
        os.dup2(null, sys.stdin.fileno())
1883
2290
        os.dup2(null, sys.stdout.fileno())
1884
2291
        os.dup2(null, sys.stderr.fileno())
1893
2300
    
1894
2301
    parser = argparse.ArgumentParser()
1895
2302
    parser.add_argument("-v", "--version", action="version",
1896
 
                        version = "%%(prog)s %s" % version,
 
2303
                        version = "%(prog)s {}".format(version),
1897
2304
                        help="show version number and exit")
1898
2305
    parser.add_argument("-i", "--interface", metavar="IF",
1899
2306
                        help="Bind to interface IF")
1905
2312
                        help="Run self-test")
1906
2313
    parser.add_argument("--debug", action="store_true",
1907
2314
                        help="Debug mode; run in foreground and log"
1908
 
                        " to terminal")
 
2315
                        " to terminal", default=None)
1909
2316
    parser.add_argument("--debuglevel", metavar="LEVEL",
1910
2317
                        help="Debug level for stdout output")
1911
2318
    parser.add_argument("--priority", help="GnuTLS"
1918
2325
                        " files")
1919
2326
    parser.add_argument("--no-dbus", action="store_false",
1920
2327
                        dest="use_dbus", help="Do not provide D-Bus"
1921
 
                        " system bus interface")
 
2328
                        " system bus interface", default=None)
1922
2329
    parser.add_argument("--no-ipv6", action="store_false",
1923
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2330
                        dest="use_ipv6", help="Do not use IPv6",
 
2331
                        default=None)
1924
2332
    parser.add_argument("--no-restore", action="store_false",
1925
 
                        dest="restore", help="Do not restore stored state",
1926
 
                        default=True)
1927
 
 
 
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
    
1928
2346
    options = parser.parse_args()
1929
2347
    
1930
2348
    if options.check:
1931
2349
        import doctest
1932
 
        doctest.testmod()
1933
 
        sys.exit()
 
2350
        fail_count, test_count = doctest.testmod()
 
2351
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1934
2352
    
1935
2353
    # Default values for config file for server-global settings
1936
2354
    server_defaults = { "interface": "",
1938
2356
                        "port": "",
1939
2357
                        "debug": "False",
1940
2358
                        "priority":
1941
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2359
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2360
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1942
2361
                        "servicename": "Mandos",
1943
2362
                        "use_dbus": "True",
1944
2363
                        "use_ipv6": "True",
1945
2364
                        "debuglevel": "",
 
2365
                        "restore": "True",
 
2366
                        "socket": "",
 
2367
                        "statedir": "/var/lib/mandos",
 
2368
                        "foreground": "False",
 
2369
                        "zeroconf": "True",
1946
2370
                        }
1947
2371
    
1948
2372
    # Parse config file for server-global settings
1953
2377
    # Convert the SafeConfigParser object to a dict
1954
2378
    server_settings = server_config.defaults()
1955
2379
    # Use the appropriate methods on the non-string config options
1956
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2380
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1957
2381
        server_settings[option] = server_config.getboolean("DEFAULT",
1958
2382
                                                           option)
1959
2383
    if server_settings["port"]:
1960
2384
        server_settings["port"] = server_config.getint("DEFAULT",
1961
2385
                                                       "port")
 
2386
    if server_settings["socket"]:
 
2387
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2388
                                                         "socket")
 
2389
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2390
        # over with an opened os.devnull.  But we don't want this to
 
2391
        # happen with a supplied network socket.
 
2392
        if 0 <= server_settings["socket"] <= 2:
 
2393
            server_settings["socket"] = os.dup(server_settings
 
2394
                                               ["socket"])
1962
2395
    del server_config
1963
2396
    
1964
2397
    # Override the settings from the config file with command line
1965
2398
    # options, if set.
1966
2399
    for option in ("interface", "address", "port", "debug",
1967
2400
                   "priority", "servicename", "configdir",
1968
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore"):
 
2401
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2402
                   "statedir", "socket", "foreground", "zeroconf"):
1969
2403
        value = getattr(options, option)
1970
2404
        if value is not None:
1971
2405
            server_settings[option] = value
1972
2406
    del options
1973
2407
    # Force all strings to be unicode
1974
2408
    for option in server_settings.keys():
1975
 
        if type(server_settings[option]) is str:
1976
 
            server_settings[option] = unicode(server_settings[option])
 
2409
        if isinstance(server_settings[option], bytes):
 
2410
            server_settings[option] = (server_settings[option]
 
2411
                                       .decode("utf-8"))
 
2412
    # Force all boolean options to be boolean
 
2413
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2414
                   "foreground", "zeroconf"):
 
2415
        server_settings[option] = bool(server_settings[option])
 
2416
    # Debug implies foreground
 
2417
    if server_settings["debug"]:
 
2418
        server_settings["foreground"] = True
1977
2419
    # Now we have our good server settings in "server_settings"
1978
2420
    
1979
2421
    ##################################################################
1980
2422
    
 
2423
    if (not server_settings["zeroconf"] and
 
2424
        not (server_settings["port"]
 
2425
             or server_settings["socket"] != "")):
 
2426
            parser.error("Needs port or socket to work without"
 
2427
                         " Zeroconf")
 
2428
    
1981
2429
    # For convenience
1982
2430
    debug = server_settings["debug"]
1983
2431
    debuglevel = server_settings["debuglevel"]
1984
2432
    use_dbus = server_settings["use_dbus"]
1985
2433
    use_ipv6 = server_settings["use_ipv6"]
 
2434
    stored_state_path = os.path.join(server_settings["statedir"],
 
2435
                                     stored_state_file)
 
2436
    foreground = server_settings["foreground"]
 
2437
    zeroconf = server_settings["zeroconf"]
 
2438
    
 
2439
    if debug:
 
2440
        initlogger(debug, logging.DEBUG)
 
2441
    else:
 
2442
        if not debuglevel:
 
2443
            initlogger(debug)
 
2444
        else:
 
2445
            level = getattr(logging, debuglevel.upper())
 
2446
            initlogger(debug, level)
1986
2447
    
1987
2448
    if server_settings["servicename"] != "Mandos":
1988
2449
        syslogger.setFormatter(logging.Formatter
1989
 
                               ('Mandos (%s) [%%(process)d]:'
1990
 
                                ' %%(levelname)s: %%(message)s'
1991
 
                                % server_settings["servicename"]))
 
2450
                               ('Mandos ({}) [%(process)d]:'
 
2451
                                ' %(levelname)s: %(message)s'
 
2452
                                .format(server_settings
 
2453
                                        ["servicename"])))
1992
2454
    
1993
2455
    # Parse config file with clients
1994
 
    client_defaults = { "timeout": "5m",
1995
 
                        "extended_timeout": "15m",
1996
 
                        "interval": "2m",
1997
 
                        "checker": "fping -q -- %%(host)s",
1998
 
                        "host": "",
1999
 
                        "approval_delay": "0s",
2000
 
                        "approval_duration": "1s",
2001
 
                        }
2002
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2456
    client_config = configparser.SafeConfigParser(Client
 
2457
                                                  .client_defaults)
2003
2458
    client_config.read(os.path.join(server_settings["configdir"],
2004
2459
                                    "clients.conf"))
2005
2460
    
2006
2461
    global mandos_dbus_service
2007
2462
    mandos_dbus_service = None
2008
2463
    
 
2464
    socketfd = None
 
2465
    if server_settings["socket"] != "":
 
2466
        socketfd = server_settings["socket"]
2009
2467
    tcp_server = MandosServer((server_settings["address"],
2010
2468
                               server_settings["port"]),
2011
2469
                              ClientHandler,
2014
2472
                              use_ipv6=use_ipv6,
2015
2473
                              gnutls_priority=
2016
2474
                              server_settings["priority"],
2017
 
                              use_dbus=use_dbus)
2018
 
    if not debug:
2019
 
        pidfilename = "/var/run/mandos.pid"
 
2475
                              use_dbus=use_dbus,
 
2476
                              socketfd=socketfd)
 
2477
    if not foreground:
 
2478
        pidfilename = "/run/mandos.pid"
 
2479
        if not os.path.isdir("/run/."):
 
2480
            pidfilename = "/var/run/mandos.pid"
 
2481
        pidfile = None
2020
2482
        try:
2021
2483
            pidfile = open(pidfilename, "w")
2022
 
        except IOError:
2023
 
            logger.error("Could not open file %r", pidfilename)
 
2484
        except IOError as e:
 
2485
            logger.error("Could not open file %r", pidfilename,
 
2486
                         exc_info=e)
2024
2487
    
2025
 
    try:
2026
 
        uid = pwd.getpwnam("_mandos").pw_uid
2027
 
        gid = pwd.getpwnam("_mandos").pw_gid
2028
 
    except KeyError:
 
2488
    for name in ("_mandos", "mandos", "nobody"):
2029
2489
        try:
2030
 
            uid = pwd.getpwnam("mandos").pw_uid
2031
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2490
            uid = pwd.getpwnam(name).pw_uid
 
2491
            gid = pwd.getpwnam(name).pw_gid
 
2492
            break
2032
2493
        except KeyError:
2033
 
            try:
2034
 
                uid = pwd.getpwnam("nobody").pw_uid
2035
 
                gid = pwd.getpwnam("nobody").pw_gid
2036
 
            except KeyError:
2037
 
                uid = 65534
2038
 
                gid = 65534
 
2494
            continue
 
2495
    else:
 
2496
        uid = 65534
 
2497
        gid = 65534
2039
2498
    try:
2040
2499
        os.setgid(gid)
2041
2500
        os.setuid(uid)
2042
2501
    except OSError as error:
2043
 
        if error[0] != errno.EPERM:
2044
 
            raise error
2045
 
    
2046
 
    if not debug and not debuglevel:
2047
 
        logger.setLevel(logging.WARNING)
2048
 
    if debuglevel:
2049
 
        level = getattr(logging, debuglevel.upper())
2050
 
        logger.setLevel(level)
 
2502
        if error.errno != errno.EPERM:
 
2503
            raise
2051
2504
    
2052
2505
    if debug:
2053
 
        logger.setLevel(logging.DEBUG)
2054
2506
        # Enable all possible GnuTLS debugging
2055
2507
        
2056
2508
        # "Use a log level over 10 to enable all debugging options."
2065
2517
         .gnutls_global_set_log_function(debug_gnutls))
2066
2518
        
2067
2519
        # Redirect stdin so all checkers get /dev/null
2068
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2520
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2069
2521
        os.dup2(null, sys.stdin.fileno())
2070
2522
        if null > 2:
2071
2523
            os.close(null)
2072
 
    else:
2073
 
        # No console logging
2074
 
        logger.removeHandler(console)
2075
2524
    
2076
2525
    # Need to fork before connecting to D-Bus
2077
 
    if not debug:
 
2526
    if not foreground:
2078
2527
        # Close all input and output, do double fork, etc.
2079
2528
        daemon()
2080
2529
    
 
2530
    # multiprocessing will use threads, so before we use gobject we
 
2531
    # need to inform gobject that threads will be used.
 
2532
    gobject.threads_init()
 
2533
    
2081
2534
    global main_loop
2082
2535
    # From the Avahi example code
2083
 
    DBusGMainLoop(set_as_default=True )
 
2536
    DBusGMainLoop(set_as_default=True)
2084
2537
    main_loop = gobject.MainLoop()
2085
2538
    bus = dbus.SystemBus()
2086
2539
    # End of Avahi example code
2092
2545
                            ("se.bsnet.fukt.Mandos", bus,
2093
2546
                             do_not_queue=True))
2094
2547
        except dbus.exceptions.NameExistsException as e:
2095
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2548
            logger.error("Disabling D-Bus:", exc_info=e)
2096
2549
            use_dbus = False
2097
2550
            server_settings["use_dbus"] = False
2098
2551
            tcp_server.use_dbus = False
2099
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2100
 
    service = AvahiServiceToSyslog(name =
2101
 
                                   server_settings["servicename"],
2102
 
                                   servicetype = "_mandos._tcp",
2103
 
                                   protocol = protocol, bus = bus)
2104
 
    if server_settings["interface"]:
2105
 
        service.interface = (if_nametoindex
2106
 
                             (str(server_settings["interface"])))
 
2552
    if zeroconf:
 
2553
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2554
        service = AvahiServiceToSyslog(name =
 
2555
                                       server_settings["servicename"],
 
2556
                                       servicetype = "_mandos._tcp",
 
2557
                                       protocol = protocol, bus = bus)
 
2558
        if server_settings["interface"]:
 
2559
            service.interface = (if_nametoindex
 
2560
                                 (server_settings["interface"]
 
2561
                                  .encode("utf-8")))
2107
2562
    
2108
2563
    global multiprocessing_manager
2109
2564
    multiprocessing_manager = multiprocessing.Manager()
2110
2565
    
2111
2566
    client_class = Client
2112
2567
    if use_dbus:
2113
 
        client_class = functools.partial(ClientDBusTransitional,
2114
 
                                         bus = bus)
2115
 
    
2116
 
    special_settings = {
2117
 
        # Some settings need to be accessd by special methods;
2118
 
        # booleans need .getboolean(), etc.  Here is a list of them:
2119
 
        "approved_by_default":
2120
 
            lambda section:
2121
 
            client_config.getboolean(section, "approved_by_default"),
2122
 
        }
2123
 
    # Construct a new dict of client settings of this form:
2124
 
    # { client_name: {setting_name: value, ...}, ...}
2125
 
    # with exceptions for any special settings as defined above
2126
 
    client_settings = dict((clientname,
2127
 
                           dict((setting,
2128
 
                                 (value if setting not in special_settings
2129
 
                                  else special_settings[setting](clientname)))
2130
 
                                for setting, value in client_config.items(clientname)))
2131
 
                          for clientname in client_config.sections())
2132
 
    
 
2568
        client_class = functools.partial(ClientDBus, bus = bus)
 
2569
    
 
2570
    client_settings = Client.config_parser(client_config)
2133
2571
    old_client_settings = {}
2134
 
    clients_data = []
2135
 
 
2136
 
    # Get client data and settings from last running state. 
 
2572
    clients_data = {}
 
2573
    
 
2574
    # This is used to redirect stdout and stderr for checker processes
 
2575
    global wnull
 
2576
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2577
    # Only used if server is running in foreground but not in debug
 
2578
    # mode
 
2579
    if debug or not foreground:
 
2580
        wnull.close()
 
2581
    
 
2582
    # Get client data and settings from last running state.
2137
2583
    if server_settings["restore"]:
2138
2584
        try:
2139
2585
            with open(stored_state_path, "rb") as stored_state:
2140
 
                clients_data, old_client_settings = pickle.load(stored_state)
 
2586
                clients_data, old_client_settings = (pickle.load
 
2587
                                                     (stored_state))
2141
2588
            os.remove(stored_state_path)
2142
2589
        except IOError as e:
2143
 
            logger.warning("Could not load persistant state: {0}".format(e))
2144
 
            if e.errno != errno.ENOENT:
 
2590
            if e.errno == errno.ENOENT:
 
2591
                logger.warning("Could not load persistent state: {}"
 
2592
                                .format(os.strerror(e.errno)))
 
2593
            else:
 
2594
                logger.critical("Could not load persistent state:",
 
2595
                                exc_info=e)
2145
2596
                raise
2146
 
 
2147
 
    for client in clients_data:
2148
 
        client_name = client["name"]
2149
 
        
2150
 
        # Decide which value to use after restoring saved state.
2151
 
        # We have three different values: Old config file,
2152
 
        # new config file, and saved state.
2153
 
        # New config value takes precedence if it differs from old
2154
 
        # config value, otherwise use saved state.
2155
 
        for name, value in client_settings[client_name].items():
 
2597
        except EOFError as e:
 
2598
            logger.warning("Could not load persistent state: "
 
2599
                           "EOFError:", exc_info=e)
 
2600
    
 
2601
    with PGPEngine() as pgp:
 
2602
        for client_name, client in clients_data.items():
 
2603
            # Skip removed clients
 
2604
            if client_name not in client_settings:
 
2605
                continue
 
2606
            
 
2607
            # Decide which value to use after restoring saved state.
 
2608
            # We have three different values: Old config file,
 
2609
            # new config file, and saved state.
 
2610
            # New config value takes precedence if it differs from old
 
2611
            # config value, otherwise use saved state.
 
2612
            for name, value in client_settings[client_name].items():
 
2613
                try:
 
2614
                    # For each value in new config, check if it
 
2615
                    # differs from the old config value (Except for
 
2616
                    # the "secret" attribute)
 
2617
                    if (name != "secret" and
 
2618
                        value != old_client_settings[client_name]
 
2619
                        [name]):
 
2620
                        client[name] = value
 
2621
                except KeyError:
 
2622
                    pass
 
2623
            
 
2624
            # Clients who has passed its expire date can still be
 
2625
            # enabled if its last checker was successful.  Clients
 
2626
            # whose checker succeeded before we stored its state is
 
2627
            # assumed to have successfully run all checkers during
 
2628
            # downtime.
 
2629
            if client["enabled"]:
 
2630
                if datetime.datetime.utcnow() >= client["expires"]:
 
2631
                    if not client["last_checked_ok"]:
 
2632
                        logger.warning(
 
2633
                            "disabling client {} - Client never "
 
2634
                            "performed a successful checker"
 
2635
                            .format(client_name))
 
2636
                        client["enabled"] = False
 
2637
                    elif client["last_checker_status"] != 0:
 
2638
                        logger.warning(
 
2639
                            "disabling client {} - Client last"
 
2640
                            " checker failed with error code {}"
 
2641
                            .format(client_name,
 
2642
                                    client["last_checker_status"]))
 
2643
                        client["enabled"] = False
 
2644
                    else:
 
2645
                        client["expires"] = (datetime.datetime
 
2646
                                             .utcnow()
 
2647
                                             + client["timeout"])
 
2648
                        logger.debug("Last checker succeeded,"
 
2649
                                     " keeping {} enabled"
 
2650
                                     .format(client_name))
2156
2651
            try:
2157
 
                # For each value in new config, check if it differs
2158
 
                # from the old config value (Except for the "secret"
2159
 
                # attribute)
2160
 
                if name != "secret" and value != old_client_settings[client_name][name]:
2161
 
                    setattr(client, name, value)
2162
 
            except KeyError:
2163
 
                pass
2164
 
 
2165
 
        # Clients who has passed its expire date, can still be enabled if its
2166
 
        # last checker was sucessful. Clients who checkers failed before we
2167
 
        # stored it state is asumed to had failed checker during downtime.
2168
 
        if client["enabled"] and client["last_checked_ok"]:
2169
 
            if ((datetime.datetime.utcnow() - client["last_checked_ok"])
2170
 
                > client["interval"]):
2171
 
                if client["last_checker_status"] != 0:
2172
 
                    client["enabled"] = False
2173
 
                else:
2174
 
                    client["expires"] = datetime.datetime.utcnow() + client["timeout"]
2175
 
 
2176
 
        client["changedstate"] = (multiprocessing_manager
2177
 
                                  .Condition(multiprocessing_manager
2178
 
                                             .Lock()))
2179
 
        if use_dbus:
2180
 
            new_client = ClientDBusTransitional.__new__(ClientDBusTransitional)
2181
 
            tcp_server.clients[client_name] = new_client
2182
 
            new_client.bus = bus
2183
 
            for name, value in client.iteritems():
2184
 
                setattr(new_client, name, value)
2185
 
            client_object_name = unicode(client_name).translate(
2186
 
                {ord("."): ord("_"),
2187
 
                 ord("-"): ord("_")})
2188
 
            new_client.dbus_object_path = (dbus.ObjectPath
2189
 
                                     ("/clients/" + client_object_name))
2190
 
            DBusObjectWithProperties.__init__(new_client,
2191
 
                                              new_client.bus,
2192
 
                                              new_client.dbus_object_path)
2193
 
        else:
2194
 
            tcp_server.clients[client_name] = Client.__new__(Client)
2195
 
            for name, value in client.iteritems():
2196
 
                setattr(tcp_server.clients[client_name], name, value)
2197
 
                
2198
 
        tcp_server.clients[client_name].decrypt_secret(
2199
 
            client_settings[client_name]["secret"])            
2200
 
        
2201
 
    # Create/remove clients based on new changes made to config
2202
 
    for clientname in set(old_client_settings) - set(client_settings):
2203
 
        del tcp_server.clients[clientname]
2204
 
    for clientname in set(client_settings) - set(old_client_settings):
2205
 
        tcp_server.clients[clientname] = (client_class(name = clientname,
2206
 
                                                       config =
2207
 
                                                       client_settings
2208
 
                                                       [clientname]))
2209
 
    
2210
 
 
 
2652
                client["secret"] = (
 
2653
                    pgp.decrypt(client["encrypted_secret"],
 
2654
                                client_settings[client_name]
 
2655
                                ["secret"]))
 
2656
            except PGPError:
 
2657
                # If decryption fails, we use secret from new settings
 
2658
                logger.debug("Failed to decrypt {} old secret"
 
2659
                             .format(client_name))
 
2660
                client["secret"] = (
 
2661
                    client_settings[client_name]["secret"])
 
2662
    
 
2663
    # Add/remove clients based on new changes made to config
 
2664
    for client_name in (set(old_client_settings)
 
2665
                        - set(client_settings)):
 
2666
        del clients_data[client_name]
 
2667
    for client_name in (set(client_settings)
 
2668
                        - set(old_client_settings)):
 
2669
        clients_data[client_name] = client_settings[client_name]
 
2670
    
 
2671
    # Create all client objects
 
2672
    for client_name, client in clients_data.items():
 
2673
        tcp_server.clients[client_name] = client_class(
 
2674
            name = client_name, settings = client,
 
2675
            server_settings = server_settings)
 
2676
    
2211
2677
    if not tcp_server.clients:
2212
2678
        logger.warning("No clients defined")
2213
 
        
2214
 
    if not debug:
2215
 
        try:
2216
 
            with pidfile:
2217
 
                pid = os.getpid()
2218
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2219
 
            del pidfile
2220
 
        except IOError:
2221
 
            logger.error("Could not write to file %r with PID %d",
2222
 
                         pidfilename, pid)
2223
 
        except NameError:
2224
 
            # "pidfile" was never created
2225
 
            pass
 
2679
    
 
2680
    if not foreground:
 
2681
        if pidfile is not None:
 
2682
            try:
 
2683
                with pidfile:
 
2684
                    pid = os.getpid()
 
2685
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
 
2686
            except IOError:
 
2687
                logger.error("Could not write to file %r with PID %d",
 
2688
                             pidfilename, pid)
 
2689
        del pidfile
2226
2690
        del pidfilename
2227
 
        
2228
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2229
2691
    
2230
2692
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2231
2693
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2232
2694
    
2233
2695
    if use_dbus:
2234
 
        class MandosDBusService(dbus.service.Object):
 
2696
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2697
                                        "se.bsnet.fukt.Mandos"})
 
2698
        class MandosDBusService(DBusObjectWithProperties):
2235
2699
            """A D-Bus proxy object"""
2236
2700
            def __init__(self):
2237
2701
                dbus.service.Object.__init__(self, bus, "/")
2238
2702
            _interface = "se.recompile.Mandos"
2239
2703
            
 
2704
            @dbus_interface_annotations(_interface)
 
2705
            def _foo(self):
 
2706
                return { "org.freedesktop.DBus.Property"
 
2707
                         ".EmitsChangedSignal":
 
2708
                             "false"}
 
2709
            
2240
2710
            @dbus.service.signal(_interface, signature="o")
2241
2711
            def ClientAdded(self, objpath):
2242
2712
                "D-Bus signal"
2264
2734
            def GetAllClientsWithProperties(self):
2265
2735
                "D-Bus method"
2266
2736
                return dbus.Dictionary(
2267
 
                    ((c.dbus_object_path, c.GetAll(""))
2268
 
                     for c in tcp_server.clients.itervalues()),
 
2737
                    { c.dbus_object_path: c.GetAll("")
 
2738
                      for c in tcp_server.clients.itervalues() },
2269
2739
                    signature="oa{sv}")
2270
2740
            
2271
2741
            @dbus.service.method(_interface, in_signature="o")
2284
2754
            
2285
2755
            del _interface
2286
2756
        
2287
 
        class MandosDBusServiceTransitional(MandosDBusService):
2288
 
            __metaclass__ = AlternateDBusNamesMetaclass
2289
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2757
        mandos_dbus_service = MandosDBusService()
2290
2758
    
2291
2759
    def cleanup():
2292
2760
        "Cleanup function; run on exit"
2293
 
        service.cleanup()
 
2761
        if zeroconf:
 
2762
            service.cleanup()
2294
2763
        
2295
2764
        multiprocessing.active_children()
 
2765
        wnull.close()
2296
2766
        if not (tcp_server.clients or client_settings):
2297
2767
            return
2298
 
 
2299
 
        # Store client before exiting. Secrets are encrypted with key based
2300
 
        # on what config file has. If config file is removed/edited, old
2301
 
        # secret will thus be unrecovable.
2302
 
        clients = []
2303
 
        for client in tcp_server.clients.itervalues():
2304
 
            client.encrypt_secret(client_settings[client.name]["secret"])
2305
 
 
2306
 
            client_dict = {}
2307
 
 
2308
 
            # A list of attributes that will not be stored when shuting down.
2309
 
            exclude = set(("bus", "changedstate", "secret"))            
2310
 
            for name, typ in inspect.getmembers(dbus.service.Object):
2311
 
                exclude.add(name)
2312
 
                
2313
 
            client_dict["encrypted_secret"] = client.encrypted_secret
2314
 
            for attr in client.client_structure:
2315
 
                if attr not in exclude:
2316
 
                    client_dict[attr] = getattr(client, attr)
2317
 
 
2318
 
            clients.append(client_dict) 
2319
 
            del client_settings[client.name]["secret"]
2320
 
            
 
2768
        
 
2769
        # Store client before exiting. Secrets are encrypted with key
 
2770
        # based on what config file has. If config file is
 
2771
        # removed/edited, old secret will thus be unrecovable.
 
2772
        clients = {}
 
2773
        with PGPEngine() as pgp:
 
2774
            for client in tcp_server.clients.itervalues():
 
2775
                key = client_settings[client.name]["secret"]
 
2776
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2777
                                                      key)
 
2778
                client_dict = {}
 
2779
                
 
2780
                # A list of attributes that can not be pickled
 
2781
                # + secret.
 
2782
                exclude = { "bus", "changedstate", "secret",
 
2783
                            "checker", "server_settings" }
 
2784
                for name, typ in (inspect.getmembers
 
2785
                                  (dbus.service.Object)):
 
2786
                    exclude.add(name)
 
2787
                
 
2788
                client_dict["encrypted_secret"] = (client
 
2789
                                                   .encrypted_secret)
 
2790
                for attr in client.client_structure:
 
2791
                    if attr not in exclude:
 
2792
                        client_dict[attr] = getattr(client, attr)
 
2793
                
 
2794
                clients[client.name] = client_dict
 
2795
                del client_settings[client.name]["secret"]
 
2796
        
2321
2797
        try:
2322
 
            with os.fdopen(os.open(stored_state_path, os.O_CREAT|os.O_WRONLY|os.O_TRUNC, 0600), "wb") as stored_state:
 
2798
            with (tempfile.NamedTemporaryFile
 
2799
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2800
                   dir=os.path.dirname(stored_state_path),
 
2801
                   delete=False)) as stored_state:
2323
2802
                pickle.dump((clients, client_settings), stored_state)
2324
 
        except IOError as e:
2325
 
            logger.warning("Could not save persistant state: {0}".format(e))
2326
 
            if e.errno != errno.ENOENT:
 
2803
                tempname=stored_state.name
 
2804
            os.rename(tempname, stored_state_path)
 
2805
        except (IOError, OSError) as e:
 
2806
            if not debug:
 
2807
                try:
 
2808
                    os.remove(tempname)
 
2809
                except NameError:
 
2810
                    pass
 
2811
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2812
                logger.warning("Could not save persistent state: {}"
 
2813
                               .format(os.strerror(e.errno)))
 
2814
            else:
 
2815
                logger.warning("Could not save persistent state:",
 
2816
                               exc_info=e)
2327
2817
                raise
2328
 
 
 
2818
        
2329
2819
        # Delete all clients, and settings from config
2330
2820
        while tcp_server.clients:
2331
2821
            name, client = tcp_server.clients.popitem()
2349
2839
        # Need to initiate checking of clients
2350
2840
        if client.enabled:
2351
2841
            client.init_checker()
2352
 
 
2353
2842
    
2354
2843
    tcp_server.enable()
2355
2844
    tcp_server.server_activate()
2356
2845
    
2357
2846
    # Find out what port we got
2358
 
    service.port = tcp_server.socket.getsockname()[1]
 
2847
    if zeroconf:
 
2848
        service.port = tcp_server.socket.getsockname()[1]
2359
2849
    if use_ipv6:
2360
2850
        logger.info("Now listening on address %r, port %d,"
2361
 
                    " flowinfo %d, scope_id %d"
2362
 
                    % tcp_server.socket.getsockname())
 
2851
                    " flowinfo %d, scope_id %d",
 
2852
                    *tcp_server.socket.getsockname())
2363
2853
    else:                       # IPv4
2364
 
        logger.info("Now listening on address %r, port %d"
2365
 
                    % tcp_server.socket.getsockname())
 
2854
        logger.info("Now listening on address %r, port %d",
 
2855
                    *tcp_server.socket.getsockname())
2366
2856
    
2367
2857
    #service.interface = tcp_server.socket.getsockname()[3]
2368
2858
    
2369
2859
    try:
2370
 
        # From the Avahi example code
2371
 
        try:
2372
 
            service.activate()
2373
 
        except dbus.exceptions.DBusException as error:
2374
 
            logger.critical("DBusException: %s", error)
2375
 
            cleanup()
2376
 
            sys.exit(1)
2377
 
        # End of Avahi example code
 
2860
        if zeroconf:
 
2861
            # From the Avahi example code
 
2862
            try:
 
2863
                service.activate()
 
2864
            except dbus.exceptions.DBusException as error:
 
2865
                logger.critical("D-Bus Exception", exc_info=error)
 
2866
                cleanup()
 
2867
                sys.exit(1)
 
2868
            # End of Avahi example code
2378
2869
        
2379
2870
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2380
2871
                             lambda *args, **kwargs:
2384
2875
        logger.debug("Starting main loop")
2385
2876
        main_loop.run()
2386
2877
    except AvahiError as error:
2387
 
        logger.critical("AvahiError: %s", error)
 
2878
        logger.critical("Avahi Error", exc_info=error)
2388
2879
        cleanup()
2389
2880
        sys.exit(1)
2390
2881
    except KeyboardInterrupt:
2395
2886
    # Must run before the D-Bus bus name gets deregistered
2396
2887
    cleanup()
2397
2888
 
2398
 
 
2399
2889
if __name__ == '__main__':
2400
2890
    main()