/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-07-27 09:23:56 UTC
  • Revision ID: teddy@recompile.se-20150727092356-65ul6jsiozlkjw4e
Debian bug fix for mandos-client: Remove dhparams.pem on purge.

* debian/mandos-client.postrm (purge): Bug fix: Remove dhparams.pem.

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