/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: 2014-08-09 13:12:55 UTC
  • Revision ID: teddy@recompile.se-20140809131255-lp31j98u2pl0xpe6
mandos: Stop using str() and remove unnecessary unicode() calls.

* mandos (if_nametoindex): Use "bytes" literal instead of str().
  (initlogger): Use a unicode string for log device.
  (AvahiError.__unicode__): Removed.
  (DBusPropertyException.__unicode__): - '' -
  (ClientDBus.Secret_dbus_property): Use bytes() instead of str().
  (IPv6_TCPServer.server_bind): Use .encode() instead of str().
  (string_to_delta): Removed unnecessary unicode() call.
  (main): Use "isinstance(x, bytes)" instead of "type(x) is str", use
          .decode() instead of unicode(), and use .encode() instead of
          str().

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
 
1
#!/usr/bin/python2.7
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2011 Teddy Hogeborn
15
 
# Copyright © 2008-2011 Björn Påhlsson
 
14
# Copyright © 2008-2014 Teddy Hogeborn
 
15
# Copyright © 2008-2014 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
31
# Contact the authors at <mandos@recompile.se>.
32
32
33
33
 
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
 
37
from future_builtins import *
 
38
 
37
39
import SocketServer as socketserver
38
40
import socket
39
41
import argparse
62
64
import functools
63
65
import cPickle as pickle
64
66
import multiprocessing
 
67
import types
 
68
import binascii
 
69
import tempfile
 
70
import itertools
 
71
import collections
65
72
 
66
73
import dbus
67
74
import dbus.service
81
88
    except ImportError:
82
89
        SO_BINDTODEVICE = None
83
90
 
84
 
 
85
 
version = "1.3.1"
86
 
 
87
 
#logger = logging.getLogger('mandos')
88
 
logger = logging.Logger('mandos')
89
 
syslogger = (logging.handlers.SysLogHandler
90
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
 
              address = str("/dev/log")))
92
 
syslogger.setFormatter(logging.Formatter
93
 
                       ('Mandos [%(process)d]: %(levelname)s:'
94
 
                        ' %(message)s'))
95
 
logger.addHandler(syslogger)
96
 
 
97
 
console = logging.StreamHandler()
98
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
99
 
                                       ' %(levelname)s:'
100
 
                                       ' %(message)s'))
101
 
logger.addHandler(console)
 
91
version = "1.6.8"
 
92
stored_state_file = "clients.pickle"
 
93
 
 
94
logger = logging.getLogger()
 
95
syslogger = None
 
96
 
 
97
try:
 
98
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
99
                      (ctypes.util.find_library("c"))
 
100
                      .if_nametoindex)
 
101
except (OSError, AttributeError):
 
102
    def if_nametoindex(interface):
 
103
        "Get an interface index the hard way, i.e. using fcntl()"
 
104
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
105
        with contextlib.closing(socket.socket()) as s:
 
106
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
107
                                struct.pack(b"16s16x", interface))
 
108
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
109
        return interface_index
 
110
 
 
111
 
 
112
def initlogger(debug, level=logging.WARNING):
 
113
    """init logger and add loglevel"""
 
114
    
 
115
    global syslogger
 
116
    syslogger = (logging.handlers.SysLogHandler
 
117
                 (facility =
 
118
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
119
                  address = "/dev/log"))
 
120
    syslogger.setFormatter(logging.Formatter
 
121
                           ('Mandos [%(process)d]: %(levelname)s:'
 
122
                            ' %(message)s'))
 
123
    logger.addHandler(syslogger)
 
124
    
 
125
    if debug:
 
126
        console = logging.StreamHandler()
 
127
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
128
                                               ' [%(process)d]:'
 
129
                                               ' %(levelname)s:'
 
130
                                               ' %(message)s'))
 
131
        logger.addHandler(console)
 
132
    logger.setLevel(level)
 
133
 
 
134
 
 
135
class PGPError(Exception):
 
136
    """Exception if encryption/decryption fails"""
 
137
    pass
 
138
 
 
139
 
 
140
class PGPEngine(object):
 
141
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
142
    def __init__(self):
 
143
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
144
        self.gnupgargs = ['--batch',
 
145
                          '--home', self.tempdir,
 
146
                          '--force-mdc',
 
147
                          '--quiet',
 
148
                          '--no-use-agent']
 
149
    
 
150
    def __enter__(self):
 
151
        return self
 
152
    
 
153
    def __exit__(self, exc_type, exc_value, traceback):
 
154
        self._cleanup()
 
155
        return False
 
156
    
 
157
    def __del__(self):
 
158
        self._cleanup()
 
159
    
 
160
    def _cleanup(self):
 
161
        if self.tempdir is not None:
 
162
            # Delete contents of tempdir
 
163
            for root, dirs, files in os.walk(self.tempdir,
 
164
                                             topdown = False):
 
165
                for filename in files:
 
166
                    os.remove(os.path.join(root, filename))
 
167
                for dirname in dirs:
 
168
                    os.rmdir(os.path.join(root, dirname))
 
169
            # Remove tempdir
 
170
            os.rmdir(self.tempdir)
 
171
            self.tempdir = None
 
172
    
 
173
    def password_encode(self, password):
 
174
        # Passphrase can not be empty and can not contain newlines or
 
175
        # NUL bytes.  So we prefix it and hex encode it.
 
176
        encoded = b"mandos" + binascii.hexlify(password)
 
177
        if len(encoded) > 2048:
 
178
            # GnuPG can't handle long passwords, so encode differently
 
179
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
180
                       .replace(b"\n", b"\\n")
 
181
                       .replace(b"\0", b"\\x00"))
 
182
        return encoded
 
183
    
 
184
    def encrypt(self, data, password):
 
185
        passphrase = self.password_encode(password)
 
186
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
187
                                         ) as passfile:
 
188
            passfile.write(passphrase)
 
189
            passfile.flush()
 
190
            proc = subprocess.Popen(['gpg', '--symmetric',
 
191
                                     '--passphrase-file',
 
192
                                     passfile.name]
 
193
                                    + self.gnupgargs,
 
194
                                    stdin = subprocess.PIPE,
 
195
                                    stdout = subprocess.PIPE,
 
196
                                    stderr = subprocess.PIPE)
 
197
            ciphertext, err = proc.communicate(input = data)
 
198
        if proc.returncode != 0:
 
199
            raise PGPError(err)
 
200
        return ciphertext
 
201
    
 
202
    def decrypt(self, data, password):
 
203
        passphrase = self.password_encode(password)
 
204
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
205
                                         ) as passfile:
 
206
            passfile.write(passphrase)
 
207
            passfile.flush()
 
208
            proc = subprocess.Popen(['gpg', '--decrypt',
 
209
                                     '--passphrase-file',
 
210
                                     passfile.name]
 
211
                                    + self.gnupgargs,
 
212
                                    stdin = subprocess.PIPE,
 
213
                                    stdout = subprocess.PIPE,
 
214
                                    stderr = subprocess.PIPE)
 
215
            decrypted_plaintext, err = proc.communicate(input
 
216
                                                        = data)
 
217
        if proc.returncode != 0:
 
218
            raise PGPError(err)
 
219
        return decrypted_plaintext
 
220
 
102
221
 
103
222
class AvahiError(Exception):
104
223
    def __init__(self, value, *args, **kwargs):
105
224
        self.value = value
106
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
107
 
    def __unicode__(self):
108
 
        return unicode(repr(self.value))
 
225
        return super(AvahiError, self).__init__(value, *args,
 
226
                                                **kwargs)
109
227
 
110
228
class AvahiServiceError(AvahiError):
111
229
    pass
122
240
               Used to optionally bind to the specified interface.
123
241
    name: string; Example: 'Mandos'
124
242
    type: string; Example: '_mandos._tcp'.
125
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
243
     See <https://www.iana.org/assignments/service-names-port-numbers>
126
244
    port: integer; what port to announce
127
245
    TXT: list of strings; TXT record for the service
128
246
    domain: string; Domain to publish on, default to .local if empty.
134
252
    server: D-Bus Server
135
253
    bus: dbus.SystemBus()
136
254
    """
 
255
    
137
256
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
138
257
                 servicetype = None, port = None, TXT = None,
139
258
                 domain = "", host = "", max_renames = 32768,
152
271
        self.server = None
153
272
        self.bus = bus
154
273
        self.entry_group_state_changed_match = None
 
274
    
155
275
    def rename(self):
156
276
        """Derived from the Avahi example code"""
157
277
        if self.rename_count >= self.max_renames:
159
279
                            " after %i retries, exiting.",
160
280
                            self.rename_count)
161
281
            raise AvahiServiceError("Too many renames")
162
 
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
 
282
        self.name = unicode(self.server
 
283
                            .GetAlternativeServiceName(self.name))
163
284
        logger.info("Changing Zeroconf service name to %r ...",
164
285
                    self.name)
165
 
        syslogger.setFormatter(logging.Formatter
166
 
                               ('Mandos (%s) [%%(process)d]:'
167
 
                                ' %%(levelname)s: %%(message)s'
168
 
                                % self.name))
169
286
        self.remove()
170
287
        try:
171
288
            self.add()
172
289
        except dbus.exceptions.DBusException as error:
173
 
            logger.critical("DBusException: %s", error)
 
290
            logger.critical("D-Bus Exception", exc_info=error)
174
291
            self.cleanup()
175
292
            os._exit(1)
176
293
        self.rename_count += 1
 
294
    
177
295
    def remove(self):
178
296
        """Derived from the Avahi example code"""
179
297
        if self.entry_group_state_changed_match is not None:
181
299
            self.entry_group_state_changed_match = None
182
300
        if self.group is not None:
183
301
            self.group.Reset()
 
302
    
184
303
    def add(self):
185
304
        """Derived from the Avahi example code"""
186
305
        self.remove()
191
310
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
192
311
        self.entry_group_state_changed_match = (
193
312
            self.group.connect_to_signal(
194
 
                'StateChanged', self .entry_group_state_changed))
 
313
                'StateChanged', self.entry_group_state_changed))
195
314
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
196
315
                     self.name, self.type)
197
316
        self.group.AddService(
203
322
            dbus.UInt16(self.port),
204
323
            avahi.string_array_to_txt_array(self.TXT))
205
324
        self.group.Commit()
 
325
    
206
326
    def entry_group_state_changed(self, state, error):
207
327
        """Derived from the Avahi example code"""
208
328
        logger.debug("Avahi entry group state change: %i", state)
215
335
        elif state == avahi.ENTRY_GROUP_FAILURE:
216
336
            logger.critical("Avahi: Error in group state changed %s",
217
337
                            unicode(error))
218
 
            raise AvahiGroupError("State changed: %s"
219
 
                                  % unicode(error))
 
338
            raise AvahiGroupError("State changed: {!s}"
 
339
                                  .format(error))
 
340
    
220
341
    def cleanup(self):
221
342
        """Derived from the Avahi example code"""
222
343
        if self.group is not None:
223
344
            try:
224
345
                self.group.Free()
225
346
            except (dbus.exceptions.UnknownMethodException,
226
 
                    dbus.exceptions.DBusException) as e:
 
347
                    dbus.exceptions.DBusException):
227
348
                pass
228
349
            self.group = None
229
350
        self.remove()
 
351
    
230
352
    def server_state_changed(self, state, error=None):
231
353
        """Derived from the Avahi example code"""
232
354
        logger.debug("Avahi server state change: %i", state)
251
373
                logger.debug("Unknown state: %r", state)
252
374
            else:
253
375
                logger.debug("Unknown state: %r: %r", state, error)
 
376
    
254
377
    def activate(self):
255
378
        """Derived from the Avahi example code"""
256
379
        if self.server is None:
264
387
        self.server_state_changed(self.server.GetState())
265
388
 
266
389
 
 
390
class AvahiServiceToSyslog(AvahiService):
 
391
    def rename(self):
 
392
        """Add the new name to the syslog messages"""
 
393
        ret = AvahiService.rename(self)
 
394
        syslogger.setFormatter(logging.Formatter
 
395
                               ('Mandos ({}) [%(process)d]:'
 
396
                                ' %(levelname)s: %(message)s'
 
397
                                .format(self.name)))
 
398
        return ret
 
399
 
 
400
 
267
401
class Client(object):
268
402
    """A representation of a client host served by this server.
269
403
    
270
404
    Attributes:
271
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
405
    approved:   bool(); 'None' if not yet approved/disapproved
272
406
    approval_delay: datetime.timedelta(); Time to wait for approval
273
407
    approval_duration: datetime.timedelta(); Duration of one approval
274
408
    checker:    subprocess.Popen(); a running checker process used
281
415
                     instance %(name)s can be used in the command.
282
416
    checker_initiator_tag: a gobject event source tag, or None
283
417
    created:    datetime.datetime(); (UTC) object creation
 
418
    client_structure: Object describing what attributes a client has
 
419
                      and is used for storing the client at exit
284
420
    current_checker_command: string; current running checker_command
285
 
    disable_hook:  If set, called by disable() as disable_hook(self)
286
421
    disable_initiator_tag: a gobject event source tag, or None
287
422
    enabled:    bool()
288
423
    fingerprint: string (40 or 32 hexadecimal digits); used to
291
426
    interval:   datetime.timedelta(); How often to start a new checker
292
427
    last_approval_request: datetime.datetime(); (UTC) or None
293
428
    last_checked_ok: datetime.datetime(); (UTC) or None
294
 
    last_enabled: datetime.datetime(); (UTC)
 
429
    last_checker_status: integer between 0 and 255 reflecting exit
 
430
                         status of last checker. -1 reflects crashed
 
431
                         checker, -2 means no checker completed yet.
 
432
    last_enabled: datetime.datetime(); (UTC) or None
295
433
    name:       string; from the config file, used in log messages and
296
434
                        D-Bus identifiers
297
435
    secret:     bytestring; sent verbatim (over TLS) to client
298
436
    timeout:    datetime.timedelta(); How long from last_checked_ok
299
437
                                      until this client is disabled
300
 
    extended_timeout:   extra long timeout when password has been sent
 
438
    extended_timeout:   extra long timeout when secret has been sent
301
439
    runtime_expansions: Allowed attributes for runtime expansion.
302
440
    expires:    datetime.datetime(); time (UTC) when a client will be
303
441
                disabled, or None
 
442
    server_settings: The server_settings dict from main()
304
443
    """
305
444
    
306
445
    runtime_expansions = ("approval_delay", "approval_duration",
307
 
                          "created", "enabled", "fingerprint",
308
 
                          "host", "interval", "last_checked_ok",
 
446
                          "created", "enabled", "expires",
 
447
                          "fingerprint", "host", "interval",
 
448
                          "last_approval_request", "last_checked_ok",
309
449
                          "last_enabled", "name", "timeout")
 
450
    client_defaults = { "timeout": "PT5M",
 
451
                        "extended_timeout": "PT15M",
 
452
                        "interval": "PT2M",
 
453
                        "checker": "fping -q -- %%(host)s",
 
454
                        "host": "",
 
455
                        "approval_delay": "PT0S",
 
456
                        "approval_duration": "PT1S",
 
457
                        "approved_by_default": "True",
 
458
                        "enabled": "True",
 
459
                        }
310
460
    
311
461
    @staticmethod
312
 
    def _timedelta_to_milliseconds(td):
313
 
        "Convert a datetime.timedelta() to milliseconds"
314
 
        return ((td.days * 24 * 60 * 60 * 1000)
315
 
                + (td.seconds * 1000)
316
 
                + (td.microseconds // 1000))
317
 
    
318
 
    def timeout_milliseconds(self):
319
 
        "Return the 'timeout' attribute in milliseconds"
320
 
        return self._timedelta_to_milliseconds(self.timeout)
321
 
 
322
 
    def extended_timeout_milliseconds(self):
323
 
        "Return the 'extended_timeout' attribute in milliseconds"
324
 
        return self._timedelta_to_milliseconds(self.extended_timeout)    
325
 
    
326
 
    def interval_milliseconds(self):
327
 
        "Return the 'interval' attribute in milliseconds"
328
 
        return self._timedelta_to_milliseconds(self.interval)
329
 
 
330
 
    def approval_delay_milliseconds(self):
331
 
        return self._timedelta_to_milliseconds(self.approval_delay)
332
 
    
333
 
    def __init__(self, name = None, disable_hook=None, config=None):
334
 
        """Note: the 'checker' key in 'config' sets the
335
 
        'checker_command' attribute and *not* the 'checker'
336
 
        attribute."""
 
462
    def config_parser(config):
 
463
        """Construct a new dict of client settings of this form:
 
464
        { client_name: {setting_name: value, ...}, ...}
 
465
        with exceptions for any special settings as defined above.
 
466
        NOTE: Must be a pure function. Must return the same result
 
467
        value given the same arguments.
 
468
        """
 
469
        settings = {}
 
470
        for client_name in config.sections():
 
471
            section = dict(config.items(client_name))
 
472
            client = settings[client_name] = {}
 
473
            
 
474
            client["host"] = section["host"]
 
475
            # Reformat values from string types to Python types
 
476
            client["approved_by_default"] = config.getboolean(
 
477
                client_name, "approved_by_default")
 
478
            client["enabled"] = config.getboolean(client_name,
 
479
                                                  "enabled")
 
480
            
 
481
            client["fingerprint"] = (section["fingerprint"].upper()
 
482
                                     .replace(" ", ""))
 
483
            if "secret" in section:
 
484
                client["secret"] = section["secret"].decode("base64")
 
485
            elif "secfile" in section:
 
486
                with open(os.path.expanduser(os.path.expandvars
 
487
                                             (section["secfile"])),
 
488
                          "rb") as secfile:
 
489
                    client["secret"] = secfile.read()
 
490
            else:
 
491
                raise TypeError("No secret or secfile for section {}"
 
492
                                .format(section))
 
493
            client["timeout"] = string_to_delta(section["timeout"])
 
494
            client["extended_timeout"] = string_to_delta(
 
495
                section["extended_timeout"])
 
496
            client["interval"] = string_to_delta(section["interval"])
 
497
            client["approval_delay"] = string_to_delta(
 
498
                section["approval_delay"])
 
499
            client["approval_duration"] = string_to_delta(
 
500
                section["approval_duration"])
 
501
            client["checker_command"] = section["checker"]
 
502
            client["last_approval_request"] = None
 
503
            client["last_checked_ok"] = None
 
504
            client["last_checker_status"] = -2
 
505
        
 
506
        return settings
 
507
    
 
508
    def __init__(self, settings, name = None, server_settings=None):
337
509
        self.name = name
338
 
        if config is None:
339
 
            config = {}
 
510
        if server_settings is None:
 
511
            server_settings = {}
 
512
        self.server_settings = server_settings
 
513
        # adding all client settings
 
514
        for setting, value in settings.items():
 
515
            setattr(self, setting, value)
 
516
        
 
517
        if self.enabled:
 
518
            if not hasattr(self, "last_enabled"):
 
519
                self.last_enabled = datetime.datetime.utcnow()
 
520
            if not hasattr(self, "expires"):
 
521
                self.expires = (datetime.datetime.utcnow()
 
522
                                + self.timeout)
 
523
        else:
 
524
            self.last_enabled = None
 
525
            self.expires = None
 
526
        
340
527
        logger.debug("Creating client %r", self.name)
341
528
        # Uppercase and remove spaces from fingerprint for later
342
529
        # comparison purposes with return value from the fingerprint()
343
530
        # function
344
 
        self.fingerprint = (config["fingerprint"].upper()
345
 
                            .replace(" ", ""))
346
531
        logger.debug("  Fingerprint: %s", self.fingerprint)
347
 
        if "secret" in config:
348
 
            self.secret = config["secret"].decode("base64")
349
 
        elif "secfile" in config:
350
 
            with open(os.path.expanduser(os.path.expandvars
351
 
                                         (config["secfile"])),
352
 
                      "rb") as secfile:
353
 
                self.secret = secfile.read()
354
 
        else:
355
 
            raise TypeError("No secret or secfile for client %s"
356
 
                            % self.name)
357
 
        self.host = config.get("host", "")
358
 
        self.created = datetime.datetime.utcnow()
359
 
        self.enabled = False
360
 
        self.last_approval_request = None
361
 
        self.last_enabled = None
362
 
        self.last_checked_ok = None
363
 
        self.timeout = string_to_delta(config["timeout"])
364
 
        self.extended_timeout = string_to_delta(config["extended_timeout"])
365
 
        self.interval = string_to_delta(config["interval"])
366
 
        self.disable_hook = disable_hook
 
532
        self.created = settings.get("created",
 
533
                                    datetime.datetime.utcnow())
 
534
        
 
535
        # attributes specific for this server instance
367
536
        self.checker = None
368
537
        self.checker_initiator_tag = None
369
538
        self.disable_initiator_tag = None
370
 
        self.expires = None
371
539
        self.checker_callback_tag = None
372
 
        self.checker_command = config["checker"]
373
540
        self.current_checker_command = None
374
 
        self.last_connect = None
375
 
        self._approved = None
376
 
        self.approved_by_default = config.get("approved_by_default",
377
 
                                              True)
 
541
        self.approved = None
378
542
        self.approvals_pending = 0
379
 
        self.approval_delay = string_to_delta(
380
 
            config["approval_delay"])
381
 
        self.approval_duration = string_to_delta(
382
 
            config["approval_duration"])
383
 
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
 
543
        self.changedstate = (multiprocessing_manager
 
544
                             .Condition(multiprocessing_manager
 
545
                                        .Lock()))
 
546
        self.client_structure = [attr for attr in
 
547
                                 self.__dict__.iterkeys()
 
548
                                 if not attr.startswith("_")]
 
549
        self.client_structure.append("client_structure")
 
550
        
 
551
        for name, t in inspect.getmembers(type(self),
 
552
                                          lambda obj:
 
553
                                              isinstance(obj,
 
554
                                                         property)):
 
555
            if not name.startswith("_"):
 
556
                self.client_structure.append(name)
384
557
    
 
558
    # Send notice to process children that client state has changed
385
559
    def send_changedstate(self):
386
 
        self.changedstate.acquire()
387
 
        self.changedstate.notify_all()
388
 
        self.changedstate.release()
389
 
        
 
560
        with self.changedstate:
 
561
            self.changedstate.notify_all()
 
562
    
390
563
    def enable(self):
391
564
        """Start this client's checker and timeout hooks"""
392
565
        if getattr(self, "enabled", False):
393
566
            # Already enabled
394
567
            return
395
 
        self.send_changedstate()
 
568
        self.expires = datetime.datetime.utcnow() + self.timeout
 
569
        self.enabled = True
396
570
        self.last_enabled = datetime.datetime.utcnow()
397
 
        # Schedule a new checker to be started an 'interval' from now,
398
 
        # and every interval from then on.
399
 
        self.checker_initiator_tag = (gobject.timeout_add
400
 
                                      (self.interval_milliseconds(),
401
 
                                       self.start_checker))
402
 
        # Schedule a disable() when 'timeout' has passed
403
 
        self.expires = datetime.datetime.utcnow() + self.timeout
404
 
        self.disable_initiator_tag = (gobject.timeout_add
405
 
                                   (self.timeout_milliseconds(),
406
 
                                    self.disable))
407
 
        self.enabled = True
408
 
        # Also start a new checker *right now*.
409
 
        self.start_checker()
 
571
        self.init_checker()
 
572
        self.send_changedstate()
410
573
    
411
574
    def disable(self, quiet=True):
412
575
        """Disable this client."""
413
576
        if not getattr(self, "enabled", False):
414
577
            return False
415
578
        if not quiet:
416
 
            self.send_changedstate()
417
 
        if not quiet:
418
579
            logger.info("Disabling client %s", self.name)
419
 
        if getattr(self, "disable_initiator_tag", False):
 
580
        if getattr(self, "disable_initiator_tag", None) is not None:
420
581
            gobject.source_remove(self.disable_initiator_tag)
421
582
            self.disable_initiator_tag = None
422
583
        self.expires = None
423
 
        if getattr(self, "checker_initiator_tag", False):
 
584
        if getattr(self, "checker_initiator_tag", None) is not None:
424
585
            gobject.source_remove(self.checker_initiator_tag)
425
586
            self.checker_initiator_tag = None
426
587
        self.stop_checker()
427
 
        if self.disable_hook:
428
 
            self.disable_hook(self)
429
588
        self.enabled = False
 
589
        if not quiet:
 
590
            self.send_changedstate()
430
591
        # Do not run this again if called by a gobject.timeout_add
431
592
        return False
432
593
    
433
594
    def __del__(self):
434
 
        self.disable_hook = None
435
595
        self.disable()
436
596
    
 
597
    def init_checker(self):
 
598
        # Schedule a new checker to be started an 'interval' from now,
 
599
        # and every interval from then on.
 
600
        if self.checker_initiator_tag is not None:
 
601
            gobject.source_remove(self.checker_initiator_tag)
 
602
        self.checker_initiator_tag = (gobject.timeout_add
 
603
                                      (int(self.interval
 
604
                                           .total_seconds() * 1000),
 
605
                                       self.start_checker))
 
606
        # Schedule a disable() when 'timeout' has passed
 
607
        if self.disable_initiator_tag is not None:
 
608
            gobject.source_remove(self.disable_initiator_tag)
 
609
        self.disable_initiator_tag = (gobject.timeout_add
 
610
                                      (int(self.timeout
 
611
                                           .total_seconds() * 1000),
 
612
                                       self.disable))
 
613
        # Also start a new checker *right now*.
 
614
        self.start_checker()
 
615
    
437
616
    def checker_callback(self, pid, condition, command):
438
617
        """The checker has completed, so take appropriate actions."""
439
618
        self.checker_callback_tag = None
440
619
        self.checker = None
441
620
        if os.WIFEXITED(condition):
442
 
            exitstatus = os.WEXITSTATUS(condition)
443
 
            if exitstatus == 0:
 
621
            self.last_checker_status = os.WEXITSTATUS(condition)
 
622
            if self.last_checker_status == 0:
444
623
                logger.info("Checker for %(name)s succeeded",
445
624
                            vars(self))
446
625
                self.checked_ok()
448
627
                logger.info("Checker for %(name)s failed",
449
628
                            vars(self))
450
629
        else:
 
630
            self.last_checker_status = -1
451
631
            logger.warning("Checker for %(name)s crashed?",
452
632
                           vars(self))
453
633
    
454
 
    def checked_ok(self, timeout=None):
455
 
        """Bump up the timeout for this client.
456
 
        
457
 
        This should only be called when the client has been seen,
458
 
        alive and well.
459
 
        """
 
634
    def checked_ok(self):
 
635
        """Assert that the client has been seen, alive and well."""
 
636
        self.last_checked_ok = datetime.datetime.utcnow()
 
637
        self.last_checker_status = 0
 
638
        self.bump_timeout()
 
639
    
 
640
    def bump_timeout(self, timeout=None):
 
641
        """Bump up the timeout for this client."""
460
642
        if timeout is None:
461
643
            timeout = self.timeout
462
 
        self.last_checked_ok = datetime.datetime.utcnow()
463
 
        gobject.source_remove(self.disable_initiator_tag)
464
 
        self.expires = datetime.datetime.utcnow() + timeout
465
 
        self.disable_initiator_tag = (gobject.timeout_add
466
 
                                      (self._timedelta_to_milliseconds(timeout),
467
 
                                       self.disable))
 
644
        if self.disable_initiator_tag is not None:
 
645
            gobject.source_remove(self.disable_initiator_tag)
 
646
            self.disable_initiator_tag = None
 
647
        if getattr(self, "enabled", False):
 
648
            self.disable_initiator_tag = (gobject.timeout_add
 
649
                                          (int(timeout.total_seconds()
 
650
                                               * 1000), self.disable))
 
651
            self.expires = datetime.datetime.utcnow() + timeout
468
652
    
469
653
    def need_approval(self):
470
654
        self.last_approval_request = datetime.datetime.utcnow()
475
659
        If a checker already exists, leave it running and do
476
660
        nothing."""
477
661
        # The reason for not killing a running checker is that if we
478
 
        # did that, then if a checker (for some reason) started
479
 
        # running slowly and taking more than 'interval' time, the
480
 
        # client would inevitably timeout, since no checker would get
481
 
        # a chance to run to completion.  If we instead leave running
 
662
        # did that, and if a checker (for some reason) started running
 
663
        # slowly and taking more than 'interval' time, then the client
 
664
        # would inevitably timeout, since no checker would get a
 
665
        # chance to run to completion.  If we instead leave running
482
666
        # checkers alone, the checker would have to take more time
483
667
        # than 'timeout' for the client to be disabled, which is as it
484
668
        # should be.
486
670
        # If a checker exists, make sure it is not a zombie
487
671
        try:
488
672
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
489
 
        except (AttributeError, OSError) as error:
490
 
            if (isinstance(error, OSError)
491
 
                and error.errno != errno.ECHILD):
492
 
                raise error
 
673
        except AttributeError:
 
674
            pass
 
675
        except OSError as error:
 
676
            if error.errno != errno.ECHILD:
 
677
                raise
493
678
        else:
494
679
            if pid:
495
680
                logger.warning("Checker was a zombie")
498
683
                                      self.current_checker_command)
499
684
        # Start a new checker if needed
500
685
        if self.checker is None:
 
686
            # Escape attributes for the shell
 
687
            escaped_attrs = { attr:
 
688
                                  re.escape(unicode(getattr(self,
 
689
                                                            attr)))
 
690
                              for attr in self.runtime_expansions }
501
691
            try:
502
 
                # In case checker_command has exactly one % operator
503
 
                command = self.checker_command % self.host
504
 
            except TypeError:
505
 
                # Escape attributes for the shell
506
 
                escaped_attrs = dict(
507
 
                    (attr,
508
 
                     re.escape(unicode(str(getattr(self, attr, "")),
509
 
                                       errors=
510
 
                                       'replace')))
511
 
                    for attr in
512
 
                    self.runtime_expansions)
513
 
 
514
 
                try:
515
 
                    command = self.checker_command % escaped_attrs
516
 
                except TypeError as error:
517
 
                    logger.error('Could not format string "%s":'
518
 
                                 ' %s', self.checker_command, error)
519
 
                    return True # Try again later
 
692
                command = self.checker_command % escaped_attrs
 
693
            except TypeError as error:
 
694
                logger.error('Could not format string "%s"',
 
695
                             self.checker_command, exc_info=error)
 
696
                return True # Try again later
520
697
            self.current_checker_command = command
521
698
            try:
522
699
                logger.info("Starting checker %r for %s",
525
702
                # in normal mode, that is already done by daemon(),
526
703
                # and in debug mode we don't want to.  (Stdin is
527
704
                # always replaced by /dev/null.)
 
705
                # The exception is when not debugging but nevertheless
 
706
                # running in the foreground; use the previously
 
707
                # created wnull.
 
708
                popen_args = {}
 
709
                if (not self.server_settings["debug"]
 
710
                    and self.server_settings["foreground"]):
 
711
                    popen_args.update({"stdout": wnull,
 
712
                                       "stderr": wnull })
528
713
                self.checker = subprocess.Popen(command,
529
714
                                                close_fds=True,
530
 
                                                shell=True, cwd="/")
531
 
                self.checker_callback_tag = (gobject.child_watch_add
532
 
                                             (self.checker.pid,
533
 
                                              self.checker_callback,
534
 
                                              data=command))
535
 
                # The checker may have completed before the gobject
536
 
                # watch was added.  Check for this.
 
715
                                                shell=True, cwd="/",
 
716
                                                **popen_args)
 
717
            except OSError as error:
 
718
                logger.error("Failed to start subprocess",
 
719
                             exc_info=error)
 
720
                return True
 
721
            self.checker_callback_tag = (gobject.child_watch_add
 
722
                                         (self.checker.pid,
 
723
                                          self.checker_callback,
 
724
                                          data=command))
 
725
            # The checker may have completed before the gobject
 
726
            # watch was added.  Check for this.
 
727
            try:
537
728
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
538
 
                if pid:
539
 
                    gobject.source_remove(self.checker_callback_tag)
540
 
                    self.checker_callback(pid, status, command)
541
729
            except OSError as error:
542
 
                logger.error("Failed to start subprocess: %s",
543
 
                             error)
 
730
                if error.errno == errno.ECHILD:
 
731
                    # This should never happen
 
732
                    logger.error("Child process vanished",
 
733
                                 exc_info=error)
 
734
                    return True
 
735
                raise
 
736
            if pid:
 
737
                gobject.source_remove(self.checker_callback_tag)
 
738
                self.checker_callback(pid, status, command)
544
739
        # Re-run this periodically if run by gobject.timeout_add
545
740
        return True
546
741
    
553
748
            return
554
749
        logger.debug("Stopping checker for %(name)s", vars(self))
555
750
        try:
556
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
751
            self.checker.terminate()
557
752
            #time.sleep(0.5)
558
753
            #if self.checker.poll() is None:
559
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
754
            #    self.checker.kill()
560
755
        except OSError as error:
561
756
            if error.errno != errno.ESRCH: # No such process
562
757
                raise
563
758
        self.checker = None
564
759
 
 
760
 
565
761
def dbus_service_property(dbus_interface, signature="v",
566
762
                          access="readwrite", byte_arrays=False):
567
763
    """Decorators for marking methods of a DBusObjectWithProperties to
578
774
    # "Set" method, so we fail early here:
579
775
    if byte_arrays and signature != "ay":
580
776
        raise ValueError("Byte arrays not supported for non-'ay'"
581
 
                         " signature %r" % signature)
 
777
                         " signature {!r}".format(signature))
582
778
    def decorator(func):
583
779
        func._dbus_is_property = True
584
780
        func._dbus_interface = dbus_interface
592
788
    return decorator
593
789
 
594
790
 
 
791
def dbus_interface_annotations(dbus_interface):
 
792
    """Decorator for marking functions returning interface annotations
 
793
    
 
794
    Usage:
 
795
    
 
796
    @dbus_interface_annotations("org.example.Interface")
 
797
    def _foo(self):  # Function name does not matter
 
798
        return {"org.freedesktop.DBus.Deprecated": "true",
 
799
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
800
                    "false"}
 
801
    """
 
802
    def decorator(func):
 
803
        func._dbus_is_interface = True
 
804
        func._dbus_interface = dbus_interface
 
805
        func._dbus_name = dbus_interface
 
806
        return func
 
807
    return decorator
 
808
 
 
809
 
 
810
def dbus_annotations(annotations):
 
811
    """Decorator to annotate D-Bus methods, signals or properties
 
812
    Usage:
 
813
    
 
814
    @dbus_service_property("org.example.Interface", signature="b",
 
815
                           access="r")
 
816
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
817
                        "org.freedesktop.DBus.Property."
 
818
                        "EmitsChangedSignal": "false"})
 
819
    def Property_dbus_property(self):
 
820
        return dbus.Boolean(False)
 
821
    """
 
822
    def decorator(func):
 
823
        func._dbus_annotations = annotations
 
824
        return func
 
825
    return decorator
 
826
 
 
827
 
595
828
class DBusPropertyException(dbus.exceptions.DBusException):
596
829
    """A base class for D-Bus property-related exceptions
597
830
    """
598
 
    def __unicode__(self):
599
 
        return unicode(str(self))
600
 
 
 
831
    pass
601
832
 
602
833
class DBusPropertyAccessException(DBusPropertyException):
603
834
    """A property's access permissions disallows an operation.
613
844
 
614
845
class DBusObjectWithProperties(dbus.service.Object):
615
846
    """A D-Bus object with properties.
616
 
 
 
847
    
617
848
    Classes inheriting from this can use the dbus_service_property
618
849
    decorator to expose methods as D-Bus properties.  It exposes the
619
850
    standard Get(), Set(), and GetAll() methods on the D-Bus.
620
851
    """
621
852
    
622
853
    @staticmethod
623
 
    def _is_dbus_property(obj):
624
 
        return getattr(obj, "_dbus_is_property", False)
 
854
    def _is_dbus_thing(thing):
 
855
        """Returns a function testing if an attribute is a D-Bus thing
 
856
        
 
857
        If called like _is_dbus_thing("method") it returns a function
 
858
        suitable for use as predicate to inspect.getmembers().
 
859
        """
 
860
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
861
                                   False)
625
862
    
626
 
    def _get_all_dbus_properties(self):
 
863
    def _get_all_dbus_things(self, thing):
627
864
        """Returns a generator of (name, attribute) pairs
628
865
        """
629
 
        return ((prop._dbus_name, prop)
630
 
                for name, prop in
631
 
                inspect.getmembers(self, self._is_dbus_property))
 
866
        return ((getattr(athing.__get__(self), "_dbus_name",
 
867
                         name),
 
868
                 athing.__get__(self))
 
869
                for cls in self.__class__.__mro__
 
870
                for name, athing in
 
871
                inspect.getmembers(cls,
 
872
                                   self._is_dbus_thing(thing)))
632
873
    
633
874
    def _get_dbus_property(self, interface_name, property_name):
634
875
        """Returns a bound method if one exists which is a D-Bus
635
876
        property with the specified name and interface.
636
877
        """
637
 
        for name in (property_name,
638
 
                     property_name + "_dbus_property"):
639
 
            prop = getattr(self, name, None)
640
 
            if (prop is None
641
 
                or not self._is_dbus_property(prop)
642
 
                or prop._dbus_name != property_name
643
 
                or (interface_name and prop._dbus_interface
644
 
                    and interface_name != prop._dbus_interface)):
645
 
                continue
646
 
            return prop
 
878
        for cls in  self.__class__.__mro__:
 
879
            for name, value in (inspect.getmembers
 
880
                                (cls,
 
881
                                 self._is_dbus_thing("property"))):
 
882
                if (value._dbus_name == property_name
 
883
                    and value._dbus_interface == interface_name):
 
884
                    return value.__get__(self)
 
885
        
647
886
        # No such property
648
887
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
649
888
                                   + interface_name + "."
673
912
            # The byte_arrays option is not supported yet on
674
913
            # signatures other than "ay".
675
914
            if prop._dbus_signature != "ay":
676
 
                raise ValueError
677
 
            value = dbus.ByteArray(''.join(unichr(byte)
678
 
                                           for byte in value))
 
915
                raise ValueError("Byte arrays not supported for non-"
 
916
                                 "'ay' signature {!r}"
 
917
                                 .format(prop._dbus_signature))
 
918
            value = dbus.ByteArray(b''.join(chr(byte)
 
919
                                            for byte in value))
679
920
        prop(value)
680
921
    
681
922
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
683
924
    def GetAll(self, interface_name):
684
925
        """Standard D-Bus property GetAll() method, see D-Bus
685
926
        standard.
686
 
 
 
927
        
687
928
        Note: Will not include properties with access="write".
688
929
        """
689
 
        all = {}
690
 
        for name, prop in self._get_all_dbus_properties():
 
930
        properties = {}
 
931
        for name, prop in self._get_all_dbus_things("property"):
691
932
            if (interface_name
692
933
                and interface_name != prop._dbus_interface):
693
934
                # Interface non-empty but did not match
697
938
                continue
698
939
            value = prop()
699
940
            if not hasattr(value, "variant_level"):
700
 
                all[name] = value
 
941
                properties[name] = value
701
942
                continue
702
 
            all[name] = type(value)(value, variant_level=
703
 
                                    value.variant_level+1)
704
 
        return dbus.Dictionary(all, signature="sv")
 
943
            properties[name] = type(value)(value, variant_level=
 
944
                                           value.variant_level+1)
 
945
        return dbus.Dictionary(properties, signature="sv")
705
946
    
706
947
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
707
948
                         out_signature="s",
708
949
                         path_keyword='object_path',
709
950
                         connection_keyword='connection')
710
951
    def Introspect(self, object_path, connection):
711
 
        """Standard D-Bus method, overloaded to insert property tags.
 
952
        """Overloading of standard D-Bus method.
 
953
        
 
954
        Inserts property tags and interface annotation tags.
712
955
        """
713
956
        xmlstring = dbus.service.Object.Introspect(self, object_path,
714
957
                                                   connection)
721
964
                e.setAttribute("access", prop._dbus_access)
722
965
                return e
723
966
            for if_tag in document.getElementsByTagName("interface"):
 
967
                # Add property tags
724
968
                for tag in (make_tag(document, name, prop)
725
969
                            for name, prop
726
 
                            in self._get_all_dbus_properties()
 
970
                            in self._get_all_dbus_things("property")
727
971
                            if prop._dbus_interface
728
972
                            == if_tag.getAttribute("name")):
729
973
                    if_tag.appendChild(tag)
 
974
                # Add annotation tags
 
975
                for typ in ("method", "signal", "property"):
 
976
                    for tag in if_tag.getElementsByTagName(typ):
 
977
                        annots = dict()
 
978
                        for name, prop in (self.
 
979
                                           _get_all_dbus_things(typ)):
 
980
                            if (name == tag.getAttribute("name")
 
981
                                and prop._dbus_interface
 
982
                                == if_tag.getAttribute("name")):
 
983
                                annots.update(getattr
 
984
                                              (prop,
 
985
                                               "_dbus_annotations",
 
986
                                               {}))
 
987
                        for name, value in annots.items():
 
988
                            ann_tag = document.createElement(
 
989
                                "annotation")
 
990
                            ann_tag.setAttribute("name", name)
 
991
                            ann_tag.setAttribute("value", value)
 
992
                            tag.appendChild(ann_tag)
 
993
                # Add interface annotation tags
 
994
                for annotation, value in dict(
 
995
                    itertools.chain.from_iterable(
 
996
                        annotations().items()
 
997
                        for name, annotations in
 
998
                        self._get_all_dbus_things("interface")
 
999
                        if name == if_tag.getAttribute("name")
 
1000
                        )).items():
 
1001
                    ann_tag = document.createElement("annotation")
 
1002
                    ann_tag.setAttribute("name", annotation)
 
1003
                    ann_tag.setAttribute("value", value)
 
1004
                    if_tag.appendChild(ann_tag)
730
1005
                # Add the names to the return values for the
731
1006
                # "org.freedesktop.DBus.Properties" methods
732
1007
                if (if_tag.getAttribute("name")
747
1022
        except (AttributeError, xml.dom.DOMException,
748
1023
                xml.parsers.expat.ExpatError) as error:
749
1024
            logger.error("Failed to override Introspection method",
750
 
                         error)
 
1025
                         exc_info=error)
751
1026
        return xmlstring
752
1027
 
753
1028
 
 
1029
def datetime_to_dbus(dt, variant_level=0):
 
1030
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
1031
    if dt is None:
 
1032
        return dbus.String("", variant_level = variant_level)
 
1033
    return dbus.String(dt.isoformat(),
 
1034
                       variant_level=variant_level)
 
1035
 
 
1036
 
 
1037
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1038
    """A class decorator; applied to a subclass of
 
1039
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1040
    interface names according to the "alt_interface_names" mapping.
 
1041
    Usage:
 
1042
    
 
1043
    @alternate_dbus_interfaces({"org.example.Interface":
 
1044
                                    "net.example.AlternateInterface"})
 
1045
    class SampleDBusObject(dbus.service.Object):
 
1046
        @dbus.service.method("org.example.Interface")
 
1047
        def SampleDBusMethod():
 
1048
            pass
 
1049
    
 
1050
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1051
    reachable via two interfaces: "org.example.Interface" and
 
1052
    "net.example.AlternateInterface", the latter of which will have
 
1053
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1054
    "true", unless "deprecate" is passed with a False value.
 
1055
    
 
1056
    This works for methods and signals, and also for D-Bus properties
 
1057
    (from DBusObjectWithProperties) and interfaces (from the
 
1058
    dbus_interface_annotations decorator).
 
1059
    """
 
1060
    def wrapper(cls):
 
1061
        for orig_interface_name, alt_interface_name in (
 
1062
            alt_interface_names.items()):
 
1063
            attr = {}
 
1064
            interface_names = set()
 
1065
            # Go though all attributes of the class
 
1066
            for attrname, attribute in inspect.getmembers(cls):
 
1067
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1068
                # with the wrong interface name
 
1069
                if (not hasattr(attribute, "_dbus_interface")
 
1070
                    or not attribute._dbus_interface
 
1071
                    .startswith(orig_interface_name)):
 
1072
                    continue
 
1073
                # Create an alternate D-Bus interface name based on
 
1074
                # the current name
 
1075
                alt_interface = (attribute._dbus_interface
 
1076
                                 .replace(orig_interface_name,
 
1077
                                          alt_interface_name))
 
1078
                interface_names.add(alt_interface)
 
1079
                # Is this a D-Bus signal?
 
1080
                if getattr(attribute, "_dbus_is_signal", False):
 
1081
                    # Extract the original non-method undecorated
 
1082
                    # function by black magic
 
1083
                    nonmethod_func = (dict(
 
1084
                            zip(attribute.func_code.co_freevars,
 
1085
                                attribute.__closure__))["func"]
 
1086
                                      .cell_contents)
 
1087
                    # Create a new, but exactly alike, function
 
1088
                    # object, and decorate it to be a new D-Bus signal
 
1089
                    # with the alternate D-Bus interface name
 
1090
                    new_function = (dbus.service.signal
 
1091
                                    (alt_interface,
 
1092
                                     attribute._dbus_signature)
 
1093
                                    (types.FunctionType(
 
1094
                                nonmethod_func.func_code,
 
1095
                                nonmethod_func.func_globals,
 
1096
                                nonmethod_func.func_name,
 
1097
                                nonmethod_func.func_defaults,
 
1098
                                nonmethod_func.func_closure)))
 
1099
                    # Copy annotations, if any
 
1100
                    try:
 
1101
                        new_function._dbus_annotations = (
 
1102
                            dict(attribute._dbus_annotations))
 
1103
                    except AttributeError:
 
1104
                        pass
 
1105
                    # Define a creator of a function to call both the
 
1106
                    # original and alternate functions, so both the
 
1107
                    # original and alternate signals gets sent when
 
1108
                    # the function is called
 
1109
                    def fixscope(func1, func2):
 
1110
                        """This function is a scope container to pass
 
1111
                        func1 and func2 to the "call_both" function
 
1112
                        outside of its arguments"""
 
1113
                        def call_both(*args, **kwargs):
 
1114
                            """This function will emit two D-Bus
 
1115
                            signals by calling func1 and func2"""
 
1116
                            func1(*args, **kwargs)
 
1117
                            func2(*args, **kwargs)
 
1118
                        return call_both
 
1119
                    # Create the "call_both" function and add it to
 
1120
                    # the class
 
1121
                    attr[attrname] = fixscope(attribute, new_function)
 
1122
                # Is this a D-Bus method?
 
1123
                elif getattr(attribute, "_dbus_is_method", False):
 
1124
                    # Create a new, but exactly alike, function
 
1125
                    # object.  Decorate it to be a new D-Bus method
 
1126
                    # with the alternate D-Bus interface name.  Add it
 
1127
                    # to the class.
 
1128
                    attr[attrname] = (dbus.service.method
 
1129
                                      (alt_interface,
 
1130
                                       attribute._dbus_in_signature,
 
1131
                                       attribute._dbus_out_signature)
 
1132
                                      (types.FunctionType
 
1133
                                       (attribute.func_code,
 
1134
                                        attribute.func_globals,
 
1135
                                        attribute.func_name,
 
1136
                                        attribute.func_defaults,
 
1137
                                        attribute.func_closure)))
 
1138
                    # Copy annotations, if any
 
1139
                    try:
 
1140
                        attr[attrname]._dbus_annotations = (
 
1141
                            dict(attribute._dbus_annotations))
 
1142
                    except AttributeError:
 
1143
                        pass
 
1144
                # Is this a D-Bus property?
 
1145
                elif getattr(attribute, "_dbus_is_property", False):
 
1146
                    # Create a new, but exactly alike, function
 
1147
                    # object, and decorate it to be a new D-Bus
 
1148
                    # property with the alternate D-Bus interface
 
1149
                    # name.  Add it to the class.
 
1150
                    attr[attrname] = (dbus_service_property
 
1151
                                      (alt_interface,
 
1152
                                       attribute._dbus_signature,
 
1153
                                       attribute._dbus_access,
 
1154
                                       attribute
 
1155
                                       ._dbus_get_args_options
 
1156
                                       ["byte_arrays"])
 
1157
                                      (types.FunctionType
 
1158
                                       (attribute.func_code,
 
1159
                                        attribute.func_globals,
 
1160
                                        attribute.func_name,
 
1161
                                        attribute.func_defaults,
 
1162
                                        attribute.func_closure)))
 
1163
                    # Copy annotations, if any
 
1164
                    try:
 
1165
                        attr[attrname]._dbus_annotations = (
 
1166
                            dict(attribute._dbus_annotations))
 
1167
                    except AttributeError:
 
1168
                        pass
 
1169
                # Is this a D-Bus interface?
 
1170
                elif getattr(attribute, "_dbus_is_interface", False):
 
1171
                    # Create a new, but exactly alike, function
 
1172
                    # object.  Decorate it to be a new D-Bus interface
 
1173
                    # with the alternate D-Bus interface name.  Add it
 
1174
                    # to the class.
 
1175
                    attr[attrname] = (dbus_interface_annotations
 
1176
                                      (alt_interface)
 
1177
                                      (types.FunctionType
 
1178
                                       (attribute.func_code,
 
1179
                                        attribute.func_globals,
 
1180
                                        attribute.func_name,
 
1181
                                        attribute.func_defaults,
 
1182
                                        attribute.func_closure)))
 
1183
            if deprecate:
 
1184
                # Deprecate all alternate interfaces
 
1185
                iname="_AlternateDBusNames_interface_annotation{}"
 
1186
                for interface_name in interface_names:
 
1187
                    @dbus_interface_annotations(interface_name)
 
1188
                    def func(self):
 
1189
                        return { "org.freedesktop.DBus.Deprecated":
 
1190
                                     "true" }
 
1191
                    # Find an unused name
 
1192
                    for aname in (iname.format(i)
 
1193
                                  for i in itertools.count()):
 
1194
                        if aname not in attr:
 
1195
                            attr[aname] = func
 
1196
                            break
 
1197
            if interface_names:
 
1198
                # Replace the class with a new subclass of it with
 
1199
                # methods, signals, etc. as created above.
 
1200
                cls = type(b"{}Alternate".format(cls.__name__),
 
1201
                           (cls,), attr)
 
1202
        return cls
 
1203
    return wrapper
 
1204
 
 
1205
 
 
1206
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1207
                                "se.bsnet.fukt.Mandos"})
754
1208
class ClientDBus(Client, DBusObjectWithProperties):
755
1209
    """A Client class using D-Bus
756
1210
    
765
1219
    # dbus.service.Object doesn't use super(), so we can't either.
766
1220
    
767
1221
    def __init__(self, bus = None, *args, **kwargs):
768
 
        self._approvals_pending = 0
769
1222
        self.bus = bus
770
1223
        Client.__init__(self, *args, **kwargs)
771
1224
        # Only now, when this client is initialized, can it show up on
777
1230
                                 ("/clients/" + client_object_name))
778
1231
        DBusObjectWithProperties.__init__(self, self.bus,
779
1232
                                          self.dbus_object_path)
780
 
    def _set_expires(self, value):
781
 
        old_value = getattr(self, "_expires", None)
782
 
        self._expires = value
783
 
        if hasattr(self, "dbus_object_path") and old_value != value:
784
 
            dbus_time = (self._datetime_to_dbus(self._expires,
785
 
                                                variant_level=1))
786
 
            self.PropertyChanged(dbus.String("Expires"),
787
 
                                 dbus_time)
788
 
    expires = property(lambda self: self._expires, _set_expires)
789
 
    del _set_expires
790
 
        
791
 
    def _get_approvals_pending(self):
792
 
        return self._approvals_pending
793
 
    def _set_approvals_pending(self, value):
794
 
        old_value = self._approvals_pending
795
 
        self._approvals_pending = value
796
 
        bval = bool(value)
797
 
        if (hasattr(self, "dbus_object_path")
798
 
            and bval is not bool(old_value)):
799
 
            dbus_bool = dbus.Boolean(bval, variant_level=1)
800
 
            self.PropertyChanged(dbus.String("ApprovalPending"),
801
 
                                 dbus_bool)
802
 
 
803
 
    approvals_pending = property(_get_approvals_pending,
804
 
                                 _set_approvals_pending)
805
 
    del _get_approvals_pending, _set_approvals_pending
806
 
    
807
 
    @staticmethod
808
 
    def _datetime_to_dbus(dt, variant_level=0):
809
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
810
 
        if dt is None:
811
 
            return dbus.String("", variant_level = variant_level)
812
 
        return dbus.String(dt.isoformat(),
813
 
                           variant_level=variant_level)
814
 
    
815
 
    def enable(self):
816
 
        oldstate = getattr(self, "enabled", False)
817
 
        r = Client.enable(self)
818
 
        if oldstate != self.enabled:
819
 
            # Emit D-Bus signals
820
 
            self.PropertyChanged(dbus.String("Enabled"),
821
 
                                 dbus.Boolean(True, variant_level=1))
822
 
            self.PropertyChanged(
823
 
                dbus.String("LastEnabled"),
824
 
                self._datetime_to_dbus(self.last_enabled,
825
 
                                       variant_level=1))
826
 
        return r
827
 
    
828
 
    def disable(self, quiet = False):
829
 
        oldstate = getattr(self, "enabled", False)
830
 
        r = Client.disable(self, quiet=quiet)
831
 
        if not quiet and oldstate != self.enabled:
832
 
            # Emit D-Bus signal
833
 
            self.PropertyChanged(dbus.String("Enabled"),
834
 
                                 dbus.Boolean(False, variant_level=1))
835
 
        return r
 
1233
    
 
1234
    def notifychangeproperty(transform_func,
 
1235
                             dbus_name, type_func=lambda x: x,
 
1236
                             variant_level=1):
 
1237
        """ Modify a variable so that it's a property which announces
 
1238
        its changes to DBus.
 
1239
        
 
1240
        transform_fun: Function that takes a value and a variant_level
 
1241
                       and transforms it to a D-Bus type.
 
1242
        dbus_name: D-Bus name of the variable
 
1243
        type_func: Function that transform the value before sending it
 
1244
                   to the D-Bus.  Default: no transform
 
1245
        variant_level: D-Bus variant level.  Default: 1
 
1246
        """
 
1247
        attrname = "_{}".format(dbus_name)
 
1248
        def setter(self, value):
 
1249
            if hasattr(self, "dbus_object_path"):
 
1250
                if (not hasattr(self, attrname) or
 
1251
                    type_func(getattr(self, attrname, None))
 
1252
                    != type_func(value)):
 
1253
                    dbus_value = transform_func(type_func(value),
 
1254
                                                variant_level
 
1255
                                                =variant_level)
 
1256
                    self.PropertyChanged(dbus.String(dbus_name),
 
1257
                                         dbus_value)
 
1258
            setattr(self, attrname, value)
 
1259
        
 
1260
        return property(lambda self: getattr(self, attrname), setter)
 
1261
    
 
1262
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1263
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1264
                                             "ApprovalPending",
 
1265
                                             type_func = bool)
 
1266
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1267
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1268
                                        "LastEnabled")
 
1269
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1270
                                   type_func = lambda checker:
 
1271
                                       checker is not None)
 
1272
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1273
                                           "LastCheckedOK")
 
1274
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1275
                                               "LastCheckerStatus")
 
1276
    last_approval_request = notifychangeproperty(
 
1277
        datetime_to_dbus, "LastApprovalRequest")
 
1278
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1279
                                               "ApprovedByDefault")
 
1280
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1281
                                          "ApprovalDelay",
 
1282
                                          type_func =
 
1283
                                          lambda td: td.total_seconds()
 
1284
                                          * 1000)
 
1285
    approval_duration = notifychangeproperty(
 
1286
        dbus.UInt64, "ApprovalDuration",
 
1287
        type_func = lambda td: td.total_seconds() * 1000)
 
1288
    host = notifychangeproperty(dbus.String, "Host")
 
1289
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1290
                                   type_func = lambda td:
 
1291
                                       td.total_seconds() * 1000)
 
1292
    extended_timeout = notifychangeproperty(
 
1293
        dbus.UInt64, "ExtendedTimeout",
 
1294
        type_func = lambda td: td.total_seconds() * 1000)
 
1295
    interval = notifychangeproperty(dbus.UInt64,
 
1296
                                    "Interval",
 
1297
                                    type_func =
 
1298
                                    lambda td: td.total_seconds()
 
1299
                                    * 1000)
 
1300
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1301
    
 
1302
    del notifychangeproperty
836
1303
    
837
1304
    def __del__(self, *args, **kwargs):
838
1305
        try:
847
1314
                         *args, **kwargs):
848
1315
        self.checker_callback_tag = None
849
1316
        self.checker = None
850
 
        # Emit D-Bus signal
851
 
        self.PropertyChanged(dbus.String("CheckerRunning"),
852
 
                             dbus.Boolean(False, variant_level=1))
853
1317
        if os.WIFEXITED(condition):
854
1318
            exitstatus = os.WEXITSTATUS(condition)
855
1319
            # Emit D-Bus signal
865
1329
        return Client.checker_callback(self, pid, condition, command,
866
1330
                                       *args, **kwargs)
867
1331
    
868
 
    def checked_ok(self, *args, **kwargs):
869
 
        Client.checked_ok(self, *args, **kwargs)
870
 
        # Emit D-Bus signal
871
 
        self.PropertyChanged(
872
 
            dbus.String("LastCheckedOK"),
873
 
            (self._datetime_to_dbus(self.last_checked_ok,
874
 
                                    variant_level=1)))
875
 
    
876
 
    def need_approval(self, *args, **kwargs):
877
 
        r = Client.need_approval(self, *args, **kwargs)
878
 
        # Emit D-Bus signal
879
 
        self.PropertyChanged(
880
 
            dbus.String("LastApprovalRequest"),
881
 
            (self._datetime_to_dbus(self.last_approval_request,
882
 
                                    variant_level=1)))
883
 
        return r
884
 
    
885
1332
    def start_checker(self, *args, **kwargs):
886
 
        old_checker = self.checker
887
 
        if self.checker is not None:
888
 
            old_checker_pid = self.checker.pid
889
 
        else:
890
 
            old_checker_pid = None
 
1333
        old_checker_pid = getattr(self.checker, "pid", None)
891
1334
        r = Client.start_checker(self, *args, **kwargs)
892
1335
        # Only if new checker process was started
893
1336
        if (self.checker is not None
894
1337
            and old_checker_pid != self.checker.pid):
895
1338
            # Emit D-Bus signal
896
1339
            self.CheckerStarted(self.current_checker_command)
897
 
            self.PropertyChanged(
898
 
                dbus.String("CheckerRunning"),
899
 
                dbus.Boolean(True, variant_level=1))
900
1340
        return r
901
1341
    
902
 
    def stop_checker(self, *args, **kwargs):
903
 
        old_checker = getattr(self, "checker", None)
904
 
        r = Client.stop_checker(self, *args, **kwargs)
905
 
        if (old_checker is not None
906
 
            and getattr(self, "checker", None) is None):
907
 
            self.PropertyChanged(dbus.String("CheckerRunning"),
908
 
                                 dbus.Boolean(False, variant_level=1))
909
 
        return r
910
 
 
911
1342
    def _reset_approved(self):
912
 
        self._approved = None
 
1343
        self.approved = None
913
1344
        return False
914
1345
    
915
1346
    def approve(self, value=True):
 
1347
        self.approved = value
 
1348
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1349
                                * 1000), self._reset_approved)
916
1350
        self.send_changedstate()
917
 
        self._approved = value
918
 
        gobject.timeout_add(self._timedelta_to_milliseconds
919
 
                            (self.approval_duration),
920
 
                            self._reset_approved)
921
 
    
922
1351
    
923
1352
    ## D-Bus methods, signals & properties
924
 
    _interface = "se.bsnet.fukt.Mandos.Client"
 
1353
    _interface = "se.recompile.Mandos.Client"
 
1354
    
 
1355
    ## Interfaces
 
1356
    
 
1357
    @dbus_interface_annotations(_interface)
 
1358
    def _foo(self):
 
1359
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1360
                     "false"}
925
1361
    
926
1362
    ## Signals
927
1363
    
1012
1448
    def ApprovedByDefault_dbus_property(self, value=None):
1013
1449
        if value is None:       # get
1014
1450
            return dbus.Boolean(self.approved_by_default)
1015
 
        old_value = self.approved_by_default
1016
1451
        self.approved_by_default = bool(value)
1017
 
        # Emit D-Bus signal
1018
 
        if old_value != self.approved_by_default:
1019
 
            self.PropertyChanged(dbus.String("ApprovedByDefault"),
1020
 
                                 dbus.Boolean(value, variant_level=1))
1021
1452
    
1022
1453
    # ApprovalDelay - property
1023
1454
    @dbus_service_property(_interface, signature="t",
1024
1455
                           access="readwrite")
1025
1456
    def ApprovalDelay_dbus_property(self, value=None):
1026
1457
        if value is None:       # get
1027
 
            return dbus.UInt64(self.approval_delay_milliseconds())
1028
 
        old_value = self.approval_delay
 
1458
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1459
                               * 1000)
1029
1460
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1030
 
        # Emit D-Bus signal
1031
 
        if old_value != self.approval_delay:
1032
 
            self.PropertyChanged(dbus.String("ApprovalDelay"),
1033
 
                                 dbus.UInt64(value, variant_level=1))
1034
1461
    
1035
1462
    # ApprovalDuration - property
1036
1463
    @dbus_service_property(_interface, signature="t",
1037
1464
                           access="readwrite")
1038
1465
    def ApprovalDuration_dbus_property(self, value=None):
1039
1466
        if value is None:       # get
1040
 
            return dbus.UInt64(self._timedelta_to_milliseconds(
1041
 
                    self.approval_duration))
1042
 
        old_value = self.approval_duration
 
1467
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1468
                               * 1000)
1043
1469
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1044
 
        # Emit D-Bus signal
1045
 
        if old_value != self.approval_duration:
1046
 
            self.PropertyChanged(dbus.String("ApprovalDuration"),
1047
 
                                 dbus.UInt64(value, variant_level=1))
1048
1470
    
1049
1471
    # Name - property
1050
1472
    @dbus_service_property(_interface, signature="s", access="read")
1062
1484
    def Host_dbus_property(self, value=None):
1063
1485
        if value is None:       # get
1064
1486
            return dbus.String(self.host)
1065
 
        old_value = self.host
1066
 
        self.host = value
1067
 
        # Emit D-Bus signal
1068
 
        if old_value != self.host:
1069
 
            self.PropertyChanged(dbus.String("Host"),
1070
 
                                 dbus.String(value, variant_level=1))
 
1487
        self.host = unicode(value)
1071
1488
    
1072
1489
    # Created - property
1073
1490
    @dbus_service_property(_interface, signature="s", access="read")
1074
1491
    def Created_dbus_property(self):
1075
 
        return dbus.String(self._datetime_to_dbus(self.created))
 
1492
        return datetime_to_dbus(self.created)
1076
1493
    
1077
1494
    # LastEnabled - property
1078
1495
    @dbus_service_property(_interface, signature="s", access="read")
1079
1496
    def LastEnabled_dbus_property(self):
1080
 
        return self._datetime_to_dbus(self.last_enabled)
 
1497
        return datetime_to_dbus(self.last_enabled)
1081
1498
    
1082
1499
    # Enabled - property
1083
1500
    @dbus_service_property(_interface, signature="b",
1097
1514
        if value is not None:
1098
1515
            self.checked_ok()
1099
1516
            return
1100
 
        return self._datetime_to_dbus(self.last_checked_ok)
 
1517
        return datetime_to_dbus(self.last_checked_ok)
 
1518
    
 
1519
    # LastCheckerStatus - property
 
1520
    @dbus_service_property(_interface, signature="n",
 
1521
                           access="read")
 
1522
    def LastCheckerStatus_dbus_property(self):
 
1523
        return dbus.Int16(self.last_checker_status)
1101
1524
    
1102
1525
    # Expires - property
1103
1526
    @dbus_service_property(_interface, signature="s", access="read")
1104
1527
    def Expires_dbus_property(self):
1105
 
        return self._datetime_to_dbus(self.expires)
 
1528
        return datetime_to_dbus(self.expires)
1106
1529
    
1107
1530
    # LastApprovalRequest - property
1108
1531
    @dbus_service_property(_interface, signature="s", access="read")
1109
1532
    def LastApprovalRequest_dbus_property(self):
1110
 
        return self._datetime_to_dbus(self.last_approval_request)
 
1533
        return datetime_to_dbus(self.last_approval_request)
1111
1534
    
1112
1535
    # Timeout - property
1113
1536
    @dbus_service_property(_interface, signature="t",
1114
1537
                           access="readwrite")
1115
1538
    def Timeout_dbus_property(self, value=None):
1116
1539
        if value is None:       # get
1117
 
            return dbus.UInt64(self.timeout_milliseconds())
1118
 
        old_value = self.timeout
 
1540
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1541
        old_timeout = self.timeout
1119
1542
        self.timeout = datetime.timedelta(0, 0, 0, value)
1120
 
        # Emit D-Bus signal
1121
 
        if old_value != self.timeout:
1122
 
            self.PropertyChanged(dbus.String("Timeout"),
1123
 
                                 dbus.UInt64(value, variant_level=1))
1124
 
        if getattr(self, "disable_initiator_tag", None) is None:
1125
 
            return
1126
 
        # Reschedule timeout
1127
 
        gobject.source_remove(self.disable_initiator_tag)
1128
 
        self.disable_initiator_tag = None
1129
 
        self.expires = None
1130
 
        time_to_die = (self.
1131
 
                       _timedelta_to_milliseconds((self
1132
 
                                                   .last_checked_ok
1133
 
                                                   + self.timeout)
1134
 
                                                  - datetime.datetime
1135
 
                                                  .utcnow()))
1136
 
        if time_to_die <= 0:
1137
 
            # The timeout has passed
1138
 
            self.disable()
1139
 
        else:
1140
 
            self.expires = (datetime.datetime.utcnow()
1141
 
                            + datetime.timedelta(milliseconds = time_to_die))
1142
 
            self.disable_initiator_tag = (gobject.timeout_add
1143
 
                                          (time_to_die, self.disable))
1144
 
 
 
1543
        # Reschedule disabling
 
1544
        if self.enabled:
 
1545
            now = datetime.datetime.utcnow()
 
1546
            self.expires += self.timeout - old_timeout
 
1547
            if self.expires <= now:
 
1548
                # The timeout has passed
 
1549
                self.disable()
 
1550
            else:
 
1551
                if (getattr(self, "disable_initiator_tag", None)
 
1552
                    is None):
 
1553
                    return
 
1554
                gobject.source_remove(self.disable_initiator_tag)
 
1555
                self.disable_initiator_tag = (
 
1556
                    gobject.timeout_add(
 
1557
                        int((self.expires - now).total_seconds()
 
1558
                            * 1000), self.disable))
 
1559
    
1145
1560
    # ExtendedTimeout - property
1146
1561
    @dbus_service_property(_interface, signature="t",
1147
1562
                           access="readwrite")
1148
1563
    def ExtendedTimeout_dbus_property(self, value=None):
1149
1564
        if value is None:       # get
1150
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
1151
 
        old_value = self.extended_timeout
 
1565
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
1566
                               * 1000)
1152
1567
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1153
 
        # Emit D-Bus signal
1154
 
        if old_value != self.extended_timeout:
1155
 
            self.PropertyChanged(dbus.String("ExtendedTimeout"),
1156
 
                                 dbus.UInt64(value, variant_level=1))
1157
 
 
 
1568
    
1158
1569
    # Interval - property
1159
1570
    @dbus_service_property(_interface, signature="t",
1160
1571
                           access="readwrite")
1161
1572
    def Interval_dbus_property(self, value=None):
1162
1573
        if value is None:       # get
1163
 
            return dbus.UInt64(self.interval_milliseconds())
1164
 
        old_value = self.interval
 
1574
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1165
1575
        self.interval = datetime.timedelta(0, 0, 0, value)
1166
 
        # Emit D-Bus signal
1167
 
        if old_value != self.interval:
1168
 
            self.PropertyChanged(dbus.String("Interval"),
1169
 
                                 dbus.UInt64(value, variant_level=1))
1170
1576
        if getattr(self, "checker_initiator_tag", None) is None:
1171
1577
            return
1172
 
        # Reschedule checker run
1173
 
        gobject.source_remove(self.checker_initiator_tag)
1174
 
        self.checker_initiator_tag = (gobject.timeout_add
1175
 
                                      (value, self.start_checker))
1176
 
        self.start_checker()    # Start one now, too
1177
 
 
 
1578
        if self.enabled:
 
1579
            # Reschedule checker run
 
1580
            gobject.source_remove(self.checker_initiator_tag)
 
1581
            self.checker_initiator_tag = (gobject.timeout_add
 
1582
                                          (value, self.start_checker))
 
1583
            self.start_checker()    # Start one now, too
 
1584
    
1178
1585
    # Checker - property
1179
1586
    @dbus_service_property(_interface, signature="s",
1180
1587
                           access="readwrite")
1181
1588
    def Checker_dbus_property(self, value=None):
1182
1589
        if value is None:       # get
1183
1590
            return dbus.String(self.checker_command)
1184
 
        old_value = self.checker_command
1185
 
        self.checker_command = value
1186
 
        # Emit D-Bus signal
1187
 
        if old_value != self.checker_command:
1188
 
            self.PropertyChanged(dbus.String("Checker"),
1189
 
                                 dbus.String(self.checker_command,
1190
 
                                             variant_level=1))
 
1591
        self.checker_command = unicode(value)
1191
1592
    
1192
1593
    # CheckerRunning - property
1193
1594
    @dbus_service_property(_interface, signature="b",
1209
1610
    @dbus_service_property(_interface, signature="ay",
1210
1611
                           access="write", byte_arrays=True)
1211
1612
    def Secret_dbus_property(self, value):
1212
 
        self.secret = str(value)
 
1613
        self.secret = bytes(value)
1213
1614
    
1214
1615
    del _interface
1215
1616
 
1220
1621
        self._pipe.send(('init', fpr, address))
1221
1622
        if not self._pipe.recv():
1222
1623
            raise KeyError()
1223
 
 
 
1624
    
1224
1625
    def __getattribute__(self, name):
1225
 
        if(name == '_pipe'):
 
1626
        if name == '_pipe':
1226
1627
            return super(ProxyClient, self).__getattribute__(name)
1227
1628
        self._pipe.send(('getattr', name))
1228
1629
        data = self._pipe.recv()
1233
1634
                self._pipe.send(('funcall', name, args, kwargs))
1234
1635
                return self._pipe.recv()[1]
1235
1636
            return func
1236
 
 
 
1637
    
1237
1638
    def __setattr__(self, name, value):
1238
 
        if(name == '_pipe'):
 
1639
        if name == '_pipe':
1239
1640
            return super(ProxyClient, self).__setattr__(name, value)
1240
1641
        self._pipe.send(('setattr', name, value))
1241
1642
 
1252
1653
                        unicode(self.client_address))
1253
1654
            logger.debug("Pipe FD: %d",
1254
1655
                         self.server.child_pipe.fileno())
1255
 
 
 
1656
            
1256
1657
            session = (gnutls.connection
1257
1658
                       .ClientSession(self.request,
1258
1659
                                      gnutls.connection
1259
1660
                                      .X509Credentials()))
1260
 
 
 
1661
            
1261
1662
            # Note: gnutls.connection.X509Credentials is really a
1262
1663
            # generic GnuTLS certificate credentials object so long as
1263
1664
            # no X.509 keys are added to it.  Therefore, we can use it
1264
1665
            # here despite using OpenPGP certificates.
1265
 
 
 
1666
            
1266
1667
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1267
1668
            #                      "+AES-256-CBC", "+SHA1",
1268
1669
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1274
1675
            (gnutls.library.functions
1275
1676
             .gnutls_priority_set_direct(session._c_object,
1276
1677
                                         priority, None))
1277
 
 
 
1678
            
1278
1679
            # Start communication using the Mandos protocol
1279
1680
            # Get protocol number
1280
1681
            line = self.request.makefile().readline()
1281
1682
            logger.debug("Protocol version: %r", line)
1282
1683
            try:
1283
1684
                if int(line.strip().split()[0]) > 1:
1284
 
                    raise RuntimeError
 
1685
                    raise RuntimeError(line)
1285
1686
            except (ValueError, IndexError, RuntimeError) as error:
1286
1687
                logger.error("Unknown protocol version: %s", error)
1287
1688
                return
1288
 
 
 
1689
            
1289
1690
            # Start GnuTLS connection
1290
1691
            try:
1291
1692
                session.handshake()
1295
1696
                # established.  Just abandon the request.
1296
1697
                return
1297
1698
            logger.debug("Handshake succeeded")
1298
 
 
 
1699
            
1299
1700
            approval_required = False
1300
1701
            try:
1301
1702
                try:
1306
1707
                    logger.warning("Bad certificate: %s", error)
1307
1708
                    return
1308
1709
                logger.debug("Fingerprint: %s", fpr)
1309
 
 
 
1710
                
1310
1711
                try:
1311
1712
                    client = ProxyClient(child_pipe, fpr,
1312
1713
                                         self.client_address)
1324
1725
                                       client.name)
1325
1726
                        if self.server.use_dbus:
1326
1727
                            # Emit D-Bus signal
1327
 
                            client.Rejected("Disabled")                    
 
1728
                            client.Rejected("Disabled")
1328
1729
                        return
1329
1730
                    
1330
 
                    if client._approved or not client.approval_delay:
 
1731
                    if client.approved or not client.approval_delay:
1331
1732
                        #We are approved or approval is disabled
1332
1733
                        break
1333
 
                    elif client._approved is None:
 
1734
                    elif client.approved is None:
1334
1735
                        logger.info("Client %s needs approval",
1335
1736
                                    client.name)
1336
1737
                        if self.server.use_dbus:
1337
1738
                            # Emit D-Bus signal
1338
1739
                            client.NeedApproval(
1339
 
                                client.approval_delay_milliseconds(),
1340
 
                                client.approved_by_default)
 
1740
                                client.approval_delay.total_seconds()
 
1741
                                * 1000, client.approved_by_default)
1341
1742
                    else:
1342
1743
                        logger.warning("Client %s was not approved",
1343
1744
                                       client.name)
1347
1748
                        return
1348
1749
                    
1349
1750
                    #wait until timeout or approved
1350
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1351
1751
                    time = datetime.datetime.now()
1352
1752
                    client.changedstate.acquire()
1353
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1753
                    client.changedstate.wait(delay.total_seconds())
1354
1754
                    client.changedstate.release()
1355
1755
                    time2 = datetime.datetime.now()
1356
1756
                    if (time2 - time) >= delay:
1372
1772
                    try:
1373
1773
                        sent = session.send(client.secret[sent_size:])
1374
1774
                    except gnutls.errors.GNUTLSError as error:
1375
 
                        logger.warning("gnutls send failed")
 
1775
                        logger.warning("gnutls send failed",
 
1776
                                       exc_info=error)
1376
1777
                        return
1377
1778
                    logger.debug("Sent: %d, remaining: %d",
1378
1779
                                 sent, len(client.secret)
1379
1780
                                 - (sent_size + sent))
1380
1781
                    sent_size += sent
1381
 
 
 
1782
                
1382
1783
                logger.info("Sending secret to %s", client.name)
1383
 
                # bump the timeout as if seen
1384
 
                client.checked_ok(client.extended_timeout)
 
1784
                # bump the timeout using extended_timeout
 
1785
                client.bump_timeout(client.extended_timeout)
1385
1786
                if self.server.use_dbus:
1386
1787
                    # Emit D-Bus signal
1387
1788
                    client.GotSecret()
1392
1793
                try:
1393
1794
                    session.bye()
1394
1795
                except gnutls.errors.GNUTLSError as error:
1395
 
                    logger.warning("GnuTLS bye failed")
 
1796
                    logger.warning("GnuTLS bye failed",
 
1797
                                   exc_info=error)
1396
1798
    
1397
1799
    @staticmethod
1398
1800
    def peer_certificate(session):
1454
1856
        # Convert the buffer to a Python bytestring
1455
1857
        fpr = ctypes.string_at(buf, buf_len.value)
1456
1858
        # Convert the bytestring to hexadecimal notation
1457
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1859
        hex_fpr = binascii.hexlify(fpr).upper()
1458
1860
        return hex_fpr
1459
1861
 
1460
1862
 
1463
1865
    def sub_process_main(self, request, address):
1464
1866
        try:
1465
1867
            self.finish_request(request, address)
1466
 
        except:
 
1868
        except Exception:
1467
1869
            self.handle_error(request, address)
1468
1870
        self.close_request(request)
1469
 
            
 
1871
    
1470
1872
    def process_request(self, request, address):
1471
1873
        """Start a new process to process the request."""
1472
 
        multiprocessing.Process(target = self.sub_process_main,
1473
 
                                args = (request, address)).start()
 
1874
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1875
                                       args = (request, address))
 
1876
        proc.start()
 
1877
        return proc
 
1878
 
1474
1879
 
1475
1880
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1476
1881
    """ adds a pipe to the MixIn """
1480
1885
        This function creates a new pipe in self.pipe
1481
1886
        """
1482
1887
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1483
 
 
1484
 
        super(MultiprocessingMixInWithPipe,
1485
 
              self).process_request(request, client_address)
 
1888
        
 
1889
        proc = MultiprocessingMixIn.process_request(self, request,
 
1890
                                                    client_address)
1486
1891
        self.child_pipe.close()
1487
 
        self.add_pipe(parent_pipe)
1488
 
 
1489
 
    def add_pipe(self, parent_pipe):
 
1892
        self.add_pipe(parent_pipe, proc)
 
1893
    
 
1894
    def add_pipe(self, parent_pipe, proc):
1490
1895
        """Dummy function; override as necessary"""
1491
 
        raise NotImplementedError
 
1896
        raise NotImplementedError()
 
1897
 
1492
1898
 
1493
1899
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1494
1900
                     socketserver.TCPServer, object):
1500
1906
        use_ipv6:       Boolean; to use IPv6 or not
1501
1907
    """
1502
1908
    def __init__(self, server_address, RequestHandlerClass,
1503
 
                 interface=None, use_ipv6=True):
 
1909
                 interface=None, use_ipv6=True, socketfd=None):
 
1910
        """If socketfd is set, use that file descriptor instead of
 
1911
        creating a new one with socket.socket().
 
1912
        """
1504
1913
        self.interface = interface
1505
1914
        if use_ipv6:
1506
1915
            self.address_family = socket.AF_INET6
 
1916
        if socketfd is not None:
 
1917
            # Save the file descriptor
 
1918
            self.socketfd = socketfd
 
1919
            # Save the original socket.socket() function
 
1920
            self.socket_socket = socket.socket
 
1921
            # To implement --socket, we monkey patch socket.socket.
 
1922
            # 
 
1923
            # (When socketserver.TCPServer is a new-style class, we
 
1924
            # could make self.socket into a property instead of monkey
 
1925
            # patching socket.socket.)
 
1926
            # 
 
1927
            # Create a one-time-only replacement for socket.socket()
 
1928
            @functools.wraps(socket.socket)
 
1929
            def socket_wrapper(*args, **kwargs):
 
1930
                # Restore original function so subsequent calls are
 
1931
                # not affected.
 
1932
                socket.socket = self.socket_socket
 
1933
                del self.socket_socket
 
1934
                # This time only, return a new socket object from the
 
1935
                # saved file descriptor.
 
1936
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1937
            # Replace socket.socket() function with wrapper
 
1938
            socket.socket = socket_wrapper
 
1939
        # The socketserver.TCPServer.__init__ will call
 
1940
        # socket.socket(), which might be our replacement,
 
1941
        # socket_wrapper(), if socketfd was set.
1507
1942
        socketserver.TCPServer.__init__(self, server_address,
1508
1943
                                        RequestHandlerClass)
 
1944
    
1509
1945
    def server_bind(self):
1510
1946
        """This overrides the normal server_bind() function
1511
1947
        to bind to an interface if one was specified, and also NOT to
1519
1955
                try:
1520
1956
                    self.socket.setsockopt(socket.SOL_SOCKET,
1521
1957
                                           SO_BINDTODEVICE,
1522
 
                                           str(self.interface
1523
 
                                               + '\0'))
 
1958
                                           (self.interface + "\0")
 
1959
                                           .encode("utf-8"))
1524
1960
                except socket.error as error:
1525
 
                    if error[0] == errno.EPERM:
1526
 
                        logger.error("No permission to"
1527
 
                                     " bind to interface %s",
1528
 
                                     self.interface)
1529
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1961
                    if error.errno == errno.EPERM:
 
1962
                        logger.error("No permission to bind to"
 
1963
                                     " interface %s", self.interface)
 
1964
                    elif error.errno == errno.ENOPROTOOPT:
1530
1965
                        logger.error("SO_BINDTODEVICE not available;"
1531
1966
                                     " cannot bind to interface %s",
1532
1967
                                     self.interface)
 
1968
                    elif error.errno == errno.ENODEV:
 
1969
                        logger.error("Interface %s does not exist,"
 
1970
                                     " cannot bind", self.interface)
1533
1971
                    else:
1534
1972
                        raise
1535
1973
        # Only bind(2) the socket if we really need to.
1538
1976
                if self.address_family == socket.AF_INET6:
1539
1977
                    any_address = "::" # in6addr_any
1540
1978
                else:
1541
 
                    any_address = socket.INADDR_ANY
 
1979
                    any_address = "0.0.0.0" # INADDR_ANY
1542
1980
                self.server_address = (any_address,
1543
1981
                                       self.server_address[1])
1544
1982
            elif not self.server_address[1]:
1565
2003
    """
1566
2004
    def __init__(self, server_address, RequestHandlerClass,
1567
2005
                 interface=None, use_ipv6=True, clients=None,
1568
 
                 gnutls_priority=None, use_dbus=True):
 
2006
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1569
2007
        self.enabled = False
1570
2008
        self.clients = clients
1571
2009
        if self.clients is None:
1572
 
            self.clients = set()
 
2010
            self.clients = {}
1573
2011
        self.use_dbus = use_dbus
1574
2012
        self.gnutls_priority = gnutls_priority
1575
2013
        IPv6_TCPServer.__init__(self, server_address,
1576
2014
                                RequestHandlerClass,
1577
2015
                                interface = interface,
1578
 
                                use_ipv6 = use_ipv6)
 
2016
                                use_ipv6 = use_ipv6,
 
2017
                                socketfd = socketfd)
1579
2018
    def server_activate(self):
1580
2019
        if self.enabled:
1581
2020
            return socketserver.TCPServer.server_activate(self)
 
2021
    
1582
2022
    def enable(self):
1583
2023
        self.enabled = True
1584
 
    def add_pipe(self, parent_pipe):
 
2024
    
 
2025
    def add_pipe(self, parent_pipe, proc):
1585
2026
        # Call "handle_ipc" for both data and EOF events
1586
2027
        gobject.io_add_watch(parent_pipe.fileno(),
1587
2028
                             gobject.IO_IN | gobject.IO_HUP,
1588
2029
                             functools.partial(self.handle_ipc,
1589
 
                                               parent_pipe = parent_pipe))
1590
 
        
 
2030
                                               parent_pipe =
 
2031
                                               parent_pipe,
 
2032
                                               proc = proc))
 
2033
    
1591
2034
    def handle_ipc(self, source, condition, parent_pipe=None,
1592
 
                   client_object=None):
1593
 
        condition_names = {
1594
 
            gobject.IO_IN: "IN",   # There is data to read.
1595
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1596
 
                                    # blocking).
1597
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1598
 
            gobject.IO_ERR: "ERR", # Error condition.
1599
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1600
 
                                    # broken, usually for pipes and
1601
 
                                    # sockets).
1602
 
            }
1603
 
        conditions_string = ' | '.join(name
1604
 
                                       for cond, name in
1605
 
                                       condition_names.iteritems()
1606
 
                                       if cond & condition)
1607
 
        # error or the other end of multiprocessing.Pipe has closed
1608
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2035
                   proc = None, client_object=None):
 
2036
        # error, or the other end of multiprocessing.Pipe has closed
 
2037
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2038
            # Wait for other process to exit
 
2039
            proc.join()
1609
2040
            return False
1610
2041
        
1611
2042
        # Read a request from the child
1616
2047
            fpr = request[1]
1617
2048
            address = request[2]
1618
2049
            
1619
 
            for c in self.clients:
 
2050
            for c in self.clients.itervalues():
1620
2051
                if c.fingerprint == fpr:
1621
2052
                    client = c
1622
2053
                    break
1625
2056
                            "dress: %s", fpr, address)
1626
2057
                if self.use_dbus:
1627
2058
                    # Emit D-Bus signal
1628
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2059
                    mandos_dbus_service.ClientNotFound(fpr,
 
2060
                                                       address[0])
1629
2061
                parent_pipe.send(False)
1630
2062
                return False
1631
2063
            
1632
2064
            gobject.io_add_watch(parent_pipe.fileno(),
1633
2065
                                 gobject.IO_IN | gobject.IO_HUP,
1634
2066
                                 functools.partial(self.handle_ipc,
1635
 
                                                   parent_pipe = parent_pipe,
1636
 
                                                   client_object = client))
 
2067
                                                   parent_pipe =
 
2068
                                                   parent_pipe,
 
2069
                                                   proc = proc,
 
2070
                                                   client_object =
 
2071
                                                   client))
1637
2072
            parent_pipe.send(True)
1638
 
            # remove the old hook in favor of the new above hook on same fileno
 
2073
            # remove the old hook in favor of the new above hook on
 
2074
            # same fileno
1639
2075
            return False
1640
2076
        if command == 'funcall':
1641
2077
            funcname = request[1]
1642
2078
            args = request[2]
1643
2079
            kwargs = request[3]
1644
2080
            
1645
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1646
 
 
 
2081
            parent_pipe.send(('data', getattr(client_object,
 
2082
                                              funcname)(*args,
 
2083
                                                         **kwargs)))
 
2084
        
1647
2085
        if command == 'getattr':
1648
2086
            attrname = request[1]
1649
2087
            if callable(client_object.__getattribute__(attrname)):
1650
2088
                parent_pipe.send(('function',))
1651
2089
            else:
1652
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2090
                parent_pipe.send(('data', client_object
 
2091
                                  .__getattribute__(attrname)))
1653
2092
        
1654
2093
        if command == 'setattr':
1655
2094
            attrname = request[1]
1656
2095
            value = request[2]
1657
2096
            setattr(client_object, attrname, value)
1658
 
 
 
2097
        
1659
2098
        return True
1660
2099
 
1661
2100
 
 
2101
def rfc3339_duration_to_delta(duration):
 
2102
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2103
    
 
2104
    >>> rfc3339_duration_to_delta("P7D")
 
2105
    datetime.timedelta(7)
 
2106
    >>> rfc3339_duration_to_delta("PT60S")
 
2107
    datetime.timedelta(0, 60)
 
2108
    >>> rfc3339_duration_to_delta("PT60M")
 
2109
    datetime.timedelta(0, 3600)
 
2110
    >>> rfc3339_duration_to_delta("PT24H")
 
2111
    datetime.timedelta(1)
 
2112
    >>> rfc3339_duration_to_delta("P1W")
 
2113
    datetime.timedelta(7)
 
2114
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2115
    datetime.timedelta(0, 330)
 
2116
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2117
    datetime.timedelta(1, 200)
 
2118
    """
 
2119
    
 
2120
    # Parsing an RFC 3339 duration with regular expressions is not
 
2121
    # possible - there would have to be multiple places for the same
 
2122
    # values, like seconds.  The current code, while more esoteric, is
 
2123
    # cleaner without depending on a parsing library.  If Python had a
 
2124
    # built-in library for parsing we would use it, but we'd like to
 
2125
    # avoid excessive use of external libraries.
 
2126
    
 
2127
    # New type for defining tokens, syntax, and semantics all-in-one
 
2128
    Token = collections.namedtuple("Token",
 
2129
                                   ("regexp", # To match token; if
 
2130
                                              # "value" is not None,
 
2131
                                              # must have a "group"
 
2132
                                              # containing digits
 
2133
                                    "value",  # datetime.timedelta or
 
2134
                                              # None
 
2135
                                    "followers")) # Tokens valid after
 
2136
                                                  # this token
 
2137
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2138
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2139
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2140
    token_second = Token(re.compile(r"(\d+)S"),
 
2141
                         datetime.timedelta(seconds=1),
 
2142
                         frozenset((token_end,)))
 
2143
    token_minute = Token(re.compile(r"(\d+)M"),
 
2144
                         datetime.timedelta(minutes=1),
 
2145
                         frozenset((token_second, token_end)))
 
2146
    token_hour = Token(re.compile(r"(\d+)H"),
 
2147
                       datetime.timedelta(hours=1),
 
2148
                       frozenset((token_minute, token_end)))
 
2149
    token_time = Token(re.compile(r"T"),
 
2150
                       None,
 
2151
                       frozenset((token_hour, token_minute,
 
2152
                                  token_second)))
 
2153
    token_day = Token(re.compile(r"(\d+)D"),
 
2154
                      datetime.timedelta(days=1),
 
2155
                      frozenset((token_time, token_end)))
 
2156
    token_month = Token(re.compile(r"(\d+)M"),
 
2157
                        datetime.timedelta(weeks=4),
 
2158
                        frozenset((token_day, token_end)))
 
2159
    token_year = Token(re.compile(r"(\d+)Y"),
 
2160
                       datetime.timedelta(weeks=52),
 
2161
                       frozenset((token_month, token_end)))
 
2162
    token_week = Token(re.compile(r"(\d+)W"),
 
2163
                       datetime.timedelta(weeks=1),
 
2164
                       frozenset((token_end,)))
 
2165
    token_duration = Token(re.compile(r"P"), None,
 
2166
                           frozenset((token_year, token_month,
 
2167
                                      token_day, token_time,
 
2168
                                      token_week)))
 
2169
    # Define starting values
 
2170
    value = datetime.timedelta() # Value so far
 
2171
    found_token = None
 
2172
    followers = frozenset((token_duration,)) # Following valid tokens
 
2173
    s = duration                # String left to parse
 
2174
    # Loop until end token is found
 
2175
    while found_token is not token_end:
 
2176
        # Search for any currently valid tokens
 
2177
        for token in followers:
 
2178
            match = token.regexp.match(s)
 
2179
            if match is not None:
 
2180
                # Token found
 
2181
                if token.value is not None:
 
2182
                    # Value found, parse digits
 
2183
                    factor = int(match.group(1), 10)
 
2184
                    # Add to value so far
 
2185
                    value += factor * token.value
 
2186
                # Strip token from string
 
2187
                s = token.regexp.sub("", s, 1)
 
2188
                # Go to found token
 
2189
                found_token = token
 
2190
                # Set valid next tokens
 
2191
                followers = found_token.followers
 
2192
                break
 
2193
        else:
 
2194
            # No currently valid tokens were found
 
2195
            raise ValueError("Invalid RFC 3339 duration")
 
2196
    # End token found
 
2197
    return value
 
2198
 
 
2199
 
1662
2200
def string_to_delta(interval):
1663
2201
    """Parse a string and return a datetime.timedelta
1664
2202
    
1675
2213
    >>> string_to_delta('5m 30s')
1676
2214
    datetime.timedelta(0, 330)
1677
2215
    """
 
2216
    
 
2217
    try:
 
2218
        return rfc3339_duration_to_delta(interval)
 
2219
    except ValueError:
 
2220
        pass
 
2221
    
1678
2222
    timevalue = datetime.timedelta(0)
1679
2223
    for s in interval.split():
1680
2224
        try:
1681
 
            suffix = unicode(s[-1])
 
2225
            suffix = s[-1]
1682
2226
            value = int(s[:-1])
1683
2227
            if suffix == "d":
1684
2228
                delta = datetime.timedelta(value)
1691
2235
            elif suffix == "w":
1692
2236
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1693
2237
            else:
1694
 
                raise ValueError("Unknown suffix %r" % suffix)
1695
 
        except (ValueError, IndexError) as e:
 
2238
                raise ValueError("Unknown suffix {!r}"
 
2239
                                 .format(suffix))
 
2240
        except IndexError as e:
1696
2241
            raise ValueError(*(e.args))
1697
2242
        timevalue += delta
1698
2243
    return timevalue
1699
2244
 
1700
2245
 
1701
 
def if_nametoindex(interface):
1702
 
    """Call the C function if_nametoindex(), or equivalent
1703
 
    
1704
 
    Note: This function cannot accept a unicode string."""
1705
 
    global if_nametoindex
1706
 
    try:
1707
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1708
 
                          (ctypes.util.find_library("c"))
1709
 
                          .if_nametoindex)
1710
 
    except (OSError, AttributeError):
1711
 
        logger.warning("Doing if_nametoindex the hard way")
1712
 
        def if_nametoindex(interface):
1713
 
            "Get an interface index the hard way, i.e. using fcntl()"
1714
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1715
 
            with contextlib.closing(socket.socket()) as s:
1716
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1717
 
                                    struct.pack(str("16s16x"),
1718
 
                                                interface))
1719
 
            interface_index = struct.unpack(str("I"),
1720
 
                                            ifreq[16:20])[0]
1721
 
            return interface_index
1722
 
    return if_nametoindex(interface)
1723
 
 
1724
 
 
1725
2246
def daemon(nochdir = False, noclose = False):
1726
2247
    """See daemon(3).  Standard BSD Unix function.
1727
2248
    
1735
2256
        sys.exit()
1736
2257
    if not noclose:
1737
2258
        # Close all standard open file descriptors
1738
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2259
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1739
2260
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1740
 
            raise OSError(errno.ENODEV,
1741
 
                          "%s not a character device"
1742
 
                          % os.path.devnull)
 
2261
            raise OSError(errno.ENODEV, "{} not a character device"
 
2262
                          .format(os.devnull))
1743
2263
        os.dup2(null, sys.stdin.fileno())
1744
2264
        os.dup2(null, sys.stdout.fileno())
1745
2265
        os.dup2(null, sys.stderr.fileno())
1754
2274
    
1755
2275
    parser = argparse.ArgumentParser()
1756
2276
    parser.add_argument("-v", "--version", action="version",
1757
 
                        version = "%%(prog)s %s" % version,
 
2277
                        version = "%(prog)s {}".format(version),
1758
2278
                        help="show version number and exit")
1759
2279
    parser.add_argument("-i", "--interface", metavar="IF",
1760
2280
                        help="Bind to interface IF")
1766
2286
                        help="Run self-test")
1767
2287
    parser.add_argument("--debug", action="store_true",
1768
2288
                        help="Debug mode; run in foreground and log"
1769
 
                        " to terminal")
 
2289
                        " to terminal", default=None)
1770
2290
    parser.add_argument("--debuglevel", metavar="LEVEL",
1771
2291
                        help="Debug level for stdout output")
1772
2292
    parser.add_argument("--priority", help="GnuTLS"
1779
2299
                        " files")
1780
2300
    parser.add_argument("--no-dbus", action="store_false",
1781
2301
                        dest="use_dbus", help="Do not provide D-Bus"
1782
 
                        " system bus interface")
 
2302
                        " system bus interface", default=None)
1783
2303
    parser.add_argument("--no-ipv6", action="store_false",
1784
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2304
                        dest="use_ipv6", help="Do not use IPv6",
 
2305
                        default=None)
 
2306
    parser.add_argument("--no-restore", action="store_false",
 
2307
                        dest="restore", help="Do not restore stored"
 
2308
                        " state", default=None)
 
2309
    parser.add_argument("--socket", type=int,
 
2310
                        help="Specify a file descriptor to a network"
 
2311
                        " socket to use instead of creating one")
 
2312
    parser.add_argument("--statedir", metavar="DIR",
 
2313
                        help="Directory to save/restore state in")
 
2314
    parser.add_argument("--foreground", action="store_true",
 
2315
                        help="Run in foreground", default=None)
 
2316
    parser.add_argument("--no-zeroconf", action="store_false",
 
2317
                        dest="zeroconf", help="Do not use Zeroconf",
 
2318
                        default=None)
 
2319
    
1785
2320
    options = parser.parse_args()
1786
2321
    
1787
2322
    if options.check:
1788
2323
        import doctest
1789
 
        doctest.testmod()
1790
 
        sys.exit()
 
2324
        fail_count, test_count = doctest.testmod()
 
2325
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1791
2326
    
1792
2327
    # Default values for config file for server-global settings
1793
2328
    server_defaults = { "interface": "",
1795
2330
                        "port": "",
1796
2331
                        "debug": "False",
1797
2332
                        "priority":
1798
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2333
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1799
2334
                        "servicename": "Mandos",
1800
2335
                        "use_dbus": "True",
1801
2336
                        "use_ipv6": "True",
1802
2337
                        "debuglevel": "",
 
2338
                        "restore": "True",
 
2339
                        "socket": "",
 
2340
                        "statedir": "/var/lib/mandos",
 
2341
                        "foreground": "False",
 
2342
                        "zeroconf": "True",
1803
2343
                        }
1804
2344
    
1805
2345
    # Parse config file for server-global settings
1810
2350
    # Convert the SafeConfigParser object to a dict
1811
2351
    server_settings = server_config.defaults()
1812
2352
    # Use the appropriate methods on the non-string config options
1813
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2353
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1814
2354
        server_settings[option] = server_config.getboolean("DEFAULT",
1815
2355
                                                           option)
1816
2356
    if server_settings["port"]:
1817
2357
        server_settings["port"] = server_config.getint("DEFAULT",
1818
2358
                                                       "port")
 
2359
    if server_settings["socket"]:
 
2360
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2361
                                                         "socket")
 
2362
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2363
        # over with an opened os.devnull.  But we don't want this to
 
2364
        # happen with a supplied network socket.
 
2365
        if 0 <= server_settings["socket"] <= 2:
 
2366
            server_settings["socket"] = os.dup(server_settings
 
2367
                                               ["socket"])
1819
2368
    del server_config
1820
2369
    
1821
2370
    # Override the settings from the config file with command line
1822
2371
    # options, if set.
1823
2372
    for option in ("interface", "address", "port", "debug",
1824
2373
                   "priority", "servicename", "configdir",
1825
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2374
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2375
                   "statedir", "socket", "foreground", "zeroconf"):
1826
2376
        value = getattr(options, option)
1827
2377
        if value is not None:
1828
2378
            server_settings[option] = value
1829
2379
    del options
1830
2380
    # Force all strings to be unicode
1831
2381
    for option in server_settings.keys():
1832
 
        if type(server_settings[option]) is str:
1833
 
            server_settings[option] = unicode(server_settings[option])
 
2382
        if isinstance(server_settings[option], bytes):
 
2383
            server_settings[option] = (server_settings[option]
 
2384
                                       .decode("utf-8"))
 
2385
    # Force all boolean options to be boolean
 
2386
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2387
                   "foreground", "zeroconf"):
 
2388
        server_settings[option] = bool(server_settings[option])
 
2389
    # Debug implies foreground
 
2390
    if server_settings["debug"]:
 
2391
        server_settings["foreground"] = True
1834
2392
    # Now we have our good server settings in "server_settings"
1835
2393
    
1836
2394
    ##################################################################
1837
2395
    
 
2396
    if (not server_settings["zeroconf"] and
 
2397
        not (server_settings["port"]
 
2398
             or server_settings["socket"] != "")):
 
2399
            parser.error("Needs port or socket to work without"
 
2400
                         " Zeroconf")
 
2401
    
1838
2402
    # For convenience
1839
2403
    debug = server_settings["debug"]
1840
2404
    debuglevel = server_settings["debuglevel"]
1841
2405
    use_dbus = server_settings["use_dbus"]
1842
2406
    use_ipv6 = server_settings["use_ipv6"]
1843
 
 
 
2407
    stored_state_path = os.path.join(server_settings["statedir"],
 
2408
                                     stored_state_file)
 
2409
    foreground = server_settings["foreground"]
 
2410
    zeroconf = server_settings["zeroconf"]
 
2411
    
 
2412
    if debug:
 
2413
        initlogger(debug, logging.DEBUG)
 
2414
    else:
 
2415
        if not debuglevel:
 
2416
            initlogger(debug)
 
2417
        else:
 
2418
            level = getattr(logging, debuglevel.upper())
 
2419
            initlogger(debug, level)
 
2420
    
1844
2421
    if server_settings["servicename"] != "Mandos":
1845
2422
        syslogger.setFormatter(logging.Formatter
1846
 
                               ('Mandos (%s) [%%(process)d]:'
1847
 
                                ' %%(levelname)s: %%(message)s'
1848
 
                                % server_settings["servicename"]))
 
2423
                               ('Mandos ({}) [%(process)d]:'
 
2424
                                ' %(levelname)s: %(message)s'
 
2425
                                .format(server_settings
 
2426
                                        ["servicename"])))
1849
2427
    
1850
2428
    # Parse config file with clients
1851
 
    client_defaults = { "timeout": "5m",
1852
 
                        "extended_timeout": "15m",
1853
 
                        "interval": "2m",
1854
 
                        "checker": "fping -q -- %%(host)s",
1855
 
                        "host": "",
1856
 
                        "approval_delay": "0s",
1857
 
                        "approval_duration": "1s",
1858
 
                        }
1859
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2429
    client_config = configparser.SafeConfigParser(Client
 
2430
                                                  .client_defaults)
1860
2431
    client_config.read(os.path.join(server_settings["configdir"],
1861
2432
                                    "clients.conf"))
1862
2433
    
1863
2434
    global mandos_dbus_service
1864
2435
    mandos_dbus_service = None
1865
2436
    
 
2437
    socketfd = None
 
2438
    if server_settings["socket"] != "":
 
2439
        socketfd = server_settings["socket"]
1866
2440
    tcp_server = MandosServer((server_settings["address"],
1867
2441
                               server_settings["port"]),
1868
2442
                              ClientHandler,
1871
2445
                              use_ipv6=use_ipv6,
1872
2446
                              gnutls_priority=
1873
2447
                              server_settings["priority"],
1874
 
                              use_dbus=use_dbus)
1875
 
    if not debug:
1876
 
        pidfilename = "/var/run/mandos.pid"
 
2448
                              use_dbus=use_dbus,
 
2449
                              socketfd=socketfd)
 
2450
    if not foreground:
 
2451
        pidfilename = "/run/mandos.pid"
 
2452
        if not os.path.isdir("/run/."):
 
2453
            pidfilename = "/var/run/mandos.pid"
 
2454
        pidfile = None
1877
2455
        try:
1878
2456
            pidfile = open(pidfilename, "w")
1879
 
        except IOError:
1880
 
            logger.error("Could not open file %r", pidfilename)
 
2457
        except IOError as e:
 
2458
            logger.error("Could not open file %r", pidfilename,
 
2459
                         exc_info=e)
1881
2460
    
1882
 
    try:
1883
 
        uid = pwd.getpwnam("_mandos").pw_uid
1884
 
        gid = pwd.getpwnam("_mandos").pw_gid
1885
 
    except KeyError:
 
2461
    for name in ("_mandos", "mandos", "nobody"):
1886
2462
        try:
1887
 
            uid = pwd.getpwnam("mandos").pw_uid
1888
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2463
            uid = pwd.getpwnam(name).pw_uid
 
2464
            gid = pwd.getpwnam(name).pw_gid
 
2465
            break
1889
2466
        except KeyError:
1890
 
            try:
1891
 
                uid = pwd.getpwnam("nobody").pw_uid
1892
 
                gid = pwd.getpwnam("nobody").pw_gid
1893
 
            except KeyError:
1894
 
                uid = 65534
1895
 
                gid = 65534
 
2467
            continue
 
2468
    else:
 
2469
        uid = 65534
 
2470
        gid = 65534
1896
2471
    try:
1897
2472
        os.setgid(gid)
1898
2473
        os.setuid(uid)
1899
2474
    except OSError as error:
1900
 
        if error[0] != errno.EPERM:
1901
 
            raise error
 
2475
        if error.errno != errno.EPERM:
 
2476
            raise
1902
2477
    
1903
 
    if not debug and not debuglevel:
1904
 
        syslogger.setLevel(logging.WARNING)
1905
 
        console.setLevel(logging.WARNING)
1906
 
    if debuglevel:
1907
 
        level = getattr(logging, debuglevel.upper())
1908
 
        syslogger.setLevel(level)
1909
 
        console.setLevel(level)
1910
 
 
1911
2478
    if debug:
1912
2479
        # Enable all possible GnuTLS debugging
1913
2480
        
1923
2490
         .gnutls_global_set_log_function(debug_gnutls))
1924
2491
        
1925
2492
        # Redirect stdin so all checkers get /dev/null
1926
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2493
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1927
2494
        os.dup2(null, sys.stdin.fileno())
1928
2495
        if null > 2:
1929
2496
            os.close(null)
1930
 
    else:
1931
 
        # No console logging
1932
 
        logger.removeHandler(console)
1933
2497
    
1934
2498
    # Need to fork before connecting to D-Bus
1935
 
    if not debug:
 
2499
    if not foreground:
1936
2500
        # Close all input and output, do double fork, etc.
1937
2501
        daemon()
1938
2502
    
 
2503
    # multiprocessing will use threads, so before we use gobject we
 
2504
    # need to inform gobject that threads will be used.
 
2505
    gobject.threads_init()
 
2506
    
1939
2507
    global main_loop
1940
2508
    # From the Avahi example code
1941
 
    DBusGMainLoop(set_as_default=True )
 
2509
    DBusGMainLoop(set_as_default=True)
1942
2510
    main_loop = gobject.MainLoop()
1943
2511
    bus = dbus.SystemBus()
1944
2512
    # End of Avahi example code
1945
2513
    if use_dbus:
1946
2514
        try:
1947
 
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
 
2515
            bus_name = dbus.service.BusName("se.recompile.Mandos",
1948
2516
                                            bus, do_not_queue=True)
 
2517
            old_bus_name = (dbus.service.BusName
 
2518
                            ("se.bsnet.fukt.Mandos", bus,
 
2519
                             do_not_queue=True))
1949
2520
        except dbus.exceptions.NameExistsException as e:
1950
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2521
            logger.error("Disabling D-Bus:", exc_info=e)
1951
2522
            use_dbus = False
1952
2523
            server_settings["use_dbus"] = False
1953
2524
            tcp_server.use_dbus = False
1954
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1955
 
    service = AvahiService(name = server_settings["servicename"],
1956
 
                           servicetype = "_mandos._tcp",
1957
 
                           protocol = protocol, bus = bus)
1958
 
    if server_settings["interface"]:
1959
 
        service.interface = (if_nametoindex
1960
 
                             (str(server_settings["interface"])))
 
2525
    if zeroconf:
 
2526
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2527
        service = AvahiServiceToSyslog(name =
 
2528
                                       server_settings["servicename"],
 
2529
                                       servicetype = "_mandos._tcp",
 
2530
                                       protocol = protocol, bus = bus)
 
2531
        if server_settings["interface"]:
 
2532
            service.interface = (if_nametoindex
 
2533
                                 (server_settings["interface"]
 
2534
                                  .encode("utf-8")))
1961
2535
    
1962
2536
    global multiprocessing_manager
1963
2537
    multiprocessing_manager = multiprocessing.Manager()
1965
2539
    client_class = Client
1966
2540
    if use_dbus:
1967
2541
        client_class = functools.partial(ClientDBus, bus = bus)
1968
 
    def client_config_items(config, section):
1969
 
        special_settings = {
1970
 
            "approved_by_default":
1971
 
                lambda: config.getboolean(section,
1972
 
                                          "approved_by_default"),
1973
 
            }
1974
 
        for name, value in config.items(section):
 
2542
    
 
2543
    client_settings = Client.config_parser(client_config)
 
2544
    old_client_settings = {}
 
2545
    clients_data = {}
 
2546
    
 
2547
    # This is used to redirect stdout and stderr for checker processes
 
2548
    global wnull
 
2549
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2550
    # Only used if server is running in foreground but not in debug
 
2551
    # mode
 
2552
    if debug or not foreground:
 
2553
        wnull.close()
 
2554
    
 
2555
    # Get client data and settings from last running state.
 
2556
    if server_settings["restore"]:
 
2557
        try:
 
2558
            with open(stored_state_path, "rb") as stored_state:
 
2559
                clients_data, old_client_settings = (pickle.load
 
2560
                                                     (stored_state))
 
2561
            os.remove(stored_state_path)
 
2562
        except IOError as e:
 
2563
            if e.errno == errno.ENOENT:
 
2564
                logger.warning("Could not load persistent state: {}"
 
2565
                                .format(os.strerror(e.errno)))
 
2566
            else:
 
2567
                logger.critical("Could not load persistent state:",
 
2568
                                exc_info=e)
 
2569
                raise
 
2570
        except EOFError as e:
 
2571
            logger.warning("Could not load persistent state: "
 
2572
                           "EOFError:", exc_info=e)
 
2573
    
 
2574
    with PGPEngine() as pgp:
 
2575
        for client_name, client in clients_data.items():
 
2576
            # Skip removed clients
 
2577
            if client_name not in client_settings:
 
2578
                continue
 
2579
            
 
2580
            # Decide which value to use after restoring saved state.
 
2581
            # We have three different values: Old config file,
 
2582
            # new config file, and saved state.
 
2583
            # New config value takes precedence if it differs from old
 
2584
            # config value, otherwise use saved state.
 
2585
            for name, value in client_settings[client_name].items():
 
2586
                try:
 
2587
                    # For each value in new config, check if it
 
2588
                    # differs from the old config value (Except for
 
2589
                    # the "secret" attribute)
 
2590
                    if (name != "secret" and
 
2591
                        value != old_client_settings[client_name]
 
2592
                        [name]):
 
2593
                        client[name] = value
 
2594
                except KeyError:
 
2595
                    pass
 
2596
            
 
2597
            # Clients who has passed its expire date can still be
 
2598
            # enabled if its last checker was successful.  Clients
 
2599
            # whose checker succeeded before we stored its state is
 
2600
            # assumed to have successfully run all checkers during
 
2601
            # downtime.
 
2602
            if client["enabled"]:
 
2603
                if datetime.datetime.utcnow() >= client["expires"]:
 
2604
                    if not client["last_checked_ok"]:
 
2605
                        logger.warning(
 
2606
                            "disabling client {} - Client never "
 
2607
                            "performed a successful checker"
 
2608
                            .format(client_name))
 
2609
                        client["enabled"] = False
 
2610
                    elif client["last_checker_status"] != 0:
 
2611
                        logger.warning(
 
2612
                            "disabling client {} - Client last"
 
2613
                            " checker failed with error code {}"
 
2614
                            .format(client_name,
 
2615
                                    client["last_checker_status"]))
 
2616
                        client["enabled"] = False
 
2617
                    else:
 
2618
                        client["expires"] = (datetime.datetime
 
2619
                                             .utcnow()
 
2620
                                             + client["timeout"])
 
2621
                        logger.debug("Last checker succeeded,"
 
2622
                                     " keeping {} enabled"
 
2623
                                     .format(client_name))
1975
2624
            try:
1976
 
                yield (name, special_settings[name]())
1977
 
            except KeyError:
1978
 
                yield (name, value)
1979
 
    
1980
 
    tcp_server.clients.update(set(
1981
 
            client_class(name = section,
1982
 
                         config= dict(client_config_items(
1983
 
                        client_config, section)))
1984
 
            for section in client_config.sections()))
 
2625
                client["secret"] = (
 
2626
                    pgp.decrypt(client["encrypted_secret"],
 
2627
                                client_settings[client_name]
 
2628
                                ["secret"]))
 
2629
            except PGPError:
 
2630
                # If decryption fails, we use secret from new settings
 
2631
                logger.debug("Failed to decrypt {} old secret"
 
2632
                             .format(client_name))
 
2633
                client["secret"] = (
 
2634
                    client_settings[client_name]["secret"])
 
2635
    
 
2636
    # Add/remove clients based on new changes made to config
 
2637
    for client_name in (set(old_client_settings)
 
2638
                        - set(client_settings)):
 
2639
        del clients_data[client_name]
 
2640
    for client_name in (set(client_settings)
 
2641
                        - set(old_client_settings)):
 
2642
        clients_data[client_name] = client_settings[client_name]
 
2643
    
 
2644
    # Create all client objects
 
2645
    for client_name, client in clients_data.items():
 
2646
        tcp_server.clients[client_name] = client_class(
 
2647
            name = client_name, settings = client,
 
2648
            server_settings = server_settings)
 
2649
    
1985
2650
    if not tcp_server.clients:
1986
2651
        logger.warning("No clients defined")
1987
 
        
1988
 
    if not debug:
1989
 
        try:
1990
 
            with pidfile:
1991
 
                pid = os.getpid()
1992
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
1993
 
            del pidfile
1994
 
        except IOError:
1995
 
            logger.error("Could not write to file %r with PID %d",
1996
 
                         pidfilename, pid)
1997
 
        except NameError:
1998
 
            # "pidfile" was never created
1999
 
            pass
 
2652
    
 
2653
    if not foreground:
 
2654
        if pidfile is not None:
 
2655
            try:
 
2656
                with pidfile:
 
2657
                    pid = os.getpid()
 
2658
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
 
2659
            except IOError:
 
2660
                logger.error("Could not write to file %r with PID %d",
 
2661
                             pidfilename, pid)
 
2662
        del pidfile
2000
2663
        del pidfilename
2001
 
        
2002
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2003
 
 
 
2664
    
2004
2665
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2005
2666
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2006
2667
    
2007
2668
    if use_dbus:
2008
 
        class MandosDBusService(dbus.service.Object):
 
2669
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2670
                                        "se.bsnet.fukt.Mandos"})
 
2671
        class MandosDBusService(DBusObjectWithProperties):
2009
2672
            """A D-Bus proxy object"""
2010
2673
            def __init__(self):
2011
2674
                dbus.service.Object.__init__(self, bus, "/")
2012
 
            _interface = "se.bsnet.fukt.Mandos"
 
2675
            _interface = "se.recompile.Mandos"
 
2676
            
 
2677
            @dbus_interface_annotations(_interface)
 
2678
            def _foo(self):
 
2679
                return { "org.freedesktop.DBus.Property"
 
2680
                         ".EmitsChangedSignal":
 
2681
                             "false"}
2013
2682
            
2014
2683
            @dbus.service.signal(_interface, signature="o")
2015
2684
            def ClientAdded(self, objpath):
2030
2699
            def GetAllClients(self):
2031
2700
                "D-Bus method"
2032
2701
                return dbus.Array(c.dbus_object_path
2033
 
                                  for c in tcp_server.clients)
 
2702
                                  for c in
 
2703
                                  tcp_server.clients.itervalues())
2034
2704
            
2035
2705
            @dbus.service.method(_interface,
2036
2706
                                 out_signature="a{oa{sv}}")
2038
2708
                "D-Bus method"
2039
2709
                return dbus.Dictionary(
2040
2710
                    ((c.dbus_object_path, c.GetAll(""))
2041
 
                     for c in tcp_server.clients),
 
2711
                     for c in tcp_server.clients.itervalues()),
2042
2712
                    signature="oa{sv}")
2043
2713
            
2044
2714
            @dbus.service.method(_interface, in_signature="o")
2045
2715
            def RemoveClient(self, object_path):
2046
2716
                "D-Bus method"
2047
 
                for c in tcp_server.clients:
 
2717
                for c in tcp_server.clients.itervalues():
2048
2718
                    if c.dbus_object_path == object_path:
2049
 
                        tcp_server.clients.remove(c)
 
2719
                        del tcp_server.clients[c.name]
2050
2720
                        c.remove_from_connection()
2051
2721
                        # Don't signal anything except ClientRemoved
2052
2722
                        c.disable(quiet=True)
2061
2731
    
2062
2732
    def cleanup():
2063
2733
        "Cleanup function; run on exit"
2064
 
        service.cleanup()
2065
 
        
 
2734
        if zeroconf:
 
2735
            service.cleanup()
 
2736
        
 
2737
        multiprocessing.active_children()
 
2738
        wnull.close()
 
2739
        if not (tcp_server.clients or client_settings):
 
2740
            return
 
2741
        
 
2742
        # Store client before exiting. Secrets are encrypted with key
 
2743
        # based on what config file has. If config file is
 
2744
        # removed/edited, old secret will thus be unrecovable.
 
2745
        clients = {}
 
2746
        with PGPEngine() as pgp:
 
2747
            for client in tcp_server.clients.itervalues():
 
2748
                key = client_settings[client.name]["secret"]
 
2749
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2750
                                                      key)
 
2751
                client_dict = {}
 
2752
                
 
2753
                # A list of attributes that can not be pickled
 
2754
                # + secret.
 
2755
                exclude = { "bus", "changedstate", "secret",
 
2756
                            "checker", "server_settings" }
 
2757
                for name, typ in (inspect.getmembers
 
2758
                                  (dbus.service.Object)):
 
2759
                    exclude.add(name)
 
2760
                
 
2761
                client_dict["encrypted_secret"] = (client
 
2762
                                                   .encrypted_secret)
 
2763
                for attr in client.client_structure:
 
2764
                    if attr not in exclude:
 
2765
                        client_dict[attr] = getattr(client, attr)
 
2766
                
 
2767
                clients[client.name] = client_dict
 
2768
                del client_settings[client.name]["secret"]
 
2769
        
 
2770
        try:
 
2771
            with (tempfile.NamedTemporaryFile
 
2772
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2773
                   dir=os.path.dirname(stored_state_path),
 
2774
                   delete=False)) as stored_state:
 
2775
                pickle.dump((clients, client_settings), stored_state)
 
2776
                tempname=stored_state.name
 
2777
            os.rename(tempname, stored_state_path)
 
2778
        except (IOError, OSError) as e:
 
2779
            if not debug:
 
2780
                try:
 
2781
                    os.remove(tempname)
 
2782
                except NameError:
 
2783
                    pass
 
2784
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2785
                logger.warning("Could not save persistent state: {}"
 
2786
                               .format(os.strerror(e.errno)))
 
2787
            else:
 
2788
                logger.warning("Could not save persistent state:",
 
2789
                               exc_info=e)
 
2790
                raise
 
2791
        
 
2792
        # Delete all clients, and settings from config
2066
2793
        while tcp_server.clients:
2067
 
            client = tcp_server.clients.pop()
 
2794
            name, client = tcp_server.clients.popitem()
2068
2795
            if use_dbus:
2069
2796
                client.remove_from_connection()
2070
 
            client.disable_hook = None
2071
2797
            # Don't signal anything except ClientRemoved
2072
2798
            client.disable(quiet=True)
2073
2799
            if use_dbus:
2074
2800
                # Emit D-Bus signal
2075
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2801
                mandos_dbus_service.ClientRemoved(client
 
2802
                                                  .dbus_object_path,
2076
2803
                                                  client.name)
 
2804
        client_settings.clear()
2077
2805
    
2078
2806
    atexit.register(cleanup)
2079
2807
    
2080
 
    for client in tcp_server.clients:
 
2808
    for client in tcp_server.clients.itervalues():
2081
2809
        if use_dbus:
2082
2810
            # Emit D-Bus signal
2083
2811
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2084
 
        client.enable()
 
2812
        # Need to initiate checking of clients
 
2813
        if client.enabled:
 
2814
            client.init_checker()
2085
2815
    
2086
2816
    tcp_server.enable()
2087
2817
    tcp_server.server_activate()
2088
2818
    
2089
2819
    # Find out what port we got
2090
 
    service.port = tcp_server.socket.getsockname()[1]
 
2820
    if zeroconf:
 
2821
        service.port = tcp_server.socket.getsockname()[1]
2091
2822
    if use_ipv6:
2092
2823
        logger.info("Now listening on address %r, port %d,"
2093
 
                    " flowinfo %d, scope_id %d"
2094
 
                    % tcp_server.socket.getsockname())
 
2824
                    " flowinfo %d, scope_id %d",
 
2825
                    *tcp_server.socket.getsockname())
2095
2826
    else:                       # IPv4
2096
 
        logger.info("Now listening on address %r, port %d"
2097
 
                    % tcp_server.socket.getsockname())
 
2827
        logger.info("Now listening on address %r, port %d",
 
2828
                    *tcp_server.socket.getsockname())
2098
2829
    
2099
2830
    #service.interface = tcp_server.socket.getsockname()[3]
2100
2831
    
2101
2832
    try:
2102
 
        # From the Avahi example code
2103
 
        try:
2104
 
            service.activate()
2105
 
        except dbus.exceptions.DBusException as error:
2106
 
            logger.critical("DBusException: %s", error)
2107
 
            cleanup()
2108
 
            sys.exit(1)
2109
 
        # End of Avahi example code
 
2833
        if zeroconf:
 
2834
            # From the Avahi example code
 
2835
            try:
 
2836
                service.activate()
 
2837
            except dbus.exceptions.DBusException as error:
 
2838
                logger.critical("D-Bus Exception", exc_info=error)
 
2839
                cleanup()
 
2840
                sys.exit(1)
 
2841
            # End of Avahi example code
2110
2842
        
2111
2843
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2112
2844
                             lambda *args, **kwargs:
2116
2848
        logger.debug("Starting main loop")
2117
2849
        main_loop.run()
2118
2850
    except AvahiError as error:
2119
 
        logger.critical("AvahiError: %s", error)
 
2851
        logger.critical("Avahi Error", exc_info=error)
2120
2852
        cleanup()
2121
2853
        sys.exit(1)
2122
2854
    except KeyboardInterrupt: