/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: 2011-07-16 00:29:19 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110716002919-r77yikuiulj42o40
* initramfs-tools-script: Abort if plugin-runner is missing.  Removed
                          workaround for Debian bug #633582; the
                          workaround required getopt, which can not be
                          guaranteed.
* plugin-runner.c (main): Work around Debian bug #633582.
* plugins.d/mandos-client.c (main): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python2.7
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2014 Teddy Hogeborn
15
 
# Copyright © 2008-2014 Björn Påhlsson
 
14
# Copyright © 2008-2011 Teddy Hogeborn
 
15
# Copyright © 2008-2011 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@recompile.se>.
 
31
# Contact the authors at <mandos@fukt.bsnet.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
 
 
39
37
import SocketServer as socketserver
40
38
import socket
41
39
import argparse
64
62
import functools
65
63
import cPickle as pickle
66
64
import multiprocessing
67
 
import types
68
 
import binascii
69
 
import tempfile
70
 
import itertools
71
 
import collections
72
65
 
73
66
import dbus
74
67
import dbus.service
88
81
    except ImportError:
89
82
        SO_BINDTODEVICE = None
90
83
 
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
 
 
 
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)
224
102
 
225
103
class AvahiError(Exception):
226
104
    def __init__(self, value, *args, **kwargs):
227
105
        self.value = value
228
 
        return super(AvahiError, self).__init__(value, *args,
229
 
                                                **kwargs)
 
106
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
107
    def __unicode__(self):
 
108
        return unicode(repr(self.value))
230
109
 
231
110
class AvahiServiceError(AvahiError):
232
111
    pass
243
122
               Used to optionally bind to the specified interface.
244
123
    name: string; Example: 'Mandos'
245
124
    type: string; Example: '_mandos._tcp'.
246
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
125
                  See <http://www.dns-sd.org/ServiceTypes.html>
247
126
    port: integer; what port to announce
248
127
    TXT: list of strings; TXT record for the service
249
128
    domain: string; Domain to publish on, default to .local if empty.
255
134
    server: D-Bus Server
256
135
    bus: dbus.SystemBus()
257
136
    """
258
 
    
259
137
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
138
                 servicetype = None, port = None, TXT = None,
261
139
                 domain = "", host = "", max_renames = 32768,
274
152
        self.server = None
275
153
        self.bus = bus
276
154
        self.entry_group_state_changed_match = None
277
 
    
278
 
    def rename(self, remove=True):
 
155
    def rename(self):
279
156
        """Derived from the Avahi example code"""
280
157
        if self.rename_count >= self.max_renames:
281
158
            logger.critical("No suitable Zeroconf service name found"
282
159
                            " after %i retries, exiting.",
283
160
                            self.rename_count)
284
161
            raise AvahiServiceError("Too many renames")
285
 
        self.name = str(self.server
286
 
                        .GetAlternativeServiceName(self.name))
287
 
        self.rename_count += 1
 
162
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
288
163
        logger.info("Changing Zeroconf service name to %r ...",
289
164
                    self.name)
290
 
        if remove:
291
 
            self.remove()
 
165
        syslogger.setFormatter(logging.Formatter
 
166
                               ('Mandos (%s) [%%(process)d]:'
 
167
                                ' %%(levelname)s: %%(message)s'
 
168
                                % self.name))
 
169
        self.remove()
292
170
        try:
293
171
            self.add()
294
172
        except dbus.exceptions.DBusException as error:
295
 
            if (error.get_dbus_name()
296
 
                == "org.freedesktop.Avahi.CollisionError"):
297
 
                logger.info("Local Zeroconf service name collision.")
298
 
                return self.rename(remove=False)
299
 
            else:
300
 
                logger.critical("D-Bus Exception", exc_info=error)
301
 
                self.cleanup()
302
 
                os._exit(1)
303
 
    
 
173
            logger.critical("DBusException: %s", error)
 
174
            self.cleanup()
 
175
            os._exit(1)
 
176
        self.rename_count += 1
304
177
    def remove(self):
305
178
        """Derived from the Avahi example code"""
306
179
        if self.entry_group_state_changed_match is not None:
308
181
            self.entry_group_state_changed_match = None
309
182
        if self.group is not None:
310
183
            self.group.Reset()
311
 
    
312
184
    def add(self):
313
185
        """Derived from the Avahi example code"""
314
186
        self.remove()
319
191
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
320
192
        self.entry_group_state_changed_match = (
321
193
            self.group.connect_to_signal(
322
 
                'StateChanged', self.entry_group_state_changed))
 
194
                'StateChanged', self .entry_group_state_changed))
323
195
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
324
196
                     self.name, self.type)
325
197
        self.group.AddService(
331
203
            dbus.UInt16(self.port),
332
204
            avahi.string_array_to_txt_array(self.TXT))
333
205
        self.group.Commit()
334
 
    
335
206
    def entry_group_state_changed(self, state, error):
336
207
        """Derived from the Avahi example code"""
337
208
        logger.debug("Avahi entry group state change: %i", state)
343
214
            self.rename()
344
215
        elif state == avahi.ENTRY_GROUP_FAILURE:
345
216
            logger.critical("Avahi: Error in group state changed %s",
346
 
                            str(error))
347
 
            raise AvahiGroupError("State changed: {!s}"
348
 
                                  .format(error))
349
 
    
 
217
                            unicode(error))
 
218
            raise AvahiGroupError("State changed: %s"
 
219
                                  % unicode(error))
350
220
    def cleanup(self):
351
221
        """Derived from the Avahi example code"""
352
222
        if self.group is not None:
353
223
            try:
354
224
                self.group.Free()
355
225
            except (dbus.exceptions.UnknownMethodException,
356
 
                    dbus.exceptions.DBusException):
 
226
                    dbus.exceptions.DBusException) as e:
357
227
                pass
358
228
            self.group = None
359
229
        self.remove()
360
 
    
361
230
    def server_state_changed(self, state, error=None):
362
231
        """Derived from the Avahi example code"""
363
232
        logger.debug("Avahi server state change: %i", state)
382
251
                logger.debug("Unknown state: %r", state)
383
252
            else:
384
253
                logger.debug("Unknown state: %r: %r", state, error)
385
 
    
386
254
    def activate(self):
387
255
        """Derived from the Avahi example code"""
388
256
        if self.server is None:
396
264
        self.server_state_changed(self.server.GetState())
397
265
 
398
266
 
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
 
 
410
267
class Client(object):
411
268
    """A representation of a client host served by this server.
412
269
    
413
270
    Attributes:
414
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
271
    _approved:   bool(); 'None' if not yet approved/disapproved
415
272
    approval_delay: datetime.timedelta(); Time to wait for approval
416
273
    approval_duration: datetime.timedelta(); Duration of one approval
417
274
    checker:    subprocess.Popen(); a running checker process used
424
281
                     instance %(name)s can be used in the command.
425
282
    checker_initiator_tag: a gobject event source tag, or None
426
283
    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
429
284
    current_checker_command: string; current running checker_command
 
285
    disable_hook:  If set, called by disable() as disable_hook(self)
430
286
    disable_initiator_tag: a gobject event source tag, or None
431
287
    enabled:    bool()
432
288
    fingerprint: string (40 or 32 hexadecimal digits); used to
435
291
    interval:   datetime.timedelta(); How often to start a new checker
436
292
    last_approval_request: datetime.datetime(); (UTC) or None
437
293
    last_checked_ok: datetime.datetime(); (UTC) or None
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
 
294
    last_enabled: datetime.datetime(); (UTC)
442
295
    name:       string; from the config file, used in log messages and
443
296
                        D-Bus identifiers
444
297
    secret:     bytestring; sent verbatim (over TLS) to client
445
298
    timeout:    datetime.timedelta(); How long from last_checked_ok
446
299
                                      until this client is disabled
447
 
    extended_timeout:   extra long timeout when secret has been sent
448
300
    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()
452
301
    """
453
302
    
454
303
    runtime_expansions = ("approval_delay", "approval_duration",
455
 
                          "created", "enabled", "expires",
456
 
                          "fingerprint", "host", "interval",
457
 
                          "last_approval_request", "last_checked_ok",
 
304
                          "created", "enabled", "fingerprint",
 
305
                          "host", "interval", "last_checked_ok",
458
306
                          "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
 
                        }
469
307
    
470
308
    @staticmethod
471
 
    def config_parser(config):
472
 
        """Construct a new dict of client settings of this form:
473
 
        { client_name: {setting_name: value, ...}, ...}
474
 
        with exceptions for any special settings as defined above.
475
 
        NOTE: Must be a pure function. Must return the same result
476
 
        value given the same arguments.
477
 
        """
478
 
        settings = {}
479
 
        for client_name in config.sections():
480
 
            section = dict(config.items(client_name))
481
 
            client = settings[client_name] = {}
482
 
            
483
 
            client["host"] = section["host"]
484
 
            # Reformat values from string types to Python types
485
 
            client["approved_by_default"] = config.getboolean(
486
 
                client_name, "approved_by_default")
487
 
            client["enabled"] = config.getboolean(client_name,
488
 
                                                  "enabled")
489
 
            
490
 
            client["fingerprint"] = (section["fingerprint"].upper()
491
 
                                     .replace(" ", ""))
492
 
            if "secret" in section:
493
 
                client["secret"] = section["secret"].decode("base64")
494
 
            elif "secfile" in section:
495
 
                with open(os.path.expanduser(os.path.expandvars
496
 
                                             (section["secfile"])),
497
 
                          "rb") as secfile:
498
 
                    client["secret"] = secfile.read()
499
 
            else:
500
 
                raise TypeError("No secret or secfile for section {}"
501
 
                                .format(section))
502
 
            client["timeout"] = string_to_delta(section["timeout"])
503
 
            client["extended_timeout"] = string_to_delta(
504
 
                section["extended_timeout"])
505
 
            client["interval"] = string_to_delta(section["interval"])
506
 
            client["approval_delay"] = string_to_delta(
507
 
                section["approval_delay"])
508
 
            client["approval_duration"] = string_to_delta(
509
 
                section["approval_duration"])
510
 
            client["checker_command"] = section["checker"]
511
 
            client["last_approval_request"] = None
512
 
            client["last_checked_ok"] = None
513
 
            client["last_checker_status"] = -2
514
 
        
515
 
        return settings
516
 
    
517
 
    def __init__(self, settings, name = None, server_settings=None):
 
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."""
518
330
        self.name = name
519
 
        if server_settings is None:
520
 
            server_settings = {}
521
 
        self.server_settings = server_settings
522
 
        # adding all client settings
523
 
        for setting, value in settings.items():
524
 
            setattr(self, setting, value)
525
 
        
526
 
        if self.enabled:
527
 
            if not hasattr(self, "last_enabled"):
528
 
                self.last_enabled = datetime.datetime.utcnow()
529
 
            if not hasattr(self, "expires"):
530
 
                self.expires = (datetime.datetime.utcnow()
531
 
                                + self.timeout)
532
 
        else:
533
 
            self.last_enabled = None
534
 
            self.expires = None
535
 
        
 
331
        if config is None:
 
332
            config = {}
536
333
        logger.debug("Creating client %r", self.name)
537
334
        # Uppercase and remove spaces from fingerprint for later
538
335
        # comparison purposes with return value from the fingerprint()
539
336
        # function
 
337
        self.fingerprint = (config["fingerprint"].upper()
 
338
                            .replace(" ", ""))
540
339
        logger.debug("  Fingerprint: %s", self.fingerprint)
541
 
        self.created = settings.get("created",
542
 
                                    datetime.datetime.utcnow())
543
 
        
544
 
        # attributes specific for this server instance
 
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
545
359
        self.checker = None
546
360
        self.checker_initiator_tag = None
547
361
        self.disable_initiator_tag = None
548
362
        self.checker_callback_tag = None
 
363
        self.checker_command = config["checker"]
549
364
        self.current_checker_command = None
550
 
        self.approved = None
 
365
        self.last_connect = None
 
366
        self._approved = None
 
367
        self.approved_by_default = config.get("approved_by_default",
 
368
                                              True)
551
369
        self.approvals_pending = 0
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)
 
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())
566
375
    
567
 
    # Send notice to process children that client state has changed
568
376
    def send_changedstate(self):
569
 
        with self.changedstate:
570
 
            self.changedstate.notify_all()
571
 
    
 
377
        self.changedstate.acquire()
 
378
        self.changedstate.notify_all()
 
379
        self.changedstate.release()
 
380
        
572
381
    def enable(self):
573
382
        """Start this client's checker and timeout hooks"""
574
383
        if getattr(self, "enabled", False):
575
384
            # Already enabled
576
385
            return
577
 
        self.expires = datetime.datetime.utcnow() + self.timeout
578
 
        self.enabled = True
 
386
        self.send_changedstate()
579
387
        self.last_enabled = datetime.datetime.utcnow()
580
 
        self.init_checker()
581
 
        self.send_changedstate()
 
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()
582
400
    
583
401
    def disable(self, quiet=True):
584
402
        """Disable this client."""
585
403
        if not getattr(self, "enabled", False):
586
404
            return False
587
405
        if not quiet:
 
406
            self.send_changedstate()
 
407
        if not quiet:
588
408
            logger.info("Disabling client %s", self.name)
589
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
409
        if getattr(self, "disable_initiator_tag", False):
590
410
            gobject.source_remove(self.disable_initiator_tag)
591
411
            self.disable_initiator_tag = None
592
 
        self.expires = None
593
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
412
        if getattr(self, "checker_initiator_tag", False):
594
413
            gobject.source_remove(self.checker_initiator_tag)
595
414
            self.checker_initiator_tag = None
596
415
        self.stop_checker()
 
416
        if self.disable_hook:
 
417
            self.disable_hook(self)
597
418
        self.enabled = False
598
 
        if not quiet:
599
 
            self.send_changedstate()
600
419
        # Do not run this again if called by a gobject.timeout_add
601
420
        return False
602
421
    
603
422
    def __del__(self):
 
423
        self.disable_hook = None
604
424
        self.disable()
605
425
    
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
 
    
625
426
    def checker_callback(self, pid, condition, command):
626
427
        """The checker has completed, so take appropriate actions."""
627
428
        self.checker_callback_tag = None
628
429
        self.checker = None
629
430
        if os.WIFEXITED(condition):
630
 
            self.last_checker_status = os.WEXITSTATUS(condition)
631
 
            if self.last_checker_status == 0:
 
431
            exitstatus = os.WEXITSTATUS(condition)
 
432
            if exitstatus == 0:
632
433
                logger.info("Checker for %(name)s succeeded",
633
434
                            vars(self))
634
435
                self.checked_ok()
636
437
                logger.info("Checker for %(name)s failed",
637
438
                            vars(self))
638
439
        else:
639
 
            self.last_checker_status = -1
640
440
            logger.warning("Checker for %(name)s crashed?",
641
441
                           vars(self))
642
442
    
643
443
    def checked_ok(self):
644
 
        """Assert that the client has been seen, alive and well."""
 
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
        """
645
449
        self.last_checked_ok = datetime.datetime.utcnow()
646
 
        self.last_checker_status = 0
647
 
        self.bump_timeout()
648
 
    
649
 
    def bump_timeout(self, timeout=None):
650
 
        """Bump up the timeout for this client."""
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
 
450
        gobject.source_remove(self.disable_initiator_tag)
 
451
        self.disable_initiator_tag = (gobject.timeout_add
 
452
                                      (self.timeout_milliseconds(),
 
453
                                       self.disable))
661
454
    
662
455
    def need_approval(self):
663
456
        self.last_approval_request = datetime.datetime.utcnow()
668
461
        If a checker already exists, leave it running and do
669
462
        nothing."""
670
463
        # The reason for not killing a running checker is that if we
671
 
        # did that, and if a checker (for some reason) started running
672
 
        # slowly and taking more than 'interval' time, then the client
673
 
        # would inevitably timeout, since no checker would get a
674
 
        # chance to run to completion.  If we instead leave running
 
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
675
468
        # checkers alone, the checker would have to take more time
676
469
        # than 'timeout' for the client to be disabled, which is as it
677
470
        # should be.
679
472
        # If a checker exists, make sure it is not a zombie
680
473
        try:
681
474
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
682
 
        except AttributeError:
683
 
            pass
684
 
        except OSError as error:
685
 
            if error.errno != errno.ECHILD:
686
 
                raise
 
475
        except (AttributeError, OSError) as error:
 
476
            if (isinstance(error, OSError)
 
477
                and error.errno != errno.ECHILD):
 
478
                raise error
687
479
        else:
688
480
            if pid:
689
481
                logger.warning("Checker was a zombie")
692
484
                                      self.current_checker_command)
693
485
        # Start a new checker if needed
694
486
        if self.checker is None:
695
 
            # Escape attributes for the shell
696
 
            escaped_attrs = { attr:
697
 
                                  re.escape(str(getattr(self, attr)))
698
 
                              for attr in self.runtime_expansions }
699
487
            try:
700
 
                command = self.checker_command % escaped_attrs
701
 
            except TypeError as error:
702
 
                logger.error('Could not format string "%s"',
703
 
                             self.checker_command, exc_info=error)
704
 
                return True # Try again later
 
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
705
506
            self.current_checker_command = command
706
507
            try:
707
508
                logger.info("Starting checker %r for %s",
710
511
                # in normal mode, that is already done by daemon(),
711
512
                # and in debug mode we don't want to.  (Stdin is
712
513
                # always replaced by /dev/null.)
713
 
                # The exception is when not debugging but nevertheless
714
 
                # running in the foreground; use the previously
715
 
                # created wnull.
716
 
                popen_args = {}
717
 
                if (not self.server_settings["debug"]
718
 
                    and self.server_settings["foreground"]):
719
 
                    popen_args.update({"stdout": wnull,
720
 
                                       "stderr": wnull })
721
514
                self.checker = subprocess.Popen(command,
722
515
                                                close_fds=True,
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:
 
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.
736
523
                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)
737
527
            except OSError as error:
738
 
                if error.errno == errno.ECHILD:
739
 
                    # This should never happen
740
 
                    logger.error("Child process vanished",
741
 
                                 exc_info=error)
742
 
                    return True
743
 
                raise
744
 
            if pid:
745
 
                gobject.source_remove(self.checker_callback_tag)
746
 
                self.checker_callback(pid, status, command)
 
528
                logger.error("Failed to start subprocess: %s",
 
529
                             error)
747
530
        # Re-run this periodically if run by gobject.timeout_add
748
531
        return True
749
532
    
756
539
            return
757
540
        logger.debug("Stopping checker for %(name)s", vars(self))
758
541
        try:
759
 
            self.checker.terminate()
 
542
            os.kill(self.checker.pid, signal.SIGTERM)
760
543
            #time.sleep(0.5)
761
544
            #if self.checker.poll() is None:
762
 
            #    self.checker.kill()
 
545
            #    os.kill(self.checker.pid, signal.SIGKILL)
763
546
        except OSError as error:
764
547
            if error.errno != errno.ESRCH: # No such process
765
548
                raise
766
549
        self.checker = None
767
550
 
768
 
 
769
551
def dbus_service_property(dbus_interface, signature="v",
770
552
                          access="readwrite", byte_arrays=False):
771
553
    """Decorators for marking methods of a DBusObjectWithProperties to
782
564
    # "Set" method, so we fail early here:
783
565
    if byte_arrays and signature != "ay":
784
566
        raise ValueError("Byte arrays not supported for non-'ay'"
785
 
                         " signature {!r}".format(signature))
 
567
                         " signature %r" % signature)
786
568
    def decorator(func):
787
569
        func._dbus_is_property = True
788
570
        func._dbus_interface = dbus_interface
796
578
    return decorator
797
579
 
798
580
 
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
 
 
836
581
class DBusPropertyException(dbus.exceptions.DBusException):
837
582
    """A base class for D-Bus property-related exceptions
838
583
    """
839
 
    pass
 
584
    def __unicode__(self):
 
585
        return unicode(str(self))
 
586
 
840
587
 
841
588
class DBusPropertyAccessException(DBusPropertyException):
842
589
    """A property's access permissions disallows an operation.
852
599
 
853
600
class DBusObjectWithProperties(dbus.service.Object):
854
601
    """A D-Bus object with properties.
855
 
    
 
602
 
856
603
    Classes inheriting from this can use the dbus_service_property
857
604
    decorator to expose methods as D-Bus properties.  It exposes the
858
605
    standard Get(), Set(), and GetAll() methods on the D-Bus.
859
606
    """
860
607
    
861
608
    @staticmethod
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)
 
609
    def _is_dbus_property(obj):
 
610
        return getattr(obj, "_dbus_is_property", False)
870
611
    
871
 
    def _get_all_dbus_things(self, thing):
 
612
    def _get_all_dbus_properties(self):
872
613
        """Returns a generator of (name, attribute) pairs
873
614
        """
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)))
 
615
        return ((prop._dbus_name, prop)
 
616
                for name, prop in
 
617
                inspect.getmembers(self, self._is_dbus_property))
881
618
    
882
619
    def _get_dbus_property(self, interface_name, property_name):
883
620
        """Returns a bound method if one exists which is a D-Bus
884
621
        property with the specified name and interface.
885
622
        """
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
 
        
 
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
894
633
        # No such property
895
634
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
896
635
                                   + interface_name + "."
920
659
            # The byte_arrays option is not supported yet on
921
660
            # signatures other than "ay".
922
661
            if prop._dbus_signature != "ay":
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))
 
662
                raise ValueError
 
663
            value = dbus.ByteArray(''.join(unichr(byte)
 
664
                                           for byte in value))
928
665
        prop(value)
929
666
    
930
667
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
932
669
    def GetAll(self, interface_name):
933
670
        """Standard D-Bus property GetAll() method, see D-Bus
934
671
        standard.
935
 
        
 
672
 
936
673
        Note: Will not include properties with access="write".
937
674
        """
938
 
        properties = {}
939
 
        for name, prop in self._get_all_dbus_things("property"):
 
675
        all = {}
 
676
        for name, prop in self._get_all_dbus_properties():
940
677
            if (interface_name
941
678
                and interface_name != prop._dbus_interface):
942
679
                # Interface non-empty but did not match
946
683
                continue
947
684
            value = prop()
948
685
            if not hasattr(value, "variant_level"):
949
 
                properties[name] = value
 
686
                all[name] = value
950
687
                continue
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
 
688
            all[name] = type(value)(value, variant_level=
 
689
                                    value.variant_level+1)
 
690
        return dbus.Dictionary(all, signature="sv")
962
691
    
963
692
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
964
693
                         out_signature="s",
965
694
                         path_keyword='object_path',
966
695
                         connection_keyword='connection')
967
696
    def Introspect(self, object_path, connection):
968
 
        """Overloading of standard D-Bus method.
969
 
        
970
 
        Inserts property tags and interface annotation tags.
 
697
        """Standard D-Bus method, overloaded to insert property tags.
971
698
        """
972
699
        xmlstring = dbus.service.Object.Introspect(self, object_path,
973
700
                                                   connection)
980
707
                e.setAttribute("access", prop._dbus_access)
981
708
                return e
982
709
            for if_tag in document.getElementsByTagName("interface"):
983
 
                # Add property tags
984
710
                for tag in (make_tag(document, name, prop)
985
711
                            for name, prop
986
 
                            in self._get_all_dbus_things("property")
 
712
                            in self._get_all_dbus_properties()
987
713
                            if prop._dbus_interface
988
714
                            == if_tag.getAttribute("name")):
989
715
                    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)
1021
716
                # Add the names to the return values for the
1022
717
                # "org.freedesktop.DBus.Properties" methods
1023
718
                if (if_tag.getAttribute("name")
1038
733
        except (AttributeError, xml.dom.DOMException,
1039
734
                xml.parsers.expat.ExpatError) as error:
1040
735
            logger.error("Failed to override Introspection method",
1041
 
                         exc_info=error)
 
736
                         error)
1042
737
        return xmlstring
1043
738
 
1044
739
 
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"})
1224
740
class ClientDBus(Client, DBusObjectWithProperties):
1225
741
    """A Client class using D-Bus
1226
742
    
1232
748
    runtime_expansions = (Client.runtime_expansions
1233
749
                          + ("dbus_object_path",))
1234
750
    
1235
 
    _interface = "se.recompile.Mandos.Client"
1236
 
    
1237
751
    # dbus.service.Object doesn't use super(), so we can't either.
1238
752
    
1239
753
    def __init__(self, bus = None, *args, **kwargs):
 
754
        self._approvals_pending = 0
1240
755
        self.bus = bus
1241
756
        Client.__init__(self, *args, **kwargs)
1242
757
        # Only now, when this client is initialized, can it show up on
1243
758
        # the D-Bus
1244
 
        client_object_name = str(self.name).translate(
 
759
        client_object_name = unicode(self.name).translate(
1245
760
            {ord("."): ord("_"),
1246
761
             ord("-"): ord("_")})
1247
762
        self.dbus_object_path = (dbus.ObjectPath
1248
763
                                 ("/clients/" + client_object_name))
1249
764
        DBusObjectWithProperties.__init__(self, self.bus,
1250
765
                                          self.dbus_object_path)
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
 
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
1334
810
    
1335
811
    def __del__(self, *args, **kwargs):
1336
812
        try:
1345
821
                         *args, **kwargs):
1346
822
        self.checker_callback_tag = None
1347
823
        self.checker = None
 
824
        # Emit D-Bus signal
 
825
        self.PropertyChanged(dbus.String("CheckerRunning"),
 
826
                             dbus.Boolean(False, variant_level=1))
1348
827
        if os.WIFEXITED(condition):
1349
828
            exitstatus = os.WEXITSTATUS(condition)
1350
829
            # Emit D-Bus signal
1360
839
        return Client.checker_callback(self, pid, condition, command,
1361
840
                                       *args, **kwargs)
1362
841
    
 
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
    
1363
859
    def start_checker(self, *args, **kwargs):
1364
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
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
1365
865
        r = Client.start_checker(self, *args, **kwargs)
1366
866
        # Only if new checker process was started
1367
867
        if (self.checker is not None
1368
868
            and old_checker_pid != self.checker.pid):
1369
869
            # Emit D-Bus signal
1370
870
            self.CheckerStarted(self.current_checker_command)
 
871
            self.PropertyChanged(
 
872
                dbus.String("CheckerRunning"),
 
873
                dbus.Boolean(True, variant_level=1))
1371
874
        return r
1372
875
    
 
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
 
1373
885
    def _reset_approved(self):
1374
 
        self.approved = None
 
886
        self._approved = None
1375
887
        return False
1376
888
    
1377
889
    def approve(self, value=True):
1378
 
        self.approved = value
1379
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1380
 
                                * 1000), self._reset_approved)
1381
890
        self.send_changedstate()
 
891
        self._approved = value
 
892
        gobject.timeout_add(self._timedelta_to_milliseconds
 
893
                            (self.approval_duration),
 
894
                            self._reset_approved)
 
895
    
1382
896
    
1383
897
    ## D-Bus methods, signals & properties
1384
 
    
1385
 
    ## Interfaces
 
898
    _interface = "se.bsnet.fukt.Mandos.Client"
1386
899
    
1387
900
    ## Signals
1388
901
    
1399
912
        pass
1400
913
    
1401
914
    # PropertyChanged - signal
1402
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1403
915
    @dbus.service.signal(_interface, signature="sv")
1404
916
    def PropertyChanged(self, property, value):
1405
917
        "D-Bus signal"
1475
987
        if value is None:       # get
1476
988
            return dbus.Boolean(self.approved_by_default)
1477
989
        self.approved_by_default = bool(value)
 
990
        # Emit D-Bus signal
 
991
        self.PropertyChanged(dbus.String("ApprovedByDefault"),
 
992
                             dbus.Boolean(value, variant_level=1))
1478
993
    
1479
994
    # ApprovalDelay - property
1480
995
    @dbus_service_property(_interface, signature="t",
1481
996
                           access="readwrite")
1482
997
    def ApprovalDelay_dbus_property(self, value=None):
1483
998
        if value is None:       # get
1484
 
            return dbus.UInt64(self.approval_delay.total_seconds()
1485
 
                               * 1000)
 
999
            return dbus.UInt64(self.approval_delay_milliseconds())
1486
1000
        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))
1487
1004
    
1488
1005
    # ApprovalDuration - property
1489
1006
    @dbus_service_property(_interface, signature="t",
1490
1007
                           access="readwrite")
1491
1008
    def ApprovalDuration_dbus_property(self, value=None):
1492
1009
        if value is None:       # get
1493
 
            return dbus.UInt64(self.approval_duration.total_seconds()
1494
 
                               * 1000)
 
1010
            return dbus.UInt64(self._timedelta_to_milliseconds(
 
1011
                    self.approval_duration))
1495
1012
        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))
1496
1016
    
1497
1017
    # Name - property
1498
1018
    @dbus_service_property(_interface, signature="s", access="read")
1510
1030
    def Host_dbus_property(self, value=None):
1511
1031
        if value is None:       # get
1512
1032
            return dbus.String(self.host)
1513
 
        self.host = str(value)
 
1033
        self.host = value
 
1034
        # Emit D-Bus signal
 
1035
        self.PropertyChanged(dbus.String("Host"),
 
1036
                             dbus.String(value, variant_level=1))
1514
1037
    
1515
1038
    # Created - property
1516
1039
    @dbus_service_property(_interface, signature="s", access="read")
1517
1040
    def Created_dbus_property(self):
1518
 
        return datetime_to_dbus(self.created)
 
1041
        return dbus.String(self._datetime_to_dbus(self.created))
1519
1042
    
1520
1043
    # LastEnabled - property
1521
1044
    @dbus_service_property(_interface, signature="s", access="read")
1522
1045
    def LastEnabled_dbus_property(self):
1523
 
        return datetime_to_dbus(self.last_enabled)
 
1046
        if self.last_enabled is None:
 
1047
            return dbus.String("")
 
1048
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
1524
1049
    
1525
1050
    # Enabled - property
1526
1051
    @dbus_service_property(_interface, signature="b",
1540
1065
        if value is not None:
1541
1066
            self.checked_ok()
1542
1067
            return
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)
 
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))
1555
1072
    
1556
1073
    # LastApprovalRequest - property
1557
1074
    @dbus_service_property(_interface, signature="s", access="read")
1558
1075
    def LastApprovalRequest_dbus_property(self):
1559
 
        return datetime_to_dbus(self.last_approval_request)
 
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))
1560
1081
    
1561
1082
    # Timeout - property
1562
1083
    @dbus_service_property(_interface, signature="t",
1563
1084
                           access="readwrite")
1564
1085
    def Timeout_dbus_property(self, value=None):
1565
1086
        if value is None:       # get
1566
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1567
 
        old_timeout = self.timeout
 
1087
            return dbus.UInt64(self.timeout_milliseconds())
1568
1088
        self.timeout = datetime.timedelta(0, 0, 0, value)
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)
 
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))
1594
1109
    
1595
1110
    # Interval - property
1596
1111
    @dbus_service_property(_interface, signature="t",
1597
1112
                           access="readwrite")
1598
1113
    def Interval_dbus_property(self, value=None):
1599
1114
        if value is None:       # get
1600
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1115
            return dbus.UInt64(self.interval_milliseconds())
1601
1116
        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))
1602
1120
        if getattr(self, "checker_initiator_tag", None) is None:
1603
1121
            return
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
 
    
 
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
 
1611
1128
    # Checker - property
1612
1129
    @dbus_service_property(_interface, signature="s",
1613
1130
                           access="readwrite")
1614
1131
    def Checker_dbus_property(self, value=None):
1615
1132
        if value is None:       # get
1616
1133
            return dbus.String(self.checker_command)
1617
 
        self.checker_command = str(value)
 
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))
1618
1139
    
1619
1140
    # CheckerRunning - property
1620
1141
    @dbus_service_property(_interface, signature="b",
1636
1157
    @dbus_service_property(_interface, signature="ay",
1637
1158
                           access="write", byte_arrays=True)
1638
1159
    def Secret_dbus_property(self, value):
1639
 
        self.secret = bytes(value)
 
1160
        self.secret = str(value)
1640
1161
    
1641
1162
    del _interface
1642
1163
 
1647
1168
        self._pipe.send(('init', fpr, address))
1648
1169
        if not self._pipe.recv():
1649
1170
            raise KeyError()
1650
 
    
 
1171
 
1651
1172
    def __getattribute__(self, name):
1652
 
        if name == '_pipe':
 
1173
        if(name == '_pipe'):
1653
1174
            return super(ProxyClient, self).__getattribute__(name)
1654
1175
        self._pipe.send(('getattr', name))
1655
1176
        data = self._pipe.recv()
1660
1181
                self._pipe.send(('funcall', name, args, kwargs))
1661
1182
                return self._pipe.recv()[1]
1662
1183
            return func
1663
 
    
 
1184
 
1664
1185
    def __setattr__(self, name, value):
1665
 
        if name == '_pipe':
 
1186
        if(name == '_pipe'):
1666
1187
            return super(ProxyClient, self).__setattr__(name, value)
1667
1188
        self._pipe.send(('setattr', name, value))
1668
1189
 
1676
1197
    def handle(self):
1677
1198
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1678
1199
            logger.info("TCP connection from: %s",
1679
 
                        str(self.client_address))
 
1200
                        unicode(self.client_address))
1680
1201
            logger.debug("Pipe FD: %d",
1681
1202
                         self.server.child_pipe.fileno())
1682
 
            
 
1203
 
1683
1204
            session = (gnutls.connection
1684
1205
                       .ClientSession(self.request,
1685
1206
                                      gnutls.connection
1686
1207
                                      .X509Credentials()))
1687
 
            
 
1208
 
1688
1209
            # Note: gnutls.connection.X509Credentials is really a
1689
1210
            # generic GnuTLS certificate credentials object so long as
1690
1211
            # no X.509 keys are added to it.  Therefore, we can use it
1691
1212
            # here despite using OpenPGP certificates.
1692
 
            
 
1213
 
1693
1214
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1694
1215
            #                      "+AES-256-CBC", "+SHA1",
1695
1216
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1701
1222
            (gnutls.library.functions
1702
1223
             .gnutls_priority_set_direct(session._c_object,
1703
1224
                                         priority, None))
1704
 
            
 
1225
 
1705
1226
            # Start communication using the Mandos protocol
1706
1227
            # Get protocol number
1707
1228
            line = self.request.makefile().readline()
1708
1229
            logger.debug("Protocol version: %r", line)
1709
1230
            try:
1710
1231
                if int(line.strip().split()[0]) > 1:
1711
 
                    raise RuntimeError(line)
 
1232
                    raise RuntimeError
1712
1233
            except (ValueError, IndexError, RuntimeError) as error:
1713
1234
                logger.error("Unknown protocol version: %s", error)
1714
1235
                return
1715
 
            
 
1236
 
1716
1237
            # Start GnuTLS connection
1717
1238
            try:
1718
1239
                session.handshake()
1722
1243
                # established.  Just abandon the request.
1723
1244
                return
1724
1245
            logger.debug("Handshake succeeded")
1725
 
            
 
1246
 
1726
1247
            approval_required = False
1727
1248
            try:
1728
1249
                try:
1733
1254
                    logger.warning("Bad certificate: %s", error)
1734
1255
                    return
1735
1256
                logger.debug("Fingerprint: %s", fpr)
1736
 
                
 
1257
 
1737
1258
                try:
1738
1259
                    client = ProxyClient(child_pipe, fpr,
1739
1260
                                         self.client_address)
1751
1272
                                       client.name)
1752
1273
                        if self.server.use_dbus:
1753
1274
                            # Emit D-Bus signal
1754
 
                            client.Rejected("Disabled")
 
1275
                            client.Rejected("Disabled")                    
1755
1276
                        return
1756
1277
                    
1757
 
                    if client.approved or not client.approval_delay:
 
1278
                    if client._approved or not client.approval_delay:
1758
1279
                        #We are approved or approval is disabled
1759
1280
                        break
1760
 
                    elif client.approved is None:
 
1281
                    elif client._approved is None:
1761
1282
                        logger.info("Client %s needs approval",
1762
1283
                                    client.name)
1763
1284
                        if self.server.use_dbus:
1764
1285
                            # Emit D-Bus signal
1765
1286
                            client.NeedApproval(
1766
 
                                client.approval_delay.total_seconds()
1767
 
                                * 1000, client.approved_by_default)
 
1287
                                client.approval_delay_milliseconds(),
 
1288
                                client.approved_by_default)
1768
1289
                    else:
1769
1290
                        logger.warning("Client %s was not approved",
1770
1291
                                       client.name)
1774
1295
                        return
1775
1296
                    
1776
1297
                    #wait until timeout or approved
 
1298
                    #x = float(client._timedelta_to_milliseconds(delay))
1777
1299
                    time = datetime.datetime.now()
1778
1300
                    client.changedstate.acquire()
1779
 
                    client.changedstate.wait(delay.total_seconds())
 
1301
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1780
1302
                    client.changedstate.release()
1781
1303
                    time2 = datetime.datetime.now()
1782
1304
                    if (time2 - time) >= delay:
1798
1320
                    try:
1799
1321
                        sent = session.send(client.secret[sent_size:])
1800
1322
                    except gnutls.errors.GNUTLSError as error:
1801
 
                        logger.warning("gnutls send failed",
1802
 
                                       exc_info=error)
 
1323
                        logger.warning("gnutls send failed")
1803
1324
                        return
1804
1325
                    logger.debug("Sent: %d, remaining: %d",
1805
1326
                                 sent, len(client.secret)
1806
1327
                                 - (sent_size + sent))
1807
1328
                    sent_size += sent
1808
 
                
 
1329
 
1809
1330
                logger.info("Sending secret to %s", client.name)
1810
 
                # bump the timeout using extended_timeout
1811
 
                client.bump_timeout(client.extended_timeout)
 
1331
                # bump the timeout as if seen
 
1332
                client.checked_ok()
1812
1333
                if self.server.use_dbus:
1813
1334
                    # Emit D-Bus signal
1814
1335
                    client.GotSecret()
1819
1340
                try:
1820
1341
                    session.bye()
1821
1342
                except gnutls.errors.GNUTLSError as error:
1822
 
                    logger.warning("GnuTLS bye failed",
1823
 
                                   exc_info=error)
 
1343
                    logger.warning("GnuTLS bye failed")
1824
1344
    
1825
1345
    @staticmethod
1826
1346
    def peer_certificate(session):
1882
1402
        # Convert the buffer to a Python bytestring
1883
1403
        fpr = ctypes.string_at(buf, buf_len.value)
1884
1404
        # Convert the bytestring to hexadecimal notation
1885
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1405
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1886
1406
        return hex_fpr
1887
1407
 
1888
1408
 
1891
1411
    def sub_process_main(self, request, address):
1892
1412
        try:
1893
1413
            self.finish_request(request, address)
1894
 
        except Exception:
 
1414
        except:
1895
1415
            self.handle_error(request, address)
1896
1416
        self.close_request(request)
1897
 
    
 
1417
            
1898
1418
    def process_request(self, request, address):
1899
1419
        """Start a new process to process the request."""
1900
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1901
 
                                       args = (request, address))
1902
 
        proc.start()
1903
 
        return proc
1904
 
 
 
1420
        multiprocessing.Process(target = self.sub_process_main,
 
1421
                                args = (request, address)).start()
1905
1422
 
1906
1423
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1907
1424
    """ adds a pipe to the MixIn """
1911
1428
        This function creates a new pipe in self.pipe
1912
1429
        """
1913
1430
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1914
 
        
1915
 
        proc = MultiprocessingMixIn.process_request(self, request,
1916
 
                                                    client_address)
 
1431
 
 
1432
        super(MultiprocessingMixInWithPipe,
 
1433
              self).process_request(request, client_address)
1917
1434
        self.child_pipe.close()
1918
 
        self.add_pipe(parent_pipe, proc)
1919
 
    
1920
 
    def add_pipe(self, parent_pipe, proc):
 
1435
        self.add_pipe(parent_pipe)
 
1436
 
 
1437
    def add_pipe(self, parent_pipe):
1921
1438
        """Dummy function; override as necessary"""
1922
 
        raise NotImplementedError()
1923
 
 
 
1439
        raise NotImplementedError
1924
1440
 
1925
1441
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1926
1442
                     socketserver.TCPServer, object):
1932
1448
        use_ipv6:       Boolean; to use IPv6 or not
1933
1449
    """
1934
1450
    def __init__(self, server_address, RequestHandlerClass,
1935
 
                 interface=None, use_ipv6=True, socketfd=None):
1936
 
        """If socketfd is set, use that file descriptor instead of
1937
 
        creating a new one with socket.socket().
1938
 
        """
 
1451
                 interface=None, use_ipv6=True):
1939
1452
        self.interface = interface
1940
1453
        if use_ipv6:
1941
1454
            self.address_family = socket.AF_INET6
1942
 
        if socketfd is not None:
1943
 
            # Save the file descriptor
1944
 
            self.socketfd = socketfd
1945
 
            # Save the original socket.socket() function
1946
 
            self.socket_socket = socket.socket
1947
 
            # To implement --socket, we monkey patch socket.socket.
1948
 
            # 
1949
 
            # (When socketserver.TCPServer is a new-style class, we
1950
 
            # could make self.socket into a property instead of monkey
1951
 
            # patching socket.socket.)
1952
 
            # 
1953
 
            # Create a one-time-only replacement for socket.socket()
1954
 
            @functools.wraps(socket.socket)
1955
 
            def socket_wrapper(*args, **kwargs):
1956
 
                # Restore original function so subsequent calls are
1957
 
                # not affected.
1958
 
                socket.socket = self.socket_socket
1959
 
                del self.socket_socket
1960
 
                # This time only, return a new socket object from the
1961
 
                # saved file descriptor.
1962
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
1963
 
            # Replace socket.socket() function with wrapper
1964
 
            socket.socket = socket_wrapper
1965
 
        # The socketserver.TCPServer.__init__ will call
1966
 
        # socket.socket(), which might be our replacement,
1967
 
        # socket_wrapper(), if socketfd was set.
1968
1455
        socketserver.TCPServer.__init__(self, server_address,
1969
1456
                                        RequestHandlerClass)
1970
 
    
1971
1457
    def server_bind(self):
1972
1458
        """This overrides the normal server_bind() function
1973
1459
        to bind to an interface if one was specified, and also NOT to
1981
1467
                try:
1982
1468
                    self.socket.setsockopt(socket.SOL_SOCKET,
1983
1469
                                           SO_BINDTODEVICE,
1984
 
                                           (self.interface + "\0")
1985
 
                                           .encode("utf-8"))
 
1470
                                           str(self.interface
 
1471
                                               + '\0'))
1986
1472
                except socket.error as error:
1987
 
                    if error.errno == errno.EPERM:
1988
 
                        logger.error("No permission to bind to"
1989
 
                                     " interface %s", self.interface)
1990
 
                    elif error.errno == errno.ENOPROTOOPT:
 
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:
1991
1478
                        logger.error("SO_BINDTODEVICE not available;"
1992
1479
                                     " cannot bind to interface %s",
1993
1480
                                     self.interface)
1994
 
                    elif error.errno == errno.ENODEV:
1995
 
                        logger.error("Interface %s does not exist,"
1996
 
                                     " cannot bind", self.interface)
1997
1481
                    else:
1998
1482
                        raise
1999
1483
        # Only bind(2) the socket if we really need to.
2002
1486
                if self.address_family == socket.AF_INET6:
2003
1487
                    any_address = "::" # in6addr_any
2004
1488
                else:
2005
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
1489
                    any_address = socket.INADDR_ANY
2006
1490
                self.server_address = (any_address,
2007
1491
                                       self.server_address[1])
2008
1492
            elif not self.server_address[1]:
2029
1513
    """
2030
1514
    def __init__(self, server_address, RequestHandlerClass,
2031
1515
                 interface=None, use_ipv6=True, clients=None,
2032
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
1516
                 gnutls_priority=None, use_dbus=True):
2033
1517
        self.enabled = False
2034
1518
        self.clients = clients
2035
1519
        if self.clients is None:
2036
 
            self.clients = {}
 
1520
            self.clients = set()
2037
1521
        self.use_dbus = use_dbus
2038
1522
        self.gnutls_priority = gnutls_priority
2039
1523
        IPv6_TCPServer.__init__(self, server_address,
2040
1524
                                RequestHandlerClass,
2041
1525
                                interface = interface,
2042
 
                                use_ipv6 = use_ipv6,
2043
 
                                socketfd = socketfd)
 
1526
                                use_ipv6 = use_ipv6)
2044
1527
    def server_activate(self):
2045
1528
        if self.enabled:
2046
1529
            return socketserver.TCPServer.server_activate(self)
2047
 
    
2048
1530
    def enable(self):
2049
1531
        self.enabled = True
2050
 
    
2051
 
    def add_pipe(self, parent_pipe, proc):
 
1532
    def add_pipe(self, parent_pipe):
2052
1533
        # Call "handle_ipc" for both data and EOF events
2053
1534
        gobject.io_add_watch(parent_pipe.fileno(),
2054
1535
                             gobject.IO_IN | gobject.IO_HUP,
2055
1536
                             functools.partial(self.handle_ipc,
2056
 
                                               parent_pipe =
2057
 
                                               parent_pipe,
2058
 
                                               proc = proc))
2059
 
    
 
1537
                                               parent_pipe = parent_pipe))
 
1538
        
2060
1539
    def handle_ipc(self, source, condition, parent_pipe=None,
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()
 
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):
2066
1557
            return False
2067
1558
        
2068
1559
        # Read a request from the child
2073
1564
            fpr = request[1]
2074
1565
            address = request[2]
2075
1566
            
2076
 
            for c in self.clients.itervalues():
 
1567
            for c in self.clients:
2077
1568
                if c.fingerprint == fpr:
2078
1569
                    client = c
2079
1570
                    break
2082
1573
                            "dress: %s", fpr, address)
2083
1574
                if self.use_dbus:
2084
1575
                    # Emit D-Bus signal
2085
 
                    mandos_dbus_service.ClientNotFound(fpr,
2086
 
                                                       address[0])
 
1576
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
2087
1577
                parent_pipe.send(False)
2088
1578
                return False
2089
1579
            
2090
1580
            gobject.io_add_watch(parent_pipe.fileno(),
2091
1581
                                 gobject.IO_IN | gobject.IO_HUP,
2092
1582
                                 functools.partial(self.handle_ipc,
2093
 
                                                   parent_pipe =
2094
 
                                                   parent_pipe,
2095
 
                                                   proc = proc,
2096
 
                                                   client_object =
2097
 
                                                   client))
 
1583
                                                   parent_pipe = parent_pipe,
 
1584
                                                   client_object = client))
2098
1585
            parent_pipe.send(True)
2099
 
            # remove the old hook in favor of the new above hook on
2100
 
            # same fileno
 
1586
            # remove the old hook in favor of the new above hook on same fileno
2101
1587
            return False
2102
1588
        if command == 'funcall':
2103
1589
            funcname = request[1]
2104
1590
            args = request[2]
2105
1591
            kwargs = request[3]
2106
1592
            
2107
 
            parent_pipe.send(('data', getattr(client_object,
2108
 
                                              funcname)(*args,
2109
 
                                                         **kwargs)))
2110
 
        
 
1593
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
 
1594
 
2111
1595
        if command == 'getattr':
2112
1596
            attrname = request[1]
2113
1597
            if callable(client_object.__getattribute__(attrname)):
2114
1598
                parent_pipe.send(('function',))
2115
1599
            else:
2116
 
                parent_pipe.send(('data', client_object
2117
 
                                  .__getattribute__(attrname)))
 
1600
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2118
1601
        
2119
1602
        if command == 'setattr':
2120
1603
            attrname = request[1]
2121
1604
            value = request[2]
2122
1605
            setattr(client_object, attrname, value)
2123
 
        
 
1606
 
2124
1607
        return True
2125
1608
 
2126
1609
 
2127
 
def rfc3339_duration_to_delta(duration):
2128
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2129
 
    
2130
 
    >>> rfc3339_duration_to_delta("P7D")
2131
 
    datetime.timedelta(7)
2132
 
    >>> rfc3339_duration_to_delta("PT60S")
2133
 
    datetime.timedelta(0, 60)
2134
 
    >>> rfc3339_duration_to_delta("PT60M")
2135
 
    datetime.timedelta(0, 3600)
2136
 
    >>> rfc3339_duration_to_delta("PT24H")
2137
 
    datetime.timedelta(1)
2138
 
    >>> rfc3339_duration_to_delta("P1W")
2139
 
    datetime.timedelta(7)
2140
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2141
 
    datetime.timedelta(0, 330)
2142
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2143
 
    datetime.timedelta(1, 200)
2144
 
    """
2145
 
    
2146
 
    # Parsing an RFC 3339 duration with regular expressions is not
2147
 
    # possible - there would have to be multiple places for the same
2148
 
    # values, like seconds.  The current code, while more esoteric, is
2149
 
    # cleaner without depending on a parsing library.  If Python had a
2150
 
    # built-in library for parsing we would use it, but we'd like to
2151
 
    # avoid excessive use of external libraries.
2152
 
    
2153
 
    # New type for defining tokens, syntax, and semantics all-in-one
2154
 
    Token = collections.namedtuple("Token",
2155
 
                                   ("regexp", # To match token; if
2156
 
                                              # "value" is not None,
2157
 
                                              # must have a "group"
2158
 
                                              # containing digits
2159
 
                                    "value",  # datetime.timedelta or
2160
 
                                              # None
2161
 
                                    "followers")) # Tokens valid after
2162
 
                                                  # this token
2163
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2164
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2165
 
    token_end = Token(re.compile(r"$"), None, frozenset())
2166
 
    token_second = Token(re.compile(r"(\d+)S"),
2167
 
                         datetime.timedelta(seconds=1),
2168
 
                         frozenset((token_end,)))
2169
 
    token_minute = Token(re.compile(r"(\d+)M"),
2170
 
                         datetime.timedelta(minutes=1),
2171
 
                         frozenset((token_second, token_end)))
2172
 
    token_hour = Token(re.compile(r"(\d+)H"),
2173
 
                       datetime.timedelta(hours=1),
2174
 
                       frozenset((token_minute, token_end)))
2175
 
    token_time = Token(re.compile(r"T"),
2176
 
                       None,
2177
 
                       frozenset((token_hour, token_minute,
2178
 
                                  token_second)))
2179
 
    token_day = Token(re.compile(r"(\d+)D"),
2180
 
                      datetime.timedelta(days=1),
2181
 
                      frozenset((token_time, token_end)))
2182
 
    token_month = Token(re.compile(r"(\d+)M"),
2183
 
                        datetime.timedelta(weeks=4),
2184
 
                        frozenset((token_day, token_end)))
2185
 
    token_year = Token(re.compile(r"(\d+)Y"),
2186
 
                       datetime.timedelta(weeks=52),
2187
 
                       frozenset((token_month, token_end)))
2188
 
    token_week = Token(re.compile(r"(\d+)W"),
2189
 
                       datetime.timedelta(weeks=1),
2190
 
                       frozenset((token_end,)))
2191
 
    token_duration = Token(re.compile(r"P"), None,
2192
 
                           frozenset((token_year, token_month,
2193
 
                                      token_day, token_time,
2194
 
                                      token_week)))
2195
 
    # Define starting values
2196
 
    value = datetime.timedelta() # Value so far
2197
 
    found_token = None
2198
 
    followers = frozenset((token_duration,)) # Following valid tokens
2199
 
    s = duration                # String left to parse
2200
 
    # Loop until end token is found
2201
 
    while found_token is not token_end:
2202
 
        # Search for any currently valid tokens
2203
 
        for token in followers:
2204
 
            match = token.regexp.match(s)
2205
 
            if match is not None:
2206
 
                # Token found
2207
 
                if token.value is not None:
2208
 
                    # Value found, parse digits
2209
 
                    factor = int(match.group(1), 10)
2210
 
                    # Add to value so far
2211
 
                    value += factor * token.value
2212
 
                # Strip token from string
2213
 
                s = token.regexp.sub("", s, 1)
2214
 
                # Go to found token
2215
 
                found_token = token
2216
 
                # Set valid next tokens
2217
 
                followers = found_token.followers
2218
 
                break
2219
 
        else:
2220
 
            # No currently valid tokens were found
2221
 
            raise ValueError("Invalid RFC 3339 duration")
2222
 
    # End token found
2223
 
    return value
2224
 
 
2225
 
 
2226
1610
def string_to_delta(interval):
2227
1611
    """Parse a string and return a datetime.timedelta
2228
1612
    
2239
1623
    >>> string_to_delta('5m 30s')
2240
1624
    datetime.timedelta(0, 330)
2241
1625
    """
2242
 
    
2243
 
    try:
2244
 
        return rfc3339_duration_to_delta(interval)
2245
 
    except ValueError:
2246
 
        pass
2247
 
    
2248
1626
    timevalue = datetime.timedelta(0)
2249
1627
    for s in interval.split():
2250
1628
        try:
2251
 
            suffix = s[-1]
 
1629
            suffix = unicode(s[-1])
2252
1630
            value = int(s[:-1])
2253
1631
            if suffix == "d":
2254
1632
                delta = datetime.timedelta(value)
2261
1639
            elif suffix == "w":
2262
1640
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2263
1641
            else:
2264
 
                raise ValueError("Unknown suffix {!r}"
2265
 
                                 .format(suffix))
2266
 
        except IndexError as e:
 
1642
                raise ValueError("Unknown suffix %r" % suffix)
 
1643
        except (ValueError, IndexError) as e:
2267
1644
            raise ValueError(*(e.args))
2268
1645
        timevalue += delta
2269
1646
    return timevalue
2270
1647
 
2271
1648
 
 
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
 
2272
1673
def daemon(nochdir = False, noclose = False):
2273
1674
    """See daemon(3).  Standard BSD Unix function.
2274
1675
    
2282
1683
        sys.exit()
2283
1684
    if not noclose:
2284
1685
        # Close all standard open file descriptors
2285
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1686
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2286
1687
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2287
 
            raise OSError(errno.ENODEV, "{} not a character device"
2288
 
                          .format(os.devnull))
 
1688
            raise OSError(errno.ENODEV,
 
1689
                          "%s not a character device"
 
1690
                          % os.path.devnull)
2289
1691
        os.dup2(null, sys.stdin.fileno())
2290
1692
        os.dup2(null, sys.stdout.fileno())
2291
1693
        os.dup2(null, sys.stderr.fileno())
2300
1702
    
2301
1703
    parser = argparse.ArgumentParser()
2302
1704
    parser.add_argument("-v", "--version", action="version",
2303
 
                        version = "%(prog)s {}".format(version),
 
1705
                        version = "%%(prog)s %s" % version,
2304
1706
                        help="show version number and exit")
2305
1707
    parser.add_argument("-i", "--interface", metavar="IF",
2306
1708
                        help="Bind to interface IF")
2312
1714
                        help="Run self-test")
2313
1715
    parser.add_argument("--debug", action="store_true",
2314
1716
                        help="Debug mode; run in foreground and log"
2315
 
                        " to terminal", default=None)
 
1717
                        " to terminal")
2316
1718
    parser.add_argument("--debuglevel", metavar="LEVEL",
2317
1719
                        help="Debug level for stdout output")
2318
1720
    parser.add_argument("--priority", help="GnuTLS"
2325
1727
                        " files")
2326
1728
    parser.add_argument("--no-dbus", action="store_false",
2327
1729
                        dest="use_dbus", help="Do not provide D-Bus"
2328
 
                        " system bus interface", default=None)
 
1730
                        " system bus interface")
2329
1731
    parser.add_argument("--no-ipv6", action="store_false",
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
 
    
 
1732
                        dest="use_ipv6", help="Do not use IPv6")
2346
1733
    options = parser.parse_args()
2347
1734
    
2348
1735
    if options.check:
2349
1736
        import doctest
2350
 
        fail_count, test_count = doctest.testmod()
2351
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
1737
        doctest.testmod()
 
1738
        sys.exit()
2352
1739
    
2353
1740
    # Default values for config file for server-global settings
2354
1741
    server_defaults = { "interface": "",
2356
1743
                        "port": "",
2357
1744
                        "debug": "False",
2358
1745
                        "priority":
2359
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
1746
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2360
1747
                        "servicename": "Mandos",
2361
1748
                        "use_dbus": "True",
2362
1749
                        "use_ipv6": "True",
2363
1750
                        "debuglevel": "",
2364
 
                        "restore": "True",
2365
 
                        "socket": "",
2366
 
                        "statedir": "/var/lib/mandos",
2367
 
                        "foreground": "False",
2368
 
                        "zeroconf": "True",
2369
1751
                        }
2370
1752
    
2371
1753
    # Parse config file for server-global settings
2376
1758
    # Convert the SafeConfigParser object to a dict
2377
1759
    server_settings = server_config.defaults()
2378
1760
    # Use the appropriate methods on the non-string config options
2379
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
1761
    for option in ("debug", "use_dbus", "use_ipv6"):
2380
1762
        server_settings[option] = server_config.getboolean("DEFAULT",
2381
1763
                                                           option)
2382
1764
    if server_settings["port"]:
2383
1765
        server_settings["port"] = server_config.getint("DEFAULT",
2384
1766
                                                       "port")
2385
 
    if server_settings["socket"]:
2386
 
        server_settings["socket"] = server_config.getint("DEFAULT",
2387
 
                                                         "socket")
2388
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
2389
 
        # over with an opened os.devnull.  But we don't want this to
2390
 
        # happen with a supplied network socket.
2391
 
        if 0 <= server_settings["socket"] <= 2:
2392
 
            server_settings["socket"] = os.dup(server_settings
2393
 
                                               ["socket"])
2394
1767
    del server_config
2395
1768
    
2396
1769
    # Override the settings from the config file with command line
2397
1770
    # options, if set.
2398
1771
    for option in ("interface", "address", "port", "debug",
2399
1772
                   "priority", "servicename", "configdir",
2400
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2401
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
1773
                   "use_dbus", "use_ipv6", "debuglevel"):
2402
1774
        value = getattr(options, option)
2403
1775
        if value is not None:
2404
1776
            server_settings[option] = value
2405
1777
    del options
2406
1778
    # Force all strings to be unicode
2407
1779
    for option in server_settings.keys():
2408
 
        if isinstance(server_settings[option], bytes):
2409
 
            server_settings[option] = (server_settings[option]
2410
 
                                       .decode("utf-8"))
2411
 
    # Force all boolean options to be boolean
2412
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2413
 
                   "foreground", "zeroconf"):
2414
 
        server_settings[option] = bool(server_settings[option])
2415
 
    # Debug implies foreground
2416
 
    if server_settings["debug"]:
2417
 
        server_settings["foreground"] = True
 
1780
        if type(server_settings[option]) is str:
 
1781
            server_settings[option] = unicode(server_settings[option])
2418
1782
    # Now we have our good server settings in "server_settings"
2419
1783
    
2420
1784
    ##################################################################
2421
1785
    
2422
 
    if (not server_settings["zeroconf"] and
2423
 
        not (server_settings["port"]
2424
 
             or server_settings["socket"] != "")):
2425
 
            parser.error("Needs port or socket to work without"
2426
 
                         " Zeroconf")
2427
 
    
2428
1786
    # For convenience
2429
1787
    debug = server_settings["debug"]
2430
1788
    debuglevel = server_settings["debuglevel"]
2431
1789
    use_dbus = server_settings["use_dbus"]
2432
1790
    use_ipv6 = server_settings["use_ipv6"]
2433
 
    stored_state_path = os.path.join(server_settings["statedir"],
2434
 
                                     stored_state_file)
2435
 
    foreground = server_settings["foreground"]
2436
 
    zeroconf = server_settings["zeroconf"]
2437
 
    
2438
 
    if debug:
2439
 
        initlogger(debug, logging.DEBUG)
2440
 
    else:
2441
 
        if not debuglevel:
2442
 
            initlogger(debug)
2443
 
        else:
2444
 
            level = getattr(logging, debuglevel.upper())
2445
 
            initlogger(debug, level)
2446
 
    
 
1791
 
2447
1792
    if server_settings["servicename"] != "Mandos":
2448
1793
        syslogger.setFormatter(logging.Formatter
2449
 
                               ('Mandos ({}) [%(process)d]:'
2450
 
                                ' %(levelname)s: %(message)s'
2451
 
                                .format(server_settings
2452
 
                                        ["servicename"])))
 
1794
                               ('Mandos (%s) [%%(process)d]:'
 
1795
                                ' %%(levelname)s: %%(message)s'
 
1796
                                % server_settings["servicename"]))
2453
1797
    
2454
1798
    # Parse config file with clients
2455
 
    client_config = configparser.SafeConfigParser(Client
2456
 
                                                  .client_defaults)
 
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)
2457
1807
    client_config.read(os.path.join(server_settings["configdir"],
2458
1808
                                    "clients.conf"))
2459
1809
    
2460
1810
    global mandos_dbus_service
2461
1811
    mandos_dbus_service = None
2462
1812
    
2463
 
    socketfd = None
2464
 
    if server_settings["socket"] != "":
2465
 
        socketfd = server_settings["socket"]
2466
1813
    tcp_server = MandosServer((server_settings["address"],
2467
1814
                               server_settings["port"]),
2468
1815
                              ClientHandler,
2471
1818
                              use_ipv6=use_ipv6,
2472
1819
                              gnutls_priority=
2473
1820
                              server_settings["priority"],
2474
 
                              use_dbus=use_dbus,
2475
 
                              socketfd=socketfd)
2476
 
    if not foreground:
2477
 
        pidfilename = "/run/mandos.pid"
2478
 
        if not os.path.isdir("/run/."):
2479
 
            pidfilename = "/var/run/mandos.pid"
2480
 
        pidfile = None
 
1821
                              use_dbus=use_dbus)
 
1822
    if not debug:
 
1823
        pidfilename = "/var/run/mandos.pid"
2481
1824
        try:
2482
1825
            pidfile = open(pidfilename, "w")
2483
 
        except IOError as e:
2484
 
            logger.error("Could not open file %r", pidfilename,
2485
 
                         exc_info=e)
 
1826
        except IOError:
 
1827
            logger.error("Could not open file %r", pidfilename)
2486
1828
    
2487
 
    for name in ("_mandos", "mandos", "nobody"):
 
1829
    try:
 
1830
        uid = pwd.getpwnam("_mandos").pw_uid
 
1831
        gid = pwd.getpwnam("_mandos").pw_gid
 
1832
    except KeyError:
2488
1833
        try:
2489
 
            uid = pwd.getpwnam(name).pw_uid
2490
 
            gid = pwd.getpwnam(name).pw_gid
2491
 
            break
 
1834
            uid = pwd.getpwnam("mandos").pw_uid
 
1835
            gid = pwd.getpwnam("mandos").pw_gid
2492
1836
        except KeyError:
2493
 
            continue
2494
 
    else:
2495
 
        uid = 65534
2496
 
        gid = 65534
 
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
2497
1843
    try:
2498
1844
        os.setgid(gid)
2499
1845
        os.setuid(uid)
2500
1846
    except OSError as error:
2501
 
        if error.errno != errno.EPERM:
2502
 
            raise
 
1847
        if error[0] != errno.EPERM:
 
1848
            raise error
2503
1849
    
 
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
 
2504
1858
    if debug:
2505
1859
        # Enable all possible GnuTLS debugging
2506
1860
        
2516
1870
         .gnutls_global_set_log_function(debug_gnutls))
2517
1871
        
2518
1872
        # Redirect stdin so all checkers get /dev/null
2519
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1873
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2520
1874
        os.dup2(null, sys.stdin.fileno())
2521
1875
        if null > 2:
2522
1876
            os.close(null)
 
1877
    else:
 
1878
        # No console logging
 
1879
        logger.removeHandler(console)
2523
1880
    
2524
1881
    # Need to fork before connecting to D-Bus
2525
 
    if not foreground:
 
1882
    if not debug:
2526
1883
        # Close all input and output, do double fork, etc.
2527
1884
        daemon()
2528
1885
    
2529
 
    # multiprocessing will use threads, so before we use gobject we
2530
 
    # need to inform gobject that threads will be used.
2531
 
    gobject.threads_init()
2532
 
    
2533
1886
    global main_loop
2534
1887
    # From the Avahi example code
2535
 
    DBusGMainLoop(set_as_default=True)
 
1888
    DBusGMainLoop(set_as_default=True )
2536
1889
    main_loop = gobject.MainLoop()
2537
1890
    bus = dbus.SystemBus()
2538
1891
    # End of Avahi example code
2539
1892
    if use_dbus:
2540
1893
        try:
2541
 
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
1894
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
2542
1895
                                            bus, do_not_queue=True)
2543
 
            old_bus_name = (dbus.service.BusName
2544
 
                            ("se.bsnet.fukt.Mandos", bus,
2545
 
                             do_not_queue=True))
2546
1896
        except dbus.exceptions.NameExistsException as e:
2547
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
1897
            logger.error(unicode(e) + ", disabling D-Bus")
2548
1898
            use_dbus = False
2549
1899
            server_settings["use_dbus"] = False
2550
1900
            tcp_server.use_dbus = False
2551
 
    if zeroconf:
2552
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2553
 
        service = AvahiServiceToSyslog(name =
2554
 
                                       server_settings["servicename"],
2555
 
                                       servicetype = "_mandos._tcp",
2556
 
                                       protocol = protocol, bus = bus)
2557
 
        if server_settings["interface"]:
2558
 
            service.interface = (if_nametoindex
2559
 
                                 (server_settings["interface"]
2560
 
                                  .encode("utf-8")))
 
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"])))
2561
1908
    
2562
1909
    global multiprocessing_manager
2563
1910
    multiprocessing_manager = multiprocessing.Manager()
2565
1912
    client_class = Client
2566
1913
    if use_dbus:
2567
1914
        client_class = functools.partial(ClientDBus, bus = bus)
2568
 
    
2569
 
    client_settings = Client.config_parser(client_config)
2570
 
    old_client_settings = {}
2571
 
    clients_data = {}
2572
 
    
2573
 
    # This is used to redirect stdout and stderr for checker processes
2574
 
    global wnull
2575
 
    wnull = open(os.devnull, "w") # A writable /dev/null
2576
 
    # Only used if server is running in foreground but not in debug
2577
 
    # mode
2578
 
    if debug or not foreground:
2579
 
        wnull.close()
2580
 
    
2581
 
    # Get client data and settings from last running state.
2582
 
    if server_settings["restore"]:
2583
 
        try:
2584
 
            with open(stored_state_path, "rb") as stored_state:
2585
 
                clients_data, old_client_settings = (pickle.load
2586
 
                                                     (stored_state))
2587
 
            os.remove(stored_state_path)
2588
 
        except IOError as e:
2589
 
            if e.errno == errno.ENOENT:
2590
 
                logger.warning("Could not load persistent state: {}"
2591
 
                                .format(os.strerror(e.errno)))
2592
 
            else:
2593
 
                logger.critical("Could not load persistent state:",
2594
 
                                exc_info=e)
2595
 
                raise
2596
 
        except EOFError as e:
2597
 
            logger.warning("Could not load persistent state: "
2598
 
                           "EOFError:", exc_info=e)
2599
 
    
2600
 
    with PGPEngine() as pgp:
2601
 
        for client_name, client in clients_data.items():
2602
 
            # Skip removed clients
2603
 
            if client_name not in client_settings:
2604
 
                continue
2605
 
            
2606
 
            # Decide which value to use after restoring saved state.
2607
 
            # We have three different values: Old config file,
2608
 
            # new config file, and saved state.
2609
 
            # New config value takes precedence if it differs from old
2610
 
            # config value, otherwise use saved state.
2611
 
            for name, value in client_settings[client_name].items():
2612
 
                try:
2613
 
                    # For each value in new config, check if it
2614
 
                    # differs from the old config value (Except for
2615
 
                    # the "secret" attribute)
2616
 
                    if (name != "secret" and
2617
 
                        value != old_client_settings[client_name]
2618
 
                        [name]):
2619
 
                        client[name] = value
2620
 
                except KeyError:
2621
 
                    pass
2622
 
            
2623
 
            # Clients who has passed its expire date can still be
2624
 
            # enabled if its last checker was successful.  Clients
2625
 
            # whose checker succeeded before we stored its state is
2626
 
            # assumed to have successfully run all checkers during
2627
 
            # downtime.
2628
 
            if client["enabled"]:
2629
 
                if datetime.datetime.utcnow() >= client["expires"]:
2630
 
                    if not client["last_checked_ok"]:
2631
 
                        logger.warning(
2632
 
                            "disabling client {} - Client never "
2633
 
                            "performed a successful checker"
2634
 
                            .format(client_name))
2635
 
                        client["enabled"] = False
2636
 
                    elif client["last_checker_status"] != 0:
2637
 
                        logger.warning(
2638
 
                            "disabling client {} - Client last"
2639
 
                            " checker failed with error code {}"
2640
 
                            .format(client_name,
2641
 
                                    client["last_checker_status"]))
2642
 
                        client["enabled"] = False
2643
 
                    else:
2644
 
                        client["expires"] = (datetime.datetime
2645
 
                                             .utcnow()
2646
 
                                             + client["timeout"])
2647
 
                        logger.debug("Last checker succeeded,"
2648
 
                                     " keeping {} enabled"
2649
 
                                     .format(client_name))
 
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):
2650
1922
            try:
2651
 
                client["secret"] = (
2652
 
                    pgp.decrypt(client["encrypted_secret"],
2653
 
                                client_settings[client_name]
2654
 
                                ["secret"]))
2655
 
            except PGPError:
2656
 
                # If decryption fails, we use secret from new settings
2657
 
                logger.debug("Failed to decrypt {} old secret"
2658
 
                             .format(client_name))
2659
 
                client["secret"] = (
2660
 
                    client_settings[client_name]["secret"])
2661
 
    
2662
 
    # Add/remove clients based on new changes made to config
2663
 
    for client_name in (set(old_client_settings)
2664
 
                        - set(client_settings)):
2665
 
        del clients_data[client_name]
2666
 
    for client_name in (set(client_settings)
2667
 
                        - set(old_client_settings)):
2668
 
        clients_data[client_name] = client_settings[client_name]
2669
 
    
2670
 
    # Create all client objects
2671
 
    for client_name, client in clients_data.items():
2672
 
        tcp_server.clients[client_name] = client_class(
2673
 
            name = client_name, settings = client,
2674
 
            server_settings = server_settings)
2675
 
    
 
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()))
2676
1932
    if not tcp_server.clients:
2677
1933
        logger.warning("No clients defined")
2678
 
    
2679
 
    if not foreground:
2680
 
        if pidfile is not None:
2681
 
            try:
2682
 
                with pidfile:
2683
 
                    pid = os.getpid()
2684
 
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
2685
 
            except IOError:
2686
 
                logger.error("Could not write to file %r with PID %d",
2687
 
                             pidfilename, pid)
2688
 
        del pidfile
 
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
2689
1947
        del pidfilename
2690
 
    
 
1948
        
 
1949
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
1950
 
2691
1951
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2692
1952
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2693
1953
    
2694
1954
    if use_dbus:
2695
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2696
 
                                        "se.bsnet.fukt.Mandos"})
2697
 
        class MandosDBusService(DBusObjectWithProperties):
 
1955
        class MandosDBusService(dbus.service.Object):
2698
1956
            """A D-Bus proxy object"""
2699
1957
            def __init__(self):
2700
1958
                dbus.service.Object.__init__(self, bus, "/")
2701
 
            _interface = "se.recompile.Mandos"
2702
 
            
2703
 
            @dbus_interface_annotations(_interface)
2704
 
            def _foo(self):
2705
 
                return { "org.freedesktop.DBus.Property"
2706
 
                         ".EmitsChangedSignal":
2707
 
                             "false"}
 
1959
            _interface = "se.bsnet.fukt.Mandos"
2708
1960
            
2709
1961
            @dbus.service.signal(_interface, signature="o")
2710
1962
            def ClientAdded(self, objpath):
2725
1977
            def GetAllClients(self):
2726
1978
                "D-Bus method"
2727
1979
                return dbus.Array(c.dbus_object_path
2728
 
                                  for c in
2729
 
                                  tcp_server.clients.itervalues())
 
1980
                                  for c in tcp_server.clients)
2730
1981
            
2731
1982
            @dbus.service.method(_interface,
2732
1983
                                 out_signature="a{oa{sv}}")
2733
1984
            def GetAllClientsWithProperties(self):
2734
1985
                "D-Bus method"
2735
1986
                return dbus.Dictionary(
2736
 
                    { c.dbus_object_path: c.GetAll("")
2737
 
                      for c in tcp_server.clients.itervalues() },
 
1987
                    ((c.dbus_object_path, c.GetAll(""))
 
1988
                     for c in tcp_server.clients),
2738
1989
                    signature="oa{sv}")
2739
1990
            
2740
1991
            @dbus.service.method(_interface, in_signature="o")
2741
1992
            def RemoveClient(self, object_path):
2742
1993
                "D-Bus method"
2743
 
                for c in tcp_server.clients.itervalues():
 
1994
                for c in tcp_server.clients:
2744
1995
                    if c.dbus_object_path == object_path:
2745
 
                        del tcp_server.clients[c.name]
 
1996
                        tcp_server.clients.remove(c)
2746
1997
                        c.remove_from_connection()
2747
1998
                        # Don't signal anything except ClientRemoved
2748
1999
                        c.disable(quiet=True)
2757
2008
    
2758
2009
    def cleanup():
2759
2010
        "Cleanup function; run on exit"
2760
 
        if zeroconf:
2761
 
            service.cleanup()
2762
 
        
2763
 
        multiprocessing.active_children()
2764
 
        wnull.close()
2765
 
        if not (tcp_server.clients or client_settings):
2766
 
            return
2767
 
        
2768
 
        # Store client before exiting. Secrets are encrypted with key
2769
 
        # based on what config file has. If config file is
2770
 
        # removed/edited, old secret will thus be unrecovable.
2771
 
        clients = {}
2772
 
        with PGPEngine() as pgp:
2773
 
            for client in tcp_server.clients.itervalues():
2774
 
                key = client_settings[client.name]["secret"]
2775
 
                client.encrypted_secret = pgp.encrypt(client.secret,
2776
 
                                                      key)
2777
 
                client_dict = {}
2778
 
                
2779
 
                # A list of attributes that can not be pickled
2780
 
                # + secret.
2781
 
                exclude = { "bus", "changedstate", "secret",
2782
 
                            "checker", "server_settings" }
2783
 
                for name, typ in (inspect.getmembers
2784
 
                                  (dbus.service.Object)):
2785
 
                    exclude.add(name)
2786
 
                
2787
 
                client_dict["encrypted_secret"] = (client
2788
 
                                                   .encrypted_secret)
2789
 
                for attr in client.client_structure:
2790
 
                    if attr not in exclude:
2791
 
                        client_dict[attr] = getattr(client, attr)
2792
 
                
2793
 
                clients[client.name] = client_dict
2794
 
                del client_settings[client.name]["secret"]
2795
 
        
2796
 
        try:
2797
 
            with (tempfile.NamedTemporaryFile
2798
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2799
 
                   dir=os.path.dirname(stored_state_path),
2800
 
                   delete=False)) as stored_state:
2801
 
                pickle.dump((clients, client_settings), stored_state)
2802
 
                tempname=stored_state.name
2803
 
            os.rename(tempname, stored_state_path)
2804
 
        except (IOError, OSError) as e:
2805
 
            if not debug:
2806
 
                try:
2807
 
                    os.remove(tempname)
2808
 
                except NameError:
2809
 
                    pass
2810
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2811
 
                logger.warning("Could not save persistent state: {}"
2812
 
                               .format(os.strerror(e.errno)))
2813
 
            else:
2814
 
                logger.warning("Could not save persistent state:",
2815
 
                               exc_info=e)
2816
 
                raise
2817
 
        
2818
 
        # Delete all clients, and settings from config
 
2011
        service.cleanup()
 
2012
        
2819
2013
        while tcp_server.clients:
2820
 
            name, client = tcp_server.clients.popitem()
 
2014
            client = tcp_server.clients.pop()
2821
2015
            if use_dbus:
2822
2016
                client.remove_from_connection()
 
2017
            client.disable_hook = None
2823
2018
            # Don't signal anything except ClientRemoved
2824
2019
            client.disable(quiet=True)
2825
2020
            if use_dbus:
2826
2021
                # Emit D-Bus signal
2827
 
                mandos_dbus_service.ClientRemoved(client
2828
 
                                                  .dbus_object_path,
 
2022
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2829
2023
                                                  client.name)
2830
 
        client_settings.clear()
2831
2024
    
2832
2025
    atexit.register(cleanup)
2833
2026
    
2834
 
    for client in tcp_server.clients.itervalues():
 
2027
    for client in tcp_server.clients:
2835
2028
        if use_dbus:
2836
2029
            # Emit D-Bus signal
2837
2030
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2838
 
        # Need to initiate checking of clients
2839
 
        if client.enabled:
2840
 
            client.init_checker()
 
2031
        client.enable()
2841
2032
    
2842
2033
    tcp_server.enable()
2843
2034
    tcp_server.server_activate()
2844
2035
    
2845
2036
    # Find out what port we got
2846
 
    if zeroconf:
2847
 
        service.port = tcp_server.socket.getsockname()[1]
 
2037
    service.port = tcp_server.socket.getsockname()[1]
2848
2038
    if use_ipv6:
2849
2039
        logger.info("Now listening on address %r, port %d,"
2850
 
                    " flowinfo %d, scope_id %d",
2851
 
                    *tcp_server.socket.getsockname())
 
2040
                    " flowinfo %d, scope_id %d"
 
2041
                    % tcp_server.socket.getsockname())
2852
2042
    else:                       # IPv4
2853
 
        logger.info("Now listening on address %r, port %d",
2854
 
                    *tcp_server.socket.getsockname())
 
2043
        logger.info("Now listening on address %r, port %d"
 
2044
                    % tcp_server.socket.getsockname())
2855
2045
    
2856
2046
    #service.interface = tcp_server.socket.getsockname()[3]
2857
2047
    
2858
2048
    try:
2859
 
        if zeroconf:
2860
 
            # From the Avahi example code
2861
 
            try:
2862
 
                service.activate()
2863
 
            except dbus.exceptions.DBusException as error:
2864
 
                logger.critical("D-Bus Exception", exc_info=error)
2865
 
                cleanup()
2866
 
                sys.exit(1)
2867
 
            # End of Avahi example code
 
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
2868
2057
        
2869
2058
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2870
2059
                             lambda *args, **kwargs:
2874
2063
        logger.debug("Starting main loop")
2875
2064
        main_loop.run()
2876
2065
    except AvahiError as error:
2877
 
        logger.critical("Avahi Error", exc_info=error)
 
2066
        logger.critical("AvahiError: %s", error)
2878
2067
        cleanup()
2879
2068
        sys.exit(1)
2880
2069
    except KeyboardInterrupt: