/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: 2015-03-10 18:03:38 UTC
  • Revision ID: teddy@recompile.se-20150310180338-pcxw6r2qmw9k6br9
Add ":!RSA" to GnuTLS priority string, to disallow non-DHE kx.

If Mandos was somehow made to use a non-ephemeral Diffie-Hellman key
exchange algorithm in the TLS handshake, any saved network traffic
could then be decrypted later if the Mandos client key was obtained.
By default, Mandos uses ephemeral DH key exchanges which does not have
this problem, but a non-ephemeral key exchange algorithm was still
enabled by default.  The simplest solution is to simply turn that off,
which ensures that Mandos will always use ephemeral DH key exchanges.

There is a "PFS" priority string specifier, but we can't use it because:

1. Security-wise, it is a mix between "NORMAL" and "SECURE128" - it
   enables a lot more algorithms than "SECURE256".

2. It is only available since GnuTLS 3.2.4.

Thanks to Andreas Fischer <af@bantuX.org> for reporting this issue.

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
 
import optparse
 
41
import argparse
40
42
import datetime
41
43
import errno
42
44
import gnutls.crypto
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.2.3"
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,
151
273
        self.group = None       # our entry group
152
274
        self.server = None
153
275
        self.bus = bus
154
 
    def rename(self):
 
276
        self.entry_group_state_changed_match = None
 
277
    
 
278
    def rename(self, remove=True):
155
279
        """Derived from the Avahi example code"""
156
280
        if self.rename_count >= self.max_renames:
157
281
            logger.critical("No suitable Zeroconf service name found"
158
282
                            " after %i retries, exiting.",
159
283
                            self.rename_count)
160
284
            raise AvahiServiceError("Too many renames")
161
 
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
 
285
        self.name = str(self.server
 
286
                        .GetAlternativeServiceName(self.name))
 
287
        self.rename_count += 1
162
288
        logger.info("Changing Zeroconf service name to %r ...",
163
289
                    self.name)
164
 
        syslogger.setFormatter(logging.Formatter
165
 
                               ('Mandos (%s) [%%(process)d]:'
166
 
                                ' %%(levelname)s: %%(message)s'
167
 
                                % self.name))
168
 
        self.remove()
 
290
        if remove:
 
291
            self.remove()
169
292
        try:
170
293
            self.add()
171
 
        except dbus.exceptions.DBusException, error:
172
 
            logger.critical("DBusException: %s", error)
173
 
            self.cleanup()
174
 
            os._exit(1)
175
 
        self.rename_count += 1
 
294
        except dbus.exceptions.DBusException as error:
 
295
            if (error.get_dbus_name()
 
296
                == "org.freedesktop.Avahi.CollisionError"):
 
297
                logger.info("Local Zeroconf service name collision.")
 
298
                return self.rename(remove=False)
 
299
            else:
 
300
                logger.critical("D-Bus Exception", exc_info=error)
 
301
                self.cleanup()
 
302
                os._exit(1)
 
303
    
176
304
    def remove(self):
177
305
        """Derived from the Avahi example code"""
 
306
        if self.entry_group_state_changed_match is not None:
 
307
            self.entry_group_state_changed_match.remove()
 
308
            self.entry_group_state_changed_match = None
178
309
        if self.group is not None:
179
310
            self.group.Reset()
 
311
    
180
312
    def add(self):
181
313
        """Derived from the Avahi example code"""
 
314
        self.remove()
182
315
        if self.group is None:
183
316
            self.group = dbus.Interface(
184
317
                self.bus.get_object(avahi.DBUS_NAME,
185
318
                                    self.server.EntryGroupNew()),
186
319
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
187
 
            self.group.connect_to_signal('StateChanged',
188
 
                                         self
189
 
                                         .entry_group_state_changed)
 
320
        self.entry_group_state_changed_match = (
 
321
            self.group.connect_to_signal(
 
322
                'StateChanged', self.entry_group_state_changed))
190
323
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
191
324
                     self.name, self.type)
192
325
        self.group.AddService(
198
331
            dbus.UInt16(self.port),
199
332
            avahi.string_array_to_txt_array(self.TXT))
200
333
        self.group.Commit()
 
334
    
201
335
    def entry_group_state_changed(self, state, error):
202
336
        """Derived from the Avahi example code"""
203
337
        logger.debug("Avahi entry group state change: %i", state)
209
343
            self.rename()
210
344
        elif state == avahi.ENTRY_GROUP_FAILURE:
211
345
            logger.critical("Avahi: Error in group state changed %s",
212
 
                            unicode(error))
213
 
            raise AvahiGroupError("State changed: %s"
214
 
                                  % unicode(error))
 
346
                            str(error))
 
347
            raise AvahiGroupError("State changed: {!s}"
 
348
                                  .format(error))
 
349
    
215
350
    def cleanup(self):
216
351
        """Derived from the Avahi example code"""
217
352
        if self.group is not None:
218
 
            self.group.Free()
 
353
            try:
 
354
                self.group.Free()
 
355
            except (dbus.exceptions.UnknownMethodException,
 
356
                    dbus.exceptions.DBusException):
 
357
                pass
219
358
            self.group = None
220
 
    def server_state_changed(self, state):
 
359
        self.remove()
 
360
    
 
361
    def server_state_changed(self, state, error=None):
221
362
        """Derived from the Avahi example code"""
222
363
        logger.debug("Avahi server state change: %i", state)
223
 
        if state == avahi.SERVER_COLLISION:
224
 
            logger.error("Zeroconf server name collision")
225
 
            self.remove()
 
364
        bad_states = { avahi.SERVER_INVALID:
 
365
                           "Zeroconf server invalid",
 
366
                       avahi.SERVER_REGISTERING: None,
 
367
                       avahi.SERVER_COLLISION:
 
368
                           "Zeroconf server name collision",
 
369
                       avahi.SERVER_FAILURE:
 
370
                           "Zeroconf server failure" }
 
371
        if state in bad_states:
 
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()
226
378
        elif state == avahi.SERVER_RUNNING:
227
379
            self.add()
 
380
        else:
 
381
            if error is None:
 
382
                logger.debug("Unknown state: %r", state)
 
383
            else:
 
384
                logger.debug("Unknown state: %r: %r", state, error)
 
385
    
228
386
    def activate(self):
229
387
        """Derived from the Avahi example code"""
230
388
        if self.server is None:
231
389
            self.server = dbus.Interface(
232
390
                self.bus.get_object(avahi.DBUS_NAME,
233
 
                                    avahi.DBUS_PATH_SERVER),
 
391
                                    avahi.DBUS_PATH_SERVER,
 
392
                                    follow_name_owner_changes=True),
234
393
                avahi.DBUS_INTERFACE_SERVER)
235
394
        self.server.connect_to_signal("StateChanged",
236
395
                                 self.server_state_changed)
237
396
        self.server_state_changed(self.server.GetState())
238
397
 
239
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
 
240
410
class Client(object):
241
411
    """A representation of a client host served by this server.
242
412
    
243
413
    Attributes:
244
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
414
    approved:   bool(); 'None' if not yet approved/disapproved
245
415
    approval_delay: datetime.timedelta(); Time to wait for approval
246
416
    approval_duration: datetime.timedelta(); Duration of one approval
247
417
    checker:    subprocess.Popen(); a running checker process used
254
424
                     instance %(name)s can be used in the command.
255
425
    checker_initiator_tag: a gobject event source tag, or None
256
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
257
429
    current_checker_command: string; current running checker_command
258
 
    disable_hook:  If set, called by disable() as disable_hook(self)
259
430
    disable_initiator_tag: a gobject event source tag, or None
260
431
    enabled:    bool()
261
432
    fingerprint: string (40 or 32 hexadecimal digits); used to
264
435
    interval:   datetime.timedelta(); How often to start a new checker
265
436
    last_approval_request: datetime.datetime(); (UTC) or None
266
437
    last_checked_ok: datetime.datetime(); (UTC) or None
267
 
    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
268
442
    name:       string; from the config file, used in log messages and
269
443
                        D-Bus identifiers
270
444
    secret:     bytestring; sent verbatim (over TLS) to client
271
445
    timeout:    datetime.timedelta(); How long from last_checked_ok
272
446
                                      until this client is disabled
 
447
    extended_timeout:   extra long timeout when secret has been sent
273
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()
274
452
    """
275
453
    
276
454
    runtime_expansions = ("approval_delay", "approval_duration",
277
 
                          "created", "enabled", "fingerprint",
278
 
                          "host", "interval", "last_checked_ok",
 
455
                          "created", "enabled", "expires",
 
456
                          "fingerprint", "host", "interval",
 
457
                          "last_approval_request", "last_checked_ok",
279
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
                        }
280
469
    
281
470
    @staticmethod
282
 
    def _timedelta_to_milliseconds(td):
283
 
        "Convert a datetime.timedelta() to milliseconds"
284
 
        return ((td.days * 24 * 60 * 60 * 1000)
285
 
                + (td.seconds * 1000)
286
 
                + (td.microseconds // 1000))
287
 
    
288
 
    def timeout_milliseconds(self):
289
 
        "Return the 'timeout' attribute in milliseconds"
290
 
        return self._timedelta_to_milliseconds(self.timeout)
291
 
    
292
 
    def interval_milliseconds(self):
293
 
        "Return the 'interval' attribute in milliseconds"
294
 
        return self._timedelta_to_milliseconds(self.interval)
295
 
 
296
 
    def approval_delay_milliseconds(self):
297
 
        return self._timedelta_to_milliseconds(self.approval_delay)
298
 
    
299
 
    def __init__(self, name = None, disable_hook=None, config=None):
300
 
        """Note: the 'checker' key in 'config' sets the
301
 
        'checker_command' attribute and *not* the 'checker'
302
 
        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):
303
521
        self.name = name
304
 
        if config is None:
305
 
            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
        
306
539
        logger.debug("Creating client %r", self.name)
307
 
        # Uppercase and remove spaces from fingerprint for later
308
 
        # comparison purposes with return value from the fingerprint()
309
 
        # function
310
 
        self.fingerprint = (config["fingerprint"].upper()
311
 
                            .replace(" ", ""))
312
540
        logger.debug("  Fingerprint: %s", self.fingerprint)
313
 
        if "secret" in config:
314
 
            self.secret = config["secret"].decode("base64")
315
 
        elif "secfile" in config:
316
 
            with open(os.path.expanduser(os.path.expandvars
317
 
                                         (config["secfile"])),
318
 
                      "rb") as secfile:
319
 
                self.secret = secfile.read()
320
 
        else:
321
 
            raise TypeError("No secret or secfile for client %s"
322
 
                            % self.name)
323
 
        self.host = config.get("host", "")
324
 
        self.created = datetime.datetime.utcnow()
325
 
        self.enabled = False
326
 
        self.last_approval_request = None
327
 
        self.last_enabled = None
328
 
        self.last_checked_ok = None
329
 
        self.timeout = string_to_delta(config["timeout"])
330
 
        self.interval = string_to_delta(config["interval"])
331
 
        self.disable_hook = disable_hook
 
541
        self.created = settings.get("created",
 
542
                                    datetime.datetime.utcnow())
 
543
        
 
544
        # attributes specific for this server instance
332
545
        self.checker = None
333
546
        self.checker_initiator_tag = None
334
547
        self.disable_initiator_tag = None
335
548
        self.checker_callback_tag = None
336
 
        self.checker_command = config["checker"]
337
549
        self.current_checker_command = None
338
 
        self.last_connect = None
339
 
        self._approved = None
340
 
        self.approved_by_default = config.get("approved_by_default",
341
 
                                              True)
 
550
        self.approved = None
342
551
        self.approvals_pending = 0
343
 
        self.approval_delay = string_to_delta(
344
 
            config["approval_delay"])
345
 
        self.approval_duration = string_to_delta(
346
 
            config["approval_duration"])
347
 
        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)
348
566
    
 
567
    # Send notice to process children that client state has changed
349
568
    def send_changedstate(self):
350
 
        self.changedstate.acquire()
351
 
        self.changedstate.notify_all()
352
 
        self.changedstate.release()
353
 
        
 
569
        with self.changedstate:
 
570
            self.changedstate.notify_all()
 
571
    
354
572
    def enable(self):
355
573
        """Start this client's checker and timeout hooks"""
356
574
        if getattr(self, "enabled", False):
357
575
            # Already enabled
358
576
            return
359
 
        self.send_changedstate()
 
577
        self.expires = datetime.datetime.utcnow() + self.timeout
 
578
        self.enabled = True
360
579
        self.last_enabled = datetime.datetime.utcnow()
361
 
        # Schedule a new checker to be started an 'interval' from now,
362
 
        # and every interval from then on.
363
 
        self.checker_initiator_tag = (gobject.timeout_add
364
 
                                      (self.interval_milliseconds(),
365
 
                                       self.start_checker))
366
 
        # Schedule a disable() when 'timeout' has passed
367
 
        self.disable_initiator_tag = (gobject.timeout_add
368
 
                                   (self.timeout_milliseconds(),
369
 
                                    self.disable))
370
 
        self.enabled = True
371
 
        # Also start a new checker *right now*.
372
 
        self.start_checker()
 
580
        self.init_checker()
 
581
        self.send_changedstate()
373
582
    
374
583
    def disable(self, quiet=True):
375
584
        """Disable this client."""
376
585
        if not getattr(self, "enabled", False):
377
586
            return False
378
587
        if not quiet:
379
 
            self.send_changedstate()
380
 
        if not quiet:
381
588
            logger.info("Disabling client %s", self.name)
382
 
        if getattr(self, "disable_initiator_tag", False):
 
589
        if getattr(self, "disable_initiator_tag", None) is not None:
383
590
            gobject.source_remove(self.disable_initiator_tag)
384
591
            self.disable_initiator_tag = None
385
 
        if getattr(self, "checker_initiator_tag", False):
 
592
        self.expires = None
 
593
        if getattr(self, "checker_initiator_tag", None) is not None:
386
594
            gobject.source_remove(self.checker_initiator_tag)
387
595
            self.checker_initiator_tag = None
388
596
        self.stop_checker()
389
 
        if self.disable_hook:
390
 
            self.disable_hook(self)
391
597
        self.enabled = False
 
598
        if not quiet:
 
599
            self.send_changedstate()
392
600
        # Do not run this again if called by a gobject.timeout_add
393
601
        return False
394
602
    
395
603
    def __del__(self):
396
 
        self.disable_hook = None
397
604
        self.disable()
398
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
    
399
625
    def checker_callback(self, pid, condition, command):
400
626
        """The checker has completed, so take appropriate actions."""
401
627
        self.checker_callback_tag = None
402
628
        self.checker = None
403
629
        if os.WIFEXITED(condition):
404
 
            exitstatus = os.WEXITSTATUS(condition)
405
 
            if exitstatus == 0:
 
630
            self.last_checker_status = os.WEXITSTATUS(condition)
 
631
            if self.last_checker_status == 0:
406
632
                logger.info("Checker for %(name)s succeeded",
407
633
                            vars(self))
408
634
                self.checked_ok()
410
636
                logger.info("Checker for %(name)s failed",
411
637
                            vars(self))
412
638
        else:
 
639
            self.last_checker_status = -1
413
640
            logger.warning("Checker for %(name)s crashed?",
414
641
                           vars(self))
415
642
    
416
643
    def checked_ok(self):
417
 
        """Bump up the timeout for this client.
418
 
        
419
 
        This should only be called when the client has been seen,
420
 
        alive and well.
421
 
        """
 
644
        """Assert that the client has been seen, alive and well."""
422
645
        self.last_checked_ok = datetime.datetime.utcnow()
423
 
        gobject.source_remove(self.disable_initiator_tag)
424
 
        self.disable_initiator_tag = (gobject.timeout_add
425
 
                                      (self.timeout_milliseconds(),
426
 
                                       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
427
661
    
428
662
    def need_approval(self):
429
663
        self.last_approval_request = datetime.datetime.utcnow()
434
668
        If a checker already exists, leave it running and do
435
669
        nothing."""
436
670
        # The reason for not killing a running checker is that if we
437
 
        # did that, then if a checker (for some reason) started
438
 
        # running slowly and taking more than 'interval' time, the
439
 
        # client would inevitably timeout, since no checker would get
440
 
        # 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
441
675
        # checkers alone, the checker would have to take more time
442
676
        # than 'timeout' for the client to be disabled, which is as it
443
677
        # should be.
445
679
        # If a checker exists, make sure it is not a zombie
446
680
        try:
447
681
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
448
 
        except (AttributeError, OSError), error:
449
 
            if (isinstance(error, OSError)
450
 
                and error.errno != errno.ECHILD):
451
 
                raise error
 
682
        except AttributeError:
 
683
            pass
 
684
        except OSError as error:
 
685
            if error.errno != errno.ECHILD:
 
686
                raise
452
687
        else:
453
688
            if pid:
454
689
                logger.warning("Checker was a zombie")
457
692
                                      self.current_checker_command)
458
693
        # Start a new checker if needed
459
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 }
460
699
            try:
461
 
                # In case checker_command has exactly one % operator
462
 
                command = self.checker_command % self.host
463
 
            except TypeError:
464
 
                # Escape attributes for the shell
465
 
                escaped_attrs = dict(
466
 
                    (attr,
467
 
                     re.escape(unicode(str(getattr(self, attr, "")),
468
 
                                       errors=
469
 
                                       'replace')))
470
 
                    for attr in
471
 
                    self.runtime_expansions)
472
 
 
473
 
                try:
474
 
                    command = self.checker_command % escaped_attrs
475
 
                except TypeError, error:
476
 
                    logger.error('Could not format string "%s":'
477
 
                                 ' %s', self.checker_command, error)
478
 
                    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
479
705
            self.current_checker_command = command
480
706
            try:
481
707
                logger.info("Starting checker %r for %s",
484
710
                # in normal mode, that is already done by daemon(),
485
711
                # and in debug mode we don't want to.  (Stdin is
486
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 })
487
721
                self.checker = subprocess.Popen(command,
488
722
                                                close_fds=True,
489
 
                                                shell=True, cwd="/")
490
 
                self.checker_callback_tag = (gobject.child_watch_add
491
 
                                             (self.checker.pid,
492
 
                                              self.checker_callback,
493
 
                                              data=command))
494
 
                # The checker may have completed before the gobject
495
 
                # 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:
496
736
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
497
 
                if pid:
498
 
                    gobject.source_remove(self.checker_callback_tag)
499
 
                    self.checker_callback(pid, status, command)
500
 
            except OSError, error:
501
 
                logger.error("Failed to start subprocess: %s",
502
 
                             error)
 
737
            except OSError as error:
 
738
                if error.errno == errno.ECHILD:
 
739
                    # This should never happen
 
740
                    logger.error("Child process vanished",
 
741
                                 exc_info=error)
 
742
                    return True
 
743
                raise
 
744
            if pid:
 
745
                gobject.source_remove(self.checker_callback_tag)
 
746
                self.checker_callback(pid, status, command)
503
747
        # Re-run this periodically if run by gobject.timeout_add
504
748
        return True
505
749
    
512
756
            return
513
757
        logger.debug("Stopping checker for %(name)s", vars(self))
514
758
        try:
515
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
759
            self.checker.terminate()
516
760
            #time.sleep(0.5)
517
761
            #if self.checker.poll() is None:
518
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
519
 
        except OSError, error:
 
762
            #    self.checker.kill()
 
763
        except OSError as error:
520
764
            if error.errno != errno.ESRCH: # No such process
521
765
                raise
522
766
        self.checker = None
523
767
 
 
768
 
524
769
def dbus_service_property(dbus_interface, signature="v",
525
770
                          access="readwrite", byte_arrays=False):
526
771
    """Decorators for marking methods of a DBusObjectWithProperties to
537
782
    # "Set" method, so we fail early here:
538
783
    if byte_arrays and signature != "ay":
539
784
        raise ValueError("Byte arrays not supported for non-'ay'"
540
 
                         " signature %r" % signature)
 
785
                         " signature {!r}".format(signature))
541
786
    def decorator(func):
542
787
        func._dbus_is_property = True
543
788
        func._dbus_interface = dbus_interface
551
796
    return decorator
552
797
 
553
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
 
554
836
class DBusPropertyException(dbus.exceptions.DBusException):
555
837
    """A base class for D-Bus property-related exceptions
556
838
    """
557
 
    def __unicode__(self):
558
 
        return unicode(str(self))
559
 
 
 
839
    pass
560
840
 
561
841
class DBusPropertyAccessException(DBusPropertyException):
562
842
    """A property's access permissions disallows an operation.
572
852
 
573
853
class DBusObjectWithProperties(dbus.service.Object):
574
854
    """A D-Bus object with properties.
575
 
 
 
855
    
576
856
    Classes inheriting from this can use the dbus_service_property
577
857
    decorator to expose methods as D-Bus properties.  It exposes the
578
858
    standard Get(), Set(), and GetAll() methods on the D-Bus.
579
859
    """
580
860
    
581
861
    @staticmethod
582
 
    def _is_dbus_property(obj):
583
 
        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)
584
870
    
585
 
    def _get_all_dbus_properties(self):
 
871
    def _get_all_dbus_things(self, thing):
586
872
        """Returns a generator of (name, attribute) pairs
587
873
        """
588
 
        return ((prop._dbus_name, prop)
589
 
                for name, prop in
590
 
                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)))
591
881
    
592
882
    def _get_dbus_property(self, interface_name, property_name):
593
883
        """Returns a bound method if one exists which is a D-Bus
594
884
        property with the specified name and interface.
595
885
        """
596
 
        for name in (property_name,
597
 
                     property_name + "_dbus_property"):
598
 
            prop = getattr(self, name, None)
599
 
            if (prop is None
600
 
                or not self._is_dbus_property(prop)
601
 
                or prop._dbus_name != property_name
602
 
                or (interface_name and prop._dbus_interface
603
 
                    and interface_name != prop._dbus_interface)):
604
 
                continue
605
 
            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
        
606
894
        # No such property
607
895
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
608
896
                                   + interface_name + "."
632
920
            # The byte_arrays option is not supported yet on
633
921
            # signatures other than "ay".
634
922
            if prop._dbus_signature != "ay":
635
 
                raise ValueError
636
 
            value = dbus.ByteArray(''.join(unichr(byte)
637
 
                                           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))
638
928
        prop(value)
639
929
    
640
930
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
642
932
    def GetAll(self, interface_name):
643
933
        """Standard D-Bus property GetAll() method, see D-Bus
644
934
        standard.
645
 
 
 
935
        
646
936
        Note: Will not include properties with access="write".
647
937
        """
648
 
        all = {}
649
 
        for name, prop in self._get_all_dbus_properties():
 
938
        properties = {}
 
939
        for name, prop in self._get_all_dbus_things("property"):
650
940
            if (interface_name
651
941
                and interface_name != prop._dbus_interface):
652
942
                # Interface non-empty but did not match
656
946
                continue
657
947
            value = prop()
658
948
            if not hasattr(value, "variant_level"):
659
 
                all[name] = value
 
949
                properties[name] = value
660
950
                continue
661
 
            all[name] = type(value)(value, variant_level=
662
 
                                    value.variant_level+1)
663
 
        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
664
962
    
665
963
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
666
964
                         out_signature="s",
667
965
                         path_keyword='object_path',
668
966
                         connection_keyword='connection')
669
967
    def Introspect(self, object_path, connection):
670
 
        """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.
671
971
        """
672
972
        xmlstring = dbus.service.Object.Introspect(self, object_path,
673
973
                                                   connection)
680
980
                e.setAttribute("access", prop._dbus_access)
681
981
                return e
682
982
            for if_tag in document.getElementsByTagName("interface"):
 
983
                # Add property tags
683
984
                for tag in (make_tag(document, name, prop)
684
985
                            for name, prop
685
 
                            in self._get_all_dbus_properties()
 
986
                            in self._get_all_dbus_things("property")
686
987
                            if prop._dbus_interface
687
988
                            == if_tag.getAttribute("name")):
688
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)
689
1021
                # Add the names to the return values for the
690
1022
                # "org.freedesktop.DBus.Properties" methods
691
1023
                if (if_tag.getAttribute("name")
704
1036
            xmlstring = document.toxml("utf-8")
705
1037
            document.unlink()
706
1038
        except (AttributeError, xml.dom.DOMException,
707
 
                xml.parsers.expat.ExpatError), error:
 
1039
                xml.parsers.expat.ExpatError) as error:
708
1040
            logger.error("Failed to override Introspection method",
709
 
                         error)
 
1041
                         exc_info=error)
710
1042
        return xmlstring
711
1043
 
712
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"})
713
1224
class ClientDBus(Client, DBusObjectWithProperties):
714
1225
    """A Client class using D-Bus
715
1226
    
721
1232
    runtime_expansions = (Client.runtime_expansions
722
1233
                          + ("dbus_object_path",))
723
1234
    
 
1235
    _interface = "se.recompile.Mandos.Client"
 
1236
    
724
1237
    # dbus.service.Object doesn't use super(), so we can't either.
725
1238
    
726
1239
    def __init__(self, bus = None, *args, **kwargs):
727
 
        self._approvals_pending = 0
728
1240
        self.bus = bus
729
1241
        Client.__init__(self, *args, **kwargs)
730
1242
        # Only now, when this client is initialized, can it show up on
731
1243
        # the D-Bus
732
 
        client_object_name = unicode(self.name).translate(
 
1244
        client_object_name = str(self.name).translate(
733
1245
            {ord("."): ord("_"),
734
1246
             ord("-"): ord("_")})
735
1247
        self.dbus_object_path = (dbus.ObjectPath
736
1248
                                 ("/clients/" + client_object_name))
737
1249
        DBusObjectWithProperties.__init__(self, self.bus,
738
1250
                                          self.dbus_object_path)
739
 
        
740
 
    def _get_approvals_pending(self):
741
 
        return self._approvals_pending
742
 
    def _set_approvals_pending(self, value):
743
 
        old_value = self._approvals_pending
744
 
        self._approvals_pending = value
745
 
        bval = bool(value)
746
 
        if (hasattr(self, "dbus_object_path")
747
 
            and bval is not bool(old_value)):
748
 
            dbus_bool = dbus.Boolean(bval, variant_level=1)
749
 
            self.PropertyChanged(dbus.String("ApprovalPending"),
750
 
                                 dbus_bool)
751
 
 
752
 
    approvals_pending = property(_get_approvals_pending,
753
 
                                 _set_approvals_pending)
754
 
    del _get_approvals_pending, _set_approvals_pending
755
 
    
756
 
    @staticmethod
757
 
    def _datetime_to_dbus(dt, variant_level=0):
758
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
759
 
        return dbus.String(dt.isoformat(),
760
 
                           variant_level=variant_level)
761
 
    
762
 
    def enable(self):
763
 
        oldstate = getattr(self, "enabled", False)
764
 
        r = Client.enable(self)
765
 
        if oldstate != self.enabled:
766
 
            # Emit D-Bus signals
767
 
            self.PropertyChanged(dbus.String("Enabled"),
768
 
                                 dbus.Boolean(True, variant_level=1))
769
 
            self.PropertyChanged(
770
 
                dbus.String("LastEnabled"),
771
 
                self._datetime_to_dbus(self.last_enabled,
772
 
                                       variant_level=1))
773
 
        return r
774
 
    
775
 
    def disable(self, quiet = False):
776
 
        oldstate = getattr(self, "enabled", False)
777
 
        r = Client.disable(self, quiet=quiet)
778
 
        if not quiet and oldstate != self.enabled:
779
 
            # Emit D-Bus signal
780
 
            self.PropertyChanged(dbus.String("Enabled"),
781
 
                                 dbus.Boolean(False, variant_level=1))
782
 
        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
783
1334
    
784
1335
    def __del__(self, *args, **kwargs):
785
1336
        try:
794
1345
                         *args, **kwargs):
795
1346
        self.checker_callback_tag = None
796
1347
        self.checker = None
797
 
        # Emit D-Bus signal
798
 
        self.PropertyChanged(dbus.String("CheckerRunning"),
799
 
                             dbus.Boolean(False, variant_level=1))
800
1348
        if os.WIFEXITED(condition):
801
1349
            exitstatus = os.WEXITSTATUS(condition)
802
1350
            # Emit D-Bus signal
812
1360
        return Client.checker_callback(self, pid, condition, command,
813
1361
                                       *args, **kwargs)
814
1362
    
815
 
    def checked_ok(self, *args, **kwargs):
816
 
        r = Client.checked_ok(self, *args, **kwargs)
817
 
        # Emit D-Bus signal
818
 
        self.PropertyChanged(
819
 
            dbus.String("LastCheckedOK"),
820
 
            (self._datetime_to_dbus(self.last_checked_ok,
821
 
                                    variant_level=1)))
822
 
        return r
823
 
    
824
 
    def need_approval(self, *args, **kwargs):
825
 
        r = Client.need_approval(self, *args, **kwargs)
826
 
        # Emit D-Bus signal
827
 
        self.PropertyChanged(
828
 
            dbus.String("LastApprovalRequest"),
829
 
            (self._datetime_to_dbus(self.last_approval_request,
830
 
                                    variant_level=1)))
831
 
        return r
832
 
    
833
1363
    def start_checker(self, *args, **kwargs):
834
 
        old_checker = self.checker
835
 
        if self.checker is not None:
836
 
            old_checker_pid = self.checker.pid
837
 
        else:
838
 
            old_checker_pid = None
 
1364
        old_checker_pid = getattr(self.checker, "pid", None)
839
1365
        r = Client.start_checker(self, *args, **kwargs)
840
1366
        # Only if new checker process was started
841
1367
        if (self.checker is not None
842
1368
            and old_checker_pid != self.checker.pid):
843
1369
            # Emit D-Bus signal
844
1370
            self.CheckerStarted(self.current_checker_command)
845
 
            self.PropertyChanged(
846
 
                dbus.String("CheckerRunning"),
847
 
                dbus.Boolean(True, variant_level=1))
848
1371
        return r
849
1372
    
850
 
    def stop_checker(self, *args, **kwargs):
851
 
        old_checker = getattr(self, "checker", None)
852
 
        r = Client.stop_checker(self, *args, **kwargs)
853
 
        if (old_checker is not None
854
 
            and getattr(self, "checker", None) is None):
855
 
            self.PropertyChanged(dbus.String("CheckerRunning"),
856
 
                                 dbus.Boolean(False, variant_level=1))
857
 
        return r
858
 
 
859
1373
    def _reset_approved(self):
860
 
        self._approved = None
 
1374
        self.approved = None
861
1375
        return False
862
1376
    
863
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)
864
1381
        self.send_changedstate()
865
 
        self._approved = value
866
 
        gobject.timeout_add(self._timedelta_to_milliseconds
867
 
                            (self.approval_duration),
868
 
                            self._reset_approved)
869
 
    
870
1382
    
871
1383
    ## D-Bus methods, signals & properties
872
 
    _interface = "se.bsnet.fukt.Mandos.Client"
 
1384
    
 
1385
    ## Interfaces
873
1386
    
874
1387
    ## Signals
875
1388
    
886
1399
        pass
887
1400
    
888
1401
    # PropertyChanged - signal
 
1402
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
889
1403
    @dbus.service.signal(_interface, signature="sv")
890
1404
    def PropertyChanged(self, property, value):
891
1405
        "D-Bus signal"
922
1436
    # CheckedOK - method
923
1437
    @dbus.service.method(_interface)
924
1438
    def CheckedOK(self):
925
 
        return self.checked_ok()
 
1439
        self.checked_ok()
926
1440
    
927
1441
    # Enable - method
928
1442
    @dbus.service.method(_interface)
961
1475
        if value is None:       # get
962
1476
            return dbus.Boolean(self.approved_by_default)
963
1477
        self.approved_by_default = bool(value)
964
 
        # Emit D-Bus signal
965
 
        self.PropertyChanged(dbus.String("ApprovedByDefault"),
966
 
                             dbus.Boolean(value, variant_level=1))
967
1478
    
968
1479
    # ApprovalDelay - property
969
1480
    @dbus_service_property(_interface, signature="t",
970
1481
                           access="readwrite")
971
1482
    def ApprovalDelay_dbus_property(self, value=None):
972
1483
        if value is None:       # get
973
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1484
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1485
                               * 1000)
974
1486
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
975
 
        # Emit D-Bus signal
976
 
        self.PropertyChanged(dbus.String("ApprovalDelay"),
977
 
                             dbus.UInt64(value, variant_level=1))
978
1487
    
979
1488
    # ApprovalDuration - property
980
1489
    @dbus_service_property(_interface, signature="t",
981
1490
                           access="readwrite")
982
1491
    def ApprovalDuration_dbus_property(self, value=None):
983
1492
        if value is None:       # get
984
 
            return dbus.UInt64(self._timedelta_to_milliseconds(
985
 
                    self.approval_duration))
 
1493
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1494
                               * 1000)
986
1495
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
987
 
        # Emit D-Bus signal
988
 
        self.PropertyChanged(dbus.String("ApprovalDuration"),
989
 
                             dbus.UInt64(value, variant_level=1))
990
1496
    
991
1497
    # Name - property
992
1498
    @dbus_service_property(_interface, signature="s", access="read")
1004
1510
    def Host_dbus_property(self, value=None):
1005
1511
        if value is None:       # get
1006
1512
            return dbus.String(self.host)
1007
 
        self.host = value
1008
 
        # Emit D-Bus signal
1009
 
        self.PropertyChanged(dbus.String("Host"),
1010
 
                             dbus.String(value, variant_level=1))
 
1513
        self.host = str(value)
1011
1514
    
1012
1515
    # Created - property
1013
1516
    @dbus_service_property(_interface, signature="s", access="read")
1014
1517
    def Created_dbus_property(self):
1015
 
        return dbus.String(self._datetime_to_dbus(self.created))
 
1518
        return datetime_to_dbus(self.created)
1016
1519
    
1017
1520
    # LastEnabled - property
1018
1521
    @dbus_service_property(_interface, signature="s", access="read")
1019
1522
    def LastEnabled_dbus_property(self):
1020
 
        if self.last_enabled is None:
1021
 
            return dbus.String("")
1022
 
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
 
1523
        return datetime_to_dbus(self.last_enabled)
1023
1524
    
1024
1525
    # Enabled - property
1025
1526
    @dbus_service_property(_interface, signature="b",
1039
1540
        if value is not None:
1040
1541
            self.checked_ok()
1041
1542
            return
1042
 
        if self.last_checked_ok is None:
1043
 
            return dbus.String("")
1044
 
        return dbus.String(self._datetime_to_dbus(self
1045
 
                                                  .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)
1046
1555
    
1047
1556
    # LastApprovalRequest - property
1048
1557
    @dbus_service_property(_interface, signature="s", access="read")
1049
1558
    def LastApprovalRequest_dbus_property(self):
1050
 
        if self.last_approval_request is None:
1051
 
            return dbus.String("")
1052
 
        return dbus.String(self.
1053
 
                           _datetime_to_dbus(self
1054
 
                                             .last_approval_request))
 
1559
        return datetime_to_dbus(self.last_approval_request)
1055
1560
    
1056
1561
    # Timeout - property
1057
1562
    @dbus_service_property(_interface, signature="t",
1058
1563
                           access="readwrite")
1059
1564
    def Timeout_dbus_property(self, value=None):
1060
1565
        if value is None:       # get
1061
 
            return dbus.UInt64(self.timeout_milliseconds())
 
1566
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1567
        old_timeout = self.timeout
1062
1568
        self.timeout = datetime.timedelta(0, 0, 0, value)
1063
 
        # Emit D-Bus signal
1064
 
        self.PropertyChanged(dbus.String("Timeout"),
1065
 
                             dbus.UInt64(value, variant_level=1))
1066
 
        if getattr(self, "disable_initiator_tag", None) is None:
1067
 
            return
1068
 
        # Reschedule timeout
1069
 
        gobject.source_remove(self.disable_initiator_tag)
1070
 
        self.disable_initiator_tag = None
1071
 
        time_to_die = (self.
1072
 
                       _timedelta_to_milliseconds((self
1073
 
                                                   .last_checked_ok
1074
 
                                                   + self.timeout)
1075
 
                                                  - datetime.datetime
1076
 
                                                  .utcnow()))
1077
 
        if time_to_die <= 0:
1078
 
            # The timeout has passed
1079
 
            self.disable()
1080
 
        else:
1081
 
            self.disable_initiator_tag = (gobject.timeout_add
1082
 
                                          (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)
1083
1594
    
1084
1595
    # Interval - property
1085
1596
    @dbus_service_property(_interface, signature="t",
1086
1597
                           access="readwrite")
1087
1598
    def Interval_dbus_property(self, value=None):
1088
1599
        if value is None:       # get
1089
 
            return dbus.UInt64(self.interval_milliseconds())
 
1600
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1090
1601
        self.interval = datetime.timedelta(0, 0, 0, value)
1091
 
        # Emit D-Bus signal
1092
 
        self.PropertyChanged(dbus.String("Interval"),
1093
 
                             dbus.UInt64(value, variant_level=1))
1094
1602
        if getattr(self, "checker_initiator_tag", None) is None:
1095
1603
            return
1096
 
        # Reschedule checker run
1097
 
        gobject.source_remove(self.checker_initiator_tag)
1098
 
        self.checker_initiator_tag = (gobject.timeout_add
1099
 
                                      (value, self.start_checker))
1100
 
        self.start_checker()    # Start one now, too
1101
 
 
 
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
    
1102
1611
    # Checker - property
1103
1612
    @dbus_service_property(_interface, signature="s",
1104
1613
                           access="readwrite")
1105
1614
    def Checker_dbus_property(self, value=None):
1106
1615
        if value is None:       # get
1107
1616
            return dbus.String(self.checker_command)
1108
 
        self.checker_command = value
1109
 
        # Emit D-Bus signal
1110
 
        self.PropertyChanged(dbus.String("Checker"),
1111
 
                             dbus.String(self.checker_command,
1112
 
                                         variant_level=1))
 
1617
        self.checker_command = str(value)
1113
1618
    
1114
1619
    # CheckerRunning - property
1115
1620
    @dbus_service_property(_interface, signature="b",
1131
1636
    @dbus_service_property(_interface, signature="ay",
1132
1637
                           access="write", byte_arrays=True)
1133
1638
    def Secret_dbus_property(self, value):
1134
 
        self.secret = str(value)
 
1639
        self.secret = bytes(value)
1135
1640
    
1136
1641
    del _interface
1137
1642
 
1142
1647
        self._pipe.send(('init', fpr, address))
1143
1648
        if not self._pipe.recv():
1144
1649
            raise KeyError()
1145
 
 
 
1650
    
1146
1651
    def __getattribute__(self, name):
1147
 
        if(name == '_pipe'):
 
1652
        if name == '_pipe':
1148
1653
            return super(ProxyClient, self).__getattribute__(name)
1149
1654
        self._pipe.send(('getattr', name))
1150
1655
        data = self._pipe.recv()
1155
1660
                self._pipe.send(('funcall', name, args, kwargs))
1156
1661
                return self._pipe.recv()[1]
1157
1662
            return func
1158
 
 
 
1663
    
1159
1664
    def __setattr__(self, name, value):
1160
 
        if(name == '_pipe'):
 
1665
        if name == '_pipe':
1161
1666
            return super(ProxyClient, self).__setattr__(name, value)
1162
1667
        self._pipe.send(('setattr', name, value))
1163
1668
 
1171
1676
    def handle(self):
1172
1677
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1173
1678
            logger.info("TCP connection from: %s",
1174
 
                        unicode(self.client_address))
 
1679
                        str(self.client_address))
1175
1680
            logger.debug("Pipe FD: %d",
1176
1681
                         self.server.child_pipe.fileno())
1177
 
 
 
1682
            
1178
1683
            session = (gnutls.connection
1179
1684
                       .ClientSession(self.request,
1180
1685
                                      gnutls.connection
1181
1686
                                      .X509Credentials()))
1182
 
 
 
1687
            
1183
1688
            # Note: gnutls.connection.X509Credentials is really a
1184
1689
            # generic GnuTLS certificate credentials object so long as
1185
1690
            # no X.509 keys are added to it.  Therefore, we can use it
1186
1691
            # here despite using OpenPGP certificates.
1187
 
 
 
1692
            
1188
1693
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1189
1694
            #                      "+AES-256-CBC", "+SHA1",
1190
1695
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1196
1701
            (gnutls.library.functions
1197
1702
             .gnutls_priority_set_direct(session._c_object,
1198
1703
                                         priority, None))
1199
 
 
 
1704
            
1200
1705
            # Start communication using the Mandos protocol
1201
1706
            # Get protocol number
1202
1707
            line = self.request.makefile().readline()
1203
1708
            logger.debug("Protocol version: %r", line)
1204
1709
            try:
1205
1710
                if int(line.strip().split()[0]) > 1:
1206
 
                    raise RuntimeError
1207
 
            except (ValueError, IndexError, RuntimeError), error:
 
1711
                    raise RuntimeError(line)
 
1712
            except (ValueError, IndexError, RuntimeError) as error:
1208
1713
                logger.error("Unknown protocol version: %s", error)
1209
1714
                return
1210
 
 
 
1715
            
1211
1716
            # Start GnuTLS connection
1212
1717
            try:
1213
1718
                session.handshake()
1214
 
            except gnutls.errors.GNUTLSError, error:
 
1719
            except gnutls.errors.GNUTLSError as error:
1215
1720
                logger.warning("Handshake failed: %s", error)
1216
1721
                # Do not run session.bye() here: the session is not
1217
1722
                # established.  Just abandon the request.
1218
1723
                return
1219
1724
            logger.debug("Handshake succeeded")
1220
 
 
 
1725
            
1221
1726
            approval_required = False
1222
1727
            try:
1223
1728
                try:
1224
1729
                    fpr = self.fingerprint(self.peer_certificate
1225
1730
                                           (session))
1226
 
                except (TypeError, gnutls.errors.GNUTLSError), error:
 
1731
                except (TypeError,
 
1732
                        gnutls.errors.GNUTLSError) as error:
1227
1733
                    logger.warning("Bad certificate: %s", error)
1228
1734
                    return
1229
1735
                logger.debug("Fingerprint: %s", fpr)
1230
 
 
 
1736
                
1231
1737
                try:
1232
1738
                    client = ProxyClient(child_pipe, fpr,
1233
1739
                                         self.client_address)
1241
1747
                
1242
1748
                while True:
1243
1749
                    if not client.enabled:
1244
 
                        logger.warning("Client %s is disabled",
 
1750
                        logger.info("Client %s is disabled",
1245
1751
                                       client.name)
1246
1752
                        if self.server.use_dbus:
1247
1753
                            # Emit D-Bus signal
1248
 
                            client.Rejected("Disabled")                    
 
1754
                            client.Rejected("Disabled")
1249
1755
                        return
1250
1756
                    
1251
 
                    if client._approved or not client.approval_delay:
 
1757
                    if client.approved or not client.approval_delay:
1252
1758
                        #We are approved or approval is disabled
1253
1759
                        break
1254
 
                    elif client._approved is None:
 
1760
                    elif client.approved is None:
1255
1761
                        logger.info("Client %s needs approval",
1256
1762
                                    client.name)
1257
1763
                        if self.server.use_dbus:
1258
1764
                            # Emit D-Bus signal
1259
1765
                            client.NeedApproval(
1260
 
                                client.approval_delay_milliseconds(),
1261
 
                                client.approved_by_default)
 
1766
                                client.approval_delay.total_seconds()
 
1767
                                * 1000, client.approved_by_default)
1262
1768
                    else:
1263
1769
                        logger.warning("Client %s was not approved",
1264
1770
                                       client.name)
1268
1774
                        return
1269
1775
                    
1270
1776
                    #wait until timeout or approved
1271
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1272
1777
                    time = datetime.datetime.now()
1273
1778
                    client.changedstate.acquire()
1274
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1779
                    client.changedstate.wait(delay.total_seconds())
1275
1780
                    client.changedstate.release()
1276
1781
                    time2 = datetime.datetime.now()
1277
1782
                    if (time2 - time) >= delay:
1292
1797
                while sent_size < len(client.secret):
1293
1798
                    try:
1294
1799
                        sent = session.send(client.secret[sent_size:])
1295
 
                    except (gnutls.errors.GNUTLSError), error:
1296
 
                        logger.warning("gnutls send failed")
 
1800
                    except gnutls.errors.GNUTLSError as error:
 
1801
                        logger.warning("gnutls send failed",
 
1802
                                       exc_info=error)
1297
1803
                        return
1298
1804
                    logger.debug("Sent: %d, remaining: %d",
1299
1805
                                 sent, len(client.secret)
1300
1806
                                 - (sent_size + sent))
1301
1807
                    sent_size += sent
1302
 
 
 
1808
                
1303
1809
                logger.info("Sending secret to %s", client.name)
1304
 
                # bump the timeout as if seen
1305
 
                client.checked_ok()
 
1810
                # bump the timeout using extended_timeout
 
1811
                client.bump_timeout(client.extended_timeout)
1306
1812
                if self.server.use_dbus:
1307
1813
                    # Emit D-Bus signal
1308
1814
                    client.GotSecret()
1312
1818
                    client.approvals_pending -= 1
1313
1819
                try:
1314
1820
                    session.bye()
1315
 
                except (gnutls.errors.GNUTLSError), error:
1316
 
                    logger.warning("GnuTLS bye failed")
 
1821
                except gnutls.errors.GNUTLSError as error:
 
1822
                    logger.warning("GnuTLS bye failed",
 
1823
                                   exc_info=error)
1317
1824
    
1318
1825
    @staticmethod
1319
1826
    def peer_certificate(session):
1375
1882
        # Convert the buffer to a Python bytestring
1376
1883
        fpr = ctypes.string_at(buf, buf_len.value)
1377
1884
        # Convert the bytestring to hexadecimal notation
1378
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1885
        hex_fpr = binascii.hexlify(fpr).upper()
1379
1886
        return hex_fpr
1380
1887
 
1381
1888
 
1384
1891
    def sub_process_main(self, request, address):
1385
1892
        try:
1386
1893
            self.finish_request(request, address)
1387
 
        except:
 
1894
        except Exception:
1388
1895
            self.handle_error(request, address)
1389
1896
        self.close_request(request)
1390
 
            
 
1897
    
1391
1898
    def process_request(self, request, address):
1392
1899
        """Start a new process to process the request."""
1393
 
        multiprocessing.Process(target = self.sub_process_main,
1394
 
                                args = (request, address)).start()
 
1900
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1901
                                       args = (request, address))
 
1902
        proc.start()
 
1903
        return proc
 
1904
 
1395
1905
 
1396
1906
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1397
1907
    """ adds a pipe to the MixIn """
1401
1911
        This function creates a new pipe in self.pipe
1402
1912
        """
1403
1913
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1404
 
 
1405
 
        super(MultiprocessingMixInWithPipe,
1406
 
              self).process_request(request, client_address)
 
1914
        
 
1915
        proc = MultiprocessingMixIn.process_request(self, request,
 
1916
                                                    client_address)
1407
1917
        self.child_pipe.close()
1408
 
        self.add_pipe(parent_pipe)
1409
 
 
1410
 
    def add_pipe(self, parent_pipe):
 
1918
        self.add_pipe(parent_pipe, proc)
 
1919
    
 
1920
    def add_pipe(self, parent_pipe, proc):
1411
1921
        """Dummy function; override as necessary"""
1412
 
        raise NotImplementedError
 
1922
        raise NotImplementedError()
 
1923
 
1413
1924
 
1414
1925
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1415
1926
                     socketserver.TCPServer, object):
1421
1932
        use_ipv6:       Boolean; to use IPv6 or not
1422
1933
    """
1423
1934
    def __init__(self, server_address, RequestHandlerClass,
1424
 
                 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
        """
1425
1939
        self.interface = interface
1426
1940
        if use_ipv6:
1427
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.
1428
1968
        socketserver.TCPServer.__init__(self, server_address,
1429
1969
                                        RequestHandlerClass)
 
1970
    
1430
1971
    def server_bind(self):
1431
1972
        """This overrides the normal server_bind() function
1432
1973
        to bind to an interface if one was specified, and also NOT to
1440
1981
                try:
1441
1982
                    self.socket.setsockopt(socket.SOL_SOCKET,
1442
1983
                                           SO_BINDTODEVICE,
1443
 
                                           str(self.interface
1444
 
                                               + '\0'))
1445
 
                except socket.error, error:
1446
 
                    if error[0] == errno.EPERM:
1447
 
                        logger.error("No permission to"
1448
 
                                     " bind to interface %s",
1449
 
                                     self.interface)
1450
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1984
                                           (self.interface + "\0")
 
1985
                                           .encode("utf-8"))
 
1986
                except socket.error as error:
 
1987
                    if error.errno == errno.EPERM:
 
1988
                        logger.error("No permission to bind to"
 
1989
                                     " interface %s", self.interface)
 
1990
                    elif error.errno == errno.ENOPROTOOPT:
1451
1991
                        logger.error("SO_BINDTODEVICE not available;"
1452
1992
                                     " cannot bind to interface %s",
1453
1993
                                     self.interface)
 
1994
                    elif error.errno == errno.ENODEV:
 
1995
                        logger.error("Interface %s does not exist,"
 
1996
                                     " cannot bind", self.interface)
1454
1997
                    else:
1455
1998
                        raise
1456
1999
        # Only bind(2) the socket if we really need to.
1459
2002
                if self.address_family == socket.AF_INET6:
1460
2003
                    any_address = "::" # in6addr_any
1461
2004
                else:
1462
 
                    any_address = socket.INADDR_ANY
 
2005
                    any_address = "0.0.0.0" # INADDR_ANY
1463
2006
                self.server_address = (any_address,
1464
2007
                                       self.server_address[1])
1465
2008
            elif not self.server_address[1]:
1486
2029
    """
1487
2030
    def __init__(self, server_address, RequestHandlerClass,
1488
2031
                 interface=None, use_ipv6=True, clients=None,
1489
 
                 gnutls_priority=None, use_dbus=True):
 
2032
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1490
2033
        self.enabled = False
1491
2034
        self.clients = clients
1492
2035
        if self.clients is None:
1493
 
            self.clients = set()
 
2036
            self.clients = {}
1494
2037
        self.use_dbus = use_dbus
1495
2038
        self.gnutls_priority = gnutls_priority
1496
2039
        IPv6_TCPServer.__init__(self, server_address,
1497
2040
                                RequestHandlerClass,
1498
2041
                                interface = interface,
1499
 
                                use_ipv6 = use_ipv6)
 
2042
                                use_ipv6 = use_ipv6,
 
2043
                                socketfd = socketfd)
1500
2044
    def server_activate(self):
1501
2045
        if self.enabled:
1502
2046
            return socketserver.TCPServer.server_activate(self)
 
2047
    
1503
2048
    def enable(self):
1504
2049
        self.enabled = True
1505
 
    def add_pipe(self, parent_pipe):
 
2050
    
 
2051
    def add_pipe(self, parent_pipe, proc):
1506
2052
        # Call "handle_ipc" for both data and EOF events
1507
2053
        gobject.io_add_watch(parent_pipe.fileno(),
1508
2054
                             gobject.IO_IN | gobject.IO_HUP,
1509
2055
                             functools.partial(self.handle_ipc,
1510
 
                                               parent_pipe = parent_pipe))
1511
 
        
 
2056
                                               parent_pipe =
 
2057
                                               parent_pipe,
 
2058
                                               proc = proc))
 
2059
    
1512
2060
    def handle_ipc(self, source, condition, parent_pipe=None,
1513
 
                   client_object=None):
1514
 
        condition_names = {
1515
 
            gobject.IO_IN: "IN",   # There is data to read.
1516
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1517
 
                                    # blocking).
1518
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1519
 
            gobject.IO_ERR: "ERR", # Error condition.
1520
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1521
 
                                    # broken, usually for pipes and
1522
 
                                    # sockets).
1523
 
            }
1524
 
        conditions_string = ' | '.join(name
1525
 
                                       for cond, name in
1526
 
                                       condition_names.iteritems()
1527
 
                                       if cond & condition)
1528
 
        # error or the other end of multiprocessing.Pipe has closed
1529
 
        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()
1530
2066
            return False
1531
2067
        
1532
2068
        # Read a request from the child
1537
2073
            fpr = request[1]
1538
2074
            address = request[2]
1539
2075
            
1540
 
            for c in self.clients:
 
2076
            for c in self.clients.itervalues():
1541
2077
                if c.fingerprint == fpr:
1542
2078
                    client = c
1543
2079
                    break
1544
2080
            else:
1545
 
                logger.warning("Client not found for fingerprint: %s, ad"
1546
 
                               "dress: %s", fpr, address)
 
2081
                logger.info("Client not found for fingerprint: %s, ad"
 
2082
                            "dress: %s", fpr, address)
1547
2083
                if self.use_dbus:
1548
2084
                    # Emit D-Bus signal
1549
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2085
                    mandos_dbus_service.ClientNotFound(fpr,
 
2086
                                                       address[0])
1550
2087
                parent_pipe.send(False)
1551
2088
                return False
1552
2089
            
1553
2090
            gobject.io_add_watch(parent_pipe.fileno(),
1554
2091
                                 gobject.IO_IN | gobject.IO_HUP,
1555
2092
                                 functools.partial(self.handle_ipc,
1556
 
                                                   parent_pipe = parent_pipe,
1557
 
                                                   client_object = client))
 
2093
                                                   parent_pipe =
 
2094
                                                   parent_pipe,
 
2095
                                                   proc = proc,
 
2096
                                                   client_object =
 
2097
                                                   client))
1558
2098
            parent_pipe.send(True)
1559
 
            # 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
1560
2101
            return False
1561
2102
        if command == 'funcall':
1562
2103
            funcname = request[1]
1563
2104
            args = request[2]
1564
2105
            kwargs = request[3]
1565
2106
            
1566
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1567
 
 
 
2107
            parent_pipe.send(('data', getattr(client_object,
 
2108
                                              funcname)(*args,
 
2109
                                                         **kwargs)))
 
2110
        
1568
2111
        if command == 'getattr':
1569
2112
            attrname = request[1]
1570
2113
            if callable(client_object.__getattribute__(attrname)):
1571
2114
                parent_pipe.send(('function',))
1572
2115
            else:
1573
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2116
                parent_pipe.send(('data', client_object
 
2117
                                  .__getattribute__(attrname)))
1574
2118
        
1575
2119
        if command == 'setattr':
1576
2120
            attrname = request[1]
1577
2121
            value = request[2]
1578
2122
            setattr(client_object, attrname, value)
1579
 
 
 
2123
        
1580
2124
        return True
1581
2125
 
1582
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
 
1583
2226
def string_to_delta(interval):
1584
2227
    """Parse a string and return a datetime.timedelta
1585
2228
    
1596
2239
    >>> string_to_delta('5m 30s')
1597
2240
    datetime.timedelta(0, 330)
1598
2241
    """
 
2242
    
 
2243
    try:
 
2244
        return rfc3339_duration_to_delta(interval)
 
2245
    except ValueError:
 
2246
        pass
 
2247
    
1599
2248
    timevalue = datetime.timedelta(0)
1600
2249
    for s in interval.split():
1601
2250
        try:
1602
 
            suffix = unicode(s[-1])
 
2251
            suffix = s[-1]
1603
2252
            value = int(s[:-1])
1604
2253
            if suffix == "d":
1605
2254
                delta = datetime.timedelta(value)
1612
2261
            elif suffix == "w":
1613
2262
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1614
2263
            else:
1615
 
                raise ValueError("Unknown suffix %r" % suffix)
1616
 
        except (ValueError, IndexError), e:
 
2264
                raise ValueError("Unknown suffix {!r}"
 
2265
                                 .format(suffix))
 
2266
        except IndexError as e:
1617
2267
            raise ValueError(*(e.args))
1618
2268
        timevalue += delta
1619
2269
    return timevalue
1620
2270
 
1621
2271
 
1622
 
def if_nametoindex(interface):
1623
 
    """Call the C function if_nametoindex(), or equivalent
1624
 
    
1625
 
    Note: This function cannot accept a unicode string."""
1626
 
    global if_nametoindex
1627
 
    try:
1628
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1629
 
                          (ctypes.util.find_library("c"))
1630
 
                          .if_nametoindex)
1631
 
    except (OSError, AttributeError):
1632
 
        logger.warning("Doing if_nametoindex the hard way")
1633
 
        def if_nametoindex(interface):
1634
 
            "Get an interface index the hard way, i.e. using fcntl()"
1635
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1636
 
            with contextlib.closing(socket.socket()) as s:
1637
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1638
 
                                    struct.pack(str("16s16x"),
1639
 
                                                interface))
1640
 
            interface_index = struct.unpack(str("I"),
1641
 
                                            ifreq[16:20])[0]
1642
 
            return interface_index
1643
 
    return if_nametoindex(interface)
1644
 
 
1645
 
 
1646
2272
def daemon(nochdir = False, noclose = False):
1647
2273
    """See daemon(3).  Standard BSD Unix function.
1648
2274
    
1656
2282
        sys.exit()
1657
2283
    if not noclose:
1658
2284
        # Close all standard open file descriptors
1659
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2285
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1660
2286
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1661
 
            raise OSError(errno.ENODEV,
1662
 
                          "%s not a character device"
1663
 
                          % os.path.devnull)
 
2287
            raise OSError(errno.ENODEV, "{} not a character device"
 
2288
                          .format(os.devnull))
1664
2289
        os.dup2(null, sys.stdin.fileno())
1665
2290
        os.dup2(null, sys.stdout.fileno())
1666
2291
        os.dup2(null, sys.stderr.fileno())
1673
2298
    ##################################################################
1674
2299
    # Parsing of options, both command line and config file
1675
2300
    
1676
 
    parser = optparse.OptionParser(version = "%%prog %s" % version)
1677
 
    parser.add_option("-i", "--interface", type="string",
1678
 
                      metavar="IF", help="Bind to interface IF")
1679
 
    parser.add_option("-a", "--address", type="string",
1680
 
                      help="Address to listen for requests on")
1681
 
    parser.add_option("-p", "--port", type="int",
1682
 
                      help="Port number to receive requests on")
1683
 
    parser.add_option("--check", action="store_true",
1684
 
                      help="Run self-test")
1685
 
    parser.add_option("--debug", action="store_true",
1686
 
                      help="Debug mode; run in foreground and log to"
1687
 
                      " terminal")
1688
 
    parser.add_option("--debuglevel", type="string", metavar="LEVEL",
1689
 
                      help="Debug level for stdout output")
1690
 
    parser.add_option("--priority", type="string", help="GnuTLS"
1691
 
                      " priority string (see GnuTLS documentation)")
1692
 
    parser.add_option("--servicename", type="string",
1693
 
                      metavar="NAME", help="Zeroconf service name")
1694
 
    parser.add_option("--configdir", type="string",
1695
 
                      default="/etc/mandos", metavar="DIR",
1696
 
                      help="Directory to search for configuration"
1697
 
                      " files")
1698
 
    parser.add_option("--no-dbus", action="store_false",
1699
 
                      dest="use_dbus", help="Do not provide D-Bus"
1700
 
                      " system bus interface")
1701
 
    parser.add_option("--no-ipv6", action="store_false",
1702
 
                      dest="use_ipv6", help="Do not use IPv6")
1703
 
    options = parser.parse_args()[0]
 
2301
    parser = argparse.ArgumentParser()
 
2302
    parser.add_argument("-v", "--version", action="version",
 
2303
                        version = "%(prog)s {}".format(version),
 
2304
                        help="show version number and exit")
 
2305
    parser.add_argument("-i", "--interface", metavar="IF",
 
2306
                        help="Bind to interface IF")
 
2307
    parser.add_argument("-a", "--address",
 
2308
                        help="Address to listen for requests on")
 
2309
    parser.add_argument("-p", "--port", type=int,
 
2310
                        help="Port number to receive requests on")
 
2311
    parser.add_argument("--check", action="store_true",
 
2312
                        help="Run self-test")
 
2313
    parser.add_argument("--debug", action="store_true",
 
2314
                        help="Debug mode; run in foreground and log"
 
2315
                        " to terminal", default=None)
 
2316
    parser.add_argument("--debuglevel", metavar="LEVEL",
 
2317
                        help="Debug level for stdout output")
 
2318
    parser.add_argument("--priority", help="GnuTLS"
 
2319
                        " priority string (see GnuTLS documentation)")
 
2320
    parser.add_argument("--servicename",
 
2321
                        metavar="NAME", help="Zeroconf service name")
 
2322
    parser.add_argument("--configdir",
 
2323
                        default="/etc/mandos", metavar="DIR",
 
2324
                        help="Directory to search for configuration"
 
2325
                        " files")
 
2326
    parser.add_argument("--no-dbus", action="store_false",
 
2327
                        dest="use_dbus", help="Do not provide D-Bus"
 
2328
                        " system bus interface", default=None)
 
2329
    parser.add_argument("--no-ipv6", action="store_false",
 
2330
                        dest="use_ipv6", help="Do not use IPv6",
 
2331
                        default=None)
 
2332
    parser.add_argument("--no-restore", action="store_false",
 
2333
                        dest="restore", help="Do not restore stored"
 
2334
                        " state", default=None)
 
2335
    parser.add_argument("--socket", type=int,
 
2336
                        help="Specify a file descriptor to a network"
 
2337
                        " socket to use instead of creating one")
 
2338
    parser.add_argument("--statedir", metavar="DIR",
 
2339
                        help="Directory to save/restore state in")
 
2340
    parser.add_argument("--foreground", action="store_true",
 
2341
                        help="Run in foreground", default=None)
 
2342
    parser.add_argument("--no-zeroconf", action="store_false",
 
2343
                        dest="zeroconf", help="Do not use Zeroconf",
 
2344
                        default=None)
 
2345
    
 
2346
    options = parser.parse_args()
1704
2347
    
1705
2348
    if options.check:
1706
2349
        import doctest
1707
 
        doctest.testmod()
1708
 
        sys.exit()
 
2350
        fail_count, test_count = doctest.testmod()
 
2351
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1709
2352
    
1710
2353
    # Default values for config file for server-global settings
1711
2354
    server_defaults = { "interface": "",
1713
2356
                        "port": "",
1714
2357
                        "debug": "False",
1715
2358
                        "priority":
1716
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2359
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2360
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
1717
2361
                        "servicename": "Mandos",
1718
2362
                        "use_dbus": "True",
1719
2363
                        "use_ipv6": "True",
1720
2364
                        "debuglevel": "",
 
2365
                        "restore": "True",
 
2366
                        "socket": "",
 
2367
                        "statedir": "/var/lib/mandos",
 
2368
                        "foreground": "False",
 
2369
                        "zeroconf": "True",
1721
2370
                        }
1722
2371
    
1723
2372
    # Parse config file for server-global settings
1728
2377
    # Convert the SafeConfigParser object to a dict
1729
2378
    server_settings = server_config.defaults()
1730
2379
    # Use the appropriate methods on the non-string config options
1731
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2380
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1732
2381
        server_settings[option] = server_config.getboolean("DEFAULT",
1733
2382
                                                           option)
1734
2383
    if server_settings["port"]:
1735
2384
        server_settings["port"] = server_config.getint("DEFAULT",
1736
2385
                                                       "port")
 
2386
    if server_settings["socket"]:
 
2387
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2388
                                                         "socket")
 
2389
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2390
        # over with an opened os.devnull.  But we don't want this to
 
2391
        # happen with a supplied network socket.
 
2392
        if 0 <= server_settings["socket"] <= 2:
 
2393
            server_settings["socket"] = os.dup(server_settings
 
2394
                                               ["socket"])
1737
2395
    del server_config
1738
2396
    
1739
2397
    # Override the settings from the config file with command line
1740
2398
    # options, if set.
1741
2399
    for option in ("interface", "address", "port", "debug",
1742
2400
                   "priority", "servicename", "configdir",
1743
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2401
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2402
                   "statedir", "socket", "foreground", "zeroconf"):
1744
2403
        value = getattr(options, option)
1745
2404
        if value is not None:
1746
2405
            server_settings[option] = value
1747
2406
    del options
1748
2407
    # Force all strings to be unicode
1749
2408
    for option in server_settings.keys():
1750
 
        if type(server_settings[option]) is str:
1751
 
            server_settings[option] = unicode(server_settings[option])
 
2409
        if isinstance(server_settings[option], bytes):
 
2410
            server_settings[option] = (server_settings[option]
 
2411
                                       .decode("utf-8"))
 
2412
    # Force all boolean options to be boolean
 
2413
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2414
                   "foreground", "zeroconf"):
 
2415
        server_settings[option] = bool(server_settings[option])
 
2416
    # Debug implies foreground
 
2417
    if server_settings["debug"]:
 
2418
        server_settings["foreground"] = True
1752
2419
    # Now we have our good server settings in "server_settings"
1753
2420
    
1754
2421
    ##################################################################
1755
2422
    
 
2423
    if (not server_settings["zeroconf"] and
 
2424
        not (server_settings["port"]
 
2425
             or server_settings["socket"] != "")):
 
2426
            parser.error("Needs port or socket to work without"
 
2427
                         " Zeroconf")
 
2428
    
1756
2429
    # For convenience
1757
2430
    debug = server_settings["debug"]
1758
2431
    debuglevel = server_settings["debuglevel"]
1759
2432
    use_dbus = server_settings["use_dbus"]
1760
2433
    use_ipv6 = server_settings["use_ipv6"]
1761
 
 
 
2434
    stored_state_path = os.path.join(server_settings["statedir"],
 
2435
                                     stored_state_file)
 
2436
    foreground = server_settings["foreground"]
 
2437
    zeroconf = server_settings["zeroconf"]
 
2438
    
 
2439
    if debug:
 
2440
        initlogger(debug, logging.DEBUG)
 
2441
    else:
 
2442
        if not debuglevel:
 
2443
            initlogger(debug)
 
2444
        else:
 
2445
            level = getattr(logging, debuglevel.upper())
 
2446
            initlogger(debug, level)
 
2447
    
1762
2448
    if server_settings["servicename"] != "Mandos":
1763
2449
        syslogger.setFormatter(logging.Formatter
1764
 
                               ('Mandos (%s) [%%(process)d]:'
1765
 
                                ' %%(levelname)s: %%(message)s'
1766
 
                                % server_settings["servicename"]))
 
2450
                               ('Mandos ({}) [%(process)d]:'
 
2451
                                ' %(levelname)s: %(message)s'
 
2452
                                .format(server_settings
 
2453
                                        ["servicename"])))
1767
2454
    
1768
2455
    # Parse config file with clients
1769
 
    client_defaults = { "timeout": "1h",
1770
 
                        "interval": "5m",
1771
 
                        "checker": "fping -q -- %%(host)s",
1772
 
                        "host": "",
1773
 
                        "approval_delay": "0s",
1774
 
                        "approval_duration": "1s",
1775
 
                        }
1776
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2456
    client_config = configparser.SafeConfigParser(Client
 
2457
                                                  .client_defaults)
1777
2458
    client_config.read(os.path.join(server_settings["configdir"],
1778
2459
                                    "clients.conf"))
1779
2460
    
1780
2461
    global mandos_dbus_service
1781
2462
    mandos_dbus_service = None
1782
2463
    
 
2464
    socketfd = None
 
2465
    if server_settings["socket"] != "":
 
2466
        socketfd = server_settings["socket"]
1783
2467
    tcp_server = MandosServer((server_settings["address"],
1784
2468
                               server_settings["port"]),
1785
2469
                              ClientHandler,
1788
2472
                              use_ipv6=use_ipv6,
1789
2473
                              gnutls_priority=
1790
2474
                              server_settings["priority"],
1791
 
                              use_dbus=use_dbus)
1792
 
    if not debug:
1793
 
        pidfilename = "/var/run/mandos.pid"
 
2475
                              use_dbus=use_dbus,
 
2476
                              socketfd=socketfd)
 
2477
    if not foreground:
 
2478
        pidfilename = "/run/mandos.pid"
 
2479
        if not os.path.isdir("/run/."):
 
2480
            pidfilename = "/var/run/mandos.pid"
 
2481
        pidfile = None
1794
2482
        try:
1795
2483
            pidfile = open(pidfilename, "w")
1796
 
        except IOError:
1797
 
            logger.error("Could not open file %r", pidfilename)
 
2484
        except IOError as e:
 
2485
            logger.error("Could not open file %r", pidfilename,
 
2486
                         exc_info=e)
1798
2487
    
1799
 
    try:
1800
 
        uid = pwd.getpwnam("_mandos").pw_uid
1801
 
        gid = pwd.getpwnam("_mandos").pw_gid
1802
 
    except KeyError:
 
2488
    for name in ("_mandos", "mandos", "nobody"):
1803
2489
        try:
1804
 
            uid = pwd.getpwnam("mandos").pw_uid
1805
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2490
            uid = pwd.getpwnam(name).pw_uid
 
2491
            gid = pwd.getpwnam(name).pw_gid
 
2492
            break
1806
2493
        except KeyError:
1807
 
            try:
1808
 
                uid = pwd.getpwnam("nobody").pw_uid
1809
 
                gid = pwd.getpwnam("nobody").pw_gid
1810
 
            except KeyError:
1811
 
                uid = 65534
1812
 
                gid = 65534
 
2494
            continue
 
2495
    else:
 
2496
        uid = 65534
 
2497
        gid = 65534
1813
2498
    try:
1814
2499
        os.setgid(gid)
1815
2500
        os.setuid(uid)
1816
 
    except OSError, error:
1817
 
        if error[0] != errno.EPERM:
1818
 
            raise error
 
2501
    except OSError as error:
 
2502
        if error.errno != errno.EPERM:
 
2503
            raise
1819
2504
    
1820
 
    if not debug and not debuglevel:
1821
 
        syslogger.setLevel(logging.WARNING)
1822
 
        console.setLevel(logging.WARNING)
1823
 
    if debuglevel:
1824
 
        level = getattr(logging, debuglevel.upper())
1825
 
        syslogger.setLevel(level)
1826
 
        console.setLevel(level)
1827
 
 
1828
2505
    if debug:
1829
2506
        # Enable all possible GnuTLS debugging
1830
2507
        
1840
2517
         .gnutls_global_set_log_function(debug_gnutls))
1841
2518
        
1842
2519
        # Redirect stdin so all checkers get /dev/null
1843
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2520
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1844
2521
        os.dup2(null, sys.stdin.fileno())
1845
2522
        if null > 2:
1846
2523
            os.close(null)
1847
 
    else:
1848
 
        # No console logging
1849
 
        logger.removeHandler(console)
1850
2524
    
1851
2525
    # Need to fork before connecting to D-Bus
1852
 
    if not debug:
 
2526
    if not foreground:
1853
2527
        # Close all input and output, do double fork, etc.
1854
2528
        daemon()
1855
2529
    
 
2530
    # multiprocessing will use threads, so before we use gobject we
 
2531
    # need to inform gobject that threads will be used.
 
2532
    gobject.threads_init()
 
2533
    
1856
2534
    global main_loop
1857
2535
    # From the Avahi example code
1858
 
    DBusGMainLoop(set_as_default=True )
 
2536
    DBusGMainLoop(set_as_default=True)
1859
2537
    main_loop = gobject.MainLoop()
1860
2538
    bus = dbus.SystemBus()
1861
2539
    # End of Avahi example code
1862
2540
    if use_dbus:
1863
2541
        try:
1864
 
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
 
2542
            bus_name = dbus.service.BusName("se.recompile.Mandos",
1865
2543
                                            bus, do_not_queue=True)
1866
 
        except dbus.exceptions.NameExistsException, e:
1867
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2544
            old_bus_name = (dbus.service.BusName
 
2545
                            ("se.bsnet.fukt.Mandos", bus,
 
2546
                             do_not_queue=True))
 
2547
        except dbus.exceptions.NameExistsException as e:
 
2548
            logger.error("Disabling D-Bus:", exc_info=e)
1868
2549
            use_dbus = False
1869
2550
            server_settings["use_dbus"] = False
1870
2551
            tcp_server.use_dbus = False
1871
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1872
 
    service = AvahiService(name = server_settings["servicename"],
1873
 
                           servicetype = "_mandos._tcp",
1874
 
                           protocol = protocol, bus = bus)
1875
 
    if server_settings["interface"]:
1876
 
        service.interface = (if_nametoindex
1877
 
                             (str(server_settings["interface"])))
 
2552
    if zeroconf:
 
2553
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2554
        service = AvahiServiceToSyslog(name =
 
2555
                                       server_settings["servicename"],
 
2556
                                       servicetype = "_mandos._tcp",
 
2557
                                       protocol = protocol, bus = bus)
 
2558
        if server_settings["interface"]:
 
2559
            service.interface = (if_nametoindex
 
2560
                                 (server_settings["interface"]
 
2561
                                  .encode("utf-8")))
1878
2562
    
1879
2563
    global multiprocessing_manager
1880
2564
    multiprocessing_manager = multiprocessing.Manager()
1882
2566
    client_class = Client
1883
2567
    if use_dbus:
1884
2568
        client_class = functools.partial(ClientDBus, bus = bus)
1885
 
    def client_config_items(config, section):
1886
 
        special_settings = {
1887
 
            "approved_by_default":
1888
 
                lambda: config.getboolean(section,
1889
 
                                          "approved_by_default"),
1890
 
            }
1891
 
        for name, value in config.items(section):
 
2569
    
 
2570
    client_settings = Client.config_parser(client_config)
 
2571
    old_client_settings = {}
 
2572
    clients_data = {}
 
2573
    
 
2574
    # This is used to redirect stdout and stderr for checker processes
 
2575
    global wnull
 
2576
    wnull = open(os.devnull, "w") # A writable /dev/null
 
2577
    # Only used if server is running in foreground but not in debug
 
2578
    # mode
 
2579
    if debug or not foreground:
 
2580
        wnull.close()
 
2581
    
 
2582
    # Get client data and settings from last running state.
 
2583
    if server_settings["restore"]:
 
2584
        try:
 
2585
            with open(stored_state_path, "rb") as stored_state:
 
2586
                clients_data, old_client_settings = (pickle.load
 
2587
                                                     (stored_state))
 
2588
            os.remove(stored_state_path)
 
2589
        except IOError as e:
 
2590
            if e.errno == errno.ENOENT:
 
2591
                logger.warning("Could not load persistent state: {}"
 
2592
                                .format(os.strerror(e.errno)))
 
2593
            else:
 
2594
                logger.critical("Could not load persistent state:",
 
2595
                                exc_info=e)
 
2596
                raise
 
2597
        except EOFError as e:
 
2598
            logger.warning("Could not load persistent state: "
 
2599
                           "EOFError:", exc_info=e)
 
2600
    
 
2601
    with PGPEngine() as pgp:
 
2602
        for client_name, client in clients_data.items():
 
2603
            # Skip removed clients
 
2604
            if client_name not in client_settings:
 
2605
                continue
 
2606
            
 
2607
            # Decide which value to use after restoring saved state.
 
2608
            # We have three different values: Old config file,
 
2609
            # new config file, and saved state.
 
2610
            # New config value takes precedence if it differs from old
 
2611
            # config value, otherwise use saved state.
 
2612
            for name, value in client_settings[client_name].items():
 
2613
                try:
 
2614
                    # For each value in new config, check if it
 
2615
                    # differs from the old config value (Except for
 
2616
                    # the "secret" attribute)
 
2617
                    if (name != "secret" and
 
2618
                        value != old_client_settings[client_name]
 
2619
                        [name]):
 
2620
                        client[name] = value
 
2621
                except KeyError:
 
2622
                    pass
 
2623
            
 
2624
            # Clients who has passed its expire date can still be
 
2625
            # enabled if its last checker was successful.  Clients
 
2626
            # whose checker succeeded before we stored its state is
 
2627
            # assumed to have successfully run all checkers during
 
2628
            # downtime.
 
2629
            if client["enabled"]:
 
2630
                if datetime.datetime.utcnow() >= client["expires"]:
 
2631
                    if not client["last_checked_ok"]:
 
2632
                        logger.warning(
 
2633
                            "disabling client {} - Client never "
 
2634
                            "performed a successful checker"
 
2635
                            .format(client_name))
 
2636
                        client["enabled"] = False
 
2637
                    elif client["last_checker_status"] != 0:
 
2638
                        logger.warning(
 
2639
                            "disabling client {} - Client last"
 
2640
                            " checker failed with error code {}"
 
2641
                            .format(client_name,
 
2642
                                    client["last_checker_status"]))
 
2643
                        client["enabled"] = False
 
2644
                    else:
 
2645
                        client["expires"] = (datetime.datetime
 
2646
                                             .utcnow()
 
2647
                                             + client["timeout"])
 
2648
                        logger.debug("Last checker succeeded,"
 
2649
                                     " keeping {} enabled"
 
2650
                                     .format(client_name))
1892
2651
            try:
1893
 
                yield (name, special_settings[name]())
1894
 
            except KeyError:
1895
 
                yield (name, value)
1896
 
    
1897
 
    tcp_server.clients.update(set(
1898
 
            client_class(name = section,
1899
 
                         config= dict(client_config_items(
1900
 
                        client_config, section)))
1901
 
            for section in client_config.sections()))
 
2652
                client["secret"] = (
 
2653
                    pgp.decrypt(client["encrypted_secret"],
 
2654
                                client_settings[client_name]
 
2655
                                ["secret"]))
 
2656
            except PGPError:
 
2657
                # If decryption fails, we use secret from new settings
 
2658
                logger.debug("Failed to decrypt {} old secret"
 
2659
                             .format(client_name))
 
2660
                client["secret"] = (
 
2661
                    client_settings[client_name]["secret"])
 
2662
    
 
2663
    # Add/remove clients based on new changes made to config
 
2664
    for client_name in (set(old_client_settings)
 
2665
                        - set(client_settings)):
 
2666
        del clients_data[client_name]
 
2667
    for client_name in (set(client_settings)
 
2668
                        - set(old_client_settings)):
 
2669
        clients_data[client_name] = client_settings[client_name]
 
2670
    
 
2671
    # Create all client objects
 
2672
    for client_name, client in clients_data.items():
 
2673
        tcp_server.clients[client_name] = client_class(
 
2674
            name = client_name, settings = client,
 
2675
            server_settings = server_settings)
 
2676
    
1902
2677
    if not tcp_server.clients:
1903
2678
        logger.warning("No clients defined")
1904
 
        
1905
 
    if not debug:
1906
 
        try:
1907
 
            with pidfile:
1908
 
                pid = os.getpid()
1909
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
1910
 
            del pidfile
1911
 
        except IOError:
1912
 
            logger.error("Could not write to file %r with PID %d",
1913
 
                         pidfilename, pid)
1914
 
        except NameError:
1915
 
            # "pidfile" was never created
1916
 
            pass
 
2679
    
 
2680
    if not foreground:
 
2681
        if pidfile is not None:
 
2682
            try:
 
2683
                with pidfile:
 
2684
                    pid = os.getpid()
 
2685
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
 
2686
            except IOError:
 
2687
                logger.error("Could not write to file %r with PID %d",
 
2688
                             pidfilename, pid)
 
2689
        del pidfile
1917
2690
        del pidfilename
1918
 
        
1919
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1920
 
 
 
2691
    
1921
2692
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1922
2693
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1923
2694
    
1924
2695
    if use_dbus:
1925
 
        class MandosDBusService(dbus.service.Object):
 
2696
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2697
                                        "se.bsnet.fukt.Mandos"})
 
2698
        class MandosDBusService(DBusObjectWithProperties):
1926
2699
            """A D-Bus proxy object"""
1927
2700
            def __init__(self):
1928
2701
                dbus.service.Object.__init__(self, bus, "/")
1929
 
            _interface = "se.bsnet.fukt.Mandos"
 
2702
            _interface = "se.recompile.Mandos"
 
2703
            
 
2704
            @dbus_interface_annotations(_interface)
 
2705
            def _foo(self):
 
2706
                return { "org.freedesktop.DBus.Property"
 
2707
                         ".EmitsChangedSignal":
 
2708
                             "false"}
1930
2709
            
1931
2710
            @dbus.service.signal(_interface, signature="o")
1932
2711
            def ClientAdded(self, objpath):
1947
2726
            def GetAllClients(self):
1948
2727
                "D-Bus method"
1949
2728
                return dbus.Array(c.dbus_object_path
1950
 
                                  for c in tcp_server.clients)
 
2729
                                  for c in
 
2730
                                  tcp_server.clients.itervalues())
1951
2731
            
1952
2732
            @dbus.service.method(_interface,
1953
2733
                                 out_signature="a{oa{sv}}")
1954
2734
            def GetAllClientsWithProperties(self):
1955
2735
                "D-Bus method"
1956
2736
                return dbus.Dictionary(
1957
 
                    ((c.dbus_object_path, c.GetAll(""))
1958
 
                     for c in tcp_server.clients),
 
2737
                    { c.dbus_object_path: c.GetAll("")
 
2738
                      for c in tcp_server.clients.itervalues() },
1959
2739
                    signature="oa{sv}")
1960
2740
            
1961
2741
            @dbus.service.method(_interface, in_signature="o")
1962
2742
            def RemoveClient(self, object_path):
1963
2743
                "D-Bus method"
1964
 
                for c in tcp_server.clients:
 
2744
                for c in tcp_server.clients.itervalues():
1965
2745
                    if c.dbus_object_path == object_path:
1966
 
                        tcp_server.clients.remove(c)
 
2746
                        del tcp_server.clients[c.name]
1967
2747
                        c.remove_from_connection()
1968
2748
                        # Don't signal anything except ClientRemoved
1969
2749
                        c.disable(quiet=True)
1978
2758
    
1979
2759
    def cleanup():
1980
2760
        "Cleanup function; run on exit"
1981
 
        service.cleanup()
1982
 
        
 
2761
        if zeroconf:
 
2762
            service.cleanup()
 
2763
        
 
2764
        multiprocessing.active_children()
 
2765
        wnull.close()
 
2766
        if not (tcp_server.clients or client_settings):
 
2767
            return
 
2768
        
 
2769
        # Store client before exiting. Secrets are encrypted with key
 
2770
        # based on what config file has. If config file is
 
2771
        # removed/edited, old secret will thus be unrecovable.
 
2772
        clients = {}
 
2773
        with PGPEngine() as pgp:
 
2774
            for client in tcp_server.clients.itervalues():
 
2775
                key = client_settings[client.name]["secret"]
 
2776
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2777
                                                      key)
 
2778
                client_dict = {}
 
2779
                
 
2780
                # A list of attributes that can not be pickled
 
2781
                # + secret.
 
2782
                exclude = { "bus", "changedstate", "secret",
 
2783
                            "checker", "server_settings" }
 
2784
                for name, typ in (inspect.getmembers
 
2785
                                  (dbus.service.Object)):
 
2786
                    exclude.add(name)
 
2787
                
 
2788
                client_dict["encrypted_secret"] = (client
 
2789
                                                   .encrypted_secret)
 
2790
                for attr in client.client_structure:
 
2791
                    if attr not in exclude:
 
2792
                        client_dict[attr] = getattr(client, attr)
 
2793
                
 
2794
                clients[client.name] = client_dict
 
2795
                del client_settings[client.name]["secret"]
 
2796
        
 
2797
        try:
 
2798
            with (tempfile.NamedTemporaryFile
 
2799
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2800
                   dir=os.path.dirname(stored_state_path),
 
2801
                   delete=False)) as stored_state:
 
2802
                pickle.dump((clients, client_settings), stored_state)
 
2803
                tempname=stored_state.name
 
2804
            os.rename(tempname, stored_state_path)
 
2805
        except (IOError, OSError) as e:
 
2806
            if not debug:
 
2807
                try:
 
2808
                    os.remove(tempname)
 
2809
                except NameError:
 
2810
                    pass
 
2811
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2812
                logger.warning("Could not save persistent state: {}"
 
2813
                               .format(os.strerror(e.errno)))
 
2814
            else:
 
2815
                logger.warning("Could not save persistent state:",
 
2816
                               exc_info=e)
 
2817
                raise
 
2818
        
 
2819
        # Delete all clients, and settings from config
1983
2820
        while tcp_server.clients:
1984
 
            client = tcp_server.clients.pop()
 
2821
            name, client = tcp_server.clients.popitem()
1985
2822
            if use_dbus:
1986
2823
                client.remove_from_connection()
1987
 
            client.disable_hook = None
1988
2824
            # Don't signal anything except ClientRemoved
1989
2825
            client.disable(quiet=True)
1990
2826
            if use_dbus:
1991
2827
                # Emit D-Bus signal
1992
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2828
                mandos_dbus_service.ClientRemoved(client
 
2829
                                                  .dbus_object_path,
1993
2830
                                                  client.name)
 
2831
        client_settings.clear()
1994
2832
    
1995
2833
    atexit.register(cleanup)
1996
2834
    
1997
 
    for client in tcp_server.clients:
 
2835
    for client in tcp_server.clients.itervalues():
1998
2836
        if use_dbus:
1999
2837
            # Emit D-Bus signal
2000
2838
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2001
 
        client.enable()
 
2839
        # Need to initiate checking of clients
 
2840
        if client.enabled:
 
2841
            client.init_checker()
2002
2842
    
2003
2843
    tcp_server.enable()
2004
2844
    tcp_server.server_activate()
2005
2845
    
2006
2846
    # Find out what port we got
2007
 
    service.port = tcp_server.socket.getsockname()[1]
 
2847
    if zeroconf:
 
2848
        service.port = tcp_server.socket.getsockname()[1]
2008
2849
    if use_ipv6:
2009
2850
        logger.info("Now listening on address %r, port %d,"
2010
 
                    " flowinfo %d, scope_id %d"
2011
 
                    % tcp_server.socket.getsockname())
 
2851
                    " flowinfo %d, scope_id %d",
 
2852
                    *tcp_server.socket.getsockname())
2012
2853
    else:                       # IPv4
2013
 
        logger.info("Now listening on address %r, port %d"
2014
 
                    % tcp_server.socket.getsockname())
 
2854
        logger.info("Now listening on address %r, port %d",
 
2855
                    *tcp_server.socket.getsockname())
2015
2856
    
2016
2857
    #service.interface = tcp_server.socket.getsockname()[3]
2017
2858
    
2018
2859
    try:
2019
 
        # From the Avahi example code
2020
 
        try:
2021
 
            service.activate()
2022
 
        except dbus.exceptions.DBusException, error:
2023
 
            logger.critical("DBusException: %s", error)
2024
 
            cleanup()
2025
 
            sys.exit(1)
2026
 
        # End of Avahi example code
 
2860
        if zeroconf:
 
2861
            # From the Avahi example code
 
2862
            try:
 
2863
                service.activate()
 
2864
            except dbus.exceptions.DBusException as error:
 
2865
                logger.critical("D-Bus Exception", exc_info=error)
 
2866
                cleanup()
 
2867
                sys.exit(1)
 
2868
            # End of Avahi example code
2027
2869
        
2028
2870
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2029
2871
                             lambda *args, **kwargs:
2032
2874
        
2033
2875
        logger.debug("Starting main loop")
2034
2876
        main_loop.run()
2035
 
    except AvahiError, error:
2036
 
        logger.critical("AvahiError: %s", error)
 
2877
    except AvahiError as error:
 
2878
        logger.critical("Avahi Error", exc_info=error)
2037
2879
        cleanup()
2038
2880
        sys.exit(1)
2039
2881
    except KeyboardInterrupt: