/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-07-07 15:49:49 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150707154949-vbuj4pc6wf3o1vgz
mandos.service: Use Type=dbus (implicitly).

mandos.service ([Service]/Type): Removed.
               ([Service]/BusName): Uncommented; set to
                                    "se.recompile.Mandos".

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