/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-08-09 13:18:46 UTC
  • mto: (237.7.304 trunk)
  • mto: This revision was merged to the branch mainline in revision 323.
  • Revision ID: teddy@recompile.se-20140809131846-2emd272mf9c9wihe
mandos: Replace unicode() with str().

This is in preparation for the coming Python 3 conversion.

* mandos: Replace "str" with "unicode".  All callers changed.

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