/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-05-31 15:56:58 UTC
  • Revision ID: teddy@recompile.se-20150531155658-l7znu7zlqr2dmuwd
mandos: Generate better messages in exceptions.

mandos (ProxyClient.__init__): Include fingerprint in KeyError().
(rfc3339_duration_to_delta): Include duration in ValueError().

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