/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
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
31
# Contact the authors at <mandos@recompile.se>.
32
32
33
33
 
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
62
64
import functools
63
65
import cPickle as pickle
64
66
import multiprocessing
 
67
import types
 
68
import binascii
 
69
import tempfile
 
70
import itertools
 
71
import collections
65
72
 
66
73
import dbus
67
74
import dbus.service
81
88
    except ImportError:
82
89
        SO_BINDTODEVICE = None
83
90
 
84
 
 
85
 
version = "1.3.0"
86
 
 
87
 
#logger = logging.getLogger('mandos')
88
 
logger = logging.Logger('mandos')
89
 
syslogger = (logging.handlers.SysLogHandler
90
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
 
              address = str("/dev/log")))
92
 
syslogger.setFormatter(logging.Formatter
93
 
                       ('Mandos [%(process)d]: %(levelname)s:'
94
 
                        ' %(message)s'))
95
 
logger.addHandler(syslogger)
96
 
 
97
 
console = logging.StreamHandler()
98
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
99
 
                                       ' %(levelname)s:'
100
 
                                       ' %(message)s'))
101
 
logger.addHandler(console)
 
91
if sys.version_info.major == 2:
 
92
    str = unicode
 
93
 
 
94
version = "1.6.9"
 
95
stored_state_file = "clients.pickle"
 
96
 
 
97
logger = logging.getLogger()
 
98
syslogger = None
 
99
 
 
100
try:
 
101
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
102
                      (ctypes.util.find_library("c"))
 
103
                      .if_nametoindex)
 
104
except (OSError, AttributeError):
 
105
    def if_nametoindex(interface):
 
106
        "Get an interface index the hard way, i.e. using fcntl()"
 
107
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
108
        with contextlib.closing(socket.socket()) as s:
 
109
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
110
                                struct.pack(b"16s16x", interface))
 
111
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
112
        return interface_index
 
113
 
 
114
 
 
115
def initlogger(debug, level=logging.WARNING):
 
116
    """init logger and add loglevel"""
 
117
    
 
118
    global syslogger
 
119
    syslogger = (logging.handlers.SysLogHandler
 
120
                 (facility =
 
121
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
122
                  address = "/dev/log"))
 
123
    syslogger.setFormatter(logging.Formatter
 
124
                           ('Mandos [%(process)d]: %(levelname)s:'
 
125
                            ' %(message)s'))
 
126
    logger.addHandler(syslogger)
 
127
    
 
128
    if debug:
 
129
        console = logging.StreamHandler()
 
130
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
131
                                               ' [%(process)d]:'
 
132
                                               ' %(levelname)s:'
 
133
                                               ' %(message)s'))
 
134
        logger.addHandler(console)
 
135
    logger.setLevel(level)
 
136
 
 
137
 
 
138
class PGPError(Exception):
 
139
    """Exception if encryption/decryption fails"""
 
140
    pass
 
141
 
 
142
 
 
143
class PGPEngine(object):
 
144
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
145
    def __init__(self):
 
146
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
147
        self.gnupgargs = ['--batch',
 
148
                          '--home', self.tempdir,
 
149
                          '--force-mdc',
 
150
                          '--quiet',
 
151
                          '--no-use-agent']
 
152
    
 
153
    def __enter__(self):
 
154
        return self
 
155
    
 
156
    def __exit__(self, exc_type, exc_value, traceback):
 
157
        self._cleanup()
 
158
        return False
 
159
    
 
160
    def __del__(self):
 
161
        self._cleanup()
 
162
    
 
163
    def _cleanup(self):
 
164
        if self.tempdir is not None:
 
165
            # Delete contents of tempdir
 
166
            for root, dirs, files in os.walk(self.tempdir,
 
167
                                             topdown = False):
 
168
                for filename in files:
 
169
                    os.remove(os.path.join(root, filename))
 
170
                for dirname in dirs:
 
171
                    os.rmdir(os.path.join(root, dirname))
 
172
            # Remove tempdir
 
173
            os.rmdir(self.tempdir)
 
174
            self.tempdir = None
 
175
    
 
176
    def password_encode(self, password):
 
177
        # Passphrase can not be empty and can not contain newlines or
 
178
        # NUL bytes.  So we prefix it and hex encode it.
 
179
        encoded = b"mandos" + binascii.hexlify(password)
 
180
        if len(encoded) > 2048:
 
181
            # GnuPG can't handle long passwords, so encode differently
 
182
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
183
                       .replace(b"\n", b"\\n")
 
184
                       .replace(b"\0", b"\\x00"))
 
185
        return encoded
 
186
    
 
187
    def encrypt(self, data, password):
 
188
        passphrase = self.password_encode(password)
 
189
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
190
                                         ) as passfile:
 
191
            passfile.write(passphrase)
 
192
            passfile.flush()
 
193
            proc = subprocess.Popen(['gpg', '--symmetric',
 
194
                                     '--passphrase-file',
 
195
                                     passfile.name]
 
196
                                    + self.gnupgargs,
 
197
                                    stdin = subprocess.PIPE,
 
198
                                    stdout = subprocess.PIPE,
 
199
                                    stderr = subprocess.PIPE)
 
200
            ciphertext, err = proc.communicate(input = data)
 
201
        if proc.returncode != 0:
 
202
            raise PGPError(err)
 
203
        return ciphertext
 
204
    
 
205
    def decrypt(self, data, password):
 
206
        passphrase = self.password_encode(password)
 
207
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
208
                                         ) as passfile:
 
209
            passfile.write(passphrase)
 
210
            passfile.flush()
 
211
            proc = subprocess.Popen(['gpg', '--decrypt',
 
212
                                     '--passphrase-file',
 
213
                                     passfile.name]
 
214
                                    + self.gnupgargs,
 
215
                                    stdin = subprocess.PIPE,
 
216
                                    stdout = subprocess.PIPE,
 
217
                                    stderr = subprocess.PIPE)
 
218
            decrypted_plaintext, err = proc.communicate(input
 
219
                                                        = data)
 
220
        if proc.returncode != 0:
 
221
            raise PGPError(err)
 
222
        return decrypted_plaintext
 
223
 
102
224
 
103
225
class AvahiError(Exception):
104
226
    def __init__(self, value, *args, **kwargs):
105
227
        self.value = value
106
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
107
 
    def __unicode__(self):
108
 
        return unicode(repr(self.value))
 
228
        return super(AvahiError, self).__init__(value, *args,
 
229
                                                **kwargs)
109
230
 
110
231
class AvahiServiceError(AvahiError):
111
232
    pass
122
243
               Used to optionally bind to the specified interface.
123
244
    name: string; Example: 'Mandos'
124
245
    type: string; Example: '_mandos._tcp'.
125
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
246
     See <https://www.iana.org/assignments/service-names-port-numbers>
126
247
    port: integer; what port to announce
127
248
    TXT: list of strings; TXT record for the service
128
249
    domain: string; Domain to publish on, default to .local if empty.
134
255
    server: D-Bus Server
135
256
    bus: dbus.SystemBus()
136
257
    """
 
258
    
137
259
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
138
260
                 servicetype = None, port = None, TXT = None,
139
261
                 domain = "", host = "", max_renames = 32768,
152
274
        self.server = None
153
275
        self.bus = bus
154
276
        self.entry_group_state_changed_match = None
155
 
    def rename(self):
 
277
    
 
278
    def rename(self, remove=True):
156
279
        """Derived from the Avahi example code"""
157
280
        if self.rename_count >= self.max_renames:
158
281
            logger.critical("No suitable Zeroconf service name found"
159
282
                            " after %i retries, exiting.",
160
283
                            self.rename_count)
161
284
            raise AvahiServiceError("Too many renames")
162
 
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
 
285
        self.name = str(self.server
 
286
                        .GetAlternativeServiceName(self.name))
 
287
        self.rename_count += 1
163
288
        logger.info("Changing Zeroconf service name to %r ...",
164
289
                    self.name)
165
 
        syslogger.setFormatter(logging.Formatter
166
 
                               ('Mandos (%s) [%%(process)d]:'
167
 
                                ' %%(levelname)s: %%(message)s'
168
 
                                % self.name))
169
 
        self.remove()
 
290
        if remove:
 
291
            self.remove()
170
292
        try:
171
293
            self.add()
172
294
        except dbus.exceptions.DBusException as error:
173
 
            logger.critical("DBusException: %s", error)
174
 
            self.cleanup()
175
 
            os._exit(1)
176
 
        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
    
177
304
    def remove(self):
178
305
        """Derived from the Avahi example code"""
179
306
        if self.entry_group_state_changed_match is not None:
181
308
            self.entry_group_state_changed_match = None
182
309
        if self.group is not None:
183
310
            self.group.Reset()
 
311
    
184
312
    def add(self):
185
313
        """Derived from the Avahi example code"""
186
314
        self.remove()
191
319
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
192
320
        self.entry_group_state_changed_match = (
193
321
            self.group.connect_to_signal(
194
 
                'StateChanged', self .entry_group_state_changed))
 
322
                'StateChanged', self.entry_group_state_changed))
195
323
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
196
324
                     self.name, self.type)
197
325
        self.group.AddService(
203
331
            dbus.UInt16(self.port),
204
332
            avahi.string_array_to_txt_array(self.TXT))
205
333
        self.group.Commit()
 
334
    
206
335
    def entry_group_state_changed(self, state, error):
207
336
        """Derived from the Avahi example code"""
208
337
        logger.debug("Avahi entry group state change: %i", state)
214
343
            self.rename()
215
344
        elif state == avahi.ENTRY_GROUP_FAILURE:
216
345
            logger.critical("Avahi: Error in group state changed %s",
217
 
                            unicode(error))
218
 
            raise AvahiGroupError("State changed: %s"
219
 
                                  % unicode(error))
 
346
                            str(error))
 
347
            raise AvahiGroupError("State changed: {!s}"
 
348
                                  .format(error))
 
349
    
220
350
    def cleanup(self):
221
351
        """Derived from the Avahi example code"""
222
352
        if self.group is not None:
223
353
            try:
224
354
                self.group.Free()
225
355
            except (dbus.exceptions.UnknownMethodException,
226
 
                    dbus.exceptions.DBusException) as e:
 
356
                    dbus.exceptions.DBusException):
227
357
                pass
228
358
            self.group = None
229
359
        self.remove()
 
360
    
230
361
    def server_state_changed(self, state, error=None):
231
362
        """Derived from the Avahi example code"""
232
363
        logger.debug("Avahi server state change: %i", state)
251
382
                logger.debug("Unknown state: %r", state)
252
383
            else:
253
384
                logger.debug("Unknown state: %r: %r", state, error)
 
385
    
254
386
    def activate(self):
255
387
        """Derived from the Avahi example code"""
256
388
        if self.server is None:
264
396
        self.server_state_changed(self.server.GetState())
265
397
 
266
398
 
 
399
class AvahiServiceToSyslog(AvahiService):
 
400
    def rename(self, *args, **kwargs):
 
401
        """Add the new name to the syslog messages"""
 
402
        ret = AvahiService.rename(self, *args, **kwargs)
 
403
        syslogger.setFormatter(logging.Formatter
 
404
                               ('Mandos ({}) [%(process)d]:'
 
405
                                ' %(levelname)s: %(message)s'
 
406
                                .format(self.name)))
 
407
        return ret
 
408
 
 
409
 
267
410
class Client(object):
268
411
    """A representation of a client host served by this server.
269
412
    
270
413
    Attributes:
271
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
414
    approved:   bool(); 'None' if not yet approved/disapproved
272
415
    approval_delay: datetime.timedelta(); Time to wait for approval
273
416
    approval_duration: datetime.timedelta(); Duration of one approval
274
417
    checker:    subprocess.Popen(); a running checker process used
281
424
                     instance %(name)s can be used in the command.
282
425
    checker_initiator_tag: a gobject event source tag, or None
283
426
    created:    datetime.datetime(); (UTC) object creation
 
427
    client_structure: Object describing what attributes a client has
 
428
                      and is used for storing the client at exit
284
429
    current_checker_command: string; current running checker_command
285
 
    disable_hook:  If set, called by disable() as disable_hook(self)
286
430
    disable_initiator_tag: a gobject event source tag, or None
287
431
    enabled:    bool()
288
432
    fingerprint: string (40 or 32 hexadecimal digits); used to
291
435
    interval:   datetime.timedelta(); How often to start a new checker
292
436
    last_approval_request: datetime.datetime(); (UTC) or None
293
437
    last_checked_ok: datetime.datetime(); (UTC) or None
294
 
    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
295
442
    name:       string; from the config file, used in log messages and
296
443
                        D-Bus identifiers
297
444
    secret:     bytestring; sent verbatim (over TLS) to client
298
445
    timeout:    datetime.timedelta(); How long from last_checked_ok
299
446
                                      until this client is disabled
 
447
    extended_timeout:   extra long timeout when secret has been sent
300
448
    runtime_expansions: Allowed attributes for runtime expansion.
 
449
    expires:    datetime.datetime(); time (UTC) when a client will be
 
450
                disabled, or None
 
451
    server_settings: The server_settings dict from main()
301
452
    """
302
453
    
303
454
    runtime_expansions = ("approval_delay", "approval_duration",
304
 
                          "created", "enabled", "fingerprint",
305
 
                          "host", "interval", "last_checked_ok",
 
455
                          "created", "enabled", "expires",
 
456
                          "fingerprint", "host", "interval",
 
457
                          "last_approval_request", "last_checked_ok",
306
458
                          "last_enabled", "name", "timeout")
 
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
                        }
307
469
    
308
470
    @staticmethod
309
 
    def _timedelta_to_milliseconds(td):
310
 
        "Convert a datetime.timedelta() to milliseconds"
311
 
        return ((td.days * 24 * 60 * 60 * 1000)
312
 
                + (td.seconds * 1000)
313
 
                + (td.microseconds // 1000))
314
 
    
315
 
    def timeout_milliseconds(self):
316
 
        "Return the 'timeout' attribute in milliseconds"
317
 
        return self._timedelta_to_milliseconds(self.timeout)
318
 
    
319
 
    def interval_milliseconds(self):
320
 
        "Return the 'interval' attribute in milliseconds"
321
 
        return self._timedelta_to_milliseconds(self.interval)
322
 
 
323
 
    def approval_delay_milliseconds(self):
324
 
        return self._timedelta_to_milliseconds(self.approval_delay)
325
 
    
326
 
    def __init__(self, name = None, disable_hook=None, config=None):
327
 
        """Note: the 'checker' key in 'config' sets the
328
 
        'checker_command' attribute and *not* the 'checker'
329
 
        attribute."""
 
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):
330
521
        self.name = name
331
 
        if config is None:
332
 
            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
        
333
539
        logger.debug("Creating client %r", self.name)
334
 
        # Uppercase and remove spaces from fingerprint for later
335
 
        # comparison purposes with return value from the fingerprint()
336
 
        # function
337
 
        self.fingerprint = (config["fingerprint"].upper()
338
 
                            .replace(" ", ""))
339
540
        logger.debug("  Fingerprint: %s", self.fingerprint)
340
 
        if "secret" in config:
341
 
            self.secret = config["secret"].decode("base64")
342
 
        elif "secfile" in config:
343
 
            with open(os.path.expanduser(os.path.expandvars
344
 
                                         (config["secfile"])),
345
 
                      "rb") as secfile:
346
 
                self.secret = secfile.read()
347
 
        else:
348
 
            raise TypeError("No secret or secfile for client %s"
349
 
                            % self.name)
350
 
        self.host = config.get("host", "")
351
 
        self.created = datetime.datetime.utcnow()
352
 
        self.enabled = False
353
 
        self.last_approval_request = None
354
 
        self.last_enabled = None
355
 
        self.last_checked_ok = None
356
 
        self.timeout = string_to_delta(config["timeout"])
357
 
        self.interval = string_to_delta(config["interval"])
358
 
        self.disable_hook = disable_hook
 
541
        self.created = settings.get("created",
 
542
                                    datetime.datetime.utcnow())
 
543
        
 
544
        # attributes specific for this server instance
359
545
        self.checker = None
360
546
        self.checker_initiator_tag = None
361
547
        self.disable_initiator_tag = None
362
548
        self.checker_callback_tag = None
363
 
        self.checker_command = config["checker"]
364
549
        self.current_checker_command = None
365
 
        self.last_connect = None
366
 
        self._approved = None
367
 
        self.approved_by_default = config.get("approved_by_default",
368
 
                                              True)
 
550
        self.approved = None
369
551
        self.approvals_pending = 0
370
 
        self.approval_delay = string_to_delta(
371
 
            config["approval_delay"])
372
 
        self.approval_duration = string_to_delta(
373
 
            config["approval_duration"])
374
 
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
 
552
        self.changedstate = (multiprocessing_manager
 
553
                             .Condition(multiprocessing_manager
 
554
                                        .Lock()))
 
555
        self.client_structure = [attr for attr in
 
556
                                 self.__dict__.iterkeys()
 
557
                                 if not attr.startswith("_")]
 
558
        self.client_structure.append("client_structure")
 
559
        
 
560
        for name, t in inspect.getmembers(type(self),
 
561
                                          lambda obj:
 
562
                                              isinstance(obj,
 
563
                                                         property)):
 
564
            if not name.startswith("_"):
 
565
                self.client_structure.append(name)
375
566
    
 
567
    # Send notice to process children that client state has changed
376
568
    def send_changedstate(self):
377
 
        self.changedstate.acquire()
378
 
        self.changedstate.notify_all()
379
 
        self.changedstate.release()
380
 
        
 
569
        with self.changedstate:
 
570
            self.changedstate.notify_all()
 
571
    
381
572
    def enable(self):
382
573
        """Start this client's checker and timeout hooks"""
383
574
        if getattr(self, "enabled", False):
384
575
            # Already enabled
385
576
            return
386
 
        self.send_changedstate()
 
577
        self.expires = datetime.datetime.utcnow() + self.timeout
 
578
        self.enabled = True
387
579
        self.last_enabled = datetime.datetime.utcnow()
388
 
        # Schedule a new checker to be started an 'interval' from now,
389
 
        # and every interval from then on.
390
 
        self.checker_initiator_tag = (gobject.timeout_add
391
 
                                      (self.interval_milliseconds(),
392
 
                                       self.start_checker))
393
 
        # Schedule a disable() when 'timeout' has passed
394
 
        self.disable_initiator_tag = (gobject.timeout_add
395
 
                                   (self.timeout_milliseconds(),
396
 
                                    self.disable))
397
 
        self.enabled = True
398
 
        # Also start a new checker *right now*.
399
 
        self.start_checker()
 
580
        self.init_checker()
 
581
        self.send_changedstate()
400
582
    
401
583
    def disable(self, quiet=True):
402
584
        """Disable this client."""
403
585
        if not getattr(self, "enabled", False):
404
586
            return False
405
587
        if not quiet:
406
 
            self.send_changedstate()
407
 
        if not quiet:
408
588
            logger.info("Disabling client %s", self.name)
409
 
        if getattr(self, "disable_initiator_tag", False):
 
589
        if getattr(self, "disable_initiator_tag", None) is not None:
410
590
            gobject.source_remove(self.disable_initiator_tag)
411
591
            self.disable_initiator_tag = None
412
 
        if getattr(self, "checker_initiator_tag", False):
 
592
        self.expires = None
 
593
        if getattr(self, "checker_initiator_tag", None) is not None:
413
594
            gobject.source_remove(self.checker_initiator_tag)
414
595
            self.checker_initiator_tag = None
415
596
        self.stop_checker()
416
 
        if self.disable_hook:
417
 
            self.disable_hook(self)
418
597
        self.enabled = False
 
598
        if not quiet:
 
599
            self.send_changedstate()
419
600
        # Do not run this again if called by a gobject.timeout_add
420
601
        return False
421
602
    
422
603
    def __del__(self):
423
 
        self.disable_hook = None
424
604
        self.disable()
425
605
    
 
606
    def init_checker(self):
 
607
        # Schedule a new checker to be started an 'interval' from now,
 
608
        # and every interval from then on.
 
609
        if self.checker_initiator_tag is not None:
 
610
            gobject.source_remove(self.checker_initiator_tag)
 
611
        self.checker_initiator_tag = (gobject.timeout_add
 
612
                                      (int(self.interval
 
613
                                           .total_seconds() * 1000),
 
614
                                       self.start_checker))
 
615
        # Schedule a disable() when 'timeout' has passed
 
616
        if self.disable_initiator_tag is not None:
 
617
            gobject.source_remove(self.disable_initiator_tag)
 
618
        self.disable_initiator_tag = (gobject.timeout_add
 
619
                                      (int(self.timeout
 
620
                                           .total_seconds() * 1000),
 
621
                                       self.disable))
 
622
        # Also start a new checker *right now*.
 
623
        self.start_checker()
 
624
    
426
625
    def checker_callback(self, pid, condition, command):
427
626
        """The checker has completed, so take appropriate actions."""
428
627
        self.checker_callback_tag = None
429
628
        self.checker = None
430
629
        if os.WIFEXITED(condition):
431
 
            exitstatus = os.WEXITSTATUS(condition)
432
 
            if exitstatus == 0:
 
630
            self.last_checker_status = os.WEXITSTATUS(condition)
 
631
            if self.last_checker_status == 0:
433
632
                logger.info("Checker for %(name)s succeeded",
434
633
                            vars(self))
435
634
                self.checked_ok()
437
636
                logger.info("Checker for %(name)s failed",
438
637
                            vars(self))
439
638
        else:
 
639
            self.last_checker_status = -1
440
640
            logger.warning("Checker for %(name)s crashed?",
441
641
                           vars(self))
442
642
    
443
643
    def checked_ok(self):
444
 
        """Bump up the timeout for this client.
445
 
        
446
 
        This should only be called when the client has been seen,
447
 
        alive and well.
448
 
        """
 
644
        """Assert that the client has been seen, alive and well."""
449
645
        self.last_checked_ok = datetime.datetime.utcnow()
450
 
        gobject.source_remove(self.disable_initiator_tag)
451
 
        self.disable_initiator_tag = (gobject.timeout_add
452
 
                                      (self.timeout_milliseconds(),
453
 
                                       self.disable))
 
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."""
 
651
        if timeout is None:
 
652
            timeout = self.timeout
 
653
        if self.disable_initiator_tag is not None:
 
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
            self.disable_initiator_tag = None
 
656
        if getattr(self, "enabled", False):
 
657
            self.disable_initiator_tag = (gobject.timeout_add
 
658
                                          (int(timeout.total_seconds()
 
659
                                               * 1000), self.disable))
 
660
            self.expires = datetime.datetime.utcnow() + timeout
454
661
    
455
662
    def need_approval(self):
456
663
        self.last_approval_request = datetime.datetime.utcnow()
461
668
        If a checker already exists, leave it running and do
462
669
        nothing."""
463
670
        # The reason for not killing a running checker is that if we
464
 
        # did that, then if a checker (for some reason) started
465
 
        # running slowly and taking more than 'interval' time, the
466
 
        # client would inevitably timeout, since no checker would get
467
 
        # 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
468
675
        # checkers alone, the checker would have to take more time
469
676
        # than 'timeout' for the client to be disabled, which is as it
470
677
        # should be.
472
679
        # If a checker exists, make sure it is not a zombie
473
680
        try:
474
681
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
475
 
        except (AttributeError, OSError) as error:
476
 
            if (isinstance(error, OSError)
477
 
                and error.errno != errno.ECHILD):
478
 
                raise error
 
682
        except AttributeError:
 
683
            pass
 
684
        except OSError as error:
 
685
            if error.errno != errno.ECHILD:
 
686
                raise
479
687
        else:
480
688
            if pid:
481
689
                logger.warning("Checker was a zombie")
484
692
                                      self.current_checker_command)
485
693
        # Start a new checker if needed
486
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 }
487
699
            try:
488
 
                # In case checker_command has exactly one % operator
489
 
                command = self.checker_command % self.host
490
 
            except TypeError:
491
 
                # Escape attributes for the shell
492
 
                escaped_attrs = dict(
493
 
                    (attr,
494
 
                     re.escape(unicode(str(getattr(self, attr, "")),
495
 
                                       errors=
496
 
                                       'replace')))
497
 
                    for attr in
498
 
                    self.runtime_expansions)
499
 
 
500
 
                try:
501
 
                    command = self.checker_command % escaped_attrs
502
 
                except TypeError as error:
503
 
                    logger.error('Could not format string "%s":'
504
 
                                 ' %s', self.checker_command, error)
505
 
                    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
506
705
            self.current_checker_command = command
507
706
            try:
508
707
                logger.info("Starting checker %r for %s",
511
710
                # in normal mode, that is already done by daemon(),
512
711
                # and in debug mode we don't want to.  (Stdin is
513
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 })
514
721
                self.checker = subprocess.Popen(command,
515
722
                                                close_fds=True,
516
 
                                                shell=True, cwd="/")
517
 
                self.checker_callback_tag = (gobject.child_watch_add
518
 
                                             (self.checker.pid,
519
 
                                              self.checker_callback,
520
 
                                              data=command))
521
 
                # The checker may have completed before the gobject
522
 
                # 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:
523
736
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
524
 
                if pid:
525
 
                    gobject.source_remove(self.checker_callback_tag)
526
 
                    self.checker_callback(pid, status, command)
527
737
            except OSError as error:
528
 
                logger.error("Failed to start subprocess: %s",
529
 
                             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)
530
747
        # Re-run this periodically if run by gobject.timeout_add
531
748
        return True
532
749
    
539
756
            return
540
757
        logger.debug("Stopping checker for %(name)s", vars(self))
541
758
        try:
542
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
759
            self.checker.terminate()
543
760
            #time.sleep(0.5)
544
761
            #if self.checker.poll() is None:
545
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
762
            #    self.checker.kill()
546
763
        except OSError as error:
547
764
            if error.errno != errno.ESRCH: # No such process
548
765
                raise
549
766
        self.checker = None
550
767
 
 
768
 
551
769
def dbus_service_property(dbus_interface, signature="v",
552
770
                          access="readwrite", byte_arrays=False):
553
771
    """Decorators for marking methods of a DBusObjectWithProperties to
564
782
    # "Set" method, so we fail early here:
565
783
    if byte_arrays and signature != "ay":
566
784
        raise ValueError("Byte arrays not supported for non-'ay'"
567
 
                         " signature %r" % signature)
 
785
                         " signature {!r}".format(signature))
568
786
    def decorator(func):
569
787
        func._dbus_is_property = True
570
788
        func._dbus_interface = dbus_interface
578
796
    return decorator
579
797
 
580
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
 
581
836
class DBusPropertyException(dbus.exceptions.DBusException):
582
837
    """A base class for D-Bus property-related exceptions
583
838
    """
584
 
    def __unicode__(self):
585
 
        return unicode(str(self))
586
 
 
 
839
    pass
587
840
 
588
841
class DBusPropertyAccessException(DBusPropertyException):
589
842
    """A property's access permissions disallows an operation.
599
852
 
600
853
class DBusObjectWithProperties(dbus.service.Object):
601
854
    """A D-Bus object with properties.
602
 
 
 
855
    
603
856
    Classes inheriting from this can use the dbus_service_property
604
857
    decorator to expose methods as D-Bus properties.  It exposes the
605
858
    standard Get(), Set(), and GetAll() methods on the D-Bus.
606
859
    """
607
860
    
608
861
    @staticmethod
609
 
    def _is_dbus_property(obj):
610
 
        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)
611
870
    
612
 
    def _get_all_dbus_properties(self):
 
871
    def _get_all_dbus_things(self, thing):
613
872
        """Returns a generator of (name, attribute) pairs
614
873
        """
615
 
        return ((prop._dbus_name, prop)
616
 
                for name, prop in
617
 
                inspect.getmembers(self, self._is_dbus_property))
 
874
        return ((getattr(athing.__get__(self), "_dbus_name",
 
875
                         name),
 
876
                 athing.__get__(self))
 
877
                for cls in self.__class__.__mro__
 
878
                for name, athing in
 
879
                inspect.getmembers(cls,
 
880
                                   self._is_dbus_thing(thing)))
618
881
    
619
882
    def _get_dbus_property(self, interface_name, property_name):
620
883
        """Returns a bound method if one exists which is a D-Bus
621
884
        property with the specified name and interface.
622
885
        """
623
 
        for name in (property_name,
624
 
                     property_name + "_dbus_property"):
625
 
            prop = getattr(self, name, None)
626
 
            if (prop is None
627
 
                or not self._is_dbus_property(prop)
628
 
                or prop._dbus_name != property_name
629
 
                or (interface_name and prop._dbus_interface
630
 
                    and interface_name != prop._dbus_interface)):
631
 
                continue
632
 
            return prop
 
886
        for cls in  self.__class__.__mro__:
 
887
            for name, value in (inspect.getmembers
 
888
                                (cls,
 
889
                                 self._is_dbus_thing("property"))):
 
890
                if (value._dbus_name == property_name
 
891
                    and value._dbus_interface == interface_name):
 
892
                    return value.__get__(self)
 
893
        
633
894
        # No such property
634
895
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
635
896
                                   + interface_name + "."
659
920
            # The byte_arrays option is not supported yet on
660
921
            # signatures other than "ay".
661
922
            if prop._dbus_signature != "ay":
662
 
                raise ValueError
663
 
            value = dbus.ByteArray(''.join(unichr(byte)
664
 
                                           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))
665
928
        prop(value)
666
929
    
667
930
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
669
932
    def GetAll(self, interface_name):
670
933
        """Standard D-Bus property GetAll() method, see D-Bus
671
934
        standard.
672
 
 
 
935
        
673
936
        Note: Will not include properties with access="write".
674
937
        """
675
 
        all = {}
676
 
        for name, prop in self._get_all_dbus_properties():
 
938
        properties = {}
 
939
        for name, prop in self._get_all_dbus_things("property"):
677
940
            if (interface_name
678
941
                and interface_name != prop._dbus_interface):
679
942
                # Interface non-empty but did not match
683
946
                continue
684
947
            value = prop()
685
948
            if not hasattr(value, "variant_level"):
686
 
                all[name] = value
 
949
                properties[name] = value
687
950
                continue
688
 
            all[name] = type(value)(value, variant_level=
689
 
                                    value.variant_level+1)
690
 
        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
691
962
    
692
963
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
693
964
                         out_signature="s",
694
965
                         path_keyword='object_path',
695
966
                         connection_keyword='connection')
696
967
    def Introspect(self, object_path, connection):
697
 
        """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.
698
971
        """
699
972
        xmlstring = dbus.service.Object.Introspect(self, object_path,
700
973
                                                   connection)
707
980
                e.setAttribute("access", prop._dbus_access)
708
981
                return e
709
982
            for if_tag in document.getElementsByTagName("interface"):
 
983
                # Add property tags
710
984
                for tag in (make_tag(document, name, prop)
711
985
                            for name, prop
712
 
                            in self._get_all_dbus_properties()
 
986
                            in self._get_all_dbus_things("property")
713
987
                            if prop._dbus_interface
714
988
                            == if_tag.getAttribute("name")):
715
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)
716
1021
                # Add the names to the return values for the
717
1022
                # "org.freedesktop.DBus.Properties" methods
718
1023
                if (if_tag.getAttribute("name")
733
1038
        except (AttributeError, xml.dom.DOMException,
734
1039
                xml.parsers.expat.ExpatError) as error:
735
1040
            logger.error("Failed to override Introspection method",
736
 
                         error)
 
1041
                         exc_info=error)
737
1042
        return xmlstring
738
1043
 
739
1044
 
 
1045
def datetime_to_dbus(dt, variant_level=0):
 
1046
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
1047
    if dt is None:
 
1048
        return dbus.String("", variant_level = variant_level)
 
1049
    return dbus.String(dt.isoformat(),
 
1050
                       variant_level=variant_level)
 
1051
 
 
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).
 
1075
    """
 
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):
 
1083
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1084
                # with the wrong interface name
 
1085
                if (not hasattr(attribute, "_dbus_interface")
 
1086
                    or not attribute._dbus_interface
 
1087
                    .startswith(orig_interface_name)):
 
1088
                    continue
 
1089
                # Create an alternate D-Bus interface name based on
 
1090
                # the current name
 
1091
                alt_interface = (attribute._dbus_interface
 
1092
                                 .replace(orig_interface_name,
 
1093
                                          alt_interface_name))
 
1094
                interface_names.add(alt_interface)
 
1095
                # Is this a D-Bus signal?
 
1096
                if getattr(attribute, "_dbus_is_signal", False):
 
1097
                    # Extract the original non-method undecorated
 
1098
                    # function by black magic
 
1099
                    nonmethod_func = (dict(
 
1100
                            zip(attribute.func_code.co_freevars,
 
1101
                                attribute.__closure__))["func"]
 
1102
                                      .cell_contents)
 
1103
                    # Create a new, but exactly alike, function
 
1104
                    # object, and decorate it to be a new D-Bus signal
 
1105
                    # with the alternate D-Bus interface name
 
1106
                    new_function = (dbus.service.signal
 
1107
                                    (alt_interface,
 
1108
                                     attribute._dbus_signature)
 
1109
                                    (types.FunctionType(
 
1110
                                nonmethod_func.func_code,
 
1111
                                nonmethod_func.func_globals,
 
1112
                                nonmethod_func.func_name,
 
1113
                                nonmethod_func.func_defaults,
 
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
 
1121
                    # Define a creator of a function to call both the
 
1122
                    # original and alternate functions, so both the
 
1123
                    # original and alternate signals gets sent when
 
1124
                    # the function is called
 
1125
                    def fixscope(func1, func2):
 
1126
                        """This function is a scope container to pass
 
1127
                        func1 and func2 to the "call_both" function
 
1128
                        outside of its arguments"""
 
1129
                        def call_both(*args, **kwargs):
 
1130
                            """This function will emit two D-Bus
 
1131
                            signals by calling func1 and func2"""
 
1132
                            func1(*args, **kwargs)
 
1133
                            func2(*args, **kwargs)
 
1134
                        return call_both
 
1135
                    # Create the "call_both" function and add it to
 
1136
                    # the class
 
1137
                    attr[attrname] = fixscope(attribute, new_function)
 
1138
                # Is this a D-Bus method?
 
1139
                elif getattr(attribute, "_dbus_is_method", False):
 
1140
                    # Create a new, but exactly alike, function
 
1141
                    # object.  Decorate it to be a new D-Bus method
 
1142
                    # with the alternate D-Bus interface name.  Add it
 
1143
                    # to the class.
 
1144
                    attr[attrname] = (dbus.service.method
 
1145
                                      (alt_interface,
 
1146
                                       attribute._dbus_in_signature,
 
1147
                                       attribute._dbus_out_signature)
 
1148
                                      (types.FunctionType
 
1149
                                       (attribute.func_code,
 
1150
                                        attribute.func_globals,
 
1151
                                        attribute.func_name,
 
1152
                                        attribute.func_defaults,
 
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
 
1160
                # Is this a D-Bus property?
 
1161
                elif getattr(attribute, "_dbus_is_property", False):
 
1162
                    # Create a new, but exactly alike, function
 
1163
                    # object, and decorate it to be a new D-Bus
 
1164
                    # property with the alternate D-Bus interface
 
1165
                    # name.  Add it to the class.
 
1166
                    attr[attrname] = (dbus_service_property
 
1167
                                      (alt_interface,
 
1168
                                       attribute._dbus_signature,
 
1169
                                       attribute._dbus_access,
 
1170
                                       attribute
 
1171
                                       ._dbus_get_args_options
 
1172
                                       ["byte_arrays"])
 
1173
                                      (types.FunctionType
 
1174
                                       (attribute.func_code,
 
1175
                                        attribute.func_globals,
 
1176
                                        attribute.func_name,
 
1177
                                        attribute.func_defaults,
 
1178
                                        attribute.func_closure)))
 
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"})
740
1224
class ClientDBus(Client, DBusObjectWithProperties):
741
1225
    """A Client class using D-Bus
742
1226
    
748
1232
    runtime_expansions = (Client.runtime_expansions
749
1233
                          + ("dbus_object_path",))
750
1234
    
 
1235
    _interface = "se.recompile.Mandos.Client"
 
1236
    
751
1237
    # dbus.service.Object doesn't use super(), so we can't either.
752
1238
    
753
1239
    def __init__(self, bus = None, *args, **kwargs):
754
 
        self._approvals_pending = 0
755
1240
        self.bus = bus
756
1241
        Client.__init__(self, *args, **kwargs)
757
1242
        # Only now, when this client is initialized, can it show up on
758
1243
        # the D-Bus
759
 
        client_object_name = unicode(self.name).translate(
 
1244
        client_object_name = str(self.name).translate(
760
1245
            {ord("."): ord("_"),
761
1246
             ord("-"): ord("_")})
762
1247
        self.dbus_object_path = (dbus.ObjectPath
763
1248
                                 ("/clients/" + client_object_name))
764
1249
        DBusObjectWithProperties.__init__(self, self.bus,
765
1250
                                          self.dbus_object_path)
766
 
        
767
 
    def _get_approvals_pending(self):
768
 
        return self._approvals_pending
769
 
    def _set_approvals_pending(self, value):
770
 
        old_value = self._approvals_pending
771
 
        self._approvals_pending = value
772
 
        bval = bool(value)
773
 
        if (hasattr(self, "dbus_object_path")
774
 
            and bval is not bool(old_value)):
775
 
            dbus_bool = dbus.Boolean(bval, variant_level=1)
776
 
            self.PropertyChanged(dbus.String("ApprovalPending"),
777
 
                                 dbus_bool)
778
 
 
779
 
    approvals_pending = property(_get_approvals_pending,
780
 
                                 _set_approvals_pending)
781
 
    del _get_approvals_pending, _set_approvals_pending
782
 
    
783
 
    @staticmethod
784
 
    def _datetime_to_dbus(dt, variant_level=0):
785
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
786
 
        return dbus.String(dt.isoformat(),
787
 
                           variant_level=variant_level)
788
 
    
789
 
    def enable(self):
790
 
        oldstate = getattr(self, "enabled", False)
791
 
        r = Client.enable(self)
792
 
        if oldstate != self.enabled:
793
 
            # Emit D-Bus signals
794
 
            self.PropertyChanged(dbus.String("Enabled"),
795
 
                                 dbus.Boolean(True, variant_level=1))
796
 
            self.PropertyChanged(
797
 
                dbus.String("LastEnabled"),
798
 
                self._datetime_to_dbus(self.last_enabled,
799
 
                                       variant_level=1))
800
 
        return r
801
 
    
802
 
    def disable(self, quiet = False):
803
 
        oldstate = getattr(self, "enabled", False)
804
 
        r = Client.disable(self, quiet=quiet)
805
 
        if not quiet and oldstate != self.enabled:
806
 
            # Emit D-Bus signal
807
 
            self.PropertyChanged(dbus.String("Enabled"),
808
 
                                 dbus.Boolean(False, variant_level=1))
809
 
        return r
 
1251
    
 
1252
    def notifychangeproperty(transform_func,
 
1253
                             dbus_name, type_func=lambda x: x,
 
1254
                             variant_level=1, invalidate_only=False,
 
1255
                             _interface=_interface):
 
1256
        """ Modify a variable so that it's a property which announces
 
1257
        its changes to DBus.
 
1258
        
 
1259
        transform_fun: Function that takes a value and a variant_level
 
1260
                       and transforms it to a D-Bus type.
 
1261
        dbus_name: D-Bus name of the variable
 
1262
        type_func: Function that transform the value before sending it
 
1263
                   to the D-Bus.  Default: no transform
 
1264
        variant_level: D-Bus variant level.  Default: 1
 
1265
        """
 
1266
        attrname = "_{}".format(dbus_name)
 
1267
        def setter(self, value):
 
1268
            if hasattr(self, "dbus_object_path"):
 
1269
                if (not hasattr(self, attrname) or
 
1270
                    type_func(getattr(self, attrname, None))
 
1271
                    != type_func(value)):
 
1272
                    if invalidate_only:
 
1273
                        self.PropertiesChanged(_interface,
 
1274
                                               dbus.Dictionary(),
 
1275
                                               dbus.Array
 
1276
                                               ((dbus_name,)))
 
1277
                    else:
 
1278
                        dbus_value = transform_func(type_func(value),
 
1279
                                                    variant_level
 
1280
                                                    =variant_level)
 
1281
                        self.PropertyChanged(dbus.String(dbus_name),
 
1282
                                             dbus_value)
 
1283
                        self.PropertiesChanged(_interface,
 
1284
                                               dbus.Dictionary({
 
1285
                                    dbus.String(dbus_name):
 
1286
                                        dbus_value }), dbus.Array())
 
1287
            setattr(self, attrname, value)
 
1288
        
 
1289
        return property(lambda self: getattr(self, attrname), setter)
 
1290
    
 
1291
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1292
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1293
                                             "ApprovalPending",
 
1294
                                             type_func = bool)
 
1295
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1296
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1297
                                        "LastEnabled")
 
1298
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1299
                                   type_func = lambda checker:
 
1300
                                       checker is not None)
 
1301
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1302
                                           "LastCheckedOK")
 
1303
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1304
                                               "LastCheckerStatus")
 
1305
    last_approval_request = notifychangeproperty(
 
1306
        datetime_to_dbus, "LastApprovalRequest")
 
1307
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1308
                                               "ApprovedByDefault")
 
1309
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1310
                                          "ApprovalDelay",
 
1311
                                          type_func =
 
1312
                                          lambda td: td.total_seconds()
 
1313
                                          * 1000)
 
1314
    approval_duration = notifychangeproperty(
 
1315
        dbus.UInt64, "ApprovalDuration",
 
1316
        type_func = lambda td: td.total_seconds() * 1000)
 
1317
    host = notifychangeproperty(dbus.String, "Host")
 
1318
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1319
                                   type_func = lambda td:
 
1320
                                       td.total_seconds() * 1000)
 
1321
    extended_timeout = notifychangeproperty(
 
1322
        dbus.UInt64, "ExtendedTimeout",
 
1323
        type_func = lambda td: td.total_seconds() * 1000)
 
1324
    interval = notifychangeproperty(dbus.UInt64,
 
1325
                                    "Interval",
 
1326
                                    type_func =
 
1327
                                    lambda td: td.total_seconds()
 
1328
                                    * 1000)
 
1329
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1330
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1331
                                  invalidate_only=True)
 
1332
    
 
1333
    del notifychangeproperty
810
1334
    
811
1335
    def __del__(self, *args, **kwargs):
812
1336
        try:
821
1345
                         *args, **kwargs):
822
1346
        self.checker_callback_tag = None
823
1347
        self.checker = None
824
 
        # Emit D-Bus signal
825
 
        self.PropertyChanged(dbus.String("CheckerRunning"),
826
 
                             dbus.Boolean(False, variant_level=1))
827
1348
        if os.WIFEXITED(condition):
828
1349
            exitstatus = os.WEXITSTATUS(condition)
829
1350
            # Emit D-Bus signal
839
1360
        return Client.checker_callback(self, pid, condition, command,
840
1361
                                       *args, **kwargs)
841
1362
    
842
 
    def checked_ok(self, *args, **kwargs):
843
 
        Client.checked_ok(self, *args, **kwargs)
844
 
        # Emit D-Bus signal
845
 
        self.PropertyChanged(
846
 
            dbus.String("LastCheckedOK"),
847
 
            (self._datetime_to_dbus(self.last_checked_ok,
848
 
                                    variant_level=1)))
849
 
    
850
 
    def need_approval(self, *args, **kwargs):
851
 
        r = Client.need_approval(self, *args, **kwargs)
852
 
        # Emit D-Bus signal
853
 
        self.PropertyChanged(
854
 
            dbus.String("LastApprovalRequest"),
855
 
            (self._datetime_to_dbus(self.last_approval_request,
856
 
                                    variant_level=1)))
857
 
        return r
858
 
    
859
1363
    def start_checker(self, *args, **kwargs):
860
 
        old_checker = self.checker
861
 
        if self.checker is not None:
862
 
            old_checker_pid = self.checker.pid
863
 
        else:
864
 
            old_checker_pid = None
 
1364
        old_checker_pid = getattr(self.checker, "pid", None)
865
1365
        r = Client.start_checker(self, *args, **kwargs)
866
1366
        # Only if new checker process was started
867
1367
        if (self.checker is not None
868
1368
            and old_checker_pid != self.checker.pid):
869
1369
            # Emit D-Bus signal
870
1370
            self.CheckerStarted(self.current_checker_command)
871
 
            self.PropertyChanged(
872
 
                dbus.String("CheckerRunning"),
873
 
                dbus.Boolean(True, variant_level=1))
874
1371
        return r
875
1372
    
876
 
    def stop_checker(self, *args, **kwargs):
877
 
        old_checker = getattr(self, "checker", None)
878
 
        r = Client.stop_checker(self, *args, **kwargs)
879
 
        if (old_checker is not None
880
 
            and getattr(self, "checker", None) is None):
881
 
            self.PropertyChanged(dbus.String("CheckerRunning"),
882
 
                                 dbus.Boolean(False, variant_level=1))
883
 
        return r
884
 
 
885
1373
    def _reset_approved(self):
886
 
        self._approved = None
 
1374
        self.approved = None
887
1375
        return False
888
1376
    
889
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)
890
1381
        self.send_changedstate()
891
 
        self._approved = value
892
 
        gobject.timeout_add(self._timedelta_to_milliseconds
893
 
                            (self.approval_duration),
894
 
                            self._reset_approved)
895
 
    
896
1382
    
897
1383
    ## D-Bus methods, signals & properties
898
 
    _interface = "se.bsnet.fukt.Mandos.Client"
 
1384
    
 
1385
    ## Interfaces
899
1386
    
900
1387
    ## Signals
901
1388
    
912
1399
        pass
913
1400
    
914
1401
    # PropertyChanged - signal
 
1402
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
915
1403
    @dbus.service.signal(_interface, signature="sv")
916
1404
    def PropertyChanged(self, property, value):
917
1405
        "D-Bus signal"
987
1475
        if value is None:       # get
988
1476
            return dbus.Boolean(self.approved_by_default)
989
1477
        self.approved_by_default = bool(value)
990
 
        # Emit D-Bus signal
991
 
        self.PropertyChanged(dbus.String("ApprovedByDefault"),
992
 
                             dbus.Boolean(value, variant_level=1))
993
1478
    
994
1479
    # ApprovalDelay - property
995
1480
    @dbus_service_property(_interface, signature="t",
996
1481
                           access="readwrite")
997
1482
    def ApprovalDelay_dbus_property(self, value=None):
998
1483
        if value is None:       # get
999
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1484
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1485
                               * 1000)
1000
1486
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1001
 
        # Emit D-Bus signal
1002
 
        self.PropertyChanged(dbus.String("ApprovalDelay"),
1003
 
                             dbus.UInt64(value, variant_level=1))
1004
1487
    
1005
1488
    # ApprovalDuration - property
1006
1489
    @dbus_service_property(_interface, signature="t",
1007
1490
                           access="readwrite")
1008
1491
    def ApprovalDuration_dbus_property(self, value=None):
1009
1492
        if value is None:       # get
1010
 
            return dbus.UInt64(self._timedelta_to_milliseconds(
1011
 
                    self.approval_duration))
 
1493
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1494
                               * 1000)
1012
1495
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1013
 
        # Emit D-Bus signal
1014
 
        self.PropertyChanged(dbus.String("ApprovalDuration"),
1015
 
                             dbus.UInt64(value, variant_level=1))
1016
1496
    
1017
1497
    # Name - property
1018
1498
    @dbus_service_property(_interface, signature="s", access="read")
1030
1510
    def Host_dbus_property(self, value=None):
1031
1511
        if value is None:       # get
1032
1512
            return dbus.String(self.host)
1033
 
        self.host = value
1034
 
        # Emit D-Bus signal
1035
 
        self.PropertyChanged(dbus.String("Host"),
1036
 
                             dbus.String(value, variant_level=1))
 
1513
        self.host = str(value)
1037
1514
    
1038
1515
    # Created - property
1039
1516
    @dbus_service_property(_interface, signature="s", access="read")
1040
1517
    def Created_dbus_property(self):
1041
 
        return dbus.String(self._datetime_to_dbus(self.created))
 
1518
        return datetime_to_dbus(self.created)
1042
1519
    
1043
1520
    # LastEnabled - property
1044
1521
    @dbus_service_property(_interface, signature="s", access="read")
1045
1522
    def LastEnabled_dbus_property(self):
1046
 
        if self.last_enabled is None:
1047
 
            return dbus.String("")
1048
 
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
 
1523
        return datetime_to_dbus(self.last_enabled)
1049
1524
    
1050
1525
    # Enabled - property
1051
1526
    @dbus_service_property(_interface, signature="b",
1065
1540
        if value is not None:
1066
1541
            self.checked_ok()
1067
1542
            return
1068
 
        if self.last_checked_ok is None:
1069
 
            return dbus.String("")
1070
 
        return dbus.String(self._datetime_to_dbus(self
1071
 
                                                  .last_checked_ok))
 
1543
        return datetime_to_dbus(self.last_checked_ok)
 
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
    
 
1551
    # Expires - property
 
1552
    @dbus_service_property(_interface, signature="s", access="read")
 
1553
    def Expires_dbus_property(self):
 
1554
        return datetime_to_dbus(self.expires)
1072
1555
    
1073
1556
    # LastApprovalRequest - property
1074
1557
    @dbus_service_property(_interface, signature="s", access="read")
1075
1558
    def LastApprovalRequest_dbus_property(self):
1076
 
        if self.last_approval_request is None:
1077
 
            return dbus.String("")
1078
 
        return dbus.String(self.
1079
 
                           _datetime_to_dbus(self
1080
 
                                             .last_approval_request))
 
1559
        return datetime_to_dbus(self.last_approval_request)
1081
1560
    
1082
1561
    # Timeout - property
1083
1562
    @dbus_service_property(_interface, signature="t",
1084
1563
                           access="readwrite")
1085
1564
    def Timeout_dbus_property(self, value=None):
1086
1565
        if value is None:       # get
1087
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1566
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1567
        old_timeout = self.timeout
1088
1568
        self.timeout = datetime.timedelta(0, 0, 0, value)
1089
 
        # Emit D-Bus signal
1090
 
        self.PropertyChanged(dbus.String("Timeout"),
1091
 
                             dbus.UInt64(value, variant_level=1))
1092
 
        if getattr(self, "disable_initiator_tag", None) is None:
1093
 
            return
1094
 
        # Reschedule timeout
1095
 
        gobject.source_remove(self.disable_initiator_tag)
1096
 
        self.disable_initiator_tag = None
1097
 
        time_to_die = (self.
1098
 
                       _timedelta_to_milliseconds((self
1099
 
                                                   .last_checked_ok
1100
 
                                                   + self.timeout)
1101
 
                                                  - datetime.datetime
1102
 
                                                  .utcnow()))
1103
 
        if time_to_die <= 0:
1104
 
            # The timeout has passed
1105
 
            self.disable()
1106
 
        else:
1107
 
            self.disable_initiator_tag = (gobject.timeout_add
1108
 
                                          (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))
 
1585
    
 
1586
    # ExtendedTimeout - property
 
1587
    @dbus_service_property(_interface, signature="t",
 
1588
                           access="readwrite")
 
1589
    def ExtendedTimeout_dbus_property(self, value=None):
 
1590
        if value is None:       # get
 
1591
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1592
                               * 1000)
 
1593
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1109
1594
    
1110
1595
    # Interval - property
1111
1596
    @dbus_service_property(_interface, signature="t",
1112
1597
                           access="readwrite")
1113
1598
    def Interval_dbus_property(self, value=None):
1114
1599
        if value is None:       # get
1115
 
            return dbus.UInt64(self.interval_milliseconds())
 
1600
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1116
1601
        self.interval = datetime.timedelta(0, 0, 0, value)
1117
 
        # Emit D-Bus signal
1118
 
        self.PropertyChanged(dbus.String("Interval"),
1119
 
                             dbus.UInt64(value, variant_level=1))
1120
1602
        if getattr(self, "checker_initiator_tag", None) is None:
1121
1603
            return
1122
 
        # Reschedule checker run
1123
 
        gobject.source_remove(self.checker_initiator_tag)
1124
 
        self.checker_initiator_tag = (gobject.timeout_add
1125
 
                                      (value, self.start_checker))
1126
 
        self.start_checker()    # Start one now, too
1127
 
 
 
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
 
1610
    
1128
1611
    # Checker - property
1129
1612
    @dbus_service_property(_interface, signature="s",
1130
1613
                           access="readwrite")
1131
1614
    def Checker_dbus_property(self, value=None):
1132
1615
        if value is None:       # get
1133
1616
            return dbus.String(self.checker_command)
1134
 
        self.checker_command = value
1135
 
        # Emit D-Bus signal
1136
 
        self.PropertyChanged(dbus.String("Checker"),
1137
 
                             dbus.String(self.checker_command,
1138
 
                                         variant_level=1))
 
1617
        self.checker_command = str(value)
1139
1618
    
1140
1619
    # CheckerRunning - property
1141
1620
    @dbus_service_property(_interface, signature="b",
1157
1636
    @dbus_service_property(_interface, signature="ay",
1158
1637
                           access="write", byte_arrays=True)
1159
1638
    def Secret_dbus_property(self, value):
1160
 
        self.secret = str(value)
 
1639
        self.secret = bytes(value)
1161
1640
    
1162
1641
    del _interface
1163
1642
 
1168
1647
        self._pipe.send(('init', fpr, address))
1169
1648
        if not self._pipe.recv():
1170
1649
            raise KeyError()
1171
 
 
 
1650
    
1172
1651
    def __getattribute__(self, name):
1173
 
        if(name == '_pipe'):
 
1652
        if name == '_pipe':
1174
1653
            return super(ProxyClient, self).__getattribute__(name)
1175
1654
        self._pipe.send(('getattr', name))
1176
1655
        data = self._pipe.recv()
1181
1660
                self._pipe.send(('funcall', name, args, kwargs))
1182
1661
                return self._pipe.recv()[1]
1183
1662
            return func
1184
 
 
 
1663
    
1185
1664
    def __setattr__(self, name, value):
1186
 
        if(name == '_pipe'):
 
1665
        if name == '_pipe':
1187
1666
            return super(ProxyClient, self).__setattr__(name, value)
1188
1667
        self._pipe.send(('setattr', name, value))
1189
1668
 
1197
1676
    def handle(self):
1198
1677
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1199
1678
            logger.info("TCP connection from: %s",
1200
 
                        unicode(self.client_address))
 
1679
                        str(self.client_address))
1201
1680
            logger.debug("Pipe FD: %d",
1202
1681
                         self.server.child_pipe.fileno())
1203
 
 
 
1682
            
1204
1683
            session = (gnutls.connection
1205
1684
                       .ClientSession(self.request,
1206
1685
                                      gnutls.connection
1207
1686
                                      .X509Credentials()))
1208
 
 
 
1687
            
1209
1688
            # Note: gnutls.connection.X509Credentials is really a
1210
1689
            # generic GnuTLS certificate credentials object so long as
1211
1690
            # no X.509 keys are added to it.  Therefore, we can use it
1212
1691
            # here despite using OpenPGP certificates.
1213
 
 
 
1692
            
1214
1693
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1215
1694
            #                      "+AES-256-CBC", "+SHA1",
1216
1695
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1222
1701
            (gnutls.library.functions
1223
1702
             .gnutls_priority_set_direct(session._c_object,
1224
1703
                                         priority, None))
1225
 
 
 
1704
            
1226
1705
            # Start communication using the Mandos protocol
1227
1706
            # Get protocol number
1228
1707
            line = self.request.makefile().readline()
1229
1708
            logger.debug("Protocol version: %r", line)
1230
1709
            try:
1231
1710
                if int(line.strip().split()[0]) > 1:
1232
 
                    raise RuntimeError
 
1711
                    raise RuntimeError(line)
1233
1712
            except (ValueError, IndexError, RuntimeError) as error:
1234
1713
                logger.error("Unknown protocol version: %s", error)
1235
1714
                return
1236
 
 
 
1715
            
1237
1716
            # Start GnuTLS connection
1238
1717
            try:
1239
1718
                session.handshake()
1243
1722
                # established.  Just abandon the request.
1244
1723
                return
1245
1724
            logger.debug("Handshake succeeded")
1246
 
 
 
1725
            
1247
1726
            approval_required = False
1248
1727
            try:
1249
1728
                try:
1254
1733
                    logger.warning("Bad certificate: %s", error)
1255
1734
                    return
1256
1735
                logger.debug("Fingerprint: %s", fpr)
1257
 
 
 
1736
                
1258
1737
                try:
1259
1738
                    client = ProxyClient(child_pipe, fpr,
1260
1739
                                         self.client_address)
1272
1751
                                       client.name)
1273
1752
                        if self.server.use_dbus:
1274
1753
                            # Emit D-Bus signal
1275
 
                            client.Rejected("Disabled")                    
 
1754
                            client.Rejected("Disabled")
1276
1755
                        return
1277
1756
                    
1278
 
                    if client._approved or not client.approval_delay:
 
1757
                    if client.approved or not client.approval_delay:
1279
1758
                        #We are approved or approval is disabled
1280
1759
                        break
1281
 
                    elif client._approved is None:
 
1760
                    elif client.approved is None:
1282
1761
                        logger.info("Client %s needs approval",
1283
1762
                                    client.name)
1284
1763
                        if self.server.use_dbus:
1285
1764
                            # Emit D-Bus signal
1286
1765
                            client.NeedApproval(
1287
 
                                client.approval_delay_milliseconds(),
1288
 
                                client.approved_by_default)
 
1766
                                client.approval_delay.total_seconds()
 
1767
                                * 1000, client.approved_by_default)
1289
1768
                    else:
1290
1769
                        logger.warning("Client %s was not approved",
1291
1770
                                       client.name)
1295
1774
                        return
1296
1775
                    
1297
1776
                    #wait until timeout or approved
1298
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1299
1777
                    time = datetime.datetime.now()
1300
1778
                    client.changedstate.acquire()
1301
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1779
                    client.changedstate.wait(delay.total_seconds())
1302
1780
                    client.changedstate.release()
1303
1781
                    time2 = datetime.datetime.now()
1304
1782
                    if (time2 - time) >= delay:
1320
1798
                    try:
1321
1799
                        sent = session.send(client.secret[sent_size:])
1322
1800
                    except gnutls.errors.GNUTLSError as error:
1323
 
                        logger.warning("gnutls send failed")
 
1801
                        logger.warning("gnutls send failed",
 
1802
                                       exc_info=error)
1324
1803
                        return
1325
1804
                    logger.debug("Sent: %d, remaining: %d",
1326
1805
                                 sent, len(client.secret)
1327
1806
                                 - (sent_size + sent))
1328
1807
                    sent_size += sent
1329
 
 
 
1808
                
1330
1809
                logger.info("Sending secret to %s", client.name)
1331
 
                # bump the timeout as if seen
1332
 
                client.checked_ok()
 
1810
                # bump the timeout using extended_timeout
 
1811
                client.bump_timeout(client.extended_timeout)
1333
1812
                if self.server.use_dbus:
1334
1813
                    # Emit D-Bus signal
1335
1814
                    client.GotSecret()
1340
1819
                try:
1341
1820
                    session.bye()
1342
1821
                except gnutls.errors.GNUTLSError as error:
1343
 
                    logger.warning("GnuTLS bye failed")
 
1822
                    logger.warning("GnuTLS bye failed",
 
1823
                                   exc_info=error)
1344
1824
    
1345
1825
    @staticmethod
1346
1826
    def peer_certificate(session):
1402
1882
        # Convert the buffer to a Python bytestring
1403
1883
        fpr = ctypes.string_at(buf, buf_len.value)
1404
1884
        # Convert the bytestring to hexadecimal notation
1405
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1885
        hex_fpr = binascii.hexlify(fpr).upper()
1406
1886
        return hex_fpr
1407
1887
 
1408
1888
 
1411
1891
    def sub_process_main(self, request, address):
1412
1892
        try:
1413
1893
            self.finish_request(request, address)
1414
 
        except:
 
1894
        except Exception:
1415
1895
            self.handle_error(request, address)
1416
1896
        self.close_request(request)
1417
 
            
 
1897
    
1418
1898
    def process_request(self, request, address):
1419
1899
        """Start a new process to process the request."""
1420
 
        multiprocessing.Process(target = self.sub_process_main,
1421
 
                                args = (request, address)).start()
 
1900
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1901
                                       args = (request, address))
 
1902
        proc.start()
 
1903
        return proc
 
1904
 
1422
1905
 
1423
1906
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1424
1907
    """ adds a pipe to the MixIn """
1428
1911
        This function creates a new pipe in self.pipe
1429
1912
        """
1430
1913
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1431
 
 
1432
 
        super(MultiprocessingMixInWithPipe,
1433
 
              self).process_request(request, client_address)
 
1914
        
 
1915
        proc = MultiprocessingMixIn.process_request(self, request,
 
1916
                                                    client_address)
1434
1917
        self.child_pipe.close()
1435
 
        self.add_pipe(parent_pipe)
1436
 
 
1437
 
    def add_pipe(self, parent_pipe):
 
1918
        self.add_pipe(parent_pipe, proc)
 
1919
    
 
1920
    def add_pipe(self, parent_pipe, proc):
1438
1921
        """Dummy function; override as necessary"""
1439
 
        raise NotImplementedError
 
1922
        raise NotImplementedError()
 
1923
 
1440
1924
 
1441
1925
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1442
1926
                     socketserver.TCPServer, object):
1448
1932
        use_ipv6:       Boolean; to use IPv6 or not
1449
1933
    """
1450
1934
    def __init__(self, server_address, RequestHandlerClass,
1451
 
                 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
        """
1452
1939
        self.interface = interface
1453
1940
        if use_ipv6:
1454
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.
1455
1968
        socketserver.TCPServer.__init__(self, server_address,
1456
1969
                                        RequestHandlerClass)
 
1970
    
1457
1971
    def server_bind(self):
1458
1972
        """This overrides the normal server_bind() function
1459
1973
        to bind to an interface if one was specified, and also NOT to
1467
1981
                try:
1468
1982
                    self.socket.setsockopt(socket.SOL_SOCKET,
1469
1983
                                           SO_BINDTODEVICE,
1470
 
                                           str(self.interface
1471
 
                                               + '\0'))
 
1984
                                           (self.interface + "\0")
 
1985
                                           .encode("utf-8"))
1472
1986
                except socket.error as error:
1473
 
                    if error[0] == errno.EPERM:
1474
 
                        logger.error("No permission to"
1475
 
                                     " bind to interface %s",
1476
 
                                     self.interface)
1477
 
                    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:
1478
1991
                        logger.error("SO_BINDTODEVICE not available;"
1479
1992
                                     " cannot bind to interface %s",
1480
1993
                                     self.interface)
 
1994
                    elif error.errno == errno.ENODEV:
 
1995
                        logger.error("Interface %s does not exist,"
 
1996
                                     " cannot bind", self.interface)
1481
1997
                    else:
1482
1998
                        raise
1483
1999
        # Only bind(2) the socket if we really need to.
1486
2002
                if self.address_family == socket.AF_INET6:
1487
2003
                    any_address = "::" # in6addr_any
1488
2004
                else:
1489
 
                    any_address = socket.INADDR_ANY
 
2005
                    any_address = "0.0.0.0" # INADDR_ANY
1490
2006
                self.server_address = (any_address,
1491
2007
                                       self.server_address[1])
1492
2008
            elif not self.server_address[1]:
1513
2029
    """
1514
2030
    def __init__(self, server_address, RequestHandlerClass,
1515
2031
                 interface=None, use_ipv6=True, clients=None,
1516
 
                 gnutls_priority=None, use_dbus=True):
 
2032
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1517
2033
        self.enabled = False
1518
2034
        self.clients = clients
1519
2035
        if self.clients is None:
1520
 
            self.clients = set()
 
2036
            self.clients = {}
1521
2037
        self.use_dbus = use_dbus
1522
2038
        self.gnutls_priority = gnutls_priority
1523
2039
        IPv6_TCPServer.__init__(self, server_address,
1524
2040
                                RequestHandlerClass,
1525
2041
                                interface = interface,
1526
 
                                use_ipv6 = use_ipv6)
 
2042
                                use_ipv6 = use_ipv6,
 
2043
                                socketfd = socketfd)
1527
2044
    def server_activate(self):
1528
2045
        if self.enabled:
1529
2046
            return socketserver.TCPServer.server_activate(self)
 
2047
    
1530
2048
    def enable(self):
1531
2049
        self.enabled = True
1532
 
    def add_pipe(self, parent_pipe):
 
2050
    
 
2051
    def add_pipe(self, parent_pipe, proc):
1533
2052
        # Call "handle_ipc" for both data and EOF events
1534
2053
        gobject.io_add_watch(parent_pipe.fileno(),
1535
2054
                             gobject.IO_IN | gobject.IO_HUP,
1536
2055
                             functools.partial(self.handle_ipc,
1537
 
                                               parent_pipe = parent_pipe))
1538
 
        
 
2056
                                               parent_pipe =
 
2057
                                               parent_pipe,
 
2058
                                               proc = proc))
 
2059
    
1539
2060
    def handle_ipc(self, source, condition, parent_pipe=None,
1540
 
                   client_object=None):
1541
 
        condition_names = {
1542
 
            gobject.IO_IN: "IN",   # There is data to read.
1543
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1544
 
                                    # blocking).
1545
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1546
 
            gobject.IO_ERR: "ERR", # Error condition.
1547
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1548
 
                                    # broken, usually for pipes and
1549
 
                                    # sockets).
1550
 
            }
1551
 
        conditions_string = ' | '.join(name
1552
 
                                       for cond, name in
1553
 
                                       condition_names.iteritems()
1554
 
                                       if cond & condition)
1555
 
        # error or the other end of multiprocessing.Pipe has closed
1556
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2061
                   proc = None, client_object=None):
 
2062
        # error, or the other end of multiprocessing.Pipe has closed
 
2063
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2064
            # Wait for other process to exit
 
2065
            proc.join()
1557
2066
            return False
1558
2067
        
1559
2068
        # Read a request from the child
1564
2073
            fpr = request[1]
1565
2074
            address = request[2]
1566
2075
            
1567
 
            for c in self.clients:
 
2076
            for c in self.clients.itervalues():
1568
2077
                if c.fingerprint == fpr:
1569
2078
                    client = c
1570
2079
                    break
1573
2082
                            "dress: %s", fpr, address)
1574
2083
                if self.use_dbus:
1575
2084
                    # Emit D-Bus signal
1576
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2085
                    mandos_dbus_service.ClientNotFound(fpr,
 
2086
                                                       address[0])
1577
2087
                parent_pipe.send(False)
1578
2088
                return False
1579
2089
            
1580
2090
            gobject.io_add_watch(parent_pipe.fileno(),
1581
2091
                                 gobject.IO_IN | gobject.IO_HUP,
1582
2092
                                 functools.partial(self.handle_ipc,
1583
 
                                                   parent_pipe = parent_pipe,
1584
 
                                                   client_object = client))
 
2093
                                                   parent_pipe =
 
2094
                                                   parent_pipe,
 
2095
                                                   proc = proc,
 
2096
                                                   client_object =
 
2097
                                                   client))
1585
2098
            parent_pipe.send(True)
1586
 
            # remove the old hook in favor of the new above hook on same fileno
 
2099
            # remove the old hook in favor of the new above hook on
 
2100
            # same fileno
1587
2101
            return False
1588
2102
        if command == 'funcall':
1589
2103
            funcname = request[1]
1590
2104
            args = request[2]
1591
2105
            kwargs = request[3]
1592
2106
            
1593
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1594
 
 
 
2107
            parent_pipe.send(('data', getattr(client_object,
 
2108
                                              funcname)(*args,
 
2109
                                                         **kwargs)))
 
2110
        
1595
2111
        if command == 'getattr':
1596
2112
            attrname = request[1]
1597
2113
            if callable(client_object.__getattribute__(attrname)):
1598
2114
                parent_pipe.send(('function',))
1599
2115
            else:
1600
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2116
                parent_pipe.send(('data', client_object
 
2117
                                  .__getattribute__(attrname)))
1601
2118
        
1602
2119
        if command == 'setattr':
1603
2120
            attrname = request[1]
1604
2121
            value = request[2]
1605
2122
            setattr(client_object, attrname, value)
1606
 
 
 
2123
        
1607
2124
        return True
1608
2125
 
1609
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
 
1610
2226
def string_to_delta(interval):
1611
2227
    """Parse a string and return a datetime.timedelta
1612
2228
    
1623
2239
    >>> string_to_delta('5m 30s')
1624
2240
    datetime.timedelta(0, 330)
1625
2241
    """
 
2242
    
 
2243
    try:
 
2244
        return rfc3339_duration_to_delta(interval)
 
2245
    except ValueError:
 
2246
        pass
 
2247
    
1626
2248
    timevalue = datetime.timedelta(0)
1627
2249
    for s in interval.split():
1628
2250
        try:
1629
 
            suffix = unicode(s[-1])
 
2251
            suffix = s[-1]
1630
2252
            value = int(s[:-1])
1631
2253
            if suffix == "d":
1632
2254
                delta = datetime.timedelta(value)
1639
2261
            elif suffix == "w":
1640
2262
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1641
2263
            else:
1642
 
                raise ValueError("Unknown suffix %r" % suffix)
1643
 
        except (ValueError, IndexError) as e:
 
2264
                raise ValueError("Unknown suffix {!r}"
 
2265
                                 .format(suffix))
 
2266
        except IndexError as e:
1644
2267
            raise ValueError(*(e.args))
1645
2268
        timevalue += delta
1646
2269
    return timevalue
1647
2270
 
1648
2271
 
1649
 
def if_nametoindex(interface):
1650
 
    """Call the C function if_nametoindex(), or equivalent
1651
 
    
1652
 
    Note: This function cannot accept a unicode string."""
1653
 
    global if_nametoindex
1654
 
    try:
1655
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1656
 
                          (ctypes.util.find_library("c"))
1657
 
                          .if_nametoindex)
1658
 
    except (OSError, AttributeError):
1659
 
        logger.warning("Doing if_nametoindex the hard way")
1660
 
        def if_nametoindex(interface):
1661
 
            "Get an interface index the hard way, i.e. using fcntl()"
1662
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1663
 
            with contextlib.closing(socket.socket()) as s:
1664
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1665
 
                                    struct.pack(str("16s16x"),
1666
 
                                                interface))
1667
 
            interface_index = struct.unpack(str("I"),
1668
 
                                            ifreq[16:20])[0]
1669
 
            return interface_index
1670
 
    return if_nametoindex(interface)
1671
 
 
1672
 
 
1673
2272
def daemon(nochdir = False, noclose = False):
1674
2273
    """See daemon(3).  Standard BSD Unix function.
1675
2274
    
1683
2282
        sys.exit()
1684
2283
    if not noclose:
1685
2284
        # Close all standard open file descriptors
1686
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2285
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1687
2286
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1688
 
            raise OSError(errno.ENODEV,
1689
 
                          "%s not a character device"
1690
 
                          % os.path.devnull)
 
2287
            raise OSError(errno.ENODEV, "{} not a character device"
 
2288
                          .format(os.devnull))
1691
2289
        os.dup2(null, sys.stdin.fileno())
1692
2290
        os.dup2(null, sys.stdout.fileno())
1693
2291
        os.dup2(null, sys.stderr.fileno())
1702
2300
    
1703
2301
    parser = argparse.ArgumentParser()
1704
2302
    parser.add_argument("-v", "--version", action="version",
1705
 
                        version = "%%(prog)s %s" % version,
 
2303
                        version = "%(prog)s {}".format(version),
1706
2304
                        help="show version number and exit")
1707
2305
    parser.add_argument("-i", "--interface", metavar="IF",
1708
2306
                        help="Bind to interface IF")
1714
2312
                        help="Run self-test")
1715
2313
    parser.add_argument("--debug", action="store_true",
1716
2314
                        help="Debug mode; run in foreground and log"
1717
 
                        " to terminal")
 
2315
                        " to terminal", default=None)
1718
2316
    parser.add_argument("--debuglevel", metavar="LEVEL",
1719
2317
                        help="Debug level for stdout output")
1720
2318
    parser.add_argument("--priority", help="GnuTLS"
1727
2325
                        " files")
1728
2326
    parser.add_argument("--no-dbus", action="store_false",
1729
2327
                        dest="use_dbus", help="Do not provide D-Bus"
1730
 
                        " system bus interface")
 
2328
                        " system bus interface", default=None)
1731
2329
    parser.add_argument("--no-ipv6", action="store_false",
1732
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2330
                        dest="use_ipv6", help="Do not use IPv6",
 
2331
                        default=None)
 
2332
    parser.add_argument("--no-restore", action="store_false",
 
2333
                        dest="restore", help="Do not restore stored"
 
2334
                        " state", default=None)
 
2335
    parser.add_argument("--socket", type=int,
 
2336
                        help="Specify a file descriptor to a network"
 
2337
                        " socket to use instead of creating one")
 
2338
    parser.add_argument("--statedir", metavar="DIR",
 
2339
                        help="Directory to save/restore state in")
 
2340
    parser.add_argument("--foreground", action="store_true",
 
2341
                        help="Run in foreground", default=None)
 
2342
    parser.add_argument("--no-zeroconf", action="store_false",
 
2343
                        dest="zeroconf", help="Do not use Zeroconf",
 
2344
                        default=None)
 
2345
    
1733
2346
    options = parser.parse_args()
1734
2347
    
1735
2348
    if options.check:
1736
2349
        import doctest
1737
 
        doctest.testmod()
1738
 
        sys.exit()
 
2350
        fail_count, test_count = doctest.testmod()
 
2351
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1739
2352
    
1740
2353
    # Default values for config file for server-global settings
1741
2354
    server_defaults = { "interface": "",
1743
2356
                        "port": "",
1744
2357
                        "debug": "False",
1745
2358
                        "priority":
1746
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2359
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2360
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1747
2361
                        "servicename": "Mandos",
1748
2362
                        "use_dbus": "True",
1749
2363
                        "use_ipv6": "True",
1750
2364
                        "debuglevel": "",
 
2365
                        "restore": "True",
 
2366
                        "socket": "",
 
2367
                        "statedir": "/var/lib/mandos",
 
2368
                        "foreground": "False",
 
2369
                        "zeroconf": "True",
1751
2370
                        }
1752
2371
    
1753
2372
    # Parse config file for server-global settings
1758
2377
    # Convert the SafeConfigParser object to a dict
1759
2378
    server_settings = server_config.defaults()
1760
2379
    # Use the appropriate methods on the non-string config options
1761
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2380
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1762
2381
        server_settings[option] = server_config.getboolean("DEFAULT",
1763
2382
                                                           option)
1764
2383
    if server_settings["port"]:
1765
2384
        server_settings["port"] = server_config.getint("DEFAULT",
1766
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"])
1767
2395
    del server_config
1768
2396
    
1769
2397
    # Override the settings from the config file with command line
1770
2398
    # options, if set.
1771
2399
    for option in ("interface", "address", "port", "debug",
1772
2400
                   "priority", "servicename", "configdir",
1773
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2401
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2402
                   "statedir", "socket", "foreground", "zeroconf"):
1774
2403
        value = getattr(options, option)
1775
2404
        if value is not None:
1776
2405
            server_settings[option] = value
1777
2406
    del options
1778
2407
    # Force all strings to be unicode
1779
2408
    for option in server_settings.keys():
1780
 
        if type(server_settings[option]) is str:
1781
 
            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
1782
2419
    # Now we have our good server settings in "server_settings"
1783
2420
    
1784
2421
    ##################################################################
1785
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
    
1786
2429
    # For convenience
1787
2430
    debug = server_settings["debug"]
1788
2431
    debuglevel = server_settings["debuglevel"]
1789
2432
    use_dbus = server_settings["use_dbus"]
1790
2433
    use_ipv6 = server_settings["use_ipv6"]
1791
 
 
 
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)
 
2447
    
1792
2448
    if server_settings["servicename"] != "Mandos":
1793
2449
        syslogger.setFormatter(logging.Formatter
1794
 
                               ('Mandos (%s) [%%(process)d]:'
1795
 
                                ' %%(levelname)s: %%(message)s'
1796
 
                                % server_settings["servicename"]))
 
2450
                               ('Mandos ({}) [%(process)d]:'
 
2451
                                ' %(levelname)s: %(message)s'
 
2452
                                .format(server_settings
 
2453
                                        ["servicename"])))
1797
2454
    
1798
2455
    # Parse config file with clients
1799
 
    client_defaults = { "timeout": "1h",
1800
 
                        "interval": "5m",
1801
 
                        "checker": "fping -q -- %%(host)s",
1802
 
                        "host": "",
1803
 
                        "approval_delay": "0s",
1804
 
                        "approval_duration": "1s",
1805
 
                        }
1806
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2456
    client_config = configparser.SafeConfigParser(Client
 
2457
                                                  .client_defaults)
1807
2458
    client_config.read(os.path.join(server_settings["configdir"],
1808
2459
                                    "clients.conf"))
1809
2460
    
1810
2461
    global mandos_dbus_service
1811
2462
    mandos_dbus_service = None
1812
2463
    
 
2464
    socketfd = None
 
2465
    if server_settings["socket"] != "":
 
2466
        socketfd = server_settings["socket"]
1813
2467
    tcp_server = MandosServer((server_settings["address"],
1814
2468
                               server_settings["port"]),
1815
2469
                              ClientHandler,
1818
2472
                              use_ipv6=use_ipv6,
1819
2473
                              gnutls_priority=
1820
2474
                              server_settings["priority"],
1821
 
                              use_dbus=use_dbus)
1822
 
    if not debug:
1823
 
        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
1824
2482
        try:
1825
2483
            pidfile = open(pidfilename, "w")
1826
 
        except IOError:
1827
 
            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)
1828
2487
    
1829
 
    try:
1830
 
        uid = pwd.getpwnam("_mandos").pw_uid
1831
 
        gid = pwd.getpwnam("_mandos").pw_gid
1832
 
    except KeyError:
 
2488
    for name in ("_mandos", "mandos", "nobody"):
1833
2489
        try:
1834
 
            uid = pwd.getpwnam("mandos").pw_uid
1835
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2490
            uid = pwd.getpwnam(name).pw_uid
 
2491
            gid = pwd.getpwnam(name).pw_gid
 
2492
            break
1836
2493
        except KeyError:
1837
 
            try:
1838
 
                uid = pwd.getpwnam("nobody").pw_uid
1839
 
                gid = pwd.getpwnam("nobody").pw_gid
1840
 
            except KeyError:
1841
 
                uid = 65534
1842
 
                gid = 65534
 
2494
            continue
 
2495
    else:
 
2496
        uid = 65534
 
2497
        gid = 65534
1843
2498
    try:
1844
2499
        os.setgid(gid)
1845
2500
        os.setuid(uid)
1846
2501
    except OSError as error:
1847
 
        if error[0] != errno.EPERM:
1848
 
            raise error
 
2502
        if error.errno != errno.EPERM:
 
2503
            raise
1849
2504
    
1850
 
    if not debug and not debuglevel:
1851
 
        syslogger.setLevel(logging.WARNING)
1852
 
        console.setLevel(logging.WARNING)
1853
 
    if debuglevel:
1854
 
        level = getattr(logging, debuglevel.upper())
1855
 
        syslogger.setLevel(level)
1856
 
        console.setLevel(level)
1857
 
 
1858
2505
    if debug:
1859
2506
        # Enable all possible GnuTLS debugging
1860
2507
        
1870
2517
         .gnutls_global_set_log_function(debug_gnutls))
1871
2518
        
1872
2519
        # Redirect stdin so all checkers get /dev/null
1873
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2520
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1874
2521
        os.dup2(null, sys.stdin.fileno())
1875
2522
        if null > 2:
1876
2523
            os.close(null)
1877
 
    else:
1878
 
        # No console logging
1879
 
        logger.removeHandler(console)
1880
2524
    
1881
2525
    # Need to fork before connecting to D-Bus
1882
 
    if not debug:
 
2526
    if not foreground:
1883
2527
        # Close all input and output, do double fork, etc.
1884
2528
        daemon()
1885
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
    
1886
2534
    global main_loop
1887
2535
    # From the Avahi example code
1888
 
    DBusGMainLoop(set_as_default=True )
 
2536
    DBusGMainLoop(set_as_default=True)
1889
2537
    main_loop = gobject.MainLoop()
1890
2538
    bus = dbus.SystemBus()
1891
2539
    # End of Avahi example code
1892
2540
    if use_dbus:
1893
2541
        try:
1894
 
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
 
2542
            bus_name = dbus.service.BusName("se.recompile.Mandos",
1895
2543
                                            bus, do_not_queue=True)
 
2544
            old_bus_name = (dbus.service.BusName
 
2545
                            ("se.bsnet.fukt.Mandos", bus,
 
2546
                             do_not_queue=True))
1896
2547
        except dbus.exceptions.NameExistsException as e:
1897
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2548
            logger.error("Disabling D-Bus:", exc_info=e)
1898
2549
            use_dbus = False
1899
2550
            server_settings["use_dbus"] = False
1900
2551
            tcp_server.use_dbus = False
1901
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1902
 
    service = AvahiService(name = server_settings["servicename"],
1903
 
                           servicetype = "_mandos._tcp",
1904
 
                           protocol = protocol, bus = bus)
1905
 
    if server_settings["interface"]:
1906
 
        service.interface = (if_nametoindex
1907
 
                             (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")))
1908
2562
    
1909
2563
    global multiprocessing_manager
1910
2564
    multiprocessing_manager = multiprocessing.Manager()
1912
2566
    client_class = Client
1913
2567
    if use_dbus:
1914
2568
        client_class = functools.partial(ClientDBus, bus = bus)
1915
 
    def client_config_items(config, section):
1916
 
        special_settings = {
1917
 
            "approved_by_default":
1918
 
                lambda: config.getboolean(section,
1919
 
                                          "approved_by_default"),
1920
 
            }
1921
 
        for name, value in config.items(section):
 
2569
    
 
2570
    client_settings = Client.config_parser(client_config)
 
2571
    old_client_settings = {}
 
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.
 
2583
    if server_settings["restore"]:
 
2584
        try:
 
2585
            with open(stored_state_path, "rb") as stored_state:
 
2586
                clients_data, old_client_settings = (pickle.load
 
2587
                                                     (stored_state))
 
2588
            os.remove(stored_state_path)
 
2589
        except IOError as e:
 
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)
 
2596
                raise
 
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))
1922
2651
            try:
1923
 
                yield (name, special_settings[name]())
1924
 
            except KeyError:
1925
 
                yield (name, value)
1926
 
    
1927
 
    tcp_server.clients.update(set(
1928
 
            client_class(name = section,
1929
 
                         config= dict(client_config_items(
1930
 
                        client_config, section)))
1931
 
            for section in client_config.sections()))
 
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
    
1932
2677
    if not tcp_server.clients:
1933
2678
        logger.warning("No clients defined")
1934
 
        
1935
 
    if not debug:
1936
 
        try:
1937
 
            with pidfile:
1938
 
                pid = os.getpid()
1939
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
1940
 
            del pidfile
1941
 
        except IOError:
1942
 
            logger.error("Could not write to file %r with PID %d",
1943
 
                         pidfilename, pid)
1944
 
        except NameError:
1945
 
            # "pidfile" was never created
1946
 
            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
1947
2690
        del pidfilename
1948
 
        
1949
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1950
 
 
 
2691
    
1951
2692
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1952
2693
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1953
2694
    
1954
2695
    if use_dbus:
1955
 
        class MandosDBusService(dbus.service.Object):
 
2696
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2697
                                        "se.bsnet.fukt.Mandos"})
 
2698
        class MandosDBusService(DBusObjectWithProperties):
1956
2699
            """A D-Bus proxy object"""
1957
2700
            def __init__(self):
1958
2701
                dbus.service.Object.__init__(self, bus, "/")
1959
 
            _interface = "se.bsnet.fukt.Mandos"
 
2702
            _interface = "se.recompile.Mandos"
 
2703
            
 
2704
            @dbus_interface_annotations(_interface)
 
2705
            def _foo(self):
 
2706
                return { "org.freedesktop.DBus.Property"
 
2707
                         ".EmitsChangedSignal":
 
2708
                             "false"}
1960
2709
            
1961
2710
            @dbus.service.signal(_interface, signature="o")
1962
2711
            def ClientAdded(self, objpath):
1977
2726
            def GetAllClients(self):
1978
2727
                "D-Bus method"
1979
2728
                return dbus.Array(c.dbus_object_path
1980
 
                                  for c in tcp_server.clients)
 
2729
                                  for c in
 
2730
                                  tcp_server.clients.itervalues())
1981
2731
            
1982
2732
            @dbus.service.method(_interface,
1983
2733
                                 out_signature="a{oa{sv}}")
1984
2734
            def GetAllClientsWithProperties(self):
1985
2735
                "D-Bus method"
1986
2736
                return dbus.Dictionary(
1987
 
                    ((c.dbus_object_path, c.GetAll(""))
1988
 
                     for c in tcp_server.clients),
 
2737
                    { c.dbus_object_path: c.GetAll("")
 
2738
                      for c in tcp_server.clients.itervalues() },
1989
2739
                    signature="oa{sv}")
1990
2740
            
1991
2741
            @dbus.service.method(_interface, in_signature="o")
1992
2742
            def RemoveClient(self, object_path):
1993
2743
                "D-Bus method"
1994
 
                for c in tcp_server.clients:
 
2744
                for c in tcp_server.clients.itervalues():
1995
2745
                    if c.dbus_object_path == object_path:
1996
 
                        tcp_server.clients.remove(c)
 
2746
                        del tcp_server.clients[c.name]
1997
2747
                        c.remove_from_connection()
1998
2748
                        # Don't signal anything except ClientRemoved
1999
2749
                        c.disable(quiet=True)
2008
2758
    
2009
2759
    def cleanup():
2010
2760
        "Cleanup function; run on exit"
2011
 
        service.cleanup()
2012
 
        
 
2761
        if zeroconf:
 
2762
            service.cleanup()
 
2763
        
 
2764
        multiprocessing.active_children()
 
2765
        wnull.close()
 
2766
        if not (tcp_server.clients or client_settings):
 
2767
            return
 
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
        
 
2797
        try:
 
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:
 
2802
                pickle.dump((clients, client_settings), stored_state)
 
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)
 
2817
                raise
 
2818
        
 
2819
        # Delete all clients, and settings from config
2013
2820
        while tcp_server.clients:
2014
 
            client = tcp_server.clients.pop()
 
2821
            name, client = tcp_server.clients.popitem()
2015
2822
            if use_dbus:
2016
2823
                client.remove_from_connection()
2017
 
            client.disable_hook = None
2018
2824
            # Don't signal anything except ClientRemoved
2019
2825
            client.disable(quiet=True)
2020
2826
            if use_dbus:
2021
2827
                # Emit D-Bus signal
2022
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2828
                mandos_dbus_service.ClientRemoved(client
 
2829
                                                  .dbus_object_path,
2023
2830
                                                  client.name)
 
2831
        client_settings.clear()
2024
2832
    
2025
2833
    atexit.register(cleanup)
2026
2834
    
2027
 
    for client in tcp_server.clients:
 
2835
    for client in tcp_server.clients.itervalues():
2028
2836
        if use_dbus:
2029
2837
            # Emit D-Bus signal
2030
2838
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2031
 
        client.enable()
 
2839
        # Need to initiate checking of clients
 
2840
        if client.enabled:
 
2841
            client.init_checker()
2032
2842
    
2033
2843
    tcp_server.enable()
2034
2844
    tcp_server.server_activate()
2035
2845
    
2036
2846
    # Find out what port we got
2037
 
    service.port = tcp_server.socket.getsockname()[1]
 
2847
    if zeroconf:
 
2848
        service.port = tcp_server.socket.getsockname()[1]
2038
2849
    if use_ipv6:
2039
2850
        logger.info("Now listening on address %r, port %d,"
2040
 
                    " flowinfo %d, scope_id %d"
2041
 
                    % tcp_server.socket.getsockname())
 
2851
                    " flowinfo %d, scope_id %d",
 
2852
                    *tcp_server.socket.getsockname())
2042
2853
    else:                       # IPv4
2043
 
        logger.info("Now listening on address %r, port %d"
2044
 
                    % tcp_server.socket.getsockname())
 
2854
        logger.info("Now listening on address %r, port %d",
 
2855
                    *tcp_server.socket.getsockname())
2045
2856
    
2046
2857
    #service.interface = tcp_server.socket.getsockname()[3]
2047
2858
    
2048
2859
    try:
2049
 
        # From the Avahi example code
2050
 
        try:
2051
 
            service.activate()
2052
 
        except dbus.exceptions.DBusException as error:
2053
 
            logger.critical("DBusException: %s", error)
2054
 
            cleanup()
2055
 
            sys.exit(1)
2056
 
        # 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
2057
2869
        
2058
2870
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2059
2871
                             lambda *args, **kwargs:
2063
2875
        logger.debug("Starting main loop")
2064
2876
        main_loop.run()
2065
2877
    except AvahiError as error:
2066
 
        logger.critical("AvahiError: %s", error)
 
2878
        logger.critical("Avahi Error", exc_info=error)
2067
2879
        cleanup()
2068
2880
        sys.exit(1)
2069
2881
    except KeyboardInterrupt: