/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-12-21 12:56:08 UTC
  • Revision ID: teddy@recompile.se-20141221125608-bmkvujlj39srpwd3
mandos-keygen: Fix some stylistic quoting issues.

Show diffs side-by-side

added added

removed removed

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