/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-08-09 13:12:55 UTC
  • Revision ID: teddy@recompile.se-20140809131255-lp31j98u2pl0xpe6
mandos: Stop using str() and remove unnecessary unicode() calls.

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

Show diffs side-by-side

added added

removed removed

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